epan/dissectors/packet-vj.c

   1 /* packet-vj.c
   2  * Routines for Van Jacobson header decompression.  (See RFC 1144.)
   3  *
   4  * $Id$
   5  *
   6  * Wireshark - Network traffic analyzer
   7  * By Gerald Combs <gerald@wireshark.org>
   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 wireshark.
  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 <epan/prefs.h>
  70 #include "packet-ppp.h"
  71 #include <epan/ppptypes.h>
  72 #include <epan/ipproto.h>
  73 #include <epan/in_cksum.h>
  74 #include <epan/emem.h>
  75
  76 /* Define relevant IP/TCP parameters */
  77 #define IP_FIELD_TOT_LEN      2 /* Total length field in IP hdr           */
  78 #define IP_FIELD_PROTOCOL     9 /* Protocol field byte in IP hdr          */
  79 #define IP_ADDR_SIZE          4 /* Size in bytes of IPv4 address          */
  80 #define IP_FIELD_SRC         12 /* Byte 12 in IP hdr - src address        */
  81 #define IP_FIELD_DST         16 /* Byte 16 in IP hdr - dst address        */
  82 #define IP_HDR_LEN           20 /* Minimum IP header length               */
  83 #define IP_HDR_LEN_MASK    0x0f /* Mask for header length field           */
  84 #define IP_MAX_OPT_LEN       44 /* Max length of IP options               */
  85 #define TCP_FIELD_HDR_LEN    12 /* Data offset field in TCP hdr           */
  86 #define TCP_HDR_LEN          20 /* Minimum TCP header length              */
  87 #define TCP_MAX_OPT_LEN      44 /* Max length of TCP options              */
  88 #define TCP_SIMUL_CONV_MAX  256 /* Max number of simul. TCP conversations */
  89 #define TCP_PUSH_BIT       0x08 /* TCP push bit                           */
  90 #define TCP_URG_BIT        0x20 /* TCP urgent bit                         */
  91
  92 /* Bits in first octet of compressed packet */
  93 /* flag bits for what changed in a packet */
  94 #define NEW_C           0x40 /* Connection number changed               */
  95 #define NEW_I           0x20 /* IP sequence number change by value != 1 */
  96 #define CHANGE_PUSH_BIT 0x10 /* TCP push bit set                        */
  97 #define NEW_S           0x08 /* Sequence number changed                 */
  98 #define NEW_A           0x04 /* Ack sequence number changed             */
  99 #define NEW_W           0x02 /* Window changed                          */
 100 #define NEW_U           0x01 /* Urgent pointer present                  */
 101
 102 /* reserved, special-case values of above */
 103 #define SPECIAL_I     (NEW_S|NEW_W|NEW_U)    /* echoed interactive traffic */
 104 #define SPECIAL_D     (NEW_S|NEW_A|NEW_W|NEW_U)/* unidirectional data */
 105 #define SPECIALS_MASK (NEW_S|NEW_A|NEW_W|NEW_U)
 106
 107 /* Function return values */
 108 #define VJ_OK           0
 109 #define VJ_ERROR       -1
 110
 111 /* Define for 0 */
 112 #define ZERO            0
 113
 114 /* VJ Mem Chunk defines */
 115 #define VJ_DATA_SIZE  128 /* Max IP hdr(64)+Max TCP hdr(64) */
 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 typedef struct {
 193         int     offset;                 /* uppermost bit is "can't dissect" flag */
 194         guint8  data[VJ_DATA_SIZE];
 195 } vj_header_t;
 196
 197 /* Function prototypes */
 198 static int get_unsigned_delta(tvbuff_t *tvb, int *offsetp, int hf,
 199                         proto_tree *tree);
 200 static int get_signed_delta(tvbuff_t *tvb, int *offsetp, int hf,
 201                         proto_tree *tree);
 202 static guint16 ip_csum(const guint8 *ptr, guint32 len);
 203 static slcompress *slhc_init(void);
 204 static gint vjc_process(tvbuff_t *src_tvb, packet_info *pinfo, proto_tree *tree,
 205                       slcompress *comp);
 206 static gint vjc_tvb_setup(tvbuff_t *src_tvb, tvbuff_t **dst_tvb,
 207                           packet_info *pinfo);
 208
 209 /* Dissector for VJ Uncompressed packets */
 210 static void
 211 dissect_vjuc(tvbuff_t *tvb, packet_info *pinfo, proto_tree * tree)
 212 {
 213   proto_item *ti;
 214   proto_tree *vj_tree     = NULL;
 215   slcompress *comp;
 216   int         i;
 217   gint        conn_index;
 218   cstate     *cs          = NULL;
 219   guint8      ihl;
 220   guint8      thl;
 221   guint8     *buffer;
 222   tvbuff_t   *next_tvb;
 223   gint        isize       = tvb_length(tvb);
 224   gint        ipsize;
 225
 226   col_set_str(pinfo->cinfo, COL_PROTOCOL, "PPP VJ");
 227
 228   if(tree != NULL) {
 229     ti = proto_tree_add_protocol_format(tree, proto_vj, tvb, 0, -1,
 230                                         "PPP VJ Compression: Uncompressed data");
 231     vj_tree = proto_item_add_subtree(ti, ett_vj);
 232   }
 233
 234   if(pinfo->p2p_dir == P2P_DIR_UNKNOWN) {
 235     /* Direction of the traffic unknown - can't update state */
 236     comp = NULL;
 237   } else {
 238     /* Get state for that direction */
 239     comp = rx_tx_state[pinfo->p2p_dir];
 240   }
 241
 242   /*
 243    * Check to make sure we can fetch the connection index.
 244    */
 245   if(!tvb_bytes_exist(tvb, IP_FIELD_PROTOCOL, 1)) {
 246     /*
 247      * We don't.  We can't even mark a connection as non-decompressable,
 248      * as we don't know which connection this is.  Mark them all as
 249      * non-decompressable.
 250      */
 251     col_set_str(pinfo->cinfo, COL_INFO, "VJ uncompressed TCP (not enough data available)");
 252     if(tree != NULL)
 253       call_dissector(data_handle, tvb, pinfo, tree);
 254     if(comp != NULL) {
 255       for(i = 0; i < TCP_SIMUL_CONV_MAX; i++)
 256         comp->rstate[i].flags |= SLF_TOSS;
 257     }
 258     return;
 259   }
 260
 261   /* Get connection index */
 262   conn_index = tvb_get_guint8(tvb, IP_FIELD_PROTOCOL);
 263   if(tree != NULL)
 264     proto_tree_add_uint(vj_tree, hf_vj_connection_number, tvb,
 265                         IP_FIELD_PROTOCOL, 1, conn_index);
 266
 267   /*
 268    * Update the current connection, and get a pointer to its state.
 269    */
 270   if(comp != NULL) {
 271     comp->recv_current = conn_index;
 272     cs = &comp->rstate[conn_index];
 273   }
 274
 275   /* Get the IP header length */
 276   ihl = tvb_get_guint8(tvb, 0) & IP_HDR_LEN_MASK;
 277   ihl <<= 2;
 278
 279   /* Check IP header length */
 280   if(ihl < IP_HDR_LEN) {
 281     if(check_col(pinfo->cinfo, COL_INFO)) {
 282       col_add_fstr(pinfo->cinfo, COL_INFO, "VJ uncompressed TCP (IP header length (%u) < %u)",
 283                    ihl, IP_HDR_LEN);
 284     }
 285     if(cs != NULL)
 286       cs->flags |= SLF_TOSS;
 287     return;
 288   }
 289
 290   /* Make sure we have the full IP header */
 291   if(isize < ihl) {
 292     col_set_str(pinfo->cinfo, COL_INFO, "VJ uncompressed TCP (not enough data available)");
 293     if(tree != NULL)
 294       call_dissector(data_handle, tvb, pinfo, tree);
 295     if(cs != NULL)
 296       cs->flags |= SLF_TOSS;
 297     return;
 298   }
 299
 300   col_set_str(pinfo->cinfo, COL_INFO, "VJ uncompressed TCP");
 301
 302   /*
 303    * Copy packet data to a buffer, and replace the connection index with
 304    * the protocol type (which is always TCP), to give the actual IP header.
 305    */
 306   buffer = tvb_memdup(tvb, 0, isize);
 307   buffer[IP_FIELD_PROTOCOL] = IP_PROTO_TCP;
 308
 309   /* Check IP checksum */
 310   if(ip_csum(buffer, ihl) != ZERO) {
 311     /*
 312      * Checksum invalid - don't update state, and don't decompress
 313      * any subsequent compressed packets in this direction.
 314      */
 315     if(cs != NULL)
 316       cs->flags |= SLF_TOSS;
 317     cs = NULL;  /* disable state updates */
 318   } else {
 319     /* Do we have the TCP header length in the tvbuff? */
 320     if(!tvb_bytes_exist(tvb, ihl + TCP_FIELD_HDR_LEN, 1)) {
 321       /* We don't, so we can't provide enough data for decompression */
 322       col_set_str(pinfo->cinfo, COL_INFO, "VJ uncompressed TCP (not enough data available)");
 323       if(cs != NULL)
 324         cs->flags |= SLF_TOSS;
 325       cs = NULL;  /* disable state updates */
 326     } else {
 327       /* Get the TCP header length */
 328       thl = tvb_get_guint8(tvb, ihl + TCP_FIELD_HDR_LEN);
 329       thl = ((thl & 0xf0) >> 4) * 4;
 330
 331       /* Check TCP header length */
 332       if(thl < TCP_HDR_LEN) {
 333         if(check_col(pinfo->cinfo, COL_INFO)) {
 334           col_add_fstr(pinfo->cinfo, COL_INFO, "VJ uncompressed TCP (TCP header length (%u) < %u)",
 335                        thl, TCP_HDR_LEN);
 336         }
 337         if(cs != NULL)
 338           cs->flags |= SLF_TOSS;
 339         cs = NULL;  /* disable state updates */
 340       } else {
 341         /* Make sure we have the full TCP header */
 342         if(isize < thl) {
 343           col_set_str(pinfo->cinfo, COL_INFO, "VJ uncompressed TCP (not enough data available)");
 344           if(cs != NULL)
 345             cs->flags |= SLF_TOSS;
 346           cs = NULL;  /* disable state updates */
 347         }
 348       }
 349     }
 350   }
 351
 352   /*
 353    * If packet seen for first time, update state if we have state and can
 354    * update it.
 355    */
 356   if(!pinfo->fd->flags.visited) {
 357     if(cs != NULL) {
 358       cs->flags &= ~SLF_TOSS;
 359       memcpy(&cs->cs_ip, &buffer[0], IP_HDR_LEN);
 360       memcpy(&cs->cs_tcp, &buffer[ihl], TCP_HDR_LEN);
 361       if(ihl > IP_HDR_LEN)
 362         memcpy(cs->cs_ipopt, &buffer[sizeof(iphdr_type)], ihl - IP_HDR_LEN);
 363       if(TCP_OFFSET(&(cs->cs_tcp)) > 5)
 364         memcpy(cs->cs_tcpopt, &buffer[ihl + sizeof(tcphdr_type)],
 365                    (TCP_OFFSET(&(cs->cs_tcp)) - 5) * 4);
 366     }
 367   }
 368
 369   /*
 370    * Set up tvbuff containing packet with protocol type.
 371    * Neither header checksum is recalculated.
 372    *
 373    * Use the length field from the IP header as the reported length;
 374    * use the minimum of that and the number of bytes we got from
 375    * the tvbuff as the actual length, just in case the tvbuff we were
 376    * handed includes part or all of the FCS (because the FCS preference
 377    * for the PPP dissector doesn't match the FCS size in this session).
 378    */
 379   ipsize = pntohs(&buffer[IP_FIELD_TOT_LEN]);
 380   if (ipsize < isize)
 381     isize = ipsize;
 382   next_tvb = tvb_new_child_real_data(tvb, buffer, isize, ipsize);
 383   tvb_set_free_cb(next_tvb, g_free);
 384   add_new_data_source(pinfo, next_tvb, "VJ Uncompressed");
 385
 386   /*
 387    * Call IP dissector.
 388    */
 389   call_dissector(ip_handle, next_tvb, pinfo, tree);
 390 }
 391
 392 /* Dissector for VJ Compressed packets */
 393 static void
 394 dissect_vjc(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree)
 395 {
 396   proto_item *ti;
 397   proto_tree *vj_tree     = NULL;
 398   tvbuff_t   *next_tvb = NULL;
 399   slcompress *comp     = NULL;
 400   gint        err      = VJ_ERROR;
 401
 402   col_set_str(pinfo->cinfo, COL_PROTOCOL, "PPP VJ");
 403
 404   if(tree != NULL) {
 405     ti = proto_tree_add_protocol_format(tree, proto_vj, tvb, 0, -1,
 406                                         "PPP VJ Compression: Compressed data");
 407     vj_tree = proto_item_add_subtree(ti, ett_vj);
 408   }
 409
 410   if(!ppp_vj_decomp || pinfo->p2p_dir == P2P_DIR_UNKNOWN) {
 411     /*
 412      * VJ decompression turned off, so we shouldn't decompress, or
 413      * direction of the traffic unknown, so we can't decompress.
 414      */
 415     comp = NULL;
 416   } else {
 417     /* Get state for that direction */
 418     comp = rx_tx_state[pinfo->p2p_dir];
 419   }
 420
 421   /* Process the compressed data header */
 422   if(vjc_process(tvb, pinfo, vj_tree, comp) == VJ_ERROR)
 423     return;
 424
 425   /* Decompression possible - set up tvb containing decompressed packet */
 426   err = vjc_tvb_setup(tvb, &next_tvb, pinfo);
 427   if(err == VJ_ERROR) {
 428     if(tree != NULL)
 429       call_dissector(data_handle, tvb, pinfo, vj_tree);
 430     return;
 431   }
 432
 433   /* No errors, so call IP dissector */
 434   call_dissector(ip_handle, next_tvb, pinfo, tree);
 435 }
 436
 437 /* Initialization function */
 438 static void
 439 vj_init(void)
 440 {
 441   gint i           = ZERO;
 442
 443   for(i = 0; i < RX_TX_STATE_COUNT; i++) {
 444     rx_tx_state[i] = slhc_init();
 445   }
 446   return;
 447 }
 448
 449 /* Initialization routine for VJ decompression */
 450 static slcompress *
 451 slhc_init(void)
 452 {
 453   slcompress *comp = se_alloc0(sizeof(slcompress));
 454   int         i;
 455
 456   /*
 457    * Initialize the state; there is no current connection, and
 458    * we have no header data for any of the connections, as we
 459    * haven't yet seen an uncompressed frame.
 460    */
 461   comp->recv_current = TCP_SIMUL_CONV_MAX - 1;
 462   for (i = 0; i < TCP_SIMUL_CONV_MAX; i++)
 463     comp->rstate[i].flags |= SLF_TOSS;
 464   return comp;
 465 }
 466
 467 /* Setup the decompressed packet tvb for VJ compressed packets */
 468 static gint
 469 vjc_tvb_setup(tvbuff_t *src_tvb,
 470               tvbuff_t **dst_tvb,
 471               packet_info *pinfo)
 472 {
 473   vj_header_t *hdr_buf;
 474   guint8       offset;
 475   guint8      *data_ptr;
 476   gint         hdr_len;
 477   gint         tot_len;
 478   gint         buf_len;
 479   guint8      *pbuf;
 480
 481   DISSECTOR_ASSERT(src_tvb);
 482
 483   /* Get decompressed header stored in fd protocol area */
 484   hdr_buf = p_get_proto_data(pinfo->fd, proto_vj);
 485   if(hdr_buf == NULL) {
 486     col_set_str(pinfo->cinfo, COL_INFO, "VJ compressed TCP (previous data bad or missing)");
 487     return VJ_ERROR;
 488   }
 489
 490   col_set_str(pinfo->cinfo, COL_INFO, "VJ compressed TCP");
 491
 492   /* Get the data offset in the tvbuff */
 493   offset  = hdr_buf->offset;
 494
 495   /* Copy header and form tvb */
 496   data_ptr = hdr_buf->data;
 497   hdr_len  = lo_nibble(data_ptr[0]) * 4;
 498   hdr_len += hi_nibble(data_ptr[hdr_len + 12]) * 4;
 499   buf_len  = tvb_length(src_tvb) + hdr_len - offset;
 500   pbuf     = g_malloc(buf_len);
 501   memcpy(pbuf, data_ptr, hdr_len);
 502   tvb_memcpy(src_tvb, pbuf + hdr_len, offset, buf_len - hdr_len);
 503   memcpy(&tot_len, data_ptr + 2, 2);
 504   *dst_tvb = tvb_new_child_real_data(src_tvb, pbuf, buf_len, g_ntohs(tot_len));
 505   tvb_set_free_cb(*dst_tvb, g_free);
 506   add_new_data_source(pinfo, *dst_tvb, "VJ Decompressed");
 507   return VJ_OK;
 508 }
 509
 510 /*
 511  * For VJ compressed packet:
 512  *
 513  *      check if it is malformed;
 514  *      dissect the relevant fields;
 515  *      update the decompressor state on the first pass.
 516  */
 517 static gint
 518 vjc_process(tvbuff_t *src_tvb, packet_info *pinfo, proto_tree *tree,
 519             slcompress *comp)
 520 {
 521   int            offset     = ZERO;
 522   int            i;
 523   gint           changes;
 524   proto_item    *ti;
 525   proto_tree    *changes_tree;
 526   guint8         conn_index;
 527   cstate        *cs         = NULL;
 528   iphdr_type    *ip         = NULL;
 529   tcphdr_type   *thp        = NULL;
 530   guint16        tcp_cksum;
 531   gint           hdrlen     = ZERO;
 532   guint16        word;
 533   int            delta;
 534   gint           len;
 535   vj_header_t   *buf_hdr;
 536   guint8        *data_ptr;
 537
 538   if(tvb_length(src_tvb) < 3){
 539     /*
 540      * We don't even have enough data for the change byte, so we can't
 541      * determine which connection this is; mark all connections as
 542      * non-decompressible.
 543      */
 544     col_set_str(pinfo->cinfo, COL_INFO, "VJ compressed TCP (not enough data available)");
 545     if(tree != NULL)
 546       call_dissector(data_handle, src_tvb, pinfo, tree);
 547     if(comp != NULL) {
 548       for(i = 0; i < TCP_SIMUL_CONV_MAX; i++)
 549         comp->rstate[i].flags |= SLF_TOSS;
 550     }
 551     return VJ_ERROR;
 552   }
 553
 554   /* Read the change byte */
 555   changes = tvb_get_guint8(src_tvb, offset);
 556   if(tree != NULL) {
 557     switch (changes & SPECIALS_MASK) {
 558
 559     case SPECIAL_I:
 560       ti = proto_tree_add_uint_format(tree, hf_vj_change_mask, src_tvb,
 561                                       offset, 1, changes,
 562                                       "Change mask: 0x%02x (echoed interactive traffic)",
 563                                       changes);
 564       break;
 565
 566     case SPECIAL_D:
 567       ti = proto_tree_add_uint_format(tree, hf_vj_change_mask, src_tvb,
 568                                       offset, 1, changes,
 569                                       "Change mask: 0x%02x (unidirectional data)",
 570                                       changes);
 571       break;
 572
 573     default:
 574       /*
 575        * XXX - summarize bits?
 576        */
 577       ti = proto_tree_add_uint_format(tree, hf_vj_change_mask, src_tvb,
 578                                       offset, 1, changes,
 579                                       "Change mask: 0x%02x", changes);
 580       break;
 581     }
 582     changes_tree = proto_item_add_subtree(ti, ett_vj_changes);
 583     proto_tree_add_boolean(changes_tree, hf_vj_change_mask_c, src_tvb,
 584                            offset, 1, changes);
 585     proto_tree_add_boolean(changes_tree, hf_vj_change_mask_i, src_tvb,
 586                            offset, 1, changes);
 587     proto_tree_add_boolean(changes_tree, hf_vj_change_mask_p, src_tvb,
 588                            offset, 1, changes);
 589     proto_tree_add_boolean(changes_tree, hf_vj_change_mask_s, src_tvb,
 590                            offset, 1, changes);
 591     proto_tree_add_boolean(changes_tree, hf_vj_change_mask_a, src_tvb,
 592                            offset, 1, changes);
 593     proto_tree_add_boolean(changes_tree, hf_vj_change_mask_w, src_tvb,
 594                            offset, 1, changes);
 595     proto_tree_add_boolean(changes_tree, hf_vj_change_mask_u, src_tvb,
 596                            offset, 1, changes);
 597   }
 598   offset++;
 599
 600   if(changes & NEW_C){    /* Read conn index */
 601     conn_index = tvb_get_guint8(src_tvb, offset);
 602     if(tree != NULL)
 603       proto_tree_add_uint(tree, hf_vj_connection_number, src_tvb, offset, 1,
 604                           conn_index);
 605     offset++;
 606     if(comp != NULL)
 607       comp->recv_current = conn_index;
 608   }
 609
 610   if(!pinfo->fd->flags.visited) {
 611     /*
 612      * This is the first time this frame has been seen, so we need
 613      * state information to decompress it.  If that information isn't
 614      * available, don't use the state information, and don't update it,
 615      * either.
 616      */
 617     if(comp != NULL && !(comp->rstate[comp->recv_current].flags & SLF_TOSS)) {
 618       cs = &comp->rstate[comp->recv_current];
 619       thp = &cs->cs_tcp;
 620       ip = &cs->cs_ip;
 621     }
 622   }
 623
 624   /* Build TCP and IP headers */
 625   tcp_cksum = tvb_get_ntohs(src_tvb, offset);
 626   if(tree != NULL)
 627     proto_tree_add_uint(tree, hf_vj_tcp_cksum, src_tvb, offset, 2, tcp_cksum);
 628   if(cs != NULL) {
 629     hdrlen = lo_nibble(ip->ihl_version) * 4 + TCP_OFFSET(thp) * 4;
 630     thp->cksum = g_htons(tcp_cksum);
 631   }
 632   offset += 2;
 633   if(cs != NULL) {
 634     if(changes & CHANGE_PUSH_BIT)
 635       thp->flags |= TCP_PUSH_BIT;
 636     else
 637       thp->flags &= ~TCP_PUSH_BIT;
 638   }
 639
 640   /* Deal with special cases and normal deltas */
 641   switch(changes & SPECIALS_MASK){
 642     guint32 tmp;
 643     case SPECIAL_I:                   /* Echoed terminal traffic */
 644       if(cs != NULL) {
 645         word = g_ntohs(ip->tot_len) - hdrlen;
 646         tmp = g_ntohl(thp->ack_seq) + word;
 647         thp->ack_seq = g_htonl(tmp);
 648         tmp = g_ntohl(thp->seq) + word;
 649         thp->seq = g_htonl(tmp);
 650       }
 651       break;
 652     case SPECIAL_D:                   /* Unidirectional data */
 653       if(cs != NULL) {
 654         tmp = g_ntohl(thp->seq) + g_ntohs(ip->tot_len) - hdrlen;
 655         thp->seq = g_htonl(tmp);
 656       }
 657       break;
 658     default:
 659       if(changes & NEW_U){
 660         delta = get_unsigned_delta(src_tvb, &offset, hf_vj_urp, tree);
 661         if(cs != NULL) {
 662           thp->urg_ptr = delta;
 663           thp->flags |= TCP_URG_BIT;
 664         }
 665       } else {
 666         if(cs != NULL)
 667           thp->flags &= ~TCP_URG_BIT;
 668       }
 669       if(changes & NEW_W) {
 670         delta = get_signed_delta(src_tvb, &offset, hf_vj_win_delta, tree);
 671         if(cs != NULL) {
 672           tmp = g_ntohs(thp->window) + delta;
 673           thp->window = g_htons(tmp);
 674         }
 675       }
 676       if(changes & NEW_A) {
 677         delta = get_unsigned_delta(src_tvb, &offset, hf_vj_ack_delta, tree);
 678         if(cs != NULL) {
 679           tmp = g_ntohl(thp->ack_seq) + delta;
 680           thp->ack_seq = g_htonl(tmp);
 681         }
 682       }
 683       if(changes & NEW_S) {
 684         delta = get_unsigned_delta(src_tvb, &offset, hf_vj_seq_delta, tree);
 685         if(cs != NULL) {
 686           tmp = g_ntohl(thp->seq) + delta;
 687           thp->seq = g_htonl(tmp);
 688         }
 689       }
 690       break;
 691   }
 692   if(changes & NEW_I)
 693     delta = get_unsigned_delta(src_tvb, &offset, hf_vj_ip_id_delta, tree);
 694   else
 695     delta = 1;
 696   if(cs != NULL) {
 697     guint32 tmp;
 698     tmp = g_ntohs(ip->id) + delta;
 699     ip->id = g_htons(tmp);
 700   }
 701
 702   /* Compute IP packet length and the buffer length needed */
 703   len = tvb_reported_length_remaining(src_tvb, offset);
 704   if(len < ZERO) {
 705     /*
 706      * This shouldn't happen, as we *were* able to fetch stuff right before
 707      * offset.
 708      */
 709     col_set_str(pinfo->cinfo, COL_INFO, "VJ compressed TCP (not enough data available)");
 710     if(cs != NULL)
 711       cs->flags |= SLF_TOSS;
 712     return VJ_ERROR;
 713   }
 714
 715   /* Show the TCP payload */
 716   if(tree != NULL && tvb_offset_exists(src_tvb, offset))
 717     proto_tree_add_text(tree, src_tvb, offset, -1, "TCP payload");
 718
 719   /* Nothing more to do if we don't have any compression state */
 720   if(comp == NULL) {
 721     /* Direction of the traffic unknown - can't decompress */
 722     col_set_str(pinfo->cinfo, COL_INFO, "VJ compressed TCP (direction unknown)");
 723     return VJ_ERROR;
 724   }
 725
 726   if((cs != NULL) && (!pinfo->fd->flags.visited)) {
 727     len += hdrlen;
 728     ip->tot_len = g_htons(len);
 729     /* Compute IP check sum */
 730     ip->cksum = ZERO;
 731     ip->cksum = ip_csum((guint8 *)ip, lo_nibble(ip->ihl_version) * 4);
 732
 733     /* Store the reconstructed header in frame data area */
 734     buf_hdr = se_alloc(sizeof (vj_header_t));
 735     buf_hdr->offset = offset;  /* Offset in tvbuff is also stored */
 736     data_ptr = buf_hdr->data;
 737     memcpy(data_ptr, ip, IP_HDR_LEN);
 738     data_ptr += IP_HDR_LEN;
 739     if(lo_nibble(ip->ihl_version) > 5) {
 740       memcpy(data_ptr, cs->cs_ipopt, (lo_nibble(ip->ihl_version) - 5) * 4);
 741       data_ptr += (lo_nibble(ip->ihl_version) - 5) * 4;
 742     }
 743     memcpy(data_ptr, thp, TCP_HDR_LEN);
 744     data_ptr += TCP_HDR_LEN;
 745     if(TCP_OFFSET(thp) > 5)
 746       memcpy(data_ptr, cs->cs_tcpopt, (TCP_OFFSET(thp) - 5) * 4);
 747     p_add_proto_data(pinfo->fd, proto_vj, buf_hdr);
 748   }
 749
 750   return VJ_OK;
 751 }
 752
 753 /*
 754  * Get an unsigned delta for a field, and put it into the protocol tree if
 755  * we're building a protocol tree.
 756  */
 757 static int
 758 get_unsigned_delta(tvbuff_t *tvb, int *offsetp, int hf, proto_tree *tree)
 759 {
 760   int offset = *offsetp;
 761   int len;
 762   guint16 del;
 763
 764   len = 1;
 765   del = tvb_get_guint8(tvb, offset++);
 766   if(del == ZERO){
 767     del = tvb_get_ntohs(tvb, offset);
 768     offset += 2;
 769     len += 2;
 770   }
 771   if(tree != NULL)
 772     proto_tree_add_uint(tree, hf, tvb, *offsetp, len, del);
 773   *offsetp = offset;
 774   return del;
 775 }
 776
 777 /*
 778  * Get a signed delta for a field, and put it into the protocol tree if
 779  * we're building a protocol tree.
 780  */
 781 static int
 782 get_signed_delta(tvbuff_t *tvb, int *offsetp, int hf, proto_tree *tree)
 783 {
 784   int offset = *offsetp;
 785   int len;
 786   gint16 del;
 787
 788   len = 1;
 789   del = tvb_get_guint8(tvb, offset++);
 790   if(del == ZERO){
 791     del = tvb_get_ntohs(tvb, offset);
 792     offset += 2;
 793     len += 2;
 794   }
 795   if(tree != NULL)
 796     proto_tree_add_int(tree, hf, tvb, *offsetp, len, del);
 797   *offsetp = offset;
 798   return del;
 799 }
 800
 801 /* Wrapper for in_cksum function */
 802 static guint16
 803 ip_csum(const guint8 * ptr, guint32 len)
 804 {
 805   vec_t cksum_vec[1];
 806
 807   cksum_vec[0].ptr = ptr;
 808   cksum_vec[0].len = len;
 809   return in_cksum(&cksum_vec[0], 1);
 810 }
 811
 812 /* Registration functions for dissectors */
 813 void
 814 proto_register_vj(void)
 815 {
 816   static hf_register_info hf[] = {
 817     { &hf_vj_change_mask,
 818       { "Change mask",  "vj.change_mask",       FT_UINT8, BASE_HEX,
 819         NULL, 0x0, NULL, HFILL }},
 820     { &hf_vj_change_mask_c,
 821       { "Connection changed",           "vj.change_mask_c",     FT_BOOLEAN, 8,
 822         NULL, NEW_C, "Connection number changed", HFILL }},
 823     { &hf_vj_change_mask_i,
 824       { "IP ID change != 1",            "vj.change_mask_i",     FT_BOOLEAN, 8,
 825         NULL, NEW_I, "IP ID changed by a value other than 1", HFILL }},
 826     { &hf_vj_change_mask_p,
 827       { "Push bit set",                 "vj.change_mask_p",     FT_BOOLEAN, 8,
 828         NULL, CHANGE_PUSH_BIT, "TCP PSH flag set", HFILL }},
 829     { &hf_vj_change_mask_s,
 830       { "Sequence number changed",      "vj.change_mask_s",     FT_BOOLEAN, 8,
 831         NULL, NEW_S, NULL, HFILL }},
 832     { &hf_vj_change_mask_a,
 833       { "Ack number changed",           "vj.change_mask_a",     FT_BOOLEAN, 8,
 834         NULL, NEW_A, "Acknowledgement sequence number changed", HFILL }},
 835     { &hf_vj_change_mask_w,
 836       { "Window changed",               "vj.change_mask_w",     FT_BOOLEAN, 8,
 837         NULL, NEW_W, "TCP window changed", HFILL }},
 838     { &hf_vj_change_mask_u,
 839       { "Urgent pointer set",           "vj.change_mask_u",     FT_BOOLEAN, 8,
 840         NULL, NEW_U, NULL, HFILL }},
 841     { &hf_vj_connection_number,
 842       { "Connection number",    "vj.connection_number", FT_UINT8, BASE_DEC,
 843         NULL, 0x0, NULL, HFILL }},
 844     { &hf_vj_tcp_cksum,
 845       { "TCP checksum",                 "vj.tcp_cksum", FT_UINT16, BASE_HEX,
 846         NULL, 0x0, NULL, HFILL }},
 847     { &hf_vj_urp,
 848       { "Urgent pointer",               "vj.urp",       FT_UINT16, BASE_DEC,
 849         NULL, 0x0, NULL, HFILL }},
 850     { &hf_vj_win_delta,
 851       { "Window delta",                 "vj.win_delta", FT_INT16, BASE_DEC,
 852         NULL, 0x0, "Delta for window", HFILL }},
 853     { &hf_vj_ack_delta,
 854       { "Ack delta",                    "vj.ack_delta", FT_UINT16, BASE_DEC,
 855         NULL, 0x0, "Delta for acknowledgment sequence number", HFILL }},
 856     { &hf_vj_seq_delta,
 857       { "Sequence delta",               "vj.seq_delta", FT_UINT16, BASE_DEC,
 858         NULL, 0x0, "Delta for sequence number", HFILL }},
 859     { &hf_vj_ip_id_delta,
 860       { "IP ID delta",                  "vj.ip_id_delta",       FT_UINT16, BASE_DEC,
 861         NULL, 0x0, "Delta for IP ID", HFILL }},
 862   };
 863   static gint *ett[] = {
 864     &ett_vj,
 865     &ett_vj_changes,
 866   };
 867
 868   proto_vj = proto_register_protocol("PPP VJ Compression", "PPP VJ", "vj");
 869   proto_register_field_array(proto_vj, hf, array_length(hf));
 870   proto_register_subtree_array(ett, array_length(ett));
 871   register_init_routine(&vj_init);
 872 }
 873
 874 void
 875 proto_reg_handoff_vj(void)
 876 {
 877   dissector_handle_t vjc_handle;
 878   dissector_handle_t vjuc_handle;
 879
 880   vjc_handle = create_dissector_handle(dissect_vjc, proto_vj);
 881   dissector_add("ppp.protocol", PPP_VJC_COMP, vjc_handle);
 882
 883   vjuc_handle = create_dissector_handle(dissect_vjuc, proto_vj);
 884   dissector_add("ppp.protocol", PPP_VJC_UNCOMP, vjuc_handle);
 885
 886   ip_handle = find_dissector("ip");
 887   data_handle = find_dissector("data");
 888 }
 889