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