2 * WPA Supplicant / UNIX domain socket -based control interface
3 * Copyright (c) 2004-2005, Jouni Malinen <j@w1.fi>
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License version 2 as
7 * published by the Free Software Foundation.
9 * Alternatively, this software may be distributed under the terms of BSD
12 * See README and COPYING for more details.
24 #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.
38 struct wpa_ctrl_dst *next;
39 struct sockaddr_un addr;
46 struct ctrl_iface_priv {
47 struct wpa_supplicant *wpa_s;
49 struct wpa_ctrl_dst *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 dst->next = priv->ctrl_dst;
72 wpa_hexdump(MSG_DEBUG, "CTRL_IFACE monitor attached",
73 (u8 *) from->sun_path,
74 fromlen - offsetof(struct sockaddr_un, sun_path));
79 static int wpa_supplicant_ctrl_iface_detach(struct ctrl_iface_priv *priv,
80 struct sockaddr_un *from,
83 struct wpa_ctrl_dst *dst, *prev = NULL;
87 if (fromlen == dst->addrlen &&
88 os_memcmp(from->sun_path, dst->addr.sun_path,
89 fromlen - offsetof(struct sockaddr_un, sun_path)) == 0) {
91 priv->ctrl_dst = dst->next;
93 prev->next = dst->next;
95 wpa_hexdump(MSG_DEBUG, "CTRL_IFACE monitor detached",
96 (u8 *) from->sun_path,
97 fromlen - offsetof(struct sockaddr_un, sun_path));
107 static int wpa_supplicant_ctrl_iface_level(struct ctrl_iface_priv *priv,
108 struct sockaddr_un *from,
112 struct wpa_ctrl_dst *dst;
114 wpa_printf(MSG_DEBUG, "CTRL_IFACE LEVEL %s", level);
116 dst = priv->ctrl_dst;
118 if (fromlen == dst->addrlen &&
119 os_memcmp(from->sun_path, dst->addr.sun_path,
120 fromlen - offsetof(struct sockaddr_un, sun_path)) == 0) {
121 wpa_hexdump(MSG_DEBUG, "CTRL_IFACE changed monitor "
122 "level", (u8 *) from->sun_path,
123 fromlen - offsetof(struct sockaddr_un, sun_path));
124 dst->debug_level = atoi(level);
134 static void wpa_supplicant_ctrl_iface_receive(int sock, void *eloop_ctx,
137 struct wpa_supplicant *wpa_s = eloop_ctx;
138 struct ctrl_iface_priv *priv = sock_ctx;
141 struct sockaddr_un from;
142 socklen_t fromlen = sizeof(from);
144 size_t reply_len = 0;
145 int new_attached = 0;
147 res = recvfrom(sock, buf, sizeof(buf) - 1, 0,
148 (struct sockaddr *) &from, &fromlen);
150 perror("recvfrom(ctrl_iface)");
155 if (os_strcmp(buf, "ATTACH") == 0) {
156 if (wpa_supplicant_ctrl_iface_attach(priv, &from, fromlen))
162 } else if (os_strcmp(buf, "DETACH") == 0) {
163 if (wpa_supplicant_ctrl_iface_detach(priv, &from, fromlen))
167 } else if (os_strncmp(buf, "LEVEL ", 6) == 0) {
168 if (wpa_supplicant_ctrl_iface_level(priv, &from, fromlen,
174 reply = wpa_supplicant_ctrl_iface_process(wpa_s, buf,
179 sendto(sock, reply, reply_len, 0, (struct sockaddr *) &from,
182 } else if (reply_len == 1) {
183 sendto(sock, "FAIL\n", 5, 0, (struct sockaddr *) &from,
185 } else if (reply_len == 2) {
186 sendto(sock, "OK\n", 3, 0, (struct sockaddr *) &from,
191 eapol_sm_notify_ctrl_attached(wpa_s->eapol);
195 static char * wpa_supplicant_ctrl_iface_path(struct wpa_supplicant *wpa_s)
199 char *pbuf, *dir = NULL, *gid_str = NULL;
202 if (wpa_s->conf->ctrl_interface == NULL)
205 pbuf = os_strdup(wpa_s->conf->ctrl_interface);
208 if (os_strncmp(pbuf, "DIR=", 4) == 0) {
210 gid_str = os_strstr(dir, " GROUP=");
218 len = os_strlen(dir) + os_strlen(wpa_s->ifname) + 2;
219 buf = os_malloc(len);
225 res = os_snprintf(buf, len, "%s/%s", dir, wpa_s->ifname);
226 if (res < 0 || (size_t) res >= len) {
233 /* Windows/WinPcap uses interface names that are not suitable
234 * as a file name - convert invalid chars to underscores */
242 #endif /* __CYGWIN__ */
248 static void wpa_supplicant_ctrl_iface_msg_cb(void *ctx, int level,
249 const char *txt, size_t len)
251 struct wpa_supplicant *wpa_s = ctx;
252 if (wpa_s == NULL || wpa_s->ctrl_iface == NULL)
254 wpa_supplicant_ctrl_iface_send(wpa_s->ctrl_iface, level, txt, len);
258 struct ctrl_iface_priv *
259 wpa_supplicant_ctrl_iface_init(struct wpa_supplicant *wpa_s)
261 struct ctrl_iface_priv *priv;
262 struct sockaddr_un addr;
266 char *buf, *dir = NULL, *gid_str = NULL;
270 priv = os_zalloc(sizeof(*priv));
276 if (wpa_s->conf->ctrl_interface == NULL)
279 buf = os_strdup(wpa_s->conf->ctrl_interface);
282 if (os_strncmp(buf, "DIR=", 4) == 0) {
284 gid_str = os_strstr(dir, " GROUP=");
291 gid_str = wpa_s->conf->ctrl_interface_group;
294 if (mkdir(dir, S_IRWXU | S_IRWXG) < 0) {
295 if (errno == EEXIST) {
296 wpa_printf(MSG_DEBUG, "Using existing control "
297 "interface directory.");
299 perror("mkdir[ctrl_interface]");
305 grp = getgrnam(gid_str);
309 wpa_printf(MSG_DEBUG, "ctrl_interface_group=%d"
310 " (from group name '%s')",
313 /* Group name not found - try to parse this as gid */
314 gid = strtol(gid_str, &endp, 10);
315 if (*gid_str == '\0' || *endp != '\0') {
316 wpa_printf(MSG_ERROR, "CTRL: Invalid group "
321 wpa_printf(MSG_DEBUG, "ctrl_interface_group=%d",
326 if (gid_set && chown(dir, -1, gid) < 0) {
327 perror("chown[ctrl_interface]");
331 if (os_strlen(dir) + 1 + os_strlen(wpa_s->ifname) >=
332 sizeof(addr.sun_path)) {
333 wpa_printf(MSG_ERROR, "ctrl_iface path limit exceeded");
337 priv->sock = socket(PF_UNIX, SOCK_DGRAM, 0);
338 if (priv->sock < 0) {
339 perror("socket(PF_UNIX)");
343 os_memset(&addr, 0, sizeof(addr));
345 addr.sun_len = sizeof(addr);
346 addr.sun_family = AF_UNIX;
347 fname = wpa_supplicant_ctrl_iface_path(wpa_s);
350 os_strlcpy(addr.sun_path, fname, sizeof(addr.sun_path));
351 if (bind(priv->sock, (struct sockaddr *) &addr, sizeof(addr)) < 0) {
352 wpa_printf(MSG_DEBUG, "ctrl_iface bind(PF_UNIX) failed: %s",
354 if (connect(priv->sock, (struct sockaddr *) &addr,
356 wpa_printf(MSG_DEBUG, "ctrl_iface exists, but does not"
357 " allow connections - assuming it was left"
358 "over from forced program termination");
359 if (unlink(fname) < 0) {
360 perror("unlink[ctrl_iface]");
361 wpa_printf(MSG_ERROR, "Could not unlink "
362 "existing ctrl_iface socket '%s'",
366 if (bind(priv->sock, (struct sockaddr *) &addr,
368 perror("bind(PF_UNIX)");
371 wpa_printf(MSG_DEBUG, "Successfully replaced leftover "
372 "ctrl_iface socket '%s'", fname);
374 wpa_printf(MSG_INFO, "ctrl_iface exists and seems to "
375 "be in use - cannot override it");
376 wpa_printf(MSG_INFO, "Delete '%s' manually if it is "
377 "not used anymore", fname);
384 if (gid_set && chown(fname, -1, gid) < 0) {
385 perror("chown[ctrl_interface/ifname]");
389 if (chmod(fname, S_IRWXU | S_IRWXG) < 0) {
390 perror("chmod[ctrl_interface/ifname]");
395 eloop_register_read_sock(priv->sock, wpa_supplicant_ctrl_iface_receive,
397 wpa_msg_register_cb(wpa_supplicant_ctrl_iface_msg_cb);
415 void wpa_supplicant_ctrl_iface_deinit(struct ctrl_iface_priv *priv)
417 struct wpa_ctrl_dst *dst, *prev;
419 if (priv->sock > -1) {
421 char *buf, *dir = NULL, *gid_str = NULL;
422 eloop_unregister_read_sock(priv->sock);
423 if (priv->ctrl_dst) {
425 * Wait a second before closing the control socket if
426 * there are any attached monitors in order to allow
427 * them to receive any pending messages.
429 wpa_printf(MSG_DEBUG, "CTRL_IFACE wait for attached "
430 "monitors to receive messages");
435 fname = wpa_supplicant_ctrl_iface_path(priv->wpa_s);
441 buf = os_strdup(priv->wpa_s->conf->ctrl_interface);
444 if (os_strncmp(buf, "DIR=", 4) == 0) {
446 gid_str = os_strstr(dir, " GROUP=");
454 if (rmdir(dir) < 0) {
455 if (errno == ENOTEMPTY) {
456 wpa_printf(MSG_DEBUG, "Control interface "
457 "directory not empty - leaving it "
460 perror("rmdir[ctrl_interface]");
467 dst = priv->ctrl_dst;
478 * wpa_supplicant_ctrl_iface_send - Send a control interface packet to monitors
479 * @priv: Pointer to private data from wpa_supplicant_ctrl_iface_init()
480 * @level: Priority level of the message
482 * @len: Message length
484 * Send a packet to all monitor programs attached to the control interface.
486 static void wpa_supplicant_ctrl_iface_send(struct ctrl_iface_priv *priv,
487 int level, const char *buf,
490 struct wpa_ctrl_dst *dst, *next;
496 dst = priv->ctrl_dst;
497 if (priv->sock < 0 || dst == NULL)
500 res = os_snprintf(levelstr, sizeof(levelstr), "<%d>", level);
501 if (res < 0 || (size_t) res >= sizeof(levelstr))
503 io[0].iov_base = levelstr;
504 io[0].iov_len = os_strlen(levelstr);
505 io[1].iov_base = (char *) buf;
507 os_memset(&msg, 0, sizeof(msg));
514 if (level >= dst->debug_level) {
515 wpa_hexdump(MSG_DEBUG, "CTRL_IFACE monitor send",
516 (u8 *) dst->addr.sun_path,
517 dst->addrlen - offsetof(struct sockaddr_un, sun_path));
518 msg.msg_name = (void *) &dst->addr;
519 msg.msg_namelen = dst->addrlen;
520 if (sendmsg(priv->sock, &msg, 0) < 0) {
521 perror("sendmsg(CTRL_IFACE monitor)");
523 if (dst->errors > 10) {
524 wpa_supplicant_ctrl_iface_detach(
537 void wpa_supplicant_ctrl_iface_wait(struct ctrl_iface_priv *priv)
541 struct sockaddr_un from;
542 socklen_t fromlen = sizeof(from);
545 wpa_printf(MSG_DEBUG, "CTRL_IFACE - %s - wait for monitor to "
546 "attach", priv->wpa_s->ifname);
547 eloop_wait_for_read_sock(priv->sock);
549 res = recvfrom(priv->sock, buf, sizeof(buf) - 1, 0,
550 (struct sockaddr *) &from, &fromlen);
552 perror("recvfrom(ctrl_iface)");
557 if (os_strcmp(buf, "ATTACH") == 0) {
558 /* handle ATTACH signal of first monitor interface */
559 if (!wpa_supplicant_ctrl_iface_attach(priv, &from,
561 sendto(priv->sock, "OK\n", 3, 0,
562 (struct sockaddr *) &from, fromlen);
566 sendto(priv->sock, "FAIL\n", 5, 0,
567 (struct sockaddr *) &from, fromlen);
570 /* return FAIL for all other signals */
571 sendto(priv->sock, "FAIL\n", 5, 0,
572 (struct sockaddr *) &from, fromlen);
578 /* Global ctrl_iface */
580 struct ctrl_iface_global_priv {
581 struct wpa_global *global;
586 static void wpa_supplicant_global_ctrl_iface_receive(int sock, void *eloop_ctx,
589 struct wpa_global *global = eloop_ctx;
592 struct sockaddr_un from;
593 socklen_t fromlen = sizeof(from);
597 res = recvfrom(sock, buf, sizeof(buf) - 1, 0,
598 (struct sockaddr *) &from, &fromlen);
600 perror("recvfrom(ctrl_iface)");
605 reply = wpa_supplicant_global_ctrl_iface_process(global, buf,
609 sendto(sock, reply, reply_len, 0, (struct sockaddr *) &from,
612 } else if (reply_len) {
613 sendto(sock, "FAIL\n", 5, 0, (struct sockaddr *) &from,
619 struct ctrl_iface_global_priv *
620 wpa_supplicant_global_ctrl_iface_init(struct wpa_global *global)
622 struct ctrl_iface_global_priv *priv;
623 struct sockaddr_un addr;
625 priv = os_zalloc(sizeof(*priv));
628 priv->global = global;
631 if (global->params.ctrl_interface == NULL)
634 wpa_printf(MSG_DEBUG, "Global control interface '%s'",
635 global->params.ctrl_interface);
637 priv->sock = socket(PF_UNIX, SOCK_DGRAM, 0);
638 if (priv->sock < 0) {
639 perror("socket(PF_UNIX)");
643 os_memset(&addr, 0, sizeof(addr));
645 addr.sun_len = sizeof(addr);
646 addr.sun_family = AF_UNIX;
647 os_strlcpy(addr.sun_path, global->params.ctrl_interface,
648 sizeof(addr.sun_path));
649 if (bind(priv->sock, (struct sockaddr *) &addr, sizeof(addr)) < 0) {
650 perror("bind(PF_UNIX)");
651 if (connect(priv->sock, (struct sockaddr *) &addr,
653 wpa_printf(MSG_DEBUG, "ctrl_iface exists, but does not"
654 " allow connections - assuming it was left"
655 "over from forced program termination");
656 if (unlink(global->params.ctrl_interface) < 0) {
657 perror("unlink[ctrl_iface]");
658 wpa_printf(MSG_ERROR, "Could not unlink "
659 "existing ctrl_iface socket '%s'",
660 global->params.ctrl_interface);
663 if (bind(priv->sock, (struct sockaddr *) &addr,
665 perror("bind(PF_UNIX)");
668 wpa_printf(MSG_DEBUG, "Successfully replaced leftover "
669 "ctrl_iface socket '%s'",
670 global->params.ctrl_interface);
672 wpa_printf(MSG_INFO, "ctrl_iface exists and seems to "
673 "be in use - cannot override it");
674 wpa_printf(MSG_INFO, "Delete '%s' manually if it is "
676 global->params.ctrl_interface);
681 eloop_register_read_sock(priv->sock,
682 wpa_supplicant_global_ctrl_iface_receive,
696 wpa_supplicant_global_ctrl_iface_deinit(struct ctrl_iface_global_priv *priv)
698 if (priv->sock >= 0) {
699 eloop_unregister_read_sock(priv->sock);
702 if (priv->global->params.ctrl_interface)
703 unlink(priv->global->params.ctrl_interface);