epan/packet_info.h

   1 /* packet_info.h
   2  * Definitions for packet info structures and routines
   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 #ifndef __PACKET_INFO_H__
  26 #define __PACKET_INFO_H__
  27
  28 #include "frame_data.h"
  29 #include "tvbuff.h"
  30 #include "address.h"
  31
  32 /* Also defined in wiretap/wtap.h */
  33 #define P2P_DIR_UNKNOWN -1
  34 #define P2P_DIR_SENT    0
  35 #define P2P_DIR_RECV    1
  36
  37 /* Link direction */
  38 #define LINK_DIR_UNKNOWN        -1
  39 #define P2P_DIR_UL      0
  40 #define P2P_DIR_DL      1
  41
  42 #define PINFO_SOF_FIRST_FRAME   0x1
  43 #define PINFO_SOF_SOFF          0x2
  44 #define PINFO_EOF_LAST_FRAME    0x80
  45 #define PINFO_EOF_INVALID       0x40
  46 #define MAX_NUMBER_OF_PPIDS     2
  47
  48 typedef struct _packet_info {
  49   const char *current_proto;    /* name of protocol currently being dissected */
  50   column_info *cinfo;           /* Column formatting information */
  51   frame_data *fd;
  52   union wtap_pseudo_header *pseudo_header;
  53   GSList *data_src;             /* Frame data sources */
  54   address dl_src;               /* link-layer source address */
  55   address dl_dst;               /* link-layer destination address */
  56   address net_src;              /* network-layer source address */
  57   address net_dst;              /* network-layer destination address */
  58   address src;                  /* source address (net if present, DL otherwise )*/
  59   address dst;                  /* destination address (net if present, DL otherwise )*/
  60   guint32 ethertype;            /* Ethernet Type Code, if this is an Ethernet packet */
  61   guint32 ipproto;              /* IP protocol, if this is an IP packet */
  62   guint32 ipxptype;             /* IPX packet type, if this is an IPX packet */
  63   guint32 mpls_label;           /* last mpls label in label stack, if this is a MPLS packet */
  64   circuit_type ctype;           /* type of circuit, for protocols with a VC identifier */
  65   guint32 circuit_id;           /* circuit ID, for protocols with a VC identifier */
  66   const char *noreassembly_reason;  /* reason why reassembly wasn't done, if any */
  67   gboolean fragmented;          /* TRUE if the protocol is only a fragment */
  68   struct {
  69     guint32 in_error_pkt:1;     /* TRUE if we're inside an {ICMP,CLNP,...} error packet */
  70     guint32 in_gre_pkt:1;       /* TRUE if we're encapsulated inside a GRE packet */
  71   } flags;
  72   port_type ptype;              /* type of the following two port numbers */
  73   guint32 srcport;              /* source port */
  74   guint32 destport;             /* destination port */
  75   guint32 match_uint;           /* matched uint for calling subdissector from table */
  76   const char *match_string;     /* matched string for calling subdissector from table */
  77   guint16 can_desegment;        /* >0 if this segment could be desegmented.
  78                                    A dissector that can offer this API (e.g.
  79                                    TCP) sets can_desegment=2, then
  80                                    can_desegment is decremented by 1 each time
  81                                    we pass to the next subdissector. Thus only
  82                                    the dissector immediately above the
  83                                    protocol which sets the flag can use it*/
  84   guint16 saved_can_desegment;  /* Value of can_desegment before current
  85                                    dissector was called.  Supplied so that
  86                                    dissectors for proxy protocols such as
  87                                    SOCKS can restore it, allowing the
  88                                    dissectors that they call to use the
  89                                    TCP dissector's desegmentation (SOCKS
  90                                    just retransmits TCP segments once it's
  91                                    finished setting things up, so the TCP
  92                                    desegmentor can desegment its payload). */
  93   int desegment_offset;         /* offset to stuff needing desegmentation */
  94 #define DESEGMENT_ONE_MORE_SEGMENT 0x0fffffff
  95 #define DESEGMENT_UNTIL_FIN        0x0ffffffe
  96   guint32 desegment_len;        /* requested desegmentation additional length
  97                                    or
  98                                    DESEGMENT_ONE_MORE_SEGMENT:
  99                                      Desegment one more full segment
 100                                      (warning! only partially implemented)
 101                                    DESEGMENT_UNTIL_FIN:
 102                                      Desgment all data for this tcp session
 103                                      until the FIN segment.
 104                                 */
 105   guint16 want_pdu_tracking;    /* >0 if the subdissector has specified
 106                                    a value in 'bytes_until_next_pdu'.
 107                                    When a dissector detects that the next PDU
 108                                    will start beyond the start of the next
 109                                    segment, it can set this value to 2
 110                                    and 'bytes_until_next_pdu' to the number of
 111                                    bytes beyond the next segment where the
 112                                    next PDU starts.
 113
 114                                    If the protocol dissector below this
 115                                    one is capable of PDU tracking it can
 116                                    use this hint to detect PDUs that starts
 117                                    unaligned to the segment boundaries.
 118                                    The TCP dissector is using this hint from
 119                                    (some) protocols to detect when a new PDU
 120                                    starts in the middle of a tcp segment.
 121
 122                                    There is intelligence in the glue between
 123                                    dissector layers to make sure that this
 124                                    request is only passed down to the protocol
 125                                    immediately below the current one and not
 126                                    any further.
 127                                 */
 128   guint32 bytes_until_next_pdu;
 129
 130
 131   int     iplen;                /* total length of IP packet */
 132   int     iphdrlen;             /* length of IP header */
 133   guint8  ip_ttl;               /* IP time to live */
 134   int     p2p_dir;              /* Packet was captured as an
 135                                        outbound (P2P_DIR_SENT)
 136                                        inbound (P2P_DIR_RECV)
 137                                        unknown (P2P_DIR_UNKNOWN) */
 138   guint16 oxid;                 /* next 2 fields reqd to identify fibre */
 139   guint16 rxid;                 /* channel conversations */
 140   guint8  r_ctl;                /* R_CTL field in Fibre Channel Protocol */
 141   guint8  sof_eof;              /* FC's SOF/EOF encoding passed to FC decoder
 142                                  * Bit 7 set if Last frame in sequence
 143                                  * Bit 6 set if invalid frame content
 144                                  * Bit 2 set if SOFf
 145                                  * Bit 1 set if first frame in sequence
 146                                  */
 147   guint16 src_idx;              /* Source port index (Cisco MDS-specific) */
 148   guint16 dst_idx;              /* Dest port index (Cisco MDS-specific) */
 149   guint16 vsan;                 /* Fibre channel/Cisco MDS-specific */
 150
 151   /* Extra data for DCERPC handling and tracking of context ids */
 152   guint16 dcectxid;             /* Context ID (DCERPC-specific) */
 153   int     dcetransporttype;     /* Transport type
 154                                  * Value -1 means "not a DCERPC packet"
 155                                  */
 156   guint16 dcetransportsalt;     /* fid: if transporttype==DCE_CN_TRANSPORT_SMBPIPE */
 157
 158   /* Extra data for handling of decryption of GSSAPI wrapped tvbuffs.
 159      Caller sets decrypt_gssapi_tvb if this service is requested.
 160      If gssapi_encrypted_tvb is NULL, then the rest of the tvb data following
 161      the gssapi blob itself is decrypted othervise the gssapi_encrypted_tvb
 162      tvb will be decrypted (DCERPC has the data before the gssapi blob)
 163      If, on return, gssapi_data_encrypted is FALSE, the wrapped tvbuff
 164      was signed (i.e., an encrypted signature was present, to check
 165      whether the data was modified by a man in the middle) but not sealed
 166      (i.e., the data itself wasn't encrypted).
 167   */
 168 #define DECRYPT_GSSAPI_NORMAL   1
 169 #define DECRYPT_GSSAPI_DCE      2
 170   guint16 decrypt_gssapi_tvb;
 171   tvbuff_t *gssapi_wrap_tvb;
 172   tvbuff_t *gssapi_encrypted_tvb;
 173   tvbuff_t *gssapi_decrypted_tvb;
 174   gboolean gssapi_data_encrypted;
 175
 176   guint32 ppid;  /* SCTP PPI of current DATA chunk */
 177   guint32 ppids[MAX_NUMBER_OF_PPIDS]; /* The first NUMBER_OF_PPIDS PPIDS which are present
 178                                       * in the SCTP packet
 179                                       */
 180   void    *private_data;        /* pointer to data passed from one dissector to another */
 181   GHashTable *private_table;    /* a hash table passed from one dissector to another */
 182   /* TODO: Use emem_strbuf_t instead */
 183   GString *layer_names;         /* layers of each protocol */
 184   guint16 link_number;
 185   guint8  annex_a_used;
 186   guint16 profinet_type;        /* the type of PROFINET packet (0: not a PROFINET packet) */
 187   void *profinet_conv;      /* the PROFINET conversation data (NULL: not a PROFINET packet) */
 188   void *usb_conv_info;
 189   void *tcp_tree;               /* proto_tree for the tcp layer */
 190
 191   const char *dcerpc_procedure_name;    /* Used by PIDL to store the name of the current dcerpc procedure */
 192
 193   struct _sccp_msg_info_t* sccp_info;
 194   guint16 clnp_srcref;      /* clnp/cotp source reference (can't use srcport, this would confuse tpkt) */
 195   guint16 clnp_dstref;      /* clnp/cotp destination reference (can't use dstport, this would confuse tpkt) */
 196
 197   guint16 zbee_cluster_id;  /* ZigBee cluster ID, an application-specific message identifier that
 198                              * happens to be included in the transport (APS) layer header.
 199                              */
 200   guint8 zbee_stack_vers;   /* ZigBee stack version number, present in the ZigBee network layer, but
 201                              * impacts the packet format at all layers of the ZigBee stack.
 202                              */
 203   int link_dir;             /* 3GPP messages are sometime different UP link(UL) or Downlink(DL) */
 204   GSList* dependent_frames;     /* A list of frames which this one depends on */
 205 } packet_info;
 206
 207 /* For old code that hasn't yet been changed. */
 208 #define match_port      match_uint
 209
 210 #endif /* __PACKET_INFO_H__ */