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