src/wps/wps.h

   1 /*
   2  * Wi-Fi Protected Setup
   3  * Copyright (c) 2007-2009, 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_UPnP = 0 /* No OP Code in UPnP transport */,
  25         WSC_Start = 0x01,
  26         WSC_ACK = 0x02,
  27         WSC_NACK = 0x03,
  28         WSC_MSG = 0x04,
  29         WSC_Done = 0x05,
  30         WSC_FRAG_ACK = 0x06
  31 };
  32
  33 struct wps_registrar;
  34 struct upnp_wps_device_sm;
  35
  36 /**
  37  * struct wps_credential - WPS Credential
  38  * @ssid: SSID
  39  * @ssid_len: Length of SSID
  40  * @auth_type: Authentication Type (WPS_AUTH_OPEN, .. flags)
  41  * @encr_type: Encryption Type (WPS_ENCR_NONE, .. flags)
  42  * @key_idx: Key index
  43  * @key: Key
  44  * @key_len: Key length in octets
  45  * @mac_addr: MAC address of the peer
  46  * @cred_attr: Unparsed Credential attribute data (used only in cred_cb());
  47  *      this may be %NULL, if not used
  48  * @cred_attr_len: Length of cred_attr in octets
  49  */
  50 struct wps_credential {
  51         u8 ssid[32];
  52         size_t ssid_len;
  53         u16 auth_type;
  54         u16 encr_type;
  55         u8 key_idx;
  56         u8 key[64];
  57         size_t key_len;
  58         u8 mac_addr[ETH_ALEN];
  59         const u8 *cred_attr;
  60         size_t cred_attr_len;
  61 };
  62
  63 /**
  64  * struct wps_device_data - WPS Device Data
  65  * @mac_addr: Device MAC address
  66  * @device_name: Device Name (0..32 octets encoded in UTF-8)
  67  * @manufacturer: Manufacturer (0..64 octets encoded in UTF-8)
  68  * @model_name: Model Name (0..32 octets encoded in UTF-8)
  69  * @model_number: Model Number (0..32 octets encoded in UTF-8)
  70  * @serial_number: Serial Number (0..32 octets encoded in UTF-8)
  71  * @categ: Primary Device Category
  72  * @oui: Primary Device OUI
  73  * @sub_categ: Primary Device Sub-Category
  74  * @os_version: OS Version
  75  * @rf_bands: RF bands (WPS_RF_24GHZ, WPS_RF_50GHZ flags)
  76  */
  77 struct wps_device_data {
  78         u8 mac_addr[ETH_ALEN];
  79         char *device_name;
  80         char *manufacturer;
  81         char *model_name;
  82         char *model_number;
  83         char *serial_number;
  84         u16 categ;
  85         u32 oui;
  86         u16 sub_categ;
  87         u32 os_version;
  88         u8 rf_bands;
  89 };
  90
  91 struct oob_conf_data {
  92         enum {
  93                 OOB_METHOD_UNKNOWN = 0,
  94                 OOB_METHOD_DEV_PWD_E,
  95                 OOB_METHOD_DEV_PWD_R,
  96                 OOB_METHOD_CRED,
  97         } oob_method;
  98         struct wpabuf *dev_password;
  99         struct wpabuf *pubkey_hash;
 100 };
 101
 102 /**
 103  * struct wps_config - WPS configuration for a single registration protocol run
 104  */
 105 struct wps_config {
 106         /**
 107          * wps - Pointer to long term WPS context
 108          */
 109         struct wps_context *wps;
 110
 111         /**
 112          * registrar - Whether this end is a Registrar
 113          */
 114         int registrar;
 115
 116         /**
 117          * pin - Enrollee Device Password (%NULL for Registrar or PBC)
 118          */
 119         const u8 *pin;
 120
 121         /**
 122          * pin_len - Length on pin in octets
 123          */
 124         size_t pin_len;
 125
 126         /**
 127          * pbc - Whether this is protocol run uses PBC
 128          */
 129         int pbc;
 130
 131         /**
 132          * assoc_wps_ie: (Re)AssocReq WPS IE (in AP; %NULL if not AP)
 133          */
 134         const struct wpabuf *assoc_wps_ie;
 135
 136         /**
 137          * new_ap_settings - New AP settings (%NULL if not used)
 138          *
 139          * This parameter provides new AP settings when using a wireless
 140          * stations as a Registrar to configure the AP. %NULL means that AP
 141          * will not be reconfigured, i.e., the station will only learn the
 142          * current AP settings by using AP PIN.
 143          */
 144         const struct wps_credential *new_ap_settings;
 145
 146         /**
 147          * peer_addr: MAC address of the peer in AP; %NULL if not AP
 148          */
 149         const u8 *peer_addr;
 150 };
 151
 152 struct wps_data * wps_init(const struct wps_config *cfg);
 153
 154 void wps_deinit(struct wps_data *data);
 155
 156 /**
 157  * enum wps_process_res - WPS message processing result
 158  */
 159 enum wps_process_res {
 160         /**
 161          * WPS_DONE - Processing done
 162          */
 163         WPS_DONE,
 164
 165         /**
 166          * WPS_CONTINUE - Processing continues
 167          */
 168         WPS_CONTINUE,
 169
 170         /**
 171          * WPS_FAILURE - Processing failed
 172          */
 173         WPS_FAILURE,
 174
 175         /**
 176          * WPS_PENDING - Processing continues, but waiting for an external
 177          *      event (e.g., UPnP message from an external Registrar)
 178          */
 179         WPS_PENDING
 180 };
 181 enum wps_process_res wps_process_msg(struct wps_data *wps,
 182                                      enum wsc_op_code op_code,
 183                                      const struct wpabuf *msg);
 184
 185 struct wpabuf * wps_get_msg(struct wps_data *wps, enum wsc_op_code *op_code);
 186
 187 int wps_is_selected_pbc_registrar(const struct wpabuf *msg);
 188 int wps_is_selected_pin_registrar(const struct wpabuf *msg);
 189 const u8 * wps_get_uuid_e(const struct wpabuf *msg);
 190
 191 struct wpabuf * wps_build_assoc_req_ie(enum wps_request_type req_type);
 192 struct wpabuf * wps_build_probe_req_ie(int pbc, struct wps_device_data *dev,
 193                                        const u8 *uuid,
 194                                        enum wps_request_type req_type);
 195
 196
 197 /**
 198  * struct wps_registrar_config - WPS Registrar configuration
 199  */
 200 struct wps_registrar_config {
 201         /**
 202          * new_psk_cb - Callback for new PSK
 203          * @ctx: Higher layer context data (cb_ctx)
 204          * @mac_addr: MAC address of the Enrollee
 205          * @psk: The new PSK
 206          * @psk_len: The length of psk in octets
 207          * Returns: 0 on success, -1 on failure
 208          *
 209          * This callback is called when a new per-device PSK is provisioned.
 210          */
 211         int (*new_psk_cb)(void *ctx, const u8 *mac_addr, const u8 *psk,
 212                           size_t psk_len);
 213
 214         /**
 215          * set_ie_cb - Callback for WPS IE changes
 216          * @ctx: Higher layer context data (cb_ctx)
 217          * @beacon_ie: WPS IE for Beacon
 218          * @beacon_ie_len: WPS IE length for Beacon
 219          * @probe_resp_ie: WPS IE for Probe Response
 220          * @probe_resp_ie_len: WPS IE length for Probe Response
 221          * Returns: 0 on success, -1 on failure
 222          *
 223          * This callback is called whenever the WPS IE in Beacon or Probe
 224          * Response frames needs to be changed (AP only).
 225          */
 226         int (*set_ie_cb)(void *ctx, const u8 *beacon_ie, size_t beacon_ie_len,
 227                          const u8 *probe_resp_ie, size_t probe_resp_ie_len);
 228
 229         /**
 230          * pin_needed_cb - Callback for requesting a PIN
 231          * @ctx: Higher layer context data (cb_ctx)
 232          * @uuid_e: UUID-E of the unknown Enrollee
 233          * @dev: Device Data from the unknown Enrollee
 234          *
 235          * This callback is called whenever an unknown Enrollee requests to use
 236          * PIN method and a matching PIN (Device Password) is not found in
 237          * Registrar data.
 238          */
 239         void (*pin_needed_cb)(void *ctx, const u8 *uuid_e,
 240                               const struct wps_device_data *dev);
 241
 242         /**
 243          * reg_success_cb - Callback for reporting successful registration
 244          * @ctx: Higher layer context data (cb_ctx)
 245          * @mac_addr: MAC address of the Enrollee
 246          * @uuid_e: UUID-E of the Enrollee
 247          *
 248          * This callback is called whenever an Enrollee completes registration
 249          * successfully.
 250          */
 251         void (*reg_success_cb)(void *ctx, const u8 *mac_addr,
 252                                const u8 *uuid_e);
 253
 254         /**
 255          * cb_ctx: Higher layer context data for Registrar callbacks
 256          */
 257         void *cb_ctx;
 258
 259         /**
 260          * skip_cred_build: Do not build credential
 261          *
 262          * This option can be used to disable internal code that builds
 263          * Credential attribute into M8 based on the current network
 264          * configuration and Enrollee capabilities. The extra_cred data will
 265          * then be used as the Credential(s).
 266          */
 267         int skip_cred_build;
 268
 269         /**
 270          * extra_cred: Additional Credential attribute(s)
 271          *
 272          * This optional data (set to %NULL to disable) can be used to add
 273          * Credential attribute(s) for other networks into M8. If
 274          * skip_cred_build is set, this will also override the automatically
 275          * generated Credential attribute.
 276          */
 277         const u8 *extra_cred;
 278
 279         /**
 280          * extra_cred_len: Length of extra_cred in octets
 281          */
 282         size_t extra_cred_len;
 283
 284         /**
 285          * disable_auto_conf - Disable auto-configuration on first registration
 286          *
 287          * By default, the AP that is started in not configured state will
 288          * generate a random PSK and move to configured state when the first
 289          * registration protocol run is completed successfully. This option can
 290          * be used to disable this functionality and leave it up to an external
 291          * program to take care of configuration. This requires the extra_cred
 292          * to be set with a suitable Credential and skip_cred_build being used.
 293          */
 294         int disable_auto_conf;
 295
 296         /**
 297          * static_wep_only - Whether the BSS supports only static WEP
 298          */
 299         int static_wep_only;
 300 };
 301
 302
 303 /**
 304  * enum wps_event - WPS event types
 305  */
 306 enum wps_event {
 307         /**
 308          * WPS_EV_M2D - M2D received (Registrar did not know us)
 309          */
 310         WPS_EV_M2D,
 311
 312         /**
 313          * WPS_EV_FAIL - Registration failed
 314          */
 315         WPS_EV_FAIL,
 316
 317         /**
 318          * WPS_EV_SUCCESS - Registration succeeded
 319          */
 320         WPS_EV_SUCCESS,
 321
 322         /**
 323          * WPS_EV_PWD_AUTH_FAIL - Password authentication failed
 324          */
 325         WPS_EV_PWD_AUTH_FAIL,
 326
 327         /**
 328          * WPS_EV_PBC_OVERLAP - PBC session overlap detected
 329          */
 330         WPS_EV_PBC_OVERLAP,
 331
 332         /**
 333          * WPS_EV_PBC_TIMEOUT - PBC walktime expired before protocol run start
 334          */
 335         WPS_EV_PBC_TIMEOUT
 336 };
 337
 338 /**
 339  * union wps_event_data - WPS event data
 340  */
 341 union wps_event_data {
 342         /**
 343          * struct wps_event_m2d - M2D event data
 344          */
 345         struct wps_event_m2d {
 346                 u16 config_methods;
 347                 const u8 *manufacturer;
 348                 size_t manufacturer_len;
 349                 const u8 *model_name;
 350                 size_t model_name_len;
 351                 const u8 *model_number;
 352                 size_t model_number_len;
 353                 const u8 *serial_number;
 354                 size_t serial_number_len;
 355                 const u8 *dev_name;
 356                 size_t dev_name_len;
 357                 const u8 *primary_dev_type; /* 8 octets */
 358                 u16 config_error;
 359                 u16 dev_password_id;
 360         } m2d;
 361
 362         /**
 363          * struct wps_event_fail - Registration failure information
 364          * @msg: enum wps_msg_type
 365          */
 366         struct wps_event_fail {
 367                 int msg;
 368         } fail;
 369
 370         struct wps_event_pwd_auth_fail {
 371                 int enrollee;
 372                 int part;
 373         } pwd_auth_fail;
 374 };
 375
 376 /**
 377  * struct upnp_pending_message - Pending PutWLANResponse messages
 378  * @next: Pointer to next pending message or %NULL
 379  * @addr: NewWLANEventMAC
 380  * @msg: NewMessage
 381  * @type: Message Type
 382  */
 383 struct upnp_pending_message {
 384         struct upnp_pending_message *next;
 385         u8 addr[ETH_ALEN];
 386         struct wpabuf *msg;
 387         enum wps_msg_type type;
 388 };
 389
 390 /**
 391  * struct wps_context - Long term WPS context data
 392  *
 393  * This data is stored at the higher layer Authenticator or Supplicant data
 394  * structures and it is maintained over multiple registration protocol runs.
 395  */
 396 struct wps_context {
 397         /**
 398          * ap - Whether the local end is an access point
 399          */
 400         int ap;
 401
 402         /**
 403          * registrar - Pointer to WPS registrar data from wps_registrar_init()
 404          */
 405         struct wps_registrar *registrar;
 406
 407         /**
 408          * wps_state - Current WPS state
 409          */
 410         enum wps_state wps_state;
 411
 412         /**
 413          * ap_setup_locked - Whether AP setup is locked (only used at AP)
 414          */
 415         int ap_setup_locked;
 416
 417         /**
 418          * uuid - Own UUID
 419          */
 420         u8 uuid[16];
 421
 422         /**
 423          * ssid - SSID
 424          *
 425          * This SSID is used by the Registrar to fill in information for
 426          * Credentials. In addition, AP uses it when acting as an Enrollee to
 427          * notify Registrar of the current configuration.
 428          */
 429         u8 ssid[32];
 430
 431         /**
 432          * ssid_len - Length of ssid in octets
 433          */
 434         size_t ssid_len;
 435
 436         /**
 437          * dev - Own WPS device data
 438          */
 439         struct wps_device_data dev;
 440
 441         /**
 442          * oob_conf - OOB Config data
 443          */
 444         struct oob_conf_data oob_conf;
 445
 446         /**
 447          * oob_dev_pw_id - OOB Device password id
 448          */
 449         u16 oob_dev_pw_id;
 450
 451         /**
 452          * dh_ctx - Context data for Diffie-Hellman operation
 453          */
 454         void *dh_ctx;
 455
 456         /**
 457          * dh_privkey - Diffie-Hellman private key
 458          */
 459         struct wpabuf *dh_privkey;
 460
 461         /**
 462          * dh_pubkey_oob - Diffie-Hellman public key
 463          */
 464         struct wpabuf *dh_pubkey;
 465
 466         /**
 467          * config_methods - Enabled configuration methods
 468          *
 469          * Bit field of WPS_CONFIG_*
 470          */
 471         u16 config_methods;
 472
 473         /**
 474          * encr_types - Enabled encryption types (bit field of WPS_ENCR_*)
 475          */
 476         u16 encr_types;
 477
 478         /**
 479          * auth_types - Authentication types (bit field of WPS_AUTH_*)
 480          */
 481         u16 auth_types;
 482
 483         /**
 484          * network_key - The current Network Key (PSK) or %NULL to generate new
 485          *
 486          * If %NULL, Registrar will generate per-device PSK. In addition, AP
 487          * uses this when acting as an Enrollee to notify Registrar of the
 488          * current configuration.
 489          */
 490         u8 *network_key;
 491
 492         /**
 493          * network_key_len - Length of network_key in octets
 494          */
 495         size_t network_key_len;
 496
 497         /**
 498          * ap_settings - AP Settings override for M7 (only used at AP)
 499          *
 500          * If %NULL, AP Settings attributes will be generated based on the
 501          * current network configuration.
 502          */
 503         u8 *ap_settings;
 504
 505         /**
 506          * ap_settings_len - Length of ap_settings in octets
 507          */
 508         size_t ap_settings_len;
 509
 510         /**
 511          * friendly_name - Friendly Name (required for UPnP)
 512          */
 513         char *friendly_name;
 514
 515         /**
 516          * manufacturer_url - Manufacturer URL (optional for UPnP)
 517          */
 518         char *manufacturer_url;
 519
 520         /**
 521          * model_description - Model Description (recommended for UPnP)
 522          */
 523         char *model_description;
 524
 525         /**
 526          * model_url - Model URL (optional for UPnP)
 527          */
 528         char *model_url;
 529
 530         /**
 531          * upc - Universal Product Code (optional for UPnP)
 532          */
 533         char *upc;
 534
 535         /**
 536          * cred_cb - Callback to notify that new Credentials were received
 537          * @ctx: Higher layer context data (cb_ctx)
 538          * @cred: The received Credential
 539          * Return: 0 on success, -1 on failure
 540          */
 541         int (*cred_cb)(void *ctx, const struct wps_credential *cred);
 542
 543         /**
 544          * event_cb - Event callback (state information about progress)
 545          * @ctx: Higher layer context data (cb_ctx)
 546          * @event: Event type
 547          * @data: Event data
 548          */
 549         void (*event_cb)(void *ctx, enum wps_event event,
 550                          union wps_event_data *data);
 551
 552         /**
 553          * cb_ctx: Higher layer context data for callbacks
 554          */
 555         void *cb_ctx;
 556
 557         struct upnp_wps_device_sm *wps_upnp;
 558
 559         /* Pending messages from UPnP PutWLANResponse */
 560         struct upnp_pending_message *upnp_msgs;
 561 };
 562
 563 struct oob_device_data {
 564         char *device_name;
 565         char *device_path;
 566         void * (*init_func)(struct wps_context *, struct oob_device_data *,
 567                             int);
 568         struct wpabuf * (*read_func)(void *);
 569         int (*write_func)(void *, struct wpabuf *);
 570         void (*deinit_func)(void *);
 571 };
 572
 573 struct oob_nfc_device_data {
 574         int (*init_func)(char *);
 575         void * (*read_func)(size_t *);
 576         int (*write_func)(void *, size_t);
 577         void (*deinit_func)(void);
 578 };
 579
 580 struct wps_registrar *
 581 wps_registrar_init(struct wps_context *wps,
 582                    const struct wps_registrar_config *cfg);
 583 void wps_registrar_deinit(struct wps_registrar *reg);
 584 int wps_registrar_add_pin(struct wps_registrar *reg, const u8 *uuid,
 585                           const u8 *pin, size_t pin_len, int timeout);
 586 int wps_registrar_invalidate_pin(struct wps_registrar *reg, const u8 *uuid);
 587 int wps_registrar_unlock_pin(struct wps_registrar *reg, const u8 *uuid);
 588 int wps_registrar_button_pushed(struct wps_registrar *reg);
 589 void wps_registrar_probe_req_rx(struct wps_registrar *reg, const u8 *addr,
 590                                 const struct wpabuf *wps_data);
 591 int wps_registrar_update_ie(struct wps_registrar *reg);
 592 int wps_registrar_set_selected_registrar(struct wps_registrar *reg,
 593                                          const struct wpabuf *msg);
 594 int wps_registrar_get_info(struct wps_registrar *reg, const u8 *addr,
 595                            char *buf, size_t buflen);
 596
 597 unsigned int wps_pin_checksum(unsigned int pin);
 598 unsigned int wps_pin_valid(unsigned int pin);
 599 unsigned int wps_generate_pin(void);
 600 void wps_free_pending_msgs(struct upnp_pending_message *msgs);
 601
 602 struct oob_device_data * wps_get_oob_device(char *device_type);
 603 struct oob_nfc_device_data * wps_get_oob_nfc_device(char *device_name);
 604 int wps_get_oob_method(char *method);
 605 int wps_process_oob(struct wps_context *wps, struct oob_device_data *oob_dev,
 606                     int registrar);
 607 int wps_attr_text(struct wpabuf *data, char *buf, char *end);
 608
 609 #endif /* WPS_H */