uspace/lib/ieee80211/include/ieee80211_private.h

   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 LIB_IEEE80211_PRIVATE_H
  40 #define LIB_IEEE80211_PRIVATE_H
  41
  42 #include <fibril_synch.h>
  43 #include <byteorder.h>
  44 #include <ddf/driver.h>
  45 #include <stddef.h>
  46 #include <stdint.h>
  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 /** Length of data to be encrypted by PRF function.
  93  *
  94  * NONCE + SNONCE (2 * 32) + DEST_MAC + SOURCE_MAC (2 * ETH_ADDR)
  95  *
  96  */
  97 #define PRF_CRYPT_DATA_LENGTH  (2 * 32 + 2 * ETH_ADDR)
  98
  99 /** Special room in header reserved for encryption. */
 100 #define IEEE80211_TKIP_HEADER_LENGTH 8
 101 #define IEEE80211_CCMP_HEADER_LENGTH 8
 102 /* Maximum of the above. */
 103 #define IEEE80211_MAX_HEADER_LENGTH 8
 104
 105 /** IEEE 802.11 PTK key length. */
 106 #define IEEE80211_PTK_CCMP_LENGTH 48
 107 #define IEEE80211_PTK_TKIP_LENGTH 64
 108
 109 /** IEEE 802.11 GTK key length. */
 110 #define IEEE80211_GTK_CCMP_LENGTH 16
 111 #define IEEE80211_GTK_TKIP_LENGTH 32
 112
 113 /** IEEE 802.11 frame types. */
 114 typedef enum {
 115         IEEE80211_MGMT_FRAME = 0x0,
 116         IEEE80211_CTRL_FRAME = 0x4,
 117         IEEE80211_DATA_FRAME = 0x8,
 118         IEEE80211_EXT_FRAME = 0xC
 119 } ieee80211_frame_type_t;
 120
 121 /** IEEE 802.11 management frame subtypes. */
 122 typedef enum {
 123         IEEE80211_MGMT_ASSOC_REQ_FRAME = 0x00,
 124         IEEE80211_MGMT_ASSOC_RESP_FRAME = 0x10,
 125         IEEE80211_MGMT_REASSOC_REQ_FRAME = 0x20,
 126         IEEE80211_MGMT_REASSOC_RESP_FRAME = 0x30,
 127         IEEE80211_MGMT_PROBE_REQ_FRAME = 0x40,
 128         IEEE80211_MGMT_PROBE_RESP_FRAME = 0x50,
 129         IEEE80211_MGMT_BEACON_FRAME = 0x80,
 130         IEEE80211_MGMT_DISASSOC_FRAME = 0xA0,
 131         IEEE80211_MGMT_AUTH_FRAME = 0xB0,
 132         IEEE80211_MGMT_DEAUTH_FRAME = 0xC0,
 133 } ieee80211_frame_mgmt_subtype_t;
 134
 135 /** IEEE 802.11 data frame subtypes. */
 136 typedef enum {
 137         IEEE80211_DATA_DATA_FRAME = 0x0000,
 138         IEEE80211_DATA_QOS_FRAME = 0x0080
 139 } ieee80211_frame_data_subtype_t;
 140
 141 /** IEEE 802.11 frame control value masks. */
 142 typedef enum {
 143         IEEE80211_FRAME_CTRL_FRAME_TYPE = 0x000C,
 144         IEEE80211_FRAME_CTRL_FRAME_SUBTYPE = 0x00F0,
 145         IEEE80211_FRAME_CTRL_PROTECTED = 0x4000
 146 } ieee80211_frame_ctrl_mask_t;
 147
 148 /** IEEE 802.11 frame control DS field values. */
 149 typedef enum {
 150         IEEE80211_FRAME_CTRL_TODS = 0x0100,
 151         IEEE80211_FRAME_CTRL_FROMDS = 0x0200
 152 } ieee80211_frame_ctrl_ds_t;
 153
 154 /** IEEE 802.11 authentication cipher suites values. */
 155 typedef enum {
 156         IEEE80211_AUTH_CIPHER_TKIP = 0x02,
 157         IEEE80211_AUTH_CIPHER_CCMP = 0x04
 158 } ieee80211_auth_cipher_type_t;
 159
 160 /** IEEE 802.11 AKM suites values. */
 161 typedef enum {
 162         IEEE80211_AUTH_AKM_8021X = 0x01,
 163         IEEE80211_AUTH_AKM_PSK = 0x02
 164 } ieee80211_auth_akm_type_t;
 165
 166 typedef enum {
 167         IEEE80211_EAPOL_START = 0x1,
 168         IEEE80211_EAPOL_KEY = 0x3
 169 } ieee80211_eapol_frame_type_t;
 170
 171 typedef enum {
 172         IEEE80211_EAPOL_KEY_KEYINFO_KEYTYPE = 0x0008,
 173         IEEE80211_EAPOL_KEY_KEYINFO_KEYID = 0x0010,
 174         IEEE80211_EAPOL_KEY_KEYINFO_INSTALL = 0x0040,
 175         IEEE80211_EAPOL_KEY_KEYINFO_ACK = 0x0080,
 176         IEEE80211_EAPOL_KEY_KEYINFO_MIC = 0x0100,
 177         IEEE80211_EAPOL_KEY_KEYINFO_SECURE = 0x0200,
 178         IEEE80211_EAPOL_KEY_KEYINFO_ENCDATA = 0x1000
 179 } ieee80211_eapol_key_keyinfo_t;
 180
 181 /** IEEE 802.11 information element types. */
 182 typedef enum {
 183         IEEE80211_SSID_IE = 0,        /**< Target SSID. */
 184         IEEE80211_RATES_IE = 1,       /**< Supported data rates. */
 185         IEEE80211_CHANNEL_IE = 3,     /**< Current channel number. */
 186         IEEE80211_CHALLENGE_IE = 16,  /**< Challenge text. */
 187         IEEE80211_RSN_IE = 48,        /**< RSN. */
 188         IEEE80211_EXT_RATES_IE = 50,  /**< Extended data rates. */
 189         IEEE80211_VENDOR_IE = 221     /**< Vendor specific IE. */
 190 } ieee80211_ie_type_t;
 191
 192 /** IEEE 802.11 authentication phases. */
 193 typedef enum {
 194         IEEE80211_AUTH_DISCONNECTED,
 195         IEEE80211_AUTH_AUTHENTICATED,
 196         IEEE80211_AUTH_ASSOCIATED,
 197         IEEE80211_AUTH_CONNECTED
 198 } ieee80211_auth_phase_t;
 199
 200 /** Link with scan result info. */
 201 typedef struct {
 202         link_t link;
 203         time_t last_beacon;
 204         ieee80211_scan_result_t scan_result;
 205         uint8_t auth_ie[256];
 206         size_t auth_ie_len;
 207 } ieee80211_scan_result_link_t;
 208
 209 /** List of scan results info. */
 210 typedef struct {
 211         list_t list;
 212         fibril_mutex_t results_mutex;
 213         size_t size;
 214 } ieee80211_scan_result_list_t;
 215
 216 /** BSSID info. */
 217 typedef struct {
 218         uint16_t aid;
 219         char password[IEEE80211_MAX_PASSW_LEN];
 220         uint8_t ptk[MAX_PTK_LENGTH];
 221         uint8_t gtk[MAX_GTK_LENGTH];
 222         ieee80211_scan_result_link_t *res_link;
 223 } ieee80211_bssid_info_t;
 224
 225 /** IEEE 802.11 WiFi device structure. */
 226 struct ieee80211_dev {
 227         /** Backing DDF device. */
 228         ddf_dev_t *ddf_dev;
 229
 230         /** Pointer to implemented IEEE 802.11 device operations. */
 231         ieee80211_ops_t *ops;
 232
 233         /** Pointer to implemented IEEE 802.11 interface operations. */
 234         ieee80211_iface_t *iface;
 235
 236         /** Pointer to driver specific data. */
 237         void *specific;
 238
 239         /** Current operating frequency. */
 240         uint16_t current_freq;
 241
 242         /** Current operating mode. */
 243         ieee80211_operating_mode_t current_op_mode;
 244
 245         /** Info about BSSID we are connected to. */
 246         ieee80211_bssid_info_t bssid_info;
 247
 248         /**
 249          * Flag indicating that data traffic is encrypted by HW key
 250          * that is set up in device.
 251          */
 252         bool using_hw_key;
 253
 254         /** BSSIDs we listen to. */
 255         nic_address_t bssid_mask;
 256
 257         /** List of APs in neighborhood. */
 258         ieee80211_scan_result_list_t ap_list;
 259
 260         /** Current sequence number used in data frames. */
 261         uint16_t sequence_number;
 262
 263         /** Current authentication phase. */
 264         ieee80211_auth_phase_t current_auth_phase;
 265
 266         /** Flag indicating whether client wants connect to network. */
 267         bool pending_conn_req;
 268
 269         /** Scanning guard. */
 270         fibril_mutex_t scan_mutex;
 271
 272         /** General purpose guard. */
 273         fibril_mutex_t gen_mutex;
 274
 275         /** General purpose condition variable. */
 276         fibril_condvar_t gen_cond;
 277
 278         /** Indicates whether device is fully initialized. */
 279         bool ready;
 280
 281         /** Indicates whether driver has already started. */
 282         bool started;
 283 };
 284
 285 /** IEEE 802.3 (ethernet) header. */
 286 typedef struct {
 287         uint8_t dest_addr[ETH_ADDR];
 288         uint8_t src_addr[ETH_ADDR];
 289         uint16_t proto;  /**< Big Endian value! */
 290 } __attribute__((packed)) __attribute__((aligned(2)))
 291     eth_header_t;
 292
 293 /** IEEE 802.11 management header structure. */
 294 typedef struct {
 295         uint16_t frame_ctrl;          /**< Little Endian value! */
 296         uint16_t duration_id;         /**< Little Endian value! */
 297         uint8_t dest_addr[ETH_ADDR];
 298         uint8_t src_addr[ETH_ADDR];
 299         uint8_t bssid[ETH_ADDR];
 300         uint16_t seq_ctrl;            /**< Little Endian value! */
 301 } __attribute__((packed)) __attribute__((aligned(2)))
 302     ieee80211_mgmt_header_t;
 303
 304 /** IEEE 802.11 data header structure. */
 305 typedef struct {
 306         uint16_t frame_ctrl;         /**< Little Endian value! */
 307         uint16_t duration_id;        /**< Little Endian value! */
 308         uint8_t address1[ETH_ADDR];
 309         uint8_t address2[ETH_ADDR];
 310         uint8_t address3[ETH_ADDR];
 311         uint16_t seq_ctrl;           /**< Little Endian value! */
 312 } __attribute__((packed)) __attribute__((aligned(2)))
 313     ieee80211_data_header_t;
 314
 315 /** IEEE 802.11 information element header. */
 316 typedef struct {
 317         uint8_t element_id;
 318         uint8_t length;
 319 } __attribute__((packed)) __attribute__((aligned(2)))
 320     ieee80211_ie_header_t;
 321
 322 /** IEEE 802.11 authentication frame body. */
 323 typedef struct {
 324         uint16_t auth_alg;       /**< Little Endian value! */
 325         uint16_t auth_trans_no;  /**< Little Endian value! */
 326         uint16_t status;         /**< Little Endian value! */
 327 } __attribute__((packed)) __attribute__((aligned(2)))
 328     ieee80211_auth_body_t;
 329
 330 /** IEEE 802.11 deauthentication frame body. */
 331 typedef struct {
 332         uint16_t reason;    /**< Little Endian value! */
 333 } __attribute__((packed)) __attribute__((aligned(2)))
 334     ieee80211_deauth_body_t;
 335
 336 /** IEEE 802.11 association request frame body. */
 337 typedef struct {
 338         uint16_t capability;       /**< Little Endian value! */
 339         uint16_t listen_interval;  /**< Little Endian value! */
 340 } __attribute__((packed)) __attribute__((aligned(2)))
 341     ieee80211_assoc_req_body_t;
 342
 343 /** IEEE 802.11 association response frame body. */
 344 typedef struct {
 345         uint16_t capability;  /**< Little Endian value! */
 346         uint16_t status;      /**< Little Endian value! */
 347         uint16_t aid;         /**< Little Endian value! */
 348 } __attribute__((packed)) __attribute__((aligned(2)))
 349     ieee80211_assoc_resp_body_t;
 350
 351 /** IEEE 802.11 beacon frame body start. */
 352 typedef struct {
 353         uint8_t timestamp[8];
 354         uint16_t beacon_interval;  /**< Little Endian value! */
 355         uint16_t capability;       /**< Little Endian value! */
 356 } __attribute__((packed)) __attribute__((aligned(2)))
 357     ieee80211_beacon_start_t;
 358
 359 /** IEEE 802.11i EAPOL-Key frame format. */
 360 typedef struct {
 361         uint8_t proto_version;
 362         uint8_t packet_type;
 363         uint16_t body_length;      /**< Big Endian value! */
 364         uint8_t descriptor_type;
 365         uint16_t key_info;         /**< Big Endian value! */
 366         uint16_t key_length;       /**< Big Endian value! */
 367         uint8_t key_replay_counter[8];
 368         uint8_t key_nonce[32];
 369         uint8_t eapol_key_iv[16];
 370         uint8_t key_rsc[8];
 371         uint8_t reserved[8];
 372         uint8_t key_mic[16];
 373         uint16_t key_data_length;  /**< Big Endian value! */
 374 } __attribute__((packed)) ieee80211_eapol_key_frame_t;
 375
 376 #define ieee80211_scan_result_list_foreach(results, iter) \
 377         list_foreach((results).list, link, ieee80211_scan_result_link_t, (iter))
 378
 379 static inline void
 380 ieee80211_scan_result_list_init(ieee80211_scan_result_list_t *results)
 381 {
 382         list_initialize(&results->list);
 383         fibril_mutex_initialize(&results->results_mutex);
 384 }
 385
 386 static inline void
 387 ieee80211_scan_result_list_remove(ieee80211_scan_result_list_t *results,
 388     ieee80211_scan_result_link_t *result)
 389 {
 390         list_remove(&result->link);
 391         results->size--;
 392 }
 393
 394 static inline void
 395 ieee80211_scan_result_list_append(ieee80211_scan_result_list_t *results,
 396     ieee80211_scan_result_link_t *result)
 397 {
 398         list_append(&result->link, &results->list);
 399         results->size++;
 400 }
 401
 402 extern bool ieee80211_is_fromds_frame(uint16_t);
 403 extern bool ieee80211_is_tods_frame(uint16_t);
 404 extern void ieee80211_set_connect_request(ieee80211_dev_t *);
 405 extern bool ieee80211_pending_connect_request(ieee80211_dev_t *);
 406 extern ieee80211_auth_phase_t ieee80211_get_auth_phase(ieee80211_dev_t *);
 407 extern void ieee80211_set_auth_phase(ieee80211_dev_t *, ieee80211_auth_phase_t);
 408 extern errno_t ieee80211_probe_request(ieee80211_dev_t *, char *);
 409 extern errno_t ieee80211_authenticate(ieee80211_dev_t *);
 410 extern errno_t ieee80211_associate(ieee80211_dev_t *, char *);
 411 extern errno_t ieee80211_deauthenticate(ieee80211_dev_t *);
 412
 413 #endif
 414
 415 /** @}
 416  */