The Tcpdump Group git mirrors - tcpdump/blob - print-geneve.c

   1 /*
   2  * Copyright (c) 2014 VMware, Inc. All Rights Reserved.
   3  *
   4  * Jesse Gross <jesse@nicira.com>
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that: (1) source code
   8  * distributions retain the above copyright notice and this paragraph
   9  * in its entirety, and (2) distributions including binary code include
  10  * the above copyright notice and this paragraph in its entirety in
  11  * the documentation or other materials provided with the distribution.
  12  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND
  13  * WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, WITHOUT
  14  * LIMITATION, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  15  * FOR A PARTICULAR PURPOSE.
  16  */
  17
  18 /* \summary: Generic Network Virtualization Encapsulation (Geneve) printer */
  19 /* specification: RFC 8926 */
  20
  21 #ifdef HAVE_CONFIG_H
  22 #include <config.h>
  23 #endif
  24
  25 #include "netdissect-stdinc.h"
  26
  27 #define ND_LONGJMP_FROM_TCHECK
  28 #include "netdissect.h"
  29 #include "extract.h"
  30 #include "ethertype.h"
  31
  32 /*
  33  * Geneve header:
  34  *
  35  *    0                   1                   2                   3
  36  *    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
  37  *    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  38  *    |Ver|  Opt Len  |O|C|    Rsvd.  |          Protocol Type        |
  39  *    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  40  *    |        Virtual Network Identifier (VNI)       |    Reserved   |
  41  *    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  42  *    |                                                               |
  43  *    ~                    Variable-Length Options                    ~
  44  *    |                                                               |
  45  *    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  46  *
  47  * Options:
  48  *    0                   1                   2                   3
  49  *    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
  50  *    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  51  *    |          Option Class         |      Type     |R|R|R| Length  |
  52  *    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  53  *    |                                                               |
  54  *    ~                  Variable-Length Option Data                  ~
  55  *    |                                                               |
  56  *    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  57  */
  58
  59 #define VER_SHIFT 6
  60 #define HDR_OPTS_LEN_MASK 0x3F
  61
  62 #define FLAG_OAM      (1 << 7)
  63 #define FLAG_CRITICAL (1 << 6)
  64 #define FLAG_R1       (1 << 5)
  65 #define FLAG_R2       (1 << 4)
  66 #define FLAG_R3       (1 << 3)
  67 #define FLAG_R4       (1 << 2)
  68 #define FLAG_R5       (1 << 1)
  69 #define FLAG_R6       (1 << 0)
  70
  71 #define OPT_TYPE_CRITICAL (1 << 7)
  72 #define OPT_LEN_MASK 0x1F
  73
  74 static const struct tok geneve_flag_values[] = {
  75         { FLAG_OAM, "O" },
  76         { FLAG_CRITICAL, "C" },
  77         { FLAG_R1, "R1" },
  78         { FLAG_R2, "R2" },
  79         { FLAG_R3, "R3" },
  80         { FLAG_R4, "R4" },
  81         { FLAG_R5, "R5" },
  82         { FLAG_R6, "R6" },
  83         { 0, NULL }
  84 };
  85
  86 static const char *
  87 format_opt_class(const uint16_t opt_class)
  88 {
  89     switch (opt_class) {
  90     case 0x0100:
  91         return "Linux";
  92     case 0x0101:
  93         return "Open vSwitch";
  94     case 0x0102:
  95         return "Open Virtual Networking (OVN)";
  96     case 0x0103:
  97         return "In-band Network Telemetry (INT)";
  98     case 0x0104:
  99         return "VMware";
 100     default:
 101         if (opt_class <= 0x00ff)
 102             return "Standard";
 103         else if (opt_class >= 0xfff0)
 104             return "Experimental";
 105     }
 106
 107     return "Unknown";
 108 }
 109
 110 static unsigned
 111 geneve_opts_print(netdissect_options *ndo, const u_char *bp, u_int len)
 112 {
 113     const char *sep = "";
 114
 115     while (len > 0) {
 116         uint16_t opt_class;
 117         uint8_t opt_type;
 118         uint8_t opt_len;
 119
 120         ND_ICHECKMSG_U("remaining options length", len, <, 4);
 121         ND_PRINT("%s", sep);
 122         sep = ", ";
 123
 124         opt_class = GET_BE_U_2(bp);
 125         opt_type = GET_U_1(bp + 2);
 126         opt_len = 4 + ((GET_U_1(bp + 3) & OPT_LEN_MASK) * 4);
 127
 128         ND_PRINT("class %s (0x%x) type 0x%x%s len %u",
 129                   format_opt_class(opt_class), opt_class, opt_type,
 130                   opt_type & OPT_TYPE_CRITICAL ? "(C)" : "", opt_len);
 131
 132         if (opt_len > len) {
 133             ND_PRINT(" [bad length]");
 134             goto invalid;
 135         }
 136
 137         if (ndo->ndo_vflag > 1 && opt_len > 4) {
 138             const uint32_t *data = (const uint32_t *)(bp + 4);
 139             int i;
 140
 141             ND_PRINT(" data");
 142
 143             for (i = 4; i < opt_len; i += 4) {
 144                 ND_PRINT(" %08x", GET_BE_U_4(data));
 145                 data++;
 146             }
 147         }
 148
 149         bp += opt_len;
 150         len -= opt_len;
 151     }
 152     return 1;
 153 invalid:
 154     ND_TCHECK_LEN(bp, len);
 155     return 0;
 156 }
 157
 158 void
 159 geneve_print(netdissect_options *ndo, const u_char *bp, u_int len)
 160 {
 161     uint8_t ver_opt;
 162     u_int version;
 163     uint8_t flags;
 164     uint16_t prot;
 165     uint32_t vni;
 166     uint8_t reserved;
 167     u_int opts_len;
 168
 169     ndo->ndo_protocol = "geneve";
 170     ND_PRINT("Geneve");
 171
 172     ND_ICHECK_U(len, <, 8);
 173
 174     ver_opt = GET_U_1(bp);
 175     bp += 1;
 176     len -= 1;
 177
 178     version = ver_opt >> VER_SHIFT;
 179     if (version != 0) {
 180         ND_PRINT(" ERROR: unknown-version %u", version);
 181         goto invalid;
 182     }
 183
 184     flags = GET_U_1(bp);
 185     bp += 1;
 186     len -= 1;
 187
 188     prot = GET_BE_U_2(bp);
 189     bp += 2;
 190     len -= 2;
 191
 192     vni = GET_BE_U_3(bp);
 193     bp += 3;
 194     len -= 3;
 195
 196     reserved = GET_U_1(bp);
 197     bp += 1;
 198     len -= 1;
 199
 200     ND_PRINT(", Flags [%s]",
 201               bittok2str_nosep(geneve_flag_values, "none", flags));
 202     ND_PRINT(", vni 0x%x", vni);
 203
 204     if (reserved)
 205         ND_PRINT(", rsvd 0x%x", reserved);
 206
 207     if (ndo->ndo_eflag)
 208         ND_PRINT(", proto %s (0x%04x)",
 209                   tok2str(ethertype_values, "unknown", prot), prot);
 210
 211     opts_len = (ver_opt & HDR_OPTS_LEN_MASK) * 4;
 212
 213     if (len < opts_len) {
 214         ND_PRINT(" (opts_len %u > %u", opts_len, len);
 215         goto invalid;
 216     }
 217
 218     if (opts_len > 0) {
 219         ND_PRINT(", options [");
 220
 221         if (ndo->ndo_vflag) {
 222             if (! geneve_opts_print(ndo, bp, opts_len))
 223                 goto invalid;
 224         }
 225         else {
 226             ND_TCHECK_LEN(bp, opts_len);
 227             ND_PRINT("%u bytes", opts_len);
 228         }
 229
 230         ND_PRINT("]");
 231     }
 232
 233     bp += opts_len;
 234     len -= opts_len;
 235
 236     if (ndo->ndo_vflag < 1)
 237         ND_PRINT(": ");
 238     else
 239         ND_PRINT("\n\t");
 240
 241     if (ethertype_print(ndo, prot, bp, len, ND_BYTES_AVAILABLE_AFTER(bp), NULL, NULL) == 0) {
 242         if (prot == ETHERTYPE_TEB)
 243             ether_print(ndo, bp, len, ND_BYTES_AVAILABLE_AFTER(bp), NULL, NULL);
 244         else {
 245             ND_PRINT("geneve-proto-0x%x", prot);
 246             ND_TCHECK_LEN(bp, len);
 247         }
 248     }
 249
 250     return;
 251
 252 invalid:
 253     nd_print_invalid(ndo);
 254 }