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 *);
319 /* --- @a_format@ --- *
321 * Arguments: @dstr *d@ = where to leave the formatted message
322 * @const char *fmt@ = pointer to format string
326 * Use: Writes a tokenized message into a string, for later
330 void a_format(dstr *d, const char *fmt, ...)
335 a_vformat(d, fmt, &ap);
339 /* --- @a_write@, @a_vwrite@ --- *
341 * Arguments: @admin *a@ = admin connection to write to
342 * @const char *status@ = status code to report
343 * @const char *tag@ = tag string, or null
344 * @const char *fmt@ = pointer to format string
345 * @va_list *ap@ = arguments in list
346 * @...@ = other arguments
350 * Use: Sends a message to an admin connection.
353 static void a_vwrite(admin *a, const char *status, const char *tag,
354 const char *fmt, va_list *ap)
358 if (tag) dstr_puts(&d, "BG");
359 dstr_puts(&d, status);
360 if (tag) u_quotify(&d, tag);
361 a_vformat(&d, fmt, ap);
363 dosend(a, d.buf, d.len);
367 static void a_write(admin *a, const char *status, const char *tag,
368 const char *fmt, ...)
373 a_vwrite(a, status, tag, fmt, &ap);
377 /* --- @a_ok@, @a_fail@ --- *
379 * Arguments: @admin *a@ = connection
380 * @const char *fmt@ = format string
381 * @...@ = other arguments
385 * Use: Convenience functions for @a_write@.
388 static void a_ok(admin *a) { a_write(a, "OK", 0, A_END); }
390 static void a_fail(admin *a, const char *fmt, ...)
395 a_vwrite(a, "FAIL", 0, fmt, &ap);
399 /* --- @a_info@ --- *
401 * Arguments: @admin *a@ = connection
402 * @const char *fmt@ = format string
403 * @...@ = other arguments
407 * Use: Report information to an admin client.
410 void a_info(admin *a, const char *fmt, ...)
415 a_vwrite(a, "INFO", 0, fmt, &ap);
419 /* --- @a_alert@, @a_valert@, @a_rawalert@ --- *
421 * Arguments: @unsigned f_and, f_eq@ = filter for connections
422 * @const char *status@ = status string
423 * @const char *fmt@ = pointer to format string
424 * @const char *p@ = pointer to raw string
425 * @size_t sz@ = size of raw string
426 * @va_list *ap@ = arguments in list
427 * @...@ = other arguments
431 * Use: Write a message to all admin connections matched by the given
435 static void a_rawalert(unsigned f_and, unsigned f_eq, const char *status,
436 const char *p, size_t sz)
441 if (!(flags & F_INIT))
443 dstr_puts(&d, status);
446 dstr_putm(&d, p, sz);
451 for (a = admins; a; a = aa) {
453 if ((a->f & f_and) == f_eq)
454 dosend(a, d.buf, d.len);
459 static void a_valert(unsigned f_and, unsigned f_eq, const char *status,
460 const char *fmt, va_list *ap)
464 if (!(flags & F_INIT))
466 a_vformat(&d, fmt, ap);
467 a_rawalert(f_and, f_eq, status, fmt ? d.buf : 0, fmt ? d.len : 0);
471 static void a_alert(unsigned f_and, unsigned f_eq, const char *status,
472 const char *fmt, ...)
477 a_valert(f_and, f_eq, status, fmt, &ap);
481 /* --- @a_warn@ --- *
483 * Arguments: @const char *fmt@ = pointer to format string
484 * @...@ = other arguments
488 * Use: Informs all admin connections of a warning.
491 void a_warn(const char *fmt, ...)
497 a_valert(0, 0, "WARN", fmt, &ap);
500 fprintf(stderr, "%s: ", QUIS);
501 a_vformat(&d, fmt, &ap);
503 dstr_write(&d, stderr);
509 /* --- @a_trace@ --- *
511 * Arguments: @const char *p@ = pointer to a buffer
512 * @size_t sz@ = size of the buffer
513 * @void *v@ = uninteresting pointer
517 * Use: Custom trace output handler. Sends trace messages to
518 * interested admin connections.
522 static void a_trace(const char *p, size_t sz, void *v)
523 { a_rawalert(AF_TRACE, AF_TRACE, "TRACE", p, sz); }
526 /* --- @a_notify@ --- *
528 * Arguments: @const char *fmt@ = pointer to format string
529 * @...@ = other arguments
533 * Use: Sends a notification to interested admin connections.
536 void a_notify(const char *fmt, ...)
541 a_valert(AF_NOTE, AF_NOTE, "NOTE", fmt, &ap);
545 /* --- @a_quit@ --- *
551 * Use: Shuts things down nicely.
558 FOREACH_PEER(p, { p_destroy(p); });
563 /* --- @a_sigdie@ --- *
565 * Arguments: @int sig@ = signal number
566 * @void *v@ = an uninteresting argument
570 * Use Shuts down on receipt of a fatal signal.
573 static void a_sigdie(int sig, void *v)
579 case SIGTERM: p = "SIGTERM"; break;
580 case SIGINT: p = "SIGINT"; break;
582 sprintf(buf, "%i", sig);
586 a_warn("SERVER", "quit", "signal", "%s", p, A_END);
590 /* --- @a_sighup@ --- *
592 * Arguments: @int sig@ = signal number
593 * @void *v@ = an uninteresting argument
597 * Use Logs a message about SIGHUP not being useful.
600 static void a_sighup(int sig, void *v)
601 { a_warn("SERVER", "ignore", "signal", "SIGHUP", A_END); }
603 /* --- @a_parsetime@ --- *
605 * Arguments; @const char *p@ = time string to parse
607 * Returns: Time in seconds, or @< 0@ on error.
610 static long a_parsetime(const char *p)
613 long t = strtol(p, &q, 0);
619 case 's': if (q[1] != 0)
626 /* --- @a_findpeer@ --- *
628 * Arguments: @admin *a@ = admin connection
629 * @const char *pn@ = peer name
631 * Returns: The peer, or null if not there.
633 * Use: Finds a peer, reporting an error if it failed.
636 static peer *a_findpeer(admin *a, const char *pn)
640 if ((p = p_find(pn)) == 0)
641 a_fail(a, "unknown-peer", "%s", pn, A_END);
645 /*----- Backgrounded operations -------------------------------------------*/
648 (((admin_bgop *)(bg))->tag ? ((admin_bgop *)(bg))->tag : "<foreground>")
650 /* --- @a_bgfind@ --- *
652 * Arguments: @admin *a@ = a client block
653 * @const char *tag@ = the requested tag
655 * Returns: The requested background job, or null.
658 static admin_bgop *a_bgfind(admin *a, const char *tag)
662 for (bg = a->bg; bg; bg = bg->next) {
663 if (bg->tag && strcmp(tag, bg->tag) == 0)
669 /* --- @a_bgrelease@ --- *
671 * Arguments: @admin_bgop *bg@ = backgrounded operation
675 * Use: Removes a backgrounded operation from the queue, since
676 * (presumably) it's done.
679 static void a_bgrelease(admin_bgop *bg)
683 T( trace(T_ADMIN, "admin: release bgop %s", BGTAG(bg)); )
684 if (bg->tag) xfree(bg->tag);
685 else selbuf_enable(&a->b);
686 if (bg->next) bg->next->prev = bg->prev;
687 if (bg->prev) bg->prev->next = bg->next;
688 else a->bg = bg->next;
690 if (!a->bg && (a->f & AF_CLOSE)) a_destroy(a);
693 /* --- @a_bgok@, @a_bginfo@, @a_bgfail@ --- *
695 * Arguments: @admin_bgop *bg@ = backgrounded operation
696 * @const char *fmt@ = format string
697 * @...@ = other arguments
701 * Use: Convenience functions for @a_write@.
704 static void a_bgok(admin_bgop *bg)
705 { a_write(bg->a, "OK", bg->tag, A_END); }
707 static void a_bginfo(admin_bgop *bg, const char *fmt, ...)
711 a_vwrite(bg->a, "INFO", bg->tag, fmt, &ap);
715 static void a_bgfail(admin_bgop *bg, const char *fmt, ...)
719 a_vwrite(bg->a, "FAIL", bg->tag, fmt, &ap);
723 /* --- @a_bgadd@ --- *
725 * Arguments: @admin *a@ = administration connection
726 * @admin_bgop *bg@ = pointer to background operation
727 * @const char *tag@ = background tag, or null for foreground
728 * @void (*cancel)(admin_bgop *)@ = cancel function
730 * Returns: Zero for success, nonzero on failure.
732 * Use: Links a background job into the list.
735 static int a_bgadd(admin *a, admin_bgop *bg, const char *tag,
736 void (*cancel)(admin_bgop *))
739 if (a_bgfind(a, tag)) {
740 a_fail(a, "tag-exists", "%s", tag, A_END);
743 bg->tag = xstrdup(tag);
747 selbuf_disable(&a->b);
753 if (a->bg) a->bg->prev = bg;
755 T( trace(T_ADMIN, "admin: add bgop %s", BGTAG(bg)); )
756 if (tag) a_write(a, "DETACH", tag, A_END);
760 /*----- Job table manipulation --------------------------------------------*/
763 #define JOB_INDEXMASK ((1ul << JOB_SHIFT) - 1)
764 #define JOB_SEQMASK ((1ul << (32 - JOB_SHIFT)) - 1)
766 #define JOB_END 0xfffffffful
768 static unsigned long a_joboffset;
770 /* --- @a_jobidencode@ --- *
772 * Arguments: @admin_svcop *svc@ = pointer to a service operation
774 * Returns: A jobid for this job, in an internal static buffer.
776 * Use: Constructs a jobid. In order to dissuade people from
777 * predicting jobids, we obfuscate them.
779 * A `raw' jobid consists of two 16-bit fields. The low 16 bits
780 * are an index into a big array. The high 16 bits are a
781 * sequence number recording how many times that slot has been
784 * This `raw' jobid is then obfuscated by adding a randomly-
785 * generated offset, and multiplying (mod %$2^{32}$%) by a fixed
789 static const char *a_jobidencode(admin_svcop *svc)
791 admin_jobtable *j = &svc->prov->j;
796 assert(svc->index <= JOB_INDEXMASK);
797 seq = j->v[svc->index].seq;
798 assert(seq <= JOB_SEQMASK);
799 pre = (unsigned long)svc->index | ((unsigned long)seq << JOB_SHIFT);
800 sprintf(buf, "J%08lx", ((pre + a_joboffset) * 0x0f87a7a3ul) & 0xffffffff);
804 /* --- @a_jobiddecode@ --- *
806 * Arguments: @admin_jobtable *j@ = pointer to a job table
807 * @const char *jid@ = pointer to a jobid string
809 * Returns: A pointer to the job's @svcop@ structure.
812 static admin_svcop *a_jobiddecode(admin_jobtable *j, const char *jid)
819 for (i = 1; i < 9; i++) {
820 if (!isxdigit((unsigned char)jid[i]))
825 pre = strtoul(jid + 1, 0, 16);
826 pre = ((pre * 0xbd11c40bul) - a_joboffset) & 0xffffffff;
827 i = pre & JOB_INDEXMASK;
828 if (i >= j->n || j->v[i].seq != (pre >> JOB_SHIFT))
830 return (j->v[i].u.op);
833 /* --- @a_jobcreate@ --- *
835 * Arguments: @admin *a@ = pointer to administration client
837 * Returns: A pointer to a freshly-allocated @svcop@, or null.
839 * Use: Allocates a fresh @svcop@ and links it into a job table.
842 static admin_svcop *a_jobcreate(admin *a)
847 admin_jobtable *j = &a->j;
849 if (j->free != JOB_END) {
851 j->free = j->v[i].u.next;
854 if (j->sz > JOB_INDEXMASK)
859 j->v = xmalloc(j->sz * sizeof(*j->v));
862 j->v = xrealloc(j->v, j->sz * sizeof(*j->v), sz * sizeof(*j->v));
868 svc = xmalloc(sizeof(*svc));
871 svc->next = j->active;
873 if (j->active) j->active->prev = svc;
876 IF_TRACING(T_ADMIN, {
877 trace(T_ADMIN, "admin: created job %s (%u)", a_jobidencode(svc), i);
882 /* --- @a_jobdestroy@ --- *
884 * Arguments: @admin_svcop *svc@ = pointer to job block
888 * Use: Frees up a completed (or cancelled) job.
891 static void a_jobdestroy(admin_svcop *svc)
893 admin *a = svc->prov;
894 admin_jobtable *j = &a->j;
895 unsigned i = svc->index;
897 IF_TRACING(T_ADMIN, {
898 trace(T_ADMIN, "admin: destroying job %s (%u)", a_jobidencode(svc), i);
900 assert(j->v[i].u.op = svc);
901 j->v[i].u.next = j->free;
904 if (svc->next) svc->next->prev = svc->prev;
905 if (svc->prev) svc->prev->next = svc->next;
906 else j->active = svc->next;
909 /* --- @a_jobtableinit@ --- *
911 * Arguments: @admin_jobtable *j@ = pointer to job table
915 * Use: Initializes a job table.
918 static void a_jobtableinit(admin_jobtable *j)
921 a_joboffset = GR_RANGE(&rand_global, 0xffffffff) + 1;
928 /* --- @a_jobtablefinal@ --- *
930 * Arguments: @admin_jobtable *j@ = pointer to job table
934 * Use: Closes down a job table.
937 static void a_jobtablefinal(admin_jobtable *j)
939 admin_svcop *svc, *ssvc;
941 for (svc = j->active; svc; svc = ssvc) {
943 a_bgfail(&svc->bg, "provider-failed", A_END);
944 a_bgrelease(&svc->bg);
946 if (j->v) xfree(j->v);
949 /*----- Services infrastructure -------------------------------------------*/
951 /* --- @a_svcfind@ --- *
953 * Arguments: @admin *a@ = the requesting client
954 * @const char *name@ = service name wanted
956 * Returns: The service requested, or null.
958 * Use: Finds a service; reports an error if the service couldn't be
962 static admin_service *a_svcfind(admin *a, const char *name)
966 if ((svc = sym_find(&a_svcs, name, -1, 0, 0)) == 0) {
967 a_fail(a, "unknown-service", "%s", name, A_END);
973 /* --- @a_svcunlink@ --- *
975 * Arguments: @admin_service *svc@ = pointer to service structure
979 * Use: Unlinks the service from its provider, without issuing a
980 * message or freeing the structure. The version string is
984 static void a_svcunlink(admin_service *svc)
987 svc->next->prev = svc->prev;
989 svc->prev->next = svc->next;
991 svc->prov->svcs = svc->next;
995 /* --- @a_svcrelease@ --- *
997 * Arguments: @admin_service *svc@ = pointer to service structure
1001 * Use: Releases a service and frees its structure.
1004 static void a_svcrelease(admin_service *svc)
1006 a_notify("SVCRELEASE", "%s", SYM_NAME(svc), A_END);
1008 sym_remove(&a_svcs, svc);
1011 /*----- Name resolution operations ----------------------------------------*/
1013 /* --- @a_resolved@ --- *
1015 * Arguments: @struct hostent *h@ = pointer to resolved hostname
1016 * @void *v@ = pointer to resolver operation
1020 * Use: Handles a completed name resolution.
1023 static void a_resolved(struct hostent *h, void *v)
1027 T( trace(T_ADMIN, "admin: resop %s resolved", BGTAG(r)); )
1030 a_bgfail(&r->bg, "resolve-error", "%s", r->addr, A_END);
1031 r->func(r, ARES_FAIL);
1033 memcpy(&r->sa.sin.sin_addr, h->h_addr, sizeof(struct in_addr));
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->sa.sin.sin_family = AF_INET;
1117 r->sasz = sizeof(r->sa.sin);
1118 r->addr = xstrdup(av[i]);
1122 pt = strtoul(av[i + 1], &p, 0);
1124 struct servent *s = getservbyname(av[i + 1], "udp");
1126 a_fail(a, "unknown-service", "%s", av[i + 1], A_END);
1129 pt = ntohs(s->s_port);
1132 if (pt == 0 || pt >= 65536) {
1133 a_fail(a, "invalid-port", "%lu", pt, A_END);
1136 r->sa.sin.sin_port = htons(pt);
1138 /* --- Report backgrounding --- *
1140 * Do this for consistency of interface, even if we're going to get the
1141 * answer straight away.
1144 if (a_bgadd(a, &r->bg, tag, a_rescancel))
1146 T( trace(T_ADMIN, "admin: %u, resop %s, hostname `%s'",
1147 a->seq, BGTAG(r), r->addr); )
1149 /* --- If the name is numeric, do it the easy way --- */
1151 if (inet_aton(av[i], &r->sa.sin.sin_addr)) {
1152 T( trace(T_ADMIN, "admin: resop %s done the easy way", BGTAG(r)); )
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.sasz = add->r.sasz;
1231 add->peer.sa = add->r.sa;
1232 if (p_findbyaddr(&add->r.sa))
1233 a_bgfail(&add->r.bg, "peer-addr-exists", "?ADDR", &add->r.sa, A_END);
1234 else if (p_find(add->peer.name))
1235 a_bgfail(&add->r.bg, "peer-exists", "%s", add->peer.name, A_END);
1236 else if (!p_create(&add->peer))
1237 a_bgfail(&add->r.bg, "peer-create-fail", "%s", add->peer.name, A_END);
1242 if (add->peer.tag) xfree(add->peer.tag);
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, {
1293 xfree(add->peer.tag);
1294 add->peer.tag = xstrdup(arg);
1296 OPT("-mobile", { add->peer.f |= PSF_MOBILE; })
1297 OPTARG("-priv", arg, {
1298 if (add->peer.privtag)
1299 xfree(add->peer.privtag);
1300 add->peer.privtag = xstrdup(arg);
1304 /* --- Make sure someone's not got there already --- */
1306 if (!av[0] || !av[1])
1309 a_fail(a, "peer-exists", "%s", *av, A_END);
1312 add->peer.name = xstrdup(*av++);
1315 /* --- Crank up the resolver --- */
1317 a_resolve(a, &add->r, tag, a_doadd, ac, av);
1320 /* --- Clearing up --- */
1323 a_fail(a, "bad-syntax", "add", "[OPTIONS] PEER ADDR ...", A_END);
1325 if (add->peer.name) xfree(add->peer.name);
1326 if (add->peer.tag) xfree(add->peer.tag);
1327 if (add->peer.privtag) xfree(add->peer.privtag);
1332 /*----- Ping --------------------------------------------------------------*/
1334 /* --- @a_pingcancel@ --- *
1336 * Arguments: @admin_bgop *bg@ = background operation block
1340 * Use: Cancels a running ping.
1343 static void a_pingcancel(admin_bgop *bg)
1345 admin_pingop *pg = (admin_pingop *)bg;
1346 T( trace(T_ADMIN, "admin: cancel ping op %s", BGTAG(pg)); )
1347 p_pingdone(&pg->ping, PING_NONOTIFY);
1350 /* --- @a_pong@ --- *
1352 * Arguments: @int rc@ = return code
1353 * @void *v@ = ping operation block
1357 * Use: Collects what happened to a ping message.
1360 static void a_pong(int rc, void *v)
1362 admin_pingop *pg = v;
1368 gettimeofday(&tv, 0);
1369 tv_sub(&tv, &tv, &pg->pingtime);
1370 millis = (double)tv.tv_sec * 1000 + (double)tv.tv_usec/1000;
1371 a_bginfo(&pg->bg, "ping-ok", "%.1f", millis, A_END);
1375 a_bginfo(&pg->bg, "ping-timeout", A_END);
1379 a_bginfo(&pg->bg, "ping-peer-died", A_END);
1385 T( trace(T_ADMIN, "admin: ponged ping op %s", BGTAG(pg)); )
1386 a_bgrelease(&pg->bg);
1389 /* --- @acmd_ping@, @acmd_eping@ --- *
1391 * Arguments: @admin *a@ = connection which requested the ping
1392 * @unsigned ac@ = argument count
1393 * @char *av[]@ = pointer to the argument list
1397 * Use: Pings a peer.
1400 static void a_ping(admin *a, unsigned ac, char *av[],
1401 const char *cmd, unsigned msg)
1405 admin_pingop *pg = 0;
1406 const char *tag = 0;
1409 OPTARG("-background", arg, { tag = arg; })
1410 OPTTIME("-timeout", arg, { t = arg; })
1412 if (!*av || av[1]) goto bad_syntax;
1413 if ((p = a_findpeer(a, *av)) == 0)
1415 pg = xmalloc(sizeof(*pg));
1416 gettimeofday(&pg->pingtime, 0);
1417 if (a_bgadd(a, &pg->bg, tag, a_pingcancel))
1419 T( trace(T_ADMIN, "admin: ping op %s: %s to %s",
1420 BGTAG(pg), cmd, p_name(p)); )
1421 if (p_pingsend(p, &pg->ping, msg, t, a_pong, pg)) {
1422 a_bgfail(&pg->bg, "ping-send-failed", A_END);
1423 a_bgrelease(&pg->bg);
1428 a_fail(a, "bad-syntax", "%s", cmd, "[OPTIONS] PEER", cmd, A_END);
1434 static void acmd_ping(admin *a, unsigned ac, char *av[])
1435 { a_ping(a, ac, av, "ping", MISC_PING); }
1436 static void acmd_eping(admin *a, unsigned ac, char *av[])
1437 { a_ping(a, ac, av, "eping", MISC_EPING); }
1439 /*----- Service commands --------------------------------------------------*/
1441 static void acmd_svcclaim(admin *a, unsigned ac, char *av[])
1446 svc = sym_find(&a_svcs, av[0], -1, sizeof(*svc), &f);
1448 if (versioncmp(av[1], svc->version) <= 0) {
1451 "%s", SYM_NAME(svc),
1456 a_write(svc->prov, "SVCCLAIM", 0, "%s", av[0], "%s", av[1], A_END);
1460 svc->version = xstrdup(av[1]);
1461 svc->next = a->svcs;
1463 if (a->svcs) a->svcs->prev = svc;
1465 a_notify("SVCCLAIM", "%s", SYM_NAME(svc), "%s", svc->version, A_END);
1469 static void acmd_svcrelease(admin *a, unsigned ac, char *av[])
1473 if ((svc = a_svcfind(a, av[0])) == 0)
1475 if (svc->prov != a) {
1476 a_fail(a, "not-service-provider", "%s", SYM_NAME(svc), A_END);
1483 static void acmd_svcensure(admin *a, unsigned ac, char *av[])
1487 if ((svc = a_svcfind(a, av[0])) == 0)
1489 if (av[1] && versioncmp(svc->version, av[1]) < 0) {
1490 a_fail(a, "service-too-old",
1491 "%s", SYM_NAME(svc),
1499 static void acmd_svcquery(admin *a, unsigned ac, char *av[])
1503 if ((svc = a_svcfind(a, av[0])) != 0) {
1504 a_info(a, "name=%s", SYM_NAME(svc), "version=%s", svc->version, A_END);
1509 static void acmd_svclist(admin *a, unsigned ac, char *av[])
1514 for (sym_mkiter(&i, &a_svcs); (svc = sym_next(&i)) != 0; )
1515 a_info(a, "%s", SYM_NAME(svc), "%s", svc->version, A_END);
1519 static void a_canceljob(admin_bgop *bg)
1521 admin_svcop *svc = (admin_svcop *)bg;
1523 a_write(svc->prov, "SVCCANCEL", 0, "%s", a_jobidencode(svc), A_END);
1527 static void acmd_svcsubmit(admin *a, unsigned ac, char *av[])
1529 const char *tag = 0;
1532 const char *ver = 0;
1536 OPTARG("-background", arg, { tag = arg; })
1537 OPTARG("-version", arg, { ver = arg; })
1539 if (!*av) goto bad_syntax;
1540 if ((svc = a_svcfind(a, *av)) == 0) goto fail;
1541 if (ver && versioncmp(svc->version, ver) < 0) {
1542 a_fail(a, "service-too-old",
1543 "%s", SYM_NAME(svc),
1548 if ((svcop = a_jobcreate(svc->prov)) == 0) {
1549 a_fail(a, "provider-overloaded", A_END);
1552 if (a_bgadd(a, &svcop->bg, tag, a_canceljob)) {
1553 a_jobdestroy(svcop);
1556 a_write(svc->prov, "SVCJOB", 0,
1557 "%s", a_jobidencode(svcop),
1563 a_fail(a, "bad-syntax", "svcsubmit", "[OPTIONS] SERVICE ARGS...", A_END);
1570 static void a_replycmd(admin *a, const char *status, int donep, char *av[])
1574 if ((svc = a_jobiddecode(&a->j, av[0])) == 0) {
1575 a_fail(a, "unknown-jobid", av[0], A_END);
1578 a_write(svc->bg.a, status, svc->bg.tag, "?TOKENS", av + 1, A_END);
1581 a_bgrelease(&svc->bg);
1586 static void acmd_svcok(admin *a, unsigned ac, char *av[])
1587 { a_replycmd(a, "OK", 1, av); }
1588 static void acmd_svcinfo(admin *a, unsigned ac, char *av[])
1589 { a_replycmd(a, "INFO", 0, av); }
1590 static void acmd_svcfail(admin *a, unsigned ac, char *av[])
1591 { a_replycmd(a, "FAIL", 1, av); }
1593 /*----- Administration commands -------------------------------------------*/
1595 /* --- Miscellaneous commands --- */
1597 /* --- @traceish@ --- *
1599 * Arguments: @admin *a@ = connection to complain on
1600 * @unsigned ac@ = number of arguments
1601 * @char *av[]@ = vector of arguments
1602 * @const char *what@ = what we're messing with
1603 * @const trace_opt *tt@ = options table
1604 * @unsigned *ff@ = where the flags are
1606 * Returns: Nonzero if anything changed.
1608 * Use: Guts of trace-ish commands like `trace' and `watch'.
1611 static int traceish(admin *a, unsigned ac, char *av[],
1612 const char *what, const trace_opt *tt, unsigned *ff)
1616 if (!ac || strcmp(av[0], "?") == 0) {
1618 for (t = tt; t->ch; t++) {
1619 a_info(a, "*%c%c %s",
1620 t->ch, (*ff & t->f) == t->f ? '+' : ' ', t->help, A_END);
1630 case '+': sense = 1; break;
1631 case '-': sense = 0; break;
1633 for (t = tt; t->ch; t++) {
1635 if (sense) f |= t->f;
1640 a_fail(a, "bad-%s-option", what, "%c", *p, A_END);
1656 static void acmd_trace(admin *a, unsigned ac, char *av[])
1658 if (traceish(a, ac, av, "trace", tr_opts, &tr_flags))
1659 trace_level(tr_flags);
1664 static void acmd_watch(admin *a, unsigned ac, char *av[])
1665 { traceish(a, ac, av, "watch", w_opts, &a->f); }
1667 static void alertcmd(admin *a, unsigned f_and, unsigned f_eq,
1668 const char *status, char *av[])
1669 { a_alert(f_and, f_eq, status, "USER", "?TOKENS", av, A_END); a_ok(a); }
1670 static void acmd_notify(admin *a, unsigned ac, char *av[])
1671 { alertcmd(a, AF_NOTE, AF_NOTE, "NOTE", av); }
1672 static void acmd_warn(admin *a, unsigned ac, char *av[])
1673 { alertcmd(a, AF_WARN, AF_WARN, "WARN", av); }
1675 static void acmd_port(admin *a, unsigned ac, char *av[])
1676 { a_info(a, "%u", p_port(), A_END); a_ok(a); }
1678 static void acmd_daemon(admin *a, unsigned ac, char *av[])
1680 if (flags & F_DAEMON)
1681 a_fail(a, "already-daemon", A_END);
1683 a_notify("DAEMON", A_END);
1687 a_fail(a, "daemon-error", "?ERRNO", A_END);
1695 static void acmd_jobs(admin *a, unsigned ac, char *av[])
1699 for (bg = a->bg; bg; bg = bg->next) {
1701 a_info(a, "%s", bg->tag, A_END);
1706 static void acmd_bgcancel(admin *a, unsigned ac, char *av[])
1710 if ((bg = a_bgfind(a, av[0])) == 0)
1711 a_fail(a, "unknown-tag", "%s", av[0], A_END);
1719 static void acmd_algs(admin *a, unsigned ac, char *av[])
1724 const algswitch *algs;
1729 if ((p = a_findpeer(a, av[0])) == 0) return;
1736 "kx-group=%s", g->ops->name,
1737 "kx-group-order-bits=%lu", (unsigned long)mp_bits(g->r),
1738 "kx-group-elt-bits=%lu", (unsigned long)g->nbits,
1741 "hash=%s", algs->h->name,
1742 "mgf=%s", algs->mgf->name,
1743 "hash-sz=%lu", (unsigned long)algs->h->hashsz,
1746 "bulk-transform=%s", algs->bulk->ops->name,
1747 "bulk-overhead=%lu",
1748 (unsigned long)algs->bulk->ops->overhead(algs->bulk),
1750 algs->bulk->ops->alginfo(algs->bulk, a);
1752 "cipher-data-limit=%lu",
1753 (unsigned long)algs->bulk->ops->expsz(algs->bulk),
1758 static void acmd_list(admin *a, unsigned ac, char *av[])
1760 FOREACH_PEER(p, { a_info(a, "%s", p_name(p), A_END); });
1764 static void acmd_ifname(admin *a, unsigned ac, char *av[])
1768 if ((p = a_findpeer(a, av[0])) != 0) {
1769 a_info(a, "%s", p_ifname(p), A_END);
1774 static void acmd_setifname(admin *a, unsigned ac, char *av[])
1778 if ((p = a_findpeer(a, av[0])) != 0) {
1779 a_notify("NEWIFNAME", "?PEER", p, "%s", p_ifname(p), "%s", av[1], A_END);
1780 p_setifname(p, av[1]);
1785 static void acmd_getchal(admin *a, unsigned ac, char *av[])
1789 buf_init(&b, buf_i, PKBUFSZ);
1791 a_info(a, "?B64", BBASE(&b), (size_t)BLEN(&b), A_END);
1795 static void acmd_checkchal(admin *a, unsigned ac, char *av[])
1802 base64_decode(&b64, av[0], strlen(av[0]), &d);
1803 base64_decode(&b64, 0, 0, &d);
1804 buf_init(&b, d.buf, d.len);
1805 if (c_check(&b) || BBAD(&b) || BLEFT(&b))
1806 a_fail(a, "invalid-challenge", A_END);
1812 static void acmd_greet(admin *a, unsigned ac, char *av[])
1818 if ((p = a_findpeer(a, av[0])) != 0) {
1820 base64_decode(&b64, av[1], strlen(av[1]), &d);
1821 base64_decode(&b64, 0, 0, &d);
1822 p_greet(p, d.buf, d.len);
1828 static void acmd_addr(admin *a, unsigned ac, char *av[])
1833 if ((p = a_findpeer(a, av[0])) != 0) {
1835 assert(ad->sa.sa_family == AF_INET);
1836 a_info(a, "?ADDR", ad, A_END);
1841 static void acmd_peerinfo(admin *a, unsigned ac, char *av[])
1847 if ((p = a_findpeer(a, av[0])) != 0) {
1849 a_info(a, "tunnel=%s", ps->tops->name, A_END);
1850 a_info(a, "key=%s", p_tag(p),
1851 "current-key=%s", p->kx.kpub->tag, A_END);
1852 if ((ptag = p_privtag(p)) == 0) ptag = "(default)";
1853 a_info(a, "private-key=%s", ptag,
1854 "current-private-key=%s", p->kx.kpriv->tag, A_END);
1855 a_info(a, "keepalive=%lu", ps->t_ka, A_END);
1860 static void acmd_servinfo(admin *a, unsigned ac, char *av[])
1862 a_info(a, "implementation=edgeware-tripe", A_END);
1863 a_info(a, "version=%s", VERSION, A_END);
1864 a_info(a, "daemon=%s", BOOL(flags & F_DAEMON), A_END);
1868 static void acmd_stats(admin *a, unsigned ac, char *av[])
1873 if ((p = a_findpeer(a, av[0])) == 0)
1877 a_info(a, "start-time=%s", timestr(st->t_start), A_END);
1878 a_info(a, "last-packet-time=%s", timestr(st->t_last), A_END);
1879 a_info(a, "last-keyexch-time=%s", timestr(st->t_kx), A_END);
1880 a_info(a, "packets-in=%lu", st->n_in, "bytes-in=%lu", st->sz_in, A_END);
1882 "packets-out=%lu", st->n_out,
1883 "bytes-out=%lu", st->sz_out,
1886 "keyexch-packets-in=%lu", st->n_kxin,
1887 "keyexch-bytes-in=%lu", st->sz_kxin,
1890 "keyexch-packets-out=%lu", st->n_kxout,
1891 "keyexch-bytes-out=%lu", st->sz_kxout,
1894 "ip-packets-in=%lu", st->n_ipin,
1895 "ip-bytes-in=%lu", st->sz_ipin,
1898 "ip-packets-out=%lu", st->n_ipout,
1899 "ip-bytes-out=%lu", st->sz_ipout,
1901 a_info(a, "rejected-packets=%lu", st->n_reject, A_END);
1905 static void acmd_kill(admin *a, unsigned ac, char *av[])
1909 if ((p = a_findpeer(a, av[0])) != 0) {
1915 static void acmd_forcekx(admin *a, unsigned ac, char *av[])
1919 if ((p = a_findpeer(a, av[0])) != 0) {
1920 kx_start(&p->kx, 1);
1925 static void acmd_reload(admin *a, unsigned ac, char *av[])
1926 { p_keyreload(); a_ok(a); }
1928 static void acmd_quit(admin *a, unsigned ac, char *av[])
1930 a_warn("SERVER", "quit", "admin-request", A_END);
1935 static void acmd_version(admin *a, unsigned ac, char *av[])
1937 a_info(a, "%s", PACKAGE, "%s", VERSION, A_END);
1941 static void acmd_tunnels(admin *a, unsigned ac, char *av[])
1945 for (i = 0; tunnels[i]; i++)
1946 a_info(a, "%s", tunnels[i]->name, A_END);
1950 /* --- The command table and help --- */
1952 typedef struct acmd {
1955 unsigned argmin, argmax;
1956 void (*func)(admin */*a*/, unsigned /*ac*/, char */*av*/[]);
1959 static void acmd_help(admin */*a*/, unsigned /*ac*/, char */*av*/[]);
1961 static const acmd acmdtab[] = {
1962 { "add", "[OPTIONS] PEER ADDR ...", 2, 0xffff, acmd_add },
1963 { "addr", "PEER", 1, 1, acmd_addr },
1964 { "algs", "[PEER]", 0, 1, acmd_algs },
1965 { "bgcancel", "TAG", 1, 1, acmd_bgcancel },
1966 { "checkchal", "CHAL", 1, 1, acmd_checkchal },
1967 { "daemon", 0, 0, 0, acmd_daemon },
1968 { "eping", "[OPTIONS] PEER", 1, 0xffff, acmd_eping },
1969 { "forcekx", "PEER", 1, 1, acmd_forcekx },
1970 { "getchal", 0, 0, 0, acmd_getchal },
1971 { "greet", "PEER CHAL", 2, 2, acmd_greet },
1972 { "help", 0, 0, 0, acmd_help },
1973 { "ifname", "PEER", 1, 1, acmd_ifname },
1974 { "jobs", 0, 0, 0, acmd_jobs },
1975 { "kill", "PEER", 1, 1, acmd_kill },
1976 { "list", 0, 0, 0, acmd_list },
1977 { "notify", "MESSAGE ...", 1, 0xffff, acmd_notify },
1978 { "peerinfo", "PEER", 1, 1, acmd_peerinfo },
1979 { "ping", "[OPTIONS] PEER", 1, 0xffff, acmd_ping },
1980 { "port", 0, 0, 0, acmd_port },
1981 { "quit", 0, 0, 0, acmd_quit },
1982 { "reload", 0, 0, 0, acmd_reload },
1983 { "servinfo", 0, 0, 0, acmd_servinfo },
1984 { "setifname", "PEER NEW-NAME", 2, 2, acmd_setifname },
1985 { "svcclaim", "SERVICE VERSION", 2, 2, acmd_svcclaim },
1986 { "svcensure", "SERVICE [VERSION]", 1, 2, acmd_svcensure },
1987 { "svcfail", "JOBID TOKENS...", 1, 0xffff, acmd_svcfail },
1988 { "svcinfo", "JOBID TOKENS...", 1, 0xffff, acmd_svcinfo },
1989 { "svclist", 0, 0, 0, acmd_svclist },
1990 { "svcok", "JOBID", 1, 1, acmd_svcok },
1991 { "svcquery", "SERVICE", 1, 1, acmd_svcquery },
1992 { "svcrelease", "SERVICE", 1, 1, acmd_svcrelease },
1993 { "svcsubmit", "[OPTIONS] SERVICE TOKENS...",
1994 2, 0xffff, acmd_svcsubmit },
1995 { "stats", "PEER", 1, 1, acmd_stats },
1997 { "trace", "[OPTIONS]", 0, 1, acmd_trace },
1999 { "tunnels", 0, 0, 0, acmd_tunnels },
2000 { "version", 0, 0, 0, acmd_version },
2001 { "warn", "MESSAGE ...", 1, 0xffff, acmd_warn },
2002 { "watch", "[OPTIONS]", 0, 1, acmd_watch },
2006 static void acmd_help(admin *a, unsigned ac, char *av[])
2010 for (c = acmdtab; c->name; c++) {
2012 a_info(a, "%s", c->name, "*%s", c->help, A_END);
2014 a_info(a, "%s", c->name, A_END);
2019 /*----- Connection handling -----------------------------------------------*/
2021 /* --- @a_destroypending@ --- *
2027 * Use: Destroys pending admin connections at a safe time.
2030 static void a_destroypending(void)
2032 admin *a, *aa, *head;
2033 admin_bgop *bg, *bbg;
2034 admin_service *svc, *ssvc;
2036 /* --- Destroy connections marked as pending --- *
2038 * Slightly messy. Killing clients may cause others to finally die. Make
2039 * sure that they can be put on the list without clobbering anything or
2046 for (a = head; a; a = aa) {
2048 assert(a->f & AF_DEAD);
2050 /* --- Report what we're doing --- */
2052 T( trace(T_ADMIN, "admin: completing destruction of connection %u",
2055 /* --- If this is the foreground client then shut down --- */
2057 if (a->f & AF_FOREGROUND) {
2058 T( trace(T_ADMIN, "admin: foreground client quit: shutting down"); )
2059 a_warn("SERVER", "quit", "foreground-eof", A_END);
2063 /* --- Abort any background jobs in progress --- */
2065 for (bg = a->bg; bg; bg = bbg) {
2068 if (bg->tag) xfree(bg->tag);
2072 /* --- Release services I hold, and abort pending jobs --- */
2074 for (svc = a->svcs; svc; svc = ssvc) {
2078 a_jobtablefinal(&a->j);
2080 /* --- Close file descriptors and selectory --- */
2082 selbuf_destroy(&a->b);
2083 if (a->b.reader.fd != a->w.fd) close(a->b.reader.fd);
2085 if (a_stdin == a) a_stdin = 0;
2094 /* --- @a_destroy@ --- *
2096 * Arguments: @admin *a@ = pointer to an admin block
2100 * Use: Destroys an admin block. This requires a certain amount of
2104 static void freequeue(oqueue *q)
2108 for (o = q->hd; o; o = oo) {
2115 static void a_destroy(admin *a)
2120 if (a->next) a->next->prev = a->prev;
2121 if (a->prev) a->prev->next = a->next;
2122 else admins = a->next;
2124 if (a->out.hd) sel_rmfile(&a->w);
2131 T( trace(T_ADMIN, "admin: killing connection %u", a->seq); )
2134 /* --- @a_line@ --- *
2136 * Arguments: @char *p@ = pointer to the line read
2137 * @size_t len@ = length of the line
2138 * @void *vp@ = pointer to my admin block
2142 * Use: Handles a line of input.
2145 static void a_line(char *p, size_t len, void *vp)
2160 selbuf_disable(&a->b);
2164 ac = str_qsplit(p, av, N(av) - 1, 0, STRF_QUOTE);
2168 for (c = acmdtab; c->name; c++) {
2169 if (mystrieq(av[0], c->name)) {
2171 if (c->argmin > ac || ac > c->argmax) {
2173 a_fail(a, "bad-syntax", "%s", c->name, "", A_END);
2175 a_fail(a, "bad-syntax", "%s", c->name, "%s", c->help, A_END);
2177 c->func(a, ac, av + 1);
2181 a_fail(a, "unknown-command", "%s", av[0], A_END);
2184 /* --- @a_create@ --- *
2186 * Arguments: @int fd_in, fd_out@ = file descriptors to use
2187 * @unsigned f@ = initial flags to set
2191 * Use: Creates a new admin connection.
2194 void a_create(int fd_in, int fd_out, unsigned f)
2196 admin *a = CREATE(admin);
2198 T( static unsigned seq = 0;
2200 T( trace(T_ADMIN, "admin: accepted connection %u", a->seq); )
2204 a_jobtableinit(&a->j);
2206 if (fd_in == STDIN_FILENO) a_stdin = a;
2207 fdflags(fd_in, O_NONBLOCK, O_NONBLOCK, FD_CLOEXEC, FD_CLOEXEC);
2208 if (fd_out != fd_in)
2209 fdflags(fd_out, O_NONBLOCK, O_NONBLOCK, FD_CLOEXEC, FD_CLOEXEC);
2210 selbuf_init(&a->b, &sel, fd_in, a_line, a);
2211 sel_initfile(&sel, &a->w, fd_out, SEL_WRITE, a_flush, a);
2212 a->out.hd = a->out.tl = 0;
2215 if (admins) admins->prev = a;
2219 /* --- @a_accept@ --- *
2221 * Arguments: @int fd@ = file descriptor to accept
2222 * @unsigned mode@ = what to do
2223 * @void *v@ = uninteresting pointer
2227 * Use: Accepts a new admin connection.
2230 static void a_accept(int fd, unsigned mode, void *v)
2233 struct sockaddr_un sun;
2234 socklen_t sz = sizeof(sun);
2236 if ((nfd = accept(fd, (struct sockaddr *)&sun, &sz)) < 0) {
2237 if (errno != EINTR && errno != EAGAIN && errno != EWOULDBLOCK &&
2238 errno != ECONNABORTED && errno != EPROTO)
2239 a_warn("ADMIN", "accept-error", "?ERRNO", A_END);
2242 a_create(nfd, nfd, 0);
2245 /* --- @a_preselect@ --- *
2251 * Use: Informs the admin module that we're about to select again,
2252 * and that it should do cleanup things it has delayed until a
2256 void a_preselect(void) { if (a_dead) a_destroypending(); }
2258 /* --- @a_daemon@ --- *
2264 * Use: Informs the admin module that it's a daemon.
2267 void a_daemon(void) { flags |= F_DAEMON; }
2269 /* --- @a_init@ --- *
2271 * Arguments: @const char *name@ = socket name to create
2272 * @uid_t u@ = user to own the socket
2273 * @gid_t g@ = group to own the socket
2274 * @mode_t m@ = permissions to set on the socket
2278 * Use: Creates the admin listening socket.
2281 void a_init(const char *name, uid_t u, gid_t g, mode_t m)
2285 struct sockaddr_un sun;
2286 struct sigaction sa;
2290 /* --- Create services table --- */
2292 sym_create(&a_svcs);
2294 /* --- Set up the socket address --- */
2296 sz = strlen(name) + 1;
2297 if (sz > sizeof(sun.sun_path))
2298 die(EXIT_FAILURE, "socket name `%s' too long", name);
2300 sun.sun_family = AF_UNIX;
2301 memcpy(sun.sun_path, name, sz);
2302 sz += offsetof(struct sockaddr_un, sun_path);
2304 /* --- Attempt to bind to the socket --- */
2306 omask = umask(0077);
2308 if ((fd = socket(PF_UNIX, SOCK_STREAM, 0)) < 0)
2309 die(EXIT_FAILURE, "couldn't create socket: %s", strerror(errno));
2310 if (bind(fd, (struct sockaddr *)&sun, sz) < 0) {
2313 if (errno != EADDRINUSE) {
2314 die(EXIT_FAILURE, "couldn't bind to address `%s': %s",
2315 sun.sun_path, strerror(e));
2318 die(EXIT_FAILURE, "too many retries; giving up");
2320 if (!connect(fd, (struct sockaddr *)&sun, sz)) {
2321 die(EXIT_FAILURE, "server already listening on admin socket `%s'",
2324 if (errno != ECONNREFUSED)
2325 die(EXIT_FAILURE, "couldn't bind to address: %s", strerror(e));
2326 if (stat(sun.sun_path, &st)) {
2327 die(EXIT_FAILURE, "couldn't stat `%s': %s",
2328 sun.sun_path, strerror(errno));
2330 if (!S_ISSOCK(st.st_mode))
2331 die(EXIT_FAILURE, "object `%s' isn't a socket", sun.sun_path);
2332 T( trace(T_ADMIN, "admin: stale socket found; removing it"); )
2333 unlink(sun.sun_path);
2337 if (chown(sun.sun_path, u, g)) {
2338 die(EXIT_FAILURE, "failed to set socket owner: %s",
2341 if (chmod(sun.sun_path, m)) {
2342 die(EXIT_FAILURE, "failed to set socket permissions: %s",
2346 fdflags(fd, O_NONBLOCK, O_NONBLOCK, FD_CLOEXEC, FD_CLOEXEC);
2348 die(EXIT_FAILURE, "couldn't listen on socket: %s", strerror(errno));
2350 /* --- Listen to the socket --- */
2352 sel_initfile(&sel, &sock, fd, SEL_READ, a_accept, 0);
2356 T( trace_custom(a_trace, 0);
2357 trace(T_ADMIN, "admin: enabled custom tracing"); )
2360 /* --- Set up signal handlers --- */
2362 sig_add(&s_term, SIGTERM, a_sigdie, 0);
2363 sig_add(&s_hup, SIGHUP, a_sighup, 0);
2364 signal(SIGPIPE, SIG_IGN);
2365 sigaction(SIGINT, 0, &sa);
2366 if (sa.sa_handler != SIG_IGN)
2367 sig_add(&s_int, SIGINT, a_sigdie, 0);
2370 /*----- That's all, folks -------------------------------------------------*/