3 * Admin interface for configuration
5 * (c) 2001 Straylight/Edgeware
8 /*----- Licensing notice --------------------------------------------------*
10 * This file is part of Trivial IP Encryption (TrIPE).
12 * TrIPE is free software: you can redistribute it and/or modify it under
13 * the terms of the GNU General Public License as published by the Free
14 * Software Foundation; either version 3 of the License, or (at your
15 * option) any later version.
17 * TrIPE is distributed in the hope that it will be useful, but WITHOUT
18 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
19 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
22 * You should have received a copy of the GNU General Public License
23 * along with TrIPE. If not, see <https://www.gnu.org/licenses/>.
26 /*----- Header files ------------------------------------------------------*/
30 /*----- Global variables --------------------------------------------------*/
34 const trace_opt tr_opts[] = {
35 { 't', T_TUNNEL, "tunnel events" },
36 { 'r', T_PEER, "peer events" },
37 { 'a', T_ADMIN, "admin interface" },
38 { 's', T_KEYSET, "symmetric keyset management" },
39 { 'x', T_KEYEXCH, "key exchange" },
40 { 'm', T_KEYMGMT, "key management" },
41 { 'l', T_CHAL, "challenge management" },
42 { 'v', T_PRIVSEP, "privilege separation" },
43 { 'p', T_PACKET, "packet contents" },
44 { 'c', T_CRYPTO, "crypto details" },
45 { 'A', T_ALL, "all of the above" },
49 unsigned tr_flags = 0;
52 static const trace_opt w_opts[] = {
54 { '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 --------------------------------------------------*/
65 static adns_state ads;
71 static const char *sockname = 0;
72 static sym_table a_svcs;
73 static unsigned flags = 0;
74 static admin *a_stdin = 0;
75 static sig s_term, s_int, s_hup;
79 #define F_FOREGROUND 4u
81 #define T_RESOLVE SEC(30)
84 static void a_destroy(admin */*a*/);
86 #define BOOL(x) ((x) ? "t" : "nil")
88 /*----- Output functions --------------------------------------------------*/
90 /* --- @trywrite@ --- *
92 * Arguments: @admin *a@ = pointer to an admin block
93 * @const char *p@ = pointer to buffer to write
94 * @size_t sz@ = size of data to write
96 * Returns: The number of bytes written, or less than zero on error.
98 * Use: Attempts to write data to a client.
101 static ssize_t trywrite(admin *a, const char *p, size_t sz)
108 n = write(a->w.fd, p, sz);
118 if (errno != EAGAIN && errno != EWOULDBLOCK) {
120 a_warn("ADMIN", "client-write-error", "?ERRNO", A_END);
127 /* --- @doqueue@ -- *
129 * Arguments: @oqueue *q@ = pointer to output queue
130 * @const char *p@ = pointer to buffer to write
131 * @size_t sz@ = size of buffer
133 * Returns: Nonzero if the queue was previously empty.
135 * Use: Queues data to be written later.
138 static int doqueue(oqueue *q, const char *p, size_t sz)
147 else if (o->p_in < o->buf + OBUFSZ)
151 o = xmalloc(sizeof(obuf));
153 o->p_in = o->p_out = o->buf;
161 n = o->buf + OBUFSZ - o->p_in;
164 memcpy(o->p_in, p, n);
173 /* --- @dosend@ --- *
175 * Arguemnts: @admin *a@ = pointer to an admin block
176 * @const char *p@ = pointer to buffer to write
177 * @size_t sz@ = size of data to write
181 * Use: Sends data to an admin client.
184 static void dosend(admin *a, const char *p, size_t sz)
191 if ((n = trywrite(a, p, sz)) < 0)
198 if (doqueue(&a->out, p, sz))
202 /* --- @a_flush@ --- *
204 * Arguments: @int fd@ = file descriptor
205 * @unsigned mode@ = what's happening
206 * @void *v@ = pointer to my admin block
210 * Use: Flushes buffers when a client is ready to read again.
213 static void a_flush(int fd, unsigned mode, void *v)
221 if ((n = trywrite(a, o->p_out, o->p_in - o->p_out)) < 0)
224 if (o->p_in < o->p_out)
237 /*----- Utility functions -------------------------------------------------*/
239 /* --- @a_vformat@ --- *
241 * Arguments: @dstr *d@ = where to leave the formatted message
242 * @const char *fmt@ = pointer to format string
243 * @va_list *ap@ = arguments in list
247 * Use: Main message token formatting driver. The arguments are
248 * interleaved formatting tokens and their parameters, finally
249 * terminated by an entry @A_END@.
253 * * "*..." ... -- pretokenized @dstr_putf@-like string
255 * * "?ADDR" SOCKADDR -- a socket address, to be converted
257 * * "?B64" BUFFER SIZE -- binary data to be base64-encoded
259 * * "?TOKENS" VECTOR -- null-terminated vector of tokens
261 * * "?PEER" PEER -- peer's name
263 * * "?ERR" CODE -- system error code
265 * * "?ERRNO" -- system error code from @errno@
267 * * "[!]..." ... -- @dstr_putf@-like string as single token
270 void a_vformat(dstr *d, const char *fmt, va_list *ap)
276 if (d->len) dstr_putc(d, ' ');
277 dstr_vputf(d, fmt + 1, ap);
278 } else if (*fmt == '?') {
279 if (strcmp(fmt, "?ADDR") == 0) {
280 const addr *a = va_arg(*ap, const addr *);
281 char name[NI_MAXHOST], serv[NI_MAXSERV];
283 if ((err = getnameinfo(&a->sa, addrsz(a),
284 name, sizeof(name), serv, sizeof(serv),
285 (NI_NUMERICHOST | NI_NUMERICSERV |
287 dstr_putf(d, " E%d", err);
288 u_quotify(d, gai_strerror(err));
290 ix = afix(a->sa.sa_family); assert(ix >= 0);
291 u_quotify(d, aftab[ix].name);
295 } else if (strcmp(fmt, "?B64") == 0) {
296 const octet *p = va_arg(*ap, const octet *);
297 size_t n = va_arg(*ap, size_t);
298 codec *b64 = base64_class.encoder(CDCF_NOEQPAD, "", 0);
300 b64->ops->code(b64, p, n, d);
301 b64->ops->code(b64, 0, 0, d);
302 b64->ops->destroy(b64);
303 } else if (strcmp(fmt, "?TOKENS") == 0) {
304 const char *const *av = va_arg(*ap, const char *const *);
305 while (*av) u_quotify(d, *av++);
306 } else if (strcmp(fmt, "?PEER") == 0)
307 u_quotify(d, p_name(va_arg(*ap, peer *)));
308 else if (strcmp(fmt, "?ERR") == 0) {
309 int e = va_arg(*ap, int);
310 dstr_putf(d, " E%d", e);
311 u_quotify(d, strerror(e));
312 } else if (strcmp(fmt, "?ERRNO") == 0) {
313 dstr_putf(d, " E%d", errno);
314 u_quotify(d, strerror(errno));
318 if (*fmt == '!') fmt++;
320 dstr_vputf(&dd, fmt, ap);
321 u_quotify(d, dd.buf);
323 fmt = va_arg(*ap, const char *);
330 /* --- @a_format@ --- *
332 * Arguments: @dstr *d@ = where to leave the formatted message
333 * @const char *fmt@ = pointer to format string
337 * Use: Writes a tokenized message into a string, for later
341 void a_format(dstr *d, const char *fmt, ...)
346 a_vformat(d, fmt, &ap);
350 /* --- @a_write@, @a_vwrite@ --- *
352 * Arguments: @admin *a@ = admin connection to write to
353 * @const char *status@ = status code to report
354 * @const char *tag@ = tag string, or null
355 * @const char *fmt@ = pointer to format string
356 * @va_list *ap@ = arguments in list
357 * @...@ = other arguments
361 * Use: Sends a message to an admin connection.
364 static void a_vwrite(admin *a, const char *status, const char *tag,
365 const char *fmt, va_list *ap)
369 if (tag) dstr_puts(&d, "BG");
370 dstr_puts(&d, status);
371 if (tag) u_quotify(&d, tag);
372 a_vformat(&d, fmt, ap);
374 dosend(a, d.buf, d.len);
378 static void a_write(admin *a, const char *status, const char *tag,
379 const char *fmt, ...)
384 a_vwrite(a, status, tag, fmt, &ap);
388 /* --- @a_ok@, @a_fail@ --- *
390 * Arguments: @admin *a@ = connection
391 * @const char *fmt@ = format string
392 * @...@ = other arguments
396 * Use: Convenience functions for @a_write@.
399 static void a_ok(admin *a) { a_write(a, "OK", 0, A_END); }
401 static void a_fail(admin *a, const char *fmt, ...)
406 a_vwrite(a, "FAIL", 0, fmt, &ap);
410 /* --- @a_info@ --- *
412 * Arguments: @admin *a@ = connection
413 * @const char *fmt@ = format string
414 * @...@ = other arguments
418 * Use: Report information to an admin client.
421 void a_info(admin *a, const char *fmt, ...)
426 a_vwrite(a, "INFO", 0, fmt, &ap);
430 /* --- @a_alert@, @a_valert@, @a_rawalert@ --- *
432 * Arguments: @unsigned f_and, f_eq@ = filter for connections
433 * @const char *status@ = status string
434 * @const char *fmt@ = pointer to format string
435 * @const char *p@ = pointer to raw string
436 * @size_t sz@ = size of raw string
437 * @va_list *ap@ = arguments in list
438 * @...@ = other arguments
442 * Use: Write a message to all admin connections matched by the given
446 static void a_rawalert(unsigned f_and, unsigned f_eq, const char *status,
447 const char *p, size_t sz)
452 if (!(flags & F_INIT))
454 dstr_puts(&d, status);
457 dstr_putm(&d, p, sz);
462 for (a = admins; a; a = aa) {
464 if ((a->f & f_and) == f_eq)
465 dosend(a, d.buf, d.len);
470 static void a_valert(unsigned f_and, unsigned f_eq, const char *status,
471 const char *fmt, va_list *ap)
475 if (!(flags & F_INIT))
477 a_vformat(&d, fmt, ap);
478 a_rawalert(f_and, f_eq, status, fmt ? d.buf : 0, fmt ? d.len : 0);
482 static void a_alert(unsigned f_and, unsigned f_eq, const char *status,
483 const char *fmt, ...)
488 a_valert(f_and, f_eq, status, fmt, &ap);
492 /* --- @a_warn@ --- *
494 * Arguments: @const char *fmt@ = pointer to format string
495 * @...@ = other arguments
499 * Use: Informs all admin connections of a warning.
502 void a_warn(const char *fmt, ...)
508 a_valert(0, 0, "WARN", fmt, &ap);
511 fprintf(stderr, "%s: ", QUIS);
512 a_vformat(&d, fmt, &ap);
514 dstr_write(&d, stderr);
520 /* --- @a_trace@ --- *
522 * Arguments: @const char *p@ = pointer to a buffer
523 * @size_t sz@ = size of the buffer
524 * @void *v@ = uninteresting pointer
528 * Use: Custom trace output handler. Sends trace messages to
529 * interested admin connections.
533 static void a_trace(const char *p, size_t sz, void *v)
534 { a_rawalert(AF_TRACE, AF_TRACE, "TRACE", p, sz); }
537 /* --- @a_notify@ --- *
539 * Arguments: @const char *fmt@ = pointer to format string
540 * @...@ = other arguments
544 * Use: Sends a notification to interested admin connections.
547 void a_notify(const char *fmt, ...)
552 a_valert(AF_NOTE, AF_NOTE, "NOTE", fmt, &ap);
556 /* --- @a_sigdie@ --- *
558 * Arguments: @int sig@ = signal number
559 * @void *v@ = an uninteresting argument
563 * Use Shuts down on receipt of a fatal signal.
566 static void a_sigdie(int sig, void *v)
572 case SIGTERM: p = "SIGTERM"; break;
573 case SIGINT: p = "SIGINT"; break;
575 sprintf(buf, "%i", sig);
579 a_warn("SERVER", "quit", "signal", "%s", p, A_END);
583 /* --- @a_sighup@ --- *
585 * Arguments: @int sig@ = signal number
586 * @void *v@ = an uninteresting argument
590 * Use Logs a message about SIGHUP not being useful.
593 static void a_sighup(int sig, void *v)
594 { a_warn("SERVER", "ignore", "signal", "SIGHUP", A_END); }
596 /* --- @a_parsetime@ --- *
598 * Arguments; @const char *p@ = time string to parse
600 * Returns: Time in seconds, or @< 0@ on error.
603 static long a_parsetime(const char *p)
606 long t = strtol(p, &q, 0);
612 case 's': if (q[1] != 0)
619 /* --- @a_findpeer@ --- *
621 * Arguments: @admin *a@ = admin connection
622 * @const char *pn@ = peer name
624 * Returns: The peer, or null if not there.
626 * Use: Finds a peer, reporting an error if it failed.
629 static peer *a_findpeer(admin *a, const char *pn)
633 if ((p = p_find(pn)) == 0)
634 a_fail(a, "unknown-peer", "%s", pn, A_END);
638 /*----- Backgrounded operations -------------------------------------------*/
641 (((admin_bgop *)(bg))->tag ? ((admin_bgop *)(bg))->tag : "<foreground>")
643 /* --- @a_bgfind@ --- *
645 * Arguments: @admin *a@ = a client block
646 * @const char *tag@ = the requested tag
648 * Returns: The requested background job, or null.
651 static admin_bgop *a_bgfind(admin *a, const char *tag)
655 for (bg = a->bg; bg; bg = bg->next) {
656 if (bg->tag && strcmp(tag, bg->tag) == 0)
662 /* --- @a_bgrelease@ --- *
664 * Arguments: @admin_bgop *bg@ = backgrounded operation
668 * Use: Removes a backgrounded operation from the queue, since
669 * (presumably) it's done.
672 static void a_bgrelease(admin_bgop *bg)
676 T( trace(T_ADMIN, "admin: release bgop %s", BGTAG(bg)); )
677 if (bg->tag) xfree(bg->tag);
678 else selbuf_enable(&a->b);
679 if (bg->next) bg->next->prev = bg->prev;
680 if (bg->prev) bg->prev->next = bg->next;
681 else a->bg = bg->next;
683 if (!a->bg && (a->f & AF_CLOSE)) a_destroy(a);
686 /* --- @a_bgok@, @a_bginfo@, @a_bgfail@ --- *
688 * Arguments: @admin_bgop *bg@ = backgrounded operation
689 * @const char *fmt@ = format string
690 * @...@ = other arguments
694 * Use: Convenience functions for @a_write@.
697 static void a_bgok(admin_bgop *bg)
698 { a_write(bg->a, "OK", bg->tag, A_END); }
700 static void a_bginfo(admin_bgop *bg, const char *fmt, ...)
704 a_vwrite(bg->a, "INFO", bg->tag, fmt, &ap);
708 static void a_bgfail(admin_bgop *bg, const char *fmt, ...)
712 a_vwrite(bg->a, "FAIL", bg->tag, fmt, &ap);
716 /* --- @a_bgadd@ --- *
718 * Arguments: @admin *a@ = administration connection
719 * @admin_bgop *bg@ = pointer to background operation
720 * @const char *tag@ = background tag, or null for foreground
721 * @void (*cancel)(admin_bgop *)@ = cancel function
723 * Returns: Zero for success, nonzero on failure.
725 * Use: Links a background job into the list.
728 static int a_bgadd(admin *a, admin_bgop *bg, const char *tag,
729 void (*cancel)(admin_bgop *))
732 if (a_bgfind(a, tag)) {
733 a_fail(a, "tag-exists", "%s", tag, A_END);
736 bg->tag = xstrdup(tag);
740 selbuf_disable(&a->b);
746 if (a->bg) a->bg->prev = bg;
748 T( trace(T_ADMIN, "admin: add bgop %s", BGTAG(bg)); )
749 if (tag) a_write(a, "DETACH", tag, A_END);
753 /*----- Job table manipulation --------------------------------------------*/
756 #define JOB_INDEXMASK ((1ul << JOB_SHIFT) - 1)
757 #define JOB_SEQMASK ((1ul << (32 - JOB_SHIFT)) - 1)
759 #define JOB_END 0xfffffffful
761 static unsigned long a_joboffset;
763 /* --- @a_jobidencode@ --- *
765 * Arguments: @admin_svcop *svc@ = pointer to a service operation
767 * Returns: A jobid for this job, in an internal static buffer.
769 * Use: Constructs a jobid. In order to dissuade people from
770 * predicting jobids, we obfuscate them.
772 * A `raw' jobid consists of two 16-bit fields. The low 16 bits
773 * are an index into a big array. The high 16 bits are a
774 * sequence number recording how many times that slot has been
777 * This `raw' jobid is then obfuscated by adding a randomly-
778 * generated offset, and multiplying (mod %$2^{32}$%) by a fixed
782 static const char *a_jobidencode(admin_svcop *svc)
784 admin_jobtable *j = &svc->prov->j;
789 assert(svc->index <= JOB_INDEXMASK);
790 seq = j->v[svc->index].seq;
791 assert(seq <= JOB_SEQMASK);
792 pre = (unsigned long)svc->index | ((unsigned long)seq << JOB_SHIFT);
793 sprintf(buf, "J%08lx", ((pre + a_joboffset) * 0x0f87a7a3ul) & 0xffffffff);
797 /* --- @a_jobiddecode@ --- *
799 * Arguments: @admin_jobtable *j@ = pointer to a job table
800 * @const char *jid@ = pointer to a jobid string
802 * Returns: A pointer to the job's @svcop@ structure.
805 static admin_svcop *a_jobiddecode(admin_jobtable *j, const char *jid)
812 for (i = 1; i < 9; i++) {
813 if (!isxdigit((unsigned char)jid[i]))
818 pre = strtoul(jid + 1, 0, 16);
819 pre = ((pre * 0xbd11c40bul) - a_joboffset) & 0xffffffff;
820 i = pre & JOB_INDEXMASK;
821 if (i >= j->n || j->v[i].seq != (pre >> JOB_SHIFT))
823 return (j->v[i].u.op);
826 /* --- @a_jobcreate@ --- *
828 * Arguments: @admin *a@ = pointer to administration client
830 * Returns: A pointer to a freshly-allocated @svcop@, or null.
832 * Use: Allocates a fresh @svcop@ and links it into a job table.
835 static admin_svcop *a_jobcreate(admin *a)
840 admin_jobtable *j = &a->j;
842 if (j->free != JOB_END) {
844 j->free = j->v[i].u.next;
847 if (j->sz > JOB_INDEXMASK)
852 j->v = xmalloc(j->sz * sizeof(*j->v));
855 j->v = xrealloc(j->v, j->sz * sizeof(*j->v), sz * sizeof(*j->v));
861 svc = xmalloc(sizeof(*svc));
864 svc->next = j->active;
866 if (j->active) j->active->prev = svc;
869 IF_TRACING(T_ADMIN, {
870 trace(T_ADMIN, "admin: created job %s (%u)", a_jobidencode(svc), i);
875 /* --- @a_jobdestroy@ --- *
877 * Arguments: @admin_svcop *svc@ = pointer to job block
881 * Use: Frees up a completed (or cancelled) job.
884 static void a_jobdestroy(admin_svcop *svc)
886 admin *a = svc->prov;
887 admin_jobtable *j = &a->j;
888 unsigned i = svc->index;
890 IF_TRACING(T_ADMIN, {
891 trace(T_ADMIN, "admin: destroying job %s (%u)", a_jobidencode(svc), i);
893 assert(j->v[i].u.op == svc);
894 j->v[i].u.next = j->free;
897 if (svc->next) svc->next->prev = svc->prev;
898 if (svc->prev) svc->prev->next = svc->next;
899 else j->active = svc->next;
902 /* --- @a_jobtableinit@ --- *
904 * Arguments: @admin_jobtable *j@ = pointer to job table
908 * Use: Initializes a job table.
911 static void a_jobtableinit(admin_jobtable *j)
914 a_joboffset = GR_RANGE(&rand_global, 0xffffffff) + 1;
921 /* --- @a_jobtablefinal@ --- *
923 * Arguments: @admin_jobtable *j@ = pointer to job table
927 * Use: Closes down a job table.
930 static void a_jobtablefinal(admin_jobtable *j)
932 admin_svcop *svc, *ssvc;
934 for (svc = j->active; svc; svc = ssvc) {
936 a_bgfail(&svc->bg, "provider-failed", A_END);
937 a_bgrelease(&svc->bg);
939 if (j->v) xfree(j->v);
942 /*----- Services infrastructure -------------------------------------------*/
944 /* --- @a_svcfind@ --- *
946 * Arguments: @admin *a@ = the requesting client
947 * @const char *name@ = service name wanted
949 * Returns: The service requested, or null.
951 * Use: Finds a service; reports an error if the service couldn't be
955 static admin_service *a_svcfind(admin *a, const char *name)
959 if ((svc = sym_find(&a_svcs, name, -1, 0, 0)) == 0) {
960 a_fail(a, "unknown-service", "%s", name, A_END);
966 /* --- @a_svcunlink@ --- *
968 * Arguments: @admin_service *svc@ = pointer to service structure
972 * Use: Unlinks the service from its provider, without issuing a
973 * message or freeing the structure. The version string is
977 static void a_svcunlink(admin_service *svc)
980 svc->next->prev = svc->prev;
982 svc->prev->next = svc->next;
984 svc->prov->svcs = svc->next;
988 /* --- @a_svcrelease@ --- *
990 * Arguments: @admin_service *svc@ = pointer to service structure
994 * Use: Releases a service and frees its structure.
997 static void a_svcrelease(admin_service *svc)
999 a_notify("SVCRELEASE", "%s", SYM_NAME(svc), A_END);
1001 sym_remove(&a_svcs, svc);
1004 /*----- Name resolution operations ----------------------------------------*/
1008 /* --- @before_select@ --- *
1010 * Arguments: @sel_state *s@ = the @sel@ multiplexor (unused)
1011 * @sel_args *a@ = input to @select@, to be updated
1012 * @void *p@ = a context pointer (unused)
1016 * Use: An I/O multiplexor hook, called just before waiting for I/O
1019 * Currently its main purpose is to wire ADNS into the event
1023 static void before_select(sel_state *s, sel_args *a, void *p)
1031 /* --- Check for name-resolution progress --- *
1033 * If there is any, then clobber the timeout: one of the resolver
1034 * callbacks might have renewed its interest in a file descriptor, but too
1035 * late to affect this @select@ call.
1037 * I think, strictly, this is an mLib bug, but it's cheap enough to hack
1038 * around here. Fixing it will wait for mLib 3.
1043 if (adns_check(ads, &q, &n, &p)) break;
1046 if (n->status != adns_s_ok) {
1047 T( trace(T_ADMIN, "admin: resop %s failed: %s",
1048 BGTAG(r), adns_strerror(n->status)); )
1049 a_bgfail(&r->bg, "resolve-error", "%s", r->addr, A_END);
1050 r->func(r, ARES_FAIL);
1052 T( trace(T_ADMIN, "admin: resop %s ok", BGTAG(r)); )
1053 assert(n->type == adns_r_addr);
1054 assert(n->nrrs > 0);
1055 assert(n->rrs.addr[0].len <= sizeof(r->sa));
1056 memcpy(&r->sa, &n->rrs.addr[0].addr, n->rrs.addr[0].len);
1057 setport(&r->sa, r->port);
1058 r->func(r, ARES_OK);
1063 a_bgrelease(&r->bg);
1066 if (any) { a->tvp = &a->tv; a->tv.tv_sec = 0; a->tv.tv_usec = 0; }
1068 gettimeofday(&now, 0);
1069 adns_beforeselect(ads, &a->maxfd,
1070 &a->fd[SEL_READ], &a->fd[SEL_WRITE], &a->fd[SEL_EXC],
1071 &a->tvp, &a->tv, &now);
1074 /* --- @after_select@ --- *
1076 * Arguments: @sel_state *s@ = the @sel@ multiplexor (unused)
1077 * @sel_args *a@ = input to @select@, to be updated
1078 * @void *p@ = a context pointer (unused)
1082 * Use: An I/O multiplexor hook, called just after waiting for I/O
1085 * Currently its main purpose is to wire ADNS into the event
1089 static void after_select(sel_state *s, sel_args *a, void *p)
1093 gettimeofday(&now, 0);
1094 adns_afterselect(ads, a->maxfd,
1095 &a->fd[SEL_READ], &a->fd[SEL_WRITE], &a->fd[SEL_EXC],
1101 /* --- @a_resolved@ --- *
1103 * Arguments: @struct hostent *h@ = pointer to resolved hostname
1104 * @void *v@ = pointer to resolver operation
1108 * Use: Handles a completed name resolution.
1111 static void a_resolved(struct hostent *h, void *v)
1117 T( trace(T_ADMIN, "admin: resop %s failed: %s",
1118 BGTAG(r), hstrerror(h_errno)); )
1119 a_bgfail(&r->bg, "resolve-error", "%s", r->addr, A_END);
1120 r->func(r, ARES_FAIL);
1122 T( trace(T_ADMIN, "admin: resop %s ok", BGTAG(r)); )
1123 r->sa.sin.sin_family = AF_INET;
1124 memcpy(&r->sa.sin.sin_addr, h->h_addr, sizeof(struct in_addr));
1125 setport(&r->sa, r->port);
1126 r->func(r, ARES_OK);
1130 a_bgrelease(&r->bg);
1135 /* --- @a_restimer@ --- *
1137 * Arguments: @struct timeval *tv@ = timer
1138 * @void *v@ = pointer to resolver operation
1142 * Use: Times out a resolver.
1145 static void a_restimer(struct timeval *tv, void *v)
1149 T( trace(T_ADMIN, "admin: resop %s timeout", BGTAG(r)); )
1150 a_bgfail(&r->bg, "resolver-timeout", "%s", r->addr, A_END);
1151 r->func(r, ARES_FAIL);
1158 a_bgrelease(&r->bg);
1161 /* --- @a_rescancel@ --- *
1163 * Arguments: @admin_bgop *bg@ = background operation
1167 * Use: Cancels an add operation.
1170 static void a_rescancel(admin_bgop *bg)
1172 admin_resop *r = (admin_resop *)bg;
1174 T( trace(T_ADMIN, "admin: cancel resop %s", BGTAG(r)); )
1175 r->func(r, ARES_FAIL);
1185 /* --- @a_resolve@ --- *
1187 * Arguments: @admin *a@ = administration connection
1188 * @admin_resop *r@ = resolver operation to run
1189 * @const char *tag@ = background operation tag
1190 * @void (*func)(struct admin_resop *, int@ = handler function
1191 * @unsigned ac@ = number of remaining arguments
1192 * @char *av[]@ = pointer to remaining arguments
1196 * Use: Cranks up a resolver job.
1199 static void a_resolve(admin *a, admin_resop *r, const char *tag,
1200 void (*func)(struct admin_resop *, int),
1201 unsigned ac, char *av[])
1206 const char *fam = "ANY";
1209 struct addrinfo *ai, *ailist, aihint = { 0 };
1215 /* --- Fill in the easy bits of address --- */
1217 r->bg.tag = "<starting>";
1220 if (mystrieq(av[i], "any"))
1221 { fam = "ANY"; af = AF_UNSPEC; i++; }
1222 else for (j = 0; j < NADDRFAM; j++) {
1223 if (mystrieq(av[i], aftab[j].name)) {
1224 if (udpsock[j].sf.fd < 0) {
1225 a_fail(a, "disabled-address-family", "%s", aftab[j].name, A_END);
1228 fam = aftab[j].name;
1234 if (ac - i != 1 && ac - i != 2) {
1235 a_fail(a, "bad-addr-syntax", "[FAMILY] ADDRESS [PORT]", A_END);
1238 r->addr = xstrdup(av[i]);
1242 pt = strtoul(av[i + 1], &p, 0);
1244 struct servent *s = getservbyname(av[i + 1], "udp");
1246 a_fail(a, "unknown-service", "%s", av[i + 1], A_END);
1249 pt = ntohs(s->s_port);
1252 if (pt == 0 || pt >= 65536) {
1253 a_fail(a, "invalid-port", "%lu", pt, A_END);
1258 /* --- Report backgrounding --- *
1260 * Do this for consistency of interface, even if we're going to get the
1261 * answer straight away.
1264 if (a_bgadd(a, &r->bg, tag, a_rescancel))
1266 T( trace(T_ADMIN, "admin: %u, resop %s, hostname `%s', family `%s'",
1267 a->seq, BGTAG(r), r->addr, fam); )
1269 /* --- If the name is numeric, do it the easy way --- */
1271 aihint.ai_family = af;
1272 aihint.ai_socktype = SOCK_DGRAM;
1273 aihint.ai_protocol = IPPROTO_UDP;
1274 aihint.ai_flags = AI_NUMERICHOST;
1275 if (!getaddrinfo(av[i], 0, &aihint, &ailist)) {
1276 for (ai = ailist; ai; ai = ai->ai_next) {
1277 if ((j = afix(ai->ai_family)) >= 0 && udpsock[j].sf.fd >= 0)
1281 T( trace(T_ADMIN, "admin: resop %s failed: "
1282 "no suitable addresses returned", BGTAG(r)); )
1283 a_bgfail(&r->bg, "resolve-error", "%s" , r->addr, A_END);
1286 T( trace(T_ADMIN, "admin: resop %s done the easy way", BGTAG(r)); )
1287 assert(ai->ai_addrlen <= sizeof(r->sa));
1288 memcpy(&r->sa, ai->ai_addr, ai->ai_addrlen);
1289 setport(&r->sa, r->port);
1292 freeaddrinfo(ailist);
1294 a_bgrelease(&r->bg);
1298 /* --- Store everything for later and crank up the resolver --- */
1300 gettimeofday(&tv, 0);
1301 tv.tv_sec += T_RESOLVE;
1302 sel_addtimer(&sel, &r->t, &tv, a_restimer, r);
1304 qf = adns_qf_search;
1305 for (j = 0; j < NADDRFAM; j++) {
1306 if ((af == AF_UNSPEC || af == aftab[i].af) && udpsock[j].sf.fd >= 0)
1309 if ((err = adns_submit(ads, r->addr, adns_r_addr, qf, r, &r->q)) != 0) {
1310 T( trace(T_ADMIN, "admin: resop %s adns_submit failed: %s",
1311 BGTAG(r), strerror(err)); )
1312 a_bgfail(&r->bg, "resolve-error", "%s", r->addr, A_END);
1316 if (af != AF_UNSPEC && af != AF_INET) {
1317 T( trace(T_ADMIN, "admin: resop %s failed: unsupported address family",
1319 a_bgfail(&r->bg, "resolve-error", "%s", r->addr, A_END);
1322 if (udpsock[AFIX_INET].sf.fd < 0) {
1323 a_bgfail(&r->bg, "disabled-address-family", "INET", A_END);
1326 bres_byname(&r->r, r->addr, a_resolved, r);
1332 if (r->addr) xfree(r->addr);
1339 a_bgrelease(&r->bg);
1342 /*----- Option parsing ----------------------------------------------------*/
1344 #define OPTIONS(argc, argv, guts) do { \
1345 char **o_av = argv; \
1349 if (mystrieq(*o_av, "--")) { \
1354 if (**o_av == '-') \
1358 argc -= o_av - argv; \
1362 #define OPT(name, guts) if (mystrieq(*o_av, name)) { guts continue; }
1364 #define OPTARG(name, arg, guts) OPT(name, { \
1367 if (!arg) goto bad_syntax; \
1371 #define OPTTIME(name, arg, guts) OPTARG(name, o_arg, { \
1373 if ((arg = a_parsetime(o_arg)) < 0) { \
1374 a_fail(a, "bad-time-spec", "%s", o_arg, A_END); \
1380 /*----- Adding peers ------------------------------------------------------*/
1382 /* --- @a_doadd@ --- *
1384 * Arguments: @admin_resop *r@ = resolver operation
1385 * @int rc@ = how it worked
1389 * Use: Handles a completed resolution.
1392 static void a_doadd(admin_resop *r, int rc)
1394 admin_addop *add = (admin_addop *)r;
1396 T( trace(T_ADMIN, "admin: done add op %s", BGTAG(add)); )
1398 if (rc == ARES_OK) {
1399 add->peer.sa = add->r.sa;
1400 if (p_findbyaddr(&add->r.sa))
1401 a_bgfail(&add->r.bg, "peer-addr-exists", "?ADDR", &add->r.sa, A_END);
1402 else if (p_find(add->peer.name))
1403 a_bgfail(&add->r.bg, "peer-exists", "%s", add->peer.name, A_END);
1404 else if (!p_create(&add->peer))
1405 a_bgfail(&add->r.bg, "peer-create-fail", "%s", add->peer.name, A_END);
1410 if (add->peer.tag) xfree(add->peer.tag);
1411 if (add->peer.privtag) xfree(add->peer.privtag);
1412 if (add->peer.knock) xfree(add->peer.knock);
1413 xfree(add->peer.name);
1416 /* --- @acmd_add@ --- *
1418 * Arguments: @admin *a@ = connection which requested the addition
1419 * @unsigned ac@ = argument count
1420 * @char *av[]@ = pointer to the argument list
1424 * Use: Adds a new peer.
1427 static void acmd_add(admin *a, unsigned ac, char *av[])
1429 const char *tag = 0;
1431 const tunnel_ops *tops;
1433 /* --- Set stuff up --- */
1435 add = xmalloc(sizeof(*add));
1438 add->peer.privtag = 0;
1439 add->peer.knock = 0;
1441 add->peer.tops = p_dflttun();
1444 /* --- Parse options --- */
1447 OPTARG("-background", arg, { tag = arg; })
1448 OPTARG("-tunnel", arg, {
1449 if ((tops = p_findtun(arg)) == 0)
1450 { a_fail(a, "unknown-tunnel", "%s", arg, A_END); goto fail; }
1451 add->peer.tops = tops;
1453 OPTTIME("-keepalive", t, { add->peer.t_ka = t; })
1454 OPT("-cork", { add->peer.f |= KXF_CORK; })
1455 OPT("-ephemeral", { add->peer.f |= PSF_EPHEM; })
1456 OPTARG("-key", arg, {
1457 if (add->peer.tag) xfree(add->peer.tag);
1458 add->peer.tag = xstrdup(arg);
1460 OPT("-mobile", { add->peer.f |= PSF_MOBILE; })
1461 OPTARG("-priv", arg, {
1462 if (add->peer.privtag) xfree(add->peer.privtag);
1463 add->peer.privtag = xstrdup(arg);
1465 OPTARG("-knock", arg, {
1466 if (add->peer.knock) xfree(add->peer.knock);
1467 add->peer.knock = xstrdup(arg);
1471 /* --- Make sure someone's not got there already --- */
1473 if (!av[0] || !av[1])
1476 a_fail(a, "peer-exists", "%s", *av, A_END);
1479 add->peer.name = xstrdup(*av++);
1482 /* --- Crank up the resolver --- */
1484 a_resolve(a, &add->r, tag, a_doadd, ac, av);
1487 /* --- Clearing up --- */
1490 a_fail(a, "bad-syntax", "add", "[OPTIONS] PEER ADDR ...", A_END);
1492 if (add->peer.name) xfree(add->peer.name);
1493 if (add->peer.tag) xfree(add->peer.tag);
1494 if (add->peer.privtag) xfree(add->peer.privtag);
1495 if (add->peer.knock) xfree(add->peer.knock);
1500 /*----- Ping --------------------------------------------------------------*/
1502 /* --- @a_pingcancel@ --- *
1504 * Arguments: @admin_bgop *bg@ = background operation block
1508 * Use: Cancels a running ping.
1511 static void a_pingcancel(admin_bgop *bg)
1513 admin_pingop *pg = (admin_pingop *)bg;
1514 T( trace(T_ADMIN, "admin: cancel ping op %s", BGTAG(pg)); )
1515 p_pingdone(&pg->ping, PING_NONOTIFY);
1518 /* --- @a_pong@ --- *
1520 * Arguments: @int rc@ = return code
1521 * @void *v@ = ping operation block
1525 * Use: Collects what happened to a ping message.
1528 static void a_pong(int rc, void *v)
1530 admin_pingop *pg = v;
1536 gettimeofday(&tv, 0);
1537 tv_sub(&tv, &tv, &pg->pingtime);
1538 millis = (double)tv.tv_sec * 1000 + (double)tv.tv_usec/1000;
1539 a_bginfo(&pg->bg, "ping-ok", "%.1f", millis, A_END);
1543 a_bginfo(&pg->bg, "ping-timeout", A_END);
1547 a_bginfo(&pg->bg, "ping-peer-died", A_END);
1553 T( trace(T_ADMIN, "admin: ponged ping op %s", BGTAG(pg)); )
1554 a_bgrelease(&pg->bg);
1557 /* --- @acmd_ping@, @acmd_eping@ --- *
1559 * Arguments: @admin *a@ = connection which requested the ping
1560 * @unsigned ac@ = argument count
1561 * @char *av[]@ = pointer to the argument list
1565 * Use: Pings a peer.
1568 static void a_ping(admin *a, unsigned ac, char *av[],
1569 const char *cmd, unsigned msg)
1573 admin_pingop *pg = 0;
1574 const char *tag = 0;
1577 OPTARG("-background", arg, { tag = arg; })
1578 OPTTIME("-timeout", arg, { t = arg; })
1580 if (!*av || av[1]) goto bad_syntax;
1581 if ((p = a_findpeer(a, *av)) == 0)
1583 pg = xmalloc(sizeof(*pg));
1584 gettimeofday(&pg->pingtime, 0);
1585 if (a_bgadd(a, &pg->bg, tag, a_pingcancel))
1587 T( trace(T_ADMIN, "admin: ping op %s: %s to %s",
1588 BGTAG(pg), cmd, p_name(p)); )
1589 if (p_pingsend(p, &pg->ping, msg, t, a_pong, pg)) {
1590 a_bgfail(&pg->bg, "ping-send-failed", A_END);
1591 a_bgrelease(&pg->bg);
1596 a_fail(a, "bad-syntax", "%s", cmd, "[OPTIONS] PEER", A_END);
1602 static void acmd_ping(admin *a, unsigned ac, char *av[])
1603 { a_ping(a, ac, av, "ping", MISC_PING); }
1604 static void acmd_eping(admin *a, unsigned ac, char *av[])
1605 { a_ping(a, ac, av, "eping", MISC_EPING); }
1607 /*----- Service commands --------------------------------------------------*/
1609 static void acmd_svcclaim(admin *a, unsigned ac, char *av[])
1614 svc = sym_find(&a_svcs, av[0], -1, sizeof(*svc), &f);
1616 if (versioncmp(av[1], svc->version) <= 0) {
1619 "%s", SYM_NAME(svc),
1624 a_write(svc->prov, "SVCCLAIM", 0, "%s", av[0], "%s", av[1], A_END);
1628 svc->version = xstrdup(av[1]);
1629 svc->next = a->svcs;
1631 if (a->svcs) a->svcs->prev = svc;
1633 a_notify("SVCCLAIM", "%s", SYM_NAME(svc), "%s", svc->version, A_END);
1637 static void acmd_svcrelease(admin *a, unsigned ac, char *av[])
1641 if ((svc = a_svcfind(a, av[0])) == 0)
1643 if (svc->prov != a) {
1644 a_fail(a, "not-service-provider", "%s", SYM_NAME(svc), A_END);
1651 static void acmd_svcensure(admin *a, unsigned ac, char *av[])
1655 if ((svc = a_svcfind(a, av[0])) == 0)
1657 if (av[1] && versioncmp(svc->version, av[1]) < 0) {
1658 a_fail(a, "service-too-old",
1659 "%s", SYM_NAME(svc),
1667 static void acmd_svcquery(admin *a, unsigned ac, char *av[])
1671 if ((svc = a_svcfind(a, av[0])) != 0) {
1672 a_info(a, "name=%s", SYM_NAME(svc), "version=%s", svc->version, A_END);
1677 static void acmd_svclist(admin *a, unsigned ac, char *av[])
1682 for (sym_mkiter(&i, &a_svcs); (svc = sym_next(&i)) != 0; )
1683 a_info(a, "%s", SYM_NAME(svc), "%s", svc->version, A_END);
1687 static void a_canceljob(admin_bgop *bg)
1689 admin_svcop *svc = (admin_svcop *)bg;
1691 a_write(svc->prov, "SVCCANCEL", 0, "%s", a_jobidencode(svc), A_END);
1695 static void acmd_svcsubmit(admin *a, unsigned ac, char *av[])
1697 const char *tag = 0;
1700 const char *ver = 0;
1704 OPTARG("-background", arg, { tag = arg; })
1705 OPTARG("-version", arg, { ver = arg; })
1707 if (!*av) goto bad_syntax;
1708 if ((svc = a_svcfind(a, *av)) == 0) goto fail;
1709 if (ver && versioncmp(svc->version, ver) < 0) {
1710 a_fail(a, "service-too-old",
1711 "%s", SYM_NAME(svc),
1716 if ((svcop = a_jobcreate(svc->prov)) == 0) {
1717 a_fail(a, "provider-overloaded", A_END);
1720 if (a_bgadd(a, &svcop->bg, tag, a_canceljob)) {
1721 a_jobdestroy(svcop);
1724 a_write(svc->prov, "SVCJOB", 0,
1725 "%s", a_jobidencode(svcop),
1731 a_fail(a, "bad-syntax", "svcsubmit", "[OPTIONS] SERVICE ARGS...", A_END);
1738 static void a_replycmd(admin *a, const char *status, int donep, char *av[])
1742 if ((svc = a_jobiddecode(&a->j, av[0])) == 0) {
1743 a_fail(a, "unknown-jobid", av[0], A_END);
1746 a_write(svc->bg.a, status, svc->bg.tag, "?TOKENS", av + 1, A_END);
1749 a_bgrelease(&svc->bg);
1754 static void acmd_svcok(admin *a, unsigned ac, char *av[])
1755 { a_replycmd(a, "OK", 1, av); }
1756 static void acmd_svcinfo(admin *a, unsigned ac, char *av[])
1757 { a_replycmd(a, "INFO", 0, av); }
1758 static void acmd_svcfail(admin *a, unsigned ac, char *av[])
1759 { a_replycmd(a, "FAIL", 1, av); }
1761 /*----- Administration commands -------------------------------------------*/
1763 /* --- Miscellaneous commands --- */
1765 /* --- @traceish@ --- *
1767 * Arguments: @admin *a@ = connection to complain on
1768 * @unsigned ac@ = number of arguments
1769 * @char *av[]@ = vector of arguments
1770 * @const char *what@ = what we're messing with
1771 * @const trace_opt *tt@ = options table
1772 * @unsigned *ff@ = where the flags are
1774 * Returns: Nonzero if anything changed.
1776 * Use: Guts of trace-ish commands like `trace' and `watch'.
1779 static int traceish(admin *a, unsigned ac, char *av[],
1780 const char *what, const trace_opt *tt, unsigned *ff)
1784 if (!ac || strcmp(av[0], "?") == 0) {
1786 for (t = tt; t->ch; t++) {
1787 a_info(a, "*%c%c %s",
1788 t->ch, (*ff & t->f) == t->f ? '+' : ' ', t->help, A_END);
1798 case '+': sense = 1; break;
1799 case '-': sense = 0; break;
1801 for (t = tt; t->ch; t++) {
1803 if (sense) f |= t->f;
1808 a_fail(a, "bad-%s-option", what, "%c", *p, A_END);
1824 static void acmd_trace(admin *a, unsigned ac, char *av[])
1826 if (traceish(a, ac, av, "trace", tr_opts, &tr_flags))
1827 trace_level(tr_flags);
1832 static void acmd_watch(admin *a, unsigned ac, char *av[])
1833 { traceish(a, ac, av, "watch", w_opts, &a->f); }
1835 static void alertcmd(admin *a, unsigned f_and, unsigned f_eq,
1836 const char *status, char *av[])
1837 { a_alert(f_and, f_eq, status, "USER", "?TOKENS", av, A_END); a_ok(a); }
1838 static void acmd_notify(admin *a, unsigned ac, char *av[])
1839 { alertcmd(a, AF_NOTE, AF_NOTE, "NOTE", av); }
1840 static void acmd_warn(admin *a, unsigned ac, char *av[])
1841 { alertcmd(a, AF_WARN, AF_WARN, "WARN", av); }
1843 static void acmd_port(admin *a, unsigned ac, char *av[])
1848 for (i = 0; i < NADDRFAM; i++)
1849 if (mystrieq(av[0], aftab[i].name)) goto found;
1850 a_fail(a, "unknown-address-family", "%s", av[0], A_END);
1853 if (udpsock[i].sf.fd < 0) {
1854 a_fail(a, "disabled-address-family", "%s", aftab[i].name, A_END);
1858 for (i = 0; i < NADDRFAM; i++)
1859 if (udpsock[i].sf.fd >= 0) goto found;
1862 a_info(a, "%u", udpsock[i].port, A_END);
1866 static void acmd_daemon(admin *a, unsigned ac, char *av[])
1868 if (flags & F_DAEMON)
1869 a_fail(a, "already-daemon", A_END);
1871 a_notify("DAEMON", A_END);
1875 a_fail(a, "daemon-error", "?ERRNO", A_END);
1883 static void acmd_jobs(admin *a, unsigned ac, char *av[])
1887 for (bg = a->bg; bg; bg = bg->next) {
1889 a_info(a, "%s", bg->tag, A_END);
1894 static void acmd_bgcancel(admin *a, unsigned ac, char *av[])
1898 if ((bg = a_bgfind(a, av[0])) == 0)
1899 a_fail(a, "unknown-tag", "%s", av[0], A_END);
1907 static void acmd_algs(admin *a, unsigned ac, char *av[])
1912 const algswitch *algs;
1917 if ((p = a_findpeer(a, av[0])) == 0) return;
1923 g->ops->grpinfo(g, a);
1925 "hash=%s", algs->h->name,
1926 "mgf=%s", algs->mgf->name,
1927 "hash-sz=%lu", (unsigned long)algs->h->hashsz,
1930 "bulk-transform=%s", algs->bulk->ops->name,
1931 "bulk-overhead=%lu",
1932 (unsigned long)algs->bulk->ops->overhead(algs->bulk),
1934 algs->bulk->ops->alginfo(algs->bulk, a);
1936 "cipher-data-limit=%lu",
1937 (unsigned long)algs->bulk->ops->expsz(algs->bulk),
1942 static void acmd_list(admin *a, unsigned ac, char *av[])
1944 FOREACH_PEER(p, { a_info(a, "%s", p_name(p), A_END); });
1948 static void acmd_ifname(admin *a, unsigned ac, char *av[])
1952 if ((p = a_findpeer(a, av[0])) != 0) {
1953 a_info(a, "%s", p_ifname(p), A_END);
1958 static void acmd_setifname(admin *a, unsigned ac, char *av[])
1962 if ((p = a_findpeer(a, av[0])) != 0) {
1963 a_notify("NEWIFNAME", "?PEER", p, "%s", p_ifname(p), "%s", av[1], A_END);
1964 p_setifname(p, av[1]);
1969 static void acmd_getchal(admin *a, unsigned ac, char *av[])
1973 buf_init(&b, buf_i, PKBUFSZ);
1975 a_info(a, "?B64", BBASE(&b), (size_t)BLEN(&b), A_END);
1979 static void acmd_checkchal(admin *a, unsigned ac, char *av[])
1981 codec *b64 = base64_class.decoder(CDCF_NOEQPAD);
1986 if ((err = b64->ops->code(b64, av[0], strlen(av[0]), &d)) != 0 ||
1987 (err = b64->ops->code(b64, 0, 0, &d)) != 0)
1988 a_fail(a, "bad-base64", "%s", codec_strerror(err), A_END);
1990 buf_init(&b, d.buf, d.len);
1991 if (c_check(0, 0, &b) || BBAD(&b) || BLEFT(&b))
1992 a_fail(a, "invalid-challenge", A_END);
1996 b64->ops->destroy(b64);
2000 static void acmd_greet(admin *a, unsigned ac, char *av[])
2007 if ((p = a_findpeer(a, av[0])) == 0) return;
2008 b64 = base64_class.decoder(CDCF_NOEQPAD);
2009 if ((err = b64->ops->code(b64, av[1], strlen(av[1]), &d)) != 0 ||
2010 (err = b64->ops->code(b64, 0, 0, &d)) != 0)
2011 a_fail(a, "bad-base64", "%s", codec_strerror(err), A_END);
2013 p_greet(p, d.buf, d.len);
2016 b64->ops->destroy(b64);
2020 static void acmd_addr(admin *a, unsigned ac, char *av[])
2025 if ((p = a_findpeer(a, av[0])) != 0) {
2027 a_info(a, "?ADDR", ad, A_END);
2032 static void acmd_peerinfo(admin *a, unsigned ac, char *av[])
2038 if ((p = a_findpeer(a, av[0])) != 0) {
2040 a_info(a, "tunnel=%s", ps->tops->name, A_END);
2041 if (ps->knock) a_info(a, "knock=%s", ps->knock, A_END);
2042 a_info(a, "key=%s", p_tag(p),
2043 "current-key=%s", p->kx.kpub->tag, A_END);
2044 if ((ptag = p_privtag(p)) == 0) ptag = "(default)";
2045 a_info(a, "private-key=%s", ptag,
2046 "current-private-key=%s", p->kx.kpriv->tag, A_END);
2047 a_info(a, "keepalive=%lu", ps->t_ka, A_END);
2048 a_info(a, "corked=%s", BOOL(p->kx.f&KXF_CORK),
2049 "mobile=%s", BOOL(ps->f&PSF_MOBILE),
2050 "ephemeral=%s", BOOL(ps->f&PSF_EPHEM),
2056 static void acmd_servinfo(admin *a, unsigned ac, char *av[])
2058 a_info(a, "implementation=edgeware-tripe", A_END);
2059 a_info(a, "version=%s", VERSION, A_END);
2060 a_info(a, "daemon=%s", BOOL(flags & F_DAEMON), A_END);
2064 static void acmd_stats(admin *a, unsigned ac, char *av[])
2069 if ((p = a_findpeer(a, av[0])) == 0)
2073 a_info(a, "start-time=%s", timestr(st->t_start), A_END);
2074 a_info(a, "last-packet-time=%s", timestr(st->t_last), A_END);
2075 a_info(a, "last-keyexch-time=%s", timestr(st->t_kx), A_END);
2076 a_info(a, "packets-in=%lu", st->n_in, "bytes-in=%lu", st->sz_in, A_END);
2078 "packets-out=%lu", st->n_out,
2079 "bytes-out=%lu", st->sz_out,
2082 "keyexch-packets-in=%lu", st->n_kxin,
2083 "keyexch-bytes-in=%lu", st->sz_kxin,
2086 "keyexch-packets-out=%lu", st->n_kxout,
2087 "keyexch-bytes-out=%lu", st->sz_kxout,
2090 "ip-packets-in=%lu", st->n_ipin,
2091 "ip-bytes-in=%lu", st->sz_ipin,
2094 "ip-packets-out=%lu", st->n_ipout,
2095 "ip-bytes-out=%lu", st->sz_ipout,
2097 a_info(a, "rejected-packets=%lu", st->n_reject, A_END);
2101 static void acmd_kill(admin *a, unsigned ac, char *av[])
2105 if ((p = a_findpeer(a, av[0])) != 0) {
2111 static void acmd_forcekx(admin *a, unsigned ac, char *av[])
2115 if ((p = a_findpeer(a, av[0])) != 0) {
2116 kx_start(&p->kx, 1);
2121 static void acmd_reload(admin *a, unsigned ac, char *av[])
2122 { p_keyreload(); a_ok(a); }
2124 static void acmd_quit(admin *a, unsigned ac, char *av[])
2126 a_warn("SERVER", "quit", "admin-request", A_END);
2131 static void acmd_version(admin *a, unsigned ac, char *av[])
2133 a_info(a, "%s", PACKAGE, "%s", VERSION, A_END);
2137 static void acmd_tunnels(admin *a, unsigned ac, char *av[])
2139 FOREACH_TUN(tops, { a_info(a, "%s", tops->name, A_END); });
2143 /* --- The command table and help --- */
2145 typedef struct acmd {
2148 unsigned argmin, argmax;
2149 void (*func)(admin */*a*/, unsigned /*ac*/, char */*av*/[]);
2152 static void acmd_help(admin */*a*/, unsigned /*ac*/, char */*av*/[]);
2154 static const acmd acmdtab[] = {
2155 { "add", "[OPTIONS] PEER ADDR ...", 2, 0xffff, acmd_add },
2156 { "addr", "PEER", 1, 1, acmd_addr },
2157 { "algs", "[PEER]", 0, 1, acmd_algs },
2158 { "bgcancel", "TAG", 1, 1, acmd_bgcancel },
2159 { "checkchal", "CHAL", 1, 1, acmd_checkchal },
2160 { "daemon", 0, 0, 0, acmd_daemon },
2161 { "eping", "[OPTIONS] PEER", 1, 0xffff, acmd_eping },
2162 { "forcekx", "PEER", 1, 1, acmd_forcekx },
2163 { "getchal", 0, 0, 0, acmd_getchal },
2164 { "greet", "PEER CHAL", 2, 2, acmd_greet },
2165 { "help", 0, 0, 0, acmd_help },
2166 { "ifname", "PEER", 1, 1, acmd_ifname },
2167 { "jobs", 0, 0, 0, acmd_jobs },
2168 { "kill", "PEER", 1, 1, acmd_kill },
2169 { "list", 0, 0, 0, acmd_list },
2170 { "notify", "MESSAGE ...", 1, 0xffff, acmd_notify },
2171 { "peerinfo", "PEER", 1, 1, acmd_peerinfo },
2172 { "ping", "[OPTIONS] PEER", 1, 0xffff, acmd_ping },
2173 { "port", "[FAMILY]", 0, 1, acmd_port },
2174 { "quit", 0, 0, 0, acmd_quit },
2175 { "reload", 0, 0, 0, acmd_reload },
2176 { "servinfo", 0, 0, 0, acmd_servinfo },
2177 { "setifname", "PEER NEW-NAME", 2, 2, acmd_setifname },
2178 { "stats", "PEER", 1, 1, acmd_stats },
2179 { "svcclaim", "SERVICE VERSION", 2, 2, acmd_svcclaim },
2180 { "svcensure", "SERVICE [VERSION]", 1, 2, acmd_svcensure },
2181 { "svcfail", "JOBID TOKENS...", 1, 0xffff, acmd_svcfail },
2182 { "svcinfo", "JOBID TOKENS...", 1, 0xffff, acmd_svcinfo },
2183 { "svclist", 0, 0, 0, acmd_svclist },
2184 { "svcok", "JOBID", 1, 1, acmd_svcok },
2185 { "svcquery", "SERVICE", 1, 1, acmd_svcquery },
2186 { "svcrelease", "SERVICE", 1, 1, acmd_svcrelease },
2187 { "svcsubmit", "[OPTIONS] SERVICE TOKENS...",
2188 2, 0xffff, acmd_svcsubmit },
2190 { "trace", "[OPTIONS]", 0, 1, acmd_trace },
2192 { "tunnels", 0, 0, 0, acmd_tunnels },
2193 { "version", 0, 0, 0, acmd_version },
2194 { "warn", "MESSAGE ...", 1, 0xffff, acmd_warn },
2195 { "watch", "[OPTIONS]", 0, 1, acmd_watch },
2199 static void acmd_help(admin *a, unsigned ac, char *av[])
2203 for (c = acmdtab; c->name; c++) {
2205 a_info(a, "%s", c->name, "*%s", c->help, A_END);
2207 a_info(a, "%s", c->name, A_END);
2212 /*----- Connection handling -----------------------------------------------*/
2214 /* --- @a_destroypending@ --- *
2220 * Use: Destroys pending admin connections at a safe time.
2223 static void a_destroypending(void)
2225 admin *a, *aa, *head;
2226 admin_bgop *bg, *bbg;
2227 admin_service *svc, *ssvc;
2229 /* --- Destroy connections marked as pending --- *
2231 * Slightly messy. Killing clients may cause others to finally die. Make
2232 * sure that they can be put on the list without clobbering anything or
2239 for (a = head; a; a = aa) {
2241 assert(a->f & AF_DEAD);
2243 /* --- Report what we're doing --- */
2245 T( trace(T_ADMIN, "admin: completing destruction of connection %u",
2248 /* --- If this is the foreground client then shut down --- */
2250 if (a->f & AF_FOREGROUND) {
2251 T( trace(T_ADMIN, "admin: foreground client quit: shutting down"); )
2252 a_warn("SERVER", "quit", "foreground-eof", A_END);
2256 /* --- Abort any background jobs in progress --- */
2258 for (bg = a->bg; bg; bg = bbg) {
2261 if (bg->tag) xfree(bg->tag);
2265 /* --- Release services I hold, and abort pending jobs --- */
2267 for (svc = a->svcs; svc; svc = ssvc) {
2271 a_jobtablefinal(&a->j);
2273 /* --- Close file descriptors and selectory --- */
2275 selbuf_destroy(&a->b);
2276 if (a->b.reader.fd != a->w.fd) close(a->b.reader.fd);
2278 if (a_stdin == a) a_stdin = 0;
2287 /* --- @a_destroy@ --- *
2289 * Arguments: @admin *a@ = pointer to an admin block
2293 * Use: Destroys an admin block. This requires a certain amount of
2297 static void freequeue(oqueue *q)
2301 for (o = q->hd; o; o = oo) {
2308 static void a_destroy(admin *a)
2313 if (a->next) a->next->prev = a->prev;
2314 if (a->prev) a->prev->next = a->next;
2315 else admins = a->next;
2317 if (a->out.hd) sel_rmfile(&a->w);
2324 T( trace(T_ADMIN, "admin: killing connection %u", a->seq); )
2327 /* --- @a_line@ --- *
2329 * Arguments: @char *p@ = pointer to the line read
2330 * @size_t len@ = length of the line
2331 * @void *vp@ = pointer to my admin block
2335 * Use: Handles a line of input.
2338 static void a_line(char *p, size_t len, void *vp)
2353 selbuf_disable(&a->b);
2357 ac = str_qsplit(p, av, N(av) - 1, 0, STRF_QUOTE);
2361 for (c = acmdtab; c->name; c++) {
2362 if (mystrieq(av[0], c->name)) {
2364 if (c->argmin > ac || ac > c->argmax) {
2366 a_fail(a, "bad-syntax", "%s", c->name, "", A_END);
2368 a_fail(a, "bad-syntax", "%s", c->name, "%s", c->help, A_END);
2370 c->func(a, ac, av + 1);
2374 a_fail(a, "unknown-command", "%s", av[0], A_END);
2377 /* --- @a_create@ --- *
2379 * Arguments: @int fd_in, fd_out@ = file descriptors to use
2380 * @unsigned f@ = initial flags to set
2384 * Use: Creates a new admin connection. It's safe to call this
2385 * before @a_init@ -- and, indeed, this makes sense if you also
2386 * call @a_switcherr@ to report initialization errors through
2387 * the administration machinery.
2390 void a_create(int fd_in, int fd_out, unsigned f)
2392 admin *a = CREATE(admin);
2394 T( static unsigned seq = 0;
2396 T( trace(T_ADMIN, "admin: accepted connection %u", a->seq); )
2400 a_jobtableinit(&a->j);
2402 if (fd_in == STDIN_FILENO) a_stdin = a;
2403 fdflags(fd_in, O_NONBLOCK, O_NONBLOCK, FD_CLOEXEC, FD_CLOEXEC);
2404 if (fd_out != fd_in)
2405 fdflags(fd_out, O_NONBLOCK, O_NONBLOCK, FD_CLOEXEC, FD_CLOEXEC);
2406 selbuf_init(&a->b, &sel, fd_in, a_line, a);
2407 sel_initfile(&sel, &a->w, fd_out, SEL_WRITE, a_flush, a);
2408 a->out.hd = a->out.tl = 0;
2411 if (admins) admins->prev = a;
2415 /* --- @a_accept@ --- *
2417 * Arguments: @int fd@ = file descriptor to accept
2418 * @unsigned mode@ = what to do
2419 * @void *v@ = uninteresting pointer
2423 * Use: Accepts a new admin connection.
2426 static void a_accept(int fd, unsigned mode, void *v)
2429 struct sockaddr_un sun;
2430 socklen_t sz = sizeof(sun);
2432 if ((nfd = accept(fd, (struct sockaddr *)&sun, &sz)) < 0) {
2433 if (errno != EINTR && errno != EAGAIN && errno != EWOULDBLOCK &&
2434 errno != ECONNABORTED && errno != EPROTO)
2435 a_warn("ADMIN", "accept-error", "?ERRNO", A_END);
2438 a_create(nfd, nfd, 0);
2441 /* --- @a_preselect@ --- *
2447 * Use: Informs the admin module that we're about to select again,
2448 * and that it should do cleanup things it has delayed until a
2452 void a_preselect(void) { if (a_dead) a_destroypending(); }
2454 /* --- @a_daemon@ --- *
2460 * Use: Informs the admin module that it's a daemon.
2463 void a_daemon(void) { flags |= F_DAEMON; }
2465 /* --- @a_listen@ --- *
2467 * Arguments: @const char *name@ = socket name to create
2468 * @uid_t u@ = user to own the socket
2469 * @gid_t g@ = group to own the socket
2470 * @mode_t m@ = permissions to set on the socket
2472 * Returns: Zero on success, @-1@ on failure.
2474 * Use: Creates the admin listening socket.
2477 int a_listen(const char *name, uid_t u, gid_t g, mode_t m)
2481 struct sockaddr_un sun;
2485 /* --- Set up the socket address --- */
2487 sz = strlen(name) + 1;
2488 if (sz > sizeof(sun.sun_path)) {
2489 a_warn("ADMIN", "admin-socket", "%s", name, "name-too-long", A_END);
2493 sun.sun_family = AF_UNIX;
2494 memcpy(sun.sun_path, name, sz);
2495 sz += offsetof(struct sockaddr_un, sun_path);
2497 /* --- Attempt to bind to the socket --- */
2499 omask = umask(0077);
2501 if ((fd = socket(PF_UNIX, SOCK_STREAM, 0)) < 0) {
2502 a_warn("ADMIN", "admin-socket", "%s", sun.sun_path,
2503 "create-failed", "?ERRNO", A_END);
2506 if (bind(fd, (struct sockaddr *)&sun, sz) < 0) {
2509 if (errno != EADDRINUSE) {
2510 a_warn("ADMIN", "admin-socket", "%s", sun.sun_path,
2511 "bind-failed", "?ERRNO", A_END);
2515 a_warn("ADMIN", "admin-socket", "%s", sun.sun_path,
2516 "too-many-retries", A_END);
2520 if (!connect(fd, (struct sockaddr *)&sun, sz)) {
2521 a_warn("ADMIN", "admin-socket", "%s", sun.sun_path,
2522 "already-in-use", A_END);
2525 if (errno != ECONNREFUSED) {
2526 a_warn("ADMIN", "admin-socket", "%s", sun.sun_path,
2527 "bind-failed", "?ERR", e, A_END);
2530 if (stat(sun.sun_path, &st)) {
2531 if (errno == ENOENT) { close(fd); goto again; }
2532 a_warn("ADMIN", "admin-socket", "%s", sun.sun_path,
2533 "stat-failed", "?ERRNO", A_END);
2536 if (!S_ISSOCK(st.st_mode)) {
2537 a_warn("ADMIN", "admin-socket", "%s", sun.sun_path,
2538 "not-a-socket", A_END);
2541 T( trace(T_ADMIN, "admin: stale socket found; removing it"); )
2542 unlink(sun.sun_path);
2546 if (chown(sun.sun_path, u, g)) {
2547 a_warn("ADMIN", "admin-socket", "%s", sun.sun_path,
2548 "chown-failed", "?ERRNO", A_END);
2551 if (chmod(sun.sun_path, m)) {
2552 a_warn("ADMIN", "admin-socket", "%s", sun.sun_path,
2553 "chmod-failed", "?ERRNO", A_END);
2556 fdflags(fd, O_NONBLOCK, O_NONBLOCK, FD_CLOEXEC, FD_CLOEXEC);
2557 if (listen(fd, 5)) {
2558 a_warn("ADMIN", "admin-socket", "%s", sun.sun_path,
2559 "listen-failed", "?ERRNO", A_END);
2564 /* --- Listen to the socket --- */
2566 sel_initfile(&sel, &sock, fd, SEL_READ, a_accept, 0);
2572 /* --- Clean up if things go sideways --- */
2575 unlink(sun.sun_path);
2584 /* --- @a_unlisten@ --- *
2590 * Use: Stops listening to the administration socket and removes it.
2593 void a_unlisten(void)
2595 if (!sockname) return;
2601 /* --- @a_switcherr@ --- *
2607 * Use: Arrange to report warnings, trace messages, etc. to
2608 * administration clients rather than the standard-error stream.
2610 * Obviously this makes no sense unless there is at least one
2611 * client established. Calling @a_listen@ won't help with this,
2612 * because the earliest a new client can connect is during the
2613 * first select-loop iteration, which is too late: some initial
2614 * client must have been added manually using @a_create@.
2617 void a_switcherr(void)
2619 T( trace_custom(a_trace, 0);
2620 trace(T_ADMIN, "admin: enabled custom tracing"); )
2624 /* --- @a_signals@ --- *
2630 * Use: Establishes handlers for the obvious signals.
2633 void a_signals(void)
2635 struct sigaction sa;
2637 sig_add(&s_term, SIGTERM, a_sigdie, 0);
2638 sig_add(&s_hup, SIGHUP, a_sighup, 0);
2639 sigaction(SIGINT, 0, &sa);
2640 if (sa.sa_handler != SIG_IGN)
2641 sig_add(&s_int, SIGINT, a_sigdie, 0);
2644 /* --- @a_init@ --- *
2648 * Returns: Zero on success, @-1@ on failure.
2650 * Use: Creates the admin listening socket.
2659 /* --- Prepare the background name resolver --- */
2662 if ((err = adns_init(&ads,
2663 (adns_if_permit_ipv4 | adns_if_permit_ipv6 |
2664 adns_if_noserverwarn | adns_if_nosigpipe |
2667 a_warn("ADMIN", "adns-init-failed", "?ERRNO", A_END);
2670 sel_addhook(&sel, &hook, before_select, after_select, 0);
2675 /* --- Create services table --- */
2677 sym_create(&a_svcs);
2679 /* --- All done --- */
2684 /*----- That's all, folks -------------------------------------------------*/