dist/wpa/src/common/wpa_ctrl.h

   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 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
  53 /* wpa_supplicant/hostapd control interface access */
  54
  55 /**
  56  * wpa_ctrl_open - Open a control interface to wpa_supplicant/hostapd
  57  * @ctrl_path: Path for UNIX domain sockets; ignored if UDP sockets are used.
  58  * Returns: Pointer to abstract control interface data or %NULL on failure
  59  *
  60  * This function is used to open a control interface to wpa_supplicant/hostapd.
  61  * ctrl_path is usually /var/run/wpa_supplicant or /var/run/hostapd. This path
  62  * is configured in wpa_supplicant/hostapd and other programs using the control
  63  * interface need to use matching path configuration.
  64  */
  65 struct wpa_ctrl * wpa_ctrl_open(const char *ctrl_path);
  66
  67
  68 /**
  69  * wpa_ctrl_close - Close a control interface to wpa_supplicant/hostapd
  70  * @ctrl: Control interface data from wpa_ctrl_open()
  71  *
  72  * This function is used to close a control interface.
  73  */
  74 void wpa_ctrl_close(struct wpa_ctrl *ctrl);
  75
  76
  77 /**
  78  * wpa_ctrl_request - Send a command to wpa_supplicant/hostapd
  79  * @ctrl: Control interface data from wpa_ctrl_open()
  80  * @cmd: Command; usually, ASCII text, e.g., "PING"
  81  * @cmd_len: Length of the cmd in bytes
  82  * @reply: Buffer for the response
  83  * @reply_len: Reply buffer length
  84  * @msg_cb: Callback function for unsolicited messages or %NULL if not used
  85  * Returns: 0 on success, -1 on error (send or receive failed), -2 on timeout
  86  *
  87  * This function is used to send commands to wpa_supplicant/hostapd. Received
  88  * response will be written to reply and reply_len is set to the actual length
  89  * of the reply. This function will block for up to two seconds while waiting
  90  * for the reply. If unsolicited messages are received, the blocking time may
  91  * be longer.
  92  *
  93  * msg_cb can be used to register a callback function that will be called for
  94  * unsolicited messages received while waiting for the command response. These
  95  * messages may be received if wpa_ctrl_request() is called at the same time as
  96  * wpa_supplicant/hostapd is sending such a message. This can happen only if
  97  * the program has used wpa_ctrl_attach() to register itself as a monitor for
  98  * event messages. Alternatively to msg_cb, programs can register two control
  99  * interface connections and use one of them for commands and the other one for
 100  * receiving event messages, in other words, call wpa_ctrl_attach() only for
 101  * the control interface connection that will be used for event messages.
 102  */
 103 int wpa_ctrl_request(struct wpa_ctrl *ctrl, const char *cmd, size_t cmd_len,
 104                      char *reply, size_t *reply_len,
 105                      void (*msg_cb)(char *msg, size_t len));
 106
 107
 108 /**
 109  * wpa_ctrl_attach - Register as an event monitor for the control interface
 110  * @ctrl: Control interface data from wpa_ctrl_open()
 111  * Returns: 0 on success, -1 on failure, -2 on timeout
 112  *
 113  * This function registers the control interface connection as a monitor for
 114  * wpa_supplicant/hostapd events. After a success wpa_ctrl_attach() call, the
 115  * control interface connection starts receiving event messages that can be
 116  * read with wpa_ctrl_recv().
 117  */
 118 int wpa_ctrl_attach(struct wpa_ctrl *ctrl);
 119
 120
 121 /**
 122  * wpa_ctrl_detach - Unregister event monitor from the control interface
 123  * @ctrl: Control interface data from wpa_ctrl_open()
 124  * Returns: 0 on success, -1 on failure, -2 on timeout
 125  *
 126  * This function unregisters the control interface connection as a monitor for
 127  * wpa_supplicant/hostapd events, i.e., cancels the registration done with
 128  * wpa_ctrl_attach().
 129  */
 130 int wpa_ctrl_detach(struct wpa_ctrl *ctrl);
 131
 132
 133 /**
 134  * wpa_ctrl_recv - Receive a pending control interface message
 135  * @ctrl: Control interface data from wpa_ctrl_open()
 136  * @reply: Buffer for the message data
 137  * @reply_len: Length of the reply buffer
 138  * Returns: 0 on success, -1 on failure
 139  *
 140  * This function will receive a pending control interface message. This
 141  * function will block if no messages are available. The received response will
 142  * be written to reply and reply_len is set to the actual length of the reply.
 143  * wpa_ctrl_recv() is only used for event messages, i.e., wpa_ctrl_attach()
 144  * must have been used to register the control interface as an event monitor.
 145  */
 146 int wpa_ctrl_recv(struct wpa_ctrl *ctrl, char *reply, size_t *reply_len);
 147
 148
 149 /**
 150  * wpa_ctrl_pending - Check whether there are pending event messages
 151  * @ctrl: Control interface data from wpa_ctrl_open()
 152  * Returns: 1 if there are pending messages, 0 if no, or -1 on error
 153  *
 154  * This function will check whether there are any pending control interface
 155  * message available to be received with wpa_ctrl_recv(). wpa_ctrl_pending() is
 156  * only used for event messages, i.e., wpa_ctrl_attach() must have been used to
 157  * register the control interface as an event monitor.
 158  */
 159 int wpa_ctrl_pending(struct wpa_ctrl *ctrl);
 160
 161
 162 /**
 163  * wpa_ctrl_get_fd - Get file descriptor used by the control interface
 164  * @ctrl: Control interface data from wpa_ctrl_open()
 165  * Returns: File descriptor used for the connection
 166  *
 167  * This function can be used to get the file descriptor that is used for the
 168  * control interface connection. The returned value can be used, e.g., with
 169  * select() while waiting for multiple events.
 170  *
 171  * The returned file descriptor must not be used directly for sending or
 172  * receiving packets; instead, the library functions wpa_ctrl_request() and
 173  * wpa_ctrl_recv() must be used for this.
 174  */
 175 int wpa_ctrl_get_fd(struct wpa_ctrl *ctrl);
 176
 177 #ifdef CONFIG_CTRL_IFACE_UDP
 178 #define WPA_CTRL_IFACE_PORT 9877
 179 #define WPA_GLOBAL_CTRL_IFACE_PORT 9878
 180 #endif /* CONFIG_CTRL_IFACE_UDP */
 181
 182
 183 #ifdef  __cplusplus
 184 }
 185 #endif
 186
 187 #endif /* WPA_CTRL_H */