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