1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
|
/** @file
*
* Copyright 1998 Mike Hall <mlh@io.com>
*
* Wireshark - Network traffic analyzer
* By Gerald Combs <gerald@wireshark.org>
* Copyright 1998 Gerald Combs
*
* SPDX-License-Identifier: GPL-2.0-or-later
*
*/
#ifndef __FOLLOW_H__
#define __FOLLOW_H__
#include <epan/epan.h>
#include <epan/packet.h>
#include <wsutil/inet_cidr.h>
#include <epan/tap.h>
#include <epan/wmem_scopes.h>
#include "ws_symbol_export.h"
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
/* Show Stream */
typedef enum {
FROM_CLIENT,
FROM_SERVER,
BOTH_HOSTS
} show_stream_t;
typedef union _stream_addr {
uint32_t ipv4;
ws_in6_addr ipv6;
} stream_addr;
struct _follow_info;
#define SUBSTREAM_UNUSED UINT64_C(0xFFFFFFFFFFFFFFFF)
typedef struct {
bool is_server;
uint32_t packet_num;
uint32_t seq; /* TCP only */
nstime_t abs_ts; /**< Packet absolute time stamp */
GByteArray *data;
} follow_record_t;
typedef struct _follow_info {
show_stream_t show_stream;
char *filter_out_filter;
GList *payload; /* "follow_record_t" entries, in reverse order. */
unsigned bytes_written[2]; /* Index with FROM_CLIENT or FROM_SERVER for readability. */
uint32_t seq[2]; /* TCP only */
GList *fragments[2]; /* TCP only */
unsigned client_port;
unsigned server_port;
address client_ip;
address server_ip;
void* gui_data;
uint64_t substream_id; /**< Sub-stream; used only by HTTP2 and QUIC */
} follow_info_t;
struct register_follow;
typedef struct register_follow register_follow_t;
typedef char* (*follow_conv_filter_func)(epan_dissect_t *edt, packet_info *pinfo, unsigned *stream, unsigned *sub_stream);
typedef char* (*follow_index_filter_func)(unsigned stream, unsigned sub_stream);
typedef char* (*follow_address_filter_func)(address* src_addr, address* dst_addr, int src_port, int dst_port);
typedef char* (*follow_port_to_display_func)(wmem_allocator_t *allocator, unsigned port);
typedef uint32_t (*follow_stream_count_func)(void);
typedef bool (*follow_sub_stream_id_func)(unsigned stream, unsigned sub_stream, bool le, unsigned *sub_stream_out);
WS_DLL_PUBLIC
void register_follow_stream(const int proto_id, const char* tap_listener,
follow_conv_filter_func conv_filter, follow_index_filter_func index_filter, follow_address_filter_func address_filter,
follow_port_to_display_func port_to_display, tap_packet_cb tap_handler,
follow_stream_count_func stream_count, follow_sub_stream_id_func sub_stream_id);
/** Get protocol ID from registered follower
*
* @param follower Registered follower
* @return protocol id of follower
*/
WS_DLL_PUBLIC int get_follow_proto_id(register_follow_t* follower);
/** Get tap name string from registered follower (used for register_tap_listener)
*
* @param follower Registered follower
* @return tap name string of follower
*/
WS_DLL_PUBLIC const char* get_follow_tap_string(register_follow_t* follower);
/** Get a registered follower by protocol short name
*
* @param proto_short_name Protocol short name
* @return tap registered follower if match, otherwise NULL
*/
WS_DLL_PUBLIC register_follow_t* get_follow_by_name(const char* proto_short_name);
/** Get a registered follower by protocol id
*
* @param proto_id Protocol Id
* @return tap registered follower if match, otherwise NULL
*/
WS_DLL_PUBLIC register_follow_t* get_follow_by_proto_id(const int proto_id);
/** Provide function that builds a follow filter based on the current packet's conversation.
*
* @param follower [in] Registered follower
* @return A filter function handler
*/
WS_DLL_PUBLIC follow_conv_filter_func get_follow_conv_func(register_follow_t* follower);
/** Provide function that builds a follow filter based on stream.
*
* @param follower [in] Registered follower
* @return A filter function handler
*/
WS_DLL_PUBLIC follow_index_filter_func get_follow_index_func(register_follow_t* follower);
/** Provide function that builds a follow filter based on address/port pairs.
*
* @param follower [in] Registered follower
* @return A filter function handler
*/
WS_DLL_PUBLIC follow_address_filter_func get_follow_address_func(register_follow_t* follower);
/** Provide function that resolves port number to name based on follower.
*
* @param follower [in] Registered follower
* @return A port resolver function handler
*/
WS_DLL_PUBLIC follow_port_to_display_func get_follow_port_to_display(register_follow_t* follower);
/** Provide function that handles tap data (tap_packet_cb parameter of register_tap_listener)
*
* @param follower [in] Registered follower
* @return A tap packet handler
*/
WS_DLL_PUBLIC tap_packet_cb get_follow_tap_handler(register_follow_t* follower);
/** Provide function that gets the total number of streams for a registered follower
* The function can be NULL if the follower does not count the number of streams
*
* @param follower [in] Registered follower
* @return A stream count handler
*/
WS_DLL_PUBLIC follow_stream_count_func get_follow_stream_count_func(register_follow_t* follower);
/** Provide function that, for given stream and sub stream ids, searches for
* the first sub stream id less than or equal (or greater than or equal) the
* given sub stream id present on the given stream id. Returns true and the
* sub stream id found, or false.
* This is used by the GUI to select valid sub stream numbers, e.g. when
* incrementing or decrementing the sub stream ID widget.
* This function should be NULL if the follower does not have sub streams.
*
* @param follower [in] Registered follower
* @return A sub stream id function handler
*/
WS_DLL_PUBLIC follow_sub_stream_id_func get_follow_sub_stream_id_func(register_follow_t* follower);
/** Tap function handler when dissector's tap provides follow data as a tvb.
* Used by TCP, UDP and HTTP followers
*/
WS_DLL_PUBLIC tap_packet_status
follow_tvb_tap_listener(void *tapdata, packet_info *pinfo, epan_dissect_t *edt _U_, const void *data, tap_flags_t flags);
/** Interator to walk all registered followers and execute func
*
* @param func action to be performed on all conversation tables
* @param user_data any data needed to help perform function
*/
WS_DLL_PUBLIC void follow_iterate_followers(wmem_foreach_func func, void *user_data);
/** Generate -z stat (tap) name for a follower
* Currently used only by TShark
*
* @param follower [in] Registered follower
* @return A tap data handler
*/
WS_DLL_PUBLIC char* follow_get_stat_tap_string(register_follow_t* follower);
/** Clear payload, fragments, counters, addresses, and ports of follow_info_t
* for retapping. (Does not clear substream_id, which is used for selecting
* which tvbs are tapped.)
* Free everything except the GUI element and the follow_info_t structure
* itself
*
* @param info [in] follower info
*/
WS_DLL_PUBLIC void follow_reset_stream(follow_info_t* info);
/** Free follow_info_t structure
* Free everything except the GUI element
*
* @param follow_info [in] follower info
*/
WS_DLL_PUBLIC void follow_info_free(follow_info_t* follow_info);
#ifdef __cplusplus
}
#endif /* __cplusplus */
#endif
|
