wps_defs.h revision 214734
1189251Ssam/* 2189251Ssam * Wi-Fi Protected Setup - message definitions 3189251Ssam * Copyright (c) 2008, Jouni Malinen <j@w1.fi> 4189251Ssam * 5189251Ssam * This program is free software; you can redistribute it and/or modify 6189251Ssam * it under the terms of the GNU General Public License version 2 as 7189251Ssam * published by the Free Software Foundation. 8189251Ssam * 9189251Ssam * Alternatively, this software may be distributed under the terms of BSD 10189251Ssam * license. 11189251Ssam * 12189251Ssam * See README and COPYING for more details. 13189251Ssam */ 14189251Ssam 15189251Ssam#ifndef WPS_DEFS_H 16189251Ssam#define WPS_DEFS_H 17189251Ssam 18189251Ssam#define WPS_VERSION 0x10 19189251Ssam 20189251Ssam/* Diffie-Hellman 1536-bit MODP Group; RFC 3526, Group 5 */ 21189251Ssam#define WPS_DH_GROUP 5 22189251Ssam 23189251Ssam#define WPS_UUID_LEN 16 24189251Ssam#define WPS_NONCE_LEN 16 25189251Ssam#define WPS_AUTHENTICATOR_LEN 8 26189251Ssam#define WPS_AUTHKEY_LEN 32 27189251Ssam#define WPS_KEYWRAPKEY_LEN 16 28189251Ssam#define WPS_EMSK_LEN 32 29189251Ssam#define WPS_PSK_LEN 16 30189251Ssam#define WPS_SECRET_NONCE_LEN 16 31189251Ssam#define WPS_HASH_LEN 32 32189251Ssam#define WPS_KWA_LEN 8 33189251Ssam#define WPS_MGMTAUTHKEY_LEN 32 34189251Ssam#define WPS_MGMTENCKEY_LEN 16 35189251Ssam#define WPS_MGMT_KEY_ID_LEN 16 36214734Srpaulo#define WPS_OOB_DEVICE_PASSWORD_ATTR_LEN 54 37214734Srpaulo#define WPS_OOB_DEVICE_PASSWORD_LEN 32 38214734Srpaulo#define WPS_OOB_PUBKEY_HASH_LEN 20 39189251Ssam 40189251Ssam/* Attribute Types */ 41189251Ssamenum wps_attribute { 42189251Ssam ATTR_AP_CHANNEL = 0x1001, 43189251Ssam ATTR_ASSOC_STATE = 0x1002, 44189251Ssam ATTR_AUTH_TYPE = 0x1003, 45189251Ssam ATTR_AUTH_TYPE_FLAGS = 0x1004, 46189251Ssam ATTR_AUTHENTICATOR = 0x1005, 47189251Ssam ATTR_CONFIG_METHODS = 0x1008, 48189251Ssam ATTR_CONFIG_ERROR = 0x1009, 49189251Ssam ATTR_CONFIRM_URL4 = 0x100a, 50189251Ssam ATTR_CONFIRM_URL6 = 0x100b, 51189251Ssam ATTR_CONN_TYPE = 0x100c, 52189251Ssam ATTR_CONN_TYPE_FLAGS = 0x100d, 53189251Ssam ATTR_CRED = 0x100e, 54189251Ssam ATTR_ENCR_TYPE = 0x100f, 55189251Ssam ATTR_ENCR_TYPE_FLAGS = 0x1010, 56189251Ssam ATTR_DEV_NAME = 0x1011, 57189251Ssam ATTR_DEV_PASSWORD_ID = 0x1012, 58189251Ssam ATTR_E_HASH1 = 0x1014, 59189251Ssam ATTR_E_HASH2 = 0x1015, 60189251Ssam ATTR_E_SNONCE1 = 0x1016, 61189251Ssam ATTR_E_SNONCE2 = 0x1017, 62189251Ssam ATTR_ENCR_SETTINGS = 0x1018, 63189251Ssam ATTR_ENROLLEE_NONCE = 0x101a, 64189251Ssam ATTR_FEATURE_ID = 0x101b, 65189251Ssam ATTR_IDENTITY = 0x101c, 66189251Ssam ATTR_IDENTITY_PROOF = 0x101d, 67189251Ssam ATTR_KEY_WRAP_AUTH = 0x101e, 68189251Ssam ATTR_KEY_ID = 0x101f, 69189251Ssam ATTR_MAC_ADDR = 0x1020, 70189251Ssam ATTR_MANUFACTURER = 0x1021, 71189251Ssam ATTR_MSG_TYPE = 0x1022, 72189251Ssam ATTR_MODEL_NAME = 0x1023, 73189251Ssam ATTR_MODEL_NUMBER = 0x1024, 74189251Ssam ATTR_NETWORK_INDEX = 0x1026, 75189251Ssam ATTR_NETWORK_KEY = 0x1027, 76189251Ssam ATTR_NETWORK_KEY_INDEX = 0x1028, 77189251Ssam ATTR_NEW_DEVICE_NAME = 0x1029, 78189251Ssam ATTR_NEW_PASSWORD = 0x102a, 79189251Ssam ATTR_OOB_DEVICE_PASSWORD = 0x102c, 80189251Ssam ATTR_OS_VERSION = 0x102d, 81189251Ssam ATTR_POWER_LEVEL = 0x102f, 82189251Ssam ATTR_PSK_CURRENT = 0x1030, 83189251Ssam ATTR_PSK_MAX = 0x1031, 84189251Ssam ATTR_PUBLIC_KEY = 0x1032, 85189251Ssam ATTR_RADIO_ENABLE = 0x1033, 86189251Ssam ATTR_REBOOT = 0x1034, 87189251Ssam ATTR_REGISTRAR_CURRENT = 0x1035, 88189251Ssam ATTR_REGISTRAR_ESTABLISHED = 0x1036, 89189251Ssam ATTR_REGISTRAR_LIST = 0x1037, 90189251Ssam ATTR_REGISTRAR_MAX = 0x1038, 91189251Ssam ATTR_REGISTRAR_NONCE = 0x1039, 92189251Ssam ATTR_REQUEST_TYPE = 0x103a, 93189251Ssam ATTR_RESPONSE_TYPE = 0x103b, 94189251Ssam ATTR_RF_BANDS = 0x103c, 95189251Ssam ATTR_R_HASH1 = 0x103d, 96189251Ssam ATTR_R_HASH2 = 0x103e, 97189251Ssam ATTR_R_SNONCE1 = 0x103f, 98189251Ssam ATTR_R_SNONCE2 = 0x1040, 99189251Ssam ATTR_SELECTED_REGISTRAR = 0x1041, 100189251Ssam ATTR_SERIAL_NUMBER = 0x1042, 101189251Ssam ATTR_WPS_STATE = 0x1044, 102189251Ssam ATTR_SSID = 0x1045, 103189251Ssam ATTR_TOTAL_NETWORKS = 0x1046, 104189251Ssam ATTR_UUID_E = 0x1047, 105189251Ssam ATTR_UUID_R = 0x1048, 106189251Ssam ATTR_VENDOR_EXT = 0x1049, 107189251Ssam ATTR_VERSION = 0x104a, 108189251Ssam ATTR_X509_CERT_REQ = 0x104b, 109189251Ssam ATTR_X509_CERT = 0x104c, 110189251Ssam ATTR_EAP_IDENTITY = 0x104d, 111189251Ssam ATTR_MSG_COUNTER = 0x104e, 112189251Ssam ATTR_PUBKEY_HASH = 0x104f, 113189251Ssam ATTR_REKEY_KEY = 0x1050, 114189251Ssam ATTR_KEY_LIFETIME = 0x1051, 115189251Ssam ATTR_PERMITTED_CFG_METHODS = 0x1052, 116189251Ssam ATTR_SELECTED_REGISTRAR_CONFIG_METHODS = 0x1053, 117189251Ssam ATTR_PRIMARY_DEV_TYPE = 0x1054, 118214734Srpaulo ATTR_SECONDARY_DEV_TYPE_LIST = 0x1055, 119189251Ssam ATTR_PORTABLE_DEV = 0x1056, 120189251Ssam ATTR_AP_SETUP_LOCKED = 0x1057, 121189251Ssam ATTR_APPLICATION_EXT = 0x1058, 122189251Ssam ATTR_EAP_TYPE = 0x1059, 123189251Ssam ATTR_IV = 0x1060, 124189251Ssam ATTR_KEY_PROVIDED_AUTO = 0x1061, 125189251Ssam ATTR_802_1X_ENABLED = 0x1062, 126189251Ssam ATTR_APPSESSIONKEY = 0x1063, 127189251Ssam ATTR_WEPTRANSMITKEY = 0x1064 128189251Ssam}; 129189251Ssam 130189251Ssam/* Device Password ID */ 131189251Ssamenum wps_dev_password_id { 132189251Ssam DEV_PW_DEFAULT = 0x0000, 133189251Ssam DEV_PW_USER_SPECIFIED = 0x0001, 134189251Ssam DEV_PW_MACHINE_SPECIFIED = 0x0002, 135189251Ssam DEV_PW_REKEY = 0x0003, 136189251Ssam DEV_PW_PUSHBUTTON = 0x0004, 137189251Ssam DEV_PW_REGISTRAR_SPECIFIED = 0x0005 138189251Ssam}; 139189251Ssam 140189251Ssam/* Message Type */ 141189251Ssamenum wps_msg_type { 142189251Ssam WPS_Beacon = 0x01, 143189251Ssam WPS_ProbeRequest = 0x02, 144189251Ssam WPS_ProbeResponse = 0x03, 145189251Ssam WPS_M1 = 0x04, 146189251Ssam WPS_M2 = 0x05, 147189251Ssam WPS_M2D = 0x06, 148189251Ssam WPS_M3 = 0x07, 149189251Ssam WPS_M4 = 0x08, 150189251Ssam WPS_M5 = 0x09, 151189251Ssam WPS_M6 = 0x0a, 152189251Ssam WPS_M7 = 0x0b, 153189251Ssam WPS_M8 = 0x0c, 154189251Ssam WPS_WSC_ACK = 0x0d, 155189251Ssam WPS_WSC_NACK = 0x0e, 156189251Ssam WPS_WSC_DONE = 0x0f 157189251Ssam}; 158189251Ssam 159189251Ssam/* Authentication Type Flags */ 160189251Ssam#define WPS_AUTH_OPEN 0x0001 161189251Ssam#define WPS_AUTH_WPAPSK 0x0002 162189251Ssam#define WPS_AUTH_SHARED 0x0004 163189251Ssam#define WPS_AUTH_WPA 0x0008 164189251Ssam#define WPS_AUTH_WPA2 0x0010 165189251Ssam#define WPS_AUTH_WPA2PSK 0x0020 166189251Ssam#define WPS_AUTH_TYPES (WPS_AUTH_OPEN | WPS_AUTH_WPAPSK | WPS_AUTH_SHARED | \ 167189251Ssam WPS_AUTH_WPA | WPS_AUTH_WPA2 | WPS_AUTH_WPA2PSK) 168189251Ssam 169189251Ssam/* Encryption Type Flags */ 170189251Ssam#define WPS_ENCR_NONE 0x0001 171189251Ssam#define WPS_ENCR_WEP 0x0002 172189251Ssam#define WPS_ENCR_TKIP 0x0004 173189251Ssam#define WPS_ENCR_AES 0x0008 174189251Ssam#define WPS_ENCR_TYPES (WPS_ENCR_NONE | WPS_ENCR_WEP | WPS_ENCR_TKIP | \ 175189251Ssam WPS_ENCR_AES) 176189251Ssam 177189251Ssam/* Configuration Error */ 178189251Ssamenum wps_config_error { 179189251Ssam WPS_CFG_NO_ERROR = 0, 180189251Ssam WPS_CFG_OOB_IFACE_READ_ERROR = 1, 181189251Ssam WPS_CFG_DECRYPTION_CRC_FAILURE = 2, 182189251Ssam WPS_CFG_24_CHAN_NOT_SUPPORTED = 3, 183189251Ssam WPS_CFG_50_CHAN_NOT_SUPPORTED = 4, 184189251Ssam WPS_CFG_SIGNAL_TOO_WEAK = 5, 185189251Ssam WPS_CFG_NETWORK_AUTH_FAILURE = 6, 186189251Ssam WPS_CFG_NETWORK_ASSOC_FAILURE = 7, 187189251Ssam WPS_CFG_NO_DHCP_RESPONSE = 8, 188189251Ssam WPS_CFG_FAILED_DHCP_CONFIG = 9, 189189251Ssam WPS_CFG_IP_ADDR_CONFLICT = 10, 190189251Ssam WPS_CFG_NO_CONN_TO_REGISTRAR = 11, 191189251Ssam WPS_CFG_MULTIPLE_PBC_DETECTED = 12, 192189251Ssam WPS_CFG_ROGUE_SUSPECTED = 13, 193189251Ssam WPS_CFG_DEVICE_BUSY = 14, 194189251Ssam WPS_CFG_SETUP_LOCKED = 15, 195189251Ssam WPS_CFG_MSG_TIMEOUT = 16, 196189251Ssam WPS_CFG_REG_SESS_TIMEOUT = 17, 197189251Ssam WPS_CFG_DEV_PASSWORD_AUTH_FAILURE = 18 198189251Ssam}; 199189251Ssam 200189251Ssam/* RF Bands */ 201189251Ssam#define WPS_RF_24GHZ 0x01 202189251Ssam#define WPS_RF_50GHZ 0x02 203189251Ssam 204189251Ssam/* Config Methods */ 205189251Ssam#define WPS_CONFIG_USBA 0x0001 206189251Ssam#define WPS_CONFIG_ETHERNET 0x0002 207189251Ssam#define WPS_CONFIG_LABEL 0x0004 208189251Ssam#define WPS_CONFIG_DISPLAY 0x0008 209189251Ssam#define WPS_CONFIG_EXT_NFC_TOKEN 0x0010 210189251Ssam#define WPS_CONFIG_INT_NFC_TOKEN 0x0020 211189251Ssam#define WPS_CONFIG_NFC_INTERFACE 0x0040 212189251Ssam#define WPS_CONFIG_PUSHBUTTON 0x0080 213189251Ssam#define WPS_CONFIG_KEYPAD 0x0100 214189251Ssam 215189251Ssam/* Connection Type Flags */ 216189251Ssam#define WPS_CONN_ESS 0x01 217189251Ssam#define WPS_CONN_IBSS 0x02 218189251Ssam 219189251Ssam/* Wi-Fi Protected Setup State */ 220189251Ssamenum wps_state { 221189251Ssam WPS_STATE_NOT_CONFIGURED = 1, 222189251Ssam WPS_STATE_CONFIGURED = 2 223189251Ssam}; 224189251Ssam 225189251Ssam/* Association State */ 226189251Ssamenum wps_assoc_state { 227189251Ssam WPS_ASSOC_NOT_ASSOC = 0, 228189251Ssam WPS_ASSOC_CONN_SUCCESS = 1, 229189251Ssam WPS_ASSOC_CFG_FAILURE = 2, 230189251Ssam WPS_ASSOC_FAILURE = 3, 231189251Ssam WPS_ASSOC_IP_FAILURE = 4 232189251Ssam}; 233189251Ssam 234189251Ssam 235189251Ssam#define WPS_DEV_OUI_WFA 0x0050f204 236189251Ssam 237189251Ssamenum wps_dev_categ { 238189251Ssam WPS_DEV_COMPUTER = 1, 239189251Ssam WPS_DEV_INPUT = 2, 240189251Ssam WPS_DEV_PRINTER = 3, 241189251Ssam WPS_DEV_CAMERA = 4, 242189251Ssam WPS_DEV_STORAGE = 5, 243189251Ssam WPS_DEV_NETWORK_INFRA = 6, 244189251Ssam WPS_DEV_DISPLAY = 7, 245189251Ssam WPS_DEV_MULTIMEDIA = 8, 246189251Ssam WPS_DEV_GAMING = 9, 247189251Ssam WPS_DEV_PHONE = 10 248189251Ssam}; 249189251Ssam 250189251Ssamenum wps_dev_subcateg { 251189251Ssam WPS_DEV_COMPUTER_PC = 1, 252189251Ssam WPS_DEV_COMPUTER_SERVER = 2, 253189251Ssam WPS_DEV_COMPUTER_MEDIA_CENTER = 3, 254189251Ssam WPS_DEV_PRINTER_PRINTER = 1, 255189251Ssam WPS_DEV_PRINTER_SCANNER = 2, 256189251Ssam WPS_DEV_CAMERA_DIGITAL_STILL_CAMERA = 1, 257189251Ssam WPS_DEV_STORAGE_NAS = 1, 258189251Ssam WPS_DEV_NETWORK_INFRA_AP = 1, 259189251Ssam WPS_DEV_NETWORK_INFRA_ROUTER = 2, 260189251Ssam WPS_DEV_NETWORK_INFRA_SWITCH = 3, 261189251Ssam WPS_DEV_DISPLAY_TV = 1, 262189251Ssam WPS_DEV_DISPLAY_PICTURE_FRAME = 2, 263189251Ssam WPS_DEV_DISPLAY_PROJECTOR = 3, 264189251Ssam WPS_DEV_MULTIMEDIA_DAR = 1, 265189251Ssam WPS_DEV_MULTIMEDIA_PVR = 2, 266189251Ssam WPS_DEV_MULTIMEDIA_MCX = 3, 267189251Ssam WPS_DEV_GAMING_XBOX = 1, 268189251Ssam WPS_DEV_GAMING_XBOX360 = 2, 269189251Ssam WPS_DEV_GAMING_PLAYSTATION = 3, 270189251Ssam WPS_DEV_PHONE_WINDOWS_MOBILE = 1 271189251Ssam}; 272189251Ssam 273189251Ssam 274189251Ssam/* Request Type */ 275189251Ssamenum wps_request_type { 276189251Ssam WPS_REQ_ENROLLEE_INFO = 0, 277189251Ssam WPS_REQ_ENROLLEE = 1, 278189251Ssam WPS_REQ_REGISTRAR = 2, 279189251Ssam WPS_REQ_WLAN_MANAGER_REGISTRAR = 3 280189251Ssam}; 281189251Ssam 282189251Ssam/* Response Type */ 283189251Ssamenum wps_response_type { 284189251Ssam WPS_RESP_ENROLLEE_INFO = 0, 285189251Ssam WPS_RESP_ENROLLEE = 1, 286189251Ssam WPS_RESP_REGISTRAR = 2, 287189251Ssam WPS_RESP_AP = 3 288189251Ssam}; 289189251Ssam 290189251Ssam/* Walk Time for push button configuration (in seconds) */ 291189251Ssam#define WPS_PBC_WALK_TIME 120 292189251Ssam 293189251Ssam#endif /* WPS_DEFS_H */ 294