epan/dissectors/packet-vj.c

   1 /* packet-vj.c
   2  * Routines for Van Jacobson header decompression.
   3  *
   4  * $Id$
   5  *
   6  * Ethereal - Network traffic analyzer
   7  * By Gerald Combs <gerald@ethereal.com>
   8  *
   9  * This file created by Irfan Khan <ikhan@qualcomm.com>
  10  * Copyright (c) 2001  by QUALCOMM, Incorporated.
  11  * All Rights reserved.
  12  *
  13  * Routines to compress and uncompress TCP packets (for transmission
  14  * over low speed serial lines).
  15  *
  16  * Copyright (c) 1989 Regents of the University of California.
  17  * All rights reserved.
  18  *
  19  * Redistribution and use in source and binary forms are permitted
  20  * provided that the above copyright notice and this paragraph are
  21  * duplicated in all such forms and that any documentation,
  22  * advertising materials, and other materials related to such
  23  * distribution and use acknowledge that the software was developed
  24  * by the University of California, Berkeley.  The name of the
  25  * University may not be used to endorse or promote products derived
  26  * from this software without specific prior written permission.
  27  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
  28  * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
  29  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
  30  *
  31  *      Van Jacobson (van@helios.ee.lbl.gov), Dec 31, 1989:
  32  *      - Initial distribution.
  33  *
  34  *
  35  * modified for KA9Q Internet Software Package by
  36  * Katie Stevens (dkstevens@ucdavis.edu)
  37  * University of California, Davis
  38  * Computing Services
  39  *      - 01-31-90      initial adaptation (from 1.19)
  40  *      PPP.05  02-15-90 [ks]
  41  *      PPP.08  05-02-90 [ks]   use PPP protocol field to signal compression
  42  *      PPP.15  09-90    [ks]   improve mbuf handling
  43  *      PPP.16  11-02    [karn] substantially rewritten to use NOS facilities
  44  *
  45  *      - Feb 1991      Bill_Simpson@um.cc.umich.edu
  46  *                      variable number of conversation slots
  47  *                      allow zero or one slots
  48  *                      separate routines
  49  *                      status display
  50  *      - Jul 1994      Dmitry Gorodchanin
  51  *                      Fixes for memory leaks.
  52  *      - Oct 1994      Dmitry Gorodchanin
  53  *                      Modularization.
  54  *      - Jan 1995      Bjorn Ekwall
  55  *                      Use ip_fast_csum from ip.h
  56  *      - July 1995     Christos A. Polyzols
  57  *                      Spotted bug in tcp option checking
  58  *      - Sep 2001      Irfan Khan
  59  *                      Rewrite to make the code work for ethereal.
  60  */
  61
  62 #ifdef HAVE_CONFIG_H
  63 # include "config.h"
  64 #endif
  65
  66 #include <glib.h>
  67 #include <string.h>
  68 #include <epan/packet.h>
  69 #include "prefs.h"
  70 #include "packet-ppp.h"
  71 #include "ppptypes.h"
  72 #include "ipproto.h"
  73 #include "in_cksum.h"
  74
  75 /* Define relevant IP/TCP parameters */
  76 #define IP_FIELD_TOT_LEN      2 /* Total length field in IP hdr           */
  77 #define IP_FIELD_PROTOCOL     9 /* Protocol field byte in IP hdr          */
  78 #define IP_ADDR_SIZE          4 /* Size in bytes of IPv4 address          */
  79 #define IP_FIELD_SRC         12 /* Byte 12 in IP hdr - src address        */
  80 #define IP_FIELD_DST         16 /* Byte 16 in IP hdr - dst address        */
  81 #define IP_HDR_LEN           20 /* Minimum IP header length               */
  82 #define IP_HDR_LEN_MASK    0x0f /* Mask for header length field           */
  83 #define IP_MAX_OPT_LEN       44 /* Max length of IP options               */
  84 #define TCP_FIELD_HDR_LEN    12 /* Data offset field in TCP hdr           */
  85 #define TCP_HDR_LEN          20 /* Minimum TCP header length              */
  86 #define TCP_MAX_OPT_LEN      44 /* Max length of TCP options              */
  87 #define TCP_SIMUL_CONV_MAX  256 /* Max number of simul. TCP conversations */
  88 #define TCP_PUSH_BIT       0x08 /* TCP push bit                           */
  89 #define TCP_URG_BIT        0x20 /* TCP urgent bit                         */
  90
  91 /* Bits in first octet of compressed packet */
  92 /* flag bits for what changed in a packet */
  93 #define NEW_C           0x40 /* Connection number changed               */
  94 #define NEW_I           0x20 /* IP sequence number change by value != 1 */
  95 #define CHANGE_PUSH_BIT 0x10 /* TCP push bit set                        */
  96 #define NEW_S           0x08 /* Sequence number changed                 */
  97 #define NEW_A           0x04 /* Ack sequence number changed             */
  98 #define NEW_W           0x02 /* Window changed                          */
  99 #define NEW_U           0x01 /* Urgent pointer present                  */
 100
 101 /* reserved, special-case values of above */
 102 #define SPECIAL_I     (NEW_S|NEW_W|NEW_U)    /* echoed interactive traffic */
 103 #define SPECIAL_D     (NEW_S|NEW_A|NEW_W|NEW_U)/* unidirectional data */
 104 #define SPECIALS_MASK (NEW_S|NEW_A|NEW_W|NEW_U)
 105
 106 /* Function return values */
 107 #define VJ_OK           0
 108 #define VJ_ERROR       -1
 109
 110 /* Define for 0 */
 111 #define ZERO            0
 112
 113 /* VJ Mem Chunk defines */
 114 #define VJ_DATA_SIZE  128 /* Max IP hdr(64)+Max TCP hdr(64) */
 115 #define VJ_ATOM_COUNT 250 /* Number of Atoms per block      */
 116
 117 /* IP and TCP header types */
 118 typedef struct {
 119   guint8  ihl_version;
 120   guint8  tos;
 121   guint16 tot_len;
 122   guint16 id;
 123   guint16 frag_off;
 124   guint8  ttl;
 125   guint8  proto;
 126   guint16 cksum;
 127   guint32 src;
 128   guint32 dst;
 129 } iphdr_type;
 130
 131 typedef struct {
 132   guint16 srcport;
 133   guint16 dstport;
 134   guint32 seq;
 135   guint32 ack_seq;
 136   guint8  off_x2;
 137   guint8  flags;
 138   guint16 window;
 139   guint16 cksum;
 140   guint16 urg_ptr;
 141 } tcphdr_type;
 142
 143 #define TCP_OFFSET(th)  (((th)->off_x2 & 0xf0) >> 4)
 144
 145 /* State per active tcp conversation */
 146 typedef struct cstate {
 147   iphdr_type cs_ip;
 148   tcphdr_type cs_tcp;
 149   guint8 cs_ipopt[IP_MAX_OPT_LEN];
 150   guint8 cs_tcpopt[TCP_MAX_OPT_LEN];
 151   guint32 flags;
 152 #define SLF_TOSS  0x00000001    /* tossing rcvd frames until id received */
 153 } cstate;
 154
 155 /* All the state data for one serial line */
 156 typedef struct {
 157   cstate rstate[TCP_SIMUL_CONV_MAX]; /* receive connection states (array) */
 158   guint8 recv_current;               /* most recent rcvd id */
 159 } slcompress;
 160
 161 /* Initialize the protocol and registered fields */
 162 static int proto_vj = -1;
 163
 164 static int hf_vj_change_mask = -1;
 165 static int hf_vj_change_mask_c = -1;
 166 static int hf_vj_change_mask_i = -1;
 167 static int hf_vj_change_mask_p = -1;
 168 static int hf_vj_change_mask_s = -1;
 169 static int hf_vj_change_mask_a = -1;
 170 static int hf_vj_change_mask_w = -1;
 171 static int hf_vj_change_mask_u = -1;
 172 static int hf_vj_connection_number = -1;
 173 static int hf_vj_tcp_cksum = -1;
 174 static int hf_vj_urp = -1;
 175 static int hf_vj_win_delta = -1;
 176 static int hf_vj_ack_delta = -1;
 177 static int hf_vj_seq_delta = -1;
 178 static int hf_vj_ip_id_delta = -1;
 179
 180 static gint ett_vj = -1;
 181 static gint ett_vj_changes = -1;
 182
 183 /* Protocol handles */
 184 static dissector_handle_t ip_handle;
 185 static dissector_handle_t data_handle;
 186
 187 /* State repository (Full Duplex) */
 188 #define RX_TX_STATE_COUNT 2
 189 static slcompress *rx_tx_state[RX_TX_STATE_COUNT] = {NULL, NULL};
 190
 191 /* Mem Chunks for storing decompressed headers */
 192 static GMemChunk *vj_header_memchunk = NULL;
 193 typedef struct {
 194         int     offset;                 /* uppermost bit is "can't dissect" flag */
 195         guint8  data[VJ_DATA_SIZE];
 196 } vj_header_t;
 197
 198 /* Function prototypes */
 199 static int get_unsigned_delta(tvbuff_t *tvb, int *offsetp, int hf,
 200                         proto_tree *tree);
 201 static int get_signed_delta(tvbuff_t *tvb, int *offsetp, int hf,
 202                         proto_tree *tree);
 203 static guint16 ip_csum(const guint8 *ptr, guint32 len);
 204 static slcompress *slhc_init(void);
 205 static void vj_init(void);
 206 static gint vjc_process(tvbuff_t *src_tvb, packet_info *pinfo, proto_tree *tree,
 207                       slcompress *comp);
 208 static gint vjc_tvb_setup(tvbuff_t *src_tvb, tvbuff_t **dst_tvb,
 209                           packet_info *pinfo);
 210
 211 /* Dissector for VJ Uncompressed packets */
 212 static void
 213 dissect_vjuc(tvbuff_t *tvb, packet_info *pinfo, proto_tree * tree)
 214 {
 215   proto_item *ti;
 216   proto_tree *vj_tree     = NULL;
 217   slcompress *comp;
 218   int         i;
 219   gint        conn_index;
 220   cstate     *cs          = NULL;
 221   guint8      ihl;
 222   guint8      thl;
 223   guint8     *buffer;
 224   tvbuff_t   *next_tvb;
 225   gint        isize       = tvb_length(tvb);
 226   gint        ipsize;
 227
 228   if(check_col(pinfo->cinfo, COL_PROTOCOL))
 229     col_set_str(pinfo->cinfo, COL_INFO, "PPP VJ");
 230
 231   if(tree != NULL) {
 232     ti = proto_tree_add_protocol_format(tree, proto_vj, tvb, 0, -1,
 233                                         "PPP VJ Compression: Uncompressed data");
 234     vj_tree = proto_item_add_subtree(ti, ett_vj);
 235   }
 236
 237   if(pinfo->p2p_dir == P2P_DIR_UNKNOWN) {
 238     /* Direction of the traffic unknown - can't update state */
 239     comp = NULL;
 240   } else {
 241     /* Get state for that direction */
 242     comp = rx_tx_state[pinfo->p2p_dir];
 243   }
 244
 245   /*
 246    * Check to make sure we can fetch the connection index.
 247    */
 248   if(!tvb_bytes_exist(tvb, IP_FIELD_PROTOCOL, 1)) {
 249     /*
 250      * We don't.  We can't even mark a connection as non-decompressable,
 251      * as we don't know which connection this is.  Mark them all as
 252      * non-decompressable.
 253      */
 254     if(check_col(pinfo->cinfo, COL_INFO))
 255       col_set_str(pinfo->cinfo, COL_INFO, "VJ uncompressed TCP (not enough data available)");
 256     if(tree != NULL)
 257       call_dissector(data_handle, tvb, pinfo, tree);
 258     if(comp != NULL) {
 259       for(i = 0; i < TCP_SIMUL_CONV_MAX; i++)
 260         comp->rstate[i].flags |= SLF_TOSS;
 261     }
 262     return;
 263   }
 264
 265   /* Get connection index */
 266   conn_index = tvb_get_guint8(tvb, IP_FIELD_PROTOCOL);
 267   if(tree != NULL)
 268     proto_tree_add_uint(vj_tree, hf_vj_connection_number, tvb,
 269                         IP_FIELD_PROTOCOL, 1, conn_index);
 270
 271   /*
 272    * Update the current connection, and get a pointer to its state.
 273    */
 274   if(comp != NULL) {
 275     comp->recv_current = conn_index;
 276     cs = &comp->rstate[conn_index];
 277   }
 278
 279   /* Get the IP header length */
 280   ihl = tvb_get_guint8(tvb, 0) & IP_HDR_LEN_MASK;
 281   ihl <<= 2;
 282
 283   /* Check IP header length */
 284   if(ihl < IP_HDR_LEN) {
 285     if(check_col(pinfo->cinfo, COL_INFO)) {
 286       col_add_fstr(pinfo->cinfo, COL_INFO, "VJ uncompressed TCP (IP header length (%u) < %u)",
 287                    ihl, IP_HDR_LEN);
 288     }
 289     if(cs != NULL)
 290       cs->flags |= SLF_TOSS;
 291     return;
 292   }
 293
 294   /* Make sure we have the full IP header */
 295   if(isize < ihl) {
 296     if(check_col(pinfo->cinfo, COL_INFO))
 297       col_set_str(pinfo->cinfo, COL_INFO, "VJ uncompressed TCP (not enough data available)");
 298     if(tree != NULL)
 299       call_dissector(data_handle, tvb, pinfo, tree);
 300     if(cs != NULL)
 301       cs->flags |= SLF_TOSS;
 302     return;
 303   }
 304
 305   if(check_col(pinfo->cinfo, COL_INFO))
 306     col_set_str(pinfo->cinfo, COL_INFO, "VJ uncompressed TCP");
 307
 308   /*
 309    * Copy packet data to a buffer, and replace the connection index with
 310    * the protocol type (which is always TCP), to give the actual IP header.
 311    */
 312   buffer = tvb_memdup(tvb, 0, isize);
 313   buffer[IP_FIELD_PROTOCOL] = IP_PROTO_TCP;
 314
 315   /* Check IP checksum */
 316   if(ip_csum(buffer, ihl) != ZERO) {
 317     /*
 318      * Checksum invalid - don't update state, and don't decompress
 319      * any subsequent compressed packets in this direction.
 320      */
 321     if(cs != NULL)
 322       cs->flags |= SLF_TOSS;
 323     cs = NULL;  /* disable state updates */
 324   } else {
 325     /* Do we have the TCP header length in the tvbuff? */
 326     if(!tvb_bytes_exist(tvb, ihl + TCP_FIELD_HDR_LEN, 1)) {
 327       /* We don't, so we can't provide enough data for decompression */
 328       if(check_col(pinfo->cinfo, COL_INFO))
 329         col_set_str(pinfo->cinfo, COL_INFO, "VJ uncompressed TCP (not enough data available)");
 330       if(cs != NULL)
 331         cs->flags |= SLF_TOSS;
 332       cs = NULL;  /* disable state updates */
 333     } else {
 334       /* Get the TCP header length */
 335       thl = tvb_get_guint8(tvb, ihl + TCP_FIELD_HDR_LEN);
 336       thl = ((thl & 0xf0) >> 4) * 4;
 337
 338       /* Check TCP header length */
 339       if(thl < TCP_HDR_LEN) {
 340         if(check_col(pinfo->cinfo, COL_INFO)) {
 341           col_add_fstr(pinfo->cinfo, COL_INFO, "VJ uncompressed TCP (TCP header length (%u) < %u)",
 342                        thl, TCP_HDR_LEN);
 343         }
 344         if(cs != NULL)
 345           cs->flags |= SLF_TOSS;
 346         cs = NULL;  /* disable state updates */
 347       } else {
 348         /* Make sure we have the full TCP header */
 349         if(isize < thl) {
 350           if(check_col(pinfo->cinfo, COL_INFO))
 351             col_set_str(pinfo->cinfo, COL_INFO, "VJ uncompressed TCP (not enough data available)");
 352           if(cs != NULL)
 353             cs->flags |= SLF_TOSS;
 354           cs = NULL;  /* disable state updates */
 355         }
 356       }
 357     }
 358   }
 359
 360   /*
 361    * If packet seen for first time, update state if we have state and can
 362    * update it.
 363    */
 364   if(!pinfo->fd->flags.visited) {
 365     if(cs != NULL) {
 366       cs->flags &= ~SLF_TOSS;
 367       memcpy(&cs->cs_ip, &buffer[0], IP_HDR_LEN);
 368       memcpy(&cs->cs_tcp, &buffer[ihl], TCP_HDR_LEN);
 369       if(ihl > IP_HDR_LEN)
 370         memcpy(cs->cs_ipopt, &buffer[sizeof(iphdr_type)], ihl - IP_HDR_LEN);
 371       if(TCP_OFFSET(&(cs->cs_tcp)) > 5)
 372         memcpy(cs->cs_tcpopt, &buffer[ihl + sizeof(tcphdr_type)],
 373                    (TCP_OFFSET(&(cs->cs_tcp)) - 5) * 4);
 374     }
 375   }
 376
 377   /*
 378    * Set up tvbuff containing packet with protocol type.
 379    * Neither header checksum is recalculated.
 380    *
 381    * Use the length field from the IP header as the reported length;
 382    * use the minimum of that and the number of bytes we got from
 383    * the tvbuff as the actual length, just in case the tvbuff we were
 384    * handed includes part or all of the FCS (because the FCS preference
 385    * for the PPP dissector doesn't match the FCS size in this session).
 386    */
 387   ipsize = pntohs(&buffer[IP_FIELD_TOT_LEN]);
 388   if (ipsize < isize)
 389     isize = ipsize;
 390   next_tvb = tvb_new_real_data(buffer, isize, ipsize);
 391   tvb_set_child_real_data_tvbuff(tvb, next_tvb);
 392   add_new_data_source(pinfo, next_tvb, "VJ Uncompressed");
 393
 394   /*
 395    * Call IP dissector.
 396    */
 397   call_dissector(ip_handle, next_tvb, pinfo, tree);
 398 }
 399
 400 /* Dissector for VJ Compressed packets */
 401 static void
 402 dissect_vjc(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree)
 403 {
 404   proto_item *ti;
 405   proto_tree *vj_tree     = NULL;
 406   tvbuff_t   *next_tvb = NULL;
 407   slcompress *comp     = NULL;
 408   gint        err      = VJ_ERROR;
 409
 410   if(check_col(pinfo->cinfo, COL_PROTOCOL))
 411     col_set_str(pinfo->cinfo, COL_INFO, "PPP VJ");
 412
 413   if(tree != NULL) {
 414     ti = proto_tree_add_protocol_format(tree, proto_vj, tvb, 0, -1,
 415                                         "PPP VJ Compression: Compressed data");
 416     vj_tree = proto_item_add_subtree(ti, ett_vj);
 417   }
 418
 419   if(!ppp_vj_decomp || pinfo->p2p_dir == P2P_DIR_UNKNOWN) {
 420     /*
 421      * VJ decompression turned off, so we shouldn't decompress, or
 422      * direction of the traffic unknown, so we can't decompress.
 423      */
 424     comp = NULL;
 425   } else {
 426     /* Get state for that direction */
 427     comp = rx_tx_state[pinfo->p2p_dir];
 428   }
 429
 430   /* Process the compressed data header */
 431   if(vjc_process(tvb, pinfo, vj_tree, comp) == VJ_ERROR)
 432     return;
 433
 434   /* Decompression possible - set up tvb containing decompressed packet */
 435   err = vjc_tvb_setup(tvb, &next_tvb, pinfo);
 436   if(err == VJ_ERROR) {
 437     if(tree != NULL)
 438       call_dissector(data_handle, tvb, pinfo, vj_tree);
 439     return;
 440   }
 441
 442   /* No errors, so call IP dissector */
 443   call_dissector(ip_handle, next_tvb, pinfo, tree);
 444 }
 445
 446 /* Registration functions for dissectors */
 447 void
 448 proto_register_vj(void)
 449 {
 450   static hf_register_info hf[] = {
 451     { &hf_vj_change_mask,
 452       { "Change mask",  "vj.change_mask",       FT_UINT8, BASE_HEX,
 453         NULL, 0x0, "", HFILL }},
 454     { &hf_vj_change_mask_c,
 455       { "Connection changed",           "vj.change_mask_c",     FT_BOOLEAN, 8,
 456         NULL, NEW_C, "Connection number changed", HFILL }},
 457     { &hf_vj_change_mask_i,
 458       { "IP ID change != 1",            "vj.change_mask_i",     FT_BOOLEAN, 8,
 459         NULL, NEW_I, "IP ID changed by a value other than 1", HFILL }},
 460     { &hf_vj_change_mask_p,
 461       { "Push bit set",                 "vj.change_mask_p",     FT_BOOLEAN, 8,
 462         NULL, CHANGE_PUSH_BIT, "TCP PSH flag set", HFILL }},
 463     { &hf_vj_change_mask_s,
 464       { "Sequence number changed",      "vj.change_mask_s",     FT_BOOLEAN, 8,
 465         NULL, NEW_S, "Sequence number changed", HFILL }},
 466     { &hf_vj_change_mask_a,
 467       { "Ack number changed",           "vj.change_mask_a",     FT_BOOLEAN, 8,
 468         NULL, NEW_A, "Acknowledgement sequence number changed", HFILL }},
 469     { &hf_vj_change_mask_w,
 470       { "Window changed",               "vj.change_mask_w",     FT_BOOLEAN, 8,
 471         NULL, NEW_W, "TCP window changed", HFILL }},
 472     { &hf_vj_change_mask_u,
 473       { "Urgent pointer set",           "vj.change_mask_u",     FT_BOOLEAN, 8,
 474         NULL, NEW_U, "Urgent pointer set", HFILL }},
 475     { &hf_vj_connection_number,
 476       { "Connection number",    "vj.connection_number", FT_UINT8, BASE_DEC,
 477         NULL, 0x0, "Connection number", HFILL }},
 478     { &hf_vj_tcp_cksum,
 479       { "TCP checksum",                 "vj.tcp_cksum", FT_UINT16, BASE_HEX,
 480         NULL, 0x0, "TCP checksum", HFILL }},
 481     { &hf_vj_urp,
 482       { "Urgent pointer",               "vj.urp",       FT_UINT16, BASE_DEC,
 483         NULL, 0x0, "Urgent pointer", HFILL }},
 484     { &hf_vj_win_delta,
 485       { "Window delta",                 "vj.win_delta", FT_INT16, BASE_DEC,
 486         NULL, 0x0, "Delta for window", HFILL }},
 487     { &hf_vj_ack_delta,
 488       { "Ack delta",                    "vj.ack_delta", FT_UINT16, BASE_DEC,
 489         NULL, 0x0, "Delta for acknowledgment sequence number", HFILL }},
 490     { &hf_vj_seq_delta,
 491       { "Sequence delta",               "vj.seq_delta", FT_UINT16, BASE_DEC,
 492         NULL, 0x0, "Delta for sequence number", HFILL }},
 493     { &hf_vj_ip_id_delta,
 494       { "IP ID delta",                  "vj.ip_id_delta",       FT_UINT16, BASE_DEC,
 495         NULL, 0x0, "Delta for IP ID", HFILL }},
 496   };
 497   static gint *ett[] = {
 498     &ett_vj,
 499     &ett_vj_changes,
 500   };
 501
 502   proto_vj = proto_register_protocol("PPP VJ Compression", "PPP VJ", "vj");
 503   proto_register_field_array(proto_vj, hf, array_length(hf));
 504   proto_register_subtree_array(ett, array_length(ett));
 505   register_init_routine(&vj_init);
 506 }
 507
 508 void
 509 proto_reg_handoff_vj(void)
 510 {
 511   dissector_handle_t vjc_handle;
 512   dissector_handle_t vjuc_handle;
 513
 514   vjc_handle = create_dissector_handle(dissect_vjc, proto_vj);
 515   dissector_add("ppp.protocol", PPP_VJC_COMP, vjc_handle);
 516
 517   vjuc_handle = create_dissector_handle(dissect_vjuc, proto_vj);
 518   dissector_add("ppp.protocol", PPP_VJC_UNCOMP, vjuc_handle);
 519
 520   ip_handle = find_dissector("ip");
 521   data_handle = find_dissector("data");
 522 }
 523
 524 /* Initialization function */
 525 static void
 526 vj_init(void)
 527 {
 528   gint i           = ZERO;
 529   slcompress *pslc = NULL;
 530
 531   if(vj_header_memchunk != NULL)
 532     g_mem_chunk_destroy(vj_header_memchunk);
 533   vj_header_memchunk = g_mem_chunk_new("vj header store", sizeof (vj_header_t),
 534                                        sizeof (vj_header_t) * VJ_ATOM_COUNT,
 535                                        G_ALLOC_ONLY);
 536   for(i = 0; i < RX_TX_STATE_COUNT; i++) {
 537     if((pslc = rx_tx_state[i]) != NULL)
 538       g_free(pslc);
 539     rx_tx_state[i] = slhc_init();
 540   }
 541   return;
 542 }
 543
 544 /* Initialization routine for VJ decompression */
 545 static slcompress *
 546 slhc_init(void)
 547 {
 548   slcompress *comp = g_malloc(sizeof(slcompress));
 549   int         i;
 550
 551   memset(comp, ZERO, sizeof(slcompress));
 552
 553   /*
 554    * Initialize the state; there is no current connection, and
 555    * we have no header data for any of the connections, as we
 556    * haven't yet seen an uncompressed frame.
 557    */
 558   comp->recv_current = TCP_SIMUL_CONV_MAX - 1;
 559   for (i = 0; i < TCP_SIMUL_CONV_MAX; i++)
 560     comp->rstate[i].flags |= SLF_TOSS;
 561   return comp;
 562 }
 563
 564 /* Setup the decompressed packet tvb for VJ compressed packets */
 565 static gint
 566 vjc_tvb_setup(tvbuff_t *src_tvb,
 567               tvbuff_t **dst_tvb,
 568               packet_info *pinfo)
 569 {
 570   vj_header_t *hdr_buf;
 571   guint8       offset;
 572   guint8      *data_ptr;
 573   iphdr_type  *ip;
 574   tcphdr_type *thp;
 575   gint         hdr_len;
 576   gint         buf_len;
 577   guint8      *pbuf;
 578
 579   g_assert(src_tvb);
 580
 581   /* Get decompressed header stored in fd protocol area */
 582   hdr_buf = p_get_proto_data(pinfo->fd, proto_vj);
 583   if(hdr_buf == NULL) {
 584     if(check_col(pinfo->cinfo, COL_INFO))
 585       col_set_str(pinfo->cinfo, COL_INFO, "VJ compressed TCP (previous data bad or missing)");
 586     return VJ_ERROR;
 587   }
 588
 589   if(check_col(pinfo->cinfo, COL_INFO))
 590     col_set_str(pinfo->cinfo, COL_INFO, "VJ compressed TCP");
 591
 592   /* Get the data offset in the tvbuff */
 593   offset  = hdr_buf->offset;
 594
 595   /* Copy header and form tvb */
 596   data_ptr = hdr_buf->data;
 597   ip = (iphdr_type *)data_ptr;
 598   hdr_len  = lo_nibble(ip->ihl_version) * 4;
 599   thp = (tcphdr_type *)(data_ptr + hdr_len);
 600   hdr_len += TCP_OFFSET(thp) * 4;
 601   buf_len  = tvb_length(src_tvb) + hdr_len - offset;
 602   pbuf     = g_malloc(buf_len);
 603   memcpy(pbuf, data_ptr, hdr_len);
 604   tvb_memcpy(src_tvb, pbuf + hdr_len, offset, buf_len - hdr_len);
 605   *dst_tvb = tvb_new_real_data(pbuf, buf_len, g_ntohs(ip->tot_len));
 606   tvb_set_child_real_data_tvbuff(src_tvb, *dst_tvb);
 607   add_new_data_source(pinfo, *dst_tvb, "VJ Decompressed");
 608   return VJ_OK;
 609 }
 610
 611 /*
 612  * For VJ compressed packet:
 613  *
 614  *      check if it is malformed;
 615  *      dissect the relevant fields;
 616  *      update the decompressor state on the first pass.
 617  */
 618 static gint
 619 vjc_process(tvbuff_t *src_tvb, packet_info *pinfo, proto_tree *tree,
 620             slcompress *comp)
 621 {
 622   int            offset     = ZERO;
 623   int            i;
 624   gint           changes;
 625   proto_item    *ti;
 626   proto_tree    *changes_tree;
 627   guint8         conn_index;
 628   cstate        *cs         = NULL;
 629   iphdr_type    *ip         = NULL;
 630   tcphdr_type   *thp        = NULL;
 631   guint16        tcp_cksum;
 632   gint           hdrlen     = ZERO;
 633   guint16        word;
 634   int            delta;
 635   gint           len;
 636   vj_header_t   *buf_hdr;
 637   guint8        *data_ptr;
 638
 639   if(tvb_length(src_tvb) < 3){
 640     /*
 641      * We don't even have enough data for the change byte, so we can't
 642      * determine which connection this is; mark all connections as
 643      * non-decompressible.
 644      */
 645     if(check_col(pinfo->cinfo, COL_INFO))
 646       col_set_str(pinfo->cinfo, COL_INFO, "VJ compressed TCP (not enough data available)");
 647     if(tree != NULL)
 648       call_dissector(data_handle, src_tvb, pinfo, tree);
 649     if(comp != NULL) {
 650       for(i = 0; i < TCP_SIMUL_CONV_MAX; i++)
 651         comp->rstate[i].flags |= SLF_TOSS;
 652     }
 653     return VJ_ERROR;
 654   }
 655
 656   /* Read the change byte */
 657   changes = tvb_get_guint8(src_tvb, offset);
 658   if(tree != NULL) {
 659     switch (changes & SPECIALS_MASK) {
 660
 661     case SPECIAL_I:
 662       ti = proto_tree_add_uint_format(tree, hf_vj_change_mask, src_tvb,
 663                                       offset, 1, changes,
 664                                       "Change mask: 0x%02x (echoed interactive traffic)",
 665                                       changes);
 666       break;
 667
 668     case SPECIAL_D:
 669       ti = proto_tree_add_uint_format(tree, hf_vj_change_mask, src_tvb,
 670                                       offset, 1, changes,
 671                                       "Change mask: 0x%02x (unidirectional data)",
 672                                       changes);
 673       break;
 674
 675     default:
 676       /*
 677        * XXX - summarize bits?
 678        */
 679       ti = proto_tree_add_uint_format(tree, hf_vj_change_mask, src_tvb,
 680                                       offset, 1, changes,
 681                                       "Change mask: 0x%02x", changes);
 682       break;
 683     }
 684     changes_tree = proto_item_add_subtree(ti, ett_vj_changes);
 685     proto_tree_add_boolean(changes_tree, hf_vj_change_mask_c, src_tvb,
 686                            offset, 1, changes);
 687     proto_tree_add_boolean(changes_tree, hf_vj_change_mask_i, src_tvb,
 688                            offset, 1, changes);
 689     proto_tree_add_boolean(changes_tree, hf_vj_change_mask_p, src_tvb,
 690                            offset, 1, changes);
 691     proto_tree_add_boolean(changes_tree, hf_vj_change_mask_s, src_tvb,
 692                            offset, 1, changes);
 693     proto_tree_add_boolean(changes_tree, hf_vj_change_mask_a, src_tvb,
 694                            offset, 1, changes);
 695     proto_tree_add_boolean(changes_tree, hf_vj_change_mask_w, src_tvb,
 696                            offset, 1, changes);
 697     proto_tree_add_boolean(changes_tree, hf_vj_change_mask_u, src_tvb,
 698                            offset, 1, changes);
 699   }
 700   offset++;
 701
 702   if(changes & NEW_C){    /* Read conn index */
 703     conn_index = tvb_get_guint8(src_tvb, offset);
 704     if(tree != NULL)
 705       proto_tree_add_uint(tree, hf_vj_connection_number, src_tvb, offset, 1,
 706                           conn_index);
 707     offset++;
 708     if(comp != NULL)
 709       comp->recv_current = conn_index;
 710   }
 711
 712   if(!pinfo->fd->flags.visited) {
 713     /*
 714      * This is the first time this frame has been seen, so we need
 715      * state information to decompress it.  If that information isn't
 716      * available, don't use the state information, and don't update it,
 717      * either.
 718      */
 719     if(comp != NULL && !(comp->rstate[comp->recv_current].flags & SLF_TOSS)) {
 720       cs = &comp->rstate[comp->recv_current];
 721       thp = &cs->cs_tcp;
 722       ip = &cs->cs_ip;
 723     }
 724   }
 725
 726   /* Build TCP and IP headers */
 727   tcp_cksum = tvb_get_ntohs(src_tvb, offset);
 728   if(tree != NULL)
 729     proto_tree_add_uint(tree, hf_vj_tcp_cksum, src_tvb, offset, 2, tcp_cksum);
 730   if(cs != NULL) {
 731     hdrlen = lo_nibble(ip->ihl_version) * 4 + TCP_OFFSET(thp) * 4;
 732     thp->cksum = g_htons(tcp_cksum);
 733   }
 734   offset += 2;
 735   if(cs != NULL) {
 736     if(changes & CHANGE_PUSH_BIT)
 737       thp->flags |= TCP_PUSH_BIT;
 738     else
 739       thp->flags &= ~TCP_PUSH_BIT;
 740   }
 741
 742   /* Deal with special cases and normal deltas */
 743   switch(changes & SPECIALS_MASK){
 744     case SPECIAL_I:                   /* Echoed terminal traffic */
 745       if(cs != NULL) {
 746         word = g_ntohs(ip->tot_len) - hdrlen;
 747         thp->ack_seq = g_htonl(g_ntohl(thp->ack_seq) + word);
 748         thp->seq = g_htonl(g_ntohl(thp->seq) + word);
 749       }
 750       break;
 751     case SPECIAL_D:                   /* Unidirectional data */
 752       if(cs != NULL)
 753         thp->seq = g_htonl(g_ntohl(thp->seq) + g_ntohs(ip->tot_len) - hdrlen);
 754       break;
 755     default:
 756       if(changes & NEW_U){
 757         delta = get_unsigned_delta(src_tvb, &offset, hf_vj_urp, tree);
 758         if(cs != NULL) {
 759           thp->urg_ptr = delta;
 760           thp->flags |= TCP_URG_BIT;
 761         }
 762       } else {
 763         if(cs != NULL)
 764           thp->flags &= ~TCP_URG_BIT;
 765       }
 766       if(changes & NEW_W) {
 767         delta = get_signed_delta(src_tvb, &offset, hf_vj_win_delta, tree);
 768         if(cs != NULL)
 769           thp->window = g_htons(g_ntohs(thp->window) + delta);
 770       }
 771       if(changes & NEW_A) {
 772         delta = get_unsigned_delta(src_tvb, &offset, hf_vj_ack_delta, tree);
 773         if(cs != NULL)
 774           thp->ack_seq = g_htonl(g_ntohl(thp->ack_seq) + delta);
 775       }
 776       if(changes & NEW_S) {
 777         delta = get_unsigned_delta(src_tvb, &offset, hf_vj_seq_delta, tree);
 778         if(cs != NULL)
 779           thp->seq = g_htonl(g_ntohl(thp->seq) + delta);
 780       }
 781       break;
 782   }
 783   if(changes & NEW_I)
 784     delta = get_unsigned_delta(src_tvb, &offset, hf_vj_ip_id_delta, tree);
 785   else
 786     delta = 1;
 787   if(cs != NULL)
 788     ip->id = g_htons(g_ntohs(ip->id) + delta);
 789
 790   /* Compute IP packet length and the buffer length needed */
 791   len = tvb_reported_length_remaining(src_tvb, offset);
 792   if(len < ZERO) {
 793     /*
 794      * This shouldn't happen, as we *were* able to fetch stuff right before
 795      * offset.
 796      */
 797     if(check_col(pinfo->cinfo, COL_INFO))
 798       col_set_str(pinfo->cinfo, COL_INFO, "VJ compressed TCP (not enough data available)");
 799     if(cs != NULL)
 800       cs->flags |= SLF_TOSS;
 801     return VJ_ERROR;
 802   }
 803
 804   /* Show the TCP payload */
 805   if(tree != NULL && tvb_offset_exists(src_tvb, offset))
 806     proto_tree_add_text(tree, src_tvb, offset, -1, "TCP payload");
 807
 808   /* Nothing more to do if we don't have any compression state */
 809   if(comp == NULL) {
 810     /* Direction of the traffic unknown - can't decompress */
 811     if(check_col(pinfo->cinfo, COL_INFO))
 812       col_set_str(pinfo->cinfo, COL_INFO, "VJ compressed TCP (direction unknown)");
 813     return VJ_ERROR;
 814   }
 815
 816   if(cs != NULL) {
 817     len += hdrlen;
 818     ip->tot_len = g_htons(len);
 819     /* Compute IP check sum */
 820     ip->cksum = ZERO;
 821     ip->cksum = ip_csum((guint8 *)ip, lo_nibble(ip->ihl_version) * 4);
 822
 823     /* Store the reconstructed header in frame data area */
 824     buf_hdr = g_mem_chunk_alloc(vj_header_memchunk);
 825     buf_hdr->offset = offset;  /* Offset in tvbuff is also stored */
 826     data_ptr = buf_hdr->data;
 827     memcpy(data_ptr, ip, IP_HDR_LEN);
 828     data_ptr += IP_HDR_LEN;
 829     if(lo_nibble(ip->ihl_version) > 5) {
 830       memcpy(data_ptr, cs->cs_ipopt, (lo_nibble(ip->ihl_version) - 5) * 4);
 831       data_ptr += (lo_nibble(ip->ihl_version) - 5) * 4;
 832     }
 833     memcpy(data_ptr, thp, TCP_HDR_LEN);
 834     data_ptr += TCP_HDR_LEN;
 835     if(TCP_OFFSET(thp) > 5)
 836       memcpy(data_ptr, cs->cs_tcpopt, (TCP_OFFSET(thp) - 5) * 4);
 837     p_add_proto_data(pinfo->fd, proto_vj, buf_hdr);
 838   }
 839
 840   return VJ_OK;
 841 }
 842
 843 /*
 844  * Get an unsigned delta for a field, and put it into the protocol tree if
 845  * we're building a protocol tree.
 846  */
 847 static int
 848 get_unsigned_delta(tvbuff_t *tvb, int *offsetp, int hf, proto_tree *tree)
 849 {
 850   int offset = *offsetp;
 851   int len;
 852   guint16 del;
 853
 854   len = 1;
 855   del = tvb_get_guint8(tvb, offset++);
 856   if(del == ZERO){
 857     del = tvb_get_ntohs(tvb, offset);
 858     offset += 2;
 859     len += 2;
 860   }
 861   if(tree != NULL)
 862     proto_tree_add_uint(tree, hf, tvb, *offsetp, len, del);
 863   *offsetp = offset;
 864   return del;
 865 }
 866
 867 /*
 868  * Get a signed delta for a field, and put it into the protocol tree if
 869  * we're building a protocol tree.
 870  */
 871 static int
 872 get_signed_delta(tvbuff_t *tvb, int *offsetp, int hf, proto_tree *tree)
 873 {
 874   int offset = *offsetp;
 875   int len;
 876   gint16 del;
 877
 878   len = 1;
 879   del = tvb_get_guint8(tvb, offset++);
 880   if(del == ZERO){
 881     del = tvb_get_ntohs(tvb, offset);
 882     offset += 2;
 883     len += 2;
 884   }
 885   if(tree != NULL)
 886     proto_tree_add_int(tree, hf, tvb, *offsetp, len, del);
 887   *offsetp = offset;
 888   return del;
 889 }
 890
 891 /* Wrapper for in_cksum function */
 892 static guint16
 893 ip_csum(const guint8 * ptr, guint32 len)
 894 {
 895   vec_t cksum_vec[1];
 896
 897   cksum_vec[0].ptr = ptr;
 898   cksum_vec[0].len = len;
 899   return in_cksum(&cksum_vec[0], 1);
 900 }