2 * Routines for Wellfleet Compression frame disassembly
3 * Copyright 2001, Jeffrey C. Foster <jfoste@woodward.com>
5 * $Id: packet-wcp.c,v 1.8 2001/03/30 10:51:50 guy Exp $
7 * Ethereal - Network traffic analyzer
8 * By Gerald Combs <gerald@zing.org>
12 * This program is free software; you can redistribute it and/or
13 * modify it under the terms of the GNU General Public License
14 * as published by the Free Software Foundation; either version 2
15 * of the License, or (at your option) any later version.
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
22 * You should have received a copy of the GNU General Public License
23 * along with this program; if not, write to the Free Software
24 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
27 * Add preference to allow/disallow decompression
28 * Calculate and verify check byte (last byte), if only we knew how!
29 * Handle Wellfleet compression over PPP links.
30 * - This will require changing the sub-dissector call
31 * routine to determine if layer 2 is frame relay or
32 * or PPP and different sub-dissector routines for each.
34 * Based upon information in the Nortel TCL based Pcaptap code.
35 *http://www.mynetworkforum.com/tools/PCAPTAP/pcaptap-Win32-3.00.exe
38 *http://www.rasip.fer.hr/research/compress/algorithms/fund/lz/lzss.html
42 * Wellfleet compression is a variation on LZSS encoding.
44 * Compression is done by keeping a sliding window of previous
45 * data transmited. The sender will use a pattern match to
46 * encode repeated data as a data pointer field. Then a stream
47 * of pointers and actual data bytes. The pointer values include
48 * an offset to previous data in the stream and the length of the
51 * The data pattern matching is done on the octects.
53 * The data is encoded as 8 field blocks with a compression flag
54 * byte at the beginning. If the bit is set in the compression
55 * flag, then that field has a compression field. If it isn't set
56 * then the byte is raw data.
58 * The compression field is either 2 or 3 bytes long. The length
59 * is determined by the length of the matching data, for short
60 * matches the match length is encoded in the high nibble of the
61 * first byte. Otherwise the third byte of the field contains
66 * High order nibble of the offset
69 * 1 = length is in 3rd byte
70 * 2-F = length of matching data - 1
73 * Lower byte of the source offset.
76 * Length of match - 1 if First byte upper nibble = 1, otherwise
77 * this byte isn't added to data stream.
80 * Uncompressed data (hex): 11 22 22 22 22 33 44 55 66 77
84 * Flag bits: 0x20 (third field is compressed)
85 * Data: 11 22 20 00 33 44 55
87 * raw data ------+--+ / /
88 * (Comp length - 1)<<4+ /
89 * Data offset ----------+
91 * Output data (hex): 20 11 22 20 00 33 44 55 66 77
93 * In this example the copy src is one byte behind the copy destination
94 * so if appears as if output is being loaded with the source byte.
104 #ifdef HAVE_SYS_TYPES_H
105 # include <sys/types.h>
112 #include "packet-frame.h"
113 #include "packet-fr.h"
114 #include "conversation.h"
118 #define MAX_WIN_BUF_LEN 0x7fff /* storage size for decompressed data */
119 #define MAX_WCP_BUF_LEN 2048 /* storage size for decompressed data */
120 #define FROM_DCE 0x80 /* for direction setting */
125 guint8 buffer[MAX_WIN_BUF_LEN];
129 /*XXX do I really want the length in here */
133 guint8 buffer[MAX_WCP_BUF_LEN];
138 #define wcp_win_init_count 4
139 #define wcp_packet_init_count 10
141 #define wcp_win_length (sizeof(wcp_window_t))
142 #define wcp_packet_length (sizeof(wcp_pdata_t))
144 static GMemChunk *wcp_window = NULL;
145 static GMemChunk *wcp_pdata = NULL;
147 extern dissector_table_t fr_subdissector_table;
149 static int proto_wcp = -1;
150 static int hf_wcp_cmd = -1;
151 static int hf_wcp_ext_cmd = -1;
152 static int hf_wcp_seq = -1;
153 static int hf_wcp_chksum = -1;
154 static int hf_wcp_tid = -1;
155 static int hf_wcp_rev = -1;
156 static int hf_wcp_init = -1;
157 static int hf_wcp_seq_size = -1;
158 static int hf_wcp_alg = -1;
159 static int hf_wcp_alg_cnt = -1;
160 static int hf_wcp_alg_a = -1;
161 static int hf_wcp_alg_b = -1;
162 static int hf_wcp_alg_c = -1;
163 static int hf_wcp_alg_d = -1;
164 static int hf_wcp_rexmit = -1;
166 static int hf_wcp_hist_size = -1;
167 static int hf_wcp_ppc = -1;
168 static int hf_wcp_pib = -1;
170 static int hf_wcp_comp_bits = -1;
171 static int hf_wcp_comp_marker = -1;
172 static int hf_wcp_short_len = -1;
173 static int hf_wcp_long_len = -1;
174 static int hf_wcp_short_run = -1;
175 static int hf_wcp_long_run = -1;
176 static int hf_wcp_offset = -1;
178 static gint ett_wcp = -1;
179 static gint ett_wcp_field = -1;
182 * Bits in the address field.
184 #define WCP_CMD 0xf0 /* WCP Command */
185 #define WCP_EXT_CMD 0x0f /* WCP Extended Command */
186 #define WCP_SEQ 0x0fff /* WCP Sequence number */
187 #define WCP_OFFSET_MASK 0x0fff /* WCP Pattern source offset */
189 #define PPC_COMPRESSED_IND 0x0
190 #define PPC_UNCOMPRESSED_IND 0x1
191 #define PPC_TPPC_COMPRESSED_IND 0x2
192 #define PPC_TPPC_UNCOMPRESSED_IND 0x3
193 #define CONNECT_REQ 0x4
194 #define CONNECT_ACK 0x5
195 #define CONNECT_NAK 0x6
196 #define DISCONNECT_REQ 0x7
197 #define DISCONNECT_ACK 0x8
200 #define RESET_REQ 0xb
201 #define RESET_ACK 0xc
202 #define REXMIT_NAK 0xd
205 static const value_string cmd_string[] = {
206 {0, "Compressed Data"},
207 {1, "Uncompressed Data"},
212 static const value_string ext_cmd_string[] = {
213 {0, "Per Packet Compression"},
224 static tvbuff_t *wcp_uncompress( tvbuff_t *src_tvb, int offset, packet_info *pinfo, proto_tree *tree);
225 static wcp_window_t *get_wcp_window_ptr( packet_info *pinfo);
228 dissect_wcp_con_req(tvbuff_t *tvb, int offset, packet_info *pinfo, proto_tree *tree) {
230 /* WCP connector request message */
232 guint alg_cnt = tvb_get_guint8(tvb, 5);
234 proto_tree_add_uint(tree, hf_wcp_tid, tvb, offset, 2, tvb_get_ntohs(tvb, offset));
235 proto_tree_add_uint(tree, hf_wcp_rev, tvb, offset + 2, 1, tvb_get_guint8(tvb, offset + 2));
236 proto_tree_add_uint(tree, hf_wcp_init, tvb, offset + 3, 1, tvb_get_guint8(tvb, offset + 3));
237 proto_tree_add_uint(tree, hf_wcp_seq_size, tvb, offset + 4, 1, tvb_get_guint8(tvb, offset + 4));
238 proto_tree_add_uint(tree, hf_wcp_alg_cnt, tvb, offset + 5, 1, alg_cnt);
239 proto_tree_add_uint(tree, hf_wcp_alg_a, tvb, offset + 6, 1, tvb_get_guint8(tvb, offset + 6));
241 proto_tree_add_uint(tree, hf_wcp_alg_b, tvb, offset + 7, 1, tvb_get_guint8(tvb, offset + 7));
243 proto_tree_add_uint(tree, hf_wcp_alg_c, tvb, offset + 8, 1, tvb_get_guint8(tvb, offset + 8));
245 proto_tree_add_uint(tree, hf_wcp_alg_d, tvb, offset + 9, 1, tvb_get_guint8(tvb, offset + 9));
249 dissect_wcp_con_ack( tvbuff_t *tvb, int offset, packet_info *pinfo, proto_tree *tree){
251 /* WCP connector ack message */
253 proto_tree_add_uint(tree, hf_wcp_tid, tvb, offset, 2, tvb_get_ntohs(tvb, offset));
254 proto_tree_add_uint(tree, hf_wcp_rev, tvb, offset + 2, 1, tvb_get_guint8(tvb, offset + 2));
255 proto_tree_add_uint(tree, hf_wcp_seq_size, tvb, offset + 3, 1, tvb_get_guint8(tvb, offset + 3));
256 proto_tree_add_uint(tree, hf_wcp_alg, tvb, offset + 4, 1, tvb_get_guint8(tvb, offset + 4));
260 dissect_wcp_init( tvbuff_t *tvb, int offset, packet_info *pinfo, proto_tree *tree){
262 /* WCP Initiate Request/Ack message */
264 proto_tree_add_uint(tree, hf_wcp_tid, tvb, offset, 2, tvb_get_ntohs(tvb, offset));
265 proto_tree_add_uint(tree, hf_wcp_rev, tvb, offset + 2, 1, tvb_get_guint8(tvb, offset + 2));
266 proto_tree_add_uint(tree, hf_wcp_hist_size, tvb, offset + 3, 1, tvb_get_guint8(tvb, offset + 3));
267 proto_tree_add_uint(tree, hf_wcp_ppc, tvb, offset + 4, 1, tvb_get_guint8(tvb, offset + 4));
268 proto_tree_add_uint(tree, hf_wcp_pib, tvb, offset + 5, 1, tvb_get_guint8(tvb, offset + 5));
273 dissect_wcp_reset( tvbuff_t *tvb, int offset, packet_info *pinfo, proto_tree *tree){
275 /* Process WCP Reset Request/Ack message */
277 proto_tree_add_uint(tree, hf_wcp_tid, tvb, offset, 2, tvb_get_ntohs(tvb, offset));
281 void wcp_save_data( tvbuff_t *tvb, packet_info *pinfo){
283 wcp_window_t *buf_ptr = 0;
286 /* discard first 2 bytes, header and last byte (check byte) */
287 len = tvb_reported_length( tvb)-3;
288 buf_ptr = get_wcp_window_ptr( pinfo);
290 if (( buf_ptr->buf_cur + len) <= (buf_ptr->buffer + MAX_WIN_BUF_LEN)){
291 tvb_memcpy( tvb, buf_ptr->buf_cur, 2, len);
292 buf_ptr->buf_cur = buf_ptr->buf_cur + len;
295 guint8 *buf_end = buf_ptr->buffer + MAX_WIN_BUF_LEN;
296 tvb_memcpy( tvb, buf_ptr->buf_cur, 2, buf_end - buf_ptr->buf_cur);
297 tvb_memcpy( tvb, buf_ptr->buffer, buf_end - buf_ptr->buf_cur-2,
298 len - (int)(buf_end - buf_ptr->buf_cur));
299 buf_ptr->buf_cur = buf_ptr->buf_cur + len - MAX_WIN_BUF_LEN;
305 void dissect_wcp( tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree) {
307 proto_tree *wcp_tree;
310 guint16 temp, cmd, ext_cmd, seq;
313 pinfo->current_proto = "WCP";
315 if (check_col(pinfo->fd, COL_PROTOCOL))
316 col_set_str(pinfo->fd, COL_PROTOCOL, "WCP");
317 if (check_col(pinfo->fd, COL_INFO))
318 col_clear(pinfo->fd, COL_INFO);
320 temp =tvb_get_ntohs(tvb, 0);
322 cmd = (temp & 0xf000) >> 12;
323 ext_cmd = (temp & 0x0f00) >> 8;
332 /*XXX should test seq to be sure it the last + 1 !! */
334 if (check_col(pinfo->fd, COL_INFO)){
335 col_add_str(pinfo->fd, COL_INFO, val_to_str(cmd, cmd_string, "Unknown"));
337 col_append_fstr(pinfo->fd, COL_INFO, ", %s",
338 val_to_str(ext_cmd, ext_cmd_string, "Unknown"));
342 ti = proto_tree_add_item(tree, proto_wcp, tvb, 0, wcp_header_len, FALSE);
344 wcp_tree = proto_item_add_subtree(ti, ett_wcp);
346 proto_tree_add_uint(wcp_tree, hf_wcp_cmd, tvb, 0, 1, tvb_get_guint8( tvb, 0));
348 proto_tree_add_uint(wcp_tree, hf_wcp_ext_cmd, tvb, 1, 1,
349 tvb_get_guint8( tvb, 0));
352 dissect_wcp_con_req( tvb, 1, pinfo, wcp_tree);
356 dissect_wcp_con_ack( tvb, 1, pinfo, wcp_tree);
360 dissect_wcp_init( tvb, 1, pinfo, wcp_tree);
364 dissect_wcp_reset( tvb, 1, pinfo, wcp_tree);
370 proto_tree_add_uint(wcp_tree, hf_wcp_seq, tvb, 0, 2, seq);
379 if ( cmd != 1 && cmd != 0 && !(cmd == 0xf && ext_cmd == 0))
382 if ( cmd == 1) { /* uncompressed data */
383 if ( !pinfo->fd->flags.visited){ /* if first pass */
384 wcp_save_data( tvb, pinfo);
386 next_tvb = tvb_new_subset(tvb, wcp_header_len, -1, -1);
388 else { /* cmd == 0 || (cmd == 0xf && ext_cmd == 0) */
390 next_tvb = wcp_uncompress( tvb, wcp_header_len, pinfo, wcp_tree);
393 proto_tree_add_protocol_format(tree, proto_malformed, tvb, 0, 0,
394 "[Malformed Frame: Bad WCP compressed data]" );
399 if ( tree) /* add the check byte */
400 proto_tree_add_uint(wcp_tree, hf_wcp_chksum, tvb,
401 tvb_reported_length( tvb)-1, 1,
402 tvb_get_guint8( tvb, tvb_reported_length(tvb)-1));
404 dissect_fr_uncompressed(next_tvb, pinfo, tree);
410 guint8 *decompressed_entry( guint8 *src, guint8 *dst, int *len, guint8 * buf_start, guint8 *buf_end){
412 /* do the decompression for one field */
414 guint16 data_offset, data_cnt;
417 data_offset = (*(src++) & 0xf) << 8; /* get high byte */
418 data_offset += *(src++); /* add next byte */
420 if (( tmp & 0xf0) == 0x10){ /* 2 byte count */
424 }else { /* one byte count */
430 src = (dst - 1 - data_offset);
431 if ( src < buf_start)
432 src += MAX_WIN_BUF_LEN;
435 /*XXX could do some fancy memory moves, later if speed is problem */
439 if ( ++(*len) >MAX_WCP_BUF_LEN){
440 printf("decomp failed, len = %d\n", *len);
442 return NULL; /* end of buffer error */
444 if ( dst++ == buf_end)
446 if ( src++ == buf_end)
455 wcp_window_t *get_wcp_window_ptr( packet_info *pinfo){
457 /* find the conversation for this side of the DLCI, create one if needed */
458 /* and return the wcp_window data structure pointer */
460 conversation_t *conv = find_conversation( &pinfo->dl_src, &pinfo->dl_src, PT_NONE,
461 ((pinfo->pseudo_header->x25.flags & FROM_DCE)? 1:0),
462 ((pinfo->pseudo_header->x25.flags & FROM_DCE)? 1:0), 0);
466 conv = conversation_new( &pinfo->dl_src, &pinfo->dl_src, PT_NONE,
467 ((pinfo->pseudo_header->x25.flags & FROM_DCE)? 1:0),
468 ((pinfo->pseudo_header->x25.flags & FROM_DCE)? 1:0),
469 g_mem_chunk_alloc( wcp_window), 0);
471 ((wcp_window_t*)conv->data)->buf_cur = ((wcp_window_t*)conv->data)->buffer;
474 return (wcp_window_t*)conv->data;
478 static tvbuff_t *wcp_uncompress( tvbuff_t *src_tvb, int offset, packet_info *pinfo, proto_tree *tree) {
480 /* do the packet data uncompression and load it into the dst buffer */
482 proto_tree *sub_tree;
486 int cnt = tvb_reported_length( src_tvb)-1; /* don't include check byte */
488 guint8 *buf = 0, *dst, *src, *buf_start, *buf_end, *tmp, comp_flag_bits = 0;
489 guint8 src_buf[ MAX_WCP_BUF_LEN];
490 tvbuff_t *volatile tvb = 0;
491 wcp_window_t *buf_ptr = 0;
492 wcp_pdata_t *volatile pdata_ptr;
494 buf_ptr = get_wcp_window_ptr( pinfo);
496 buf_start = buf_ptr->buffer;
497 buf_end = buf_start + MAX_WIN_BUF_LEN;
498 tmp = buf_ptr->buf_cur;
500 src = tvb_memcpy(src_tvb, src_buf, offset, cnt - offset);
501 dst = buf_ptr->buf_cur;
503 while( offset++ < cnt){
506 if ( comp_flag_bits & 0x80){ /* if this is a compressed entry */
508 if ( !pinfo->fd->flags.visited){ /* if first pass */
509 dst = decompressed_entry( src, dst, &len, buf_start, buf_end);
511 if ((*src & 0xf0) == 0x10){
513 ti = proto_tree_add_item( tree, hf_wcp_long_run, src_tvb,
515 sub_tree = proto_item_add_subtree(ti, ett_wcp_field);
516 proto_tree_add_uint(sub_tree, hf_wcp_offset, src_tvb,
517 offset-1, 2, pntohs(src));
519 proto_tree_add_item( sub_tree, hf_wcp_long_len, src_tvb,
520 offset+1, 1, pntohs(src));
526 ti = proto_tree_add_item( tree, hf_wcp_short_run, src_tvb,
527 offset - 1, 2, *src);
528 sub_tree = proto_item_add_subtree(ti, ett_wcp_field);
529 proto_tree_add_item( sub_tree, hf_wcp_short_len, src_tvb,
531 proto_tree_add_uint(sub_tree, hf_wcp_offset, src_tvb,
532 offset-1, 2, pntohs(src));
538 if ( !pinfo->fd->flags.visited){ /* if first pass */
540 if ( dst++ == buf_end)
548 if ( len >MAX_WCP_BUF_LEN){
552 comp_flag_bits <<= 1;
554 }else { /* compressed data flag */
556 comp_flag_bits = *src++;
558 proto_tree_add_uint( tree, hf_wcp_comp_bits, src_tvb, offset-1, 1,
565 if ( pinfo->fd->flags.visited){ /* if not first pass */
566 /* get uncompressed data */
567 pdata_ptr = p_get_proto_data( pinfo->fd, proto_wcp);
569 if ( !pdata_ptr) /* exit if no data */
571 len = pdata_ptr->len;
574 /* save the new data as per packet data */
575 pdata_ptr = g_mem_chunk_alloc( wcp_pdata);
576 memcpy( &pdata_ptr->buffer, buf_ptr->buf_cur, len);
577 pdata_ptr->len = len;
579 p_add_proto_data( pinfo->fd, proto_wcp, (void*)pdata_ptr);
581 buf_ptr->buf_cur = dst;
586 tvb = tvb_new_real_data( pdata_ptr->buffer, pdata_ptr->len, pdata_ptr->len, "uncompressed");
590 g_assert_not_reached();
594 CATCH(ReportedBoundsError) {
600 /* link new tvbuff into tvbuff chain so cleanup is done later */
601 tvb_set_child_real_data_tvbuff( src_tvb, tvb);
603 /* Add new data to the data source list */
604 pinfo->fd->data_src = g_slist_append( pinfo->fd->data_src, tvb);
610 static void wcp_reinit( void){
612 /* Do the cleanup work when a new pass through the packet list is */
613 /* performed. re-initialize the memory chunks. */
616 g_mem_chunk_destroy(wcp_window);
618 wcp_window = g_mem_chunk_new("wcp_window", wcp_win_length,
619 wcp_win_init_count * wcp_win_length,
623 g_mem_chunk_destroy(wcp_pdata);
625 wcp_pdata = g_mem_chunk_new("wcp_pdata", wcp_packet_length,
626 wcp_packet_init_count * wcp_packet_length,
633 proto_register_wcp(void)
635 static hf_register_info hf[] = {
637 { "Command", "wcp.cmd", FT_UINT8, BASE_HEX, VALS(cmd_string), WCP_CMD,
638 "Compression Command" }},
640 { "Extended Command", "wcp.ext_cmd", FT_UINT8, BASE_HEX, VALS(ext_cmd_string), WCP_EXT_CMD,
641 "Extended Compression Command" }},
643 { "SEQ", "wcp.seq", FT_UINT16, BASE_HEX, NULL, WCP_SEQ,
644 "Sequence Number" }},
646 { "Checksum", "wcp.checksum", FT_UINT8, BASE_DEC, NULL, 0,
647 "Packet Checksum" }},
649 { "TID", "wcp.tid", FT_UINT16, BASE_DEC, NULL, 0,
652 { "Revision", "wcp.rev", FT_UINT8, BASE_DEC, NULL, 0,
655 { "Initiator", "wcp.init", FT_UINT8, BASE_DEC, NULL, 0,
658 { "Seq Size", "wcp.seq_size", FT_UINT8, BASE_DEC, NULL, 0,
661 { "Alg Count", "wcp.alg_cnt", FT_UINT8, BASE_DEC, NULL, 0,
664 { "Alg 1", "wcp.alg1", FT_UINT8, BASE_DEC, NULL, 0,
667 { "Alg 2", "wcp.alg2", FT_UINT8, BASE_DEC, NULL, 0,
670 { "Alg 3", "wcp.alg3", FT_UINT8, BASE_DEC, NULL, 0,
673 { "Alg 4", "wcp.alg4", FT_UINT8, BASE_DEC, NULL, 0,
676 { "Alg", "wcp.alg", FT_UINT8, BASE_DEC, NULL, 0,
679 { "Rexmit", "wcp.rexmit", FT_UINT8, BASE_DEC, NULL, 0,
682 { "History", "wcp.hist", FT_UINT8, BASE_DEC, NULL, 0,
685 { "PerPackComp", "wcp.ppc", FT_UINT8, BASE_DEC, NULL, 0,
686 "Per Packet Compression"}},
688 { "PIB", "wcp.pib", FT_UINT8, BASE_DEC, NULL, 0,
691 { "Compress Flag", "wcp.flag", FT_UINT8, BASE_HEX, NULL, 0,
692 "Compressed byte flag"}},
693 { &hf_wcp_comp_marker,
694 { "Compress Marker", "wcp.mark", FT_UINT8, BASE_BIN, NULL, 0,
695 "Compressed marker"}},
697 { "Source offset", "wcp.off", FT_UINT16, BASE_HEX, NULL, WCP_OFFSET_MASK,
698 "Data source offset"}},
700 { "Compress Length", "wcp.short_len", FT_UINT8, BASE_HEX, NULL, 0xf0,
701 "Compressed length"}},
703 { "Compress Length", "wcp.long_len", FT_UINT8, BASE_HEX, NULL, 0,
704 "Compressed length"}},
706 { "Long Compression", "wcp.long_comp", FT_UINT16, BASE_HEX, NULL, 0,
707 "Long Compression type"}},
709 { "Short Compression", "wcp.short_comp", FT_UINT8, BASE_HEX, NULL, 0,
710 "Short Compression type"}},
715 static gint *ett[] = {
720 proto_wcp = proto_register_protocol ("Wellfleet Compression", "WCP", "wcp");
721 proto_register_field_array (proto_wcp, hf, array_length(hf));
722 proto_register_subtree_array(ett, array_length(ett));
723 register_init_routine(&wcp_reinit);
728 proto_reg_handoff_wcp(void) {
730 dissector_add("fr.ietf", NLPID_COMPRESSED, dissect_wcp, proto_wcp);
731 dissector_add("ethertype", ETHERTYPE_WCP, dissect_wcp, proto_wcp);