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