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 */
25 #include <cutils/sockets.h>
26 #include "private/android_filesystem_config.h"
29 #ifdef CONFIG_CTRL_IFACE_UDP_IPV6
31 #endif /* CONFIG_CTRL_IFACE_UDP_IPV6 */
37 #if defined(CONFIG_CTRL_IFACE_UNIX) || defined(CONFIG_CTRL_IFACE_UDP)
38 #define CTRL_IFACE_SOCKET
39 #endif /* CONFIG_CTRL_IFACE_UNIX || CONFIG_CTRL_IFACE_UDP */
43 * struct wpa_ctrl - Internal structure for control interface library
45 * This structure is used by the wpa_supplicant/hostapd control interface
46 * library to store internal data. Programs using the library should not touch
47 * this data directly. They can only use the pointer to the data structure as
48 * an identifier for the control interface connection and use this as one of
49 * the arguments for most of the control interface library functions.
52 #ifdef CONFIG_CTRL_IFACE_UDP
54 #ifdef CONFIG_CTRL_IFACE_UDP_IPV6
55 struct sockaddr_in6 local;
56 struct sockaddr_in6 dest;
57 #else /* CONFIG_CTRL_IFACE_UDP_IPV6 */
58 struct sockaddr_in local;
59 struct sockaddr_in dest;
60 #endif /* CONFIG_CTRL_IFACE_UDP_IPV6 */
64 #endif /* CONFIG_CTRL_IFACE_UDP */
65 #ifdef CONFIG_CTRL_IFACE_UNIX
67 struct sockaddr_un local;
68 struct sockaddr_un dest;
69 #endif /* CONFIG_CTRL_IFACE_UNIX */
70 #ifdef CONFIG_CTRL_IFACE_NAMED_PIPE
72 #endif /* CONFIG_CTRL_IFACE_NAMED_PIPE */
76 #ifdef CONFIG_CTRL_IFACE_UNIX
78 #ifndef CONFIG_CTRL_IFACE_CLIENT_DIR
79 #define CONFIG_CTRL_IFACE_CLIENT_DIR "/tmp"
80 #endif /* CONFIG_CTRL_IFACE_CLIENT_DIR */
81 #ifndef CONFIG_CTRL_IFACE_CLIENT_PREFIX
82 #define CONFIG_CTRL_IFACE_CLIENT_PREFIX "wpa_ctrl_"
83 #endif /* CONFIG_CTRL_IFACE_CLIENT_PREFIX */
86 struct wpa_ctrl * wpa_ctrl_open(const char *ctrl_path)
88 return wpa_ctrl_open2(ctrl_path, NULL);
92 struct wpa_ctrl * wpa_ctrl_open2(const char *ctrl_path,
95 struct wpa_ctrl *ctrl;
96 static int counter = 0;
102 if (ctrl_path == NULL)
105 ctrl = os_zalloc(sizeof(*ctrl));
109 ctrl->s = socket(PF_UNIX, SOCK_DGRAM, 0);
115 ctrl->local.sun_family = AF_UNIX;
118 if (cli_path && cli_path[0] == '/') {
119 ret = os_snprintf(ctrl->local.sun_path,
120 sizeof(ctrl->local.sun_path),
121 "%s/" CONFIG_CTRL_IFACE_CLIENT_PREFIX "%d-%d",
122 cli_path, (int) getpid(), counter);
124 ret = os_snprintf(ctrl->local.sun_path,
125 sizeof(ctrl->local.sun_path),
126 CONFIG_CTRL_IFACE_CLIENT_DIR "/"
127 CONFIG_CTRL_IFACE_CLIENT_PREFIX "%d-%d",
128 (int) getpid(), counter);
130 if (os_snprintf_error(sizeof(ctrl->local.sun_path), ret)) {
136 if (bind(ctrl->s, (struct sockaddr *) &ctrl->local,
137 sizeof(ctrl->local)) < 0) {
138 if (errno == EADDRINUSE && tries < 2) {
140 * getpid() returns unique identifier for this instance
141 * of wpa_ctrl, so the existing socket file must have
142 * been left by unclean termination of an earlier run.
143 * Remove the file and try again.
145 unlink(ctrl->local.sun_path);
154 chmod(ctrl->local.sun_path, S_IRUSR | S_IWUSR | S_IRGRP | S_IWGRP);
155 /* Set group even if we do not have privileges to change owner */
156 chown(ctrl->local.sun_path, -1, AID_WIFI);
157 chown(ctrl->local.sun_path, AID_SYSTEM, AID_WIFI);
159 if (os_strncmp(ctrl_path, "@android:", 9) == 0) {
160 if (socket_local_client_connect(
161 ctrl->s, ctrl_path + 9,
162 ANDROID_SOCKET_NAMESPACE_RESERVED,
165 unlink(ctrl->local.sun_path);
173 * If the ctrl_path isn't an absolute pathname, assume that
174 * it's the name of a socket in the Android reserved namespace.
175 * Otherwise, it's a normal UNIX domain socket appearing in the
178 if (*ctrl_path != '/') {
180 os_snprintf(buf, sizeof(buf), "wpa_%s", ctrl_path);
181 if (socket_local_client_connect(
183 ANDROID_SOCKET_NAMESPACE_RESERVED,
186 unlink(ctrl->local.sun_path);
194 ctrl->dest.sun_family = AF_UNIX;
195 if (os_strncmp(ctrl_path, "@abstract:", 10) == 0) {
196 ctrl->dest.sun_path[0] = '\0';
197 os_strlcpy(ctrl->dest.sun_path + 1, ctrl_path + 10,
198 sizeof(ctrl->dest.sun_path) - 1);
200 res = os_strlcpy(ctrl->dest.sun_path, ctrl_path,
201 sizeof(ctrl->dest.sun_path));
202 if (res >= sizeof(ctrl->dest.sun_path)) {
208 if (connect(ctrl->s, (struct sockaddr *) &ctrl->dest,
209 sizeof(ctrl->dest)) < 0) {
211 unlink(ctrl->local.sun_path);
217 * Make socket non-blocking so that we don't hang forever if
218 * target dies unexpectedly.
220 flags = fcntl(ctrl->s, F_GETFL);
223 if (fcntl(ctrl->s, F_SETFL, flags) < 0) {
224 perror("fcntl(ctrl->s, O_NONBLOCK)");
225 /* Not fatal, continue on.*/
233 void wpa_ctrl_close(struct wpa_ctrl *ctrl)
237 unlink(ctrl->local.sun_path);
246 * wpa_ctrl_cleanup() - Delete any local UNIX domain socket files that
247 * may be left over from clients that were previously connected to
248 * wpa_supplicant. This keeps these files from being orphaned in the
249 * event of crashes that prevented them from being removed as part
250 * of the normal orderly shutdown.
252 void wpa_ctrl_cleanup(void)
256 struct dirent *result;
259 char pathname[PATH_MAX];
262 if ((dir = opendir(CONFIG_CTRL_IFACE_CLIENT_DIR)) == NULL)
265 dirnamelen = (size_t) os_snprintf(pathname, sizeof(pathname), "%s/",
266 CONFIG_CTRL_IFACE_CLIENT_DIR);
267 if (dirnamelen >= sizeof(pathname)) {
271 namep = pathname + dirnamelen;
272 maxcopy = PATH_MAX - dirnamelen;
273 while (readdir_r(dir, &entry, &result) == 0 && result != NULL) {
274 if (os_strlcpy(namep, entry.d_name, maxcopy) < maxcopy)
281 #else /* CONFIG_CTRL_IFACE_UNIX */
284 void wpa_ctrl_cleanup(void)
289 #endif /* CONFIG_CTRL_IFACE_UNIX */
292 #ifdef CONFIG_CTRL_IFACE_UDP
294 struct wpa_ctrl * wpa_ctrl_open(const char *ctrl_path)
296 struct wpa_ctrl *ctrl;
299 #ifdef CONFIG_CTRL_IFACE_UDP_REMOTE
301 #endif /* CONFIG_CTRL_IFACE_UDP_REMOTE */
303 ctrl = os_zalloc(sizeof(*ctrl));
307 #ifdef CONFIG_CTRL_IFACE_UDP_IPV6
308 ctrl->s = socket(PF_INET6, SOCK_DGRAM, 0);
309 #else /* CONFIG_CTRL_IFACE_UDP_IPV6 */
310 ctrl->s = socket(PF_INET, SOCK_DGRAM, 0);
311 #endif /* CONFIG_CTRL_IFACE_UDP_IPV6 */
318 #ifdef CONFIG_CTRL_IFACE_UDP_IPV6
319 ctrl->local.sin6_family = AF_INET6;
320 #ifdef CONFIG_CTRL_IFACE_UDP_REMOTE
321 ctrl->local.sin6_addr = in6addr_any;
322 #else /* CONFIG_CTRL_IFACE_UDP_REMOTE */
323 inet_pton(AF_INET6, "::1", &ctrl->local.sin6_addr);
324 #endif /* CONFIG_CTRL_IFACE_UDP_REMOTE */
325 #else /* CONFIG_CTRL_IFACE_UDP_IPV6 */
326 ctrl->local.sin_family = AF_INET;
327 #ifdef CONFIG_CTRL_IFACE_UDP_REMOTE
328 ctrl->local.sin_addr.s_addr = INADDR_ANY;
329 #else /* CONFIG_CTRL_IFACE_UDP_REMOTE */
330 ctrl->local.sin_addr.s_addr = htonl((127 << 24) | 1);
331 #endif /* CONFIG_CTRL_IFACE_UDP_REMOTE */
332 #endif /* CONFIG_CTRL_IFACE_UDP_IPV6 */
334 if (bind(ctrl->s, (struct sockaddr *) &ctrl->local,
335 sizeof(ctrl->local)) < 0) {
341 #ifdef CONFIG_CTRL_IFACE_UDP_IPV6
342 ctrl->dest.sin6_family = AF_INET6;
343 inet_pton(AF_INET6, "::1", &ctrl->dest.sin6_addr);
344 ctrl->dest.sin6_port = htons(WPA_CTRL_IFACE_PORT);
345 #else /* CONFIG_CTRL_IFACE_UDP_IPV6 */
346 ctrl->dest.sin_family = AF_INET;
347 ctrl->dest.sin_addr.s_addr = htonl((127 << 24) | 1);
348 ctrl->dest.sin_port = htons(WPA_CTRL_IFACE_PORT);
349 #endif /* CONFIG_CTRL_IFACE_UDP_IPV6 */
351 #ifdef CONFIG_CTRL_IFACE_UDP_REMOTE
355 #ifdef CONFIG_CTRL_IFACE_UDP_IPV6
358 #endif /* CONFIG_CTRL_IFACE_UDP_IPV6 */
360 name = os_strdup(ctrl_path);
366 #ifdef CONFIG_CTRL_IFACE_UDP_IPV6
367 port = os_strchr(name, ',');
368 #else /* CONFIG_CTRL_IFACE_UDP_IPV6 */
369 port = os_strchr(name, ':');
370 #endif /* CONFIG_CTRL_IFACE_UDP_IPV6 */
373 port_id = atoi(&port[1]);
376 port_id = WPA_CTRL_IFACE_PORT;
378 #ifdef CONFIG_CTRL_IFACE_UDP_IPV6
379 scope = os_strchr(name, '%');
381 scope_id = if_nametoindex(&scope[1]);
384 h = gethostbyname2(name, AF_INET6);
385 #else /* CONFIG_CTRL_IFACE_UDP_IPV6 */
386 h = gethostbyname(name);
387 #endif /* CONFIG_CTRL_IFACE_UDP_IPV6 */
388 ctrl->remote_ip = os_strdup(name);
391 perror("gethostbyname");
393 os_free(ctrl->remote_ip);
397 #ifdef CONFIG_CTRL_IFACE_UDP_IPV6
398 ctrl->dest.sin6_scope_id = scope_id;
399 ctrl->dest.sin6_port = htons(port_id);
400 os_memcpy(&ctrl->dest.sin6_addr, h->h_addr, h->h_length);
401 #else /* CONFIG_CTRL_IFACE_UDP_IPV6 */
402 ctrl->dest.sin_port = htons(port_id);
403 os_memcpy(&ctrl->dest.sin_addr.s_addr, h->h_addr, h->h_length);
404 #endif /* CONFIG_CTRL_IFACE_UDP_IPV6 */
406 ctrl->remote_ip = os_strdup("localhost");
407 #endif /* CONFIG_CTRL_IFACE_UDP_REMOTE */
409 if (connect(ctrl->s, (struct sockaddr *) &ctrl->dest,
410 sizeof(ctrl->dest)) < 0) {
411 #ifdef CONFIG_CTRL_IFACE_UDP_IPV6
412 char addr[INET6_ADDRSTRLEN];
413 wpa_printf(MSG_ERROR, "connect(%s:%d) failed: %s",
414 inet_ntop(AF_INET6, &ctrl->dest.sin6_addr, addr,
416 ntohs(ctrl->dest.sin6_port),
418 #else /* CONFIG_CTRL_IFACE_UDP_IPV6 */
419 wpa_printf(MSG_ERROR, "connect(%s:%d) failed: %s",
420 inet_ntoa(ctrl->dest.sin_addr),
421 ntohs(ctrl->dest.sin_port),
423 #endif /* CONFIG_CTRL_IFACE_UDP_IPV6 */
425 os_free(ctrl->remote_ip);
430 len = sizeof(buf) - 1;
431 if (wpa_ctrl_request(ctrl, "GET_COOKIE", 10, buf, &len, NULL) == 0) {
433 ctrl->cookie = os_strdup(buf);
436 if (wpa_ctrl_request(ctrl, "IFNAME", 6, buf, &len, NULL) == 0) {
438 ctrl->remote_ifname = os_strdup(buf);
445 char * wpa_ctrl_get_remote_ifname(struct wpa_ctrl *ctrl)
447 #define WPA_CTRL_MAX_PS_NAME 100
448 static char ps[WPA_CTRL_MAX_PS_NAME] = {};
449 os_snprintf(ps, WPA_CTRL_MAX_PS_NAME, "%s/%s",
450 ctrl->remote_ip, ctrl->remote_ifname);
455 void wpa_ctrl_close(struct wpa_ctrl *ctrl)
458 os_free(ctrl->cookie);
459 os_free(ctrl->remote_ifname);
460 os_free(ctrl->remote_ip);
464 #endif /* CONFIG_CTRL_IFACE_UDP */
467 #ifdef CTRL_IFACE_SOCKET
468 int wpa_ctrl_request(struct wpa_ctrl *ctrl, const char *cmd, size_t cmd_len,
469 char *reply, size_t *reply_len,
470 void (*msg_cb)(char *msg, size_t len))
473 struct os_reltime started_at;
477 char *cmd_buf = NULL;
480 #ifdef CONFIG_CTRL_IFACE_UDP
483 _cmd_len = os_strlen(ctrl->cookie) + 1 + cmd_len;
484 cmd_buf = os_malloc(_cmd_len);
489 os_strlcpy(pos, ctrl->cookie, _cmd_len);
490 pos += os_strlen(ctrl->cookie);
492 os_memcpy(pos, cmd, cmd_len);
494 #endif /* CONFIG_CTRL_IFACE_UDP */
504 if (send(ctrl->s, _cmd, _cmd_len, 0) < 0) {
505 if (errno == EAGAIN || errno == EBUSY || errno == EWOULDBLOCK)
508 * Must be a non-blocking socket... Try for a bit
509 * longer before giving up.
511 if (started_at.sec == 0)
512 os_get_reltime(&started_at);
516 /* Try for a few seconds. */
517 if (os_reltime_expired(&n, &started_at, 5))
533 FD_SET(ctrl->s, &rfds);
534 res = select(ctrl->s + 1, &rfds, NULL, NULL, &tv);
537 if (FD_ISSET(ctrl->s, &rfds)) {
538 res = recv(ctrl->s, reply, *reply_len, 0);
541 if (res > 0 && reply[0] == '<') {
542 /* This is an unsolicited message from
543 * wpa_supplicant, not the reply to the
544 * request. Use msg_cb to report this to the
547 /* Make sure the message is nul
549 if ((size_t) res == *reply_len)
550 res = (*reply_len) - 1;
564 #endif /* CTRL_IFACE_SOCKET */
567 static int wpa_ctrl_attach_helper(struct wpa_ctrl *ctrl, int attach)
573 ret = wpa_ctrl_request(ctrl, attach ? "ATTACH" : "DETACH", 6,
577 if (len == 3 && os_memcmp(buf, "OK\n", 3) == 0)
583 int wpa_ctrl_attach(struct wpa_ctrl *ctrl)
585 return wpa_ctrl_attach_helper(ctrl, 1);
589 int wpa_ctrl_detach(struct wpa_ctrl *ctrl)
591 return wpa_ctrl_attach_helper(ctrl, 0);
595 #ifdef CTRL_IFACE_SOCKET
597 int wpa_ctrl_recv(struct wpa_ctrl *ctrl, char *reply, size_t *reply_len)
601 res = recv(ctrl->s, reply, *reply_len, 0);
609 int wpa_ctrl_pending(struct wpa_ctrl *ctrl)
616 FD_SET(ctrl->s, &rfds);
617 select(ctrl->s + 1, &rfds, NULL, NULL, &tv);
618 return FD_ISSET(ctrl->s, &rfds);
622 int wpa_ctrl_get_fd(struct wpa_ctrl *ctrl)
627 #endif /* CTRL_IFACE_SOCKET */
630 #ifdef CONFIG_CTRL_IFACE_NAMED_PIPE
632 #ifndef WPA_SUPPLICANT_NAMED_PIPE
633 #define WPA_SUPPLICANT_NAMED_PIPE "WpaSupplicant"
635 #define NAMED_PIPE_PREFIX TEXT("\\\\.\\pipe\\") TEXT(WPA_SUPPLICANT_NAMED_PIPE)
637 struct wpa_ctrl * wpa_ctrl_open(const char *ctrl_path)
639 struct wpa_ctrl *ctrl;
644 ctrl = os_malloc(sizeof(*ctrl));
647 os_memset(ctrl, 0, sizeof(*ctrl));
650 if (ctrl_path == NULL)
651 ret = _snwprintf(name, 256, NAMED_PIPE_PREFIX);
653 ret = _snwprintf(name, 256, NAMED_PIPE_PREFIX TEXT("-%S"),
656 if (ctrl_path == NULL)
657 ret = os_snprintf(name, 256, NAMED_PIPE_PREFIX);
659 ret = os_snprintf(name, 256, NAMED_PIPE_PREFIX "-%s",
662 if (os_snprintf_error(256, ret)) {
667 for (i = 0; i < 10; i++) {
668 ctrl->pipe = CreateFile(name, GENERIC_READ | GENERIC_WRITE, 0,
669 NULL, OPEN_EXISTING, 0, NULL);
671 * Current named pipe server side in wpa_supplicant is
672 * re-opening the pipe for new clients only after the previous
673 * one is taken into use. This leaves a small window for race
674 * conditions when two connections are being opened at almost
675 * the same time. Retry if that was the case.
677 if (ctrl->pipe != INVALID_HANDLE_VALUE ||
678 GetLastError() != ERROR_PIPE_BUSY)
680 WaitNamedPipe(name, 1000);
682 if (ctrl->pipe == INVALID_HANDLE_VALUE) {
687 mode = PIPE_READMODE_MESSAGE;
688 if (!SetNamedPipeHandleState(ctrl->pipe, &mode, NULL, NULL)) {
689 CloseHandle(ctrl->pipe);
698 void wpa_ctrl_close(struct wpa_ctrl *ctrl)
700 CloseHandle(ctrl->pipe);
705 int wpa_ctrl_request(struct wpa_ctrl *ctrl, const char *cmd, size_t cmd_len,
706 char *reply, size_t *reply_len,
707 void (*msg_cb)(char *msg, size_t len))
710 DWORD readlen = *reply_len;
712 if (!WriteFile(ctrl->pipe, cmd, cmd_len, &written, NULL))
715 if (!ReadFile(ctrl->pipe, reply, *reply_len, &readlen, NULL))
717 *reply_len = readlen;
723 int wpa_ctrl_recv(struct wpa_ctrl *ctrl, char *reply, size_t *reply_len)
725 DWORD len = *reply_len;
726 if (!ReadFile(ctrl->pipe, reply, *reply_len, &len, NULL))
733 int wpa_ctrl_pending(struct wpa_ctrl *ctrl)
737 if (!PeekNamedPipe(ctrl->pipe, NULL, 0, NULL, &left, NULL))
743 int wpa_ctrl_get_fd(struct wpa_ctrl *ctrl)
748 #endif /* CONFIG_CTRL_IFACE_NAMED_PIPE */
750 #endif /* CONFIG_CTRL_IFACE */