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 switch (a->sa.sa_family) {
277 u_quotify(d, "INET");
278 u_quotify(d, inet_ntoa(a->sin.sin_addr));
279 dstr_putf(d, " %u", (unsigned)ntohs(a->sin.sin_port));
284 } else if (strcmp(fmt, "?B64") == 0) {
285 const octet *p = va_arg(*ap, const octet *);
286 size_t n = va_arg(*ap, size_t);
287 codec *b64 = base64_class.encoder(CDCF_NOEQPAD, "", 0);
289 b64->ops->code(b64, p, n, d);
290 b64->ops->code(b64, 0, 0, d);
291 b64->ops->destroy(b64);
292 } else if (strcmp(fmt, "?TOKENS") == 0) {
293 const char *const *av = va_arg(*ap, const char *const *);
294 while (*av) u_quotify(d, *av++);
295 } else if (strcmp(fmt, "?PEER") == 0)
296 u_quotify(d, p_name(va_arg(*ap, peer *)));
297 else if (strcmp(fmt, "?ERRNO") == 0) {
298 dstr_putf(d, " E%d", errno);
299 u_quotify(d, strerror(errno));
303 if (*fmt == '!') fmt++;
305 dstr_vputf(&dd, fmt, ap);
306 u_quotify(d, dd.buf);
308 fmt = va_arg(*ap, const char *);
315 /* --- @a_format@ --- *
317 * Arguments: @dstr *d@ = where to leave the formatted message
318 * @const char *fmt@ = pointer to format string
322 * Use: Writes a tokenized message into a string, for later
326 void a_format(dstr *d, const char *fmt, ...)
331 a_vformat(d, fmt, &ap);
335 /* --- @a_write@, @a_vwrite@ --- *
337 * Arguments: @admin *a@ = admin connection to write to
338 * @const char *status@ = status code to report
339 * @const char *tag@ = tag string, or null
340 * @const char *fmt@ = pointer to format string
341 * @va_list *ap@ = arguments in list
342 * @...@ = other arguments
346 * Use: Sends a message to an admin connection.
349 static void a_vwrite(admin *a, const char *status, const char *tag,
350 const char *fmt, va_list *ap)
354 if (tag) dstr_puts(&d, "BG");
355 dstr_puts(&d, status);
356 if (tag) u_quotify(&d, tag);
357 a_vformat(&d, fmt, ap);
359 dosend(a, d.buf, d.len);
363 static void a_write(admin *a, const char *status, const char *tag,
364 const char *fmt, ...)
369 a_vwrite(a, status, tag, fmt, &ap);
373 /* --- @a_ok@, @a_fail@ --- *
375 * Arguments: @admin *a@ = connection
376 * @const char *fmt@ = format string
377 * @...@ = other arguments
381 * Use: Convenience functions for @a_write@.
384 static void a_ok(admin *a) { a_write(a, "OK", 0, A_END); }
386 static void a_fail(admin *a, const char *fmt, ...)
391 a_vwrite(a, "FAIL", 0, fmt, &ap);
395 /* --- @a_info@ --- *
397 * Arguments: @admin *a@ = connection
398 * @const char *fmt@ = format string
399 * @...@ = other arguments
403 * Use: Report information to an admin client.
406 void a_info(admin *a, const char *fmt, ...)
411 a_vwrite(a, "INFO", 0, fmt, &ap);
415 /* --- @a_alert@, @a_valert@, @a_rawalert@ --- *
417 * Arguments: @unsigned f_and, f_eq@ = filter for connections
418 * @const char *status@ = status string
419 * @const char *fmt@ = pointer to format string
420 * @const char *p@ = pointer to raw string
421 * @size_t sz@ = size of raw string
422 * @va_list *ap@ = arguments in list
423 * @...@ = other arguments
427 * Use: Write a message to all admin connections matched by the given
431 static void a_rawalert(unsigned f_and, unsigned f_eq, const char *status,
432 const char *p, size_t sz)
437 if (!(flags & F_INIT))
439 dstr_puts(&d, status);
442 dstr_putm(&d, p, sz);
447 for (a = admins; a; a = aa) {
449 if ((a->f & f_and) == f_eq)
450 dosend(a, d.buf, d.len);
455 static void a_valert(unsigned f_and, unsigned f_eq, const char *status,
456 const char *fmt, va_list *ap)
460 if (!(flags & F_INIT))
462 a_vformat(&d, fmt, ap);
463 a_rawalert(f_and, f_eq, status, fmt ? d.buf : 0, fmt ? d.len : 0);
467 static void a_alert(unsigned f_and, unsigned f_eq, const char *status,
468 const char *fmt, ...)
473 a_valert(f_and, f_eq, status, fmt, &ap);
477 /* --- @a_warn@ --- *
479 * Arguments: @const char *fmt@ = pointer to format string
480 * @...@ = other arguments
484 * Use: Informs all admin connections of a warning.
487 void a_warn(const char *fmt, ...)
493 a_valert(0, 0, "WARN", fmt, &ap);
496 fprintf(stderr, "%s: ", QUIS);
497 a_vformat(&d, fmt, &ap);
499 dstr_write(&d, stderr);
505 /* --- @a_trace@ --- *
507 * Arguments: @const char *p@ = pointer to a buffer
508 * @size_t sz@ = size of the buffer
509 * @void *v@ = uninteresting pointer
513 * Use: Custom trace output handler. Sends trace messages to
514 * interested admin connections.
518 static void a_trace(const char *p, size_t sz, void *v)
519 { a_rawalert(AF_TRACE, AF_TRACE, "TRACE", p, sz); }
522 /* --- @a_notify@ --- *
524 * Arguments: @const char *fmt@ = pointer to format string
525 * @...@ = other arguments
529 * Use: Sends a notification to interested admin connections.
532 void a_notify(const char *fmt, ...)
537 a_valert(AF_NOTE, AF_NOTE, "NOTE", fmt, &ap);
541 /* --- @a_quit@ --- *
547 * Use: Shuts things down nicely.
554 FOREACH_PEER(p, { p_destroy(p); });
559 /* --- @a_sigdie@ --- *
561 * Arguments: @int sig@ = signal number
562 * @void *v@ = an uninteresting argument
566 * Use Shuts down on receipt of a fatal signal.
569 static void a_sigdie(int sig, void *v)
575 case SIGTERM: p = "SIGTERM"; break;
576 case SIGINT: p = "SIGINT"; break;
578 sprintf(buf, "%i", sig);
582 a_warn("SERVER", "quit", "signal", "%s", p, A_END);
586 /* --- @a_sighup@ --- *
588 * Arguments: @int sig@ = signal number
589 * @void *v@ = an uninteresting argument
593 * Use Logs a message about SIGHUP not being useful.
596 static void a_sighup(int sig, void *v)
597 { a_warn("SERVER", "ignore", "signal", "SIGHUP", A_END); }
599 /* --- @a_parsetime@ --- *
601 * Arguments; @const char *p@ = time string to parse
603 * Returns: Time in seconds, or @< 0@ on error.
606 static long a_parsetime(const char *p)
609 long t = strtol(p, &q, 0);
615 case 's': if (q[1] != 0)
622 /* --- @a_findpeer@ --- *
624 * Arguments: @admin *a@ = admin connection
625 * @const char *pn@ = peer name
627 * Returns: The peer, or null if not there.
629 * Use: Finds a peer, reporting an error if it failed.
632 static peer *a_findpeer(admin *a, const char *pn)
636 if ((p = p_find(pn)) == 0)
637 a_fail(a, "unknown-peer", "%s", pn, A_END);
641 /*----- Backgrounded operations -------------------------------------------*/
644 (((admin_bgop *)(bg))->tag ? ((admin_bgop *)(bg))->tag : "<foreground>")
646 /* --- @a_bgfind@ --- *
648 * Arguments: @admin *a@ = a client block
649 * @const char *tag@ = the requested tag
651 * Returns: The requested background job, or null.
654 static admin_bgop *a_bgfind(admin *a, const char *tag)
658 for (bg = a->bg; bg; bg = bg->next) {
659 if (bg->tag && strcmp(tag, bg->tag) == 0)
665 /* --- @a_bgrelease@ --- *
667 * Arguments: @admin_bgop *bg@ = backgrounded operation
671 * Use: Removes a backgrounded operation from the queue, since
672 * (presumably) it's done.
675 static void a_bgrelease(admin_bgop *bg)
679 T( trace(T_ADMIN, "admin: release bgop %s", BGTAG(bg)); )
680 if (bg->tag) xfree(bg->tag);
681 else selbuf_enable(&a->b);
682 if (bg->next) bg->next->prev = bg->prev;
683 if (bg->prev) bg->prev->next = bg->next;
684 else a->bg = bg->next;
686 if (!a->bg && (a->f & AF_CLOSE)) a_destroy(a);
689 /* --- @a_bgok@, @a_bginfo@, @a_bgfail@ --- *
691 * Arguments: @admin_bgop *bg@ = backgrounded operation
692 * @const char *fmt@ = format string
693 * @...@ = other arguments
697 * Use: Convenience functions for @a_write@.
700 static void a_bgok(admin_bgop *bg)
701 { a_write(bg->a, "OK", bg->tag, A_END); }
703 static void a_bginfo(admin_bgop *bg, const char *fmt, ...)
707 a_vwrite(bg->a, "INFO", bg->tag, fmt, &ap);
711 static void a_bgfail(admin_bgop *bg, const char *fmt, ...)
715 a_vwrite(bg->a, "FAIL", bg->tag, fmt, &ap);
719 /* --- @a_bgadd@ --- *
721 * Arguments: @admin *a@ = administration connection
722 * @admin_bgop *bg@ = pointer to background operation
723 * @const char *tag@ = background tag, or null for foreground
724 * @void (*cancel)(admin_bgop *)@ = cancel function
726 * Returns: Zero for success, nonzero on failure.
728 * Use: Links a background job into the list.
731 static int a_bgadd(admin *a, admin_bgop *bg, const char *tag,
732 void (*cancel)(admin_bgop *))
735 if (a_bgfind(a, tag)) {
736 a_fail(a, "tag-exists", "%s", tag, A_END);
739 bg->tag = xstrdup(tag);
743 selbuf_disable(&a->b);
749 if (a->bg) a->bg->prev = bg;
751 T( trace(T_ADMIN, "admin: add bgop %s", BGTAG(bg)); )
752 if (tag) a_write(a, "DETACH", tag, A_END);
756 /*----- Job table manipulation --------------------------------------------*/
759 #define JOB_INDEXMASK ((1ul << JOB_SHIFT) - 1)
760 #define JOB_SEQMASK ((1ul << (32 - JOB_SHIFT)) - 1)
762 #define JOB_END 0xfffffffful
764 static unsigned long a_joboffset;
766 /* --- @a_jobidencode@ --- *
768 * Arguments: @admin_svcop *svc@ = pointer to a service operation
770 * Returns: A jobid for this job, in an internal static buffer.
772 * Use: Constructs a jobid. In order to dissuade people from
773 * predicting jobids, we obfuscate them.
775 * A `raw' jobid consists of two 16-bit fields. The low 16 bits
776 * are an index into a big array. The high 16 bits are a
777 * sequence number recording how many times that slot has been
780 * This `raw' jobid is then obfuscated by adding a randomly-
781 * generated offset, and multiplying (mod %$2^{32}$%) by a fixed
785 static const char *a_jobidencode(admin_svcop *svc)
787 admin_jobtable *j = &svc->prov->j;
792 assert(svc->index <= JOB_INDEXMASK);
793 seq = j->v[svc->index].seq;
794 assert(seq <= JOB_SEQMASK);
795 pre = (unsigned long)svc->index | ((unsigned long)seq << JOB_SHIFT);
796 sprintf(buf, "J%08lx", ((pre + a_joboffset) * 0x0f87a7a3ul) & 0xffffffff);
800 /* --- @a_jobiddecode@ --- *
802 * Arguments: @admin_jobtable *j@ = pointer to a job table
803 * @const char *jid@ = pointer to a jobid string
805 * Returns: A pointer to the job's @svcop@ structure.
808 static admin_svcop *a_jobiddecode(admin_jobtable *j, const char *jid)
815 for (i = 1; i < 9; i++) {
816 if (!isxdigit((unsigned char)jid[i]))
821 pre = strtoul(jid + 1, 0, 16);
822 pre = ((pre * 0xbd11c40bul) - a_joboffset) & 0xffffffff;
823 i = pre & JOB_INDEXMASK;
824 if (i >= j->n || j->v[i].seq != (pre >> JOB_SHIFT))
826 return (j->v[i].u.op);
829 /* --- @a_jobcreate@ --- *
831 * Arguments: @admin *a@ = pointer to administration client
833 * Returns: A pointer to a freshly-allocated @svcop@, or null.
835 * Use: Allocates a fresh @svcop@ and links it into a job table.
838 static admin_svcop *a_jobcreate(admin *a)
843 admin_jobtable *j = &a->j;
845 if (j->free != JOB_END) {
847 j->free = j->v[i].u.next;
850 if (j->sz > JOB_INDEXMASK)
855 j->v = xmalloc(j->sz * sizeof(*j->v));
858 j->v = xrealloc(j->v, j->sz * sizeof(*j->v), sz * sizeof(*j->v));
864 svc = xmalloc(sizeof(*svc));
867 svc->next = j->active;
869 if (j->active) j->active->prev = svc;
872 IF_TRACING(T_ADMIN, {
873 trace(T_ADMIN, "admin: created job %s (%u)", a_jobidencode(svc), i);
878 /* --- @a_jobdestroy@ --- *
880 * Arguments: @admin_svcop *svc@ = pointer to job block
884 * Use: Frees up a completed (or cancelled) job.
887 static void a_jobdestroy(admin_svcop *svc)
889 admin *a = svc->prov;
890 admin_jobtable *j = &a->j;
891 unsigned i = svc->index;
893 IF_TRACING(T_ADMIN, {
894 trace(T_ADMIN, "admin: destroying job %s (%u)", a_jobidencode(svc), i);
896 assert(j->v[i].u.op = svc);
897 j->v[i].u.next = j->free;
900 if (svc->next) svc->next->prev = svc->prev;
901 if (svc->prev) svc->prev->next = svc->next;
902 else j->active = svc->next;
905 /* --- @a_jobtableinit@ --- *
907 * Arguments: @admin_jobtable *j@ = pointer to job table
911 * Use: Initializes a job table.
914 static void a_jobtableinit(admin_jobtable *j)
917 a_joboffset = GR_RANGE(&rand_global, 0xffffffff) + 1;
924 /* --- @a_jobtablefinal@ --- *
926 * Arguments: @admin_jobtable *j@ = pointer to job table
930 * Use: Closes down a job table.
933 static void a_jobtablefinal(admin_jobtable *j)
935 admin_svcop *svc, *ssvc;
937 for (svc = j->active; svc; svc = ssvc) {
939 a_bgfail(&svc->bg, "provider-failed", A_END);
940 a_bgrelease(&svc->bg);
942 if (j->v) xfree(j->v);
945 /*----- Services infrastructure -------------------------------------------*/
947 /* --- @a_svcfind@ --- *
949 * Arguments: @admin *a@ = the requesting client
950 * @const char *name@ = service name wanted
952 * Returns: The service requested, or null.
954 * Use: Finds a service; reports an error if the service couldn't be
958 static admin_service *a_svcfind(admin *a, const char *name)
962 if ((svc = sym_find(&a_svcs, name, -1, 0, 0)) == 0) {
963 a_fail(a, "unknown-service", "%s", name, A_END);
969 /* --- @a_svcunlink@ --- *
971 * Arguments: @admin_service *svc@ = pointer to service structure
975 * Use: Unlinks the service from its provider, without issuing a
976 * message or freeing the structure. The version string is
980 static void a_svcunlink(admin_service *svc)
983 svc->next->prev = svc->prev;
985 svc->prev->next = svc->next;
987 svc->prov->svcs = svc->next;
991 /* --- @a_svcrelease@ --- *
993 * Arguments: @admin_service *svc@ = pointer to service structure
997 * Use: Releases a service and frees its structure.
1000 static void a_svcrelease(admin_service *svc)
1002 a_notify("SVCRELEASE", "%s", SYM_NAME(svc), A_END);
1004 sym_remove(&a_svcs, svc);
1007 /*----- Name resolution operations ----------------------------------------*/
1009 /* --- @a_resolved@ --- *
1011 * Arguments: @struct hostent *h@ = pointer to resolved hostname
1012 * @void *v@ = pointer to resolver operation
1016 * Use: Handles a completed name resolution.
1019 static void a_resolved(struct hostent *h, void *v)
1025 T( trace(T_ADMIN, "admin: resop %s failed: %s",
1026 BGTAG(r), hstrerror(h_errno)); )
1027 a_bgfail(&r->bg, "resolve-error", "%s", r->addr, A_END);
1028 r->func(r, ARES_FAIL);
1030 T( trace(T_ADMIN, "admin: resop %s ok", BGTAG(r)); )
1031 r->sa.sin.sin_family = AF_INET;
1032 memcpy(&r->sa.sin.sin_addr, h->h_addr, sizeof(struct in_addr));
1033 setport(&r->sa, r->port);
1034 r->func(r, ARES_OK);
1038 a_bgrelease(&r->bg);
1041 /* --- @a_restimer@ --- *
1043 * Arguments: @struct timeval *tv@ = timer
1044 * @void *v@ = pointer to resolver operation
1048 * Use: Times out a resolver.
1051 static void a_restimer(struct timeval *tv, void *v)
1055 T( trace(T_ADMIN, "admin: resop %s timeout", BGTAG(r)); )
1056 a_bgfail(&r->bg, "resolver-timeout", "%s", r->addr, A_END);
1057 r->func(r, ARES_FAIL);
1060 a_bgrelease(&r->bg);
1063 /* --- @a_rescancel@ --- *
1065 * Arguments: @admin_bgop *bg@ = background operation
1069 * Use: Cancels an add operation.
1072 static void a_rescancel(admin_bgop *bg)
1074 admin_resop *r = (admin_resop *)bg;
1076 T( trace(T_ADMIN, "admin: cancel resop %s", BGTAG(r)); )
1077 r->func(r, ARES_FAIL);
1083 /* --- @a_resolve@ --- *
1085 * Arguments: @admin *a@ = administration connection
1086 * @admin_resop *r@ = resolver operation to run
1087 * @const char *tag@ = background operation tag
1088 * @void (*func)(struct admin_resop *, int@ = handler function
1089 * @unsigned ac@ = number of remaining arguments
1090 * @char *av[]@ = pointer to remaining arguments
1094 * Use: Cranks up a resolver job.
1097 static void a_resolve(admin *a, admin_resop *r, const char *tag,
1098 void (*func)(struct admin_resop *, int),
1099 unsigned ac, char *av[])
1106 /* --- Fill in the easy bits of address --- */
1108 r->bg.tag = "<starting>";
1111 if (mystrieq(av[i], "inet")) i++;
1112 if (ac - i != 1 && ac - i != 2) {
1113 a_fail(a, "bad-addr-syntax", "[inet] ADDRESS [PORT]", A_END);
1116 r->addr = xstrdup(av[i]);
1120 pt = strtoul(av[i + 1], &p, 0);
1122 struct servent *s = getservbyname(av[i + 1], "udp");
1124 a_fail(a, "unknown-service", "%s", av[i + 1], A_END);
1127 pt = ntohs(s->s_port);
1130 if (pt == 0 || pt >= 65536) {
1131 a_fail(a, "invalid-port", "%lu", pt, A_END);
1136 /* --- Report backgrounding --- *
1138 * Do this for consistency of interface, even if we're going to get the
1139 * answer straight away.
1142 if (a_bgadd(a, &r->bg, tag, a_rescancel))
1144 T( trace(T_ADMIN, "admin: %u, resop %s, hostname `%s'",
1145 a->seq, BGTAG(r), r->addr); )
1147 /* --- If the name is numeric, do it the easy way --- */
1149 if (inet_aton(av[i], &r->sa.sin.sin_addr)) {
1150 T( trace(T_ADMIN, "admin: resop %s done the easy way", BGTAG(r)); )
1151 r->sa.sin.sin_family = AF_INET;
1152 setport(&r->sa, r->port);
1155 a_bgrelease(&r->bg);
1159 /* --- Store everything for later and crank up the resolver --- */
1161 gettimeofday(&tv, 0);
1162 tv.tv_sec += T_RESOLVE;
1163 sel_addtimer(&sel, &r->t, &tv, a_restimer, r);
1164 bres_byname(&r->r, r->addr, a_resolved, r);
1169 if (r->addr) xfree(r->addr);
1173 /*----- Option parsing ----------------------------------------------------*/
1175 #define OPTIONS(argc, argv, guts) do { \
1176 char **o_av = argv; \
1180 if (mystrieq(*o_av, "--")) { \
1185 if (**o_av == '-') \
1189 argc -= o_av - argv; \
1193 #define OPT(name, guts) if (mystrieq(*o_av, name)) { guts continue; }
1195 #define OPTARG(name, arg, guts) OPT(name, { \
1198 if (!arg) goto bad_syntax; \
1202 #define OPTTIME(name, arg, guts) OPTARG(name, o_arg, { \
1204 if ((arg = a_parsetime(o_arg)) < 0) { \
1205 a_fail(a, "bad-time-spec", "%s", o_arg, A_END); \
1211 /*----- Adding peers ------------------------------------------------------*/
1213 /* --- @a_doadd@ --- *
1215 * Arguments: @admin_resop *r@ = resolver operation
1216 * @int rc@ = how it worked
1220 * Use: Handles a completed resolution.
1223 static void a_doadd(admin_resop *r, int rc)
1225 admin_addop *add = (admin_addop *)r;
1227 T( trace(T_ADMIN, "admin: done add op %s", BGTAG(add)); )
1229 if (rc == ARES_OK) {
1230 add->peer.sa = add->r.sa;
1231 if (p_findbyaddr(&add->r.sa))
1232 a_bgfail(&add->r.bg, "peer-addr-exists", "?ADDR", &add->r.sa, A_END);
1233 else if (p_find(add->peer.name))
1234 a_bgfail(&add->r.bg, "peer-exists", "%s", add->peer.name, A_END);
1235 else if (!p_create(&add->peer))
1236 a_bgfail(&add->r.bg, "peer-create-fail", "%s", add->peer.name, A_END);
1241 if (add->peer.tag) xfree(add->peer.tag);
1242 if (add->peer.privtag) xfree(add->peer.privtag);
1243 xfree(add->peer.name);
1246 /* --- @acmd_add@ --- *
1248 * Arguments: @admin *a@ = connection which requested the addition
1249 * @unsigned ac@ = argument count
1250 * @char *av[]@ = pointer to the argument list
1254 * Use: Adds a new peer.
1257 static void acmd_add(admin *a, unsigned ac, char *av[])
1259 const char *tag = 0;
1262 /* --- Set stuff up --- */
1264 add = xmalloc(sizeof(*add));
1267 add->peer.privtag = 0;
1269 add->peer.tops = tun_default;
1272 /* --- Parse options --- */
1275 OPTARG("-background", arg, { tag = arg; })
1276 OPTARG("-tunnel", arg, {
1280 a_fail(a, "unknown-tunnel", "%s", arg, A_END);
1283 if (mystrieq(arg, tunnels[i]->name)) {
1284 add->peer.tops = tunnels[i];
1289 OPTTIME("-keepalive", t, { add->peer.t_ka = t; })
1290 OPT("-cork", { add->peer.f |= KXF_CORK; })
1291 OPTARG("-key", arg, {
1292 if (add->peer.tag) xfree(add->peer.tag);
1293 add->peer.tag = xstrdup(arg);
1295 OPT("-mobile", { add->peer.f |= PSF_MOBILE; })
1296 OPTARG("-priv", arg, {
1297 if (add->peer.privtag) xfree(add->peer.privtag);
1298 add->peer.privtag = xstrdup(arg);
1302 /* --- Make sure someone's not got there already --- */
1304 if (!av[0] || !av[1])
1307 a_fail(a, "peer-exists", "%s", *av, A_END);
1310 add->peer.name = xstrdup(*av++);
1313 /* --- Crank up the resolver --- */
1315 a_resolve(a, &add->r, tag, a_doadd, ac, av);
1318 /* --- Clearing up --- */
1321 a_fail(a, "bad-syntax", "add", "[OPTIONS] PEER ADDR ...", A_END);
1323 if (add->peer.name) xfree(add->peer.name);
1324 if (add->peer.tag) xfree(add->peer.tag);
1325 if (add->peer.privtag) xfree(add->peer.privtag);
1330 /*----- Ping --------------------------------------------------------------*/
1332 /* --- @a_pingcancel@ --- *
1334 * Arguments: @admin_bgop *bg@ = background operation block
1338 * Use: Cancels a running ping.
1341 static void a_pingcancel(admin_bgop *bg)
1343 admin_pingop *pg = (admin_pingop *)bg;
1344 T( trace(T_ADMIN, "admin: cancel ping op %s", BGTAG(pg)); )
1345 p_pingdone(&pg->ping, PING_NONOTIFY);
1348 /* --- @a_pong@ --- *
1350 * Arguments: @int rc@ = return code
1351 * @void *v@ = ping operation block
1355 * Use: Collects what happened to a ping message.
1358 static void a_pong(int rc, void *v)
1360 admin_pingop *pg = v;
1366 gettimeofday(&tv, 0);
1367 tv_sub(&tv, &tv, &pg->pingtime);
1368 millis = (double)tv.tv_sec * 1000 + (double)tv.tv_usec/1000;
1369 a_bginfo(&pg->bg, "ping-ok", "%.1f", millis, A_END);
1373 a_bginfo(&pg->bg, "ping-timeout", A_END);
1377 a_bginfo(&pg->bg, "ping-peer-died", A_END);
1383 T( trace(T_ADMIN, "admin: ponged ping op %s", BGTAG(pg)); )
1384 a_bgrelease(&pg->bg);
1387 /* --- @acmd_ping@, @acmd_eping@ --- *
1389 * Arguments: @admin *a@ = connection which requested the ping
1390 * @unsigned ac@ = argument count
1391 * @char *av[]@ = pointer to the argument list
1395 * Use: Pings a peer.
1398 static void a_ping(admin *a, unsigned ac, char *av[],
1399 const char *cmd, unsigned msg)
1403 admin_pingop *pg = 0;
1404 const char *tag = 0;
1407 OPTARG("-background", arg, { tag = arg; })
1408 OPTTIME("-timeout", arg, { t = arg; })
1410 if (!*av || av[1]) goto bad_syntax;
1411 if ((p = a_findpeer(a, *av)) == 0)
1413 pg = xmalloc(sizeof(*pg));
1414 gettimeofday(&pg->pingtime, 0);
1415 if (a_bgadd(a, &pg->bg, tag, a_pingcancel))
1417 T( trace(T_ADMIN, "admin: ping op %s: %s to %s",
1418 BGTAG(pg), cmd, p_name(p)); )
1419 if (p_pingsend(p, &pg->ping, msg, t, a_pong, pg)) {
1420 a_bgfail(&pg->bg, "ping-send-failed", A_END);
1421 a_bgrelease(&pg->bg);
1426 a_fail(a, "bad-syntax", "%s", cmd, "[OPTIONS] PEER", cmd, A_END);
1432 static void acmd_ping(admin *a, unsigned ac, char *av[])
1433 { a_ping(a, ac, av, "ping", MISC_PING); }
1434 static void acmd_eping(admin *a, unsigned ac, char *av[])
1435 { a_ping(a, ac, av, "eping", MISC_EPING); }
1437 /*----- Service commands --------------------------------------------------*/
1439 static void acmd_svcclaim(admin *a, unsigned ac, char *av[])
1444 svc = sym_find(&a_svcs, av[0], -1, sizeof(*svc), &f);
1446 if (versioncmp(av[1], svc->version) <= 0) {
1449 "%s", SYM_NAME(svc),
1454 a_write(svc->prov, "SVCCLAIM", 0, "%s", av[0], "%s", av[1], A_END);
1458 svc->version = xstrdup(av[1]);
1459 svc->next = a->svcs;
1461 if (a->svcs) a->svcs->prev = svc;
1463 a_notify("SVCCLAIM", "%s", SYM_NAME(svc), "%s", svc->version, A_END);
1467 static void acmd_svcrelease(admin *a, unsigned ac, char *av[])
1471 if ((svc = a_svcfind(a, av[0])) == 0)
1473 if (svc->prov != a) {
1474 a_fail(a, "not-service-provider", "%s", SYM_NAME(svc), A_END);
1481 static void acmd_svcensure(admin *a, unsigned ac, char *av[])
1485 if ((svc = a_svcfind(a, av[0])) == 0)
1487 if (av[1] && versioncmp(svc->version, av[1]) < 0) {
1488 a_fail(a, "service-too-old",
1489 "%s", SYM_NAME(svc),
1497 static void acmd_svcquery(admin *a, unsigned ac, char *av[])
1501 if ((svc = a_svcfind(a, av[0])) != 0) {
1502 a_info(a, "name=%s", SYM_NAME(svc), "version=%s", svc->version, A_END);
1507 static void acmd_svclist(admin *a, unsigned ac, char *av[])
1512 for (sym_mkiter(&i, &a_svcs); (svc = sym_next(&i)) != 0; )
1513 a_info(a, "%s", SYM_NAME(svc), "%s", svc->version, A_END);
1517 static void a_canceljob(admin_bgop *bg)
1519 admin_svcop *svc = (admin_svcop *)bg;
1521 a_write(svc->prov, "SVCCANCEL", 0, "%s", a_jobidencode(svc), A_END);
1525 static void acmd_svcsubmit(admin *a, unsigned ac, char *av[])
1527 const char *tag = 0;
1530 const char *ver = 0;
1534 OPTARG("-background", arg, { tag = arg; })
1535 OPTARG("-version", arg, { ver = arg; })
1537 if (!*av) goto bad_syntax;
1538 if ((svc = a_svcfind(a, *av)) == 0) goto fail;
1539 if (ver && versioncmp(svc->version, ver) < 0) {
1540 a_fail(a, "service-too-old",
1541 "%s", SYM_NAME(svc),
1546 if ((svcop = a_jobcreate(svc->prov)) == 0) {
1547 a_fail(a, "provider-overloaded", A_END);
1550 if (a_bgadd(a, &svcop->bg, tag, a_canceljob)) {
1551 a_jobdestroy(svcop);
1554 a_write(svc->prov, "SVCJOB", 0,
1555 "%s", a_jobidencode(svcop),
1561 a_fail(a, "bad-syntax", "svcsubmit", "[OPTIONS] SERVICE ARGS...", A_END);
1568 static void a_replycmd(admin *a, const char *status, int donep, char *av[])
1572 if ((svc = a_jobiddecode(&a->j, av[0])) == 0) {
1573 a_fail(a, "unknown-jobid", av[0], A_END);
1576 a_write(svc->bg.a, status, svc->bg.tag, "?TOKENS", av + 1, A_END);
1579 a_bgrelease(&svc->bg);
1584 static void acmd_svcok(admin *a, unsigned ac, char *av[])
1585 { a_replycmd(a, "OK", 1, av); }
1586 static void acmd_svcinfo(admin *a, unsigned ac, char *av[])
1587 { a_replycmd(a, "INFO", 0, av); }
1588 static void acmd_svcfail(admin *a, unsigned ac, char *av[])
1589 { a_replycmd(a, "FAIL", 1, av); }
1591 /*----- Administration commands -------------------------------------------*/
1593 /* --- Miscellaneous commands --- */
1595 /* --- @traceish@ --- *
1597 * Arguments: @admin *a@ = connection to complain on
1598 * @unsigned ac@ = number of arguments
1599 * @char *av[]@ = vector of arguments
1600 * @const char *what@ = what we're messing with
1601 * @const trace_opt *tt@ = options table
1602 * @unsigned *ff@ = where the flags are
1604 * Returns: Nonzero if anything changed.
1606 * Use: Guts of trace-ish commands like `trace' and `watch'.
1609 static int traceish(admin *a, unsigned ac, char *av[],
1610 const char *what, const trace_opt *tt, unsigned *ff)
1614 if (!ac || strcmp(av[0], "?") == 0) {
1616 for (t = tt; t->ch; t++) {
1617 a_info(a, "*%c%c %s",
1618 t->ch, (*ff & t->f) == t->f ? '+' : ' ', t->help, A_END);
1628 case '+': sense = 1; break;
1629 case '-': sense = 0; break;
1631 for (t = tt; t->ch; t++) {
1633 if (sense) f |= t->f;
1638 a_fail(a, "bad-%s-option", what, "%c", *p, A_END);
1654 static void acmd_trace(admin *a, unsigned ac, char *av[])
1656 if (traceish(a, ac, av, "trace", tr_opts, &tr_flags))
1657 trace_level(tr_flags);
1662 static void acmd_watch(admin *a, unsigned ac, char *av[])
1663 { traceish(a, ac, av, "watch", w_opts, &a->f); }
1665 static void alertcmd(admin *a, unsigned f_and, unsigned f_eq,
1666 const char *status, char *av[])
1667 { a_alert(f_and, f_eq, status, "USER", "?TOKENS", av, A_END); a_ok(a); }
1668 static void acmd_notify(admin *a, unsigned ac, char *av[])
1669 { alertcmd(a, AF_NOTE, AF_NOTE, "NOTE", av); }
1670 static void acmd_warn(admin *a, unsigned ac, char *av[])
1671 { alertcmd(a, AF_WARN, AF_WARN, "WARN", av); }
1673 static void acmd_port(admin *a, unsigned ac, char *av[])
1678 for (i = 0; i < NADDRFAM; i++)
1679 if (mystrieq(av[0], aftab[i].name)) goto found;
1680 a_fail(a, "unknown-address-family", "%s", av[0], A_END);
1683 assert(udpsock[i].fd >= 0);
1685 for (i = 0; i < NADDRFAM; i++)
1686 if (udpsock[i].fd >= 0) goto found;
1689 a_info(a, "%u", p_port(i), A_END);
1693 static void acmd_daemon(admin *a, unsigned ac, char *av[])
1695 if (flags & F_DAEMON)
1696 a_fail(a, "already-daemon", A_END);
1698 a_notify("DAEMON", A_END);
1702 a_fail(a, "daemon-error", "?ERRNO", A_END);
1710 static void acmd_jobs(admin *a, unsigned ac, char *av[])
1714 for (bg = a->bg; bg; bg = bg->next) {
1716 a_info(a, "%s", bg->tag, A_END);
1721 static void acmd_bgcancel(admin *a, unsigned ac, char *av[])
1725 if ((bg = a_bgfind(a, av[0])) == 0)
1726 a_fail(a, "unknown-tag", "%s", av[0], A_END);
1734 static void acmd_algs(admin *a, unsigned ac, char *av[])
1739 const algswitch *algs;
1744 if ((p = a_findpeer(a, av[0])) == 0) return;
1750 g->ops->grpinfo(g, a);
1752 "hash=%s", algs->h->name,
1753 "mgf=%s", algs->mgf->name,
1754 "hash-sz=%lu", (unsigned long)algs->h->hashsz,
1757 "bulk-transform=%s", algs->bulk->ops->name,
1758 "bulk-overhead=%lu",
1759 (unsigned long)algs->bulk->ops->overhead(algs->bulk),
1761 algs->bulk->ops->alginfo(algs->bulk, a);
1763 "cipher-data-limit=%lu",
1764 (unsigned long)algs->bulk->ops->expsz(algs->bulk),
1769 static void acmd_list(admin *a, unsigned ac, char *av[])
1771 FOREACH_PEER(p, { a_info(a, "%s", p_name(p), A_END); });
1775 static void acmd_ifname(admin *a, unsigned ac, char *av[])
1779 if ((p = a_findpeer(a, av[0])) != 0) {
1780 a_info(a, "%s", p_ifname(p), A_END);
1785 static void acmd_setifname(admin *a, unsigned ac, char *av[])
1789 if ((p = a_findpeer(a, av[0])) != 0) {
1790 a_notify("NEWIFNAME", "?PEER", p, "%s", p_ifname(p), "%s", av[1], A_END);
1791 p_setifname(p, av[1]);
1796 static void acmd_getchal(admin *a, unsigned ac, char *av[])
1800 buf_init(&b, buf_i, PKBUFSZ);
1802 a_info(a, "?B64", BBASE(&b), (size_t)BLEN(&b), A_END);
1806 static void acmd_checkchal(admin *a, unsigned ac, char *av[])
1808 codec *b64 = base64_class.decoder(CDCF_NOEQPAD);
1813 if ((err = b64->ops->code(b64, av[0], strlen(av[0]), &d)) != 0 ||
1814 (err = b64->ops->code(b64, 0, 0, &d)) != 0)
1815 a_fail(a, "bad-base64", "%s", codec_strerror(err), A_END);
1817 buf_init(&b, d.buf, d.len);
1818 if (c_check(&b) || BBAD(&b) || BLEFT(&b))
1819 a_fail(a, "invalid-challenge", A_END);
1823 b64->ops->destroy(b64);
1827 static void acmd_greet(admin *a, unsigned ac, char *av[])
1834 if ((p = a_findpeer(a, av[0])) == 0) return;
1835 b64 = base64_class.decoder(CDCF_NOEQPAD);
1836 if ((err = b64->ops->code(b64, av[1], strlen(av[1]), &d)) != 0 ||
1837 (err = b64->ops->code(b64, 0, 0, &d)) != 0)
1838 a_fail(a, "bad-base64", "%s", codec_strerror(err), A_END);
1840 p_greet(p, d.buf, d.len);
1843 b64->ops->destroy(b64);
1847 static void acmd_addr(admin *a, unsigned ac, char *av[])
1852 if ((p = a_findpeer(a, av[0])) != 0) {
1854 a_info(a, "?ADDR", ad, A_END);
1859 static void acmd_peerinfo(admin *a, unsigned ac, char *av[])
1865 if ((p = a_findpeer(a, av[0])) != 0) {
1867 a_info(a, "tunnel=%s", ps->tops->name, A_END);
1868 a_info(a, "key=%s", p_tag(p),
1869 "current-key=%s", p->kx.kpub->tag, A_END);
1870 if ((ptag = p_privtag(p)) == 0) ptag = "(default)";
1871 a_info(a, "private-key=%s", ptag,
1872 "current-private-key=%s", p->kx.kpriv->tag, A_END);
1873 a_info(a, "keepalive=%lu", ps->t_ka, A_END);
1874 a_info(a, "corked=%s", BOOL(p->kx.f&KXF_CORK),
1875 "mobile=%s", BOOL(ps->f&PSF_MOBILE),
1881 static void acmd_servinfo(admin *a, unsigned ac, char *av[])
1883 a_info(a, "implementation=edgeware-tripe", A_END);
1884 a_info(a, "version=%s", VERSION, A_END);
1885 a_info(a, "daemon=%s", BOOL(flags & F_DAEMON), A_END);
1889 static void acmd_stats(admin *a, unsigned ac, char *av[])
1894 if ((p = a_findpeer(a, av[0])) == 0)
1898 a_info(a, "start-time=%s", timestr(st->t_start), A_END);
1899 a_info(a, "last-packet-time=%s", timestr(st->t_last), A_END);
1900 a_info(a, "last-keyexch-time=%s", timestr(st->t_kx), A_END);
1901 a_info(a, "packets-in=%lu", st->n_in, "bytes-in=%lu", st->sz_in, A_END);
1903 "packets-out=%lu", st->n_out,
1904 "bytes-out=%lu", st->sz_out,
1907 "keyexch-packets-in=%lu", st->n_kxin,
1908 "keyexch-bytes-in=%lu", st->sz_kxin,
1911 "keyexch-packets-out=%lu", st->n_kxout,
1912 "keyexch-bytes-out=%lu", st->sz_kxout,
1915 "ip-packets-in=%lu", st->n_ipin,
1916 "ip-bytes-in=%lu", st->sz_ipin,
1919 "ip-packets-out=%lu", st->n_ipout,
1920 "ip-bytes-out=%lu", st->sz_ipout,
1922 a_info(a, "rejected-packets=%lu", st->n_reject, A_END);
1926 static void acmd_kill(admin *a, unsigned ac, char *av[])
1930 if ((p = a_findpeer(a, av[0])) != 0) {
1936 static void acmd_forcekx(admin *a, unsigned ac, char *av[])
1940 if ((p = a_findpeer(a, av[0])) != 0) {
1941 kx_start(&p->kx, 1);
1946 static void acmd_reload(admin *a, unsigned ac, char *av[])
1947 { p_keyreload(); a_ok(a); }
1949 static void acmd_quit(admin *a, unsigned ac, char *av[])
1951 a_warn("SERVER", "quit", "admin-request", A_END);
1956 static void acmd_version(admin *a, unsigned ac, char *av[])
1958 a_info(a, "%s", PACKAGE, "%s", VERSION, A_END);
1962 static void acmd_tunnels(admin *a, unsigned ac, char *av[])
1966 for (i = 0; tunnels[i]; i++)
1967 a_info(a, "%s", tunnels[i]->name, A_END);
1971 /* --- The command table and help --- */
1973 typedef struct acmd {
1976 unsigned argmin, argmax;
1977 void (*func)(admin */*a*/, unsigned /*ac*/, char */*av*/[]);
1980 static void acmd_help(admin */*a*/, unsigned /*ac*/, char */*av*/[]);
1982 static const acmd acmdtab[] = {
1983 { "add", "[OPTIONS] PEER ADDR ...", 2, 0xffff, acmd_add },
1984 { "addr", "PEER", 1, 1, acmd_addr },
1985 { "algs", "[PEER]", 0, 1, acmd_algs },
1986 { "bgcancel", "TAG", 1, 1, acmd_bgcancel },
1987 { "checkchal", "CHAL", 1, 1, acmd_checkchal },
1988 { "daemon", 0, 0, 0, acmd_daemon },
1989 { "eping", "[OPTIONS] PEER", 1, 0xffff, acmd_eping },
1990 { "forcekx", "PEER", 1, 1, acmd_forcekx },
1991 { "getchal", 0, 0, 0, acmd_getchal },
1992 { "greet", "PEER CHAL", 2, 2, acmd_greet },
1993 { "help", 0, 0, 0, acmd_help },
1994 { "ifname", "PEER", 1, 1, acmd_ifname },
1995 { "jobs", 0, 0, 0, acmd_jobs },
1996 { "kill", "PEER", 1, 1, acmd_kill },
1997 { "list", 0, 0, 0, acmd_list },
1998 { "notify", "MESSAGE ...", 1, 0xffff, acmd_notify },
1999 { "peerinfo", "PEER", 1, 1, acmd_peerinfo },
2000 { "ping", "[OPTIONS] PEER", 1, 0xffff, acmd_ping },
2001 { "port", "[FAMILY]", 0, 1, acmd_port },
2002 { "quit", 0, 0, 0, acmd_quit },
2003 { "reload", 0, 0, 0, acmd_reload },
2004 { "servinfo", 0, 0, 0, acmd_servinfo },
2005 { "setifname", "PEER NEW-NAME", 2, 2, acmd_setifname },
2006 { "stats", "PEER", 1, 1, acmd_stats },
2007 { "svcclaim", "SERVICE VERSION", 2, 2, acmd_svcclaim },
2008 { "svcensure", "SERVICE [VERSION]", 1, 2, acmd_svcensure },
2009 { "svcfail", "JOBID TOKENS...", 1, 0xffff, acmd_svcfail },
2010 { "svcinfo", "JOBID TOKENS...", 1, 0xffff, acmd_svcinfo },
2011 { "svclist", 0, 0, 0, acmd_svclist },
2012 { "svcok", "JOBID", 1, 1, acmd_svcok },
2013 { "svcquery", "SERVICE", 1, 1, acmd_svcquery },
2014 { "svcrelease", "SERVICE", 1, 1, acmd_svcrelease },
2015 { "svcsubmit", "[OPTIONS] SERVICE TOKENS...",
2016 2, 0xffff, acmd_svcsubmit },
2018 { "trace", "[OPTIONS]", 0, 1, acmd_trace },
2020 { "tunnels", 0, 0, 0, acmd_tunnels },
2021 { "version", 0, 0, 0, acmd_version },
2022 { "warn", "MESSAGE ...", 1, 0xffff, acmd_warn },
2023 { "watch", "[OPTIONS]", 0, 1, acmd_watch },
2027 static void acmd_help(admin *a, unsigned ac, char *av[])
2031 for (c = acmdtab; c->name; c++) {
2033 a_info(a, "%s", c->name, "*%s", c->help, A_END);
2035 a_info(a, "%s", c->name, A_END);
2040 /*----- Connection handling -----------------------------------------------*/
2042 /* --- @a_destroypending@ --- *
2048 * Use: Destroys pending admin connections at a safe time.
2051 static void a_destroypending(void)
2053 admin *a, *aa, *head;
2054 admin_bgop *bg, *bbg;
2055 admin_service *svc, *ssvc;
2057 /* --- Destroy connections marked as pending --- *
2059 * Slightly messy. Killing clients may cause others to finally die. Make
2060 * sure that they can be put on the list without clobbering anything or
2067 for (a = head; a; a = aa) {
2069 assert(a->f & AF_DEAD);
2071 /* --- Report what we're doing --- */
2073 T( trace(T_ADMIN, "admin: completing destruction of connection %u",
2076 /* --- If this is the foreground client then shut down --- */
2078 if (a->f & AF_FOREGROUND) {
2079 T( trace(T_ADMIN, "admin: foreground client quit: shutting down"); )
2080 a_warn("SERVER", "quit", "foreground-eof", A_END);
2084 /* --- Abort any background jobs in progress --- */
2086 for (bg = a->bg; bg; bg = bbg) {
2089 if (bg->tag) xfree(bg->tag);
2093 /* --- Release services I hold, and abort pending jobs --- */
2095 for (svc = a->svcs; svc; svc = ssvc) {
2099 a_jobtablefinal(&a->j);
2101 /* --- Close file descriptors and selectory --- */
2103 selbuf_destroy(&a->b);
2104 if (a->b.reader.fd != a->w.fd) close(a->b.reader.fd);
2106 if (a_stdin == a) a_stdin = 0;
2115 /* --- @a_destroy@ --- *
2117 * Arguments: @admin *a@ = pointer to an admin block
2121 * Use: Destroys an admin block. This requires a certain amount of
2125 static void freequeue(oqueue *q)
2129 for (o = q->hd; o; o = oo) {
2136 static void a_destroy(admin *a)
2141 if (a->next) a->next->prev = a->prev;
2142 if (a->prev) a->prev->next = a->next;
2143 else admins = a->next;
2145 if (a->out.hd) sel_rmfile(&a->w);
2152 T( trace(T_ADMIN, "admin: killing connection %u", a->seq); )
2155 /* --- @a_line@ --- *
2157 * Arguments: @char *p@ = pointer to the line read
2158 * @size_t len@ = length of the line
2159 * @void *vp@ = pointer to my admin block
2163 * Use: Handles a line of input.
2166 static void a_line(char *p, size_t len, void *vp)
2181 selbuf_disable(&a->b);
2185 ac = str_qsplit(p, av, N(av) - 1, 0, STRF_QUOTE);
2189 for (c = acmdtab; c->name; c++) {
2190 if (mystrieq(av[0], c->name)) {
2192 if (c->argmin > ac || ac > c->argmax) {
2194 a_fail(a, "bad-syntax", "%s", c->name, "", A_END);
2196 a_fail(a, "bad-syntax", "%s", c->name, "%s", c->help, A_END);
2198 c->func(a, ac, av + 1);
2202 a_fail(a, "unknown-command", "%s", av[0], A_END);
2205 /* --- @a_create@ --- *
2207 * Arguments: @int fd_in, fd_out@ = file descriptors to use
2208 * @unsigned f@ = initial flags to set
2212 * Use: Creates a new admin connection.
2215 void a_create(int fd_in, int fd_out, unsigned f)
2217 admin *a = CREATE(admin);
2219 T( static unsigned seq = 0;
2221 T( trace(T_ADMIN, "admin: accepted connection %u", a->seq); )
2225 a_jobtableinit(&a->j);
2227 if (fd_in == STDIN_FILENO) a_stdin = a;
2228 fdflags(fd_in, O_NONBLOCK, O_NONBLOCK, FD_CLOEXEC, FD_CLOEXEC);
2229 if (fd_out != fd_in)
2230 fdflags(fd_out, O_NONBLOCK, O_NONBLOCK, FD_CLOEXEC, FD_CLOEXEC);
2231 selbuf_init(&a->b, &sel, fd_in, a_line, a);
2232 sel_initfile(&sel, &a->w, fd_out, SEL_WRITE, a_flush, a);
2233 a->out.hd = a->out.tl = 0;
2236 if (admins) admins->prev = a;
2240 /* --- @a_accept@ --- *
2242 * Arguments: @int fd@ = file descriptor to accept
2243 * @unsigned mode@ = what to do
2244 * @void *v@ = uninteresting pointer
2248 * Use: Accepts a new admin connection.
2251 static void a_accept(int fd, unsigned mode, void *v)
2254 struct sockaddr_un sun;
2255 socklen_t sz = sizeof(sun);
2257 if ((nfd = accept(fd, (struct sockaddr *)&sun, &sz)) < 0) {
2258 if (errno != EINTR && errno != EAGAIN && errno != EWOULDBLOCK &&
2259 errno != ECONNABORTED && errno != EPROTO)
2260 a_warn("ADMIN", "accept-error", "?ERRNO", A_END);
2263 a_create(nfd, nfd, 0);
2266 /* --- @a_preselect@ --- *
2272 * Use: Informs the admin module that we're about to select again,
2273 * and that it should do cleanup things it has delayed until a
2277 void a_preselect(void) { if (a_dead) a_destroypending(); }
2279 /* --- @a_daemon@ --- *
2285 * Use: Informs the admin module that it's a daemon.
2288 void a_daemon(void) { flags |= F_DAEMON; }
2290 /* --- @a_init@ --- *
2292 * Arguments: @const char *name@ = socket name to create
2293 * @uid_t u@ = user to own the socket
2294 * @gid_t g@ = group to own the socket
2295 * @mode_t m@ = permissions to set on the socket
2299 * Use: Creates the admin listening socket.
2302 void a_init(const char *name, uid_t u, gid_t g, mode_t m)
2306 struct sockaddr_un sun;
2307 struct sigaction sa;
2311 /* --- Create services table --- */
2313 sym_create(&a_svcs);
2315 /* --- Set up the socket address --- */
2317 sz = strlen(name) + 1;
2318 if (sz > sizeof(sun.sun_path))
2319 die(EXIT_FAILURE, "socket name `%s' too long", name);
2321 sun.sun_family = AF_UNIX;
2322 memcpy(sun.sun_path, name, sz);
2323 sz += offsetof(struct sockaddr_un, sun_path);
2325 /* --- Attempt to bind to the socket --- */
2327 omask = umask(0077);
2329 if ((fd = socket(PF_UNIX, SOCK_STREAM, 0)) < 0)
2330 die(EXIT_FAILURE, "couldn't create socket: %s", strerror(errno));
2331 if (bind(fd, (struct sockaddr *)&sun, sz) < 0) {
2334 if (errno != EADDRINUSE) {
2335 die(EXIT_FAILURE, "couldn't bind to address `%s': %s",
2336 sun.sun_path, strerror(e));
2339 die(EXIT_FAILURE, "too many retries; giving up");
2341 if (!connect(fd, (struct sockaddr *)&sun, sz)) {
2342 die(EXIT_FAILURE, "server already listening on admin socket `%s'",
2345 if (errno != ECONNREFUSED)
2346 die(EXIT_FAILURE, "couldn't bind to address: %s", strerror(e));
2347 if (stat(sun.sun_path, &st)) {
2348 die(EXIT_FAILURE, "couldn't stat `%s': %s",
2349 sun.sun_path, strerror(errno));
2351 if (!S_ISSOCK(st.st_mode))
2352 die(EXIT_FAILURE, "object `%s' isn't a socket", sun.sun_path);
2353 T( trace(T_ADMIN, "admin: stale socket found; removing it"); )
2354 unlink(sun.sun_path);
2358 if (chown(sun.sun_path, u, g)) {
2359 die(EXIT_FAILURE, "failed to set socket owner: %s",
2362 if (chmod(sun.sun_path, m)) {
2363 die(EXIT_FAILURE, "failed to set socket permissions: %s",
2367 fdflags(fd, O_NONBLOCK, O_NONBLOCK, FD_CLOEXEC, FD_CLOEXEC);
2369 die(EXIT_FAILURE, "couldn't listen on socket: %s", strerror(errno));
2371 /* --- Listen to the socket --- */
2373 sel_initfile(&sel, &sock, fd, SEL_READ, a_accept, 0);
2377 T( trace_custom(a_trace, 0);
2378 trace(T_ADMIN, "admin: enabled custom tracing"); )
2381 /* --- Set up signal handlers --- */
2383 sig_add(&s_term, SIGTERM, a_sigdie, 0);
2384 sig_add(&s_hup, SIGHUP, a_sighup, 0);
2385 sigaction(SIGINT, 0, &sa);
2386 if (sa.sa_handler != SIG_IGN)
2387 sig_add(&s_int, SIGINT, a_sigdie, 0);
2390 /*----- That's all, folks -------------------------------------------------*/