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

   1 /* Copyright (c) 2017, Sabrina Dubroca <sd@queasysnail.net>
   2  *
   3  * Redistribution and use in source and binary forms, with or without
   4  * modification, are permitted provided that the following conditions
   5  * are met:
   6  *
   7  *   1. Redistributions of source code must retain the above copyright
   8  *      notice, this list of conditions and the following disclaimer.
   9  *   2. Redistributions in binary form must reproduce the above copyright
  10  *      notice, this list of conditions and the following disclaimer in
  11  *      the documentation and/or other materials provided with the
  12  *      distribution.
  13  *   3. The names of the authors may not be used to endorse or promote
  14  *      products derived from this software without specific prior
  15  *      written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
  18  * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
  19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
  20  */
  21
  22 /* \summary: MACsec printer */
  23
  24 #ifdef HAVE_CONFIG_H
  25 #include <config.h>
  26 #endif
  27
  28 #include <netdissect-stdinc.h>
  29
  30 #include <string.h>
  31
  32 #include "netdissect.h"
  33 #include "addrtoname.h"
  34 #include "ethertype.h"
  35 #include "extract.h"
  36
  37 #define MACSEC_DEFAULT_ICV_LEN 16
  38
  39 /* Header format (SecTAG), following an Ethernet header
  40  * IEEE 802.1AE-2006 9.3
  41  *
  42  * +---------------------------------+----------------+----------------+
  43  * |        (MACsec ethertype)       |     TCI_AN     |       SL       |
  44  * +---------------------------------+----------------+----------------+
  45  * |                           Packet Number                           |
  46  * +-------------------------------------------------------------------+
  47  * |                     Secure Channel Identifier                     |
  48  * |                            (optional)                             |
  49  * +-------------------------------------------------------------------+
  50  *
  51  * MACsec ethertype = 0x88e5
  52  * TCI: Tag Control Information, set of flags
  53  * AN: association number, 2 bits
  54  * SL (short length): 6-bit length of the protected payload, if < 48
  55  * Packet Number: 32-bits packet identifier
  56  * Secure Channel Identifier: 64-bit unique identifier, usually
  57  *     composed of a MAC address + 16-bit port number
  58  */
  59 struct macsec_sectag {
  60         nd_uint8_t  tci_an;
  61         nd_uint8_t  short_length;
  62         nd_uint32_t packet_number;
  63         nd_uint8_t  secure_channel_id[8]; /* optional */
  64 };
  65
  66 /* IEEE 802.1AE-2006 9.5 */
  67 #define MACSEC_TCI_VERSION 0x80
  68 #define MACSEC_TCI_ES      0x40 /* end station */
  69 #define MACSEC_TCI_SC      0x20 /* SCI present */
  70 #define MACSEC_TCI_SCB     0x10 /* epon */
  71 #define MACSEC_TCI_E       0x08 /* encryption */
  72 #define MACSEC_TCI_C       0x04 /* changed text */
  73 #define MACSEC_AN_MASK     0x03 /* association number */
  74 #define MACSEC_TCI_FLAGS   (MACSEC_TCI_ES | MACSEC_TCI_SC | MACSEC_TCI_SCB | MACSEC_TCI_E | MACSEC_TCI_C)
  75 #define MACSEC_TCI_CONFID  (MACSEC_TCI_E | MACSEC_TCI_C)
  76 #define MACSEC_SL_MASK     0x3F /* short length */
  77
  78 #define MACSEC_SECTAG_LEN_NOSCI 6  /* length of MACsec header without SCI */
  79 #define MACSEC_SECTAG_LEN_SCI   14 /* length of MACsec header with SCI */
  80
  81 #define SCI_FMT "%016" PRIx64
  82
  83 static const struct tok macsec_flag_values[] = {
  84         { MACSEC_TCI_E,   "E" },
  85         { MACSEC_TCI_C,   "C" },
  86         { MACSEC_TCI_ES,  "S" },
  87         { MACSEC_TCI_SCB, "B" },
  88         { MACSEC_TCI_SC,  "I" },
  89         { 0, NULL }
  90 };
  91
  92 static void macsec_print_header(netdissect_options *ndo,
  93                                 const struct macsec_sectag *sectag,
  94                                 u_int short_length)
  95 {
  96         ND_PRINT("an %u, pn %u, flags %s",
  97                  GET_U_1(sectag->tci_an) & MACSEC_AN_MASK,
  98                  GET_BE_U_4(sectag->packet_number),
  99                  bittok2str_nosep(macsec_flag_values, "none",
 100                                   GET_U_1(sectag->tci_an) & MACSEC_TCI_FLAGS));
 101
 102         if (short_length != 0)
 103                 ND_PRINT(", sl %u", short_length);
 104
 105         if (GET_U_1(sectag->tci_an) & MACSEC_TCI_SC)
 106                 ND_PRINT(", sci " SCI_FMT, GET_BE_U_8(sectag->secure_channel_id));
 107
 108         ND_PRINT(", ");
 109 }
 110
 111 /* returns < 0 if the packet can be decoded completely */
 112 int macsec_print(netdissect_options *ndo, const u_char **bp,
 113                  u_int *lengthp, u_int *caplenp, u_int *hdrlenp,
 114                  const struct lladdr_info *src, const struct lladdr_info *dst)
 115 {
 116         const char *save_protocol;
 117         const u_char *p = *bp;
 118         u_int length = *lengthp;
 119         u_int caplen = *caplenp;
 120         u_int hdrlen = *hdrlenp;
 121         const struct macsec_sectag *sectag = (const struct macsec_sectag *)p;
 122         u_int sectag_len;
 123         u_int short_length;
 124
 125         save_protocol = ndo->ndo_protocol;
 126         ndo->ndo_protocol = "macsec";
 127
 128         /* we need the full MACsec header in the capture */
 129         if (caplen < MACSEC_SECTAG_LEN_NOSCI) {
 130                 nd_print_trunc(ndo);
 131                 ndo->ndo_protocol = save_protocol;
 132                 return hdrlen + caplen;
 133         }
 134         if (length < MACSEC_SECTAG_LEN_NOSCI) {
 135                 nd_print_trunc(ndo);
 136                 ndo->ndo_protocol = save_protocol;
 137                 return hdrlen + caplen;
 138         }
 139
 140         if (GET_U_1(sectag->tci_an) & MACSEC_TCI_SC) {
 141                 sectag_len = MACSEC_SECTAG_LEN_SCI;
 142                 if (caplen < MACSEC_SECTAG_LEN_SCI) {
 143                         nd_print_trunc(ndo);
 144                         ndo->ndo_protocol = save_protocol;
 145                         return hdrlen + caplen;
 146                 }
 147                 if (length < MACSEC_SECTAG_LEN_SCI) {
 148                         nd_print_trunc(ndo);
 149                         ndo->ndo_protocol = save_protocol;
 150                         return hdrlen + caplen;
 151                 }
 152         } else
 153                 sectag_len = MACSEC_SECTAG_LEN_NOSCI;
 154
 155         if ((GET_U_1(sectag->short_length) & ~MACSEC_SL_MASK) != 0 ||
 156             GET_U_1(sectag->tci_an) & MACSEC_TCI_VERSION) {
 157                 nd_print_invalid(ndo);
 158                 ndo->ndo_protocol = save_protocol;
 159                 return hdrlen + caplen;
 160         }
 161
 162         short_length = GET_U_1(sectag->short_length) & MACSEC_SL_MASK;
 163         if (ndo->ndo_eflag)
 164                 macsec_print_header(ndo, sectag, short_length);
 165
 166         /* Skip the MACsec header. */
 167         *bp += sectag_len;
 168         *hdrlenp += sectag_len;
 169
 170         /* Remove it from the lengths, as it's been processed. */
 171         *lengthp -= sectag_len;
 172         *caplenp -= sectag_len;
 173
 174         if ((GET_U_1(sectag->tci_an) & MACSEC_TCI_CONFID)) {
 175                 /*
 176                  * The payload is encrypted.  Print link-layer
 177                  * information, if it hasn't already been printed.
 178                  */
 179                 if (!ndo->ndo_eflag) {
 180                         /*
 181                          * Nobody printed the link-layer addresses,
 182                          * so print them, if we have any.
 183                          */
 184                         if (src != NULL && dst != NULL) {
 185                                 ND_PRINT("%s > %s ",
 186                                         (src->addr_string)(ndo, src->addr),
 187                                         (dst->addr_string)(ndo, dst->addr));
 188                         }
 189
 190                         ND_PRINT("802.1AE MACsec, ");
 191
 192                         /*
 193                          * Print the MACsec header.
 194                          */
 195                         macsec_print_header(ndo, sectag, short_length);
 196                 }
 197
 198                 /*
 199                  * Tell our caller it can't be dissected.
 200                  */
 201                 ndo->ndo_protocol = save_protocol;
 202                 return 0;
 203         }
 204
 205         /*
 206          * The payload isn't encrypted; remove the
 207          * ICV length from the lengths, so our caller
 208          * doesn't treat it as payload.
 209          */
 210         if (*lengthp < MACSEC_DEFAULT_ICV_LEN) {
 211                 nd_print_trunc(ndo);
 212                 ndo->ndo_protocol = save_protocol;
 213                 return hdrlen + caplen;
 214         }
 215         if (*caplenp < MACSEC_DEFAULT_ICV_LEN) {
 216                 nd_print_trunc(ndo);
 217                 ndo->ndo_protocol = save_protocol;
 218                 return hdrlen + caplen;
 219         }
 220         *lengthp -= MACSEC_DEFAULT_ICV_LEN;
 221         *caplenp -= MACSEC_DEFAULT_ICV_LEN;
 222
 223         /*
 224          * If the SL field is non-zero, then it's the length of the
 225          * Secure Data; otherwise, the Secure Data is what's left
 226          * ver after the MACsec header and ICV are removed.
 227          */
 228         if (short_length != 0) {
 229                 /*
 230                  * If the short length is more than we *have*,
 231                  * that's an error.
 232                  */
 233                 if (short_length > *lengthp) {
 234                         nd_print_trunc(ndo);
 235                         ndo->ndo_protocol = save_protocol;
 236                         return hdrlen + caplen;
 237                 }
 238                 if (short_length > *caplenp) {
 239                         nd_print_trunc(ndo);
 240                         ndo->ndo_protocol = save_protocol;
 241                         return hdrlen + caplen;
 242                 }
 243                 if (*lengthp > short_length)
 244                         *lengthp = short_length;
 245                 if (*caplenp > short_length)
 246                         *caplenp = short_length;
 247         }
 248
 249         ndo->ndo_protocol = save_protocol;
 250         return -1;
 251 }