1 /* 2 * Wi-Fi Protected Setup - message 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_DEFS_H 16 #define WPS_DEFS_H 17 18 #define WPS_VERSION 0x10 19 20 /* Diffie-Hellman 1536-bit MODP Group; RFC 3526, Group 5 */ 21 #define WPS_DH_GROUP 5 22 23 #define WPS_UUID_LEN 16 24 #define WPS_NONCE_LEN 16 25 #define WPS_AUTHENTICATOR_LEN 8 26 #define WPS_AUTHKEY_LEN 32 27 #define WPS_KEYWRAPKEY_LEN 16 28 #define WPS_EMSK_LEN 32 29 #define WPS_PSK_LEN 16 30 #define WPS_SECRET_NONCE_LEN 16 31 #define WPS_HASH_LEN 32 32 #define WPS_KWA_LEN 8 33 #define WPS_MGMTAUTHKEY_LEN 32 34 #define WPS_MGMTENCKEY_LEN 16 35 #define WPS_MGMT_KEY_ID_LEN 16 36 #define WPS_OOB_DEVICE_PASSWORD_ATTR_LEN 54 37 #define WPS_OOB_DEVICE_PASSWORD_LEN 32 38 #define WPS_OOB_PUBKEY_HASH_LEN 20 39 40 /* Attribute Types */ 41 enum wps_attribute { 42 ATTR_AP_CHANNEL = 0x1001, 43 ATTR_ASSOC_STATE = 0x1002, 44 ATTR_AUTH_TYPE = 0x1003, 45 ATTR_AUTH_TYPE_FLAGS = 0x1004, 46 ATTR_AUTHENTICATOR = 0x1005, 47 ATTR_CONFIG_METHODS = 0x1008, 48 ATTR_CONFIG_ERROR = 0x1009, 49 ATTR_CONFIRM_URL4 = 0x100a, 50 ATTR_CONFIRM_URL6 = 0x100b, 51 ATTR_CONN_TYPE = 0x100c, 52 ATTR_CONN_TYPE_FLAGS = 0x100d, 53 ATTR_CRED = 0x100e, 54 ATTR_ENCR_TYPE = 0x100f, 55 ATTR_ENCR_TYPE_FLAGS = 0x1010, 56 ATTR_DEV_NAME = 0x1011, 57 ATTR_DEV_PASSWORD_ID = 0x1012, 58 ATTR_E_HASH1 = 0x1014, 59 ATTR_E_HASH2 = 0x1015, 60 ATTR_E_SNONCE1 = 0x1016, 61 ATTR_E_SNONCE2 = 0x1017, 62 ATTR_ENCR_SETTINGS = 0x1018, 63 ATTR_ENROLLEE_NONCE = 0x101a, 64 ATTR_FEATURE_ID = 0x101b, 65 ATTR_IDENTITY = 0x101c, 66 ATTR_IDENTITY_PROOF = 0x101d, 67 ATTR_KEY_WRAP_AUTH = 0x101e, 68 ATTR_KEY_ID = 0x101f, 69 ATTR_MAC_ADDR = 0x1020, 70 ATTR_MANUFACTURER = 0x1021, 71 ATTR_MSG_TYPE = 0x1022, 72 ATTR_MODEL_NAME = 0x1023, 73 ATTR_MODEL_NUMBER = 0x1024, 74 ATTR_NETWORK_INDEX = 0x1026, 75 ATTR_NETWORK_KEY = 0x1027, 76 ATTR_NETWORK_KEY_INDEX = 0x1028, 77 ATTR_NEW_DEVICE_NAME = 0x1029, 78 ATTR_NEW_PASSWORD = 0x102a, 79 ATTR_OOB_DEVICE_PASSWORD = 0x102c, 80 ATTR_OS_VERSION = 0x102d, 81 ATTR_POWER_LEVEL = 0x102f, 82 ATTR_PSK_CURRENT = 0x1030, 83 ATTR_PSK_MAX = 0x1031, 84 ATTR_PUBLIC_KEY = 0x1032, 85 ATTR_RADIO_ENABLE = 0x1033, 86 ATTR_REBOOT = 0x1034, 87 ATTR_REGISTRAR_CURRENT = 0x1035, 88 ATTR_REGISTRAR_ESTABLISHED = 0x1036, 89 ATTR_REGISTRAR_LIST = 0x1037, 90 ATTR_REGISTRAR_MAX = 0x1038, 91 ATTR_REGISTRAR_NONCE = 0x1039, 92 ATTR_REQUEST_TYPE = 0x103a, 93 ATTR_RESPONSE_TYPE = 0x103b, 94 ATTR_RF_BANDS = 0x103c, 95 ATTR_R_HASH1 = 0x103d, 96 ATTR_R_HASH2 = 0x103e, 97 ATTR_R_SNONCE1 = 0x103f, 98 ATTR_R_SNONCE2 = 0x1040, 99 ATTR_SELECTED_REGISTRAR = 0x1041, 100 ATTR_SERIAL_NUMBER = 0x1042, 101 ATTR_WPS_STATE = 0x1044, 102 ATTR_SSID = 0x1045, 103 ATTR_TOTAL_NETWORKS = 0x1046, 104 ATTR_UUID_E = 0x1047, 105 ATTR_UUID_R = 0x1048, 106 ATTR_VENDOR_EXT = 0x1049, 107 ATTR_VERSION = 0x104a, 108 ATTR_X509_CERT_REQ = 0x104b, 109 ATTR_X509_CERT = 0x104c, 110 ATTR_EAP_IDENTITY = 0x104d, 111 ATTR_MSG_COUNTER = 0x104e, 112 ATTR_PUBKEY_HASH = 0x104f, 113 ATTR_REKEY_KEY = 0x1050, 114 ATTR_KEY_LIFETIME = 0x1051, 115 ATTR_PERMITTED_CFG_METHODS = 0x1052, 116 ATTR_SELECTED_REGISTRAR_CONFIG_METHODS = 0x1053, 117 ATTR_PRIMARY_DEV_TYPE = 0x1054, 118 ATTR_SECONDARY_DEV_TYP_ELIST = 0x1055, 119 ATTR_PORTABLE_DEV = 0x1056, 120 ATTR_AP_SETUP_LOCKED = 0x1057, 121 ATTR_APPLICATION_EXT = 0x1058, 122 ATTR_EAP_TYPE = 0x1059, 123 ATTR_IV = 0x1060, 124 ATTR_KEY_PROVIDED_AUTO = 0x1061, 125 ATTR_802_1X_ENABLED = 0x1062, 126 ATTR_APPSESSIONKEY = 0x1063, 127 ATTR_WEPTRANSMITKEY = 0x1064 128 }; 129 130 /* Device Password ID */ 131 enum wps_dev_password_id { 132 DEV_PW_DEFAULT = 0x0000, 133 DEV_PW_USER_SPECIFIED = 0x0001, 134 DEV_PW_MACHINE_SPECIFIED = 0x0002, 135 DEV_PW_REKEY = 0x0003, 136 DEV_PW_PUSHBUTTON = 0x0004, 137 DEV_PW_REGISTRAR_SPECIFIED = 0x0005 138 }; 139 140 /* Message Type */ 141 enum wps_msg_type { 142 WPS_Beacon = 0x01, 143 WPS_ProbeRequest = 0x02, 144 WPS_ProbeResponse = 0x03, 145 WPS_M1 = 0x04, 146 WPS_M2 = 0x05, 147 WPS_M2D = 0x06, 148 WPS_M3 = 0x07, 149 WPS_M4 = 0x08, 150 WPS_M5 = 0x09, 151 WPS_M6 = 0x0a, 152 WPS_M7 = 0x0b, 153 WPS_M8 = 0x0c, 154 WPS_WSC_ACK = 0x0d, 155 WPS_WSC_NACK = 0x0e, 156 WPS_WSC_DONE = 0x0f 157 }; 158 159 /* Authentication Type Flags */ 160 #define WPS_AUTH_OPEN 0x0001 161 #define WPS_AUTH_WPAPSK 0x0002 162 #define WPS_AUTH_SHARED 0x0004 163 #define WPS_AUTH_WPA 0x0008 164 #define WPS_AUTH_WPA2 0x0010 165 #define WPS_AUTH_WPA2PSK 0x0020 166 #define WPS_AUTH_TYPES (WPS_AUTH_OPEN | WPS_AUTH_WPAPSK | WPS_AUTH_SHARED | \ 167 WPS_AUTH_WPA | WPS_AUTH_WPA2 | WPS_AUTH_WPA2PSK) 168 169 /* Encryption Type Flags */ 170 #define WPS_ENCR_NONE 0x0001 171 #define WPS_ENCR_WEP 0x0002 172 #define WPS_ENCR_TKIP 0x0004 173 #define WPS_ENCR_AES 0x0008 174 #define WPS_ENCR_TYPES (WPS_ENCR_NONE | WPS_ENCR_WEP | WPS_ENCR_TKIP | \ 175 WPS_ENCR_AES) 176 177 /* Configuration Error */ 178 enum wps_config_error { 179 WPS_CFG_NO_ERROR = 0, 180 WPS_CFG_OOB_IFACE_READ_ERROR = 1, 181 WPS_CFG_DECRYPTION_CRC_FAILURE = 2, 182 WPS_CFG_24_CHAN_NOT_SUPPORTED = 3, 183 WPS_CFG_50_CHAN_NOT_SUPPORTED = 4, 184 WPS_CFG_SIGNAL_TOO_WEAK = 5, 185 WPS_CFG_NETWORK_AUTH_FAILURE = 6, 186 WPS_CFG_NETWORK_ASSOC_FAILURE = 7, 187 WPS_CFG_NO_DHCP_RESPONSE = 8, 188 WPS_CFG_FAILED_DHCP_CONFIG = 9, 189 WPS_CFG_IP_ADDR_CONFLICT = 10, 190 WPS_CFG_NO_CONN_TO_REGISTRAR = 11, 191 WPS_CFG_MULTIPLE_PBC_DETECTED = 12, 192 WPS_CFG_ROGUE_SUSPECTED = 13, 193 WPS_CFG_DEVICE_BUSY = 14, 194 WPS_CFG_SETUP_LOCKED = 15, 195 WPS_CFG_MSG_TIMEOUT = 16, 196 WPS_CFG_REG_SESS_TIMEOUT = 17, 197 WPS_CFG_DEV_PASSWORD_AUTH_FAILURE = 18 198 }; 199 200 /* RF Bands */ 201 #define WPS_RF_24GHZ 0x01 202 #define WPS_RF_50GHZ 0x02 203 204 /* Config Methods */ 205 #define WPS_CONFIG_USBA 0x0001 206 #define WPS_CONFIG_ETHERNET 0x0002 207 #define WPS_CONFIG_LABEL 0x0004 208 #define WPS_CONFIG_DISPLAY 0x0008 209 #define WPS_CONFIG_EXT_NFC_TOKEN 0x0010 210 #define WPS_CONFIG_INT_NFC_TOKEN 0x0020 211 #define WPS_CONFIG_NFC_INTERFACE 0x0040 212 #define WPS_CONFIG_PUSHBUTTON 0x0080 213 #define WPS_CONFIG_KEYPAD 0x0100 214 215 /* Connection Type Flags */ 216 #define WPS_CONN_ESS 0x01 217 #define WPS_CONN_IBSS 0x02 218 219 /* Wi-Fi Protected Setup State */ 220 enum wps_state { 221 WPS_STATE_NOT_CONFIGURED = 1, 222 WPS_STATE_CONFIGURED = 2 223 }; 224 225 /* Association State */ 226 enum wps_assoc_state { 227 WPS_ASSOC_NOT_ASSOC = 0, 228 WPS_ASSOC_CONN_SUCCESS = 1, 229 WPS_ASSOC_CFG_FAILURE = 2, 230 WPS_ASSOC_FAILURE = 3, 231 WPS_ASSOC_IP_FAILURE = 4 232 }; 233 234 235 #define WPS_DEV_OUI_WFA 0x0050f204 236 237 enum wps_dev_categ { 238 WPS_DEV_COMPUTER = 1, 239 WPS_DEV_INPUT = 2, 240 WPS_DEV_PRINTER = 3, 241 WPS_DEV_CAMERA = 4, 242 WPS_DEV_STORAGE = 5, 243 WPS_DEV_NETWORK_INFRA = 6, 244 WPS_DEV_DISPLAY = 7, 245 WPS_DEV_MULTIMEDIA = 8, 246 WPS_DEV_GAMING = 9, 247 WPS_DEV_PHONE = 10 248 }; 249 250 enum wps_dev_subcateg { 251 WPS_DEV_COMPUTER_PC = 1, 252 WPS_DEV_COMPUTER_SERVER = 2, 253 WPS_DEV_COMPUTER_MEDIA_CENTER = 3, 254 WPS_DEV_PRINTER_PRINTER = 1, 255 WPS_DEV_PRINTER_SCANNER = 2, 256 WPS_DEV_CAMERA_DIGITAL_STILL_CAMERA = 1, 257 WPS_DEV_STORAGE_NAS = 1, 258 WPS_DEV_NETWORK_INFRA_AP = 1, 259 WPS_DEV_NETWORK_INFRA_ROUTER = 2, 260 WPS_DEV_NETWORK_INFRA_SWITCH = 3, 261 WPS_DEV_DISPLAY_TV = 1, 262 WPS_DEV_DISPLAY_PICTURE_FRAME = 2, 263 WPS_DEV_DISPLAY_PROJECTOR = 3, 264 WPS_DEV_MULTIMEDIA_DAR = 1, 265 WPS_DEV_MULTIMEDIA_PVR = 2, 266 WPS_DEV_MULTIMEDIA_MCX = 3, 267 WPS_DEV_GAMING_XBOX = 1, 268 WPS_DEV_GAMING_XBOX360 = 2, 269 WPS_DEV_GAMING_PLAYSTATION = 3, 270 WPS_DEV_PHONE_WINDOWS_MOBILE = 1 271 }; 272 273 274 /* Request Type */ 275 enum wps_request_type { 276 WPS_REQ_ENROLLEE_INFO = 0, 277 WPS_REQ_ENROLLEE = 1, 278 WPS_REQ_REGISTRAR = 2, 279 WPS_REQ_WLAN_MANAGER_REGISTRAR = 3 280 }; 281 282 /* Response Type */ 283 enum wps_response_type { 284 WPS_RESP_ENROLLEE_INFO = 0, 285 WPS_RESP_ENROLLEE = 1, 286 WPS_RESP_REGISTRAR = 2, 287 WPS_RESP_AP = 3 288 }; 289 290 /* Walk Time for push button configuration (in seconds) */ 291 #define WPS_PBC_WALK_TIME 120 292 293 #endif /* WPS_DEFS_H */ 294