]> The Tcpdump Group git mirrors - tcpdump/blobdiff - print-cdp.c
More nd_ification of structures.
[tcpdump] / print-cdp.c
index 1e6520f1cb2c402324d051ded1600a91ed5eed5c..364af045eec3f4f9214ccf5d10d72f5b4246a93c 100644 (file)
  *    http://www.cisco.com/univercd/cc/td/doc/product/lan/trsrb/frames.htm
  */
 
-#ifndef lint
-static const char rcsid[] =
-    "@(#) $Header: /tcpdump/master/tcpdump/print-cdp.c,v 1.12 2002-04-26 09:13:19 guy Exp $";
-#endif
+/* \summary: Cisco Discovery Protocol (CDP) printer */
 
 #ifdef HAVE_CONFIG_H
 #include "config.h"
 #endif
 
-#include <sys/param.h>
-#include <sys/time.h>
-
-#include <netinet/in.h>
+#include <netdissect-stdinc.h>
 
-#include <ctype.h>
-#include <netdb.h>
-#include <stdio.h>
 #include <string.h>
 
-#include "interface.h"
+#include "netdissect.h"
 #include "addrtoname.h"
-#include "extract.h"                   /* must come after interface.h */
-
-static int cdp_print_addr(const u_char *, int);
-static int cdp_print_prefixes(const u_char *, int);
+#include "extract.h"
+#include "nlpid.h"
+
+static const char tstr[] = "[|cdp]";
+
+#define CDP_HEADER_LEN             4
+#define CDP_HEADER_VERSION_OFFSET  0
+#define CDP_HEADER_TTL_OFFSET      1
+#define CDP_HEADER_CHECKSUM_OFFSET 2
+
+#define CDP_TLV_HEADER_LEN  4
+#define CDP_TLV_TYPE_OFFSET 0
+#define CDP_TLV_LEN_OFFSET  2
+
+static const struct tok cdp_tlv_values[] = {
+    { 0x01,             "Device-ID"},
+    { 0x02,             "Address"},
+    { 0x03,             "Port-ID"},
+    { 0x04,             "Capability"},
+    { 0x05,             "Version String"},
+    { 0x06,             "Platform"},
+    { 0x07,             "Prefixes"},
+    { 0x08,             "Protocol-Hello option"},
+    { 0x09,             "VTP Management Domain"},
+    { 0x0a,             "Native VLAN ID"},
+    { 0x0b,             "Duplex"},
+    { 0x0e,             "ATA-186 VoIP VLAN request"},
+    { 0x0f,             "ATA-186 VoIP VLAN assignment"},
+    { 0x10,             "power consumption"},
+    { 0x11,             "MTU"},
+    { 0x12,             "AVVID trust bitmap"},
+    { 0x13,             "AVVID untrusted ports CoS"},
+    { 0x14,             "System Name"},
+    { 0x15,             "System Object ID (not decoded)"},
+    { 0x16,             "Management Addresses"},
+    { 0x17,             "Physical Location"},
+    { 0, NULL}
+};
+
+static const struct tok cdp_capability_values[] = {
+    { 0x01,             "Router" },
+    { 0x02,             "Transparent Bridge" },
+    { 0x04,             "Source Route Bridge" },
+    { 0x08,             "L2 Switch" },
+    { 0x10,             "L3 capable" },
+    { 0x20,             "IGMP snooping" },
+    { 0x40,             "L1 capable" },
+    { 0, NULL }
+};
+
+static int cdp_print_addr(netdissect_options *, const u_char *, int);
+static int cdp_print_prefixes(netdissect_options *, const u_char *, int);
 static unsigned long cdp_get_number(const u_char *, int);
 
 void
-cdp_print(const u_char *p, u_int length, u_int caplen,
-         const u_char *esrc, const u_char *edst)
+cdp_print(netdissect_options *ndo,
+          const u_char *pptr, u_int length, u_int caplen)
 {
-       u_int i;
-       int type, len;
+       int type, len, i, j;
+       const u_char *tptr;
 
-       /* Cisco Discovery Protocol */
-
-       if (caplen < 4) {
-               (void)printf("[|cdp]");
+       if (caplen < CDP_HEADER_LEN) {
+               ND_PRINT((ndo, "%s", tstr));
                return;
        }
 
-       i = 0;          /* CDP data starts at offset 0 */
-       printf("CDP v%u, ttl=%us", p[i], p[i + 1]);
-       i += 4;         /* skip version, TTL and chksum */
+       tptr = pptr; /* temporary pointer */
+
+       ND_TCHECK2(*tptr, CDP_HEADER_LEN);
+       ND_PRINT((ndo, "CDPv%u, ttl: %us", EXTRACT_U_1((tptr + CDP_HEADER_VERSION_OFFSET)),
+                                          EXTRACT_U_1(tptr + CDP_HEADER_TTL_OFFSET)));
+       if (ndo->ndo_vflag)
+               ND_PRINT((ndo, ", checksum: 0x%04x (unverified), length %u", EXTRACT_BE_U_2(tptr + CDP_HEADER_CHECKSUM_OFFSET), length));
+       tptr += CDP_HEADER_LEN;
+
+       while (tptr < (pptr+length)) {
+               ND_TCHECK2(*tptr, CDP_TLV_HEADER_LEN); /* read out Type and Length */
+               type = EXTRACT_BE_U_2(tptr + CDP_TLV_TYPE_OFFSET);
+               len  = EXTRACT_BE_U_2(tptr + CDP_TLV_LEN_OFFSET); /* object length includes the 4 bytes header length */
+               if (len < CDP_TLV_HEADER_LEN) {
+                   if (ndo->ndo_vflag)
+                       ND_PRINT((ndo, "\n\t%s (0x%02x), TLV length: %u byte%s (too short)",
+                              tok2str(cdp_tlv_values,"unknown field type", type),
+                              type,
+                              len,
+                              PLURAL_SUFFIX(len))); /* plural */
+                   else
+                       ND_PRINT((ndo, ", %s TLV length %u too short",
+                              tok2str(cdp_tlv_values,"unknown field type", type),
+                              len));
+                   break;
+               }
+               tptr += CDP_TLV_HEADER_LEN;
+               len -= CDP_TLV_HEADER_LEN;
 
-       while (i < length) {
-               if (i + 4 > caplen)
-                       goto trunc;
-               type = (p[i] <<  8) + p[i + 1];
-               len  = (p[i + 2] << 8) + p[i + 3];
+               ND_TCHECK2(*tptr, len);
 
-               if (vflag > 1)
-                       printf("\n\t");
+               if (ndo->ndo_vflag || type == 1) { /* in non-verbose mode just print Device-ID */
 
-               if (vflag)
-                       printf(" %02x/%02x", type, len);
+                   if (ndo->ndo_vflag)
+                       ND_PRINT((ndo, "\n\t%s (0x%02x), value length: %u byte%s: ",
+                              tok2str(cdp_tlv_values,"unknown field type", type),
+                              type,
+                              len,
+                              PLURAL_SUFFIX(len))); /* plural */
 
-               if (i + len > caplen)
-                       goto trunc;
+                   switch (type) {
 
-               switch (type) {
-               case 0x00:
-                       printf(" Goodbye");
-                       break;
-               case 0x01:
-                       printf(" DevID '%.*s'", len - 4, p + i + 4);
-                       break;
-               case 0x02:
-                       printf(" Addr");
-                       if (cdp_print_addr(p + i + 4, len - 4) < 0)
-                               goto trunc;
-                       break;
-               case 0x03:
-                       printf(" PortID '%.*s'", len - 4, p + i + 4);
+                   case 0x01: /* Device-ID */
+                       if (!ndo->ndo_vflag)
+                           ND_PRINT((ndo, ", Device-ID "));
+                       ND_PRINT((ndo, "'"));
+                       (void)fn_printn(ndo, tptr, len, NULL);
+                       ND_PRINT((ndo, "'"));
                        break;
-               case 0x04:
-                       printf(" CAP 0x%02x", (unsigned) p[i + 7]);
+                   case 0x02: /* Address */
+                       if (cdp_print_addr(ndo, tptr, len) < 0)
+                           goto trunc;
                        break;
-               case 0x05:
-                       if (vflag > 1)
-                               printf(" Version:\n%.*s", len - 4, p + i + 4);
-                       else
-                               printf(" Version: (suppressed)");
+                   case 0x03: /* Port-ID */
+                       ND_PRINT((ndo, "'"));
+                       (void)fn_printn(ndo, tptr, len, NULL);
+                       ND_PRINT((ndo, "'"));
                        break;
-               case 0x06:
-                       printf(" Platform: '%.*s'", len - 4, p + i + 4);
+                   case 0x04: /* Capabilities */
+                       if (len < 4)
+                           goto trunc;
+                       ND_PRINT((ndo, "(0x%08x): %s",
+                              EXTRACT_BE_U_4(tptr),
+                              bittok2str(cdp_capability_values, "none", EXTRACT_BE_U_4(tptr))));
                        break;
-               case 0x07:
-                       if (cdp_print_prefixes(p + i + 4, len - 4) < 0)
-                               goto trunc;
+                   case 0x05: /* Version */
+                       ND_PRINT((ndo, "\n\t  "));
+                       for (i=0;i<len;i++) {
+                           j = EXTRACT_U_1(tptr + i);
+                           if (j == '\n') /* lets rework the version string to
+                                             get a nice indentation */
+                               ND_PRINT((ndo, "\n\t  "));
+                           else
+                               fn_print_char(ndo, j);
+                       }
                        break;
-               case 0x08:              /* guess - not documented */
-                       printf(" Protocol-Hello option" );
+                   case 0x06: /* Platform */
+                       ND_PRINT((ndo, "'"));
+                       (void)fn_printn(ndo, tptr, len, NULL);
+                       ND_PRINT((ndo, "'"));
                        break;
-               case 0x09:              /* guess - not documented */
-                       printf(" VTP Management Domain: '%.*s'", len - 4,
-                           p + i + 4);
+                   case 0x07: /* Prefixes */
+                       if (cdp_print_prefixes(ndo, tptr, len) < 0)
+                           goto trunc;
                        break;
-               case 0x0a:              /* guess - not documented */
-                       printf(" Native VLAN ID: %d",
-                           (p[i + 4] << 8) + p[i + 4 + 1] );
+                   case 0x08: /* Protocol Hello Option - not documented */
                        break;
-               case 0x0b:              /* guess - not documented */
-                       printf(" Duplex: %s", p[i + 4] ? "full": "half");
+                   case 0x09: /* VTP Mgmt Domain  - CDPv2 */
+                       ND_PRINT((ndo, "'"));
+                       (void)fn_printn(ndo, tptr, len, NULL);
+                       ND_PRINT((ndo, "'"));
                        break;
-/* http://www.cisco.com/univercd/cc/td/doc/product/voice/ata/atarn/186rn21m.htm
- * plus more details from other sources 
- */
-               case 0x0e:              /* incomplete doc. */
-                       printf(" ATA-186 VoIP VLAN request, app %d, vlan %d",
-                               p[i + 4], (p[i + 4] << 8) + p[i + 4 + 1] );
+                   case 0x0a: /* Native VLAN ID - CDPv2 */
+                       if (len < 2)
+                           goto trunc;
+                       ND_PRINT((ndo, "%d", EXTRACT_BE_U_2(tptr)));
                        break;
-               case 0x0f:              /* incomplete doc. */
-                       printf(" ATA-186 VoIP VLAN assignment" );
+                   case 0x0b: /* Duplex - CDPv2 */
+                       if (len < 1)
+                           goto trunc;
+                       ND_PRINT((ndo, "%s", EXTRACT_U_1(tptr) ? "full": "half"));
                        break;
-               case 0x10:              /* incomplete doc. */
-                       printf(" power consumption: %1.2fW", 
-                               cdp_get_number(p+i+4, len-4)/1000.0 );
+
+                   /* http://www.cisco.com/c/en/us/td/docs/voice_ip_comm/cata/186/2_12_m/english/release/notes/186rn21m.html
+                    * plus more details from other sources
+                    */
+                   case 0x0e: /* ATA-186 VoIP VLAN request - incomplete doc. */
+                       if (len < 3)
+                           goto trunc;
+                       ND_PRINT((ndo, "app %d, vlan %d", EXTRACT_U_1((tptr)), EXTRACT_BE_U_2(tptr + 1)));
                        break;
-               case 0x11:              /* guess - not documented */
-                       printf(" MTU %u bytes", EXTRACT_32BITS(&p[i+4]));
+                   case 0x10: /* ATA-186 VoIP VLAN assignment - incomplete doc. */
+                       ND_PRINT((ndo, "%1.2fW", cdp_get_number(tptr, len) / 1000.0));
                        break;
-               case 0x12:              /* guess - not documented */
-                       printf(" AVVID trust bitmap 0x%02x", p[i+4] );
+                   case 0x11: /* MTU - not documented */
+                       if (len < 4)
+                           goto trunc;
+                       ND_PRINT((ndo, "%u bytes", EXTRACT_BE_U_4(tptr)));
                        break;
-               case 0x13:              /* guess - not documented */
-                       printf(" AVVID untrusted ports CoS: 0x%02x", p[i+4]);
+                   case 0x12: /* AVVID trust bitmap - not documented */
+                       if (len < 1)
+                           goto trunc;
+                       ND_PRINT((ndo, "0x%02x", EXTRACT_U_1(tptr)));
                        break;
-               case 0x14:              /* guess - not documented */
-                       printf(" sysName='%.*s'", len - 4, p + i + 4 );
+                   case 0x13: /* AVVID untrusted port CoS - not documented */
+                       if (len < 1)
+                           goto trunc;
+                       ND_PRINT((ndo, "0x%02x", EXTRACT_U_1(tptr)));
                        break;
-               case 0x15:              /* guess - not documented */
-                       printf(" sysObjectID" );                /* TODO */
+                   case 0x14: /* System Name - not documented */
+                       ND_PRINT((ndo, "'"));
+                       (void)fn_printn(ndo, tptr, len, NULL);
+                       ND_PRINT((ndo, "'"));
                        break;
-               case 0x16:              /* guess - not documented */
-                       printf(" management address(es)" );
+                   case 0x16: /* System Object ID - not documented */
+                       if (cdp_print_addr(ndo, tptr, len) < 0)
+                               goto trunc;
                        break;
-               case 0x17:              /* guess - not documented */
-                       printf(" phys. location 0x%02x/%.*s",
-                               p[i+4], len - 5, p + i + 5 );
+                   case 0x17: /* Physical Location - not documented */
+                       if (len < 1)
+                           goto trunc;
+                       ND_PRINT((ndo, "0x%02x", EXTRACT_U_1(tptr)));
+                       if (len > 1) {
+                               ND_PRINT((ndo, "/"));
+                               (void)fn_printn(ndo, tptr + 1, len - 1, NULL);
+                       }
                        break;
-               default:
-                       printf(" unknown field type %02x, len %d", type, len);
+                   default:
+                       print_unknown_data(ndo, tptr, "\n\t  ", len);
                        break;
+                   }
                }
-
-               /* avoid infinite loop */
-               if (len == 0)
-                       break;
-               i += len;
+               tptr = tptr+len;
        }
+       if (ndo->ndo_vflag < 1)
+           ND_PRINT((ndo, ", length %u", caplen));
 
        return;
-
 trunc:
-       printf("[|cdp]");
+       ND_PRINT((ndo, "%s", tstr));
 }
 
 /*
@@ -194,33 +276,36 @@ trunc:
 #define PT_IEEE_802_2          2       /* IEEE 802.2 LLC header */
 
 static int
-cdp_print_addr(const u_char * p, int l)
+cdp_print_addr(netdissect_options *ndo,
+              const u_char * p, int l)
 {
        int pt, pl, al, num;
        const u_char *endp = p + l;
-#ifdef INET6
-       static u_char prot_ipv6[] = {
+       static const u_char prot_ipv6[] = {
                0xaa, 0xaa, 0x03, 0x00, 0x00, 0x00, 0x86, 0xdd
        };
-#endif
 
-       num = EXTRACT_32BITS(p);
+       ND_TCHECK_4(p);
+       if (p + 4 > endp)
+               goto trunc;
+       num = EXTRACT_BE_U_4(p);
        p += 4;
 
-       printf(" (%d): ", num);
-
        while (p < endp && num >= 0) {
+               ND_TCHECK_2(p);
                if (p + 2 > endp)
                        goto trunc;
-               pt = p[0];              /* type of "protocol" field */
-               pl = p[1];              /* length of "protocol" field */
+               pt = EXTRACT_U_1(p);            /* type of "protocol" field */
+               pl = EXTRACT_U_1(p + 1);                /* length of "protocol" field */
                p += 2;
 
+               ND_TCHECK_2(p + pl);
                if (p + pl + 2 > endp)
                        goto trunc;
-               al = EXTRACT_16BITS(&p[pl]);    /* address length */
+               al = EXTRACT_BE_U_2(p + pl);    /* address length */
 
-               if (pt == PT_NLPID && pl == 1 && *p == 0xcc && al == 4) {
+               if (pt == PT_NLPID && pl == 1 && EXTRACT_U_1(p) == NLPID_IP &&
+                   al == 4) {
                        /*
                         * IPv4: protocol type = NLPID, protocol length = 1
                         * (1-byte NLPID), protocol = 0xcc (NLPID for IPv4),
@@ -228,12 +313,12 @@ cdp_print_addr(const u_char * p, int l)
                         */
                        p += 3;
 
+                       ND_TCHECK_4(p);
                        if (p + 4 > endp)
                                goto trunc;
-                       printf("IPv4 %u.%u.%u.%u", p[0], p[1], p[2], p[3]);
+                       ND_PRINT((ndo, "IPv4 (%u) %s", num, ipaddr_string(ndo, p)));
                        p += 4;
                }
-#ifdef INET6
                else if (pt == PT_IEEE_802_2 && pl == 8 &&
                    memcmp(p, prot_ipv6, 8) == 0 && al == 16) {
                        /*
@@ -242,36 +327,42 @@ cdp_print_addr(const u_char * p, int l)
                         * protocol = LLC+SNAP header with the IPv6
                         * Ethertype, address length = 16
                         */
-                       p += 10; 
+                       p += 10;
+                       ND_TCHECK2(*p, al);
                        if (p + al > endp)
                                goto trunc;
 
-                       printf("IPv6 %s", ip6addr_string(p));
+                       ND_PRINT((ndo, "IPv6 (%u) %s", num, ip6addr_string(ndo, p)));
                        p += al;
                }
-#endif
                else {
                        /*
                         * Generic case: just print raw data
                         */
+                       ND_TCHECK2(*p, pl);
                        if (p + pl > endp)
                                goto trunc;
-                       printf("pt=0x%02x, pl=%d, pb=", *(p - 2), pl);
-                       while (pl-- > 0)
-                               printf(" %02x", *p++);
+                       ND_PRINT((ndo, "pt=0x%02x, pl=%d, pb=", EXTRACT_U_1((p - 2)), pl));
+                       while (pl-- > 0) {
+                               ND_PRINT((ndo, " %02x", EXTRACT_U_1(p)));
+                               p++;
+                       }
+                       ND_TCHECK_2(p);
                        if (p + 2 > endp)
                                goto trunc;
-                       al = (*p << 8) + *(p + 1);
-                       printf(", al=%d, a=", al);
+                       ND_PRINT((ndo, ", al=%d, a=", al));
                        p += 2;
+                       ND_TCHECK2(*p, al);
                        if (p + al > endp)
                                goto trunc;
-                       while (al-- > 0)
-                               printf(" %02x", *p++);
+                       while (al-- > 0) {
+                               ND_PRINT((ndo, " %02x", EXTRACT_U_1(p)));
+                               p++;
+                       }
                }
                num--;
                if (num)
-                       printf(" ");
+                       ND_PRINT((ndo, " "));
        }
 
        return 0;
@@ -282,15 +373,18 @@ trunc:
 
 
 static int
-cdp_print_prefixes(const u_char * p, int l)
+cdp_print_prefixes(netdissect_options *ndo,
+                  const u_char * p, int l)
 {
        if (l % 5)
                goto trunc;
 
-       printf(" IPv4 Prefixes (%d):", l / 5);
+       ND_PRINT((ndo, " IPv4 Prefixes (%d):", l / 5));
 
        while (l > 0) {
-               printf(" %u.%u.%u.%u/%u", p[0], p[1], p[2], p[3], p[4]);
+               ND_PRINT((ndo, " %u.%u.%u.%u/%u",
+                         EXTRACT_U_1(p), EXTRACT_U_1(p + 1), EXTRACT_U_1(p + 2),
+                         EXTRACT_U_1(p + 3), EXTRACT_U_1(p + 4)));
                l -= 5;
                p += 5;
        }
@@ -309,7 +403,7 @@ static unsigned long cdp_get_number(const u_char * p, int l)
     unsigned long res=0;
     while( l>0 )
     {
-       res = (res<<8) + *p;
+       res = (res<<8) + EXTRACT_U_1(p);
        p++; l--;
     }
     return res;