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
20 /**
21 * struct wps_data - WPS registration protocol data
22 *
23 * This data is stored at the EAP-WSC server/peer method and it is kept for a
24 * single registration protocol run.
25 */
26 struct wps_data {
27 /**
28 * wps - Pointer to long term WPS context
29 */
30 struct wps_context *wps;
31
32 /**
33 * registrar - Whether this end is a Registrar
34 */
35 int registrar;
36
37 enum {
38 /* Enrollee states */
39 SEND_M1, RECV_M2, SEND_M3, RECV_M4, SEND_M5, RECV_M6, SEND_M7,
40 RECV_M8, RECEIVED_M2D, WPS_MSG_DONE, RECV_ACK, WPS_FINISHED,
41 SEND_WSC_NACK,
42
43 /* Registrar states */
44 RECV_M1, SEND_M2, RECV_M3, SEND_M4, RECV_M5, SEND_M6,
45 RECV_M7, SEND_M8, RECV_DONE, SEND_M2D, RECV_M2D_ACK
46 } state;
47
48 u8 uuid_e[WPS_UUID_LEN];
49 u8 uuid_r[WPS_UUID_LEN];
50 u8 mac_addr_e[ETH_ALEN];
51 u8 nonce_e[WPS_NONCE_LEN];
52 u8 nonce_r[WPS_NONCE_LEN];
53 u8 psk1[WPS_PSK_LEN];
54 u8 psk2[WPS_PSK_LEN];
55 u8 snonce[2 * WPS_SECRET_NONCE_LEN];
56 u8 peer_hash1[WPS_HASH_LEN];
57 u8 peer_hash2[WPS_HASH_LEN];
58
59 struct wpabuf *dh_privkey;
60 struct wpabuf *dh_pubkey_e;
61 struct wpabuf *dh_pubkey_r;
62 u8 authkey[WPS_AUTHKEY_LEN];
63 u8 keywrapkey[WPS_KEYWRAPKEY_LEN];
64 u8 emsk[WPS_EMSK_LEN];
65
66 struct wpabuf *last_msg;
67
68 u8 *dev_password;
69 size_t dev_password_len;
70 u16 dev_pw_id;
71 int pbc;
72
73 /**
74 * request_type - Request Type attribute from (Re)AssocReq
75 */
76 u8 request_type;
77
78 /**
79 * encr_type - Available encryption types
80 */
81 u16 encr_type;
82
83 /**
84 * auth_type - Available authentication types
85 */
86 u16 auth_type;
87
88 u8 *new_psk;
89 size_t new_psk_len;
90
91 int wps_pin_revealed;
92 struct wps_credential cred;
93
94 struct wps_device_data peer_dev;
95
96 /**
97 * config_error - Configuration Error value to be used in NACK
98 */
99 u16 config_error;
100
101 int ext_reg;
102 };
103
104
105 struct wps_parse_attr {
106 /* fixed length fields */
107 const u8 *version; /* 1 octet */
108 const u8 *msg_type; /* 1 octet */
109 const u8 *enrollee_nonce; /* WPS_NONCE_LEN (16) octets */
110 const u8 *registrar_nonce; /* WPS_NONCE_LEN (16) octets */
111 const u8 *uuid_r; /* WPS_UUID_LEN (16) octets */
112 const u8 *uuid_e; /* WPS_UUID_LEN (16) octets */
113 const u8 *auth_type_flags; /* 2 octets */
114 const u8 *encr_type_flags; /* 2 octets */
115 const u8 *conn_type_flags; /* 1 octet */
116 const u8 *config_methods; /* 2 octets */
117 const u8 *sel_reg_config_methods; /* 2 octets */
118 const u8 *primary_dev_type; /* 8 octets */
119 const u8 *rf_bands; /* 1 octet */
120 const u8 *assoc_state; /* 2 octets */
121 const u8 *config_error; /* 2 octets */
122 const u8 *dev_password_id; /* 2 octets */
123 const u8 *os_version; /* 4 octets */
124 const u8 *wps_state; /* 1 octet */
125 const u8 *authenticator; /* WPS_AUTHENTICATOR_LEN (8) octets */
126 const u8 *r_hash1; /* WPS_HASH_LEN (32) octets */
127 const u8 *r_hash2; /* WPS_HASH_LEN (32) octets */
128 const u8 *e_hash1; /* WPS_HASH_LEN (32) octets */
129 const u8 *e_hash2; /* WPS_HASH_LEN (32) octets */
130 const u8 *r_snonce1; /* WPS_SECRET_NONCE_LEN (16) octets */
131 const u8 *r_snonce2; /* WPS_SECRET_NONCE_LEN (16) octets */
132 const u8 *e_snonce1; /* WPS_SECRET_NONCE_LEN (16) octets */
133 const u8 *e_snonce2; /* WPS_SECRET_NONCE_LEN (16) octets */
134 const u8 *key_wrap_auth; /* WPS_KWA_LEN (8) octets */
135 const u8 *auth_type; /* 2 octets */
136 const u8 *encr_type; /* 2 octets */
137 const u8 *network_idx; /* 1 octet */
138 const u8 *network_key_idx; /* 1 octet */
139 const u8 *mac_addr; /* ETH_ALEN (6) octets */
140 const u8 *key_prov_auto; /* 1 octet (Bool) */
141 const u8 *dot1x_enabled; /* 1 octet (Bool) */
142 const u8 *selected_registrar; /* 1 octet (Bool) */
143 const u8 *request_type; /* 1 octet */
144 const u8 *response_type; /* 1 octet */
145 const u8 *ap_setup_locked; /* 1 octet */
146
147 /* variable length fields */
148 const u8 *manufacturer;
149 size_t manufacturer_len;
150 const u8 *model_name;
151 size_t model_name_len;
152 const u8 *model_number;
153 size_t model_number_len;
154 const u8 *serial_number;
155 size_t serial_number_len;
156 const u8 *dev_name;
157 size_t dev_name_len;
158 const u8 *public_key;
159 size_t public_key_len;
160 const u8 *encr_settings;
161 size_t encr_settings_len;
162 const u8 *ssid; /* <= 32 octets */
163 size_t ssid_len;
164 const u8 *network_key; /* <= 64 octets */
165 size_t network_key_len;
166 const u8 *eap_type; /* <= 8 octets */
167 size_t eap_type_len;
168 const u8 *eap_identity; /* <= 64 octets */
169 size_t eap_identity_len;
170
171 /* attributes that can occur multiple times */
172 #define MAX_CRED_COUNT 10
173 const u8 *cred[MAX_CRED_COUNT];
174 size_t cred_len[MAX_CRED_COUNT];
175 size_t num_cred;
176 };
177
178 /* wps_common.c */
179 void wps_kdf(const u8 *key, const u8 *label_prefix, size_t label_prefix_len,
180 const char *label, u8 *res, size_t res_len);
181 int wps_derive_keys(struct wps_data *wps);
182 void wps_derive_psk(struct wps_data *wps, const u8 *dev_passwd,
183 size_t dev_passwd_len);
184 struct wpabuf * wps_decrypt_encr_settings(struct wps_data *wps, const u8 *encr,
185 size_t encr_len);
186 void wps_fail_event(struct wps_context *wps, enum wps_msg_type msg);
187 void wps_success_event(struct wps_context *wps);
188 void wps_pwd_auth_fail_event(struct wps_context *wps, int enrollee, int part);
189 void wps_pbc_overlap_event(struct wps_context *wps);
190 void wps_pbc_timeout_event(struct wps_context *wps);
191
192 /* wps_attr_parse.c */
193 int wps_parse_msg(const struct wpabuf *msg, struct wps_parse_attr *attr);
194
195 /* wps_attr_build.c */
196 int wps_build_public_key(struct wps_data *wps, struct wpabuf *msg);
197 int wps_build_req_type(struct wpabuf *msg, enum wps_request_type type);
198 int wps_build_config_methods(struct wpabuf *msg, u16 methods);
199 int wps_build_uuid_e(struct wpabuf *msg, const u8 *uuid);
200 int wps_build_dev_password_id(struct wpabuf *msg, u16 id);
201 int wps_build_config_error(struct wpabuf *msg, u16 err);
202 int wps_build_authenticator(struct wps_data *wps, struct wpabuf *msg);
203 int wps_build_key_wrap_auth(struct wps_data *wps, struct wpabuf *msg);
204 int wps_build_encr_settings(struct wps_data *wps, struct wpabuf *msg,
205 struct wpabuf *plain);
206 int wps_build_version(struct wpabuf *msg);
207 int wps_build_msg_type(struct wpabuf *msg, enum wps_msg_type msg_type);
208 int wps_build_enrollee_nonce(struct wps_data *wps, struct wpabuf *msg);
209 int wps_build_registrar_nonce(struct wps_data *wps, struct wpabuf *msg);
210 int wps_build_auth_type_flags(struct wps_data *wps, struct wpabuf *msg);
211 int wps_build_encr_type_flags(struct wps_data *wps, struct wpabuf *msg);
212 int wps_build_conn_type_flags(struct wps_data *wps, struct wpabuf *msg);
213 int wps_build_assoc_state(struct wps_data *wps, struct wpabuf *msg);
214
215 /* wps_attr_process.c */
216 int wps_process_authenticator(struct wps_data *wps, const u8 *authenticator,
217 const struct wpabuf *msg);
218 int wps_process_key_wrap_auth(struct wps_data *wps, struct wpabuf *msg,
219 const u8 *key_wrap_auth);
220 int wps_process_cred(struct wps_parse_attr *attr,
221 struct wps_credential *cred);
222 int wps_process_ap_settings(struct wps_parse_attr *attr,
223 struct wps_credential *cred);
224
225 /* wps_enrollee.c */
226 struct wpabuf * wps_enrollee_get_msg(struct wps_data *wps,
227 enum wsc_op_code *op_code);
228 enum wps_process_res wps_enrollee_process_msg(struct wps_data *wps,
229 enum wsc_op_code op_code,
230 const struct wpabuf *msg);
231
232 /* wps_registrar.c */
233 struct wpabuf * wps_registrar_get_msg(struct wps_data *wps,
234 enum wsc_op_code *op_code);
235 enum wps_process_res wps_registrar_process_msg(struct wps_data *wps,
236 enum wsc_op_code op_code,
237 const struct wpabuf *msg);
238
239
wps_version_supported(const u8 * version)240 static inline int wps_version_supported(const u8 *version)
241 {
242 /* Require major version match, but allow minor version differences */
243 return version && (*version & 0xf0) == (WPS_VERSION & 0xf0);
244 }
245
246 #endif /* WPS_I_H */
247