src/wps/wps.h

   1 /*
   2  * Wi-Fi Protected Setup
   3  * Copyright (c) 2007-2008, Jouni Malinen <j@w1.fi>
   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 version 2 as
   7  * published by the Free Software Foundation.
   8  *
   9  * Alternatively, this software may be distributed under the terms of BSD
  10  * license.
  11  *
  12  * See README and COPYING for more details.
  13  */
  14
  15 #ifndef WPS_H
  16 #define WPS_H
  17
  18 #include "wps_defs.h"
  19
  20 /**
  21  * enum wsc_op_code - EAP-WSC OP-Code values
  22  */
  23 enum wsc_op_code {
  24         WSC_Start = 0x01,
  25         WSC_ACK = 0x02,
  26         WSC_NACK = 0x03,
  27         WSC_MSG = 0x04,
  28         WSC_Done = 0x05,
  29         WSC_FRAG_ACK = 0x06
  30 };
  31
  32 struct wps_registrar;
  33
  34 /**
  35  * struct wps_credential - WPS Credential
  36  * @ssid: SSID
  37  * @ssid_len: Length of SSID
  38  * @auth_type: Authentication Type (WPS_AUTH_OPEN, .. flags)
  39  * @encr_type: Encryption Type (WPS_ENCR_NONE, .. flags)
  40  * @key_idx: Key index
  41  * @key: Key
  42  * @key_len: Key length in octets
  43  * @mac_addr: MAC address of the peer
  44  */
  45 struct wps_credential {
  46         u8 ssid[32];
  47         size_t ssid_len;
  48         u16 auth_type;
  49         u16 encr_type;
  50         u8 key_idx;
  51         u8 key[64];
  52         size_t key_len;
  53         u8 mac_addr[ETH_ALEN];
  54 };
  55
  56 /**
  57  * struct wps_device_data - WPS Device Data
  58  * @mac_addr: Device MAC address
  59  * @device_name: Device Name (0..32 octets encoded in UTF-8)
  60  * @manufacturer: Manufacturer (0..64 octets encoded in UTF-8)
  61  * @model_name: Model Name (0..32 octets encoded in UTF-8)
  62  * @model_number: Model Number (0..32 octets encoded in UTF-8)
  63  * @serial_number: Serial Number (0..32 octets encoded in UTF-8)
  64  * @categ: Primary Device Category
  65  * @oui: Primary Device OUI
  66  * @sub_categ: Primary Device Sub-Category
  67  * @os_version: OS Version
  68  * @rf_bands: RF bands (WPS_RF_24GHZ, WPS_RF_50GHZ flags)
  69  */
  70 struct wps_device_data {
  71         u8 mac_addr[ETH_ALEN];
  72         char *device_name;
  73         char *manufacturer;
  74         char *model_name;
  75         char *model_number;
  76         char *serial_number;
  77         u16 categ;
  78         u32 oui;
  79         u16 sub_categ;
  80         u32 os_version;
  81         u8 rf_bands;
  82 };
  83
  84 /**
  85  * struct wps_config - WPS configuration for a single registration protocol run
  86  */
  87 struct wps_config {
  88         /**
  89          * wps - Pointer to long term WPS context
  90          */
  91         struct wps_context *wps;
  92
  93         /**
  94          * registrar - Whether this end is a Registrar
  95          */
  96         int registrar;
  97
  98         /**
  99          * pin - Enrollee Device Password (%NULL for Registrar or PBC)
 100          */
 101         const u8 *pin;
 102
 103         /**
 104          * pin_len - Length on pin in octets
 105          */
 106         size_t pin_len;
 107
 108         /**
 109          * pbc - Whether this is protocol run uses PBC
 110          */
 111         int pbc;
 112
 113         /**
 114          * assoc_wps_ie: (Re)AssocReq WPS IE (in AP; %NULL if not AP)
 115          */
 116         const struct wpabuf *assoc_wps_ie;
 117 };
 118
 119 struct wps_data * wps_init(const struct wps_config *cfg);
 120
 121 void wps_deinit(struct wps_data *data);
 122
 123 /**
 124  * enum wps_process_res - WPS message processing result
 125  */
 126 enum wps_process_res {
 127         /**
 128          * WPS_DONE - Processing done
 129          */
 130         WPS_DONE,
 131
 132         /**
 133          * WPS_CONTINUE - Processing continues
 134          */
 135         WPS_CONTINUE,
 136
 137         /**
 138          * WPS_FAILURE - Processing failed
 139          */
 140         WPS_FAILURE
 141 };
 142 enum wps_process_res wps_process_msg(struct wps_data *wps,
 143                                      enum wsc_op_code op_code,
 144                                      const struct wpabuf *msg);
 145
 146 struct wpabuf * wps_get_msg(struct wps_data *wps, enum wsc_op_code *op_code);
 147
 148 int wps_is_selected_pbc_registrar(const struct wpabuf *msg);
 149 int wps_is_selected_pin_registrar(const struct wpabuf *msg);
 150 const u8 * wps_get_uuid_e(const struct wpabuf *msg);
 151
 152 struct wpabuf * wps_build_assoc_req_ie(enum wps_request_type req_type);
 153 struct wpabuf * wps_build_probe_req_ie(int pbc, struct wps_device_data *dev,
 154                                        const u8 *uuid,
 155                                        enum wps_request_type req_type);
 156
 157
 158 /**
 159  * struct wps_registrar_config - WPS Registrar configuration
 160  */
 161 struct wps_registrar_config {
 162         /**
 163          * new_psk_cb - Callback for new PSK
 164          * @ctx: Higher layer context data (cb_ctx)
 165          * @mac_addr: MAC address of the Enrollee
 166          * @psk: The new PSK
 167          * @psk_len: The length of psk in octets
 168          * Returns: 0 on success, -1 on failure
 169          *
 170          * This callback is called when a new per-device PSK is provisioned.
 171          */
 172         int (*new_psk_cb)(void *ctx, const u8 *mac_addr, const u8 *psk,
 173                           size_t psk_len);
 174
 175         /**
 176          * set_ie_cb - Callback for WPS IE changes
 177          * @ctx: Higher layer context data (cb_ctx)
 178          * @beacon_ie: WPS IE for Beacon
 179          * @beacon_ie_len: WPS IE length for Beacon
 180          * @probe_resp_ie: WPS IE for Probe Response
 181          * @probe_resp_ie_len: WPS IE length for Probe Response
 182          * Returns: 0 on success, -1 on failure
 183          *
 184          * This callback is called whenever the WPS IE in Beacon or Probe
 185          * Response frames needs to be changed (AP only).
 186          */
 187         int (*set_ie_cb)(void *ctx, const u8 *beacon_ie, size_t beacon_ie_len,
 188                          const u8 *probe_resp_ie, size_t probe_resp_ie_len);
 189
 190         /**
 191          * pin_needed_cb - Callback for requesting a PIN
 192          * @ctx: Higher layer context data (cb_ctx)
 193          * @uuid_e: UUID-E of the unknown Enrollee
 194          * @dev: Device Data from the unknown Enrollee
 195          *
 196          * This callback is called whenever an unknown Enrollee requests to use
 197          * PIN method and a matching PIN (Device Password) is not found in
 198          * Registrar data.
 199          */
 200         void (*pin_needed_cb)(void *ctx, const u8 *uuid_e,
 201                               const struct wps_device_data *dev);
 202
 203         /**
 204          * cb_ctx: Higher layer context data for Registrar callbacks
 205          */
 206         void *cb_ctx;
 207 };
 208
 209
 210 /**
 211  * enum wps_event - WPS event types
 212  */
 213 enum wps_event {
 214         /**
 215          * WPS_EV_M2D - M2D received (Registrar did not know us)
 216          */
 217         WPS_EV_M2D,
 218
 219         /**
 220          * WPS_EV_FAIL - Registration failed
 221          */
 222         WPS_EV_FAIL,
 223
 224         /**
 225          * WPS_EV_SUCCESS - Registration succeeded
 226          */
 227         WPS_EV_SUCCESS
 228 };
 229
 230 /**
 231  * union wps_event_data - WPS event data
 232  */
 233 union wps_event_data {
 234         /**
 235          * struct wps_event_m2d - M2D event data
 236          */
 237         struct wps_event_m2d {
 238                 u16 config_methods;
 239                 const u8 *manufacturer;
 240                 size_t manufacturer_len;
 241                 const u8 *model_name;
 242                 size_t model_name_len;
 243                 const u8 *model_number;
 244                 size_t model_number_len;
 245                 const u8 *serial_number;
 246                 size_t serial_number_len;
 247                 const u8 *dev_name;
 248                 size_t dev_name_len;
 249                 const u8 *primary_dev_type; /* 8 octets */
 250                 u16 config_error;
 251                 u16 dev_password_id;
 252         } m2d;
 253
 254         /**
 255          * struct wps_event_fail - Registration failure information
 256          * @msg: enum wps_msg_type
 257          */
 258         struct wps_event_fail {
 259                 int msg;
 260         } fail;
 261 };
 262
 263 /**
 264  * struct wps_context - Long term WPS context data
 265  *
 266  * This data is stored at the higher layer Authenticator or Supplicant data
 267  * structures and it is maintained over multiple registration protocol runs.
 268  */
 269 struct wps_context {
 270         /**
 271          * ap - Whether the local end is an access point
 272          */
 273         int ap;
 274
 275         /**
 276          * registrar - Pointer to WPS registrar data from wps_registrar_init()
 277          */
 278         struct wps_registrar *registrar;
 279
 280         /**
 281          * wps_state - Current WPS state
 282          */
 283         enum wps_state wps_state;
 284
 285         /**
 286          * ap_setup_locked - Whether AP setup is locked (only used at AP)
 287          */
 288         int ap_setup_locked;
 289
 290         /**
 291          * uuid - Own UUID
 292          */
 293         u8 uuid[16];
 294
 295         /**
 296          * ssid - SSID
 297          *
 298          * This SSID is used by the Registrar to fill in information for
 299          * Credentials. In addition, AP uses it when acting as an Enrollee to
 300          * notify Registrar of the current configuration.
 301          */
 302         u8 ssid[32];
 303
 304         /**
 305          * ssid_len - Length of ssid in octets
 306          */
 307         size_t ssid_len;
 308
 309         /**
 310          * dev - Own WPS device data
 311          */
 312         struct wps_device_data dev;
 313
 314         /**
 315          * config_methods - Enabled configuration methods
 316          *
 317          * Bit field of WPS_CONFIG_*
 318          */
 319         u16 config_methods;
 320
 321         /**
 322          * encr_types - Enabled encryption types (bit field of WPS_ENCR_*)
 323          */
 324         u16 encr_types;
 325
 326         /**
 327          * auth_types - Authentication types (bit field of WPS_AUTH_*)
 328          */
 329         u16 auth_types;
 330
 331         /**
 332          * network_key - The current Network Key (PSK) or %NULL to generate new
 333          *
 334          * If %NULL, Registrar will generate per-device PSK. In addition, AP
 335          * uses this when acting as an Enrollee to notify Registrar of the
 336          * current configuration.
 337          */
 338         u8 *network_key;
 339
 340         /**
 341          * network_key_len - Length of network_key in octets
 342          */
 343         size_t network_key_len;
 344
 345         /**
 346          * cred_cb - Callback to notify that new Credentials were received
 347          * @ctx: Higher layer context data (cb_ctx)
 348          * @cred: The received Credential
 349          * Return: 0 on success, -1 on failure
 350          */
 351         int (*cred_cb)(void *ctx, const struct wps_credential *cred);
 352
 353         /**
 354          * event_cb - Event callback (state information about progress)
 355          * @ctx: Higher layer context data (cb_ctx)
 356          * @event: Event type
 357          * @data: Event data
 358          */
 359         void (*event_cb)(void *ctx, enum wps_event event,
 360                          union wps_event_data *data);
 361
 362         /**
 363          * cb_ctx: Higher layer context data for callbacks
 364          */
 365         void *cb_ctx;
 366 };
 367
 368
 369 struct wps_registrar *
 370 wps_registrar_init(struct wps_context *wps,
 371                    const struct wps_registrar_config *cfg);
 372 void wps_registrar_deinit(struct wps_registrar *reg);
 373 int wps_registrar_add_pin(struct wps_registrar *reg, const u8 *uuid,
 374                           const u8 *pin, size_t pin_len);
 375 int wps_registrar_invalidate_pin(struct wps_registrar *reg, const u8 *uuid);
 376 int wps_registrar_unlock_pin(struct wps_registrar *reg, const u8 *uuid);
 377 int wps_registrar_button_pushed(struct wps_registrar *reg);
 378 void wps_registrar_probe_req_rx(struct wps_registrar *reg, const u8 *addr,
 379                                 const struct wpabuf *wps_data);
 380
 381 unsigned int wps_pin_checksum(unsigned int pin);
 382 unsigned int wps_pin_valid(unsigned int pin);
 383 unsigned int wps_generate_pin(void);
 384
 385 #endif /* WPS_H */