xref: /freebsd/contrib/wpa/src/wps/wps_defs.h (revision 1f4bcc459a76b7aa664f3fd557684cd0ba6da352)
1 /*
2  * Wi-Fi Protected Setup - message definitions
3  * Copyright (c) 2008, 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_DEFS_H
10 #define WPS_DEFS_H
11 
12 #ifdef CONFIG_WPS_TESTING
13 
14 extern int wps_version_number;
15 extern int wps_testing_dummy_cred;
16 extern int wps_corrupt_pkhash;
17 #define WPS_VERSION wps_version_number
18 
19 #else /* CONFIG_WPS_TESTING */
20 
21 #define WPS_VERSION 0x20
22 
23 #endif /* CONFIG_WPS_TESTING */
24 
25 /* Diffie-Hellman 1536-bit MODP Group; RFC 3526, Group 5 */
26 #define WPS_DH_GROUP 5
27 
28 #define WPS_UUID_LEN 16
29 #define WPS_NONCE_LEN 16
30 #define WPS_AUTHENTICATOR_LEN 8
31 #define WPS_AUTHKEY_LEN 32
32 #define WPS_KEYWRAPKEY_LEN 16
33 #define WPS_EMSK_LEN 32
34 #define WPS_PSK_LEN 16
35 #define WPS_SECRET_NONCE_LEN 16
36 #define WPS_HASH_LEN 32
37 #define WPS_KWA_LEN 8
38 #define WPS_MGMTAUTHKEY_LEN 32
39 #define WPS_MGMTENCKEY_LEN 16
40 #define WPS_MGMT_KEY_ID_LEN 16
41 #define WPS_OOB_DEVICE_PASSWORD_MIN_LEN 16
42 #define WPS_OOB_DEVICE_PASSWORD_LEN 32
43 #define WPS_OOB_PUBKEY_HASH_LEN 20
44 #define WPS_DEV_NAME_MAX_LEN 32
45 #define WPS_MANUFACTURER_MAX_LEN 64
46 #define WPS_MODEL_NAME_MAX_LEN 32
47 #define WPS_MODEL_NUMBER_MAX_LEN 32
48 #define WPS_SERIAL_NUMBER_MAX_LEN 32
49 
50 /* Attribute Types */
51 enum wps_attribute {
52 	ATTR_AP_CHANNEL = 0x1001,
53 	ATTR_ASSOC_STATE = 0x1002,
54 	ATTR_AUTH_TYPE = 0x1003,
55 	ATTR_AUTH_TYPE_FLAGS = 0x1004,
56 	ATTR_AUTHENTICATOR = 0x1005,
57 	ATTR_CONFIG_METHODS = 0x1008,
58 	ATTR_CONFIG_ERROR = 0x1009,
59 	ATTR_CONFIRM_URL4 = 0x100a,
60 	ATTR_CONFIRM_URL6 = 0x100b,
61 	ATTR_CONN_TYPE = 0x100c,
62 	ATTR_CONN_TYPE_FLAGS = 0x100d,
63 	ATTR_CRED = 0x100e,
64 	ATTR_ENCR_TYPE = 0x100f,
65 	ATTR_ENCR_TYPE_FLAGS = 0x1010,
66 	ATTR_DEV_NAME = 0x1011,
67 	ATTR_DEV_PASSWORD_ID = 0x1012,
68 	ATTR_E_HASH1 = 0x1014,
69 	ATTR_E_HASH2 = 0x1015,
70 	ATTR_E_SNONCE1 = 0x1016,
71 	ATTR_E_SNONCE2 = 0x1017,
72 	ATTR_ENCR_SETTINGS = 0x1018,
73 	ATTR_ENROLLEE_NONCE = 0x101a,
74 	ATTR_FEATURE_ID = 0x101b,
75 	ATTR_IDENTITY = 0x101c,
76 	ATTR_IDENTITY_PROOF = 0x101d,
77 	ATTR_KEY_WRAP_AUTH = 0x101e,
78 	ATTR_KEY_ID = 0x101f,
79 	ATTR_MAC_ADDR = 0x1020,
80 	ATTR_MANUFACTURER = 0x1021,
81 	ATTR_MSG_TYPE = 0x1022,
82 	ATTR_MODEL_NAME = 0x1023,
83 	ATTR_MODEL_NUMBER = 0x1024,
84 	ATTR_NETWORK_INDEX = 0x1026,
85 	ATTR_NETWORK_KEY = 0x1027,
86 	ATTR_NETWORK_KEY_INDEX = 0x1028,
87 	ATTR_NEW_DEVICE_NAME = 0x1029,
88 	ATTR_NEW_PASSWORD = 0x102a,
89 	ATTR_OOB_DEVICE_PASSWORD = 0x102c,
90 	ATTR_OS_VERSION = 0x102d,
91 	ATTR_POWER_LEVEL = 0x102f,
92 	ATTR_PSK_CURRENT = 0x1030,
93 	ATTR_PSK_MAX = 0x1031,
94 	ATTR_PUBLIC_KEY = 0x1032,
95 	ATTR_RADIO_ENABLE = 0x1033,
96 	ATTR_REBOOT = 0x1034,
97 	ATTR_REGISTRAR_CURRENT = 0x1035,
98 	ATTR_REGISTRAR_ESTABLISHED = 0x1036,
99 	ATTR_REGISTRAR_LIST = 0x1037,
100 	ATTR_REGISTRAR_MAX = 0x1038,
101 	ATTR_REGISTRAR_NONCE = 0x1039,
102 	ATTR_REQUEST_TYPE = 0x103a,
103 	ATTR_RESPONSE_TYPE = 0x103b,
104 	ATTR_RF_BANDS = 0x103c,
105 	ATTR_R_HASH1 = 0x103d,
106 	ATTR_R_HASH2 = 0x103e,
107 	ATTR_R_SNONCE1 = 0x103f,
108 	ATTR_R_SNONCE2 = 0x1040,
109 	ATTR_SELECTED_REGISTRAR = 0x1041,
110 	ATTR_SERIAL_NUMBER = 0x1042,
111 	ATTR_WPS_STATE = 0x1044,
112 	ATTR_SSID = 0x1045,
113 	ATTR_TOTAL_NETWORKS = 0x1046,
114 	ATTR_UUID_E = 0x1047,
115 	ATTR_UUID_R = 0x1048,
116 	ATTR_VENDOR_EXT = 0x1049,
117 	ATTR_VERSION = 0x104a,
118 	ATTR_X509_CERT_REQ = 0x104b,
119 	ATTR_X509_CERT = 0x104c,
120 	ATTR_EAP_IDENTITY = 0x104d,
121 	ATTR_MSG_COUNTER = 0x104e,
122 	ATTR_PUBKEY_HASH = 0x104f,
123 	ATTR_REKEY_KEY = 0x1050,
124 	ATTR_KEY_LIFETIME = 0x1051,
125 	ATTR_PERMITTED_CFG_METHODS = 0x1052,
126 	ATTR_SELECTED_REGISTRAR_CONFIG_METHODS = 0x1053,
127 	ATTR_PRIMARY_DEV_TYPE = 0x1054,
128 	ATTR_SECONDARY_DEV_TYPE_LIST = 0x1055,
129 	ATTR_PORTABLE_DEV = 0x1056,
130 	ATTR_AP_SETUP_LOCKED = 0x1057,
131 	ATTR_APPLICATION_EXT = 0x1058,
132 	ATTR_EAP_TYPE = 0x1059,
133 	ATTR_IV = 0x1060,
134 	ATTR_KEY_PROVIDED_AUTO = 0x1061,
135 	ATTR_802_1X_ENABLED = 0x1062,
136 	ATTR_APPSESSIONKEY = 0x1063,
137 	ATTR_WEPTRANSMITKEY = 0x1064,
138 	ATTR_REQUESTED_DEV_TYPE = 0x106a,
139 	ATTR_EXTENSIBILITY_TEST = 0x10fa /* _NOT_ defined in the spec */
140 };
141 
142 #define WPS_VENDOR_ID_WFA 14122
143 
144 /* WFA Vendor Extension subelements */
145 enum {
146 	WFA_ELEM_VERSION2 = 0x00,
147 	WFA_ELEM_AUTHORIZEDMACS = 0x01,
148 	WFA_ELEM_NETWORK_KEY_SHAREABLE = 0x02,
149 	WFA_ELEM_REQUEST_TO_ENROLL = 0x03,
150 	WFA_ELEM_SETTINGS_DELAY_TIME = 0x04,
151 	WFA_ELEM_REGISTRAR_CONFIGURATION_METHODS = 0x05
152 };
153 
154 /* Device Password ID */
155 enum wps_dev_password_id {
156 	DEV_PW_DEFAULT = 0x0000,
157 	DEV_PW_USER_SPECIFIED = 0x0001,
158 	DEV_PW_MACHINE_SPECIFIED = 0x0002,
159 	DEV_PW_REKEY = 0x0003,
160 	DEV_PW_PUSHBUTTON = 0x0004,
161 	DEV_PW_REGISTRAR_SPECIFIED = 0x0005,
162 	DEV_PW_NFC_CONNECTION_HANDOVER = 0x0007,
163 	DEV_PW_P2PS_DEFAULT = 0x0008
164 };
165 
166 /* Message Type */
167 enum wps_msg_type {
168 	WPS_Beacon = 0x01,
169 	WPS_ProbeRequest = 0x02,
170 	WPS_ProbeResponse = 0x03,
171 	WPS_M1 = 0x04,
172 	WPS_M2 = 0x05,
173 	WPS_M2D = 0x06,
174 	WPS_M3 = 0x07,
175 	WPS_M4 = 0x08,
176 	WPS_M5 = 0x09,
177 	WPS_M6 = 0x0a,
178 	WPS_M7 = 0x0b,
179 	WPS_M8 = 0x0c,
180 	WPS_WSC_ACK = 0x0d,
181 	WPS_WSC_NACK = 0x0e,
182 	WPS_WSC_DONE = 0x0f
183 };
184 
185 /* Authentication Type Flags */
186 #define WPS_AUTH_OPEN 0x0001
187 #define WPS_AUTH_WPAPSK 0x0002
188 #define WPS_AUTH_SHARED 0x0004 /* deprecated */
189 #define WPS_AUTH_WPA 0x0008
190 #define WPS_AUTH_WPA2 0x0010
191 #define WPS_AUTH_WPA2PSK 0x0020
192 #define WPS_AUTH_TYPES (WPS_AUTH_OPEN | WPS_AUTH_WPAPSK | WPS_AUTH_SHARED | \
193 			WPS_AUTH_WPA | WPS_AUTH_WPA2 | WPS_AUTH_WPA2PSK)
194 
195 /* Encryption Type Flags */
196 #define WPS_ENCR_NONE 0x0001
197 #define WPS_ENCR_WEP 0x0002 /* deprecated */
198 #define WPS_ENCR_TKIP 0x0004
199 #define WPS_ENCR_AES 0x0008
200 #define WPS_ENCR_TYPES (WPS_ENCR_NONE | WPS_ENCR_WEP | WPS_ENCR_TKIP | \
201 			WPS_ENCR_AES)
202 
203 /* Configuration Error */
204 enum wps_config_error {
205 	WPS_CFG_NO_ERROR = 0,
206 	WPS_CFG_OOB_IFACE_READ_ERROR = 1,
207 	WPS_CFG_DECRYPTION_CRC_FAILURE = 2,
208 	WPS_CFG_24_CHAN_NOT_SUPPORTED = 3,
209 	WPS_CFG_50_CHAN_NOT_SUPPORTED = 4,
210 	WPS_CFG_SIGNAL_TOO_WEAK = 5,
211 	WPS_CFG_NETWORK_AUTH_FAILURE = 6,
212 	WPS_CFG_NETWORK_ASSOC_FAILURE = 7,
213 	WPS_CFG_NO_DHCP_RESPONSE = 8,
214 	WPS_CFG_FAILED_DHCP_CONFIG = 9,
215 	WPS_CFG_IP_ADDR_CONFLICT = 10,
216 	WPS_CFG_NO_CONN_TO_REGISTRAR = 11,
217 	WPS_CFG_MULTIPLE_PBC_DETECTED = 12,
218 	WPS_CFG_ROGUE_SUSPECTED = 13,
219 	WPS_CFG_DEVICE_BUSY = 14,
220 	WPS_CFG_SETUP_LOCKED = 15,
221 	WPS_CFG_MSG_TIMEOUT = 16,
222 	WPS_CFG_REG_SESS_TIMEOUT = 17,
223 	WPS_CFG_DEV_PASSWORD_AUTH_FAILURE = 18,
224 	WPS_CFG_60G_CHAN_NOT_SUPPORTED = 19,
225 	WPS_CFG_PUBLIC_KEY_HASH_MISMATCH = 20
226 };
227 
228 /* Vendor specific Error Indication for WPS event messages */
229 enum wps_error_indication {
230 	WPS_EI_NO_ERROR,
231 	WPS_EI_SECURITY_TKIP_ONLY_PROHIBITED,
232 	WPS_EI_SECURITY_WEP_PROHIBITED,
233 	WPS_EI_AUTH_FAILURE,
234 	NUM_WPS_EI_VALUES
235 };
236 
237 /* RF Bands */
238 #define WPS_RF_24GHZ 0x01
239 #define WPS_RF_50GHZ 0x02
240 #define WPS_RF_60GHZ 0x04
241 
242 /* Config Methods */
243 #define WPS_CONFIG_USBA 0x0001
244 #define WPS_CONFIG_ETHERNET 0x0002
245 #define WPS_CONFIG_LABEL 0x0004
246 #define WPS_CONFIG_DISPLAY 0x0008
247 #define WPS_CONFIG_EXT_NFC_TOKEN 0x0010
248 #define WPS_CONFIG_INT_NFC_TOKEN 0x0020
249 #define WPS_CONFIG_NFC_INTERFACE 0x0040
250 #define WPS_CONFIG_PUSHBUTTON 0x0080
251 #define WPS_CONFIG_KEYPAD 0x0100
252 #define WPS_CONFIG_VIRT_PUSHBUTTON 0x0280
253 #define WPS_CONFIG_PHY_PUSHBUTTON 0x0480
254 #define WPS_CONFIG_P2PS 0x1000
255 #define WPS_CONFIG_VIRT_DISPLAY 0x2008
256 #define WPS_CONFIG_PHY_DISPLAY 0x4008
257 
258 /* Connection Type Flags */
259 #define WPS_CONN_ESS 0x01
260 #define WPS_CONN_IBSS 0x02
261 
262 /* Wi-Fi Protected Setup State */
263 enum wps_state {
264 	WPS_STATE_NOT_CONFIGURED = 1,
265 	WPS_STATE_CONFIGURED = 2
266 };
267 
268 /* Association State */
269 enum wps_assoc_state {
270 	WPS_ASSOC_NOT_ASSOC = 0,
271 	WPS_ASSOC_CONN_SUCCESS = 1,
272 	WPS_ASSOC_CFG_FAILURE = 2,
273 	WPS_ASSOC_FAILURE = 3,
274 	WPS_ASSOC_IP_FAILURE = 4
275 };
276 
277 
278 #define WPS_DEV_OUI_WFA 0x0050f204
279 
280 enum wps_dev_categ {
281 	WPS_DEV_COMPUTER = 1,
282 	WPS_DEV_INPUT = 2,
283 	WPS_DEV_PRINTER = 3,
284 	WPS_DEV_CAMERA = 4,
285 	WPS_DEV_STORAGE = 5,
286 	WPS_DEV_NETWORK_INFRA = 6,
287 	WPS_DEV_DISPLAY = 7,
288 	WPS_DEV_MULTIMEDIA = 8,
289 	WPS_DEV_GAMING = 9,
290 	WPS_DEV_PHONE = 10,
291 	WPS_DEV_AUDIO = 11,
292 };
293 
294 enum wps_dev_subcateg {
295 	WPS_DEV_COMPUTER_PC = 1,
296 	WPS_DEV_COMPUTER_SERVER = 2,
297 	WPS_DEV_COMPUTER_MEDIA_CENTER = 3,
298 	WPS_DEV_COMPUTER_ULTRA_MOBILE = 4,
299 	WPS_DEV_COMPUTER_NOTEBOOK = 5,
300 	WPS_DEV_COMPUTER_DESKTOP = 6,
301 	WPS_DEV_COMPUTER_MID = 7,
302 	WPS_DEV_COMPUTER_NETBOOK = 8,
303 	WPS_DEV_COMPUTER_TABLET = 9,
304 	WPS_DEV_INPUT_KEYBOARD = 1,
305 	WPS_DEV_INPUT_MOUSE = 2,
306 	WPS_DEV_INPUT_JOYSTICK = 3,
307 	WPS_DEV_INPUT_TRACKBALL = 4,
308 	WPS_DEV_INPUT_GAMING = 5,
309 	WPS_DEV_INPUT_REMOTE = 6,
310 	WPS_DEV_INPUT_TOUCHSCREEN = 7,
311 	WPS_DEV_INPUT_BIOMETRIC_READER = 8,
312 	WPS_DEV_INPUT_BARCODE_READER = 9,
313 	WPS_DEV_PRINTER_PRINTER = 1,
314 	WPS_DEV_PRINTER_SCANNER = 2,
315 	WPS_DEV_PRINTER_FAX = 3,
316 	WPS_DEV_PRINTER_COPIER = 4,
317 	WPS_DEV_PRINTER_ALL_IN_ONE = 5,
318 	WPS_DEV_CAMERA_DIGITAL_STILL_CAMERA = 1,
319 	WPS_DEV_CAMERA_VIDEO = 2,
320 	WPS_DEV_CAMERA_WEB = 3,
321 	WPS_DEV_CAMERA_SECURITY = 4,
322 	WPS_DEV_STORAGE_NAS = 1,
323 	WPS_DEV_NETWORK_INFRA_AP = 1,
324 	WPS_DEV_NETWORK_INFRA_ROUTER = 2,
325 	WPS_DEV_NETWORK_INFRA_SWITCH = 3,
326 	WPS_DEV_NETWORK_INFRA_GATEWAY = 4,
327 	WPS_DEV_NETWORK_INFRA_BRIDGE = 5,
328 	WPS_DEV_DISPLAY_TV = 1,
329 	WPS_DEV_DISPLAY_PICTURE_FRAME = 2,
330 	WPS_DEV_DISPLAY_PROJECTOR = 3,
331 	WPS_DEV_DISPLAY_MONITOR = 4,
332 	WPS_DEV_MULTIMEDIA_DAR = 1,
333 	WPS_DEV_MULTIMEDIA_PVR = 2,
334 	WPS_DEV_MULTIMEDIA_MCX = 3,
335 	WPS_DEV_MULTIMEDIA_SET_TOP_BOX = 4,
336 	WPS_DEV_MULTIMEDIA_MEDIA_SERVER = 5,
337 	WPS_DEV_MULTIMEDIA_PORTABLE_VIDEO_PLAYER = 6,
338 	WPS_DEV_GAMING_XBOX = 1,
339 	WPS_DEV_GAMING_XBOX360 = 2,
340 	WPS_DEV_GAMING_PLAYSTATION = 3,
341 	WPS_DEV_GAMING_GAME_CONSOLE = 4,
342 	WPS_DEV_GAMING_PORTABLE_DEVICE = 5,
343 	WPS_DEV_PHONE_WINDOWS_MOBILE = 1,
344 	WPS_DEV_PHONE_SINGLE_MODE = 2,
345 	WPS_DEV_PHONE_DUAL_MODE = 3,
346 	WPS_DEV_PHONE_SP_SINGLE_MODE = 4,
347 	WPS_DEV_PHONE_SP_DUAL_MODE = 5,
348 	WPS_DEV_AUDIO_TUNER_RECV = 1,
349 	WPS_DEV_AUDIO_SPEAKERS = 2,
350 	WPS_DEV_AUDIO_PMP = 3,
351 	WPS_DEV_AUDIO_HEADSET = 4,
352 	WPS_DEV_AUDIO_HEADPHONES = 5,
353 	WPS_DEV_AUDIO_MICROPHONE = 6,
354 	WPS_DEV_AUDIO_HOME_THEATRE = 7,
355 };
356 
357 
358 /* Request Type */
359 enum wps_request_type {
360 	WPS_REQ_ENROLLEE_INFO = 0,
361 	WPS_REQ_ENROLLEE = 1,
362 	WPS_REQ_REGISTRAR = 2,
363 	WPS_REQ_WLAN_MANAGER_REGISTRAR = 3
364 };
365 
366 /* Response Type */
367 enum wps_response_type {
368 	WPS_RESP_ENROLLEE_INFO = 0,
369 	WPS_RESP_ENROLLEE = 1,
370 	WPS_RESP_REGISTRAR = 2,
371 	WPS_RESP_AP = 3
372 };
373 
374 /* Walk Time for push button configuration (in seconds) */
375 #define WPS_PBC_WALK_TIME 120
376 
377 #define WPS_MAX_AUTHORIZED_MACS 5
378 
379 #endif /* WPS_DEFS_H */
380