rtw_security.h revision 75f3f039563c85e6dc89e937e253051a07336348 
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 ******************************************************************************/
15#ifndef __RTW_SECURITY_H_
16#define __RTW_SECURITY_H_
17
18#include <osdep_service.h>
19#include <drv_types.h>
20
21
22#define _NO_PRIVACY_		0x0
23#define _WEP40_			0x1
24#define _TKIP_			0x2
25#define _TKIP_WTMIC_		0x3
26#define _AES_			0x4
27#define _WEP104_		0x5
28#define _WEP_WPA_MIXED_	0x07  /*  WEP + WPA */
29#define _SMS4_			0x06
30
31#define is_wep_enc(alg) (((alg) == _WEP40_) || ((alg) == _WEP104_))
32
33#define _WPA2_IE_ID_	0x30
34
35#define SHA256_MAC_LEN 32
36#define AES_BLOCK_SIZE 16
37#define AES_PRIV_SIZE (4 * 44)
38
39enum ENCRYP_PROTOCOL {
40	ENCRYP_PROTOCOL_OPENSYS,   /* open system */
41	ENCRYP_PROTOCOL_WEP,       /* WEP */
42	ENCRYP_PROTOCOL_WPA,       /* WPA */
43	ENCRYP_PROTOCOL_WPA2,      /* WPA2 */
44	ENCRYP_PROTOCOL_MAX
45};
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
55union pn48 {
56	u64	val;
57
58#ifdef __LITTLE_ENDIAN
59
60struct {
61	u8 TSC0;
62	u8 TSC1;
63	u8 TSC2;
64	u8 TSC3;
65	u8 TSC4;
66	u8 TSC5;
67	u8 TSC6;
68	u8 TSC7;
69} _byte_;
70
71#elif defined(__BIG_ENDIAN)
72
73struct {
74	u8 TSC7;
75	u8 TSC6;
76	u8 TSC5;
77	u8 TSC4;
78	u8 TSC3;
79	u8 TSC2;
80	u8 TSC1;
81	u8 TSC0;
82} _byte_;
83#else
84#error Need BIG or LITTLE endian
85
86#endif
87
88};
89
90union Keytype {
91	u8   skey[16];
92	u32    lkey[4];
93};
94
95
96struct rt_pmkid_list {
97	u8	bUsed;
98	u8	Bssid[6];
99	u8	PMKID[16];
100	u8	SsidBuf[33];
101	u8	*ssid_octet;
102	u16	ssid_length;
103};
104
105struct security_priv {
106	u32	  dot11AuthAlgrthm;	/*  802.11 auth, could be open, shared,
107					 * 8021x and authswitch */
108	u32	  dot11PrivacyAlgrthm;	/* This specifies the privacy for
109					 * shared auth. algorithm.
110					 */
111	/* WEP */
112	u32	  dot11PrivacyKeyIndex;	/*  this is only valid for legendary
113					 * wep, 0~3 for key id. (tx key index)
114					 */
115	union Keytype dot11DefKey[4];	/*  this is only valid for def. key */
116	u32	dot11DefKeylen[4];
117
118	u32 dot118021XGrpPrivacy;	/* specify the privacy algthm.
119					 * used for Grp key
120					 */
121	u32	dot118021XGrpKeyid;	/*  key id used for Grp Key
122					 * (tx key index)
123					 */
124	union Keytype	dot118021XGrpKey[4];/* 802.1x Grp Key, inx0 and inx1 */
125	union Keytype	dot118021XGrptxmickey[4];
126	union Keytype	dot118021XGrprxmickey[4];
127	union pn48	dot11Grptxpn;		/* PN48 used for Grp Key xmit.*/
128	union pn48	dot11Grprxpn;		/* PN48 used for Grp Key recv.*/
129
130#ifdef CONFIG_8723AU_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	u8	binstallGrpkey;
143	u8	busetkipkey;
144	u8	bcheck_grpkey;
145	u8	bgrpkey_handshake;
146	s32	hw_decrypted;
147	u32 ndisauthtype;	/*  enum ndis_802_11_auth_mode */
148	u32 ndisencryptstatus;	/*  NDIS_802_11_ENCRYPTION_STATUS */
149	struct wlan_bssid_ex sec_bss;  /* for joinbss (h2c buffer) usage */
150	struct ndis_802_11_wep ndiswep;
151	u8 assoc_info[600];
152	u8 szofcapability[256]; /* for wpa2 usage */
153	u8 oidassociation[512]; /* for wpa/wpa2 usage */
154	u8 authenticator_ie[256];  /* store ap security information element */
155	u8 supplicant_ie[256];  /* store sta security information element */
156
157	/* for tkip countermeasure */
158	unsigned long last_mic_err_time;
159	u8	btkip_countermeasure;
160	u8	btkip_wait_report;
161	unsigned long btkip_countermeasure_time;
162
163	/*  For WPA2 Pre-Authentication. */
164	struct rt_pmkid_list PMKIDList[NUM_PMKID_CACHE];
165	u8 PMKIDIndex;
166	u8 bWepDefaultKeyIdxSet;
167};
168
169struct sha256_state {
170	u64 length;
171	u32 state[8], curlen;
172	u8 buf[64];
173};
174
175#define GET_ENCRY_ALGO(psecuritypriv, psta, encry_algo, bmcst)\
176do {\
177	switch (psecuritypriv->dot11AuthAlgrthm) {\
178	case dot11AuthAlgrthm_Open:\
179	case dot11AuthAlgrthm_Shared:\
180	case dot11AuthAlgrthm_Auto:\
181		encry_algo = (u8)psecuritypriv->dot11PrivacyAlgrthm;\
182		break;\
183	case dot11AuthAlgrthm_8021X:\
184		if (bmcst)\
185			encry_algo = (u8)psecuritypriv->dot118021XGrpPrivacy;\
186		else\
187			encry_algo = (u8)psta->dot118021XPrivacy;\
188		break;\
189	}	\
190} while (0)
191
192#define GET_TKIP_PN(iv, dot11txpn)\
193do {\
194	dot11txpn._byte_.TSC0 = iv[2];\
195	dot11txpn._byte_.TSC1 = iv[0];\
196	dot11txpn._byte_.TSC2 = iv[4];\
197	dot11txpn._byte_.TSC3 = iv[5];\
198	dot11txpn._byte_.TSC4 = iv[6];\
199	dot11txpn._byte_.TSC5 = iv[7];\
200} while (0)
201
202#define ROL32(A, n)  (((A) << (n)) | (((A)>>(32-(n)))  & ((1UL << (n)) - 1)))
203#define ROR32(A, n)  ROL32((A), 32-(n))
204
205struct mic_data {
206	u32  K0, K1;         /*  Key */
207	u32  L, R;           /*  Current state */
208	u32  M;              /*  Message accumulator (single word) */
209	u32     nBytesInM;      /*  # bytes in M */
210};
211
212extern const u32 Te0[256];
213extern const u32 Te1[256];
214extern const u32 Te2[256];
215extern const u32 Te3[256];
216extern const u32 Te4[256];
217extern const u32 Td0[256];
218extern const u32 Td1[256];
219extern const u32 Td2[256];
220extern const u32 Td3[256];
221extern const u32 Td4[256];
222extern const u32 rcon[10];
223extern const u8 Td4s[256];
224extern const u8 rcons[10];
225
226#define RCON(i) (rcons[(i)] << 24)
227
228static inline u32 rotr(u32 val, int bits)
229{
230	return (val >> bits) | (val << (32 - bits));
231}
232
233#define TE0(i) Te0[((i) >> 24) & 0xff]
234#define TE1(i) rotr(Te0[((i) >> 16) & 0xff], 8)
235#define TE2(i) rotr(Te0[((i) >> 8) & 0xff], 16)
236#define TE3(i) rotr(Te0[(i) & 0xff], 24)
237#define TE41(i) ((Te0[((i) >> 24) & 0xff] << 8) & 0xff000000)
238#define TE42(i) (Te0[((i) >> 16) & 0xff] & 0x00ff0000)
239#define TE43(i) (Te0[((i) >> 8) & 0xff] & 0x0000ff00)
240#define TE44(i) ((Te0[(i) & 0xff] >> 8) & 0x000000ff)
241#define TE421(i) ((Te0[((i) >> 16) & 0xff] << 8) & 0xff000000)
242#define TE432(i) (Te0[((i) >> 8) & 0xff] & 0x00ff0000)
243#define TE443(i) (Te0[(i) & 0xff] & 0x0000ff00)
244#define TE414(i) ((Te0[((i) >> 24) & 0xff] >> 8) & 0x000000ff)
245#define TE4(i) ((Te0[(i)] >> 8) & 0x000000ff)
246
247#define TD0(i) Td0[((i) >> 24) & 0xff]
248#define TD1(i) rotr(Td0[((i) >> 16) & 0xff], 8)
249#define TD2(i) rotr(Td0[((i) >> 8) & 0xff], 16)
250#define TD3(i) rotr(Td0[(i) & 0xff], 24)
251#define TD41(i) (Td4s[((i) >> 24) & 0xff] << 24)
252#define TD42(i) (Td4s[((i) >> 16) & 0xff] << 16)
253#define TD43(i) (Td4s[((i) >> 8) & 0xff] << 8)
254#define TD44(i) (Td4s[(i) & 0xff])
255#define TD0_(i) Td0[(i) & 0xff]
256#define TD1_(i) rotr(Td0[(i) & 0xff], 8)
257#define TD2_(i) rotr(Td0[(i) & 0xff], 16)
258#define TD3_(i) rotr(Td0[(i) & 0xff], 24)
259
260#define GETU32(pt) (((u32)(pt)[0] << 24) ^ ((u32)(pt)[1] << 16) ^ \
261			((u32)(pt)[2] <<  8) ^ ((u32)(pt)[3]))
262
263#define PUTU32(ct, st) { \
264(ct)[0] = (u8)((st) >> 24); (ct)[1] = (u8)((st) >> 16); \
265(ct)[2] = (u8)((st) >>  8); (ct)[3] = (u8)(st); }
266
267#define WPA_GET_BE32(a) ((((u32) (a)[0]) << 24) | (((u32) (a)[1]) << 16) | \
268			 (((u32) (a)[2]) << 8) | ((u32) (a)[3]))
269
270#define WPA_PUT_LE16(a, val)			\
271	do {					\
272		(a)[1] = ((u16) (val)) >> 8;	\
273		(a)[0] = ((u16) (val)) & 0xff;	\
274	} while (0)
275
276#define WPA_PUT_BE32(a, val)					\
277	do {							\
278		(a)[0] = (u8) ((((u32) (val)) >> 24) & 0xff);	\
279		(a)[1] = (u8) ((((u32) (val)) >> 16) & 0xff);	\
280		(a)[2] = (u8) ((((u32) (val)) >> 8) & 0xff);	\
281		(a)[3] = (u8) (((u32) (val)) & 0xff);		\
282	} while (0)
283
284#define WPA_PUT_BE64(a, val)				\
285	do {						\
286		(a)[0] = (u8) (((u64) (val)) >> 56);	\
287		(a)[1] = (u8) (((u64) (val)) >> 48);	\
288		(a)[2] = (u8) (((u64) (val)) >> 40);	\
289		(a)[3] = (u8) (((u64) (val)) >> 32);	\
290		(a)[4] = (u8) (((u64) (val)) >> 24);	\
291		(a)[5] = (u8) (((u64) (val)) >> 16);	\
292		(a)[6] = (u8) (((u64) (val)) >> 8);	\
293		(a)[7] = (u8) (((u64) (val)) & 0xff);	\
294	} while (0)
295
296/* ===== start - public domain SHA256 implementation ===== */
297
298/* This is based on SHA256 implementation in LibTomCrypt that was released into
299 * public domain by Tom St Denis. */
300
301/* the K array */
302static const unsigned long K[64] = {
303	0x428a2f98UL, 0x71374491UL, 0xb5c0fbcfUL, 0xe9b5dba5UL, 0x3956c25bUL,
304	0x59f111f1UL, 0x923f82a4UL, 0xab1c5ed5UL, 0xd807aa98UL, 0x12835b01UL,
305	0x243185beUL, 0x550c7dc3UL, 0x72be5d74UL, 0x80deb1feUL, 0x9bdc06a7UL,
306	0xc19bf174UL, 0xe49b69c1UL, 0xefbe4786UL, 0x0fc19dc6UL, 0x240ca1ccUL,
307	0x2de92c6fUL, 0x4a7484aaUL, 0x5cb0a9dcUL, 0x76f988daUL, 0x983e5152UL,
308	0xa831c66dUL, 0xb00327c8UL, 0xbf597fc7UL, 0xc6e00bf3UL, 0xd5a79147UL,
309	0x06ca6351UL, 0x14292967UL, 0x27b70a85UL, 0x2e1b2138UL, 0x4d2c6dfcUL,
310	0x53380d13UL, 0x650a7354UL, 0x766a0abbUL, 0x81c2c92eUL, 0x92722c85UL,
311	0xa2bfe8a1UL, 0xa81a664bUL, 0xc24b8b70UL, 0xc76c51a3UL, 0xd192e819UL,
312	0xd6990624UL, 0xf40e3585UL, 0x106aa070UL, 0x19a4c116UL, 0x1e376c08UL,
313	0x2748774cUL, 0x34b0bcb5UL, 0x391c0cb3UL, 0x4ed8aa4aUL, 0x5b9cca4fUL,
314	0x682e6ff3UL, 0x748f82eeUL, 0x78a5636fUL, 0x84c87814UL, 0x8cc70208UL,
315	0x90befffaUL, 0xa4506cebUL, 0xbef9a3f7UL, 0xc67178f2UL
316};
317
318void rtw_secmicsetkey23a(struct mic_data *pmicdata, u8 *key);
319void rtw_secmicappend23abyte23a(struct mic_data *pmicdata, u8 b);
320void rtw_secmicappend23a(struct mic_data *pmicdata, u8 *src, u32 nbBytes);
321void rtw_secgetmic23a(struct mic_data *pmicdata, u8 *dst);
322
323void rtw_seccalctkipmic23a(u8 *key, u8 *header, u8 *data, u32 data_len,
324			u8 *Miccode, u8 priorityi);
325
326int rtw_aes_encrypt23a(struct rtw_adapter *padapter,
327		    struct xmit_frame *pxmitframe);
328int rtw_tkip_encrypt23a(struct rtw_adapter *padapter,
329		     struct xmit_frame *pxmitframe);
330void rtw_wep_encrypt23a(struct rtw_adapter *padapter,
331		     struct xmit_frame *pxmitframe);
332int rtw_aes_decrypt23a(struct rtw_adapter *padapter,
333		    struct recv_frame *precvframe);
334int rtw_tkip_decrypt23a(struct rtw_adapter *padapter,
335		     struct recv_frame *precvframe);
336void rtw_wep_decrypt23a(struct rtw_adapter *padapter, struct recv_frame *precvframe);
337
338void rtw_use_tkipkey_handler23a(void *FunctionContext);
339
340#endif	/* __RTL871X_SECURITY_H_ */
341