blob: f749c7a027d3ebd61e320d5aa54667c23ed12675 [file] [log] [blame]
Forest Bond92b96792009-06-13 07:38:31 -04001/*
2 * Copyright (c) 1996, 2003 VIA Networking Technologies, Inc.
3 * All rights reserved.
4 *
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
18 *
19 *
20 * File: key.h
21 *
22 * Purpose: Implement functions for 802.11i Key management
23 *
24 * Author: Jerry Chen
25 *
26 * Date: May 29, 2003
27 *
28 */
29
Forest Bond92b96792009-06-13 07:38:31 -040030#ifndef __KEY_H__
31#define __KEY_H__
32
Forest Bond92b96792009-06-13 07:38:31 -040033#include "ttype.h"
Forest Bond92b96792009-06-13 07:38:31 -040034#include "tether.h"
Forest Bond92b96792009-06-13 07:38:31 -040035#include "80211mgr.h"
Forest Bond92b96792009-06-13 07:38:31 -040036
37/*--------------------- Export Definitions -------------------------*/
38#define MAX_GROUP_KEY 4
39#define MAX_KEY_TABLE 11
40#define MAX_KEY_LEN 32
41#define AES_KEY_LEN 16
42
43
44#define AUTHENTICATOR_KEY 0x10000000
45#define USE_KEYRSC 0x20000000
46#define PAIRWISE_KEY 0x40000000
47#define TRANSMIT_KEY 0x80000000
48
49#define GROUP_KEY 0x00000000
50
51#define KEY_CTL_WEP 0x00
52#define KEY_CTL_NONE 0x01
53#define KEY_CTL_TKIP 0x02
54#define KEY_CTL_CCMP 0x03
55#define KEY_CTL_INVALID 0xFF
56
57
58typedef struct tagSKeyItem
59{
60 BOOL bKeyValid;
Andres Morecc856e62010-05-17 21:34:01 -030061 unsigned long uKeyLength;
Forest Bond92b96792009-06-13 07:38:31 -040062 BYTE abyKey[MAX_KEY_LEN];
63 QWORD KeyRSC;
64 DWORD dwTSC47_16;
65 WORD wTSC15_0;
66 BYTE byCipherSuite;
67 BYTE byReserved0;
68 DWORD dwKeyIndex;
Andres More8611a292010-05-01 14:25:00 -030069 void *pvKeyTable;
Jim Lieb193a8232009-08-12 14:54:06 -070070} SKeyItem, *PSKeyItem; //64
Forest Bond92b96792009-06-13 07:38:31 -040071
72typedef struct tagSKeyTable
73{
Andres More9a0e7562010-04-13 21:54:48 -030074 BYTE abyBSSID[ETH_ALEN]; /* 6 */
Forest Bond92b96792009-06-13 07:38:31 -040075 BYTE byReserved0[2]; //8
76 SKeyItem PairwiseKey;
77 SKeyItem GroupKey[MAX_GROUP_KEY]; //64*5 = 320, 320+8=328
78 DWORD dwGTKeyIndex; // GroupTransmitKey Index
79 BOOL bInUse;
80 WORD wKeyCtl;
81 BOOL bSoftWEP;
82 BYTE byReserved1[6];
Jim Lieb193a8232009-08-12 14:54:06 -070083} SKeyTable, *PSKeyTable; //352
Forest Bond92b96792009-06-13 07:38:31 -040084
85typedef struct tagSKeyManagement
86{
87 SKeyTable KeyTable[MAX_KEY_TABLE];
Jim Lieb193a8232009-08-12 14:54:06 -070088} SKeyManagement, *PSKeyManagement;
Forest Bond92b96792009-06-13 07:38:31 -040089
90/*--------------------- Export Types ------------------------------*/
91
92/*--------------------- Export Macros ------------------------------*/
93
94/*--------------------- Export Classes ----------------------------*/
95
96/*--------------------- Export Variables --------------------------*/
97
98/*--------------------- Export Functions --------------------------*/
Forest Bond92b96792009-06-13 07:38:31 -040099
Andres More8611a292010-05-01 14:25:00 -0300100void KeyvInitTable(void *pDeviceHandler, PSKeyManagement pTable);
Forest Bond92b96792009-06-13 07:38:31 -0400101
Andres More6f8c13c2010-05-04 20:40:10 -0300102BOOL KeybGetKey(PSKeyManagement pTable, PBYTE pbyBSSID, DWORD dwKeyIndex,
103 PSKeyItem *pKey);
Forest Bond92b96792009-06-13 07:38:31 -0400104
105BOOL KeybSetKey(
Andres More8611a292010-05-01 14:25:00 -0300106 void *pDeviceHandler,
Forest Bond92b96792009-06-13 07:38:31 -0400107 PSKeyManagement pTable,
108 PBYTE pbyBSSID,
109 DWORD dwKeyIndex,
Andres Morecc856e62010-05-17 21:34:01 -0300110 unsigned long uKeyLength,
Forest Bond92b96792009-06-13 07:38:31 -0400111 PQWORD pKeyRSC,
112 PBYTE pbyKey,
113 BYTE byKeyDecMode
114 );
115
116BOOL KeybRemoveKey(
Andres More8611a292010-05-01 14:25:00 -0300117 void *pDeviceHandler,
Forest Bond92b96792009-06-13 07:38:31 -0400118 PSKeyManagement pTable,
119 PBYTE pbyBSSID,
120 DWORD dwKeyIndex
121 );
122
Andres More8611a292010-05-01 14:25:00 -0300123BOOL KeybRemoveAllKey(
124 void *pDeviceHandler,
Forest Bond92b96792009-06-13 07:38:31 -0400125 PSKeyManagement pTable,
126 PBYTE pbyBSSID
127 );
128
Andres More8611a292010-05-01 14:25:00 -0300129void KeyvRemoveWEPKey(
130 void *pDeviceHandler,
Forest Bond92b96792009-06-13 07:38:31 -0400131 PSKeyManagement pTable,
132 DWORD dwKeyIndex
133 );
134
Andres More8611a292010-05-01 14:25:00 -0300135void KeyvRemoveAllWEPKey(
136 void *pDeviceHandler,
Forest Bond92b96792009-06-13 07:38:31 -0400137 PSKeyManagement pTable
138 );
139
Andres More6f8c13c2010-05-04 20:40:10 -0300140BOOL KeybGetTransmitKey(PSKeyManagement pTable, PBYTE pbyBSSID, DWORD dwKeyType,
141 PSKeyItem *pKey);
Forest Bond92b96792009-06-13 07:38:31 -0400142
Andres More6f8c13c2010-05-04 20:40:10 -0300143BOOL KeybCheckPairewiseKey(PSKeyManagement pTable, PSKeyItem *pKey);
Forest Bond92b96792009-06-13 07:38:31 -0400144
Andres More8611a292010-05-01 14:25:00 -0300145BOOL KeybSetDefaultKey(
146 void *pDeviceHandler,
Forest Bond92b96792009-06-13 07:38:31 -0400147 PSKeyManagement pTable,
148 DWORD dwKeyIndex,
Andres Morecc856e62010-05-17 21:34:01 -0300149 unsigned long uKeyLength,
Forest Bond92b96792009-06-13 07:38:31 -0400150 PQWORD pKeyRSC,
151 PBYTE pbyKey,
152 BYTE byKeyDecMode
153 );
154
Andres More8611a292010-05-01 14:25:00 -0300155BOOL KeybSetAllGroupKey(
156 void *pDeviceHandler,
Forest Bond92b96792009-06-13 07:38:31 -0400157 PSKeyManagement pTable,
158 DWORD dwKeyIndex,
Andres Morecc856e62010-05-17 21:34:01 -0300159 unsigned long uKeyLength,
Forest Bond92b96792009-06-13 07:38:31 -0400160 PQWORD pKeyRSC,
161 PBYTE pbyKey,
162 BYTE byKeyDecMode
163 );
164
Andres Moree7b07d12010-05-01 19:12:26 -0300165#endif /* __KEY_H__ */