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
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation; either version 2 of the License, or
15 * (at your option) any later version.
17 * TrIPE is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
22 * You should have received a copy of the GNU General Public License
23 * along with TrIPE; if not, write to the Free Software Foundation,
24 * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
27 /*----- Header files ------------------------------------------------------*/
31 /*----- Global variables --------------------------------------------------*/
35 const trace_opt tr_opts[] = {
36 { 't', T_TUNNEL, "tunnel events" },
37 { 'r', T_PEER, "peer events" },
38 { 'a', T_ADMIN, "admin interface" },
39 { 's', T_KEYSET, "symmetric keyset management" },
40 { 'x', T_KEYEXCH, "key exchange" },
41 { 'm', T_KEYMGMT, "key management" },
42 { 'l', T_CHAL, "challenge management" },
43 { 'v', T_PRIVSEP, "privilege separation" },
44 { 'p', T_PACKET, "packet contents" },
45 { 'c', T_CRYPTO, "crypto details" },
46 { 'A', T_ALL, "all of the above" },
50 unsigned tr_flags = 0;
53 static const trace_opt w_opts[] = {
55 { 't', AF_TRACE, "trace messages" },
57 { 'n', AF_NOTE, "asynchronous notifications" },
58 { 'w', AF_WARN, "warnings" },
59 { 'A', AF_ALLMSGS, "all of the above" },
63 /*----- Static variables --------------------------------------------------*/
68 static const char *sockname;
69 static sym_table a_svcs;
70 static unsigned flags = 0;
71 static admin *a_stdin = 0;
72 static sig s_term, s_int, s_hup;
76 #define F_FOREGROUND 4u
78 #define T_RESOLVE SEC(30)
81 static void a_destroy(admin */*a*/);
83 #define BOOL(x) ((x) ? "t" : "nil")
85 /*----- Output functions --------------------------------------------------*/
87 /* --- @trywrite@ --- *
89 * Arguments: @admin *a@ = pointer to an admin block
90 * @const char *p@ = pointer to buffer to write
91 * @size_t sz@ = size of data to write
93 * Returns: The number of bytes written, or less than zero on error.
95 * Use: Attempts to write data to a client.
98 static ssize_t trywrite(admin *a, const char *p, size_t sz)
105 n = write(a->w.fd, p, sz);
115 if (errno != EAGAIN && errno != EWOULDBLOCK) {
117 a_warn("ADMIN", "client-write-error", "?ERRNO", A_END);
124 /* --- @doqueue@ -- *
126 * Arguments: @oqueue *q@ = pointer to output queue
127 * @const char *p@ = pointer to buffer to write
128 * @size_t sz@ = size of buffer
130 * Returns: Nonzero if the queue was previously empty.
132 * Use: Queues data to be written later.
135 static int doqueue(oqueue *q, const char *p, size_t sz)
144 else if (o->p_in < o->buf + OBUFSZ)
148 o = xmalloc(sizeof(obuf));
150 o->p_in = o->p_out = o->buf;
158 n = o->buf + OBUFSZ - o->p_in;
161 memcpy(o->p_in, p, n);
170 /* --- @dosend@ --- *
172 * Arguemnts: @admin *a@ = pointer to an admin block
173 * @const char *p@ = pointer to buffer to write
174 * @size_t sz@ = size of data to write
178 * Use: Sends data to an admin client.
181 static void dosend(admin *a, const char *p, size_t sz)
188 if ((n = trywrite(a, p, sz)) < 0)
195 if (doqueue(&a->out, p, sz))
199 /* --- @a_flush@ --- *
201 * Arguments: @int fd@ = file descriptor
202 * @unsigned mode@ = what's happening
203 * @void *v@ = pointer to my admin block
207 * Use: Flushes buffers when a client is ready to read again.
210 static void a_flush(int fd, unsigned mode, void *v)
218 if ((n = trywrite(a, o->p_out, o->p_in - o->p_out)) < 0)
221 if (o->p_in < o->p_out)
234 /*----- Utility functions -------------------------------------------------*/
236 /* --- @a_vformat@ --- *
238 * Arguments: @dstr *d@ = where to leave the formatted message
239 * @const char *fmt@ = pointer to format string
240 * @va_list *ap@ = arguments in list
244 * Use: Main message token formatting driver. The arguments are
245 * interleaved formatting tokens and their parameters, finally
246 * terminated by an entry @A_END@.
250 * * "*..." ... -- pretokenized @dstr_putf@-like string
252 * * "?ADDR" SOCKADDR -- a socket address, to be converted
254 * * "?B64" BUFFER SIZE -- binary data to be base64-encoded
256 * * "?TOKENS" VECTOR -- null-terminated vector of tokens
258 * * "?PEER" PEER -- peer's name
260 * * "?ERRNO" ERRNO -- system error code
262 * * "[!]..." ... -- @dstr_putf@-like string as single token
265 void a_vformat(dstr *d, const char *fmt, va_list *ap)
271 if (d->len) dstr_putc(d, ' ');
272 dstr_vputf(d, fmt + 1, ap);
273 } else if (*fmt == '?') {
274 if (strcmp(fmt, "?ADDR") == 0) {
275 const addr *a = va_arg(ap, const addr *);
276 switch (a->sa.sa_family) {
278 u_quotify(d, "INET");
279 u_quotify(d, inet_ntoa(a->sin.sin_addr));
280 dstr_putf(d, " %u", (unsigned)ntohs(a->sin.sin_port));
285 } else if (strcmp(fmt, "?B64") == 0) {
286 const octet *p = va_arg(ap, const octet *);
287 size_t n = va_arg(ap, size_t);
293 base64_encode(&b64, p, n, d);
294 base64_encode(&b64, 0, 0, d);
295 while (d->len && d->buf[d->len - 1] == '=') d->len--;
296 } else if (strcmp(fmt, "?TOKENS") == 0) {
297 const char *const *av = va_arg(ap, const char *const *);
298 while (*av) u_quotify(d, *av++);
299 } else if (strcmp(fmt, "?PEER") == 0)
300 u_quotify(d, p_name(va_arg(ap, peer *)));
301 else if (strcmp(fmt, "?ERRNO") == 0) {
302 dstr_putf(d, " E%d", errno);
303 u_quotify(d, strerror(errno));
307 if (*fmt == '!') fmt++;
309 dstr_vputf(&dd, fmt, ap);
310 u_quotify(d, dd.buf);
312 fmt = va_arg(ap, const char *);
318 /* --- @a_format@ --- *
320 * Arguments: @dstr *d@ = where to leave the formatted message
321 * @const char *fmt@ = pointer to format string
325 * Use: Writes a tokenized message into a string, for later
329 void a_format(dstr *d, const char *fmt, ...)
334 a_vformat(d, fmt, &ap);
338 /* --- @a_write@, @a_vwrite@ --- *
340 * Arguments: @admin *a@ = admin connection to write to
341 * @const char *status@ = status code to report
342 * @const char *tag@ = tag string, or null
343 * @const char *fmt@ = pointer to format string
344 * @va_list ap@ = arguments in list
345 * @...@ = other arguments
349 * Use: Sends a message to an admin connection.
352 static void a_vwrite(admin *a, const char *status, const char *tag,
353 const char *fmt, va_list *ap)
357 if (tag) dstr_puts(&d, "BG");
358 dstr_puts(&d, status);
359 if (tag) u_quotify(&d, tag);
360 a_vformat(&d, fmt, ap);
362 dosend(a, d.buf, d.len);
366 static void a_write(admin *a, const char *status, const char *tag,
367 const char *fmt, ...)
372 a_vwrite(a, status, tag, fmt, &ap);
376 /* --- @a_ok@, @a_info@, @a_fail@ --- *
378 * Arguments: @admin *a@ = connection
379 * @const char *fmt@ = format string
380 * @...@ = other arguments
384 * Use: Convenience functions for @a_write@.
387 static void a_ok(admin *a) { a_write(a, "OK", 0, A_END); }
389 static void a_info(admin *a, const char *fmt, ...)
394 a_vwrite(a, "INFO", 0, fmt, &ap);
398 static void a_fail(admin *a, const char *fmt, ...)
403 a_vwrite(a, "FAIL", 0, fmt, &ap);
407 /* --- @a_alert@, @a_valert@, @a_rawalert@ --- *
409 * Arguments: @unsigned f_and, f_eq@ = filter for connections
410 * @const char *status@ = status string
411 * @const char *fmt@ = pointer to format string
412 * @const char *p@ = pointer to raw string
413 * @size_t sz@ = size of raw string
414 * @va_list ap@ = arguments in list
415 * @...@ = other arguments
419 * Use: Write a message to all admin connections matched by the given
423 static void a_rawalert(unsigned f_and, unsigned f_eq, const char *status,
424 const char *p, size_t sz)
429 if (!(flags & F_INIT))
431 dstr_puts(&d, status);
434 dstr_putm(&d, p, sz);
439 for (a = admins; a; a = aa) {
441 if ((a->f & f_and) == f_eq)
442 dosend(a, d.buf, d.len);
447 static void a_valert(unsigned f_and, unsigned f_eq, const char *status,
448 const char *fmt, va_list *ap)
452 if (!(flags & F_INIT))
454 a_vformat(&d, fmt, ap);
455 a_rawalert(f_and, f_eq, status, fmt ? d.buf : 0, fmt ? d.len : 0);
459 static void a_alert(unsigned f_and, unsigned f_eq, const char *status,
460 const char *fmt, ...)
465 a_valert(f_and, f_eq, status, fmt, &ap);
469 /* --- @a_warn@ --- *
471 * Arguments: @const char *fmt@ = pointer to format string
472 * @...@ = other arguments
476 * Use: Informs all admin connections of a warning.
479 void a_warn(const char *fmt, ...)
485 a_valert(0, 0, "WARN", fmt, &ap);
488 fprintf(stderr, "%s: ", QUIS);
489 a_vformat(&d, fmt, &ap);
491 dstr_write(&d, stderr);
497 /* --- @a_trace@ --- *
499 * Arguments: @const char *p@ = pointer to a buffer
500 * @size_t sz@ = size of the buffer
501 * @void *v@ = uninteresting pointer
505 * Use: Custom trace output handler. Sends trace messages to
506 * interested admin connections.
510 static void a_trace(const char *p, size_t sz, void *v)
511 { a_rawalert(AF_TRACE, AF_TRACE, "TRACE", p, sz); }
514 /* --- @a_notify@ --- *
516 * Arguments: @const char *fmt@ = pointer to format string
517 * @...@ = other arguments
521 * Use: Sends a notification to interested admin connections.
524 void a_notify(const char *fmt, ...)
529 a_valert(AF_NOTE, AF_NOTE, "NOTE", fmt, &ap);
533 /* --- @a_quit@ --- *
539 * Use: Shuts things down nicely.
546 FOREACH_PEER(p, { p_destroy(p); });
551 /* --- @a_sigdie@ --- *
553 * Arguments: @int sig@ = signal number
554 * @void *v@ = an uninteresting argument
558 * Use Shuts down on receipt of a fatal signal.
561 static void a_sigdie(int sig, void *v)
567 case SIGTERM: p = "SIGTERM"; break;
568 case SIGINT: p = "SIGINT"; break;
570 sprintf(buf, "%i", sig);
574 a_warn("SERVER", "quit", "signal", "%s", p, A_END);
578 /* --- @a_sighup@ --- *
580 * Arguments: @int sig@ = signal number
581 * @void *v@ = an uninteresting argument
585 * Use Logs a message about SIGHUP not being useful.
588 static void a_sighup(int sig, void *v)
589 { a_warn("SERVER", "ignore", "signal", "SIGHUP", A_END); }
591 /* --- @a_parsetime@ --- *
593 * Arguments; @const char *p@ = time string to parse
595 * Returns: Time in seconds, or @< 0@ on error.
598 static long a_parsetime(const char *p)
601 long t = strtol(p, &q, 0);
607 case 's': if (q[1] != 0)
614 /* --- @a_findpeer@ --- *
616 * Arguments: @admin *a@ = admin connection
617 * @const char *pn@ = peer name
619 * Returns: The peer, or null if not there.
621 * Use: Finds a peer, reporting an error if it failed.
624 static peer *a_findpeer(admin *a, const char *pn)
628 if ((p = p_find(pn)) == 0)
629 a_fail(a, "unknown-peer", "%s", pn, A_END);
633 /*----- Backgrounded operations -------------------------------------------*/
636 (((admin_bgop *)(bg))->tag ? ((admin_bgop *)(bg))->tag : "<foreground>")
638 /* --- @a_bgfind@ --- *
640 * Arguments: @admin *a@ = a client block
641 * @const char *tag@ = the requested tag
643 * Returns: The requested background job, or null.
646 static admin_bgop *a_bgfind(admin *a, const char *tag)
650 for (bg = a->bg; bg; bg = bg->next) {
651 if (bg->tag && strcmp(tag, bg->tag) == 0)
657 /* --- @a_bgrelease@ --- *
659 * Arguments: @admin_bgop *bg@ = backgrounded operation
663 * Use: Removes a backgrounded operation from the queue, since
664 * (presumably) it's done.
667 static void a_bgrelease(admin_bgop *bg)
671 T( trace(T_ADMIN, "admin: release bgop %s", BGTAG(bg)); )
672 if (bg->tag) xfree(bg->tag);
673 else selbuf_enable(&a->b);
674 if (bg->next) bg->next->prev = bg->prev;
675 if (bg->prev) bg->prev->next = bg->next;
676 else a->bg = bg->next;
678 if (!a->bg && (a->f & AF_CLOSE)) a_destroy(a);
681 /* --- @a_bgok@, @a_bginfo@, @a_bgfail@ --- *
683 * Arguments: @admin_bgop *bg@ = backgrounded operation
684 * @const char *fmt@ = format string
685 * @...@ = other arguments
689 * Use: Convenience functions for @a_write@.
692 static void a_bgok(admin_bgop *bg)
693 { a_write(bg->a, "OK", bg->tag, A_END); }
695 static void a_bginfo(admin_bgop *bg, const char *fmt, ...)
699 a_vwrite(bg->a, "INFO", bg->tag, fmt, &ap);
703 static void a_bgfail(admin_bgop *bg, const char *fmt, ...)
707 a_vwrite(bg->a, "FAIL", bg->tag, fmt, &ap);
711 /* --- @a_bgadd@ --- *
713 * Arguments: @admin *a@ = administration connection
714 * @admin_bgop *bg@ = pointer to background operation
715 * @const char *tag@ = background tag, or null for foreground
716 * @void (*cancel)(admin_bgop *)@ = cancel function
718 * Returns: Zero for success, nonzero on failure.
720 * Use: Links a background job into the list.
723 static int a_bgadd(admin *a, admin_bgop *bg, const char *tag,
724 void (*cancel)(admin_bgop *))
727 if (a_bgfind(a, tag)) {
728 a_fail(a, "tag-exists", "%s", tag, A_END);
731 bg->tag = xstrdup(tag);
735 selbuf_disable(&a->b);
741 if (a->bg) a->bg->prev = bg;
743 T( trace(T_ADMIN, "admin: add bgop %s", BGTAG(bg)); )
744 if (tag) a_write(a, "DETACH", tag, A_END);
748 /*----- Job table manipulation --------------------------------------------*/
751 #define JOB_INDEXMASK ((1ul << JOB_SHIFT) - 1)
752 #define JOB_SEQMASK ((1ul << (32 - JOB_SHIFT)) - 1)
754 #define JOB_END 0xfffffffful
756 static unsigned long a_joboffset;
758 /* --- @a_jobidencode@ --- *
760 * Arguments: @admin_svcop *svc@ = pointer to a service operation
762 * Returns: A jobid for this job, in an internal static buffer.
764 * Use: Constructs a jobid. In order to dissuade people from
765 * predicting jobids, we obfuscate them.
767 * A `raw' jobid consists of two 16-bit fields. The low 16 bits
768 * are an index into a big array. The high 16 bits are a
769 * sequence number recording how many times that slot has been
772 * This `raw' jobid is then obfuscated by adding a randomly-
773 * generated offset, and multiplying (mod %$2^{32}$%) by a fixed
777 static const char *a_jobidencode(admin_svcop *svc)
779 admin_jobtable *j = &svc->prov->j;
784 assert(svc->index <= JOB_INDEXMASK);
785 seq = j->v[svc->index].seq;
786 assert(seq <= JOB_SEQMASK);
787 pre = (unsigned long)svc->index | ((unsigned long)seq << JOB_SHIFT);
788 sprintf(buf, "J%08lx", ((pre + a_joboffset) * 0x0f87a7a3ul) & 0xffffffff);
792 /* --- @a_jobiddecode@ --- *
794 * Arguments: @admin_jobtable *j@ = pointer to a job table
795 * @const char *jid@ = pointer to a jobid string
797 * Returns: A pointer to the job's @svcop@ structure.
800 static admin_svcop *a_jobiddecode(admin_jobtable *j, const char *jid)
807 for (i = 1; i < 9; i++) {
808 if (!isxdigit((unsigned char)jid[i]))
813 pre = strtoul(jid + 1, 0, 16);
814 pre = ((pre * 0xbd11c40bul) - a_joboffset) & 0xffffffff;
815 i = pre & JOB_INDEXMASK;
816 if (i >= j->n || j->v[i].seq != (pre >> JOB_SHIFT))
818 return (j->v[i].u.op);
821 /* --- @a_jobcreate@ --- *
823 * Arguments: @admin *a@ = pointer to administration client
825 * Returns: A pointer to a freshly-allocated @svcop@, or null.
827 * Use: Allocates a fresh @svcop@ and links it into a job table.
830 static admin_svcop *a_jobcreate(admin *a)
835 admin_jobtable *j = &a->j;
837 if (j->free != JOB_END) {
839 j->free = j->v[i].u.next;
842 if (j->sz > JOB_INDEXMASK)
847 j->v = xmalloc(j->sz * sizeof(*j->v));
850 j->v = xrealloc(j->v, j->sz * sizeof(*j->v), sz * sizeof(*j->v));
856 svc = xmalloc(sizeof(*svc));
859 svc->next = j->active;
861 if (j->active) j->active->prev = svc;
864 IF_TRACING(T_ADMIN, {
865 trace(T_ADMIN, "admin: created job %s (%u)", a_jobidencode(svc), i);
870 /* --- @a_jobdestroy@ --- *
872 * Arguments: @admin_svcop *svc@ = pointer to job block
876 * Use: Frees up a completed (or cancelled) job.
879 static void a_jobdestroy(admin_svcop *svc)
881 admin *a = svc->prov;
882 admin_jobtable *j = &a->j;
883 unsigned i = svc->index;
885 IF_TRACING(T_ADMIN, {
886 trace(T_ADMIN, "admin: destroying job %s (%u)", a_jobidencode(svc), i);
888 assert(j->v[i].u.op = svc);
889 j->v[i].u.next = j->free;
892 if (svc->next) svc->next->prev = svc->prev;
893 if (svc->prev) svc->prev->next = svc->next;
894 else j->active = svc->next;
897 /* --- @a_jobtableinit@ --- *
899 * Arguments: @admin_jobtable *j@ = pointer to job table
903 * Use: Initializes a job table.
906 static void a_jobtableinit(admin_jobtable *j)
909 a_joboffset = GR_RANGE(&rand_global, 0xffffffff) + 1;
916 /* --- @a_jobtablefinal@ --- *
918 * Arguments: @admin_jobtable *j@ = pointer to job table
922 * Use: Closes down a job table.
925 static void a_jobtablefinal(admin_jobtable *j)
927 admin_svcop *svc, *ssvc;
929 for (svc = j->active; svc; svc = ssvc) {
931 a_bgfail(&svc->bg, "provider-failed", A_END);
932 a_bgrelease(&svc->bg);
934 if (j->v) xfree(j->v);
937 /*----- Services infrastructure -------------------------------------------*/
939 /* --- @a_svcfind@ --- *
941 * Arguments: @admin *a@ = the requesting client
942 * @const char *name@ = service name wanted
944 * Returns: The service requested, or null.
946 * Use: Finds a service; reports an error if the service couldn't be
950 static admin_service *a_svcfind(admin *a, const char *name)
954 if ((svc = sym_find(&a_svcs, name, -1, 0, 0)) == 0) {
955 a_fail(a, "unknown-service", "%s", name, A_END);
961 /* --- @a_svcunlink@ --- *
963 * Arguments: @admin_service *svc@ = pointer to service structure
967 * Use: Unlinks the service from its provider, without issuing a
968 * message or freeing the structure. The version string is
972 static void a_svcunlink(admin_service *svc)
975 svc->next->prev = svc->prev;
977 svc->prev->next = svc->next;
979 svc->prov->svcs = svc->next;
983 /* --- @a_svcrelease@ --- *
985 * Arguments: @admin_service *svc@ = pointer to service structure
989 * Use: Releases a service and frees its structure.
992 static void a_svcrelease(admin_service *svc)
994 a_notify("SVCRELEASE", "%s", SYM_NAME(svc), A_END);
996 sym_remove(&a_svcs, svc);
999 /*----- Name resolution operations ----------------------------------------*/
1001 /* --- @a_resolved@ --- *
1003 * Arguments: @struct hostent *h@ = pointer to resolved hostname
1004 * @void *v@ = pointer to resolver operation
1008 * Use: Handles a completed name resolution.
1011 static void a_resolved(struct hostent *h, void *v)
1015 T( trace(T_ADMIN, "admin: resop %s resolved", BGTAG(r)); )
1018 a_bgfail(&r->bg, "resolve-error", "%s", r->addr, A_END);
1019 r->func(r, ARES_FAIL);
1021 memcpy(&r->sa.sin.sin_addr, h->h_addr, sizeof(struct in_addr));
1022 r->func(r, ARES_OK);
1026 a_bgrelease(&r->bg);
1029 /* --- @a_restimer@ --- *
1031 * Arguments: @struct timeval *tv@ = timer
1032 * @void *v@ = pointer to resolver operation
1036 * Use: Times out a resolver.
1039 static void a_restimer(struct timeval *tv, void *v)
1043 T( trace(T_ADMIN, "admin: resop %s timeout", BGTAG(r)); )
1044 a_bgfail(&r->bg, "resolver-timeout", "%s", r->addr, A_END);
1045 r->func(r, ARES_FAIL);
1048 a_bgrelease(&r->bg);
1051 /* --- @a_rescancel@ --- *
1053 * Arguments: @admin_bgop *bg@ = background operation
1057 * Use: Cancels an add operation.
1060 static void a_rescancel(admin_bgop *bg)
1062 admin_resop *r = (admin_resop *)bg;
1064 T( trace(T_ADMIN, "admin: cancel resop %s", BGTAG(r)); )
1065 r->func(r, ARES_FAIL);
1071 /* --- @a_resolve@ --- *
1073 * Arguments: @admin *a@ = administration connection
1074 * @admin_resop *r@ = resolver operation to run
1075 * @const char *tag@ = background operation tag
1076 * @void (*func)(struct admin_resop *, int@ = handler function
1077 * @unsigned ac@ = number of remaining arguments
1078 * @char *av[]@ = pointer to remaining arguments
1082 * Use: Cranks up a resolver job.
1085 static void a_resolve(admin *a, admin_resop *r, const char *tag,
1086 void (*func)(struct admin_resop *, int),
1087 unsigned ac, char *av[])
1094 /* --- Fill in the easy bits of address --- */
1096 r->bg.tag = "<starting>";
1099 if (mystrieq(av[i], "inet")) i++;
1100 if (ac - i != 1 && ac - i != 2) {
1101 a_fail(a, "bad-addr-syntax", "[inet] ADDRESS [PORT]", A_END);
1104 r->sa.sin.sin_family = AF_INET;
1105 r->sasz = sizeof(r->sa.sin);
1106 r->addr = xstrdup(av[i]);
1110 pt = strtoul(av[i + 1], &p, 0);
1112 struct servent *s = getservbyname(av[i + 1], "udp");
1114 a_fail(a, "unknown-service", "%s", av[i + 1], A_END);
1117 pt = ntohs(s->s_port);
1120 if (pt == 0 || pt >= 65536) {
1121 a_fail(a, "invalid-port", "%lu", pt, A_END);
1124 r->sa.sin.sin_port = htons(pt);
1126 /* --- Report backgrounding --- *
1128 * Do this for consistency of interface, even if we're going to get the
1129 * answer straight away.
1132 if (a_bgadd(a, &r->bg, tag, a_rescancel))
1134 T( trace(T_ADMIN, "admin: %u, resop %s, hostname `%s'",
1135 a->seq, BGTAG(r), r->addr); )
1137 /* --- If the name is numeric, do it the easy way --- */
1139 if (inet_aton(av[i], &r->sa.sin.sin_addr)) {
1140 T( trace(T_ADMIN, "admin: resop %s done the easy way", BGTAG(r)); )
1143 a_bgrelease(&r->bg);
1147 /* --- Store everything for later and crank up the resolver --- */
1149 gettimeofday(&tv, 0);
1150 tv.tv_sec += T_RESOLVE;
1151 sel_addtimer(&sel, &r->t, &tv, a_restimer, r);
1152 bres_byname(&r->r, r->addr, a_resolved, r);
1157 if (r->addr) xfree(r->addr);
1161 /*----- Option parsing ----------------------------------------------------*/
1163 #define OPTIONS(argc, argv, guts) do { \
1164 char **o_av = argv; \
1168 if (mystrieq(*o_av, "--")) { \
1173 if (**o_av == '-') \
1177 argc -= o_av - argv; \
1181 #define OPT(name, guts) if (mystrieq(*o_av, name)) { guts continue; }
1183 #define OPTARG(name, arg, guts) OPT(name, { \
1186 if (!arg) goto bad_syntax; \
1190 #define OPTTIME(name, arg, guts) OPTARG(name, o_arg, { \
1192 if ((arg = a_parsetime(o_arg)) < 0) { \
1193 a_fail(a, "bad-time-spec", "%s", o_arg, A_END); \
1199 /*----- Adding peers ------------------------------------------------------*/
1201 /* --- @a_doadd@ --- *
1203 * Arguments: @admin_resop *r@ = resolver operation
1204 * @int rc@ = how it worked
1208 * Use: Handles a completed resolution.
1211 static void a_doadd(admin_resop *r, int rc)
1213 admin_addop *add = (admin_addop *)r;
1215 T( trace(T_ADMIN, "admin: done add op %s", BGTAG(add)); )
1217 if (rc == ARES_OK) {
1218 add->peer.sasz = add->r.sasz;
1219 add->peer.sa = add->r.sa;
1220 if (p_findbyaddr(&add->r.sa))
1221 a_bgfail(&add->r.bg, "peer-addr-exists", "?ADDR", &add->r.sa, A_END);
1222 else if (p_find(add->peer.name))
1223 a_bgfail(&add->r.bg, "peer-exists", "%s", add->peer.name, A_END);
1224 else if (!p_create(&add->peer))
1225 a_bgfail(&add->r.bg, "peer-create-fail", "%s", add->peer.name, A_END);
1230 if (add->peer.tag) xfree(add->peer.tag);
1231 xfree(add->peer.name);
1234 /* --- @acmd_add@ --- *
1236 * Arguments: @admin *a@ = connection which requested the addition
1237 * @unsigned ac@ = argument count
1238 * @char *av[]@ = pointer to the argument list
1242 * Use: Adds a new peer.
1245 static void acmd_add(admin *a, unsigned ac, char *av[])
1247 const char *tag = 0;
1250 /* --- Set stuff up --- */
1252 add = xmalloc(sizeof(*add));
1255 add->peer.privtag = 0;
1257 add->peer.tops = tun_default;
1260 /* --- Parse options --- */
1263 OPTARG("-background", arg, { tag = arg; })
1264 OPTARG("-tunnel", arg, {
1268 a_fail(a, "unknown-tunnel", "%s", arg, A_END);
1271 if (mystrieq(arg, tunnels[i]->name)) {
1272 add->peer.tops = tunnels[i];
1277 OPTTIME("-keepalive", t, { add->peer.t_ka = t; })
1278 OPT("-cork", { add->peer.f |= KXF_CORK; })
1279 OPTARG("-key", arg, {
1281 xfree(add->peer.tag);
1282 add->peer.tag = xstrdup(arg);
1284 OPT("-mobile", { add->peer.f |= PSF_MOBILE; })
1285 OPTARG("-priv", arg, {
1286 if (add->peer.privtag)
1287 xfree(add->peer.privtag);
1288 add->peer.privtag = xstrdup(arg);
1292 /* --- Make sure someone's not got there already --- */
1294 if (!av[0] || !av[1])
1297 a_fail(a, "peer-exists", "%s", *av, A_END);
1300 add->peer.name = xstrdup(*av++);
1303 /* --- Crank up the resolver --- */
1305 a_resolve(a, &add->r, tag, a_doadd, ac, av);
1308 /* --- Clearing up --- */
1311 a_fail(a, "bad-syntax", "add", "[OPTIONS] PEER ADDR ...", A_END);
1313 if (add->peer.name) xfree(add->peer.name);
1314 if (add->peer.tag) xfree(add->peer.tag);
1315 if (add->peer.privtag) xfree(add->peer.privtag);
1320 /*----- Ping --------------------------------------------------------------*/
1322 /* --- @a_pingcancel@ --- *
1324 * Arguments: @admin_bgop *bg@ = background operation block
1328 * Use: Cancels a running ping.
1331 static void a_pingcancel(admin_bgop *bg)
1333 admin_pingop *pg = (admin_pingop *)bg;
1334 T( trace(T_ADMIN, "admin: cancel ping op %s", BGTAG(pg)); )
1335 p_pingdone(&pg->ping, PING_NONOTIFY);
1338 /* --- @a_pong@ --- *
1340 * Arguments: @int rc@ = return code
1341 * @void *v@ = ping operation block
1345 * Use: Collects what happened to a ping message.
1348 static void a_pong(int rc, void *v)
1350 admin_pingop *pg = v;
1356 gettimeofday(&tv, 0);
1357 tv_sub(&tv, &tv, &pg->pingtime);
1358 millis = (double)tv.tv_sec * 1000 + (double)tv.tv_usec/1000;
1359 a_bginfo(&pg->bg, "ping-ok", "%.1f", millis, A_END);
1363 a_bginfo(&pg->bg, "ping-timeout", A_END);
1367 a_bginfo(&pg->bg, "ping-peer-died", A_END);
1373 T( trace(T_ADMIN, "admin: ponged ping op %s", BGTAG(pg)); )
1374 a_bgrelease(&pg->bg);
1377 /* --- @acmd_ping@, @acmd_eping@ --- *
1379 * Arguments: @admin *a@ = connection which requested the ping
1380 * @unsigned ac@ = argument count
1381 * @char *av[]@ = pointer to the argument list
1385 * Use: Pings a peer.
1388 static void a_ping(admin *a, unsigned ac, char *av[],
1389 const char *cmd, unsigned msg)
1393 admin_pingop *pg = 0;
1394 const char *tag = 0;
1397 OPTARG("-background", arg, { tag = arg; })
1398 OPTTIME("-timeout", arg, { t = arg; })
1400 if (!*av || av[1]) goto bad_syntax;
1401 if ((p = a_findpeer(a, *av)) == 0)
1403 pg = xmalloc(sizeof(*pg));
1404 gettimeofday(&pg->pingtime, 0);
1405 if (a_bgadd(a, &pg->bg, tag, a_pingcancel))
1407 T( trace(T_ADMIN, "admin: ping op %s: %s to %s",
1408 BGTAG(pg), cmd, p_name(p)); )
1409 if (p_pingsend(p, &pg->ping, msg, t, a_pong, pg)) {
1410 a_bgfail(&pg->bg, "ping-send-failed", A_END);
1411 a_bgrelease(&pg->bg);
1416 a_fail(a, "bad-syntax", "%s", cmd, "[OPTIONS] PEER", cmd, A_END);
1422 static void acmd_ping(admin *a, unsigned ac, char *av[])
1423 { a_ping(a, ac, av, "ping", MISC_PING); }
1424 static void acmd_eping(admin *a, unsigned ac, char *av[])
1425 { a_ping(a, ac, av, "eping", MISC_EPING); }
1427 /*----- Service commands --------------------------------------------------*/
1429 static void acmd_svcclaim(admin *a, unsigned ac, char *av[])
1434 svc = sym_find(&a_svcs, av[0], -1, sizeof(*svc), &f);
1436 if (versioncmp(av[1], svc->version) <= 0) {
1439 "%s", SYM_NAME(svc),
1444 a_write(svc->prov, "SVCCLAIM", 0, "%s", av[0], "%s", av[1], A_END);
1448 svc->version = xstrdup(av[1]);
1449 svc->next = a->svcs;
1451 if (a->svcs) a->svcs->prev = svc;
1453 a_notify("SVCCLAIM", "%s", SYM_NAME(svc), "%s", svc->version, A_END);
1457 static void acmd_svcrelease(admin *a, unsigned ac, char *av[])
1461 if ((svc = a_svcfind(a, av[0])) == 0)
1463 if (svc->prov != a) {
1464 a_fail(a, "not-service-provider", "%s", SYM_NAME(svc), A_END);
1471 static void acmd_svcensure(admin *a, unsigned ac, char *av[])
1475 if ((svc = a_svcfind(a, av[0])) == 0)
1477 if (av[1] && versioncmp(svc->version, av[1]) < 0) {
1478 a_fail(a, "service-too-old",
1479 "%s", SYM_NAME(svc),
1487 static void acmd_svcquery(admin *a, unsigned ac, char *av[])
1491 if ((svc = a_svcfind(a, av[0])) != 0) {
1492 a_info(a, "name=%s", SYM_NAME(svc), "version=%s", svc->version, A_END);
1497 static void acmd_svclist(admin *a, unsigned ac, char *av[])
1502 for (sym_mkiter(&i, &a_svcs); (svc = sym_next(&i)) != 0; )
1503 a_info(a, "%s", SYM_NAME(svc), "%s", svc->version, A_END);
1507 static void a_canceljob(admin_bgop *bg)
1509 admin_svcop *svc = (admin_svcop *)bg;
1511 a_write(svc->prov, "SVCCANCEL", 0, "%s", a_jobidencode(svc), A_END);
1515 static void acmd_svcsubmit(admin *a, unsigned ac, char *av[])
1517 const char *tag = 0;
1520 const char *ver = 0;
1524 OPTARG("-background", arg, { tag = arg; })
1525 OPTARG("-version", arg, { ver = arg; })
1527 if (!*av) goto bad_syntax;
1528 if ((svc = a_svcfind(a, *av)) == 0) goto fail;
1529 if (ver && versioncmp(svc->version, ver) < 0) {
1530 a_fail(a, "service-too-old",
1531 "%s", SYM_NAME(svc),
1536 if ((svcop = a_jobcreate(svc->prov)) == 0) {
1537 a_fail(a, "provider-overloaded", A_END);
1540 if (a_bgadd(a, &svcop->bg, tag, a_canceljob)) {
1541 a_jobdestroy(svcop);
1544 a_write(svc->prov, "SVCJOB", 0,
1545 "%s", a_jobidencode(svcop),
1551 a_fail(a, "bad-syntax", "svcsubmit", "[OPTIONS] SERVICE ARGS...", A_END);
1558 static void a_replycmd(admin *a, const char *status, int donep, char *av[])
1562 if ((svc = a_jobiddecode(&a->j, av[0])) == 0) {
1563 a_fail(a, "unknown-jobid", av[0], A_END);
1566 a_write(svc->bg.a, status, svc->bg.tag, "?TOKENS", av + 1, A_END);
1569 a_bgrelease(&svc->bg);
1574 static void acmd_svcok(admin *a, unsigned ac, char *av[])
1575 { a_replycmd(a, "OK", 1, av); }
1576 static void acmd_svcinfo(admin *a, unsigned ac, char *av[])
1577 { a_replycmd(a, "INFO", 0, av); }
1578 static void acmd_svcfail(admin *a, unsigned ac, char *av[])
1579 { a_replycmd(a, "FAIL", 1, av); }
1581 /*----- Administration commands -------------------------------------------*/
1583 /* --- Miscellaneous commands --- */
1585 /* --- @traceish@ --- *
1587 * Arguments: @admin *a@ = connection to complain on
1588 * @unsigned ac@ = number of arguments
1589 * @char *av[]@ = vector of arguments
1590 * @const char *what@ = what we're messing with
1591 * @const trace_opt *tt@ = options table
1592 * @unsigned *ff@ = where the flags are
1594 * Returns: Nonzero if anything changed.
1596 * Use: Guts of trace-ish commands like `trace' and `watch'.
1599 static int traceish(admin *a, unsigned ac, char *av[],
1600 const char *what, const trace_opt *tt, unsigned *ff)
1604 if (!ac || strcmp(av[0], "?") == 0) {
1606 for (t = tt; t->ch; t++) {
1607 a_info(a, "*%c%c %s",
1608 t->ch, (*ff & t->f) == t->f ? '+' : ' ', t->help, A_END);
1618 case '+': sense = 1; break;
1619 case '-': sense = 0; break;
1621 for (t = tt; t->ch; t++) {
1623 if (sense) f |= t->f;
1628 a_fail(a, "bad-%s-option", what, "%c", *p, A_END);
1644 static void acmd_trace(admin *a, unsigned ac, char *av[])
1646 if (traceish(a, ac, av, "trace", tr_opts, &tr_flags))
1647 trace_level(tr_flags);
1652 static void acmd_watch(admin *a, unsigned ac, char *av[])
1653 { traceish(a, ac, av, "watch", w_opts, &a->f); }
1655 static void alertcmd(admin *a, unsigned f_and, unsigned f_eq,
1656 const char *status, char *av[])
1657 { a_alert(f_and, f_eq, status, "USER", "?TOKENS", av, A_END); a_ok(a); }
1658 static void acmd_notify(admin *a, unsigned ac, char *av[])
1659 { alertcmd(a, AF_NOTE, AF_NOTE, "NOTE", av); }
1660 static void acmd_warn(admin *a, unsigned ac, char *av[])
1661 { alertcmd(a, AF_WARN, AF_WARN, "WARN", av); }
1663 static void acmd_port(admin *a, unsigned ac, char *av[])
1664 { a_info(a, "%u", p_port(), A_END); a_ok(a); }
1666 static void acmd_daemon(admin *a, unsigned ac, char *av[])
1668 if (flags & F_DAEMON)
1669 a_fail(a, "already-daemon", A_END);
1671 a_notify("DAEMON", A_END);
1675 a_fail(a, "daemon-error", "?ERRNO", A_END);
1683 static void acmd_jobs(admin *a, unsigned ac, char *av[])
1687 for (bg = a->bg; bg; bg = bg->next) {
1689 a_info(a, "%s", bg->tag, A_END);
1694 static void acmd_bgcancel(admin *a, unsigned ac, char *av[])
1698 if ((bg = a_bgfind(a, av[0])) == 0)
1699 a_fail(a, "unknown-tag", "%s", av[0], A_END);
1707 static void acmd_algs(admin *a, unsigned ac, char *av[])
1712 const algswitch *algs;
1717 if ((p = a_findpeer(a, av[0])) == 0) return;
1724 "kx-group=%s", g->ops->name,
1725 "kx-group-order-bits=%lu", (unsigned long)mp_bits(g->r),
1726 "kx-group-elt-bits=%lu", (unsigned long)g->nbits,
1729 "hash=%s", algs->h->name,
1730 "mgf=%s", algs->mgf->name,
1731 "hash-sz=%lu", (unsigned long)algs->h->hashsz,
1734 "bulk-transform=%s", algs->bulk->name,
1735 "bulk-overhead=%lu", (unsigned long)algs->bulk->overhead(algs),
1739 "cipher=%s", algs->c->name,
1740 "cipher-keysz=%lu", (unsigned long)algs->cksz,
1741 "cipher-blksz=%lu", (unsigned long)algs->c->blksz,
1745 "cipher-data-limit=%lu", (unsigned long)algs->expsz,
1749 "mac=%s", algs->m->name,
1750 "mac-keysz=%lu", (unsigned long)algs->mksz,
1751 "mac-tagsz=%lu", (unsigned long)algs->tagsz,
1756 "blkc=%.*s", strlen(algs->b->name) - 4, algs->b->name,
1757 "blkc-keysz=%lu", (unsigned long)algs->bksz,
1758 "blkc-blksz=%lu", (unsigned long)algs->b->blksz,
1764 static void acmd_list(admin *a, unsigned ac, char *av[])
1766 FOREACH_PEER(p, { a_info(a, "%s", p_name(p), A_END); });
1770 static void acmd_ifname(admin *a, unsigned ac, char *av[])
1774 if ((p = a_findpeer(a, av[0])) != 0) {
1775 a_info(a, "%s", p_ifname(p), A_END);
1780 static void acmd_setifname(admin *a, unsigned ac, char *av[])
1784 if ((p = a_findpeer(a, av[0])) != 0) {
1785 a_notify("NEWIFNAME", "?PEER", p, "%s", p_ifname(p), "%s", av[1], A_END);
1786 p_setifname(p, av[1]);
1791 static void acmd_getchal(admin *a, unsigned ac, char *av[])
1795 buf_init(&b, buf_i, PKBUFSZ);
1797 a_info(a, "?B64", BBASE(&b), (size_t)BLEN(&b), A_END);
1801 static void acmd_checkchal(admin *a, unsigned ac, char *av[])
1808 base64_decode(&b64, av[0], strlen(av[0]), &d);
1809 base64_decode(&b64, 0, 0, &d);
1810 buf_init(&b, d.buf, d.len);
1811 if (c_check(&b) || BBAD(&b) || BLEFT(&b))
1812 a_fail(a, "invalid-challenge", A_END);
1818 static void acmd_greet(admin *a, unsigned ac, char *av[])
1824 if ((p = a_findpeer(a, av[0])) != 0) {
1826 base64_decode(&b64, av[1], strlen(av[1]), &d);
1827 base64_decode(&b64, 0, 0, &d);
1828 p_greet(p, d.buf, d.len);
1834 static void acmd_addr(admin *a, unsigned ac, char *av[])
1839 if ((p = a_findpeer(a, av[0])) != 0) {
1841 assert(ad->sa.sa_family == AF_INET);
1842 a_info(a, "?ADDR", ad, A_END);
1847 static void acmd_peerinfo(admin *a, unsigned ac, char *av[])
1853 if ((p = a_findpeer(a, av[0])) != 0) {
1855 a_info(a, "tunnel=%s", ps->tops->name, A_END);
1856 a_info(a, "key=%s", p_tag(p),
1857 "current-key=%s", p->kx.kpub->tag, A_END);
1858 if ((ptag = p_privtag(p)) == 0) ptag = "(default)";
1859 a_info(a, "private-key=%s", ptag,
1860 "current-private-key=%s", p->kx.kpriv->tag, A_END);
1861 a_info(a, "keepalive=%lu", ps->t_ka, A_END);
1866 static void acmd_servinfo(admin *a, unsigned ac, char *av[])
1868 a_info(a, "implementation=edgeware-tripe", A_END);
1869 a_info(a, "version=%s", VERSION, A_END);
1870 a_info(a, "daemon=%s", BOOL(flags & F_DAEMON), A_END);
1874 static void acmd_stats(admin *a, unsigned ac, char *av[])
1879 if ((p = a_findpeer(a, av[0])) == 0)
1883 a_info(a, "start-time=%s", timestr(st->t_start), A_END);
1884 a_info(a, "last-packet-time=%s", timestr(st->t_last), A_END);
1885 a_info(a, "last-keyexch-time=%s", timestr(st->t_kx), A_END);
1886 a_info(a, "packets-in=%lu", st->n_in, "bytes-in=%lu", st->sz_in, A_END);
1888 "packets-out=%lu", st->n_out,
1889 "bytes-out=%lu", st->sz_out,
1892 "keyexch-packets-in=%lu", st->n_kxin,
1893 "keyexch-bytes-in=%lu", st->sz_kxin,
1896 "keyexch-packets-out=%lu", st->n_kxout,
1897 "keyexch-bytes-out=%lu", st->sz_kxout,
1900 "ip-packets-in=%lu", st->n_ipin,
1901 "ip-bytes-in=%lu", st->sz_ipin,
1904 "ip-packets-out=%lu", st->n_ipout,
1905 "ip-bytes-out=%lu", st->sz_ipout,
1907 a_info(a, "rejected-packets=%lu", st->n_reject, A_END);
1911 static void acmd_kill(admin *a, unsigned ac, char *av[])
1915 if ((p = a_findpeer(a, av[0])) != 0) {
1921 static void acmd_forcekx(admin *a, unsigned ac, char *av[])
1925 if ((p = a_findpeer(a, av[0])) != 0) {
1926 kx_start(&p->kx, 1);
1931 static void acmd_reload(admin *a, unsigned ac, char *av[])
1932 { p_keyreload(); a_ok(a); }
1934 static void acmd_quit(admin *a, unsigned ac, char *av[])
1936 a_warn("SERVER", "quit", "admin-request", A_END);
1941 static void acmd_version(admin *a, unsigned ac, char *av[])
1943 a_info(a, "%s", PACKAGE, "%s", VERSION, A_END);
1947 static void acmd_tunnels(admin *a, unsigned ac, char *av[])
1951 for (i = 0; tunnels[i]; i++)
1952 a_info(a, "%s", tunnels[i]->name, A_END);
1956 /* --- The command table and help --- */
1958 typedef struct acmd {
1961 unsigned argmin, argmax;
1962 void (*func)(admin */*a*/, unsigned /*ac*/, char */*av*/[]);
1965 static void acmd_help(admin */*a*/, unsigned /*ac*/, char */*av*/[]);
1967 static const acmd acmdtab[] = {
1968 { "add", "[OPTIONS] PEER ADDR ...", 2, 0xffff, acmd_add },
1969 { "addr", "PEER", 1, 1, acmd_addr },
1970 { "algs", "[PEER]", 0, 1, acmd_algs },
1971 { "bgcancel", "TAG", 1, 1, acmd_bgcancel },
1972 { "checkchal", "CHAL", 1, 1, acmd_checkchal },
1973 { "daemon", 0, 0, 0, acmd_daemon },
1974 { "eping", "[OPTIONS] PEER", 1, 0xffff, acmd_eping },
1975 { "forcekx", "PEER", 1, 1, acmd_forcekx },
1976 { "getchal", 0, 0, 0, acmd_getchal },
1977 { "greet", "PEER CHAL", 2, 2, acmd_greet },
1978 { "help", 0, 0, 0, acmd_help },
1979 { "ifname", "PEER", 1, 1, acmd_ifname },
1980 { "jobs", 0, 0, 0, acmd_jobs },
1981 { "kill", "PEER", 1, 1, acmd_kill },
1982 { "list", 0, 0, 0, acmd_list },
1983 { "notify", "MESSAGE ...", 1, 0xffff, acmd_notify },
1984 { "peerinfo", "PEER", 1, 1, acmd_peerinfo },
1985 { "ping", "[OPTIONS] PEER", 1, 0xffff, acmd_ping },
1986 { "port", 0, 0, 0, acmd_port },
1987 { "quit", 0, 0, 0, acmd_quit },
1988 { "reload", 0, 0, 0, acmd_reload },
1989 { "servinfo", 0, 0, 0, acmd_servinfo },
1990 { "setifname", "PEER NEW-NAME", 2, 2, acmd_setifname },
1991 { "svcclaim", "SERVICE VERSION", 2, 2, acmd_svcclaim },
1992 { "svcensure", "SERVICE [VERSION]", 1, 2, acmd_svcensure },
1993 { "svcfail", "JOBID TOKENS...", 1, 0xffff, acmd_svcfail },
1994 { "svcinfo", "JOBID TOKENS...", 1, 0xffff, acmd_svcinfo },
1995 { "svclist", 0, 0, 0, acmd_svclist },
1996 { "svcok", "JOBID", 1, 1, acmd_svcok },
1997 { "svcquery", "SERVICE", 1, 1, acmd_svcquery },
1998 { "svcrelease", "SERVICE", 1, 1, acmd_svcrelease },
1999 { "svcsubmit", "[OPTIONS] SERVICE TOKENS...",
2000 2, 0xffff, acmd_svcsubmit },
2001 { "stats", "PEER", 1, 1, acmd_stats },
2003 { "trace", "[OPTIONS]", 0, 1, acmd_trace },
2005 { "tunnels", 0, 0, 0, acmd_tunnels },
2006 { "version", 0, 0, 0, acmd_version },
2007 { "warn", "MESSAGE ...", 1, 0xffff, acmd_warn },
2008 { "watch", "[OPTIONS]", 0, 1, acmd_watch },
2012 static void acmd_help(admin *a, unsigned ac, char *av[])
2016 for (c = acmdtab; c->name; c++) {
2018 a_info(a, "%s", c->name, "*%s", c->help, A_END);
2020 a_info(a, "%s", c->name, A_END);
2025 /*----- Connection handling -----------------------------------------------*/
2027 /* --- @a_destroypending@ --- *
2033 * Use: Destroys pending admin connections at a safe time.
2036 static void a_destroypending(void)
2038 admin *a, *aa, *head;
2039 admin_bgop *bg, *bbg;
2040 admin_service *svc, *ssvc;
2042 /* --- Destroy connections marked as pending --- *
2044 * Slightly messy. Killing clients may cause others to finally die. Make
2045 * sure that they can be put on the list without clobbering anything or
2052 for (a = head; a; a = aa) {
2054 assert(a->f & AF_DEAD);
2056 /* --- Report what we're doing --- */
2058 T( trace(T_ADMIN, "admin: completing destruction of connection %u",
2061 /* --- If this is the foreground client then shut down --- */
2063 if (a->f & AF_FOREGROUND) {
2064 T( trace(T_ADMIN, "admin: foreground client quit: shutting down"); )
2065 a_warn("SERVER", "quit", "foreground-eof", A_END);
2069 /* --- Abort any background jobs in progress --- */
2071 for (bg = a->bg; bg; bg = bbg) {
2074 if (bg->tag) xfree(bg->tag);
2078 /* --- Release services I hold, and abort pending jobs --- */
2080 for (svc = a->svcs; svc; svc = ssvc) {
2084 a_jobtablefinal(&a->j);
2086 /* --- Close file descriptors and selectory --- */
2088 selbuf_destroy(&a->b);
2089 if (a->b.reader.fd != a->w.fd) close(a->b.reader.fd);
2091 if (a_stdin == a) a_stdin = 0;
2100 /* --- @a_destroy@ --- *
2102 * Arguments: @admin *a@ = pointer to an admin block
2106 * Use: Destroys an admin block. This requires a certain amount of
2110 static void freequeue(oqueue *q)
2114 for (o = q->hd; o; o = oo) {
2121 static void a_destroy(admin *a)
2126 if (a->next) a->next->prev = a->prev;
2127 if (a->prev) a->prev->next = a->next;
2128 else admins = a->next;
2130 if (a->out.hd) sel_rmfile(&a->w);
2137 T( trace(T_ADMIN, "admin: killing connection %u", a->seq); )
2140 /* --- @a_line@ --- *
2142 * Arguments: @char *p@ = pointer to the line read
2143 * @size_t len@ = length of the line
2144 * @void *vp@ = pointer to my admin block
2148 * Use: Handles a line of input.
2151 static void a_line(char *p, size_t len, void *vp)
2166 selbuf_disable(&a->b);
2170 ac = str_qsplit(p, av, N(av) - 1, 0, STRF_QUOTE);
2174 for (c = acmdtab; c->name; c++) {
2175 if (mystrieq(av[0], c->name)) {
2177 if (c->argmin > ac || ac > c->argmax) {
2179 a_fail(a, "bad-syntax", "%s", c->name, "", A_END);
2181 a_fail(a, "bad-syntax", "%s", c->name, "%s", c->help, A_END);
2183 c->func(a, ac, av + 1);
2187 a_fail(a, "unknown-command", "%s", av[0], A_END);
2190 /* --- @a_create@ --- *
2192 * Arguments: @int fd_in, fd_out@ = file descriptors to use
2193 * @unsigned f@ = initial flags to set
2197 * Use: Creates a new admin connection.
2200 void a_create(int fd_in, int fd_out, unsigned f)
2202 admin *a = CREATE(admin);
2204 T( static unsigned seq = 0;
2206 T( trace(T_ADMIN, "admin: accepted connection %u", a->seq); )
2210 a_jobtableinit(&a->j);
2212 if (fd_in == STDIN_FILENO) a_stdin = a;
2213 fdflags(fd_in, O_NONBLOCK, O_NONBLOCK, FD_CLOEXEC, FD_CLOEXEC);
2214 if (fd_out != fd_in)
2215 fdflags(fd_out, O_NONBLOCK, O_NONBLOCK, FD_CLOEXEC, FD_CLOEXEC);
2216 selbuf_init(&a->b, &sel, fd_in, a_line, a);
2217 sel_initfile(&sel, &a->w, fd_out, SEL_WRITE, a_flush, a);
2218 a->out.hd = a->out.tl = 0;
2221 if (admins) admins->prev = a;
2225 /* --- @a_accept@ --- *
2227 * Arguments: @int fd@ = file descriptor to accept
2228 * @unsigned mode@ = what to do
2229 * @void *v@ = uninteresting pointer
2233 * Use: Accepts a new admin connection.
2236 static void a_accept(int fd, unsigned mode, void *v)
2239 struct sockaddr_un sun;
2240 socklen_t sz = sizeof(sun);
2242 if ((nfd = accept(fd, (struct sockaddr *)&sun, &sz)) < 0) {
2243 if (errno != EINTR && errno != EAGAIN && errno != EWOULDBLOCK &&
2244 errno != ECONNABORTED && errno != EPROTO)
2245 a_warn("ADMIN", "accept-error", "?ERRNO", A_END);
2248 a_create(nfd, nfd, 0);
2251 /* --- @a_preselect@ --- *
2257 * Use: Informs the admin module that we're about to select again,
2258 * and that it should do cleanup things it has delayed until a
2262 void a_preselect(void) { if (a_dead) a_destroypending(); }
2264 /* --- @a_daemon@ --- *
2270 * Use: Informs the admin module that it's a daemon.
2273 void a_daemon(void) { flags |= F_DAEMON; }
2275 /* --- @a_init@ --- *
2277 * Arguments: @const char *name@ = socket name to create
2278 * @uid_t u@ = user to own the socket
2279 * @gid_t g@ = group to own the socket
2280 * @mode_t m@ = permissions to set on the socket
2284 * Use: Creates the admin listening socket.
2287 void a_init(const char *name, uid_t u, gid_t g, mode_t m)
2291 struct sockaddr_un sun;
2292 struct sigaction sa;
2296 /* --- Create services table --- */
2298 sym_create(&a_svcs);
2300 /* --- Set up the socket address --- */
2302 sz = strlen(name) + 1;
2303 if (sz > sizeof(sun.sun_path))
2304 die(EXIT_FAILURE, "socket name `%s' too long", name);
2306 sun.sun_family = AF_UNIX;
2307 memcpy(sun.sun_path, name, sz);
2308 sz += offsetof(struct sockaddr_un, sun_path);
2310 /* --- Attempt to bind to the socket --- */
2312 omask = umask(0077);
2314 if ((fd = socket(PF_UNIX, SOCK_STREAM, 0)) < 0)
2315 die(EXIT_FAILURE, "couldn't create socket: %s", strerror(errno));
2316 if (bind(fd, (struct sockaddr *)&sun, sz) < 0) {
2319 if (errno != EADDRINUSE) {
2320 die(EXIT_FAILURE, "couldn't bind to address `%s': %s",
2321 sun.sun_path, strerror(e));
2324 die(EXIT_FAILURE, "too many retries; giving up");
2326 if (!connect(fd, (struct sockaddr *)&sun, sz)) {
2327 die(EXIT_FAILURE, "server already listening on admin socket `%s'",
2330 if (errno != ECONNREFUSED)
2331 die(EXIT_FAILURE, "couldn't bind to address: %s", strerror(e));
2332 if (stat(sun.sun_path, &st)) {
2333 die(EXIT_FAILURE, "couldn't stat `%s': %s",
2334 sun.sun_path, strerror(errno));
2336 if (!S_ISSOCK(st.st_mode))
2337 die(EXIT_FAILURE, "object `%s' isn't a socket", sun.sun_path);
2338 T( trace(T_ADMIN, "admin: stale socket found; removing it"); )
2339 unlink(sun.sun_path);
2343 if (chown(sun.sun_path, u, g)) {
2344 die(EXIT_FAILURE, "failed to set socket owner: %s",
2347 if (chmod(sun.sun_path, m)) {
2348 die(EXIT_FAILURE, "failed to set socket permissions: %s",
2352 fdflags(fd, O_NONBLOCK, O_NONBLOCK, FD_CLOEXEC, FD_CLOEXEC);
2354 die(EXIT_FAILURE, "couldn't listen on socket: %s", strerror(errno));
2356 /* --- Listen to the socket --- */
2358 sel_initfile(&sel, &sock, fd, SEL_READ, a_accept, 0);
2362 T( trace_custom(a_trace, 0);
2363 trace(T_ADMIN, "admin: enabled custom tracing"); )
2366 /* --- Set up signal handlers --- */
2368 sig_add(&s_term, SIGTERM, a_sigdie, 0);
2369 sig_add(&s_hup, SIGHUP, a_sighup, 0);
2370 signal(SIGPIPE, SIG_IGN);
2371 sigaction(SIGINT, 0, &sa);
2372 if (sa.sa_handler != SIG_IGN)
2373 sig_add(&s_int, SIGINT, a_sigdie, 0);
2376 /*----- That's all, folks -------------------------------------------------*/