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 struct wpa_ctrl *ctrl;
89 static int counter = 0;
95 if (ctrl_path == NULL)
98 ctrl = os_zalloc(sizeof(*ctrl));
102 ctrl->s = socket(PF_UNIX, SOCK_DGRAM, 0);
108 ctrl->local.sun_family = AF_UNIX;
111 ret = os_snprintf(ctrl->local.sun_path, sizeof(ctrl->local.sun_path),
112 CONFIG_CTRL_IFACE_CLIENT_DIR "/"
113 CONFIG_CTRL_IFACE_CLIENT_PREFIX "%d-%d",
114 (int) getpid(), counter);
115 if (os_snprintf_error(sizeof(ctrl->local.sun_path), ret)) {
121 if (bind(ctrl->s, (struct sockaddr *) &ctrl->local,
122 sizeof(ctrl->local)) < 0) {
123 if (errno == EADDRINUSE && tries < 2) {
125 * getpid() returns unique identifier for this instance
126 * of wpa_ctrl, so the existing socket file must have
127 * been left by unclean termination of an earlier run.
128 * Remove the file and try again.
130 unlink(ctrl->local.sun_path);
139 chmod(ctrl->local.sun_path, S_IRUSR | S_IWUSR | S_IRGRP | S_IWGRP);
140 chown(ctrl->local.sun_path, AID_SYSTEM, AID_WIFI);
142 if (os_strncmp(ctrl_path, "@android:", 9) == 0) {
143 if (socket_local_client_connect(
144 ctrl->s, ctrl_path + 9,
145 ANDROID_SOCKET_NAMESPACE_RESERVED,
148 unlink(ctrl->local.sun_path);
156 * If the ctrl_path isn't an absolute pathname, assume that
157 * it's the name of a socket in the Android reserved namespace.
158 * Otherwise, it's a normal UNIX domain socket appearing in the
161 if (*ctrl_path != '/') {
163 os_snprintf(buf, sizeof(buf), "wpa_%s", ctrl_path);
164 if (socket_local_client_connect(
166 ANDROID_SOCKET_NAMESPACE_RESERVED,
169 unlink(ctrl->local.sun_path);
177 ctrl->dest.sun_family = AF_UNIX;
178 if (os_strncmp(ctrl_path, "@abstract:", 10) == 0) {
179 ctrl->dest.sun_path[0] = '\0';
180 os_strlcpy(ctrl->dest.sun_path + 1, ctrl_path + 10,
181 sizeof(ctrl->dest.sun_path) - 1);
183 res = os_strlcpy(ctrl->dest.sun_path, ctrl_path,
184 sizeof(ctrl->dest.sun_path));
185 if (res >= sizeof(ctrl->dest.sun_path)) {
191 if (connect(ctrl->s, (struct sockaddr *) &ctrl->dest,
192 sizeof(ctrl->dest)) < 0) {
194 unlink(ctrl->local.sun_path);
200 * Make socket non-blocking so that we don't hang forever if
201 * target dies unexpectedly.
203 flags = fcntl(ctrl->s, F_GETFL);
206 if (fcntl(ctrl->s, F_SETFL, flags) < 0) {
207 perror("fcntl(ctrl->s, O_NONBLOCK)");
208 /* Not fatal, continue on.*/
216 void wpa_ctrl_close(struct wpa_ctrl *ctrl)
220 unlink(ctrl->local.sun_path);
229 * wpa_ctrl_cleanup() - Delete any local UNIX domain socket files that
230 * may be left over from clients that were previously connected to
231 * wpa_supplicant. This keeps these files from being orphaned in the
232 * event of crashes that prevented them from being removed as part
233 * of the normal orderly shutdown.
235 void wpa_ctrl_cleanup(void)
239 struct dirent *result;
242 char pathname[PATH_MAX];
245 if ((dir = opendir(CONFIG_CTRL_IFACE_CLIENT_DIR)) == NULL)
248 dirnamelen = (size_t) os_snprintf(pathname, sizeof(pathname), "%s/",
249 CONFIG_CTRL_IFACE_CLIENT_DIR);
250 if (dirnamelen >= sizeof(pathname)) {
254 namep = pathname + dirnamelen;
255 maxcopy = PATH_MAX - dirnamelen;
256 while (readdir_r(dir, &entry, &result) == 0 && result != NULL) {
257 if (os_strlcpy(namep, entry.d_name, maxcopy) < maxcopy)
264 #else /* CONFIG_CTRL_IFACE_UNIX */
267 void wpa_ctrl_cleanup(void)
272 #endif /* CONFIG_CTRL_IFACE_UNIX */
275 #ifdef CONFIG_CTRL_IFACE_UDP
277 struct wpa_ctrl * wpa_ctrl_open(const char *ctrl_path)
279 struct wpa_ctrl *ctrl;
282 #ifdef CONFIG_CTRL_IFACE_UDP_REMOTE
284 #endif /* CONFIG_CTRL_IFACE_UDP_REMOTE */
286 ctrl = os_zalloc(sizeof(*ctrl));
290 #ifdef CONFIG_CTRL_IFACE_UDP_IPV6
291 ctrl->s = socket(PF_INET6, SOCK_DGRAM, 0);
292 #else /* CONFIG_CTRL_IFACE_UDP_IPV6 */
293 ctrl->s = socket(PF_INET, SOCK_DGRAM, 0);
294 #endif /* CONFIG_CTRL_IFACE_UDP_IPV6 */
301 #ifdef CONFIG_CTRL_IFACE_UDP_IPV6
302 ctrl->local.sin6_family = AF_INET6;
303 #ifdef CONFIG_CTRL_IFACE_UDP_REMOTE
304 ctrl->local.sin6_addr = in6addr_any;
305 #else /* CONFIG_CTRL_IFACE_UDP_REMOTE */
306 inet_pton(AF_INET6, "::1", &ctrl->local.sin6_addr);
307 #endif /* CONFIG_CTRL_IFACE_UDP_REMOTE */
308 #else /* CONFIG_CTRL_IFACE_UDP_IPV6 */
309 ctrl->local.sin_family = AF_INET;
310 #ifdef CONFIG_CTRL_IFACE_UDP_REMOTE
311 ctrl->local.sin_addr.s_addr = INADDR_ANY;
312 #else /* CONFIG_CTRL_IFACE_UDP_REMOTE */
313 ctrl->local.sin_addr.s_addr = htonl((127 << 24) | 1);
314 #endif /* CONFIG_CTRL_IFACE_UDP_REMOTE */
315 #endif /* CONFIG_CTRL_IFACE_UDP_IPV6 */
317 if (bind(ctrl->s, (struct sockaddr *) &ctrl->local,
318 sizeof(ctrl->local)) < 0) {
324 #ifdef CONFIG_CTRL_IFACE_UDP_IPV6
325 ctrl->dest.sin6_family = AF_INET6;
326 inet_pton(AF_INET6, "::1", &ctrl->dest.sin6_addr);
327 ctrl->dest.sin6_port = htons(WPA_CTRL_IFACE_PORT);
328 #else /* CONFIG_CTRL_IFACE_UDP_IPV6 */
329 ctrl->dest.sin_family = AF_INET;
330 ctrl->dest.sin_addr.s_addr = htonl((127 << 24) | 1);
331 ctrl->dest.sin_port = htons(WPA_CTRL_IFACE_PORT);
332 #endif /* CONFIG_CTRL_IFACE_UDP_IPV6 */
334 #ifdef CONFIG_CTRL_IFACE_UDP_REMOTE
338 #ifdef CONFIG_CTRL_IFACE_UDP_IPV6
341 #endif /* CONFIG_CTRL_IFACE_UDP_IPV6 */
343 name = os_strdup(ctrl_path);
349 #ifdef CONFIG_CTRL_IFACE_UDP_IPV6
350 port = os_strchr(name, ',');
351 #else /* CONFIG_CTRL_IFACE_UDP_IPV6 */
352 port = os_strchr(name, ':');
353 #endif /* CONFIG_CTRL_IFACE_UDP_IPV6 */
356 port_id = atoi(&port[1]);
359 port_id = WPA_CTRL_IFACE_PORT;
361 #ifdef CONFIG_CTRL_IFACE_UDP_IPV6
362 scope = os_strchr(name, '%');
364 scope_id = if_nametoindex(&scope[1]);
367 h = gethostbyname2(name, AF_INET6);
368 #else /* CONFIG_CTRL_IFACE_UDP_IPV6 */
369 h = gethostbyname(name);
370 #endif /* CONFIG_CTRL_IFACE_UDP_IPV6 */
371 ctrl->remote_ip = os_strdup(name);
374 perror("gethostbyname");
376 os_free(ctrl->remote_ip);
380 #ifdef CONFIG_CTRL_IFACE_UDP_IPV6
381 ctrl->dest.sin6_scope_id = scope_id;
382 ctrl->dest.sin6_port = htons(port_id);
383 os_memcpy(&ctrl->dest.sin6_addr, h->h_addr, h->h_length);
384 #else /* CONFIG_CTRL_IFACE_UDP_IPV6 */
385 ctrl->dest.sin_port = htons(port_id);
386 os_memcpy(&ctrl->dest.sin_addr.s_addr, h->h_addr, h->h_length);
387 #endif /* CONFIG_CTRL_IFACE_UDP_IPV6 */
389 ctrl->remote_ip = os_strdup("localhost");
390 #endif /* CONFIG_CTRL_IFACE_UDP_REMOTE */
392 if (connect(ctrl->s, (struct sockaddr *) &ctrl->dest,
393 sizeof(ctrl->dest)) < 0) {
394 #ifdef CONFIG_CTRL_IFACE_UDP_IPV6
395 char addr[INET6_ADDRSTRLEN];
396 wpa_printf(MSG_ERROR, "connect(%s:%d) failed: %s",
397 inet_ntop(AF_INET6, &ctrl->dest.sin6_addr, addr,
399 ntohs(ctrl->dest.sin6_port),
401 #else /* CONFIG_CTRL_IFACE_UDP_IPV6 */
402 wpa_printf(MSG_ERROR, "connect(%s:%d) failed: %s",
403 inet_ntoa(ctrl->dest.sin_addr),
404 ntohs(ctrl->dest.sin_port),
406 #endif /* CONFIG_CTRL_IFACE_UDP_IPV6 */
408 os_free(ctrl->remote_ip);
413 len = sizeof(buf) - 1;
414 if (wpa_ctrl_request(ctrl, "GET_COOKIE", 10, buf, &len, NULL) == 0) {
416 ctrl->cookie = os_strdup(buf);
419 if (wpa_ctrl_request(ctrl, "IFNAME", 6, buf, &len, NULL) == 0) {
421 ctrl->remote_ifname = os_strdup(buf);
428 char * wpa_ctrl_get_remote_ifname(struct wpa_ctrl *ctrl)
430 #define WPA_CTRL_MAX_PS_NAME 100
431 static char ps[WPA_CTRL_MAX_PS_NAME] = {};
432 os_snprintf(ps, WPA_CTRL_MAX_PS_NAME, "%s/%s",
433 ctrl->remote_ip, ctrl->remote_ifname);
438 void wpa_ctrl_close(struct wpa_ctrl *ctrl)
441 os_free(ctrl->cookie);
442 os_free(ctrl->remote_ifname);
443 os_free(ctrl->remote_ip);
447 #endif /* CONFIG_CTRL_IFACE_UDP */
450 #ifdef CTRL_IFACE_SOCKET
451 int wpa_ctrl_request(struct wpa_ctrl *ctrl, const char *cmd, size_t cmd_len,
452 char *reply, size_t *reply_len,
453 void (*msg_cb)(char *msg, size_t len))
456 struct os_reltime started_at;
460 char *cmd_buf = NULL;
463 #ifdef CONFIG_CTRL_IFACE_UDP
466 _cmd_len = os_strlen(ctrl->cookie) + 1 + cmd_len;
467 cmd_buf = os_malloc(_cmd_len);
472 os_strlcpy(pos, ctrl->cookie, _cmd_len);
473 pos += os_strlen(ctrl->cookie);
475 os_memcpy(pos, cmd, cmd_len);
477 #endif /* CONFIG_CTRL_IFACE_UDP */
487 if (send(ctrl->s, _cmd, _cmd_len, 0) < 0) {
488 if (errno == EAGAIN || errno == EBUSY || errno == EWOULDBLOCK)
491 * Must be a non-blocking socket... Try for a bit
492 * longer before giving up.
494 if (started_at.sec == 0)
495 os_get_reltime(&started_at);
499 /* Try for a few seconds. */
500 if (os_reltime_expired(&n, &started_at, 5))
516 FD_SET(ctrl->s, &rfds);
517 res = select(ctrl->s + 1, &rfds, NULL, NULL, &tv);
520 if (FD_ISSET(ctrl->s, &rfds)) {
521 res = recv(ctrl->s, reply, *reply_len, 0);
524 if (res > 0 && reply[0] == '<') {
525 /* This is an unsolicited message from
526 * wpa_supplicant, not the reply to the
527 * request. Use msg_cb to report this to the
530 /* Make sure the message is nul
532 if ((size_t) res == *reply_len)
533 res = (*reply_len) - 1;
547 #endif /* CTRL_IFACE_SOCKET */
550 static int wpa_ctrl_attach_helper(struct wpa_ctrl *ctrl, int attach)
556 ret = wpa_ctrl_request(ctrl, attach ? "ATTACH" : "DETACH", 6,
560 if (len == 3 && os_memcmp(buf, "OK\n", 3) == 0)
566 int wpa_ctrl_attach(struct wpa_ctrl *ctrl)
568 return wpa_ctrl_attach_helper(ctrl, 1);
572 int wpa_ctrl_detach(struct wpa_ctrl *ctrl)
574 return wpa_ctrl_attach_helper(ctrl, 0);
578 #ifdef CTRL_IFACE_SOCKET
580 int wpa_ctrl_recv(struct wpa_ctrl *ctrl, char *reply, size_t *reply_len)
584 res = recv(ctrl->s, reply, *reply_len, 0);
592 int wpa_ctrl_pending(struct wpa_ctrl *ctrl)
599 FD_SET(ctrl->s, &rfds);
600 select(ctrl->s + 1, &rfds, NULL, NULL, &tv);
601 return FD_ISSET(ctrl->s, &rfds);
605 int wpa_ctrl_get_fd(struct wpa_ctrl *ctrl)
610 #endif /* CTRL_IFACE_SOCKET */
613 #ifdef CONFIG_CTRL_IFACE_NAMED_PIPE
615 #ifndef WPA_SUPPLICANT_NAMED_PIPE
616 #define WPA_SUPPLICANT_NAMED_PIPE "WpaSupplicant"
618 #define NAMED_PIPE_PREFIX TEXT("\\\\.\\pipe\\") TEXT(WPA_SUPPLICANT_NAMED_PIPE)
620 struct wpa_ctrl * wpa_ctrl_open(const char *ctrl_path)
622 struct wpa_ctrl *ctrl;
627 ctrl = os_malloc(sizeof(*ctrl));
630 os_memset(ctrl, 0, sizeof(*ctrl));
633 if (ctrl_path == NULL)
634 ret = _snwprintf(name, 256, NAMED_PIPE_PREFIX);
636 ret = _snwprintf(name, 256, NAMED_PIPE_PREFIX TEXT("-%S"),
639 if (ctrl_path == NULL)
640 ret = os_snprintf(name, 256, NAMED_PIPE_PREFIX);
642 ret = os_snprintf(name, 256, NAMED_PIPE_PREFIX "-%s",
645 if (os_snprintf_error(256, ret)) {
650 for (i = 0; i < 10; i++) {
651 ctrl->pipe = CreateFile(name, GENERIC_READ | GENERIC_WRITE, 0,
652 NULL, OPEN_EXISTING, 0, NULL);
654 * Current named pipe server side in wpa_supplicant is
655 * re-opening the pipe for new clients only after the previous
656 * one is taken into use. This leaves a small window for race
657 * conditions when two connections are being opened at almost
658 * the same time. Retry if that was the case.
660 if (ctrl->pipe != INVALID_HANDLE_VALUE ||
661 GetLastError() != ERROR_PIPE_BUSY)
663 WaitNamedPipe(name, 1000);
665 if (ctrl->pipe == INVALID_HANDLE_VALUE) {
670 mode = PIPE_READMODE_MESSAGE;
671 if (!SetNamedPipeHandleState(ctrl->pipe, &mode, NULL, NULL)) {
672 CloseHandle(ctrl->pipe);
681 void wpa_ctrl_close(struct wpa_ctrl *ctrl)
683 CloseHandle(ctrl->pipe);
688 int wpa_ctrl_request(struct wpa_ctrl *ctrl, const char *cmd, size_t cmd_len,
689 char *reply, size_t *reply_len,
690 void (*msg_cb)(char *msg, size_t len))
693 DWORD readlen = *reply_len;
695 if (!WriteFile(ctrl->pipe, cmd, cmd_len, &written, NULL))
698 if (!ReadFile(ctrl->pipe, reply, *reply_len, &readlen, NULL))
700 *reply_len = readlen;
706 int wpa_ctrl_recv(struct wpa_ctrl *ctrl, char *reply, size_t *reply_len)
708 DWORD len = *reply_len;
709 if (!ReadFile(ctrl->pipe, reply, *reply_len, &len, NULL))
716 int wpa_ctrl_pending(struct wpa_ctrl *ctrl)
720 if (!PeekNamedPipe(ctrl->pipe, NULL, 0, NULL, &left, NULL))
726 int wpa_ctrl_get_fd(struct wpa_ctrl *ctrl)
731 #endif /* CONFIG_CTRL_IFACE_NAMED_PIPE */
733 #endif /* CONFIG_CTRL_IFACE */