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 enum wsc_op_code {
  19         WSC_Start = 0x01,
  20         WSC_ACK = 0x02,
  21         WSC_NACK = 0x03,
  22         WSC_MSG = 0x04,
  23         WSC_Done = 0x05,
  24         WSC_FRAG_ACK = 0x06
  25 };
  26
  27 struct wps_registrar;
  28
  29 struct wps_credential {
  30         u8 ssid[32];
  31         size_t ssid_len;
  32         u16 auth_type;
  33         u16 encr_type;
  34         u8 key_idx;
  35         u8 key[64];
  36         size_t key_len;
  37         u8 mac_addr[ETH_ALEN];
  38 };
  39
  40 struct wps_config {
  41         int authenticator;
  42         struct wps_context *wps;
  43         struct wps_registrar *registrar; /* NULL for Enrollee */
  44         const u8 *enrollee_mac_addr; /* NULL for Registrar */
  45         const u8 *pin; /* Enrollee Device Password (NULL for Registrar or PBC)
  46                         */
  47         size_t pin_len;
  48         const u8 *uuid; /* 128-bit Enrollee UUID (NULL for Registrar) */
  49         int pbc;
  50         const struct wpabuf *assoc_wps_ie; /* (Re)AssocReq WPS IE (in AP) */
  51 };
  52
  53 struct wps_data * wps_init(const struct wps_config *cfg);
  54
  55 void wps_deinit(struct wps_data *data);
  56
  57 enum wps_process_res {
  58         WPS_DONE, WPS_CONTINUE, WPS_FAILURE, WPS_PENDING
  59 };
  60 enum wps_process_res wps_process_msg(struct wps_data *wps, u8 op_code,
  61                                      const struct wpabuf *msg);
  62
  63 struct wpabuf * wps_get_msg(struct wps_data *wps, u8 *op_code);
  64
  65 int wps_is_selected_pbc_registrar(const u8 *buf, size_t len);
  66 int wps_is_selected_pin_registrar(const u8 *buf, size_t len);
  67 const u8 * wps_get_uuid_e(const u8 *buf, size_t len);
  68
  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 };
  82
  83
  84 struct wps_registrar_config {
  85         int (*new_psk_cb)(void *ctx, const u8 *mac_addr, const u8 *psk,
  86                           size_t psk_len);
  87         int (*set_ie_cb)(void *ctx, const u8 *beacon_ie, size_t beacon_ie_len,
  88                          const u8 *probe_resp_ie, size_t probe_resp_ie_len);
  89         void (*pin_needed_cb)(void *ctx, const u8 *uuid_e,
  90                               const struct wps_device_data *dev);
  91         void *cb_ctx;
  92 };
  93
  94
  95 /**
  96  * struct wps_context - Long term WPS context data
  97  *
  98  * This data is stored at the higher layer Authenticator or Supplicant data
  99  * structures and it is maintained over multiple registration protocol runs.
 100  */
 101 struct wps_context {
 102         int ap;
 103         struct wps_registrar *registrar;
 104         int wps_state;
 105         int ap_setup_locked;
 106         u8 uuid[16];
 107         u8 ssid[32];
 108         size_t ssid_len;
 109         struct wps_device_data dev;
 110         u16 config_methods; /* bit field of WPS_CONFIG_* */
 111         u16 encr_types; /* bit field of WPS_ENCR_* */
 112         u16 auth_types; /* bit field of WPS_AUTH_* */
 113         u8 *network_key; /* or NULL to generate per-device PSK */
 114         size_t network_key_len;
 115
 116         int (*cred_cb)(void *ctx, const struct wps_credential *cred);
 117         void *cb_ctx;
 118 };
 119
 120
 121 struct wps_registrar *
 122 wps_registrar_init(struct wps_context *wps,
 123                    const struct wps_registrar_config *cfg);
 124 void wps_registrar_deinit(struct wps_registrar *reg);
 125 int wps_registrar_add_pin(struct wps_registrar *reg, const u8 *uuid,
 126                           const u8 *pin, size_t pin_len);
 127 int wps_registrar_invalidate_pin(struct wps_registrar *reg, const u8 *uuid);
 128 int wps_registrar_unlock_pin(struct wps_registrar *reg, const u8 *uuid);
 129 int wps_registrar_button_pushed(struct wps_registrar *reg);
 130 void wps_registrar_probe_req_rx(struct wps_registrar *reg, const u8 *addr,
 131                                 const struct wpabuf *wps_data);
 132
 133 struct wpabuf * wps_enrollee_build_assoc_req_ie(void);
 134 struct wpabuf * wps_enrollee_build_probe_req_ie(int pbc,
 135                                                 struct wps_device_data *dev,
 136                                                 const u8 *uuid);
 137
 138 #endif /* WPS_H */