src/wps/wps_i.h

   1 /*
   2  * Wi-Fi Protected Setup - internal definitions
   3  * Copyright (c) 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_I_H
  16 #define WPS_I_H
  17
  18 #include "wps.h"
  19 #include "wps_defs.h"
  20
  21 struct wps_data {
  22         int authenticator;
  23         struct wps_context *wps;
  24         struct wps_registrar *registrar;
  25         enum {
  26                 /* Enrollee states */
  27                 SEND_M1, RECV_M2, SEND_M3, RECV_M4, SEND_M5, RECV_M6, SEND_M7,
  28                 RECV_M8, RECEIVED_M2D, WPS_MSG_DONE, RECV_ACK, WPS_FINISHED,
  29                 SEND_WSC_NACK,
  30
  31                 /* Registrar states */
  32                 RECV_M1, SEND_M2, RECV_M3, SEND_M4, RECV_M5, SEND_M6,
  33                 RECV_M7, SEND_M8, RECV_DONE, SEND_M2D, RECV_M2D_ACK
  34         } state;
  35
  36         u8 uuid_e[WPS_UUID_LEN];
  37         u8 uuid_r[WPS_UUID_LEN];
  38         u8 mac_addr_e[ETH_ALEN];
  39         u8 nonce_e[WPS_NONCE_LEN];
  40         u8 nonce_r[WPS_NONCE_LEN];
  41         u8 psk1[WPS_PSK_LEN];
  42         u8 psk2[WPS_PSK_LEN];
  43         u8 snonce[2 * WPS_SECRET_NONCE_LEN];
  44         u8 peer_hash1[WPS_HASH_LEN];
  45         u8 peer_hash2[WPS_HASH_LEN];
  46
  47         struct wpabuf *dh_privkey;
  48         struct wpabuf *dh_pubkey_e;
  49         struct wpabuf *dh_pubkey_r;
  50         u8 authkey[WPS_AUTHKEY_LEN];
  51         u8 keywrapkey[WPS_KEYWRAPKEY_LEN];
  52         u8 emsk[WPS_EMSK_LEN];
  53
  54         struct wpabuf *last_msg;
  55
  56         u8 *dev_password;
  57         size_t dev_password_len;
  58         u16 dev_pw_id;
  59         int pbc;
  60
  61         u16 encr_type; /* available encryption types */
  62         u16 auth_type; /* available authentication types */
  63
  64         u8 *new_psk;
  65         size_t new_psk_len;
  66
  67         int wps_pin_revealed;
  68         struct wps_credential cred;
  69
  70         int (*wps_cred_cb)(void *ctx, struct wps_credential *cred);
  71         void *cb_ctx;
  72
  73         struct wps_device_data peer_dev;
  74 };
  75
  76
  77 struct wps_parse_attr {
  78         /* fixed length fields */
  79         const u8 *version; /* 1 octet */
  80         const u8 *msg_type; /* 1 octet */
  81         const u8 *enrollee_nonce; /* WPS_NONCE_LEN (16) octets */
  82         const u8 *registrar_nonce; /* WPS_NONCE_LEN (16) octets */
  83         const u8 *uuid_r; /* WPS_UUID_LEN (16) octets */
  84         const u8 *uuid_e; /* WPS_UUID_LEN (16) octets */
  85         const u8 *auth_type_flags; /* 2 octets */
  86         const u8 *encr_type_flags; /* 2 octets */
  87         const u8 *conn_type_flags; /* 1 octet */
  88         const u8 *config_methods; /* 2 octets */
  89         const u8 *sel_reg_config_methods; /* 2 octets */
  90         const u8 *primary_dev_type; /* 8 octets */
  91         const u8 *rf_bands; /* 1 octet */
  92         const u8 *assoc_state; /* 2 octets */
  93         const u8 *config_error; /* 2 octets */
  94         const u8 *dev_password_id; /* 2 octets */
  95         const u8 *os_version; /* 4 octets */
  96         const u8 *wps_state; /* 1 octet */
  97         const u8 *authenticator; /* WPS_AUTHENTICATOR_LEN (8) octets */
  98         const u8 *r_hash1; /* WPS_HASH_LEN (32) octets */
  99         const u8 *r_hash2; /* WPS_HASH_LEN (32) octets */
 100         const u8 *e_hash1; /* WPS_HASH_LEN (32) octets */
 101         const u8 *e_hash2; /* WPS_HASH_LEN (32) octets */
 102         const u8 *r_snonce1; /* WPS_SECRET_NONCE_LEN (16) octets */
 103         const u8 *r_snonce2; /* WPS_SECRET_NONCE_LEN (16) octets */
 104         const u8 *e_snonce1; /* WPS_SECRET_NONCE_LEN (16) octets */
 105         const u8 *e_snonce2; /* WPS_SECRET_NONCE_LEN (16) octets */
 106         const u8 *key_wrap_auth; /* WPS_KWA_LEN (8) octets */
 107         const u8 *auth_type; /* 2 octets */
 108         const u8 *encr_type; /* 2 octets */
 109         const u8 *network_idx; /* 1 octet */
 110         const u8 *network_key_idx; /* 1 octet */
 111         const u8 *mac_addr; /* ETH_ALEN (6) octets */
 112         const u8 *key_prov_auto; /* 1 octet (Bool) */
 113         const u8 *dot1x_enabled; /* 1 octet (Bool) */
 114         const u8 *selected_registrar; /* 1 octet (Bool) */
 115
 116         /* variable length fields */
 117         const u8 *manufacturer;
 118         size_t manufacturer_len;
 119         const u8 *model_name;
 120         size_t model_name_len;
 121         const u8 *model_number;
 122         size_t model_number_len;
 123         const u8 *serial_number;
 124         size_t serial_number_len;
 125         const u8 *dev_name;
 126         size_t dev_name_len;
 127         const u8 *public_key;
 128         size_t public_key_len;
 129         const u8 *encr_settings;
 130         size_t encr_settings_len;
 131         const u8 *ssid; /* <= 32 octets */
 132         size_t ssid_len;
 133         const u8 *network_key; /* <= 64 octets */
 134         size_t network_key_len;
 135         const u8 *eap_type; /* <= 8 octets */
 136         size_t eap_type_len;
 137         const u8 *eap_identity; /* <= 64 octets */
 138         size_t eap_identity_len;
 139
 140         /* attributes that can occur multiple times */
 141 #define MAX_CRED_COUNT 10
 142         const u8 *cred[MAX_CRED_COUNT];
 143         size_t cred_len[MAX_CRED_COUNT];
 144         size_t num_cred;
 145 };
 146
 147 /* wps_common.c */
 148 int wps_parse_msg(const struct wpabuf *msg, struct wps_parse_attr *attr);
 149 void wps_kdf(const u8 *key, const char *label, u8 *res, size_t res_len);
 150 int wps_build_public_key(struct wps_data *wps, struct wpabuf *msg);
 151 int wps_derive_keys(struct wps_data *wps);
 152 int wps_build_authenticator(struct wps_data *wps, struct wpabuf *msg);
 153 int wps_process_authenticator(struct wps_data *wps, const u8 *authenticator,
 154                               const struct wpabuf *msg);
 155 void wps_derive_psk(struct wps_data *wps, const u8 *dev_passwd,
 156                     size_t dev_passwd_len);
 157 struct wpabuf * wps_decrypt_encr_settings(struct wps_data *wps, const u8 *encr,
 158                                           size_t encr_len);
 159 int wps_process_key_wrap_auth(struct wps_data *wps, struct wpabuf *msg,
 160                               const u8 *key_wrap_auth);
 161 int wps_build_key_wrap_auth(struct wps_data *wps, struct wpabuf *msg);
 162 int wps_build_encr_settings(struct wps_data *wps, struct wpabuf *msg,
 163                             struct wpabuf *plain);
 164 int wps_build_version(struct wpabuf *msg);
 165 int wps_build_msg_type(struct wpabuf *msg, enum wps_msg_type msg_type);
 166 int wps_build_enrollee_nonce(struct wps_data *wps, struct wpabuf *msg);
 167 int wps_build_registrar_nonce(struct wps_data *wps, struct wpabuf *msg);
 168 int wps_build_auth_type_flags(struct wps_data *wps, struct wpabuf *msg);
 169 int wps_build_encr_type_flags(struct wps_data *wps, struct wpabuf *msg);
 170 int wps_build_conn_type_flags(struct wps_data *wps, struct wpabuf *msg);
 171 int wps_build_assoc_state(struct wps_data *wps, struct wpabuf *msg);
 172
 173 /* wps_enrollee.c */
 174 struct wpabuf * wps_enrollee_get_msg(struct wps_data *wps, u8 *op_code);
 175 enum wps_process_res wps_enrollee_process_msg(struct wps_data *wps, u8 op_code,
 176                                               const struct wpabuf *msg);
 177
 178 /* wps_registrar.c */
 179 struct wpabuf * wps_registrar_get_msg(struct wps_data *wps, u8 *op_code);
 180 enum wps_process_res wps_registrar_process_msg(struct wps_data *wps,
 181                                                u8 op_code,
 182                                                const struct wpabuf *msg);
 183
 184 #endif /* WPS_I_H */