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 19 extern "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 /** wpa_supplicant is exiting */ 36 #define WPA_EVENT_TERMINATING "CTRL-EVENT-TERMINATING " 37 /** Password change was completed successfully */ 38 #define WPA_EVENT_PASSWORD_CHANGED "CTRL-EVENT-PASSWORD-CHANGED " 39 /** EAP-Request/Notification received */ 40 #define WPA_EVENT_EAP_NOTIFICATION "CTRL-EVENT-EAP-NOTIFICATION " 41 /** EAP authentication started (EAP-Request/Identity received) */ 42 #define WPA_EVENT_EAP_STARTED "CTRL-EVENT-EAP-STARTED " 43 /** EAP method proposed by the server */ 44 #define WPA_EVENT_EAP_PROPOSED_METHOD "CTRL-EVENT-EAP-PROPOSED-METHOD " 45 /** EAP method selected */ 46 #define WPA_EVENT_EAP_METHOD "CTRL-EVENT-EAP-METHOD " 47 /** EAP peer certificate from TLS */ 48 #define WPA_EVENT_EAP_PEER_CERT "CTRL-EVENT-EAP-PEER-CERT " 49 /** EAP TLS certificate chain validation error */ 50 #define WPA_EVENT_EAP_TLS_CERT_ERROR "CTRL-EVENT-EAP-TLS-CERT-ERROR " 51 /** EAP authentication completed successfully */ 52 #define WPA_EVENT_EAP_SUCCESS "CTRL-EVENT-EAP-SUCCESS " 53 /** EAP authentication failed (EAP-Failure received) */ 54 #define WPA_EVENT_EAP_FAILURE "CTRL-EVENT-EAP-FAILURE " 55 /** New scan results available */ 56 #define WPA_EVENT_SCAN_RESULTS "CTRL-EVENT-SCAN-RESULTS " 57 /** A new BSS entry was added (followed by BSS entry id and BSSID) */ 58 #define WPA_EVENT_BSS_ADDED "CTRL-EVENT-BSS-ADDED " 59 /** A BSS entry was removed (followed by BSS entry id and BSSID) */ 60 #define WPA_EVENT_BSS_REMOVED "CTRL-EVENT-BSS-REMOVED " 61 62 /** WPS overlap detected in PBC mode */ 63 #define WPS_EVENT_OVERLAP "WPS-OVERLAP-DETECTED " 64 /** Available WPS AP with active PBC found in scan results */ 65 #define WPS_EVENT_AP_AVAILABLE_PBC "WPS-AP-AVAILABLE-PBC " 66 /** Available WPS AP with recently selected PIN registrar found in scan results 67 */ 68 #define WPS_EVENT_AP_AVAILABLE_PIN "WPS-AP-AVAILABLE-PIN " 69 /** Available WPS AP found in scan results */ 70 #define WPS_EVENT_AP_AVAILABLE "WPS-AP-AVAILABLE " 71 /** A new credential received */ 72 #define WPS_EVENT_CRED_RECEIVED "WPS-CRED-RECEIVED " 73 /** M2D received */ 74 #define WPS_EVENT_M2D "WPS-M2D " 75 /** WPS registration failed after M2/M2D */ 76 #define WPS_EVENT_FAIL "WPS-FAIL " 77 /** WPS registration completed successfully */ 78 #define WPS_EVENT_SUCCESS "WPS-SUCCESS " 79 /** WPS enrollment attempt timed out and was terminated */ 80 #define WPS_EVENT_TIMEOUT "WPS-TIMEOUT " 81 82 #define WPS_EVENT_ENROLLEE_SEEN "WPS-ENROLLEE-SEEN " 83 84 /* WPS ER events */ 85 #define WPS_EVENT_ER_AP_ADD "WPS-ER-AP-ADD " 86 #define WPS_EVENT_ER_AP_REMOVE "WPS-ER-AP-REMOVE " 87 #define WPS_EVENT_ER_ENROLLEE_ADD "WPS-ER-ENROLLEE-ADD " 88 #define WPS_EVENT_ER_ENROLLEE_REMOVE "WPS-ER-ENROLLEE-REMOVE " 89 90 /* hostapd control interface - fixed message prefixes */ 91 #define WPS_EVENT_PIN_NEEDED "WPS-PIN-NEEDED " 92 #define WPS_EVENT_NEW_AP_SETTINGS "WPS-NEW-AP-SETTINGS " 93 #define WPS_EVENT_REG_SUCCESS "WPS-REG-SUCCESS " 94 #define WPS_EVENT_AP_SETUP_LOCKED "WPS-AP-SETUP-LOCKED " 95 #define AP_STA_CONNECTED "AP-STA-CONNECTED " 96 #define AP_STA_DISCONNECTED "AP-STA-DISCONNECTED " 97 98 99 /* wpa_supplicant/hostapd control interface access */ 100 101 /** 102 * wpa_ctrl_open - Open a control interface to wpa_supplicant/hostapd 103 * @ctrl_path: Path for UNIX domain sockets; ignored if UDP sockets are used. 104 * Returns: Pointer to abstract control interface data or %NULL on failure 105 * 106 * This function is used to open a control interface to wpa_supplicant/hostapd. 107 * ctrl_path is usually /var/run/wpa_supplicant or /var/run/hostapd. This path 108 * is configured in wpa_supplicant/hostapd and other programs using the control 109 * interface need to use matching path configuration. 110 */ 111 struct wpa_ctrl * wpa_ctrl_open(const char *ctrl_path); 112 113 114 /** 115 * wpa_ctrl_close - Close a control interface to wpa_supplicant/hostapd 116 * @ctrl: Control interface data from wpa_ctrl_open() 117 * 118 * This function is used to close a control interface. 119 */ 120 void wpa_ctrl_close(struct wpa_ctrl *ctrl); 121 122 123 /** 124 * wpa_ctrl_request - Send a command to wpa_supplicant/hostapd 125 * @ctrl: Control interface data from wpa_ctrl_open() 126 * @cmd: Command; usually, ASCII text, e.g., "PING" 127 * @cmd_len: Length of the cmd in bytes 128 * @reply: Buffer for the response 129 * @reply_len: Reply buffer length 130 * @msg_cb: Callback function for unsolicited messages or %NULL if not used 131 * Returns: 0 on success, -1 on error (send or receive failed), -2 on timeout 132 * 133 * This function is used to send commands to wpa_supplicant/hostapd. Received 134 * response will be written to reply and reply_len is set to the actual length 135 * of the reply. This function will block for up to two seconds while waiting 136 * for the reply. If unsolicited messages are received, the blocking time may 137 * be longer. 138 * 139 * msg_cb can be used to register a callback function that will be called for 140 * unsolicited messages received while waiting for the command response. These 141 * messages may be received if wpa_ctrl_request() is called at the same time as 142 * wpa_supplicant/hostapd is sending such a message. This can happen only if 143 * the program has used wpa_ctrl_attach() to register itself as a monitor for 144 * event messages. Alternatively to msg_cb, programs can register two control 145 * interface connections and use one of them for commands and the other one for 146 * receiving event messages, in other words, call wpa_ctrl_attach() only for 147 * the control interface connection that will be used for event messages. 148 */ 149 int wpa_ctrl_request(struct wpa_ctrl *ctrl, const char *cmd, size_t cmd_len, 150 char *reply, size_t *reply_len, 151 void (*msg_cb)(char *msg, size_t len)); 152 153 154 /** 155 * wpa_ctrl_attach - Register as an event monitor for the control interface 156 * @ctrl: Control interface data from wpa_ctrl_open() 157 * Returns: 0 on success, -1 on failure, -2 on timeout 158 * 159 * This function registers the control interface connection as a monitor for 160 * wpa_supplicant/hostapd events. After a success wpa_ctrl_attach() call, the 161 * control interface connection starts receiving event messages that can be 162 * read with wpa_ctrl_recv(). 163 */ 164 int wpa_ctrl_attach(struct wpa_ctrl *ctrl); 165 166 167 /** 168 * wpa_ctrl_detach - Unregister event monitor from the control interface 169 * @ctrl: Control interface data from wpa_ctrl_open() 170 * Returns: 0 on success, -1 on failure, -2 on timeout 171 * 172 * This function unregisters the control interface connection as a monitor for 173 * wpa_supplicant/hostapd events, i.e., cancels the registration done with 174 * wpa_ctrl_attach(). 175 */ 176 int wpa_ctrl_detach(struct wpa_ctrl *ctrl); 177 178 179 /** 180 * wpa_ctrl_recv - Receive a pending control interface message 181 * @ctrl: Control interface data from wpa_ctrl_open() 182 * @reply: Buffer for the message data 183 * @reply_len: Length of the reply buffer 184 * Returns: 0 on success, -1 on failure 185 * 186 * This function will receive a pending control interface message. This 187 * function will block if no messages are available. The received response will 188 * be written to reply and reply_len is set to the actual length of the reply. 189 * wpa_ctrl_recv() is only used for event messages, i.e., wpa_ctrl_attach() 190 * must have been used to register the control interface as an event monitor. 191 */ 192 int wpa_ctrl_recv(struct wpa_ctrl *ctrl, char *reply, size_t *reply_len); 193 194 195 /** 196 * wpa_ctrl_pending - Check whether there are pending event messages 197 * @ctrl: Control interface data from wpa_ctrl_open() 198 * Returns: 1 if there are pending messages, 0 if no, or -1 on error 199 * 200 * This function will check whether there are any pending control interface 201 * message available to be received with wpa_ctrl_recv(). wpa_ctrl_pending() is 202 * only used for event messages, i.e., wpa_ctrl_attach() must have been used to 203 * register the control interface as an event monitor. 204 */ 205 int wpa_ctrl_pending(struct wpa_ctrl *ctrl); 206 207 208 /** 209 * wpa_ctrl_get_fd - Get file descriptor used by the control interface 210 * @ctrl: Control interface data from wpa_ctrl_open() 211 * Returns: File descriptor used for the connection 212 * 213 * This function can be used to get the file descriptor that is used for the 214 * control interface connection. The returned value can be used, e.g., with 215 * select() while waiting for multiple events. 216 * 217 * The returned file descriptor must not be used directly for sending or 218 * receiving packets; instead, the library functions wpa_ctrl_request() and 219 * wpa_ctrl_recv() must be used for this. 220 */ 221 int wpa_ctrl_get_fd(struct wpa_ctrl *ctrl); 222 223 #ifdef CONFIG_CTRL_IFACE_UDP 224 #define WPA_CTRL_IFACE_PORT 9877 225 #define WPA_GLOBAL_CTRL_IFACE_PORT 9878 226 #endif /* CONFIG_CTRL_IFACE_UDP */ 227 228 229 #ifdef __cplusplus 230 } 231 #endif 232 233 #endif /* WPA_CTRL_H */ 234