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.
15 #include <cutils/sockets.h>
18 #include "utils/common.h"
19 #include "utils/eloop.h"
20 #include "utils/list.h"
21 #include "eapol_supp/eapol_supp_sm.h"
23 #include "wpa_supplicant_i.h"
24 #include "ctrl_iface.h"
26 /* Per-interface ctrl_iface */
29 * struct wpa_ctrl_dst - Internal data structure of control interface monitors
31 * This structure is used to store information about registered control
32 * interface monitors into struct wpa_supplicant. This data is private to
33 * ctrl_iface_unix.c and should not be touched directly from other files.
37 struct sockaddr_un addr;
44 struct ctrl_iface_priv {
45 struct wpa_supplicant *wpa_s;
47 struct dl_list ctrl_dst;
51 static void wpa_supplicant_ctrl_iface_send(struct ctrl_iface_priv *priv,
52 int level, const char *buf,
56 static int wpa_supplicant_ctrl_iface_attach(struct ctrl_iface_priv *priv,
57 struct sockaddr_un *from,
60 struct wpa_ctrl_dst *dst;
62 dst = os_zalloc(sizeof(*dst));
65 os_memcpy(&dst->addr, from, sizeof(struct sockaddr_un));
66 dst->addrlen = fromlen;
67 dst->debug_level = MSG_INFO;
68 dl_list_add(&priv->ctrl_dst, &dst->list);
69 wpa_hexdump(MSG_DEBUG, "CTRL_IFACE monitor attached",
70 (u8 *) from->sun_path,
71 fromlen - offsetof(struct sockaddr_un, sun_path));
76 static int wpa_supplicant_ctrl_iface_detach(struct ctrl_iface_priv *priv,
77 struct sockaddr_un *from,
80 struct wpa_ctrl_dst *dst;
82 dl_list_for_each(dst, &priv->ctrl_dst, struct wpa_ctrl_dst, list) {
83 if (fromlen == dst->addrlen &&
84 os_memcmp(from->sun_path, dst->addr.sun_path,
85 fromlen - offsetof(struct sockaddr_un, sun_path))
87 dl_list_del(&dst->list);
89 wpa_hexdump(MSG_DEBUG, "CTRL_IFACE monitor detached",
90 (u8 *) from->sun_path,
92 offsetof(struct sockaddr_un, sun_path));
100 static int wpa_supplicant_ctrl_iface_level(struct ctrl_iface_priv *priv,
101 struct sockaddr_un *from,
105 struct wpa_ctrl_dst *dst;
107 wpa_printf(MSG_DEBUG, "CTRL_IFACE LEVEL %s", level);
109 dl_list_for_each(dst, &priv->ctrl_dst, struct wpa_ctrl_dst, list) {
110 if (fromlen == dst->addrlen &&
111 os_memcmp(from->sun_path, dst->addr.sun_path,
112 fromlen - offsetof(struct sockaddr_un, sun_path))
114 wpa_hexdump(MSG_DEBUG, "CTRL_IFACE changed monitor "
115 "level", (u8 *) from->sun_path,
117 offsetof(struct sockaddr_un, sun_path));
118 dst->debug_level = atoi(level);
127 static void wpa_supplicant_ctrl_iface_receive(int sock, void *eloop_ctx,
130 struct wpa_supplicant *wpa_s = eloop_ctx;
131 struct ctrl_iface_priv *priv = sock_ctx;
134 struct sockaddr_un from;
135 socklen_t fromlen = sizeof(from);
137 size_t reply_len = 0;
138 int new_attached = 0;
140 res = recvfrom(sock, buf, sizeof(buf) - 1, 0,
141 (struct sockaddr *) &from, &fromlen);
143 perror("recvfrom(ctrl_iface)");
148 if (os_strcmp(buf, "ATTACH") == 0) {
149 if (wpa_supplicant_ctrl_iface_attach(priv, &from, fromlen))
155 } else if (os_strcmp(buf, "DETACH") == 0) {
156 if (wpa_supplicant_ctrl_iface_detach(priv, &from, fromlen))
160 } else if (os_strncmp(buf, "LEVEL ", 6) == 0) {
161 if (wpa_supplicant_ctrl_iface_level(priv, &from, fromlen,
167 reply = wpa_supplicant_ctrl_iface_process(wpa_s, buf,
172 sendto(sock, reply, reply_len, 0, (struct sockaddr *) &from,
175 } else if (reply_len == 1) {
176 sendto(sock, "FAIL\n", 5, 0, (struct sockaddr *) &from,
178 } else if (reply_len == 2) {
179 sendto(sock, "OK\n", 3, 0, (struct sockaddr *) &from,
184 eapol_sm_notify_ctrl_attached(wpa_s->eapol);
188 static char * wpa_supplicant_ctrl_iface_path(struct wpa_supplicant *wpa_s)
192 char *pbuf, *dir = NULL, *gid_str = NULL;
195 if (wpa_s->conf->ctrl_interface == NULL)
198 pbuf = os_strdup(wpa_s->conf->ctrl_interface);
201 if (os_strncmp(pbuf, "DIR=", 4) == 0) {
203 gid_str = os_strstr(dir, " GROUP=");
211 len = os_strlen(dir) + os_strlen(wpa_s->ifname) + 2;
212 buf = os_malloc(len);
218 res = os_snprintf(buf, len, "%s/%s", dir, wpa_s->ifname);
219 if (res < 0 || (size_t) res >= len) {
226 /* Windows/WinPcap uses interface names that are not suitable
227 * as a file name - convert invalid chars to underscores */
235 #endif /* __CYGWIN__ */
241 static void wpa_supplicant_ctrl_iface_msg_cb(void *ctx, int level,
242 const char *txt, size_t len)
244 struct wpa_supplicant *wpa_s = ctx;
245 if (wpa_s == NULL || wpa_s->ctrl_iface == NULL)
247 wpa_supplicant_ctrl_iface_send(wpa_s->ctrl_iface, level, txt, len);
251 struct ctrl_iface_priv *
252 wpa_supplicant_ctrl_iface_init(struct wpa_supplicant *wpa_s)
254 struct ctrl_iface_priv *priv;
255 struct sockaddr_un addr;
259 char *buf, *dir = NULL, *gid_str = NULL;
263 priv = os_zalloc(sizeof(*priv));
266 dl_list_init(&priv->ctrl_dst);
270 if (wpa_s->conf->ctrl_interface == NULL)
273 buf = os_strdup(wpa_s->conf->ctrl_interface);
277 os_snprintf(addr.sun_path, sizeof(addr.sun_path), "wpa_%s",
278 wpa_s->conf->ctrl_interface);
279 priv->sock = android_get_control_socket(addr.sun_path);
283 if (os_strncmp(buf, "DIR=", 4) == 0) {
285 gid_str = os_strstr(dir, " GROUP=");
292 gid_str = wpa_s->conf->ctrl_interface_group;
295 if (mkdir(dir, S_IRWXU | S_IRWXG) < 0) {
296 if (errno == EEXIST) {
297 wpa_printf(MSG_DEBUG, "Using existing control "
298 "interface directory.");
300 perror("mkdir[ctrl_interface]");
306 grp = getgrnam(gid_str);
310 wpa_printf(MSG_DEBUG, "ctrl_interface_group=%d"
311 " (from group name '%s')",
314 /* Group name not found - try to parse this as gid */
315 gid = strtol(gid_str, &endp, 10);
316 if (*gid_str == '\0' || *endp != '\0') {
317 wpa_printf(MSG_ERROR, "CTRL: Invalid group "
322 wpa_printf(MSG_DEBUG, "ctrl_interface_group=%d",
327 if (gid_set && chown(dir, -1, gid) < 0) {
328 perror("chown[ctrl_interface]");
332 /* Make sure the group can enter and read the directory */
334 chmod(dir, S_IRUSR | S_IWUSR | S_IXUSR | S_IRGRP | S_IXGRP) < 0) {
335 wpa_printf(MSG_ERROR, "CTRL: chmod[ctrl_interface]: %s",
340 if (os_strlen(dir) + 1 + os_strlen(wpa_s->ifname) >=
341 sizeof(addr.sun_path)) {
342 wpa_printf(MSG_ERROR, "ctrl_iface path limit exceeded");
346 priv->sock = socket(PF_UNIX, SOCK_DGRAM, 0);
347 if (priv->sock < 0) {
348 perror("socket(PF_UNIX)");
352 os_memset(&addr, 0, sizeof(addr));
353 #if defined(__FreeBSD__) || defined(__FreeBSD_kernel__)
354 addr.sun_len = sizeof(addr);
355 #endif /* __FreeBSD__ */
356 addr.sun_family = AF_UNIX;
357 fname = wpa_supplicant_ctrl_iface_path(wpa_s);
360 os_strlcpy(addr.sun_path, fname, sizeof(addr.sun_path));
361 if (bind(priv->sock, (struct sockaddr *) &addr, sizeof(addr)) < 0) {
362 wpa_printf(MSG_DEBUG, "ctrl_iface bind(PF_UNIX) failed: %s",
364 if (connect(priv->sock, (struct sockaddr *) &addr,
366 wpa_printf(MSG_DEBUG, "ctrl_iface exists, but does not"
367 " allow connections - assuming it was left"
368 "over from forced program termination");
369 if (unlink(fname) < 0) {
370 perror("unlink[ctrl_iface]");
371 wpa_printf(MSG_ERROR, "Could not unlink "
372 "existing ctrl_iface socket '%s'",
376 if (bind(priv->sock, (struct sockaddr *) &addr,
378 perror("supp-ctrl-iface-init: bind(PF_UNIX)");
381 wpa_printf(MSG_DEBUG, "Successfully replaced leftover "
382 "ctrl_iface socket '%s'", fname);
384 wpa_printf(MSG_INFO, "ctrl_iface exists and seems to "
385 "be in use - cannot override it");
386 wpa_printf(MSG_INFO, "Delete '%s' manually if it is "
387 "not used anymore", fname);
394 if (gid_set && chown(fname, -1, gid) < 0) {
395 perror("chown[ctrl_interface/ifname]");
399 if (chmod(fname, S_IRWXU | S_IRWXG) < 0) {
400 perror("chmod[ctrl_interface/ifname]");
408 eloop_register_read_sock(priv->sock, wpa_supplicant_ctrl_iface_receive,
410 wpa_msg_register_cb(wpa_supplicant_ctrl_iface_msg_cb);
428 void wpa_supplicant_ctrl_iface_deinit(struct ctrl_iface_priv *priv)
430 struct wpa_ctrl_dst *dst, *prev;
432 if (priv->sock > -1) {
434 char *buf, *dir = NULL, *gid_str = NULL;
435 eloop_unregister_read_sock(priv->sock);
436 if (!dl_list_empty(&priv->ctrl_dst)) {
438 * Wait a second before closing the control socket if
439 * there are any attached monitors in order to allow
440 * them to receive any pending messages.
442 wpa_printf(MSG_DEBUG, "CTRL_IFACE wait for attached "
443 "monitors to receive messages");
448 fname = wpa_supplicant_ctrl_iface_path(priv->wpa_s);
454 buf = os_strdup(priv->wpa_s->conf->ctrl_interface);
457 if (os_strncmp(buf, "DIR=", 4) == 0) {
459 gid_str = os_strstr(dir, " GROUP=");
467 if (rmdir(dir) < 0) {
468 if (errno == ENOTEMPTY) {
469 wpa_printf(MSG_DEBUG, "Control interface "
470 "directory not empty - leaving it "
473 perror("rmdir[ctrl_interface]");
480 dl_list_for_each_safe(dst, prev, &priv->ctrl_dst, struct wpa_ctrl_dst,
488 * wpa_supplicant_ctrl_iface_send - Send a control interface packet to monitors
489 * @priv: Pointer to private data from wpa_supplicant_ctrl_iface_init()
490 * @level: Priority level of the message
492 * @len: Message length
494 * Send a packet to all monitor programs attached to the control interface.
496 static void wpa_supplicant_ctrl_iface_send(struct ctrl_iface_priv *priv,
497 int level, const char *buf,
500 struct wpa_ctrl_dst *dst, *next;
506 if (priv->sock < 0 || dl_list_empty(&priv->ctrl_dst))
509 res = os_snprintf(levelstr, sizeof(levelstr), "<%d>", level);
510 if (res < 0 || (size_t) res >= sizeof(levelstr))
512 io[0].iov_base = levelstr;
513 io[0].iov_len = os_strlen(levelstr);
514 io[1].iov_base = (char *) buf;
516 os_memset(&msg, 0, sizeof(msg));
521 dl_list_for_each_safe(dst, next, &priv->ctrl_dst, struct wpa_ctrl_dst,
523 if (level >= dst->debug_level) {
524 wpa_hexdump(MSG_DEBUG, "CTRL_IFACE monitor send",
525 (u8 *) dst->addr.sun_path, dst->addrlen -
526 offsetof(struct sockaddr_un, sun_path));
527 msg.msg_name = (void *) &dst->addr;
528 msg.msg_namelen = dst->addrlen;
529 if (sendmsg(priv->sock, &msg, 0) < 0) {
531 wpa_printf(MSG_INFO, "CTRL_IFACE monitor[%d]: "
533 idx, errno, strerror(errno));
535 if (dst->errors > 1000 ||
536 (_errno != ENOBUFS && dst->errors > 10) ||
538 wpa_supplicant_ctrl_iface_detach(
550 void wpa_supplicant_ctrl_iface_wait(struct ctrl_iface_priv *priv)
554 struct sockaddr_un from;
555 socklen_t fromlen = sizeof(from);
558 wpa_printf(MSG_DEBUG, "CTRL_IFACE - %s - wait for monitor to "
559 "attach", priv->wpa_s->ifname);
560 eloop_wait_for_read_sock(priv->sock);
562 res = recvfrom(priv->sock, buf, sizeof(buf) - 1, 0,
563 (struct sockaddr *) &from, &fromlen);
565 perror("recvfrom(ctrl_iface)");
570 if (os_strcmp(buf, "ATTACH") == 0) {
571 /* handle ATTACH signal of first monitor interface */
572 if (!wpa_supplicant_ctrl_iface_attach(priv, &from,
574 sendto(priv->sock, "OK\n", 3, 0,
575 (struct sockaddr *) &from, fromlen);
579 sendto(priv->sock, "FAIL\n", 5, 0,
580 (struct sockaddr *) &from, fromlen);
583 /* return FAIL for all other signals */
584 sendto(priv->sock, "FAIL\n", 5, 0,
585 (struct sockaddr *) &from, fromlen);
591 /* Global ctrl_iface */
593 struct ctrl_iface_global_priv {
594 struct wpa_global *global;
599 static void wpa_supplicant_global_ctrl_iface_receive(int sock, void *eloop_ctx,
602 struct wpa_global *global = eloop_ctx;
605 struct sockaddr_un from;
606 socklen_t fromlen = sizeof(from);
610 res = recvfrom(sock, buf, sizeof(buf) - 1, 0,
611 (struct sockaddr *) &from, &fromlen);
613 perror("recvfrom(ctrl_iface)");
618 reply = wpa_supplicant_global_ctrl_iface_process(global, buf,
622 sendto(sock, reply, reply_len, 0, (struct sockaddr *) &from,
625 } else if (reply_len) {
626 sendto(sock, "FAIL\n", 5, 0, (struct sockaddr *) &from,
632 struct ctrl_iface_global_priv *
633 wpa_supplicant_global_ctrl_iface_init(struct wpa_global *global)
635 struct ctrl_iface_global_priv *priv;
636 struct sockaddr_un addr;
638 priv = os_zalloc(sizeof(*priv));
641 priv->global = global;
644 if (global->params.ctrl_interface == NULL)
648 priv->sock = android_get_control_socket(global->params.ctrl_interface);
653 wpa_printf(MSG_DEBUG, "Global control interface '%s'",
654 global->params.ctrl_interface);
656 priv->sock = socket(PF_UNIX, SOCK_DGRAM, 0);
657 if (priv->sock < 0) {
658 perror("socket(PF_UNIX)");
662 os_memset(&addr, 0, sizeof(addr));
663 #if defined(__FreeBSD__) || defined(__FreeBSD_kernel__)
664 addr.sun_len = sizeof(addr);
665 #endif /* __FreeBSD__ */
666 addr.sun_family = AF_UNIX;
667 os_strlcpy(addr.sun_path, global->params.ctrl_interface,
668 sizeof(addr.sun_path));
669 if (bind(priv->sock, (struct sockaddr *) &addr, sizeof(addr)) < 0) {
670 perror("supp-global-ctrl-iface-init (will try fixup): "
672 if (connect(priv->sock, (struct sockaddr *) &addr,
674 wpa_printf(MSG_DEBUG, "ctrl_iface exists, but does not"
675 " allow connections - assuming it was left"
676 "over from forced program termination");
677 if (unlink(global->params.ctrl_interface) < 0) {
678 perror("unlink[ctrl_iface]");
679 wpa_printf(MSG_ERROR, "Could not unlink "
680 "existing ctrl_iface socket '%s'",
681 global->params.ctrl_interface);
684 if (bind(priv->sock, (struct sockaddr *) &addr,
686 perror("supp-glb-iface-init: bind(PF_UNIX)");
689 wpa_printf(MSG_DEBUG, "Successfully replaced leftover "
690 "ctrl_iface socket '%s'",
691 global->params.ctrl_interface);
693 wpa_printf(MSG_INFO, "ctrl_iface exists and seems to "
694 "be in use - cannot override it");
695 wpa_printf(MSG_INFO, "Delete '%s' manually if it is "
697 global->params.ctrl_interface);
705 eloop_register_read_sock(priv->sock,
706 wpa_supplicant_global_ctrl_iface_receive,
720 wpa_supplicant_global_ctrl_iface_deinit(struct ctrl_iface_global_priv *priv)
722 if (priv->sock >= 0) {
723 eloop_unregister_read_sock(priv->sock);
726 if (priv->global->params.ctrl_interface)
727 unlink(priv->global->params.ctrl_interface);