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"
92 #endif /* CONFIG_WPS */
93 " help show this usage help\n"
94 " interface [ifname] show interfaces/select interface\n"
95 " level <debug level> change debug level\n"
96 " license show full hostapd_cli license\n"
97 " quit exit hostapd_cli\n";
99 static struct wpa_ctrl *ctrl_conn;
100 static int hostapd_cli_quit = 0;
101 static int hostapd_cli_attached = 0;
102 static const char *ctrl_iface_dir = "/var/run/hostapd";
103 static char *ctrl_ifname = NULL;
106 static void usage(void)
108 fprintf(stderr, "%s\n", hostapd_cli_version);
111 "usage: hostapd_cli [-p<path>] [-i<ifname>] [-hv] "
115 " -h help (show this usage text)\n"
116 " -v shown version information\n"
117 " -p<path> path to find control sockets (default: "
118 "/var/run/hostapd)\n"
119 " -i<ifname> Interface to listen on (default: first "
120 "interface found in the\n"
127 static struct wpa_ctrl * hostapd_cli_open_connection(const char *ifname)
135 flen = strlen(ctrl_iface_dir) + strlen(ifname) + 2;
136 cfile = malloc(flen);
139 snprintf(cfile, flen, "%s/%s", ctrl_iface_dir, ifname);
141 ctrl_conn = wpa_ctrl_open(cfile);
147 static void hostapd_cli_close_connection(void)
149 if (ctrl_conn == NULL)
152 if (hostapd_cli_attached) {
153 wpa_ctrl_detach(ctrl_conn);
154 hostapd_cli_attached = 0;
156 wpa_ctrl_close(ctrl_conn);
161 static void hostapd_cli_msg_cb(char *msg, size_t len)
167 static int _wpa_ctrl_command(struct wpa_ctrl *ctrl, char *cmd, int print)
173 if (ctrl_conn == NULL) {
174 printf("Not connected to hostapd - command dropped.\n");
177 len = sizeof(buf) - 1;
178 ret = wpa_ctrl_request(ctrl, cmd, strlen(cmd), buf, &len,
181 printf("'%s' command timed out.\n", cmd);
183 } else if (ret < 0) {
184 printf("'%s' command failed.\n", cmd);
195 static inline int wpa_ctrl_command(struct wpa_ctrl *ctrl, char *cmd)
197 return _wpa_ctrl_command(ctrl, cmd, 1);
201 static int hostapd_cli_cmd_ping(struct wpa_ctrl *ctrl, int argc, char *argv[])
203 return wpa_ctrl_command(ctrl, "PING");
207 static int hostapd_cli_cmd_mib(struct wpa_ctrl *ctrl, int argc, char *argv[])
209 return wpa_ctrl_command(ctrl, "MIB");
213 static int hostapd_cli_cmd_sta(struct wpa_ctrl *ctrl, int argc, char *argv[])
217 printf("Invalid 'sta' command - exactly one argument, STA "
218 "address, is required.\n");
221 snprintf(buf, sizeof(buf), "STA %s", argv[0]);
222 return wpa_ctrl_command(ctrl, buf);
226 static int hostapd_cli_cmd_new_sta(struct wpa_ctrl *ctrl, int argc,
231 printf("Invalid 'new_sta' command - exactly one argument, STA "
232 "address, is required.\n");
235 snprintf(buf, sizeof(buf), "NEW_STA %s", argv[0]);
236 return wpa_ctrl_command(ctrl, buf);
240 #ifdef CONFIG_IEEE80211W
241 static int hostapd_cli_cmd_sa_query(struct wpa_ctrl *ctrl, int argc,
246 printf("Invalid 'sa_query' command - exactly one argument, "
247 "STA address, is required.\n");
250 snprintf(buf, sizeof(buf), "SA_QUERY %s", argv[0]);
251 return wpa_ctrl_command(ctrl, buf);
253 #endif /* CONFIG_IEEE80211W */
257 static int hostapd_cli_cmd_wps_pin(struct wpa_ctrl *ctrl, int argc,
262 printf("Invalid 'wps_pin' command - exactly two arguments, "
263 "UUID and PIN, are required.\n");
266 snprintf(buf, sizeof(buf), "WPS_PIN %s %s", argv[0], argv[1]);
267 return wpa_ctrl_command(ctrl, buf);
271 static int hostapd_cli_cmd_wps_pbc(struct wpa_ctrl *ctrl, int argc,
274 return wpa_ctrl_command(ctrl, "WPS_PBC");
276 #endif /* CONFIG_WPS */
279 static int wpa_ctrl_command_sta(struct wpa_ctrl *ctrl, char *cmd,
280 char *addr, size_t addr_len)
282 char buf[4096], *pos;
286 if (ctrl_conn == NULL) {
287 printf("Not connected to hostapd - command dropped.\n");
290 len = sizeof(buf) - 1;
291 ret = wpa_ctrl_request(ctrl, cmd, strlen(cmd), buf, &len,
294 printf("'%s' command timed out.\n", cmd);
296 } else if (ret < 0) {
297 printf("'%s' command failed.\n", cmd);
302 if (memcmp(buf, "FAIL", 4) == 0)
307 while (*pos != '\0' && *pos != '\n')
310 os_strlcpy(addr, buf, addr_len);
315 static int hostapd_cli_cmd_all_sta(struct wpa_ctrl *ctrl, int argc,
318 char addr[32], cmd[64];
320 if (wpa_ctrl_command_sta(ctrl, "STA-FIRST", addr, sizeof(addr)))
323 snprintf(cmd, sizeof(cmd), "STA-NEXT %s", addr);
324 } while (wpa_ctrl_command_sta(ctrl, cmd, addr, sizeof(addr)) == 0);
330 static int hostapd_cli_cmd_help(struct wpa_ctrl *ctrl, int argc, char *argv[])
332 printf("%s", commands_help);
337 static int hostapd_cli_cmd_license(struct wpa_ctrl *ctrl, int argc,
340 printf("%s\n\n%s\n", hostapd_cli_version, hostapd_cli_full_license);
345 static int hostapd_cli_cmd_quit(struct wpa_ctrl *ctrl, int argc, char *argv[])
347 hostapd_cli_quit = 1;
352 static int hostapd_cli_cmd_level(struct wpa_ctrl *ctrl, int argc, char *argv[])
356 printf("Invalid LEVEL command: needs one argument (debug "
360 snprintf(cmd, sizeof(cmd), "LEVEL %s", argv[0]);
361 return wpa_ctrl_command(ctrl, cmd);
365 static void hostapd_cli_list_interfaces(struct wpa_ctrl *ctrl)
370 dir = opendir(ctrl_iface_dir);
372 printf("Control interface directory '%s' could not be "
373 "openned.\n", ctrl_iface_dir);
377 printf("Available interfaces:\n");
378 while ((dent = readdir(dir))) {
379 if (strcmp(dent->d_name, ".") == 0 ||
380 strcmp(dent->d_name, "..") == 0)
382 printf("%s\n", dent->d_name);
388 static int hostapd_cli_cmd_interface(struct wpa_ctrl *ctrl, int argc,
392 hostapd_cli_list_interfaces(ctrl);
396 hostapd_cli_close_connection();
398 ctrl_ifname = strdup(argv[0]);
400 if (hostapd_cli_open_connection(ctrl_ifname)) {
401 printf("Connected to interface '%s.\n", ctrl_ifname);
402 if (wpa_ctrl_attach(ctrl_conn) == 0) {
403 hostapd_cli_attached = 1;
405 printf("Warning: Failed to attach to "
409 printf("Could not connect to interface '%s' - re-trying\n",
416 struct hostapd_cli_cmd {
418 int (*handler)(struct wpa_ctrl *ctrl, int argc, char *argv[]);
421 static struct hostapd_cli_cmd hostapd_cli_commands[] = {
422 { "ping", hostapd_cli_cmd_ping },
423 { "mib", hostapd_cli_cmd_mib },
424 { "sta", hostapd_cli_cmd_sta },
425 { "all_sta", hostapd_cli_cmd_all_sta },
426 { "new_sta", hostapd_cli_cmd_new_sta },
427 #ifdef CONFIG_IEEE80211W
428 { "sa_query", hostapd_cli_cmd_sa_query },
429 #endif /* CONFIG_IEEE80211W */
431 { "wps_pin", hostapd_cli_cmd_wps_pin },
432 { "wps_pbc", hostapd_cli_cmd_wps_pbc },
433 #endif /* CONFIG_WPS */
434 { "help", hostapd_cli_cmd_help },
435 { "interface", hostapd_cli_cmd_interface },
436 { "level", hostapd_cli_cmd_level },
437 { "license", hostapd_cli_cmd_license },
438 { "quit", hostapd_cli_cmd_quit },
443 static void wpa_request(struct wpa_ctrl *ctrl, int argc, char *argv[])
445 struct hostapd_cli_cmd *cmd, *match = NULL;
449 cmd = hostapd_cli_commands;
451 if (strncasecmp(cmd->cmd, argv[0], strlen(argv[0])) == 0) {
459 printf("Ambiguous command '%s'; possible commands:", argv[0]);
460 cmd = hostapd_cli_commands;
462 if (strncasecmp(cmd->cmd, argv[0], strlen(argv[0])) ==
464 printf(" %s", cmd->cmd);
469 } else if (count == 0) {
470 printf("Unknown command '%s'\n", argv[0]);
472 match->handler(ctrl, argc - 1, &argv[1]);
477 static void hostapd_cli_recv_pending(struct wpa_ctrl *ctrl, int in_read)
480 if (ctrl_conn == NULL)
482 while (wpa_ctrl_pending(ctrl)) {
484 size_t len = sizeof(buf) - 1;
485 if (wpa_ctrl_recv(ctrl, buf, &len) == 0) {
487 if (in_read && first)
492 printf("Could not read pending message.\n");
499 static void hostapd_cli_interactive(void)
501 const int max_args = 10;
502 char cmd[256], *res, *argv[max_args], *pos;
505 printf("\nInteractive mode\n\n");
508 hostapd_cli_recv_pending(ctrl_conn, 0);
511 res = fgets(cmd, sizeof(cmd), stdin);
516 while (*pos != '\0') {
532 if (argc == max_args)
534 while (*pos != '\0' && *pos != ' ')
540 wpa_request(ctrl_conn, argc, argv);
541 } while (!hostapd_cli_quit);
545 static void hostapd_cli_terminate(int sig)
547 hostapd_cli_close_connection();
552 static void hostapd_cli_alarm(int sig)
554 if (ctrl_conn && _wpa_ctrl_command(ctrl_conn, "PING", 0)) {
555 printf("Connection to hostapd lost - trying to reconnect\n");
556 hostapd_cli_close_connection();
559 ctrl_conn = hostapd_cli_open_connection(ctrl_ifname);
561 printf("Connection to hostapd re-established\n");
562 if (wpa_ctrl_attach(ctrl_conn) == 0) {
563 hostapd_cli_attached = 1;
565 printf("Warning: Failed to attach to "
571 hostapd_cli_recv_pending(ctrl_conn, 1);
576 int main(int argc, char *argv[])
579 int warning_displayed = 0;
583 c = getopt(argc, argv, "hi:p:v");
591 printf("%s\n", hostapd_cli_version);
595 ctrl_ifname = strdup(optarg);
598 ctrl_iface_dir = optarg;
606 interactive = argc == optind;
609 printf("%s\n\n%s\n\n", hostapd_cli_version,
610 hostapd_cli_license);
614 if (ctrl_ifname == NULL) {
616 DIR *dir = opendir(ctrl_iface_dir);
618 while ((dent = readdir(dir))) {
619 if (strcmp(dent->d_name, ".") == 0 ||
620 strcmp(dent->d_name, "..") == 0)
622 printf("Selected interface '%s'\n",
624 ctrl_ifname = strdup(dent->d_name);
630 ctrl_conn = hostapd_cli_open_connection(ctrl_ifname);
632 if (warning_displayed)
633 printf("Connection established.\n");
638 perror("Failed to connect to hostapd - "
643 if (!warning_displayed) {
644 printf("Could not connect to hostapd - re-trying\n");
645 warning_displayed = 1;
651 signal(SIGINT, hostapd_cli_terminate);
652 signal(SIGTERM, hostapd_cli_terminate);
653 signal(SIGALRM, hostapd_cli_alarm);
656 if (wpa_ctrl_attach(ctrl_conn) == 0) {
657 hostapd_cli_attached = 1;
659 printf("Warning: Failed to attach to hostapd.\n");
661 hostapd_cli_interactive();
663 wpa_request(ctrl_conn, argc - optind, &argv[optind]);
666 hostapd_cli_close_connection();