epan/dissectors/packet-beep.c

   1 /* packet-beep.c
   2  * Routines for BEEP packet disassembly
   3  *
   4  * $Id$
   5  *
   6  * Copyright (c) 2000 by Richard Sharpe <rsharpe@ns.aus.com>
   7  * Modified 2001 Darren New <dnew@invisible.net> for BEEP.
   8  *
   9  * Original BXXP dissector developed with funding from InvisibleWorlds
  10  * (www.invisibleworlds.com) via Collab.Net.
  11  *
  12  * Ethereal - Network traffic analyzer
  13  * By Gerald Combs
  14  * Copyright 1999 Gerald Combs
  15  *
  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.
  20  *
  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.
  25  *
  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.
  29  */
  30
  31 #ifdef HAVE_CONFIG_H
  32 #include "config.h"
  33 #endif
  34
  35 #include <stdio.h>
  36 #include <stdlib.h>
  37 #include <ctype.h>
  38 #include <time.h>
  39 #include <glib.h>
  40 #include <string.h>
  41 #include <epan/packet.h>
  42 #include <epan/resolv.h>
  43 #include "prefs.h"
  44 #include <epan/conversation.h>
  45
  46 #define TCP_PORT_BEEP 10288
  47 void proto_reg_handoff_beep(void);
  48
  49
  50 static int global_beep_tcp_port = TCP_PORT_BEEP;
  51 static int global_beep_strict_term = TRUE;
  52
  53 static int proto_beep = -1;
  54
  55 static int hf_beep_req = -1;
  56 static int hf_beep_req_chan = -1;
  57 static int hf_beep_rsp_chan = -1;
  58 static int hf_beep_seq_chan = -1;
  59 static int hf_beep_rsp = -1;
  60 static int hf_beep_seq = -1;
  61 static int hf_beep_end = -1;
  62 static int hf_beep_proto_viol = -1;
  63 static int hf_beep_complete = -1;   /* No More data follows */
  64 static int hf_beep_intermediate = -1; /* More data follows */
  65 static int hf_beep_msgno = -1;
  66 static int hf_beep_ansno = -1;
  67 static int hf_beep_seqno = -1;
  68 static int hf_beep_size = -1;
  69 static int hf_beep_channel = -1;
  70 static int hf_beep_positive = -1;
  71 static int hf_beep_negative = -1;
  72 static int hf_beep_ackno = -1;
  73 static int hf_beep_window = -1;
  74
  75 /* Arrays of hf entry pointers for some routines to use. If you want more
  76  * hidden items added for a field, add them to the list before the NULL,
  77  * and the various routines that these are passed to will add them.
  78  */
  79
  80 static int *req_msgno_hfa[] = { &hf_beep_msgno, NULL };
  81 static int *req_ansno_hfa[] = { &hf_beep_ansno, NULL };
  82 static int *req_seqno_hfa[]  = { &hf_beep_seqno, NULL };
  83 static int *req_size_hfa[]   = { &hf_beep_size, NULL };
  84 static int *req_chan_hfa[]   = { &hf_beep_channel, &hf_beep_req_chan, NULL };
  85 /*
  86 static int *rsp_msgno_hfa[] = { &hf_beep_msgno, NULL };
  87 static int *rsp_seqno_hfa[]  = { &hf_beep_seqno, NULL };
  88 static int *rsp_size_hfa[]   = { &hf_beep_size, NULL };
  89 */
  90 static int *seq_chan_hfa[]   = { &hf_beep_channel, &hf_beep_seq_chan, NULL };
  91 static int *seq_ackno_hfa[]  = { &hf_beep_ackno, NULL };
  92 static int *seq_window_hfa[] = { &hf_beep_window, NULL };
  93
  94 static int ett_beep = -1;
  95 static int ett_mime_header = -1;
  96 static int ett_header = -1;
  97 static int ett_trailer = -1;
  98
  99 static unsigned int tcp_port = 0;
 100
 101 /* Get the state of the more flag ... */
 102
 103 #define BEEP_VIOL         0
 104 #define BEEP_INTERMEDIATE 1
 105 #define BEEP_COMPLETE     2
 106
 107 /*
 108  * Per-frame data
 109  *
 110  * pl_left is the amount of data in this packet that belongs to another
 111  * frame ...
 112  *
 113  * It relies on TCP segments not being re-ordered too much ...
 114  */
 115 struct beep_proto_data {
 116   int pl_left;   /* Payload at beginning of frame */
 117   int pl_size;   /* Payload in current message ...*/
 118   int mime_hdr;  /* Whether we expect a mime header. 1 on first, 0 on rest
 119                   * in a message
 120                   */
 121 };
 122
 123 /*
 124  * Conversation stuff
 125  */
 126 static int beep_packet_init_count = 100;
 127
 128 struct beep_request_key {
 129   guint32 conversation;
 130 };
 131
 132 struct beep_request_val {
 133   guint16 processed;     /* Have we processed this conversation? */
 134   int size;              /* Size of the message                  */
 135                          /* We need an indication in each dirn of
 136                           * whether on not a mime header is expected
 137                           */
 138   int c_mime_hdr, s_mime_hdr;
 139 };
 140
 141 static GHashTable *beep_request_hash = NULL;
 142 static GMemChunk  *beep_request_keys = NULL;
 143 static GMemChunk  *beep_request_vals = NULL;
 144 static GMemChunk  *beep_packet_infos = NULL;
 145
 146 /* Hash Functions */
 147 static gint
 148 beep_equal(gconstpointer v, gconstpointer w)
 149 {
 150   const struct beep_request_key *v1 = (const struct beep_request_key *)v;
 151   const struct beep_request_key *v2 = (const struct beep_request_key *)w;
 152
 153 #if defined(DEBUG_BEEP_HASH)
 154   printf("Comparing %08X\n      and %08X\n",
 155          v1->conversation, v2->conversation);
 156 #endif
 157
 158   if (v1->conversation == v2->conversation)
 159     return 1;
 160
 161   return 0;
 162
 163 }
 164
 165 static guint
 166 beep_hash(gconstpointer v)
 167 {
 168   const struct beep_request_key *key = (const struct beep_request_key *)v;
 169   guint val;
 170
 171   val = key->conversation;
 172
 173 #if defined(DEBUG_BEEP_HASH)
 174   printf("BEEP Hash calculated as %u\n", val);
 175 #endif
 176
 177   return val;
 178
 179 }
 180
 181 static void
 182 beep_init_protocol(void)
 183 {
 184 #if defined(DEBUG_BEEP_HASH)
 185   fprintf(stderr, "Initializing BEEP hashtable area\n");
 186 #endif
 187
 188   if (beep_request_hash)
 189     g_hash_table_destroy(beep_request_hash);
 190   if (beep_request_keys)
 191     g_mem_chunk_destroy(beep_request_keys);
 192   if (beep_request_vals)
 193     g_mem_chunk_destroy(beep_request_vals);
 194   if (beep_packet_infos)
 195     g_mem_chunk_destroy(beep_packet_infos);
 196
 197   beep_request_hash = g_hash_table_new(beep_hash, beep_equal);
 198   beep_request_keys = g_mem_chunk_new("beep_request_keys",
 199                                        sizeof(struct beep_request_key),
 200                                        beep_packet_init_count * sizeof(struct beep_request_key), G_ALLOC_AND_FREE);
 201   beep_request_vals = g_mem_chunk_new("beep_request_vals",
 202                                       sizeof(struct beep_request_val),
 203                                       beep_packet_init_count * sizeof(struct beep_request_val), G_ALLOC_AND_FREE);
 204   beep_packet_infos = g_mem_chunk_new("beep_packet_infos",
 205                                       sizeof(struct beep_proto_data),
 206                                       beep_packet_init_count * sizeof(struct beep_proto_data), G_ALLOC_AND_FREE);
 207 }
 208
 209 /*
 210  * BEEP routines
 211  */
 212
 213 static int beep_get_more(char more)
 214 {
 215
 216   if (more == '.')
 217     return BEEP_COMPLETE;
 218   else if (more == '*')
 219     return BEEP_INTERMEDIATE;
 220
 221   return BEEP_VIOL;
 222 }
 223
 224 /* dissect the more flag, and return a value of:
 225  *  1 -> more
 226  *  0 -> no more
 227  *  -1 -> Proto violation
 228  */
 229
 230 static int
 231 dissect_beep_more(tvbuff_t *tvb, int offset,
 232                   proto_tree *tree)
 233 {
 234
 235
 236   switch (beep_get_more(tvb_get_guint8(tvb, offset))) {
 237
 238   case BEEP_COMPLETE:
 239
 240     if (tree) {
 241       proto_tree_add_boolean_hidden(tree, hf_beep_complete, tvb, offset, 1, TRUE);
 242       proto_tree_add_text(tree, tvb, offset, 1, "More: Complete");
 243     }
 244
 245     return 0;
 246
 247     break;
 248
 249   case BEEP_INTERMEDIATE:
 250
 251     if (tree) {
 252       proto_tree_add_boolean_hidden(tree, hf_beep_intermediate, tvb, offset, 1, TRUE);
 253       proto_tree_add_text(tree, tvb, offset, 1, "More: Intermediate");
 254     }
 255
 256     return 1;
 257
 258     break;
 259
 260   default:
 261
 262     if (tree) {
 263       proto_tree_add_boolean_hidden(tree, hf_beep_proto_viol, tvb, offset, 1, TRUE);
 264       proto_tree_add_text(tree, tvb, offset, 1, "PROTOCOL VIOLATION: Expected More Flag (* or .)");
 265     }
 266
 267     return -1;
 268
 269     break;
 270   }
 271
 272 }
 273
 274 #if 0
 275 static void dissect_beep_status(tvbuff_t *tvb, int offset,
 276                                 proto_tree *tree)
 277 {
 278
 279   /* FIXME: We should return a value to indicate all OK. */
 280
 281   switch(tvb_get_guint8(tvb, offset)) {
 282
 283   case '+':
 284
 285     if (tree) {
 286       proto_tree_add_boolean_hidden(tree, hf_beep_positive, tvb, offset, 1, TRUE);
 287       proto_tree_add_text(tree, tvb, offset, 1, "Status: Positive");
 288     }
 289
 290     break;
 291
 292   case '-':
 293
 294     if (tree) {
 295       proto_tree_add_boolean_hidden(tree, hf_beep_negative, tvb, offset, 1, TRUE);
 296       proto_tree_add_text(tree, tvb, offset, 1, "Status: Negative");
 297     }
 298
 299     break;
 300
 301   default:  /* Proto violation: FIXME */
 302
 303     break;
 304
 305   }
 306
 307 }
 308 #endif
 309
 310 static int num_len(tvbuff_t *tvb, int offset)
 311 {
 312   unsigned int i = 0;
 313
 314   while (isdigit(tvb_get_guint8(tvb, offset + i))) i++;
 315
 316   return i;
 317
 318 }
 319
 320 /*
 321  * We check for a terminator. This can be CRLF, which will be recorded
 322  * as a terminator, or CR or LF by itself, which will be redorded as
 323  * an incorrect terminator ... We build the tree at this point
 324  * However, we depend on the variable beep_strict_term
 325  */
 326
 327 static int
 328 check_term(tvbuff_t *tvb, int offset, proto_tree *tree)
 329 {
 330
 331   /* First, check for CRLF, or, if global_beep_strict_term is false,
 332    * one of CR or LF ... If neither of these hold, we add an element
 333    * that complains of a protocol violation, and return -1, else
 334    * we add a terminator to the tree (possibly non-standard) and return
 335    * the count of characters we saw ... This may throw off the rest of the
 336    * dissection ... so-be-it!
 337    */
 338
 339   if ((tvb_get_guint8(tvb, offset) == 0x0d &&
 340        tvb_get_guint8(tvb, offset + 1) == 0x0a)){ /* Correct terminator */
 341
 342     if (tree) {
 343       proto_tree_add_text(tree, tvb, offset, 2, "Terminator: CRLF");
 344     }
 345     return 2;
 346
 347   }
 348   else if ((tvb_get_guint8(tvb, offset) == 0x0d) && !global_beep_strict_term) {
 349
 350     if (tree) {
 351       proto_tree_add_text(tree, tvb, offset, 1, "Nonstandard Terminator: CR");
 352       proto_tree_add_boolean_hidden(tree, hf_beep_proto_viol, tvb, offset, 1, TRUE);
 353     }
 354     return 1;
 355
 356   }
 357   else if ((tvb_get_guint8(tvb, offset) == 0x0a) && !global_beep_strict_term) {
 358
 359     if (tree) {
 360       proto_tree_add_text(tree, tvb, offset, 1, "Nonstandard Terminator: LF");
 361       proto_tree_add_boolean_hidden(tree, hf_beep_proto_viol, tvb, offset, 1, TRUE);
 362     }
 363     return 1;
 364
 365   }
 366   else {
 367
 368     if (tree) {
 369       proto_tree_add_text(tree, tvb, offset, 2, "PROTOCOL VIOLATION, Invalid Terminator: %s", tvb_format_text(tvb, offset, 2));
 370       proto_tree_add_boolean_hidden(tree, hf_beep_proto_viol, tvb, offset, 2, TRUE);
 371     }
 372     return -1;
 373
 374   }
 375
 376 }
 377
 378 /* Get the header length, up to CRLF or CR or LF */
 379 static int header_len(tvbuff_t *tvb, int offset)
 380 {
 381   int i = 0;
 382   guint8 sc;
 383
 384   /* FIXME: Have to make sure we stop looking at the end of the tvb ... */
 385
 386   /* We look for CRLF, or CR or LF if global_beep_strict_term is
 387    * not set.
 388    */
 389
 390   while (1) {
 391
 392     if ((sc = tvb_get_guint8(tvb, offset + i)) == 0x0d
 393         && tvb_get_guint8(tvb, offset + i + 1) == 0x0a)
 394       return i;   /* Done here ... */
 395
 396     if (!global_beep_strict_term && (sc == 0x0d || sc == 0x0a))
 397       return i;   /* Done here also ... */
 398
 399     i++;
 400
 401   }
 402 }
 403
 404 static int
 405 dissect_beep_mime_header(tvbuff_t *tvb, int offset,
 406                          struct beep_proto_data *frame_data,
 407                          proto_tree *tree)
 408 {
 409   proto_tree    *ti = NULL, *mime_tree = NULL;
 410   int           mime_length = header_len(tvb, offset), cc = 0;
 411
 412   if (frame_data && !frame_data->mime_hdr) return 0;
 413
 414   if (tree) {
 415
 416     /* FIXME: Should calculate the whole length of the mime headers */
 417
 418     ti = proto_tree_add_text(tree, tvb, offset, mime_length, "Mime header: %s", tvb_format_text(tvb, offset, mime_length));
 419     mime_tree = proto_item_add_subtree(ti, ett_mime_header);
 420   }
 421
 422   if (mime_length == 0) { /* Default header */
 423
 424     if (tree) {
 425       proto_tree_add_text(mime_tree, tvb, offset, 0, "Default values");
 426     }
 427
 428     if ((cc = check_term(tvb, offset, mime_tree)) <= 0) {
 429
 430       /* Ignore it, it will cause funnies in the rest of the dissect */
 431
 432     }
 433
 434   }
 435   else {  /* FIXME: Process the headers */
 436
 437     if (tree) {
 438       proto_tree_add_text(mime_tree, tvb, offset, mime_length, "Header: %s",
 439                           tvb_format_text(tvb, offset, mime_length));
 440     }
 441
 442     if ((cc = check_term(tvb, offset + mime_length, mime_tree)) <= 0) {
 443
 444       /* Ignore it, it will cause funnies in the rest of the dissect */
 445
 446     }
 447
 448   }
 449
 450   return mime_length + cc;  /* FIXME: Check that the CRLF is there */
 451
 452 }
 453
 454 static int
 455 dissect_beep_int(tvbuff_t *tvb, int offset,
 456                     proto_tree *tree, int hf, int *val, int *hfa[])
 457 {
 458   int ival, ind = 0;
 459   unsigned int i = num_len(tvb, offset);
 460   guint8 int_buff[100];
 461
 462   memset(int_buff, '\0', sizeof(int_buff));
 463
 464   tvb_memcpy(tvb, int_buff, offset, MIN(sizeof(int_buff) - 1, i));
 465
 466   /* XXX - is this still "Dangerous" now that we don't copy to the
 467      last byte of "int_buff[]"? */
 468   sscanf(int_buff, "%d", &ival);
 469
 470   if (tree) {
 471     proto_tree_add_uint(tree, hf, tvb, offset, i, ival);
 472   }
 473
 474   while (hfa[ind]) {
 475
 476     proto_tree_add_uint_hidden(tree, *hfa[ind], tvb, offset, i, ival);
 477     ind++;
 478
 479   }
 480
 481   *val = ival;  /* Return the value */
 482
 483   return i;
 484
 485 }
 486
 487 static void
 488 set_mime_hdr_flags(int more, struct beep_request_val *request_val,
 489                    struct beep_proto_data *frame_data, packet_info *pinfo)
 490 {
 491
 492   if (!request_val) return; /* Nothing to do ??? */
 493
 494   if (pinfo->destport == tcp_port) { /* Going to the server ... client */
 495
 496     if (request_val->c_mime_hdr) {
 497
 498       frame_data->mime_hdr = 0;
 499
 500       if (!more) request_val->c_mime_hdr = 0;
 501
 502     }
 503     else {
 504
 505       frame_data->mime_hdr = 1;
 506
 507       if (more) request_val->c_mime_hdr = 1;
 508
 509     }
 510
 511   }
 512   else {
 513
 514     if (request_val->s_mime_hdr) {
 515
 516       frame_data->mime_hdr = 0;
 517
 518       if (!more) request_val->s_mime_hdr = 0;
 519
 520     }
 521     else {
 522
 523       frame_data->mime_hdr = 1;
 524
 525       if (more) request_val->s_mime_hdr = 1;
 526
 527     }
 528
 529   }
 530
 531 }
 532
 533 /* Build the tree
 534  *
 535  * A return value of <= 0 says we bailed out, skip the rest of this message,
 536  * if any.
 537  *
 538  * A return value > 0 is the count of bytes we consumed ...
 539  */
 540
 541 static int
 542 dissect_beep_tree(tvbuff_t *tvb, int offset, packet_info *pinfo,
 543                   proto_tree *tree, struct beep_request_val *request_val,
 544                   struct beep_proto_data *frame_data)
 545 {
 546   proto_tree     *ti = NULL, *hdr = NULL;
 547   int            st_offset, msgno, ansno, seqno, size, channel, ackno, window, cc,
 548                  more;
 549
 550   char * cmd_temp = NULL;
 551   int is_ANS = 0;
 552   st_offset = offset;
 553
 554   if (tvb_strneql(tvb, offset, "MSG ", 4) == 0)
 555     cmd_temp = "Command: MSG";
 556   if (tvb_strneql(tvb, offset, "RPY ", 4) == 0)
 557     cmd_temp = "Command: RPY";
 558   if (tvb_strneql(tvb, offset, "ERR ", 4) == 0)
 559     cmd_temp = "Command: ERR";
 560   if (tvb_strneql(tvb, offset, "NUL ", 4) == 0)
 561     cmd_temp = "Command: NUL";
 562   if (tvb_strneql(tvb, offset, "ANS ", 4) == 0) {
 563     cmd_temp = "Command: ANS";
 564     is_ANS = 1;
 565   }
 566
 567   if (cmd_temp != NULL) {
 568
 569     if (tree) {
 570       ti = proto_tree_add_text(tree, tvb, offset, header_len(tvb, offset) + 2, "Header");
 571
 572       hdr = proto_item_add_subtree(ti, ett_header);
 573
 574       proto_tree_add_boolean_hidden(hdr, hf_beep_req, tvb, offset, 3, TRUE);
 575       proto_tree_add_text(hdr, tvb, offset, 3, cmd_temp);
 576     }
 577
 578     offset += 4;
 579
 580     /* Get the channel */
 581     offset += dissect_beep_int(tvb, offset, hdr, hf_beep_channel, &channel, req_chan_hfa);
 582     offset += 1; /* Skip the space */
 583
 584     /* Dissect the message number */
 585     offset += dissect_beep_int(tvb, offset, hdr, hf_beep_msgno, &msgno, req_msgno_hfa);
 586     offset += 1; /* skip the space */
 587
 588     /* Insert the more elements ... */
 589     if ((more = dissect_beep_more(tvb, offset, hdr)) >= 0) {
 590       /* Figure out which direction this is in and what mime_hdr flag to
 591        * add to the frame_data. If there are missing segments, this code
 592        * will get it wrong!
 593        */
 594       set_mime_hdr_flags(more, request_val, frame_data, pinfo);
 595     }
 596     else {  /* Protocol violation, so dissect rest as undisectable */
 597       if (tree) {
 598         proto_tree_add_text(hdr, tvb, offset,
 599                             tvb_length_remaining(tvb, offset),
 600                             "Undissected Payload: %s",
 601                             tvb_format_text(tvb, offset,
 602                                             tvb_length_remaining(tvb, offset)
 603                                             )
 604                             );
 605
 606       }
 607       return -1;
 608     }
 609
 610     offset += 2; /* Skip the flag and the space ... */
 611
 612     /* now for the seqno */
 613     offset += dissect_beep_int(tvb, offset, hdr, hf_beep_seqno, &seqno, req_seqno_hfa);
 614     offset += 1; /* skip the space */
 615
 616     offset += dissect_beep_int(tvb, offset, hdr, hf_beep_size, &size, req_size_hfa);
 617     if (request_val)   /* FIXME, is this the right order ... */
 618       request_val -> size = size;  /* Stash this away */
 619     else {
 620       frame_data->pl_size = size;
 621       if (frame_data->pl_size < 0) frame_data->pl_size = 0; /* FIXME: OK? */
 622     }
 623     /* offset += 1; skip the space */
 624
 625     if (is_ANS) { /* We need to put in the ansno */
 626         offset += 1; /* skip the space */
 627         /* Dissect the message number */
 628         offset += dissect_beep_int(tvb, offset, hdr, hf_beep_ansno, &ansno, req_ansno_hfa);
 629     }
 630
 631     if ((cc = check_term(tvb, offset, hdr)) <= 0) {
 632
 633       /* We dissect the rest as data and bail ... */
 634
 635       if (tree) {
 636         proto_tree_add_text(hdr, tvb, offset,
 637                             tvb_length_remaining(tvb, offset),
 638                             "Undissected Payload: %s",
 639                             tvb_format_text(tvb, offset,
 640                                             tvb_length_remaining(tvb, offset)
 641                                             )
 642                             );
 643       }
 644
 645       return -1;
 646
 647     }
 648
 649     offset += cc;
 650
 651     /* Insert MIME header ... */
 652
 653     if (frame_data && frame_data->mime_hdr)
 654       offset += dissect_beep_mime_header(tvb, offset, frame_data, hdr);
 655
 656     /* Now for the payload, if any */
 657
 658     if (tvb_length_remaining(tvb, offset) > 0) { /* Dissect what is left as payload */
 659
 660       int pl_size = MIN(size, tvb_length_remaining(tvb, offset));
 661
 662       /* Except, check the payload length, and only dissect that much */
 663
 664       /* We need to keep track, in the conversation, of how much is left
 665        * so in the next packet, we can figure out what is part of the payload
 666        * and what is the next message
 667        */
 668
 669       if (tree) {
 670         proto_tree_add_text(tree, tvb, offset, pl_size, "Payload: %s", tvb_format_text(tvb, offset, pl_size));
 671
 672       }
 673
 674       offset += pl_size;
 675
 676       if (request_val) {
 677         request_val->size -= pl_size;
 678         if (request_val->size < 0) request_val->size = 0;
 679       }
 680       else {
 681         frame_data->pl_size -= pl_size;
 682         if (frame_data->pl_size < 0) frame_data->pl_size = 0;
 683       }
 684     }
 685
 686     /* If anything else left, dissect it ... */
 687
 688     if (tvb_length_remaining(tvb, offset) > 0)
 689       offset += dissect_beep_tree(tvb, offset, pinfo, tree, request_val, frame_data);
 690
 691   } else if (tvb_strneql(tvb, offset, "SEQ ", 4) == 0) {
 692
 693     if (tree) {
 694       proto_tree_add_boolean_hidden(tree, hf_beep_seq, tvb, offset, 3, TRUE);
 695       proto_tree_add_text(tree, tvb, offset, 3, "Command: SEQ");
 696     }
 697
 698     offset += 3;
 699
 700     /* Now check the space: FIXME */
 701
 702     offset += 1;
 703
 704     offset += dissect_beep_int(tvb, offset, tree, hf_beep_channel, &channel, seq_chan_hfa);
 705
 706     /* Check the space: FIXME */
 707
 708     offset += 1;
 709
 710     offset += dissect_beep_int(tvb, offset, tree, hf_beep_ackno, &ackno, seq_ackno_hfa);
 711
 712     /* Check the space: FIXME */
 713
 714     offset += 1;
 715
 716     offset += dissect_beep_int(tvb, offset, tree, hf_beep_window, &window, seq_window_hfa);
 717
 718     if ((cc = check_term(tvb, offset, tree)) <= 0) {
 719
 720       /* We dissect the rest as data and bail ... */
 721
 722       if (tree) {
 723         proto_tree_add_text(tree, tvb, offset,
 724                             tvb_length_remaining(tvb, offset),
 725                             "Undissected Payload: %s",
 726                             tvb_format_text(tvb, offset,
 727                                             tvb_length_remaining(tvb, offset)
 728                                             )
 729                             );
 730       }
 731
 732       return -1;
 733
 734     }
 735
 736     offset += cc;
 737
 738   } else if (tvb_strneql(tvb, offset, "END", 3) == 0) {
 739
 740     proto_tree *tr = NULL;
 741
 742     if (tree) {
 743       ti = proto_tree_add_text(tree, tvb, offset, MIN(5, tvb_length_remaining(tvb, offset)), "Trailer");
 744
 745       tr = proto_item_add_subtree(ti, ett_trailer);
 746
 747       proto_tree_add_boolean_hidden(tr, hf_beep_end, tvb, offset, 3, TRUE);
 748       proto_tree_add_text(tr, tvb, offset, 3, "Command: END");
 749
 750     }
 751
 752     offset += 3;
 753
 754     if ((cc = check_term(tvb, offset, tr)) <= 0) {
 755
 756       /* We dissect the rest as data and bail ... */
 757
 758       if (tree) {
 759         proto_tree_add_text(tr, tvb, offset, tvb_length_remaining(tvb, offset),
 760                             "Undissected Payload: %s",
 761                             tvb_format_text(tvb, offset,
 762                                             tvb_length_remaining(tvb, offset)
 763                                             )
 764                             );
 765       }
 766
 767       return -1;
 768
 769     }
 770
 771     offset += cc;
 772
 773   }
 774
 775   if (tvb_length_remaining(tvb, offset) > 0) { /* Dissect anything left over */
 776
 777     int pl_size = 0;
 778
 779     if (request_val) {
 780
 781       pl_size = MIN(request_val->size, tvb_length_remaining(tvb, offset));
 782
 783       if (pl_size == 0) { /* The whole of the rest must be payload */
 784
 785         pl_size = tvb_length_remaining(tvb, offset); /* Right place ? */
 786
 787       }
 788
 789     } else if (frame_data) {
 790       pl_size = MIN(frame_data->pl_size, tvb_length_remaining(tvb, offset));
 791     } else { /* Just in case */
 792       pl_size = tvb_length_remaining(tvb, offset);
 793     }
 794
 795     /* Take care here to handle the payload correctly, and if there is
 796      * another message here, then handle it correctly as well.
 797      */
 798
 799     /* If the pl_size == 0 and the offset == 0?, then we have not processed
 800      * anything in this frame above, so we better treat all this data as
 801      * payload to avoid recursion loops
 802      */
 803
 804     if (pl_size == 0 && offset == st_offset)
 805       pl_size = tvb_length_remaining(tvb, offset);
 806
 807     if (pl_size > 0) {
 808
 809       if (tree) {
 810         proto_tree_add_text(tree, tvb, offset, pl_size, "Payload: %s",
 811                             tvb_format_text(tvb, offset, pl_size));
 812       }
 813
 814       offset += pl_size;            /* Advance past the payload */
 815
 816       if (request_val){
 817         request_val->size -= pl_size; /* Reduce payload by what we added */
 818         if (request_val->size < 0) request_val->size = 0;
 819       }
 820       else {
 821         frame_data->pl_size -= pl_size;
 822         if (frame_data->pl_size < 0) frame_data->pl_size = 0;
 823       }
 824     }
 825
 826     if (tvb_length_remaining(tvb, offset) > 0) {
 827       offset += dissect_beep_tree(tvb, offset, pinfo, tree, request_val, frame_data);
 828     }
 829   }
 830
 831   return offset - st_offset;
 832
 833 }
 834
 835 static void
 836 dissect_beep(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree)
 837 {
 838   int offset;
 839   struct beep_proto_data  *frame_data = NULL;
 840   proto_tree              *beep_tree = NULL, *ti = NULL;
 841   conversation_t          *conversation = NULL;
 842   struct beep_request_key request_key, *new_request_key;
 843   struct beep_request_val *request_val = NULL;
 844
 845   offset = 0;
 846
 847   /* If we have per frame data, use that, else, we must have lost the per-
 848    * frame data, and we have to do a full dissect pass again.
 849    *
 850    * The per-frame data tells us how much of this frame is left over from a
 851    * previous frame, so we dissect it as payload and then try to dissect the
 852    * rest.
 853    *
 854    * We use the conversation to build up info on the first pass over the
 855    * packets of type BEEP, and record anything that is needed if the user
 856    * does random dissects of packets in per packet data.
 857    *
 858    * Once we have per-packet data, we don't need the conversation stuff
 859    * anymore, but if per-packet data and conversation stuff gets deleted, as
 860    * it does under some circumstances when a rescan is done, it all gets
 861    * rebuilt.
 862    */
 863
 864   /* Find out what conversation this packet is part of ... but only
 865    * if we have no information on this packet, so find the per-frame
 866    * info first.
 867    */
 868
 869   frame_data = p_get_proto_data(pinfo->fd, proto_beep);
 870
 871   if (!frame_data) {
 872
 873     conversation = find_conversation(&pinfo->src, &pinfo->dst, pinfo->ptype,
 874                                        pinfo->srcport, pinfo->destport, 0);
 875     if (conversation == NULL) { /* No conversation, create one */
 876         conversation = conversation_new(&pinfo->src, &pinfo->dst, pinfo->ptype,
 877                                         pinfo->srcport, pinfo->destport, 0);
 878
 879       }
 880
 881       /*
 882        * Check for and insert an entry in the request table if does not exist
 883        */
 884       request_key.conversation = conversation->index;
 885
 886       request_val = (struct beep_request_val *)g_hash_table_lookup(beep_request_hash, &request_key);
 887
 888       if (!request_val) { /* Create one */
 889
 890         new_request_key = g_mem_chunk_alloc(beep_request_keys);
 891         new_request_key->conversation = conversation->index;
 892
 893         request_val = g_mem_chunk_alloc(beep_request_vals);
 894         request_val->processed = 0;
 895         request_val->size = 0;
 896
 897         g_hash_table_insert(beep_request_hash, new_request_key, request_val);
 898
 899       }
 900     }
 901
 902   if (check_col(pinfo->cinfo, COL_PROTOCOL))
 903     col_set_str(pinfo->cinfo, COL_PROTOCOL, "BEEP");
 904
 905   if (check_col(pinfo->cinfo, COL_INFO)) {  /* Check the type ... */
 906
 907     /* "tvb_format_text()" is passed a value that won't go past the end
 908      * of the packet, so it won't throw an exception. */
 909     col_add_str(pinfo->cinfo, COL_INFO, tvb_format_text(tvb, offset, tvb_length_remaining(tvb, offset)));
 910
 911   }
 912
 913   /* Here, we parse the message so we can retrieve the info we need, which
 914    * is that there is some payload left from a previous segment on the
 915    * front of this segment ... This all depends on TCP segments not getting
 916    * out of order ...
 917    *
 918    * As a huge kludge, we push the checking for the tree down into the code
 919    * and process as if we were given a tree but not call the routines that
 920    * adorn the protocol tree if they were NULL.
 921    */
 922
 923   if (tree) {  /* Build the tree info ... */
 924
 925     ti = proto_tree_add_item(tree, proto_beep, tvb, offset, -1, FALSE);
 926
 927     beep_tree = proto_item_add_subtree(ti, ett_beep);
 928
 929   }
 930
 931   /* Check the per-frame data and the conversation for any left-over
 932    * payload from the previous frame
 933    *
 934    * We check that per-frame data exists first, and if so, use it,
 935    * else we use the conversation data.
 936    *
 937    * We create per-frame data here as well, but we must ensure we create it
 938    * after we have done the check for per-frame or conversation data.
 939    *
 940    * We also depend on the first frame in a group having a pl_size of 0.
 941    */
 942
 943   if (frame_data && frame_data->pl_left > 0) {
 944
 945     int pl_left = frame_data->pl_left;
 946
 947     pl_left = MIN(pl_left, tvb_length_remaining(tvb, offset));
 948
 949     /* Add the payload bit, only if we have a tree */
 950     if (tree) {
 951       proto_tree_add_text(beep_tree, tvb, offset, pl_left, "Payload: %s",
 952                           tvb_format_text(tvb, offset, pl_left));
 953     }
 954     offset += pl_left;
 955   }
 956   else if (request_val && request_val->size > 0) {
 957
 958     int pl_left = request_val->size;
 959
 960     request_val->size = 0;
 961
 962     /* We create the frame data here for this case, and
 963      * elsewhere for other frames
 964      */
 965
 966     frame_data = g_mem_chunk_alloc(beep_packet_infos);
 967
 968     frame_data->pl_left = pl_left;
 969     frame_data->pl_size = 0;
 970     frame_data->mime_hdr = 0;
 971
 972     p_add_proto_data(pinfo->fd, proto_beep, frame_data);
 973
 974   }
 975
 976   /* Set up the per-frame data here if not already done so
 977    * This _must_ come after the checks above ...
 978    */
 979
 980   if (frame_data == NULL) {
 981
 982     frame_data = g_mem_chunk_alloc(beep_packet_infos);
 983
 984     frame_data->pl_left = 0;
 985     frame_data->pl_size = 0;
 986     frame_data->mime_hdr = 0;
 987
 988     p_add_proto_data(pinfo->fd, proto_beep, frame_data);
 989
 990   }
 991
 992   if (tvb_length_remaining(tvb, offset) > 0) {
 993
 994     offset += dissect_beep_tree(tvb, offset, pinfo, beep_tree, request_val, frame_data);
 995
 996   }
 997
 998 }
 999
1000 /* Register all the bits needed with the filtering engine */
1001
1002 void
1003 proto_register_beep(void)
1004 {
1005   static hf_register_info hf[] = {
1006     { &hf_beep_proto_viol,
1007       { "Protocol Violation", "beep.violation", FT_BOOLEAN, BASE_NONE, NULL, 0x0, "", HFILL }},
1008
1009     { &hf_beep_req,
1010       { "Request", "beep.req", FT_BOOLEAN, BASE_NONE, NULL, 0x0, "", HFILL }},
1011
1012     { &hf_beep_req_chan,
1013       { "Request Channel Number", "beep.req.channel", FT_UINT32, BASE_DEC, NULL, 0x0, "", HFILL }},
1014
1015     { &hf_beep_rsp,
1016       { "Response", "beep.rsp", FT_BOOLEAN, BASE_NONE, NULL, 0x0, "", HFILL }},
1017
1018     { &hf_beep_rsp_chan,
1019       { "Response Channel Number", "beep.rsp.channel", FT_UINT32, BASE_DEC, NULL, 0x0, "", HFILL }},
1020
1021     { &hf_beep_seq,
1022       { "Sequence", "beep.seq", FT_BOOLEAN, BASE_NONE, NULL, 0x0, "", HFILL }},
1023
1024     { &hf_beep_seq_chan,
1025       { "Sequence Channel Number", "beep.seq.channel", FT_UINT32, BASE_DEC, NULL, 0x0, "", HFILL }},
1026
1027     { &hf_beep_end,
1028       { "End", "beep.end", FT_BOOLEAN, BASE_NONE, NULL, 0x0, "", HFILL }},
1029
1030     { &hf_beep_complete,
1031       { "Complete", "beep.more.complete", FT_BOOLEAN, BASE_NONE, NULL, 0x0, "", HFILL }},
1032
1033     { &hf_beep_intermediate,
1034       { "Intermediate", "beep.more.intermediate", FT_BOOLEAN, BASE_NONE, NULL, 0x0, "", HFILL }},
1035
1036     { &hf_beep_msgno,
1037       { "Msgno", "beep.msgno", FT_UINT32, BASE_DEC, NULL, 0x0, "", HFILL }},
1038
1039     { &hf_beep_ansno,
1040       { "Ansno", "beep.ansno", FT_UINT32, BASE_DEC, NULL, 0x0, "", HFILL }},
1041
1042     { &hf_beep_seqno,
1043       { "Seqno", "beep.seqno", FT_UINT32, BASE_DEC, NULL, 0x0, "", HFILL }},
1044
1045     { &hf_beep_size,
1046       { "Size", "beep.size", FT_UINT32, BASE_DEC, NULL, 0x0, "", HFILL }},
1047
1048     { &hf_beep_channel,
1049       { "Channel", "beep.channel", FT_UINT32, BASE_DEC, NULL, 0x0, "", HFILL }},
1050
1051     { &hf_beep_negative,
1052       { "Negative", "beep.status.negative", FT_BOOLEAN, BASE_NONE, NULL, 0x0, "", HFILL }},
1053
1054     { &hf_beep_positive,
1055       { "Positive", "beep.status.positive", FT_BOOLEAN, BASE_NONE, NULL, 0x0, "", HFILL }},
1056
1057     { &hf_beep_ackno,
1058       { "Ackno", "beep.seq.ackno", FT_UINT32, BASE_DEC, NULL, 0x0, "", HFILL }},
1059
1060     { &hf_beep_window,
1061       { "Window", "beep.seq.window", FT_UINT32, BASE_DEC, NULL, 0x0, "", HFILL }},
1062
1063   };
1064   static gint *ett[] = {
1065     &ett_beep,
1066     &ett_mime_header,
1067     &ett_header,
1068     &ett_trailer,
1069   };
1070   module_t *beep_module;
1071
1072   proto_beep = proto_register_protocol("Blocks Extensible Exchange Protocol",
1073                                        "BEEP", "beep");
1074
1075   proto_register_field_array(proto_beep, hf, array_length(hf));
1076   proto_register_subtree_array(ett, array_length(ett));
1077   register_init_routine(&beep_init_protocol);
1078
1079   /* Register our configuration options for BEEP, particularly our port */
1080
1081   beep_module = prefs_register_protocol(proto_beep, proto_reg_handoff_beep);
1082
1083   prefs_register_uint_preference(beep_module, "tcp.port", "BEEP TCP Port",
1084                                  "Set the port for BEEP messages (if other"
1085                                  " than the default of 10288)",
1086                                  10, &global_beep_tcp_port);
1087
1088   prefs_register_bool_preference(beep_module, "strict_header_terminator",
1089                                  "BEEP Header Requires CRLF",
1090                                  "Specifies that BEEP requires CRLF as a "
1091                                  "terminator, and not just CR or LF",
1092                                  &global_beep_strict_term);
1093 }
1094
1095 /* The registration hand-off routine */
1096 void
1097 proto_reg_handoff_beep(void)
1098 {
1099   static int beep_prefs_initialized = FALSE;
1100   static dissector_handle_t beep_handle;
1101
1102   if (!beep_prefs_initialized) {
1103
1104     beep_handle = create_dissector_handle(dissect_beep, proto_beep);
1105
1106     beep_prefs_initialized = TRUE;
1107
1108   }
1109   else {
1110
1111     dissector_delete("tcp.port", tcp_port, beep_handle);
1112
1113   }
1114
1115   /* Set our port number for future use */
1116
1117   tcp_port = global_beep_tcp_port;
1118
1119   dissector_add("tcp.port", global_beep_tcp_port, beep_handle);
1120
1121 }