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 /*----- Header files ------------------------------------------------------*/
33 /*----- Global variables --------------------------------------------------*/
37 const trace_opt tr_opts[] = {
38 { 't', T_TUNNEL, "tunnel events" },
39 { 'r', T_PEER, "peer events" },
40 { 'a', T_ADMIN, "admin interface" },
41 { 'p', T_PACKET, "packet contents" },
42 { 'c', T_CRYPTO, "crypto details" },
43 { 's', T_KEYSET, "symmetric keyset management" },
44 { 'x', T_KEYEXCH, "key exchange" },
45 { 'm', T_KEYMGMT, "key management" },
46 { 'A', T_ALL, "all of the above" },
50 unsigned tr_flags = 0;
53 static const trace_opt w_opts[] = {
54 { 't', AF_TRACE, "trace messages" },
55 { 'n', AF_NOTE, "asynchronous notifications" },
56 { 'w', AF_WARN, "warnings" },
57 { 'A', AF_ALLMSGS, "all of the above" },
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)
76 static void a_destroy(admin */*a*/);
77 static void a_lock(admin */*a*/);
78 static void a_unlock(admin */*a*/);
80 /*----- Output functions --------------------------------------------------*/
82 /* --- @trywrite@ --- *
84 * Arguments: @admin *a@ = pointer to an admin block
85 * @const char *p@ = pointer to buffer to write
86 * @size_t sz@ = size of data to write
88 * Returns: The number of bytes written, or less than zero on error.
90 * Use: Attempts to write data to a client.
93 static ssize_t trywrite(admin *a, const char *p, size_t sz)
100 n = write(a->w.fd, p, sz);
110 if (errno != EAGAIN && errno != EWOULDBLOCK) {
112 a_warn("ADMIN client-read-error -- %s", strerror(errno));
119 /* --- @doqueue@ -- *
121 * Arguments: @oqueue *q@ = pointer to output queue
122 * @const char *p@ = pointer to buffer to write
123 * @size_t sz@ = size of buffer
125 * Returns: Nonzero if the queue was previously empty.
127 * Use: Queues data to be written later.
130 static int doqueue(oqueue *q, const char *p, size_t sz)
139 else if (o->p_in < o->buf + OBUFSZ)
143 o = xmalloc(sizeof(obuf));
145 o->p_in = o->p_out = o->buf;
153 n = o->buf + OBUFSZ - o->p_in;
156 memcpy(o->p_in, p, n);
165 /* --- @dosend@ --- *
167 * Arguemnts: @admin *a@ = pointer to an admin block
168 * @const char *p@ = pointer to buffer to write
169 * @size_t sz@ = size of data to write
173 * Use: Sends data to an admin client.
176 static void dosend(admin *a, const char *p, size_t sz)
183 if ((n = trywrite(a, p, sz)) < 0)
190 if (doqueue(&a->out, p, sz))
194 /* --- @a_flush@ --- *
196 * Arguments: @int fd@ = file descriptor
197 * @unsigned mode@ = what's happening
198 * @void *v@ = pointer to my admin block
202 * Use: Flushes buffers when a client is ready to read again.
205 static void a_flush(int fd, unsigned mode, void *v)
213 if ((n = trywrite(a, o->p_out, o->p_in - o->p_out)) < 0)
216 if (o->p_in < o->p_out)
229 /*----- Utility functions -------------------------------------------------*/
231 /* --- @a_write@, @a_vwrite@ --- *
233 * Arguments: @admin *a@ = admin connection to write to
234 * @const char *status@ = status code to report
235 * @const char *tag@ = tag string, or null
236 * @const char *fmt@ = pointer to format string
237 * @va_list ap@ = arguments in list
238 * @...@ = other arguments
242 * Use: Sends a message to an admin connection.
245 static void a_vwrite(admin *a, const char *status, const char *tag,
246 const char *fmt, va_list ap)
250 if (tag) dstr_puts(&d, "BG");
251 dstr_puts(&d, status);
258 dstr_vputf(&d, fmt, &ap);
261 dosend(a, d.buf, d.len);
265 static void a_write(admin *a, const char *status, const char *tag,
266 const char *fmt, ...)
270 a_vwrite(a, status, tag, fmt, ap);
274 /* --- @a_ok@, @a_info@, @a_fail@ --- *
276 * Arguments: @admin *a@ = connection
277 * @const char *fmt@ = format string
278 * @...@ = other arguments
282 * Use: Convenience functions for @a_write@.
285 static void a_ok(admin *a) { a_write(a, "OK", 0, 0); }
287 static void a_info(admin *a, const char *fmt, ...)
291 a_vwrite(a, "INFO", 0, fmt, ap);
295 static void a_fail(admin *a, const char *fmt, ...)
299 a_vwrite(a, "FAIL", 0, fmt, ap);
303 /* --- @a_alert@, @a_valert@, @a_rawalert@ --- *
305 * Arguments: @unsigned f_and, f_eq@ = filter for connections
306 * @const char *status@ = status string
307 * @const char *fmt@ = pointer to format string
308 * @const char *p@ = pointer to raw string
309 * @size_t sz@ = size of raw string
310 * @va_list ap@ = arguments in list
311 * @...@ = other arguments
315 * Use: Write a message to all admin connections matched by the given
319 static void a_rawalert(unsigned f_and, unsigned f_eq, const char *status,
320 const char *p, size_t sz)
325 if (!(flags & F_INIT))
327 dstr_puts(&d, status);
330 dstr_putm(&d, p, sz);
335 for (a = admins; a; a = aa) {
337 if ((a->f & f_and) == f_eq)
338 dosend(a, d.buf, d.len);
343 static void a_valert(unsigned f_and, unsigned f_eq, const char *tag,
344 const char *fmt, va_list ap)
348 if (!(flags & F_INIT))
351 dstr_vputf(&d, fmt, &ap);
352 a_rawalert(f_and, f_eq, tag, fmt ? d.buf : 0, fmt ? d.len : 0);
357 static void a_alert(unsigned f_and, unsigned f_eq, const char *tag,
358 const char *fmt, ...)
362 a_valert(f_and, f_eq, tag, fmt, ap);
367 /* --- @a_warn@ --- *
369 * Arguments: @const char *fmt@ = pointer to format string
370 * @...@ = other arguments
374 * Use: Informs all admin connections of a warning.
377 void a_warn(const char *fmt, ...)
383 a_valert(0, 0, "WARN", fmt, ap);
385 fprintf(stderr, "%s: ", QUIS);
386 vfprintf(stderr, fmt, ap);
392 /* --- @a_trace@ --- *
394 * Arguments: @const char *p@ = pointer to a buffer
395 * @size_t sz@ = size of the buffer
396 * @void *v@ = uninteresting pointer
400 * Use: Custom trace output handler. Sends trace messages to
401 * interested admin connections.
405 static void a_trace(const char *p, size_t sz, void *v)
406 { a_rawalert(AF_TRACE, AF_TRACE, "TRACE", p, sz); }
409 /* --- @a_notify@ --- *
411 * Arguments: @const char *fmt@ = pointer to format string
412 * @...@ = other arguments
416 * Use: Sends a notification to interested admin connections.
419 void a_notify(const char *fmt, ...)
424 a_valert(AF_NOTE, AF_NOTE, "NOTE", fmt, ap);
428 /* --- @a_quit@ --- *
434 * Use: Shuts things down nicely.
443 while ((p = p_first()) != 0)
448 /* --- @a_sigdie@ --- *
450 * Arguments: @int sig@ = signal number
451 * @void *v@ = an uninteresting argument
455 * Use Shuts down on receipt of a fatal signal.
458 static void a_sigdie(int sig, void *v)
464 case SIGTERM: p = "SIGTERM"; break;
465 case SIGINT: p = "SIGINT"; break;
467 sprintf(buf, "%i", sig);
471 a_warn("SERVER quit signal %s", p);
475 /* --- @a_sighup@ --- *
477 * Arguments: @int sig@ = signal number
478 * @void *v@ = an uninteresting argument
482 * Use Logs a message about SIGHUP not being useful.
485 static void a_sighup(int sig, void *v)
487 a_warn("SERVER ignore signal SIGHUP");
490 /* --- @a_parsetime@ --- *
492 * Arguments; @const char *p@ = time string to parse
494 * Returns: Time in seconds, or @< 0@ on error.
497 static long a_parsetime(const char *p)
500 long t = strtol(p, &q, 0);
506 case 's': if (q[1] != 0)
513 /*----- Backgrounded operations -------------------------------------------*/
515 /* --- @a_bgrelease@ --- *
517 * Arguments: @admin_bgop *bg@ = backgrounded operation
521 * Use: Removes a backgrounded operation from the queue, since
522 * (presumably) it's done.
525 static void a_bgrelease(admin_bgop *bg)
532 selbuf_enable(&a->b);
534 bg->next->prev = bg->prev;
536 bg->prev->next = bg->next;
544 /* --- @a_bgok@, @a_bginfo@, @a_bgfail@ --- *
546 * Arguments: @admin_bgop *bg@ = backgrounded operation
547 * @const char *fmt@ = format string
548 * @...@ = other arguments
552 * Use: Convenience functions for @a_write@.
555 static void a_bgok(admin_bgop *bg)
556 { a_write(bg->a, "OK", bg->tag, 0); }
558 static void a_bginfo(admin_bgop *bg, const char *fmt, ...)
562 a_vwrite(bg->a, "INFO", bg->tag, fmt, ap);
566 static void a_bgfail(admin_bgop *bg, const char *fmt, ...)
570 a_vwrite(bg->a, "FAIL", bg->tag, fmt, ap);
574 /* --- @a_bgadd@ --- *
576 * Arguments: @admin *a@ = administration connection
577 * @admin_bgop *bg@ = pointer to background operation
578 * @const char *tag@ = background tag, or null for foreground
579 * @void (*cancel)(admin_bgop *)@ = cancel function
583 * Use: Links a background job into the list.
586 static void a_bgadd(admin *a, admin_bgop *bg, const char *tag,
587 void (*cancel)(admin_bgop *))
590 bg->tag = xstrdup(tag);
593 selbuf_disable(&a->b);
600 if (tag) a_write(a, "DETACH", tag, 0);
603 /*----- Adding peers ------------------------------------------------------*/
605 /* --- @a_addfree@ --- *
607 * Arguments: @admin_addop *add@ = operation block
611 * Use: Frees an add operation.
614 static void a_addfree(admin_addop *add)
616 if (add->peer.name) xfree(add->peer.name);
617 if (add->paddr) xfree(add->paddr);
620 /* --- @a_addcancel@ --- *
622 * Arguments: @admin_bgop *bg@ = background operation
626 * Use: Cancels an add operation.
629 static void a_addcancel(admin_bgop *bg)
631 admin_addop *add = (admin_addop *)bg;
633 sel_rmtimer(&add->t);
638 /* --- @a_doadd@ --- *
640 * Arguments: @admin_addop *add@ = operation block
644 * Use: Does the peer add thing.
647 static void a_doadd(admin_addop *add)
649 if (p_find(add->peer.name))
650 a_bgfail(&add->bg, "peer-exists %s", add->peer.name);
651 else if (!p_create(&add->peer))
652 a_bgfail(&add->bg, "peer-create-fail %s", add->peer.name);
657 /* --- @a_addresolve@ --- *
659 * Arguments: @struct hostent *h@ = pointer to resolved hostname
660 * @void *v@ = pointer to add operation
664 * Use: Handles a completed name resolution.
667 static void a_addresolve(struct hostent *h, void *v)
669 admin_addop *add = v;
672 T( trace(T_ADMIN, "admin: %u resolved", add->bg.a->seq); )
675 a_bgfail(&add->bg, "resolve-error %s", add->paddr);
677 memcpy(&add->peer.sa.sin.sin_addr, h->h_addr, sizeof(struct in_addr));
680 sel_rmtimer(&add->t);
682 a_bgrelease(&add->bg);
686 /* --- @a_addtimer@ --- *
688 * Arguments: @struct timeval *tv@ = timer
689 * @void *v@ = pointer to add operation
693 * Use: Times out a resolver.
696 static void a_addtimer(struct timeval *tv, void *v)
698 admin_addop *add = v;
701 T( trace(T_ADMIN, "admin: %u resolver timeout", add->bg.a->seq); )
702 a_bgfail(&add->bg, "resolver-timeout %s\n", add->paddr);
705 a_bgrelease(&add->bg);
709 /* --- @acmd_add@ --- *
711 * Arguments: @admin *a@ = connection which requested the addition
712 * @unsigned ac@ = argument count
713 * @char *av[]@ = pointer to the argument list
717 * Use: Adds a new peer.
720 static void acmd_add(admin *a, unsigned ac, char *av[])
727 admin_addop *add = 0;
729 /* --- Make sure someone's not got there already --- */
732 a_fail(a, "peer-exists %s", av[0]);
736 /* --- Set stuff up --- */
738 add = xmalloc(sizeof(*add));
739 add->peer.name = xstrdup(av[0]);
741 add->peer.tops = tun_default;
744 /* --- Parse options --- */
750 if (mystrieq(av[i], "-background")) {
751 if (!av[++i]) goto bad_syntax;
753 } else if (mystrieq(av[i], "-tunnel")) {
754 if (!av[++i]) goto bad_syntax;
757 a_fail(a, "unknown-tunnel %s", av[i]);
760 if (mystrieq(av[i], tunnels[j]->name)) {
761 add->peer.tops = tunnels[j];
765 } else if (mystrieq(av[i], "-keepalive")) {
767 if (!av[++i]) goto bad_syntax;
768 if ((t = a_parsetime(av[i])) < 0) {
769 a_fail(a, "bad-time-spec %s", av[i]);
773 } else if (mystrieq(av[i], "--")) {
781 /* --- Fill in the easy bits of address --- */
783 if (mystrieq(av[i], "inet")) i++;
785 a_fail(a, "bad-syntax -- add PEER [OPTIONS] [inet] ADDRESS PORT");
788 add->peer.sa.sin.sin_family = AF_INET;
789 add->peer.sasz = sizeof(add->peer.sa.sin);
790 add->paddr = xstrdup(av[i]);
791 pt = strtoul(av[i + 1], &p, 0);
793 struct servent *s = getservbyname(av[i + 1], "udp");
795 a_fail(a, "unknown-service %s", av[i + 1]);
798 pt = ntohs(s->s_port);
800 if (pt == 0 || pt >= 65536) {
801 a_fail(a, "invalid-port %lu", pt);
804 add->peer.sa.sin.sin_port = htons(pt);
806 /* --- Report backgrounding --- *
808 * Do this for consistency of interface, even if we're going to get the
809 * answer straight away.
812 a_bgadd(a, &add->bg, tag, a_addcancel);
814 /* --- If the name is numeric, do it the easy way --- */
816 if (inet_aton(av[i], &add->peer.sa.sin.sin_addr)) {
819 a_bgrelease(&add->bg);
823 /* --- Store everything for later and crank up the resolver --- */
825 gettimeofday(&tv, 0);
826 tv.tv_sec += T_RESOLVE;
827 sel_addtimer(&sel, &add->t, &tv, a_addtimer, add);
828 bres_byname(&add->r, add->paddr, a_addresolve, add);
829 T( trace(T_ADMIN, "admin: %u resolving hostname `%s'",
830 a->seq, add->paddr); )
834 a_fail(a, "bad-syntax -- add PEER [OPTIONS] ADDR ...");
843 /*----- Ping --------------------------------------------------------------*/
845 /* --- @a_pingcancel@ --- *
847 * Arguments: @admin_bgop *bg@ = background operation block
851 * Use: Cancels a running ping.
854 static void a_pingcancel(admin_bgop *bg)
856 admin_pingop *pg = (admin_pingop *)bg;
857 p_pingdone(&pg->ping, PING_NONOTIFY);
860 /* --- @a_pong@ --- *
862 * Arguments: @int rc@ = return code
863 * @void *v@ = ping operation block
867 * Use: Collects what happened to a ping message.
870 static void a_pong(int rc, void *v)
872 admin_pingop *pg = v;
879 gettimeofday(&tv, 0);
880 tv_sub(&tv, &tv, &pg->pingtime);
881 millis = (double)tv.tv_sec * 1000 + (double)tv.tv_usec/1000;
882 a_bginfo(&pg->bg, "ping-ok %.1f", millis);
886 a_bginfo(&pg->bg, "ping-timeout");
890 a_bginfo(&pg->bg, "ping-peer-died");
896 a_bgrelease(&pg->bg);
900 /* --- @acmd_ping@, @acmd_eping@ --- *
902 * Arguments: @admin *a@ = connection which requested the ping
903 * @unsigned ac@ = argument count
904 * @char *av[]@ = pointer to the argument list
911 static void a_ping(admin *a, unsigned ac, char *av[],
912 const char *cmd, unsigned msg)
917 admin_pingop *pg = 0;
924 if (mystrieq(av[i], "-background")) {
925 if (!av[++i]) goto bad_syntax;
927 } else if (mystrieq(av[i], "-timeout")) {
928 if (!av[++i]) goto bad_syntax;
929 if ((t = a_parsetime(av[i])) < 0) {
930 a_fail(a, "bad-time-spec %s", av[i]);
933 } else if (mystrieq(av[i], "--")) {
941 if (!av[i]) goto bad_syntax;
942 if ((p = p_find(av[i])) == 0) {
943 a_fail(a, "unknown-peer %s", av[i]);
946 pg = xmalloc(sizeof(*pg));
947 gettimeofday(&pg->pingtime, 0);
948 a_bgadd(a, &pg->bg, tag, a_pingcancel);
949 if (p_pingsend(p, &pg->ping, msg, t, a_pong, pg)) {
950 a_bgfail(&pg->bg, "ping-send-failed");
951 a_bgrelease(&pg->bg);
956 a_fail(a, "bad-syntax -- %s [OPTIONS] PEER", cmd);
960 static void acmd_ping(admin *a, unsigned ac, char *av[])
961 { a_ping(a, ac, av, "ping", MISC_PING); }
962 static void acmd_eping(admin *a, unsigned ac, char *av[])
963 { a_ping(a, ac, av, "eping", MISC_EPING); }
965 /*----- Administration commands -------------------------------------------*/
967 /* --- Miscellaneous commands --- */
969 /* --- @traceish@ --- *
971 * Arguments: @admin *a@ = connection to complain on
972 * @unsigned ac@ = number of arguments
973 * @char *av[]@ = vector of arguments
974 * @const char *what@ = what we're messing with
975 * @const trace_opt *tt@ = options table
976 * @unsigned *ff@ = where the flags are
978 * Returns: Nonzero if anything changed.
980 * Use: Guts of trace-ish commands like `trace' and `watch'.
983 static int traceish(admin *a, unsigned ac, char *av[],
984 const char *what, const trace_opt *tt, unsigned *ff)
988 if (!ac || strcmp(av[0], "?") == 0) {
990 a_info(a, "Current %s status:", what);
991 for (t = tt; t->ch; t++) {
992 a_info(a, "%c %c %s",
993 t->ch, (*ff & t->f) == t->f ? '*' : ' ', t->help);
1003 case '+': sense = 1; break;
1004 case '-': sense = 0; break;
1006 for (t = tt; t->ch; t++) {
1008 if (sense) f |= t->f;
1013 a_fail(a, "bad-%s-option %c", what, *p);
1029 static void acmd_trace(admin *a, unsigned ac, char *av[])
1031 if (traceish(a, ac, av, "trace", tr_opts, &tr_flags))
1032 trace_level(tr_flags);
1037 static void acmd_watch(admin *a, unsigned ac, char *av[])
1039 traceish(a, ac, av, "watch", w_opts, &a->f);
1042 static void quotify(dstr *d, const char *p)
1046 if (*p && !p[strcspn(p, "\"' \t\n\v")])
1051 if (*p == '\\' || *p == '\"')
1059 static void alertcmd(admin *a, unsigned f_and, unsigned f_eq,
1060 const char *tag, unsigned ac, char *av[])
1065 dstr_puts(&d, "USER");
1066 for (i = 0; i < ac; i++)
1069 a_rawalert(f_and, f_eq, tag, d.buf, d.len);
1074 static void acmd_notify(admin *a, unsigned ac, char *av[])
1075 { alertcmd(a, AF_NOTE, AF_NOTE, "NOTE", ac, av); }
1076 static void acmd_warn(admin *a, unsigned ac, char *av[])
1077 { alertcmd(a, AF_WARN, AF_WARN, "WARN", ac, av); }
1079 static void acmd_port(admin *a, unsigned ac, char *av[])
1081 a_info(a, "%u", p_port());
1085 static void acmd_daemon(admin *a, unsigned ac, char *av[])
1087 if (flags & F_DAEMON)
1088 a_fail(a, "already-daemon");
1094 a_fail(a, "daemon-error -- %s", strerror(errno));
1102 static void acmd_list(admin *a, unsigned ac, char *av[])
1105 for (p = p_first(); p; p = p_next(p))
1106 a_info(a, "%s", p_name(p));
1110 static void acmd_ifname(admin *a, unsigned ac, char *av[])
1114 if ((p = p_find(av[0])) == 0)
1115 a_fail(a, "unknown-peer %s", av[0]);
1117 a_info(a, "%s", p_ifname(p));
1122 static void acmd_addr(admin *a, unsigned ac, char *av[])
1127 if ((p = p_find(av[0])) == 0)
1128 a_fail(a, "unknown-peer %s", av[0]);
1131 assert(ad->sa.sa_family == AF_INET);
1132 a_info(a, "INET %s %u",
1133 inet_ntoa(ad->sin.sin_addr),
1134 (unsigned)ntohs(ad->sin.sin_port));
1139 static void acmd_stats(admin *a, unsigned ac, char *av[])
1144 if ((p = p_find(av[0])) == 0)
1145 a_fail(a, "unknown-peer %s", av[0]);
1148 a_info(a, "start-time=%s", timestr(st->t_start));
1149 a_info(a, "last-packet-time=%s", timestr(st->t_last));
1150 a_info(a, "last-keyexch-time=%s", timestr(st->t_kx));
1151 a_info(a, "packets-in=%lu bytes-in=%lu", st->n_in, st->sz_in);
1152 a_info(a, "packets-out=%lu bytes-out=%lu",
1153 st->n_out, st->sz_out);
1154 a_info(a, "keyexch-packets-in=%lu keyexch-bytes-in=%lu",
1155 st->n_kxin, st->sz_kxin);
1156 a_info(a, "keyexch-packets-out=%lu keyexch-bytes-out=%lu",
1157 st->n_kxout, st->sz_kxout);
1158 a_info(a, "ip-packets-in=%lu ip-bytes-in=%lu",
1159 st->n_ipin, st->sz_ipin);
1160 a_info(a, "ip-packets-out=%lu ip-bytes-out=%lu",
1161 st->n_ipout, st->sz_ipout);
1162 a_info(a, "rejected-packets=%lu", st->n_reject);
1167 static void acmd_kill(admin *a, unsigned ac, char *av[])
1170 if ((p = p_find(av[0])) == 0)
1171 a_fail(a, "unknown-peer %s", av[0]);
1178 static void acmd_forcekx(admin *a, unsigned ac, char *av[])
1181 if ((p = p_find(av[0])) == 0)
1182 a_fail(a, "unknown-peer %s", av[0]);
1184 kx_start(&p->kx, 1);
1189 static void acmd_reload(admin *a, unsigned ac, char *av[])
1190 { p_keyreload(); a_ok(a); }
1192 static void acmd_quit(admin *a, unsigned ac, char *av[])
1194 a_warn("SERVER quit admin-request");
1200 static void acmd_version(admin *a, unsigned ac, char *av[])
1202 a_info(a, "%s %s", PACKAGE, VERSION);
1206 static void acmd_tunnels(admin *a, unsigned ac, char *av[])
1209 for (i = 0; tunnels[i]; i++)
1210 a_info(a, "%s", tunnels[i]->name);
1214 /* --- The command table and help --- */
1216 typedef struct acmd {
1219 unsigned argmin, argmax;
1220 void (*func)(admin */*a*/, unsigned /*ac*/, char */*av*/[]);
1223 static void acmd_help(admin */*a*/, unsigned /*ac*/, char */*av*/[]);
1225 static const acmd acmdtab[] = {
1226 { "add", "add PEER [OPTIONS] ADDR ...",
1227 2, 0xffff, acmd_add },
1228 { "addr", "addr PEER", 1, 1, acmd_addr },
1229 { "daemon", "daemon", 0, 0, acmd_daemon },
1230 { "eping", "eping [OPTIONS] PEER", 1, 0xffff, acmd_eping },
1231 { "forcekx", "forcekx PEER", 1, 1, acmd_forcekx },
1232 { "help", "help", 0, 0, acmd_help },
1233 { "ifname", "ifname PEER", 1, 1, acmd_ifname },
1234 { "kill", "kill PEER", 1, 1, acmd_kill },
1235 { "list", "list", 0, 0, acmd_list },
1236 { "notify", "notify MESSAGE ...", 1, 0xffff, acmd_notify },
1237 { "ping", "ping [OPTIONS] PEER", 1, 0xffff, acmd_ping },
1238 { "port", "port", 0, 0, acmd_port },
1239 { "quit", "quit", 0, 0, acmd_quit },
1240 { "reload", "reload", 0, 0, acmd_reload },
1241 { "stats", "stats PEER", 1, 1, acmd_stats },
1243 { "trace", "trace [OPTIONS]", 0, 1, acmd_trace },
1245 { "tunnels", "tunnels", 0, 0, acmd_tunnels },
1246 { "version", "version", 0, 0, acmd_version },
1247 { "warn", "warn MESSAGE ...", 1, 0xffff, acmd_warn },
1248 { "watch", "watch [OPTIONS]", 0, 1, acmd_watch },
1252 static void acmd_help(admin *a, unsigned ac, char *av[])
1255 for (c = acmdtab; c->name; c++)
1256 a_info(a, "%s", c->help);
1260 /*----- Connection handling -----------------------------------------------*/
1262 /* --- @a_lock@ --- *
1264 * Arguments: @admin *a@ = pointer to an admin block
1268 * Use: Locks an admin block so that it won't be destroyed
1272 static void a_lock(admin *a) { assert(!(a->f & AF_LOCK)); a->f |= AF_LOCK; }
1274 /* --- @a_unlock@ --- *
1276 * Arguments: @admin *a@ = pointer to an admin block
1280 * Use: Unlocks an admin block, allowing its destruction. This is
1281 * also the second half of @a_destroy@.
1284 static void a_unlock(admin *a)
1286 admin_bgop *bg, *bbg;
1288 assert(a->f & AF_LOCK);
1290 /* --- If we're not dead, that's fine --- */
1292 if (!(a->f & AF_DEAD)) {
1297 /* --- If we are, then destroy the rest of the block --- */
1299 T( trace(T_ADMIN, "admin: completing destruction of connection %u",
1302 selbuf_destroy(&a->b);
1303 for (bg = a->bg; bg; bg = bbg) {
1306 if (bg->tag) xfree(bg->tag);
1309 if (a->b.reader.fd != a->w.fd) close(a->b.reader.fd);
1315 a->next->prev = a->prev;
1317 a->prev->next = a->next;
1323 /* --- @a_destroy@ --- *
1325 * Arguments: @admin *a@ = pointer to an admin block
1329 * Use: Destroys an admin block. This requires a certain amount of
1333 static void freequeue(oqueue *q)
1337 for (o = q->hd; o; o = oo) {
1344 static void a_destroy(admin *a)
1346 /* --- Don't multiply destroy admin blocks --- */
1351 /* --- Make sure nobody expects it to work --- */
1354 T( trace(T_ADMIN, "admin: destroying connection %u", a->seq); )
1356 /* --- Free the output buffers --- */
1362 /* --- If the block is locked, that's all we can manage --- */
1364 if (a->f & AF_LOCK) {
1365 T( trace(T_ADMIN, "admin: deferring destruction..."); )
1372 /* --- @a_line@ --- *
1374 * Arguments: @char *p@ = pointer to the line read
1375 * @size_t len@ = length of the line
1376 * @void *vp@ = pointer to my admin block
1380 * Use: Handles a line of input.
1383 static void a_line(char *p, size_t len, void *vp)
1398 selbuf_disable(&a->b);
1402 ac = str_qsplit(p, av, 16, 0, STRF_QUOTE);
1405 for (c = acmdtab; c->name; c++) {
1406 if (mystrieq(av[0], c->name)) {
1408 if (c->argmin > ac || ac > c->argmax)
1409 a_fail(a, "bad-syntax -- %s", c->help);
1412 c->func(a, ac, av + 1);
1418 a_fail(a, "unknown-command %s", av[0]);
1421 /* --- @a_create@ --- *
1423 * Arguments: @int fd_in, fd_out@ = file descriptors to use
1424 * @unsigned f@ = initial flags to set
1428 * Use: Creates a new admin connection.
1431 void a_create(int fd_in, int fd_out, unsigned f)
1433 admin *a = CREATE(admin);
1435 T( static unsigned seq = 0;
1437 T( trace(T_ADMIN, "admin: accepted connection %u", a->seq); )
1440 if (fd_in == STDIN_FILENO) a_stdin = a;
1441 fdflags(fd_in, O_NONBLOCK, O_NONBLOCK, FD_CLOEXEC, FD_CLOEXEC);
1442 if (fd_out != fd_in)
1443 fdflags(fd_out, O_NONBLOCK, O_NONBLOCK, FD_CLOEXEC, FD_CLOEXEC);
1444 selbuf_init(&a->b, &sel, fd_in, a_line, a);
1445 sel_initfile(&sel, &a->w, fd_out, SEL_WRITE, a_flush, a);
1446 a->out.hd = a->out.tl = 0;
1449 if (admins) admins->prev = a;
1453 /* --- @a_accept@ --- *
1455 * Arguments: @int fd@ = file descriptor to accept
1456 * @unsigned mode@ = what to do
1457 * @void *v@ = uninteresting pointer
1461 * Use: Accepts a new admin connection.
1464 static void a_accept(int fd, unsigned mode, void *v)
1467 struct sockaddr_un sun;
1468 size_t sz = sizeof(sun);
1470 if ((nfd = accept(fd, (struct sockaddr *)&sun, &sz)) < 0) {
1471 if (errno != EINTR && errno != EAGAIN && errno != EWOULDBLOCK &&
1472 errno != ECONNABORTED && errno != EPROTO)
1473 a_warn("ADMIN accept-error -- %s", strerror(errno));
1476 a_create(nfd, nfd, 0);
1479 /* --- @a_daemon@ --- *
1485 * Use: Informs the admin module that it's a daemon.
1493 /* --- @a_init@ --- *
1495 * Arguments: @const char *name@ = socket name to create
1499 * Use: Creates the admin listening socket.
1502 void a_init(const char *name)
1506 struct sockaddr_un sun;
1507 struct sigaction sa;
1510 /* --- Set up the socket address --- */
1512 sz = strlen(name) + 1;
1513 if (sz > sizeof(sun.sun_path))
1514 die(EXIT_FAILURE, "socket name `%s' too long", name);
1516 sun.sun_family = AF_UNIX;
1517 memcpy(sun.sun_path, name, sz);
1518 sz += offsetof(struct sockaddr_un, sun_path);
1520 /* --- Attempt to bind to the socket --- */
1524 if ((fd = socket(PF_UNIX, SOCK_STREAM, 0)) < 0)
1525 die(EXIT_FAILURE, "couldn't create socket: %s", strerror(errno));
1526 if (bind(fd, (struct sockaddr *)&sun, sz) < 0) {
1529 if (errno != EADDRINUSE) {
1530 die(EXIT_FAILURE, "couldn't bind to address `%s': %s",
1531 sun.sun_path, strerror(e));
1534 die(EXIT_FAILURE, "too many retries; giving up");
1536 if (!connect(fd, (struct sockaddr *)&sun, sz)) {
1537 die(EXIT_FAILURE, "server already listening on admin socket `%s'",
1540 if (errno != ECONNREFUSED)
1541 die(EXIT_FAILURE, "couldn't bind to address: %s", strerror(e));
1542 if (stat(sun.sun_path, &st)) {
1543 die(EXIT_FAILURE, "couldn't stat `%s': %s",
1544 sun.sun_path, strerror(errno));
1546 if (!S_ISSOCK(st.st_mode))
1547 die(EXIT_FAILURE, "object `%s' isn't a socket", sun.sun_path);
1548 T( trace(T_ADMIN, "admin: stale socket found; removing it"); )
1549 unlink(sun.sun_path);
1553 chmod(sun.sun_path, 0600);
1554 fdflags(fd, O_NONBLOCK, O_NONBLOCK, FD_CLOEXEC, FD_CLOEXEC);
1556 die(EXIT_FAILURE, "couldn't listen on socket: %s", strerror(errno));
1558 /* --- Listen to the socket --- */
1560 sel_initfile(&sel, &sock, fd, SEL_READ, a_accept, 0);
1564 T( trace_custom(a_trace, 0);
1565 trace(T_ADMIN, "admin: enabled custom tracing"); )
1568 /* --- Set up signal handlers --- */
1570 sig_add(&s_term, SIGTERM, a_sigdie, 0);
1571 sig_add(&s_hup, SIGHUP, a_sighup, 0);
1572 signal(SIGPIPE, SIG_IGN);
1573 sigaction(SIGINT, 0, &sa);
1574 if (sa.sa_handler != SIG_IGN)
1575 sig_add(&s_int, SIGINT, a_sigdie, 0);
1578 /*----- That's all, folks -------------------------------------------------*/