2 * WPA Supplicant / UNIX domain socket -based control interface
3 * Copyright (c) 2004-2009, Jouni Malinen <j@w1.fi>
5 * This software may be distributed under the terms of the BSD license.
6 * See README for more details.
17 #include <cutils/sockets.h>
20 #include "utils/common.h"
21 #include "utils/eloop.h"
22 #include "utils/list.h"
23 #include "eapol_supp/eapol_supp_sm.h"
25 #include "wpa_supplicant_i.h"
26 #include "ctrl_iface.h"
28 /* Per-interface ctrl_iface */
31 * struct wpa_ctrl_dst - Internal data structure of control interface monitors
33 * This structure is used to store information about registered control
34 * interface monitors into struct wpa_supplicant. This data is private to
35 * ctrl_iface_unix.c and should not be touched directly from other files.
39 struct sockaddr_un addr;
46 struct ctrl_iface_priv {
47 struct wpa_supplicant *wpa_s;
49 struct dl_list ctrl_dst;
53 static void wpa_supplicant_ctrl_iface_send(struct ctrl_iface_priv *priv,
54 int level, const char *buf,
58 static int wpa_supplicant_ctrl_iface_attach(struct ctrl_iface_priv *priv,
59 struct sockaddr_un *from,
62 struct wpa_ctrl_dst *dst;
64 dst = os_zalloc(sizeof(*dst));
67 os_memcpy(&dst->addr, from, sizeof(struct sockaddr_un));
68 dst->addrlen = fromlen;
69 dst->debug_level = MSG_INFO;
70 dl_list_add(&priv->ctrl_dst, &dst->list);
71 wpa_hexdump(MSG_DEBUG, "CTRL_IFACE monitor attached",
72 (u8 *) from->sun_path,
73 fromlen - offsetof(struct sockaddr_un, sun_path));
78 static int wpa_supplicant_ctrl_iface_detach(struct ctrl_iface_priv *priv,
79 struct sockaddr_un *from,
82 struct wpa_ctrl_dst *dst;
84 dl_list_for_each(dst, &priv->ctrl_dst, struct wpa_ctrl_dst, list) {
85 if (fromlen == dst->addrlen &&
86 os_memcmp(from->sun_path, dst->addr.sun_path,
87 fromlen - offsetof(struct sockaddr_un, sun_path))
89 dl_list_del(&dst->list);
91 wpa_hexdump(MSG_DEBUG, "CTRL_IFACE monitor detached",
92 (u8 *) from->sun_path,
94 offsetof(struct sockaddr_un, sun_path));
102 static int wpa_supplicant_ctrl_iface_level(struct ctrl_iface_priv *priv,
103 struct sockaddr_un *from,
107 struct wpa_ctrl_dst *dst;
109 wpa_printf(MSG_DEBUG, "CTRL_IFACE LEVEL %s", level);
111 dl_list_for_each(dst, &priv->ctrl_dst, struct wpa_ctrl_dst, list) {
112 if (fromlen == dst->addrlen &&
113 os_memcmp(from->sun_path, dst->addr.sun_path,
114 fromlen - offsetof(struct sockaddr_un, sun_path))
116 wpa_hexdump(MSG_DEBUG, "CTRL_IFACE changed monitor "
117 "level", (u8 *) from->sun_path,
119 offsetof(struct sockaddr_un, sun_path));
120 dst->debug_level = atoi(level);
129 static void wpa_supplicant_ctrl_iface_receive(int sock, void *eloop_ctx,
132 struct wpa_supplicant *wpa_s = eloop_ctx;
133 struct ctrl_iface_priv *priv = sock_ctx;
136 struct sockaddr_un from;
137 socklen_t fromlen = sizeof(from);
139 size_t reply_len = 0;
140 int new_attached = 0;
142 res = recvfrom(sock, buf, sizeof(buf) - 1, 0,
143 (struct sockaddr *) &from, &fromlen);
145 perror("recvfrom(ctrl_iface)");
150 if (os_strcmp(buf, "ATTACH") == 0) {
151 if (wpa_supplicant_ctrl_iface_attach(priv, &from, fromlen))
157 } else if (os_strcmp(buf, "DETACH") == 0) {
158 if (wpa_supplicant_ctrl_iface_detach(priv, &from, fromlen))
162 } else if (os_strncmp(buf, "LEVEL ", 6) == 0) {
163 if (wpa_supplicant_ctrl_iface_level(priv, &from, fromlen,
169 #if defined(CONFIG_P2P) && defined(ANDROID_P2P)
170 char *ifname, *ifend;
172 ifname = os_strstr(buf, "interface=");
173 if (ifname != NULL) {
174 ifend = os_strchr(ifname + 10, ' ');
179 wpa_printf(MSG_DEBUG, "Found %s", ifname);
180 for (wpa_s = wpa_s->global->ifaces; wpa_s; wpa_s = wpa_s->next) {
181 if (os_strcmp(wpa_s->ifname, ifname + 10) == 0)
185 wpa_printf(MSG_ERROR, "P2P: %s does not exist", ifname);
188 os_memmove(ifname, ifend, strlen(ifend) + 1);
189 wpa_printf(MSG_INFO, "wpa_s %p cmd %s", wpa_s, buf);
191 #endif /* defined CONFIG_P2P && defined ANDROID_P2P */
192 reply = wpa_supplicant_ctrl_iface_process(wpa_s, buf,
197 sendto(sock, reply, reply_len, 0, (struct sockaddr *) &from,
200 } else if (reply_len == 1) {
201 sendto(sock, "FAIL\n", 5, 0, (struct sockaddr *) &from,
203 } else if (reply_len == 2) {
204 sendto(sock, "OK\n", 3, 0, (struct sockaddr *) &from,
209 eapol_sm_notify_ctrl_attached(wpa_s->eapol);
213 static char * wpa_supplicant_ctrl_iface_path(struct wpa_supplicant *wpa_s)
217 char *pbuf, *dir = NULL, *gid_str = NULL;
220 if (wpa_s->conf->ctrl_interface == NULL)
223 pbuf = os_strdup(wpa_s->conf->ctrl_interface);
226 if (os_strncmp(pbuf, "DIR=", 4) == 0) {
228 gid_str = os_strstr(dir, " GROUP=");
236 len = os_strlen(dir) + os_strlen(wpa_s->ifname) + 2;
237 buf = os_malloc(len);
243 res = os_snprintf(buf, len, "%s/%s", dir, wpa_s->ifname);
244 if (res < 0 || (size_t) res >= len) {
251 /* Windows/WinPcap uses interface names that are not suitable
252 * as a file name - convert invalid chars to underscores */
260 #endif /* __CYGWIN__ */
266 static void wpa_supplicant_ctrl_iface_msg_cb(void *ctx, int level,
267 const char *txt, size_t len)
269 struct wpa_supplicant *wpa_s = ctx;
270 if (wpa_s == NULL || wpa_s->ctrl_iface == NULL)
272 wpa_supplicant_ctrl_iface_send(wpa_s->ctrl_iface, level, txt, len);
276 struct ctrl_iface_priv *
277 wpa_supplicant_ctrl_iface_init(struct wpa_supplicant *wpa_s)
279 struct ctrl_iface_priv *priv;
280 struct sockaddr_un addr;
284 char *buf, *dir = NULL, *gid_str = NULL;
289 priv = os_zalloc(sizeof(*priv));
292 dl_list_init(&priv->ctrl_dst);
296 if (wpa_s->conf->ctrl_interface == NULL)
299 buf = os_strdup(wpa_s->conf->ctrl_interface);
303 os_snprintf(addr.sun_path, sizeof(addr.sun_path), "wpa_%s",
304 wpa_s->conf->ctrl_interface);
305 priv->sock = android_get_control_socket(addr.sun_path);
309 if (os_strncmp(buf, "DIR=", 4) == 0) {
311 gid_str = os_strstr(dir, " GROUP=");
318 gid_str = wpa_s->conf->ctrl_interface_group;
321 if (mkdir(dir, S_IRWXU | S_IRWXG) < 0) {
322 if (errno == EEXIST) {
323 wpa_printf(MSG_DEBUG, "Using existing control "
324 "interface directory.");
326 perror("mkdir[ctrl_interface]");
332 grp = getgrnam(gid_str);
336 wpa_printf(MSG_DEBUG, "ctrl_interface_group=%d"
337 " (from group name '%s')",
340 /* Group name not found - try to parse this as gid */
341 gid = strtol(gid_str, &endp, 10);
342 if (*gid_str == '\0' || *endp != '\0') {
343 wpa_printf(MSG_ERROR, "CTRL: Invalid group "
348 wpa_printf(MSG_DEBUG, "ctrl_interface_group=%d",
353 if (gid_set && chown(dir, -1, gid) < 0) {
354 perror("chown[ctrl_interface]");
358 /* Make sure the group can enter and read the directory */
360 chmod(dir, S_IRUSR | S_IWUSR | S_IXUSR | S_IRGRP | S_IXGRP) < 0) {
361 wpa_printf(MSG_ERROR, "CTRL: chmod[ctrl_interface]: %s",
366 if (os_strlen(dir) + 1 + os_strlen(wpa_s->ifname) >=
367 sizeof(addr.sun_path)) {
368 wpa_printf(MSG_ERROR, "ctrl_iface path limit exceeded");
372 priv->sock = socket(PF_UNIX, SOCK_DGRAM, 0);
373 if (priv->sock < 0) {
374 perror("socket(PF_UNIX)");
378 os_memset(&addr, 0, sizeof(addr));
379 #if defined(__FreeBSD__) || defined(__FreeBSD_kernel__)
380 addr.sun_len = sizeof(addr);
381 #endif /* __FreeBSD__ */
382 addr.sun_family = AF_UNIX;
383 fname = wpa_supplicant_ctrl_iface_path(wpa_s);
386 os_strlcpy(addr.sun_path, fname, sizeof(addr.sun_path));
387 if (bind(priv->sock, (struct sockaddr *) &addr, sizeof(addr)) < 0) {
388 wpa_printf(MSG_DEBUG, "ctrl_iface bind(PF_UNIX) failed: %s",
390 if (connect(priv->sock, (struct sockaddr *) &addr,
392 wpa_printf(MSG_DEBUG, "ctrl_iface exists, but does not"
393 " allow connections - assuming it was left"
394 "over from forced program termination");
395 if (unlink(fname) < 0) {
396 perror("unlink[ctrl_iface]");
397 wpa_printf(MSG_ERROR, "Could not unlink "
398 "existing ctrl_iface socket '%s'",
402 if (bind(priv->sock, (struct sockaddr *) &addr,
404 perror("supp-ctrl-iface-init: bind(PF_UNIX)");
407 wpa_printf(MSG_DEBUG, "Successfully replaced leftover "
408 "ctrl_iface socket '%s'", fname);
410 wpa_printf(MSG_INFO, "ctrl_iface exists and seems to "
411 "be in use - cannot override it");
412 wpa_printf(MSG_INFO, "Delete '%s' manually if it is "
413 "not used anymore", fname);
420 if (gid_set && chown(fname, -1, gid) < 0) {
421 perror("chown[ctrl_interface/ifname]");
425 if (chmod(fname, S_IRWXU | S_IRWXG) < 0) {
426 perror("chmod[ctrl_interface/ifname]");
436 * Make socket non-blocking so that we don't hang forever if
437 * target dies unexpectedly.
439 flags = fcntl(priv->sock, F_GETFL);
442 if (fcntl(priv->sock, F_SETFL, flags) < 0) {
443 perror("fcntl(ctrl, O_NONBLOCK)");
444 /* Not fatal, continue on.*/
448 eloop_register_read_sock(priv->sock, wpa_supplicant_ctrl_iface_receive,
450 wpa_msg_register_cb(wpa_supplicant_ctrl_iface_msg_cb);
468 void wpa_supplicant_ctrl_iface_deinit(struct ctrl_iface_priv *priv)
470 struct wpa_ctrl_dst *dst, *prev;
472 if (priv->sock > -1) {
474 char *buf, *dir = NULL, *gid_str = NULL;
475 eloop_unregister_read_sock(priv->sock);
476 if (!dl_list_empty(&priv->ctrl_dst)) {
478 * Wait a second before closing the control socket if
479 * there are any attached monitors in order to allow
480 * them to receive any pending messages.
482 wpa_printf(MSG_DEBUG, "CTRL_IFACE wait for attached "
483 "monitors to receive messages");
488 fname = wpa_supplicant_ctrl_iface_path(priv->wpa_s);
494 buf = os_strdup(priv->wpa_s->conf->ctrl_interface);
497 if (os_strncmp(buf, "DIR=", 4) == 0) {
499 gid_str = os_strstr(dir, " GROUP=");
507 if (rmdir(dir) < 0) {
508 if (errno == ENOTEMPTY) {
509 wpa_printf(MSG_DEBUG, "Control interface "
510 "directory not empty - leaving it "
513 perror("rmdir[ctrl_interface]");
520 dl_list_for_each_safe(dst, prev, &priv->ctrl_dst, struct wpa_ctrl_dst,
528 * wpa_supplicant_ctrl_iface_send - Send a control interface packet to monitors
529 * @priv: Pointer to private data from wpa_supplicant_ctrl_iface_init()
530 * @level: Priority level of the message
532 * @len: Message length
534 * Send a packet to all monitor programs attached to the control interface.
536 static void wpa_supplicant_ctrl_iface_send(struct ctrl_iface_priv *priv,
537 int level, const char *buf,
540 struct wpa_ctrl_dst *dst, *next;
546 if (priv->sock < 0 || dl_list_empty(&priv->ctrl_dst))
549 res = os_snprintf(levelstr, sizeof(levelstr), "<%d>", level);
550 if (res < 0 || (size_t) res >= sizeof(levelstr))
552 io[0].iov_base = levelstr;
553 io[0].iov_len = os_strlen(levelstr);
554 io[1].iov_base = (char *) buf;
556 os_memset(&msg, 0, sizeof(msg));
561 dl_list_for_each_safe(dst, next, &priv->ctrl_dst, struct wpa_ctrl_dst,
563 if (level >= dst->debug_level) {
564 wpa_hexdump(MSG_DEBUG, "CTRL_IFACE monitor send",
565 (u8 *) dst->addr.sun_path, dst->addrlen -
566 offsetof(struct sockaddr_un, sun_path));
567 msg.msg_name = (void *) &dst->addr;
568 msg.msg_namelen = dst->addrlen;
569 if (sendmsg(priv->sock, &msg, 0) < 0) {
571 wpa_printf(MSG_INFO, "CTRL_IFACE monitor[%d]: "
573 idx, errno, strerror(errno));
575 if (dst->errors > 1000 ||
576 (_errno != ENOBUFS && dst->errors > 10) ||
578 wpa_supplicant_ctrl_iface_detach(
590 void wpa_supplicant_ctrl_iface_wait(struct ctrl_iface_priv *priv)
594 struct sockaddr_un from;
595 socklen_t fromlen = sizeof(from);
598 wpa_printf(MSG_DEBUG, "CTRL_IFACE - %s - wait for monitor to "
599 "attach", priv->wpa_s->ifname);
600 eloop_wait_for_read_sock(priv->sock);
602 res = recvfrom(priv->sock, buf, sizeof(buf) - 1, 0,
603 (struct sockaddr *) &from, &fromlen);
605 perror("recvfrom(ctrl_iface)");
610 if (os_strcmp(buf, "ATTACH") == 0) {
611 /* handle ATTACH signal of first monitor interface */
612 if (!wpa_supplicant_ctrl_iface_attach(priv, &from,
614 sendto(priv->sock, "OK\n", 3, 0,
615 (struct sockaddr *) &from, fromlen);
619 sendto(priv->sock, "FAIL\n", 5, 0,
620 (struct sockaddr *) &from, fromlen);
623 /* return FAIL for all other signals */
624 sendto(priv->sock, "FAIL\n", 5, 0,
625 (struct sockaddr *) &from, fromlen);
631 /* Global ctrl_iface */
633 struct ctrl_iface_global_priv {
634 struct wpa_global *global;
639 static void wpa_supplicant_global_ctrl_iface_receive(int sock, void *eloop_ctx,
642 struct wpa_global *global = eloop_ctx;
645 struct sockaddr_un from;
646 socklen_t fromlen = sizeof(from);
650 res = recvfrom(sock, buf, sizeof(buf) - 1, 0,
651 (struct sockaddr *) &from, &fromlen);
653 perror("recvfrom(ctrl_iface)");
658 reply = wpa_supplicant_global_ctrl_iface_process(global, buf,
662 sendto(sock, reply, reply_len, 0, (struct sockaddr *) &from,
665 } else if (reply_len) {
666 sendto(sock, "FAIL\n", 5, 0, (struct sockaddr *) &from,
672 struct ctrl_iface_global_priv *
673 wpa_supplicant_global_ctrl_iface_init(struct wpa_global *global)
675 struct ctrl_iface_global_priv *priv;
676 struct sockaddr_un addr;
678 priv = os_zalloc(sizeof(*priv));
681 priv->global = global;
684 if (global->params.ctrl_interface == NULL)
688 priv->sock = android_get_control_socket(global->params.ctrl_interface);
693 wpa_printf(MSG_DEBUG, "Global control interface '%s'",
694 global->params.ctrl_interface);
696 priv->sock = socket(PF_UNIX, SOCK_DGRAM, 0);
697 if (priv->sock < 0) {
698 perror("socket(PF_UNIX)");
702 os_memset(&addr, 0, sizeof(addr));
703 #if defined(__FreeBSD__) || defined(__FreeBSD_kernel__)
704 addr.sun_len = sizeof(addr);
705 #endif /* __FreeBSD__ */
706 addr.sun_family = AF_UNIX;
707 os_strlcpy(addr.sun_path, global->params.ctrl_interface,
708 sizeof(addr.sun_path));
709 if (bind(priv->sock, (struct sockaddr *) &addr, sizeof(addr)) < 0) {
710 perror("supp-global-ctrl-iface-init (will try fixup): "
712 if (connect(priv->sock, (struct sockaddr *) &addr,
714 wpa_printf(MSG_DEBUG, "ctrl_iface exists, but does not"
715 " allow connections - assuming it was left"
716 "over from forced program termination");
717 if (unlink(global->params.ctrl_interface) < 0) {
718 perror("unlink[ctrl_iface]");
719 wpa_printf(MSG_ERROR, "Could not unlink "
720 "existing ctrl_iface socket '%s'",
721 global->params.ctrl_interface);
724 if (bind(priv->sock, (struct sockaddr *) &addr,
726 perror("supp-glb-iface-init: bind(PF_UNIX)");
729 wpa_printf(MSG_DEBUG, "Successfully replaced leftover "
730 "ctrl_iface socket '%s'",
731 global->params.ctrl_interface);
733 wpa_printf(MSG_INFO, "ctrl_iface exists and seems to "
734 "be in use - cannot override it");
735 wpa_printf(MSG_INFO, "Delete '%s' manually if it is "
737 global->params.ctrl_interface);
745 eloop_register_read_sock(priv->sock,
746 wpa_supplicant_global_ctrl_iface_receive,
760 wpa_supplicant_global_ctrl_iface_deinit(struct ctrl_iface_global_priv *priv)
762 if (priv->sock >= 0) {
763 eloop_unregister_read_sock(priv->sock);
766 if (priv->global->params.ctrl_interface)
767 unlink(priv->global->params.ctrl_interface);