contrib/tcpdump/print-bfd.c

   1 /*
   2  * Redistribution and use in source and binary forms, with or without
   3  * modification, are permitted provided that: (1) source code
   4  * distributions retain the above copyright notice and this paragraph
   5  * in its entirety, and (2) distributions including binary code include
   6  * the above copyright notice and this paragraph in its entirety in
   7  * the documentation or other materials provided with the distribution.
   8  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND
   9  * WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, WITHOUT
  10  * LIMITATION, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  11  * FOR A PARTICULAR PURPOSE.
  12  *
  13  * Original code by Hannes Gredler (hannes@juniper.net)
  14  */
  15
  16 #ifndef lint
  17 static const char rcsid[] _U_ =
  18     "@(#) $Header: /tcpdump/master/tcpdump/print-bfd.c,v 1.10 2006-02-02 06:35:52 hannes Exp $";
  19 #endif
  20
  21 #ifdef HAVE_CONFIG_H
  22 #include "config.h"
  23 #endif
  24
  25 #include <tcpdump-stdinc.h>
  26
  27 #include <stdio.h>
  28 #include <stdlib.h>
  29
  30 #include "interface.h"
  31 #include "extract.h"
  32 #include "addrtoname.h"
  33
  34 #include "udp.h"
  35
  36 /*
  37  * Control packet, BFDv0, draft-katz-ward-bfd-01.txt
  38  *
  39  *     0                   1                   2                   3
  40  *     0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
  41  *    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  42  *    |Vers |  Diag   |H|D|P|F| Rsvd  |  Detect Mult  |    Length     |
  43  *    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  44  *    |                       My Discriminator                        |
  45  *    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  46  *    |                      Your Discriminator                       |
  47  *    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  48  *    |                    Desired Min TX Interval                    |
  49  *    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  50  *    |                   Required Min RX Interval                    |
  51  *    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  52  *    |                 Required Min Echo RX Interval                 |
  53  *    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  54  */
  55
  56 /*
  57  *  Control packet, BFDv1, draft-ietf-bfd-base-02.txt
  58  *
  59  *     0                   1                   2                   3
  60  *     0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
  61  *    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  62  *    |Vers |  Diag   |Sta|P|F|C|A|D|R|  Detect Mult  |    Length     |
  63  *    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  64  *    |                       My Discriminator                        |
  65  *    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  66  *    |                      Your Discriminator                       |
  67  *    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  68  *    |                    Desired Min TX Interval                    |
  69  *    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  70  *    |                   Required Min RX Interval                    |
  71  *    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  72  *    |                 Required Min Echo RX Interval                 |
  73  *    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  74  */
  75
  76 struct bfd_header_t {
  77     u_int8_t version_diag;
  78     u_int8_t flags;
  79     u_int8_t detect_time_multiplier;
  80     u_int8_t length;
  81     u_int8_t my_discriminator[4];
  82     u_int8_t your_discriminator[4];
  83     u_int8_t desired_min_tx_interval[4];
  84     u_int8_t required_min_rx_interval[4];
  85     u_int8_t required_min_echo_interval[4];
  86 };
  87
  88 /*
  89  *    An optional Authentication Header may be present
  90  *
  91  *     0                   1                   2                   3
  92  *     0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
  93  *    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  94  *    |   Auth Type   |   Auth Len    |    Authentication Data...     |
  95  *    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  96  */
  97
  98 struct bfd_auth_header_t {
  99     u_int8_t auth_type;
 100     u_int8_t auth_len;
 101     u_int8_t auth_data;
 102 };
 103
 104 static const struct tok bfd_v1_authentication_values[] = {
 105     { 0,        "Reserved" },
 106     { 1,        "Simple Password" },
 107     { 2,        "Keyed MD5" },
 108     { 3,        "Meticulous Keyed MD5" },
 109     { 4,        "Keyed SHA1" },
 110     { 5,        "Meticulous Keyed SHA1" },
 111     { 0, NULL }
 112 };
 113
 114 #define BFD_EXTRACT_VERSION(x) (((x)&0xe0)>>5)
 115 #define BFD_EXTRACT_DIAG(x)     ((x)&0x1f)
 116
 117 static const struct tok bfd_port_values[] = {
 118     { BFD_CONTROL_PORT, "Control" },
 119     { BFD_ECHO_PORT,    "Echo" },
 120     { 0, NULL }
 121 };
 122
 123
 124 static const struct tok bfd_diag_values[] = {
 125     { 0, "No Diagnostic" },
 126     { 1, "Control Detection Time Expired" },
 127     { 2, "Echo Function Failed" },
 128     { 3, "Neighbor Signaled Session Down" },
 129     { 4, "Forwarding Plane Reset" },
 130     { 5, "Path Down" },
 131     { 6, "Concatenated Path Down" },
 132     { 7, "Administratively Down" },
 133     { 8, "Reverse Concatenated Path Down" },
 134     { 0, NULL }
 135 };
 136
 137 static const struct tok bfd_v0_flag_values[] = {
 138     { 0x80,     "I Hear You" },
 139     { 0x40,     "Demand" },
 140     { 0x20,     "Poll" },
 141     { 0x10,     "Final" },
 142     { 0x08,     "Reserved" },
 143     { 0x04,     "Reserved" },
 144     { 0x02,     "Reserved" },
 145     { 0x01,     "Reserved" },
 146     { 0, NULL }
 147 };
 148
 149 #define BFD_FLAG_AUTH 0x04
 150
 151 static const struct tok bfd_v1_flag_values[] = {
 152     { 0x20, "Poll" },
 153     { 0x10, "Final" },
 154     { 0x08, "Control Plane Independent" },
 155     { BFD_FLAG_AUTH, "Authentication Present" },
 156     { 0x02, "Demand" },
 157     { 0x01, "Reserved" },
 158     { 0, NULL }
 159 };
 160
 161 static const struct tok bfd_v1_state_values[] = {
 162     { 0, "AdminDown" },
 163     { 1, "Down" },
 164     { 2, "Init" },
 165     { 3, "Up" },
 166     { 0, NULL }
 167 };
 168
 169 void
 170 bfd_print(register const u_char *pptr, register u_int len, register u_int port)
 171 {
 172         const struct bfd_header_t *bfd_header;
 173         const struct bfd_auth_header_t *bfd_auth_header;
 174         u_int8_t version;
 175
 176         bfd_header = (const struct bfd_header_t *)pptr;
 177         TCHECK(*bfd_header);
 178         version = BFD_EXTRACT_VERSION(bfd_header->version_diag);
 179
 180         switch (port << 8 | version) {
 181
 182             /* BFDv0 */
 183         case (BFD_CONTROL_PORT << 8):
 184             if (vflag < 1 )
 185             {
 186                 printf("BFDv%u, %s, Flags: [%s], length: %u",
 187                        version,
 188                        tok2str(bfd_port_values, "unknown (%u)", port),
 189                        bittok2str(bfd_v0_flag_values, "none", bfd_header->flags),
 190                        len);
 191                 return;
 192             }
 193
 194             printf("BFDv%u, length: %u\n\t%s, Flags: [%s], Diagnostic: %s (0x%02x)",
 195                    version,
 196                    len,
 197                    tok2str(bfd_port_values, "unknown (%u)", port),
 198                    bittok2str(bfd_v0_flag_values, "none", bfd_header->flags),
 199                    tok2str(bfd_diag_values,"unknown",BFD_EXTRACT_DIAG(bfd_header->version_diag)),
 200                    BFD_EXTRACT_DIAG(bfd_header->version_diag));
 201
 202             printf("\n\tDetection Timer Multiplier: %u (%u ms Detection time), BFD Length: %u",
 203                    bfd_header->detect_time_multiplier,
 204                    bfd_header->detect_time_multiplier * EXTRACT_32BITS(bfd_header->desired_min_tx_interval)/1000,
 205                    bfd_header->length);
 206
 207
 208             printf("\n\tMy Discriminator: 0x%08x", EXTRACT_32BITS(bfd_header->my_discriminator));
 209             printf(", Your Discriminator: 0x%08x", EXTRACT_32BITS(bfd_header->your_discriminator));
 210             printf("\n\t  Desired min Tx Interval:    %4u ms", EXTRACT_32BITS(bfd_header->desired_min_tx_interval)/1000);
 211             printf("\n\t  Required min Rx Interval:   %4u ms", EXTRACT_32BITS(bfd_header->required_min_rx_interval)/1000);
 212             printf("\n\t  Required min Echo Interval: %4u ms", EXTRACT_32BITS(bfd_header->required_min_echo_interval)/1000);
 213             break;
 214
 215             /* BFDv1 */
 216         case (BFD_CONTROL_PORT << 8 | 1):
 217             if (vflag < 1 )
 218             {
 219                 printf("BFDv%u, %s, State %s, Flags: [%s], length: %u",
 220                        version,
 221                        tok2str(bfd_port_values, "unknown (%u)", port),
 222                        tok2str(bfd_v1_state_values, "unknown (%u)", (bfd_header->flags & 0xc0) >> 6),
 223                        bittok2str(bfd_v1_flag_values, "none", bfd_header->flags & 0x3f),
 224                        len);
 225                 return;
 226             }
 227
 228             printf("BFDv%u, length: %u\n\t%s, State %s, Flags: [%s], Diagnostic: %s (0x%02x)",
 229                    version,
 230                    len,
 231                    tok2str(bfd_port_values, "unknown (%u)", port),
 232                    tok2str(bfd_v1_state_values, "unknown (%u)", (bfd_header->flags & 0xc0) >> 6),
 233                    bittok2str(bfd_v1_flag_values, "none", bfd_header->flags & 0x3f),
 234                    tok2str(bfd_diag_values,"unknown",BFD_EXTRACT_DIAG(bfd_header->version_diag)),
 235                    BFD_EXTRACT_DIAG(bfd_header->version_diag));
 236
 237             printf("\n\tDetection Timer Multiplier: %u (%u ms Detection time), BFD Length: %u",
 238                    bfd_header->detect_time_multiplier,
 239                    bfd_header->detect_time_multiplier * EXTRACT_32BITS(bfd_header->desired_min_tx_interval)/1000,
 240                    bfd_header->length);
 241
 242
 243             printf("\n\tMy Discriminator: 0x%08x", EXTRACT_32BITS(bfd_header->my_discriminator));
 244             printf(", Your Discriminator: 0x%08x", EXTRACT_32BITS(bfd_header->your_discriminator));
 245             printf("\n\t  Desired min Tx Interval:    %4u ms", EXTRACT_32BITS(bfd_header->desired_min_tx_interval)/1000);
 246             printf("\n\t  Required min Rx Interval:   %4u ms", EXTRACT_32BITS(bfd_header->required_min_rx_interval)/1000);
 247             printf("\n\t  Required min Echo Interval: %4u ms", EXTRACT_32BITS(bfd_header->required_min_echo_interval)/1000);
 248
 249             if (bfd_header->flags & BFD_FLAG_AUTH) {
 250                 pptr += sizeof (const struct bfd_header_t);
 251                 bfd_auth_header = (const struct bfd_auth_header_t *)pptr;
 252                 TCHECK2(*bfd_auth_header, sizeof(const struct bfd_auth_header_t));
 253                 printf("\n\t%s (%u) Authentication, length %u present",
 254                        tok2str(bfd_v1_authentication_values,"Unknown",bfd_auth_header->auth_type),
 255                        bfd_auth_header->auth_type,
 256                        bfd_auth_header->auth_len);
 257             }
 258             break;
 259
 260             /* BFDv0 */
 261         case (BFD_ECHO_PORT << 8): /* not yet supported - fall through */
 262             /* BFDv1 */
 263         case (BFD_ECHO_PORT << 8 | 1):
 264
 265         default:
 266             printf("BFD, %s, length: %u",
 267                    tok2str(bfd_port_values, "unknown (%u)", port),
 268                    len);
 269             if (vflag >= 1) {
 270                 if(!print_unknown_data(pptr,"\n\t",len))
 271                     return;
 272             }
 273             break;
 274         }
 275         return;
 276
 277 trunc:
 278         printf("[|BFD]");
 279 }