2 * hostapd - command line interface for hostapd daemon
3 * Copyright (c) 2004-2009, 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.
23 static const char *hostapd_cli_version =
24 "hostapd_cli v" VERSION_STR "\n"
25 "Copyright (c) 2004-2009, Jouni Malinen <j@w1.fi> and contributors";
28 static const char *hostapd_cli_license =
29 "This program is free software. You can distribute it and/or modify it\n"
30 "under the terms of the GNU General Public License version 2.\n"
32 "Alternatively, this software may be distributed under the terms of the\n"
33 "BSD license. See README and COPYING for more details.\n";
35 static const char *hostapd_cli_full_license =
36 "This program is free software; you can redistribute it and/or modify\n"
37 "it under the terms of the GNU General Public License version 2 as\n"
38 "published by the Free Software Foundation.\n"
40 "This program is distributed in the hope that it will be useful,\n"
41 "but WITHOUT ANY WARRANTY; without even the implied warranty of\n"
42 "MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n"
43 "GNU General Public License for more details.\n"
45 "You should have received a copy of the GNU General Public License\n"
46 "along with this program; if not, write to the Free Software\n"
47 "Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n"
49 "Alternatively, this software may be distributed under the terms of the\n"
52 "Redistribution and use in source and binary forms, with or without\n"
53 "modification, are permitted provided that the following conditions are\n"
56 "1. Redistributions of source code must retain the above copyright\n"
57 " notice, this list of conditions and the following disclaimer.\n"
59 "2. Redistributions in binary form must reproduce the above copyright\n"
60 " notice, this list of conditions and the following disclaimer in the\n"
61 " documentation and/or other materials provided with the distribution.\n"
63 "3. Neither the name(s) of the above-listed copyright holder(s) nor the\n"
64 " names of its contributors may be used to endorse or promote products\n"
65 " derived from this software without specific prior written permission.\n"
67 "THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS\n"
68 "\"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT\n"
69 "LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR\n"
70 "A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT\n"
71 "OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,\n"
72 "SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT\n"
73 "LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,\n"
74 "DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY\n"
75 "THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT\n"
76 "(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE\n"
77 "OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\n"
80 static const char *commands_help =
82 " mib get MIB variables (dot1x, dot11, radius)\n"
83 " sta <addr> get MIB variables for one station\n"
84 " all_sta get MIB variables for all stations\n"
85 " new_sta <addr> add a new station\n"
86 #ifdef CONFIG_IEEE80211W
87 " sa_query <addr> send SA Query to a station\n"
88 #endif /* CONFIG_IEEE80211W */
90 " wps_pin <uuid> <pin> add WPS Enrollee PIN (Device Password)\n"
91 " wps_pbc indicate button pushed to initiate PBC\n"
93 " wps_oob <type> <path> <method> use WPS with out-of-band (UFD)\n"
94 #endif /* CONFIG_WPS_OOB */
95 #endif /* CONFIG_WPS */
96 " help show this usage help\n"
97 " interface [ifname] show interfaces/select interface\n"
98 " level <debug level> change debug level\n"
99 " license show full hostapd_cli license\n"
100 " quit exit hostapd_cli\n";
102 static struct wpa_ctrl *ctrl_conn;
103 static int hostapd_cli_quit = 0;
104 static int hostapd_cli_attached = 0;
105 static const char *ctrl_iface_dir = "/var/run/hostapd";
106 static char *ctrl_ifname = NULL;
107 static int ping_interval = 5;
110 static void usage(void)
112 fprintf(stderr, "%s\n", hostapd_cli_version);
115 "usage: hostapd_cli [-p<path>] [-i<ifname>] [-hv] "
116 "[-G<ping interval>] \\\n"
120 " -h help (show this usage text)\n"
121 " -v shown version information\n"
122 " -p<path> path to find control sockets (default: "
123 "/var/run/hostapd)\n"
124 " -i<ifname> Interface to listen on (default: first "
125 "interface found in the\n"
132 static struct wpa_ctrl * hostapd_cli_open_connection(const char *ifname)
140 flen = strlen(ctrl_iface_dir) + strlen(ifname) + 2;
141 cfile = malloc(flen);
144 snprintf(cfile, flen, "%s/%s", ctrl_iface_dir, ifname);
146 ctrl_conn = wpa_ctrl_open(cfile);
152 static void hostapd_cli_close_connection(void)
154 if (ctrl_conn == NULL)
157 if (hostapd_cli_attached) {
158 wpa_ctrl_detach(ctrl_conn);
159 hostapd_cli_attached = 0;
161 wpa_ctrl_close(ctrl_conn);
166 static void hostapd_cli_msg_cb(char *msg, size_t len)
172 static int _wpa_ctrl_command(struct wpa_ctrl *ctrl, char *cmd, int print)
178 if (ctrl_conn == NULL) {
179 printf("Not connected to hostapd - command dropped.\n");
182 len = sizeof(buf) - 1;
183 ret = wpa_ctrl_request(ctrl, cmd, strlen(cmd), buf, &len,
186 printf("'%s' command timed out.\n", cmd);
188 } else if (ret < 0) {
189 printf("'%s' command failed.\n", cmd);
200 static inline int wpa_ctrl_command(struct wpa_ctrl *ctrl, char *cmd)
202 return _wpa_ctrl_command(ctrl, cmd, 1);
206 static int hostapd_cli_cmd_ping(struct wpa_ctrl *ctrl, int argc, char *argv[])
208 return wpa_ctrl_command(ctrl, "PING");
212 static int hostapd_cli_cmd_mib(struct wpa_ctrl *ctrl, int argc, char *argv[])
214 return wpa_ctrl_command(ctrl, "MIB");
218 static int hostapd_cli_cmd_sta(struct wpa_ctrl *ctrl, int argc, char *argv[])
222 printf("Invalid 'sta' command - exactly one argument, STA "
223 "address, is required.\n");
226 snprintf(buf, sizeof(buf), "STA %s", argv[0]);
227 return wpa_ctrl_command(ctrl, buf);
231 static int hostapd_cli_cmd_new_sta(struct wpa_ctrl *ctrl, int argc,
236 printf("Invalid 'new_sta' command - exactly one argument, STA "
237 "address, is required.\n");
240 snprintf(buf, sizeof(buf), "NEW_STA %s", argv[0]);
241 return wpa_ctrl_command(ctrl, buf);
245 #ifdef CONFIG_IEEE80211W
246 static int hostapd_cli_cmd_sa_query(struct wpa_ctrl *ctrl, int argc,
251 printf("Invalid 'sa_query' command - exactly one argument, "
252 "STA address, is required.\n");
255 snprintf(buf, sizeof(buf), "SA_QUERY %s", argv[0]);
256 return wpa_ctrl_command(ctrl, buf);
258 #endif /* CONFIG_IEEE80211W */
262 static int hostapd_cli_cmd_wps_pin(struct wpa_ctrl *ctrl, int argc,
267 printf("Invalid 'wps_pin' command - exactly two arguments, "
268 "UUID and PIN, are required.\n");
271 snprintf(buf, sizeof(buf), "WPS_PIN %s %s", argv[0], argv[1]);
272 return wpa_ctrl_command(ctrl, buf);
276 static int hostapd_cli_cmd_wps_pbc(struct wpa_ctrl *ctrl, int argc,
279 return wpa_ctrl_command(ctrl, "WPS_PBC");
283 #ifdef CONFIG_WPS_OOB
284 static int hostapd_cli_cmd_wps_oob(struct wpa_ctrl *ctrl, int argc,
291 printf("Invalid WPS_OOB command: need three arguments:\n"
292 "- OOB_DEV_TYPE: use 'ufd'\n"
293 "- OOB_PATH: path of OOB device like '/mnt'\n"
294 "- OOB_METHOD: OOB method 'pin-e' or 'pin-r', "
299 res = os_snprintf(cmd, sizeof(cmd), "WPS_OOB %s %s %s",
300 argv[0], argv[1], argv[2]);
301 if (res < 0 || (size_t) res >= sizeof(cmd) - 1) {
302 printf("Too long WPS_OOB command.\n");
305 return wpa_ctrl_command(ctrl, cmd);
307 #endif /* CONFIG_WPS_OOB */
308 #endif /* CONFIG_WPS */
311 static int wpa_ctrl_command_sta(struct wpa_ctrl *ctrl, char *cmd,
312 char *addr, size_t addr_len)
314 char buf[4096], *pos;
318 if (ctrl_conn == NULL) {
319 printf("Not connected to hostapd - command dropped.\n");
322 len = sizeof(buf) - 1;
323 ret = wpa_ctrl_request(ctrl, cmd, strlen(cmd), buf, &len,
326 printf("'%s' command timed out.\n", cmd);
328 } else if (ret < 0) {
329 printf("'%s' command failed.\n", cmd);
334 if (memcmp(buf, "FAIL", 4) == 0)
339 while (*pos != '\0' && *pos != '\n')
342 os_strlcpy(addr, buf, addr_len);
347 static int hostapd_cli_cmd_all_sta(struct wpa_ctrl *ctrl, int argc,
350 char addr[32], cmd[64];
352 if (wpa_ctrl_command_sta(ctrl, "STA-FIRST", addr, sizeof(addr)))
355 snprintf(cmd, sizeof(cmd), "STA-NEXT %s", addr);
356 } while (wpa_ctrl_command_sta(ctrl, cmd, addr, sizeof(addr)) == 0);
362 static int hostapd_cli_cmd_help(struct wpa_ctrl *ctrl, int argc, char *argv[])
364 printf("%s", commands_help);
369 static int hostapd_cli_cmd_license(struct wpa_ctrl *ctrl, int argc,
372 printf("%s\n\n%s\n", hostapd_cli_version, hostapd_cli_full_license);
377 static int hostapd_cli_cmd_quit(struct wpa_ctrl *ctrl, int argc, char *argv[])
379 hostapd_cli_quit = 1;
384 static int hostapd_cli_cmd_level(struct wpa_ctrl *ctrl, int argc, char *argv[])
388 printf("Invalid LEVEL command: needs one argument (debug "
392 snprintf(cmd, sizeof(cmd), "LEVEL %s", argv[0]);
393 return wpa_ctrl_command(ctrl, cmd);
397 static void hostapd_cli_list_interfaces(struct wpa_ctrl *ctrl)
402 dir = opendir(ctrl_iface_dir);
404 printf("Control interface directory '%s' could not be "
405 "openned.\n", ctrl_iface_dir);
409 printf("Available interfaces:\n");
410 while ((dent = readdir(dir))) {
411 if (strcmp(dent->d_name, ".") == 0 ||
412 strcmp(dent->d_name, "..") == 0)
414 printf("%s\n", dent->d_name);
420 static int hostapd_cli_cmd_interface(struct wpa_ctrl *ctrl, int argc,
424 hostapd_cli_list_interfaces(ctrl);
428 hostapd_cli_close_connection();
430 ctrl_ifname = strdup(argv[0]);
432 if (hostapd_cli_open_connection(ctrl_ifname)) {
433 printf("Connected to interface '%s.\n", ctrl_ifname);
434 if (wpa_ctrl_attach(ctrl_conn) == 0) {
435 hostapd_cli_attached = 1;
437 printf("Warning: Failed to attach to "
441 printf("Could not connect to interface '%s' - re-trying\n",
448 struct hostapd_cli_cmd {
450 int (*handler)(struct wpa_ctrl *ctrl, int argc, char *argv[]);
453 static struct hostapd_cli_cmd hostapd_cli_commands[] = {
454 { "ping", hostapd_cli_cmd_ping },
455 { "mib", hostapd_cli_cmd_mib },
456 { "sta", hostapd_cli_cmd_sta },
457 { "all_sta", hostapd_cli_cmd_all_sta },
458 { "new_sta", hostapd_cli_cmd_new_sta },
459 #ifdef CONFIG_IEEE80211W
460 { "sa_query", hostapd_cli_cmd_sa_query },
461 #endif /* CONFIG_IEEE80211W */
463 { "wps_pin", hostapd_cli_cmd_wps_pin },
464 { "wps_pbc", hostapd_cli_cmd_wps_pbc },
465 #ifdef CONFIG_WPS_OOB
466 { "wps_oob", hostapd_cli_cmd_wps_oob },
467 #endif /* CONFIG_WPS_OOB */
468 #endif /* CONFIG_WPS */
469 { "help", hostapd_cli_cmd_help },
470 { "interface", hostapd_cli_cmd_interface },
471 { "level", hostapd_cli_cmd_level },
472 { "license", hostapd_cli_cmd_license },
473 { "quit", hostapd_cli_cmd_quit },
478 static void wpa_request(struct wpa_ctrl *ctrl, int argc, char *argv[])
480 struct hostapd_cli_cmd *cmd, *match = NULL;
484 cmd = hostapd_cli_commands;
486 if (strncasecmp(cmd->cmd, argv[0], strlen(argv[0])) == 0) {
494 printf("Ambiguous command '%s'; possible commands:", argv[0]);
495 cmd = hostapd_cli_commands;
497 if (strncasecmp(cmd->cmd, argv[0], strlen(argv[0])) ==
499 printf(" %s", cmd->cmd);
504 } else if (count == 0) {
505 printf("Unknown command '%s'\n", argv[0]);
507 match->handler(ctrl, argc - 1, &argv[1]);
512 static void hostapd_cli_recv_pending(struct wpa_ctrl *ctrl, int in_read)
515 if (ctrl_conn == NULL)
517 while (wpa_ctrl_pending(ctrl)) {
519 size_t len = sizeof(buf) - 1;
520 if (wpa_ctrl_recv(ctrl, buf, &len) == 0) {
522 if (in_read && first)
527 printf("Could not read pending message.\n");
534 static void hostapd_cli_interactive(void)
536 const int max_args = 10;
537 char cmd[256], *res, *argv[max_args], *pos;
540 printf("\nInteractive mode\n\n");
543 hostapd_cli_recv_pending(ctrl_conn, 0);
545 alarm(ping_interval);
546 res = fgets(cmd, sizeof(cmd), stdin);
551 while (*pos != '\0') {
567 if (argc == max_args)
569 while (*pos != '\0' && *pos != ' ')
575 wpa_request(ctrl_conn, argc, argv);
576 } while (!hostapd_cli_quit);
580 static void hostapd_cli_terminate(int sig)
582 hostapd_cli_close_connection();
587 static void hostapd_cli_alarm(int sig)
589 if (ctrl_conn && _wpa_ctrl_command(ctrl_conn, "PING", 0)) {
590 printf("Connection to hostapd lost - trying to reconnect\n");
591 hostapd_cli_close_connection();
594 ctrl_conn = hostapd_cli_open_connection(ctrl_ifname);
596 printf("Connection to hostapd re-established\n");
597 if (wpa_ctrl_attach(ctrl_conn) == 0) {
598 hostapd_cli_attached = 1;
600 printf("Warning: Failed to attach to "
606 hostapd_cli_recv_pending(ctrl_conn, 1);
607 alarm(ping_interval);
611 int main(int argc, char *argv[])
614 int warning_displayed = 0;
618 c = getopt(argc, argv, "hG:i:p:v");
623 ping_interval = atoi(optarg);
629 printf("%s\n", hostapd_cli_version);
633 ctrl_ifname = strdup(optarg);
636 ctrl_iface_dir = optarg;
644 interactive = argc == optind;
647 printf("%s\n\n%s\n\n", hostapd_cli_version,
648 hostapd_cli_license);
652 if (ctrl_ifname == NULL) {
654 DIR *dir = opendir(ctrl_iface_dir);
656 while ((dent = readdir(dir))) {
657 if (strcmp(dent->d_name, ".") == 0 ||
658 strcmp(dent->d_name, "..") == 0)
660 printf("Selected interface '%s'\n",
662 ctrl_ifname = strdup(dent->d_name);
668 ctrl_conn = hostapd_cli_open_connection(ctrl_ifname);
670 if (warning_displayed)
671 printf("Connection established.\n");
676 perror("Failed to connect to hostapd - "
681 if (!warning_displayed) {
682 printf("Could not connect to hostapd - re-trying\n");
683 warning_displayed = 1;
689 signal(SIGINT, hostapd_cli_terminate);
690 signal(SIGTERM, hostapd_cli_terminate);
691 signal(SIGALRM, hostapd_cli_alarm);
694 if (wpa_ctrl_attach(ctrl_conn) == 0) {
695 hostapd_cli_attached = 1;
697 printf("Warning: Failed to attach to hostapd.\n");
699 hostapd_cli_interactive();
701 wpa_request(ctrl_conn, argc - optind, &argv[optind]);
704 hostapd_cli_close_connection();