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_quit@ --- *
562 * Use: Shuts things down nicely.
568 if (sockname) unlink(sockname);
569 FOREACH_PEER(p, { p_destroy(p, 1); });
574 /* --- @a_sigdie@ --- *
576 * Arguments: @int sig@ = signal number
577 * @void *v@ = an uninteresting argument
581 * Use Shuts down on receipt of a fatal signal.
584 static void a_sigdie(int sig, void *v)
590 case SIGTERM: p = "SIGTERM"; break;
591 case SIGINT: p = "SIGINT"; break;
593 sprintf(buf, "%i", sig);
597 a_warn("SERVER", "quit", "signal", "%s", p, A_END);
601 /* --- @a_sighup@ --- *
603 * Arguments: @int sig@ = signal number
604 * @void *v@ = an uninteresting argument
608 * Use Logs a message about SIGHUP not being useful.
611 static void a_sighup(int sig, void *v)
612 { a_warn("SERVER", "ignore", "signal", "SIGHUP", A_END); }
614 /* --- @a_parsetime@ --- *
616 * Arguments; @const char *p@ = time string to parse
618 * Returns: Time in seconds, or @< 0@ on error.
621 static long a_parsetime(const char *p)
624 long t = strtol(p, &q, 0);
630 case 's': if (q[1] != 0)
637 /* --- @a_findpeer@ --- *
639 * Arguments: @admin *a@ = admin connection
640 * @const char *pn@ = peer name
642 * Returns: The peer, or null if not there.
644 * Use: Finds a peer, reporting an error if it failed.
647 static peer *a_findpeer(admin *a, const char *pn)
651 if ((p = p_find(pn)) == 0)
652 a_fail(a, "unknown-peer", "%s", pn, A_END);
656 /*----- Backgrounded operations -------------------------------------------*/
659 (((admin_bgop *)(bg))->tag ? ((admin_bgop *)(bg))->tag : "<foreground>")
661 /* --- @a_bgfind@ --- *
663 * Arguments: @admin *a@ = a client block
664 * @const char *tag@ = the requested tag
666 * Returns: The requested background job, or null.
669 static admin_bgop *a_bgfind(admin *a, const char *tag)
673 for (bg = a->bg; bg; bg = bg->next) {
674 if (bg->tag && strcmp(tag, bg->tag) == 0)
680 /* --- @a_bgrelease@ --- *
682 * Arguments: @admin_bgop *bg@ = backgrounded operation
686 * Use: Removes a backgrounded operation from the queue, since
687 * (presumably) it's done.
690 static void a_bgrelease(admin_bgop *bg)
694 T( trace(T_ADMIN, "admin: release bgop %s", BGTAG(bg)); )
695 if (bg->tag) xfree(bg->tag);
696 else selbuf_enable(&a->b);
697 if (bg->next) bg->next->prev = bg->prev;
698 if (bg->prev) bg->prev->next = bg->next;
699 else a->bg = bg->next;
701 if (!a->bg && (a->f & AF_CLOSE)) a_destroy(a);
704 /* --- @a_bgok@, @a_bginfo@, @a_bgfail@ --- *
706 * Arguments: @admin_bgop *bg@ = backgrounded operation
707 * @const char *fmt@ = format string
708 * @...@ = other arguments
712 * Use: Convenience functions for @a_write@.
715 static void a_bgok(admin_bgop *bg)
716 { a_write(bg->a, "OK", bg->tag, A_END); }
718 static void a_bginfo(admin_bgop *bg, const char *fmt, ...)
722 a_vwrite(bg->a, "INFO", bg->tag, fmt, &ap);
726 static void a_bgfail(admin_bgop *bg, const char *fmt, ...)
730 a_vwrite(bg->a, "FAIL", bg->tag, fmt, &ap);
734 /* --- @a_bgadd@ --- *
736 * Arguments: @admin *a@ = administration connection
737 * @admin_bgop *bg@ = pointer to background operation
738 * @const char *tag@ = background tag, or null for foreground
739 * @void (*cancel)(admin_bgop *)@ = cancel function
741 * Returns: Zero for success, nonzero on failure.
743 * Use: Links a background job into the list.
746 static int a_bgadd(admin *a, admin_bgop *bg, const char *tag,
747 void (*cancel)(admin_bgop *))
750 if (a_bgfind(a, tag)) {
751 a_fail(a, "tag-exists", "%s", tag, A_END);
754 bg->tag = xstrdup(tag);
758 selbuf_disable(&a->b);
764 if (a->bg) a->bg->prev = bg;
766 T( trace(T_ADMIN, "admin: add bgop %s", BGTAG(bg)); )
767 if (tag) a_write(a, "DETACH", tag, A_END);
771 /*----- Job table manipulation --------------------------------------------*/
774 #define JOB_INDEXMASK ((1ul << JOB_SHIFT) - 1)
775 #define JOB_SEQMASK ((1ul << (32 - JOB_SHIFT)) - 1)
777 #define JOB_END 0xfffffffful
779 static unsigned long a_joboffset;
781 /* --- @a_jobidencode@ --- *
783 * Arguments: @admin_svcop *svc@ = pointer to a service operation
785 * Returns: A jobid for this job, in an internal static buffer.
787 * Use: Constructs a jobid. In order to dissuade people from
788 * predicting jobids, we obfuscate them.
790 * A `raw' jobid consists of two 16-bit fields. The low 16 bits
791 * are an index into a big array. The high 16 bits are a
792 * sequence number recording how many times that slot has been
795 * This `raw' jobid is then obfuscated by adding a randomly-
796 * generated offset, and multiplying (mod %$2^{32}$%) by a fixed
800 static const char *a_jobidencode(admin_svcop *svc)
802 admin_jobtable *j = &svc->prov->j;
807 assert(svc->index <= JOB_INDEXMASK);
808 seq = j->v[svc->index].seq;
809 assert(seq <= JOB_SEQMASK);
810 pre = (unsigned long)svc->index | ((unsigned long)seq << JOB_SHIFT);
811 sprintf(buf, "J%08lx", ((pre + a_joboffset) * 0x0f87a7a3ul) & 0xffffffff);
815 /* --- @a_jobiddecode@ --- *
817 * Arguments: @admin_jobtable *j@ = pointer to a job table
818 * @const char *jid@ = pointer to a jobid string
820 * Returns: A pointer to the job's @svcop@ structure.
823 static admin_svcop *a_jobiddecode(admin_jobtable *j, const char *jid)
830 for (i = 1; i < 9; i++) {
831 if (!isxdigit((unsigned char)jid[i]))
836 pre = strtoul(jid + 1, 0, 16);
837 pre = ((pre * 0xbd11c40bul) - a_joboffset) & 0xffffffff;
838 i = pre & JOB_INDEXMASK;
839 if (i >= j->n || j->v[i].seq != (pre >> JOB_SHIFT))
841 return (j->v[i].u.op);
844 /* --- @a_jobcreate@ --- *
846 * Arguments: @admin *a@ = pointer to administration client
848 * Returns: A pointer to a freshly-allocated @svcop@, or null.
850 * Use: Allocates a fresh @svcop@ and links it into a job table.
853 static admin_svcop *a_jobcreate(admin *a)
858 admin_jobtable *j = &a->j;
860 if (j->free != JOB_END) {
862 j->free = j->v[i].u.next;
865 if (j->sz > JOB_INDEXMASK)
870 j->v = xmalloc(j->sz * sizeof(*j->v));
873 j->v = xrealloc(j->v, j->sz * sizeof(*j->v), sz * sizeof(*j->v));
879 svc = xmalloc(sizeof(*svc));
882 svc->next = j->active;
884 if (j->active) j->active->prev = svc;
887 IF_TRACING(T_ADMIN, {
888 trace(T_ADMIN, "admin: created job %s (%u)", a_jobidencode(svc), i);
893 /* --- @a_jobdestroy@ --- *
895 * Arguments: @admin_svcop *svc@ = pointer to job block
899 * Use: Frees up a completed (or cancelled) job.
902 static void a_jobdestroy(admin_svcop *svc)
904 admin *a = svc->prov;
905 admin_jobtable *j = &a->j;
906 unsigned i = svc->index;
908 IF_TRACING(T_ADMIN, {
909 trace(T_ADMIN, "admin: destroying job %s (%u)", a_jobidencode(svc), i);
911 assert(j->v[i].u.op = svc);
912 j->v[i].u.next = j->free;
915 if (svc->next) svc->next->prev = svc->prev;
916 if (svc->prev) svc->prev->next = svc->next;
917 else j->active = svc->next;
920 /* --- @a_jobtableinit@ --- *
922 * Arguments: @admin_jobtable *j@ = pointer to job table
926 * Use: Initializes a job table.
929 static void a_jobtableinit(admin_jobtable *j)
932 a_joboffset = GR_RANGE(&rand_global, 0xffffffff) + 1;
939 /* --- @a_jobtablefinal@ --- *
941 * Arguments: @admin_jobtable *j@ = pointer to job table
945 * Use: Closes down a job table.
948 static void a_jobtablefinal(admin_jobtable *j)
950 admin_svcop *svc, *ssvc;
952 for (svc = j->active; svc; svc = ssvc) {
954 a_bgfail(&svc->bg, "provider-failed", A_END);
955 a_bgrelease(&svc->bg);
957 if (j->v) xfree(j->v);
960 /*----- Services infrastructure -------------------------------------------*/
962 /* --- @a_svcfind@ --- *
964 * Arguments: @admin *a@ = the requesting client
965 * @const char *name@ = service name wanted
967 * Returns: The service requested, or null.
969 * Use: Finds a service; reports an error if the service couldn't be
973 static admin_service *a_svcfind(admin *a, const char *name)
977 if ((svc = sym_find(&a_svcs, name, -1, 0, 0)) == 0) {
978 a_fail(a, "unknown-service", "%s", name, A_END);
984 /* --- @a_svcunlink@ --- *
986 * Arguments: @admin_service *svc@ = pointer to service structure
990 * Use: Unlinks the service from its provider, without issuing a
991 * message or freeing the structure. The version string is
995 static void a_svcunlink(admin_service *svc)
998 svc->next->prev = svc->prev;
1000 svc->prev->next = svc->next;
1002 svc->prov->svcs = svc->next;
1003 xfree(svc->version);
1006 /* --- @a_svcrelease@ --- *
1008 * Arguments: @admin_service *svc@ = pointer to service structure
1012 * Use: Releases a service and frees its structure.
1015 static void a_svcrelease(admin_service *svc)
1017 a_notify("SVCRELEASE", "%s", SYM_NAME(svc), A_END);
1019 sym_remove(&a_svcs, svc);
1022 /*----- Name resolution operations ----------------------------------------*/
1026 /* --- @before_select@ --- *
1028 * Arguments: @sel_state *s@ = the @sel@ multiplexor (unused)
1029 * @sel_args *a@ = input to @select@, to be updated
1030 * @void *p@ = a context pointer (unused)
1034 * Use: An I/O multiplexor hook, called just before waiting for I/O
1037 * Currently its main purpose is to wire ADNS into the event
1041 static void before_select(sel_state *s, sel_args *a, void *p)
1049 /* --- Check for name-resolution progress --- *
1051 * If there is any, then clobber the timeout: one of the resolver
1052 * callbacks might have renewed its interest in a file descriptor, but too
1053 * late to affect this @select@ call.
1055 * I think, strictly, this is an mLib bug, but it's cheap enough to hack
1056 * around here. Fixing it will wait for mLib 3.
1061 if (adns_check(ads, &q, &n, &p)) break;
1064 if (n->status != adns_s_ok) {
1065 T( trace(T_ADMIN, "admin: resop %s failed: %s",
1066 BGTAG(r), adns_strerror(n->status)); )
1067 a_bgfail(&r->bg, "resolve-error", "%s", r->addr, A_END);
1068 r->func(r, ARES_FAIL);
1070 T( trace(T_ADMIN, "admin: resop %s ok", BGTAG(r)); )
1071 assert(n->type == adns_r_addr);
1072 assert(n->nrrs > 0);
1073 assert(n->rrs.addr[0].len <= sizeof(r->sa));
1074 memcpy(&r->sa, &n->rrs.addr[0].addr, n->rrs.addr[0].len);
1075 setport(&r->sa, r->port);
1076 r->func(r, ARES_OK);
1081 a_bgrelease(&r->bg);
1084 if (any) { a->tvp = &a->tv; a->tv.tv_sec = 0; a->tv.tv_usec = 0; }
1086 gettimeofday(&now, 0);
1087 adns_beforeselect(ads, &a->maxfd,
1088 &a->fd[SEL_READ], &a->fd[SEL_WRITE], &a->fd[SEL_EXC],
1089 &a->tvp, &a->tv, &now);
1092 /* --- @after_select@ --- *
1094 * Arguments: @sel_state *s@ = the @sel@ multiplexor (unused)
1095 * @sel_args *a@ = input to @select@, to be updated
1096 * @void *p@ = a context pointer (unused)
1100 * Use: An I/O multiplexor hook, called just after waiting for I/O
1103 * Currently its main purpose is to wire ADNS into the event
1107 static void after_select(sel_state *s, sel_args *a, void *p)
1111 gettimeofday(&now, 0);
1112 adns_afterselect(ads, a->maxfd,
1113 &a->fd[SEL_READ], &a->fd[SEL_WRITE], &a->fd[SEL_EXC],
1119 /* --- @a_resolved@ --- *
1121 * Arguments: @struct hostent *h@ = pointer to resolved hostname
1122 * @void *v@ = pointer to resolver operation
1126 * Use: Handles a completed name resolution.
1129 static void a_resolved(struct hostent *h, void *v)
1135 T( trace(T_ADMIN, "admin: resop %s failed: %s",
1136 BGTAG(r), hstrerror(h_errno)); )
1137 a_bgfail(&r->bg, "resolve-error", "%s", r->addr, A_END);
1138 r->func(r, ARES_FAIL);
1140 T( trace(T_ADMIN, "admin: resop %s ok", BGTAG(r)); )
1141 r->sa.sin.sin_family = AF_INET;
1142 memcpy(&r->sa.sin.sin_addr, h->h_addr, sizeof(struct in_addr));
1143 setport(&r->sa, r->port);
1144 r->func(r, ARES_OK);
1148 a_bgrelease(&r->bg);
1153 /* --- @a_restimer@ --- *
1155 * Arguments: @struct timeval *tv@ = timer
1156 * @void *v@ = pointer to resolver operation
1160 * Use: Times out a resolver.
1163 static void a_restimer(struct timeval *tv, void *v)
1167 T( trace(T_ADMIN, "admin: resop %s timeout", BGTAG(r)); )
1168 a_bgfail(&r->bg, "resolver-timeout", "%s", r->addr, A_END);
1169 r->func(r, ARES_FAIL);
1176 a_bgrelease(&r->bg);
1179 /* --- @a_rescancel@ --- *
1181 * Arguments: @admin_bgop *bg@ = background operation
1185 * Use: Cancels an add operation.
1188 static void a_rescancel(admin_bgop *bg)
1190 admin_resop *r = (admin_resop *)bg;
1192 T( trace(T_ADMIN, "admin: cancel resop %s", BGTAG(r)); )
1193 r->func(r, ARES_FAIL);
1203 /* --- @a_resolve@ --- *
1205 * Arguments: @admin *a@ = administration connection
1206 * @admin_resop *r@ = resolver operation to run
1207 * @const char *tag@ = background operation tag
1208 * @void (*func)(struct admin_resop *, int@ = handler function
1209 * @unsigned ac@ = number of remaining arguments
1210 * @char *av[]@ = pointer to remaining arguments
1214 * Use: Cranks up a resolver job.
1217 static void a_resolve(admin *a, admin_resop *r, const char *tag,
1218 void (*func)(struct admin_resop *, int),
1219 unsigned ac, char *av[])
1224 const char *fam = "ANY";
1227 struct addrinfo *ai, *ailist, aihint = { 0 };
1233 /* --- Fill in the easy bits of address --- */
1235 r->bg.tag = "<starting>";
1238 if (mystrieq(av[i], "any"))
1239 { fam = "ANY"; af = AF_UNSPEC; i++; }
1240 else for (j = 0; j < NADDRFAM; j++) {
1241 if (mystrieq(av[i], aftab[j].name)) {
1242 if (udpsock[j].sf.fd < 0) {
1243 a_fail(a, "disabled-address-family", "%s", aftab[j].name, A_END);
1246 fam = aftab[j].name;
1252 if (ac - i != 1 && ac - i != 2) {
1253 a_fail(a, "bad-addr-syntax", "[FAMILY] ADDRESS [PORT]", A_END);
1256 r->addr = xstrdup(av[i]);
1260 pt = strtoul(av[i + 1], &p, 0);
1262 struct servent *s = getservbyname(av[i + 1], "udp");
1264 a_fail(a, "unknown-service", "%s", av[i + 1], A_END);
1267 pt = ntohs(s->s_port);
1270 if (pt == 0 || pt >= 65536) {
1271 a_fail(a, "invalid-port", "%lu", pt, A_END);
1276 /* --- Report backgrounding --- *
1278 * Do this for consistency of interface, even if we're going to get the
1279 * answer straight away.
1282 if (a_bgadd(a, &r->bg, tag, a_rescancel))
1284 T( trace(T_ADMIN, "admin: %u, resop %s, hostname `%s', family `%s'",
1285 a->seq, BGTAG(r), r->addr, fam); )
1287 /* --- If the name is numeric, do it the easy way --- */
1289 aihint.ai_family = af;
1290 aihint.ai_socktype = SOCK_DGRAM;
1291 aihint.ai_protocol = IPPROTO_UDP;
1292 aihint.ai_flags = AI_NUMERICHOST;
1293 if (!getaddrinfo(av[i], 0, &aihint, &ailist)) {
1294 for (ai = ailist; ai; ai = ai->ai_next) {
1295 if ((j = afix(ai->ai_family)) >= 0 && udpsock[j].sf.fd >= 0)
1299 T( trace(T_ADMIN, "admin: resop %s failed: "
1300 "no suitable addresses returned", BGTAG(r)); )
1301 a_bgfail(&r->bg, "resolve-error", "%s" , r->addr, A_END);
1304 T( trace(T_ADMIN, "admin: resop %s done the easy way", BGTAG(r)); )
1305 assert(ai->ai_addrlen <= sizeof(r->sa));
1306 memcpy(&r->sa, ai->ai_addr, ai->ai_addrlen);
1307 setport(&r->sa, r->port);
1310 freeaddrinfo(ailist);
1312 a_bgrelease(&r->bg);
1316 /* --- Store everything for later and crank up the resolver --- */
1318 gettimeofday(&tv, 0);
1319 tv.tv_sec += T_RESOLVE;
1320 sel_addtimer(&sel, &r->t, &tv, a_restimer, r);
1322 qf = adns_qf_search;
1323 for (j = 0; j < NADDRFAM; j++) {
1324 if ((af == AF_UNSPEC || af == aftab[i].af) && udpsock[j].sf.fd >= 0)
1327 if ((err = adns_submit(ads, r->addr, adns_r_addr, qf, r, &r->q)) != 0) {
1328 T( trace(T_ADMIN, "admin: resop %s adns_submit failed: %s",
1329 BGTAG(r), strerror(err)); )
1330 a_bgfail(&r->bg, "resolve-error", "%s", r->addr, A_END);
1334 if (af != AF_UNSPEC && af != AF_INET) {
1335 T( trace(T_ADMIN, "admin: resop %s failed: unsupported address family",
1337 a_bgfail(&r->bg, "resolve-error", "%s", r->addr, A_END);
1340 if (udpsock[AFIX_INET].sf.fd < 0) {
1341 a_bgfail(&r->bg, "disabled-address-family", "INET", A_END);
1344 bres_byname(&r->r, r->addr, a_resolved, r);
1350 if (r->addr) xfree(r->addr);
1357 a_bgrelease(&r->bg);
1360 /*----- Option parsing ----------------------------------------------------*/
1362 #define OPTIONS(argc, argv, guts) do { \
1363 char **o_av = argv; \
1367 if (mystrieq(*o_av, "--")) { \
1372 if (**o_av == '-') \
1376 argc -= o_av - argv; \
1380 #define OPT(name, guts) if (mystrieq(*o_av, name)) { guts continue; }
1382 #define OPTARG(name, arg, guts) OPT(name, { \
1385 if (!arg) goto bad_syntax; \
1389 #define OPTTIME(name, arg, guts) OPTARG(name, o_arg, { \
1391 if ((arg = a_parsetime(o_arg)) < 0) { \
1392 a_fail(a, "bad-time-spec", "%s", o_arg, A_END); \
1398 /*----- Adding peers ------------------------------------------------------*/
1400 /* --- @a_doadd@ --- *
1402 * Arguments: @admin_resop *r@ = resolver operation
1403 * @int rc@ = how it worked
1407 * Use: Handles a completed resolution.
1410 static void a_doadd(admin_resop *r, int rc)
1412 admin_addop *add = (admin_addop *)r;
1414 T( trace(T_ADMIN, "admin: done add op %s", BGTAG(add)); )
1416 if (rc == ARES_OK) {
1417 add->peer.sa = add->r.sa;
1418 if (p_findbyaddr(&add->r.sa))
1419 a_bgfail(&add->r.bg, "peer-addr-exists", "?ADDR", &add->r.sa, A_END);
1420 else if (p_find(add->peer.name))
1421 a_bgfail(&add->r.bg, "peer-exists", "%s", add->peer.name, A_END);
1422 else if (!p_create(&add->peer))
1423 a_bgfail(&add->r.bg, "peer-create-fail", "%s", add->peer.name, A_END);
1428 if (add->peer.tag) xfree(add->peer.tag);
1429 if (add->peer.privtag) xfree(add->peer.privtag);
1430 if (add->peer.knock) xfree(add->peer.knock);
1431 xfree(add->peer.name);
1434 /* --- @acmd_add@ --- *
1436 * Arguments: @admin *a@ = connection which requested the addition
1437 * @unsigned ac@ = argument count
1438 * @char *av[]@ = pointer to the argument list
1442 * Use: Adds a new peer.
1445 static void acmd_add(admin *a, unsigned ac, char *av[])
1447 const char *tag = 0;
1450 /* --- Set stuff up --- */
1452 add = xmalloc(sizeof(*add));
1455 add->peer.privtag = 0;
1456 add->peer.knock = 0;
1458 add->peer.tops = tun_default;
1461 /* --- Parse options --- */
1464 OPTARG("-background", arg, { tag = arg; })
1465 OPTARG("-tunnel", arg, {
1469 a_fail(a, "unknown-tunnel", "%s", arg, A_END);
1472 if (mystrieq(arg, tunnels[i]->name)) {
1473 add->peer.tops = tunnels[i];
1478 OPTTIME("-keepalive", t, { add->peer.t_ka = t; })
1479 OPT("-cork", { add->peer.f |= KXF_CORK; })
1480 OPT("-ephemeral", { add->peer.f |= PSF_EPHEM; })
1481 OPTARG("-key", arg, {
1482 if (add->peer.tag) xfree(add->peer.tag);
1483 add->peer.tag = xstrdup(arg);
1485 OPT("-mobile", { add->peer.f |= PSF_MOBILE | PSF_EPHEM; })
1486 OPTARG("-priv", arg, {
1487 if (add->peer.privtag) xfree(add->peer.privtag);
1488 add->peer.privtag = xstrdup(arg);
1490 OPTARG("-knock", arg, {
1491 if (add->peer.knock) xfree(add->peer.knock);
1492 add->peer.knock = xstrdup(arg);
1493 add->peer.f |= PSF_EPHEM;
1497 /* --- Make sure someone's not got there already --- */
1499 if (!av[0] || !av[1])
1502 a_fail(a, "peer-exists", "%s", *av, A_END);
1505 add->peer.name = xstrdup(*av++);
1508 /* --- Crank up the resolver --- */
1510 a_resolve(a, &add->r, tag, a_doadd, ac, av);
1513 /* --- Clearing up --- */
1516 a_fail(a, "bad-syntax", "add", "[OPTIONS] PEER ADDR ...", A_END);
1518 if (add->peer.name) xfree(add->peer.name);
1519 if (add->peer.tag) xfree(add->peer.tag);
1520 if (add->peer.privtag) xfree(add->peer.privtag);
1521 if (add->peer.knock) xfree(add->peer.knock);
1526 /*----- Ping --------------------------------------------------------------*/
1528 /* --- @a_pingcancel@ --- *
1530 * Arguments: @admin_bgop *bg@ = background operation block
1534 * Use: Cancels a running ping.
1537 static void a_pingcancel(admin_bgop *bg)
1539 admin_pingop *pg = (admin_pingop *)bg;
1540 T( trace(T_ADMIN, "admin: cancel ping op %s", BGTAG(pg)); )
1541 p_pingdone(&pg->ping, PING_NONOTIFY);
1544 /* --- @a_pong@ --- *
1546 * Arguments: @int rc@ = return code
1547 * @void *v@ = ping operation block
1551 * Use: Collects what happened to a ping message.
1554 static void a_pong(int rc, void *v)
1556 admin_pingop *pg = v;
1562 gettimeofday(&tv, 0);
1563 tv_sub(&tv, &tv, &pg->pingtime);
1564 millis = (double)tv.tv_sec * 1000 + (double)tv.tv_usec/1000;
1565 a_bginfo(&pg->bg, "ping-ok", "%.1f", millis, A_END);
1569 a_bginfo(&pg->bg, "ping-timeout", A_END);
1573 a_bginfo(&pg->bg, "ping-peer-died", A_END);
1579 T( trace(T_ADMIN, "admin: ponged ping op %s", BGTAG(pg)); )
1580 a_bgrelease(&pg->bg);
1583 /* --- @acmd_ping@, @acmd_eping@ --- *
1585 * Arguments: @admin *a@ = connection which requested the ping
1586 * @unsigned ac@ = argument count
1587 * @char *av[]@ = pointer to the argument list
1591 * Use: Pings a peer.
1594 static void a_ping(admin *a, unsigned ac, char *av[],
1595 const char *cmd, unsigned msg)
1599 admin_pingop *pg = 0;
1600 const char *tag = 0;
1603 OPTARG("-background", arg, { tag = arg; })
1604 OPTTIME("-timeout", arg, { t = arg; })
1606 if (!*av || av[1]) goto bad_syntax;
1607 if ((p = a_findpeer(a, *av)) == 0)
1609 pg = xmalloc(sizeof(*pg));
1610 gettimeofday(&pg->pingtime, 0);
1611 if (a_bgadd(a, &pg->bg, tag, a_pingcancel))
1613 T( trace(T_ADMIN, "admin: ping op %s: %s to %s",
1614 BGTAG(pg), cmd, p_name(p)); )
1615 if (p_pingsend(p, &pg->ping, msg, t, a_pong, pg)) {
1616 a_bgfail(&pg->bg, "ping-send-failed", A_END);
1617 a_bgrelease(&pg->bg);
1622 a_fail(a, "bad-syntax", "%s", cmd, "[OPTIONS] PEER", cmd, A_END);
1628 static void acmd_ping(admin *a, unsigned ac, char *av[])
1629 { a_ping(a, ac, av, "ping", MISC_PING); }
1630 static void acmd_eping(admin *a, unsigned ac, char *av[])
1631 { a_ping(a, ac, av, "eping", MISC_EPING); }
1633 /*----- Service commands --------------------------------------------------*/
1635 static void acmd_svcclaim(admin *a, unsigned ac, char *av[])
1640 svc = sym_find(&a_svcs, av[0], -1, sizeof(*svc), &f);
1642 if (versioncmp(av[1], svc->version) <= 0) {
1645 "%s", SYM_NAME(svc),
1650 a_write(svc->prov, "SVCCLAIM", 0, "%s", av[0], "%s", av[1], A_END);
1654 svc->version = xstrdup(av[1]);
1655 svc->next = a->svcs;
1657 if (a->svcs) a->svcs->prev = svc;
1659 a_notify("SVCCLAIM", "%s", SYM_NAME(svc), "%s", svc->version, A_END);
1663 static void acmd_svcrelease(admin *a, unsigned ac, char *av[])
1667 if ((svc = a_svcfind(a, av[0])) == 0)
1669 if (svc->prov != a) {
1670 a_fail(a, "not-service-provider", "%s", SYM_NAME(svc), A_END);
1677 static void acmd_svcensure(admin *a, unsigned ac, char *av[])
1681 if ((svc = a_svcfind(a, av[0])) == 0)
1683 if (av[1] && versioncmp(svc->version, av[1]) < 0) {
1684 a_fail(a, "service-too-old",
1685 "%s", SYM_NAME(svc),
1693 static void acmd_svcquery(admin *a, unsigned ac, char *av[])
1697 if ((svc = a_svcfind(a, av[0])) != 0) {
1698 a_info(a, "name=%s", SYM_NAME(svc), "version=%s", svc->version, A_END);
1703 static void acmd_svclist(admin *a, unsigned ac, char *av[])
1708 for (sym_mkiter(&i, &a_svcs); (svc = sym_next(&i)) != 0; )
1709 a_info(a, "%s", SYM_NAME(svc), "%s", svc->version, A_END);
1713 static void a_canceljob(admin_bgop *bg)
1715 admin_svcop *svc = (admin_svcop *)bg;
1717 a_write(svc->prov, "SVCCANCEL", 0, "%s", a_jobidencode(svc), A_END);
1721 static void acmd_svcsubmit(admin *a, unsigned ac, char *av[])
1723 const char *tag = 0;
1726 const char *ver = 0;
1730 OPTARG("-background", arg, { tag = arg; })
1731 OPTARG("-version", arg, { ver = arg; })
1733 if (!*av) goto bad_syntax;
1734 if ((svc = a_svcfind(a, *av)) == 0) goto fail;
1735 if (ver && versioncmp(svc->version, ver) < 0) {
1736 a_fail(a, "service-too-old",
1737 "%s", SYM_NAME(svc),
1742 if ((svcop = a_jobcreate(svc->prov)) == 0) {
1743 a_fail(a, "provider-overloaded", A_END);
1746 if (a_bgadd(a, &svcop->bg, tag, a_canceljob)) {
1747 a_jobdestroy(svcop);
1750 a_write(svc->prov, "SVCJOB", 0,
1751 "%s", a_jobidencode(svcop),
1757 a_fail(a, "bad-syntax", "svcsubmit", "[OPTIONS] SERVICE ARGS...", A_END);
1764 static void a_replycmd(admin *a, const char *status, int donep, char *av[])
1768 if ((svc = a_jobiddecode(&a->j, av[0])) == 0) {
1769 a_fail(a, "unknown-jobid", av[0], A_END);
1772 a_write(svc->bg.a, status, svc->bg.tag, "?TOKENS", av + 1, A_END);
1775 a_bgrelease(&svc->bg);
1780 static void acmd_svcok(admin *a, unsigned ac, char *av[])
1781 { a_replycmd(a, "OK", 1, av); }
1782 static void acmd_svcinfo(admin *a, unsigned ac, char *av[])
1783 { a_replycmd(a, "INFO", 0, av); }
1784 static void acmd_svcfail(admin *a, unsigned ac, char *av[])
1785 { a_replycmd(a, "FAIL", 1, av); }
1787 /*----- Administration commands -------------------------------------------*/
1789 /* --- Miscellaneous commands --- */
1791 /* --- @traceish@ --- *
1793 * Arguments: @admin *a@ = connection to complain on
1794 * @unsigned ac@ = number of arguments
1795 * @char *av[]@ = vector of arguments
1796 * @const char *what@ = what we're messing with
1797 * @const trace_opt *tt@ = options table
1798 * @unsigned *ff@ = where the flags are
1800 * Returns: Nonzero if anything changed.
1802 * Use: Guts of trace-ish commands like `trace' and `watch'.
1805 static int traceish(admin *a, unsigned ac, char *av[],
1806 const char *what, const trace_opt *tt, unsigned *ff)
1810 if (!ac || strcmp(av[0], "?") == 0) {
1812 for (t = tt; t->ch; t++) {
1813 a_info(a, "*%c%c %s",
1814 t->ch, (*ff & t->f) == t->f ? '+' : ' ', t->help, A_END);
1824 case '+': sense = 1; break;
1825 case '-': sense = 0; break;
1827 for (t = tt; t->ch; t++) {
1829 if (sense) f |= t->f;
1834 a_fail(a, "bad-%s-option", what, "%c", *p, A_END);
1850 static void acmd_trace(admin *a, unsigned ac, char *av[])
1852 if (traceish(a, ac, av, "trace", tr_opts, &tr_flags))
1853 trace_level(tr_flags);
1858 static void acmd_watch(admin *a, unsigned ac, char *av[])
1859 { traceish(a, ac, av, "watch", w_opts, &a->f); }
1861 static void alertcmd(admin *a, unsigned f_and, unsigned f_eq,
1862 const char *status, char *av[])
1863 { a_alert(f_and, f_eq, status, "USER", "?TOKENS", av, A_END); a_ok(a); }
1864 static void acmd_notify(admin *a, unsigned ac, char *av[])
1865 { alertcmd(a, AF_NOTE, AF_NOTE, "NOTE", av); }
1866 static void acmd_warn(admin *a, unsigned ac, char *av[])
1867 { alertcmd(a, AF_WARN, AF_WARN, "WARN", av); }
1869 static void acmd_port(admin *a, unsigned ac, char *av[])
1874 for (i = 0; i < NADDRFAM; i++)
1875 if (mystrieq(av[0], aftab[i].name)) goto found;
1876 a_fail(a, "unknown-address-family", "%s", av[0], A_END);
1879 if (udpsock[i].sf.fd < 0) {
1880 a_fail(a, "disabled-address-family", "%s", aftab[i].name, A_END);
1884 for (i = 0; i < NADDRFAM; i++)
1885 if (udpsock[i].sf.fd >= 0) goto found;
1888 a_info(a, "%u", udpsock[i].port, A_END);
1892 static void acmd_daemon(admin *a, unsigned ac, char *av[])
1894 if (flags & F_DAEMON)
1895 a_fail(a, "already-daemon", A_END);
1897 a_notify("DAEMON", A_END);
1901 a_fail(a, "daemon-error", "?ERRNO", A_END);
1909 static void acmd_jobs(admin *a, unsigned ac, char *av[])
1913 for (bg = a->bg; bg; bg = bg->next) {
1915 a_info(a, "%s", bg->tag, A_END);
1920 static void acmd_bgcancel(admin *a, unsigned ac, char *av[])
1924 if ((bg = a_bgfind(a, av[0])) == 0)
1925 a_fail(a, "unknown-tag", "%s", av[0], A_END);
1933 static void acmd_algs(admin *a, unsigned ac, char *av[])
1938 const algswitch *algs;
1943 if ((p = a_findpeer(a, av[0])) == 0) return;
1949 g->ops->grpinfo(g, a);
1951 "hash=%s", algs->h->name,
1952 "mgf=%s", algs->mgf->name,
1953 "hash-sz=%lu", (unsigned long)algs->h->hashsz,
1956 "bulk-transform=%s", algs->bulk->ops->name,
1957 "bulk-overhead=%lu",
1958 (unsigned long)algs->bulk->ops->overhead(algs->bulk),
1960 algs->bulk->ops->alginfo(algs->bulk, a);
1962 "cipher-data-limit=%lu",
1963 (unsigned long)algs->bulk->ops->expsz(algs->bulk),
1968 static void acmd_list(admin *a, unsigned ac, char *av[])
1970 FOREACH_PEER(p, { a_info(a, "%s", p_name(p), A_END); });
1974 static void acmd_ifname(admin *a, unsigned ac, char *av[])
1978 if ((p = a_findpeer(a, av[0])) != 0) {
1979 a_info(a, "%s", p_ifname(p), A_END);
1984 static void acmd_setifname(admin *a, unsigned ac, char *av[])
1988 if ((p = a_findpeer(a, av[0])) != 0) {
1989 a_notify("NEWIFNAME", "?PEER", p, "%s", p_ifname(p), "%s", av[1], A_END);
1990 p_setifname(p, av[1]);
1995 static void acmd_getchal(admin *a, unsigned ac, char *av[])
1999 buf_init(&b, buf_i, PKBUFSZ);
2001 a_info(a, "?B64", BBASE(&b), (size_t)BLEN(&b), A_END);
2005 static void acmd_checkchal(admin *a, unsigned ac, char *av[])
2007 codec *b64 = base64_class.decoder(CDCF_NOEQPAD);
2012 if ((err = b64->ops->code(b64, av[0], strlen(av[0]), &d)) != 0 ||
2013 (err = b64->ops->code(b64, 0, 0, &d)) != 0)
2014 a_fail(a, "bad-base64", "%s", codec_strerror(err), A_END);
2016 buf_init(&b, d.buf, d.len);
2017 if (c_check(0, 0, &b) || BBAD(&b) || BLEFT(&b))
2018 a_fail(a, "invalid-challenge", A_END);
2022 b64->ops->destroy(b64);
2026 static void acmd_greet(admin *a, unsigned ac, char *av[])
2033 if ((p = a_findpeer(a, av[0])) == 0) return;
2034 b64 = base64_class.decoder(CDCF_NOEQPAD);
2035 if ((err = b64->ops->code(b64, av[1], strlen(av[1]), &d)) != 0 ||
2036 (err = b64->ops->code(b64, 0, 0, &d)) != 0)
2037 a_fail(a, "bad-base64", "%s", codec_strerror(err), A_END);
2039 p_greet(p, d.buf, d.len);
2042 b64->ops->destroy(b64);
2046 static void acmd_addr(admin *a, unsigned ac, char *av[])
2051 if ((p = a_findpeer(a, av[0])) != 0) {
2053 a_info(a, "?ADDR", ad, A_END);
2058 static void acmd_peerinfo(admin *a, unsigned ac, char *av[])
2064 if ((p = a_findpeer(a, av[0])) != 0) {
2066 a_info(a, "tunnel=%s", ps->tops->name, A_END);
2067 if (ps->knock) a_info(a, "knock=%s", ps->knock, A_END);
2068 a_info(a, "key=%s", p_tag(p),
2069 "current-key=%s", p->kx.kpub->tag, A_END);
2070 if ((ptag = p_privtag(p)) == 0) ptag = "(default)";
2071 a_info(a, "private-key=%s", ptag,
2072 "current-private-key=%s", p->kx.kpriv->tag, A_END);
2073 a_info(a, "keepalive=%lu", ps->t_ka, A_END);
2074 a_info(a, "corked=%s", BOOL(p->kx.f&KXF_CORK),
2075 "mobile=%s", BOOL(ps->f&PSF_MOBILE),
2076 "ephemeral=%s", BOOL(ps->f&PSF_EPHEM),
2082 static void acmd_servinfo(admin *a, unsigned ac, char *av[])
2084 a_info(a, "implementation=edgeware-tripe", A_END);
2085 a_info(a, "version=%s", VERSION, A_END);
2086 a_info(a, "daemon=%s", BOOL(flags & F_DAEMON), A_END);
2090 static void acmd_stats(admin *a, unsigned ac, char *av[])
2095 if ((p = a_findpeer(a, av[0])) == 0)
2099 a_info(a, "start-time=%s", timestr(st->t_start), A_END);
2100 a_info(a, "last-packet-time=%s", timestr(st->t_last), A_END);
2101 a_info(a, "last-keyexch-time=%s", timestr(st->t_kx), A_END);
2102 a_info(a, "packets-in=%lu", st->n_in, "bytes-in=%lu", st->sz_in, A_END);
2104 "packets-out=%lu", st->n_out,
2105 "bytes-out=%lu", st->sz_out,
2108 "keyexch-packets-in=%lu", st->n_kxin,
2109 "keyexch-bytes-in=%lu", st->sz_kxin,
2112 "keyexch-packets-out=%lu", st->n_kxout,
2113 "keyexch-bytes-out=%lu", st->sz_kxout,
2116 "ip-packets-in=%lu", st->n_ipin,
2117 "ip-bytes-in=%lu", st->sz_ipin,
2120 "ip-packets-out=%lu", st->n_ipout,
2121 "ip-bytes-out=%lu", st->sz_ipout,
2123 a_info(a, "rejected-packets=%lu", st->n_reject, A_END);
2127 static void acmd_kill(admin *a, unsigned ac, char *av[])
2131 if ((p = a_findpeer(a, av[0])) != 0) {
2137 static void acmd_forcekx(admin *a, unsigned ac, char *av[])
2141 if ((p = a_findpeer(a, av[0])) != 0) {
2142 kx_start(&p->kx, 1);
2147 static void acmd_reload(admin *a, unsigned ac, char *av[])
2148 { p_keyreload(); a_ok(a); }
2150 static void acmd_quit(admin *a, unsigned ac, char *av[])
2152 a_warn("SERVER", "quit", "admin-request", A_END);
2157 static void acmd_version(admin *a, unsigned ac, char *av[])
2159 a_info(a, "%s", PACKAGE, "%s", VERSION, A_END);
2163 static void acmd_tunnels(admin *a, unsigned ac, char *av[])
2167 for (i = 0; tunnels[i]; i++)
2168 a_info(a, "%s", tunnels[i]->name, A_END);
2172 /* --- The command table and help --- */
2174 typedef struct acmd {
2177 unsigned argmin, argmax;
2178 void (*func)(admin */*a*/, unsigned /*ac*/, char */*av*/[]);
2181 static void acmd_help(admin */*a*/, unsigned /*ac*/, char */*av*/[]);
2183 static const acmd acmdtab[] = {
2184 { "add", "[OPTIONS] PEER ADDR ...", 2, 0xffff, acmd_add },
2185 { "addr", "PEER", 1, 1, acmd_addr },
2186 { "algs", "[PEER]", 0, 1, acmd_algs },
2187 { "bgcancel", "TAG", 1, 1, acmd_bgcancel },
2188 { "checkchal", "CHAL", 1, 1, acmd_checkchal },
2189 { "daemon", 0, 0, 0, acmd_daemon },
2190 { "eping", "[OPTIONS] PEER", 1, 0xffff, acmd_eping },
2191 { "forcekx", "PEER", 1, 1, acmd_forcekx },
2192 { "getchal", 0, 0, 0, acmd_getchal },
2193 { "greet", "PEER CHAL", 2, 2, acmd_greet },
2194 { "help", 0, 0, 0, acmd_help },
2195 { "ifname", "PEER", 1, 1, acmd_ifname },
2196 { "jobs", 0, 0, 0, acmd_jobs },
2197 { "kill", "PEER", 1, 1, acmd_kill },
2198 { "list", 0, 0, 0, acmd_list },
2199 { "notify", "MESSAGE ...", 1, 0xffff, acmd_notify },
2200 { "peerinfo", "PEER", 1, 1, acmd_peerinfo },
2201 { "ping", "[OPTIONS] PEER", 1, 0xffff, acmd_ping },
2202 { "port", "[FAMILY]", 0, 1, acmd_port },
2203 { "quit", 0, 0, 0, acmd_quit },
2204 { "reload", 0, 0, 0, acmd_reload },
2205 { "servinfo", 0, 0, 0, acmd_servinfo },
2206 { "setifname", "PEER NEW-NAME", 2, 2, acmd_setifname },
2207 { "stats", "PEER", 1, 1, acmd_stats },
2208 { "svcclaim", "SERVICE VERSION", 2, 2, acmd_svcclaim },
2209 { "svcensure", "SERVICE [VERSION]", 1, 2, acmd_svcensure },
2210 { "svcfail", "JOBID TOKENS...", 1, 0xffff, acmd_svcfail },
2211 { "svcinfo", "JOBID TOKENS...", 1, 0xffff, acmd_svcinfo },
2212 { "svclist", 0, 0, 0, acmd_svclist },
2213 { "svcok", "JOBID", 1, 1, acmd_svcok },
2214 { "svcquery", "SERVICE", 1, 1, acmd_svcquery },
2215 { "svcrelease", "SERVICE", 1, 1, acmd_svcrelease },
2216 { "svcsubmit", "[OPTIONS] SERVICE TOKENS...",
2217 2, 0xffff, acmd_svcsubmit },
2219 { "trace", "[OPTIONS]", 0, 1, acmd_trace },
2221 { "tunnels", 0, 0, 0, acmd_tunnels },
2222 { "version", 0, 0, 0, acmd_version },
2223 { "warn", "MESSAGE ...", 1, 0xffff, acmd_warn },
2224 { "watch", "[OPTIONS]", 0, 1, acmd_watch },
2228 static void acmd_help(admin *a, unsigned ac, char *av[])
2232 for (c = acmdtab; c->name; c++) {
2234 a_info(a, "%s", c->name, "*%s", c->help, A_END);
2236 a_info(a, "%s", c->name, A_END);
2241 /*----- Connection handling -----------------------------------------------*/
2243 /* --- @a_destroypending@ --- *
2249 * Use: Destroys pending admin connections at a safe time.
2252 static void a_destroypending(void)
2254 admin *a, *aa, *head;
2255 admin_bgop *bg, *bbg;
2256 admin_service *svc, *ssvc;
2258 /* --- Destroy connections marked as pending --- *
2260 * Slightly messy. Killing clients may cause others to finally die. Make
2261 * sure that they can be put on the list without clobbering anything or
2268 for (a = head; a; a = aa) {
2270 assert(a->f & AF_DEAD);
2272 /* --- Report what we're doing --- */
2274 T( trace(T_ADMIN, "admin: completing destruction of connection %u",
2277 /* --- If this is the foreground client then shut down --- */
2279 if (a->f & AF_FOREGROUND) {
2280 T( trace(T_ADMIN, "admin: foreground client quit: shutting down"); )
2281 a_warn("SERVER", "quit", "foreground-eof", A_END);
2285 /* --- Abort any background jobs in progress --- */
2287 for (bg = a->bg; bg; bg = bbg) {
2290 if (bg->tag) xfree(bg->tag);
2294 /* --- Release services I hold, and abort pending jobs --- */
2296 for (svc = a->svcs; svc; svc = ssvc) {
2300 a_jobtablefinal(&a->j);
2302 /* --- Close file descriptors and selectory --- */
2304 selbuf_destroy(&a->b);
2305 if (a->b.reader.fd != a->w.fd) close(a->b.reader.fd);
2307 if (a_stdin == a) a_stdin = 0;
2316 /* --- @a_destroy@ --- *
2318 * Arguments: @admin *a@ = pointer to an admin block
2322 * Use: Destroys an admin block. This requires a certain amount of
2326 static void freequeue(oqueue *q)
2330 for (o = q->hd; o; o = oo) {
2337 static void a_destroy(admin *a)
2342 if (a->next) a->next->prev = a->prev;
2343 if (a->prev) a->prev->next = a->next;
2344 else admins = a->next;
2346 if (a->out.hd) sel_rmfile(&a->w);
2353 T( trace(T_ADMIN, "admin: killing connection %u", a->seq); )
2356 /* --- @a_line@ --- *
2358 * Arguments: @char *p@ = pointer to the line read
2359 * @size_t len@ = length of the line
2360 * @void *vp@ = pointer to my admin block
2364 * Use: Handles a line of input.
2367 static void a_line(char *p, size_t len, void *vp)
2382 selbuf_disable(&a->b);
2386 ac = str_qsplit(p, av, N(av) - 1, 0, STRF_QUOTE);
2390 for (c = acmdtab; c->name; c++) {
2391 if (mystrieq(av[0], c->name)) {
2393 if (c->argmin > ac || ac > c->argmax) {
2395 a_fail(a, "bad-syntax", "%s", c->name, "", A_END);
2397 a_fail(a, "bad-syntax", "%s", c->name, "%s", c->help, A_END);
2399 c->func(a, ac, av + 1);
2403 a_fail(a, "unknown-command", "%s", av[0], A_END);
2406 /* --- @a_create@ --- *
2408 * Arguments: @int fd_in, fd_out@ = file descriptors to use
2409 * @unsigned f@ = initial flags to set
2413 * Use: Creates a new admin connection. It's safe to call this
2414 * before @a_init@ -- and, indeed, this makes sense if you also
2415 * call @a_switcherr@ to report initialization errors through
2416 * the administration machinery.
2419 void a_create(int fd_in, int fd_out, unsigned f)
2421 admin *a = CREATE(admin);
2423 T( static unsigned seq = 0;
2425 T( trace(T_ADMIN, "admin: accepted connection %u", a->seq); )
2429 a_jobtableinit(&a->j);
2431 if (fd_in == STDIN_FILENO) a_stdin = a;
2432 fdflags(fd_in, O_NONBLOCK, O_NONBLOCK, FD_CLOEXEC, FD_CLOEXEC);
2433 if (fd_out != fd_in)
2434 fdflags(fd_out, O_NONBLOCK, O_NONBLOCK, FD_CLOEXEC, FD_CLOEXEC);
2435 selbuf_init(&a->b, &sel, fd_in, a_line, a);
2436 sel_initfile(&sel, &a->w, fd_out, SEL_WRITE, a_flush, a);
2437 a->out.hd = a->out.tl = 0;
2440 if (admins) admins->prev = a;
2444 /* --- @a_accept@ --- *
2446 * Arguments: @int fd@ = file descriptor to accept
2447 * @unsigned mode@ = what to do
2448 * @void *v@ = uninteresting pointer
2452 * Use: Accepts a new admin connection.
2455 static void a_accept(int fd, unsigned mode, void *v)
2458 struct sockaddr_un sun;
2459 socklen_t sz = sizeof(sun);
2461 if ((nfd = accept(fd, (struct sockaddr *)&sun, &sz)) < 0) {
2462 if (errno != EINTR && errno != EAGAIN && errno != EWOULDBLOCK &&
2463 errno != ECONNABORTED && errno != EPROTO)
2464 a_warn("ADMIN", "accept-error", "?ERRNO", A_END);
2467 a_create(nfd, nfd, 0);
2470 /* --- @a_preselect@ --- *
2476 * Use: Informs the admin module that we're about to select again,
2477 * and that it should do cleanup things it has delayed until a
2481 void a_preselect(void) { if (a_dead) a_destroypending(); }
2483 /* --- @a_daemon@ --- *
2489 * Use: Informs the admin module that it's a daemon.
2492 void a_daemon(void) { flags |= F_DAEMON; }
2494 /* --- @a_listen@ --- *
2496 * Arguments: @const char *name@ = socket name to create
2497 * @uid_t u@ = user to own the socket
2498 * @gid_t g@ = group to own the socket
2499 * @mode_t m@ = permissions to set on the socket
2503 * Use: Creates the admin listening socket.
2506 void a_listen(const char *name, uid_t u, gid_t g, mode_t m)
2510 struct sockaddr_un sun;
2514 /* --- Set up the socket address --- */
2516 sz = strlen(name) + 1;
2517 if (sz > sizeof(sun.sun_path)) {
2518 a_warn("ADMIN", "admin-socket", "%s", name, "name-too-long", A_END);
2522 sun.sun_family = AF_UNIX;
2523 memcpy(sun.sun_path, name, sz);
2524 sz += offsetof(struct sockaddr_un, sun_path);
2526 /* --- Attempt to bind to the socket --- */
2528 omask = umask(0077);
2530 if ((fd = socket(PF_UNIX, SOCK_STREAM, 0)) < 0) {
2531 a_warn("ADMIN", "admin-socket", "%s", sun.sun_path,
2532 "create-failed", "?ERRNO", A_END);
2535 if (bind(fd, (struct sockaddr *)&sun, sz) < 0) {
2538 if (errno != EADDRINUSE) {
2539 a_warn("ADMIN", "admin-socket", "%s", sun.sun_path,
2540 "bind-failed", "?ERRNO", A_END);
2544 a_warn("ADMIN", "admin-socket", "%s", sun.sun_path,
2545 "too-many-retries", A_END);
2549 if (!connect(fd, (struct sockaddr *)&sun, sz)) {
2550 a_warn("ADMIN", "admin-socket", "%s", sun.sun_path,
2551 "already-in-use", A_END);
2554 if (errno != ECONNREFUSED) {
2555 a_warn("ADMIN", "admin-socket", "%s", sun.sun_path,
2556 "bind-failed", "?ERR", e, A_END);
2559 if (stat(sun.sun_path, &st)) {
2560 if (errno == ENOENT) { close(fd); goto again; }
2561 a_warn("ADMIN", "admin-socket", "%s", sun.sun_path,
2562 "stat-failed", "?ERRNO", A_END);
2565 if (!S_ISSOCK(st.st_mode)) {
2566 a_warn("ADMIN", "admin-socket", "%s", sun.sun_path,
2567 "not-a-socket", A_END);
2570 T( trace(T_ADMIN, "admin: stale socket found; removing it"); )
2571 unlink(sun.sun_path);
2575 if (chown(sun.sun_path, u, g)) {
2576 a_warn("ADMIN", "admin-socket", "%s", sun.sun_path,
2577 "chown-failed", "?ERRNO", A_END);
2580 if (chmod(sun.sun_path, m)) {
2581 a_warn("ADMIN", "admin-socket", "%s", sun.sun_path,
2582 "chmod-failed", "?ERRNO", A_END);
2586 fdflags(fd, O_NONBLOCK, O_NONBLOCK, FD_CLOEXEC, FD_CLOEXEC);
2587 if (listen(fd, 5)) {
2588 a_warn("ADMIN", "admin-socket", "%s", sun.sun_path,
2589 "listen-failed", "?ERRNO", A_END);
2593 /* --- Listen to the socket --- */
2595 sel_initfile(&sel, &sock, fd, SEL_READ, a_accept, 0);
2600 /* --- @a_switcherr@ --- *
2606 * Use: Arrange to report warnings, trace messages, etc. to
2607 * administration clients rather than the standard-error stream.
2609 * Obviously this makes no sense unless there is at least one
2610 * client established. Calling @a_listen@ won't help with this,
2611 * because the earliest a new client can connect is during the
2612 * first select-loop iteration, which is too late: some initial
2613 * client must have been added manually using @a_create@.
2616 void a_switcherr(void)
2618 T( trace_custom(a_trace, 0);
2619 trace(T_ADMIN, "admin: enabled custom tracing"); )
2623 /* --- @a_signals@ --- *
2629 * Use: Establishes handlers for the obvious signals.
2632 void a_signals(void)
2634 struct sigaction sa;
2636 sig_add(&s_term, SIGTERM, a_sigdie, 0);
2637 sig_add(&s_hup, SIGHUP, a_sighup, 0);
2638 sigaction(SIGINT, 0, &sa);
2639 if (sa.sa_handler != SIG_IGN)
2640 sig_add(&s_int, SIGINT, a_sigdie, 0);
2643 /* --- @a_init@ --- *
2649 * Use: Creates the admin listening socket.
2658 /* --- Create services table --- */
2660 sym_create(&a_svcs);
2662 /* --- Prepare the background name resolver --- */
2665 if ((err = adns_init(&ads,
2666 (adns_if_permit_ipv4 | adns_if_permit_ipv6 |
2667 adns_if_noserverwarn | adns_if_nosigpipe |
2670 a_warn("ADMIN", "adns-init-failed", "?ERRNO", A_END);
2673 sel_addhook(&sel, &hook, before_select, after_select, 0);
2679 /*----- That's all, folks -------------------------------------------------*/