drivers/net/wireless/rtl8192du/include/rtw_security.h

   1 /******************************************************************************
   2  *
   3  * Copyright(c) 2007 - 2011 Realtek Corporation. All rights reserved.
   4  *
   5  * This program is free software; you can redistribute it and/or modify it
   6  * under the terms of version 2 of the GNU General Public License as
   7  * published by the Free Software Foundation.
   8  *
   9  * This program is distributed in the hope that it will be useful, but WITHOUT
  10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11  * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
  12  * more details.
  13  *
  14  * You should have received a copy of the GNU General Public License along with
  15  * this program; if not, write to the Free Software Foundation, Inc.,
  16  * 51 Franklin Street, Fifth Floor, Boston, MA 02110, USA
  17  *
  18  *
  19  ******************************************************************************/
  20 #ifndef __RTW_SECURITY_H_
  21 #define __RTW_SECURITY_H_
  22
  23
  24 #include <drv_conf.h>
  25 #include <osdep_service.h>
  26 #include <drv_types.h>
  27
  28
  29 #define _NO_PRIVACY_    0x0
  30 #define _WEP40_                 0x1
  31 #define _TKIP_                  0x2
  32 #define _TKIP_WTMIC_    0x3
  33 #define _AES_                   0x4
  34 #define _WEP104_                0x5
  35 #ifdef CONFIG_IEEE80211W
  36 #define _BIP_                           0x8
  37 #endif //CONFIG_IEEE80211W
  38 #define is_wep_enc(alg) (((alg) == _WEP40_) || ((alg) == _WEP104_))
  39
  40 #define _WPA_IE_ID_     0xdd
  41 #define _WPA2_IE_ID_    0x30
  42
  43 #define SHA256_MAC_LEN 32
  44 #define AES_BLOCK_SIZE 16
  45 #define AES_PRIV_SIZE (4 * 44)
  46
  47 #ifndef Ndis802_11AuthModeWPA2
  48 #define Ndis802_11AuthModeWPA2 (Ndis802_11AuthModeWPANone + 1)
  49 #endif
  50
  51 #ifndef Ndis802_11AuthModeWPA2PSK
  52 #define Ndis802_11AuthModeWPA2PSK (Ndis802_11AuthModeWPANone + 2)
  53 #endif
  54
  55 union pn48      {
  56
  57         u64     val;
  58
  59 #ifdef CONFIG_LITTLE_ENDIAN
  60
  61 struct {
  62   u8 TSC0;
  63   u8 TSC1;
  64   u8 TSC2;
  65   u8 TSC3;
  66   u8 TSC4;
  67   u8 TSC5;
  68   u8 TSC6;
  69   u8 TSC7;
  70 } _byte_;
  71
  72 #elif defined(CONFIG_BIG_ENDIAN)
  73
  74 struct {
  75   u8 TSC7;
  76   u8 TSC6;
  77   u8 TSC5;
  78   u8 TSC4;
  79   u8 TSC3;
  80   u8 TSC2;
  81   u8 TSC1;
  82   u8 TSC0;
  83 } _byte_;
  84
  85 #endif
  86
  87 };
  88
  89 union Keytype {
  90         u8   skey[16];
  91         u32    lkey[4];
  92 };
  93
  94
  95 typedef struct _RT_PMKID_LIST
  96 {
  97         u8                                              bUsed;
  98         u8                                              Bssid[6];
  99         u8                                              PMKID[16];
 100         u8                                              SsidBuf[33];
 101         u8*                                             ssid_octet;
 102         u16                                             ssid_length;
 103 } RT_PMKID_LIST, *PRT_PMKID_LIST;
 104
 105
 106 struct security_priv
 107 {
 108         u32       dot11AuthAlgrthm;             // 802.11 auth, could be open, shared, 8021x and authswitch
 109         u32       dot11PrivacyAlgrthm;  // This specify the privacy for shared auth. algorithm.
 110
 111         /* WEP */
 112         u32       dot11PrivacyKeyIndex; // this is only valid for legendary wep, 0~3 for key id. (tx key index)
 113         union Keytype dot11DefKey[4];                   // this is only valid for def. key
 114         u32     dot11DefKeylen[4];
 115         u8      key_mask; /* use to restore wep key after hal_init */
 116
 117         u32 dot118021XGrpPrivacy;       // This specify the privacy algthm. used for Grp key
 118         u32     dot118021XGrpKeyid;             // key id used for Grp Key ( tx key index)
 119         union Keytype   dot118021XGrpKey[4];    // 802.1x Group Key, for inx0 and inx1
 120         union Keytype   dot118021XGrptxmickey[4];
 121         union Keytype   dot118021XGrprxmickey[4];
 122         union pn48              dot11Grptxpn;                   // PN48 used for Grp Key xmit.
 123         union pn48              dot11Grprxpn;                   // PN48 used for Grp Key recv.
 124 #ifdef CONFIG_IEEE80211W
 125         u32     dot11wBIPKeyid;                                         // key id used for BIP Key ( tx key index)
 126         union Keytype   dot11wBIPKey[6];                // BIP Key, for index4 and index5
 127         union pn48              dot11wBIPtxpn;                  // PN48 used for Grp Key xmit.
 128         union pn48              dot11wBIPrxpn;                  // PN48 used for Grp Key recv.
 129 #endif //CONFIG_IEEE80211W
 130 #ifdef CONFIG_AP_MODE
 131         //extend security capabilities for AP_MODE
 132         unsigned int dot8021xalg;//0:disable, 1:psk, 2:802.1x
 133         unsigned int wpa_psk;//0:disable, bit(0): WPA, bit(1):WPA2
 134         unsigned int wpa_group_cipher;
 135         unsigned int wpa2_group_cipher;
 136         unsigned int wpa_pairwise_cipher;
 137         unsigned int wpa2_pairwise_cipher;
 138 #endif
 139
 140         u8 wps_ie[MAX_WPS_IE_LEN];//added in assoc req
 141         int wps_ie_len;
 142
 143
 144         u8      binstallGrpkey;
 145 #ifdef CONFIG_IEEE80211W
 146         u8      binstallBIPkey;
 147 #endif //CONFIG_IEEE80211W
 148         u8      busetkipkey;
 149         //_timer tkip_timer;
 150         u8      bcheck_grpkey;
 151         u8      bgrpkey_handshake;
 152
 153         //u8    packet_cnt;//unused, removed
 154
 155         s32     sw_encrypt;//from registry_priv
 156         s32     sw_decrypt;//from registry_priv
 157
 158         s32     hw_decrypted;//if the rx packets is hw_decrypted==_FALSE, it means the hw has not been ready.
 159
 160
 161         //keeps the auth_type & enc_status from upper layer ioctl(wpa_supplicant or wzc)
 162         u32 ndisauthtype;       // NDIS_802_11_AUTHENTICATION_MODE
 163         u32 ndisencryptstatus;  // NDIS_802_11_ENCRYPTION_STATUS
 164
 165         WLAN_BSSID_EX sec_bss;  //for joinbss (h2c buffer) usage
 166
 167         NDIS_802_11_WEP ndiswep;
 168 #ifdef PLATFORM_WINDOWS
 169         u8 KeyMaterial[16];// variable length depending on above field.
 170 #endif
 171
 172         u8 assoc_info[600];
 173         u8 szofcapability[256]; //for wpa2 usage
 174         u8 oidassociation[512]; //for wpa/wpa2 usage
 175         u8 authenticator_ie[256];  //store ap security information element
 176         u8 supplicant_ie[256];  //store sta security information element
 177
 178
 179         //for tkip countermeasure
 180         u32 last_mic_err_time;
 181         u8      btkip_countermeasure;
 182         u8      btkip_wait_report;
 183         u32 btkip_countermeasure_time;
 184
 185         //---------------------------------------------------------------------------
 186         // For WPA2 Pre-Authentication.
 187         //---------------------------------------------------------------------------
 188         //u8                            RegEnablePreAuth;                               // Default value: Pre-Authentication enabled or not, from registry "EnablePreAuth". Added by Annie, 2005-11-01.
 189         //u8                            EnablePreAuthentication;                        // Current Value: Pre-Authentication enabled or not.
 190         RT_PMKID_LIST           PMKIDList[NUM_PMKID_CACHE];     // Renamed from PreAuthKey[NUM_PRE_AUTH_KEY]. Annie, 2006-10-13.
 191         u8                              PMKIDIndex;
 192         //u32                           PMKIDCount;                                             // Added by Annie, 2006-10-13.
 193         //u8                            szCapability[256];                              // For WPA2-PSK using zero-config, by Annie, 2005-09-20.
 194
 195         u8 bWepDefaultKeyIdxSet;
 196 };
 197
 198 struct sha256_state {
 199         u64 length;
 200         u32 state[8], curlen;
 201         u8 buf[64];
 202 };
 203
 204 #define GET_ENCRY_ALGO(psecuritypriv, psta, encry_algo, bmcst)\
 205 do{\
 206         switch(psecuritypriv->dot11AuthAlgrthm)\
 207         {\
 208                 case dot11AuthAlgrthm_Open:\
 209                 case dot11AuthAlgrthm_Shared:\
 210                 case dot11AuthAlgrthm_Auto:\
 211                         encry_algo = (u8)psecuritypriv->dot11PrivacyAlgrthm;\
 212                         break;\
 213                 case dot11AuthAlgrthm_8021X:\
 214                         if(bmcst)\
 215                                 encry_algo = (u8)psecuritypriv->dot118021XGrpPrivacy;\
 216                         else\
 217                                 encry_algo =(u8) psta->dot118021XPrivacy;\
 218                         break;\
 219         }\
 220 }while(0)
 221
 222
 223 #define SET_ICE_IV_LEN( iv_len, icv_len, encrypt)\
 224 do{\
 225         switch(encrypt)\
 226         {\
 227                 case _WEP40_:\
 228                 case _WEP104_:\
 229                         iv_len = 4;\
 230                         icv_len = 4;\
 231                         break;\
 232                 case _TKIP_:\
 233                         iv_len = 8;\
 234                         icv_len = 4;\
 235                         break;\
 236                 case _AES_:\
 237                         iv_len = 8;\
 238                         icv_len = 8;\
 239                         break;\
 240                 default:\
 241                         iv_len = 0;\
 242                         icv_len = 0;\
 243                         break;\
 244         }\
 245 }while(0)
 246
 247
 248 #define GET_TKIP_PN(iv,dot11txpn)\
 249 do{\
 250         dot11txpn._byte_.TSC0=iv[2];\
 251         dot11txpn._byte_.TSC1=iv[0];\
 252         dot11txpn._byte_.TSC2=iv[4];\
 253         dot11txpn._byte_.TSC3=iv[5];\
 254         dot11txpn._byte_.TSC4=iv[6];\
 255         dot11txpn._byte_.TSC5=iv[7];\
 256 }while(0)
 257
 258
 259 #define ROL32( A, n )   ( ((A) << (n)) | ( ((A)>>(32-(n)))  & ( (1UL << (n)) - 1 ) ) )
 260 #define ROR32( A, n )   ROL32( (A), 32-(n) )
 261
 262 struct mic_data
 263 {
 264         u32  K0, K1;         // Key
 265         u32  L, R;           // Current state
 266         u32  M;              // Message accumulator (single word)
 267         u32     nBytesInM;      // # bytes in M
 268 };
 269
 270 extern const u32 Te0[256];
 271 extern const u32 Te1[256];
 272 extern const u32 Te2[256];
 273 extern const u32 Te3[256];
 274 extern const u32 Te4[256];
 275 extern const u32 Td0[256];
 276 extern const u32 Td1[256];
 277 extern const u32 Td2[256];
 278 extern const u32 Td3[256];
 279 extern const u32 Td4[256];
 280 extern const u32 rcon[10];
 281 extern const u8 Td4s[256];
 282 extern const u8 rcons[10];
 283
 284 #define RCON(i) (rcons[(i)] << 24)
 285
 286 static inline u32 rotr(u32 val, int bits)
 287 {
 288         return (val >> bits) | (val << (32 - bits));
 289 }
 290
 291 #define TE0(i) Te0[((i) >> 24) & 0xff]
 292 #define TE1(i) rotr(Te0[((i) >> 16) & 0xff], 8)
 293 #define TE2(i) rotr(Te0[((i) >> 8) & 0xff], 16)
 294 #define TE3(i) rotr(Te0[(i) & 0xff], 24)
 295 #define TE41(i) ((Te0[((i) >> 24) & 0xff] << 8) & 0xff000000)
 296 #define TE42(i) (Te0[((i) >> 16) & 0xff] & 0x00ff0000)
 297 #define TE43(i) (Te0[((i) >> 8) & 0xff] & 0x0000ff00)
 298 #define TE44(i) ((Te0[(i) & 0xff] >> 8) & 0x000000ff)
 299 #define TE421(i) ((Te0[((i) >> 16) & 0xff] << 8) & 0xff000000)
 300 #define TE432(i) (Te0[((i) >> 8) & 0xff] & 0x00ff0000)
 301 #define TE443(i) (Te0[(i) & 0xff] & 0x0000ff00)
 302 #define TE414(i) ((Te0[((i) >> 24) & 0xff] >> 8) & 0x000000ff)
 303 #define TE4(i) ((Te0[(i)] >> 8) & 0x000000ff)
 304
 305 #define TD0(i) Td0[((i) >> 24) & 0xff]
 306 #define TD1(i) rotr(Td0[((i) >> 16) & 0xff], 8)
 307 #define TD2(i) rotr(Td0[((i) >> 8) & 0xff], 16)
 308 #define TD3(i) rotr(Td0[(i) & 0xff], 24)
 309 #define TD41(i) (Td4s[((i) >> 24) & 0xff] << 24)
 310 #define TD42(i) (Td4s[((i) >> 16) & 0xff] << 16)
 311 #define TD43(i) (Td4s[((i) >> 8) & 0xff] << 8)
 312 #define TD44(i) (Td4s[(i) & 0xff])
 313 #define TD0_(i) Td0[(i) & 0xff]
 314 #define TD1_(i) rotr(Td0[(i) & 0xff], 8)
 315 #define TD2_(i) rotr(Td0[(i) & 0xff], 16)
 316 #define TD3_(i) rotr(Td0[(i) & 0xff], 24)
 317
 318 #define GETU32(pt) (((u32)(pt)[0] << 24) ^ ((u32)(pt)[1] << 16) ^ \
 319                         ((u32)(pt)[2] <<  8) ^ ((u32)(pt)[3]))
 320
 321 #define PUTU32(ct, st) { \
 322 (ct)[0] = (u8)((st) >> 24); (ct)[1] = (u8)((st) >> 16); \
 323 (ct)[2] = (u8)((st) >>  8); (ct)[3] = (u8)(st); }
 324
 325 #define WPA_GET_BE32(a) ((((u32) (a)[0]) << 24) | (((u32) (a)[1]) << 16) | \
 326                          (((u32) (a)[2]) << 8) | ((u32) (a)[3]))
 327
 328 #define WPA_PUT_LE16(a, val)                    \
 329         do {                                    \
 330                 (a)[1] = ((u16) (val)) >> 8;    \
 331                 (a)[0] = ((u16) (val)) & 0xff;  \
 332         } while (0)
 333
 334 #define WPA_PUT_BE32(a, val)                                    \
 335         do {                                                    \
 336                 (a)[0] = (u8) ((((u32) (val)) >> 24) & 0xff);   \
 337                 (a)[1] = (u8) ((((u32) (val)) >> 16) & 0xff);   \
 338                 (a)[2] = (u8) ((((u32) (val)) >> 8) & 0xff);    \
 339                 (a)[3] = (u8) (((u32) (val)) & 0xff);           \
 340         } while (0)
 341
 342 #define WPA_PUT_BE64(a, val)                            \
 343         do {                                            \
 344                 (a)[0] = (u8) (((u64) (val)) >> 56);    \
 345                 (a)[1] = (u8) (((u64) (val)) >> 48);    \
 346                 (a)[2] = (u8) (((u64) (val)) >> 40);    \
 347                 (a)[3] = (u8) (((u64) (val)) >> 32);    \
 348                 (a)[4] = (u8) (((u64) (val)) >> 24);    \
 349                 (a)[5] = (u8) (((u64) (val)) >> 16);    \
 350                 (a)[6] = (u8) (((u64) (val)) >> 8);     \
 351                 (a)[7] = (u8) (((u64) (val)) & 0xff);   \
 352         } while (0)
 353
 354 /* ===== start - public domain SHA256 implementation ===== */
 355
 356 /* This is based on SHA256 implementation in LibTomCrypt that was released into
 357  * public domain by Tom St Denis. */
 358
 359 /* the K array */
 360 static const unsigned long K[64] = {
 361         0x428a2f98UL, 0x71374491UL, 0xb5c0fbcfUL, 0xe9b5dba5UL, 0x3956c25bUL,
 362         0x59f111f1UL, 0x923f82a4UL, 0xab1c5ed5UL, 0xd807aa98UL, 0x12835b01UL,
 363         0x243185beUL, 0x550c7dc3UL, 0x72be5d74UL, 0x80deb1feUL, 0x9bdc06a7UL,
 364         0xc19bf174UL, 0xe49b69c1UL, 0xefbe4786UL, 0x0fc19dc6UL, 0x240ca1ccUL,
 365         0x2de92c6fUL, 0x4a7484aaUL, 0x5cb0a9dcUL, 0x76f988daUL, 0x983e5152UL,
 366         0xa831c66dUL, 0xb00327c8UL, 0xbf597fc7UL, 0xc6e00bf3UL, 0xd5a79147UL,
 367         0x06ca6351UL, 0x14292967UL, 0x27b70a85UL, 0x2e1b2138UL, 0x4d2c6dfcUL,
 368         0x53380d13UL, 0x650a7354UL, 0x766a0abbUL, 0x81c2c92eUL, 0x92722c85UL,
 369         0xa2bfe8a1UL, 0xa81a664bUL, 0xc24b8b70UL, 0xc76c51a3UL, 0xd192e819UL,
 370         0xd6990624UL, 0xf40e3585UL, 0x106aa070UL, 0x19a4c116UL, 0x1e376c08UL,
 371         0x2748774cUL, 0x34b0bcb5UL, 0x391c0cb3UL, 0x4ed8aa4aUL, 0x5b9cca4fUL,
 372         0x682e6ff3UL, 0x748f82eeUL, 0x78a5636fUL, 0x84c87814UL, 0x8cc70208UL,
 373         0x90befffaUL, 0xa4506cebUL, 0xbef9a3f7UL, 0xc67178f2UL
 374 };
 375
 376
 377 /* Various logical functions */
 378 #define RORc(x, y) \
 379 ( ((((unsigned long) (x) & 0xFFFFFFFFUL) >> (unsigned long) ((y) & 31)) | \
 380    ((unsigned long) (x) << (unsigned long) (32 - ((y) & 31)))) & 0xFFFFFFFFUL)
 381 #define Ch(x,y,z)       (z ^ (x & (y ^ z)))
 382 #define Maj(x,y,z)      (((x | y) & z) | (x & y))
 383 #define S(x, n)         RORc((x), (n))
 384 #define R(x, n)         (((x)&0xFFFFFFFFUL)>>(n))
 385 #define Sigma0(x)       (S(x, 2) ^ S(x, 13) ^ S(x, 22))
 386 #define Sigma1(x)       (S(x, 6) ^ S(x, 11) ^ S(x, 25))
 387 #define Gamma0(x)       (S(x, 7) ^ S(x, 18) ^ R(x, 3))
 388 #define Gamma1(x)       (S(x, 17) ^ S(x, 19) ^ R(x, 10))
 389 #ifndef MIN
 390 #define MIN(x, y) (((x) < (y)) ? (x) : (y))
 391 #endif
 392 #ifdef CONFIG_IEEE80211W
 393 int omac1_aes_128(u8 *key, u8 *data, size_t data_len, u8 *mac);
 394 #endif //CONFIG_IEEE80211W
 395 void rtw_secmicsetkey(struct mic_data *pmicdata, u8 * key );
 396 void rtw_secmicappendbyte(struct mic_data *pmicdata, u8 b );
 397 void rtw_secmicappend(struct mic_data *pmicdata, u8 * src, u32 nBytes );
 398 void rtw_secgetmic(struct mic_data *pmicdata, u8 * dst );
 399
 400 void rtw_seccalctkipmic(
 401         u8 * key,
 402         u8 *header,
 403         u8 *data,
 404         u32 data_len,
 405         u8 *Miccode,
 406         u8   priority);
 407
 408 u32 rtw_aes_encrypt(_adapter *padapter, u8 *pxmitframe);
 409 u32 rtw_tkip_encrypt(_adapter *padapter, u8 *pxmitframe);
 410 void rtw_wep_encrypt(_adapter *padapter, u8  *pxmitframe);
 411
 412 u32 rtw_aes_decrypt(_adapter *padapter, u8  *precvframe);
 413 u32 rtw_tkip_decrypt(_adapter *padapter, u8  *precvframe);
 414 void rtw_wep_decrypt(_adapter *padapter, u8  *precvframe);
 415 #ifdef CONFIG_IEEE80211W
 416 u32     rtw_BIP_verify(_adapter *padapter, u8 *precvframe);
 417 #endif //CONFIG_IEEE80211W
 418 #ifdef CONFIG_TDLS
 419 void wpa_tdls_generate_tpk(_adapter *padapter, struct sta_info *psta);
 420 int wpa_tdls_ftie_mic(u8 *kck, u8 trans_seq,
 421                                                 u8 *lnkid, u8 *rsnie, u8 *timeoutie, u8 *ftie,
 422                                                 u8 *mic);
 423 int tdls_verify_mic(u8 *kck, u8 trans_seq,
 424                                                 u8 *lnkid, u8 *rsnie, u8 *timeoutie, u8 *ftie);
 425 #endif //CONFIG_TDLS
 426
 427 #ifdef PLATFORM_WINDOWS
 428 void rtw_use_tkipkey_handler (
 429         IN      PVOID                                   SystemSpecific1,
 430         IN      PVOID                                   FunctionContext,
 431         IN      PVOID                                   SystemSpecific2,
 432         IN      PVOID                                   SystemSpecific3
 433         );
 434 #endif
 435 #ifdef PLATFORM_LINUX
 436 void rtw_use_tkipkey_handler(void* FunctionContext);
 437 #endif
 438
 439 #ifdef PLATFORM_FREEBSD
 440 void rtw_use_tkipkey_handler(void* FunctionContext);
 441 #endif //PLATFORM_FREEBSD
 442
 443 void rtw_sec_restore_wep_key(_adapter *adapter);
 444 u8 rtw_handle_tkip_countermeasure(_adapter* adapter, const char *caller);
 445
 446 #endif  //__RTL871X_SECURITY_H_
 447