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 sym_table a_svcs;
69 static unsigned flags = 0;
70 static admin *a_stdin = 0;
71 static sig s_term, s_int, s_hup;
76 #define T_RESOLVE SEC(30)
79 static void a_destroy(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, "?TOKENS") == 0) {
305 const char *const *av = va_arg(ap, const char *const *);
306 while (*av) quotify(d, *av++);
307 } else if (strcmp(fmt, "?PEER") == 0)
308 quotify(d, p_name(va_arg(ap, peer *)));
309 else if (strcmp(fmt, "?ERRNO") == 0) {
310 dstr_putf(d, " E%d", errno);
311 quotify(d, strerror(errno));
315 if (*fmt == '!') fmt++;
317 dstr_vputf(&dd, fmt, &ap);
320 fmt = va_arg(ap, const char *);
326 /* --- @a_write@, @a_vwrite@ --- *
328 * Arguments: @admin *a@ = admin connection to write to
329 * @const char *status@ = status code to report
330 * @const char *tag@ = tag string, or null
331 * @const char *fmt@ = pointer to format string
332 * @va_list ap@ = arguments in list
333 * @...@ = other arguments
337 * Use: Sends a message to an admin connection.
340 static void a_vwrite(admin *a, const char *status, const char *tag,
341 const char *fmt, va_list ap)
344 if (tag) dstr_puts(&d, "BG");
345 dstr_puts(&d, status);
346 if (tag) quotify(&d, tag);
347 a_vformat(&d, fmt, ap);
349 dosend(a, d.buf, d.len);
353 static void a_write(admin *a, const char *status, const char *tag,
354 const char *fmt, ...)
358 a_vwrite(a, status, tag, fmt, ap);
362 /* --- @a_ok@, @a_info@, @a_fail@ --- *
364 * Arguments: @admin *a@ = connection
365 * @const char *fmt@ = format string
366 * @...@ = other arguments
370 * Use: Convenience functions for @a_write@.
373 static void a_ok(admin *a) { a_write(a, "OK", 0, A_END); }
375 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, ...)
387 a_vwrite(a, "FAIL", 0, fmt, ap);
391 /* --- @a_alert@, @a_valert@, @a_rawalert@ --- *
393 * Arguments: @unsigned f_and, f_eq@ = filter for connections
394 * @const char *status@ = status string
395 * @const char *fmt@ = pointer to format string
396 * @const char *p@ = pointer to raw string
397 * @size_t sz@ = size of raw string
398 * @va_list ap@ = arguments in list
399 * @...@ = other arguments
403 * Use: Write a message to all admin connections matched by the given
407 static void a_rawalert(unsigned f_and, unsigned f_eq, const char *status,
408 const char *p, size_t sz)
413 if (!(flags & F_INIT))
415 dstr_puts(&d, status);
418 dstr_putm(&d, p, sz);
423 for (a = admins; a; a = aa) {
425 if ((a->f & f_and) == f_eq)
426 dosend(a, d.buf, d.len);
431 static void a_valert(unsigned f_and, unsigned f_eq, const char *tag,
432 const char *fmt, va_list ap)
436 if (!(flags & F_INIT))
438 a_vformat(&d, fmt, ap);
439 a_rawalert(f_and, f_eq, tag, fmt ? d.buf : 0, fmt ? d.len : 0);
443 static void a_alert(unsigned f_and, unsigned f_eq, const char *tag,
444 const char *fmt, ...)
448 a_valert(f_and, f_eq, tag, fmt, ap);
452 /* --- @a_warn@ --- *
454 * Arguments: @const char *fmt@ = pointer to format string
455 * @...@ = other arguments
459 * Use: Informs all admin connections of a warning.
462 void a_warn(const char *fmt, ...)
468 a_valert(0, 0, "WARN", fmt, ap);
471 fprintf(stderr, "%s: ", QUIS);
472 a_vformat(&d, fmt, ap);
474 dstr_write(&d, stderr);
480 /* --- @a_trace@ --- *
482 * Arguments: @const char *p@ = pointer to a buffer
483 * @size_t sz@ = size of the buffer
484 * @void *v@ = uninteresting pointer
488 * Use: Custom trace output handler. Sends trace messages to
489 * interested admin connections.
493 static void a_trace(const char *p, size_t sz, void *v)
494 { a_rawalert(AF_TRACE, AF_TRACE, "TRACE", p, sz); }
497 /* --- @a_notify@ --- *
499 * Arguments: @const char *fmt@ = pointer to format string
500 * @...@ = other arguments
504 * Use: Sends a notification to interested admin connections.
507 void a_notify(const char *fmt, ...)
512 a_valert(AF_NOTE, AF_NOTE, "NOTE", fmt, ap);
516 /* --- @a_quit@ --- *
522 * Use: Shuts things down nicely.
531 while ((p = p_first()) != 0)
536 /* --- @a_sigdie@ --- *
538 * Arguments: @int sig@ = signal number
539 * @void *v@ = an uninteresting argument
543 * Use Shuts down on receipt of a fatal signal.
546 static void a_sigdie(int sig, void *v)
552 case SIGTERM: p = "SIGTERM"; break;
553 case SIGINT: p = "SIGINT"; break;
555 sprintf(buf, "%i", sig);
559 a_warn("SERVER", "quit", "signal", "%s", p, A_END);
563 /* --- @a_sighup@ --- *
565 * Arguments: @int sig@ = signal number
566 * @void *v@ = an uninteresting argument
570 * Use Logs a message about SIGHUP not being useful.
573 static void a_sighup(int sig, void *v)
575 a_warn("SERVER", "ignore", "signal", "SIGHUP", A_END);
578 /* --- @a_parsetime@ --- *
580 * Arguments; @const char *p@ = time string to parse
582 * Returns: Time in seconds, or @< 0@ on error.
585 static long a_parsetime(const char *p)
588 long t = strtol(p, &q, 0);
594 case 's': if (q[1] != 0)
601 /* --- @a_findpeer@ --- *
603 * Arguments: @admin *a@ = admin connection
604 * @const char *pn@ = peer name
606 * Returns: The peer, or null if not there.
608 * Use: Finds a peer, reporting an error if it failed.
611 static peer *a_findpeer(admin *a, const char *pn)
615 if ((p = p_find(pn)) == 0)
616 a_fail(a, "unknown-peer", "%s", pn, A_END);
620 /*----- Backgrounded operations -------------------------------------------*/
623 (((admin_bgop *)(bg))->tag ? ((admin_bgop *)(bg))->tag : "<foreground>")
625 /* --- @a_bgfind@ --- *
627 * Arguments: @admin *a@ = a client block
628 * @const char *tag@ = the requested tag
630 * Returns: The requested background job, or null.
633 static admin_bgop *a_bgfind(admin *a, const char *tag)
637 for (bg = a->bg; bg; bg = bg->next) {
638 if (bg->tag && strcmp(tag, bg->tag) == 0)
644 /* --- @a_bgrelease@ --- *
646 * Arguments: @admin_bgop *bg@ = backgrounded operation
650 * Use: Removes a backgrounded operation from the queue, since
651 * (presumably) it's done.
654 static void a_bgrelease(admin_bgop *bg)
658 T( trace(T_ADMIN, "admin: release bgop %s", BGTAG(bg)); )
659 if (bg->tag) xfree(bg->tag);
660 else selbuf_enable(&a->b);
661 if (bg->next) bg->next->prev = bg->prev;
662 if (bg->prev) bg->prev->next = bg->next;
663 else a->bg = bg->next;
665 if (!a->bg && (a->f & AF_CLOSE)) a_destroy(a);
668 /* --- @a_bgok@, @a_bginfo@, @a_bgfail@ --- *
670 * Arguments: @admin_bgop *bg@ = backgrounded operation
671 * @const char *fmt@ = format string
672 * @...@ = other arguments
676 * Use: Convenience functions for @a_write@.
679 static void a_bgok(admin_bgop *bg)
680 { a_write(bg->a, "OK", bg->tag, A_END); }
682 static void a_bginfo(admin_bgop *bg, const char *fmt, ...)
686 a_vwrite(bg->a, "INFO", bg->tag, fmt, ap);
690 static void a_bgfail(admin_bgop *bg, const char *fmt, ...)
694 a_vwrite(bg->a, "FAIL", bg->tag, fmt, ap);
698 /* --- @a_bgadd@ --- *
700 * Arguments: @admin *a@ = administration connection
701 * @admin_bgop *bg@ = pointer to background operation
702 * @const char *tag@ = background tag, or null for foreground
703 * @void (*cancel)(admin_bgop *)@ = cancel function
705 * Returns: Zero for success, nonzero on failure.
707 * Use: Links a background job into the list.
710 static int a_bgadd(admin *a, admin_bgop *bg, const char *tag,
711 void (*cancel)(admin_bgop *))
714 if (a_bgfind(a, tag)) {
715 a_fail(a, "tag-exists", "%s", tag, A_END);
718 bg->tag = xstrdup(tag);
722 selbuf_disable(&a->b);
728 if (a->bg) a->bg->prev = bg;
730 T( trace(T_ADMIN, "admin: add bgop %s", BGTAG(bg)); )
731 if (tag) a_write(a, "DETACH", tag, A_END);
735 /*----- Services infrastructure -------------------------------------------*/
737 /* --- @a_svcfind@ --- *
739 * Arguments: @admin *a@ = the requesting client
740 * @const char *name@ = service name wanted
742 * Returns: The service requested, or null.
744 * Use: Finds a service; reports an error if the service couldn't be
748 static admin_service *a_svcfind(admin *a, const char *name)
752 if ((svc = sym_find(&a_svcs, name, -1, 0, 0)) == 0) {
753 a_fail(a, "unknown-service", "%s", name, A_END);
759 /* --- @a_svcunlink@ --- *
761 * Arguments: @admin_service *svc@ = pointer to service structure
765 * Use: Unlinks the service from its provider, without issuing a
766 * message or freeing the structure. The version string is
770 static void a_svcunlink(admin_service *svc)
773 svc->next->prev = svc->prev;
775 svc->prev->next = svc->next;
777 svc->prov->svcs = svc->next;
781 /* --- @a_svcrelease@ --- *
783 * Arguments: @admin_service *svc@ = pointer to service structure
787 * Use: Releases a service and frees its structure.
790 static void a_svcrelease(admin_service *svc)
792 a_notify("SVCRELEASE", "%s", SYM_NAME(svc), A_END);
794 sym_remove(&a_svcs, svc);
797 /*----- Name resolution operations ----------------------------------------*/
799 /* --- @a_resolved@ --- *
801 * Arguments: @struct hostent *h@ = pointer to resolved hostname
802 * @void *v@ = pointer to resolver operation
806 * Use: Handles a completed name resolution.
809 static void a_resolved(struct hostent *h, void *v)
813 T( trace(T_ADMIN, "admin: resop %s resolved", BGTAG(r)); )
816 a_bgfail(&r->bg, "resolve-error", "%s", r->addr, A_END);
817 r->func(r, ARES_FAIL);
819 memcpy(&r->sa.sin.sin_addr, h->h_addr, sizeof(struct in_addr));
827 /* --- @a_restimer@ --- *
829 * Arguments: @struct timeval *tv@ = timer
830 * @void *v@ = pointer to resolver operation
834 * Use: Times out a resolver.
837 static void a_restimer(struct timeval *tv, void *v)
841 T( trace(T_ADMIN, "admin: resop %s timeout", BGTAG(r)); )
842 a_bgfail(&r->bg, "resolver-timeout", "%s", r->addr, A_END);
843 r->func(r, ARES_FAIL);
849 /* --- @a_rescancel@ --- *
851 * Arguments: @admin_bgop *bg@ = background operation
855 * Use: Cancels an add operation.
858 static void a_rescancel(admin_bgop *bg)
860 admin_resop *r = (admin_resop *)bg;
862 T( trace(T_ADMIN, "admin: cancel resop %s", BGTAG(r)); )
863 r->func(r, ARES_FAIL);
869 /* --- @a_resolve@ --- *
871 * Arguments: @admin *a@ = administration connection
872 * @admin_resop *r@ = resolver operation to run
873 * @const char *tag@ = background operation tag
874 * @void (*func)(struct admin_resop *, int@ = handler function
875 * @unsigned ac@ = number of remaining arguments
876 * @char *av[]@ = pointer to remaining arguments
880 * Use: Cranks up a resolver job.
883 static void a_resolve(admin *a, admin_resop *r, const char *tag,
884 void (*func)(struct admin_resop *, int),
885 unsigned ac, char *av[])
892 /* --- Fill in the easy bits of address --- */
894 r->bg.tag = "<starting>";
897 if (mystrieq(av[i], "inet")) i++;
899 a_fail(a, "bad-addr-syntax", "[inet] ADDRESS PORT", A_END);
902 r->sa.sin.sin_family = AF_INET;
903 r->sasz = sizeof(r->sa.sin);
904 r->addr = xstrdup(av[i]);
905 pt = strtoul(av[i + 1], &p, 0);
907 struct servent *s = getservbyname(av[i + 1], "udp");
909 a_fail(a, "unknown-service", "%s", av[i + 1], A_END);
912 pt = ntohs(s->s_port);
914 if (pt == 0 || pt >= 65536) {
915 a_fail(a, "invalid-port", "%lu", pt, A_END);
918 r->sa.sin.sin_port = htons(pt);
920 /* --- Report backgrounding --- *
922 * Do this for consistency of interface, even if we're going to get the
923 * answer straight away.
926 if (a_bgadd(a, &r->bg, tag, a_rescancel))
928 T( trace(T_ADMIN, "admin: %u, resop %s, hostname `%s'",
929 a->seq, BGTAG(r), r->addr); )
931 /* --- If the name is numeric, do it the easy way --- */
933 if (inet_aton(av[i], &r->sa.sin.sin_addr)) {
934 T( trace(T_ADMIN, "admin: resop %s done the easy way", BGTAG(r)); )
941 /* --- Store everything for later and crank up the resolver --- */
943 gettimeofday(&tv, 0);
944 tv.tv_sec += T_RESOLVE;
945 sel_addtimer(&sel, &r->t, &tv, a_restimer, r);
946 bres_byname(&r->r, r->addr, a_resolved, r);
951 if (r->addr) xfree(r->addr);
955 /*----- Option parsing ----------------------------------------------------*/
957 #define OPTIONS(argc, argv, guts) do { \
958 char **o_av = argv; \
962 if (mystrieq(*o_av, "--")) { \
971 argc -= o_av - argv; \
975 #define OPT(name, guts) if (mystrieq(*o_av, name)) { guts continue; }
977 #define OPTARG(name, arg, guts) OPT(name, { \
980 if (!arg) goto bad_syntax; \
984 #define OPTTIME(name, arg, guts) OPTARG(name, o_arg, { \
986 if ((arg = a_parsetime(o_arg)) < 0) { \
987 a_fail(a, "bad-time-spec", "%s", o_arg, A_END); \
993 /*----- Adding peers ------------------------------------------------------*/
995 /* --- @a_doadd@ --- *
997 * Arguments: @admin_resop *r@ = resolver operation
998 * @int rc@ = how it worked
1002 * Use: Handles a completed resolution.
1005 static void a_doadd(admin_resop *r, int rc)
1007 admin_addop *add = (admin_addop *)r;
1009 T( trace(T_ADMIN, "admin: done add op %s", BGTAG(add)); )
1011 if (rc == ARES_OK) {
1012 add->peer.sasz = add->r.sasz;
1013 add->peer.sa = add->r.sa;
1014 if (p_find(add->peer.name))
1015 a_bgfail(&add->r.bg, "peer-exists", "%s", add->peer.name, A_END);
1016 else if (!p_create(&add->peer))
1017 a_bgfail(&add->r.bg, "peer-create-fail", "%s", add->peer.name, A_END);
1022 xfree(add->peer.name);
1025 /* --- @acmd_add@ --- *
1027 * Arguments: @admin *a@ = connection which requested the addition
1028 * @unsigned ac@ = argument count
1029 * @char *av[]@ = pointer to the argument list
1033 * Use: Adds a new peer.
1036 static void acmd_add(admin *a, unsigned ac, char *av[])
1038 const char *tag = 0;
1041 /* --- Set stuff up --- */
1043 add = xmalloc(sizeof(*add));
1046 add->peer.tops = tun_default;
1048 /* --- Parse options --- */
1051 OPTARG("-background", arg, { tag = arg; })
1052 OPTARG("-tunnel", arg, {
1056 a_fail(a, "unknown-tunnel", "%s", arg, A_END);
1059 if (mystrieq(arg, tunnels[i]->name)) {
1060 add->peer.tops = tunnels[i];
1065 OPTTIME("-keepalive", t, { add->peer.t_ka = t; })
1068 /* --- Make sure someone's not got there already --- */
1073 a_fail(a, "peer-exists", "%s", *av, A_END);
1076 add->peer.name = xstrdup(*av++);
1079 /* --- Crank up the resolver --- */
1081 a_resolve(a, &add->r, tag, a_doadd, ac, av);
1084 /* --- Clearing up --- */
1087 a_fail(a, "bad-syntax", "add", "[OPTIONS] PEER ADDR ...", A_END);
1089 if (add->peer.name) xfree(add->peer.name);
1094 /*----- Ping --------------------------------------------------------------*/
1096 /* --- @a_pingcancel@ --- *
1098 * Arguments: @admin_bgop *bg@ = background operation block
1102 * Use: Cancels a running ping.
1105 static void a_pingcancel(admin_bgop *bg)
1107 admin_pingop *pg = (admin_pingop *)bg;
1108 T( trace(T_ADMIN, "admin: cancel ping op %s", BGTAG(pg)); )
1109 p_pingdone(&pg->ping, PING_NONOTIFY);
1112 /* --- @a_pong@ --- *
1114 * Arguments: @int rc@ = return code
1115 * @void *v@ = ping operation block
1119 * Use: Collects what happened to a ping message.
1122 static void a_pong(int rc, void *v)
1124 admin_pingop *pg = v;
1130 gettimeofday(&tv, 0);
1131 tv_sub(&tv, &tv, &pg->pingtime);
1132 millis = (double)tv.tv_sec * 1000 + (double)tv.tv_usec/1000;
1133 a_bginfo(&pg->bg, "ping-ok", "%.1f", millis, A_END);
1137 a_bginfo(&pg->bg, "ping-timeout", A_END);
1141 a_bginfo(&pg->bg, "ping-peer-died", A_END);
1147 T( trace(T_ADMIN, "admin: ponged ping op %s", BGTAG(pg)); )
1148 a_bgrelease(&pg->bg);
1151 /* --- @acmd_ping@, @acmd_eping@ --- *
1153 * Arguments: @admin *a@ = connection which requested the ping
1154 * @unsigned ac@ = argument count
1155 * @char *av[]@ = pointer to the argument list
1159 * Use: Pings a peer.
1162 static void a_ping(admin *a, unsigned ac, char *av[],
1163 const char *cmd, unsigned msg)
1167 admin_pingop *pg = 0;
1168 const char *tag = 0;
1171 OPTARG("-background", arg, { tag = arg; })
1172 OPTTIME("-timeout", arg, { t = arg; })
1174 if (!*av || av[1]) goto bad_syntax;
1175 if ((p = a_findpeer(a, *av)) == 0)
1177 pg = xmalloc(sizeof(*pg));
1178 gettimeofday(&pg->pingtime, 0);
1179 if (a_bgadd(a, &pg->bg, tag, a_pingcancel))
1181 T( trace(T_ADMIN, "admin: ping op %s: %s to %s",
1182 BGTAG(pg), cmd, p_name(p)); )
1183 if (p_pingsend(p, &pg->ping, msg, t, a_pong, pg)) {
1184 a_bgfail(&pg->bg, "ping-send-failed", A_END);
1185 a_bgrelease(&pg->bg);
1190 a_fail(a, "bad-syntax", "%s", cmd, "[OPTIONS] PEER", cmd, A_END);
1196 static void acmd_ping(admin *a, unsigned ac, char *av[])
1197 { a_ping(a, ac, av, "ping", MISC_PING); }
1198 static void acmd_eping(admin *a, unsigned ac, char *av[])
1199 { a_ping(a, ac, av, "eping", MISC_EPING); }
1201 /*----- Service commands --------------------------------------------------*/
1203 static void acmd_svcclaim(admin *a, unsigned ac, char *av[])
1208 svc = sym_find(&a_svcs, av[0], -1, sizeof(*svc), &f);
1210 if (versioncmp(av[1], svc->version) <= 0) {
1213 "%s", SYM_NAME(svc),
1218 a_write(svc->prov, "SVCCLAIM", 0, "%s", av[0], "%s", av[1], A_END);
1222 svc->version = xstrdup(av[1]);
1223 svc->next = a->svcs;
1225 if (a->svcs) a->svcs->prev = svc;
1227 a_notify("SVCCLAIM", "%s", SYM_NAME(svc), "%s", svc->version, A_END);
1231 static void acmd_svcrelease(admin *a, unsigned ac, char *av[])
1235 if ((svc = a_svcfind(a, av[0])) == 0)
1237 if (svc->prov != a) {
1238 a_fail(a, "not-service-provider", "%s", SYM_NAME(svc), A_END);
1245 static void acmd_svcensure(admin *a, unsigned ac, char *av[])
1249 if ((svc = a_svcfind(a, av[0])) == 0)
1251 if (av[1] && versioncmp(svc->version, av[1]) < 0) {
1252 a_fail(a, "service-too-old",
1253 "%s", SYM_NAME(svc),
1261 static void acmd_svcquery(admin *a, unsigned ac, char *av[])
1265 if ((svc = a_svcfind(a, av[0])) != 0) {
1266 a_info(a, "name=%s", SYM_NAME(svc), "version=%s", svc->version, A_END);
1271 static void acmd_svclist(admin *a, unsigned ac, char *av[])
1276 for (sym_mkiter(&i, &a_svcs); (svc = sym_next(&i)) != 0; )
1277 a_info(a, "%s", SYM_NAME(svc), "%s", svc->version, A_END);
1281 /*----- Administration commands -------------------------------------------*/
1283 /* --- Miscellaneous commands --- */
1285 /* --- @traceish@ --- *
1287 * Arguments: @admin *a@ = connection to complain on
1288 * @unsigned ac@ = number of arguments
1289 * @char *av[]@ = vector of arguments
1290 * @const char *what@ = what we're messing with
1291 * @const trace_opt *tt@ = options table
1292 * @unsigned *ff@ = where the flags are
1294 * Returns: Nonzero if anything changed.
1296 * Use: Guts of trace-ish commands like `trace' and `watch'.
1299 static int traceish(admin *a, unsigned ac, char *av[],
1300 const char *what, const trace_opt *tt, unsigned *ff)
1304 if (!ac || strcmp(av[0], "?") == 0) {
1306 for (t = tt; t->ch; t++) {
1307 a_info(a, "*%c%c %s",
1308 t->ch, (*ff & t->f) == t->f ? '+' : ' ', t->help, A_END);
1318 case '+': sense = 1; break;
1319 case '-': sense = 0; break;
1321 for (t = tt; t->ch; t++) {
1323 if (sense) f |= t->f;
1328 a_fail(a, "bad-%s-option", what, "%c", *p, A_END);
1344 static void acmd_trace(admin *a, unsigned ac, char *av[])
1346 if (traceish(a, ac, av, "trace", tr_opts, &tr_flags))
1347 trace_level(tr_flags);
1352 static void acmd_watch(admin *a, unsigned ac, char *av[])
1354 traceish(a, ac, av, "watch", w_opts, &a->f);
1357 static void alertcmd(admin *a, unsigned f_and, unsigned f_eq,
1358 const char *status, char *av[])
1359 { a_alert(f_and, f_eq, status, "USER", "?TOKENS", av, A_END); a_ok(a); }
1360 static void acmd_notify(admin *a, unsigned ac, char *av[])
1361 { alertcmd(a, AF_NOTE, AF_NOTE, "NOTE", av); }
1362 static void acmd_warn(admin *a, unsigned ac, char *av[])
1363 { alertcmd(a, AF_WARN, AF_WARN, "WARN", av); }
1365 static void acmd_port(admin *a, unsigned ac, char *av[])
1367 a_info(a, "%u", p_port(), A_END);
1371 static void acmd_daemon(admin *a, unsigned ac, char *av[])
1373 if (flags & F_DAEMON)
1374 a_fail(a, "already-daemon", A_END);
1376 a_notify("DAEMON", A_END);
1380 a_fail(a, "daemon-error", "?ERRNO", A_END);
1388 static void acmd_jobs(admin *a, unsigned ac, char *av[])
1392 for (bg = a->bg; bg; bg = bg->next) {
1394 a_info(a, "%s", bg->tag, A_END);
1399 static void acmd_bgcancel(admin *a, unsigned ac, char *av[])
1403 if ((bg = a_bgfind(a, av[0])) == 0)
1404 a_fail(a, "unknown-tag", "%s", av[0], A_END);
1412 static void acmd_list(admin *a, unsigned ac, char *av[])
1415 for (p = p_first(); p; p = p_next(p))
1416 a_info(a, "%s", p_name(p), A_END);
1420 static void acmd_ifname(admin *a, unsigned ac, char *av[])
1424 if ((p = a_findpeer(a, av[0])) != 0) {
1425 a_info(a, "%s", p_ifname(p), A_END);
1430 static void acmd_setifname(admin *a, unsigned ac, char *av[])
1434 if ((p = a_findpeer(a, av[0])) != 0) {
1435 a_notify("NEWIFNAME", "?PEER", p, "%s", p_ifname(p), "%s", av[1], A_END);
1436 p_setifname(p, av[1]);
1441 static void acmd_getchal(admin *a, unsigned ac, char *av[])
1445 buf_init(&b, buf_i, PKBUFSZ);
1447 a_info(a, "?B64", BBASE(&b), (size_t)BLEN(&b), A_END);
1451 static void acmd_checkchal(admin *a, unsigned ac, char *av[])
1458 base64_decode(&b64, av[0], strlen(av[0]), &d);
1459 base64_decode(&b64, 0, 0, &d);
1460 buf_init(&b, d.buf, d.len);
1461 if (c_check(&b) || BBAD(&b) || BLEFT(&b))
1462 a_fail(a, "invalid-challenge", A_END);
1468 static void acmd_greet(admin *a, unsigned ac, char *av[])
1474 if ((p = a_findpeer(a, av[0])) != 0) {
1476 base64_decode(&b64, av[1], strlen(av[1]), &d);
1477 base64_decode(&b64, 0, 0, &d);
1478 p_greet(p, d.buf, d.len);
1484 static void acmd_addr(admin *a, unsigned ac, char *av[])
1489 if ((p = a_findpeer(a, av[0])) != 0) {
1491 assert(ad->sa.sa_family == AF_INET);
1492 a_info(a, "?ADDR", ad, A_END);
1497 static void acmd_peerinfo(admin *a, unsigned ac, char *av[])
1502 if ((p = a_findpeer(a, av[0])) != 0) {
1504 a_info(a, "tunnel=%s", ps->tops->name, A_END);
1505 a_info(a, "keepalive=%lu", ps->t_ka, A_END);
1510 static void acmd_servinfo(admin *a, unsigned ac, char *av[])
1512 a_info(a, "implementation=edgeware-tripe", A_END);
1513 a_info(a, "version=%s", VERSION, A_END);
1514 a_info(a, "daemon=%s", BOOL(flags & F_DAEMON), A_END);
1518 static void acmd_stats(admin *a, unsigned ac, char *av[])
1523 if ((p = a_findpeer(a, av[0])) == 0)
1527 a_info(a, "start-time=%s", timestr(st->t_start), A_END);
1528 a_info(a, "last-packet-time=%s", timestr(st->t_last), A_END);
1529 a_info(a, "last-keyexch-time=%s", timestr(st->t_kx), A_END);
1530 a_info(a, "packets-in=%lu bytes-in=%lu", st->n_in, st->sz_in, A_END);
1531 a_info(a, "packets-out=%lu bytes-out=%lu",
1532 st->n_out, st->sz_out, A_END);
1533 a_info(a, "keyexch-packets-in=%lu keyexch-bytes-in=%lu",
1534 st->n_kxin, st->sz_kxin, A_END);
1535 a_info(a, "keyexch-packets-out=%lu keyexch-bytes-out=%lu",
1536 st->n_kxout, st->sz_kxout, A_END);
1537 a_info(a, "ip-packets-in=%lu ip-bytes-in=%lu",
1538 st->n_ipin, st->sz_ipin, A_END);
1539 a_info(a, "ip-packets-out=%lu ip-bytes-out=%lu",
1540 st->n_ipout, st->sz_ipout, A_END);
1541 a_info(a, "rejected-packets=%lu", st->n_reject, A_END);
1545 static void acmd_kill(admin *a, unsigned ac, char *av[])
1548 if ((p = a_findpeer(a, av[0])) != 0) {
1554 static void acmd_forcekx(admin *a, unsigned ac, char *av[])
1557 if ((p = a_findpeer(a, av[0])) != 0) {
1558 kx_start(&p->kx, 1);
1563 static void acmd_reload(admin *a, unsigned ac, char *av[])
1564 { p_keyreload(); a_ok(a); }
1566 static void acmd_quit(admin *a, unsigned ac, char *av[])
1568 a_warn("SERVER", "quit", "admin-request", A_END);
1573 static void acmd_version(admin *a, unsigned ac, char *av[])
1575 a_info(a, "%s", PACKAGE, "%s", VERSION, A_END);
1579 static void acmd_tunnels(admin *a, unsigned ac, char *av[])
1582 for (i = 0; tunnels[i]; i++)
1583 a_info(a, "%s", tunnels[i]->name, A_END);
1587 /* --- The command table and help --- */
1589 typedef struct acmd {
1592 unsigned argmin, argmax;
1593 void (*func)(admin */*a*/, unsigned /*ac*/, char */*av*/[]);
1596 static void acmd_help(admin */*a*/, unsigned /*ac*/, char */*av*/[]);
1598 static const acmd acmdtab[] = {
1599 { "add", "[OPTIONS] PEER ADDR ...", 2, 0xffff, acmd_add },
1600 { "addr", "PEER", 1, 1, acmd_addr },
1601 { "bgcancel", "TAG", 1, 1, acmd_bgcancel },
1602 { "checkchal", "CHAL", 1, 1, acmd_checkchal },
1603 { "daemon", 0, 0, 0, acmd_daemon },
1604 { "eping", "[OPTIONS] PEER", 1, 0xffff, acmd_eping },
1605 { "forcekx", "PEER", 1, 1, acmd_forcekx },
1606 { "getchal", 0, 0, 0, acmd_getchal },
1607 { "greet", "PEER CHAL", 2, 2, acmd_greet },
1608 { "help", 0, 0, 0, acmd_help },
1609 { "ifname", "PEER", 1, 1, acmd_ifname },
1610 { "jobs", 0, 0, 0, acmd_jobs },
1611 { "kill", "PEER", 1, 1, acmd_kill },
1612 { "list", 0, 0, 0, acmd_list },
1613 { "notify", "MESSAGE ...", 1, 0xffff, acmd_notify },
1614 { "peerinfo", "PEER", 1, 1, acmd_peerinfo },
1615 { "ping", "[OPTIONS] PEER", 1, 0xffff, acmd_ping },
1616 { "port", 0, 0, 0, acmd_port },
1617 { "quit", 0, 0, 0, acmd_quit },
1618 { "reload", 0, 0, 0, acmd_reload },
1619 { "servinfo", 0, 0, 0, acmd_servinfo },
1620 { "setifname", "PEER NEW-NAME", 2, 2, acmd_setifname },
1621 { "svcclaim", "SERVICE VERSION", 2, 2, acmd_svcclaim },
1622 { "svcensure", "SERVICE [VERSION]", 1, 2, acmd_svcensure },
1623 { "svclist", 0, 0, 0, acmd_svclist },
1624 { "svcquery", "SERVICE", 1, 1, acmd_svcquery },
1625 { "svcrelease", "SERVICE", 1, 1, acmd_svcrelease },
1626 { "stats", "PEER", 1, 1, acmd_stats },
1628 { "trace", "[OPTIONS]", 0, 1, acmd_trace },
1630 { "tunnels", 0, 0, 0, acmd_tunnels },
1631 { "version", 0, 0, 0, acmd_version },
1632 { "warn", "MESSAGE ...", 1, 0xffff, acmd_warn },
1633 { "watch", "[OPTIONS]", 0, 1, acmd_watch },
1637 static void acmd_help(admin *a, unsigned ac, char *av[])
1640 for (c = acmdtab; c->name; c++) {
1642 a_info(a, "%s", c->name, "*%s", c->help, A_END);
1644 a_info(a, "%s", c->name, A_END);
1649 /*----- Connection handling -----------------------------------------------*/
1651 /* --- @a_destroypending@ --- *
1657 * Use: Destroys pending admin connections at a safe time.
1660 static void a_destroypending(void)
1663 admin_bgop *bg, *bbg;
1664 admin_service *svc, *ssvc;
1666 /* --- Destroy connections marked as pending --- */
1668 for (a = a_dead; a; a = aa) {
1670 assert(a->f & AF_DEAD);
1672 /* --- Report what we're doing --- */
1674 T( trace(T_ADMIN, "admin: completing destruction of connection %u",
1677 /* --- Abort any background jobs in progress --- */
1679 for (bg = a->bg; bg; bg = bbg) {
1682 if (bg->tag) xfree(bg->tag);
1686 /* --- Release services I hold --- */
1688 for (svc = a->svcs; svc; svc = ssvc) {
1693 /* --- Close file descriptors and selectory --- */
1695 selbuf_destroy(&a->b);
1696 if (a->b.reader.fd != a->w.fd) close(a->b.reader.fd);
1698 if (a_stdin == a) a_stdin = 0;
1705 /* --- All pending destruction completed --- */
1710 /* --- @a_destroy@ --- *
1712 * Arguments: @admin *a@ = pointer to an admin block
1716 * Use: Destroys an admin block. This requires a certain amount of
1720 static void freequeue(oqueue *q)
1724 for (o = q->hd; o; o = oo) {
1731 static void a_destroy(admin *a)
1736 if (a->next) a->next->prev = a->prev;
1737 if (a->prev) a->prev->next = a->next;
1738 else admins = a->next;
1740 if (a->out.hd) sel_rmfile(&a->w);
1747 T( trace(T_ADMIN, "admin: killing connection %u", a->seq); )
1750 /* --- @a_line@ --- *
1752 * Arguments: @char *p@ = pointer to the line read
1753 * @size_t len@ = length of the line
1754 * @void *vp@ = pointer to my admin block
1758 * Use: Handles a line of input.
1761 static void a_line(char *p, size_t len, void *vp)
1776 selbuf_disable(&a->b);
1780 ac = str_qsplit(p, av, 16, 0, STRF_QUOTE);
1783 for (c = acmdtab; c->name; c++) {
1784 if (mystrieq(av[0], c->name)) {
1786 if (c->argmin > ac || ac > c->argmax) {
1788 a_fail(a, "bad-syntax", "%s", c->name, "", A_END);
1790 a_fail(a, "bad-syntax", "%s", c->name, "%s", c->help, A_END);
1792 c->func(a, ac, av + 1);
1796 a_fail(a, "unknown-command", "%s", av[0], A_END);
1799 /* --- @a_create@ --- *
1801 * Arguments: @int fd_in, fd_out@ = file descriptors to use
1802 * @unsigned f@ = initial flags to set
1806 * Use: Creates a new admin connection.
1809 void a_create(int fd_in, int fd_out, unsigned f)
1811 admin *a = CREATE(admin);
1813 T( static unsigned seq = 0;
1815 T( trace(T_ADMIN, "admin: accepted connection %u", a->seq); )
1820 if (fd_in == STDIN_FILENO) a_stdin = a;
1821 fdflags(fd_in, O_NONBLOCK, O_NONBLOCK, FD_CLOEXEC, FD_CLOEXEC);
1822 if (fd_out != fd_in)
1823 fdflags(fd_out, O_NONBLOCK, O_NONBLOCK, FD_CLOEXEC, FD_CLOEXEC);
1824 selbuf_init(&a->b, &sel, fd_in, a_line, a);
1825 sel_initfile(&sel, &a->w, fd_out, SEL_WRITE, a_flush, a);
1826 a->out.hd = a->out.tl = 0;
1829 if (admins) admins->prev = a;
1833 /* --- @a_accept@ --- *
1835 * Arguments: @int fd@ = file descriptor to accept
1836 * @unsigned mode@ = what to do
1837 * @void *v@ = uninteresting pointer
1841 * Use: Accepts a new admin connection.
1844 static void a_accept(int fd, unsigned mode, void *v)
1847 struct sockaddr_un sun;
1848 size_t sz = sizeof(sun);
1850 if ((nfd = accept(fd, (struct sockaddr *)&sun, &sz)) < 0) {
1851 if (errno != EINTR && errno != EAGAIN && errno != EWOULDBLOCK &&
1852 errno != ECONNABORTED && errno != EPROTO)
1853 a_warn("ADMIN", "accept-error", "?ERRNO", A_END);
1856 a_create(nfd, nfd, 0);
1859 /* --- @a_preselect@ --- *
1865 * Use: Informs the admin module that we're about to select again,
1866 * and that it should do cleanup things it has delayed until a
1870 void a_preselect(void) { if (a_dead) a_destroypending(); }
1872 /* --- @a_daemon@ --- *
1878 * Use: Informs the admin module that it's a daemon.
1886 /* --- @a_init@ --- *
1888 * Arguments: @const char *name@ = socket name to create
1892 * Use: Creates the admin listening socket.
1895 void a_init(const char *name)
1899 struct sockaddr_un sun;
1900 struct sigaction sa;
1903 /* --- Create services table --- */
1905 sym_create(&a_svcs);
1907 /* --- Set up the socket address --- */
1909 sz = strlen(name) + 1;
1910 if (sz > sizeof(sun.sun_path))
1911 die(EXIT_FAILURE, "socket name `%s' too long", name);
1913 sun.sun_family = AF_UNIX;
1914 memcpy(sun.sun_path, name, sz);
1915 sz += offsetof(struct sockaddr_un, sun_path);
1917 /* --- Attempt to bind to the socket --- */
1921 if ((fd = socket(PF_UNIX, SOCK_STREAM, 0)) < 0)
1922 die(EXIT_FAILURE, "couldn't create socket: %s", strerror(errno));
1923 if (bind(fd, (struct sockaddr *)&sun, sz) < 0) {
1926 if (errno != EADDRINUSE) {
1927 die(EXIT_FAILURE, "couldn't bind to address `%s': %s",
1928 sun.sun_path, strerror(e));
1931 die(EXIT_FAILURE, "too many retries; giving up");
1933 if (!connect(fd, (struct sockaddr *)&sun, sz)) {
1934 die(EXIT_FAILURE, "server already listening on admin socket `%s'",
1937 if (errno != ECONNREFUSED)
1938 die(EXIT_FAILURE, "couldn't bind to address: %s", strerror(e));
1939 if (stat(sun.sun_path, &st)) {
1940 die(EXIT_FAILURE, "couldn't stat `%s': %s",
1941 sun.sun_path, strerror(errno));
1943 if (!S_ISSOCK(st.st_mode))
1944 die(EXIT_FAILURE, "object `%s' isn't a socket", sun.sun_path);
1945 T( trace(T_ADMIN, "admin: stale socket found; removing it"); )
1946 unlink(sun.sun_path);
1950 chmod(sun.sun_path, 0600);
1951 fdflags(fd, O_NONBLOCK, O_NONBLOCK, FD_CLOEXEC, FD_CLOEXEC);
1953 die(EXIT_FAILURE, "couldn't listen on socket: %s", strerror(errno));
1955 /* --- Listen to the socket --- */
1957 sel_initfile(&sel, &sock, fd, SEL_READ, a_accept, 0);
1961 T( trace_custom(a_trace, 0);
1962 trace(T_ADMIN, "admin: enabled custom tracing"); )
1965 /* --- Set up signal handlers --- */
1967 sig_add(&s_term, SIGTERM, a_sigdie, 0);
1968 sig_add(&s_hup, SIGHUP, a_sighup, 0);
1969 signal(SIGPIPE, SIG_IGN);
1970 sigaction(SIGINT, 0, &sa);
1971 if (sa.sa_handler != SIG_IGN)
1972 sig_add(&s_int, SIGINT, a_sigdie, 0);
1975 /*----- That's all, folks -------------------------------------------------*/