2 * wpa_supplicant/hostapd control interface library
3 * Copyright (c) 2004-2007, Jouni Malinen <j@w1.fi>
5 * This software may be distributed under the terms of the BSD license.
6 * See README for more details.
11 #ifdef CONFIG_CTRL_IFACE
13 #ifdef CONFIG_CTRL_IFACE_UNIX
17 #endif /* CONFIG_CTRL_IFACE_UNIX */
18 #ifdef CONFIG_CTRL_IFACE_UDP_REMOTE
20 #endif /* CONFIG_CTRL_IFACE_UDP_REMOTE */
24 #include <cutils/sockets.h>
25 #include "private/android_filesystem_config.h"
32 #if defined(CONFIG_CTRL_IFACE_UNIX) || defined(CONFIG_CTRL_IFACE_UDP)
33 #define CTRL_IFACE_SOCKET
34 #endif /* CONFIG_CTRL_IFACE_UNIX || CONFIG_CTRL_IFACE_UDP */
38 * struct wpa_ctrl - Internal structure for control interface library
40 * This structure is used by the wpa_supplicant/hostapd control interface
41 * library to store internal data. Programs using the library should not touch
42 * this data directly. They can only use the pointer to the data structure as
43 * an identifier for the control interface connection and use this as one of
44 * the arguments for most of the control interface library functions.
47 #ifdef CONFIG_CTRL_IFACE_UDP
49 struct sockaddr_in local;
50 struct sockaddr_in dest;
54 #endif /* CONFIG_CTRL_IFACE_UDP */
55 #ifdef CONFIG_CTRL_IFACE_UNIX
57 struct sockaddr_un local;
58 struct sockaddr_un dest;
59 #endif /* CONFIG_CTRL_IFACE_UNIX */
60 #ifdef CONFIG_CTRL_IFACE_NAMED_PIPE
62 #endif /* CONFIG_CTRL_IFACE_NAMED_PIPE */
66 #ifdef CONFIG_CTRL_IFACE_UNIX
68 #ifndef CONFIG_CTRL_IFACE_CLIENT_DIR
69 #define CONFIG_CTRL_IFACE_CLIENT_DIR "/tmp"
70 #endif /* CONFIG_CTRL_IFACE_CLIENT_DIR */
71 #ifndef CONFIG_CTRL_IFACE_CLIENT_PREFIX
72 #define CONFIG_CTRL_IFACE_CLIENT_PREFIX "wpa_ctrl_"
73 #endif /* CONFIG_CTRL_IFACE_CLIENT_PREFIX */
76 struct wpa_ctrl * wpa_ctrl_open(const char *ctrl_path)
78 struct wpa_ctrl *ctrl;
79 static int counter = 0;
85 ctrl = os_malloc(sizeof(*ctrl));
88 os_memset(ctrl, 0, sizeof(*ctrl));
90 ctrl->s = socket(PF_UNIX, SOCK_DGRAM, 0);
96 ctrl->local.sun_family = AF_UNIX;
99 ret = os_snprintf(ctrl->local.sun_path, sizeof(ctrl->local.sun_path),
100 CONFIG_CTRL_IFACE_CLIENT_DIR "/"
101 CONFIG_CTRL_IFACE_CLIENT_PREFIX "%d-%d",
102 (int) getpid(), counter);
103 if (ret < 0 || (size_t) ret >= sizeof(ctrl->local.sun_path)) {
109 if (bind(ctrl->s, (struct sockaddr *) &ctrl->local,
110 sizeof(ctrl->local)) < 0) {
111 if (errno == EADDRINUSE && tries < 2) {
113 * getpid() returns unique identifier for this instance
114 * of wpa_ctrl, so the existing socket file must have
115 * been left by unclean termination of an earlier run.
116 * Remove the file and try again.
118 unlink(ctrl->local.sun_path);
127 chmod(ctrl->local.sun_path, S_IRUSR | S_IWUSR | S_IRGRP | S_IWGRP);
128 chown(ctrl->local.sun_path, AID_SYSTEM, AID_WIFI);
130 * If the ctrl_path isn't an absolute pathname, assume that
131 * it's the name of a socket in the Android reserved namespace.
132 * Otherwise, it's a normal UNIX domain socket appearing in the
135 if (ctrl_path != NULL && *ctrl_path != '/') {
137 os_snprintf(buf, sizeof(buf), "wpa_%s", ctrl_path);
138 if (socket_local_client_connect(
140 ANDROID_SOCKET_NAMESPACE_RESERVED,
143 unlink(ctrl->local.sun_path);
151 ctrl->dest.sun_family = AF_UNIX;
152 res = os_strlcpy(ctrl->dest.sun_path, ctrl_path,
153 sizeof(ctrl->dest.sun_path));
154 if (res >= sizeof(ctrl->dest.sun_path)) {
159 if (connect(ctrl->s, (struct sockaddr *) &ctrl->dest,
160 sizeof(ctrl->dest)) < 0) {
162 unlink(ctrl->local.sun_path);
168 * Make socket non-blocking so that we don't hang forever if
169 * target dies unexpectedly.
171 flags = fcntl(ctrl->s, F_GETFL);
174 if (fcntl(ctrl->s, F_SETFL, flags) < 0) {
175 perror("fcntl(ctrl->s, O_NONBLOCK)");
176 /* Not fatal, continue on.*/
184 void wpa_ctrl_close(struct wpa_ctrl *ctrl)
188 unlink(ctrl->local.sun_path);
197 * wpa_ctrl_cleanup() - Delete any local UNIX domain socket files that
198 * may be left over from clients that were previously connected to
199 * wpa_supplicant. This keeps these files from being orphaned in the
200 * event of crashes that prevented them from being removed as part
201 * of the normal orderly shutdown.
203 void wpa_ctrl_cleanup(void)
207 struct dirent *result;
209 int prefixlen = os_strlen(CONFIG_CTRL_IFACE_CLIENT_PREFIX);
211 char pathname[PATH_MAX];
214 if ((dir = opendir(CONFIG_CTRL_IFACE_CLIENT_DIR)) == NULL)
217 dirnamelen = (size_t) os_snprintf(pathname, sizeof(pathname), "%s/",
218 CONFIG_CTRL_IFACE_CLIENT_DIR);
219 if (dirnamelen >= sizeof(pathname)) {
223 namep = pathname + dirnamelen;
224 maxcopy = PATH_MAX - dirnamelen;
225 while (readdir_r(dir, &entry, &result) == 0 && result != NULL) {
226 if (os_strncmp(entry.d_name, CONFIG_CTRL_IFACE_CLIENT_PREFIX,
228 if (os_strlcpy(namep, entry.d_name, maxcopy) < maxcopy)
236 #else /* CONFIG_CTRL_IFACE_UNIX */
239 void wpa_ctrl_cleanup(void)
244 #endif /* CONFIG_CTRL_IFACE_UNIX */
247 #ifdef CONFIG_CTRL_IFACE_UDP
249 struct wpa_ctrl * wpa_ctrl_open(const char *ctrl_path)
251 struct wpa_ctrl *ctrl;
254 #ifdef CONFIG_CTRL_IFACE_UDP_REMOTE
256 #endif /* CONFIG_CTRL_IFACE_UDP_REMOTE */
258 ctrl = os_malloc(sizeof(*ctrl));
261 os_memset(ctrl, 0, sizeof(*ctrl));
263 ctrl->s = socket(PF_INET, SOCK_DGRAM, 0);
270 ctrl->local.sin_family = AF_INET;
271 #ifdef CONFIG_CTRL_IFACE_UDP_REMOTE
272 ctrl->local.sin_addr.s_addr = INADDR_ANY;
273 #else /* CONFIG_CTRL_IFACE_UDP_REMOTE */
274 ctrl->local.sin_addr.s_addr = htonl((127 << 24) | 1);
275 #endif /* CONFIG_CTRL_IFACE_UDP_REMOTE */
276 if (bind(ctrl->s, (struct sockaddr *) &ctrl->local,
277 sizeof(ctrl->local)) < 0) {
283 ctrl->dest.sin_family = AF_INET;
284 ctrl->dest.sin_addr.s_addr = htonl((127 << 24) | 1);
285 ctrl->dest.sin_port = htons(WPA_CTRL_IFACE_PORT);
287 #ifdef CONFIG_CTRL_IFACE_UDP_REMOTE
292 name = os_strdup(ctrl_path);
298 port = os_strchr(name, ':');
301 port_id = atoi(&port[1]);
304 port_id = WPA_CTRL_IFACE_PORT;
306 h = gethostbyname(name);
307 ctrl->remote_ip = os_strdup(name);
310 perror("gethostbyname");
312 os_free(ctrl->remote_ip);
316 ctrl->dest.sin_port = htons(port_id);
317 os_memcpy(h->h_addr, (char *) &ctrl->dest.sin_addr.s_addr,
320 ctrl->remote_ip = os_strdup("localhost");
321 #endif /* CONFIG_CTRL_IFACE_UDP_REMOTE */
323 if (connect(ctrl->s, (struct sockaddr *) &ctrl->dest,
324 sizeof(ctrl->dest)) < 0) {
327 os_free(ctrl->remote_ip);
332 len = sizeof(buf) - 1;
333 if (wpa_ctrl_request(ctrl, "GET_COOKIE", 10, buf, &len, NULL) == 0) {
335 ctrl->cookie = os_strdup(buf);
338 if (wpa_ctrl_request(ctrl, "IFNAME", 6, buf, &len, NULL) == 0) {
340 ctrl->remote_ifname = os_strdup(buf);
347 char * wpa_ctrl_get_remote_ifname(struct wpa_ctrl *ctrl)
349 #define WPA_CTRL_MAX_PS_NAME 100
350 static char ps[WPA_CTRL_MAX_PS_NAME] = {};
351 os_snprintf(ps, WPA_CTRL_MAX_PS_NAME, "%s/%s",
352 ctrl->remote_ip, ctrl->remote_ifname);
357 void wpa_ctrl_close(struct wpa_ctrl *ctrl)
360 os_free(ctrl->cookie);
361 os_free(ctrl->remote_ifname);
362 os_free(ctrl->remote_ip);
366 #endif /* CONFIG_CTRL_IFACE_UDP */
369 #ifdef CTRL_IFACE_SOCKET
370 int wpa_ctrl_request(struct wpa_ctrl *ctrl, const char *cmd, size_t cmd_len,
371 char *reply, size_t *reply_len,
372 void (*msg_cb)(char *msg, size_t len))
375 struct os_time started_at;
379 char *cmd_buf = NULL;
382 #ifdef CONFIG_CTRL_IFACE_UDP
385 _cmd_len = os_strlen(ctrl->cookie) + 1 + cmd_len;
386 cmd_buf = os_malloc(_cmd_len);
391 os_strlcpy(pos, ctrl->cookie, _cmd_len);
392 pos += os_strlen(ctrl->cookie);
394 os_memcpy(pos, cmd, cmd_len);
396 #endif /* CONFIG_CTRL_IFACE_UDP */
406 if (send(ctrl->s, _cmd, _cmd_len, 0) < 0) {
407 if (errno == EAGAIN || errno == EBUSY || errno == EWOULDBLOCK)
410 * Must be a non-blocking socket... Try for a bit
411 * longer before giving up.
413 if (started_at.sec == 0)
414 os_get_time(&started_at);
418 /* Try for a few seconds. */
419 if (n.sec > started_at.sec + 5)
435 FD_SET(ctrl->s, &rfds);
436 res = select(ctrl->s + 1, &rfds, NULL, NULL, &tv);
439 if (FD_ISSET(ctrl->s, &rfds)) {
440 res = recv(ctrl->s, reply, *reply_len, 0);
443 if (res > 0 && reply[0] == '<') {
444 /* This is an unsolicited message from
445 * wpa_supplicant, not the reply to the
446 * request. Use msg_cb to report this to the
449 /* Make sure the message is nul
451 if ((size_t) res == *reply_len)
452 res = (*reply_len) - 1;
466 #endif /* CTRL_IFACE_SOCKET */
469 static int wpa_ctrl_attach_helper(struct wpa_ctrl *ctrl, int attach)
475 ret = wpa_ctrl_request(ctrl, attach ? "ATTACH" : "DETACH", 6,
479 if (len == 3 && os_memcmp(buf, "OK\n", 3) == 0)
485 int wpa_ctrl_attach(struct wpa_ctrl *ctrl)
487 return wpa_ctrl_attach_helper(ctrl, 1);
491 int wpa_ctrl_detach(struct wpa_ctrl *ctrl)
493 return wpa_ctrl_attach_helper(ctrl, 0);
497 #ifdef CTRL_IFACE_SOCKET
499 int wpa_ctrl_recv(struct wpa_ctrl *ctrl, char *reply, size_t *reply_len)
503 res = recv(ctrl->s, reply, *reply_len, 0);
511 int wpa_ctrl_pending(struct wpa_ctrl *ctrl)
518 FD_SET(ctrl->s, &rfds);
519 select(ctrl->s + 1, &rfds, NULL, NULL, &tv);
520 return FD_ISSET(ctrl->s, &rfds);
524 int wpa_ctrl_get_fd(struct wpa_ctrl *ctrl)
529 #endif /* CTRL_IFACE_SOCKET */
532 #ifdef CONFIG_CTRL_IFACE_NAMED_PIPE
534 #ifndef WPA_SUPPLICANT_NAMED_PIPE
535 #define WPA_SUPPLICANT_NAMED_PIPE "WpaSupplicant"
537 #define NAMED_PIPE_PREFIX TEXT("\\\\.\\pipe\\") TEXT(WPA_SUPPLICANT_NAMED_PIPE)
539 struct wpa_ctrl * wpa_ctrl_open(const char *ctrl_path)
541 struct wpa_ctrl *ctrl;
546 ctrl = os_malloc(sizeof(*ctrl));
549 os_memset(ctrl, 0, sizeof(*ctrl));
552 if (ctrl_path == NULL)
553 ret = _snwprintf(name, 256, NAMED_PIPE_PREFIX);
555 ret = _snwprintf(name, 256, NAMED_PIPE_PREFIX TEXT("-%S"),
558 if (ctrl_path == NULL)
559 ret = os_snprintf(name, 256, NAMED_PIPE_PREFIX);
561 ret = os_snprintf(name, 256, NAMED_PIPE_PREFIX "-%s",
564 if (ret < 0 || ret >= 256) {
569 for (i = 0; i < 10; i++) {
570 ctrl->pipe = CreateFile(name, GENERIC_READ | GENERIC_WRITE, 0,
571 NULL, OPEN_EXISTING, 0, NULL);
573 * Current named pipe server side in wpa_supplicant is
574 * re-opening the pipe for new clients only after the previous
575 * one is taken into use. This leaves a small window for race
576 * conditions when two connections are being opened at almost
577 * the same time. Retry if that was the case.
579 if (ctrl->pipe != INVALID_HANDLE_VALUE ||
580 GetLastError() != ERROR_PIPE_BUSY)
582 WaitNamedPipe(name, 1000);
584 if (ctrl->pipe == INVALID_HANDLE_VALUE) {
589 mode = PIPE_READMODE_MESSAGE;
590 if (!SetNamedPipeHandleState(ctrl->pipe, &mode, NULL, NULL)) {
591 CloseHandle(ctrl->pipe);
600 void wpa_ctrl_close(struct wpa_ctrl *ctrl)
602 CloseHandle(ctrl->pipe);
607 int wpa_ctrl_request(struct wpa_ctrl *ctrl, const char *cmd, size_t cmd_len,
608 char *reply, size_t *reply_len,
609 void (*msg_cb)(char *msg, size_t len))
612 DWORD readlen = *reply_len;
614 if (!WriteFile(ctrl->pipe, cmd, cmd_len, &written, NULL))
617 if (!ReadFile(ctrl->pipe, reply, *reply_len, &readlen, NULL))
619 *reply_len = readlen;
625 int wpa_ctrl_recv(struct wpa_ctrl *ctrl, char *reply, size_t *reply_len)
627 DWORD len = *reply_len;
628 if (!ReadFile(ctrl->pipe, reply, *reply_len, &len, NULL))
635 int wpa_ctrl_pending(struct wpa_ctrl *ctrl)
639 if (!PeekNamedPipe(ctrl->pipe, NULL, 0, NULL, &left, NULL))
645 int wpa_ctrl_get_fd(struct wpa_ctrl *ctrl)
650 #endif /* CONFIG_CTRL_IFACE_NAMED_PIPE */
652 #endif /* CONFIG_CTRL_IFACE */