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

   1 /*
   2  * Copyright (c) 2004 - Michael Richardson <mcr@xelerance.com>
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that: (1) source code distributions
   6  * retain the above copyright notice and this paragraph in its entirety, (2)
   7  * distributions including binary code include the above copyright notice and
   8  * this paragraph in its entirety in the documentation or other materials
   9  * provided with the distribution, and (3) all advertising materials mentioning
  10  * features or use of this software display the following acknowledgement:
  11  * ``This product includes software developed by the University of California,
  12  * Lawrence Berkeley Laboratory and its contributors.'' Neither the name of
  13  * the University nor the names of its contributors may be used to endorse
  14  * or promote products derived from this software without specific prior
  15  * written permission.
  16  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED
  17  * WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
  18  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
  19  */
  20
  21 /* \summary: Extensible Authentication Protocol (EAP) printer */
  22
  23 #ifdef HAVE_CONFIG_H
  24 #include <config.h>
  25 #endif
  26
  27 #include "netdissect-stdinc.h"
  28
  29 #include "netdissect.h"
  30 #include "extract.h"
  31
  32 #define EAP_FRAME_TYPE_PACKET           0
  33 #define EAP_FRAME_TYPE_START            1
  34 #define EAP_FRAME_TYPE_LOGOFF           2
  35 #define EAP_FRAME_TYPE_KEY              3
  36 #define EAP_FRAME_TYPE_ENCAP_ASF_ALERT  4
  37
  38 struct eap_frame_t {
  39     nd_uint8_t  version;
  40     nd_uint8_t  type;
  41     nd_uint16_t length;
  42 };
  43
  44 static const struct tok eap_frame_type_values[] = {
  45     { EAP_FRAME_TYPE_PACKET,            "EAP packet" },
  46     { EAP_FRAME_TYPE_START,             "EAPOL start" },
  47     { EAP_FRAME_TYPE_LOGOFF,            "EAPOL logoff" },
  48     { EAP_FRAME_TYPE_KEY,               "EAPOL key" },
  49     { EAP_FRAME_TYPE_ENCAP_ASF_ALERT,   "Encapsulated ASF alert" },
  50     { 0, NULL}
  51 };
  52
  53 /* RFC 3748 */
  54 struct eap_packet_t {
  55     nd_uint8_t  code;
  56     nd_uint8_t  id;
  57     nd_uint16_t length;
  58 };
  59
  60 #define         EAP_REQUEST     1
  61 #define         EAP_RESPONSE    2
  62 #define         EAP_SUCCESS     3
  63 #define         EAP_FAILURE     4
  64
  65 static const struct tok eap_code_values[] = {
  66     { EAP_REQUEST,      "Request" },
  67     { EAP_RESPONSE,     "Response" },
  68     { EAP_SUCCESS,      "Success" },
  69     { EAP_FAILURE,      "Failure" },
  70     { 0, NULL}
  71 };
  72
  73 #define         EAP_TYPE_NO_PROPOSED    0
  74 #define         EAP_TYPE_IDENTITY       1
  75 #define         EAP_TYPE_NOTIFICATION   2
  76 #define         EAP_TYPE_NAK            3
  77 #define         EAP_TYPE_MD5_CHALLENGE  4
  78 #define         EAP_TYPE_OTP            5
  79 #define         EAP_TYPE_GTC            6
  80 #define         EAP_TYPE_TLS            13              /* RFC 2716 */
  81 #define         EAP_TYPE_SIM            18              /* RFC 4186 */
  82 #define         EAP_TYPE_TTLS           21              /* draft-funk-eap-ttls-v0-01.txt */
  83 #define         EAP_TYPE_AKA            23              /* RFC 4187 */
  84 #define         EAP_TYPE_FAST           43              /* RFC 4851 */
  85 #define         EAP_TYPE_EXPANDED_TYPES 254
  86 #define         EAP_TYPE_EXPERIMENTAL   255
  87
  88 static const struct tok eap_type_values[] = {
  89     { EAP_TYPE_NO_PROPOSED,     "No proposed" },
  90     { EAP_TYPE_IDENTITY,        "Identity" },
  91     { EAP_TYPE_NOTIFICATION,    "Notification" },
  92     { EAP_TYPE_NAK,             "Nak" },
  93     { EAP_TYPE_MD5_CHALLENGE,   "MD5-challenge" },
  94     { EAP_TYPE_OTP,             "OTP" },
  95     { EAP_TYPE_GTC,             "GTC" },
  96     { EAP_TYPE_TLS,             "TLS" },
  97     { EAP_TYPE_SIM,             "SIM" },
  98     { EAP_TYPE_TTLS,            "TTLS" },
  99     { EAP_TYPE_AKA,             "AKA" },
 100     { EAP_TYPE_FAST,            "FAST" },
 101     { EAP_TYPE_EXPANDED_TYPES,  "Expanded types" },
 102     { EAP_TYPE_EXPERIMENTAL,    "Experimental" },
 103     { 0, NULL}
 104 };
 105
 106 #define EAP_TLS_EXTRACT_BIT_L(x)        (((x)&0x80)>>7)
 107
 108 /* RFC 2716 - EAP TLS bits */
 109 #define EAP_TLS_FLAGS_LEN_INCLUDED              (1 << 7)
 110 #define EAP_TLS_FLAGS_MORE_FRAGMENTS            (1 << 6)
 111 #define EAP_TLS_FLAGS_START                     (1 << 5)
 112
 113 static const struct tok eap_tls_flags_values[] = {
 114         { EAP_TLS_FLAGS_LEN_INCLUDED, "L bit" },
 115         { EAP_TLS_FLAGS_MORE_FRAGMENTS, "More fragments bit"},
 116         { EAP_TLS_FLAGS_START, "Start bit"},
 117         { 0, NULL}
 118 };
 119
 120 #define EAP_TTLS_VERSION(x)             ((x)&0x07)
 121
 122 /* EAP-AKA and EAP-SIM - RFC 4187 */
 123 #define EAP_AKA_CHALLENGE               1
 124 #define EAP_AKA_AUTH_REJECT             2
 125 #define EAP_AKA_SYNC_FAILURE            4
 126 #define EAP_AKA_IDENTITY                5
 127 #define EAP_SIM_START                   10
 128 #define EAP_SIM_CHALLENGE               11
 129 #define EAP_AKA_NOTIFICATION            12
 130 #define EAP_AKA_REAUTH                  13
 131 #define EAP_AKA_CLIENT_ERROR            14
 132
 133 static const struct tok eap_aka_subtype_values[] = {
 134     { EAP_AKA_CHALLENGE,        "Challenge" },
 135     { EAP_AKA_AUTH_REJECT,      "Auth reject" },
 136     { EAP_AKA_SYNC_FAILURE,     "Sync failure" },
 137     { EAP_AKA_IDENTITY,         "Identity" },
 138     { EAP_SIM_START,            "Start" },
 139     { EAP_SIM_CHALLENGE,        "Challenge" },
 140     { EAP_AKA_NOTIFICATION,     "Notification" },
 141     { EAP_AKA_REAUTH,           "Reauth" },
 142     { EAP_AKA_CLIENT_ERROR,     "Client error" },
 143     { 0, NULL}
 144 };
 145
 146 /*
 147  * Print EAP requests / responses
 148  */
 149 void
 150 eap_print(netdissect_options *ndo,
 151           const u_char *cp,
 152           u_int length)
 153 {
 154     const struct eap_frame_t *eap;
 155     const u_char *tptr;
 156     u_int eap_type, tlen, type, subtype;
 157     int count=0, len;
 158
 159     ndo->ndo_protocol = "eap";
 160     tptr = cp;
 161     tlen = length;
 162     eap = (const struct eap_frame_t *)cp;
 163     ND_TCHECK_SIZE(eap);
 164     eap_type = EXTRACT_U_1(eap->type);
 165
 166     /* in non-verbose mode just lets print the basic info */
 167     if (ndo->ndo_vflag < 1) {
 168         ND_PRINT("%s (%u) v%u, len %u",
 169                tok2str(eap_frame_type_values, "unknown", eap_type),
 170                eap_type,
 171                EXTRACT_U_1(eap->version),
 172                EXTRACT_BE_U_2(eap->length));
 173         return;
 174     }
 175
 176     ND_PRINT("%s (%u) v%u, len %u",
 177            tok2str(eap_frame_type_values, "unknown", eap_type),
 178            eap_type,
 179            EXTRACT_U_1(eap->version),
 180            EXTRACT_BE_U_2(eap->length));
 181
 182     tptr += sizeof(struct eap_frame_t);
 183     tlen -= sizeof(struct eap_frame_t);
 184
 185     switch (eap_type) {
 186     case EAP_FRAME_TYPE_PACKET:
 187         ND_TCHECK_1(tptr);
 188         type = EXTRACT_U_1(tptr);
 189         ND_TCHECK_2(tptr + 2);
 190         len = EXTRACT_BE_U_2(tptr + 2);
 191         ND_PRINT(", %s (%u), id %u, len %u",
 192                tok2str(eap_code_values, "unknown", type),
 193                type,
 194                EXTRACT_U_1((tptr + 1)),
 195                len);
 196
 197         ND_TCHECK_LEN(tptr, len);
 198
 199         if (type <= 2) { /* For EAP_REQUEST and EAP_RESPONSE only */
 200             ND_TCHECK_1(tptr + 4);
 201             subtype = EXTRACT_U_1(tptr + 4);
 202             ND_PRINT("\n\t\t Type %s (%u)",
 203                    tok2str(eap_type_values, "unknown", subtype),
 204                    subtype);
 205
 206             switch (subtype) {
 207             case EAP_TYPE_IDENTITY:
 208                 if (len - 5 > 0) {
 209                     ND_PRINT(", Identity: ");
 210                     (void)nd_printzp(ndo, tptr + 5, len - 5, NULL);
 211                 }
 212                 break;
 213
 214             case EAP_TYPE_NOTIFICATION:
 215                 if (len - 5 > 0) {
 216                     ND_PRINT(", Notification: ");
 217                     (void)nd_printzp(ndo, tptr + 5, len - 5, NULL);
 218                 }
 219                 break;
 220
 221             case EAP_TYPE_NAK:
 222                 count = 5;
 223
 224                 /*
 225                  * one or more octets indicating
 226                  * the desired authentication
 227                  * type one octet per type
 228                  */
 229                 while (count < len) {
 230                     ND_TCHECK_1(tptr + count);
 231                     ND_PRINT(" %s (%u),",
 232                            tok2str(eap_type_values, "unknown", EXTRACT_U_1((tptr + count))),
 233                            EXTRACT_U_1(tptr + count));
 234                     count++;
 235                 }
 236                 break;
 237
 238             case EAP_TYPE_TTLS:
 239             case EAP_TYPE_TLS:
 240                 ND_TCHECK_1(tptr + 5);
 241                 if (subtype == EAP_TYPE_TTLS)
 242                     ND_PRINT(" TTLSv%u",
 243                            EAP_TTLS_VERSION(EXTRACT_U_1((tptr + 5))));
 244                 ND_PRINT(" flags [%s] 0x%02x,",
 245                        bittok2str(eap_tls_flags_values, "none", EXTRACT_U_1((tptr + 5))),
 246                        EXTRACT_U_1(tptr + 5));
 247
 248                 if (EAP_TLS_EXTRACT_BIT_L(EXTRACT_U_1(tptr + 5))) {
 249                     ND_TCHECK_4(tptr + 6);
 250                     ND_PRINT(" len %u", EXTRACT_BE_U_4(tptr + 6));
 251                 }
 252                 break;
 253
 254             case EAP_TYPE_FAST:
 255                 ND_TCHECK_1(tptr + 5);
 256                 ND_PRINT(" FASTv%u",
 257                        EAP_TTLS_VERSION(EXTRACT_U_1((tptr + 5))));
 258                 ND_PRINT(" flags [%s] 0x%02x,",
 259                        bittok2str(eap_tls_flags_values, "none", EXTRACT_U_1((tptr + 5))),
 260                        EXTRACT_U_1(tptr + 5));
 261
 262                 if (EAP_TLS_EXTRACT_BIT_L(EXTRACT_U_1(tptr + 5))) {
 263                     ND_TCHECK_4(tptr + 6);
 264                     ND_PRINT(" len %u", EXTRACT_BE_U_4(tptr + 6));
 265                 }
 266
 267                 /* FIXME - TLV attributes follow */
 268                 break;
 269
 270             case EAP_TYPE_AKA:
 271             case EAP_TYPE_SIM:
 272                 ND_TCHECK_1(tptr + 5);
 273                 ND_PRINT(" subtype [%s] 0x%02x,",
 274                        tok2str(eap_aka_subtype_values, "unknown", EXTRACT_U_1((tptr + 5))),
 275                        EXTRACT_U_1(tptr + 5));
 276
 277                 /* FIXME - TLV attributes follow */
 278                 break;
 279
 280             case EAP_TYPE_MD5_CHALLENGE:
 281             case EAP_TYPE_OTP:
 282             case EAP_TYPE_GTC:
 283             case EAP_TYPE_EXPANDED_TYPES:
 284             case EAP_TYPE_EXPERIMENTAL:
 285             default:
 286                 break;
 287             }
 288         }
 289         break;
 290
 291     case EAP_FRAME_TYPE_LOGOFF:
 292     case EAP_FRAME_TYPE_ENCAP_ASF_ALERT:
 293     default:
 294         break;
 295     }
 296     return;
 297
 298  trunc:
 299     nd_print_trunc(ndo);
 300 }