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 --------------------------------------------------*/
66 static const char *sockname;
67 static unsigned flags = 0;
68 static admin *a_stdin = 0;
69 static sig s_term, s_int, s_hup;
74 #define T_RESOLVE SEC(30)
77 static void a_destroy(admin */*a*/);
78 static void a_lock(admin */*a*/);
79 static void a_unlock(admin */*a*/);
81 #define BOOL(x) ((x) ? "t" : "nil")
83 /*----- Output functions --------------------------------------------------*/
85 /* --- @trywrite@ --- *
87 * Arguments: @admin *a@ = pointer to an admin block
88 * @const char *p@ = pointer to buffer to write
89 * @size_t sz@ = size of data to write
91 * Returns: The number of bytes written, or less than zero on error.
93 * Use: Attempts to write data to a client.
96 static ssize_t trywrite(admin *a, const char *p, size_t sz)
103 n = write(a->w.fd, p, sz);
113 if (errno != EAGAIN && errno != EWOULDBLOCK) {
115 a_warn("ADMIN", "client-write-error", "?ERRNO", A_END);
122 /* --- @doqueue@ -- *
124 * Arguments: @oqueue *q@ = pointer to output queue
125 * @const char *p@ = pointer to buffer to write
126 * @size_t sz@ = size of buffer
128 * Returns: Nonzero if the queue was previously empty.
130 * Use: Queues data to be written later.
133 static int doqueue(oqueue *q, const char *p, size_t sz)
142 else if (o->p_in < o->buf + OBUFSZ)
146 o = xmalloc(sizeof(obuf));
148 o->p_in = o->p_out = o->buf;
156 n = o->buf + OBUFSZ - o->p_in;
159 memcpy(o->p_in, p, n);
168 /* --- @dosend@ --- *
170 * Arguemnts: @admin *a@ = pointer to an admin block
171 * @const char *p@ = pointer to buffer to write
172 * @size_t sz@ = size of data to write
176 * Use: Sends data to an admin client.
179 static void dosend(admin *a, const char *p, size_t sz)
186 if ((n = trywrite(a, p, sz)) < 0)
193 if (doqueue(&a->out, p, sz))
197 /* --- @a_flush@ --- *
199 * Arguments: @int fd@ = file descriptor
200 * @unsigned mode@ = what's happening
201 * @void *v@ = pointer to my admin block
205 * Use: Flushes buffers when a client is ready to read again.
208 static void a_flush(int fd, unsigned mode, void *v)
216 if ((n = trywrite(a, o->p_out, o->p_in - o->p_out)) < 0)
219 if (o->p_in < o->p_out)
232 /*----- Utility functions -------------------------------------------------*/
234 /* --- @quotify@ --- *
236 * Arguments: @dstr *d@ = where to write the answer
237 * @const char *p@ = string to quotify
241 * Use: Quotes the given string if necessary, according to our
245 static void quotify(dstr *d, const char *p)
249 if (*p && !p[strcspn(p, "\"' \t\n\v")])
254 if (*p == '\\' || *p == '\"')
262 /* --- @a_vformat@ --- *
264 * Arguments: @dstr *d@ = where to leave the formatted message
265 * @const char *fmt@ = pointer to format string
266 * @va_list ap@ = arguments in list
270 * Use: Main message token formatting driver.
273 static void a_vformat(dstr *d, const char *fmt, va_list ap)
280 dstr_vputf(d, fmt + 1, &ap);
281 } else if (*fmt == '?') {
282 if (strcmp(fmt, "?ADDR") == 0) {
283 const addr *a = va_arg(ap, const addr *);
284 switch (a->sa.sa_family) {
287 quotify(d, inet_ntoa(a->sin.sin_addr));
288 dstr_putf(d, " %u", (unsigned)ntohs(a->sin.sin_port));
293 } else if (strcmp(fmt, "?B64") == 0) {
294 const octet *p = va_arg(ap, const octet *);
295 size_t n = va_arg(ap, size_t);
301 base64_encode(&b64, p, n, d);
302 base64_encode(&b64, 0, 0, d);
303 while (d->len && d->buf[d->len - 1] == '=') d->len--;
304 } else if (strcmp(fmt, "?PEER") == 0)
305 quotify(d, p_name(va_arg(ap, peer *)));
306 else if (strcmp(fmt, "?ERRNO") == 0) {
307 dstr_putf(d, " E%d", errno);
308 quotify(d, strerror(errno));
312 if (*fmt == '!') fmt++;
314 dstr_vputf(&dd, fmt, &ap);
317 fmt = va_arg(ap, const char *);
323 /* --- @a_write@, @a_vwrite@ --- *
325 * Arguments: @admin *a@ = admin connection to write to
326 * @const char *status@ = status code to report
327 * @const char *tag@ = tag string, or null
328 * @const char *fmt@ = pointer to format string
329 * @va_list ap@ = arguments in list
330 * @...@ = other arguments
334 * Use: Sends a message to an admin connection.
337 static void a_vwrite(admin *a, const char *status, const char *tag,
338 const char *fmt, va_list ap)
342 if (tag) dstr_puts(&d, "BG");
343 dstr_puts(&d, status);
344 if (tag) quotify(&d, tag);
345 a_vformat(&d, fmt, ap);
347 dosend(a, d.buf, d.len);
351 static void a_write(admin *a, const char *status, const char *tag,
352 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, ...)
379 a_vwrite(a, "INFO", 0, fmt, ap);
383 static void a_fail(admin *a, const char *fmt, ...)
388 a_vwrite(a, "FAIL", 0, fmt, ap);
392 /* --- @a_alert@, @a_valert@, @a_rawalert@ --- *
394 * Arguments: @unsigned f_and, f_eq@ = filter for connections
395 * @const char *status@ = status string
396 * @const char *fmt@ = pointer to format string
397 * @const char *p@ = pointer to raw string
398 * @size_t sz@ = size of raw string
399 * @va_list ap@ = arguments in list
400 * @...@ = other arguments
404 * Use: Write a message to all admin connections matched by the given
408 static void a_rawalert(unsigned f_and, unsigned f_eq, const char *status,
409 const char *p, size_t sz)
414 if (!(flags & F_INIT))
416 dstr_puts(&d, status);
419 dstr_putm(&d, p, sz);
424 for (a = admins; a; a = aa) {
426 if ((a->f & f_and) == f_eq)
427 dosend(a, d.buf, d.len);
432 static void a_valert(unsigned f_and, unsigned f_eq, const char *status,
433 const char *fmt, va_list ap)
437 if (!(flags & F_INIT))
439 a_vformat(&d, fmt, ap);
440 a_rawalert(f_and, f_eq, status, fmt ? d.buf : 0, fmt ? d.len : 0);
445 static void a_alert(unsigned f_and, unsigned f_eq, const char *status,
446 const char *fmt, ...)
451 a_valert(f_and, f_eq, status, fmt, ap);
456 /* --- @a_warn@ --- *
458 * Arguments: @const char *fmt@ = pointer to format string
459 * @...@ = other arguments
463 * Use: Informs all admin connections of a warning.
466 void a_warn(const char *fmt, ...)
472 a_valert(0, 0, "WARN", fmt, ap);
475 fprintf(stderr, "%s: ", QUIS);
476 a_vformat(&d, fmt, ap);
478 dstr_write(&d, stderr);
484 /* --- @a_trace@ --- *
486 * Arguments: @const char *p@ = pointer to a buffer
487 * @size_t sz@ = size of the buffer
488 * @void *v@ = uninteresting pointer
492 * Use: Custom trace output handler. Sends trace messages to
493 * interested admin connections.
497 static void a_trace(const char *p, size_t sz, void *v)
498 { a_rawalert(AF_TRACE, AF_TRACE, "TRACE", p, sz); }
501 /* --- @a_notify@ --- *
503 * Arguments: @const char *fmt@ = pointer to format string
504 * @...@ = other arguments
508 * Use: Sends a notification to interested admin connections.
511 void a_notify(const char *fmt, ...)
516 a_valert(AF_NOTE, AF_NOTE, "NOTE", fmt, ap);
520 /* --- @a_quit@ --- *
526 * Use: Shuts things down nicely.
535 while ((p = p_first()) != 0)
540 /* --- @a_sigdie@ --- *
542 * Arguments: @int sig@ = signal number
543 * @void *v@ = an uninteresting argument
547 * Use Shuts down on receipt of a fatal signal.
550 static void a_sigdie(int sig, void *v)
556 case SIGTERM: p = "SIGTERM"; break;
557 case SIGINT: p = "SIGINT"; break;
559 sprintf(buf, "%i", sig);
563 a_warn("SERVER", "quit", "signal", "%s", p, A_END);
567 /* --- @a_sighup@ --- *
569 * Arguments: @int sig@ = signal number
570 * @void *v@ = an uninteresting argument
574 * Use Logs a message about SIGHUP not being useful.
577 static void a_sighup(int sig, void *v)
578 { a_warn("SERVER", "ignore", "signal", "SIGHUP", A_END); }
580 /* --- @a_parsetime@ --- *
582 * Arguments; @const char *p@ = time string to parse
584 * Returns: Time in seconds, or @< 0@ on error.
587 static long a_parsetime(const char *p)
590 long t = strtol(p, &q, 0);
596 case 's': if (q[1] != 0)
603 /* --- @a_findpeer@ --- *
605 * Arguments: @admin *a@ = admin connection
606 * @const char *pn@ = peer name
608 * Returns: The peer, or null if not there.
610 * Use: Finds a peer, reporting an error if it failed.
613 static peer *a_findpeer(admin *a, const char *pn)
617 if ((p = p_find(pn)) == 0)
618 a_fail(a, "unknown-peer", "%s", pn, A_END);
622 /*----- Backgrounded operations -------------------------------------------*/
625 (((admin_bgop *)(bg))->tag ? ((admin_bgop *)(bg))->tag : "<foreground>")
627 /* --- @a_bgrelease@ --- *
629 * Arguments: @admin_bgop *bg@ = backgrounded operation
633 * Use: Removes a backgrounded operation from the queue, since
634 * (presumably) it's done.
637 static void a_bgrelease(admin_bgop *bg)
641 T( trace(T_ADMIN, "admin: release bgop %s", BGTAG(bg)); )
642 if (bg->tag) xfree(bg->tag);
643 else selbuf_enable(&a->b);
644 if (bg->next) bg->next->prev = bg->prev;
645 if (bg->prev) bg->prev->next = bg->next;
646 else a->bg = bg->next;
648 if (a->f & AF_CLOSE) a_destroy(a);
652 /* --- @a_bgok@, @a_bginfo@, @a_bgfail@ --- *
654 * Arguments: @admin_bgop *bg@ = backgrounded operation
655 * @const char *fmt@ = format string
656 * @...@ = other arguments
660 * Use: Convenience functions for @a_write@.
663 static void a_bgok(admin_bgop *bg)
664 { a_write(bg->a, "OK", bg->tag, A_END); }
666 static void a_bginfo(admin_bgop *bg, const char *fmt, ...)
670 a_vwrite(bg->a, "INFO", bg->tag, fmt, ap);
674 static void a_bgfail(admin_bgop *bg, const char *fmt, ...)
678 a_vwrite(bg->a, "FAIL", bg->tag, fmt, ap);
682 /* --- @a_bgadd@ --- *
684 * Arguments: @admin *a@ = administration connection
685 * @admin_bgop *bg@ = pointer to background operation
686 * @const char *tag@ = background tag, or null for foreground
687 * @void (*cancel)(admin_bgop *)@ = cancel function
691 * Use: Links a background job into the list.
694 static void a_bgadd(admin *a, admin_bgop *bg, const char *tag,
695 void (*cancel)(admin_bgop *))
698 bg->tag = xstrdup(tag);
701 selbuf_disable(&a->b);
707 if (a->bg) a->bg->prev = bg;
710 T( trace(T_ADMIN, "admin: add bgop %s", BGTAG(bg)); )
711 if (tag) a_write(a, "DETACH", tag, A_END);
714 /*----- Name resolution operations ----------------------------------------*/
716 /* --- @a_resolved@ --- *
718 * Arguments: @struct hostent *h@ = pointer to resolved hostname
719 * @void *v@ = pointer to resolver operation
723 * Use: Handles a completed name resolution.
726 static void a_resolved(struct hostent *h, void *v)
730 T( trace(T_ADMIN, "admin: resop %s resolved", BGTAG(r)); )
733 a_bgfail(&r->bg, "resolve-error", "%s", r->addr, A_END);
734 r->func(r, ARES_FAIL);
736 memcpy(&r->sa.sin.sin_addr, h->h_addr, sizeof(struct in_addr));
744 /* --- @a_restimer@ --- *
746 * Arguments: @struct timeval *tv@ = timer
747 * @void *v@ = pointer to resolver operation
751 * Use: Times out a resolver.
754 static void a_restimer(struct timeval *tv, void *v)
758 T( trace(T_ADMIN, "admin: resop %s timeout", BGTAG(r)); )
759 a_bgfail(&r->bg, "resolver-timeout", "%s", r->addr, A_END);
760 r->func(r, ARES_FAIL);
766 /* --- @a_rescancel@ --- *
768 * Arguments: @admin_bgop *bg@ = background operation
772 * Use: Cancels an add operation.
775 static void a_rescancel(admin_bgop *bg)
777 admin_resop *r = (admin_resop *)bg;
779 T( trace(T_ADMIN, "admin: cancel resop %s", BGTAG(r)); )
780 r->func(r, ARES_FAIL);
786 /* --- @a_resolve@ --- *
788 * Arguments: @admin *a@ = administration connection
789 * @admin_resop *r@ = resolver operation to run
790 * @const char *tag@ = background operation tag
791 * @void (*func)(struct admin_resop *, int@ = handler function
792 * @unsigned ac@ = number of remaining arguments
793 * @char *av[]@ = pointer to remaining arguments
797 * Use: Cranks up a resolver job.
800 static void a_resolve(admin *a, admin_resop *r, const char *tag,
801 void (*func)(struct admin_resop *, int),
802 unsigned ac, char *av[])
809 /* --- Fill in the easy bits of address --- */
811 r->bg.tag = "<starting>";
814 if (mystrieq(av[i], "inet")) i++;
816 a_fail(a, "bad-addr-syntax", "[inet] ADDRESS PORT", A_END);
819 r->sa.sin.sin_family = AF_INET;
820 r->sasz = sizeof(r->sa.sin);
821 r->addr = xstrdup(av[i]);
822 pt = strtoul(av[i + 1], &p, 0);
824 struct servent *s = getservbyname(av[i + 1], "udp");
826 a_fail(a, "unknown-service", "%s", av[i + 1], A_END);
829 pt = ntohs(s->s_port);
831 if (pt == 0 || pt >= 65536) {
832 a_fail(a, "invalid-port", "%lu", pt, A_END);
835 r->sa.sin.sin_port = htons(pt);
837 /* --- Report backgrounding --- *
839 * Do this for consistency of interface, even if we're going to get the
840 * answer straight away.
843 a_bgadd(a, &r->bg, tag, a_rescancel);
844 T( trace(T_ADMIN, "admin: %u, resop %s, hostname `%s'",
845 a->seq, BGTAG(r), r->addr); )
847 /* --- If the name is numeric, do it the easy way --- */
849 if (inet_aton(av[i], &r->sa.sin.sin_addr)) {
850 T( trace(T_ADMIN, "admin: resop %s done the easy way", BGTAG(r)); )
857 /* --- Store everything for later and crank up the resolver --- */
859 gettimeofday(&tv, 0);
860 tv.tv_sec += T_RESOLVE;
861 sel_addtimer(&sel, &r->t, &tv, a_restimer, r);
862 bres_byname(&r->r, r->addr, a_resolved, r);
867 if (r->addr) xfree(r->addr);
871 /*----- Adding peers ------------------------------------------------------*/
873 /* --- @a_doadd@ --- *
875 * Arguments: @admin_resop *r@ = resolver operation
876 * @int rc@ = how it worked
880 * Use: Handles a completed resolution.
883 static void a_doadd(admin_resop *r, int rc)
885 admin_addop *add = (admin_addop *)r;
887 T( trace(T_ADMIN, "admin: done add op %s", BGTAG(add)); )
890 add->peer.sasz = add->r.sasz;
891 add->peer.sa = add->r.sa;
892 if (p_find(add->peer.name))
893 a_bgfail(&add->r.bg, "peer-exists", "%s", add->peer.name, A_END);
894 else if (!p_create(&add->peer))
895 a_bgfail(&add->r.bg, "peer-create-fail", "%s", add->peer.name, A_END);
900 xfree(add->peer.name);
903 /* --- @acmd_add@ --- *
905 * Arguments: @admin *a@ = connection which requested the addition
906 * @unsigned ac@ = argument count
907 * @char *av[]@ = pointer to the argument list
911 * Use: Adds a new peer.
914 static void acmd_add(admin *a, unsigned ac, char *av[])
918 admin_addop *add = 0;
920 /* --- Set stuff up --- */
922 add = xmalloc(sizeof(*add));
923 add->peer.name = xstrdup(av[0]);
925 add->peer.tops = tun_default;
927 /* --- Make sure someone's not got there already --- */
930 a_fail(a, "peer-exists", "%s", av[0], A_END);
934 /* --- Parse options --- */
940 if (mystrieq(av[i], "-background")) {
941 if (!av[++i]) goto bad_syntax;
943 } else if (mystrieq(av[i], "-tunnel")) {
944 if (!av[++i]) goto bad_syntax;
947 a_fail(a, "unknown-tunnel", "%s", av[i], A_END);
950 if (mystrieq(av[i], tunnels[j]->name)) {
951 add->peer.tops = tunnels[j];
955 } else if (mystrieq(av[i], "-keepalive")) {
957 if (!av[++i]) goto bad_syntax;
958 if ((t = a_parsetime(av[i])) < 0) {
959 a_fail(a, "bad-time-spec", "%s", av[i], A_END);
963 } else if (mystrieq(av[i], "--")) {
971 /* --- Crank up the resolver --- */
973 a_resolve(a, &add->r, tag, a_doadd, ac - i, av + i);
976 /* --- Clearing up --- */
979 a_fail(a, "bad-syntax", "add", "PEER [OPTIONS] ADDR ...", A_END);
981 xfree(add->peer.name);
986 /*----- Ping --------------------------------------------------------------*/
988 /* --- @a_pingcancel@ --- *
990 * Arguments: @admin_bgop *bg@ = background operation block
994 * Use: Cancels a running ping.
997 static void a_pingcancel(admin_bgop *bg)
999 admin_pingop *pg = (admin_pingop *)bg;
1000 T( trace(T_ADMIN, "admin: cancel ping op %s", BGTAG(pg)); )
1001 p_pingdone(&pg->ping, PING_NONOTIFY);
1004 /* --- @a_pong@ --- *
1006 * Arguments: @int rc@ = return code
1007 * @void *v@ = ping operation block
1011 * Use: Collects what happened to a ping message.
1014 static void a_pong(int rc, void *v)
1016 admin_pingop *pg = v;
1022 gettimeofday(&tv, 0);
1023 tv_sub(&tv, &tv, &pg->pingtime);
1024 millis = (double)tv.tv_sec * 1000 + (double)tv.tv_usec/1000;
1025 a_bginfo(&pg->bg, "ping-ok", "%.1f", millis, A_END);
1029 a_bginfo(&pg->bg, "ping-timeout", A_END);
1033 a_bginfo(&pg->bg, "ping-peer-died", A_END);
1039 T( trace(T_ADMIN, "admin: ponged ping op %s", BGTAG(pg)); )
1040 a_bgrelease(&pg->bg);
1043 /* --- @acmd_ping@, @acmd_eping@ --- *
1045 * Arguments: @admin *a@ = connection which requested the ping
1046 * @unsigned ac@ = argument count
1047 * @char *av[]@ = pointer to the argument list
1051 * Use: Pings a peer.
1054 static void a_ping(admin *a, unsigned ac, char *av[],
1055 const char *cmd, unsigned msg)
1060 admin_pingop *pg = 0;
1061 const char *tag = 0;
1067 if (mystrieq(av[i], "-background")) {
1068 if (!av[++i]) goto bad_syntax;
1070 } else if (mystrieq(av[i], "-timeout")) {
1071 if (!av[++i]) goto bad_syntax;
1072 if ((t = a_parsetime(av[i])) < 0) {
1073 a_fail(a, "bad-time-spec", "%s", av[i], A_END);
1076 } else if (mystrieq(av[i], "--")) {
1084 if (!av[i]) goto bad_syntax;
1085 if ((p = a_findpeer(a, av[i])) == 0)
1087 pg = xmalloc(sizeof(*pg));
1088 gettimeofday(&pg->pingtime, 0);
1089 a_bgadd(a, &pg->bg, tag, a_pingcancel);
1090 T( trace(T_ADMIN, "admin: ping op %s: %s to %s",
1091 BGTAG(pg), cmd, p_name(p)); )
1092 if (p_pingsend(p, &pg->ping, msg, t, a_pong, pg)) {
1093 a_bgfail(&pg->bg, "ping-send-failed", A_END);
1094 a_bgrelease(&pg->bg);
1099 a_fail(a, "bad-syntax", "%s", cmd, "[OPTIONS] PEER", cmd, A_END);
1103 static void acmd_ping(admin *a, unsigned ac, char *av[])
1104 { a_ping(a, ac, av, "ping", MISC_PING); }
1105 static void acmd_eping(admin *a, unsigned ac, char *av[])
1106 { a_ping(a, ac, av, "eping", MISC_EPING); }
1108 /*----- Administration commands -------------------------------------------*/
1110 /* --- Miscellaneous commands --- */
1112 /* --- @traceish@ --- *
1114 * Arguments: @admin *a@ = connection to complain on
1115 * @unsigned ac@ = number of arguments
1116 * @char *av[]@ = vector of arguments
1117 * @const char *what@ = what we're messing with
1118 * @const trace_opt *tt@ = options table
1119 * @unsigned *ff@ = where the flags are
1121 * Returns: Nonzero if anything changed.
1123 * Use: Guts of trace-ish commands like `trace' and `watch'.
1126 static int traceish(admin *a, unsigned ac, char *av[],
1127 const char *what, const trace_opt *tt, unsigned *ff)
1131 if (!ac || strcmp(av[0], "?") == 0) {
1133 for (t = tt; t->ch; t++) {
1134 a_info(a, "*%c%c %s",
1135 t->ch, (*ff & t->f) == t->f ? '+' : ' ', t->help, A_END);
1145 case '+': sense = 1; break;
1146 case '-': sense = 0; break;
1148 for (t = tt; t->ch; t++) {
1150 if (sense) f |= t->f;
1155 a_fail(a, "bad-%s-option", what, "%c", *p, A_END);
1171 static void acmd_trace(admin *a, unsigned ac, char *av[])
1173 if (traceish(a, ac, av, "trace", tr_opts, &tr_flags))
1174 trace_level(tr_flags);
1179 static void acmd_watch(admin *a, unsigned ac, char *av[])
1180 { traceish(a, ac, av, "watch", w_opts, &a->f); }
1182 static void alertcmd(admin *a, unsigned f_and, unsigned f_eq,
1183 const char *tag, unsigned ac, char *av[])
1188 dstr_puts(&d, "USER");
1189 for (i = 0; i < ac; i++)
1192 a_rawalert(f_and, f_eq, tag, d.buf, d.len);
1197 static void acmd_notify(admin *a, unsigned ac, char *av[])
1198 { alertcmd(a, AF_NOTE, AF_NOTE, "NOTE", ac, av); }
1199 static void acmd_warn(admin *a, unsigned ac, char *av[])
1200 { alertcmd(a, AF_WARN, AF_WARN, "WARN", ac, av); }
1202 static void acmd_port(admin *a, unsigned ac, char *av[])
1203 { a_info(a, "%u", p_port(), A_END); a_ok(a); }
1205 static void acmd_daemon(admin *a, unsigned ac, char *av[])
1207 if (flags & F_DAEMON)
1208 a_fail(a, "already-daemon", A_END);
1210 a_notify("DAEMON", A_END);
1214 a_fail(a, "daemon-error", "?ERRNO", A_END);
1222 static void acmd_list(admin *a, unsigned ac, char *av[])
1226 for (p = p_first(); p; p = p_next(p))
1227 a_info(a, "%s", p_name(p), A_END);
1231 static void acmd_ifname(admin *a, unsigned ac, char *av[])
1235 if ((p = a_findpeer(a, av[0])) != 0) {
1236 a_info(a, "%s", p_ifname(p), A_END);
1241 static void acmd_setifname(admin *a, unsigned ac, char *av[])
1245 if ((p = a_findpeer(a, av[0])) != 0) {
1246 a_notify("NEWIFNAME", "?PEER", p, "%s", p_ifname(p), "%s", av[1], A_END);
1247 p_setifname(p, av[1]);
1252 static void acmd_getchal(admin *a, unsigned ac, char *av[])
1256 buf_init(&b, buf_i, PKBUFSZ);
1258 a_info(a, "?B64", BBASE(&b), (size_t)BLEN(&b), A_END);
1262 static void acmd_checkchal(admin *a, unsigned ac, char *av[])
1269 base64_decode(&b64, av[0], strlen(av[0]), &d);
1270 base64_decode(&b64, 0, 0, &d);
1271 buf_init(&b, d.buf, d.len);
1272 if (c_check(&b) || BBAD(&b) || BLEFT(&b))
1273 a_fail(a, "invalid-challenge", A_END);
1279 static void acmd_greet(admin *a, unsigned ac, char *av[])
1285 if ((p = a_findpeer(a, av[0])) != 0) {
1287 base64_decode(&b64, av[1], strlen(av[1]), &d);
1288 base64_decode(&b64, 0, 0, &d);
1289 p_greet(p, d.buf, d.len);
1295 static void acmd_addr(admin *a, unsigned ac, char *av[])
1300 if ((p = a_findpeer(a, av[0])) != 0) {
1302 assert(ad->sa.sa_family == AF_INET);
1303 a_info(a, "?ADDR", ad, A_END);
1308 static void acmd_peerinfo(admin *a, unsigned ac, char *av[])
1313 if ((p = a_findpeer(a, av[0])) != 0) {
1315 a_info(a, "tunnel=%s", ps->tops->name, A_END);
1316 a_info(a, "keepalive=%lu", ps->t_ka, A_END);
1321 static void acmd_servinfo(admin *a, unsigned ac, char *av[])
1323 a_info(a, "implementation=edgeware-tripe", A_END);
1324 a_info(a, "version=%s", VERSION, A_END);
1325 a_info(a, "daemon=%s", BOOL(flags & F_DAEMON), A_END);
1329 static void acmd_stats(admin *a, unsigned ac, char *av[])
1334 if ((p = a_findpeer(a, av[0])) == 0)
1338 a_info(a, "start-time=%s", timestr(st->t_start), A_END);
1339 a_info(a, "last-packet-time=%s", timestr(st->t_last), A_END);
1340 a_info(a, "last-keyexch-time=%s", timestr(st->t_kx), A_END);
1341 a_info(a, "packets-in=%lu", st->n_in, "bytes-in=%lu", st->sz_in, A_END);
1343 "packets-out=%lu", st->n_out,
1344 "bytes-out=%lu", st->sz_out,
1347 "keyexch-packets-in=%lu", st->n_kxin,
1348 "keyexch-bytes-in=%lu", st->sz_kxin,
1351 "keyexch-packets-out=%lu", st->n_kxout,
1352 "keyexch-bytes-out=%lu", st->sz_kxout,
1355 "ip-packets-in=%lu", st->n_ipin,
1356 "ip-bytes-in=%lu", st->sz_ipin,
1359 "ip-packets-out=%lu", st->n_ipout,
1360 "ip-bytes-out=%lu", st->sz_ipout,
1362 a_info(a, "rejected-packets=%lu", st->n_reject, A_END);
1366 static void acmd_kill(admin *a, unsigned ac, char *av[])
1370 if ((p = a_findpeer(a, av[0])) != 0) {
1376 static void acmd_forcekx(admin *a, unsigned ac, char *av[])
1380 if ((p = a_findpeer(a, av[0])) != 0) {
1381 kx_start(&p->kx, 1);
1386 static void acmd_reload(admin *a, unsigned ac, char *av[])
1387 { p_keyreload(); a_ok(a); }
1389 static void acmd_quit(admin *a, unsigned ac, char *av[])
1391 a_warn("SERVER", "quit", "admin-request", A_END);
1397 static void acmd_version(admin *a, unsigned ac, char *av[])
1399 a_info(a, "%s", PACKAGE, "%s", VERSION, A_END);
1403 static void acmd_tunnels(admin *a, unsigned ac, char *av[])
1407 for (i = 0; tunnels[i]; i++)
1408 a_info(a, "%s", tunnels[i]->name, A_END);
1412 /* --- The command table and help --- */
1414 typedef struct acmd {
1417 unsigned argmin, argmax;
1418 void (*func)(admin */*a*/, unsigned /*ac*/, char */*av*/[]);
1421 static void acmd_help(admin */*a*/, unsigned /*ac*/, char */*av*/[]);
1423 static const acmd acmdtab[] = {
1424 { "add", "PEER [OPTIONS] ADDR ...", 2, 0xffff, acmd_add },
1425 { "addr", "PEER", 1, 1, acmd_addr },
1426 { "checkchal", "CHAL", 1, 1, acmd_checkchal },
1427 { "daemon", 0, 0, 0, acmd_daemon },
1428 { "eping", "[OPTIONS] PEER", 1, 0xffff, acmd_eping },
1429 { "forcekx", "PEER", 1, 1, acmd_forcekx },
1430 { "getchal", 0, 0, 0, acmd_getchal },
1431 { "greet", "PEER CHAL", 2, 2, acmd_greet },
1432 { "help", 0, 0, 0, acmd_help },
1433 { "ifname", "PEER", 1, 1, acmd_ifname },
1434 { "kill", "PEER", 1, 1, acmd_kill },
1435 { "list", 0, 0, 0, acmd_list },
1436 { "notify", "MESSAGE ...", 1, 0xffff, acmd_notify },
1437 { "peerinfo", "PEER", 1, 1, acmd_peerinfo },
1438 { "ping", "[OPTIONS] PEER", 1, 0xffff, acmd_ping },
1439 { "port", 0, 0, 0, acmd_port },
1440 { "quit", 0, 0, 0, acmd_quit },
1441 { "reload", 0, 0, 0, acmd_reload },
1442 { "servinfo", 0, 0, 0, acmd_servinfo },
1443 { "setifname", "PEER NEW-NAME", 2, 2, acmd_setifname },
1444 { "stats", "PEER", 1, 1, acmd_stats },
1446 { "trace", "[OPTIONS]", 0, 1, acmd_trace },
1448 { "tunnels", 0, 0, 0, acmd_tunnels },
1449 { "version", 0, 0, 0, acmd_version },
1450 { "warn", "MESSAGE ...", 1, 0xffff, acmd_warn },
1451 { "watch", "[OPTIONS]", 0, 1, acmd_watch },
1455 static void acmd_help(admin *a, unsigned ac, char *av[])
1459 for (c = acmdtab; c->name; c++) {
1461 a_info(a, "%s", c->name, "*%s", c->help, A_END);
1463 a_info(a, "%s", c->name, A_END);
1468 /*----- Connection handling -----------------------------------------------*/
1470 /* --- @a_lock@ --- *
1472 * Arguments: @admin *a@ = pointer to an admin block
1476 * Use: Locks an admin block so that it won't be destroyed
1480 static void a_lock(admin *a) { a->ref++; }
1482 /* --- @a_dodestroy@ --- *
1484 * Arguments: @admin *a@ = pointer to an admin block
1488 * Use: Actually does the legwork of destroying an admin block.
1491 static void a_dodestroy(admin *a)
1493 admin_bgop *bg, *bbg;
1495 T( trace(T_ADMIN, "admin: completing destruction of connection %u",
1498 selbuf_destroy(&a->b);
1499 for (bg = a->bg; bg; bg = bbg) {
1502 if (bg->tag) xfree(bg->tag);
1505 if (a->b.reader.fd != a->w.fd) close(a->b.reader.fd);
1511 a->next->prev = a->prev;
1513 a->prev->next = a->next;
1519 /* --- @a_unlock@ --- *
1521 * Arguments: @admin *a@ = pointer to an admin block
1525 * Use: Unlocks an admin block, allowing its destruction. This is
1526 * also the second half of @a_destroy@.
1529 static void a_unlock(admin *a)
1532 if (!--a->ref && (a->f & AF_DEAD))
1536 /* --- @a_destroy@ --- *
1538 * Arguments: @admin *a@ = pointer to an admin block
1542 * Use: Destroys an admin block. This requires a certain amount of
1546 static void freequeue(oqueue *q)
1550 for (o = q->hd; o; o = oo) {
1557 static void a_destroy(admin *a)
1559 /* --- Don't multiply destroy admin blocks --- */
1564 /* --- Make sure nobody expects it to work --- */
1567 T( trace(T_ADMIN, "admin: destroying connection %u", a->seq); )
1569 /* --- Free the output buffers --- */
1575 /* --- If the block is locked, that's all we can manage --- */
1580 trace(T_ADMIN, "admin: deferring destruction..."); )
1583 /* --- @a_line@ --- *
1585 * Arguments: @char *p@ = pointer to the line read
1586 * @size_t len@ = length of the line
1587 * @void *vp@ = pointer to my admin block
1591 * Use: Handles a line of input.
1594 static void a_line(char *p, size_t len, void *vp)
1609 selbuf_disable(&a->b);
1613 ac = str_qsplit(p, av, 16, 0, STRF_QUOTE);
1616 for (c = acmdtab; c->name; c++) {
1617 if (mystrieq(av[0], c->name)) {
1619 if (c->argmin > ac || ac > c->argmax) {
1621 a_fail(a, "bad-syntax", "%s", c->name, "", A_END);
1623 a_fail(a, "bad-syntax", "%s", c->name, "%s", c->help, A_END);
1626 c->func(a, ac, av + 1);
1632 a_fail(a, "unknown-command", "%s", av[0], A_END);
1635 /* --- @a_create@ --- *
1637 * Arguments: @int fd_in, fd_out@ = file descriptors to use
1638 * @unsigned f@ = initial flags to set
1642 * Use: Creates a new admin connection.
1645 void a_create(int fd_in, int fd_out, unsigned f)
1647 admin *a = CREATE(admin);
1649 T( static unsigned seq = 0;
1651 T( trace(T_ADMIN, "admin: accepted connection %u", a->seq); )
1655 if (fd_in == STDIN_FILENO) a_stdin = a;
1656 fdflags(fd_in, O_NONBLOCK, O_NONBLOCK, FD_CLOEXEC, FD_CLOEXEC);
1657 if (fd_out != fd_in)
1658 fdflags(fd_out, O_NONBLOCK, O_NONBLOCK, FD_CLOEXEC, FD_CLOEXEC);
1659 selbuf_init(&a->b, &sel, fd_in, a_line, a);
1660 sel_initfile(&sel, &a->w, fd_out, SEL_WRITE, a_flush, a);
1661 a->out.hd = a->out.tl = 0;
1664 if (admins) admins->prev = a;
1668 /* --- @a_accept@ --- *
1670 * Arguments: @int fd@ = file descriptor to accept
1671 * @unsigned mode@ = what to do
1672 * @void *v@ = uninteresting pointer
1676 * Use: Accepts a new admin connection.
1679 static void a_accept(int fd, unsigned mode, void *v)
1682 struct sockaddr_un sun;
1683 size_t sz = sizeof(sun);
1685 if ((nfd = accept(fd, (struct sockaddr *)&sun, &sz)) < 0) {
1686 if (errno != EINTR && errno != EAGAIN && errno != EWOULDBLOCK &&
1687 errno != ECONNABORTED && errno != EPROTO)
1688 a_warn("ADMIN", "accept-error", "?ERRNO", A_END);
1691 a_create(nfd, nfd, 0);
1694 /* --- @a_daemon@ --- *
1700 * Use: Informs the admin module that it's a daemon.
1703 void a_daemon(void) { flags |= F_DAEMON; }
1705 /* --- @a_init@ --- *
1707 * Arguments: @const char *name@ = socket name to create
1711 * Use: Creates the admin listening socket.
1714 void a_init(const char *name)
1718 struct sockaddr_un sun;
1719 struct sigaction sa;
1722 /* --- Set up the socket address --- */
1724 sz = strlen(name) + 1;
1725 if (sz > sizeof(sun.sun_path))
1726 die(EXIT_FAILURE, "socket name `%s' too long", name);
1728 sun.sun_family = AF_UNIX;
1729 memcpy(sun.sun_path, name, sz);
1730 sz += offsetof(struct sockaddr_un, sun_path);
1732 /* --- Attempt to bind to the socket --- */
1736 if ((fd = socket(PF_UNIX, SOCK_STREAM, 0)) < 0)
1737 die(EXIT_FAILURE, "couldn't create socket: %s", strerror(errno));
1738 if (bind(fd, (struct sockaddr *)&sun, sz) < 0) {
1741 if (errno != EADDRINUSE) {
1742 die(EXIT_FAILURE, "couldn't bind to address `%s': %s",
1743 sun.sun_path, strerror(e));
1746 die(EXIT_FAILURE, "too many retries; giving up");
1748 if (!connect(fd, (struct sockaddr *)&sun, sz)) {
1749 die(EXIT_FAILURE, "server already listening on admin socket `%s'",
1752 if (errno != ECONNREFUSED)
1753 die(EXIT_FAILURE, "couldn't bind to address: %s", strerror(e));
1754 if (stat(sun.sun_path, &st)) {
1755 die(EXIT_FAILURE, "couldn't stat `%s': %s",
1756 sun.sun_path, strerror(errno));
1758 if (!S_ISSOCK(st.st_mode))
1759 die(EXIT_FAILURE, "object `%s' isn't a socket", sun.sun_path);
1760 T( trace(T_ADMIN, "admin: stale socket found; removing it"); )
1761 unlink(sun.sun_path);
1765 chmod(sun.sun_path, 0600);
1766 fdflags(fd, O_NONBLOCK, O_NONBLOCK, FD_CLOEXEC, FD_CLOEXEC);
1768 die(EXIT_FAILURE, "couldn't listen on socket: %s", strerror(errno));
1770 /* --- Listen to the socket --- */
1772 sel_initfile(&sel, &sock, fd, SEL_READ, a_accept, 0);
1776 T( trace_custom(a_trace, 0);
1777 trace(T_ADMIN, "admin: enabled custom tracing"); )
1780 /* --- Set up signal handlers --- */
1782 sig_add(&s_term, SIGTERM, a_sigdie, 0);
1783 sig_add(&s_hup, SIGHUP, a_sighup, 0);
1784 signal(SIGPIPE, SIG_IGN);
1785 sigaction(SIGINT, 0, &sa);
1786 if (sa.sa_handler != SIG_IGN)
1787 sig_add(&s_int, SIGINT, a_sigdie, 0);
1790 /*----- That's all, folks -------------------------------------------------*/