wpa_ctrl.h revision f7e0a9905988e62e4f70fed8b795722abeab719b
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/** WPS overlap detected in PBC mode */ 71#define WPS_EVENT_OVERLAP "WPS-OVERLAP-DETECTED " 72/** Available WPS AP with active PBC found in scan results */ 73#define WPS_EVENT_AP_AVAILABLE_PBC "WPS-AP-AVAILABLE-PBC " 74/** Available WPS AP with our address as authorized in scan results */ 75#define WPS_EVENT_AP_AVAILABLE_AUTH "WPS-AP-AVAILABLE-AUTH " 76/** Available WPS AP with recently selected PIN registrar found in scan results 77 */ 78#define WPS_EVENT_AP_AVAILABLE_PIN "WPS-AP-AVAILABLE-PIN " 79/** Available WPS AP found in scan results */ 80#define WPS_EVENT_AP_AVAILABLE "WPS-AP-AVAILABLE " 81/** A new credential received */ 82#define WPS_EVENT_CRED_RECEIVED "WPS-CRED-RECEIVED " 83/** M2D received */ 84#define WPS_EVENT_M2D "WPS-M2D " 85/** WPS registration failed after M2/M2D */ 86#define WPS_EVENT_FAIL "WPS-FAIL " 87/** WPS registration completed successfully */ 88#define WPS_EVENT_SUCCESS "WPS-SUCCESS " 89/** WPS enrollment attempt timed out and was terminated */ 90#define WPS_EVENT_TIMEOUT "WPS-TIMEOUT " 91 92#define WPS_EVENT_ENROLLEE_SEEN "WPS-ENROLLEE-SEEN " 93 94#define WPS_EVENT_OPEN_NETWORK "WPS-OPEN-NETWORK " 95 96/* WPS ER events */ 97#define WPS_EVENT_ER_AP_ADD "WPS-ER-AP-ADD " 98#define WPS_EVENT_ER_AP_REMOVE "WPS-ER-AP-REMOVE " 99#define WPS_EVENT_ER_ENROLLEE_ADD "WPS-ER-ENROLLEE-ADD " 100#define WPS_EVENT_ER_ENROLLEE_REMOVE "WPS-ER-ENROLLEE-REMOVE " 101#define WPS_EVENT_ER_AP_SETTINGS "WPS-ER-AP-SETTINGS " 102#define WPS_EVENT_ER_SET_SEL_REG "WPS-ER-AP-SET-SEL-REG " 103 104/** P2P device found */ 105#define P2P_EVENT_DEVICE_FOUND "P2P-DEVICE-FOUND " 106 107/** P2P device lost */ 108#define P2P_EVENT_DEVICE_LOST "P2P-DEVICE-LOST " 109 110/** A P2P device requested GO negotiation, but we were not ready to start the 111 * negotiation */ 112#define P2P_EVENT_GO_NEG_REQUEST "P2P-GO-NEG-REQUEST " 113#define P2P_EVENT_GO_NEG_SUCCESS "P2P-GO-NEG-SUCCESS " 114#define P2P_EVENT_GO_NEG_FAILURE "P2P-GO-NEG-FAILURE " 115#define P2P_EVENT_GROUP_FORMATION_SUCCESS "P2P-GROUP-FORMATION-SUCCESS " 116#define P2P_EVENT_GROUP_FORMATION_FAILURE "P2P-GROUP-FORMATION-FAILURE " 117#define P2P_EVENT_GROUP_STARTED "P2P-GROUP-STARTED " 118#define P2P_EVENT_GROUP_REMOVED "P2P-GROUP-REMOVED " 119#define P2P_EVENT_CROSS_CONNECT_ENABLE "P2P-CROSS-CONNECT-ENABLE " 120#define P2P_EVENT_CROSS_CONNECT_DISABLE "P2P-CROSS-CONNECT-DISABLE " 121/* parameters: <peer address> <PIN> */ 122#define P2P_EVENT_PROV_DISC_SHOW_PIN "P2P-PROV-DISC-SHOW-PIN " 123/* parameters: <peer address> */ 124#define P2P_EVENT_PROV_DISC_ENTER_PIN "P2P-PROV-DISC-ENTER-PIN " 125/* parameters: <peer address> */ 126#define P2P_EVENT_PROV_DISC_PBC_REQ "P2P-PROV-DISC-PBC-REQ " 127/* parameters: <peer address> */ 128#define P2P_EVENT_PROV_DISC_PBC_RESP "P2P-PROV-DISC-PBC-RESP " 129/* parameters: <peer address> <status> */ 130#define P2P_EVENT_PROV_DISC_FAILURE "P2P-PROV-DISC-FAILURE" 131/* parameters: <freq> <src addr> <dialog token> <update indicator> <TLVs> */ 132#define P2P_EVENT_SERV_DISC_REQ "P2P-SERV-DISC-REQ " 133/* parameters: <src addr> <update indicator> <TLVs> */ 134#define P2P_EVENT_SERV_DISC_RESP "P2P-SERV-DISC-RESP " 135#define P2P_EVENT_INVITATION_RECEIVED "P2P-INVITATION-RECEIVED " 136#define P2P_EVENT_INVITATION_RESULT "P2P-INVITATION-RESULT " 137#define P2P_EVENT_FIND_STOPPED "P2P-FIND-STOPPED " 138 139/* parameters: <PMF enabled> <timeout in ms> <Session Information URL> */ 140#define ESS_DISASSOC_IMMINENT "ESS-DISASSOC-IMMINENT " 141 142#define INTERWORKING_AP "INTERWORKING-AP " 143#define INTERWORKING_NO_MATCH "INTERWORKING-NO-MATCH " 144 145#define GAS_RESPONSE_INFO "GAS-RESPONSE-INFO " 146 147/* hostapd control interface - fixed message prefixes */ 148#define WPS_EVENT_PIN_NEEDED "WPS-PIN-NEEDED " 149#define WPS_EVENT_NEW_AP_SETTINGS "WPS-NEW-AP-SETTINGS " 150#define WPS_EVENT_REG_SUCCESS "WPS-REG-SUCCESS " 151#define WPS_EVENT_AP_SETUP_LOCKED "WPS-AP-SETUP-LOCKED " 152#define WPS_EVENT_AP_SETUP_UNLOCKED "WPS-AP-SETUP-UNLOCKED " 153#define WPS_EVENT_AP_PIN_ENABLED "WPS-AP-PIN-ENABLED " 154#define WPS_EVENT_AP_PIN_DISABLED "WPS-AP-PIN-DISABLED " 155#define AP_STA_CONNECTED "AP-STA-CONNECTED " 156#define AP_STA_DISCONNECTED "AP-STA-DISCONNECTED " 157 158#define AP_REJECTED_MAX_STA "AP-REJECTED-MAX-STA " 159#define AP_REJECTED_BLOCKED_STA "AP-REJECTED-BLOCKED-STA " 160 161/* BSS command information masks */ 162 163#define WPA_BSS_MASK_ALL 0xFFFDFFFF 164#define WPA_BSS_MASK_ID BIT(0) 165#define WPA_BSS_MASK_BSSID BIT(1) 166#define WPA_BSS_MASK_FREQ BIT(2) 167#define WPA_BSS_MASK_BEACON_INT BIT(3) 168#define WPA_BSS_MASK_CAPABILITIES BIT(4) 169#define WPA_BSS_MASK_QUAL BIT(5) 170#define WPA_BSS_MASK_NOISE BIT(6) 171#define WPA_BSS_MASK_LEVEL BIT(7) 172#define WPA_BSS_MASK_TSF BIT(8) 173#define WPA_BSS_MASK_AGE BIT(9) 174#define WPA_BSS_MASK_IE BIT(10) 175#define WPA_BSS_MASK_FLAGS BIT(11) 176#define WPA_BSS_MASK_SSID BIT(12) 177#define WPA_BSS_MASK_WPS_SCAN BIT(13) 178#define WPA_BSS_MASK_P2P_SCAN BIT(14) 179#define WPA_BSS_MASK_INTERNETW BIT(15) 180#define WPA_BSS_MASK_WIFI_DISPLAY BIT(16) 181#define WPA_BSS_MASK_DELIM BIT(17) 182 183 184/* wpa_supplicant/hostapd control interface access */ 185 186/** 187 * wpa_ctrl_open - Open a control interface to wpa_supplicant/hostapd 188 * @ctrl_path: Path for UNIX domain sockets; ignored if UDP sockets are used. 189 * Returns: Pointer to abstract control interface data or %NULL on failure 190 * 191 * This function is used to open a control interface to wpa_supplicant/hostapd. 192 * ctrl_path is usually /var/run/wpa_supplicant or /var/run/hostapd. This path 193 * is configured in wpa_supplicant/hostapd and other programs using the control 194 * interface need to use matching path configuration. 195 */ 196struct wpa_ctrl * wpa_ctrl_open(const char *ctrl_path); 197 198 199/** 200 * wpa_ctrl_close - Close a control interface to wpa_supplicant/hostapd 201 * @ctrl: Control interface data from wpa_ctrl_open() 202 * 203 * This function is used to close a control interface. 204 */ 205void wpa_ctrl_close(struct wpa_ctrl *ctrl); 206 207 208/** 209 * wpa_ctrl_request - Send a command to wpa_supplicant/hostapd 210 * @ctrl: Control interface data from wpa_ctrl_open() 211 * @cmd: Command; usually, ASCII text, e.g., "PING" 212 * @cmd_len: Length of the cmd in bytes 213 * @reply: Buffer for the response 214 * @reply_len: Reply buffer length 215 * @msg_cb: Callback function for unsolicited messages or %NULL if not used 216 * Returns: 0 on success, -1 on error (send or receive failed), -2 on timeout 217 * 218 * This function is used to send commands to wpa_supplicant/hostapd. Received 219 * response will be written to reply and reply_len is set to the actual length 220 * of the reply. This function will block for up to two seconds while waiting 221 * for the reply. If unsolicited messages are received, the blocking time may 222 * be longer. 223 * 224 * msg_cb can be used to register a callback function that will be called for 225 * unsolicited messages received while waiting for the command response. These 226 * messages may be received if wpa_ctrl_request() is called at the same time as 227 * wpa_supplicant/hostapd is sending such a message. This can happen only if 228 * the program has used wpa_ctrl_attach() to register itself as a monitor for 229 * event messages. Alternatively to msg_cb, programs can register two control 230 * interface connections and use one of them for commands and the other one for 231 * receiving event messages, in other words, call wpa_ctrl_attach() only for 232 * the control interface connection that will be used for event messages. 233 */ 234int wpa_ctrl_request(struct wpa_ctrl *ctrl, const char *cmd, size_t cmd_len, 235 char *reply, size_t *reply_len, 236 void (*msg_cb)(char *msg, size_t len)); 237 238 239/** 240 * wpa_ctrl_attach - Register as an event monitor for the control interface 241 * @ctrl: Control interface data from wpa_ctrl_open() 242 * Returns: 0 on success, -1 on failure, -2 on timeout 243 * 244 * This function registers the control interface connection as a monitor for 245 * wpa_supplicant/hostapd events. After a success wpa_ctrl_attach() call, the 246 * control interface connection starts receiving event messages that can be 247 * read with wpa_ctrl_recv(). 248 */ 249int wpa_ctrl_attach(struct wpa_ctrl *ctrl); 250 251 252/** 253 * wpa_ctrl_detach - Unregister event monitor from the control interface 254 * @ctrl: Control interface data from wpa_ctrl_open() 255 * Returns: 0 on success, -1 on failure, -2 on timeout 256 * 257 * This function unregisters the control interface connection as a monitor for 258 * wpa_supplicant/hostapd events, i.e., cancels the registration done with 259 * wpa_ctrl_attach(). 260 */ 261int wpa_ctrl_detach(struct wpa_ctrl *ctrl); 262 263 264/** 265 * wpa_ctrl_recv - Receive a pending control interface message 266 * @ctrl: Control interface data from wpa_ctrl_open() 267 * @reply: Buffer for the message data 268 * @reply_len: Length of the reply buffer 269 * Returns: 0 on success, -1 on failure 270 * 271 * This function will receive a pending control interface message. This 272 * function will block if no messages are available. The received response will 273 * be written to reply and reply_len is set to the actual length of the reply. 274 * wpa_ctrl_recv() is only used for event messages, i.e., wpa_ctrl_attach() 275 * must have been used to register the control interface as an event monitor. 276 */ 277int wpa_ctrl_recv(struct wpa_ctrl *ctrl, char *reply, size_t *reply_len); 278 279 280/** 281 * wpa_ctrl_pending - Check whether there are pending event messages 282 * @ctrl: Control interface data from wpa_ctrl_open() 283 * Returns: 1 if there are pending messages, 0 if no, or -1 on error 284 * 285 * This function will check whether there are any pending control interface 286 * message available to be received with wpa_ctrl_recv(). wpa_ctrl_pending() is 287 * only used for event messages, i.e., wpa_ctrl_attach() must have been used to 288 * register the control interface as an event monitor. 289 */ 290int wpa_ctrl_pending(struct wpa_ctrl *ctrl); 291 292 293/** 294 * wpa_ctrl_get_fd - Get file descriptor used by the control interface 295 * @ctrl: Control interface data from wpa_ctrl_open() 296 * Returns: File descriptor used for the connection 297 * 298 * This function can be used to get the file descriptor that is used for the 299 * control interface connection. The returned value can be used, e.g., with 300 * select() while waiting for multiple events. 301 * 302 * The returned file descriptor must not be used directly for sending or 303 * receiving packets; instead, the library functions wpa_ctrl_request() and 304 * wpa_ctrl_recv() must be used for this. 305 */ 306int wpa_ctrl_get_fd(struct wpa_ctrl *ctrl); 307 308char * wpa_ctrl_get_remote_ifname(struct wpa_ctrl *ctrl); 309 310#ifdef ANDROID 311/** 312 * wpa_ctrl_cleanup() - Delete any local UNIX domain socket files that 313 * may be left over from clients that were previously connected to 314 * wpa_supplicant. This keeps these files from being orphaned in the 315 * event of crashes that prevented them from being removed as part 316 * of the normal orderly shutdown. 317 */ 318void wpa_ctrl_cleanup(void); 319#endif /* ANDROID */ 320 321#ifdef CONFIG_CTRL_IFACE_UDP 322/* Port range for multiple wpa_supplicant instances and multiple VIFs */ 323#define WPA_CTRL_IFACE_PORT 9877 324#define WPA_CTRL_IFACE_PORT_LIMIT 50 /* decremented from start */ 325#define WPA_GLOBAL_CTRL_IFACE_PORT 9878 326#define WPA_GLOBAL_CTRL_IFACE_PORT_LIMIT 20 /* incremented from start */ 327#endif /* CONFIG_CTRL_IFACE_UDP */ 328 329 330#ifdef __cplusplus 331} 332#endif 333 334#endif /* WPA_CTRL_H */ 335