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 * Original code by Hannes Gredler (hannes@juniper.net)
18 /* \summary: IEEE 802.1ag Connectivity Fault Management (CFM) protocols printer */
24 #include <netdissect-stdinc.h>
28 #include "netdissect.h"
31 #include "addrtoname.h"
35 struct cfm_common_header_t {
36 uint8_t mdlevel_version;
39 uint8_t first_tlv_offset;
43 #define CFM_EXTRACT_VERSION(x) (((x)&0x1f))
44 #define CFM_EXTRACT_MD_LEVEL(x) (((x)&0xe0)>>5)
46 #define CFM_OPCODE_CCM 1
47 #define CFM_OPCODE_LBR 2
48 #define CFM_OPCODE_LBM 3
49 #define CFM_OPCODE_LTR 4
50 #define CFM_OPCODE_LTM 5
52 static const struct tok cfm_opcode_values[] = {
53 { CFM_OPCODE_CCM, "Continouity Check Message"},
54 { CFM_OPCODE_LBR, "Loopback Reply"},
55 { CFM_OPCODE_LBM, "Loopback Message"},
56 { CFM_OPCODE_LTR, "Linktrace Reply"},
57 { CFM_OPCODE_LTM, "Linktrace Message"},
68 uint8_t itu_t_y_1731[16];
72 * Timer Bases for the CCM Interval field.
73 * Expressed in units of seconds.
75 static const float ccm_interval_base[8] = {0, 0.003333, 0.01, 0.1, 1, 10, 60, 600};
76 #define CCM_INTERVAL_MIN_MULTIPLIER 3.25
77 #define CCM_INTERVAL_MAX_MULTIPLIER 3.5
79 #define CFM_CCM_RDI_FLAG 0x80
80 #define CFM_EXTRACT_CCM_INTERVAL(x) (((x)&0x07))
82 #define CFM_CCM_MD_FORMAT_8021 0
83 #define CFM_CCM_MD_FORMAT_NONE 1
84 #define CFM_CCM_MD_FORMAT_DNS 2
85 #define CFM_CCM_MD_FORMAT_MAC 3
86 #define CFM_CCM_MD_FORMAT_CHAR 4
88 static const struct tok cfm_md_nameformat_values[] = {
89 { CFM_CCM_MD_FORMAT_8021, "IEEE 802.1"},
90 { CFM_CCM_MD_FORMAT_NONE, "No MD Name present"},
91 { CFM_CCM_MD_FORMAT_DNS, "DNS string"},
92 { CFM_CCM_MD_FORMAT_MAC, "MAC + 16Bit Integer"},
93 { CFM_CCM_MD_FORMAT_CHAR, "Character string"},
97 #define CFM_CCM_MA_FORMAT_8021 0
98 #define CFM_CCM_MA_FORMAT_VID 1
99 #define CFM_CCM_MA_FORMAT_CHAR 2
100 #define CFM_CCM_MA_FORMAT_INT 3
101 #define CFM_CCM_MA_FORMAT_VPN 4
103 static const struct tok cfm_ma_nameformat_values[] = {
104 { CFM_CCM_MA_FORMAT_8021, "IEEE 802.1"},
105 { CFM_CCM_MA_FORMAT_VID, "Primary VID"},
106 { CFM_CCM_MA_FORMAT_CHAR, "Character string"},
107 { CFM_CCM_MA_FORMAT_INT, "16Bit Integer"},
108 { CFM_CCM_MA_FORMAT_VPN, "RFC2685 VPN-ID"},
113 uint8_t transaction_id[4];
117 uint8_t transaction_id[4];
119 uint8_t original_mac[ETHER_ADDR_LEN];
120 uint8_t target_mac[ETHER_ADDR_LEN];
123 static const struct tok cfm_ltm_flag_values[] = {
124 { 0x80, "Use Forwarding-DB only"},
129 uint8_t transaction_id[4];
131 uint8_t replay_action;
134 static const struct tok cfm_ltr_flag_values[] = {
135 { 0x80, "UseFDB Only"},
137 { 0x20, "Terminal MEP"},
141 static const struct tok cfm_ltr_replay_action_values[] = {
143 { 2, "Filtering DB"},
149 #define CFM_TLV_END 0
150 #define CFM_TLV_SENDER_ID 1
151 #define CFM_TLV_PORT_STATUS 2
152 #define CFM_TLV_INTERFACE_STATUS 3
153 #define CFM_TLV_DATA 4
154 #define CFM_TLV_REPLY_INGRESS 5
155 #define CFM_TLV_REPLY_EGRESS 6
156 #define CFM_TLV_PRIVATE 31
158 static const struct tok cfm_tlv_values[] = {
159 { CFM_TLV_END, "End"},
160 { CFM_TLV_SENDER_ID, "Sender ID"},
161 { CFM_TLV_PORT_STATUS, "Port status"},
162 { CFM_TLV_INTERFACE_STATUS, "Interface status"},
163 { CFM_TLV_DATA, "Data"},
164 { CFM_TLV_REPLY_INGRESS, "Reply Ingress"},
165 { CFM_TLV_REPLY_EGRESS, "Reply Egress"},
166 { CFM_TLV_PRIVATE, "Organization Specific"},
174 struct cfm_tlv_header_t {
179 /* FIXME define TLV formats */
181 static const struct tok cfm_tlv_port_status_values[] = {
187 static const struct tok cfm_tlv_interface_status_values[] = {
193 { 7, "lower Layer down"},
197 #define CFM_CHASSIS_ID_CHASSIS_COMPONENT 1
198 #define CFM_CHASSIS_ID_INTERFACE_ALIAS 2
199 #define CFM_CHASSIS_ID_PORT_COMPONENT 3
200 #define CFM_CHASSIS_ID_MAC_ADDRESS 4
201 #define CFM_CHASSIS_ID_NETWORK_ADDRESS 5
202 #define CFM_CHASSIS_ID_INTERFACE_NAME 6
203 #define CFM_CHASSIS_ID_LOCAL 7
205 static const struct tok cfm_tlv_senderid_chassisid_values[] = {
207 { CFM_CHASSIS_ID_CHASSIS_COMPONENT, "Chassis component"},
208 { CFM_CHASSIS_ID_INTERFACE_ALIAS, "Interface alias"},
209 { CFM_CHASSIS_ID_PORT_COMPONENT, "Port component"},
210 { CFM_CHASSIS_ID_MAC_ADDRESS, "MAC address"},
211 { CFM_CHASSIS_ID_NETWORK_ADDRESS, "Network address"},
212 { CFM_CHASSIS_ID_INTERFACE_NAME, "Interface name"},
213 { CFM_CHASSIS_ID_LOCAL, "Locally assigned"},
219 cfm_network_addr_print(netdissect_options *ndo,
220 register const u_char *tptr)
222 u_int network_addr_type;
223 u_int hexdump = FALSE;
226 * Altough AFIs are tpically 2 octects wide,
227 * 802.1ab specifies that this field width
230 network_addr_type = *tptr;
231 ND_PRINT((ndo, "\n\t Network Address Type %s (%u)",
232 tok2str(af_values, "Unknown", network_addr_type),
236 * Resolve the passed in Address.
238 switch(network_addr_type) {
240 ND_PRINT((ndo, ", %s", ipaddr_string(ndo, tptr + 1)));
244 ND_PRINT((ndo, ", %s", ip6addr_string(ndo, tptr + 1)));
256 cfm_print(netdissect_options *ndo,
257 register const u_char *pptr, register u_int length)
259 const struct cfm_common_header_t *cfm_common_header;
260 const struct cfm_tlv_header_t *cfm_tlv_header;
261 const uint8_t *tptr, *tlv_ptr;
262 const uint8_t *namesp;
263 u_int names_data_remaining;
264 uint8_t md_nameformat, md_namelength;
265 const uint8_t *md_name;
266 uint8_t ma_nameformat, ma_namelength;
267 const uint8_t *ma_name;
268 u_int hexdump, tlen, cfm_tlv_len, cfm_tlv_type, ccm_interval;
272 const struct cfm_ccm_t *cfm_ccm;
273 const struct cfm_lbm_t *cfm_lbm;
274 const struct cfm_ltm_t *cfm_ltm;
275 const struct cfm_ltr_t *cfm_ltr;
279 cfm_common_header = (const struct cfm_common_header_t *)pptr;
280 if (length < sizeof(*cfm_common_header))
282 ND_TCHECK(*cfm_common_header);
285 * Sanity checking of the header.
287 if (CFM_EXTRACT_VERSION(cfm_common_header->mdlevel_version) != CFM_VERSION) {
288 ND_PRINT((ndo, "CFMv%u not supported, length %u",
289 CFM_EXTRACT_VERSION(cfm_common_header->mdlevel_version), length));
293 ND_PRINT((ndo, "CFMv%u %s, MD Level %u, length %u",
294 CFM_EXTRACT_VERSION(cfm_common_header->mdlevel_version),
295 tok2str(cfm_opcode_values, "unknown (%u)", cfm_common_header->opcode),
296 CFM_EXTRACT_MD_LEVEL(cfm_common_header->mdlevel_version),
300 * In non-verbose mode just print the opcode and md-level.
302 if (ndo->ndo_vflag < 1) {
306 ND_PRINT((ndo, "\n\tFirst TLV offset %u", cfm_common_header->first_tlv_offset));
308 tptr += sizeof(const struct cfm_common_header_t);
309 tlen = length - sizeof(struct cfm_common_header_t);
312 * Sanity check the first TLV offset.
314 if (cfm_common_header->first_tlv_offset > tlen) {
315 ND_PRINT((ndo, " (too large, must be <= %u)", tlen));
319 switch (cfm_common_header->opcode) {
321 msg_ptr.cfm_ccm = (const struct cfm_ccm_t *)tptr;
322 if (cfm_common_header->first_tlv_offset < sizeof(*msg_ptr.cfm_ccm)) {
323 ND_PRINT((ndo, " (too small 1, must be >= %lu)",
324 (unsigned long) sizeof(*msg_ptr.cfm_ccm)));
327 if (tlen < sizeof(*msg_ptr.cfm_ccm))
329 ND_TCHECK(*msg_ptr.cfm_ccm);
331 ccm_interval = CFM_EXTRACT_CCM_INTERVAL(cfm_common_header->flags);
332 ND_PRINT((ndo, ", Flags [CCM Interval %u%s]",
334 cfm_common_header->flags & CFM_CCM_RDI_FLAG ?
338 * Resolve the CCM interval field.
341 ND_PRINT((ndo, "\n\t CCM Interval %.3fs"
342 ", min CCM Lifetime %.3fs, max CCM Lifetime %.3fs",
343 ccm_interval_base[ccm_interval],
344 ccm_interval_base[ccm_interval] * CCM_INTERVAL_MIN_MULTIPLIER,
345 ccm_interval_base[ccm_interval] * CCM_INTERVAL_MAX_MULTIPLIER));
348 ND_PRINT((ndo, "\n\t Sequence Number 0x%08x, MA-End-Point-ID 0x%04x",
349 EXTRACT_32BITS(msg_ptr.cfm_ccm->sequence),
350 EXTRACT_16BITS(msg_ptr.cfm_ccm->ma_epi)));
352 namesp = msg_ptr.cfm_ccm->names;
353 names_data_remaining = sizeof(msg_ptr.cfm_ccm->names);
356 * Resolve the MD fields.
358 md_nameformat = *namesp;
360 names_data_remaining--; /* We know this is != 0 */
361 if (md_nameformat != CFM_CCM_MD_FORMAT_NONE) {
362 md_namelength = *namesp;
364 names_data_remaining--; /* We know this is !=0 */
365 ND_PRINT((ndo, "\n\t MD Name Format %s (%u), MD Name length %u",
366 tok2str(cfm_md_nameformat_values, "Unknown",
371 /* -2 for the MA short name format and length */
372 if (md_namelength > names_data_remaining - 2) {
373 ND_PRINT((ndo, " (too large, must be <= %u)", names_data_remaining - 2));
378 ND_PRINT((ndo, "\n\t MD Name: "));
379 switch (md_nameformat) {
380 case CFM_CCM_MD_FORMAT_DNS:
381 case CFM_CCM_MD_FORMAT_CHAR:
382 safeputs(ndo, md_name, md_namelength);
385 case CFM_CCM_MD_FORMAT_MAC:
386 if (md_namelength == 6) {
387 ND_PRINT((ndo, "\n\t MAC %s", etheraddr_string(ndo,
390 ND_PRINT((ndo, "\n\t MAC (length invalid)"));
394 /* FIXME add printers for those MD formats - hexdump for now */
395 case CFM_CCM_MA_FORMAT_8021:
397 print_unknown_data(ndo, md_name, "\n\t ",
400 namesp += md_namelength;
401 names_data_remaining -= md_namelength;
403 ND_PRINT((ndo, "\n\t MD Name Format %s (%u)",
404 tok2str(cfm_md_nameformat_values, "Unknown",
411 * Resolve the MA fields.
413 ma_nameformat = *namesp;
415 names_data_remaining--; /* We know this is != 0 */
416 ma_namelength = *namesp;
418 names_data_remaining--; /* We know this is != 0 */
419 ND_PRINT((ndo, "\n\t MA Name-Format %s (%u), MA name length %u",
420 tok2str(cfm_ma_nameformat_values, "Unknown",
425 if (ma_namelength > names_data_remaining) {
426 ND_PRINT((ndo, " (too large, must be <= %u)", names_data_remaining));
431 ND_PRINT((ndo, "\n\t MA Name: "));
432 switch (ma_nameformat) {
433 case CFM_CCM_MA_FORMAT_CHAR:
434 safeputs(ndo, ma_name, ma_namelength);
437 /* FIXME add printers for those MA formats - hexdump for now */
438 case CFM_CCM_MA_FORMAT_8021:
439 case CFM_CCM_MA_FORMAT_VID:
440 case CFM_CCM_MA_FORMAT_INT:
441 case CFM_CCM_MA_FORMAT_VPN:
443 print_unknown_data(ndo, ma_name, "\n\t ", ma_namelength);
448 msg_ptr.cfm_ltm = (const struct cfm_ltm_t *)tptr;
449 if (cfm_common_header->first_tlv_offset < sizeof(*msg_ptr.cfm_ltm)) {
450 ND_PRINT((ndo, " (too small 4, must be >= %lu)",
451 (unsigned long) sizeof(*msg_ptr.cfm_ltm)));
454 if (tlen < sizeof(*msg_ptr.cfm_ltm))
456 ND_TCHECK(*msg_ptr.cfm_ltm);
458 ND_PRINT((ndo, ", Flags [%s]",
459 bittok2str(cfm_ltm_flag_values, "none", cfm_common_header->flags)));
461 ND_PRINT((ndo, "\n\t Transaction-ID 0x%08x, ttl %u",
462 EXTRACT_32BITS(msg_ptr.cfm_ltm->transaction_id),
463 msg_ptr.cfm_ltm->ttl));
465 ND_PRINT((ndo, "\n\t Original-MAC %s, Target-MAC %s",
466 etheraddr_string(ndo, msg_ptr.cfm_ltm->original_mac),
467 etheraddr_string(ndo, msg_ptr.cfm_ltm->target_mac)));
471 msg_ptr.cfm_ltr = (const struct cfm_ltr_t *)tptr;
472 if (cfm_common_header->first_tlv_offset < sizeof(*msg_ptr.cfm_ltr)) {
473 ND_PRINT((ndo, " (too small 5, must be >= %lu)",
474 (unsigned long) sizeof(*msg_ptr.cfm_ltr)));
477 if (tlen < sizeof(*msg_ptr.cfm_ltr))
479 ND_TCHECK(*msg_ptr.cfm_ltr);
481 ND_PRINT((ndo, ", Flags [%s]",
482 bittok2str(cfm_ltr_flag_values, "none", cfm_common_header->flags)));
484 ND_PRINT((ndo, "\n\t Transaction-ID 0x%08x, ttl %u",
485 EXTRACT_32BITS(msg_ptr.cfm_ltr->transaction_id),
486 msg_ptr.cfm_ltr->ttl));
488 ND_PRINT((ndo, "\n\t Replay-Action %s (%u)",
489 tok2str(cfm_ltr_replay_action_values,
491 msg_ptr.cfm_ltr->replay_action),
492 msg_ptr.cfm_ltr->replay_action));
496 * No message decoder yet.
497 * Hexdump everything up until the start of the TLVs
502 print_unknown_data(ndo, tptr, "\n\t ",
503 tlen - cfm_common_header->first_tlv_offset);
507 tptr += cfm_common_header->first_tlv_offset;
508 tlen -= cfm_common_header->first_tlv_offset;
511 cfm_tlv_header = (const struct cfm_tlv_header_t *)tptr;
513 /* Enough to read the tlv type ? */
514 ND_TCHECK2(*tptr, 1);
515 cfm_tlv_type=cfm_tlv_header->type;
517 ND_PRINT((ndo, "\n\t%s TLV (0x%02x)",
518 tok2str(cfm_tlv_values, "Unknown", cfm_tlv_type),
521 if (cfm_tlv_type == CFM_TLV_END) {
522 /* Length is "Not present if the Type field is 0." */
526 /* do we have the full tlv header ? */
527 if (tlen < sizeof(struct cfm_tlv_header_t))
529 ND_TCHECK2(*tptr, sizeof(struct cfm_tlv_header_t));
530 cfm_tlv_len=EXTRACT_16BITS(&cfm_tlv_header->length);
532 ND_PRINT((ndo, ", length %u", cfm_tlv_len));
534 tptr += sizeof(struct cfm_tlv_header_t);
535 tlen -= sizeof(struct cfm_tlv_header_t);
538 /* do we have the full tlv ? */
539 if (tlen < cfm_tlv_len)
541 ND_TCHECK2(*tptr, cfm_tlv_len);
544 switch(cfm_tlv_type) {
545 case CFM_TLV_PORT_STATUS:
546 if (cfm_tlv_len < 1) {
547 ND_PRINT((ndo, " (too short, must be >= 1)"));
550 ND_PRINT((ndo, ", Status: %s (%u)",
551 tok2str(cfm_tlv_port_status_values, "Unknown", *tptr),
555 case CFM_TLV_INTERFACE_STATUS:
556 if (cfm_tlv_len < 1) {
557 ND_PRINT((ndo, " (too short, must be >= 1)"));
560 ND_PRINT((ndo, ", Status: %s (%u)",
561 tok2str(cfm_tlv_interface_status_values, "Unknown", *tptr),
565 case CFM_TLV_PRIVATE:
566 if (cfm_tlv_len < 4) {
567 ND_PRINT((ndo, " (too short, must be >= 4)"));
570 ND_PRINT((ndo, ", Vendor: %s (%u), Sub-Type %u",
571 tok2str(oui_values,"Unknown", EXTRACT_24BITS(tptr)),
572 EXTRACT_24BITS(tptr),
577 case CFM_TLV_SENDER_ID:
579 u_int chassis_id_type, chassis_id_length;
580 u_int mgmt_addr_length;
582 if (cfm_tlv_len < 1) {
583 ND_PRINT((ndo, " (too short, must be >= 1)"));
588 * Get the Chassis ID length and check it.
590 chassis_id_length = *tptr;
595 if (chassis_id_length) {
596 if (cfm_tlv_len < 1) {
597 ND_PRINT((ndo, "\n\t (TLV too short)"));
600 chassis_id_type = *tptr;
602 ND_PRINT((ndo, "\n\t Chassis-ID Type %s (%u), Chassis-ID length %u",
603 tok2str(cfm_tlv_senderid_chassisid_values,
609 if (cfm_tlv_len < chassis_id_length) {
610 ND_PRINT((ndo, "\n\t (TLV too short)"));
614 switch (chassis_id_type) {
615 case CFM_CHASSIS_ID_MAC_ADDRESS:
616 ND_PRINT((ndo, "\n\t MAC %s", etheraddr_string(ndo, tptr + 1)));
619 case CFM_CHASSIS_ID_NETWORK_ADDRESS:
620 hexdump |= cfm_network_addr_print(ndo, tptr);
623 case CFM_CHASSIS_ID_INTERFACE_NAME: /* fall through */
624 case CFM_CHASSIS_ID_INTERFACE_ALIAS:
625 case CFM_CHASSIS_ID_LOCAL:
626 case CFM_CHASSIS_ID_CHASSIS_COMPONENT:
627 case CFM_CHASSIS_ID_PORT_COMPONENT:
628 safeputs(ndo, tptr + 1, chassis_id_length);
635 cfm_tlv_len -= chassis_id_length;
637 tptr += 1 + chassis_id_length;
638 tlen -= 1 + chassis_id_length;
642 * Check if there is a Management Address.
644 if (cfm_tlv_len == 0) {
645 /* No, there isn't; we're done. */
649 mgmt_addr_length = *tptr;
653 if (mgmt_addr_length) {
654 if (cfm_tlv_len < mgmt_addr_length) {
655 ND_PRINT((ndo, "\n\t (TLV too short)"));
658 cfm_tlv_len -= mgmt_addr_length;
660 * XXX - this is an OID; print it as such.
662 tptr += mgmt_addr_length;
663 tlen -= mgmt_addr_length;
665 if (cfm_tlv_len < 1) {
666 ND_PRINT((ndo, "\n\t (TLV too short)"));
670 mgmt_addr_length = *tptr;
674 if (mgmt_addr_length) {
675 if (cfm_tlv_len < mgmt_addr_length) {
676 ND_PRINT((ndo, "\n\t (TLV too short)"));
679 cfm_tlv_len -= mgmt_addr_length;
681 * XXX - this is a TransportDomain; print it as such.
683 tptr += mgmt_addr_length;
684 tlen -= mgmt_addr_length;
691 * FIXME those are the defined TLVs that lack a decoder
692 * you are welcome to contribute code ;-)
696 case CFM_TLV_REPLY_INGRESS:
697 case CFM_TLV_REPLY_EGRESS:
702 /* do we want to see an additional hexdump ? */
703 if (hexdump || ndo->ndo_vflag > 1)
704 print_unknown_data(ndo, tlv_ptr, "\n\t ", cfm_tlv_len);
712 ND_PRINT((ndo, "\n\t\t packet is too short"));
716 ND_PRINT((ndo, "\n\t\t packet exceeded snapshot"));