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          * authenticator - Whether the local end is Authenticator
  90          * 1 = Authenticator, 0 = Supplicant
  91          */
  92         int authenticator;
  93
  94         /**
  95          * wps - Pointer to long term WPS context
  96          */
  97         struct wps_context *wps;
  98
  99         /**
 100          * registrar - Pointer to WPS registrar data from wps_registrar_init()
 101          * This is only used if the local end is Registrar; set to %NULL for
 102          * Enrollee.
 103          */
 104         struct wps_registrar *registrar;
 105
 106         /**
 107          * pin - Enrollee Device Password (%NULL for Registrar or PBC)
 108          */
 109         const u8 *pin;
 110
 111         /**
 112          * pin_len - Length on pin in octets
 113          */
 114         size_t pin_len;
 115
 116         /**
 117          * pbc - Whether this is protocol run uses PBC
 118          */
 119         int pbc;
 120
 121         /**
 122          * assoc_wps_ie: (Re)AssocReq WPS IE (in AP; %NULL if not AP)
 123          */
 124         const struct wpabuf *assoc_wps_ie;
 125 };
 126
 127 struct wps_data * wps_init(const struct wps_config *cfg);
 128
 129 void wps_deinit(struct wps_data *data);
 130
 131 /**
 132  * enum wps_process_res - WPS message processing result
 133  */
 134 enum wps_process_res {
 135         /**
 136          * WPS_DONE - Processing done
 137          */
 138         WPS_DONE,
 139
 140         /**
 141          * WPS_CONTINUE - Processing continues
 142          */
 143         WPS_CONTINUE,
 144
 145         /**
 146          * WPS_FAILURE - Processing failed
 147          */
 148         WPS_FAILURE
 149 };
 150 enum wps_process_res wps_process_msg(struct wps_data *wps,
 151                                      enum wsc_op_code op_code,
 152                                      const struct wpabuf *msg);
 153
 154 struct wpabuf * wps_get_msg(struct wps_data *wps, enum wsc_op_code *op_code);
 155
 156 int wps_is_selected_pbc_registrar(const struct wpabuf *msg);
 157 int wps_is_selected_pin_registrar(const struct wpabuf *msg);
 158 const u8 * wps_get_uuid_e(const struct wpabuf *msg);
 159
 160 struct wpabuf * wps_build_assoc_req_ie(enum wps_request_type req_type);
 161 struct wpabuf * wps_build_probe_req_ie(int pbc, struct wps_device_data *dev,
 162                                        const u8 *uuid,
 163                                        enum wps_request_type req_type);
 164
 165
 166 /**
 167  * struct wps_registrar_config - WPS Registrar configuration
 168  */
 169 struct wps_registrar_config {
 170         /**
 171          * new_psk_cb - Callback for new PSK
 172          * @ctx: Higher layer context data (cb_ctx)
 173          * @mac_addr: MAC address of the Enrollee
 174          * @psk: The new PSK
 175          * @psk_len: The length of psk in octets
 176          * Returns: 0 on success, -1 on failure
 177          *
 178          * This callback is called when a new per-device PSK is provisioned.
 179          */
 180         int (*new_psk_cb)(void *ctx, const u8 *mac_addr, const u8 *psk,
 181                           size_t psk_len);
 182
 183         /**
 184          * set_ie_cb - Callback for WPS IE changes
 185          * @ctx: Higher layer context data (cb_ctx)
 186          * @beacon_ie: WPS IE for Beacon
 187          * @beacon_ie_len: WPS IE length for Beacon
 188          * @probe_resp_ie: WPS IE for Probe Response
 189          * @probe_resp_ie_len: WPS IE length for Probe Response
 190          * Returns: 0 on success, -1 on failure
 191          *
 192          * This callback is called whenever the WPS IE in Beacon or Probe
 193          * Response frames needs to be changed (AP only).
 194          */
 195         int (*set_ie_cb)(void *ctx, const u8 *beacon_ie, size_t beacon_ie_len,
 196                          const u8 *probe_resp_ie, size_t probe_resp_ie_len);
 197
 198         /**
 199          * pin_needed_cb - Callback for requesting a PIN
 200          * @ctx: Higher layer context data (cb_ctx)
 201          * @uuid_e: UUID-E of the unknown Enrollee
 202          * @dev: Device Data from the unknown Enrollee
 203          *
 204          * This callback is called whenever an unknown Enrollee requests to use
 205          * PIN method and a matching PIN (Device Password) is not found in
 206          * Registrar data.
 207          */
 208         void (*pin_needed_cb)(void *ctx, const u8 *uuid_e,
 209                               const struct wps_device_data *dev);
 210
 211         /**
 212          * cb_ctx: Higher layer context data for Registrar callbacks
 213          */
 214         void *cb_ctx;
 215 };
 216
 217
 218 /**
 219  * enum wps_event - WPS event types
 220  */
 221 enum wps_event {
 222         /**
 223          * WPS_EV_M2D - M2D received (Registrar did not know us)
 224          */
 225         WPS_EV_M2D,
 226
 227         /**
 228          * WPS_EV_FAIL - Registration failed
 229          */
 230         WPS_EV_FAIL,
 231
 232         /**
 233          * WPS_EV_SUCCESS - Registration succeeded
 234          */
 235         WPS_EV_SUCCESS
 236 };
 237
 238 /**
 239  * union wps_event_data - WPS event data
 240  */
 241 union wps_event_data {
 242         /**
 243          * struct wps_event_m2d - M2D event data
 244          */
 245         struct wps_event_m2d {
 246                 u16 config_methods;
 247                 const u8 *manufacturer;
 248                 size_t manufacturer_len;
 249                 const u8 *model_name;
 250                 size_t model_name_len;
 251                 const u8 *model_number;
 252                 size_t model_number_len;
 253                 const u8 *serial_number;
 254                 size_t serial_number_len;
 255                 const u8 *dev_name;
 256                 size_t dev_name_len;
 257                 const u8 *primary_dev_type; /* 8 octets */
 258                 u16 config_error;
 259                 u16 dev_password_id;
 260         } m2d;
 261
 262         /**
 263          * struct wps_event_fail - Registration failure information
 264          * @msg: enum wps_msg_type
 265          */
 266         struct wps_event_fail {
 267                 int msg;
 268         } fail;
 269 };
 270
 271 /**
 272  * struct wps_context - Long term WPS context data
 273  *
 274  * This data is stored at the higher layer Authenticator or Supplicant data
 275  * structures and it is maintained over multiple registration protocol runs.
 276  */
 277 struct wps_context {
 278         /**
 279          * ap - Whether the local end is an access point
 280          */
 281         int ap;
 282
 283         /**
 284          * registrar - Pointer to WPS registrar data from wps_registrar_init()
 285          */
 286         struct wps_registrar *registrar;
 287
 288         /**
 289          * wps_state - Current WPS state
 290          */
 291         enum wps_state wps_state;
 292
 293         /**
 294          * ap_setup_locked - Whether AP setup is locked (only used at AP)
 295          */
 296         int ap_setup_locked;
 297
 298         /**
 299          * uuid - Own UUID
 300          */
 301         u8 uuid[16];
 302
 303         /**
 304          * ssid - SSID
 305          *
 306          * This SSID is used by the Registrar to fill in information for
 307          * Credentials. In addition, AP uses it when acting as an Enrollee to
 308          * notify Registrar of the current configuration.
 309          */
 310         u8 ssid[32];
 311
 312         /**
 313          * ssid_len - Length of ssid in octets
 314          */
 315         size_t ssid_len;
 316
 317         /**
 318          * dev - Own WPS device data
 319          */
 320         struct wps_device_data dev;
 321
 322         /**
 323          * config_methods - Enabled configuration methods
 324          *
 325          * Bit field of WPS_CONFIG_*
 326          */
 327         u16 config_methods;
 328
 329         /**
 330          * encr_types - Enabled encryption types (bit field of WPS_ENCR_*)
 331          */
 332         u16 encr_types;
 333
 334         /**
 335          * auth_types - Authentication types (bit field of WPS_AUTH_*)
 336          */
 337         u16 auth_types;
 338
 339         /**
 340          * network_key - The current Network Key (PSK) or %NULL to generate new
 341          *
 342          * If %NULL, Registrar will generate per-device PSK. In addition, AP
 343          * uses this when acting as an Enrollee to notify Registrar of the
 344          * current configuration.
 345          */
 346         u8 *network_key;
 347
 348         /**
 349          * network_key_len - Length of network_key in octets
 350          */
 351         size_t network_key_len;
 352
 353         /**
 354          * cred_cb - Callback to notify that new Credentials were received
 355          * @ctx: Higher layer context data (cb_ctx)
 356          * @cred: The received Credential
 357          * Return: 0 on success, -1 on failure
 358          */
 359         int (*cred_cb)(void *ctx, const struct wps_credential *cred);
 360
 361         /**
 362          * event_cb - Event callback (state information about progress)
 363          * @ctx: Higher layer context data (cb_ctx)
 364          * @event: Event type
 365          * @data: Event data
 366          */
 367         void (*event_cb)(void *ctx, enum wps_event event,
 368                          union wps_event_data *data);
 369
 370         /**
 371          * cb_ctx: Higher layer context data for callbacks
 372          */
 373         void *cb_ctx;
 374 };
 375
 376
 377 struct wps_registrar *
 378 wps_registrar_init(struct wps_context *wps,
 379                    const struct wps_registrar_config *cfg);
 380 void wps_registrar_deinit(struct wps_registrar *reg);
 381 int wps_registrar_add_pin(struct wps_registrar *reg, const u8 *uuid,
 382                           const u8 *pin, size_t pin_len);
 383 int wps_registrar_invalidate_pin(struct wps_registrar *reg, const u8 *uuid);
 384 int wps_registrar_unlock_pin(struct wps_registrar *reg, const u8 *uuid);
 385 int wps_registrar_button_pushed(struct wps_registrar *reg);
 386 void wps_registrar_probe_req_rx(struct wps_registrar *reg, const u8 *addr,
 387                                 const struct wpabuf *wps_data);
 388
 389 unsigned int wps_pin_checksum(unsigned int pin);
 390 unsigned int wps_pin_valid(unsigned int pin);
 391 unsigned int wps_generate_pin(void);
 392
 393 #endif /* WPS_H */