3 * $Id: admin.c,v 1.1 2001/02/03 20:26:37 mdw Exp $
5 * Admin interface for configuration
7 * (c) 2001 Straylight/Edgeware
10 /*----- Licensing notice --------------------------------------------------*
12 * This file is part of Trivial IP Encryption (TrIPE).
14 * TrIPE is free software; you can redistribute it and/or modify
15 * it under the terms of the GNU General Public License as published by
16 * the Free Software Foundation; either version 2 of the License, or
17 * (at your option) any later version.
19 * TrIPE is distributed in the hope that it will be useful,
20 * but WITHOUT ANY WARRANTY; without even the implied warranty of
21 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 * GNU General Public License for more details.
24 * You should have received a copy of the GNU General Public License
25 * along with TrIPE; if not, write to the Free Software Foundation,
26 * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
29 /*----- Revision history --------------------------------------------------*
32 * Revision 1.1 2001/02/03 20:26:37 mdw
37 /*----- Header files ------------------------------------------------------*/
41 /*----- Global variables --------------------------------------------------*/
45 const trace_opt tr_opts[] = {
46 { 't', T_TUNNEL, "tunnel events" },
47 { 'r', T_PEER, "peer events" },
48 { 'a', T_ADMIN, "admin interface" },
49 { 'p', T_PACKET, "packet contents" },
50 { 'c', T_CRYPTO, "crypto details" },
51 { 's', T_KEYSET, "symmetric keyset management" },
52 { 'x', T_KEYEXCH, "key exchange" },
53 { 'm', T_KEYMGMT, "key management" },
54 { 'A', T_ALL, "all of the above" },
58 unsigned tr_flags = 0;
61 /*----- Static variables --------------------------------------------------*/
65 static const char *sockname;
66 static unsigned flags = 0;
67 static admin *a_stdin = 0;
68 static sig s_term, s_int, s_hup;
73 #define T_RESOLVE SEC(30)
75 /*----- Utility functions -------------------------------------------------*/
77 /* --- @a_write@ --- *
79 * Arguments: @admin *a@ = admin connection to write to
80 * @const char *fmt@ = pointer to format string
81 * @...@ = other arguments
85 * Use: Sends a message to an admin connection.
88 static void a_write(admin *a, const char *fmt, ...)
93 dstr_vputf(&d, fmt, ap);
95 write(a->fd, d.buf, d.len);
101 * Arguments: @const char *fmt@ = pointer to format string
102 * @...@ = other arguments
106 * Use: Informs all admin connections of a warning.
109 void a_warn(const char *fmt, ...)
116 dstr_puts(&d, "WARN ");
118 dstr_vputf(&d, fmt, ap);
120 if (!(flags & F_INIT))
124 for (a = admins; a; a = a->next)
125 write(a->fd, d.buf, d.len);
130 /* --- @a_trace@ --- *
132 * Arguments: @const char *p@ = pointer to a buffer
133 * @size_t sz@ = size of the buffer
134 * @void *v@ = uninteresting pointer
138 * Use: Custom trace output handler.
142 static void a_trace(const char *p, size_t sz, void *v)
147 dstr_puts(&d, "TRACE ");
148 dstr_putm(&d, p, sz);
150 for (a = admins; a; a = a->next)
151 write(a->fd, d.buf, d.len);
156 /* --- @a_quit@ --- *
162 * Use: Shuts things down nicely.
172 /* --- @a_sigdie@ --- *
174 * Arguments: @int sig@ = signal number
175 * @void *v@ = an uninteresting argument
179 * Use Shuts down on receipt of a fatal signal.
182 static void a_sigdie(int sig, void *v)
188 case SIGTERM: p = "SIGTERM"; break;
189 case SIGINT: p = "SIGINT"; break;
191 sprintf(buf, "signal %i", sig);
195 a_warn("shutting down on %s", p);
199 /* --- @a_sighup@ --- *
201 * Arguments: @int sig@ = signal number
202 * @void *v@ = an uninteresting argument
206 * Use Logs a message about SIGHUP not being useful.
209 static void a_sighup(int sig, void *v)
211 a_warn("received SIGHUP: ignoring");
214 /*----- Adding peers ------------------------------------------------------*/
216 /* --- @a_resolve@ --- *
218 * Arguments: @struct hostent *h@ = pointer to resolved hostname
219 * @void *v@ = pointer to admin block
223 * Use: Handles a completed name resolution.
226 static void a_resolve(struct hostent *h, void *v)
229 T( trace(T_ADMIN, "admin: %u resolved", a->seq); )
232 a_write(a, "ERR couldn't resolve hostname `%s'\n", a->paddr);
233 else if (p_find(a->pname))
234 a_write(a, "ERR peer `%s' already registered\n", a->pname);
236 memcpy(&a->peer.sin.sin_addr, h->h_addr, sizeof(struct in_addr));
237 if (!p_create(a->pname, &a->peer.sa, a->sasz))
238 a_write(a, "ERR couldn't create peer\n");
245 selbuf_enable(&a->b);
248 /* --- @a_timer@ --- *
250 * Arguments: @struct timeval *tv@ = timer
251 * @void *v@ = pointer to admin block
255 * Use: Times out a resolver.
258 static void a_timer(struct timeval *tv, void *v)
261 T( trace(T_ADMIN, "admin: %u resolver timeout", a->seq); )
263 a_write(a, "ERR timeout resolving `%s'\n", a->paddr);
267 selbuf_enable(&a->b);
270 /* --- @acmd_add@ --- *
272 * Arguments: @admin *a@ = connection which requested the addition
273 * @unsigned ac@ = argument count
274 * @char *av[]@ = pointer to the argument list
278 * Use: Adds a new peer.
281 static void acmd_add(admin *a, unsigned ac, char *av[])
287 /* --- Make sure someone's not got there already --- */
290 a_write(a, "ERR peer `%s' already registered\n", av[0]);
294 /* --- Fill in the easy bits of address --- */
297 a->peer.sin.sin_family = AF_INET;
298 a->sasz = sizeof(a->peer.sin);
299 pt = strtoul(av[2], &p, 0);
301 struct servent *s = getservbyname(av[2], "udp");
303 a_write(a, "ERR service `%s' not known\n", av[2]);
306 pt = ntohs(s->s_port);
308 if (pt == 0 || pt >= 65536) {
309 a_write(a, "ERR bad port number %lu\n", pt);
312 a->peer.sin.sin_port = htons(pt);
314 /* --- If the name is numeric, do it the easy way --- */
316 if (inet_aton(av[1], &a->peer.sin.sin_addr)) {
317 if (!p_create(av[0], &a->peer.sa, a->sasz))
318 a_write(a, "ERR couldn't create peer\n");
324 /* --- Store everything for later and crank up the resolver --- *
326 * We disable the line buffer until the resolver completes (or times out).
327 * This prevents other commands on the same connection (though the rest of
328 * the system continues regardless), but makes life simpler for the client.
331 a->pname = xstrdup(av[0]);
332 a->paddr = xstrdup(av[1]);
333 selbuf_disable(&a->b);
334 gettimeofday(&tv, 0);
335 tv.tv_sec += T_RESOLVE;
336 sel_addtimer(&sel, &a->t, &tv, a_timer, a);
337 bres_byname(&a->r, a->paddr, a_resolve, a);
338 T( trace(T_ADMIN, "admin: %u resolving hostname `%s'",
342 /*----- Administration commands -------------------------------------------*/
344 /* --- Miscellaneous commands --- */
348 static void acmd_trace(admin *a, unsigned ac, char *av[])
350 if (!ac || strcmp(av[0], "?") == 0) {
352 a_write(a, "INFO Trace options:\n");
353 for (t = tr_opts; t->ch; t++) {
354 a_write(a, "INFO %c %c %s\n",
355 t->ch, (tr_flags & t->f) == t->f ? '*' : ' ', t->help);
359 unsigned f = tr_flags;
365 case '+': sense = 1; break;
366 case '-': sense = 0; break;
368 for (tt = tr_opts; tt->ch; tt++) {
370 if (sense) f |= tt->f;
375 a_write(a, "ERR unknown trace option `%c'\n", *p);
383 trace_level(tr_flags);
390 static void acmd_port(admin *a, unsigned ac, char *av[])
392 a_write(a, "INFO %u\nOK\n", p_port());
395 static void a_destroy(admin */*a*/);
397 static void acmd_daemon(admin *a, unsigned ac, char *av[])
399 if (flags & F_DAEMON)
400 a_write(a, "ERR already running as a daemon\n");
403 a_write(a_stdin, "WARN becoming a daemon\n");
407 a_write(a, "ERR error becoming a daemon: %s", strerror(errno));
413 static void acmd_list(admin *a, unsigned ac, char *av[])
416 for (p = p_first(); p; p = p_next(p))
417 a_write(a, "INFO %s\n", p_name(p));
421 static void acmd_ifname(admin *a, unsigned ac, char *av[])
425 if ((p = p_find(av[0])) == 0)
426 a_write(a, "ERR peer `%s' not found\n", av[0]);
428 a_write(a, "INFO %s\nOK\n", p_ifname(p));
431 static void acmd_addr(admin *a, unsigned ac, char *av[])
436 if ((p = p_find(av[0])) == 0)
437 a_write(a, "ERR peer `%s' not found\n", av[0]);
440 assert(ad->sa.sa_family == AF_INET);
441 a_write(a, "INFO %s %u\nOK\n",
442 inet_ntoa(ad->sin.sin_addr),
443 (unsigned)ntohs(ad->sin.sin_port));
447 static void acmd_kill(admin *a, unsigned ac, char *av[])
450 if ((p = p_find(av[0])) == 0)
451 a_write(a, "ERR peer `%s' not found\n", av[0]);
458 static void acmd_quit(admin *a, unsigned ac, char *av[])
460 a_warn("closing down on admin request");
464 /* --- The command table and help --- */
466 typedef struct acmd {
469 unsigned argmin, argmax;
470 void (*func)(admin */*a*/, unsigned /*ac*/, char */*av*/[]);
473 static void acmd_help(admin */*a*/, unsigned /*ac*/, char */*av*/[]);
475 static const acmd acmdtab[] = {
476 { "help", "HELP", 0, 0, acmd_help },
478 { "trace", "TRACE [options]", 0, 1, acmd_trace },
480 { "port", "PORT", 0, 0, acmd_port },
481 { "daemon", "DAEMON", 0, 0, acmd_daemon },
482 { "list", "LIST", 0, 0, acmd_list },
483 { "ifname", "IFNAME peer", 1, 1, acmd_ifname },
484 { "addr", "ADDR peer", 1, 1, acmd_addr },
485 { "kill", "KILL peer", 1, 1, acmd_kill },
486 { "add", "ADD peer addr port", 3, 3, acmd_add },
487 { "quit", "QUIT", 0, 0, acmd_quit },
491 static void acmd_help(admin *a, unsigned ac, char *av[])
494 for (c = acmdtab; c->name; c++)
495 a_write(a, "INFO %s\n", c->help);
499 /*----- Connection handling -----------------------------------------------*/
501 /* --- @a_destroy@ --- *
503 * Arguments: @admin *a@ = pointer to an admin block
507 * Use: Destroys an admin block.
510 static void a_destroy(admin *a)
512 T( trace(T_ADMIN, "admin: destroying connection %u", a->seq); )
513 selbuf_destroy(&a->b);
514 if (a->b.reader.fd != a->fd)
515 close(a->b.reader.fd);
524 a->next->prev = a->prev;
526 a->prev->next = a->next;
534 /* --- @a_line@ --- *
536 * Arguments: @char *p@ = pointer to the line read
537 * @void *vp@ = pointer to my admin block
541 * Use: Handles a line of input.
544 static void a_line(char *p, void *vp)
555 ac = str_qsplit(p, av, 4, 0, STRF_QUOTE);
558 for (p = av[0]; *p; p++) *p = tolower((unsigned char)*p);
559 for (c = acmdtab; c->name; c++) {
560 if (strcmp(av[0], c->name) == 0) {
562 if (c->argmin > ac || ac > c->argmax)
563 a_write(a, "ERR syntax: %s\n", c->help);
565 c->func(a, ac, av + 1);
569 a_write(a, "ERR unknown command `%s'\n", av[0]);
572 /* --- @a_create@ --- *
574 * Arguments: @int fd_in, fd_out@ = file descriptors to use
578 * Use: Creates a new admin connection.
581 void a_create(int fd_in, int fd_out)
583 admin *a = CREATE(admin);
584 T( static unsigned seq = 0; )
586 T( trace(T_ADMIN, "admin: accepted connection %u", a->seq); )
588 if (fd_in == STDIN_FILENO)
590 fdflags(fd_in, O_NONBLOCK, O_NONBLOCK, FD_CLOEXEC, FD_CLOEXEC);
592 fdflags(fd_out, O_NONBLOCK, O_NONBLOCK, FD_CLOEXEC, FD_CLOEXEC);
594 selbuf_init(&a->b, &sel, fd_in, a_line, a);
602 /* --- @a_accept@ --- *
604 * Arguments: @int fd@ = file descriptor to accept
605 * @unsigned mode@ = what to do
606 * @void *v@ = uninteresting pointer
610 * Use: Accepts a new admin connection.
613 static void a_accept(int fd, unsigned mode, void *v)
616 struct sockaddr_un sun;
617 size_t sz = sizeof(sun);
619 if ((nfd = accept(fd, (struct sockaddr *)&sun, &sz)) < 0) {
620 a_warn("accept admin connection failed: %s", strerror(errno));
626 /* --- @a_daemon@ --- *
632 * Use: Informs the admin module that it's a daemon.
640 /* --- @a_init@ --- *
642 * Arguments: @const char *name@ = socket name to create
646 * Use: Creates the admin listening socket.
649 void a_init(const char *name)
653 struct sockaddr_un sun;
657 /* --- Set up the socket address --- */
659 sz = strlen(name) + 1;
660 if (sz > sizeof(sun.sun_path))
661 die(EXIT_FAILURE, "socket name `%s' too long", name);
663 sun.sun_family = AF_UNIX;
664 memcpy(sun.sun_path, name, sz);
665 sz += offsetof(struct sockaddr_un, sun_path);
667 /* --- Attempt to bind to the socket --- */
671 if ((fd = socket(PF_UNIX, SOCK_STREAM, 0)) < 0)
672 die(EXIT_FAILURE, "couldn't create socket: %s", strerror(errno));
673 if (bind(fd, (struct sockaddr *)&sun, sz) < 0) {
676 if (errno != EADDRINUSE) {
677 die(EXIT_FAILURE, "couldn't bind to address `%s': %s",
678 sun.sun_path, strerror(e));
681 die(EXIT_FAILURE, "too many retries; giving up");
683 if (!connect(fd, (struct sockaddr *)&sun, sz)) {
684 die(EXIT_FAILURE, "server already listening on admin socket `%s'",
687 if (errno != ECONNREFUSED)
688 die(EXIT_FAILURE, "couldn't bind to address: %s", strerror(e));
689 if (stat(sun.sun_path, &st)) {
690 die(EXIT_FAILURE, "couldn't stat `%s': %s",
691 sun.sun_path, strerror(errno));
693 if (!S_ISSOCK(st.st_mode))
694 die(EXIT_FAILURE, "object `%s' isn't a socket", sun.sun_path);
695 T( trace(T_ADMIN, "stale socket found; removing it"); )
696 unlink(sun.sun_path);
700 chmod(sun.sun_path, 0600);
701 fdflags(fd, O_NONBLOCK, O_NONBLOCK, FD_CLOEXEC, FD_CLOEXEC);
703 die(EXIT_FAILURE, "couldn't listen on socket: %s", strerror(errno));
705 /* --- Listen to the socket --- */
707 sel_initfile(&sel, &sock, fd, SEL_READ, a_accept, 0);
711 T( trace_custom(a_trace, 0);
712 trace(T_ADMIN, "admin: enabled custom tracing"); )
715 /* --- Set up signal handlers --- */
717 sig_add(&s_term, SIGTERM, a_sigdie, 0);
718 sig_add(&s_hup, SIGHUP, a_sighup, 0);
719 sigaction(SIGINT, 0, &sa);
720 if (sa.sa_handler != SIG_IGN)
721 sig_add(&s_int, SIGINT, a_sigdie, 0);
724 /*----- That's all, folks -------------------------------------------------*/