wpa_ctrl.h revision 5460547a121207cf7a99eac45e05fcdd83be3161
1/* 2 * wpa_supplicant/hostapd control interface library 3 * Copyright (c) 2004-2006, 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 WPA_CTRL_H 10#define WPA_CTRL_H 11 12#ifdef __cplusplus 13extern "C" { 14#endif 15 16/* wpa_supplicant control interface - fixed message prefixes */ 17 18/** Interactive request for identity/password/pin */ 19#define WPA_CTRL_REQ "CTRL-REQ-" 20 21/** Response to identity/password/pin request */ 22#define WPA_CTRL_RSP "CTRL-RSP-" 23 24/* Event messages with fixed prefix */ 25/** Authentication completed successfully and data connection enabled */ 26#define WPA_EVENT_CONNECTED "CTRL-EVENT-CONNECTED " 27/** Disconnected, data connection is not available */ 28#define WPA_EVENT_DISCONNECTED "CTRL-EVENT-DISCONNECTED " 29/** Association rejected during connection attempt */ 30#define WPA_EVENT_ASSOC_REJECT "CTRL-EVENT-ASSOC-REJECT " 31/** wpa_supplicant is exiting */ 32#define WPA_EVENT_TERMINATING "CTRL-EVENT-TERMINATING " 33/** Password change was completed successfully */ 34#define WPA_EVENT_PASSWORD_CHANGED "CTRL-EVENT-PASSWORD-CHANGED " 35/** EAP-Request/Notification received */ 36#define WPA_EVENT_EAP_NOTIFICATION "CTRL-EVENT-EAP-NOTIFICATION " 37/** EAP authentication started (EAP-Request/Identity received) */ 38#define WPA_EVENT_EAP_STARTED "CTRL-EVENT-EAP-STARTED " 39/** EAP method proposed by the server */ 40#define WPA_EVENT_EAP_PROPOSED_METHOD "CTRL-EVENT-EAP-PROPOSED-METHOD " 41/** EAP method selected */ 42#define WPA_EVENT_EAP_METHOD "CTRL-EVENT-EAP-METHOD " 43/** EAP peer certificate from TLS */ 44#define WPA_EVENT_EAP_PEER_CERT "CTRL-EVENT-EAP-PEER-CERT " 45/** EAP TLS certificate chain validation error */ 46#define WPA_EVENT_EAP_TLS_CERT_ERROR "CTRL-EVENT-EAP-TLS-CERT-ERROR " 47/** EAP status */ 48#define WPA_EVENT_EAP_STATUS "CTRL-EVENT-EAP-STATUS " 49/** EAP authentication completed successfully */ 50#define WPA_EVENT_EAP_SUCCESS "CTRL-EVENT-EAP-SUCCESS " 51/** EAP authentication failed (EAP-Failure received) */ 52#define WPA_EVENT_EAP_FAILURE "CTRL-EVENT-EAP-FAILURE " 53/** Network block temporarily disabled (e.g., due to authentication failure) */ 54#define WPA_EVENT_TEMP_DISABLED "CTRL-EVENT-SSID-TEMP-DISABLED " 55/** Temporarily disabled network block re-enabled */ 56#define WPA_EVENT_REENABLED "CTRL-EVENT-SSID-REENABLED " 57/** New scan results available */ 58#define WPA_EVENT_SCAN_RESULTS "CTRL-EVENT-SCAN-RESULTS " 59/** wpa_supplicant state change */ 60#define WPA_EVENT_STATE_CHANGE "CTRL-EVENT-STATE-CHANGE " 61/** A new BSS entry was added (followed by BSS entry id and BSSID) */ 62#define WPA_EVENT_BSS_ADDED "CTRL-EVENT-BSS-ADDED " 63/** A BSS entry was removed (followed by BSS entry id and BSSID) */ 64#define WPA_EVENT_BSS_REMOVED "CTRL-EVENT-BSS-REMOVED " 65#ifdef ANDROID_P2P 66/** Notify the Userspace about the freq conflict */ 67#define WPA_EVENT_FREQ_CONFLICT "CTRL-EVENT-FREQ-CONFLICT " 68#endif 69 70/** RSN IBSS 4-way handshakes completed with specified peer */ 71#define IBSS_RSN_COMPLETED "IBSS-RSN-COMPLETED " 72 73/** WPS overlap detected in PBC mode */ 74#define WPS_EVENT_OVERLAP "WPS-OVERLAP-DETECTED " 75/** Available WPS AP with active PBC found in scan results */ 76#define WPS_EVENT_AP_AVAILABLE_PBC "WPS-AP-AVAILABLE-PBC " 77/** Available WPS AP with our address as authorized in scan results */ 78#define WPS_EVENT_AP_AVAILABLE_AUTH "WPS-AP-AVAILABLE-AUTH " 79/** Available WPS AP with recently selected PIN registrar found in scan results 80 */ 81#define WPS_EVENT_AP_AVAILABLE_PIN "WPS-AP-AVAILABLE-PIN " 82/** Available WPS AP found in scan results */ 83#define WPS_EVENT_AP_AVAILABLE "WPS-AP-AVAILABLE " 84/** A new credential received */ 85#define WPS_EVENT_CRED_RECEIVED "WPS-CRED-RECEIVED " 86/** M2D received */ 87#define WPS_EVENT_M2D "WPS-M2D " 88/** WPS registration failed after M2/M2D */ 89#define WPS_EVENT_FAIL "WPS-FAIL " 90/** WPS registration completed successfully */ 91#define WPS_EVENT_SUCCESS "WPS-SUCCESS " 92/** WPS enrollment attempt timed out and was terminated */ 93#define WPS_EVENT_TIMEOUT "WPS-TIMEOUT " 94/* PBC mode was activated */ 95#define WPS_EVENT_ACTIVE "WPS-PBC-ACTIVE " 96/* PBC mode was disabled */ 97#define WPS_EVENT_DISABLE "WPS-PBC-DISABLE " 98 99#define WPS_EVENT_ENROLLEE_SEEN "WPS-ENROLLEE-SEEN " 100 101#define WPS_EVENT_OPEN_NETWORK "WPS-OPEN-NETWORK " 102 103/* WPS ER events */ 104#define WPS_EVENT_ER_AP_ADD "WPS-ER-AP-ADD " 105#define WPS_EVENT_ER_AP_REMOVE "WPS-ER-AP-REMOVE " 106#define WPS_EVENT_ER_ENROLLEE_ADD "WPS-ER-ENROLLEE-ADD " 107#define WPS_EVENT_ER_ENROLLEE_REMOVE "WPS-ER-ENROLLEE-REMOVE " 108#define WPS_EVENT_ER_AP_SETTINGS "WPS-ER-AP-SETTINGS " 109#define WPS_EVENT_ER_SET_SEL_REG "WPS-ER-AP-SET-SEL-REG " 110 111/** P2P device found */ 112#define P2P_EVENT_DEVICE_FOUND "P2P-DEVICE-FOUND " 113 114/** P2P device lost */ 115#define P2P_EVENT_DEVICE_LOST "P2P-DEVICE-LOST " 116 117/** A P2P device requested GO negotiation, but we were not ready to start the 118 * negotiation */ 119#define P2P_EVENT_GO_NEG_REQUEST "P2P-GO-NEG-REQUEST " 120#define P2P_EVENT_GO_NEG_SUCCESS "P2P-GO-NEG-SUCCESS " 121#define P2P_EVENT_GO_NEG_FAILURE "P2P-GO-NEG-FAILURE " 122#define P2P_EVENT_GROUP_FORMATION_SUCCESS "P2P-GROUP-FORMATION-SUCCESS " 123#define P2P_EVENT_GROUP_FORMATION_FAILURE "P2P-GROUP-FORMATION-FAILURE " 124#define P2P_EVENT_GROUP_STARTED "P2P-GROUP-STARTED " 125#define P2P_EVENT_GROUP_REMOVED "P2P-GROUP-REMOVED " 126#define P2P_EVENT_CROSS_CONNECT_ENABLE "P2P-CROSS-CONNECT-ENABLE " 127#define P2P_EVENT_CROSS_CONNECT_DISABLE "P2P-CROSS-CONNECT-DISABLE " 128/* parameters: <peer address> <PIN> */ 129#define P2P_EVENT_PROV_DISC_SHOW_PIN "P2P-PROV-DISC-SHOW-PIN " 130/* parameters: <peer address> */ 131#define P2P_EVENT_PROV_DISC_ENTER_PIN "P2P-PROV-DISC-ENTER-PIN " 132/* parameters: <peer address> */ 133#define P2P_EVENT_PROV_DISC_PBC_REQ "P2P-PROV-DISC-PBC-REQ " 134/* parameters: <peer address> */ 135#define P2P_EVENT_PROV_DISC_PBC_RESP "P2P-PROV-DISC-PBC-RESP " 136/* parameters: <peer address> <status> */ 137#define P2P_EVENT_PROV_DISC_FAILURE "P2P-PROV-DISC-FAILURE" 138/* parameters: <freq> <src addr> <dialog token> <update indicator> <TLVs> */ 139#define P2P_EVENT_SERV_DISC_REQ "P2P-SERV-DISC-REQ " 140/* parameters: <src addr> <update indicator> <TLVs> */ 141#define P2P_EVENT_SERV_DISC_RESP "P2P-SERV-DISC-RESP " 142#define P2P_EVENT_INVITATION_RECEIVED "P2P-INVITATION-RECEIVED " 143#define P2P_EVENT_INVITATION_RESULT "P2P-INVITATION-RESULT " 144#define P2P_EVENT_FIND_STOPPED "P2P-FIND-STOPPED " 145#define P2P_EVENT_PERSISTENT_PSK_FAIL "P2P-PERSISTENT-PSK-FAIL id=" 146 147/* parameters: <PMF enabled> <timeout in ms> <Session Information URL> */ 148#define ESS_DISASSOC_IMMINENT "ESS-DISASSOC-IMMINENT " 149 150#define INTERWORKING_AP "INTERWORKING-AP " 151#define INTERWORKING_NO_MATCH "INTERWORKING-NO-MATCH " 152#define INTERWORKING_ALREADY_CONNECTED "INTERWORKING-ALREADY-CONNECTED " 153 154#define GAS_RESPONSE_INFO "GAS-RESPONSE-INFO " 155 156/* hostapd control interface - fixed message prefixes */ 157#define WPS_EVENT_PIN_NEEDED "WPS-PIN-NEEDED " 158#define WPS_EVENT_NEW_AP_SETTINGS "WPS-NEW-AP-SETTINGS " 159#define WPS_EVENT_REG_SUCCESS "WPS-REG-SUCCESS " 160#define WPS_EVENT_AP_SETUP_LOCKED "WPS-AP-SETUP-LOCKED " 161#define WPS_EVENT_AP_SETUP_UNLOCKED "WPS-AP-SETUP-UNLOCKED " 162#define WPS_EVENT_AP_PIN_ENABLED "WPS-AP-PIN-ENABLED " 163#define WPS_EVENT_AP_PIN_DISABLED "WPS-AP-PIN-DISABLED " 164#define AP_STA_CONNECTED "AP-STA-CONNECTED " 165#define AP_STA_DISCONNECTED "AP-STA-DISCONNECTED " 166 167#define AP_REJECTED_MAX_STA "AP-REJECTED-MAX-STA " 168#define AP_REJECTED_BLOCKED_STA "AP-REJECTED-BLOCKED-STA " 169 170#define AP_EVENT_ENABLED "AP-ENABLED " 171#define AP_EVENT_DISABLED "AP-DISABLED " 172 173#define ACS_EVENT_STARTED "ACS-STARTED " 174#define ACS_EVENT_COMPLETED "ACS-COMPLETED " 175#define ACS_EVENT_FAILED "ACS-FAILED " 176 177#define DFS_EVENT_RADAR_DETECTED "DFS-RADAR-DETECTED " 178#define DFS_EVENT_NEW_CHANNEL "DFS-NEW-CHANNEL " 179#define DFS_EVENT_CAC_START "DFS-CAC-START " 180#define DFS_EVENT_CAC_COMPLETED "DFS-CAC-COMPLETED " 181#define DFS_EVENT_NOP_FINISHED "DFS-NOP-FINISHED " 182 183/* BSS command information masks */ 184 185#define WPA_BSS_MASK_ALL 0xFFFDFFFF 186#define WPA_BSS_MASK_ID BIT(0) 187#define WPA_BSS_MASK_BSSID BIT(1) 188#define WPA_BSS_MASK_FREQ BIT(2) 189#define WPA_BSS_MASK_BEACON_INT BIT(3) 190#define WPA_BSS_MASK_CAPABILITIES BIT(4) 191#define WPA_BSS_MASK_QUAL BIT(5) 192#define WPA_BSS_MASK_NOISE BIT(6) 193#define WPA_BSS_MASK_LEVEL BIT(7) 194#define WPA_BSS_MASK_TSF BIT(8) 195#define WPA_BSS_MASK_AGE BIT(9) 196#define WPA_BSS_MASK_IE BIT(10) 197#define WPA_BSS_MASK_FLAGS BIT(11) 198#define WPA_BSS_MASK_SSID BIT(12) 199#define WPA_BSS_MASK_WPS_SCAN BIT(13) 200#define WPA_BSS_MASK_P2P_SCAN BIT(14) 201#define WPA_BSS_MASK_INTERNETW BIT(15) 202#define WPA_BSS_MASK_WIFI_DISPLAY BIT(16) 203#define WPA_BSS_MASK_DELIM BIT(17) 204 205 206/* wpa_supplicant/hostapd control interface access */ 207 208/** 209 * wpa_ctrl_open - Open a control interface to wpa_supplicant/hostapd 210 * @ctrl_path: Path for UNIX domain sockets; ignored if UDP sockets are used. 211 * Returns: Pointer to abstract control interface data or %NULL on failure 212 * 213 * This function is used to open a control interface to wpa_supplicant/hostapd. 214 * ctrl_path is usually /var/run/wpa_supplicant or /var/run/hostapd. This path 215 * is configured in wpa_supplicant/hostapd and other programs using the control 216 * interface need to use matching path configuration. 217 */ 218struct wpa_ctrl * wpa_ctrl_open(const char *ctrl_path); 219 220 221/** 222 * wpa_ctrl_close - Close a control interface to wpa_supplicant/hostapd 223 * @ctrl: Control interface data from wpa_ctrl_open() 224 * 225 * This function is used to close a control interface. 226 */ 227void wpa_ctrl_close(struct wpa_ctrl *ctrl); 228 229 230/** 231 * wpa_ctrl_request - Send a command to wpa_supplicant/hostapd 232 * @ctrl: Control interface data from wpa_ctrl_open() 233 * @cmd: Command; usually, ASCII text, e.g., "PING" 234 * @cmd_len: Length of the cmd in bytes 235 * @reply: Buffer for the response 236 * @reply_len: Reply buffer length 237 * @msg_cb: Callback function for unsolicited messages or %NULL if not used 238 * Returns: 0 on success, -1 on error (send or receive failed), -2 on timeout 239 * 240 * This function is used to send commands to wpa_supplicant/hostapd. Received 241 * response will be written to reply and reply_len is set to the actual length 242 * of the reply. This function will block for up to two seconds while waiting 243 * for the reply. If unsolicited messages are received, the blocking time may 244 * be longer. 245 * 246 * msg_cb can be used to register a callback function that will be called for 247 * unsolicited messages received while waiting for the command response. These 248 * messages may be received if wpa_ctrl_request() is called at the same time as 249 * wpa_supplicant/hostapd is sending such a message. This can happen only if 250 * the program has used wpa_ctrl_attach() to register itself as a monitor for 251 * event messages. Alternatively to msg_cb, programs can register two control 252 * interface connections and use one of them for commands and the other one for 253 * receiving event messages, in other words, call wpa_ctrl_attach() only for 254 * the control interface connection that will be used for event messages. 255 */ 256int wpa_ctrl_request(struct wpa_ctrl *ctrl, const char *cmd, size_t cmd_len, 257 char *reply, size_t *reply_len, 258 void (*msg_cb)(char *msg, size_t len)); 259 260 261/** 262 * wpa_ctrl_attach - Register as an event monitor for the control interface 263 * @ctrl: Control interface data from wpa_ctrl_open() 264 * Returns: 0 on success, -1 on failure, -2 on timeout 265 * 266 * This function registers the control interface connection as a monitor for 267 * wpa_supplicant/hostapd events. After a success wpa_ctrl_attach() call, the 268 * control interface connection starts receiving event messages that can be 269 * read with wpa_ctrl_recv(). 270 */ 271int wpa_ctrl_attach(struct wpa_ctrl *ctrl); 272 273 274/** 275 * wpa_ctrl_detach - Unregister event monitor from the control interface 276 * @ctrl: Control interface data from wpa_ctrl_open() 277 * Returns: 0 on success, -1 on failure, -2 on timeout 278 * 279 * This function unregisters the control interface connection as a monitor for 280 * wpa_supplicant/hostapd events, i.e., cancels the registration done with 281 * wpa_ctrl_attach(). 282 */ 283int wpa_ctrl_detach(struct wpa_ctrl *ctrl); 284 285 286/** 287 * wpa_ctrl_recv - Receive a pending control interface message 288 * @ctrl: Control interface data from wpa_ctrl_open() 289 * @reply: Buffer for the message data 290 * @reply_len: Length of the reply buffer 291 * Returns: 0 on success, -1 on failure 292 * 293 * This function will receive a pending control interface message. This 294 * function will block if no messages are available. The received response will 295 * be written to reply and reply_len is set to the actual length of the reply. 296 * wpa_ctrl_recv() is only used for event messages, i.e., wpa_ctrl_attach() 297 * must have been used to register the control interface as an event monitor. 298 */ 299int wpa_ctrl_recv(struct wpa_ctrl *ctrl, char *reply, size_t *reply_len); 300 301 302/** 303 * wpa_ctrl_pending - Check whether there are pending event messages 304 * @ctrl: Control interface data from wpa_ctrl_open() 305 * Returns: 1 if there are pending messages, 0 if no, or -1 on error 306 * 307 * This function will check whether there are any pending control interface 308 * message available to be received with wpa_ctrl_recv(). wpa_ctrl_pending() is 309 * only used for event messages, i.e., wpa_ctrl_attach() must have been used to 310 * register the control interface as an event monitor. 311 */ 312int wpa_ctrl_pending(struct wpa_ctrl *ctrl); 313 314 315/** 316 * wpa_ctrl_get_fd - Get file descriptor used by the control interface 317 * @ctrl: Control interface data from wpa_ctrl_open() 318 * Returns: File descriptor used for the connection 319 * 320 * This function can be used to get the file descriptor that is used for the 321 * control interface connection. The returned value can be used, e.g., with 322 * select() while waiting for multiple events. 323 * 324 * The returned file descriptor must not be used directly for sending or 325 * receiving packets; instead, the library functions wpa_ctrl_request() and 326 * wpa_ctrl_recv() must be used for this. 327 */ 328int wpa_ctrl_get_fd(struct wpa_ctrl *ctrl); 329 330char * wpa_ctrl_get_remote_ifname(struct wpa_ctrl *ctrl); 331 332#ifdef ANDROID 333/** 334 * wpa_ctrl_cleanup() - Delete any local UNIX domain socket files that 335 * may be left over from clients that were previously connected to 336 * wpa_supplicant. This keeps these files from being orphaned in the 337 * event of crashes that prevented them from being removed as part 338 * of the normal orderly shutdown. 339 */ 340void wpa_ctrl_cleanup(void); 341#endif /* ANDROID */ 342 343#ifdef CONFIG_CTRL_IFACE_UDP 344/* Port range for multiple wpa_supplicant instances and multiple VIFs */ 345#define WPA_CTRL_IFACE_PORT 9877 346#define WPA_CTRL_IFACE_PORT_LIMIT 50 /* decremented from start */ 347#define WPA_GLOBAL_CTRL_IFACE_PORT 9878 348#define WPA_GLOBAL_CTRL_IFACE_PORT_LIMIT 20 /* incremented from start */ 349#endif /* CONFIG_CTRL_IFACE_UDP */ 350 351 352#ifdef __cplusplus 353} 354#endif 355 356#endif /* WPA_CTRL_H */ 357