reassemble.h

   1 /* reassemble.h
   2  * Declarations of outines for {fragment,segment} reassembly
   3  *
   4  * $Id: reassemble.h,v 1.20 2003/08/28 04:19:29 guy Exp $
   5  *
   6  * Ethereal - Network traffic analyzer
   7  * By Gerald Combs <gerald@ethereal.com>
   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 alloced, 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 typedef struct _fragment_data {
  55         struct _fragment_data *next;
  56         guint32 frame;
  57         guint32 offset;
  58         guint32 len;
  59         guint32 datalen; /*Only valid in first item of list */
  60         guint32 reassembled_in; /* frame where this PDU was reassembled,
  61                                    only valid in the first item of the list
  62                                    and when FD_DEFRAGMENTED is set*/
  63         guint32 flags;
  64         unsigned char *data;
  65 } fragment_data;
  66
  67 /*
  68  * Initialize a fragment table.
  69  */
  70 extern void fragment_table_init(GHashTable **fragment_table);
  71
  72 /*
  73  * Initialize a reassembled-packet table.
  74  */
  75 extern void reassembled_table_init(GHashTable **reassembled_table);
  76
  77 /*
  78  * Free up all space allocated for fragment keys and data.
  79  */
  80 void reassemble_init(void);
  81
  82 /*
  83  * This function adds a new fragment to the fragment hash table.
  84  * If this is the first fragment seen for this datagram, a new entry
  85  * is created in the hash table, otherwise this fragment is just added
  86  * to the linked list of fragments for this packet.
  87  * The list of fragments for a specific datagram is kept sorted for
  88  * easier handling.
  89  *
  90  * Returns a pointer to the head of the fragment data list if we have all the
  91  * fragments, NULL otherwise.
  92  */
  93 extern fragment_data *fragment_add(tvbuff_t *tvb, int offset, packet_info *pinfo,
  94     guint32 id, GHashTable *fragment_table, guint32 frag_offset,
  95     guint32 frag_data_len, gboolean more_frags);
  96 extern fragment_data *fragment_add_multiple_ok(tvbuff_t *tvb, int offset,
  97     packet_info *pinfo, guint32 id, GHashTable *fragment_table,
  98     guint32 frag_offset, guint32 frag_data_len, gboolean more_frags);
  99
 100 extern fragment_data *fragment_add_check(tvbuff_t *tvb, int offset,
 101     packet_info *pinfo, guint32 id, GHashTable *fragment_table,
 102     GHashTable *reassembled_table, guint32 frag_offset,
 103     guint32 frag_data_len, gboolean more_frags);
 104
 105 /* same as fragment_add() but this one assumes frag_number is a block
 106    sequence number. note that frag_number is 0 for the first fragment. */
 107 extern fragment_data *fragment_add_seq(tvbuff_t *tvb, int offset, packet_info *pinfo,
 108     guint32 id, GHashTable *fragment_table, guint32 frag_number,
 109     guint32 frag_data_len, gboolean more_frags);
 110
 111 /*
 112  * These functions add a new fragment to the fragment hash table.
 113  * If this is the first fragment seen for this datagram, a new
 114  * "fragment_data" structure is allocated to refer to the reassembled,
 115  * packet, and:
 116  *
 117  *      if "more_frags" is false, the structure is not added to
 118  *      the hash table, and not given any fragments to refer to,
 119  *      but is just returned;
 120  *
 121  *      if "more_frags" is true, this fragment is added to the linked
 122  *      list of fragments for this packet, and the "fragment_data"
 123  *      structure is put into the hash table.
 124  *
 125  * Otherwise, this fragment is just added to the linked list of fragments
 126  * for this packet.
 127  *
 128  * They return a pointer to the head of the fragment data list, and removes
 129  * that from the fragment hash table if necessary and adds it to the
 130  * table of reassembled fragments, if we have all the fragments or if
 131  * this is the only fragment and "more_frags" is false, returns NULL
 132  * otherwise.
 133  *
 134  * They assumes frag_number is a block sequence number.
 135  * The bsn for the first block is 0.
 136  *
 137  * "fragment_add_seq_check()" takes the sequence number as an argument;
 138  * "fragment_add_seq_next()" is for protocols with no sequence number,
 139  * and assumes fragments always appear in sequence.
 140  */
 141 extern fragment_data *
 142 fragment_add_seq_check(tvbuff_t *tvb, int offset, packet_info *pinfo,
 143              guint32 id, GHashTable *fragment_table,
 144              GHashTable *reassembled_table, guint32 frag_number,
 145              guint32 frag_data_len, gboolean more_frags);
 146
 147 extern fragment_data *
 148 fragment_add_seq_next(tvbuff_t *tvb, int offset, packet_info *pinfo, guint32 id,
 149              GHashTable *fragment_table, GHashTable *reassembled_table,
 150              guint32 frag_data_len, gboolean more_frags);
 151
 152 /* to specify how much to reassemble, for fragmentation where last fragment can not be
 153  * identified by flags or such.
 154  * note that for FD_BLOCKSEQUENCE tot_len is the index for the tail fragment.
 155  * i.e. since the block numbers start at 0, if we specify tot_len==2, that
 156  * actually means we want to defragment 3 blocks, block 0, 1 and 2.
 157  *
 158  */
 159 extern void
 160 fragment_set_tot_len(packet_info *pinfo, guint32 id, GHashTable *fragment_table,
 161                      guint32 tot_len);
 162
 163 /* to resad whatever totlen previously set */
 164 extern guint32
 165 fragment_get_tot_len(packet_info *pinfo, guint32 id, GHashTable *fragment_table);
 166
 167 /*
 168  * This function will set the partial reassembly flag(FD_PARTIAL_REASSEMBLY) for a fh.
 169  * When this function is called, the fh MUST already exist, i.e.
 170  * the fh MUST be created by the initial call to fragment_add() before
 171  * this function is called. Also note that this function MUST be called to indicate
 172  * a fh will be extended (increase the already stored data). After calling this function,
 173  * and if FD_DEFRAGMENTED is set, the reassembly process will be continued.
 174  */
 175 extern void
 176 fragment_set_partial_reassembly(packet_info *pinfo, guint32 id, GHashTable *fragment_table);
 177
 178 /* This function is used to check if there is partial or completed reassembly state
 179  * matching this packet. I.e. Are there reassembly going on or not for this packet?
 180  */
 181 extern fragment_data *
 182 fragment_get(packet_info *pinfo, guint32 id, GHashTable *fragment_table);
 183
 184 /* This will free up all resources and delete reassembly state for this PDU.
 185  * Except if the PDU is completely reassembled, then it would NOT deallocate the
 186  * buffer holding the reassembled data but instead return the pointer to that
 187  * buffer.
 188  *
 189  * So, if you call fragment_delete and it returns non-NULL, YOU are responsible to
 190  * g_free() that buffer.
 191  */
 192 extern unsigned char *
 193 fragment_delete(packet_info *pinfo, guint32 id, GHashTable *fragment_table);
 194
 195 /* hf_fragment, hf_fragment_error, and hf_reassembled_in should be
 196    FT_FRAMENUM, the others should be FT_BOOLEAN
 197 */
 198 typedef struct _fragment_items {
 199         gint    *ett_fragment;
 200         gint    *ett_fragments;
 201
 202         int     *hf_fragments;
 203         int     *hf_fragment;
 204         int     *hf_fragment_overlap;
 205         int     *hf_fragment_overlap_conflict;
 206         int     *hf_fragment_multiple_tails;
 207         int     *hf_fragment_too_long_fragment;
 208         int     *hf_fragment_error;
 209         int     *hf_reassembled_in;
 210
 211         char    *tag;
 212 } fragment_items;
 213
 214 extern tvbuff_t *
 215 process_reassembled_data(tvbuff_t *tvb, int offset, packet_info *pinfo,
 216     char *name, fragment_data *fd_head, const fragment_items *fit,
 217     gboolean *update_col_infop, proto_tree *tree);
 218
 219 extern gboolean
 220 show_fragment_tree(fragment_data *ipfd_head, const fragment_items *fit,
 221     proto_tree *tree, packet_info *pinfo, tvbuff_t *tvb);
 222
 223 extern gboolean
 224 show_fragment_seq_tree(fragment_data *ipfd_head, const fragment_items *fit,
 225     proto_tree *tree, packet_info *pinfo, tvbuff_t *tvb);