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)
341 if (tag) dstr_puts(&d, "BG");
342 dstr_puts(&d, status);
343 if (tag) quotify(&d, tag);
344 a_vformat(&d, fmt, ap);
346 dosend(a, d.buf, d.len);
350 static void a_write(admin *a, const char *status, const char *tag,
351 const char *fmt, ...)
355 a_vwrite(a, status, tag, fmt, ap);
359 /* --- @a_ok@, @a_info@, @a_fail@ --- *
361 * Arguments: @admin *a@ = connection
362 * @const char *fmt@ = format string
363 * @...@ = other arguments
367 * Use: Convenience functions for @a_write@.
370 static void a_ok(admin *a) { a_write(a, "OK", 0, A_END); }
372 static void a_info(admin *a, const char *fmt, ...)
376 a_vwrite(a, "INFO", 0, fmt, ap);
380 static void a_fail(admin *a, const char *fmt, ...)
384 a_vwrite(a, "FAIL", 0, fmt, ap);
388 /* --- @a_alert@, @a_valert@, @a_rawalert@ --- *
390 * Arguments: @unsigned f_and, f_eq@ = filter for connections
391 * @const char *status@ = status string
392 * @const char *fmt@ = pointer to format string
393 * @const char *p@ = pointer to raw string
394 * @size_t sz@ = size of raw string
395 * @va_list ap@ = arguments in list
396 * @...@ = other arguments
400 * Use: Write a message to all admin connections matched by the given
404 static void a_rawalert(unsigned f_and, unsigned f_eq, const char *status,
405 const char *p, size_t sz)
410 if (!(flags & F_INIT))
412 dstr_puts(&d, status);
415 dstr_putm(&d, p, sz);
420 for (a = admins; a; a = aa) {
422 if ((a->f & f_and) == f_eq)
423 dosend(a, d.buf, d.len);
428 static void a_valert(unsigned f_and, unsigned f_eq, const char *tag,
429 const char *fmt, va_list ap)
433 if (!(flags & F_INIT))
435 a_vformat(&d, fmt, ap);
436 a_rawalert(f_and, f_eq, tag, fmt ? d.buf : 0, fmt ? d.len : 0);
441 static void a_alert(unsigned f_and, unsigned f_eq, const char *tag,
442 const char *fmt, ...)
446 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_bgrelease@ --- *
626 * Arguments: @admin_bgop *bg@ = backgrounded operation
630 * Use: Removes a backgrounded operation from the queue, since
631 * (presumably) it's done.
634 static void a_bgrelease(admin_bgop *bg)
638 T( trace(T_ADMIN, "admin: release bgop %s", BGTAG(bg)); )
639 if (bg->tag) xfree(bg->tag);
640 else selbuf_enable(&a->b);
641 if (bg->next) bg->next->prev = bg->prev;
642 if (bg->prev) bg->prev->next = bg->next;
643 else a->bg = bg->next;
645 if (a->f & AF_CLOSE) a_destroy(a);
649 /* --- @a_bgok@, @a_bginfo@, @a_bgfail@ --- *
651 * Arguments: @admin_bgop *bg@ = backgrounded operation
652 * @const char *fmt@ = format string
653 * @...@ = other arguments
657 * Use: Convenience functions for @a_write@.
660 static void a_bgok(admin_bgop *bg)
661 { a_write(bg->a, "OK", bg->tag, A_END); }
663 static void a_bginfo(admin_bgop *bg, const char *fmt, ...)
667 a_vwrite(bg->a, "INFO", bg->tag, fmt, ap);
671 static void a_bgfail(admin_bgop *bg, const char *fmt, ...)
675 a_vwrite(bg->a, "FAIL", bg->tag, fmt, ap);
679 /* --- @a_bgadd@ --- *
681 * Arguments: @admin *a@ = administration connection
682 * @admin_bgop *bg@ = pointer to background operation
683 * @const char *tag@ = background tag, or null for foreground
684 * @void (*cancel)(admin_bgop *)@ = cancel function
688 * Use: Links a background job into the list.
691 static void a_bgadd(admin *a, admin_bgop *bg, const char *tag,
692 void (*cancel)(admin_bgop *))
695 bg->tag = xstrdup(tag);
698 selbuf_disable(&a->b);
704 if (a->bg) a->bg->prev = bg;
707 T( trace(T_ADMIN, "admin: add bgop %s", BGTAG(bg)); )
708 if (tag) a_write(a, "DETACH", tag, A_END);
711 /*----- Name resolution operations ----------------------------------------*/
713 /* --- @a_resolved@ --- *
715 * Arguments: @struct hostent *h@ = pointer to resolved hostname
716 * @void *v@ = pointer to resolver operation
720 * Use: Handles a completed name resolution.
723 static void a_resolved(struct hostent *h, void *v)
727 T( trace(T_ADMIN, "admin: resop %s resolved", BGTAG(r)); )
730 a_bgfail(&r->bg, "resolve-error", "%s", r->addr, A_END);
731 r->func(r, ARES_FAIL);
733 memcpy(&r->sa.sin.sin_addr, h->h_addr, sizeof(struct in_addr));
741 /* --- @a_restimer@ --- *
743 * Arguments: @struct timeval *tv@ = timer
744 * @void *v@ = pointer to resolver operation
748 * Use: Times out a resolver.
751 static void a_restimer(struct timeval *tv, void *v)
755 T( trace(T_ADMIN, "admin: resop %s timeout", BGTAG(r)); )
756 a_bgfail(&r->bg, "resolver-timeout", "%s", r->addr, A_END);
757 r->func(r, ARES_FAIL);
763 /* --- @a_rescancel@ --- *
765 * Arguments: @admin_bgop *bg@ = background operation
769 * Use: Cancels an add operation.
772 static void a_rescancel(admin_bgop *bg)
774 admin_resop *r = (admin_resop *)bg;
776 T( trace(T_ADMIN, "admin: cancel resop %s", BGTAG(r)); )
777 r->func(r, ARES_FAIL);
783 /* --- @a_resolve@ --- *
785 * Arguments: @admin *a@ = administration connection
786 * @admin_resop *r@ = resolver operation to run
787 * @const char *tag@ = background operation tag
788 * @void (*func)(struct admin_resop *, int@ = handler function
789 * @unsigned ac@ = number of remaining arguments
790 * @char *av[]@ = pointer to remaining arguments
794 * Use: Cranks up a resolver job.
797 static void a_resolve(admin *a, admin_resop *r, const char *tag,
798 void (*func)(struct admin_resop *, int),
799 unsigned ac, char *av[])
806 /* --- Fill in the easy bits of address --- */
808 r->bg.tag = "<starting>";
811 if (mystrieq(av[i], "inet")) i++;
813 a_fail(a, "bad-addr-syntax", "[inet] ADDRESS PORT", A_END);
816 r->sa.sin.sin_family = AF_INET;
817 r->sasz = sizeof(r->sa.sin);
818 r->addr = xstrdup(av[i]);
819 pt = strtoul(av[i + 1], &p, 0);
821 struct servent *s = getservbyname(av[i + 1], "udp");
823 a_fail(a, "unknown-service", "%s", av[i + 1], A_END);
826 pt = ntohs(s->s_port);
828 if (pt == 0 || pt >= 65536) {
829 a_fail(a, "invalid-port", "%lu", pt, A_END);
832 r->sa.sin.sin_port = htons(pt);
834 /* --- Report backgrounding --- *
836 * Do this for consistency of interface, even if we're going to get the
837 * answer straight away.
840 a_bgadd(a, &r->bg, tag, a_rescancel);
841 T( trace(T_ADMIN, "admin: %u, resop %s, hostname `%s'",
842 a->seq, BGTAG(r), r->addr); )
844 /* --- If the name is numeric, do it the easy way --- */
846 if (inet_aton(av[i], &r->sa.sin.sin_addr)) {
847 T( trace(T_ADMIN, "admin: resop %s done the easy way", BGTAG(r)); )
854 /* --- Store everything for later and crank up the resolver --- */
856 gettimeofday(&tv, 0);
857 tv.tv_sec += T_RESOLVE;
858 sel_addtimer(&sel, &r->t, &tv, a_restimer, r);
859 bres_byname(&r->r, r->addr, a_resolved, r);
864 if (r->addr) xfree(r->addr);
868 /*----- Adding peers ------------------------------------------------------*/
870 /* --- @a_doadd@ --- *
872 * Arguments: @admin_resop *r@ = resolver operation
873 * @int rc@ = how it worked
877 * Use: Handles a completed resolution.
880 static void a_doadd(admin_resop *r, int rc)
882 admin_addop *add = (admin_addop *)r;
884 T( trace(T_ADMIN, "admin: done add op %s", BGTAG(add)); )
887 add->peer.sasz = add->r.sasz;
888 add->peer.sa = add->r.sa;
889 if (p_find(add->peer.name))
890 a_bgfail(&add->r.bg, "peer-exists", "%s", add->peer.name, A_END);
891 else if (!p_create(&add->peer))
892 a_bgfail(&add->r.bg, "peer-create-fail", "%s", add->peer.name, A_END);
897 xfree(add->peer.name);
900 /* --- @acmd_add@ --- *
902 * Arguments: @admin *a@ = connection which requested the addition
903 * @unsigned ac@ = argument count
904 * @char *av[]@ = pointer to the argument list
908 * Use: Adds a new peer.
911 static void acmd_add(admin *a, unsigned ac, char *av[])
915 admin_addop *add = 0;
917 /* --- Set stuff up --- */
919 add = xmalloc(sizeof(*add));
920 add->peer.name = xstrdup(av[0]);
922 add->peer.tops = tun_default;
924 /* --- Make sure someone's not got there already --- */
927 a_fail(a, "peer-exists", "%s", av[0], A_END);
931 /* --- Parse options --- */
937 if (mystrieq(av[i], "-background")) {
938 if (!av[++i]) goto bad_syntax;
940 } else if (mystrieq(av[i], "-tunnel")) {
941 if (!av[++i]) goto bad_syntax;
944 a_fail(a, "unknown-tunnel", "%s", av[i], A_END);
947 if (mystrieq(av[i], tunnels[j]->name)) {
948 add->peer.tops = tunnels[j];
952 } else if (mystrieq(av[i], "-keepalive")) {
954 if (!av[++i]) goto bad_syntax;
955 if ((t = a_parsetime(av[i])) < 0) {
956 a_fail(a, "bad-time-spec", "%s", av[i], A_END);
960 } else if (mystrieq(av[i], "--")) {
968 /* --- Crank up the resolver --- */
970 a_resolve(a, &add->r, tag, a_doadd, ac - i, av + i);
973 /* --- Clearing up --- */
976 a_fail(a, "bad-syntax", "add", "PEER [OPTIONS] ADDR ...", A_END);
978 xfree(add->peer.name);
983 /*----- Ping --------------------------------------------------------------*/
985 /* --- @a_pingcancel@ --- *
987 * Arguments: @admin_bgop *bg@ = background operation block
991 * Use: Cancels a running ping.
994 static void a_pingcancel(admin_bgop *bg)
996 admin_pingop *pg = (admin_pingop *)bg;
997 T( trace(T_ADMIN, "admin: cancel ping op %s", BGTAG(pg)); )
998 p_pingdone(&pg->ping, PING_NONOTIFY);
1001 /* --- @a_pong@ --- *
1003 * Arguments: @int rc@ = return code
1004 * @void *v@ = ping operation block
1008 * Use: Collects what happened to a ping message.
1011 static void a_pong(int rc, void *v)
1013 admin_pingop *pg = v;
1019 gettimeofday(&tv, 0);
1020 tv_sub(&tv, &tv, &pg->pingtime);
1021 millis = (double)tv.tv_sec * 1000 + (double)tv.tv_usec/1000;
1022 a_bginfo(&pg->bg, "ping-ok", "%.1f", millis, A_END);
1026 a_bginfo(&pg->bg, "ping-timeout", A_END);
1030 a_bginfo(&pg->bg, "ping-peer-died", A_END);
1036 T( trace(T_ADMIN, "admin: ponged ping op %s", BGTAG(pg)); )
1037 a_bgrelease(&pg->bg);
1040 /* --- @acmd_ping@, @acmd_eping@ --- *
1042 * Arguments: @admin *a@ = connection which requested the ping
1043 * @unsigned ac@ = argument count
1044 * @char *av[]@ = pointer to the argument list
1048 * Use: Pings a peer.
1051 static void a_ping(admin *a, unsigned ac, char *av[],
1052 const char *cmd, unsigned msg)
1057 admin_pingop *pg = 0;
1058 const char *tag = 0;
1064 if (mystrieq(av[i], "-background")) {
1065 if (!av[++i]) goto bad_syntax;
1067 } else if (mystrieq(av[i], "-timeout")) {
1068 if (!av[++i]) goto bad_syntax;
1069 if ((t = a_parsetime(av[i])) < 0) {
1070 a_fail(a, "bad-time-spec", "%s", av[i], A_END);
1073 } else if (mystrieq(av[i], "--")) {
1081 if (!av[i]) goto bad_syntax;
1082 if ((p = a_findpeer(a, av[i])) == 0)
1084 pg = xmalloc(sizeof(*pg));
1085 gettimeofday(&pg->pingtime, 0);
1086 a_bgadd(a, &pg->bg, tag, a_pingcancel);
1087 T( trace(T_ADMIN, "admin: ping op %s: %s to %s",
1088 BGTAG(pg), cmd, p_name(p)); )
1089 if (p_pingsend(p, &pg->ping, msg, t, a_pong, pg)) {
1090 a_bgfail(&pg->bg, "ping-send-failed", A_END);
1091 a_bgrelease(&pg->bg);
1096 a_fail(a, "bad-syntax", "%s", cmd, "[OPTIONS] PEER", cmd, A_END);
1100 static void acmd_ping(admin *a, unsigned ac, char *av[])
1101 { a_ping(a, ac, av, "ping", MISC_PING); }
1102 static void acmd_eping(admin *a, unsigned ac, char *av[])
1103 { a_ping(a, ac, av, "eping", MISC_EPING); }
1105 /*----- Administration commands -------------------------------------------*/
1107 /* --- Miscellaneous commands --- */
1109 /* --- @traceish@ --- *
1111 * Arguments: @admin *a@ = connection to complain on
1112 * @unsigned ac@ = number of arguments
1113 * @char *av[]@ = vector of arguments
1114 * @const char *what@ = what we're messing with
1115 * @const trace_opt *tt@ = options table
1116 * @unsigned *ff@ = where the flags are
1118 * Returns: Nonzero if anything changed.
1120 * Use: Guts of trace-ish commands like `trace' and `watch'.
1123 static int traceish(admin *a, unsigned ac, char *av[],
1124 const char *what, const trace_opt *tt, unsigned *ff)
1128 if (!ac || strcmp(av[0], "?") == 0) {
1130 for (t = tt; t->ch; t++) {
1131 a_info(a, "*%c%c %s",
1132 t->ch, (*ff & t->f) == t->f ? '+' : ' ', t->help, A_END);
1142 case '+': sense = 1; break;
1143 case '-': sense = 0; break;
1145 for (t = tt; t->ch; t++) {
1147 if (sense) f |= t->f;
1152 a_fail(a, "bad-%s-option", what, "%c", *p, A_END);
1168 static void acmd_trace(admin *a, unsigned ac, char *av[])
1170 if (traceish(a, ac, av, "trace", tr_opts, &tr_flags))
1171 trace_level(tr_flags);
1176 static void acmd_watch(admin *a, unsigned ac, char *av[])
1178 traceish(a, ac, av, "watch", w_opts, &a->f);
1181 static void alertcmd(admin *a, unsigned f_and, unsigned f_eq,
1182 const char *tag, unsigned ac, char *av[])
1187 dstr_puts(&d, "USER");
1188 for (i = 0; i < ac; i++)
1191 a_rawalert(f_and, f_eq, tag, d.buf, d.len);
1196 static void acmd_notify(admin *a, unsigned ac, char *av[])
1197 { alertcmd(a, AF_NOTE, AF_NOTE, "NOTE", ac, av); }
1198 static void acmd_warn(admin *a, unsigned ac, char *av[])
1199 { alertcmd(a, AF_WARN, AF_WARN, "WARN", ac, av); }
1201 static void acmd_port(admin *a, unsigned ac, char *av[])
1203 a_info(a, "%u", p_port(), A_END);
1207 static void acmd_daemon(admin *a, unsigned ac, char *av[])
1209 if (flags & F_DAEMON)
1210 a_fail(a, "already-daemon", A_END);
1212 a_notify("DAEMON", A_END);
1216 a_fail(a, "daemon-error", "?ERRNO", A_END);
1224 static void acmd_list(admin *a, unsigned ac, char *av[])
1227 for (p = p_first(); p; p = p_next(p))
1228 a_info(a, "%s", p_name(p), A_END);
1232 static void acmd_ifname(admin *a, unsigned ac, char *av[])
1236 if ((p = a_findpeer(a, av[0])) != 0) {
1237 a_info(a, "%s", p_ifname(p), A_END);
1242 static void acmd_setifname(admin *a, unsigned ac, char *av[])
1246 if ((p = a_findpeer(a, av[0])) != 0) {
1247 a_notify("NEWIFNAME", "?PEER", p, "%s", p_ifname(p), "%s", av[1], A_END);
1248 p_setifname(p, av[1]);
1253 static void acmd_getchal(admin *a, unsigned ac, char *av[])
1257 buf_init(&b, buf_i, PKBUFSZ);
1259 a_info(a, "?B64", BBASE(&b), (size_t)BLEN(&b), A_END);
1263 static void acmd_checkchal(admin *a, unsigned ac, char *av[])
1270 base64_decode(&b64, av[0], strlen(av[0]), &d);
1271 base64_decode(&b64, 0, 0, &d);
1272 buf_init(&b, d.buf, d.len);
1273 if (c_check(&b) || BBAD(&b) || BLEFT(&b))
1274 a_fail(a, "invalid-challenge", A_END);
1280 static void acmd_greet(admin *a, unsigned ac, char *av[])
1286 if ((p = a_findpeer(a, av[0])) != 0) {
1288 base64_decode(&b64, av[1], strlen(av[1]), &d);
1289 base64_decode(&b64, 0, 0, &d);
1290 p_greet(p, d.buf, d.len);
1296 static void acmd_addr(admin *a, unsigned ac, char *av[])
1301 if ((p = a_findpeer(a, av[0])) != 0) {
1303 assert(ad->sa.sa_family == AF_INET);
1304 a_info(a, "?ADDR", ad, A_END);
1309 static void acmd_peerinfo(admin *a, unsigned ac, char *av[])
1314 if ((p = a_findpeer(a, av[0])) != 0) {
1316 a_info(a, "tunnel=%s", ps->tops->name, A_END);
1317 a_info(a, "keepalive=%lu", ps->t_ka, A_END);
1322 static void acmd_servinfo(admin *a, unsigned ac, char *av[])
1324 a_info(a, "implementation=edgeware-tripe", A_END);
1325 a_info(a, "version=%s", VERSION, A_END);
1326 a_info(a, "daemon=%s", BOOL(flags & F_DAEMON), A_END);
1330 static void acmd_stats(admin *a, unsigned ac, char *av[])
1335 if ((p = a_findpeer(a, av[0])) == 0)
1339 a_info(a, "start-time=%s", timestr(st->t_start), A_END);
1340 a_info(a, "last-packet-time=%s", timestr(st->t_last), A_END);
1341 a_info(a, "last-keyexch-time=%s", timestr(st->t_kx), A_END);
1342 a_info(a, "packets-in=%lu bytes-in=%lu", st->n_in, st->sz_in, A_END);
1343 a_info(a, "packets-out=%lu bytes-out=%lu",
1344 st->n_out, st->sz_out, A_END);
1345 a_info(a, "keyexch-packets-in=%lu keyexch-bytes-in=%lu",
1346 st->n_kxin, st->sz_kxin, A_END);
1347 a_info(a, "keyexch-packets-out=%lu keyexch-bytes-out=%lu",
1348 st->n_kxout, st->sz_kxout, A_END);
1349 a_info(a, "ip-packets-in=%lu ip-bytes-in=%lu",
1350 st->n_ipin, st->sz_ipin, A_END);
1351 a_info(a, "ip-packets-out=%lu ip-bytes-out=%lu",
1352 st->n_ipout, st->sz_ipout, A_END);
1353 a_info(a, "rejected-packets=%lu", st->n_reject, A_END);
1357 static void acmd_kill(admin *a, unsigned ac, char *av[])
1360 if ((p = a_findpeer(a, av[0])) != 0) {
1366 static void acmd_forcekx(admin *a, unsigned ac, char *av[])
1369 if ((p = a_findpeer(a, av[0])) != 0) {
1370 kx_start(&p->kx, 1);
1375 static void acmd_reload(admin *a, unsigned ac, char *av[])
1376 { p_keyreload(); a_ok(a); }
1378 static void acmd_quit(admin *a, unsigned ac, char *av[])
1380 a_warn("SERVER", "quit", "admin-request", A_END);
1386 static void acmd_version(admin *a, unsigned ac, char *av[])
1388 a_info(a, "%s", PACKAGE, "%s", VERSION, A_END);
1392 static void acmd_tunnels(admin *a, unsigned ac, char *av[])
1395 for (i = 0; tunnels[i]; i++)
1396 a_info(a, "%s", tunnels[i]->name, A_END);
1400 /* --- The command table and help --- */
1402 typedef struct acmd {
1405 unsigned argmin, argmax;
1406 void (*func)(admin */*a*/, unsigned /*ac*/, char */*av*/[]);
1409 static void acmd_help(admin */*a*/, unsigned /*ac*/, char */*av*/[]);
1411 static const acmd acmdtab[] = {
1412 { "add", "PEER [OPTIONS] ADDR ...", 2, 0xffff, acmd_add },
1413 { "addr", "PEER", 1, 1, acmd_addr },
1414 { "checkchal", "CHAL", 1, 1, acmd_checkchal },
1415 { "daemon", 0, 0, 0, acmd_daemon },
1416 { "eping", "[OPTIONS] PEER", 1, 0xffff, acmd_eping },
1417 { "forcekx", "PEER", 1, 1, acmd_forcekx },
1418 { "getchal", 0, 0, 0, acmd_getchal },
1419 { "greet", "PEER CHAL", 2, 2, acmd_greet },
1420 { "help", 0, 0, 0, acmd_help },
1421 { "ifname", "PEER", 1, 1, acmd_ifname },
1422 { "kill", "PEER", 1, 1, acmd_kill },
1423 { "list", 0, 0, 0, acmd_list },
1424 { "notify", "MESSAGE ...", 1, 0xffff, acmd_notify },
1425 { "peerinfo", "PEER", 1, 1, acmd_peerinfo },
1426 { "ping", "[OPTIONS] PEER", 1, 0xffff, acmd_ping },
1427 { "port", 0, 0, 0, acmd_port },
1428 { "quit", 0, 0, 0, acmd_quit },
1429 { "reload", 0, 0, 0, acmd_reload },
1430 { "servinfo", 0, 0, 0, acmd_servinfo },
1431 { "setifname", "PEER NEW-NAME", 2, 2, acmd_setifname },
1432 { "stats", "PEER", 1, 1, acmd_stats },
1434 { "trace", "[OPTIONS]", 0, 1, acmd_trace },
1436 { "tunnels", 0, 0, 0, acmd_tunnels },
1437 { "version", 0, 0, 0, acmd_version },
1438 { "warn", "MESSAGE ...", 1, 0xffff, acmd_warn },
1439 { "watch", "[OPTIONS]", 0, 1, acmd_watch },
1443 static void acmd_help(admin *a, unsigned ac, char *av[])
1446 for (c = acmdtab; c->name; c++) {
1448 a_info(a, "%s", c->name, "*%s", c->help, A_END);
1450 a_info(a, "%s", c->name, A_END);
1455 /*----- Connection handling -----------------------------------------------*/
1457 /* --- @a_lock@ --- *
1459 * Arguments: @admin *a@ = pointer to an admin block
1463 * Use: Locks an admin block so that it won't be destroyed
1467 static void a_lock(admin *a) { a->ref++; }
1469 /* --- @a_dodestroy@ --- *
1471 * Arguments: @admin *a@ = pointer to an admin block
1475 * Use: Actually does the legwork of destroying an admin block.
1478 static void a_dodestroy(admin *a)
1480 admin_bgop *bg, *bbg;
1482 T( trace(T_ADMIN, "admin: completing destruction of connection %u",
1485 selbuf_destroy(&a->b);
1486 for (bg = a->bg; bg; bg = bbg) {
1489 if (bg->tag) xfree(bg->tag);
1492 if (a->b.reader.fd != a->w.fd) close(a->b.reader.fd);
1498 a->next->prev = a->prev;
1500 a->prev->next = a->next;
1506 /* --- @a_unlock@ --- *
1508 * Arguments: @admin *a@ = pointer to an admin block
1512 * Use: Unlocks an admin block, allowing its destruction. This is
1513 * also the second half of @a_destroy@.
1516 static void a_unlock(admin *a)
1519 if (!--a->ref && (a->f & AF_DEAD))
1523 /* --- @a_destroy@ --- *
1525 * Arguments: @admin *a@ = pointer to an admin block
1529 * Use: Destroys an admin block. This requires a certain amount of
1533 static void freequeue(oqueue *q)
1537 for (o = q->hd; o; o = oo) {
1544 static void a_destroy(admin *a)
1546 /* --- Don't multiply destroy admin blocks --- */
1551 /* --- Make sure nobody expects it to work --- */
1554 T( trace(T_ADMIN, "admin: destroying connection %u", a->seq); )
1556 /* --- Free the output buffers --- */
1562 /* --- If the block is locked, that's all we can manage --- */
1567 trace(T_ADMIN, "admin: deferring destruction..."); )
1570 /* --- @a_line@ --- *
1572 * Arguments: @char *p@ = pointer to the line read
1573 * @size_t len@ = length of the line
1574 * @void *vp@ = pointer to my admin block
1578 * Use: Handles a line of input.
1581 static void a_line(char *p, size_t len, void *vp)
1596 selbuf_disable(&a->b);
1600 ac = str_qsplit(p, av, 16, 0, STRF_QUOTE);
1603 for (c = acmdtab; c->name; c++) {
1604 if (mystrieq(av[0], c->name)) {
1606 if (c->argmin > ac || ac > c->argmax) {
1608 a_fail(a, "bad-syntax", "%s", c->name, "", A_END);
1610 a_fail(a, "bad-syntax", "%s", c->name, "%s", c->help, A_END);
1613 c->func(a, ac, av + 1);
1619 a_fail(a, "unknown-command", "%s", av[0], A_END);
1622 /* --- @a_create@ --- *
1624 * Arguments: @int fd_in, fd_out@ = file descriptors to use
1625 * @unsigned f@ = initial flags to set
1629 * Use: Creates a new admin connection.
1632 void a_create(int fd_in, int fd_out, unsigned f)
1634 admin *a = CREATE(admin);
1636 T( static unsigned seq = 0;
1638 T( trace(T_ADMIN, "admin: accepted connection %u", a->seq); )
1642 if (fd_in == STDIN_FILENO) a_stdin = a;
1643 fdflags(fd_in, O_NONBLOCK, O_NONBLOCK, FD_CLOEXEC, FD_CLOEXEC);
1644 if (fd_out != fd_in)
1645 fdflags(fd_out, O_NONBLOCK, O_NONBLOCK, FD_CLOEXEC, FD_CLOEXEC);
1646 selbuf_init(&a->b, &sel, fd_in, a_line, a);
1647 sel_initfile(&sel, &a->w, fd_out, SEL_WRITE, a_flush, a);
1648 a->out.hd = a->out.tl = 0;
1651 if (admins) admins->prev = a;
1655 /* --- @a_accept@ --- *
1657 * Arguments: @int fd@ = file descriptor to accept
1658 * @unsigned mode@ = what to do
1659 * @void *v@ = uninteresting pointer
1663 * Use: Accepts a new admin connection.
1666 static void a_accept(int fd, unsigned mode, void *v)
1669 struct sockaddr_un sun;
1670 size_t sz = sizeof(sun);
1672 if ((nfd = accept(fd, (struct sockaddr *)&sun, &sz)) < 0) {
1673 if (errno != EINTR && errno != EAGAIN && errno != EWOULDBLOCK &&
1674 errno != ECONNABORTED && errno != EPROTO)
1675 a_warn("ADMIN", "accept-error", "?ERRNO", A_END);
1678 a_create(nfd, nfd, 0);
1681 /* --- @a_daemon@ --- *
1687 * Use: Informs the admin module that it's a daemon.
1695 /* --- @a_init@ --- *
1697 * Arguments: @const char *name@ = socket name to create
1701 * Use: Creates the admin listening socket.
1704 void a_init(const char *name)
1708 struct sockaddr_un sun;
1709 struct sigaction sa;
1712 /* --- Set up the socket address --- */
1714 sz = strlen(name) + 1;
1715 if (sz > sizeof(sun.sun_path))
1716 die(EXIT_FAILURE, "socket name `%s' too long", name);
1718 sun.sun_family = AF_UNIX;
1719 memcpy(sun.sun_path, name, sz);
1720 sz += offsetof(struct sockaddr_un, sun_path);
1722 /* --- Attempt to bind to the socket --- */
1726 if ((fd = socket(PF_UNIX, SOCK_STREAM, 0)) < 0)
1727 die(EXIT_FAILURE, "couldn't create socket: %s", strerror(errno));
1728 if (bind(fd, (struct sockaddr *)&sun, sz) < 0) {
1731 if (errno != EADDRINUSE) {
1732 die(EXIT_FAILURE, "couldn't bind to address `%s': %s",
1733 sun.sun_path, strerror(e));
1736 die(EXIT_FAILURE, "too many retries; giving up");
1738 if (!connect(fd, (struct sockaddr *)&sun, sz)) {
1739 die(EXIT_FAILURE, "server already listening on admin socket `%s'",
1742 if (errno != ECONNREFUSED)
1743 die(EXIT_FAILURE, "couldn't bind to address: %s", strerror(e));
1744 if (stat(sun.sun_path, &st)) {
1745 die(EXIT_FAILURE, "couldn't stat `%s': %s",
1746 sun.sun_path, strerror(errno));
1748 if (!S_ISSOCK(st.st_mode))
1749 die(EXIT_FAILURE, "object `%s' isn't a socket", sun.sun_path);
1750 T( trace(T_ADMIN, "admin: stale socket found; removing it"); )
1751 unlink(sun.sun_path);
1755 chmod(sun.sun_path, 0600);
1756 fdflags(fd, O_NONBLOCK, O_NONBLOCK, FD_CLOEXEC, FD_CLOEXEC);
1758 die(EXIT_FAILURE, "couldn't listen on socket: %s", strerror(errno));
1760 /* --- Listen to the socket --- */
1762 sel_initfile(&sel, &sock, fd, SEL_READ, a_accept, 0);
1766 T( trace_custom(a_trace, 0);
1767 trace(T_ADMIN, "admin: enabled custom tracing"); )
1770 /* --- Set up signal handlers --- */
1772 sig_add(&s_term, SIGTERM, a_sigdie, 0);
1773 sig_add(&s_hup, SIGHUP, a_sighup, 0);
1774 signal(SIGPIPE, SIG_IGN);
1775 sigaction(SIGINT, 0, &sa);
1776 if (sa.sa_handler != SIG_IGN)
1777 sig_add(&s_int, SIGINT, a_sigdie, 0);
1780 /*----- That's all, folks -------------------------------------------------*/