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