2 * Routines for BEEP packet disassembly
4 * $Id: packet-beep.c,v 1.2 2001/12/10 00:25:26 guy Exp $
6 * Copyright (c) 2000 by Richard Sharpe <rsharpe@ns.aus.com>
7 * Modified 2001 Darren New <dnew@invisible.net> for BEEP.
9 * Original BXXP dissector developed with funding from InvisibleWorlds
10 * (www.invisibleworlds.com) via Collab.Net.
12 * Ethereal - Network traffic analyzer
14 * Copyright 1999 Gerald Combs
16 * This program is free software; you can redistribute it and/or
17 * modify it under the terms of the GNU General Public License
18 * as published by the Free Software Foundation; either version 2
19 * of the License, or (at your option) any later version.
21 * This program is distributed in the hope that it will be useful,
22 * but WITHOUT ANY WARRANTY; without even the implied warranty of
23 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
24 * GNU General Public License for more details.
26 * You should have received a copy of the GNU General Public License
27 * along with this program; if not, write to the Free Software
28 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
35 #ifdef HAVE_SYS_TYPES_H
36 # include <sys/types.h>
39 #ifdef HAVE_NETINET_IN_H
40 #include <netinet/in.h>
52 #include "conversation.h"
54 #define TCP_PORT_BEEP 10288
55 void proto_reg_handoff_beep(void);
58 static int global_beep_tcp_port = TCP_PORT_BEEP;
59 static int global_beep_strict_term = TRUE;
61 static int proto_beep = -1;
63 static int hf_beep_req = -1;
64 static int hf_beep_req_chan = -1;
65 static int hf_beep_rsp_chan = -1;
66 static int hf_beep_seq_chan = -1;
67 static int hf_beep_rsp = -1;
68 static int hf_beep_seq = -1;
69 static int hf_beep_end = -1;
70 static int hf_beep_proto_viol = -1;
71 static int hf_beep_complete = -1; /* No More data follows */
72 static int hf_beep_intermediate = -1; /* More data follows */
73 static int hf_beep_msgno = -1;
74 static int hf_beep_ansno = -1;
75 static int hf_beep_seqno = -1;
76 static int hf_beep_size = -1;
77 static int hf_beep_channel = -1;
78 static int hf_beep_positive = -1;
79 static int hf_beep_negative = -1;
80 static int hf_beep_ackno = -1;
81 static int hf_beep_window = -1;
83 /* Arrays of hf entry pointers for some routines to use. If you want more
84 * hidden items added for a field, add them to the list before the NULL,
85 * and the various routines that these are passed to will add them.
88 static int *req_msgno_hfa[] = { &hf_beep_msgno, NULL };
89 static int *req_ansno_hfa[] = { &hf_beep_ansno, NULL };
90 static int *req_seqno_hfa[] = { &hf_beep_seqno, NULL };
91 static int *req_size_hfa[] = { &hf_beep_size, NULL };
92 static int *req_chan_hfa[] = { &hf_beep_channel, &hf_beep_req_chan, NULL };
94 static int *rsp_msgno_hfa[] = { &hf_beep_msgno, NULL };
95 static int *rsp_seqno_hfa[] = { &hf_beep_seqno, NULL };
96 static int *rsp_size_hfa[] = { &hf_beep_size, NULL };
98 static int *seq_chan_hfa[] = { &hf_beep_channel, &hf_beep_seq_chan, NULL };
99 static int *seq_ackno_hfa[] = { &hf_beep_ackno, NULL };
100 static int *seq_window_hfa[] = { &hf_beep_window, NULL };
102 static int ett_beep = -1;
103 static int ett_mime_header = -1;
104 static int ett_header = -1;
105 static int ett_trailer = -1;
107 static unsigned int tcp_port = 0;
109 /* Get the state of the more flag ... */
112 #define BEEP_INTERMEDIATE 1
113 #define BEEP_COMPLETE 2
118 * pl_left is the amount of data in this packet that belongs to another
121 * It relies on TCP segments not being re-ordered too much ...
123 struct beep_proto_data {
124 int pl_left; /* Payload at beginning of frame */
125 int pl_size; /* Payload in current message ...*/
126 int mime_hdr; /* Whether we expect a mime header. 1 on first, 0 on rest
134 static int beep_packet_init_count = 100;
136 struct beep_request_key {
137 guint32 conversation;
140 struct beep_request_val {
141 guint16 processed; /* Have we processed this conversation? */
142 int size; /* Size of the message */
143 /* We need an indication in each dirn of
144 * whether on not a mime header is expected
146 int c_mime_hdr, s_mime_hdr;
149 GHashTable *beep_request_hash = NULL;
150 GMemChunk *beep_request_keys = NULL;
151 GMemChunk *beep_request_vals = NULL;
152 GMemChunk *beep_packet_infos = NULL;
156 beep_equal(gconstpointer v, gconstpointer w)
158 struct beep_request_key *v1 = (struct beep_request_key *)v;
159 struct beep_request_key *v2 = (struct beep_request_key *)w;
161 #if defined(DEBUG_BEEP_HASH)
162 printf("Comparing %08X\n and %08X\n",
163 v1->conversation, v2->conversation);
166 if (v1->conversation == v2->conversation)
174 beep_hash(gconstpointer v)
176 struct beep_request_key *key = (struct beep_request_key *)v;
179 val = key->conversation;
181 #if defined(DEBUG_BEEP_HASH)
182 printf("BEEP Hash calculated as %u\n", val);
190 beep_init_protocol(void)
192 #if defined(DEBUG_BEEP_HASH)
193 fprintf(stderr, "Initializing BEEP hashtable area\n");
196 if (beep_request_hash)
197 g_hash_table_destroy(beep_request_hash);
198 if (beep_request_keys)
199 g_mem_chunk_destroy(beep_request_keys);
200 if (beep_request_vals)
201 g_mem_chunk_destroy(beep_request_vals);
202 if (beep_packet_infos)
203 g_mem_chunk_destroy(beep_packet_infos);
205 beep_request_hash = g_hash_table_new(beep_hash, beep_equal);
206 beep_request_keys = g_mem_chunk_new("beep_request_keys",
207 sizeof(struct beep_request_key),
208 beep_packet_init_count * sizeof(struct beep_request_key), G_ALLOC_AND_FREE);
209 beep_request_vals = g_mem_chunk_new("beep_request_vals",
210 sizeof(struct beep_request_val),
211 beep_packet_init_count * sizeof(struct beep_request_val), G_ALLOC_AND_FREE);
212 beep_packet_infos = g_mem_chunk_new("beep_packet_infos",
213 sizeof(struct beep_proto_data),
214 beep_packet_init_count * sizeof(struct beep_proto_data), G_ALLOC_AND_FREE);
221 static int beep_get_more(char more)
225 return BEEP_COMPLETE;
226 else if (more == '*')
227 return BEEP_INTERMEDIATE;
232 /* dissect the more flag, and return a value of:
235 * -1 -> Proto violation
239 dissect_beep_more(tvbuff_t *tvb, int offset, frame_data *fd,
244 switch (beep_get_more(tvb_get_guint8(tvb, offset))) {
249 proto_tree_add_boolean_hidden(tree, hf_beep_complete, tvb, offset, 1, TRUE);
250 proto_tree_add_text(tree, tvb, offset, 1, "More: Complete");
257 case BEEP_INTERMEDIATE:
260 proto_tree_add_boolean_hidden(tree, hf_beep_intermediate, tvb, offset, 1, TRUE);
261 proto_tree_add_text(tree, tvb, offset, 1, "More: Intermediate");
271 proto_tree_add_boolean_hidden(tree, hf_beep_proto_viol, tvb, offset, 1, TRUE);
272 proto_tree_add_text(tree, tvb, offset, 1, "PROTOCOL VIOLATION: Expected More Flag (* or .)");
282 static void dissect_beep_status(tvbuff_t *tvb, int offset, frame_data *fd,
286 /* FIXME: We should return a value to indicate all OK. */
288 switch(tvb_get_guint8(tvb, offset)) {
293 proto_tree_add_boolean_hidden(tree, hf_beep_positive, tvb, offset, 1, TRUE);
294 proto_tree_add_text(tree, tvb, offset, 1, "Status: Positive");
302 proto_tree_add_boolean_hidden(tree, hf_beep_negative, tvb, offset, 1, TRUE);
303 proto_tree_add_text(tree, tvb, offset, 1, "Status: Negative");
308 default: /* Proto violation: FIXME */
316 static int num_len(tvbuff_t *tvb, int offset)
320 while (isdigit(tvb_get_guint8(tvb, offset + i))) i++;
327 * We check for a terminator. This can be CRLF, which will be recorded
328 * as a terminator, or CR or LF by itself, which will be redorded as
329 * an incorrect terminator ... We build the tree at this point
330 * However, we depend on the variable beep_strict_term
334 check_term(tvbuff_t *tvb, int offset, proto_tree *tree)
337 /* First, check for CRLF, or, if global_beep_strict_term is false,
338 * one of CR or LF ... If neither of these hold, we add an element
339 * that complains of a protocol violation, and return -1, else
340 * we add a terminator to the tree (possibly non-standard) and return
341 * the count of characters we saw ... This may throw off the rest of the
342 * dissection ... so-be-it!
345 if ((tvb_get_guint8(tvb, offset) == 0x0d &&
346 tvb_get_guint8(tvb, offset + 1) == 0x0a)){ /* Correct terminator */
349 proto_tree_add_text(tree, tvb, offset, 2, "Terminator: CRLF");
354 else if ((tvb_get_guint8(tvb, offset) == 0x0d) && !global_beep_strict_term) {
357 proto_tree_add_text(tree, tvb, offset, 1, "Nonstandard Terminator: CR");
358 proto_tree_add_boolean_hidden(tree, hf_beep_proto_viol, tvb, offset, 1, TRUE);
363 else if ((tvb_get_guint8(tvb, offset) == 0x0a) && !global_beep_strict_term) {
366 proto_tree_add_text(tree, tvb, offset, 1, "Nonstandard Terminator: LF");
367 proto_tree_add_boolean_hidden(tree, hf_beep_proto_viol, tvb, offset, 1, TRUE);
375 proto_tree_add_text(tree, tvb, offset, 2, "PROTOCOL VIOLATION, Invalid Terminator: %s", tvb_format_text(tvb, offset, 2));
376 proto_tree_add_boolean_hidden(tree, hf_beep_proto_viol, tvb, offset, 2, TRUE);
384 /* Get the header length, up to CRLF or CR or LF */
385 static int header_len(tvbuff_t *tvb, int offset)
390 /* FIXME: Have to make sure we stop looking at the end of the tvb ... */
392 /* We look for CRLF, or CR or LF if global_beep_strict_term is
398 if (tvb_length_remaining(tvb, offset + i) < 1)
399 return i; /* Not enough characters left ... */
401 if ((sc = tvb_get_guint8(tvb, offset + i)) == 0x0d
402 && tvb_get_guint8(tvb, offset + i + 1) == 0x0a)
403 return i; /* Done here ... */
405 if (!global_beep_strict_term && (sc == 0x0d || sc == 0x0a))
406 return i; /* Done here also ... */
414 dissect_beep_mime_header(tvbuff_t *tvb, int offset,
415 struct beep_proto_data *frame_data,
418 proto_tree *ti = NULL, *mime_tree = NULL;
419 int mime_length = header_len(tvb, offset), cc = 0;
421 if (frame_data && !frame_data->mime_hdr) return 0;
425 /* FIXME: Should calculate the whole length of the mime headers */
427 ti = proto_tree_add_text(tree, tvb, offset, mime_length, "Mime header: %s", tvb_format_text(tvb, offset, mime_length));
428 mime_tree = proto_item_add_subtree(ti, ett_mime_header);
431 if (mime_length == 0) { /* Default header */
434 proto_tree_add_text(mime_tree, tvb, offset, 0, "Default values");
437 if ((cc = check_term(tvb, offset, mime_tree)) <= 0) {
439 /* Ignore it, it will cause funnies in the rest of the dissect */
444 else { /* FIXME: Process the headers */
447 proto_tree_add_text(mime_tree, tvb, offset, mime_length, "Header: %s",
448 tvb_format_text(tvb, offset, mime_length));
451 if ((cc = check_term(tvb, offset + mime_length, mime_tree)) <= 0) {
453 /* Ignore it, it will cause funnies in the rest of the dissect */
459 return mime_length + cc; /* FIXME: Check that the CRLF is there */
464 dissect_beep_int(tvbuff_t *tvb, int offset, frame_data *fd,
465 proto_tree *tree, int hf, int *val, int *hfa[])
468 unsigned int i = num_len(tvb, offset);
469 guint8 int_buff[100];
471 memset(int_buff, '\0', sizeof(int_buff));
473 tvb_memcpy(tvb, int_buff, offset, MIN(sizeof(int_buff), i));
475 sscanf(int_buff, "%d", &ival); /* FIXME: Dangerous */
478 proto_tree_add_uint(tree, hf, tvb, offset, i, ival);
483 proto_tree_add_uint_hidden(tree, *hfa[ind], tvb, offset, i, ival);
488 *val = ival; /* Return the value */
495 set_mime_hdr_flags(int more, struct beep_request_val *request_val,
496 struct beep_proto_data *frame_data, packet_info *pinfo)
499 if (!request_val) return; /* Nothing to do ??? */
501 if (pinfo->destport == tcp_port) { /* Going to the server ... client */
503 if (request_val->c_mime_hdr) {
505 frame_data->mime_hdr = 0;
507 if (!more) request_val->c_mime_hdr = 0;
512 frame_data->mime_hdr = 1;
514 if (more) request_val->c_mime_hdr = 1;
521 if (request_val->s_mime_hdr) {
523 frame_data->mime_hdr = 0;
525 if (!more) request_val->s_mime_hdr = 0;
530 frame_data->mime_hdr = 1;
532 if (more) request_val->s_mime_hdr = 1;
542 * A return value of <= 0 says we bailed out, skip the rest of this message,
545 * A return value > 0 is the count of bytes we consumed ...
549 dissect_beep_tree(tvbuff_t *tvb, int offset, packet_info *pinfo,
550 proto_tree *tree, struct beep_request_val *request_val,
551 struct beep_proto_data *frame_data)
553 proto_tree *ti = NULL, *hdr = NULL;
554 int st_offset, msgno, ansno, seqno, size, channel, ackno, window, cc,
557 char * cmd_temp = NULL;
561 if (tvb_strneql(tvb, offset, "MSG ", 4) == 0)
562 cmd_temp = "Command: MSG";
563 if (tvb_strneql(tvb, offset, "RPY ", 4) == 0)
564 cmd_temp = "Command: RPY";
565 if (tvb_strneql(tvb, offset, "ERR ", 4) == 0)
566 cmd_temp = "Command: ERR";
567 if (tvb_strneql(tvb, offset, "NUL ", 4) == 0)
568 cmd_temp = "Command: NUL";
569 if (tvb_strneql(tvb, offset, "ANS ", 4) == 0) {
570 cmd_temp = "Command: ANS";
574 if (cmd_temp != NULL) {
577 ti = proto_tree_add_text(tree, tvb, offset, header_len(tvb, offset) + 2, "Header");
579 hdr = proto_item_add_subtree(ti, ett_header);
581 proto_tree_add_boolean_hidden(hdr, hf_beep_req, tvb, offset, 3, TRUE);
582 proto_tree_add_text(hdr, tvb, offset, 3, cmd_temp);
587 /* Get the channel */
588 offset += dissect_beep_int(tvb, offset, pinfo->fd, hdr, hf_beep_channel, &channel, req_chan_hfa);
589 offset += 1; /* Skip the space */
591 /* Dissect the message number */
592 offset += dissect_beep_int(tvb, offset, pinfo->fd, hdr, hf_beep_msgno, &msgno, req_msgno_hfa);
593 offset += 1; /* skip the space */
595 /* Insert the more elements ... */
596 if ((more = dissect_beep_more(tvb, offset, pinfo->fd, hdr)) >= 0) {
597 /* Figure out which direction this is in and what mime_hdr flag to
598 * add to the frame_data. If there are missing segments, this code
601 set_mime_hdr_flags(more, request_val, frame_data, pinfo);
603 else { /* Protocol violation, so dissect rest as undisectable */
605 proto_tree_add_text(hdr, tvb, offset,
606 tvb_length_remaining(tvb, offset),
607 "Undissected Payload: %s",
608 tvb_format_text(tvb, offset,
609 tvb_length_remaining(tvb, offset)
617 offset += 2; /* Skip the flag and the space ... */
619 /* now for the seqno */
620 offset += dissect_beep_int(tvb, offset, pinfo->fd, hdr, hf_beep_seqno, &seqno, req_seqno_hfa);
621 offset += 1; /* skip the space */
623 offset += dissect_beep_int(tvb, offset, pinfo->fd, hdr, hf_beep_size, &size, req_size_hfa);
624 if (request_val) /* FIXME, is this the right order ... */
625 request_val -> size = size; /* Stash this away */
627 frame_data->pl_size = size;
628 if (frame_data->pl_size < 0) frame_data->pl_size = 0; /* FIXME: OK? */
630 /* offset += 1; skip the space */
632 if (is_ANS) { /* We need to put in the ansno */
633 offset += 1; /* skip the space */
634 /* Dissect the message number */
635 offset += dissect_beep_int(tvb, offset, pinfo->fd, hdr, hf_beep_ansno, &ansno, req_ansno_hfa);
638 if ((cc = check_term(tvb, offset, hdr)) <= 0) {
640 /* We dissect the rest as data and bail ... */
643 proto_tree_add_text(hdr, tvb, offset,
644 tvb_length_remaining(tvb, offset),
645 "Undissected Payload: %s",
646 tvb_format_text(tvb, offset,
647 tvb_length_remaining(tvb, offset)
658 /* Insert MIME header ... */
660 if (frame_data && frame_data->mime_hdr)
661 offset += dissect_beep_mime_header(tvb, offset, frame_data, hdr);
663 /* Now for the payload, if any */
665 if (tvb_length_remaining(tvb, offset) > 0) { /* Dissect what is left as payload */
667 int pl_size = MIN(size, tvb_length_remaining(tvb, offset));
669 /* Except, check the payload length, and only dissect that much */
671 /* We need to keep track, in the conversation, of how much is left
672 * so in the next packet, we can figure out what is part of the payload
673 * and what is the next message
677 proto_tree_add_text(tree, tvb, offset, pl_size, "Payload: %s", tvb_format_text(tvb, offset, pl_size));
684 request_val->size -= pl_size;
685 if (request_val->size < 0) request_val->size = 0;
688 frame_data->pl_size -= pl_size;
689 if (frame_data->pl_size < 0) frame_data->pl_size = 0;
693 /* If anything else left, dissect it ... */
695 if (tvb_length_remaining(tvb, offset) > 0)
696 offset += dissect_beep_tree(tvb, offset, pinfo, tree, request_val, frame_data);
698 } else if (tvb_strneql(tvb, offset, "SEQ ", 4) == 0) {
701 proto_tree_add_boolean_hidden(tree, hf_beep_seq, tvb, offset, 3, TRUE);
702 proto_tree_add_text(tree, tvb, offset, 3, "Command: SEQ");
707 /* Now check the space: FIXME */
711 offset += dissect_beep_int(tvb, offset, pinfo->fd, tree, hf_beep_channel, &channel, seq_chan_hfa);
713 /* Check the space: FIXME */
717 offset += dissect_beep_int(tvb, offset, pinfo->fd, tree, hf_beep_ackno, &ackno, seq_ackno_hfa);
719 /* Check the space: FIXME */
723 offset += dissect_beep_int(tvb, offset, pinfo->fd, tree, hf_beep_window, &window, seq_window_hfa);
725 if ((cc = check_term(tvb, offset, tree)) <= 0) {
727 /* We dissect the rest as data and bail ... */
730 proto_tree_add_text(tree, tvb, offset,
731 tvb_length_remaining(tvb, offset),
732 "Undissected Payload: %s",
733 tvb_format_text(tvb, offset,
734 tvb_length_remaining(tvb, offset)
745 } else if (tvb_strneql(tvb, offset, "END", 3) == 0) {
747 proto_tree *tr = NULL;
750 ti = proto_tree_add_text(tree, tvb, offset, MIN(5, tvb_length_remaining(tvb, offset)), "Trailer");
752 tr = proto_item_add_subtree(ti, ett_trailer);
754 proto_tree_add_boolean_hidden(tr, hf_beep_end, tvb, offset, 3, TRUE);
755 proto_tree_add_text(tr, tvb, offset, 3, "Command: END");
761 if ((cc = check_term(tvb, offset, tr)) <= 0) {
763 /* We dissect the rest as data and bail ... */
766 proto_tree_add_text(tr, tvb, offset, tvb_length_remaining(tvb, offset),
767 "Undissected Payload: %s",
768 tvb_format_text(tvb, offset,
769 tvb_length_remaining(tvb, offset)
782 if (tvb_length_remaining(tvb, offset) > 0) { /* Dissect anything left over */
788 pl_size = MIN(request_val->size, tvb_length_remaining(tvb, offset));
790 if (pl_size == 0) { /* The whole of the rest must be payload */
792 pl_size = tvb_length_remaining(tvb, offset); /* Right place ? */
796 } else if (frame_data) {
797 pl_size = MIN(frame_data->pl_size, tvb_length_remaining(tvb, offset));
798 } else { /* Just in case */
799 pl_size = tvb_length_remaining(tvb, offset);
802 /* Take care here to handle the payload correctly, and if there is
803 * another message here, then handle it correctly as well.
806 /* If the pl_size == 0 and the offset == 0?, then we have not processed
807 * anything in this frame above, so we better treat all this data as
808 * payload to avoid recursion loops
811 if (pl_size == 0 && offset == st_offset)
812 pl_size = tvb_length_remaining(tvb, offset);
817 proto_tree_add_text(tree, tvb, offset, pl_size, "Payload: %s",
818 tvb_format_text(tvb, offset, pl_size));
821 offset += pl_size; /* Advance past the payload */
824 request_val->size -= pl_size; /* Reduce payload by what we added */
825 if (request_val->size < 0) request_val->size = 0;
828 frame_data->pl_size -= pl_size;
829 if (frame_data->pl_size < 0) frame_data->pl_size = 0;
833 if (tvb_length_remaining(tvb, offset) > 0) {
834 offset += dissect_beep_tree(tvb, offset, pinfo, tree, request_val, frame_data);
838 return offset - st_offset;
843 dissect_beep(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree)
846 struct beep_proto_data *frame_data = NULL;
847 proto_tree *beep_tree = NULL, *ti = NULL;
848 conversation_t *conversation = NULL;
849 struct beep_request_key request_key, *new_request_key;
850 struct beep_request_val *request_val = NULL;
854 /* If we have per frame data, use that, else, we must have lost the per-
855 * frame data, and we have to do a full dissect pass again.
857 * The per-frame data tells us how much of this frame is left over from a
858 * previous frame, so we dissect it as payload and then try to dissect the
861 * We use the conversation to build up info on the first pass over the
862 * packets of type BEEP, and record anything that is needed if the user
863 * does random dissects of packets in per packet data.
865 * Once we have per-packet data, we don't need the conversation stuff
866 * anymore, but if per-packet data and conversation stuff gets deleted, as
867 * it does under some circumstances when a rescan is done, it all gets
871 /* Find out what conversation this packet is part of ... but only
872 * if we have no information on this packet, so find the per-frame
876 frame_data = p_get_proto_data(pinfo->fd, proto_beep);
880 conversation = find_conversation(&pinfo->src, &pinfo->dst, pinfo->ptype,
881 pinfo->srcport, pinfo->destport, 0);
882 if (conversation == NULL) { /* No conversation, create one */
883 conversation = conversation_new(&pinfo->src, &pinfo->dst, pinfo->ptype,
884 pinfo->srcport, pinfo->destport, 0);
889 * Check for and insert an entry in the request table if does not exist
891 request_key.conversation = conversation->index;
893 request_val = (struct beep_request_val *)g_hash_table_lookup(beep_request_hash, &request_key);
895 if (!request_val) { /* Create one */
897 new_request_key = g_mem_chunk_alloc(beep_request_keys);
898 new_request_key->conversation = conversation->index;
900 request_val = g_mem_chunk_alloc(beep_request_vals);
901 request_val->processed = 0;
902 request_val->size = 0;
904 g_hash_table_insert(beep_request_hash, new_request_key, request_val);
909 if (check_col(pinfo->cinfo, COL_PROTOCOL))
910 col_set_str(pinfo->cinfo, COL_PROTOCOL, "BEEP");
912 if (check_col(pinfo->cinfo, COL_INFO)) { /* Check the type ... */
914 /* "tvb_format_text()" is passed a value that won't go past the end
915 * of the packet, so it won't throw an exception. */
916 col_add_str(pinfo->cinfo, COL_INFO, tvb_format_text(tvb, offset, tvb_length_remaining(tvb, offset)));
920 /* Here, we parse the message so we can retrieve the info we need, which
921 * is that there is some payload left from a previous segment on the
922 * front of this segment ... This all depends on TCP segments not getting
925 * As a huge kludge, we push the checking for the tree down into the code
926 * and process as if we were given a tree but not call the routines that
927 * adorn the protocol tree if they were NULL.
930 if (tree) { /* Build the tree info ... */
932 ti = proto_tree_add_item(tree, proto_beep, tvb, offset, tvb_length(tvb), FALSE);
934 beep_tree = proto_item_add_subtree(ti, ett_beep);
938 /* Check the per-frame data and the conversation for any left-over
939 * payload from the previous frame
941 * We check that per-frame data exists first, and if so, use it,
942 * else we use the conversation data.
944 * We create per-frame data here as well, but we must ensure we create it
945 * after we have done the check for per-frame or conversation data.
947 * We also depend on the first frame in a group having a pl_size of 0.
950 if (frame_data && frame_data->pl_left > 0) {
952 int pl_left = frame_data->pl_left;
954 pl_left = MIN(pl_left, tvb_length_remaining(tvb, offset));
956 /* Add the payload bit, only if we have a tree */
958 proto_tree_add_text(beep_tree, tvb, offset, pl_left, "Payload: %s",
959 tvb_format_text(tvb, offset, pl_left));
963 else if (request_val && request_val->size > 0) {
965 int pl_left = request_val->size;
967 request_val->size = 0;
969 /* We create the frame data here for this case, and
970 * elsewhere for other frames
973 frame_data = g_mem_chunk_alloc(beep_packet_infos);
975 frame_data->pl_left = pl_left;
976 frame_data->pl_size = 0;
977 frame_data->mime_hdr = 0;
979 p_add_proto_data(pinfo->fd, proto_beep, frame_data);
983 /* Set up the per-frame data here if not already done so
984 * This _must_ come after the checks above ...
987 if (frame_data == NULL) {
989 frame_data = g_mem_chunk_alloc(beep_packet_infos);
991 frame_data->pl_left = 0;
992 frame_data->pl_size = 0;
993 frame_data->mime_hdr = 0;
995 p_add_proto_data(pinfo->fd, proto_beep, frame_data);
999 if (tvb_length_remaining(tvb, offset) > 0) {
1001 offset += dissect_beep_tree(tvb, offset, pinfo, beep_tree, request_val, frame_data);
1007 /* Register all the bits needed with the filtering engine */
1010 proto_register_beep(void)
1012 static hf_register_info hf[] = {
1013 { &hf_beep_proto_viol,
1014 { "Protocol Violation", "beep.violation", FT_BOOLEAN, BASE_NONE, NULL, 0x0, "", HFILL }},
1017 { "Request", "beep.req", FT_BOOLEAN, BASE_NONE, NULL, 0x0, "", HFILL }},
1019 { &hf_beep_req_chan,
1020 { "Request Channel Number", "beep.req.channel", FT_UINT32, BASE_DEC, NULL, 0x0, "", HFILL }},
1023 { "Response", "beep.rsp", FT_BOOLEAN, BASE_NONE, NULL, 0x0, "", HFILL }},
1025 { &hf_beep_rsp_chan,
1026 { "Response Channel Number", "beep.rsp.channel", FT_UINT32, BASE_DEC, NULL, 0x0, "", HFILL }},
1029 { "Sequence", "beep.seq", FT_BOOLEAN, BASE_NONE, NULL, 0x0, "", HFILL }},
1031 { &hf_beep_seq_chan,
1032 { "Sequence Channel Number", "beep.seq.channel", FT_UINT32, BASE_DEC, NULL, 0x0, "", HFILL }},
1035 { "End", "beep.end", FT_BOOLEAN, BASE_NONE, NULL, 0x0, "", HFILL }},
1037 { &hf_beep_complete,
1038 { "Complete", "beep.more.complete", FT_BOOLEAN, BASE_NONE, NULL, 0x0, "", HFILL }},
1040 { &hf_beep_intermediate,
1041 { "Intermediate", "beep.more.intermediate", FT_BOOLEAN, BASE_NONE, NULL, 0x0, "", HFILL }},
1044 { "Msgno", "beep.msgno", FT_UINT32, BASE_DEC, NULL, 0x0, "", HFILL }},
1047 { "Ansno", "beep.ansno", FT_UINT32, BASE_DEC, NULL, 0x0, "", HFILL }},
1050 { "Seqno", "beep.seqno", FT_UINT32, BASE_DEC, NULL, 0x0, "", HFILL }},
1053 { "Size", "beep.size", FT_UINT32, BASE_DEC, NULL, 0x0, "", HFILL }},
1056 { "Channel", "beep.channel", FT_UINT32, BASE_DEC, NULL, 0x0, "", HFILL }},
1058 { &hf_beep_negative,
1059 { "Negative", "beep.status.negative", FT_BOOLEAN, BASE_NONE, NULL, 0x0, "", HFILL }},
1061 { &hf_beep_positive,
1062 { "Positive", "beep.status.positive", FT_BOOLEAN, BASE_NONE, NULL, 0x0, "", HFILL }},
1065 { "Ackno", "beep.seq.ackno", FT_UINT32, BASE_DEC, NULL, 0x0, "", HFILL }},
1068 { "Window", "beep.seq.window", FT_UINT32, BASE_DEC, NULL, 0x0, "", HFILL }},
1071 static gint *ett[] = {
1077 module_t *beep_module;
1079 proto_beep = proto_register_protocol("Blocks Extensible Exchange Protocol",
1082 proto_register_field_array(proto_beep, hf, array_length(hf));
1083 proto_register_subtree_array(ett, array_length(ett));
1084 register_init_routine(&beep_init_protocol);
1086 /* Register our configuration options for BEEP, particularly our port */
1088 beep_module = prefs_register_protocol(proto_beep, proto_reg_handoff_beep);
1090 prefs_register_uint_preference(beep_module, "tcp.port", "BEEP TCP Port",
1091 "Set the port for BEEP messages (if other"
1092 " than the default of 10288)",
1093 10, &global_beep_tcp_port);
1095 prefs_register_bool_preference(beep_module, "strict_header_terminator",
1096 "BEEP Header Requires CRLF",
1097 "Specifies that BEEP requires CRLF as a "
1098 "terminator, and not just CR or LF",
1099 &global_beep_strict_term);
1102 /* The registration hand-off routine */
1104 proto_reg_handoff_beep(void)
1106 static int beep_prefs_initialized = FALSE;
1107 static dissector_handle_t beep_handle;
1109 if (!beep_prefs_initialized) {
1111 beep_handle = create_dissector_handle(dissect_beep, proto_beep);
1113 beep_prefs_initialized = TRUE;
1118 dissector_delete("tcp.port", tcp_port, beep_handle);
1122 /* Set our port number for future use */
1124 tcp_port = global_beep_tcp_port;
1126 dissector_add("tcp.port", global_beep_tcp_port, beep_handle);