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