[thirdparty/hostap.git] / src / common / wpa_ctrl.h

/*
 * wpa_supplicant/hostapd control interface library
 * Copyright (c) 2004-2006, Jouni Malinen <j@w1.fi>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation.
 *
 * Alternatively, this software may be distributed under the terms of BSD
 * license.
 *
 * See README and COPYING for more details.
 */

#ifndef WPA_CTRL_H
#define WPA_CTRL_H

#ifdef  __cplusplus
extern "C" {
#endif

/* wpa_supplicant control interface - fixed message prefixes */

/** Interactive request for identity/password/pin */
#define WPA_CTRL_REQ "CTRL-REQ-"

/** Response to identity/password/pin request */
#define WPA_CTRL_RSP "CTRL-RSP-"

/* Event messages with fixed prefix */
/** Authentication completed successfully and data connection enabled */
#define WPA_EVENT_CONNECTED "CTRL-EVENT-CONNECTED "
/** Disconnected, data connection is not available */
#define WPA_EVENT_DISCONNECTED "CTRL-EVENT-DISCONNECTED "
/** wpa_supplicant is exiting */
#define WPA_EVENT_TERMINATING "CTRL-EVENT-TERMINATING "
/** Password change was completed successfully */
#define WPA_EVENT_PASSWORD_CHANGED "CTRL-EVENT-PASSWORD-CHANGED "
/** EAP-Request/Notification received */
#define WPA_EVENT_EAP_NOTIFICATION "CTRL-EVENT-EAP-NOTIFICATION "
/** EAP authentication started (EAP-Request/Identity received) */
#define WPA_EVENT_EAP_STARTED "CTRL-EVENT-EAP-STARTED "
/** EAP method proposed by the server */
#define WPA_EVENT_EAP_PROPOSED_METHOD "CTRL-EVENT-EAP-PROPOSED-METHOD "
/** EAP method selected */
#define WPA_EVENT_EAP_METHOD "CTRL-EVENT-EAP-METHOD "
/** EAP peer certificate from TLS */
#define WPA_EVENT_EAP_PEER_CERT "CTRL-EVENT-EAP-PEER-CERT "
/** EAP TLS certificate chain validation error */
#define WPA_EVENT_EAP_TLS_CERT_ERROR "CTRL-EVENT-EAP-TLS-CERT-ERROR "
/** EAP authentication completed successfully */
#define WPA_EVENT_EAP_SUCCESS "CTRL-EVENT-EAP-SUCCESS "
/** EAP authentication failed (EAP-Failure received) */
#define WPA_EVENT_EAP_FAILURE "CTRL-EVENT-EAP-FAILURE "
/** New scan results available */
#define WPA_EVENT_SCAN_RESULTS "CTRL-EVENT-SCAN-RESULTS "
/** A new BSS entry was added (followed by BSS entry id and BSSID) */
#define WPA_EVENT_BSS_ADDED "CTRL-EVENT-BSS-ADDED "
/** A BSS entry was removed (followed by BSS entry id and BSSID) */
#define WPA_EVENT_BSS_REMOVED "CTRL-EVENT-BSS-REMOVED "

/** WPS overlap detected in PBC mode */
#define WPS_EVENT_OVERLAP "WPS-OVERLAP-DETECTED "
/** Available WPS AP with active PBC found in scan results */
#define WPS_EVENT_AP_AVAILABLE_PBC "WPS-AP-AVAILABLE-PBC "
/** Available WPS AP with recently selected PIN registrar found in scan results
 */
#define WPS_EVENT_AP_AVAILABLE_PIN "WPS-AP-AVAILABLE-PIN "
/** Available WPS AP found in scan results */
#define WPS_EVENT_AP_AVAILABLE "WPS-AP-AVAILABLE "
/** A new credential received */
#define WPS_EVENT_CRED_RECEIVED "WPS-CRED-RECEIVED "
/** M2D received */
#define WPS_EVENT_M2D "WPS-M2D "
/** WPS registration failed after M2/M2D */
#define WPS_EVENT_FAIL "WPS-FAIL "
/** WPS registration completed successfully */
#define WPS_EVENT_SUCCESS "WPS-SUCCESS "
/** WPS enrollment attempt timed out and was terminated */
#define WPS_EVENT_TIMEOUT "WPS-TIMEOUT "

#define WPS_EVENT_ENROLLEE_SEEN "WPS-ENROLLEE-SEEN "

/* WPS ER events */
#define WPS_EVENT_ER_AP_ADD "WPS-ER-AP-ADD "
#define WPS_EVENT_ER_AP_REMOVE "WPS-ER-AP-REMOVE "
#define WPS_EVENT_ER_ENROLLEE_ADD "WPS-ER-ENROLLEE-ADD "
#define WPS_EVENT_ER_ENROLLEE_REMOVE "WPS-ER-ENROLLEE-REMOVE "
#define WPS_EVENT_ER_AP_SETTINGS "WPS-ER-AP-SETTINGS "

/* hostapd control interface - fixed message prefixes */
#define WPS_EVENT_PIN_NEEDED "WPS-PIN-NEEDED "
#define WPS_EVENT_NEW_AP_SETTINGS "WPS-NEW-AP-SETTINGS "
#define WPS_EVENT_REG_SUCCESS "WPS-REG-SUCCESS "
#define WPS_EVENT_AP_SETUP_LOCKED "WPS-AP-SETUP-LOCKED "
#define WPS_EVENT_AP_SETUP_UNLOCKED "WPS-AP-SETUP-UNLOCKED "
#define WPS_EVENT_AP_PIN_ENABLED "WPS-AP-PIN-ENABLED "
#define WPS_EVENT_AP_PIN_DISABLED "WPS-AP-PIN-DISABLED "
#define AP_STA_CONNECTED "AP-STA-CONNECTED "
#define AP_STA_DISCONNECTED "AP-STA-DISCONNECTED "


/* wpa_supplicant/hostapd control interface access */

/**
 * wpa_ctrl_open - Open a control interface to wpa_supplicant/hostapd
 * @ctrl_path: Path for UNIX domain sockets; ignored if UDP sockets are used.
 * Returns: Pointer to abstract control interface data or %NULL on failure
 *
 * This function is used to open a control interface to wpa_supplicant/hostapd.
 * ctrl_path is usually /var/run/wpa_supplicant or /var/run/hostapd. This path
 * is configured in wpa_supplicant/hostapd and other programs using the control
 * interface need to use matching path configuration.
 */
struct wpa_ctrl * wpa_ctrl_open(const char *ctrl_path);


/**
 * wpa_ctrl_close - Close a control interface to wpa_supplicant/hostapd
 * @ctrl: Control interface data from wpa_ctrl_open()
 *
 * This function is used to close a control interface.
 */
void wpa_ctrl_close(struct wpa_ctrl *ctrl);


/**
 * wpa_ctrl_request - Send a command to wpa_supplicant/hostapd
 * @ctrl: Control interface data from wpa_ctrl_open()
 * @cmd: Command; usually, ASCII text, e.g., "PING"
 * @cmd_len: Length of the cmd in bytes
 * @reply: Buffer for the response
 * @reply_len: Reply buffer length
 * @msg_cb: Callback function for unsolicited messages or %NULL if not used
 * Returns: 0 on success, -1 on error (send or receive failed), -2 on timeout
 *
 * This function is used to send commands to wpa_supplicant/hostapd. Received
 * response will be written to reply and reply_len is set to the actual length
 * of the reply. This function will block for up to two seconds while waiting
 * for the reply. If unsolicited messages are received, the blocking time may
 * be longer.
 *
 * msg_cb can be used to register a callback function that will be called for
 * unsolicited messages received while waiting for the command response. These
 * messages may be received if wpa_ctrl_request() is called at the same time as
 * wpa_supplicant/hostapd is sending such a message. This can happen only if
 * the program has used wpa_ctrl_attach() to register itself as a monitor for
 * event messages. Alternatively to msg_cb, programs can register two control
 * interface connections and use one of them for commands and the other one for
 * receiving event messages, in other words, call wpa_ctrl_attach() only for
 * the control interface connection that will be used for event messages.
 */
int wpa_ctrl_request(struct wpa_ctrl *ctrl, const char *cmd, size_t cmd_len,
		     char *reply, size_t *reply_len,
		     void (*msg_cb)(char *msg, size_t len));


/**
 * wpa_ctrl_attach - Register as an event monitor for the control interface
 * @ctrl: Control interface data from wpa_ctrl_open()
 * Returns: 0 on success, -1 on failure, -2 on timeout
 *
 * This function registers the control interface connection as a monitor for
 * wpa_supplicant/hostapd events. After a success wpa_ctrl_attach() call, the
 * control interface connection starts receiving event messages that can be
 * read with wpa_ctrl_recv().
 */
int wpa_ctrl_attach(struct wpa_ctrl *ctrl);


/**
 * wpa_ctrl_detach - Unregister event monitor from the control interface
 * @ctrl: Control interface data from wpa_ctrl_open()
 * Returns: 0 on success, -1 on failure, -2 on timeout
 *
 * This function unregisters the control interface connection as a monitor for
 * wpa_supplicant/hostapd events, i.e., cancels the registration done with
 * wpa_ctrl_attach().
 */
int wpa_ctrl_detach(struct wpa_ctrl *ctrl);


/**
 * wpa_ctrl_recv - Receive a pending control interface message
 * @ctrl: Control interface data from wpa_ctrl_open()
 * @reply: Buffer for the message data
 * @reply_len: Length of the reply buffer
 * Returns: 0 on success, -1 on failure
 *
 * This function will receive a pending control interface message. This
 * function will block if no messages are available. The received response will
 * be written to reply and reply_len is set to the actual length of the reply.
 * wpa_ctrl_recv() is only used for event messages, i.e., wpa_ctrl_attach()
 * must have been used to register the control interface as an event monitor.
 */
int wpa_ctrl_recv(struct wpa_ctrl *ctrl, char *reply, size_t *reply_len);


/**
 * wpa_ctrl_pending - Check whether there are pending event messages
 * @ctrl: Control interface data from wpa_ctrl_open()
 * Returns: 1 if there are pending messages, 0 if no, or -1 on error
 *
 * This function will check whether there are any pending control interface
 * message available to be received with wpa_ctrl_recv(). wpa_ctrl_pending() is
 * only used for event messages, i.e., wpa_ctrl_attach() must have been used to
 * register the control interface as an event monitor.
 */
int wpa_ctrl_pending(struct wpa_ctrl *ctrl);


/**
 * wpa_ctrl_get_fd - Get file descriptor used by the control interface
 * @ctrl: Control interface data from wpa_ctrl_open()
 * Returns: File descriptor used for the connection
 *
 * This function can be used to get the file descriptor that is used for the
 * control interface connection. The returned value can be used, e.g., with
 * select() while waiting for multiple events.
 *
 * The returned file descriptor must not be used directly for sending or
 * receiving packets; instead, the library functions wpa_ctrl_request() and
 * wpa_ctrl_recv() must be used for this.
 */
int wpa_ctrl_get_fd(struct wpa_ctrl *ctrl);

#ifdef CONFIG_CTRL_IFACE_UDP
#define WPA_CTRL_IFACE_PORT 9877
#define WPA_GLOBAL_CTRL_IFACE_PORT 9878
#endif /* CONFIG_CTRL_IFACE_UDP */


#ifdef  __cplusplus
}
#endif

#endif /* WPA_CTRL_H */
Commit	Line	Data
6fc6879b JM	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 "
7796f20e JM	43	/** EAP method proposed by the server */
7796f20e JM	44	#define WPA_EVENT_EAP_PROPOSED_METHOD "CTRL-EVENT-EAP-PROPOSED-METHOD "
6fc6879b JM	45	/** EAP method selected */
6fc6879b JM	46	#define WPA_EVENT_EAP_METHOD "CTRL-EVENT-EAP-METHOD "
00468b46 JM	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 "
6fc6879b JM	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 "
b590812e	57	/** A new BSS entry was added (followed by BSS entry id and BSSID) */
f0d126d3	58	#define WPA_EVENT_BSS_ADDED "CTRL-EVENT-BSS-ADDED "
b590812e	59	/** A BSS entry was removed (followed by BSS entry id and BSSID) */
f0d126d3	60	#define WPA_EVENT_BSS_REMOVED "CTRL-EVENT-BSS-REMOVED "
6fc6879b	61
a524f05e	62	/** WPS overlap detected in PBC mode */
ad08c363	63	#define WPS_EVENT_OVERLAP "WPS-OVERLAP-DETECTED "
a524f05e JM	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 "
ff8a53a8 JM	71	/** A new credential received */
ff8a53a8 JM	72	#define WPS_EVENT_CRED_RECEIVED "WPS-CRED-RECEIVED "
4b68290e JM	73	/** M2D received */
4b68290e JM	74	#define WPS_EVENT_M2D "WPS-M2D "
469fc3a4 JM	75	/** WPS registration failed after M2/M2D */
469fc3a4 JM	76	#define WPS_EVENT_FAIL "WPS-FAIL "
ad5302a1 JM	77	/** WPS registration completed successfully */
ad5302a1 JM	78	#define WPS_EVENT_SUCCESS "WPS-SUCCESS "
a6099152 JM	79	/** WPS enrollment attempt timed out and was terminated */
a6099152 JM	80	#define WPS_EVENT_TIMEOUT "WPS-TIMEOUT "
ad08c363	81
c2f51269 JM	82	#define WPS_EVENT_ENROLLEE_SEEN "WPS-ENROLLEE-SEEN "
c2f51269 JM	83
b78bc3a3 JM	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 "
15dbf129	89	#define WPS_EVENT_ER_AP_SETTINGS "WPS-ER-AP-SETTINGS "
b78bc3a3	90
ad08c363 JM	91	/* hostapd control interface - fixed message prefixes */
	92	#define WPS_EVENT_PIN_NEEDED "WPS-PIN-NEEDED "
	93	#define WPS_EVENT_NEW_AP_SETTINGS "WPS-NEW-AP-SETTINGS "
aabe26a1	94	#define WPS_EVENT_REG_SUCCESS "WPS-REG-SUCCESS "
3b2cf800	95	#define WPS_EVENT_AP_SETUP_LOCKED "WPS-AP-SETUP-LOCKED "
94481410	96	#define WPS_EVENT_AP_SETUP_UNLOCKED "WPS-AP-SETUP-UNLOCKED "
5a1cc30f JM	97	#define WPS_EVENT_AP_PIN_ENABLED "WPS-AP-PIN-ENABLED "
5a1cc30f JM	98	#define WPS_EVENT_AP_PIN_DISABLED "WPS-AP-PIN-DISABLED "
20bd9547 JM	99	#define AP_STA_CONNECTED "AP-STA-CONNECTED "
20bd9547 JM	100	#define AP_STA_DISCONNECTED "AP-STA-DISCONNECTED "
ad08c363	101
6fc6879b JM	102
	103	/* wpa_supplicant/hostapd control interface access */
	104
	105	/**
	106	* wpa_ctrl_open - Open a control interface to wpa_supplicant/hostapd
	107	* @ctrl_path: Path for UNIX domain sockets; ignored if UDP sockets are used.
	108	* Returns: Pointer to abstract control interface data or %NULL on failure
	109	*
	110	* This function is used to open a control interface to wpa_supplicant/hostapd.
	111	* ctrl_path is usually /var/run/wpa_supplicant or /var/run/hostapd. This path
	112	* is configured in wpa_supplicant/hostapd and other programs using the control
	113	* interface need to use matching path configuration.
	114	*/
	115	struct wpa_ctrl * wpa_ctrl_open(const char *ctrl_path);
	116
	117
	118	/**
	119	* wpa_ctrl_close - Close a control interface to wpa_supplicant/hostapd
	120	* @ctrl: Control interface data from wpa_ctrl_open()
	121	*
	122	* This function is used to close a control interface.
	123	*/
	124	void wpa_ctrl_close(struct wpa_ctrl *ctrl);
	125
	126
	127	/**
	128	* wpa_ctrl_request - Send a command to wpa_supplicant/hostapd
	129	* @ctrl: Control interface data from wpa_ctrl_open()
	130	* @cmd: Command; usually, ASCII text, e.g., "PING"
	131	* @cmd_len: Length of the cmd in bytes
	132	* @reply: Buffer for the response
	133	* @reply_len: Reply buffer length
	134	* @msg_cb: Callback function for unsolicited messages or %NULL if not used
	135	* Returns: 0 on success, -1 on error (send or receive failed), -2 on timeout
	136	*
	137	* This function is used to send commands to wpa_supplicant/hostapd. Received
	138	* response will be written to reply and reply_len is set to the actual length
	139	* of the reply. This function will block for up to two seconds while waiting
	140	* for the reply. If unsolicited messages are received, the blocking time may
	141	* be longer.
	142	*
	143	* msg_cb can be used to register a callback function that will be called for
	144	* unsolicited messages received while waiting for the command response. These
	145	* messages may be received if wpa_ctrl_request() is called at the same time as
	146	* wpa_supplicant/hostapd is sending such a message. This can happen only if
	147	* the program has used wpa_ctrl_attach() to register itself as a monitor for
	148	* event messages. Alternatively to msg_cb, programs can register two control
	149	* interface connections and use one of them for commands and the other one for
	150	* receiving event messages, in other words, call wpa_ctrl_attach() only for
	151	* the control interface connection that will be used for event messages.
	152	*/
	153	int wpa_ctrl_request(struct wpa_ctrl ctrl, const char cmd, size_t cmd_len,
	154	char reply, size_t reply_len,
	155	void (msg_cb)(char msg, size_t len));
	156
	157
	158	/**
	159	* wpa_ctrl_attach - Register as an event monitor for the control interface
	160	* @ctrl: Control interface data from wpa_ctrl_open()
	161	* Returns: 0 on success, -1 on failure, -2 on timeout
	162	*
	163	* This function registers the control interface connection as a monitor for
	164	* wpa_supplicant/hostapd events. After a success wpa_ctrl_attach() call, the
	165	* control interface connection starts receiving event messages that can be
166	* read with wpa_ctrl_recv().
167	*/
168	int wpa_ctrl_attach(struct wpa_ctrl *ctrl);
169
170
171	/**
172	* wpa_ctrl_detach - Unregister event monitor from the control interface
173	* @ctrl: Control interface data from wpa_ctrl_open()
174	* Returns: 0 on success, -1 on failure, -2 on timeout
175	*
176	* This function unregisters the control interface connection as a monitor for
177	* wpa_supplicant/hostapd events, i.e., cancels the registration done with
178	* wpa_ctrl_attach().
179	*/
180	int wpa_ctrl_detach(struct wpa_ctrl *ctrl);
181
182
183	/**
184	* wpa_ctrl_recv - Receive a pending control interface message
185	* @ctrl: Control interface data from wpa_ctrl_open()
186	* @reply: Buffer for the message data
187	* @reply_len: Length of the reply buffer
188	* Returns: 0 on success, -1 on failure
189	*
190	* This function will receive a pending control interface message. This
191	* function will block if no messages are available. The received response will
192	* be written to reply and reply_len is set to the actual length of the reply.
193	* wpa_ctrl_recv() is only used for event messages, i.e., wpa_ctrl_attach()
194	* must have been used to register the control interface as an event monitor.
195	*/
196	int wpa_ctrl_recv(struct wpa_ctrl ctrl, char reply, size_t *reply_len);
197
198
199	/**
200	* wpa_ctrl_pending - Check whether there are pending event messages
201	* @ctrl: Control interface data from wpa_ctrl_open()
202	* Returns: 1 if there are pending messages, 0 if no, or -1 on error
203	*
204	* This function will check whether there are any pending control interface
205	* message available to be received with wpa_ctrl_recv(). wpa_ctrl_pending() is
206	* only used for event messages, i.e., wpa_ctrl_attach() must have been used to
207	* register the control interface as an event monitor.
208	*/
209	int wpa_ctrl_pending(struct wpa_ctrl *ctrl);
210
211
212	/**
213	* wpa_ctrl_get_fd - Get file descriptor used by the control interface
214	* @ctrl: Control interface data from wpa_ctrl_open()
215	* Returns: File descriptor used for the connection
216	*
217	* This function can be used to get the file descriptor that is used for the
218	* control interface connection. The returned value can be used, e.g., with
219	* select() while waiting for multiple events.
220	*
221	* The returned file descriptor must not be used directly for sending or
222	* receiving packets; instead, the library functions wpa_ctrl_request() and
223	* wpa_ctrl_recv() must be used for this.
224	*/
225	int wpa_ctrl_get_fd(struct wpa_ctrl *ctrl);
226
227	#ifdef CONFIG_CTRL_IFACE_UDP
228	#define WPA_CTRL_IFACE_PORT 9877
229	#define WPA_GLOBAL_CTRL_IFACE_PORT 9878
230	#endif /* CONFIG_CTRL_IFACE_UDP */
231
232
233	#ifdef __cplusplus
234	}
235	#endif
236
237	#endif /* WPA_CTRL_H */