2 * Copyright (c) 1998-2006 The TCPDUMP project
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that: (1) source code
6 * distributions retain the above copyright notice and this paragraph
7 * in its entirety, and (2) distributions including binary code include
8 * the above copyright notice and this paragraph in its entirety in
9 * the documentation or other materials provided with the distribution.
10 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND
11 * WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, WITHOUT
12 * LIMITATION, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
13 * FOR A PARTICULAR PURPOSE.
15 * Support for the IEEE Connectivity Fault Management Protocols as per 802.1ag.
17 * Original code by Hannes Gredler (hannes@juniper.net)
20 #define NETDISSECT_REWORKED
25 #include <tcpdump-stdinc.h>
29 #include "interface.h"
32 #include "addrtoname.h"
36 struct cfm_common_header_t {
37 uint8_t mdlevel_version;
40 uint8_t first_tlv_offset;
44 #define CFM_EXTRACT_VERSION(x) (((x)&0x1f))
45 #define CFM_EXTRACT_MD_LEVEL(x) (((x)&0xe0)>>5)
47 #define CFM_OPCODE_CCM 1
48 #define CFM_OPCODE_LBR 2
49 #define CFM_OPCODE_LBM 3
50 #define CFM_OPCODE_LTR 4
51 #define CFM_OPCODE_LTM 5
53 static const struct tok cfm_opcode_values[] = {
54 { CFM_OPCODE_CCM, "Continouity Check Message"},
55 { CFM_OPCODE_LBR, "Loopback Reply"},
56 { CFM_OPCODE_LBM, "Loopback Message"},
57 { CFM_OPCODE_LTR, "Linktrace Reply"},
58 { CFM_OPCODE_LTM, "Linktrace Message"},
68 uint8_t md_nameformat;
69 uint8_t md_namelength;
70 uint8_t md_name[46]; /* md name and short ma name */
71 uint8_t reserved_itu[16];
76 * Timer Bases for the CCM Interval field.
77 * Expressed in units of seconds.
79 const float ccm_interval_base[8] = {0, 0.003333, 0.01, 0.1, 1, 10, 60, 600};
80 #define CCM_INTERVAL_MIN_MULTIPLIER 3.25
81 #define CCM_INTERVAL_MAX_MULTIPLIER 3.5
83 #define CFM_CCM_RDI_FLAG 0x80
84 #define CFM_EXTRACT_CCM_INTERVAL(x) (((x)&0x07))
86 #define CFM_CCM_MD_FORMAT_8021 0
87 #define CFM_CCM_MD_FORMAT_NONE 1
88 #define CFM_CCM_MD_FORMAT_DNS 2
89 #define CFM_CCM_MD_FORMAT_MAC 3
90 #define CFM_CCM_MD_FORMAT_CHAR 4
92 static const struct tok cfm_md_nameformat_values[] = {
93 { CFM_CCM_MD_FORMAT_8021, "IEEE 802.1"},
94 { CFM_CCM_MD_FORMAT_NONE, "No MD Name present"},
95 { CFM_CCM_MD_FORMAT_DNS, "DNS string"},
96 { CFM_CCM_MD_FORMAT_MAC, "MAC + 16Bit Integer"},
97 { CFM_CCM_MD_FORMAT_CHAR, "Character string"},
101 #define CFM_CCM_MA_FORMAT_8021 0
102 #define CFM_CCM_MA_FORMAT_VID 1
103 #define CFM_CCM_MA_FORMAT_CHAR 2
104 #define CFM_CCM_MA_FORMAT_INT 3
105 #define CFM_CCM_MA_FORMAT_VPN 4
107 static const struct tok cfm_ma_nameformat_values[] = {
108 { CFM_CCM_MA_FORMAT_8021, "IEEE 802.1"},
109 { CFM_CCM_MA_FORMAT_VID, "Primary VID"},
110 { CFM_CCM_MA_FORMAT_CHAR, "Character string"},
111 { CFM_CCM_MA_FORMAT_INT, "16Bit Integer"},
112 { CFM_CCM_MA_FORMAT_VPN, "RFC2685 VPN-ID"},
117 uint8_t transaction_id[4];
122 uint8_t transaction_id[4];
123 uint8_t egress_id[8];
125 uint8_t original_mac[ETHER_ADDR_LEN];
126 uint8_t target_mac[ETHER_ADDR_LEN];
130 static const struct tok cfm_ltm_flag_values[] = {
131 { 0x80, "Use Forwarding-DB only"},
136 uint8_t transaction_id[4];
137 uint8_t last_egress_id[8];
138 uint8_t next_egress_id[8];
140 uint8_t replay_action;
144 static const struct tok cfm_ltr_flag_values[] = {
145 { 0x80, "UseFDB Only"},
147 { 0x20, "Terminal MEP"},
151 static const struct tok cfm_ltr_replay_action_values[] = {
153 { 2, "Filtering DB"},
159 #define CFM_TLV_END 0
160 #define CFM_TLV_SENDER_ID 1
161 #define CFM_TLV_PORT_STATUS 2
162 #define CFM_TLV_INTERFACE_STATUS 3
163 #define CFM_TLV_DATA 4
164 #define CFM_TLV_REPLY_INGRESS 5
165 #define CFM_TLV_REPLY_EGRESS 6
166 #define CFM_TLV_PRIVATE 31
168 static const struct tok cfm_tlv_values[] = {
169 { CFM_TLV_END, "End"},
170 { CFM_TLV_SENDER_ID, "Sender ID"},
171 { CFM_TLV_PORT_STATUS, "Port status"},
172 { CFM_TLV_INTERFACE_STATUS, "Interface status"},
173 { CFM_TLV_DATA, "Data"},
174 { CFM_TLV_REPLY_INGRESS, "Reply Ingress"},
175 { CFM_TLV_REPLY_EGRESS, "Reply Egress"},
176 { CFM_TLV_PRIVATE, "Organization Specific"},
184 struct cfm_tlv_header_t {
189 /* FIXME define TLV formats */
191 static const struct tok cfm_tlv_port_status_values[] = {
197 static const struct tok cfm_tlv_interface_status_values[] = {
203 { 7, "lower Layer down"},
207 #define CFM_CHASSIS_ID_CHASSIS_COMPONENT 1
208 #define CFM_CHASSIS_ID_INTERFACE_ALIAS 2
209 #define CFM_CHASSIS_ID_PORT_COMPONENT 3
210 #define CFM_CHASSIS_ID_MAC_ADDRESS 4
211 #define CFM_CHASSIS_ID_NETWORK_ADDRESS 5
212 #define CFM_CHASSIS_ID_INTERFACE_NAME 6
213 #define CFM_CHASSIS_ID_LOCAL 7
215 static const struct tok cfm_tlv_senderid_chassisid_values[] = {
217 { CFM_CHASSIS_ID_CHASSIS_COMPONENT, "Chassis component"},
218 { CFM_CHASSIS_ID_INTERFACE_ALIAS, "Interface alias"},
219 { CFM_CHASSIS_ID_PORT_COMPONENT, "Port component"},
220 { CFM_CHASSIS_ID_MAC_ADDRESS, "MAC address"},
221 { CFM_CHASSIS_ID_NETWORK_ADDRESS, "Network address"},
222 { CFM_CHASSIS_ID_INTERFACE_NAME, "Interface name"},
223 { CFM_CHASSIS_ID_LOCAL, "Locally assigned"},
229 cfm_mgmt_addr_print(netdissect_options *ndo,
230 register const u_char *tptr)
232 u_int mgmt_addr_type;
233 u_int hexdump = FALSE;
236 * Altough AFIs are tpically 2 octects wide,
237 * 802.1ab specifies that this field width
240 mgmt_addr_type = *tptr;
241 ND_PRINT((ndo, "\n\t Management Address Type %s (%u)",
242 tok2str(af_values, "Unknown", mgmt_addr_type),
246 * Resolve the passed in Address.
248 switch(mgmt_addr_type) {
250 ND_PRINT((ndo, ", %s", ipaddr_string(ndo, tptr + 1)));
255 ND_PRINT((ndo, ", %s", ip6addr_string(ndo, tptr + 1)));
268 * The egress-ID string is a 16-Bit string plus a MAC address.
271 cfm_egress_id_string(netdissect_options *ndo, register const u_char *tptr)
273 static char egress_id_buffer[80];
275 snprintf(egress_id_buffer, sizeof(egress_id_buffer),
277 EXTRACT_16BITS(tptr),
278 etheraddr_string(ndo, tptr+2));
280 return egress_id_buffer;
284 cfm_print(netdissect_options *ndo,
285 register const u_char *pptr, register u_int length)
287 const struct cfm_common_header_t *cfm_common_header;
288 const struct cfm_tlv_header_t *cfm_tlv_header;
289 const uint8_t *tptr, *tlv_ptr, *ma_name, *ma_nameformat, *ma_namelength;
290 u_int hexdump, tlen, cfm_tlv_len, cfm_tlv_type, ccm_interval;
294 const struct cfm_ccm_t *cfm_ccm;
295 const struct cfm_lbm_t *cfm_lbm;
296 const struct cfm_ltm_t *cfm_ltm;
297 const struct cfm_ltr_t *cfm_ltr;
301 cfm_common_header = (const struct cfm_common_header_t *)pptr;
302 ND_TCHECK(*cfm_common_header);
305 * Sanity checking of the header.
307 if (CFM_EXTRACT_VERSION(cfm_common_header->mdlevel_version) != CFM_VERSION) {
308 ND_PRINT((ndo, "CFMv%u not supported, length %u",
309 CFM_EXTRACT_VERSION(cfm_common_header->mdlevel_version), length));
313 ND_PRINT((ndo, "CFMv%u %s, MD Level %u, length %u",
314 CFM_EXTRACT_VERSION(cfm_common_header->mdlevel_version),
315 tok2str(cfm_opcode_values, "unknown (%u)", cfm_common_header->opcode),
316 CFM_EXTRACT_MD_LEVEL(cfm_common_header->mdlevel_version),
320 * In non-verbose mode just print the opcode and md-level.
322 if (ndo->ndo_vflag < 1) {
326 ND_PRINT((ndo, "\n\tFirst TLV offset %u", cfm_common_header->first_tlv_offset));
328 tptr += sizeof(const struct cfm_common_header_t);
329 tlen = length - sizeof(struct cfm_common_header_t);
331 switch (cfm_common_header->opcode) {
333 msg_ptr.cfm_ccm = (const struct cfm_ccm_t *)tptr;
335 ccm_interval = CFM_EXTRACT_CCM_INTERVAL(cfm_common_header->flags);
336 ND_PRINT((ndo, ", Flags [CCM Interval %u%s]",
338 cfm_common_header->flags & CFM_CCM_RDI_FLAG ?
342 * Resolve the CCM interval field.
345 ND_PRINT((ndo, "\n\t CCM Interval %.3fs"
346 ", min CCM Lifetime %.3fs, max CCM Lifetime %.3fs",
347 ccm_interval_base[ccm_interval],
348 ccm_interval_base[ccm_interval] * CCM_INTERVAL_MIN_MULTIPLIER,
349 ccm_interval_base[ccm_interval] * CCM_INTERVAL_MAX_MULTIPLIER));
352 ND_PRINT((ndo, "\n\t Sequence Number 0x%08x, MA-End-Point-ID 0x%04x",
353 EXTRACT_32BITS(msg_ptr.cfm_ccm->sequence),
354 EXTRACT_16BITS(msg_ptr.cfm_ccm->ma_epi)));
358 * Resolve the MD fields.
360 ND_PRINT((ndo, "\n\t MD Name Format %s (%u), MD Name length %u",
361 tok2str(cfm_md_nameformat_values, "Unknown",
362 msg_ptr.cfm_ccm->md_nameformat),
363 msg_ptr.cfm_ccm->md_nameformat,
364 msg_ptr.cfm_ccm->md_namelength));
366 if (msg_ptr.cfm_ccm->md_nameformat != CFM_CCM_MD_FORMAT_NONE) {
367 ND_PRINT((ndo, "\n\t MD Name: "));
368 switch (msg_ptr.cfm_ccm->md_nameformat) {
369 case CFM_CCM_MD_FORMAT_DNS:
370 case CFM_CCM_MD_FORMAT_CHAR:
371 safeputs(ndo, msg_ptr.cfm_ccm->md_name, msg_ptr.cfm_ccm->md_namelength);
374 case CFM_CCM_MD_FORMAT_MAC:
375 ND_PRINT((ndo, "\n\t MAC %s", etheraddr_string(ndo,
376 msg_ptr.cfm_ccm->md_name)));
379 /* FIXME add printers for those MD formats - hexdump for now */
380 case CFM_CCM_MA_FORMAT_8021:
382 print_unknown_data(ndo, msg_ptr.cfm_ccm->md_name, "\n\t ",
383 msg_ptr.cfm_ccm->md_namelength);
389 * Resolve the MA fields.
391 ma_nameformat = msg_ptr.cfm_ccm->md_name + msg_ptr.cfm_ccm->md_namelength;
392 ma_namelength = msg_ptr.cfm_ccm->md_name + msg_ptr.cfm_ccm->md_namelength + 1;
393 ma_name = msg_ptr.cfm_ccm->md_name + msg_ptr.cfm_ccm->md_namelength + 2;
395 ND_PRINT((ndo, "\n\t MA Name-Format %s (%u), MA name length %u",
396 tok2str(cfm_ma_nameformat_values, "Unknown",
401 ND_PRINT((ndo, "\n\t MA Name: "));
402 switch (*ma_nameformat) {
403 case CFM_CCM_MA_FORMAT_CHAR:
404 safeputs(ndo, ma_name, *ma_namelength);
407 /* FIXME add printers for those MA formats - hexdump for now */
408 case CFM_CCM_MA_FORMAT_8021:
409 case CFM_CCM_MA_FORMAT_VID:
410 case CFM_CCM_MA_FORMAT_INT:
411 case CFM_CCM_MA_FORMAT_VPN:
413 print_unknown_data(ndo, ma_name, "\n\t ", *ma_namelength);
418 msg_ptr.cfm_ltm = (const struct cfm_ltm_t *)tptr;
420 ND_PRINT((ndo, ", Flags [%s]",
421 bittok2str(cfm_ltm_flag_values, "none", cfm_common_header->flags)));
423 ND_PRINT((ndo, "\n\t Transaction-ID 0x%08x, Egress-ID %s, ttl %u",
424 EXTRACT_32BITS(msg_ptr.cfm_ltm->transaction_id),
425 cfm_egress_id_string(ndo, msg_ptr.cfm_ltm->egress_id),
426 msg_ptr.cfm_ltm->ttl));
428 ND_PRINT((ndo, "\n\t Original-MAC %s, Target-MAC %s",
429 etheraddr_string(ndo, msg_ptr.cfm_ltm->original_mac),
430 etheraddr_string(ndo, msg_ptr.cfm_ltm->target_mac)));
434 msg_ptr.cfm_ltr = (const struct cfm_ltr_t *)tptr;
436 ND_PRINT((ndo, ", Flags [%s]",
437 bittok2str(cfm_ltr_flag_values, "none", cfm_common_header->flags)));
439 ND_PRINT((ndo, "\n\t Transaction-ID 0x%08x, Last-Egress-ID %s",
440 EXTRACT_32BITS(msg_ptr.cfm_ltr->transaction_id),
441 cfm_egress_id_string(ndo, msg_ptr.cfm_ltr->last_egress_id)));
443 ND_PRINT((ndo, "\n\t Next-Egress-ID %s, ttl %u",
444 cfm_egress_id_string(ndo, msg_ptr.cfm_ltr->next_egress_id),
445 msg_ptr.cfm_ltr->ttl));
447 ND_PRINT((ndo, "\n\t Replay-Action %s (%u)",
448 tok2str(cfm_ltr_replay_action_values,
450 msg_ptr.cfm_ltr->replay_action),
451 msg_ptr.cfm_ltr->replay_action));
455 * No message decoder yet.
456 * Hexdump everything up until the start of the TLVs
461 if (tlen > cfm_common_header->first_tlv_offset) {
462 print_unknown_data(ndo, tptr, "\n\t ",
463 tlen - cfm_common_header->first_tlv_offset);
469 * Sanity check for not walking off.
471 if (tlen <= cfm_common_header->first_tlv_offset) {
475 tptr += cfm_common_header->first_tlv_offset;
476 tlen -= cfm_common_header->first_tlv_offset;
479 cfm_tlv_header = (const struct cfm_tlv_header_t *)tptr;
481 /* Enough to read the tlv type ? */
482 ND_TCHECK2(*tptr, 1);
483 cfm_tlv_type=cfm_tlv_header->type;
485 if (cfm_tlv_type != CFM_TLV_END) {
486 /* did we capture enough for fully decoding the object header ? */
487 ND_TCHECK2(*tptr, sizeof(struct cfm_tlv_header_t));
488 cfm_tlv_len=EXTRACT_16BITS(&cfm_tlv_header->length);
493 ND_PRINT((ndo, "\n\t%s TLV (0x%02x), length %u",
494 tok2str(cfm_tlv_values, "Unknown", cfm_tlv_type),
498 /* sanity check for not walking off and infinite loop check. */
499 if ((cfm_tlv_type != CFM_TLV_END) &&
500 ((cfm_tlv_len + sizeof(struct cfm_tlv_header_t) > tlen) ||
502 print_unknown_data(ndo, tptr, "\n\t ", tlen);
506 tptr += sizeof(struct cfm_tlv_header_t);
507 tlen -= sizeof(struct cfm_tlv_header_t);
510 /* did we capture enough for fully decoding the object ? */
511 if (cfm_tlv_type != CFM_TLV_END) {
512 ND_TCHECK2(*tptr, cfm_tlv_len);
516 switch(cfm_tlv_type) {
518 /* we are done - bail out */
521 case CFM_TLV_PORT_STATUS:
522 ND_PRINT((ndo, ", Status: %s (%u)",
523 tok2str(cfm_tlv_port_status_values, "Unknown", *tptr),
527 case CFM_TLV_INTERFACE_STATUS:
528 ND_PRINT((ndo, ", Status: %s (%u)",
529 tok2str(cfm_tlv_interface_status_values, "Unknown", *tptr),
533 case CFM_TLV_PRIVATE:
534 ND_PRINT((ndo, ", Vendor: %s (%u), Sub-Type %u",
535 tok2str(oui_values,"Unknown", EXTRACT_24BITS(tptr)),
536 EXTRACT_24BITS(tptr),
541 case CFM_TLV_SENDER_ID:
543 u_int chassis_id_type, chassis_id_length;
544 u_int mgmt_addr_length;
547 * Check if there is a Chassis-ID.
549 chassis_id_length = *tptr;
550 if (chassis_id_length > tlen) {
558 if (chassis_id_length) {
559 chassis_id_type = *tptr;
560 ND_PRINT((ndo, "\n\t Chassis-ID Type %s (%u), Chassis-ID length %u",
561 tok2str(cfm_tlv_senderid_chassisid_values,
567 switch (chassis_id_type) {
568 case CFM_CHASSIS_ID_MAC_ADDRESS:
569 ND_PRINT((ndo, "\n\t MAC %s", etheraddr_string(ndo, tptr + 1)));
572 case CFM_CHASSIS_ID_NETWORK_ADDRESS:
573 hexdump |= cfm_mgmt_addr_print(ndo, tptr);
576 case CFM_CHASSIS_ID_INTERFACE_NAME: /* fall through */
577 case CFM_CHASSIS_ID_INTERFACE_ALIAS:
578 case CFM_CHASSIS_ID_LOCAL:
579 case CFM_CHASSIS_ID_CHASSIS_COMPONENT:
580 case CFM_CHASSIS_ID_PORT_COMPONENT:
581 safeputs(ndo, tptr + 1, chassis_id_length);
590 tptr += chassis_id_length;
591 tlen -= chassis_id_length;
594 * Check if there is a Management Address.
596 mgmt_addr_length = *tptr;
597 if (mgmt_addr_length > tlen) {
605 if (mgmt_addr_length) {
606 hexdump |= cfm_mgmt_addr_print(ndo, tptr);
609 tptr += mgmt_addr_length;
610 tlen -= mgmt_addr_length;
616 * FIXME those are the defined TLVs that lack a decoder
617 * you are welcome to contribute code ;-)
621 case CFM_TLV_REPLY_INGRESS:
622 case CFM_TLV_REPLY_EGRESS:
627 /* do we want to see an additional hexdump ? */
628 if (hexdump || ndo->ndo_vflag > 1)
629 print_unknown_data(ndo, tlv_ptr, "\n\t ", cfm_tlv_len);
636 ND_PRINT((ndo, "\n\t\t packet exceeded snapshot"));