]> The Tcpdump Group git mirrors - tcpdump/blob - print-stp.c
projects / tcpdump / blob
summary | shortlog | log | commit | commitdiff | tree
history | raw | HEAD
Added-support-BPDUv4
[tcpdump] / print-stp.c
1 /*
2 * Copyright (c) 2000 Lennert Buytenhek
3 *
4 * This software may be distributed either under the terms of the
5 * BSD-style license that accompanies tcpdump or the GNU General
6 * Public License
7 *
8 * Format and print IEEE 802.1d spanning tree protocol packets.
9 * Contributed by Lennert Buytenhek <buytenh@gnu.org>
10 */
11
12 #ifndef lint
13 static const char rcsid[] _U_ =
14 "@(#) $Header: /tcpdump/master/tcpdump/print-stp.c,v 1.20 2007-03-18 17:11:46 hannes Exp $";
15 #endif
16
17 #ifdef HAVE_CONFIG_H
18 #include "config.h"
19 #endif
20
21 #include <tcpdump-stdinc.h>
22
23 #include <stdlib.h>
24 #include <stdio.h>
25 #include <string.h>
26
27 #include "interface.h"
28 #include "addrtoname.h"
29 #include "extract.h"
30
31 #define RSTP_EXTRACT_PORT_ROLE(x) (((x)&0x0C)>>2)
32 /* STP timers are expressed in multiples of 1/256th second */
33 #define STP_TIME_BASE 256
34 #define STP_BPDU_MSTP_MIN_LEN 102
35
36 struct stp_bpdu_ {
37 u_int8_t protocol_id[2];
38 u_int8_t protocol_version;
39 u_int8_t bpdu_type;
40 u_int8_t flags;
41 u_int8_t root_id[8];
42 u_int8_t root_path_cost[4];
43 u_int8_t bridge_id[8];
44 u_int8_t port_id[2];
45 u_int8_t message_age[2];
46 u_int8_t max_age[2];
47 u_int8_t hello_time[2];
48 u_int8_t forward_delay[2];
49 u_int8_t v1_length;
50 };
51
52 #define STP_PROTO_REGULAR 0x00
53 #define STP_PROTO_RAPID 0x02
54 #define STP_PROTO_MSTP 0x03
55 #define STP_PROTO_SPB 0x04
56
57 struct tok stp_proto_values[] = {
58 { STP_PROTO_REGULAR, "802.1d" },
59 { STP_PROTO_RAPID, "802.1w" },
60 { STP_PROTO_MSTP, "802.1s" },
61 { STP_PROTO_SPB, "802.1aq" },
62 { 0, NULL}
63 };
64
65 #define STP_BPDU_TYPE_CONFIG 0x00
66 #define STP_BPDU_TYPE_RSTP 0x02
67 #define STP_BPDU_TYPE_TOPO_CHANGE 0x80
68
69 struct tok stp_bpdu_flag_values[] = {
70 { 0x01, "Topology change" },
71 { 0x02, "Proposal" },
72 { 0x10, "Learn" },
73 { 0x20, "Forward" },
74 { 0x40, "Agreement" },
75 { 0x80, "Topology change ACK" },
76 { 0, NULL}
77 };
78
79 struct tok stp_bpdu_type_values[] = {
80 { STP_BPDU_TYPE_CONFIG, "Config" },
81 { STP_BPDU_TYPE_RSTP, "Rapid STP" },
82 { STP_BPDU_TYPE_TOPO_CHANGE, "Topology Change" },
83 { 0, NULL}
84 };
85
86 struct tok rstp_obj_port_role_values[] = {
87 { 0x00, "Unknown" },
88 { 0x01, "Alternate" },
89 { 0x02, "Root" },
90 { 0x03, "Designated" },
91 { 0, NULL}
92 };
93
94 static char *
95 stp_print_bridge_id(const u_char *p)
96 {
97 static char bridge_id_str[sizeof("pppp.aa:bb:cc:dd:ee:ff")];
98
99 snprintf(bridge_id_str, sizeof(bridge_id_str),
100 "%.2x%.2x.%.2x:%.2x:%.2x:%.2x:%.2x:%.2x",
101 p[0], p[1], p[2], p[3], p[4], p[5], p[6], p[7]);
102
103 return bridge_id_str;
104 }
105
106 static void
107 stp_print_config_bpdu(const struct stp_bpdu_ *stp_bpdu, u_int length)
108 {
109 printf(", Flags [%s]",
110 bittok2str(stp_bpdu_flag_values, "none", stp_bpdu->flags));
111
112 printf(", bridge-id %s.%04x, length %u",
113 stp_print_bridge_id((const u_char *)&stp_bpdu->bridge_id),
114 EXTRACT_16BITS(&stp_bpdu->port_id), length);
115
116 /* in non-verbose mode just print the bridge-id */
117 if (!vflag) {
118 return;
119 }
120
121 printf("\n\tmessage-age %.2fs, max-age %.2fs"
122 ", hello-time %.2fs, forwarding-delay %.2fs",
123 (float)EXTRACT_16BITS(&stp_bpdu->message_age) / STP_TIME_BASE,
124 (float)EXTRACT_16BITS(&stp_bpdu->max_age) / STP_TIME_BASE,
125 (float)EXTRACT_16BITS(&stp_bpdu->hello_time) / STP_TIME_BASE,
126 (float)EXTRACT_16BITS(&stp_bpdu->forward_delay) / STP_TIME_BASE);
127
128 printf("\n\troot-id %s, root-pathcost %u",
129 stp_print_bridge_id((const u_char *)&stp_bpdu->root_id),
130 EXTRACT_32BITS(&stp_bpdu->root_path_cost));
131
132 /* Port role is only valid for 802.1w */
133 if (stp_bpdu->protocol_version == STP_PROTO_RAPID) {
134 printf(", port-role %s",
135 tok2str(rstp_obj_port_role_values, "Unknown",
136 RSTP_EXTRACT_PORT_ROLE(stp_bpdu->flags)));
137 }
138 }
139
140 /*
141 * MSTP packet format
142 * Ref. IEEE 802.1Q 2003 Ed. Section 14
143 *
144 * MSTP BPDU
145 *
146 * 2 - bytes Protocol Id
147 * 1 - byte Protocol Ver.
148 * 1 - byte BPDU tye
149 * 1 - byte Flags
150 * 8 - bytes CIST Root Identifier
151 * 4 - bytes CIST External Path Cost
152 * 8 - bytes CIST Regional Root Identifier
153 * 2 - bytes CIST Port Identifier
154 * 2 - bytes Message Age
155 * 2 - bytes Max age
156 * 2 - bytes Hello Time
157 * 2 - bytes Forward delay
158 * 1 - byte Version 1 length. Must be 0
159 * 2 - bytes Version 3 length
160 * 1 - byte Config Identifier
161 * 32 - bytes Config Name
162 * 2 - bytes Revision level
163 * 16 - bytes Config Digest [MD5]
164 * 4 - bytes CIST Internal Root Path Cost
165 * 8 - bytes CIST Bridge Identifier
166 * 1 - byte CIST Remaining Hops
167 * 16 - bytes MSTI information [Max 64 MSTI, each 16 bytes]
168 *
169 *
170 * MSTI Payload
171 *
172 * 1 - byte MSTI flag
173 * 8 - bytes MSTI Regional Root Identifier
174 * 4 - bytes MSTI Regional Path Cost
175 * 1 - byte MSTI Bridge Priority
176 * 1 - byte MSTI Port Priority
177 * 1 - byte MSTI Remaining Hops
178 */
179
180 #define MST_BPDU_MSTI_LENGTH 16
181 #define MST_BPDU_CONFIG_INFO_LENGTH 64
182
183 /* Offsets of fields from the begginning for the packet */
184 #define MST_BPDU_VER3_LEN_OFFSET 36
185 #define MST_BPDU_CONFIG_NAME_OFFSET 39
186 #define MST_BPDU_CONFIG_DIGEST_OFFSET 73
187 #define MST_BPDU_CIST_INT_PATH_COST_OFFSET 89
188 #define MST_BPDU_CIST_BRIDGE_ID_OFFSET 93
189 #define MST_BPDU_CIST_REMAIN_HOPS_OFFSET 101
190 #define MST_BPDU_MSTI_OFFSET 102
191 /* Offsets within an MSTI */
192 #define MST_BPDU_MSTI_ROOT_PRIO_OFFSET 1
193 #define MST_BPDU_MSTI_ROOT_PATH_COST_OFFSET 9
194 #define MST_BPDU_MSTI_BRIDGE_PRIO_OFFSET 13
195 #define MST_BPDU_MSTI_PORT_PRIO_OFFSET 14
196 #define MST_BPDU_MSTI_REMAIN_HOPS_OFFSET 15
197
198 #define SPB_BPDU_MIN_LEN 87
199 #define SPB_BPDU_CONFIG_NAME_OFFSET 3
200 #define SPB_BPDU_CONFIG_REV_OFFSET SPB_BPDU_CONFIG_NAME_OFFSET + 32
201 #define SPB_BPDU_CONFIG_DIGEST_OFFSET SPB_BPDU_CONFIG_REV_OFFSET + 2
202 #define SPB_BPDU_AGREEMENT_OFFSET SPB_BPDU_CONFIG_DIGEST_OFFSET + 16
203 #define SPB_BPDU_AGREEMENT_CON_OFFSET SPB_BPDU_AGREEMENT_OFFSET + 1
204 #define SPB_BPDU_AGREEMENT_EDGE_OFFSET SPB_BPDU_AGREEMENT_CON_OFFSET + 1
205 #define SPB_BPDU_AGREEMENT_DIGEST_OFFSET SPB_BPDU_AGREEMENT_EDGE_OFFSET + 10
206
207
208 static void
209 stp_print_mstp_bpdu(const struct stp_bpdu_ *stp_bpdu, u_int length)
210 {
211 const u_char *ptr;
212 u_int16_t v3len;
213 u_int16_t v4len;
214 u_int16_t len;
215 u_int16_t msti;
216 u_int16_t offset;
217
218 ptr = (const u_char *)stp_bpdu;
219 printf(", CIST Flags [%s]",
220 bittok2str(stp_bpdu_flag_values, "none", stp_bpdu->flags));
221
222 /*
223 * in non-verbose mode just print the flags. We dont read that much
224 * of the packet (DEFAULT_SNAPLEN) to print out cist bridge-id
225 */
226 if (!vflag) {
227 return;
228 }
229
230 printf(", CIST bridge-id %s.%04x, length %u",
231 stp_print_bridge_id(ptr + MST_BPDU_CIST_BRIDGE_ID_OFFSET),
232 EXTRACT_16BITS(&stp_bpdu->port_id), length);
233
234
235 printf("\n\tmessage-age %.2fs, max-age %.2fs"
236 ", hello-time %.2fs, forwarding-delay %.2fs",
237 (float)EXTRACT_16BITS(&stp_bpdu->message_age) / STP_TIME_BASE,
238 (float)EXTRACT_16BITS(&stp_bpdu->max_age) / STP_TIME_BASE,
239 (float)EXTRACT_16BITS(&stp_bpdu->hello_time) / STP_TIME_BASE,
240 (float)EXTRACT_16BITS(&stp_bpdu->forward_delay) / STP_TIME_BASE);
241
242 printf("\n\tCIST root-id %s, ext-pathcost %u int-pathcost %u",
243 stp_print_bridge_id((const u_char *)&stp_bpdu->root_id),
244 EXTRACT_32BITS(&stp_bpdu->root_path_cost),
245 EXTRACT_32BITS(ptr + MST_BPDU_CIST_INT_PATH_COST_OFFSET));
246
247 printf("\n\t\tport-role %s",
248 tok2str(rstp_obj_port_role_values, "Unknown",
249 RSTP_EXTRACT_PORT_ROLE(stp_bpdu->flags)));
250
251 printf("\n\tCIST regional-root-id %s",
252 stp_print_bridge_id((const u_char *)&stp_bpdu->bridge_id));
253
254 printf("\n\tMSTP Configuration Name %s, revision %u, \n\t\tdigest %08x%08x%08x%08x",
255 ptr + MST_BPDU_CONFIG_NAME_OFFSET,
256 EXTRACT_16BITS(ptr + MST_BPDU_CONFIG_NAME_OFFSET + 32),
257 EXTRACT_32BITS(ptr + MST_BPDU_CONFIG_DIGEST_OFFSET),
258 EXTRACT_32BITS(ptr + MST_BPDU_CONFIG_DIGEST_OFFSET + 4),
259 EXTRACT_32BITS(ptr + MST_BPDU_CONFIG_DIGEST_OFFSET + 8),
260 EXTRACT_32BITS(ptr + MST_BPDU_CONFIG_DIGEST_OFFSET + 12));
261
262 printf("\n\tCIST remaining-hops %d", ptr[MST_BPDU_CIST_REMAIN_HOPS_OFFSET]);
263
264 /* Dump all MSTI's */
265 v3len = EXTRACT_16BITS(ptr + MST_BPDU_VER3_LEN_OFFSET);
266 if (v3len > MST_BPDU_CONFIG_INFO_LENGTH) {
267 len = v3len - MST_BPDU_CONFIG_INFO_LENGTH;
268 offset = MST_BPDU_MSTI_OFFSET;
269 while (len >= MST_BPDU_MSTI_LENGTH) {
270 msti = EXTRACT_16BITS(ptr + offset +
271 MST_BPDU_MSTI_ROOT_PRIO_OFFSET);
272 msti = msti & 0x0FFF;
273
274 printf("\n\tMSTI %d, Flags [%s], port-role %s",
275 msti, bittok2str(stp_bpdu_flag_values, "none", ptr[offset]),
276 tok2str(rstp_obj_port_role_values, "Unknown",
277 RSTP_EXTRACT_PORT_ROLE(ptr[offset])));
278 printf("\n\t\tMSTI regional-root-id %s, pathcost %u",
279 stp_print_bridge_id(ptr + offset +
280 MST_BPDU_MSTI_ROOT_PRIO_OFFSET),
281 EXTRACT_32BITS(ptr + offset +
282 MST_BPDU_MSTI_ROOT_PATH_COST_OFFSET));
283 printf("\n\t\tMSTI bridge-prio %d, port-prio %d, hops %d",
284 ptr[offset + MST_BPDU_MSTI_BRIDGE_PRIO_OFFSET] >> 4,
285 ptr[offset + MST_BPDU_MSTI_PORT_PRIO_OFFSET] >> 4,
286 ptr[offset + MST_BPDU_MSTI_REMAIN_HOPS_OFFSET]);
287
288 len -= MST_BPDU_MSTI_LENGTH;
289 offset += MST_BPDU_MSTI_LENGTH;
290 }
291 }
292
293 if (length != offset)
294 {
295 printf("\n\tv4len: %d AUXMCID Name %s, Rev: %u, \n\t\tdigest %08x%08x%08x%08x",
296 EXTRACT_16BITS (ptr + offset),
297 ptr + offset + SPB_BPDU_CONFIG_NAME_OFFSET,
298 EXTRACT_16BITS(ptr + offset + SPB_BPDU_CONFIG_REV_OFFSET),
299 EXTRACT_32BITS(ptr + offset + SPB_BPDU_CONFIG_DIGEST_OFFSET),
300 EXTRACT_32BITS(ptr + offset + SPB_BPDU_CONFIG_DIGEST_OFFSET + 4),
301 EXTRACT_32BITS(ptr + offset + SPB_BPDU_CONFIG_DIGEST_OFFSET + 8),
302 EXTRACT_32BITS(ptr + offset + SPB_BPDU_CONFIG_DIGEST_OFFSET + 12));
303
304 printf("\n\tFormat ID: %d, Cap: %d, Convention ID: %d, Cap: %d, EdgeCount:%d\n"
305 "\tDigest: %08x%08x%08x%08x%08x\n",
306 ptr[offset + SPB_BPDU_AGREEMENT_OFFSET]>>4,
307 ptr[offset + SPB_BPDU_AGREEMENT_OFFSET]&0x00ff,
308 ptr[offset + SPB_BPDU_AGREEMENT_CON_OFFSET]>>4,
309 ptr[offset + SPB_BPDU_AGREEMENT_CON_OFFSET]&0x00ff,
310 EXTRACT_16BITS(ptr + offset + SPB_BPDU_AGREEMENT_EDGE_OFFSET),
311 EXTRACT_32BITS(ptr + offset + SPB_BPDU_AGREEMENT_DIGEST_OFFSET),
312 EXTRACT_32BITS(ptr + offset + SPB_BPDU_AGREEMENT_DIGEST_OFFSET)+4,
313 EXTRACT_32BITS(ptr + offset + SPB_BPDU_AGREEMENT_DIGEST_OFFSET)+8,
314 EXTRACT_32BITS(ptr + offset + SPB_BPDU_AGREEMENT_DIGEST_OFFSET)+12,
315 EXTRACT_32BITS(ptr + offset + SPB_BPDU_AGREEMENT_DIGEST_OFFSET)+16);
316 }
317 }
318
319 /*
320 * Print 802.1d / 802.1w / 802.1q (mstp) / 802.1aq (spb) packets.
321 */
322 void
323 stp_print(const u_char *p, u_int length)
324 {
325 const struct stp_bpdu_ *stp_bpdu;
326 u_int16_t mstp_len;
327 u_int16_t spb_len;
328
329 stp_bpdu = (struct stp_bpdu_*)p;
330
331 /* Minimum STP Frame size. */
332 if (length < 4)
333 goto trunc;
334
335 if (EXTRACT_16BITS(&stp_bpdu->protocol_id)) {
336 printf("unknown STP version, length %u", length);
337 return;
338 }
339
340 printf("STP %s", tok2str(stp_proto_values, "Unknown STP protocol (0x%02x)",
341 stp_bpdu->protocol_version));
342
343 switch (stp_bpdu->protocol_version) {
344 case STP_PROTO_REGULAR:
345 case STP_PROTO_RAPID:
346 case STP_PROTO_MSTP:
347 case STP_PROTO_SPB:
348 break;
349 default:
350 return;
351 }
352
353 printf(", %s", tok2str(stp_bpdu_type_values, "Unknown BPDU Type (0x%02x)",
354 stp_bpdu->bpdu_type));
355
356 switch (stp_bpdu->bpdu_type) {
357 case STP_BPDU_TYPE_CONFIG:
358 if (length < sizeof(struct stp_bpdu_) - 1) {
359 goto trunc;
360 }
361 stp_print_config_bpdu(stp_bpdu, length);
362 break;
363
364 case STP_BPDU_TYPE_RSTP:
365 if (stp_bpdu->protocol_version == STP_PROTO_RAPID) {
366 if (length < sizeof(struct stp_bpdu_)) {
367 goto trunc;
368 }
369 stp_print_config_bpdu(stp_bpdu, length);
370 } else if (stp_bpdu->protocol_version == STP_PROTO_MSTP ||
371 stp_bpdu->protocol_version == STP_PROTO_SPB) {
372 if (length < STP_BPDU_MSTP_MIN_LEN) {
373 goto trunc;
374 }
375 if (stp_bpdu->v1_length != 0) {
376 /* FIX ME: Emit a message here ? */
377 goto trunc;
378 }
379 /* Validate v3 length */
380 mstp_len = EXTRACT_16BITS(p + MST_BPDU_VER3_LEN_OFFSET);
381 mstp_len += 2; /* length encoding itself is 2 bytes */
382 if (length < (sizeof(struct stp_bpdu_) + mstp_len)) {
383 goto trunc;
384 }
385
386 if (stp_bpdu->protocol_version == STP_PROTO_SPB)
387 {
388 spb_len = EXTRACT_16BITS (p + MST_BPDU_VER3_LEN_OFFSET + mstp_len);
389 spb_len += 2;
390 if (length < (sizeof(struct stp_bpdu_) + mstp_len + spb_len) ||
391 spb_len < SPB_BPDU_MIN_LEN) {
392 goto trunc;
393 }
394 }
395
396 stp_print_mstp_bpdu(stp_bpdu, length);
397 }
398 break;
399
400 case STP_BPDU_TYPE_TOPO_CHANGE:
401 /* always empty message - just break out */
402 break;
403
404 default:
405 break;
406 }
407
408 return;
409 trunc:
410 printf("[|stp %d]", length);
411 }
412
413 /*
414 * Local Variables:
415 * c-style: whitesmith
416 * c-basic-offset: 4
417 * End:
418 */
[mirror] the TCPdump network dissector