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 --------------------------------------------------*/
67 static const char *sockname;
68 static sym_table a_svcs;
69 static unsigned flags = 0;
70 static admin *a_stdin = 0;
71 static sig s_term, s_int, s_hup;
75 #define F_FOREGROUND 4u
77 #define T_RESOLVE SEC(30)
80 static void a_destroy(admin */*a*/);
82 #define BOOL(x) ((x) ? "t" : "nil")
84 /*----- Output functions --------------------------------------------------*/
86 /* --- @trywrite@ --- *
88 * Arguments: @admin *a@ = pointer to an admin block
89 * @const char *p@ = pointer to buffer to write
90 * @size_t sz@ = size of data to write
92 * Returns: The number of bytes written, or less than zero on error.
94 * Use: Attempts to write data to a client.
97 static ssize_t trywrite(admin *a, const char *p, size_t sz)
104 n = write(a->w.fd, p, sz);
114 if (errno != EAGAIN && errno != EWOULDBLOCK) {
116 a_warn("ADMIN", "client-write-error", "?ERRNO", A_END);
123 /* --- @doqueue@ -- *
125 * Arguments: @oqueue *q@ = pointer to output queue
126 * @const char *p@ = pointer to buffer to write
127 * @size_t sz@ = size of buffer
129 * Returns: Nonzero if the queue was previously empty.
131 * Use: Queues data to be written later.
134 static int doqueue(oqueue *q, const char *p, size_t sz)
143 else if (o->p_in < o->buf + OBUFSZ)
147 o = xmalloc(sizeof(obuf));
149 o->p_in = o->p_out = o->buf;
157 n = o->buf + OBUFSZ - o->p_in;
160 memcpy(o->p_in, p, n);
169 /* --- @dosend@ --- *
171 * Arguemnts: @admin *a@ = pointer to an admin block
172 * @const char *p@ = pointer to buffer to write
173 * @size_t sz@ = size of data to write
177 * Use: Sends data to an admin client.
180 static void dosend(admin *a, const char *p, size_t sz)
187 if ((n = trywrite(a, p, sz)) < 0)
194 if (doqueue(&a->out, p, sz))
198 /* --- @a_flush@ --- *
200 * Arguments: @int fd@ = file descriptor
201 * @unsigned mode@ = what's happening
202 * @void *v@ = pointer to my admin block
206 * Use: Flushes buffers when a client is ready to read again.
209 static void a_flush(int fd, unsigned mode, void *v)
217 if ((n = trywrite(a, o->p_out, o->p_in - o->p_out)) < 0)
220 if (o->p_in < o->p_out)
233 /*----- Utility functions -------------------------------------------------*/
235 /* --- @a_vformat@ --- *
237 * Arguments: @dstr *d@ = where to leave the formatted message
238 * @const char *fmt@ = pointer to format string
239 * @va_list *ap@ = arguments in list
243 * Use: Main message token formatting driver. The arguments are
244 * interleaved formatting tokens and their parameters, finally
245 * terminated by an entry @A_END@.
249 * * "*..." ... -- pretokenized @dstr_putf@-like string
251 * * "?ADDR" SOCKADDR -- a socket address, to be converted
253 * * "?B64" BUFFER SIZE -- binary data to be base64-encoded
255 * * "?TOKENS" VECTOR -- null-terminated vector of tokens
257 * * "?PEER" PEER -- peer's name
259 * * "?ERRNO" ERRNO -- system error code
261 * * "[!]..." ... -- @dstr_putf@-like string as single token
264 void a_vformat(dstr *d, const char *fmt, va_list *ap)
270 if (d->len) dstr_putc(d, ' ');
271 dstr_vputf(d, fmt + 1, ap);
272 } else if (*fmt == '?') {
273 if (strcmp(fmt, "?ADDR") == 0) {
274 const addr *a = va_arg(*ap, const addr *);
275 char name[NI_MAXHOST], serv[NI_MAXSERV];
277 if ((err = getnameinfo(&a->sa, addrsz(a),
278 name, sizeof(name), serv, sizeof(serv),
279 (NI_NUMERICHOST | NI_NUMERICSERV |
281 dstr_putf(d, " E%d", err);
282 u_quotify(d, gai_strerror(err));
284 ix = afix(a->sa.sa_family); assert(ix >= 0);
285 u_quotify(d, aftab[ix].name);
289 } else if (strcmp(fmt, "?B64") == 0) {
290 const octet *p = va_arg(*ap, const octet *);
291 size_t n = va_arg(*ap, size_t);
292 codec *b64 = base64_class.encoder(CDCF_NOEQPAD, "", 0);
294 b64->ops->code(b64, p, n, d);
295 b64->ops->code(b64, 0, 0, d);
296 b64->ops->destroy(b64);
297 } else if (strcmp(fmt, "?TOKENS") == 0) {
298 const char *const *av = va_arg(*ap, const char *const *);
299 while (*av) u_quotify(d, *av++);
300 } else if (strcmp(fmt, "?PEER") == 0)
301 u_quotify(d, p_name(va_arg(*ap, peer *)));
302 else if (strcmp(fmt, "?ERRNO") == 0) {
303 dstr_putf(d, " E%d", errno);
304 u_quotify(d, strerror(errno));
308 if (*fmt == '!') fmt++;
310 dstr_vputf(&dd, fmt, ap);
311 u_quotify(d, dd.buf);
313 fmt = va_arg(*ap, const char *);
320 /* --- @a_format@ --- *
322 * Arguments: @dstr *d@ = where to leave the formatted message
323 * @const char *fmt@ = pointer to format string
327 * Use: Writes a tokenized message into a string, for later
331 void a_format(dstr *d, const char *fmt, ...)
336 a_vformat(d, fmt, &ap);
340 /* --- @a_write@, @a_vwrite@ --- *
342 * Arguments: @admin *a@ = admin connection to write to
343 * @const char *status@ = status code to report
344 * @const char *tag@ = tag string, or null
345 * @const char *fmt@ = pointer to format string
346 * @va_list *ap@ = arguments in list
347 * @...@ = other arguments
351 * Use: Sends a message to an admin connection.
354 static void a_vwrite(admin *a, const char *status, const char *tag,
355 const char *fmt, va_list *ap)
359 if (tag) dstr_puts(&d, "BG");
360 dstr_puts(&d, status);
361 if (tag) u_quotify(&d, tag);
362 a_vformat(&d, fmt, ap);
364 dosend(a, d.buf, d.len);
368 static void a_write(admin *a, const char *status, const char *tag,
369 const char *fmt, ...)
374 a_vwrite(a, status, tag, fmt, &ap);
378 /* --- @a_ok@, @a_fail@ --- *
380 * Arguments: @admin *a@ = connection
381 * @const char *fmt@ = format string
382 * @...@ = other arguments
386 * Use: Convenience functions for @a_write@.
389 static void a_ok(admin *a) { a_write(a, "OK", 0, A_END); }
391 static void a_fail(admin *a, const char *fmt, ...)
396 a_vwrite(a, "FAIL", 0, fmt, &ap);
400 /* --- @a_info@ --- *
402 * Arguments: @admin *a@ = connection
403 * @const char *fmt@ = format string
404 * @...@ = other arguments
408 * Use: Report information to an admin client.
411 void a_info(admin *a, const char *fmt, ...)
416 a_vwrite(a, "INFO", 0, fmt, &ap);
420 /* --- @a_alert@, @a_valert@, @a_rawalert@ --- *
422 * Arguments: @unsigned f_and, f_eq@ = filter for connections
423 * @const char *status@ = status string
424 * @const char *fmt@ = pointer to format string
425 * @const char *p@ = pointer to raw string
426 * @size_t sz@ = size of raw string
427 * @va_list *ap@ = arguments in list
428 * @...@ = other arguments
432 * Use: Write a message to all admin connections matched by the given
436 static void a_rawalert(unsigned f_and, unsigned f_eq, const char *status,
437 const char *p, size_t sz)
442 if (!(flags & F_INIT))
444 dstr_puts(&d, status);
447 dstr_putm(&d, p, sz);
452 for (a = admins; a; a = aa) {
454 if ((a->f & f_and) == f_eq)
455 dosend(a, d.buf, d.len);
460 static void a_valert(unsigned f_and, unsigned f_eq, const char *status,
461 const char *fmt, va_list *ap)
465 if (!(flags & F_INIT))
467 a_vformat(&d, fmt, ap);
468 a_rawalert(f_and, f_eq, status, fmt ? d.buf : 0, fmt ? d.len : 0);
472 static void a_alert(unsigned f_and, unsigned f_eq, const char *status,
473 const char *fmt, ...)
478 a_valert(f_and, f_eq, status, fmt, &ap);
482 /* --- @a_warn@ --- *
484 * Arguments: @const char *fmt@ = pointer to format string
485 * @...@ = other arguments
489 * Use: Informs all admin connections of a warning.
492 void a_warn(const char *fmt, ...)
498 a_valert(0, 0, "WARN", fmt, &ap);
501 fprintf(stderr, "%s: ", QUIS);
502 a_vformat(&d, fmt, &ap);
504 dstr_write(&d, stderr);
510 /* --- @a_trace@ --- *
512 * Arguments: @const char *p@ = pointer to a buffer
513 * @size_t sz@ = size of the buffer
514 * @void *v@ = uninteresting pointer
518 * Use: Custom trace output handler. Sends trace messages to
519 * interested admin connections.
523 static void a_trace(const char *p, size_t sz, void *v)
524 { a_rawalert(AF_TRACE, AF_TRACE, "TRACE", p, sz); }
527 /* --- @a_notify@ --- *
529 * Arguments: @const char *fmt@ = pointer to format string
530 * @...@ = other arguments
534 * Use: Sends a notification to interested admin connections.
537 void a_notify(const char *fmt, ...)
542 a_valert(AF_NOTE, AF_NOTE, "NOTE", fmt, &ap);
546 /* --- @a_quit@ --- *
552 * Use: Shuts things down nicely.
559 FOREACH_PEER(p, { p_destroy(p); });
564 /* --- @a_sigdie@ --- *
566 * Arguments: @int sig@ = signal number
567 * @void *v@ = an uninteresting argument
571 * Use Shuts down on receipt of a fatal signal.
574 static void a_sigdie(int sig, void *v)
580 case SIGTERM: p = "SIGTERM"; break;
581 case SIGINT: p = "SIGINT"; break;
583 sprintf(buf, "%i", sig);
587 a_warn("SERVER", "quit", "signal", "%s", p, A_END);
591 /* --- @a_sighup@ --- *
593 * Arguments: @int sig@ = signal number
594 * @void *v@ = an uninteresting argument
598 * Use Logs a message about SIGHUP not being useful.
601 static void a_sighup(int sig, void *v)
602 { a_warn("SERVER", "ignore", "signal", "SIGHUP", A_END); }
604 /* --- @a_parsetime@ --- *
606 * Arguments; @const char *p@ = time string to parse
608 * Returns: Time in seconds, or @< 0@ on error.
611 static long a_parsetime(const char *p)
614 long t = strtol(p, &q, 0);
620 case 's': if (q[1] != 0)
627 /* --- @a_findpeer@ --- *
629 * Arguments: @admin *a@ = admin connection
630 * @const char *pn@ = peer name
632 * Returns: The peer, or null if not there.
634 * Use: Finds a peer, reporting an error if it failed.
637 static peer *a_findpeer(admin *a, const char *pn)
641 if ((p = p_find(pn)) == 0)
642 a_fail(a, "unknown-peer", "%s", pn, A_END);
646 /*----- Backgrounded operations -------------------------------------------*/
649 (((admin_bgop *)(bg))->tag ? ((admin_bgop *)(bg))->tag : "<foreground>")
651 /* --- @a_bgfind@ --- *
653 * Arguments: @admin *a@ = a client block
654 * @const char *tag@ = the requested tag
656 * Returns: The requested background job, or null.
659 static admin_bgop *a_bgfind(admin *a, const char *tag)
663 for (bg = a->bg; bg; bg = bg->next) {
664 if (bg->tag && strcmp(tag, bg->tag) == 0)
670 /* --- @a_bgrelease@ --- *
672 * Arguments: @admin_bgop *bg@ = backgrounded operation
676 * Use: Removes a backgrounded operation from the queue, since
677 * (presumably) it's done.
680 static void a_bgrelease(admin_bgop *bg)
684 T( trace(T_ADMIN, "admin: release bgop %s", BGTAG(bg)); )
685 if (bg->tag) xfree(bg->tag);
686 else selbuf_enable(&a->b);
687 if (bg->next) bg->next->prev = bg->prev;
688 if (bg->prev) bg->prev->next = bg->next;
689 else a->bg = bg->next;
691 if (!a->bg && (a->f & AF_CLOSE)) a_destroy(a);
694 /* --- @a_bgok@, @a_bginfo@, @a_bgfail@ --- *
696 * Arguments: @admin_bgop *bg@ = backgrounded operation
697 * @const char *fmt@ = format string
698 * @...@ = other arguments
702 * Use: Convenience functions for @a_write@.
705 static void a_bgok(admin_bgop *bg)
706 { a_write(bg->a, "OK", bg->tag, A_END); }
708 static void a_bginfo(admin_bgop *bg, const char *fmt, ...)
712 a_vwrite(bg->a, "INFO", bg->tag, fmt, &ap);
716 static void a_bgfail(admin_bgop *bg, const char *fmt, ...)
720 a_vwrite(bg->a, "FAIL", bg->tag, fmt, &ap);
724 /* --- @a_bgadd@ --- *
726 * Arguments: @admin *a@ = administration connection
727 * @admin_bgop *bg@ = pointer to background operation
728 * @const char *tag@ = background tag, or null for foreground
729 * @void (*cancel)(admin_bgop *)@ = cancel function
731 * Returns: Zero for success, nonzero on failure.
733 * Use: Links a background job into the list.
736 static int a_bgadd(admin *a, admin_bgop *bg, const char *tag,
737 void (*cancel)(admin_bgop *))
740 if (a_bgfind(a, tag)) {
741 a_fail(a, "tag-exists", "%s", tag, A_END);
744 bg->tag = xstrdup(tag);
748 selbuf_disable(&a->b);
754 if (a->bg) a->bg->prev = bg;
756 T( trace(T_ADMIN, "admin: add bgop %s", BGTAG(bg)); )
757 if (tag) a_write(a, "DETACH", tag, A_END);
761 /*----- Job table manipulation --------------------------------------------*/
764 #define JOB_INDEXMASK ((1ul << JOB_SHIFT) - 1)
765 #define JOB_SEQMASK ((1ul << (32 - JOB_SHIFT)) - 1)
767 #define JOB_END 0xfffffffful
769 static unsigned long a_joboffset;
771 /* --- @a_jobidencode@ --- *
773 * Arguments: @admin_svcop *svc@ = pointer to a service operation
775 * Returns: A jobid for this job, in an internal static buffer.
777 * Use: Constructs a jobid. In order to dissuade people from
778 * predicting jobids, we obfuscate them.
780 * A `raw' jobid consists of two 16-bit fields. The low 16 bits
781 * are an index into a big array. The high 16 bits are a
782 * sequence number recording how many times that slot has been
785 * This `raw' jobid is then obfuscated by adding a randomly-
786 * generated offset, and multiplying (mod %$2^{32}$%) by a fixed
790 static const char *a_jobidencode(admin_svcop *svc)
792 admin_jobtable *j = &svc->prov->j;
797 assert(svc->index <= JOB_INDEXMASK);
798 seq = j->v[svc->index].seq;
799 assert(seq <= JOB_SEQMASK);
800 pre = (unsigned long)svc->index | ((unsigned long)seq << JOB_SHIFT);
801 sprintf(buf, "J%08lx", ((pre + a_joboffset) * 0x0f87a7a3ul) & 0xffffffff);
805 /* --- @a_jobiddecode@ --- *
807 * Arguments: @admin_jobtable *j@ = pointer to a job table
808 * @const char *jid@ = pointer to a jobid string
810 * Returns: A pointer to the job's @svcop@ structure.
813 static admin_svcop *a_jobiddecode(admin_jobtable *j, const char *jid)
820 for (i = 1; i < 9; i++) {
821 if (!isxdigit((unsigned char)jid[i]))
826 pre = strtoul(jid + 1, 0, 16);
827 pre = ((pre * 0xbd11c40bul) - a_joboffset) & 0xffffffff;
828 i = pre & JOB_INDEXMASK;
829 if (i >= j->n || j->v[i].seq != (pre >> JOB_SHIFT))
831 return (j->v[i].u.op);
834 /* --- @a_jobcreate@ --- *
836 * Arguments: @admin *a@ = pointer to administration client
838 * Returns: A pointer to a freshly-allocated @svcop@, or null.
840 * Use: Allocates a fresh @svcop@ and links it into a job table.
843 static admin_svcop *a_jobcreate(admin *a)
848 admin_jobtable *j = &a->j;
850 if (j->free != JOB_END) {
852 j->free = j->v[i].u.next;
855 if (j->sz > JOB_INDEXMASK)
860 j->v = xmalloc(j->sz * sizeof(*j->v));
863 j->v = xrealloc(j->v, j->sz * sizeof(*j->v), sz * sizeof(*j->v));
869 svc = xmalloc(sizeof(*svc));
872 svc->next = j->active;
874 if (j->active) j->active->prev = svc;
877 IF_TRACING(T_ADMIN, {
878 trace(T_ADMIN, "admin: created job %s (%u)", a_jobidencode(svc), i);
883 /* --- @a_jobdestroy@ --- *
885 * Arguments: @admin_svcop *svc@ = pointer to job block
889 * Use: Frees up a completed (or cancelled) job.
892 static void a_jobdestroy(admin_svcop *svc)
894 admin *a = svc->prov;
895 admin_jobtable *j = &a->j;
896 unsigned i = svc->index;
898 IF_TRACING(T_ADMIN, {
899 trace(T_ADMIN, "admin: destroying job %s (%u)", a_jobidencode(svc), i);
901 assert(j->v[i].u.op = svc);
902 j->v[i].u.next = j->free;
905 if (svc->next) svc->next->prev = svc->prev;
906 if (svc->prev) svc->prev->next = svc->next;
907 else j->active = svc->next;
910 /* --- @a_jobtableinit@ --- *
912 * Arguments: @admin_jobtable *j@ = pointer to job table
916 * Use: Initializes a job table.
919 static void a_jobtableinit(admin_jobtable *j)
922 a_joboffset = GR_RANGE(&rand_global, 0xffffffff) + 1;
929 /* --- @a_jobtablefinal@ --- *
931 * Arguments: @admin_jobtable *j@ = pointer to job table
935 * Use: Closes down a job table.
938 static void a_jobtablefinal(admin_jobtable *j)
940 admin_svcop *svc, *ssvc;
942 for (svc = j->active; svc; svc = ssvc) {
944 a_bgfail(&svc->bg, "provider-failed", A_END);
945 a_bgrelease(&svc->bg);
947 if (j->v) xfree(j->v);
950 /*----- Services infrastructure -------------------------------------------*/
952 /* --- @a_svcfind@ --- *
954 * Arguments: @admin *a@ = the requesting client
955 * @const char *name@ = service name wanted
957 * Returns: The service requested, or null.
959 * Use: Finds a service; reports an error if the service couldn't be
963 static admin_service *a_svcfind(admin *a, const char *name)
967 if ((svc = sym_find(&a_svcs, name, -1, 0, 0)) == 0) {
968 a_fail(a, "unknown-service", "%s", name, A_END);
974 /* --- @a_svcunlink@ --- *
976 * Arguments: @admin_service *svc@ = pointer to service structure
980 * Use: Unlinks the service from its provider, without issuing a
981 * message or freeing the structure. The version string is
985 static void a_svcunlink(admin_service *svc)
988 svc->next->prev = svc->prev;
990 svc->prev->next = svc->next;
992 svc->prov->svcs = svc->next;
996 /* --- @a_svcrelease@ --- *
998 * Arguments: @admin_service *svc@ = pointer to service structure
1002 * Use: Releases a service and frees its structure.
1005 static void a_svcrelease(admin_service *svc)
1007 a_notify("SVCRELEASE", "%s", SYM_NAME(svc), A_END);
1009 sym_remove(&a_svcs, svc);
1012 /*----- Name resolution operations ----------------------------------------*/
1014 /* --- @a_resolved@ --- *
1016 * Arguments: @struct hostent *h@ = pointer to resolved hostname
1017 * @void *v@ = pointer to resolver operation
1021 * Use: Handles a completed name resolution.
1024 static void a_resolved(struct hostent *h, void *v)
1030 T( trace(T_ADMIN, "admin: resop %s failed: %s",
1031 BGTAG(r), hstrerror(h_errno)); )
1032 a_bgfail(&r->bg, "resolve-error", "%s", r->addr, A_END);
1033 r->func(r, ARES_FAIL);
1035 T( trace(T_ADMIN, "admin: resop %s ok", BGTAG(r)); )
1036 r->sa.sin.sin_family = AF_INET;
1037 memcpy(&r->sa.sin.sin_addr, h->h_addr, sizeof(struct in_addr));
1038 setport(&r->sa, r->port);
1039 r->func(r, ARES_OK);
1043 a_bgrelease(&r->bg);
1046 /* --- @a_restimer@ --- *
1048 * Arguments: @struct timeval *tv@ = timer
1049 * @void *v@ = pointer to resolver operation
1053 * Use: Times out a resolver.
1056 static void a_restimer(struct timeval *tv, void *v)
1060 T( trace(T_ADMIN, "admin: resop %s timeout", BGTAG(r)); )
1061 a_bgfail(&r->bg, "resolver-timeout", "%s", r->addr, A_END);
1062 r->func(r, ARES_FAIL);
1065 a_bgrelease(&r->bg);
1068 /* --- @a_rescancel@ --- *
1070 * Arguments: @admin_bgop *bg@ = background operation
1074 * Use: Cancels an add operation.
1077 static void a_rescancel(admin_bgop *bg)
1079 admin_resop *r = (admin_resop *)bg;
1081 T( trace(T_ADMIN, "admin: cancel resop %s", BGTAG(r)); )
1082 r->func(r, ARES_FAIL);
1088 /* --- @a_resolve@ --- *
1090 * Arguments: @admin *a@ = administration connection
1091 * @admin_resop *r@ = resolver operation to run
1092 * @const char *tag@ = background operation tag
1093 * @void (*func)(struct admin_resop *, int@ = handler function
1094 * @unsigned ac@ = number of remaining arguments
1095 * @char *av[]@ = pointer to remaining arguments
1099 * Use: Cranks up a resolver job.
1102 static void a_resolve(admin *a, admin_resop *r, const char *tag,
1103 void (*func)(struct admin_resop *, int),
1104 unsigned ac, char *av[])
1109 const char *fam = "ANY";
1112 struct addrinfo *ai, *ailist, aihint = { 0 };
1114 /* --- Fill in the easy bits of address --- */
1116 r->bg.tag = "<starting>";
1119 if (mystrieq(av[i], "any"))
1120 { fam = "ANY"; af = AF_UNSPEC; i++; }
1121 else for (j = 0; j < NADDRFAM; j++) {
1122 if (mystrieq(av[i], aftab[j].name)) {
1123 assert(udpsock[j].fd >= 0);
1124 fam = aftab[j].name;
1130 if (ac - i != 1 && ac - i != 2) {
1131 a_fail(a, "bad-addr-syntax", "[FAMILY] ADDRESS [PORT]", A_END);
1134 r->addr = xstrdup(av[i]);
1138 pt = strtoul(av[i + 1], &p, 0);
1140 struct servent *s = getservbyname(av[i + 1], "udp");
1142 a_fail(a, "unknown-service", "%s", av[i + 1], A_END);
1145 pt = ntohs(s->s_port);
1148 if (pt == 0 || pt >= 65536) {
1149 a_fail(a, "invalid-port", "%lu", pt, A_END);
1154 /* --- Report backgrounding --- *
1156 * Do this for consistency of interface, even if we're going to get the
1157 * answer straight away.
1160 if (a_bgadd(a, &r->bg, tag, a_rescancel))
1162 T( trace(T_ADMIN, "admin: %u, resop %s, hostname `%s', family `%s'",
1163 a->seq, BGTAG(r), r->addr, fam); )
1165 /* --- Make sure the address family is something we can implement --- */
1167 if (af != AF_UNSPEC && af != AF_INET) {
1168 T( trace(T_ADMIN, "admin: resop %s failed: unsupported address family",
1170 a_bgfail(&r->bg, "resolve-error", "%s", r->addr, A_END);
1173 assert(udpsock[AFIX_INET].fd >= 0);
1175 /* --- If the name is numeric, do it the easy way --- */
1177 aihint.ai_family = AF_INET;
1178 aihint.ai_socktype = SOCK_DGRAM;
1179 aihint.ai_protocol = IPPROTO_UDP;
1180 aihint.ai_flags = AI_NUMERICHOST;
1181 if (!getaddrinfo(av[i], 0, &aihint, &ailist)) {
1182 for (ai = ailist; ai; ai = ai->ai_next) {
1183 if ((j = afix(ai->ai_family)) >= 0 && udpsock[j].fd >= 0)
1187 T( trace(T_ADMIN, "admin: resop %s failed: "
1188 "no suitable addresses returned", BGTAG(r)); )
1189 a_bgfail(&r->bg, "resolve-error", "%s" , r->addr, A_END);
1192 T( trace(T_ADMIN, "admin: resop %s done the easy way", BGTAG(r)); )
1193 assert(ai->ai_addrlen <= sizeof(r->sa));
1194 memcpy(&r->sa, ai->ai_addr, ai->ai_addrlen);
1195 setport(&r->sa, r->port);
1198 freeaddrinfo(ailist);
1200 a_bgrelease(&r->bg);
1204 /* --- Store everything for later and crank up the resolver --- */
1206 gettimeofday(&tv, 0);
1207 tv.tv_sec += T_RESOLVE;
1208 sel_addtimer(&sel, &r->t, &tv, a_restimer, r);
1209 bres_byname(&r->r, r->addr, a_resolved, r);
1214 if (r->addr) xfree(r->addr);
1221 a_bgrelease(&r->bg);
1224 /*----- Option parsing ----------------------------------------------------*/
1226 #define OPTIONS(argc, argv, guts) do { \
1227 char **o_av = argv; \
1231 if (mystrieq(*o_av, "--")) { \
1236 if (**o_av == '-') \
1240 argc -= o_av - argv; \
1244 #define OPT(name, guts) if (mystrieq(*o_av, name)) { guts continue; }
1246 #define OPTARG(name, arg, guts) OPT(name, { \
1249 if (!arg) goto bad_syntax; \
1253 #define OPTTIME(name, arg, guts) OPTARG(name, o_arg, { \
1255 if ((arg = a_parsetime(o_arg)) < 0) { \
1256 a_fail(a, "bad-time-spec", "%s", o_arg, A_END); \
1262 /*----- Adding peers ------------------------------------------------------*/
1264 /* --- @a_doadd@ --- *
1266 * Arguments: @admin_resop *r@ = resolver operation
1267 * @int rc@ = how it worked
1271 * Use: Handles a completed resolution.
1274 static void a_doadd(admin_resop *r, int rc)
1276 admin_addop *add = (admin_addop *)r;
1278 T( trace(T_ADMIN, "admin: done add op %s", BGTAG(add)); )
1280 if (rc == ARES_OK) {
1281 add->peer.sa = add->r.sa;
1282 if (p_findbyaddr(&add->r.sa))
1283 a_bgfail(&add->r.bg, "peer-addr-exists", "?ADDR", &add->r.sa, A_END);
1284 else if (p_find(add->peer.name))
1285 a_bgfail(&add->r.bg, "peer-exists", "%s", add->peer.name, A_END);
1286 else if (!p_create(&add->peer))
1287 a_bgfail(&add->r.bg, "peer-create-fail", "%s", add->peer.name, A_END);
1292 if (add->peer.tag) xfree(add->peer.tag);
1293 if (add->peer.privtag) xfree(add->peer.privtag);
1294 xfree(add->peer.name);
1297 /* --- @acmd_add@ --- *
1299 * Arguments: @admin *a@ = connection which requested the addition
1300 * @unsigned ac@ = argument count
1301 * @char *av[]@ = pointer to the argument list
1305 * Use: Adds a new peer.
1308 static void acmd_add(admin *a, unsigned ac, char *av[])
1310 const char *tag = 0;
1313 /* --- Set stuff up --- */
1315 add = xmalloc(sizeof(*add));
1318 add->peer.privtag = 0;
1320 add->peer.tops = tun_default;
1323 /* --- Parse options --- */
1326 OPTARG("-background", arg, { tag = arg; })
1327 OPTARG("-tunnel", arg, {
1331 a_fail(a, "unknown-tunnel", "%s", arg, A_END);
1334 if (mystrieq(arg, tunnels[i]->name)) {
1335 add->peer.tops = tunnels[i];
1340 OPTTIME("-keepalive", t, { add->peer.t_ka = t; })
1341 OPT("-cork", { add->peer.f |= KXF_CORK; })
1342 OPTARG("-key", arg, {
1343 if (add->peer.tag) xfree(add->peer.tag);
1344 add->peer.tag = xstrdup(arg);
1346 OPT("-mobile", { add->peer.f |= PSF_MOBILE; })
1347 OPTARG("-priv", arg, {
1348 if (add->peer.privtag) xfree(add->peer.privtag);
1349 add->peer.privtag = xstrdup(arg);
1353 /* --- Make sure someone's not got there already --- */
1355 if (!av[0] || !av[1])
1358 a_fail(a, "peer-exists", "%s", *av, A_END);
1361 add->peer.name = xstrdup(*av++);
1364 /* --- Crank up the resolver --- */
1366 a_resolve(a, &add->r, tag, a_doadd, ac, av);
1369 /* --- Clearing up --- */
1372 a_fail(a, "bad-syntax", "add", "[OPTIONS] PEER ADDR ...", A_END);
1374 if (add->peer.name) xfree(add->peer.name);
1375 if (add->peer.tag) xfree(add->peer.tag);
1376 if (add->peer.privtag) xfree(add->peer.privtag);
1381 /*----- Ping --------------------------------------------------------------*/
1383 /* --- @a_pingcancel@ --- *
1385 * Arguments: @admin_bgop *bg@ = background operation block
1389 * Use: Cancels a running ping.
1392 static void a_pingcancel(admin_bgop *bg)
1394 admin_pingop *pg = (admin_pingop *)bg;
1395 T( trace(T_ADMIN, "admin: cancel ping op %s", BGTAG(pg)); )
1396 p_pingdone(&pg->ping, PING_NONOTIFY);
1399 /* --- @a_pong@ --- *
1401 * Arguments: @int rc@ = return code
1402 * @void *v@ = ping operation block
1406 * Use: Collects what happened to a ping message.
1409 static void a_pong(int rc, void *v)
1411 admin_pingop *pg = v;
1417 gettimeofday(&tv, 0);
1418 tv_sub(&tv, &tv, &pg->pingtime);
1419 millis = (double)tv.tv_sec * 1000 + (double)tv.tv_usec/1000;
1420 a_bginfo(&pg->bg, "ping-ok", "%.1f", millis, A_END);
1424 a_bginfo(&pg->bg, "ping-timeout", A_END);
1428 a_bginfo(&pg->bg, "ping-peer-died", A_END);
1434 T( trace(T_ADMIN, "admin: ponged ping op %s", BGTAG(pg)); )
1435 a_bgrelease(&pg->bg);
1438 /* --- @acmd_ping@, @acmd_eping@ --- *
1440 * Arguments: @admin *a@ = connection which requested the ping
1441 * @unsigned ac@ = argument count
1442 * @char *av[]@ = pointer to the argument list
1446 * Use: Pings a peer.
1449 static void a_ping(admin *a, unsigned ac, char *av[],
1450 const char *cmd, unsigned msg)
1454 admin_pingop *pg = 0;
1455 const char *tag = 0;
1458 OPTARG("-background", arg, { tag = arg; })
1459 OPTTIME("-timeout", arg, { t = arg; })
1461 if (!*av || av[1]) goto bad_syntax;
1462 if ((p = a_findpeer(a, *av)) == 0)
1464 pg = xmalloc(sizeof(*pg));
1465 gettimeofday(&pg->pingtime, 0);
1466 if (a_bgadd(a, &pg->bg, tag, a_pingcancel))
1468 T( trace(T_ADMIN, "admin: ping op %s: %s to %s",
1469 BGTAG(pg), cmd, p_name(p)); )
1470 if (p_pingsend(p, &pg->ping, msg, t, a_pong, pg)) {
1471 a_bgfail(&pg->bg, "ping-send-failed", A_END);
1472 a_bgrelease(&pg->bg);
1477 a_fail(a, "bad-syntax", "%s", cmd, "[OPTIONS] PEER", cmd, A_END);
1483 static void acmd_ping(admin *a, unsigned ac, char *av[])
1484 { a_ping(a, ac, av, "ping", MISC_PING); }
1485 static void acmd_eping(admin *a, unsigned ac, char *av[])
1486 { a_ping(a, ac, av, "eping", MISC_EPING); }
1488 /*----- Service commands --------------------------------------------------*/
1490 static void acmd_svcclaim(admin *a, unsigned ac, char *av[])
1495 svc = sym_find(&a_svcs, av[0], -1, sizeof(*svc), &f);
1497 if (versioncmp(av[1], svc->version) <= 0) {
1500 "%s", SYM_NAME(svc),
1505 a_write(svc->prov, "SVCCLAIM", 0, "%s", av[0], "%s", av[1], A_END);
1509 svc->version = xstrdup(av[1]);
1510 svc->next = a->svcs;
1512 if (a->svcs) a->svcs->prev = svc;
1514 a_notify("SVCCLAIM", "%s", SYM_NAME(svc), "%s", svc->version, A_END);
1518 static void acmd_svcrelease(admin *a, unsigned ac, char *av[])
1522 if ((svc = a_svcfind(a, av[0])) == 0)
1524 if (svc->prov != a) {
1525 a_fail(a, "not-service-provider", "%s", SYM_NAME(svc), A_END);
1532 static void acmd_svcensure(admin *a, unsigned ac, char *av[])
1536 if ((svc = a_svcfind(a, av[0])) == 0)
1538 if (av[1] && versioncmp(svc->version, av[1]) < 0) {
1539 a_fail(a, "service-too-old",
1540 "%s", SYM_NAME(svc),
1548 static void acmd_svcquery(admin *a, unsigned ac, char *av[])
1552 if ((svc = a_svcfind(a, av[0])) != 0) {
1553 a_info(a, "name=%s", SYM_NAME(svc), "version=%s", svc->version, A_END);
1558 static void acmd_svclist(admin *a, unsigned ac, char *av[])
1563 for (sym_mkiter(&i, &a_svcs); (svc = sym_next(&i)) != 0; )
1564 a_info(a, "%s", SYM_NAME(svc), "%s", svc->version, A_END);
1568 static void a_canceljob(admin_bgop *bg)
1570 admin_svcop *svc = (admin_svcop *)bg;
1572 a_write(svc->prov, "SVCCANCEL", 0, "%s", a_jobidencode(svc), A_END);
1576 static void acmd_svcsubmit(admin *a, unsigned ac, char *av[])
1578 const char *tag = 0;
1581 const char *ver = 0;
1585 OPTARG("-background", arg, { tag = arg; })
1586 OPTARG("-version", arg, { ver = arg; })
1588 if (!*av) goto bad_syntax;
1589 if ((svc = a_svcfind(a, *av)) == 0) goto fail;
1590 if (ver && versioncmp(svc->version, ver) < 0) {
1591 a_fail(a, "service-too-old",
1592 "%s", SYM_NAME(svc),
1597 if ((svcop = a_jobcreate(svc->prov)) == 0) {
1598 a_fail(a, "provider-overloaded", A_END);
1601 if (a_bgadd(a, &svcop->bg, tag, a_canceljob)) {
1602 a_jobdestroy(svcop);
1605 a_write(svc->prov, "SVCJOB", 0,
1606 "%s", a_jobidencode(svcop),
1612 a_fail(a, "bad-syntax", "svcsubmit", "[OPTIONS] SERVICE ARGS...", A_END);
1619 static void a_replycmd(admin *a, const char *status, int donep, char *av[])
1623 if ((svc = a_jobiddecode(&a->j, av[0])) == 0) {
1624 a_fail(a, "unknown-jobid", av[0], A_END);
1627 a_write(svc->bg.a, status, svc->bg.tag, "?TOKENS", av + 1, A_END);
1630 a_bgrelease(&svc->bg);
1635 static void acmd_svcok(admin *a, unsigned ac, char *av[])
1636 { a_replycmd(a, "OK", 1, av); }
1637 static void acmd_svcinfo(admin *a, unsigned ac, char *av[])
1638 { a_replycmd(a, "INFO", 0, av); }
1639 static void acmd_svcfail(admin *a, unsigned ac, char *av[])
1640 { a_replycmd(a, "FAIL", 1, av); }
1642 /*----- Administration commands -------------------------------------------*/
1644 /* --- Miscellaneous commands --- */
1646 /* --- @traceish@ --- *
1648 * Arguments: @admin *a@ = connection to complain on
1649 * @unsigned ac@ = number of arguments
1650 * @char *av[]@ = vector of arguments
1651 * @const char *what@ = what we're messing with
1652 * @const trace_opt *tt@ = options table
1653 * @unsigned *ff@ = where the flags are
1655 * Returns: Nonzero if anything changed.
1657 * Use: Guts of trace-ish commands like `trace' and `watch'.
1660 static int traceish(admin *a, unsigned ac, char *av[],
1661 const char *what, const trace_opt *tt, unsigned *ff)
1665 if (!ac || strcmp(av[0], "?") == 0) {
1667 for (t = tt; t->ch; t++) {
1668 a_info(a, "*%c%c %s",
1669 t->ch, (*ff & t->f) == t->f ? '+' : ' ', t->help, A_END);
1679 case '+': sense = 1; break;
1680 case '-': sense = 0; break;
1682 for (t = tt; t->ch; t++) {
1684 if (sense) f |= t->f;
1689 a_fail(a, "bad-%s-option", what, "%c", *p, A_END);
1705 static void acmd_trace(admin *a, unsigned ac, char *av[])
1707 if (traceish(a, ac, av, "trace", tr_opts, &tr_flags))
1708 trace_level(tr_flags);
1713 static void acmd_watch(admin *a, unsigned ac, char *av[])
1714 { traceish(a, ac, av, "watch", w_opts, &a->f); }
1716 static void alertcmd(admin *a, unsigned f_and, unsigned f_eq,
1717 const char *status, char *av[])
1718 { a_alert(f_and, f_eq, status, "USER", "?TOKENS", av, A_END); a_ok(a); }
1719 static void acmd_notify(admin *a, unsigned ac, char *av[])
1720 { alertcmd(a, AF_NOTE, AF_NOTE, "NOTE", av); }
1721 static void acmd_warn(admin *a, unsigned ac, char *av[])
1722 { alertcmd(a, AF_WARN, AF_WARN, "WARN", av); }
1724 static void acmd_port(admin *a, unsigned ac, char *av[])
1729 for (i = 0; i < NADDRFAM; i++)
1730 if (mystrieq(av[0], aftab[i].name)) goto found;
1731 a_fail(a, "unknown-address-family", "%s", av[0], A_END);
1734 assert(udpsock[i].fd >= 0);
1736 for (i = 0; i < NADDRFAM; i++)
1737 if (udpsock[i].fd >= 0) goto found;
1740 a_info(a, "%u", p_port(i), A_END);
1744 static void acmd_daemon(admin *a, unsigned ac, char *av[])
1746 if (flags & F_DAEMON)
1747 a_fail(a, "already-daemon", A_END);
1749 a_notify("DAEMON", A_END);
1753 a_fail(a, "daemon-error", "?ERRNO", A_END);
1761 static void acmd_jobs(admin *a, unsigned ac, char *av[])
1765 for (bg = a->bg; bg; bg = bg->next) {
1767 a_info(a, "%s", bg->tag, A_END);
1772 static void acmd_bgcancel(admin *a, unsigned ac, char *av[])
1776 if ((bg = a_bgfind(a, av[0])) == 0)
1777 a_fail(a, "unknown-tag", "%s", av[0], A_END);
1785 static void acmd_algs(admin *a, unsigned ac, char *av[])
1790 const algswitch *algs;
1795 if ((p = a_findpeer(a, av[0])) == 0) return;
1801 g->ops->grpinfo(g, a);
1803 "hash=%s", algs->h->name,
1804 "mgf=%s", algs->mgf->name,
1805 "hash-sz=%lu", (unsigned long)algs->h->hashsz,
1808 "bulk-transform=%s", algs->bulk->ops->name,
1809 "bulk-overhead=%lu",
1810 (unsigned long)algs->bulk->ops->overhead(algs->bulk),
1812 algs->bulk->ops->alginfo(algs->bulk, a);
1814 "cipher-data-limit=%lu",
1815 (unsigned long)algs->bulk->ops->expsz(algs->bulk),
1820 static void acmd_list(admin *a, unsigned ac, char *av[])
1822 FOREACH_PEER(p, { a_info(a, "%s", p_name(p), A_END); });
1826 static void acmd_ifname(admin *a, unsigned ac, char *av[])
1830 if ((p = a_findpeer(a, av[0])) != 0) {
1831 a_info(a, "%s", p_ifname(p), A_END);
1836 static void acmd_setifname(admin *a, unsigned ac, char *av[])
1840 if ((p = a_findpeer(a, av[0])) != 0) {
1841 a_notify("NEWIFNAME", "?PEER", p, "%s", p_ifname(p), "%s", av[1], A_END);
1842 p_setifname(p, av[1]);
1847 static void acmd_getchal(admin *a, unsigned ac, char *av[])
1851 buf_init(&b, buf_i, PKBUFSZ);
1853 a_info(a, "?B64", BBASE(&b), (size_t)BLEN(&b), A_END);
1857 static void acmd_checkchal(admin *a, unsigned ac, char *av[])
1859 codec *b64 = base64_class.decoder(CDCF_NOEQPAD);
1864 if ((err = b64->ops->code(b64, av[0], strlen(av[0]), &d)) != 0 ||
1865 (err = b64->ops->code(b64, 0, 0, &d)) != 0)
1866 a_fail(a, "bad-base64", "%s", codec_strerror(err), A_END);
1868 buf_init(&b, d.buf, d.len);
1869 if (c_check(&b) || BBAD(&b) || BLEFT(&b))
1870 a_fail(a, "invalid-challenge", A_END);
1874 b64->ops->destroy(b64);
1878 static void acmd_greet(admin *a, unsigned ac, char *av[])
1885 if ((p = a_findpeer(a, av[0])) == 0) return;
1886 b64 = base64_class.decoder(CDCF_NOEQPAD);
1887 if ((err = b64->ops->code(b64, av[1], strlen(av[1]), &d)) != 0 ||
1888 (err = b64->ops->code(b64, 0, 0, &d)) != 0)
1889 a_fail(a, "bad-base64", "%s", codec_strerror(err), A_END);
1891 p_greet(p, d.buf, d.len);
1894 b64->ops->destroy(b64);
1898 static void acmd_addr(admin *a, unsigned ac, char *av[])
1903 if ((p = a_findpeer(a, av[0])) != 0) {
1905 a_info(a, "?ADDR", ad, A_END);
1910 static void acmd_peerinfo(admin *a, unsigned ac, char *av[])
1916 if ((p = a_findpeer(a, av[0])) != 0) {
1918 a_info(a, "tunnel=%s", ps->tops->name, A_END);
1919 a_info(a, "key=%s", p_tag(p),
1920 "current-key=%s", p->kx.kpub->tag, A_END);
1921 if ((ptag = p_privtag(p)) == 0) ptag = "(default)";
1922 a_info(a, "private-key=%s", ptag,
1923 "current-private-key=%s", p->kx.kpriv->tag, A_END);
1924 a_info(a, "keepalive=%lu", ps->t_ka, A_END);
1925 a_info(a, "corked=%s", BOOL(p->kx.f&KXF_CORK),
1926 "mobile=%s", BOOL(ps->f&PSF_MOBILE),
1932 static void acmd_servinfo(admin *a, unsigned ac, char *av[])
1934 a_info(a, "implementation=edgeware-tripe", A_END);
1935 a_info(a, "version=%s", VERSION, A_END);
1936 a_info(a, "daemon=%s", BOOL(flags & F_DAEMON), A_END);
1940 static void acmd_stats(admin *a, unsigned ac, char *av[])
1945 if ((p = a_findpeer(a, av[0])) == 0)
1949 a_info(a, "start-time=%s", timestr(st->t_start), A_END);
1950 a_info(a, "last-packet-time=%s", timestr(st->t_last), A_END);
1951 a_info(a, "last-keyexch-time=%s", timestr(st->t_kx), A_END);
1952 a_info(a, "packets-in=%lu", st->n_in, "bytes-in=%lu", st->sz_in, A_END);
1954 "packets-out=%lu", st->n_out,
1955 "bytes-out=%lu", st->sz_out,
1958 "keyexch-packets-in=%lu", st->n_kxin,
1959 "keyexch-bytes-in=%lu", st->sz_kxin,
1962 "keyexch-packets-out=%lu", st->n_kxout,
1963 "keyexch-bytes-out=%lu", st->sz_kxout,
1966 "ip-packets-in=%lu", st->n_ipin,
1967 "ip-bytes-in=%lu", st->sz_ipin,
1970 "ip-packets-out=%lu", st->n_ipout,
1971 "ip-bytes-out=%lu", st->sz_ipout,
1973 a_info(a, "rejected-packets=%lu", st->n_reject, A_END);
1977 static void acmd_kill(admin *a, unsigned ac, char *av[])
1981 if ((p = a_findpeer(a, av[0])) != 0) {
1987 static void acmd_forcekx(admin *a, unsigned ac, char *av[])
1991 if ((p = a_findpeer(a, av[0])) != 0) {
1992 kx_start(&p->kx, 1);
1997 static void acmd_reload(admin *a, unsigned ac, char *av[])
1998 { p_keyreload(); a_ok(a); }
2000 static void acmd_quit(admin *a, unsigned ac, char *av[])
2002 a_warn("SERVER", "quit", "admin-request", A_END);
2007 static void acmd_version(admin *a, unsigned ac, char *av[])
2009 a_info(a, "%s", PACKAGE, "%s", VERSION, A_END);
2013 static void acmd_tunnels(admin *a, unsigned ac, char *av[])
2017 for (i = 0; tunnels[i]; i++)
2018 a_info(a, "%s", tunnels[i]->name, A_END);
2022 /* --- The command table and help --- */
2024 typedef struct acmd {
2027 unsigned argmin, argmax;
2028 void (*func)(admin */*a*/, unsigned /*ac*/, char */*av*/[]);
2031 static void acmd_help(admin */*a*/, unsigned /*ac*/, char */*av*/[]);
2033 static const acmd acmdtab[] = {
2034 { "add", "[OPTIONS] PEER ADDR ...", 2, 0xffff, acmd_add },
2035 { "addr", "PEER", 1, 1, acmd_addr },
2036 { "algs", "[PEER]", 0, 1, acmd_algs },
2037 { "bgcancel", "TAG", 1, 1, acmd_bgcancel },
2038 { "checkchal", "CHAL", 1, 1, acmd_checkchal },
2039 { "daemon", 0, 0, 0, acmd_daemon },
2040 { "eping", "[OPTIONS] PEER", 1, 0xffff, acmd_eping },
2041 { "forcekx", "PEER", 1, 1, acmd_forcekx },
2042 { "getchal", 0, 0, 0, acmd_getchal },
2043 { "greet", "PEER CHAL", 2, 2, acmd_greet },
2044 { "help", 0, 0, 0, acmd_help },
2045 { "ifname", "PEER", 1, 1, acmd_ifname },
2046 { "jobs", 0, 0, 0, acmd_jobs },
2047 { "kill", "PEER", 1, 1, acmd_kill },
2048 { "list", 0, 0, 0, acmd_list },
2049 { "notify", "MESSAGE ...", 1, 0xffff, acmd_notify },
2050 { "peerinfo", "PEER", 1, 1, acmd_peerinfo },
2051 { "ping", "[OPTIONS] PEER", 1, 0xffff, acmd_ping },
2052 { "port", "[FAMILY]", 0, 1, acmd_port },
2053 { "quit", 0, 0, 0, acmd_quit },
2054 { "reload", 0, 0, 0, acmd_reload },
2055 { "servinfo", 0, 0, 0, acmd_servinfo },
2056 { "setifname", "PEER NEW-NAME", 2, 2, acmd_setifname },
2057 { "stats", "PEER", 1, 1, acmd_stats },
2058 { "svcclaim", "SERVICE VERSION", 2, 2, acmd_svcclaim },
2059 { "svcensure", "SERVICE [VERSION]", 1, 2, acmd_svcensure },
2060 { "svcfail", "JOBID TOKENS...", 1, 0xffff, acmd_svcfail },
2061 { "svcinfo", "JOBID TOKENS...", 1, 0xffff, acmd_svcinfo },
2062 { "svclist", 0, 0, 0, acmd_svclist },
2063 { "svcok", "JOBID", 1, 1, acmd_svcok },
2064 { "svcquery", "SERVICE", 1, 1, acmd_svcquery },
2065 { "svcrelease", "SERVICE", 1, 1, acmd_svcrelease },
2066 { "svcsubmit", "[OPTIONS] SERVICE TOKENS...",
2067 2, 0xffff, acmd_svcsubmit },
2069 { "trace", "[OPTIONS]", 0, 1, acmd_trace },
2071 { "tunnels", 0, 0, 0, acmd_tunnels },
2072 { "version", 0, 0, 0, acmd_version },
2073 { "warn", "MESSAGE ...", 1, 0xffff, acmd_warn },
2074 { "watch", "[OPTIONS]", 0, 1, acmd_watch },
2078 static void acmd_help(admin *a, unsigned ac, char *av[])
2082 for (c = acmdtab; c->name; c++) {
2084 a_info(a, "%s", c->name, "*%s", c->help, A_END);
2086 a_info(a, "%s", c->name, A_END);
2091 /*----- Connection handling -----------------------------------------------*/
2093 /* --- @a_destroypending@ --- *
2099 * Use: Destroys pending admin connections at a safe time.
2102 static void a_destroypending(void)
2104 admin *a, *aa, *head;
2105 admin_bgop *bg, *bbg;
2106 admin_service *svc, *ssvc;
2108 /* --- Destroy connections marked as pending --- *
2110 * Slightly messy. Killing clients may cause others to finally die. Make
2111 * sure that they can be put on the list without clobbering anything or
2118 for (a = head; a; a = aa) {
2120 assert(a->f & AF_DEAD);
2122 /* --- Report what we're doing --- */
2124 T( trace(T_ADMIN, "admin: completing destruction of connection %u",
2127 /* --- If this is the foreground client then shut down --- */
2129 if (a->f & AF_FOREGROUND) {
2130 T( trace(T_ADMIN, "admin: foreground client quit: shutting down"); )
2131 a_warn("SERVER", "quit", "foreground-eof", A_END);
2135 /* --- Abort any background jobs in progress --- */
2137 for (bg = a->bg; bg; bg = bbg) {
2140 if (bg->tag) xfree(bg->tag);
2144 /* --- Release services I hold, and abort pending jobs --- */
2146 for (svc = a->svcs; svc; svc = ssvc) {
2150 a_jobtablefinal(&a->j);
2152 /* --- Close file descriptors and selectory --- */
2154 selbuf_destroy(&a->b);
2155 if (a->b.reader.fd != a->w.fd) close(a->b.reader.fd);
2157 if (a_stdin == a) a_stdin = 0;
2166 /* --- @a_destroy@ --- *
2168 * Arguments: @admin *a@ = pointer to an admin block
2172 * Use: Destroys an admin block. This requires a certain amount of
2176 static void freequeue(oqueue *q)
2180 for (o = q->hd; o; o = oo) {
2187 static void a_destroy(admin *a)
2192 if (a->next) a->next->prev = a->prev;
2193 if (a->prev) a->prev->next = a->next;
2194 else admins = a->next;
2196 if (a->out.hd) sel_rmfile(&a->w);
2203 T( trace(T_ADMIN, "admin: killing connection %u", a->seq); )
2206 /* --- @a_line@ --- *
2208 * Arguments: @char *p@ = pointer to the line read
2209 * @size_t len@ = length of the line
2210 * @void *vp@ = pointer to my admin block
2214 * Use: Handles a line of input.
2217 static void a_line(char *p, size_t len, void *vp)
2232 selbuf_disable(&a->b);
2236 ac = str_qsplit(p, av, N(av) - 1, 0, STRF_QUOTE);
2240 for (c = acmdtab; c->name; c++) {
2241 if (mystrieq(av[0], c->name)) {
2243 if (c->argmin > ac || ac > c->argmax) {
2245 a_fail(a, "bad-syntax", "%s", c->name, "", A_END);
2247 a_fail(a, "bad-syntax", "%s", c->name, "%s", c->help, A_END);
2249 c->func(a, ac, av + 1);
2253 a_fail(a, "unknown-command", "%s", av[0], A_END);
2256 /* --- @a_create@ --- *
2258 * Arguments: @int fd_in, fd_out@ = file descriptors to use
2259 * @unsigned f@ = initial flags to set
2263 * Use: Creates a new admin connection.
2266 void a_create(int fd_in, int fd_out, unsigned f)
2268 admin *a = CREATE(admin);
2270 T( static unsigned seq = 0;
2272 T( trace(T_ADMIN, "admin: accepted connection %u", a->seq); )
2276 a_jobtableinit(&a->j);
2278 if (fd_in == STDIN_FILENO) a_stdin = a;
2279 fdflags(fd_in, O_NONBLOCK, O_NONBLOCK, FD_CLOEXEC, FD_CLOEXEC);
2280 if (fd_out != fd_in)
2281 fdflags(fd_out, O_NONBLOCK, O_NONBLOCK, FD_CLOEXEC, FD_CLOEXEC);
2282 selbuf_init(&a->b, &sel, fd_in, a_line, a);
2283 sel_initfile(&sel, &a->w, fd_out, SEL_WRITE, a_flush, a);
2284 a->out.hd = a->out.tl = 0;
2287 if (admins) admins->prev = a;
2291 /* --- @a_accept@ --- *
2293 * Arguments: @int fd@ = file descriptor to accept
2294 * @unsigned mode@ = what to do
2295 * @void *v@ = uninteresting pointer
2299 * Use: Accepts a new admin connection.
2302 static void a_accept(int fd, unsigned mode, void *v)
2305 struct sockaddr_un sun;
2306 socklen_t sz = sizeof(sun);
2308 if ((nfd = accept(fd, (struct sockaddr *)&sun, &sz)) < 0) {
2309 if (errno != EINTR && errno != EAGAIN && errno != EWOULDBLOCK &&
2310 errno != ECONNABORTED && errno != EPROTO)
2311 a_warn("ADMIN", "accept-error", "?ERRNO", A_END);
2314 a_create(nfd, nfd, 0);
2317 /* --- @a_preselect@ --- *
2323 * Use: Informs the admin module that we're about to select again,
2324 * and that it should do cleanup things it has delayed until a
2328 void a_preselect(void) { if (a_dead) a_destroypending(); }
2330 /* --- @a_daemon@ --- *
2336 * Use: Informs the admin module that it's a daemon.
2339 void a_daemon(void) { flags |= F_DAEMON; }
2341 /* --- @a_init@ --- *
2343 * Arguments: @const char *name@ = socket name to create
2344 * @uid_t u@ = user to own the socket
2345 * @gid_t g@ = group to own the socket
2346 * @mode_t m@ = permissions to set on the socket
2350 * Use: Creates the admin listening socket.
2353 void a_init(const char *name, uid_t u, gid_t g, mode_t m)
2357 struct sockaddr_un sun;
2358 struct sigaction sa;
2362 /* --- Create services table --- */
2364 sym_create(&a_svcs);
2366 /* --- Set up the socket address --- */
2368 sz = strlen(name) + 1;
2369 if (sz > sizeof(sun.sun_path))
2370 die(EXIT_FAILURE, "socket name `%s' too long", name);
2372 sun.sun_family = AF_UNIX;
2373 memcpy(sun.sun_path, name, sz);
2374 sz += offsetof(struct sockaddr_un, sun_path);
2376 /* --- Attempt to bind to the socket --- */
2378 omask = umask(0077);
2380 if ((fd = socket(PF_UNIX, SOCK_STREAM, 0)) < 0)
2381 die(EXIT_FAILURE, "couldn't create socket: %s", strerror(errno));
2382 if (bind(fd, (struct sockaddr *)&sun, sz) < 0) {
2385 if (errno != EADDRINUSE) {
2386 die(EXIT_FAILURE, "couldn't bind to address `%s': %s",
2387 sun.sun_path, strerror(e));
2390 die(EXIT_FAILURE, "too many retries; giving up");
2392 if (!connect(fd, (struct sockaddr *)&sun, sz)) {
2393 die(EXIT_FAILURE, "server already listening on admin socket `%s'",
2396 if (errno != ECONNREFUSED)
2397 die(EXIT_FAILURE, "couldn't bind to address: %s", strerror(e));
2398 if (stat(sun.sun_path, &st)) {
2399 die(EXIT_FAILURE, "couldn't stat `%s': %s",
2400 sun.sun_path, strerror(errno));
2402 if (!S_ISSOCK(st.st_mode))
2403 die(EXIT_FAILURE, "object `%s' isn't a socket", sun.sun_path);
2404 T( trace(T_ADMIN, "admin: stale socket found; removing it"); )
2405 unlink(sun.sun_path);
2409 if (chown(sun.sun_path, u, g)) {
2410 die(EXIT_FAILURE, "failed to set socket owner: %s",
2413 if (chmod(sun.sun_path, m)) {
2414 die(EXIT_FAILURE, "failed to set socket permissions: %s",
2418 fdflags(fd, O_NONBLOCK, O_NONBLOCK, FD_CLOEXEC, FD_CLOEXEC);
2420 die(EXIT_FAILURE, "couldn't listen on socket: %s", strerror(errno));
2422 /* --- Listen to the socket --- */
2424 sel_initfile(&sel, &sock, fd, SEL_READ, a_accept, 0);
2428 T( trace_custom(a_trace, 0);
2429 trace(T_ADMIN, "admin: enabled custom tracing"); )
2432 /* --- Set up signal handlers --- */
2434 sig_add(&s_term, SIGTERM, a_sigdie, 0);
2435 sig_add(&s_hup, SIGHUP, a_sighup, 0);
2436 sigaction(SIGINT, 0, &sa);
2437 if (sa.sa_handler != SIG_IGN)
2438 sig_add(&s_int, SIGINT, a_sigdie, 0);
2441 /*----- That's all, folks -------------------------------------------------*/