wps_i.h revision b7b4d0ec07161a6d76c40ba7ef1306e82fbb7e15 
1/*
2 * Wi-Fi Protected Setup - internal definitions
3 * Copyright (c) 2008-2012, Jouni Malinen <j@w1.fi>
4 *
5 * This software may be distributed under the terms of the BSD license.
6 * See README for more details.
7 */
8
9#ifndef WPS_I_H
10#define WPS_I_H
11
12#include "wps.h"
13#include "wps_attr_parse.h"
14
15struct wps_nfc_pw_token;
16
17/**
18 * struct wps_data - WPS registration protocol data
19 *
20 * This data is stored at the EAP-WSC server/peer method and it is kept for a
21 * single registration protocol run.
22 */
23struct wps_data {
24	/**
25	 * wps - Pointer to long term WPS context
26	 */
27	struct wps_context *wps;
28
29	/**
30	 * registrar - Whether this end is a Registrar
31	 */
32	int registrar;
33
34	/**
35	 * er - Whether the local end is an external registrar
36	 */
37	int er;
38
39	enum {
40		/* Enrollee states */
41		SEND_M1, RECV_M2, SEND_M3, RECV_M4, SEND_M5, RECV_M6, SEND_M7,
42		RECV_M8, RECEIVED_M2D, WPS_MSG_DONE, RECV_ACK, WPS_FINISHED,
43		SEND_WSC_NACK,
44
45		/* Registrar states */
46		RECV_M1, SEND_M2, RECV_M3, SEND_M4, RECV_M5, SEND_M6,
47		RECV_M7, SEND_M8, RECV_DONE, SEND_M2D, RECV_M2D_ACK
48	} state;
49
50	u8 uuid_e[WPS_UUID_LEN];
51	u8 uuid_r[WPS_UUID_LEN];
52	u8 mac_addr_e[ETH_ALEN];
53	u8 nonce_e[WPS_NONCE_LEN];
54	u8 nonce_r[WPS_NONCE_LEN];
55	u8 psk1[WPS_PSK_LEN];
56	u8 psk2[WPS_PSK_LEN];
57	u8 snonce[2 * WPS_SECRET_NONCE_LEN];
58	u8 peer_hash1[WPS_HASH_LEN];
59	u8 peer_hash2[WPS_HASH_LEN];
60
61	struct wpabuf *dh_privkey;
62	struct wpabuf *dh_pubkey_e;
63	struct wpabuf *dh_pubkey_r;
64	u8 authkey[WPS_AUTHKEY_LEN];
65	u8 keywrapkey[WPS_KEYWRAPKEY_LEN];
66	u8 emsk[WPS_EMSK_LEN];
67
68	struct wpabuf *last_msg;
69
70	u8 *dev_password;
71	size_t dev_password_len;
72	u16 dev_pw_id;
73	int pbc;
74	u8 *alt_dev_password;
75	size_t alt_dev_password_len;
76	u16 alt_dev_pw_id;
77
78	/**
79	 * request_type - Request Type attribute from (Re)AssocReq
80	 */
81	u8 request_type;
82
83	/**
84	 * encr_type - Available encryption types
85	 */
86	u16 encr_type;
87
88	/**
89	 * auth_type - Available authentication types
90	 */
91	u16 auth_type;
92
93	u8 *new_psk;
94	size_t new_psk_len;
95
96	int wps_pin_revealed;
97	struct wps_credential cred;
98
99	struct wps_device_data peer_dev;
100
101	/**
102	 * config_error - Configuration Error value to be used in NACK
103	 */
104	u16 config_error;
105	u16 error_indication;
106
107	int ext_reg;
108	int int_reg;
109
110	struct wps_credential *new_ap_settings;
111
112	void *dh_ctx;
113
114	void (*ap_settings_cb)(void *ctx, const struct wps_credential *cred);
115	void *ap_settings_cb_ctx;
116
117	struct wps_credential *use_cred;
118
119	int use_psk_key;
120	u8 p2p_dev_addr[ETH_ALEN]; /* P2P Device Address of the client or
121				    * 00:00:00:00:00:00 if not a P2p client */
122	int pbc_in_m1;
123
124	struct wps_nfc_pw_token *nfc_pw_token;
125};
126
127
128/* wps_common.c */
129void wps_kdf(const u8 *key, const u8 *label_prefix, size_t label_prefix_len,
130	     const char *label, u8 *res, size_t res_len);
131int wps_derive_keys(struct wps_data *wps);
132void wps_derive_psk(struct wps_data *wps, const u8 *dev_passwd,
133		    size_t dev_passwd_len);
134struct wpabuf * wps_decrypt_encr_settings(struct wps_data *wps, const u8 *encr,
135					  size_t encr_len);
136void wps_fail_event(struct wps_context *wps, enum wps_msg_type msg,
137		    u16 config_error, u16 error_indication, const u8 *mac_addr);
138void wps_success_event(struct wps_context *wps, const u8 *mac_addr);
139void wps_pwd_auth_fail_event(struct wps_context *wps, int enrollee, int part,
140			     const u8 *mac_addr);
141void wps_pbc_overlap_event(struct wps_context *wps);
142void wps_pbc_timeout_event(struct wps_context *wps);
143void wps_pbc_active_event(struct wps_context *wps);
144void wps_pbc_disable_event(struct wps_context *wps);
145
146struct wpabuf * wps_build_wsc_ack(struct wps_data *wps);
147struct wpabuf * wps_build_wsc_nack(struct wps_data *wps);
148
149/* wps_attr_build.c */
150int wps_build_public_key(struct wps_data *wps, struct wpabuf *msg);
151int wps_build_req_type(struct wpabuf *msg, enum wps_request_type type);
152int wps_build_resp_type(struct wpabuf *msg, enum wps_response_type type);
153int wps_build_config_methods(struct wpabuf *msg, u16 methods);
154int wps_build_uuid_e(struct wpabuf *msg, const u8 *uuid);
155int wps_build_dev_password_id(struct wpabuf *msg, u16 id);
156int wps_build_config_error(struct wpabuf *msg, u16 err);
157int wps_build_authenticator(struct wps_data *wps, struct wpabuf *msg);
158int wps_build_key_wrap_auth(struct wps_data *wps, struct wpabuf *msg);
159int wps_build_encr_settings(struct wps_data *wps, struct wpabuf *msg,
160			    struct wpabuf *plain);
161int wps_build_version(struct wpabuf *msg);
162int wps_build_wfa_ext(struct wpabuf *msg, int req_to_enroll,
163		      const u8 *auth_macs, size_t auth_macs_count);
164int wps_build_msg_type(struct wpabuf *msg, enum wps_msg_type msg_type);
165int wps_build_enrollee_nonce(struct wps_data *wps, struct wpabuf *msg);
166int wps_build_registrar_nonce(struct wps_data *wps, struct wpabuf *msg);
167int wps_build_auth_type_flags(struct wps_data *wps, struct wpabuf *msg);
168int wps_build_encr_type_flags(struct wps_data *wps, struct wpabuf *msg);
169int wps_build_conn_type_flags(struct wps_data *wps, struct wpabuf *msg);
170int wps_build_assoc_state(struct wps_data *wps, struct wpabuf *msg);
171int wps_build_oob_dev_pw(struct wpabuf *msg, u16 dev_pw_id,
172			 const struct wpabuf *pubkey, const u8 *dev_pw,
173			 size_t dev_pw_len);
174struct wpabuf * wps_ie_encapsulate(struct wpabuf *data);
175int wps_build_mac_addr(struct wpabuf *msg, const u8 *addr);
176
177/* wps_attr_process.c */
178int wps_process_authenticator(struct wps_data *wps, const u8 *authenticator,
179			      const struct wpabuf *msg);
180int wps_process_key_wrap_auth(struct wps_data *wps, struct wpabuf *msg,
181			      const u8 *key_wrap_auth);
182int wps_process_cred(struct wps_parse_attr *attr,
183		     struct wps_credential *cred);
184int wps_process_ap_settings(struct wps_parse_attr *attr,
185			    struct wps_credential *cred);
186
187/* wps_enrollee.c */
188struct wpabuf * wps_enrollee_get_msg(struct wps_data *wps,
189				     enum wsc_op_code *op_code);
190enum wps_process_res wps_enrollee_process_msg(struct wps_data *wps,
191					      enum wsc_op_code op_code,
192					      const struct wpabuf *msg);
193
194/* wps_registrar.c */
195struct wpabuf * wps_registrar_get_msg(struct wps_data *wps,
196				      enum wsc_op_code *op_code);
197enum wps_process_res wps_registrar_process_msg(struct wps_data *wps,
198					       enum wsc_op_code op_code,
199					       const struct wpabuf *msg);
200int wps_build_cred(struct wps_data *wps, struct wpabuf *msg);
201int wps_device_store(struct wps_registrar *reg,
202		     struct wps_device_data *dev, const u8 *uuid);
203void wps_registrar_selected_registrar_changed(struct wps_registrar *reg,
204					      u16 dev_pw_id);
205const u8 * wps_authorized_macs(struct wps_registrar *reg, size_t *count);
206int wps_registrar_pbc_overlap(struct wps_registrar *reg,
207			      const u8 *addr, const u8 *uuid_e);
208void wps_registrar_remove_nfc_pw_token(struct wps_registrar *reg,
209				       struct wps_nfc_pw_token *token);
210
211#endif /* WPS_I_H */
212