dcerpc-netlogon: maintain netlogon_auth_vars for NetrServerAuthenticateKerberos
[wireshark-sm.git] / epan / dissectors / packet-calcappprotocol.c
blob3f7378b08b43408c3ff939ce6d3ee856af178a8c
1 /* packet-calcappprotocol.c
2 * Routines for the Calculation Application Protocol, a test application of the
3 * RSPLIB RSerPool implementation
4 * https://www.uni-due.de/~be0001/rserpool/
6 * Copyright 2006-2021 by Thomas Dreibholz <dreibh [AT] iem.uni-due.de>
8 * Wireshark - Network traffic analyzer
9 * By Gerald Combs <gerald@wireshark.org>
10 * Copyright 1998 Gerald Combs
12 * Copied from README.developer
14 * SPDX-License-Identifier: GPL-2.0-or-later
17 #include "config.h"
19 #include <epan/packet.h>
20 #include <epan/sctpppids.h>
21 #include <epan/stat_tap_ui.h>
22 #include <wsutil/array.h>
24 void proto_register_calcappprotocol(void);
25 void proto_reg_handoff_calcappprotocol(void);
27 static dissector_handle_t calcappprotocol_handle;
29 #define CALCAPPPROTOCOL_PAYLOAD_PROTOCOL_ID_LEGACY 0x29097603
32 /* Initialize the protocol and registered fields */
33 static int proto_calcappprotocol;
34 static int tap_calcappprotocol = -1;
35 static int hf_message_type;
36 static int hf_message_flags;
37 static int hf_message_length;
38 static int hf_message_jobid;
39 static int hf_message_jobsize;
40 static int hf_message_completed;
42 static uint64_t calcappprotocol_total_msgs;
43 static uint64_t calcappprotocol_total_bytes;
45 /* Initialize the subtree pointers */
46 static int ett_calcappprotocol;
48 /* Dissectors for messages. This is specific to CalcAppProtocol */
49 #define MESSAGE_TYPE_LENGTH 1
50 #define MESSAGE_FLAGS_LENGTH 1
51 #define MESSAGE_LENGTH_LENGTH 2
52 #define MESSAGE_JOBID_LENGTH 4
53 #define MESSAGE_JOBSIZE_LENGTH 8
54 #define MESSAGE_COMPLETED_LENGTH 8
56 #define MESSAGE_TYPE_OFFSET 0
57 #define MESSAGE_FLAGS_OFFSET (MESSAGE_TYPE_OFFSET + MESSAGE_TYPE_LENGTH)
58 #define MESSAGE_LENGTH_OFFSET (MESSAGE_FLAGS_OFFSET + MESSAGE_FLAGS_LENGTH)
59 #define MESSAGE_JOBID_OFFSET (MESSAGE_LENGTH_OFFSET + MESSAGE_LENGTH_LENGTH)
60 #define MESSAGE_JOBSIZE_OFFSET (MESSAGE_JOBID_OFFSET + MESSAGE_JOBID_OFFSET)
61 #define MESSAGE_COMPLETED_OFFSET (MESSAGE_JOBSIZE_OFFSET + MESSAGE_JOBSIZE_OFFSET)
64 #define CALCAPP_REQUEST_MESSAGE_TYPE 1
65 #define CALCAPP_ACCEPT_MESSAGE_TYPE 2
66 #define CALCAPP_REJECT_MESSAGE_TYPE 3
67 #define CALCAPP_ABORT_MESSAGE_TYPE 4
68 #define CALCAPP_COMPLETE_MESSAGE_TYPE 5
69 #define CALCAPP_KEEPALIVE_MESSAGE_TYPE 6
70 #define CALCAPP_KEEPALIVE_ACK_MESSAGE_TYPE 7
73 static const value_string message_type_values[] = {
74 { CALCAPP_REQUEST_MESSAGE_TYPE, "CalcApp Request" },
75 { CALCAPP_ACCEPT_MESSAGE_TYPE, "CalcApp Accept" },
76 { CALCAPP_REJECT_MESSAGE_TYPE, "CalcApp Reject" },
77 { CALCAPP_ABORT_MESSAGE_TYPE, "CalcApp Abort" },
78 { CALCAPP_COMPLETE_MESSAGE_TYPE, "CalcApp Complete" },
79 { CALCAPP_KEEPALIVE_MESSAGE_TYPE, "CalcApp Keep-Alive" },
80 { CALCAPP_KEEPALIVE_ACK_MESSAGE_TYPE, "CalcApp Keep-Alive Ack" },
81 { 0, NULL }
85 typedef struct _tap_calcappprotocol_rec_t {
86 uint8_t type;
87 uint16_t size;
88 const char* type_string;
89 } tap_calcappprotocol_rec_t;
92 static void
93 dissect_calcappprotocol_message(tvbuff_t *message_tvb, packet_info *pinfo, proto_tree *calcappprotocol_tree)
95 tap_calcappprotocol_rec_t* tap_rec = wmem_new0(pinfo->pool, tap_calcappprotocol_rec_t);
96 tap_rec->type = tvb_get_uint8(message_tvb, MESSAGE_TYPE_OFFSET);
97 tap_rec->size = tvb_get_ntohs(message_tvb, MESSAGE_LENGTH_OFFSET);
98 tap_rec->type_string = val_to_str_const(tap_rec->type, message_type_values, "Unknown CalcAppProtocol message type");
99 tap_queue_packet(tap_calcappprotocol, pinfo, tap_rec);
101 col_add_fstr(pinfo->cinfo, COL_INFO, "%s ", tap_rec->type_string);
103 proto_tree_add_item(calcappprotocol_tree, hf_message_type, message_tvb, MESSAGE_TYPE_OFFSET, MESSAGE_TYPE_LENGTH, ENC_BIG_ENDIAN);
104 proto_tree_add_item(calcappprotocol_tree, hf_message_flags, message_tvb, MESSAGE_FLAGS_OFFSET, MESSAGE_FLAGS_LENGTH, ENC_BIG_ENDIAN);
105 proto_tree_add_item(calcappprotocol_tree, hf_message_length, message_tvb, MESSAGE_LENGTH_OFFSET, MESSAGE_LENGTH_LENGTH, ENC_BIG_ENDIAN);
106 proto_tree_add_item(calcappprotocol_tree, hf_message_jobid, message_tvb, MESSAGE_JOBID_OFFSET, MESSAGE_JOBID_LENGTH, ENC_BIG_ENDIAN);
107 proto_tree_add_item(calcappprotocol_tree, hf_message_jobsize, message_tvb, MESSAGE_JOBSIZE_OFFSET, MESSAGE_JOBSIZE_LENGTH, ENC_BIG_ENDIAN);
108 proto_tree_add_item(calcappprotocol_tree, hf_message_completed, message_tvb, MESSAGE_COMPLETED_OFFSET, MESSAGE_COMPLETED_LENGTH, ENC_BIG_ENDIAN);
112 static int
113 dissect_calcappprotocol(tvbuff_t *message_tvb, packet_info *pinfo, proto_tree *tree, void *data _U_)
115 proto_item *calcappprotocol_item;
116 proto_tree *calcappprotocol_tree;
118 col_set_str(pinfo->cinfo, COL_PROTOCOL, "CalcAppProtocol");
120 /* In the interest of speed, if "tree" is NULL, don't do any work not
121 necessary to generate protocol tree items. */
122 if (tree) {
123 /* create the calcappprotocol protocol tree */
124 calcappprotocol_item = proto_tree_add_item(tree, proto_calcappprotocol, message_tvb, 0, -1, ENC_NA);
125 calcappprotocol_tree = proto_item_add_subtree(calcappprotocol_item, ett_calcappprotocol);
126 } else {
127 calcappprotocol_tree = NULL;
129 /* dissect the message */
130 dissect_calcappprotocol_message(message_tvb, pinfo, calcappprotocol_tree);
131 return true;
135 /* TAP STAT INFO */
136 typedef enum
138 MESSAGE_TYPE_COLUMN = 0,
139 MESSAGES_COLUMN,
140 MESSAGES_SHARE_COLUMN,
141 BYTES_COLUMN,
142 BYTES_SHARE_COLUMN,
143 FIRST_SEEN_COLUMN,
144 LAST_SEEN_COLUMN,
145 INTERVAL_COLUMN,
146 MESSAGE_RATE_COLUMN,
147 BYTE_RATE_COLUMN
148 } calcappprotocol_stat_columns;
150 static stat_tap_table_item calcappprotocol_stat_fields[] = {
151 { TABLE_ITEM_STRING, TAP_ALIGN_LEFT, "CalcAppProtocol Message Type", "%-25s" },
152 { TABLE_ITEM_UINT, TAP_ALIGN_RIGHT, "Messages ", "%u" },
153 { TABLE_ITEM_UINT, TAP_ALIGN_RIGHT, "Messages Share (%)" , "%1.3f %%" },
154 { TABLE_ITEM_UINT, TAP_ALIGN_RIGHT, "Bytes (B)", "%u" },
155 { TABLE_ITEM_UINT, TAP_ALIGN_RIGHT, "Bytes Share (%) ", "%1.3f %%" },
156 { TABLE_ITEM_FLOAT, TAP_ALIGN_LEFT, "First Seen (s)", "%1.6f" },
157 { TABLE_ITEM_FLOAT, TAP_ALIGN_LEFT, "Last Seen (s)", "%1.6f" },
158 { TABLE_ITEM_FLOAT, TAP_ALIGN_LEFT, "Interval (s)", "%1.6f" },
159 { TABLE_ITEM_FLOAT, TAP_ALIGN_LEFT, "Message Rate (Msg/s)", "%1.2f" },
160 { TABLE_ITEM_FLOAT, TAP_ALIGN_LEFT, "Byte Rate (B/s)", "%1.2f" }
163 static void calcappprotocol_stat_init(stat_tap_table_ui* new_stat)
165 const char *table_name = "CalcAppProtocol Statistics";
166 int num_fields = array_length(calcappprotocol_stat_fields);
167 stat_tap_table *table;
168 int i = 0;
169 stat_tap_table_item_type items[array_length(calcappprotocol_stat_fields)];
171 table = stat_tap_find_table(new_stat, table_name);
172 if (table) {
173 if (new_stat->stat_tap_reset_table_cb) {
174 new_stat->stat_tap_reset_table_cb(table);
176 return;
179 table = stat_tap_init_table(table_name, num_fields, 0, NULL);
180 stat_tap_add_table(new_stat, table);
182 memset(items, 0x0, sizeof(items));
183 /* Add a row for each value type */
184 while (message_type_values[i].strptr) {
185 items[MESSAGE_TYPE_COLUMN].type = TABLE_ITEM_STRING;
186 items[MESSAGE_TYPE_COLUMN].value.string_value = message_type_values[i].strptr;
187 items[MESSAGES_COLUMN].type = TABLE_ITEM_UINT;
188 items[MESSAGES_COLUMN].value.uint_value = 0;
189 items[MESSAGES_SHARE_COLUMN].type = TABLE_ITEM_NONE;
190 items[MESSAGES_SHARE_COLUMN].value.float_value = -1.0;
191 items[BYTES_COLUMN].type = TABLE_ITEM_UINT;
192 items[BYTES_COLUMN].value.uint_value = 0;
193 items[BYTES_SHARE_COLUMN].type = TABLE_ITEM_NONE;
194 items[BYTES_SHARE_COLUMN].value.float_value = -1.0;
195 items[FIRST_SEEN_COLUMN].type = TABLE_ITEM_NONE;
196 items[FIRST_SEEN_COLUMN].value.float_value = DBL_MAX;
197 items[LAST_SEEN_COLUMN].type = TABLE_ITEM_NONE;
198 items[LAST_SEEN_COLUMN].value.float_value = DBL_MIN;
199 items[INTERVAL_COLUMN].type = TABLE_ITEM_NONE;
200 items[INTERVAL_COLUMN].value.float_value = -1.0;
201 items[MESSAGE_RATE_COLUMN].type = TABLE_ITEM_NONE;
202 items[MESSAGE_RATE_COLUMN].value.float_value = -1.0;
203 items[BYTE_RATE_COLUMN].type = TABLE_ITEM_NONE;
204 items[BYTE_RATE_COLUMN].value.float_value = -1.0;
205 stat_tap_init_table_row(table, i, num_fields, items);
206 i++;
210 static tap_packet_status
211 calcappprotocol_stat_packet(void* tapdata, packet_info* pinfo _U_, epan_dissect_t* edt _U_, const void* data, tap_flags_t flags _U_)
213 stat_data_t* stat_data = (stat_data_t*)tapdata;
214 const tap_calcappprotocol_rec_t* tap_rec = (const tap_calcappprotocol_rec_t*)data;
215 stat_tap_table* table;
216 stat_tap_table_item_type* msg_data;
217 int idx;
218 uint64_t messages;
219 uint64_t bytes;
220 int i = 0;
221 double firstSeen = -1.0;
222 double lastSeen = -1.0;
224 idx = str_to_val_idx(tap_rec->type_string, message_type_values);
225 if (idx < 0)
226 return TAP_PACKET_DONT_REDRAW;
228 table = g_array_index(stat_data->stat_tap_data->tables, stat_tap_table*, 0);
230 /* Update packets counter */
231 calcappprotocol_total_msgs++;
232 msg_data = stat_tap_get_field_data(table, idx, MESSAGES_COLUMN);
233 msg_data->value.uint_value++;
234 messages = msg_data->value.uint_value;
235 stat_tap_set_field_data(table, idx, MESSAGES_COLUMN, msg_data);
237 /* Update bytes counter */
238 calcappprotocol_total_bytes += tap_rec->size;
239 msg_data = stat_tap_get_field_data(table, idx, BYTES_COLUMN);
240 msg_data->value.uint_value += tap_rec->size;
241 bytes = msg_data->value.uint_value;
242 stat_tap_set_field_data(table, idx, BYTES_COLUMN, msg_data);
244 /* Update messages and bytes share */
245 while (message_type_values[i].strptr) {
246 msg_data = stat_tap_get_field_data(table, i, MESSAGES_COLUMN);
247 const unsigned m = msg_data->value.uint_value;
248 msg_data = stat_tap_get_field_data(table, i, BYTES_COLUMN);
249 const unsigned b = msg_data->value.uint_value;
251 msg_data = stat_tap_get_field_data(table, i, MESSAGES_SHARE_COLUMN);
252 msg_data->type = TABLE_ITEM_FLOAT;
253 msg_data->value.float_value = 100.0 * m / (double)calcappprotocol_total_msgs;
254 stat_tap_set_field_data(table, i, MESSAGES_SHARE_COLUMN, msg_data);
256 msg_data = stat_tap_get_field_data(table, i, BYTES_SHARE_COLUMN);
257 msg_data->type = TABLE_ITEM_FLOAT;
258 msg_data->value.float_value = 100.0 * b / (double)calcappprotocol_total_bytes;
259 stat_tap_set_field_data(table, i, BYTES_SHARE_COLUMN, msg_data);
260 i++;
263 /* Update first seen time */
264 if (pinfo->presence_flags & PINFO_HAS_TS) {
265 msg_data = stat_tap_get_field_data(table, idx, FIRST_SEEN_COLUMN);
266 msg_data->type = TABLE_ITEM_FLOAT;
267 msg_data->value.float_value = MIN(msg_data->value.float_value, nstime_to_sec(&pinfo->rel_ts));
268 firstSeen = msg_data->value.float_value;
269 stat_tap_set_field_data(table, idx, FIRST_SEEN_COLUMN, msg_data);
272 /* Update last seen time */
273 if (pinfo->presence_flags & PINFO_HAS_TS) {
274 msg_data = stat_tap_get_field_data(table, idx, LAST_SEEN_COLUMN);
275 msg_data->type = TABLE_ITEM_FLOAT;
276 msg_data->value.float_value = MAX(msg_data->value.float_value, nstime_to_sec(&pinfo->rel_ts));
277 lastSeen = msg_data->value.float_value;
278 stat_tap_set_field_data(table, idx, LAST_SEEN_COLUMN, msg_data);
281 if ((lastSeen - firstSeen) > 0.0) {
282 /* Update interval */
283 msg_data = stat_tap_get_field_data(table, idx, INTERVAL_COLUMN);
284 msg_data->type = TABLE_ITEM_FLOAT;
285 msg_data->value.float_value = lastSeen - firstSeen;
286 stat_tap_set_field_data(table, idx, INTERVAL_COLUMN, msg_data);
288 /* Update message rate */
289 msg_data = stat_tap_get_field_data(table, idx, MESSAGE_RATE_COLUMN);
290 msg_data->type = TABLE_ITEM_FLOAT;
291 msg_data->value.float_value = messages / (lastSeen - firstSeen);
292 stat_tap_set_field_data(table, idx, MESSAGE_RATE_COLUMN, msg_data);
294 /* Update byte rate */
295 msg_data = stat_tap_get_field_data(table, idx, BYTE_RATE_COLUMN);
296 msg_data->type = TABLE_ITEM_FLOAT;
297 msg_data->value.float_value = bytes / (lastSeen - firstSeen);
298 stat_tap_set_field_data(table, idx, BYTE_RATE_COLUMN, msg_data);
301 return TAP_PACKET_REDRAW;
304 static void
305 calcappprotocol_stat_reset(stat_tap_table* table)
307 unsigned element;
308 stat_tap_table_item_type* item_data;
310 for (element = 0; element < table->num_elements; element++) {
311 item_data = stat_tap_get_field_data(table, element, MESSAGES_COLUMN);
312 item_data->value.uint_value = 0;
313 stat_tap_set_field_data(table, element, MESSAGES_COLUMN, item_data);
315 item_data = stat_tap_get_field_data(table, element, MESSAGES_SHARE_COLUMN);
316 item_data->type = TABLE_ITEM_NONE;
317 item_data->value.float_value = -1.0;
318 stat_tap_set_field_data(table, element, MESSAGES_SHARE_COLUMN, item_data);
320 item_data = stat_tap_get_field_data(table, element, BYTES_COLUMN);
321 item_data->value.uint_value = 0;
322 stat_tap_set_field_data(table, element, BYTES_COLUMN, item_data);
324 item_data = stat_tap_get_field_data(table, element, BYTES_SHARE_COLUMN);
325 item_data->type = TABLE_ITEM_NONE;
326 item_data->value.float_value = -1.0;
327 stat_tap_set_field_data(table, element, BYTES_SHARE_COLUMN, item_data);
329 item_data = stat_tap_get_field_data(table, element, FIRST_SEEN_COLUMN);
330 item_data->type = TABLE_ITEM_NONE;
331 item_data->value.float_value = DBL_MAX;
332 stat_tap_set_field_data(table, element, FIRST_SEEN_COLUMN, item_data);
334 item_data = stat_tap_get_field_data(table, element, LAST_SEEN_COLUMN);
335 item_data->type = TABLE_ITEM_NONE;
336 item_data->value.float_value = DBL_MIN;
337 stat_tap_set_field_data(table, element, LAST_SEEN_COLUMN, item_data);
339 item_data = stat_tap_get_field_data(table, element, INTERVAL_COLUMN);
340 item_data->type = TABLE_ITEM_NONE;
341 item_data->value.float_value = -1.0;
342 stat_tap_set_field_data(table, element, INTERVAL_COLUMN, item_data);
344 item_data = stat_tap_get_field_data(table, element, MESSAGE_RATE_COLUMN);
345 item_data->type = TABLE_ITEM_NONE;
346 item_data->value.float_value = -1.0;
347 stat_tap_set_field_data(table, element, MESSAGE_RATE_COLUMN, item_data);
349 item_data = stat_tap_get_field_data(table, element, BYTE_RATE_COLUMN);
350 item_data->type = TABLE_ITEM_NONE;
351 item_data->value.float_value = -1.0;
352 stat_tap_set_field_data(table, element, BYTE_RATE_COLUMN, item_data);
354 calcappprotocol_total_msgs = 0;
355 calcappprotocol_total_bytes = 0;
359 /* Register the protocol with Wireshark */
360 void
361 proto_register_calcappprotocol(void)
364 /* Setup list of header fields */
365 static hf_register_info hf[] = {
366 { &hf_message_type, { "Type", "calcappprotocol.message_type", FT_UINT8, BASE_DEC, VALS(message_type_values), 0x0, NULL, HFILL } },
367 { &hf_message_flags, { "Flags", "calcappprotocol.message_flags", FT_UINT8, BASE_DEC, NULL, 0x0, NULL, HFILL } },
368 { &hf_message_length, { "Length", "calcappprotocol.message_length", FT_UINT16, BASE_DEC, NULL, 0x0, NULL, HFILL } },
369 { &hf_message_jobid, { "JobID", "calcappprotocol.message_jobid", FT_UINT32, BASE_DEC, NULL, 0x0, NULL, HFILL } },
370 { &hf_message_jobsize, { "JobSize", "calcappprotocol.message_jobsize", FT_UINT64, BASE_DEC, NULL, 0x0, NULL, HFILL } },
371 { &hf_message_completed, { "Completed", "calcappprotocol.message_completed", FT_UINT64, BASE_DEC, NULL, 0x0, NULL, HFILL } },
374 /* Setup protocol subtree array */
375 static int *ett[] = {
376 &ett_calcappprotocol
379 static tap_param calcappprotocol_stat_params[] = {
380 { PARAM_FILTER, "filter", "Filter", NULL, true }
383 static stat_tap_table_ui calcappprotocol_stat_table = {
384 REGISTER_STAT_GROUP_RSERPOOL,
385 "CalcAppProtocol Statistics",
386 "calcappprotocol",
387 "calcappprotocol,stat",
388 calcappprotocol_stat_init,
389 calcappprotocol_stat_packet,
390 calcappprotocol_stat_reset,
391 NULL,
392 NULL,
393 array_length(calcappprotocol_stat_fields), calcappprotocol_stat_fields,
394 array_length(calcappprotocol_stat_params), calcappprotocol_stat_params,
395 NULL,
399 /* Register the protocol name and description */
400 proto_calcappprotocol = proto_register_protocol("Calculation Application Protocol", "CalcAppProtocol", "calcappprotocol");
402 /* Required function calls to register the header fields and subtrees used */
403 proto_register_field_array(proto_calcappprotocol, hf, array_length(hf));
404 proto_register_subtree_array(ett, array_length(ett));
405 tap_calcappprotocol = register_tap("calcappprotocol");
407 register_stat_tap_table_ui(&calcappprotocol_stat_table);
409 calcappprotocol_handle = register_dissector("calcappprotocol", dissect_calcappprotocol, proto_calcappprotocol);
412 void
413 proto_reg_handoff_calcappprotocol(void)
415 dissector_add_uint("sctp.ppi", CALCAPPPROTOCOL_PAYLOAD_PROTOCOL_ID_LEGACY, calcappprotocol_handle);
416 dissector_add_uint("sctp.ppi", CALCAPP_PAYLOAD_PROTOCOL_ID, calcappprotocol_handle);
420 * Editor modelines - https://www.wireshark.org/tools/modelines.html
422 * Local Variables:
423 * c-basic-offset: 2
424 * tab-width: 8
425 * indent-tabs-mode: nil
426 * End:
428 * ex: set shiftwidth=2 tabstop=8 expandtab:
429 * :indentSize=2:tabSize=8:noTabs=true: