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 { 's', T_KEYSET, "symmetric keyset management" },
42 { 'x', T_KEYEXCH, "key exchange" },
43 { 'm', T_KEYMGMT, "key management" },
44 { 'l', T_CHAL, "challenge management" },
45 { 'p', T_PACKET, "packet contents" },
46 { 'c', T_CRYPTO, "crypto details" },
47 { 'A', T_ALL, "all of the above" },
51 unsigned tr_flags = 0;
54 static const trace_opt w_opts[] = {
55 { 't', AF_TRACE, "trace messages" },
56 { 'n', AF_NOTE, "asynchronous notifications" },
57 { 'w', AF_WARN, "warnings" },
58 { 'A', AF_ALLMSGS, "all of the above" },
62 /*----- Static variables --------------------------------------------------*/
67 static const char *sockname;
68 static unsigned flags = 0;
69 static admin *a_stdin = 0;
70 static sig s_term, s_int, s_hup;
75 #define T_RESOLVE SEC(30)
78 static void a_destroy(admin */*a*/);
80 #define BOOL(x) ((x) ? "t" : "nil")
82 /*----- Output functions --------------------------------------------------*/
84 /* --- @trywrite@ --- *
86 * Arguments: @admin *a@ = pointer to an admin block
87 * @const char *p@ = pointer to buffer to write
88 * @size_t sz@ = size of data to write
90 * Returns: The number of bytes written, or less than zero on error.
92 * Use: Attempts to write data to a client.
95 static ssize_t trywrite(admin *a, const char *p, size_t sz)
102 n = write(a->w.fd, p, sz);
112 if (errno != EAGAIN && errno != EWOULDBLOCK) {
114 a_warn("ADMIN", "client-write-error", "?ERRNO", A_END);
121 /* --- @doqueue@ -- *
123 * Arguments: @oqueue *q@ = pointer to output queue
124 * @const char *p@ = pointer to buffer to write
125 * @size_t sz@ = size of buffer
127 * Returns: Nonzero if the queue was previously empty.
129 * Use: Queues data to be written later.
132 static int doqueue(oqueue *q, const char *p, size_t sz)
141 else if (o->p_in < o->buf + OBUFSZ)
145 o = xmalloc(sizeof(obuf));
147 o->p_in = o->p_out = o->buf;
155 n = o->buf + OBUFSZ - o->p_in;
158 memcpy(o->p_in, p, n);
167 /* --- @dosend@ --- *
169 * Arguemnts: @admin *a@ = pointer to an admin block
170 * @const char *p@ = pointer to buffer to write
171 * @size_t sz@ = size of data to write
175 * Use: Sends data to an admin client.
178 static void dosend(admin *a, const char *p, size_t sz)
185 if ((n = trywrite(a, p, sz)) < 0)
192 if (doqueue(&a->out, p, sz))
196 /* --- @a_flush@ --- *
198 * Arguments: @int fd@ = file descriptor
199 * @unsigned mode@ = what's happening
200 * @void *v@ = pointer to my admin block
204 * Use: Flushes buffers when a client is ready to read again.
207 static void a_flush(int fd, unsigned mode, void *v)
215 if ((n = trywrite(a, o->p_out, o->p_in - o->p_out)) < 0)
218 if (o->p_in < o->p_out)
231 /*----- Utility functions -------------------------------------------------*/
233 /* --- @quotify@ --- *
235 * Arguments: @dstr *d@ = where to write the answer
236 * @const char *p@ = string to quotify
240 * Use: Quotes the given string if necessary, according to our
244 static void quotify(dstr *d, const char *p)
248 if (*p && !p[strcspn(p, "\"' \t\n\v")])
253 if (*p == '\\' || *p == '\"')
261 /* --- @a_vformat@ --- *
263 * Arguments: @dstr *d@ = where to leave the formatted message
264 * @const char *fmt@ = pointer to format string
265 * @va_list ap@ = arguments in list
269 * Use: Main message token formatting driver.
272 static void a_vformat(dstr *d, const char *fmt, va_list ap)
279 dstr_vputf(d, fmt + 1, &ap);
280 } else if (*fmt == '?') {
281 if (strcmp(fmt, "?ADDR") == 0) {
282 const addr *a = va_arg(ap, const addr *);
283 switch (a->sa.sa_family) {
286 quotify(d, inet_ntoa(a->sin.sin_addr));
287 dstr_putf(d, " %u", (unsigned)ntohs(a->sin.sin_port));
292 } else if (strcmp(fmt, "?B64") == 0) {
293 const octet *p = va_arg(ap, const octet *);
294 size_t n = va_arg(ap, size_t);
300 base64_encode(&b64, p, n, d);
301 base64_encode(&b64, 0, 0, d);
302 while (d->len && d->buf[d->len - 1] == '=') d->len--;
303 } else if (strcmp(fmt, "?TOKENS") == 0) {
304 const char *const *av = va_arg(ap, const char *const *);
305 while (*av) quotify(d, *av++);
306 } else if (strcmp(fmt, "?PEER") == 0)
307 quotify(d, p_name(va_arg(ap, peer *)));
308 else if (strcmp(fmt, "?ERRNO") == 0) {
309 dstr_putf(d, " E%d", errno);
310 quotify(d, strerror(errno));
314 if (*fmt == '!') fmt++;
316 dstr_vputf(&dd, fmt, &ap);
319 fmt = va_arg(ap, const char *);
325 /* --- @a_write@, @a_vwrite@ --- *
327 * Arguments: @admin *a@ = admin connection to write to
328 * @const char *status@ = status code to report
329 * @const char *tag@ = tag string, or null
330 * @const char *fmt@ = pointer to format string
331 * @va_list ap@ = arguments in list
332 * @...@ = other arguments
336 * Use: Sends a message to an admin connection.
339 static void a_vwrite(admin *a, const char *status, const char *tag,
340 const char *fmt, va_list ap)
343 if (tag) dstr_puts(&d, "BG");
344 dstr_puts(&d, status);
345 if (tag) quotify(&d, tag);
346 a_vformat(&d, fmt, ap);
348 dosend(a, d.buf, d.len);
352 static void a_write(admin *a, const char *status, const char *tag,
353 const char *fmt, ...)
357 a_vwrite(a, status, tag, fmt, ap);
361 /* --- @a_ok@, @a_info@, @a_fail@ --- *
363 * Arguments: @admin *a@ = connection
364 * @const char *fmt@ = format string
365 * @...@ = other arguments
369 * Use: Convenience functions for @a_write@.
372 static void a_ok(admin *a) { a_write(a, "OK", 0, A_END); }
374 static void a_info(admin *a, const char *fmt, ...)
378 a_vwrite(a, "INFO", 0, fmt, ap);
382 static void a_fail(admin *a, const char *fmt, ...)
386 a_vwrite(a, "FAIL", 0, fmt, ap);
390 /* --- @a_alert@, @a_valert@, @a_rawalert@ --- *
392 * Arguments: @unsigned f_and, f_eq@ = filter for connections
393 * @const char *status@ = status string
394 * @const char *fmt@ = pointer to format string
395 * @const char *p@ = pointer to raw string
396 * @size_t sz@ = size of raw string
397 * @va_list ap@ = arguments in list
398 * @...@ = other arguments
402 * Use: Write a message to all admin connections matched by the given
406 static void a_rawalert(unsigned f_and, unsigned f_eq, const char *status,
407 const char *p, size_t sz)
412 if (!(flags & F_INIT))
414 dstr_puts(&d, status);
417 dstr_putm(&d, p, sz);
422 for (a = admins; a; a = aa) {
424 if ((a->f & f_and) == f_eq)
425 dosend(a, d.buf, d.len);
430 static void a_valert(unsigned f_and, unsigned f_eq, const char *tag,
431 const char *fmt, va_list ap)
435 if (!(flags & F_INIT))
437 a_vformat(&d, fmt, ap);
438 a_rawalert(f_and, f_eq, tag, fmt ? d.buf : 0, fmt ? d.len : 0);
442 static void a_alert(unsigned f_and, unsigned f_eq, const char *tag,
443 const char *fmt, ...)
447 a_valert(f_and, f_eq, tag, fmt, ap);
451 /* --- @a_warn@ --- *
453 * Arguments: @const char *fmt@ = pointer to format string
454 * @...@ = other arguments
458 * Use: Informs all admin connections of a warning.
461 void a_warn(const char *fmt, ...)
467 a_valert(0, 0, "WARN", fmt, ap);
470 fprintf(stderr, "%s: ", QUIS);
471 a_vformat(&d, fmt, ap);
473 dstr_write(&d, stderr);
479 /* --- @a_trace@ --- *
481 * Arguments: @const char *p@ = pointer to a buffer
482 * @size_t sz@ = size of the buffer
483 * @void *v@ = uninteresting pointer
487 * Use: Custom trace output handler. Sends trace messages to
488 * interested admin connections.
492 static void a_trace(const char *p, size_t sz, void *v)
493 { a_rawalert(AF_TRACE, AF_TRACE, "TRACE", p, sz); }
496 /* --- @a_notify@ --- *
498 * Arguments: @const char *fmt@ = pointer to format string
499 * @...@ = other arguments
503 * Use: Sends a notification to interested admin connections.
506 void a_notify(const char *fmt, ...)
511 a_valert(AF_NOTE, AF_NOTE, "NOTE", fmt, ap);
515 /* --- @a_quit@ --- *
521 * Use: Shuts things down nicely.
530 while ((p = p_first()) != 0)
535 /* --- @a_sigdie@ --- *
537 * Arguments: @int sig@ = signal number
538 * @void *v@ = an uninteresting argument
542 * Use Shuts down on receipt of a fatal signal.
545 static void a_sigdie(int sig, void *v)
551 case SIGTERM: p = "SIGTERM"; break;
552 case SIGINT: p = "SIGINT"; break;
554 sprintf(buf, "%i", sig);
558 a_warn("SERVER", "quit", "signal", "%s", p, A_END);
562 /* --- @a_sighup@ --- *
564 * Arguments: @int sig@ = signal number
565 * @void *v@ = an uninteresting argument
569 * Use Logs a message about SIGHUP not being useful.
572 static void a_sighup(int sig, void *v)
574 a_warn("SERVER", "ignore", "signal", "SIGHUP", A_END);
577 /* --- @a_parsetime@ --- *
579 * Arguments; @const char *p@ = time string to parse
581 * Returns: Time in seconds, or @< 0@ on error.
584 static long a_parsetime(const char *p)
587 long t = strtol(p, &q, 0);
593 case 's': if (q[1] != 0)
600 /* --- @a_findpeer@ --- *
602 * Arguments: @admin *a@ = admin connection
603 * @const char *pn@ = peer name
605 * Returns: The peer, or null if not there.
607 * Use: Finds a peer, reporting an error if it failed.
610 static peer *a_findpeer(admin *a, const char *pn)
614 if ((p = p_find(pn)) == 0)
615 a_fail(a, "unknown-peer", "%s", pn, A_END);
619 /*----- Backgrounded operations -------------------------------------------*/
622 (((admin_bgop *)(bg))->tag ? ((admin_bgop *)(bg))->tag : "<foreground>")
624 /* --- @a_bgfind@ --- *
626 * Arguments: @admin *a@ = a client block
627 * @const char *tag@ = the requested tag
629 * Returns: The requested background job, or null.
632 static admin_bgop *a_bgfind(admin *a, const char *tag)
636 for (bg = a->bg; bg; bg = bg->next) {
637 if (bg->tag && strcmp(tag, bg->tag) == 0)
643 /* --- @a_bgrelease@ --- *
645 * Arguments: @admin_bgop *bg@ = backgrounded operation
649 * Use: Removes a backgrounded operation from the queue, since
650 * (presumably) it's done.
653 static void a_bgrelease(admin_bgop *bg)
657 T( trace(T_ADMIN, "admin: release bgop %s", BGTAG(bg)); )
658 if (bg->tag) xfree(bg->tag);
659 else selbuf_enable(&a->b);
660 if (bg->next) bg->next->prev = bg->prev;
661 if (bg->prev) bg->prev->next = bg->next;
662 else a->bg = bg->next;
664 if (!a->bg && (a->f & AF_CLOSE)) a_destroy(a);
667 /* --- @a_bgok@, @a_bginfo@, @a_bgfail@ --- *
669 * Arguments: @admin_bgop *bg@ = backgrounded operation
670 * @const char *fmt@ = format string
671 * @...@ = other arguments
675 * Use: Convenience functions for @a_write@.
678 static void a_bgok(admin_bgop *bg)
679 { a_write(bg->a, "OK", bg->tag, A_END); }
681 static void a_bginfo(admin_bgop *bg, const char *fmt, ...)
685 a_vwrite(bg->a, "INFO", bg->tag, fmt, ap);
689 static void a_bgfail(admin_bgop *bg, const char *fmt, ...)
693 a_vwrite(bg->a, "FAIL", bg->tag, fmt, ap);
697 /* --- @a_bgadd@ --- *
699 * Arguments: @admin *a@ = administration connection
700 * @admin_bgop *bg@ = pointer to background operation
701 * @const char *tag@ = background tag, or null for foreground
702 * @void (*cancel)(admin_bgop *)@ = cancel function
704 * Returns: Zero for success, nonzero on failure.
706 * Use: Links a background job into the list.
709 static int a_bgadd(admin *a, admin_bgop *bg, const char *tag,
710 void (*cancel)(admin_bgop *))
713 if (a_bgfind(a, tag)) {
714 a_fail(a, "tag-exists", "%s", tag, A_END);
717 bg->tag = xstrdup(tag);
721 selbuf_disable(&a->b);
727 if (a->bg) a->bg->prev = bg;
729 T( trace(T_ADMIN, "admin: add bgop %s", BGTAG(bg)); )
730 if (tag) a_write(a, "DETACH", tag, A_END);
734 /*----- Name resolution operations ----------------------------------------*/
736 /* --- @a_resolved@ --- *
738 * Arguments: @struct hostent *h@ = pointer to resolved hostname
739 * @void *v@ = pointer to resolver operation
743 * Use: Handles a completed name resolution.
746 static void a_resolved(struct hostent *h, void *v)
750 T( trace(T_ADMIN, "admin: resop %s resolved", BGTAG(r)); )
753 a_bgfail(&r->bg, "resolve-error", "%s", r->addr, A_END);
754 r->func(r, ARES_FAIL);
756 memcpy(&r->sa.sin.sin_addr, h->h_addr, sizeof(struct in_addr));
764 /* --- @a_restimer@ --- *
766 * Arguments: @struct timeval *tv@ = timer
767 * @void *v@ = pointer to resolver operation
771 * Use: Times out a resolver.
774 static void a_restimer(struct timeval *tv, void *v)
778 T( trace(T_ADMIN, "admin: resop %s timeout", BGTAG(r)); )
779 a_bgfail(&r->bg, "resolver-timeout", "%s", r->addr, A_END);
780 r->func(r, ARES_FAIL);
786 /* --- @a_rescancel@ --- *
788 * Arguments: @admin_bgop *bg@ = background operation
792 * Use: Cancels an add operation.
795 static void a_rescancel(admin_bgop *bg)
797 admin_resop *r = (admin_resop *)bg;
799 T( trace(T_ADMIN, "admin: cancel resop %s", BGTAG(r)); )
800 r->func(r, ARES_FAIL);
806 /* --- @a_resolve@ --- *
808 * Arguments: @admin *a@ = administration connection
809 * @admin_resop *r@ = resolver operation to run
810 * @const char *tag@ = background operation tag
811 * @void (*func)(struct admin_resop *, int@ = handler function
812 * @unsigned ac@ = number of remaining arguments
813 * @char *av[]@ = pointer to remaining arguments
817 * Use: Cranks up a resolver job.
820 static void a_resolve(admin *a, admin_resop *r, const char *tag,
821 void (*func)(struct admin_resop *, int),
822 unsigned ac, char *av[])
829 /* --- Fill in the easy bits of address --- */
831 r->bg.tag = "<starting>";
834 if (mystrieq(av[i], "inet")) i++;
836 a_fail(a, "bad-addr-syntax", "[inet] ADDRESS PORT", A_END);
839 r->sa.sin.sin_family = AF_INET;
840 r->sasz = sizeof(r->sa.sin);
841 r->addr = xstrdup(av[i]);
842 pt = strtoul(av[i + 1], &p, 0);
844 struct servent *s = getservbyname(av[i + 1], "udp");
846 a_fail(a, "unknown-port", "%s", av[i + 1], A_END);
849 pt = ntohs(s->s_port);
851 if (pt == 0 || pt >= 65536) {
852 a_fail(a, "invalid-port", "%lu", pt, A_END);
855 r->sa.sin.sin_port = htons(pt);
857 /* --- Report backgrounding --- *
859 * Do this for consistency of interface, even if we're going to get the
860 * answer straight away.
863 if (a_bgadd(a, &r->bg, tag, a_rescancel))
865 T( trace(T_ADMIN, "admin: %u, resop %s, hostname `%s'",
866 a->seq, BGTAG(r), r->addr); )
868 /* --- If the name is numeric, do it the easy way --- */
870 if (inet_aton(av[i], &r->sa.sin.sin_addr)) {
871 T( trace(T_ADMIN, "admin: resop %s done the easy way", BGTAG(r)); )
878 /* --- Store everything for later and crank up the resolver --- */
880 gettimeofday(&tv, 0);
881 tv.tv_sec += T_RESOLVE;
882 sel_addtimer(&sel, &r->t, &tv, a_restimer, r);
883 bres_byname(&r->r, r->addr, a_resolved, r);
888 if (r->addr) xfree(r->addr);
892 /*----- Option parsing ----------------------------------------------------*/
894 #define OPTIONS(argc, argv, guts) do { \
895 char **o_av = argv; \
899 if (mystrieq(*o_av, "--")) { \
908 argc -= o_av - argv; \
912 #define OPT(name, guts) if (mystrieq(*o_av, name)) { guts continue; }
914 #define OPTARG(name, arg, guts) OPT(name, { \
917 if (!arg) goto bad_syntax; \
921 #define OPTTIME(name, arg, guts) OPTARG(name, o_arg, { \
923 if ((arg = a_parsetime(o_arg)) < 0) { \
924 a_fail(a, "bad-time-spec", "%s", o_arg, A_END); \
930 /*----- Adding peers ------------------------------------------------------*/
932 /* --- @a_doadd@ --- *
934 * Arguments: @admin_resop *r@ = resolver operation
935 * @int rc@ = how it worked
939 * Use: Handles a completed resolution.
942 static void a_doadd(admin_resop *r, int rc)
944 admin_addop *add = (admin_addop *)r;
946 T( trace(T_ADMIN, "admin: done add op %s", BGTAG(add)); )
949 add->peer.sasz = add->r.sasz;
950 add->peer.sa = add->r.sa;
951 if (p_find(add->peer.name))
952 a_bgfail(&add->r.bg, "peer-exists", "%s", add->peer.name, A_END);
953 else if (!p_create(&add->peer))
954 a_bgfail(&add->r.bg, "peer-create-fail", "%s", add->peer.name, A_END);
959 xfree(add->peer.name);
962 /* --- @acmd_add@ --- *
964 * Arguments: @admin *a@ = connection which requested the addition
965 * @unsigned ac@ = argument count
966 * @char *av[]@ = pointer to the argument list
970 * Use: Adds a new peer.
973 static void acmd_add(admin *a, unsigned ac, char *av[])
978 /* --- Set stuff up --- */
980 add = xmalloc(sizeof(*add));
983 add->peer.tops = tun_default;
985 /* --- Parse options --- */
988 OPTARG("-background", arg, { tag = arg; })
989 OPTARG("-tunnel", arg, {
993 a_fail(a, "unknown-tunnel", "%s", arg, A_END);
996 if (mystrieq(arg, tunnels[i]->name)) {
997 add->peer.tops = tunnels[i];
1002 OPTTIME("-keepalive", t, { add->peer.t_ka = t; })
1005 /* --- Make sure someone's not got there already --- */
1010 a_fail(a, "peer-exists", "%s", *av, A_END);
1013 add->peer.name = xstrdup(*av++);
1016 /* --- Crank up the resolver --- */
1018 a_resolve(a, &add->r, tag, a_doadd, ac, av);
1021 /* --- Clearing up --- */
1024 a_fail(a, "bad-syntax", "add", "[OPTIONS] PEER ADDR ...", A_END);
1026 if (add->peer.name) xfree(add->peer.name);
1031 /*----- Ping --------------------------------------------------------------*/
1033 /* --- @a_pingcancel@ --- *
1035 * Arguments: @admin_bgop *bg@ = background operation block
1039 * Use: Cancels a running ping.
1042 static void a_pingcancel(admin_bgop *bg)
1044 admin_pingop *pg = (admin_pingop *)bg;
1045 T( trace(T_ADMIN, "admin: cancel ping op %s", BGTAG(pg)); )
1046 p_pingdone(&pg->ping, PING_NONOTIFY);
1049 /* --- @a_pong@ --- *
1051 * Arguments: @int rc@ = return code
1052 * @void *v@ = ping operation block
1056 * Use: Collects what happened to a ping message.
1059 static void a_pong(int rc, void *v)
1061 admin_pingop *pg = v;
1067 gettimeofday(&tv, 0);
1068 tv_sub(&tv, &tv, &pg->pingtime);
1069 millis = (double)tv.tv_sec * 1000 + (double)tv.tv_usec/1000;
1070 a_bginfo(&pg->bg, "ping-ok", "%.1f", millis, A_END);
1074 a_bginfo(&pg->bg, "ping-timeout", A_END);
1078 a_bginfo(&pg->bg, "ping-peer-died", A_END);
1084 T( trace(T_ADMIN, "admin: ponged ping op %s", BGTAG(pg)); )
1085 a_bgrelease(&pg->bg);
1088 /* --- @acmd_ping@, @acmd_eping@ --- *
1090 * Arguments: @admin *a@ = connection which requested the ping
1091 * @unsigned ac@ = argument count
1092 * @char *av[]@ = pointer to the argument list
1096 * Use: Pings a peer.
1099 static void a_ping(admin *a, unsigned ac, char *av[],
1100 const char *cmd, unsigned msg)
1104 admin_pingop *pg = 0;
1105 const char *tag = 0;
1108 OPTARG("-background", arg, { tag = arg; })
1109 OPTTIME("-timeout", arg, { t = arg; })
1111 if (!*av || av[1]) goto bad_syntax;
1112 if ((p = a_findpeer(a, *av)) == 0)
1114 pg = xmalloc(sizeof(*pg));
1115 gettimeofday(&pg->pingtime, 0);
1116 if (a_bgadd(a, &pg->bg, tag, a_pingcancel))
1118 T( trace(T_ADMIN, "admin: ping op %s: %s to %s",
1119 BGTAG(pg), cmd, p_name(p)); )
1120 if (p_pingsend(p, &pg->ping, msg, t, a_pong, pg)) {
1121 a_bgfail(&pg->bg, "ping-send-failed", A_END);
1122 a_bgrelease(&pg->bg);
1127 a_fail(a, "bad-syntax", "%s", cmd, "[OPTIONS] PEER", cmd, A_END);
1133 static void acmd_ping(admin *a, unsigned ac, char *av[])
1134 { a_ping(a, ac, av, "ping", MISC_PING); }
1135 static void acmd_eping(admin *a, unsigned ac, char *av[])
1136 { a_ping(a, ac, av, "eping", MISC_EPING); }
1138 /*----- Administration commands -------------------------------------------*/
1140 /* --- Miscellaneous commands --- */
1142 /* --- @traceish@ --- *
1144 * Arguments: @admin *a@ = connection to complain on
1145 * @unsigned ac@ = number of arguments
1146 * @char *av[]@ = vector of arguments
1147 * @const char *what@ = what we're messing with
1148 * @const trace_opt *tt@ = options table
1149 * @unsigned *ff@ = where the flags are
1151 * Returns: Nonzero if anything changed.
1153 * Use: Guts of trace-ish commands like `trace' and `watch'.
1156 static int traceish(admin *a, unsigned ac, char *av[],
1157 const char *what, const trace_opt *tt, unsigned *ff)
1161 if (!ac || strcmp(av[0], "?") == 0) {
1163 for (t = tt; t->ch; t++) {
1164 a_info(a, "*%c%c %s",
1165 t->ch, (*ff & t->f) == t->f ? '+' : ' ', t->help, A_END);
1175 case '+': sense = 1; break;
1176 case '-': sense = 0; break;
1178 for (t = tt; t->ch; t++) {
1180 if (sense) f |= t->f;
1185 a_fail(a, "bad-%s-option", what, "%c", *p, A_END);
1201 static void acmd_trace(admin *a, unsigned ac, char *av[])
1203 if (traceish(a, ac, av, "trace", tr_opts, &tr_flags))
1204 trace_level(tr_flags);
1209 static void acmd_watch(admin *a, unsigned ac, char *av[])
1211 traceish(a, ac, av, "watch", w_opts, &a->f);
1214 static void alertcmd(admin *a, unsigned f_and, unsigned f_eq,
1215 const char *status, char *av[])
1216 { a_alert(f_and, f_eq, status, "USER", "?TOKENS", av, A_END); a_ok(a); }
1217 static void acmd_notify(admin *a, unsigned ac, char *av[])
1218 { alertcmd(a, AF_NOTE, AF_NOTE, "NOTE", av); }
1219 static void acmd_warn(admin *a, unsigned ac, char *av[])
1220 { alertcmd(a, AF_WARN, AF_WARN, "WARN", av); }
1222 static void acmd_port(admin *a, unsigned ac, char *av[])
1224 a_info(a, "%u", p_port(), A_END);
1228 static void acmd_daemon(admin *a, unsigned ac, char *av[])
1230 if (flags & F_DAEMON)
1231 a_fail(a, "already-daemon", A_END);
1233 a_notify("DAEMON", A_END);
1237 a_fail(a, "daemon-error", "?ERRNO", A_END);
1245 static void acmd_jobs(admin *a, unsigned ac, char *av[])
1249 for (bg = a->bg; bg; bg = bg->next) {
1251 a_info(a, "%s", bg->tag, A_END);
1256 static void acmd_bgcancel(admin *a, unsigned ac, char *av[])
1260 if ((bg = a_bgfind(a, av[0])) == 0)
1261 a_fail(a, "unknown-tag", "%s", av[0], A_END);
1269 static void acmd_list(admin *a, unsigned ac, char *av[])
1272 for (p = p_first(); p; p = p_next(p))
1273 a_info(a, "%s", p_name(p), A_END);
1277 static void acmd_ifname(admin *a, unsigned ac, char *av[])
1281 if ((p = a_findpeer(a, av[0])) != 0) {
1282 a_info(a, "%s", p_ifname(p), A_END);
1287 static void acmd_setifname(admin *a, unsigned ac, char *av[])
1291 if ((p = a_findpeer(a, av[0])) != 0) {
1292 a_notify("NEWIFNAME", "?PEER", p, "%s", p_ifname(p), "%s", av[1], A_END);
1293 p_setifname(p, av[1]);
1298 static void acmd_getchal(admin *a, unsigned ac, char *av[])
1302 buf_init(&b, buf_i, PKBUFSZ);
1304 a_info(a, "?B64", BBASE(&b), (size_t)BLEN(&b), A_END);
1308 static void acmd_checkchal(admin *a, unsigned ac, char *av[])
1315 base64_decode(&b64, av[0], strlen(av[0]), &d);
1316 base64_decode(&b64, 0, 0, &d);
1317 buf_init(&b, d.buf, d.len);
1318 if (c_check(&b) || BBAD(&b) || BLEFT(&b))
1319 a_fail(a, "invalid-challenge", A_END);
1325 static void acmd_greet(admin *a, unsigned ac, char *av[])
1331 if ((p = a_findpeer(a, av[0])) != 0) {
1333 base64_decode(&b64, av[1], strlen(av[1]), &d);
1334 base64_decode(&b64, 0, 0, &d);
1335 p_greet(p, d.buf, d.len);
1341 static void acmd_addr(admin *a, unsigned ac, char *av[])
1346 if ((p = a_findpeer(a, av[0])) != 0) {
1348 assert(ad->sa.sa_family == AF_INET);
1349 a_info(a, "?ADDR", ad, A_END);
1354 static void acmd_peerinfo(admin *a, unsigned ac, char *av[])
1359 if ((p = a_findpeer(a, av[0])) != 0) {
1361 a_info(a, "tunnel=%s", ps->tops->name, A_END);
1362 a_info(a, "keepalive=%lu", ps->t_ka, A_END);
1367 static void acmd_servinfo(admin *a, unsigned ac, char *av[])
1369 a_info(a, "implementation=edgeware-tripe", A_END);
1370 a_info(a, "version=%s", VERSION, A_END);
1371 a_info(a, "daemon=%s", BOOL(flags & F_DAEMON), A_END);
1375 static void acmd_stats(admin *a, unsigned ac, char *av[])
1380 if ((p = a_findpeer(a, av[0])) == 0)
1384 a_info(a, "start-time=%s", timestr(st->t_start), A_END);
1385 a_info(a, "last-packet-time=%s", timestr(st->t_last), A_END);
1386 a_info(a, "last-keyexch-time=%s", timestr(st->t_kx), A_END);
1387 a_info(a, "packets-in=%lu bytes-in=%lu", st->n_in, st->sz_in, A_END);
1388 a_info(a, "packets-out=%lu bytes-out=%lu",
1389 st->n_out, st->sz_out, A_END);
1390 a_info(a, "keyexch-packets-in=%lu keyexch-bytes-in=%lu",
1391 st->n_kxin, st->sz_kxin, A_END);
1392 a_info(a, "keyexch-packets-out=%lu keyexch-bytes-out=%lu",
1393 st->n_kxout, st->sz_kxout, A_END);
1394 a_info(a, "ip-packets-in=%lu ip-bytes-in=%lu",
1395 st->n_ipin, st->sz_ipin, A_END);
1396 a_info(a, "ip-packets-out=%lu ip-bytes-out=%lu",
1397 st->n_ipout, st->sz_ipout, A_END);
1398 a_info(a, "rejected-packets=%lu", st->n_reject, A_END);
1402 static void acmd_kill(admin *a, unsigned ac, char *av[])
1405 if ((p = a_findpeer(a, av[0])) != 0) {
1411 static void acmd_forcekx(admin *a, unsigned ac, char *av[])
1414 if ((p = a_findpeer(a, av[0])) != 0) {
1415 kx_start(&p->kx, 1);
1420 static void acmd_reload(admin *a, unsigned ac, char *av[])
1421 { p_keyreload(); a_ok(a); }
1423 static void acmd_quit(admin *a, unsigned ac, char *av[])
1425 a_warn("SERVER", "quit", "admin-request", A_END);
1430 static void acmd_version(admin *a, unsigned ac, char *av[])
1432 a_info(a, "%s", PACKAGE, "%s", VERSION, A_END);
1436 static void acmd_tunnels(admin *a, unsigned ac, char *av[])
1439 for (i = 0; tunnels[i]; i++)
1440 a_info(a, "%s", tunnels[i]->name, A_END);
1444 /* --- The command table and help --- */
1446 typedef struct acmd {
1449 unsigned argmin, argmax;
1450 void (*func)(admin */*a*/, unsigned /*ac*/, char */*av*/[]);
1453 static void acmd_help(admin */*a*/, unsigned /*ac*/, char */*av*/[]);
1455 static const acmd acmdtab[] = {
1456 { "add", "[OPTIONS] PEER ADDR ...", 2, 0xffff, acmd_add },
1457 { "addr", "PEER", 1, 1, acmd_addr },
1458 { "bgcancel", "TAG", 1, 1, acmd_bgcancel },
1459 { "checkchal", "CHAL", 1, 1, acmd_checkchal },
1460 { "daemon", 0, 0, 0, acmd_daemon },
1461 { "eping", "[OPTIONS] PEER", 1, 0xffff, acmd_eping },
1462 { "forcekx", "PEER", 1, 1, acmd_forcekx },
1463 { "getchal", 0, 0, 0, acmd_getchal },
1464 { "greet", "PEER CHAL", 2, 2, acmd_greet },
1465 { "help", 0, 0, 0, acmd_help },
1466 { "ifname", "PEER", 1, 1, acmd_ifname },
1467 { "jobs", 0, 0, 0, acmd_jobs },
1468 { "kill", "PEER", 1, 1, acmd_kill },
1469 { "list", 0, 0, 0, acmd_list },
1470 { "notify", "MESSAGE ...", 1, 0xffff, acmd_notify },
1471 { "peerinfo", "PEER", 1, 1, acmd_peerinfo },
1472 { "ping", "[OPTIONS] PEER", 1, 0xffff, acmd_ping },
1473 { "port", 0, 0, 0, acmd_port },
1474 { "quit", 0, 0, 0, acmd_quit },
1475 { "reload", 0, 0, 0, acmd_reload },
1476 { "servinfo", 0, 0, 0, acmd_servinfo },
1477 { "setifname", "PEER NEW-NAME", 2, 2, acmd_setifname },
1478 { "stats", "PEER", 1, 1, acmd_stats },
1480 { "trace", "[OPTIONS]", 0, 1, acmd_trace },
1482 { "tunnels", 0, 0, 0, acmd_tunnels },
1483 { "version", 0, 0, 0, acmd_version },
1484 { "warn", "MESSAGE ...", 1, 0xffff, acmd_warn },
1485 { "watch", "[OPTIONS]", 0, 1, acmd_watch },
1489 static void acmd_help(admin *a, unsigned ac, char *av[])
1492 for (c = acmdtab; c->name; c++) {
1494 a_info(a, "%s", c->name, "*%s", c->help, A_END);
1496 a_info(a, "%s", c->name, A_END);
1501 /*----- Connection handling -----------------------------------------------*/
1503 /* --- @a_destroypending@ --- *
1509 * Use: Destroys pending admin connections at a safe time.
1512 static void a_destroypending(void)
1515 admin_bgop *bg, *bbg;
1517 /* --- Destroy connections marked as pending --- */
1519 for (a = a_dead; a; a = aa) {
1521 assert(a->f & AF_DEAD);
1523 /* --- Report what we're doing --- */
1525 T( trace(T_ADMIN, "admin: completing destruction of connection %u",
1528 /* --- Abort any background jobs in progress --- */
1530 for (bg = a->bg; bg; bg = bbg) {
1533 if (bg->tag) xfree(bg->tag);
1537 /* --- Close file descriptors and selectory --- */
1539 selbuf_destroy(&a->b);
1540 if (a->b.reader.fd != a->w.fd) close(a->b.reader.fd);
1542 if (a_stdin == a) a_stdin = 0;
1549 /* --- All pending destruction completed --- */
1554 /* --- @a_destroy@ --- *
1556 * Arguments: @admin *a@ = pointer to an admin block
1560 * Use: Destroys an admin block. This requires a certain amount of
1564 static void freequeue(oqueue *q)
1568 for (o = q->hd; o; o = oo) {
1575 static void a_destroy(admin *a)
1580 if (a->next) a->next->prev = a->prev;
1581 if (a->prev) a->prev->next = a->next;
1582 else admins = a->next;
1584 if (a->out.hd) sel_rmfile(&a->w);
1591 T( trace(T_ADMIN, "admin: killing connection %u", a->seq); )
1594 /* --- @a_line@ --- *
1596 * Arguments: @char *p@ = pointer to the line read
1597 * @size_t len@ = length of the line
1598 * @void *vp@ = pointer to my admin block
1602 * Use: Handles a line of input.
1605 static void a_line(char *p, size_t len, void *vp)
1620 selbuf_disable(&a->b);
1624 ac = str_qsplit(p, av, 16, 0, STRF_QUOTE);
1627 for (c = acmdtab; c->name; c++) {
1628 if (mystrieq(av[0], c->name)) {
1630 if (c->argmin > ac || ac > c->argmax) {
1632 a_fail(a, "bad-syntax", "%s", c->name, "", A_END);
1634 a_fail(a, "bad-syntax", "%s", c->name, "%s", c->help, A_END);
1636 c->func(a, ac, av + 1);
1640 a_fail(a, "unknown-command", "%s", av[0], A_END);
1643 /* --- @a_create@ --- *
1645 * Arguments: @int fd_in, fd_out@ = file descriptors to use
1646 * @unsigned f@ = initial flags to set
1650 * Use: Creates a new admin connection.
1653 void a_create(int fd_in, int fd_out, unsigned f)
1655 admin *a = CREATE(admin);
1657 T( static unsigned seq = 0;
1659 T( trace(T_ADMIN, "admin: accepted connection %u", a->seq); )
1663 if (fd_in == STDIN_FILENO) a_stdin = a;
1664 fdflags(fd_in, O_NONBLOCK, O_NONBLOCK, FD_CLOEXEC, FD_CLOEXEC);
1665 if (fd_out != fd_in)
1666 fdflags(fd_out, O_NONBLOCK, O_NONBLOCK, FD_CLOEXEC, FD_CLOEXEC);
1667 selbuf_init(&a->b, &sel, fd_in, a_line, a);
1668 sel_initfile(&sel, &a->w, fd_out, SEL_WRITE, a_flush, a);
1669 a->out.hd = a->out.tl = 0;
1672 if (admins) admins->prev = a;
1676 /* --- @a_accept@ --- *
1678 * Arguments: @int fd@ = file descriptor to accept
1679 * @unsigned mode@ = what to do
1680 * @void *v@ = uninteresting pointer
1684 * Use: Accepts a new admin connection.
1687 static void a_accept(int fd, unsigned mode, void *v)
1690 struct sockaddr_un sun;
1691 size_t sz = sizeof(sun);
1693 if ((nfd = accept(fd, (struct sockaddr *)&sun, &sz)) < 0) {
1694 if (errno != EINTR && errno != EAGAIN && errno != EWOULDBLOCK &&
1695 errno != ECONNABORTED && errno != EPROTO)
1696 a_warn("ADMIN", "accept-error", "?ERRNO", A_END);
1699 a_create(nfd, nfd, 0);
1702 /* --- @a_preselect@ --- *
1708 * Use: Informs the admin module that we're about to select again,
1709 * and that it should do cleanup things it has delayed until a
1713 void a_preselect(void) { if (a_dead) a_destroypending(); }
1715 /* --- @a_daemon@ --- *
1721 * Use: Informs the admin module that it's a daemon.
1729 /* --- @a_init@ --- *
1731 * Arguments: @const char *name@ = socket name to create
1735 * Use: Creates the admin listening socket.
1738 void a_init(const char *name)
1742 struct sockaddr_un sun;
1743 struct sigaction sa;
1746 /* --- Set up the socket address --- */
1748 sz = strlen(name) + 1;
1749 if (sz > sizeof(sun.sun_path))
1750 die(EXIT_FAILURE, "socket name `%s' too long", name);
1752 sun.sun_family = AF_UNIX;
1753 memcpy(sun.sun_path, name, sz);
1754 sz += offsetof(struct sockaddr_un, sun_path);
1756 /* --- Attempt to bind to the socket --- */
1760 if ((fd = socket(PF_UNIX, SOCK_STREAM, 0)) < 0)
1761 die(EXIT_FAILURE, "couldn't create socket: %s", strerror(errno));
1762 if (bind(fd, (struct sockaddr *)&sun, sz) < 0) {
1765 if (errno != EADDRINUSE) {
1766 die(EXIT_FAILURE, "couldn't bind to address `%s': %s",
1767 sun.sun_path, strerror(e));
1770 die(EXIT_FAILURE, "too many retries; giving up");
1772 if (!connect(fd, (struct sockaddr *)&sun, sz)) {
1773 die(EXIT_FAILURE, "server already listening on admin socket `%s'",
1776 if (errno != ECONNREFUSED)
1777 die(EXIT_FAILURE, "couldn't bind to address: %s", strerror(e));
1778 if (stat(sun.sun_path, &st)) {
1779 die(EXIT_FAILURE, "couldn't stat `%s': %s",
1780 sun.sun_path, strerror(errno));
1782 if (!S_ISSOCK(st.st_mode))
1783 die(EXIT_FAILURE, "object `%s' isn't a socket", sun.sun_path);
1784 T( trace(T_ADMIN, "admin: stale socket found; removing it"); )
1785 unlink(sun.sun_path);
1789 chmod(sun.sun_path, 0600);
1790 fdflags(fd, O_NONBLOCK, O_NONBLOCK, FD_CLOEXEC, FD_CLOEXEC);
1792 die(EXIT_FAILURE, "couldn't listen on socket: %s", strerror(errno));
1794 /* --- Listen to the socket --- */
1796 sel_initfile(&sel, &sock, fd, SEL_READ, a_accept, 0);
1800 T( trace_custom(a_trace, 0);
1801 trace(T_ADMIN, "admin: enabled custom tracing"); )
1804 /* --- Set up signal handlers --- */
1806 sig_add(&s_term, SIGTERM, a_sigdie, 0);
1807 sig_add(&s_hup, SIGHUP, a_sighup, 0);
1808 signal(SIGPIPE, SIG_IGN);
1809 sigaction(SIGINT, 0, &sa);
1810 if (sa.sa_handler != SIG_IGN)
1811 sig_add(&s_int, SIGINT, a_sigdie, 0);
1814 /*----- That's all, folks -------------------------------------------------*/