wpa_ctrl.h revision 497c1d5e50162d6b3c1cce5dbd9c5fd9da69aaef
1/* 2 * wpa_supplicant/hostapd control interface library 3 * Copyright (c) 2004-2006, 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 WPA_CTRL_H 16#define WPA_CTRL_H 17 18#ifdef __cplusplus 19extern "C" { 20#endif 21 22/* wpa_supplicant control interface - fixed message prefixes */ 23 24/** Interactive request for identity/password/pin */ 25#define WPA_CTRL_REQ "CTRL-REQ-" 26 27/** Response to identity/password/pin request */ 28#define WPA_CTRL_RSP "CTRL-RSP-" 29 30/* Event messages with fixed prefix */ 31/** Authentication completed successfully and data connection enabled */ 32#define WPA_EVENT_CONNECTED "CTRL-EVENT-CONNECTED " 33/** Disconnected, data connection is not available */ 34#define WPA_EVENT_DISCONNECTED "CTRL-EVENT-DISCONNECTED " 35/** Association rejected during connection attempt */ 36#define WPA_EVENT_ASSOC_REJECT "CTRL-EVENT-ASSOC-REJECT " 37/** wpa_supplicant is exiting */ 38#define WPA_EVENT_TERMINATING "CTRL-EVENT-TERMINATING " 39/** Password change was completed successfully */ 40#define WPA_EVENT_PASSWORD_CHANGED "CTRL-EVENT-PASSWORD-CHANGED " 41/** EAP-Request/Notification received */ 42#define WPA_EVENT_EAP_NOTIFICATION "CTRL-EVENT-EAP-NOTIFICATION " 43/** EAP authentication started (EAP-Request/Identity received) */ 44#define WPA_EVENT_EAP_STARTED "CTRL-EVENT-EAP-STARTED " 45/** EAP method proposed by the server */ 46#define WPA_EVENT_EAP_PROPOSED_METHOD "CTRL-EVENT-EAP-PROPOSED-METHOD " 47/** EAP method selected */ 48#define WPA_EVENT_EAP_METHOD "CTRL-EVENT-EAP-METHOD " 49/** EAP peer certificate from TLS */ 50#define WPA_EVENT_EAP_PEER_CERT "CTRL-EVENT-EAP-PEER-CERT " 51/** EAP TLS certificate chain validation error */ 52#define WPA_EVENT_EAP_TLS_CERT_ERROR "CTRL-EVENT-EAP-TLS-CERT-ERROR " 53/** EAP authentication completed successfully */ 54#define WPA_EVENT_EAP_SUCCESS "CTRL-EVENT-EAP-SUCCESS " 55/** EAP authentication failed (EAP-Failure received) */ 56#define WPA_EVENT_EAP_FAILURE "CTRL-EVENT-EAP-FAILURE " 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 66/** WPS overlap detected in PBC mode */ 67#define WPS_EVENT_OVERLAP "WPS-OVERLAP-DETECTED " 68/** Available WPS AP with active PBC found in scan results */ 69#define WPS_EVENT_AP_AVAILABLE_PBC "WPS-AP-AVAILABLE-PBC " 70/** Available WPS AP with our address as authorized in scan results */ 71#define WPS_EVENT_AP_AVAILABLE_AUTH "WPS-AP-AVAILABLE-AUTH " 72/** Available WPS AP with recently selected PIN registrar found in scan results 73 */ 74#define WPS_EVENT_AP_AVAILABLE_PIN "WPS-AP-AVAILABLE-PIN " 75/** Available WPS AP found in scan results */ 76#define WPS_EVENT_AP_AVAILABLE "WPS-AP-AVAILABLE " 77/** A new credential received */ 78#define WPS_EVENT_CRED_RECEIVED "WPS-CRED-RECEIVED " 79/** M2D received */ 80#define WPS_EVENT_M2D "WPS-M2D " 81/** WPS registration failed after M2/M2D */ 82#define WPS_EVENT_FAIL "WPS-FAIL " 83/** WPS registration completed successfully */ 84#define WPS_EVENT_SUCCESS "WPS-SUCCESS " 85/** WPS enrollment attempt timed out and was terminated */ 86#define WPS_EVENT_TIMEOUT "WPS-TIMEOUT " 87 88#define WPS_EVENT_ENROLLEE_SEEN "WPS-ENROLLEE-SEEN " 89 90#define WPS_EVENT_OPEN_NETWORK "WPS-OPEN-NETWORK " 91 92/* WPS ER events */ 93#define WPS_EVENT_ER_AP_ADD "WPS-ER-AP-ADD " 94#define WPS_EVENT_ER_AP_REMOVE "WPS-ER-AP-REMOVE " 95#define WPS_EVENT_ER_ENROLLEE_ADD "WPS-ER-ENROLLEE-ADD " 96#define WPS_EVENT_ER_ENROLLEE_REMOVE "WPS-ER-ENROLLEE-REMOVE " 97#define WPS_EVENT_ER_AP_SETTINGS "WPS-ER-AP-SETTINGS " 98#define WPS_EVENT_ER_SET_SEL_REG "WPS-ER-AP-SET-SEL-REG " 99 100/** P2P device found */ 101#define P2P_EVENT_DEVICE_FOUND "P2P-DEVICE-FOUND " 102 103#ifdef ANDROID_BRCM_P2P_PATCH 104/** P2P device lost */ 105#define P2P_EVENT_DEVICE_LOST "P2P-DEVICE-LOST " 106#endif 107 108/** A P2P device requested GO negotiation, but we were not ready to start the 109 * negotiation */ 110#define P2P_EVENT_GO_NEG_REQUEST "P2P-GO-NEG-REQUEST " 111#define P2P_EVENT_GO_NEG_SUCCESS "P2P-GO-NEG-SUCCESS " 112#define P2P_EVENT_GO_NEG_FAILURE "P2P-GO-NEG-FAILURE " 113#define P2P_EVENT_GROUP_FORMATION_SUCCESS "P2P-GROUP-FORMATION-SUCCESS " 114#define P2P_EVENT_GROUP_FORMATION_FAILURE "P2P-GROUP-FORMATION-FAILURE " 115#define P2P_EVENT_GROUP_STARTED "P2P-GROUP-STARTED " 116#define P2P_EVENT_GROUP_REMOVED "P2P-GROUP-REMOVED " 117#define P2P_EVENT_CROSS_CONNECT_ENABLE "P2P-CROSS-CONNECT-ENABLE " 118#define P2P_EVENT_CROSS_CONNECT_DISABLE "P2P-CROSS-CONNECT-DISABLE " 119/* parameters: <peer address> <PIN> */ 120#define P2P_EVENT_PROV_DISC_SHOW_PIN "P2P-PROV-DISC-SHOW-PIN " 121/* parameters: <peer address> */ 122#define P2P_EVENT_PROV_DISC_ENTER_PIN "P2P-PROV-DISC-ENTER-PIN " 123/* parameters: <peer address> */ 124#define P2P_EVENT_PROV_DISC_PBC_REQ "P2P-PROV-DISC-PBC-REQ " 125/* parameters: <peer address> */ 126#define P2P_EVENT_PROV_DISC_PBC_RESP "P2P-PROV-DISC-PBC-RESP " 127/* parameters: <freq> <src addr> <dialog token> <update indicator> <TLVs> */ 128#define P2P_EVENT_SERV_DISC_REQ "P2P-SERV-DISC-REQ " 129/* parameters: <src addr> <update indicator> <TLVs> */ 130#define P2P_EVENT_SERV_DISC_RESP "P2P-SERV-DISC-RESP " 131#define P2P_EVENT_INVITATION_RECEIVED "P2P-INVITATION-RECEIVED " 132#define P2P_EVENT_INVITATION_RESULT "P2P-INVITATION-RESULT " 133 134/* hostapd control interface - fixed message prefixes */ 135#define WPS_EVENT_PIN_NEEDED "WPS-PIN-NEEDED " 136#define WPS_EVENT_NEW_AP_SETTINGS "WPS-NEW-AP-SETTINGS " 137#define WPS_EVENT_REG_SUCCESS "WPS-REG-SUCCESS " 138#define WPS_EVENT_AP_SETUP_LOCKED "WPS-AP-SETUP-LOCKED " 139#define WPS_EVENT_AP_SETUP_UNLOCKED "WPS-AP-SETUP-UNLOCKED " 140#define WPS_EVENT_AP_PIN_ENABLED "WPS-AP-PIN-ENABLED " 141#define WPS_EVENT_AP_PIN_DISABLED "WPS-AP-PIN-DISABLED " 142#define AP_STA_CONNECTED "AP-STA-CONNECTED " 143#define AP_STA_DISCONNECTED "AP-STA-DISCONNECTED " 144 145 146/* wpa_supplicant/hostapd control interface access */ 147 148/** 149 * wpa_ctrl_open - Open a control interface to wpa_supplicant/hostapd 150 * @ctrl_path: Path for UNIX domain sockets; ignored if UDP sockets are used. 151 * Returns: Pointer to abstract control interface data or %NULL on failure 152 * 153 * This function is used to open a control interface to wpa_supplicant/hostapd. 154 * ctrl_path is usually /var/run/wpa_supplicant or /var/run/hostapd. This path 155 * is configured in wpa_supplicant/hostapd and other programs using the control 156 * interface need to use matching path configuration. 157 */ 158struct wpa_ctrl * wpa_ctrl_open(const char *ctrl_path); 159 160 161/** 162 * wpa_ctrl_close - Close a control interface to wpa_supplicant/hostapd 163 * @ctrl: Control interface data from wpa_ctrl_open() 164 * 165 * This function is used to close a control interface. 166 */ 167void wpa_ctrl_close(struct wpa_ctrl *ctrl); 168 169 170/** 171 * wpa_ctrl_request - Send a command to wpa_supplicant/hostapd 172 * @ctrl: Control interface data from wpa_ctrl_open() 173 * @cmd: Command; usually, ASCII text, e.g., "PING" 174 * @cmd_len: Length of the cmd in bytes 175 * @reply: Buffer for the response 176 * @reply_len: Reply buffer length 177 * @msg_cb: Callback function for unsolicited messages or %NULL if not used 178 * Returns: 0 on success, -1 on error (send or receive failed), -2 on timeout 179 * 180 * This function is used to send commands to wpa_supplicant/hostapd. Received 181 * response will be written to reply and reply_len is set to the actual length 182 * of the reply. This function will block for up to two seconds while waiting 183 * for the reply. If unsolicited messages are received, the blocking time may 184 * be longer. 185 * 186 * msg_cb can be used to register a callback function that will be called for 187 * unsolicited messages received while waiting for the command response. These 188 * messages may be received if wpa_ctrl_request() is called at the same time as 189 * wpa_supplicant/hostapd is sending such a message. This can happen only if 190 * the program has used wpa_ctrl_attach() to register itself as a monitor for 191 * event messages. Alternatively to msg_cb, programs can register two control 192 * interface connections and use one of them for commands and the other one for 193 * receiving event messages, in other words, call wpa_ctrl_attach() only for 194 * the control interface connection that will be used for event messages. 195 */ 196int wpa_ctrl_request(struct wpa_ctrl *ctrl, const char *cmd, size_t cmd_len, 197 char *reply, size_t *reply_len, 198 void (*msg_cb)(char *msg, size_t len)); 199 200 201/** 202 * wpa_ctrl_attach - Register as an event monitor for the control interface 203 * @ctrl: Control interface data from wpa_ctrl_open() 204 * Returns: 0 on success, -1 on failure, -2 on timeout 205 * 206 * This function registers the control interface connection as a monitor for 207 * wpa_supplicant/hostapd events. After a success wpa_ctrl_attach() call, the 208 * control interface connection starts receiving event messages that can be 209 * read with wpa_ctrl_recv(). 210 */ 211int wpa_ctrl_attach(struct wpa_ctrl *ctrl); 212 213 214/** 215 * wpa_ctrl_detach - Unregister event monitor from the control interface 216 * @ctrl: Control interface data from wpa_ctrl_open() 217 * Returns: 0 on success, -1 on failure, -2 on timeout 218 * 219 * This function unregisters the control interface connection as a monitor for 220 * wpa_supplicant/hostapd events, i.e., cancels the registration done with 221 * wpa_ctrl_attach(). 222 */ 223int wpa_ctrl_detach(struct wpa_ctrl *ctrl); 224 225 226/** 227 * wpa_ctrl_recv - Receive a pending control interface message 228 * @ctrl: Control interface data from wpa_ctrl_open() 229 * @reply: Buffer for the message data 230 * @reply_len: Length of the reply buffer 231 * Returns: 0 on success, -1 on failure 232 * 233 * This function will receive a pending control interface message. This 234 * function will block if no messages are available. The received response will 235 * be written to reply and reply_len is set to the actual length of the reply. 236 * wpa_ctrl_recv() is only used for event messages, i.e., wpa_ctrl_attach() 237 * must have been used to register the control interface as an event monitor. 238 */ 239int wpa_ctrl_recv(struct wpa_ctrl *ctrl, char *reply, size_t *reply_len); 240 241 242/** 243 * wpa_ctrl_pending - Check whether there are pending event messages 244 * @ctrl: Control interface data from wpa_ctrl_open() 245 * Returns: 1 if there are pending messages, 0 if no, or -1 on error 246 * 247 * This function will check whether there are any pending control interface 248 * message available to be received with wpa_ctrl_recv(). wpa_ctrl_pending() is 249 * only used for event messages, i.e., wpa_ctrl_attach() must have been used to 250 * register the control interface as an event monitor. 251 */ 252int wpa_ctrl_pending(struct wpa_ctrl *ctrl); 253 254 255/** 256 * wpa_ctrl_get_fd - Get file descriptor used by the control interface 257 * @ctrl: Control interface data from wpa_ctrl_open() 258 * Returns: File descriptor used for the connection 259 * 260 * This function can be used to get the file descriptor that is used for the 261 * control interface connection. The returned value can be used, e.g., with 262 * select() while waiting for multiple events. 263 * 264 * The returned file descriptor must not be used directly for sending or 265 * receiving packets; instead, the library functions wpa_ctrl_request() and 266 * wpa_ctrl_recv() must be used for this. 267 */ 268int wpa_ctrl_get_fd(struct wpa_ctrl *ctrl); 269 270#ifdef CONFIG_CTRL_IFACE_UDP 271#define WPA_CTRL_IFACE_PORT 9877 272#define WPA_GLOBAL_CTRL_IFACE_PORT 9878 273#endif /* CONFIG_CTRL_IFACE_UDP */ 274 275 276#ifdef __cplusplus 277} 278#endif 279 280#endif /* WPA_CTRL_H */ 281