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
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
|
/* packet-clique_rm.c
* Routines for clique reliable multicast dissector
* Copyright 2007, Collabora Ltd.
* @author: Sjoerd Simons <sjoerd.simons@collabora.co.uk>
*
* Wireshark - Network traffic analyzer
* By Gerald Combs <gerald@wireshark.org>
* Copyright 1998 Gerald Combs
*
* SPDX-License-Identifier: GPL-2.0-or-later
*/
#include "config.h"
#include <epan/packet.h>
void proto_register_clique_rm(void);
void proto_reg_handoff_clique_rm(void);
/* Initialize the protocol and registered fields */
static int proto_clique_rm;
static int hf_clique_rm_version;
static int hf_clique_rm_type;
static int hf_clique_rm_sender;
static int hf_clique_rm_packet_id;
static int hf_clique_rm_depends;
static int hf_clique_rm_depend_sender;
static int hf_clique_rm_depend_packet_id;
static int hf_clique_rm_failures;
static int hf_clique_rm_failures_senders;
static int hf_clique_rm_attempt_join;
static int hf_clique_rm_attempt_join_senders;
static int hf_clique_rm_join_failures;
static int hf_clique_rm_join_failures_senders;
static int hf_clique_rm_data_flags;
static int hf_clique_rm_data_size;
static int hf_clique_rm_data_stream_id;
static int hf_clique_rm_data_data;
static int hf_clique_rm_whois_request_id;
static int hf_clique_rm_whois_reply_name;
static int hf_clique_rm_whois_reply_name_length;
static int hf_clique_rm_repair_request_sender_id;
static int hf_clique_rm_repair_request_packet_id;
/* Initialize the subtree pointers */
static int ett_clique_rm;
static int ett_clique_rm_data;
static int ett_clique_rm_depends;
static int ett_clique_rm_depends_item;
static int ett_clique_rm_failures;
static int ett_clique_rm_join_failures;
static int ett_clique_rm_attempt_join;
static int ett_clique_rm_join;
/* Packet types */
typedef enum {
/* Unreliable packets */
PACKET_TYPE_WHOIS_REQUEST = 0,
PACKET_TYPE_WHOIS_REPLY,
PACKET_TYPE_REPAIR_REQUEST,
PACKET_TYPE_SESSION,
/* Reliable packets */
FIRST_RELIABLE_PACKET = 0xf,
PACKET_TYPE_DATA = FIRST_RELIABLE_PACKET,
/* No data just acknowledgement */
PACKET_TYPE_NO_DATA,
/* Some nodes failed */
PACKET_TYPE_FAILURE,
/* Start a joining attempt */
PACKET_TYPE_ATTEMPT_JOIN,
/* The real join */
PACKET_TYPE_JOIN,
/* Leaving now, bye */
PACKET_TYPE_BYE,
PACKET_TYPE_INVALID
} GibberRMulticastPacketType;
#define IS_RELIABLE(type) (type >= FIRST_RELIABLE_PACKET)
static const value_string packet_type_vals[] = {
{ PACKET_TYPE_WHOIS_REQUEST, "Whois request" },
{ PACKET_TYPE_WHOIS_REPLY, "Whois reply" },
{ PACKET_TYPE_REPAIR_REQUEST, "Repair request"},
{ PACKET_TYPE_SESSION, "Session" },
{ PACKET_TYPE_DATA, "Data" },
/* No data just acknowledgement */
{ PACKET_TYPE_NO_DATA, "No data" },
/* Some nodes failed */
{ PACKET_TYPE_FAILURE, "Failure" },
/* Start a joining attempt */
{ PACKET_TYPE_ATTEMPT_JOIN, "Attempt join" },
/* The real join */
{ PACKET_TYPE_JOIN, "Join" },
/* Leaving now, bye */
{ PACKET_TYPE_BYE, "Bye" },
{ 0, NULL }
};
static void
dissect_sender_array(proto_tree *clique_rm_tree, int hf_header, int ett_header,
int hf_header_sender, tvbuff_t *tvb, int offset)
{
unsigned i, count;
int len;
proto_item *ti;
proto_tree *tree;
count = tvb_get_uint8(tvb, offset);
len = 1 + 4 * count;
ti = proto_tree_add_item(clique_rm_tree, hf_header, tvb, offset, 1, ENC_BIG_ENDIAN);
proto_item_set_len(ti, len);
tree = proto_item_add_subtree(ti, ett_header);
offset++;
for (i = 0; i < count; i++, offset += 4)
proto_tree_add_item(tree, hf_header_sender, tvb, offset, 4, ENC_BIG_ENDIAN);
}
static void
dissect_data_packet(proto_tree *clique_rm_tree, tvbuff_t *tvb, int offset)
{
proto_tree *tree;
tree = proto_tree_add_subtree(clique_rm_tree, tvb, offset, -1, ett_clique_rm_data, NULL, "Data");
proto_tree_add_item(tree, hf_clique_rm_data_flags, tvb, offset, 1, ENC_BIG_ENDIAN);
offset += 1;
proto_tree_add_item(tree, hf_clique_rm_data_stream_id, tvb, offset, 2,
ENC_BIG_ENDIAN);
offset += 2;
proto_tree_add_item(tree, hf_clique_rm_data_size, tvb, offset, 4, ENC_BIG_ENDIAN);
offset += 4;
proto_tree_add_item(tree, hf_clique_rm_data_data, tvb, offset, -1, ENC_NA);
}
static int
dissect_depends(proto_tree *clique_rm_tree, tvbuff_t *tvb, int offset)
{
proto_item *ti;
proto_tree *tree, *depend_tree;
unsigned ii, count;
int len;
count = tvb_get_uint8(tvb, offset);
len = 1 + count * 8;
ti = proto_tree_add_item(clique_rm_tree,
hf_clique_rm_depends, tvb, offset, 1, ENC_BIG_ENDIAN);
proto_item_set_len(ti, len);
offset += 1;
tree = proto_item_add_subtree(ti, ett_clique_rm_depends);
for (ii = 0; ii < count; ii++)
{
depend_tree = proto_tree_add_subtree_format(tree, tvb, offset, 8,
ett_clique_rm_depends_item, NULL, "Depend item %d", ii+1);
proto_tree_add_item(depend_tree, hf_clique_rm_depend_sender,
tvb, offset, 4, ENC_BIG_ENDIAN);
proto_tree_add_item(depend_tree, hf_clique_rm_depend_packet_id,
tvb, offset+4, 4, ENC_BIG_ENDIAN);
offset += 8;
}
return len;
}
/* Code to actually dissect the packets */
static void
dissect_reliable_packet(proto_tree *clique_rm_tree, uint8_t type, tvbuff_t *tvb, int offset)
{
if (!clique_rm_tree)
return; /* no col_..() or expert...() calls in following */
proto_tree_add_item(clique_rm_tree, hf_clique_rm_packet_id, tvb, offset, 4,
ENC_BIG_ENDIAN);
offset += 4;
offset += dissect_depends(clique_rm_tree, tvb, offset);
switch (type)
{
case PACKET_TYPE_DATA:
dissect_data_packet(clique_rm_tree, tvb, offset);
break;
case PACKET_TYPE_NO_DATA:
break;
case PACKET_TYPE_FAILURE:
dissect_sender_array(clique_rm_tree, hf_clique_rm_failures,
ett_clique_rm_failures, hf_clique_rm_failures_senders, tvb, offset);
break;
case PACKET_TYPE_ATTEMPT_JOIN:
dissect_sender_array(clique_rm_tree, hf_clique_rm_attempt_join,
ett_clique_rm_attempt_join, hf_clique_rm_attempt_join_senders, tvb, offset);
break;
case PACKET_TYPE_JOIN:
dissect_sender_array(clique_rm_tree, hf_clique_rm_join_failures,
ett_clique_rm_join_failures, hf_clique_rm_join_failures_senders, tvb, offset);
break;
case PACKET_TYPE_BYE:
break;
default:
break;
}
}
static void
dissect_unreliable_packet(proto_tree *clique_rm_tree, uint8_t type, tvbuff_t *tvb, int offset)
{
unsigned len;
if (!clique_rm_tree)
return; /* no col_..() or expert...() calls in following */
switch (type)
{
case PACKET_TYPE_WHOIS_REQUEST:
proto_tree_add_item(clique_rm_tree,
hf_clique_rm_whois_request_id, tvb, offset, 4, ENC_BIG_ENDIAN);
break;
case PACKET_TYPE_WHOIS_REPLY:
len = tvb_get_uint8(tvb, offset);
proto_tree_add_item(clique_rm_tree,
hf_clique_rm_whois_reply_name_length, tvb, offset, 1, ENC_BIG_ENDIAN);
offset += 1;
proto_tree_add_item(clique_rm_tree,
hf_clique_rm_whois_reply_name, tvb, offset, len, ENC_ASCII);
break;
case PACKET_TYPE_REPAIR_REQUEST:
proto_tree_add_item(clique_rm_tree,
hf_clique_rm_repair_request_sender_id, tvb, offset, 4, ENC_BIG_ENDIAN);
offset += 4;
proto_tree_add_item(clique_rm_tree,
hf_clique_rm_repair_request_packet_id, tvb, offset, 4, ENC_BIG_ENDIAN);
break;
case PACKET_TYPE_SESSION:
dissect_depends(clique_rm_tree, tvb, offset);
break;
default:
break;
}
}
static bool
dissect_clique_rm_heur(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, void *data _U_)
{
proto_item *ti;
proto_tree *clique_rm_tree;
uint8_t version;
uint8_t type;
int offset = 0;
uint64_t qword;
if (tvb_captured_length(tvb) < 12)
return false;
qword = tvb_get_ntoh48(tvb,0);
/* ASCII str for 'Clique' = 0x436c69717565 */
if(qword != UINT64_C (0x436c69717565))
return false;
offset += 6;
version = tvb_get_uint8(tvb, offset);
if (version != 1)
return false;
offset++;
type = tvb_get_uint8(tvb, offset);
offset++;
col_set_str(pinfo->cinfo, COL_PROTOCOL, "Clique-rm");
col_add_str(pinfo->cinfo, COL_INFO,
val_to_str(type, packet_type_vals, "Unknown (0x%02x)"));
/* rewind back to just behind the prefix */
offset = 6;
ti = proto_tree_add_item(tree, proto_clique_rm, tvb, 0, -1, ENC_NA);
clique_rm_tree = proto_item_add_subtree(ti, ett_clique_rm);
proto_tree_add_item(clique_rm_tree, hf_clique_rm_version, tvb, offset, 1,
ENC_BIG_ENDIAN);
offset++;
proto_tree_add_item(clique_rm_tree, hf_clique_rm_type, tvb, offset, 1,
ENC_BIG_ENDIAN);
offset++;
col_append_fstr(pinfo->cinfo, COL_INFO, ", sender: 0x%x",
tvb_get_ntohl(tvb, offset));
proto_tree_add_item(clique_rm_tree, hf_clique_rm_sender, tvb, offset,
4, ENC_BIG_ENDIAN);
offset += 4;
if (IS_RELIABLE(type)) {
col_append_fstr(pinfo->cinfo, COL_INFO, ", id: 0x%x",
tvb_get_ntohl(tvb, offset));
dissect_reliable_packet(clique_rm_tree, type, tvb, offset);
} else {
dissect_unreliable_packet(clique_rm_tree, type, tvb, offset);
}
return true;
}
/* Register the protocol with Wireshark */
void
proto_register_clique_rm(void)
{
/* Setup list of header fields See Section 1.6.1 for details*/
static hf_register_info hf[] = {
{ &hf_clique_rm_version,
{ "Version", "clique_rm.version",
FT_UINT8, BASE_DEC, NULL, 0x0,
NULL, HFILL }
},
{ &hf_clique_rm_type,
{ "Type", "clique_rm.type",
FT_UINT8, BASE_HEX, VALS(packet_type_vals), 0x0,
NULL, HFILL }
},
{ &hf_clique_rm_sender,
{ "Sender", "clique_rm.sender",
FT_UINT32, BASE_HEX, NULL, 0x0,
NULL, HFILL }
},
{ &hf_clique_rm_packet_id,
{ "Packet id", "clique_rm.packet_id",
FT_UINT32, BASE_HEX, NULL, 0x0,
NULL, HFILL }
},
{ &hf_clique_rm_depends,
{ "Depends", "clique_rm.depends",
FT_UINT8, BASE_HEX, NULL, 0x0,
NULL, HFILL }
},
{ &hf_clique_rm_depend_sender,
{ "Sender", "clique_rm.depends.sender",
FT_UINT32, BASE_HEX, NULL, 0x0,
NULL, HFILL }
},
{ &hf_clique_rm_depend_packet_id,
{ "Packet id", "clique_rm.depends.packet_id",
FT_UINT32, BASE_HEX, NULL, 0x0,
NULL, HFILL }
},
{ &hf_clique_rm_failures,
{ "Failures", "clique_rm.failures",
FT_UINT8, BASE_HEX, NULL, 0x0,
NULL, HFILL }
},
{ &hf_clique_rm_failures_senders,
{ "Sender", "clique_rm.failures.sender",
FT_UINT32, BASE_HEX, NULL, 0x0,
NULL, HFILL }
},
{ &hf_clique_rm_attempt_join,
{ "New attempt join senders", "clique_rm.attempt_join",
FT_UINT8, BASE_HEX, NULL, 0x0,
NULL, HFILL }
},
{ &hf_clique_rm_attempt_join_senders,
{ "Sender", "clique_rm.attempt_join.sender",
FT_UINT32, BASE_HEX, NULL, 0x0,
NULL, HFILL }
},
{ &hf_clique_rm_join_failures,
{ "Join failures", "clique_rm.join_failures",
FT_UINT8, BASE_HEX, NULL, 0x0,
NULL, HFILL }
},
{ &hf_clique_rm_join_failures_senders,
{ "Sender", "clique_rm.join_failures.sender",
FT_UINT32, BASE_HEX, NULL, 0x0,
NULL, HFILL }
},
{ &hf_clique_rm_data_flags,
{ "Data flags", "clique_rm.data.flags",
FT_UINT8, BASE_HEX, NULL, 0x0,
NULL, HFILL }
},
{ &hf_clique_rm_data_size,
{ "Data total size", "clique_rm.data.size",
FT_UINT32, BASE_DEC, NULL, 0x0,
NULL, HFILL }
},
{ &hf_clique_rm_data_stream_id,
{ "Data stream id", "clique_rm.data.stream_id",
FT_UINT16, BASE_HEX, NULL, 0x0,
NULL, HFILL }
},
{ &hf_clique_rm_data_data,
{ "Raw data", "clique_rm.data.data",
FT_BYTES, BASE_NONE, NULL, 0x0,
NULL, HFILL }
},
{ &hf_clique_rm_whois_request_id,
{ "Whois request id", "clique_rm.whois_request.id",
FT_UINT32, BASE_HEX, NULL, 0x0,
NULL, HFILL }
},
{ &hf_clique_rm_whois_reply_name_length,
{ "Whois reply name length", "clique_rm.whois_reply.length",
FT_UINT8, BASE_DEC, NULL, 0x0,
NULL, HFILL }
},
{ &hf_clique_rm_whois_reply_name,
{ "Whois reply name", "clique_rm.whois_reply.name",
FT_STRINGZ, BASE_NONE, NULL, 0x0,
NULL, HFILL }
},
{ &hf_clique_rm_repair_request_sender_id,
{ "Repair request for sender",
"clique_rm.repair_request.sender_id",
FT_UINT32, BASE_HEX, NULL, 0x0,
NULL, HFILL }
},
{ &hf_clique_rm_repair_request_packet_id,
{ "Repair request for packet",
"clique_rm.repair_request.packet_id",
FT_UINT32, BASE_HEX, NULL, 0x0,
NULL, HFILL }
},
};
/* Setup protocol subtree array */
static int *ett[] = {
&ett_clique_rm,
&ett_clique_rm_depends,
&ett_clique_rm_depends_item,
&ett_clique_rm_data,
&ett_clique_rm_failures,
&ett_clique_rm_join_failures,
&ett_clique_rm_attempt_join,
&ett_clique_rm_join,
};
/* Register the protocol name and description */
proto_clique_rm = proto_register_protocol("Clique Reliable Multicast Protocol", "Clique-rm", "clique-rm");
/* Required function calls to register the header fields and subtrees used */
proto_register_field_array(proto_clique_rm, hf, array_length(hf));
proto_register_subtree_array(ett, array_length(ett));
}
void
proto_reg_handoff_clique_rm(void)
{
heur_dissector_add("udp", dissect_clique_rm_heur, "Clique RM over UDP", "clique_rm_udp", proto_clique_rm, HEURISTIC_ENABLE);
}
/*
* Editor modelines - https://www.wireshark.org/tools/modelines.html
*
* Local Variables:
* c-basic-offset: 2
* tab-width: 8
* indent-tabs-mode: nil
* End:
*
* ex: set shiftwidth=2 tabstop=8 expandtab:
* :indentSize=2:tabSize=8:noTabs=true:
*/
|
