package/broadcom-wl/src/driver/proto/wpa.h

   1 /*
   2  * Fundamental types and constants relating to WPA
   3  *
   4  * Copyright 2007, Broadcom Corporation
   5  * All Rights Reserved.
   6  *
   7  * THIS SOFTWARE IS OFFERED "AS IS", AND BROADCOM GRANTS NO WARRANTIES OF ANY
   8  * KIND, EXPRESS OR IMPLIED, BY STATUTE, COMMUNICATION OR OTHERWISE. BROADCOM
   9  * SPECIFICALLY DISCLAIMS ANY IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS
  10  * FOR A SPECIFIC PURPOSE OR NONINFRINGEMENT CONCERNING THIS SOFTWARE.
  11  *
  12  * $Id$
  13  */
  14
  15 #ifndef _proto_wpa_h_
  16 #define _proto_wpa_h_
  17
  18 #include <typedefs.h>
  19 #include <proto/ethernet.h>
  20
  21 /* enable structure packing */
  22 #if defined(__GNUC__)
  23 #define PACKED  __attribute__((packed))
  24 #else
  25 #pragma pack(1)
  26 #define PACKED
  27 #endif
  28
  29 /* Reason Codes */
  30
  31 /* 13 through 23 taken from IEEE Std 802.11i-2004 */
  32 #define DOT11_RC_INVALID_WPA_IE         13      /* Invalid info. element */
  33 #define DOT11_RC_MIC_FAILURE            14      /* Michael failure */
  34 #define DOT11_RC_4WH_TIMEOUT            15      /* 4-way handshake timeout */
  35 #define DOT11_RC_GTK_UPDATE_TIMEOUT     16      /* Group key update timeout */
  36 #define DOT11_RC_WPA_IE_MISMATCH        17      /* WPA IE in 4-way handshake differs from
  37                                                  * (re-)assoc. request/probe response
  38                                                  */
  39 #define DOT11_RC_INVALID_MC_CIPHER      18      /* Invalid multicast cipher */
  40 #define DOT11_RC_INVALID_UC_CIPHER      19      /* Invalid unicast cipher */
  41 #define DOT11_RC_INVALID_AKMP           20      /* Invalid authenticated key management protocol */
  42 #define DOT11_RC_BAD_WPA_VERSION        21      /* Unsupported WPA version */
  43 #define DOT11_RC_INVALID_WPA_CAP        22      /* Invalid WPA IE capabilities */
  44 #define DOT11_RC_8021X_AUTH_FAIL        23      /* 802.1X authentication failure */
  45
  46 #define WPA2_PMKID_LEN  16
  47
  48 /* WPA IE fixed portion */
  49 typedef struct
  50 {
  51         uint8 tag;      /* TAG */
  52         uint8 length;   /* TAG length */
  53         uint8 oui[3];   /* IE OUI */
  54         uint8 oui_type; /* OUI type */
  55         struct {
  56                 uint8 low;
  57                 uint8 high;
  58         } PACKED version;       /* IE version */
  59 } PACKED wpa_ie_fixed_t;
  60 #define WPA_IE_OUITYPE_LEN      4
  61 #define WPA_IE_FIXED_LEN        8
  62 #define WPA_IE_TAG_FIXED_LEN    6
  63
  64 #ifdef BCMWPA2
  65 typedef struct {
  66         uint8 tag;      /* TAG */
  67         uint8 length;   /* TAG length */
  68         struct {
  69                 uint8 low;
  70                 uint8 high;
  71         } PACKED version;       /* IE version */
  72 } PACKED wpa_rsn_ie_fixed_t;
  73 #define WPA_RSN_IE_FIXED_LEN    4
  74 #define WPA_RSN_IE_TAG_FIXED_LEN        2
  75 typedef uint8 wpa_pmkid_t[WPA2_PMKID_LEN];
  76 #endif
  77
  78 /* WPA suite/multicast suite */
  79 typedef struct
  80 {
  81         uint8 oui[3];
  82         uint8 type;
  83 } PACKED wpa_suite_t, wpa_suite_mcast_t;
  84 #define WPA_SUITE_LEN   4
  85
  86 /* WPA unicast suite list/key management suite list */
  87 typedef struct
  88 {
  89         struct {
  90                 uint8 low;
  91                 uint8 high;
  92         } PACKED count;
  93         wpa_suite_t list[1];
  94 } PACKED wpa_suite_ucast_t, wpa_suite_auth_key_mgmt_t;
  95 #define WPA_IE_SUITE_COUNT_LEN  2
  96 #ifdef BCMWPA2
  97 typedef struct
  98 {
  99         struct {
 100                 uint8 low;
 101                 uint8 high;
 102         } PACKED count;
 103         wpa_pmkid_t list[1];
 104 } PACKED wpa_pmkid_list_t;
 105 #endif
 106
 107 /* WPA cipher suites */
 108 #define WPA_CIPHER_NONE         0       /* None */
 109 #define WPA_CIPHER_WEP_40       1       /* WEP (40-bit) */
 110 #define WPA_CIPHER_TKIP         2       /* TKIP: default for WPA */
 111 #define WPA_CIPHER_AES_OCB      3       /* AES (OCB) */
 112 #define WPA_CIPHER_AES_CCM      4       /* AES (CCM) */
 113 #define WPA_CIPHER_WEP_104      5       /* WEP (104-bit) */
 114
 115 #define IS_WPA_CIPHER(cipher)   ((cipher) == WPA_CIPHER_NONE || \
 116                                  (cipher) == WPA_CIPHER_WEP_40 || \
 117                                  (cipher) == WPA_CIPHER_WEP_104 || \
 118                                  (cipher) == WPA_CIPHER_TKIP || \
 119                                  (cipher) == WPA_CIPHER_AES_OCB || \
 120                                  (cipher) == WPA_CIPHER_AES_CCM)
 121
 122 /* WPA TKIP countermeasures parameters */
 123 #define WPA_TKIP_CM_DETECT      60      /* multiple MIC failure window (seconds) */
 124 #define WPA_TKIP_CM_BLOCK       60      /* countermeasures active window (seconds) */
 125
 126 /* RSN IE defines */
 127 #define RSN_CAP_LEN             2       /* Length of RSN capabilities field (2 octets) */
 128
 129 /* RSN Capabilities defined in 802.11i */
 130 #define RSN_CAP_PREAUTH                 0x0001
 131 #define RSN_CAP_NOPAIRWISE              0x0002
 132 #define RSN_CAP_PTK_REPLAY_CNTR_MASK    0x000C
 133 #define RSN_CAP_PTK_REPLAY_CNTR_SHIFT   2
 134 #define RSN_CAP_GTK_REPLAY_CNTR_MASK    0x0030
 135 #define RSN_CAP_GTK_REPLAY_CNTR_SHIFT   4
 136 #define RSN_CAP_1_REPLAY_CNTR           0
 137 #define RSN_CAP_2_REPLAY_CNTRS          1
 138 #define RSN_CAP_4_REPLAY_CNTRS          2
 139 #define RSN_CAP_16_REPLAY_CNTRS         3
 140
 141 /* WPA capabilities defined in 802.11i */
 142 #define WPA_CAP_4_REPLAY_CNTRS          RSN_CAP_4_REPLAY_CNTRS
 143 #define WPA_CAP_16_REPLAY_CNTRS         RSN_CAP_16_REPLAY_CNTRS
 144 #define WPA_CAP_REPLAY_CNTR_SHIFT       RSN_CAP_PTK_REPLAY_CNTR_SHIFT
 145 #define WPA_CAP_REPLAY_CNTR_MASK        RSN_CAP_PTK_REPLAY_CNTR_MASK
 146
 147 /* WPA Specific defines */
 148 #define WPA_CAP_LEN     RSN_CAP_LEN     /* Length of RSN capabilities in RSN IE (2 octets) */
 149
 150 #define WPA_CAP_WPA2_PREAUTH            RSN_CAP_PREAUTH
 151
 152
 153 #undef PACKED
 154 #if !defined(__GNUC__)
 155 #pragma pack()
 156 #endif
 157
 158 #endif /* _proto_wpa_h_ */