source: mainline/uspace/lib/ieee80211/include/ieee80211_private.h@ cc575ef9

lfn serial ticket/834-toolchain-update topic/msim-upgrade topic/simplify-dev-export
Last change on this file since cc575ef9 was cc575ef9, checked in by Jan Kolarik <kolarik@…>, 10 years ago

Appending Michael MIC footer in TKIP communication, tested MIC algorithm itself, but needs testing on real data transmission
  • Property mode set to 100644
File size: 12.4 KB
Line 
1/*
2 * Copyright (c) 2015 Jan Kolarik
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 *
9 * - Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * - Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
14 * - The name of the author may not be used to endorse or promote products
15 * derived from this software without specific prior written permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 */
28
29/**
30 * @addtogroup libieee80211
31 * @{
32 */
33
34/** @file ieee80211.h
35 *
36 * Internal IEEE 802.11 header that should not be included.
37 */
38
39#ifndef LIBNET_IEEE80211_PRIVATE_H
40#define LIBNET_IEEE80211_PRIVATE_H
41
42#include <fibril_synch.h>
43#include <byteorder.h>
44#include <ddf/driver.h>
45#include <sys/types.h>
46
47#include <ieee80211/ieee80211.h>
48#include "ieee80211.h"
49
50/* Timeout in us for waiting to authentication/association response. */
51#define AUTH_TIMEOUT 200000
52
53/* Timeout in us for waiting to finish 4-way handshake process. */
54#define HANDSHAKE_TIMEOUT 5000000
55
56/* Scanning period. */
57#define SCAN_PERIOD_USEC 35000000
58
59/* Time to wait for beacons on channel. */
60#define SCAN_CHANNEL_WAIT_USEC 200000
61
62/* Max time to keep scan result. */
63#define MAX_KEEP_SCAN_SPAN_SEC 120
64
65/* Security bit in capability info field. */
66#define CAP_SECURITY 0x10
67
68/* Protocol type used in EAPOL frames. */
69#define ETH_TYPE_PAE 0x888E
70
71/* WPA OUI used in vendor specific IE. */
72#define WPA_OUI 0x0050F201
73
74/* GTK OUI used in vendor specific IE. */
75#define GTK_OUI 0x000FAC01
76
77/* Max PTK key length. */
78#define MAX_PTK_LENGTH 64
79
80/* Max GTK key length. */
81#define MAX_GTK_LENGTH 64
82
83/* KEK offset inside PTK. */
84#define KEK_OFFSET 16
85
86/* TK offset inside PTK. */
87#define TK_OFFSET 32
88
89/* Length of Michael MIC code used in TKIP security suite. */
90#define MIC_LENGTH 8
91
92/*
93 * Length of data to be encrypted by PRF function:
94 * NONCE + SNONCE (2 * 32) + DEST_MAC + SOURCE_MAC (2 * ETH_ADDR)
95 */
96#define PRF_CRYPT_DATA_LENGTH 2*32 + 2*ETH_ADDR
97
98/* Special room in header reserved for encryption. */
99typedef enum {
100 IEEE80211_TKIP_HEADER_LENGTH = 8,
101 IEEE80211_CCMP_HEADER_LENGTH = 8
102} ieee80211_encrypt_header_reserve_length_t;
103
104/** IEEE 802.11 PTK key length. */
105typedef enum {
106 IEEE80211_PTK_CCMP_LENGTH = 48,
107 IEEE80211_PTK_TKIP_LENGTH = 64
108} ieee80211_ptk_length_t;
109
110/** IEEE 802.11 GTK key length. */
111typedef enum {
112 IEEE80211_GTK_CCMP_LENGTH = 16,
113 IEEE80211_GTK_TKIP_LENGTH = 32
114} ieee80211_gtk_length_t;
115
116/** IEEE 802.11 frame types. */
117typedef enum {
118 IEEE80211_MGMT_FRAME = 0x0,
119 IEEE80211_CTRL_FRAME = 0x4,
120 IEEE80211_DATA_FRAME = 0x8,
121 IEEE80211_EXT_FRAME = 0xC
122} ieee80211_frame_type_t;
123
124/** IEEE 802.11 management frame subtypes. */
125typedef enum {
126 IEEE80211_MGMT_ASSOC_REQ_FRAME = 0x00,
127 IEEE80211_MGMT_ASSOC_RESP_FRAME = 0x10,
128 IEEE80211_MGMT_REASSOC_REQ_FRAME = 0x20,
129 IEEE80211_MGMT_REASSOC_RESP_FRAME = 0x30,
130 IEEE80211_MGMT_PROBE_REQ_FRAME = 0x40,
131 IEEE80211_MGMT_PROBE_RESP_FRAME = 0x50,
132 IEEE80211_MGMT_BEACON_FRAME = 0x80,
133 IEEE80211_MGMT_DISASSOC_FRAME = 0xA0,
134 IEEE80211_MGMT_AUTH_FRAME = 0xB0,
135 IEEE80211_MGMT_DEAUTH_FRAME = 0xC0,
136} ieee80211_frame_mgmt_subtype_t;
137
138/** IEEE 802.11 data frame subtypes. */
139typedef enum {
140 IEEE80211_DATA_DATA_FRAME = 0x0000,
141 IEEE80211_DATA_QOS_FRAME = 0x0080
142} ieee80211_frame_data_subtype_t;
143
144/** IEEE 802.11 frame control value masks. */
145typedef enum {
146 IEEE80211_FRAME_CTRL_FRAME_TYPE = 0x000C,
147 IEEE80211_FRAME_CTRL_FRAME_SUBTYPE = 0x00F0,
148 IEEE80211_FRAME_CTRL_PROTECTED = 0x4000
149} ieee80211_frame_ctrl_mask_t;
150
151/** IEEE 802.11 frame control DS field values. */
152typedef enum {
153 IEEE80211_FRAME_CTRL_TODS = 0x0100,
154 IEEE80211_FRAME_CTRL_FROMDS = 0x0200
155} ieee80211_frame_ctrl_ds_t;
156
157/** IEEE 802.11 authentication cipher suites values. */
158typedef enum {
159 IEEE80211_AUTH_CIPHER_TKIP = 0x02,
160 IEEE80211_AUTH_CIPHER_CCMP = 0x04
161} ieee80211_auth_cipher_type_t;
162
163/** IEEE 802.11 AKM suites values. */
164typedef enum {
165 IEEE80211_AUTH_AKM_8021X = 0x01,
166 IEEE80211_AUTH_AKM_PSK = 0x02
167} ieee80211_auth_akm_type_t;
168
169typedef enum {
170 IEEE80211_EAPOL_START = 0x1,
171 IEEE80211_EAPOL_KEY = 0x3
172} ieee80211_eapol_frame_type_t;
173
174typedef enum {
175 IEEE80211_EAPOL_KEY_KEYINFO_KEYTYPE = 0x0008,
176 IEEE80211_EAPOL_KEY_KEYINFO_INSTALL = 0x0040,
177 IEEE80211_EAPOL_KEY_KEYINFO_ACK = 0x0080,
178 IEEE80211_EAPOL_KEY_KEYINFO_MIC = 0x0100,
179 IEEE80211_EAPOL_KEY_KEYINFO_SECURE = 0x0200,
180 IEEE80211_EAPOL_KEY_KEYINFO_ENCDATA = 0x1000
181} ieee80211_eapol_key_keyinfo_t;
182
183/** IEEE 802.11 information element types. */
184typedef enum {
185 IEEE80211_SSID_IE = 0, /**< Target SSID. */
186 IEEE80211_RATES_IE = 1, /**< Supported data rates. */
187 IEEE80211_CHANNEL_IE = 3, /**< Current channel number. */
188 IEEE80211_CHALLENGE_IE = 16, /**< Challenge text. */
189 IEEE80211_RSN_IE = 48, /**< RSN. */
190 IEEE80211_EXT_RATES_IE = 50, /**< Extended data rates. */
191 IEEE80211_VENDOR_IE = 221 /**< Vendor specific IE. */
192} ieee80211_ie_type_t;
193
194/** IEEE 802.11 authentication phases. */
195typedef enum {
196 IEEE80211_AUTH_DISCONNECTED,
197 IEEE80211_AUTH_AUTHENTICATED,
198 IEEE80211_AUTH_ASSOCIATED,
199 IEEE80211_AUTH_CONNECTED
200} ieee80211_auth_phase_t;
201
202/** Link with scan result info. */
203typedef struct {
204 link_t link;
205 time_t last_beacon;
206 ieee80211_scan_result_t scan_result;
207 uint8_t auth_ie[256];
208 size_t auth_ie_len;
209} ieee80211_scan_result_link_t;
210
211/** List of scan results info. */
212typedef struct {
213 list_t list;
214 fibril_mutex_t results_mutex;
215 size_t size;
216} ieee80211_scan_result_list_t;
217
218/** BSSID info. */
219typedef struct {
220 uint16_t aid;
221 char password[IEEE80211_MAX_PASSW_LEN];
222 uint8_t ptk[MAX_PTK_LENGTH];
223 uint8_t gtk[MAX_GTK_LENGTH];
224 ieee80211_scan_result_link_t *res_link;
225} ieee80211_bssid_info_t;
226
227/** IEEE 802.11 WiFi device structure. */
228struct ieee80211_dev {
229 /** Backing DDF device. */
230 ddf_dev_t *ddf_dev;
231
232 /** Pointer to implemented IEEE 802.11 device operations. */
233 ieee80211_ops_t *ops;
234
235 /** Pointer to implemented IEEE 802.11 interface operations. */
236 ieee80211_iface_t *iface;
237
238 /** Pointer to driver specific data. */
239 void *specific;
240
241 /** Current operating frequency. */
242 uint16_t current_freq;
243
244 /** Current operating mode. */
245 ieee80211_operating_mode_t current_op_mode;
246
247 /** Info about BSSID we are connected to. */
248 ieee80211_bssid_info_t bssid_info;
249
250 /**
251 * Flag indicating that data traffic is encrypted by HW key
252 * that is set up in device.
253 */
254 bool using_hw_key;
255
256 /** BSSIDs we listen to. */
257 nic_address_t bssid_mask;
258
259 /** List of APs in neighborhood. */
260 ieee80211_scan_result_list_t ap_list;
261
262 /** Current sequence number used in data frames. */
263 uint16_t sequence_number;
264
265 /** Current authentication phase. */
266 ieee80211_auth_phase_t current_auth_phase;
267
268 /** Flag indicating whether client wants connect to network. */
269 bool pending_conn_req;
270
271 /** Scanning guard. */
272 fibril_mutex_t scan_mutex;
273
274 /** General purpose guard. */
275 fibril_mutex_t gen_mutex;
276
277 /** General purpose condition variable. */
278 fibril_condvar_t gen_cond;
279
280 /** Indicates whether device is fully initialized. */
281 bool ready;
282
283 /** Indicates whether driver has already started. */
284 bool started;
285};
286
287/** IEEE 802.3 (ethernet) header. */
288typedef struct {
289 uint8_t dest_addr[ETH_ADDR];
290 uint8_t src_addr[ETH_ADDR];
291 uint16_t proto; /**< Big Endian value! */
292} __attribute__((packed)) __attribute__ ((aligned(2)))
293 eth_header_t;
294
295/** IEEE 802.11 management header structure. */
296typedef struct {
297 uint16_t frame_ctrl; /**< Little Endian value! */
298 uint16_t duration_id; /**< Little Endian value! */
299 uint8_t dest_addr[ETH_ADDR];
300 uint8_t src_addr[ETH_ADDR];
301 uint8_t bssid[ETH_ADDR];
302 uint16_t seq_ctrl; /**< Little Endian value! */
303} __attribute__((packed)) __attribute__ ((aligned(2)))
304 ieee80211_mgmt_header_t;
305
306/** IEEE 802.11 data header structure. */
307typedef struct {
308 uint16_t frame_ctrl; /**< Little Endian value! */
309 uint16_t duration_id; /**< Little Endian value! */
310 uint8_t address1[ETH_ADDR];
311 uint8_t address2[ETH_ADDR];
312 uint8_t address3[ETH_ADDR];
313 uint16_t seq_ctrl; /**< Little Endian value! */
314} __attribute__((packed)) __attribute__ ((aligned(2)))
315 ieee80211_data_header_t;
316
317/** IEEE 802.11 information element header. */
318typedef struct {
319 uint8_t element_id;
320 uint8_t length;
321} __attribute__((packed)) __attribute__ ((aligned(2)))
322 ieee80211_ie_header_t;
323
324/** IEEE 802.11 authentication frame body. */
325typedef struct {
326 uint16_t auth_alg; /**< Little Endian value! */
327 uint16_t auth_trans_no; /**< Little Endian value! */
328 uint16_t status; /**< Little Endian value! */
329} __attribute__((packed)) __attribute__ ((aligned(2)))
330 ieee80211_auth_body_t;
331
332/** IEEE 802.11 deauthentication frame body. */
333typedef struct {
334 uint16_t reason; /**< Little Endian value! */
335} __attribute__((packed)) __attribute__ ((aligned(2)))
336 ieee80211_deauth_body_t;
337
338/** IEEE 802.11 association request frame body. */
339typedef struct {
340 uint16_t capability; /**< Little Endian value! */
341 uint16_t listen_interval; /**< Little Endian value! */
342} __attribute__((packed)) __attribute__ ((aligned(2)))
343 ieee80211_assoc_req_body_t;
344
345/** IEEE 802.11 association response frame body. */
346typedef struct {
347 uint16_t capability; /**< Little Endian value! */
348 uint16_t status; /**< Little Endian value! */
349 uint16_t aid; /**< Little Endian value! */
350} __attribute__((packed)) __attribute__ ((aligned(2)))
351 ieee80211_assoc_resp_body_t;
352
353/** IEEE 802.11 beacon frame body start. */
354typedef struct {
355 uint8_t timestamp[8];
356 uint16_t beacon_interval; /**< Little Endian value! */
357 uint16_t capability; /**< Little Endian value! */
358} __attribute__((packed)) __attribute__ ((aligned(2)))
359 ieee80211_beacon_start_t;
360
361/** IEEE 802.11i EAPOL-Key frame format. */
362typedef struct {
363 uint8_t proto_version;
364 uint8_t packet_type;
365 uint16_t body_length; /**< Big Endian value! */
366 uint8_t descriptor_type;
367 uint16_t key_info; /**< Big Endian value! */
368 uint16_t key_length; /**< Big Endian value! */
369 uint8_t key_replay_counter[8];
370 uint8_t key_nonce[32];
371 uint8_t eapol_key_iv[16];
372 uint8_t key_rsc[8];
373 uint8_t reserved[8];
374 uint8_t key_mic[16];
375 uint16_t key_data_length; /**< Big Endian value! */
376} __attribute__((packed)) ieee80211_eapol_key_frame_t;
377
378#define ieee80211_scan_result_list_foreach(results, iter) \
379 list_foreach((results).list, link, ieee80211_scan_result_link_t, (iter))
380
381static inline void ieee80211_scan_result_list_init(
382 ieee80211_scan_result_list_t *results)
383{
384 list_initialize(&results->list);
385 fibril_mutex_initialize(&results->results_mutex);
386}
387
388static inline void ieee80211_scan_result_list_remove(
389 ieee80211_scan_result_list_t *results,
390 ieee80211_scan_result_link_t *result)
391{
392 list_remove(&result->link);
393 results->size--;
394}
395
396static inline void ieee80211_scan_result_list_append(
397 ieee80211_scan_result_list_t *results,
398 ieee80211_scan_result_link_t *result)
399{
400 list_append(&result->link, &results->list);
401 results->size++;
402}
403
404extern bool ieee80211_is_fromds_frame(uint16_t frame_ctrl);
405extern bool ieee80211_is_tods_frame(uint16_t frame_ctrl);
406extern void ieee80211_set_connect_request(ieee80211_dev_t *ieee80211_dev);
407extern bool ieee80211_pending_connect_request(ieee80211_dev_t *ieee80211_dev);
408extern ieee80211_auth_phase_t ieee80211_get_auth_phase(ieee80211_dev_t
409 *ieee80211_dev);
410extern void ieee80211_set_auth_phase(ieee80211_dev_t *ieee80211_dev,
411 ieee80211_auth_phase_t auth_phase);
412extern int ieee80211_probe_request(ieee80211_dev_t *ieee80211_dev,
413 char *ssid);
414extern int ieee80211_authenticate(ieee80211_dev_t *ieee80211_dev);
415extern int ieee80211_associate(ieee80211_dev_t *ieee80211_dev,
416 char *password);
417extern int ieee80211_deauthenticate(ieee80211_dev_t *ieee80211_dev);
418
419#endif /* LIBN_IEEE80211_H */
420
421/** @}
422 */
Note: See TracBrowser for help on using the repository browser.