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 13 extern "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 authentication completed successfully */ 48 #define WPA_EVENT_EAP_SUCCESS "CTRL-EVENT-EAP-SUCCESS " 49 /** EAP authentication failed (EAP-Failure received) */ 50 #define WPA_EVENT_EAP_FAILURE "CTRL-EVENT-EAP-FAILURE " 51 /** New scan results available */ 52 #define WPA_EVENT_SCAN_RESULTS "CTRL-EVENT-SCAN-RESULTS " 53 /** wpa_supplicant state change */ 54 #define WPA_EVENT_STATE_CHANGE "CTRL-EVENT-STATE-CHANGE " 55 /** A new BSS entry was added (followed by BSS entry id and BSSID) */ 56 #define WPA_EVENT_BSS_ADDED "CTRL-EVENT-BSS-ADDED " 57 /** A BSS entry was removed (followed by BSS entry id and BSSID) */ 58 #define WPA_EVENT_BSS_REMOVED "CTRL-EVENT-BSS-REMOVED " 59 #ifdef ANDROID_P2P 60 /** Notify the Userspace about the freq conflict */ 61 #define WPA_EVENT_FREQ_CONFLICT "CTRL-EVENT-FREQ-CONFLICT " 62 #endif 63 64 /** WPS overlap detected in PBC mode */ 65 #define WPS_EVENT_OVERLAP "WPS-OVERLAP-DETECTED " 66 /** Available WPS AP with active PBC found in scan results */ 67 #define WPS_EVENT_AP_AVAILABLE_PBC "WPS-AP-AVAILABLE-PBC " 68 /** Available WPS AP with our address as authorized in scan results */ 69 #define WPS_EVENT_AP_AVAILABLE_AUTH "WPS-AP-AVAILABLE-AUTH " 70 /** Available WPS AP with recently selected PIN registrar found in scan results 71 */ 72 #define WPS_EVENT_AP_AVAILABLE_PIN "WPS-AP-AVAILABLE-PIN " 73 /** Available WPS AP found in scan results */ 74 #define WPS_EVENT_AP_AVAILABLE "WPS-AP-AVAILABLE " 75 /** A new credential received */ 76 #define WPS_EVENT_CRED_RECEIVED "WPS-CRED-RECEIVED " 77 /** M2D received */ 78 #define WPS_EVENT_M2D "WPS-M2D " 79 /** WPS registration failed after M2/M2D */ 80 #define WPS_EVENT_FAIL "WPS-FAIL " 81 /** WPS registration completed successfully */ 82 #define WPS_EVENT_SUCCESS "WPS-SUCCESS " 83 /** WPS enrollment attempt timed out and was terminated */ 84 #define WPS_EVENT_TIMEOUT "WPS-TIMEOUT " 85 86 #define WPS_EVENT_ENROLLEE_SEEN "WPS-ENROLLEE-SEEN " 87 88 #define WPS_EVENT_OPEN_NETWORK "WPS-OPEN-NETWORK " 89 90 /* WPS ER events */ 91 #define WPS_EVENT_ER_AP_ADD "WPS-ER-AP-ADD " 92 #define WPS_EVENT_ER_AP_REMOVE "WPS-ER-AP-REMOVE " 93 #define WPS_EVENT_ER_ENROLLEE_ADD "WPS-ER-ENROLLEE-ADD " 94 #define WPS_EVENT_ER_ENROLLEE_REMOVE "WPS-ER-ENROLLEE-REMOVE " 95 #define WPS_EVENT_ER_AP_SETTINGS "WPS-ER-AP-SETTINGS " 96 #define WPS_EVENT_ER_SET_SEL_REG "WPS-ER-AP-SET-SEL-REG " 97 98 /** P2P device found */ 99 #define P2P_EVENT_DEVICE_FOUND "P2P-DEVICE-FOUND " 100 101 /** P2P device lost */ 102 #define P2P_EVENT_DEVICE_LOST "P2P-DEVICE-LOST " 103 104 /** A P2P device requested GO negotiation, but we were not ready to start the 105 * negotiation */ 106 #define P2P_EVENT_GO_NEG_REQUEST "P2P-GO-NEG-REQUEST " 107 #define P2P_EVENT_GO_NEG_SUCCESS "P2P-GO-NEG-SUCCESS " 108 #define P2P_EVENT_GO_NEG_FAILURE "P2P-GO-NEG-FAILURE " 109 #define P2P_EVENT_GROUP_FORMATION_SUCCESS "P2P-GROUP-FORMATION-SUCCESS " 110 #define P2P_EVENT_GROUP_FORMATION_FAILURE "P2P-GROUP-FORMATION-FAILURE " 111 #define P2P_EVENT_GROUP_STARTED "P2P-GROUP-STARTED " 112 #define P2P_EVENT_GROUP_REMOVED "P2P-GROUP-REMOVED " 113 #define P2P_EVENT_CROSS_CONNECT_ENABLE "P2P-CROSS-CONNECT-ENABLE " 114 #define P2P_EVENT_CROSS_CONNECT_DISABLE "P2P-CROSS-CONNECT-DISABLE " 115 /* parameters: <peer address> <PIN> */ 116 #define P2P_EVENT_PROV_DISC_SHOW_PIN "P2P-PROV-DISC-SHOW-PIN " 117 /* parameters: <peer address> */ 118 #define P2P_EVENT_PROV_DISC_ENTER_PIN "P2P-PROV-DISC-ENTER-PIN " 119 /* parameters: <peer address> */ 120 #define P2P_EVENT_PROV_DISC_PBC_REQ "P2P-PROV-DISC-PBC-REQ " 121 /* parameters: <peer address> */ 122 #define P2P_EVENT_PROV_DISC_PBC_RESP "P2P-PROV-DISC-PBC-RESP " 123 /* parameters: <freq> <src addr> <dialog token> <update indicator> <TLVs> */ 124 #define P2P_EVENT_SERV_DISC_REQ "P2P-SERV-DISC-REQ " 125 /* parameters: <src addr> <update indicator> <TLVs> */ 126 #define P2P_EVENT_SERV_DISC_RESP "P2P-SERV-DISC-RESP " 127 #define P2P_EVENT_INVITATION_RECEIVED "P2P-INVITATION-RECEIVED " 128 #define P2P_EVENT_INVITATION_RESULT "P2P-INVITATION-RESULT " 129 #define P2P_EVENT_FIND_STOPPED "P2P-FIND-STOPPED " 130 131 #define INTERWORKING_AP "INTERWORKING-AP " 132 #define INTERWORKING_NO_MATCH "INTERWORKING-NO-MATCH " 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 */ 158 struct 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 */ 167 void 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 */ 196 int 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 */ 211 int 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 */ 223 int 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 */ 239 int 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 */ 252 int 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 */ 268 int wpa_ctrl_get_fd(struct wpa_ctrl *ctrl); 269 270 #ifdef ANDROID 271 /** 272 * wpa_ctrl_cleanup() - Delete any local UNIX domain socket files that 273 * may be left over from clients that were previously connected to 274 * wpa_supplicant. This keeps these files from being orphaned in the 275 * event of crashes that prevented them from being removed as part 276 * of the normal orderly shutdown. 277 */ 278 void wpa_ctrl_cleanup(void); 279 #endif /* ANDROID */ 280 281 #ifdef CONFIG_CTRL_IFACE_UDP 282 #define WPA_CTRL_IFACE_PORT 9877 283 #define WPA_GLOBAL_CTRL_IFACE_PORT 9878 284 #endif /* CONFIG_CTRL_IFACE_UDP */ 285 286 287 #ifdef __cplusplus 288 } 289 #endif 290 291 #endif /* WPA_CTRL_H */ 292