epan/reassemble.h

   1 /* reassemble.h
   2  * Declarations of outines for {fragment,segment} reassembly
   3  *
   4  * $Id$
   5  *
   6  * Wireshark - Network traffic analyzer
   7  * By Gerald Combs <gerald@wireshark.org>
   8  * Copyright 1998 Gerald Combs
   9  *
  10  * This program is free software; you can redistribute it and/or
  11  * modify it under the terms of the GNU General Public License
  12  * as published by the Free Software Foundation; either version 2
  13  * of the License, or (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  23  */
  24
  25 /* make sure that all flags that are set in a fragment entry is also set for
  26  * the flags field of fd_head !!!
  27  */
  28
  29 /* only in fd_head: packet is defragmented */
  30 #define FD_DEFRAGMENTED         0x0001
  31
  32 /* there are overlapping fragments */
  33 #define FD_OVERLAP              0x0002
  34
  35 /* overlapping fragments contain different data */
  36 #define FD_OVERLAPCONFLICT      0x0004
  37
  38 /* more than one fragment which indicates end-of data */
  39 #define FD_MULTIPLETAILS        0x0008
  40
  41 /* fragment contains data past the end of the datagram */
  42 #define FD_TOOLONGFRAGMENT      0x0010
  43
  44 /* fragment data not alloc'ed, fd->data pointing to fd_head->data+fd->offset */
  45 #define FD_NOT_MALLOCED         0x0020
  46
  47 /* this flag is used to request fragment_add to continue the reassembly process */
  48 #define FD_PARTIAL_REASSEMBLY   0x0040
  49
  50 /* fragment offset is indicated by sequence number and not byte offset
  51    into the defragmented packet */
  52 #define FD_BLOCKSEQUENCE        0x0100
  53
  54 /* if REASSEMBLE_FLAGS_CHECK_DATA_PRESENT is set, and the first fragment is
  55  * incomplete, this flag is set in the flags word on the fd_head returned.
  56  *
  57  * It's all a fudge to preserve historical behaviour.
  58  */
  59 #define FD_DATA_NOT_PRESENT     0x0200
  60
  61 /* This flag is set in (only) fd_head to denote that datalen has been set to a valid value.
  62  * It's implied by FD_DEFRAGMENTED (we must know the total length of the
  63  * datagram if we have defragmented it...)
  64  */
  65 #define FD_DATALEN_SET          0x0400
  66
  67 typedef struct _fragment_data {
  68         struct _fragment_data *next;
  69         guint32 frame;
  70         guint32 offset;
  71         guint32 len;
  72         guint32 datalen; /* Only valid in first item of list and when
  73                           * flags&FD_DATALEN_SET is set;
  74                           * number of bytes or (if flags&FD_BLOCKSEQUENCE set)
  75                           * segments in the datagram */
  76         guint32 reassembled_in; /* frame where this PDU was reassembled,
  77                                    only valid in the first item of the list
  78                                    and when FD_DEFRAGMENTED is set*/
  79         guint32 flags;
  80         unsigned char *data;
  81 } fragment_data;
  82
  83
  84 /*
  85  * Flags for fragment_add_seq_*
  86  */
  87
  88 /* we don't have any sequence numbers - fragments are assumed to appear in
  89  * order */
  90 #define REASSEMBLE_FLAGS_NO_FRAG_NUMBER         0x0001
  91
  92 /* a special fudge for the 802.11 dissector */
  93 #define REASSEMBLE_FLAGS_802_11_HACK            0x0002
  94
  95 /* causes fragment_add_seq_key to check that all the fragment data is present
  96  * in the tvb, and if not, do something a bit odd. */
  97 #define REASSEMBLE_FLAGS_CHECK_DATA_PRESENT     0x0004
  98
  99 /* a function for copying hash keys */
 100 typedef void *(*fragment_key_copier)(const void *key);
 101
 102
 103 /*
 104  * Initialize a fragment table.
 105  */
 106 extern void fragment_table_init(GHashTable **fragment_table);
 107 extern void dcerpc_fragment_table_init(GHashTable **fragment_table);
 108
 109 /*
 110  * Initialize a reassembled-packet table.
 111  */
 112 extern void reassembled_table_init(GHashTable **reassembled_table);
 113
 114 /*
 115  * Free up all space allocated for fragment keys and data.
 116  */
 117 void reassemble_cleanup(void);
 118
 119 /*
 120  * Initialise fragment keys and data.
 121  */
 122 void reassemble_init(void);
 123
 124 /*
 125  * This function adds a new fragment to the fragment hash table.
 126  * If this is the first fragment seen for this datagram, a new entry
 127  * is created in the hash table, otherwise this fragment is just added
 128  * to the linked list of fragments for this packet.
 129  * The list of fragments for a specific datagram is kept sorted for
 130  * easier handling.
 131  *
 132  * Returns a pointer to the head of the fragment data list if we have all the
 133  * fragments, NULL otherwise.
 134  */
 135 extern fragment_data *fragment_add(tvbuff_t *tvb, const int offset, const packet_info *pinfo,
 136     const guint32 id, GHashTable *fragment_table, const guint32 frag_offset,
 137     guint32 const frag_data_len, const gboolean more_frags);
 138 extern fragment_data *fragment_add_multiple_ok(tvbuff_t *tvb, const int offset,
 139     const packet_info *pinfo, const guint32 id, GHashTable *fragment_table,
 140     const guint32 frag_offset, const guint32 frag_data_len, const gboolean more_frags);
 141
 142 /*
 143  * This routine extends fragment_add to use a "reassembled_table".
 144  *
 145  * If, after processing this fragment, we have all the fragments, they
 146  * remove that from the fragment hash table if necessary and add it
 147  * to the table of reassembled fragments, and return a pointer to the
 148  * head of the fragment list.
 149  */
 150 extern fragment_data *fragment_add_check(tvbuff_t *tvb, const int offset,
 151     const packet_info *pinfo, const guint32 id, GHashTable *fragment_table,
 152     GHashTable *reassembled_table, const guint32 frag_offset,
 153     const guint32 frag_data_len, const gboolean more_frags);
 154
 155 /* same as fragment_add() but this one assumes frag_number is a block
 156    sequence number. note that frag_number is 0 for the first fragment. */
 157
 158 /*
 159  * These functions add a new fragment to the fragment hash table,
 160  * assuming that frag_number is a block sequence number (starting from zero for
 161  * the first fragment of each datagram).
 162  *
 163  * If this is the first fragment seen for this datagram, a new
 164  * "fragment_data" structure is allocated to refer to the reassembled
 165  * packet, and:
 166  *
 167  *      if "more_frags" is false, and either we have no sequence numbers, or
 168  *      are using the 802.11 hack, it is assumed that this is the only fragment
 169  *      in the datagram. The structure is not added to the hash
 170  *      table, and not given any fragments to refer to, but is just returned.
 171  *
 172  *      In this latter case reassembly wasn't done (since there was only one
 173  *      fragment in the packet); dissectors can check the 'next' pointer on the
 174  *      returned list to see if this case was hit or not.
 175  *
 176  * Otherwise, this fragment is just added to the linked list of fragments
 177  * for this packet; the fragment_data is also added to the fragment hash if
 178  * necessary.
 179  *
 180  * If this packet completes assembly, these functions return the head of the
 181  * fragment data; otherwise, they return null.
 182  */
 183
 184 /* "key" should be an arbitrary key used for indexing the fragment hash;
 185  * "key_copier" is called to copy the key to a more appropriate store before
 186  * inserting a new entry to the hash.
 187  */
 188 extern fragment_data *
 189 fragment_add_seq_key(tvbuff_t *tvb, const int offset, const packet_info *pinfo,
 190                      void *key, fragment_key_copier key_copier,
 191                      GHashTable *fragment_table, guint32 frag_number,
 192                      const guint32 frag_data_len, const gboolean more_frags,
 193                      const guint32 flags);
 194
 195 /* a wrapper for fragment_add_seq_key - uses a key of source, dest and id */
 196 extern fragment_data *fragment_add_seq(tvbuff_t *tvb, const int offset, const packet_info *pinfo,
 197     const guint32 id, GHashTable *fragment_table, const guint32 frag_number,
 198     const guint32 frag_data_len, const gboolean more_frags);
 199
 200 /* another wrapper for fragment_add_seq_key - uses a key of source, dest, id
 201  * and act_id */
 202 extern fragment_data *
 203 fragment_add_dcerpc_dg(tvbuff_t *tvb, const int offset, const packet_info *pinfo, const guint32 id,
 204         void *act_id,
 205         GHashTable *fragment_table, const guint32 frag_number,
 206         const guint32 frag_data_len, const gboolean more_frags);
 207
 208 /*
 209  * These routines extend fragment_add_seq_key to use a "reassembled_table".
 210  *
 211  * If, after processing this fragment, we have all the fragments, they
 212  * remove that from the fragment hash table if necessary and add it
 213  * to the table of reassembled fragments, and return a pointer to the
 214  * head of the fragment list.
 215  */
 216 extern fragment_data *
 217 fragment_add_seq_check(tvbuff_t *tvb, const int offset,
 218                        const packet_info *pinfo, const guint32 id,
 219                        GHashTable *fragment_table,
 220                        GHashTable *reassembled_table, const guint32 frag_number,
 221                        const guint32 frag_data_len, const gboolean more_frags);
 222
 223 extern fragment_data *
 224 fragment_add_seq_802_11(tvbuff_t *tvb, const int offset,
 225                         const packet_info *pinfo, const guint32 id,
 226                         GHashTable *fragment_table,
 227                         GHashTable *reassembled_table,
 228                         const guint32 frag_number, const guint32 frag_data_len,
 229                         const gboolean more_frags);
 230
 231 extern fragment_data *
 232 fragment_add_seq_next(tvbuff_t *tvb, const int offset, const packet_info *pinfo,
 233                       const guint32 id, GHashTable *fragment_table,
 234                       GHashTable *reassembled_table,
 235                       const guint32 frag_data_len, const gboolean more_frags);
 236
 237 extern void
 238 fragment_start_seq_check(const packet_info *pinfo, const guint32 id, GHashTable *fragment_table,
 239                          const guint32 tot_len);
 240
 241 extern fragment_data *
 242 fragment_end_seq_next(const packet_info *pinfo, const guint32 id, GHashTable *fragment_table,
 243                       GHashTable *reassembled_table);
 244 /* to specify how much to reassemble, for fragmentation where last fragment can not be
 245  * identified by flags or such.
 246  * note that for FD_BLOCKSEQUENCE tot_len is the index for the tail fragment.
 247  * i.e. since the block numbers start at 0, if we specify tot_len==2, that
 248  * actually means we want to defragment 3 blocks, block 0, 1 and 2.
 249  *
 250  */
 251 extern void
 252 fragment_set_tot_len(const packet_info *pinfo, const guint32 id, GHashTable *fragment_table,
 253                      const guint32 tot_len);
 254
 255 /* to resad whatever totlen previously set */
 256 extern guint32
 257 fragment_get_tot_len(const packet_info *pinfo, const guint32 id, GHashTable *fragment_table);
 258
 259 /*
 260  * This function will set the partial reassembly flag(FD_PARTIAL_REASSEMBLY) for a fh.
 261  * When this function is called, the fh MUST already exist, i.e.
 262  * the fh MUST be created by the initial call to fragment_add() before
 263  * this function is called. Also note that this function MUST be called to indicate
 264  * a fh will be extended (increase the already stored data). After calling this function,
 265  * and if FD_DEFRAGMENTED is set, the reassembly process will be continued.
 266  */
 267 extern void
 268 fragment_set_partial_reassembly(const packet_info *pinfo, const guint32 id, GHashTable *fragment_table);
 269
 270 /* This function is used to check if there is partial or completed reassembly state
 271  * matching this packet. I.e. Are there reassembly going on or not for this packet?
 272  */
 273 extern fragment_data *
 274 fragment_get(const packet_info *pinfo, const guint32 id, GHashTable *fragment_table);
 275
 276 /* The same for the reassemble table */
 277 /* id *must* be the frame number for this to work! */
 278 extern fragment_data *
 279 fragment_get_reassembled(const guint32 id, GHashTable *reassembled_table);
 280
 281 extern fragment_data *
 282 fragment_get_reassembled_id(const packet_info *pinfo, const guint32 id, GHashTable *reassembled_table);
 283
 284 /* This will free up all resources and delete reassembly state for this PDU.
 285  * Except if the PDU is completely reassembled, then it would NOT deallocate the
 286  * buffer holding the reassembled data but instead return the pointer to that
 287  * buffer.
 288  *
 289  * So, if you call fragment_delete and it returns non-NULL, YOU are responsible to
 290  * g_free() that buffer.
 291  */
 292 extern unsigned char *
 293 fragment_delete(const packet_info *pinfo, const guint32 id, GHashTable *fragment_table);
 294
 295 /* hf_fragment, hf_fragment_error, and hf_reassembled_in should be
 296    FT_FRAMENUM, the others should be FT_BOOLEAN
 297 */
 298 typedef struct _fragment_items {
 299         gint    *ett_fragment;
 300         gint    *ett_fragments;
 301
 302         int     *hf_fragments;
 303         int     *hf_fragment;
 304         int     *hf_fragment_overlap;
 305         int     *hf_fragment_overlap_conflict;
 306         int     *hf_fragment_multiple_tails;
 307         int     *hf_fragment_too_long_fragment;
 308         int     *hf_fragment_error;
 309         int     *hf_fragment_count;
 310         int     *hf_reassembled_in;
 311         int     *hf_reassembled_length;
 312
 313         const char      *tag;
 314 } fragment_items;
 315
 316 extern tvbuff_t *
 317 process_reassembled_data(tvbuff_t *tvb, const int offset, packet_info *pinfo,
 318     const char *name, fragment_data *fd_head, const fragment_items *fit,
 319     gboolean *update_col_infop, proto_tree *tree);
 320
 321 extern gboolean
 322 show_fragment_tree(fragment_data *ipfd_head, const fragment_items *fit,
 323     proto_tree *tree, packet_info *pinfo, tvbuff_t *tvb, proto_item **fi);
 324
 325 extern gboolean
 326 show_fragment_seq_tree(fragment_data *ipfd_head, const fragment_items *fit,
 327     proto_tree *tree, packet_info *pinfo, tvbuff_t *tvb, proto_item **fi);