Wireshark 4.5.0
The Wireshark network protocol analyzer
Loading...
Searching...
No Matches
conversation.h
Go to the documentation of this file.
1/* conversation.h
2 * Routines for building lists of packets that are part of a "conversation"
3 *
4 * Wireshark - Network traffic analyzer
5 * By Gerald Combs <[email protected]>
6 * Copyright 1998 Gerald Combs
7 *
8 * SPDX-License-Identifier: GPL-2.0-or-later
9 */
10
11#ifndef __CONVERSATION_H__
12#define __CONVERSATION_H__
13
14#include "ws_symbol_export.h"
15
16#include "packet.h" /* for conversation dissector type */
17#include <epan/wmem_scopes.h>
18
19#ifdef __cplusplus
20extern "C" {
21#endif /* __cplusplus */
22
41#define NO_ADDR2 0x01
42#define NO_PORT2 0x02
43#define NO_PORT2_FORCE 0x04
44#define CONVERSATION_TEMPLATE 0x08
45#define NO_PORTS 0x010
46
51#define NO_MASK_B 0xFFFF0000
52#define NO_ADDR_B 0x00010000
53#define NO_PORT_B 0x00020000
54#define NO_PORT_X 0x00040000
55#define NO_ANC 0x00080000
56
58#define USE_LAST_ENDPOINT 0x08
60/* Types of conversations Wireshark knows about. */
61/* XXX: There should be a way to register conversation types used only
62 * within one dissector, similar to address types, instead of changing
63 * the global typedef.
64 */
65typedef enum {
66 CONVERSATION_NONE, /* no conversation key */
67 CONVERSATION_SCTP, /* SCTP */
68 CONVERSATION_TCP, /* TCP address/port pairs */
69 CONVERSATION_UDP, /* UDP address/port pairs */
70 CONVERSATION_DCCP, /* DCCP */
71 CONVERSATION_IPX, /* IPX sockets */
72 CONVERSATION_NCP, /* NCP connection */
73 CONVERSATION_EXCHG, /* Fibre Channel exchange */
74 CONVERSATION_DDP, /* DDP AppleTalk address/port pair */
75 CONVERSATION_SBCCS, /* FICON */
76 CONVERSATION_IDP, /* XNS IDP sockets */
77 CONVERSATION_TIPC, /* TIPC PORT */
78 CONVERSATION_USB, /* USB endpoint 0xffff means the host */
79 CONVERSATION_I2C,
80 CONVERSATION_IBQP, /* Infiniband QP number */
81 CONVERSATION_BLUETOOTH,
82 CONVERSATION_TDMOP,
83 CONVERSATION_DVBCI,
84 CONVERSATION_ISO14443,
85 CONVERSATION_ISDN, /* ISDN channel number */
86 CONVERSATION_H223, /* H.223 logical channel number */
87 CONVERSATION_X25, /* X.25 logical channel number */
88 CONVERSATION_IAX2, /* IAX2 call id */
89 CONVERSATION_DLCI, /* Frame Relay DLCI */
90 CONVERSATION_ISUP, /* ISDN User Part CIC */
91 CONVERSATION_BICC, /* BICC Circuit identifier */
92 CONVERSATION_GSMTAP,
93 CONVERSATION_IUUP,
94 CONVERSATION_DVBBBF, /* DVB Base Band Frame ISI/PLP_ID */
95 CONVERSATION_IWARP_MPA, /* iWarp MPA */
96 CONVERSATION_BT_UTP, /* BitTorrent uTP Connection ID */
97 CONVERSATION_LOG, /* Logging source */
98 CONVERSATION_LTP, /* LTP Engine ID and Session Number */
99 CONVERSATION_MCTP,
100 CONVERSATION_NVME_MI, /* NVMe management interface */
101 CONVERSATION_BP, /* Bundle Protocol endpoint IDs */
102 CONVERSATION_SNMP, /* SNMP */
103 CONVERSATION_QUIC, /* QUIC */
104 CONVERSATION_IDN,
105 CONVERSATION_IP, /* IP */
106 CONVERSATION_IPV6, /* IPv6 */
107 CONVERSATION_ETH, /* ETHERNET classic */
108 CONVERSATION_ETH_NN, /* ETHERNET deinterlaced Interface:N VLAN:N */
109 CONVERSATION_ETH_NV, /* ETHERNET deinterlaced Interface:N VLAN:Y */
110 CONVERSATION_ETH_IN, /* ETHERNET deinterlaced Interface:Y VLAN:N */
111 CONVERSATION_ETH_IV, /* ETHERNET deinterlaced Interface:Y VLAN:Y */
112 CONVERSATION_VSPC_VMOTION, /* VMware vSPC vMotion (Telnet) */
113 CONVERSATION_OPENVPN,
114 CONVERSATION_PROXY,
115 CONVERSATION_DNP3
116} conversation_type;
117
118/*
119 * XXX - for now, we just #define these to be the same as the
120 * corresponding CONVERSATION_ values, for backwards source
121 * compatibility.
122 *
123 * In the long term, we should make this into a separate enum,
124 * with elements corresponding to conversation types that do
125 * not have known endpoints removed.
126 */
127/* Types of conversation endpoints Wireshark knows about. */
128#define ENDPOINT_NONE CONVERSATION_NONE
129#define ENDPOINT_SCTP CONVERSATION_SCTP
130#define ENDPOINT_TCP CONVERSATION_TCP
131#define ENDPOINT_UDP CONVERSATION_UDP
132#define ENDPOINT_DCCP CONVERSATION_DCCP
133#define ENDPOINT_IPX CONVERSATION_IPX
134#define ENDPOINT_NCP CONVERSATION_NCP
135#define ENDPOINT_EXCHG CONVERSATION_EXCHG
136#define ENDPOINT_DDP CONVERSATION_DDP
137#define ENDPOINT_SBCCS CONVERSATION_SBCCS
138#define ENDPOINT_IDP CONVERSATION_IDP
139#define ENDPOINT_TIPC CONVERSATION_TIPC
140#define ENDPOINT_USB CONVERSATION_USB
141#define ENDPOINT_I2C CONVERSATION_I2C
142#define ENDPOINT_IBQP CONVERSATION_IBQP
143#define ENDPOINT_BLUETOOTH CONVERSATION_BLUETOOTH
144#define ENDPOINT_TDMOP CONVERSATION_TDMOP
145#define ENDPOINT_DVBCI CONVERSATION_DVBCI
146#define ENDPOINT_ISO14443 CONVERSATION_ISO14443
147#define ENDPOINT_ISDN CONVERSATION_ISDN
148#define ENDPOINT_H223 CONVERSATION_H223
149#define ENDPOINT_X25 CONVERSATION_X25
150#define ENDPOINT_IAX2 CONVERSATION_IAX2
151#define ENDPOINT_DLCI CONVERSATION_DLCI
152#define ENDPOINT_ISUP CONVERSATION_ISUP
153#define ENDPOINT_BICC CONVERSATION_BICC
154#define ENDPOINT_GSMTAP CONVERSATION_GSMTAP
155#define ENDPOINT_IUUP CONVERSATION_IUUP
156#define ENDPOINT_DVBBBF CONVERSATION_DVBBBF
157#define ENDPOINT_IWARP_MPA CONVERSATION_IWARP_MPA
158#define ENDPOINT_BT_UTP CONVERSATION_BT_UTP
159#define ENDPOINT_LOG CONVERSATION_LOG
160#define ENDPOINT_MCTP CONVERSATION_MCTP
161#define ENDPOINT_NVME_MI CONVERSATION_NVME_MI
162#define ENDPOINT_SNMP CONVERSATION_SNMP
163
164typedef conversation_type endpoint_type;
165
169typedef enum {
170 CE_CONVERSATION_TYPE, /* CONVERSATION_ value */
171 CE_ADDRESS, /* address */
172 CE_PORT, /* unsigned integer representing a port */
173 CE_STRING, /* string */
174 CE_UINT, /* unsigned integer not representing a port */
175 CE_UINT64, /* 64-bit unsigned integer */
176 CE_INT, /* signed integer */
177 CE_INT64, /* signed integer */
178 CE_BLOB, /* arbitrary binary data */
180
202typedef struct conversation_element {
204 union {
205 conversation_type conversation_type_val;
206 address addr_val;
207 unsigned int port_val;
208 const char *str_val;
209 unsigned int uint_val;
210 uint64_t uint64_val;
211 int int_val;
212 int64_t int64_val;
213 struct {
214 const uint8_t *val;
215 size_t len;
216 } blob;
217 };
219
223typedef struct conversation {
224 struct conversation *next;
227 uint32_t conv_index;
228 uint32_t setup_frame;
229 /* Assume that setup_frame is also the lowest frame number for now. */
230 uint32_t last_frame;
233 unsigned options;
236
237/*
238 * For some protocols, we store, in the packet_info structure, a pair
239 * of address/port endpoints, for use by code that might want to
240 * construct a conversation for that protocol.
241 *
242 * This appears to have been done in order to allow protocols to save
243 * that information *without* overwriting the addresses or ports in the
244 * packet_info structure, so that the other code that uses those values,
245 * such as the code that fills in the address and port columns in the
246 * packet summary, will pick up the values put there by protocols such
247 * as IP and UDP, rather than the values put there by protocols such as
248 * TDMoP, FCIP, TIPC, and DVB Dynamic Mode Adaptation. See commit
249 * 66b441f3d63e21949530d672bf1406dea94ed254 and issue #11340.
250 *
251 * That is set by conversation_set_conv_addr_port_endpoints().
252 *
253 * In find_conversation_pinfo() and find_or_create_conversation(), if
254 * any dissector has set this, that address/port endpoint pair is used
255 * to look up or create the conversation.
256 *
257 * Prior to 4.0, conversations identified by a single integer value
258 * (such as a circuit ID) were handled by creating a pair of address/port
259 * endpoints with null addresses, the first port equal to the integer
260 * value, the second port missing, and a port type being an ENDPOINT_
261 * type specifying the protocol for the conversation. Now we use an
262 * array of elements, with a CE_UINT value for the integer followed
263 * by a CE_CONVERSATION_TYPE value specifying the protocol for the
264 * conversation.
265 *
266 * XXX - is there any reason why we shouldn't use an array of conversation
267 * elements, with the appropriate addresses and ports, instead of this
268 * structure? It would at least simplify find_conversation_pinfo() and
269 * find_or_create_conversation().
270 */
273
274WS_DLL_PUBLIC const address* conversation_key_addr1(const conversation_element_t *key);
275WS_DLL_PUBLIC uint32_t conversation_key_port1(const conversation_element_t *key);
276WS_DLL_PUBLIC const address* conversation_key_addr2(const conversation_element_t *key);
277WS_DLL_PUBLIC uint32_t conversation_key_port2(const conversation_element_t *key);
278
282extern void conversation_init(void);
283
287extern void conversation_epan_reset(void);
288
295WS_DLL_PUBLIC WS_RETNONNULL conversation_t *conversation_new_full(const uint32_t setup_frame, conversation_element_t *elements);
296
316WS_DLL_PUBLIC WS_RETNONNULL conversation_t *conversation_new(const uint32_t setup_frame, const address *addr1, const address *addr2,
317 const conversation_type ctype, const uint32_t port1, const uint32_t port2, const unsigned options);
318
319WS_DLL_PUBLIC WS_RETNONNULL conversation_t *conversation_new_by_id(const uint32_t setup_frame, const conversation_type ctype, const uint32_t id);
320
324WS_DLL_PUBLIC WS_RETNONNULL conversation_t *conversation_new_deinterlaced(const uint32_t setup_frame, const address *addr1, const address *addr2,
325 const conversation_type ctype, const uint32_t port1, const uint32_t port2, const uint32_t anchor, const unsigned options);
326
340WS_DLL_PUBLIC WS_RETNONNULL conversation_t *conversation_new_deinterlacer(const uint32_t setup_frame, const address *addr1, const address *addr2,
341 const conversation_type ctype, const uint32_t key1, const uint32_t key2, const uint32_t key3);
342
353WS_DLL_PUBLIC WS_RETNONNULL conversation_t *conversation_new_strat(packet_info *pinfo, const conversation_type ctype, const unsigned options);
354
361WS_DLL_PUBLIC conversation_t *find_conversation_full(const uint32_t frame_num, conversation_element_t *elements);
362
410WS_DLL_PUBLIC conversation_t *find_conversation(const uint32_t frame_num, const address *addr_a, const address *addr_b,
411 const conversation_type ctype, const uint32_t port_a, const uint32_t port_b, const unsigned options);
412
413WS_DLL_PUBLIC conversation_t *find_conversation_deinterlaced(const uint32_t frame_num, const address *addr_a, const address *addr_b,
414 const conversation_type ctype, const uint32_t port_a, const uint32_t port_b, const uint32_t anchor, const unsigned options);
415
416WS_DLL_PUBLIC conversation_t *find_conversation_deinterlacer(const uint32_t frame_num, const address *addr_a, const address *addr_b,
417 const conversation_type ctype, const uint32_t key_a, const uint32_t key_b, const uint32_t key_c);
418
425
426WS_DLL_PUBLIC conversation_t *find_conversation_by_id(const uint32_t frame, const conversation_type ctype, const uint32_t id);
427
432WS_DLL_PUBLIC conversation_t *find_conversation_strat(const packet_info *pinfo, const conversation_type ctype, const unsigned options);
433
437WS_DLL_PUBLIC conversation_t *find_conversation_pinfo(const packet_info *pinfo, const unsigned options);
438
445WS_DLL_PUBLIC conversation_t *find_conversation_pinfo_ro(const packet_info *pinfo, const unsigned options);
446
457WS_DLL_PUBLIC WS_RETNONNULL conversation_t *find_or_create_conversation(packet_info *pinfo);
458
463WS_DLL_PUBLIC WS_RETNONNULL conversation_t *find_or_create_conversation_by_id(packet_info *pinfo, const conversation_type ctype, const uint32_t id);
464
470WS_DLL_PUBLIC void conversation_add_proto_data(conversation_t *conv, const int proto, void *proto_data);
471
477WS_DLL_PUBLIC void *conversation_get_proto_data(const conversation_t *conv, const int proto);
478
483WS_DLL_PUBLIC void conversation_delete_proto_data(conversation_t *conv, const int proto);
484
485WS_DLL_PUBLIC void conversation_set_dissector(conversation_t *conversation, const dissector_handle_t handle);
486
487WS_DLL_PUBLIC void conversation_set_dissector_from_frame_number(conversation_t *conversation,
488 const uint32_t starting_frame_num, const dissector_handle_t handle);
489
490WS_DLL_PUBLIC dissector_handle_t conversation_get_dissector(conversation_t *conversation, const uint32_t frame_num);
491
503WS_DLL_PUBLIC void conversation_set_conv_addr_port_endpoints(struct _packet_info *pinfo, address* addr1, address* addr2,
504 conversation_type ctype, uint32_t port1, uint32_t port2);
505
514WS_DLL_PUBLIC void conversation_set_elements_by_id(struct _packet_info *pinfo,
515 conversation_type ctype, uint32_t id);
516
525WS_DLL_PUBLIC uint32_t conversation_get_id_from_elements(struct _packet_info *pinfo,
526 conversation_type ctype, const unsigned options);
527
538WS_DLL_PUBLIC bool try_conversation_dissector(const address *addr_a, const address *addr_b, const conversation_type ctype,
539 const uint32_t port_a, const uint32_t port_b, tvbuff_t *tvb, packet_info *pinfo,
540 proto_tree *tree, void* data, const unsigned options);
541
542WS_DLL_PUBLIC bool try_conversation_dissector_by_id(const conversation_type ctype, const uint32_t id, tvbuff_t *tvb,
543 packet_info *pinfo, proto_tree *tree, void* data);
544
545/* These routines are used to set undefined values for a conversation */
546
552WS_DLL_PUBLIC void conversation_set_port2(conversation_t *conv, const uint32_t port);
553
559WS_DLL_PUBLIC void conversation_set_addr2(conversation_t *conv, const address *addr);
560
567WS_DLL_PUBLIC wmem_map_t *get_conversation_hashtables(void);
568
569/* Temporary function to handle port_type to conversation_type conversion
570 For now it's a 1-1 mapping, but the intention is to remove
571 many of the port_type instances in favor of conversation_type
572 */
573WS_DLL_PUBLIC conversation_type conversation_pt_to_conversation_type(port_type pt);
574
575/* Temporary function to handle port_type to endpoint_type conversion
576 For now it's a 1-1 mapping, but the intention is to remove
577 many of the port_type instances in favor of endpoint_type
578 */
579WS_DLL_PUBLIC endpoint_type conversation_pt_to_endpoint_type(port_type pt);
580
581#ifdef __cplusplus
582}
583#endif /* __cplusplus */
584
585#endif /* conversation.h */
WS_DLL_PUBLIC bool try_conversation_dissector(const address *addr_a, const address *addr_b, const conversation_type ctype, const uint32_t port_a, const uint32_t port_b, tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, void *data, const unsigned options)
Definition conversation.c:2172
WS_DLL_PUBLIC conversation_t * find_conversation_full(const uint32_t frame_num, conversation_element_t *elements)
Definition conversation.c:1361
void conversation_epan_reset(void)
Definition conversation.c:698
WS_DLL_PUBLIC void * conversation_get_proto_data(const conversation_t *conv, const int proto)
Definition conversation.c:2090
struct conversation conversation_t
WS_DLL_PUBLIC conversation_t * find_conversation_deinterlacer_pinfo(const packet_info *pinfo)
Definition conversation.c:2024
WS_DLL_PUBLIC void conversation_set_addr2(conversation_t *conv, const address *addr)
Definition conversation.c:1287
WS_DLL_PUBLIC WS_RETNONNULL conversation_t * find_or_create_conversation_by_id(packet_info *pinfo, const conversation_type ctype, const uint32_t id)
Definition conversation.c:2408
WS_DLL_PUBLIC conversation_t * find_conversation_strat(const packet_info *pinfo, const conversation_type ctype, const unsigned options)
Definition conversation.c:2253
WS_DLL_PUBLIC void conversation_set_conv_addr_port_endpoints(struct _packet_info *pinfo, address *addr1, address *addr2, conversation_type ctype, uint32_t port1, uint32_t port2)
Definition conversation.c:2426
WS_DLL_PUBLIC void conversation_set_elements_by_id(struct _packet_info *pinfo, conversation_type ctype, uint32_t id)
Definition conversation.c:2446
WS_DLL_PUBLIC WS_RETNONNULL conversation_t * find_or_create_conversation(packet_info *pinfo)
Definition conversation.c:2380
WS_DLL_PUBLIC WS_RETNONNULL conversation_t * conversation_new_full(const uint32_t setup_frame, conversation_element_t *elements)
Definition conversation.c:825
WS_DLL_PUBLIC void conversation_delete_proto_data(conversation_t *conv, const int proto)
Definition conversation.c:2104
struct conversation_element conversation_element_t
WS_DLL_PUBLIC WS_RETNONNULL conversation_t * conversation_new_deinterlacer(const uint32_t setup_frame, const address *addr1, const address *addr2, const conversation_type ctype, const uint32_t key1, const uint32_t key2, const uint32_t key3)
Definition conversation.c:1104
WS_DLL_PUBLIC conversation_t * find_conversation_pinfo(const packet_info *pinfo, const unsigned options)
Definition conversation.c:2277
WS_DLL_PUBLIC conversation_t * find_conversation_pinfo_ro(const packet_info *pinfo, const unsigned options)
Definition conversation.c:2332
WS_DLL_PUBLIC uint32_t conversation_get_id_from_elements(struct _packet_info *pinfo, conversation_type ctype, const unsigned options)
Get the ID value from the conversation elements in the packet info.
Definition conversation.c:2456
WS_DLL_PUBLIC conversation_t * find_conversation(const uint32_t frame_num, const address *addr_a, const address *addr_b, const conversation_type ctype, const uint32_t port_a, const uint32_t port_b, const unsigned options)
Definition conversation.c:1564
WS_DLL_PUBLIC void conversation_set_port2(conversation_t *conv, const uint32_t port)
Definition conversation.c:1243
void conversation_init(void)
Definition conversation.c:539
conversation_element_type
Definition conversation.h:169
WS_DLL_PUBLIC wmem_map_t * get_conversation_hashtables(void)
Get a hash table of conversation hash table.
Definition conversation.c:2474
WS_DLL_PUBLIC void conversation_add_proto_data(conversation_t *conv, const int proto, void *proto_data)
Definition conversation.c:2077
WS_DLL_PUBLIC WS_RETNONNULL conversation_t * conversation_new(const uint32_t setup_frame, const address *addr1, const address *addr2, const conversation_type ctype, const uint32_t port1, const uint32_t port2, const unsigned options)
Definition conversation.c:869
WS_DLL_PUBLIC WS_RETNONNULL conversation_t * conversation_new_strat(packet_info *pinfo, const conversation_type ctype, const unsigned options)
Definition conversation.c:1059
Definition address.h:56
Definition packet_info.h:43
Definition proto.h:901
Definition wmem_map.c:44
Definition wmem_tree-int.h:48
Definition conversation.c:49
Definition conversation.h:202
Definition conversation.h:223
wmem_tree_t * dissector_tree
Definition conversation.h:232
struct conversation * last
Definition conversation.h:225
struct conversation * latest_found
Definition conversation.h:226
uint32_t setup_frame
Definition conversation.h:228
unsigned options
Definition conversation.h:233
wmem_tree_t * data_list
Definition conversation.h:231
uint32_t last_frame
Definition conversation.h:230
uint32_t conv_index
Definition conversation.h:227
conversation_element_t * key_ptr
Definition conversation.h:234
Definition packet.c:763
Definition tvbuff-int.h:35