5 * Admin interface for configuration
7 * (c) 2001 Straylight/Edgeware
10 /*----- Licensing notice --------------------------------------------------*
12 * This file is part of Trivial IP Encryption (TrIPE).
14 * TrIPE is free software; you can redistribute it and/or modify
15 * it under the terms of the GNU General Public License as published by
16 * the Free Software Foundation; either version 2 of the License, or
17 * (at your option) any later version.
19 * TrIPE is distributed in the hope that it will be useful,
20 * but WITHOUT ANY WARRANTY; without even the implied warranty of
21 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 * GNU General Public License for more details.
24 * You should have received a copy of the GNU General Public License
25 * along with TrIPE; if not, write to the Free Software Foundation,
26 * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
29 /*----- Header files ------------------------------------------------------*/
33 /*----- Global variables --------------------------------------------------*/
37 const trace_opt tr_opts[] = {
38 { 't', T_TUNNEL, "tunnel events" },
39 { 'r', T_PEER, "peer events" },
40 { 'a', T_ADMIN, "admin interface" },
41 { 's', T_KEYSET, "symmetric keyset management" },
42 { 'x', T_KEYEXCH, "key exchange" },
43 { 'm', T_KEYMGMT, "key management" },
44 { 'l', T_CHAL, "challenge management" },
45 { 'p', T_PACKET, "packet contents" },
46 { 'c', T_CRYPTO, "crypto details" },
47 { 'A', T_ALL, "all of the above" },
51 unsigned tr_flags = 0;
54 static const trace_opt w_opts[] = {
55 { '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;
76 #define T_RESOLVE SEC(30)
79 static void a_destroy(admin */*a*/);
81 #define BOOL(x) ((x) ? "t" : "nil")
83 /*----- Output functions --------------------------------------------------*/
85 /* --- @trywrite@ --- *
87 * Arguments: @admin *a@ = pointer to an admin block
88 * @const char *p@ = pointer to buffer to write
89 * @size_t sz@ = size of data to write
91 * Returns: The number of bytes written, or less than zero on error.
93 * Use: Attempts to write data to a client.
96 static ssize_t trywrite(admin *a, const char *p, size_t sz)
103 n = write(a->w.fd, p, sz);
113 if (errno != EAGAIN && errno != EWOULDBLOCK) {
115 a_warn("ADMIN", "client-write-error", "?ERRNO", A_END);
122 /* --- @doqueue@ -- *
124 * Arguments: @oqueue *q@ = pointer to output queue
125 * @const char *p@ = pointer to buffer to write
126 * @size_t sz@ = size of buffer
128 * Returns: Nonzero if the queue was previously empty.
130 * Use: Queues data to be written later.
133 static int doqueue(oqueue *q, const char *p, size_t sz)
142 else if (o->p_in < o->buf + OBUFSZ)
146 o = xmalloc(sizeof(obuf));
148 o->p_in = o->p_out = o->buf;
156 n = o->buf + OBUFSZ - o->p_in;
159 memcpy(o->p_in, p, n);
168 /* --- @dosend@ --- *
170 * Arguemnts: @admin *a@ = pointer to an admin block
171 * @const char *p@ = pointer to buffer to write
172 * @size_t sz@ = size of data to write
176 * Use: Sends data to an admin client.
179 static void dosend(admin *a, const char *p, size_t sz)
186 if ((n = trywrite(a, p, sz)) < 0)
193 if (doqueue(&a->out, p, sz))
197 /* --- @a_flush@ --- *
199 * Arguments: @int fd@ = file descriptor
200 * @unsigned mode@ = what's happening
201 * @void *v@ = pointer to my admin block
205 * Use: Flushes buffers when a client is ready to read again.
208 static void a_flush(int fd, unsigned mode, void *v)
216 if ((n = trywrite(a, o->p_out, o->p_in - o->p_out)) < 0)
219 if (o->p_in < o->p_out)
232 /*----- Utility functions -------------------------------------------------*/
234 /* --- @quotify@ --- *
236 * Arguments: @dstr *d@ = where to write the answer
237 * @const char *p@ = string to quotify
241 * Use: Quotes the given string if necessary, according to our
245 static void quotify(dstr *d, const char *p)
249 if (*p && !p[strcspn(p, "\"' \t\n\v")])
254 if (*p == '\\' || *p == '\"')
262 /* --- @a_vformat@ --- *
264 * Arguments: @dstr *d@ = where to leave the formatted message
265 * @const char *fmt@ = pointer to format string
266 * @va_list ap@ = arguments in list
270 * Use: Main message token formatting driver.
273 static void a_vformat(dstr *d, const char *fmt, va_list ap)
280 dstr_vputf(d, fmt + 1, &ap);
281 } else if (*fmt == '?') {
282 if (strcmp(fmt, "?ADDR") == 0) {
283 const addr *a = va_arg(ap, const addr *);
284 switch (a->sa.sa_family) {
287 quotify(d, inet_ntoa(a->sin.sin_addr));
288 dstr_putf(d, " %u", (unsigned)ntohs(a->sin.sin_port));
293 } else if (strcmp(fmt, "?B64") == 0) {
294 const octet *p = va_arg(ap, const octet *);
295 size_t n = va_arg(ap, size_t);
301 base64_encode(&b64, p, n, d);
302 base64_encode(&b64, 0, 0, d);
303 while (d->len && d->buf[d->len - 1] == '=') d->len--;
304 } else if (strcmp(fmt, "?TOKENS") == 0) {
305 const char *const *av = va_arg(ap, const char *const *);
306 while (*av) quotify(d, *av++);
307 } else if (strcmp(fmt, "?PEER") == 0)
308 quotify(d, p_name(va_arg(ap, peer *)));
309 else if (strcmp(fmt, "?ERRNO") == 0) {
310 dstr_putf(d, " E%d", errno);
311 quotify(d, strerror(errno));
315 if (*fmt == '!') fmt++;
317 dstr_vputf(&dd, fmt, &ap);
320 fmt = va_arg(ap, const char *);
326 /* --- @a_write@, @a_vwrite@ --- *
328 * Arguments: @admin *a@ = admin connection to write to
329 * @const char *status@ = status code to report
330 * @const char *tag@ = tag string, or null
331 * @const char *fmt@ = pointer to format string
332 * @va_list ap@ = arguments in list
333 * @...@ = other arguments
337 * Use: Sends a message to an admin connection.
340 static void a_vwrite(admin *a, const char *status, const char *tag,
341 const char *fmt, va_list ap)
345 if (tag) dstr_puts(&d, "BG");
346 dstr_puts(&d, status);
347 if (tag) quotify(&d, tag);
348 a_vformat(&d, fmt, ap);
350 dosend(a, d.buf, d.len);
354 static void a_write(admin *a, const char *status, const char *tag,
355 const char *fmt, ...)
360 a_vwrite(a, status, tag, fmt, ap);
364 /* --- @a_ok@, @a_info@, @a_fail@ --- *
366 * Arguments: @admin *a@ = connection
367 * @const char *fmt@ = format string
368 * @...@ = other arguments
372 * Use: Convenience functions for @a_write@.
375 static void a_ok(admin *a) { a_write(a, "OK", 0, A_END); }
377 static void a_info(admin *a, const char *fmt, ...)
382 a_vwrite(a, "INFO", 0, fmt, ap);
386 static void a_fail(admin *a, const char *fmt, ...)
391 a_vwrite(a, "FAIL", 0, fmt, ap);
395 /* --- @a_alert@, @a_valert@, @a_rawalert@ --- *
397 * Arguments: @unsigned f_and, f_eq@ = filter for connections
398 * @const char *status@ = status string
399 * @const char *fmt@ = pointer to format string
400 * @const char *p@ = pointer to raw string
401 * @size_t sz@ = size of raw string
402 * @va_list ap@ = arguments in list
403 * @...@ = other arguments
407 * Use: Write a message to all admin connections matched by the given
411 static void a_rawalert(unsigned f_and, unsigned f_eq, const char *status,
412 const char *p, size_t sz)
417 if (!(flags & F_INIT))
419 dstr_puts(&d, status);
422 dstr_putm(&d, p, sz);
427 for (a = admins; a; a = aa) {
429 if ((a->f & f_and) == f_eq)
430 dosend(a, d.buf, d.len);
435 static void a_valert(unsigned f_and, unsigned f_eq, const char *status,
436 const char *fmt, va_list ap)
440 if (!(flags & F_INIT))
442 a_vformat(&d, fmt, ap);
443 a_rawalert(f_and, f_eq, status, fmt ? d.buf : 0, fmt ? d.len : 0);
447 static void a_alert(unsigned f_and, unsigned f_eq, const char *status,
448 const char *fmt, ...)
453 a_valert(f_and, f_eq, status, fmt, ap);
457 /* --- @a_warn@ --- *
459 * Arguments: @const char *fmt@ = pointer to format string
460 * @...@ = other arguments
464 * Use: Informs all admin connections of a warning.
467 void a_warn(const char *fmt, ...)
473 a_valert(0, 0, "WARN", fmt, ap);
476 fprintf(stderr, "%s: ", QUIS);
477 a_vformat(&d, fmt, ap);
479 dstr_write(&d, stderr);
485 /* --- @a_trace@ --- *
487 * Arguments: @const char *p@ = pointer to a buffer
488 * @size_t sz@ = size of the buffer
489 * @void *v@ = uninteresting pointer
493 * Use: Custom trace output handler. Sends trace messages to
494 * interested admin connections.
498 static void a_trace(const char *p, size_t sz, void *v)
499 { a_rawalert(AF_TRACE, AF_TRACE, "TRACE", p, sz); }
502 /* --- @a_notify@ --- *
504 * Arguments: @const char *fmt@ = pointer to format string
505 * @...@ = other arguments
509 * Use: Sends a notification to interested admin connections.
512 void a_notify(const char *fmt, ...)
517 a_valert(AF_NOTE, AF_NOTE, "NOTE", fmt, ap);
521 /* --- @a_quit@ --- *
527 * Use: Shuts things down nicely.
536 while ((p = p_first()) != 0)
541 /* --- @a_sigdie@ --- *
543 * Arguments: @int sig@ = signal number
544 * @void *v@ = an uninteresting argument
548 * Use Shuts down on receipt of a fatal signal.
551 static void a_sigdie(int sig, void *v)
557 case SIGTERM: p = "SIGTERM"; break;
558 case SIGINT: p = "SIGINT"; break;
560 sprintf(buf, "%i", sig);
564 a_warn("SERVER", "quit", "signal", "%s", p, A_END);
568 /* --- @a_sighup@ --- *
570 * Arguments: @int sig@ = signal number
571 * @void *v@ = an uninteresting argument
575 * Use Logs a message about SIGHUP not being useful.
578 static void a_sighup(int sig, void *v)
579 { a_warn("SERVER", "ignore", "signal", "SIGHUP", A_END); }
581 /* --- @a_parsetime@ --- *
583 * Arguments; @const char *p@ = time string to parse
585 * Returns: Time in seconds, or @< 0@ on error.
588 static long a_parsetime(const char *p)
591 long t = strtol(p, &q, 0);
597 case 's': if (q[1] != 0)
604 /* --- @a_findpeer@ --- *
606 * Arguments: @admin *a@ = admin connection
607 * @const char *pn@ = peer name
609 * Returns: The peer, or null if not there.
611 * Use: Finds a peer, reporting an error if it failed.
614 static peer *a_findpeer(admin *a, const char *pn)
618 if ((p = p_find(pn)) == 0)
619 a_fail(a, "unknown-peer", "%s", pn, A_END);
623 /*----- Backgrounded operations -------------------------------------------*/
626 (((admin_bgop *)(bg))->tag ? ((admin_bgop *)(bg))->tag : "<foreground>")
628 /* --- @a_bgfind@ --- *
630 * Arguments: @admin *a@ = a client block
631 * @const char *tag@ = the requested tag
633 * Returns: The requested background job, or null.
636 static admin_bgop *a_bgfind(admin *a, const char *tag)
640 for (bg = a->bg; bg; bg = bg->next) {
641 if (bg->tag && strcmp(tag, bg->tag) == 0)
647 /* --- @a_bgrelease@ --- *
649 * Arguments: @admin_bgop *bg@ = backgrounded operation
653 * Use: Removes a backgrounded operation from the queue, since
654 * (presumably) it's done.
657 static void a_bgrelease(admin_bgop *bg)
661 T( trace(T_ADMIN, "admin: release bgop %s", BGTAG(bg)); )
662 if (bg->tag) xfree(bg->tag);
663 else selbuf_enable(&a->b);
664 if (bg->next) bg->next->prev = bg->prev;
665 if (bg->prev) bg->prev->next = bg->next;
666 else a->bg = bg->next;
668 if (!a->bg && (a->f & AF_CLOSE)) a_destroy(a);
671 /* --- @a_bgok@, @a_bginfo@, @a_bgfail@ --- *
673 * Arguments: @admin_bgop *bg@ = backgrounded operation
674 * @const char *fmt@ = format string
675 * @...@ = other arguments
679 * Use: Convenience functions for @a_write@.
682 static void a_bgok(admin_bgop *bg)
683 { a_write(bg->a, "OK", bg->tag, A_END); }
685 static void a_bginfo(admin_bgop *bg, const char *fmt, ...)
689 a_vwrite(bg->a, "INFO", bg->tag, fmt, ap);
693 static void a_bgfail(admin_bgop *bg, const char *fmt, ...)
697 a_vwrite(bg->a, "FAIL", bg->tag, fmt, ap);
701 /* --- @a_bgadd@ --- *
703 * Arguments: @admin *a@ = administration connection
704 * @admin_bgop *bg@ = pointer to background operation
705 * @const char *tag@ = background tag, or null for foreground
706 * @void (*cancel)(admin_bgop *)@ = cancel function
708 * Returns: Zero for success, nonzero on failure.
710 * Use: Links a background job into the list.
713 static int a_bgadd(admin *a, admin_bgop *bg, const char *tag,
714 void (*cancel)(admin_bgop *))
717 if (a_bgfind(a, tag)) {
718 a_fail(a, "tag-exists", "%s", tag, A_END);
721 bg->tag = xstrdup(tag);
725 selbuf_disable(&a->b);
731 if (a->bg) a->bg->prev = bg;
733 T( trace(T_ADMIN, "admin: add bgop %s", BGTAG(bg)); )
734 if (tag) a_write(a, "DETACH", tag, A_END);
738 /*----- Job table manipulation --------------------------------------------*/
741 #define JOB_INDEXMASK ((1ul << JOB_SHIFT) - 1)
742 #define JOB_SEQMASK ((1ul << (32 - JOB_SHIFT)) - 1)
744 #define JOB_END 0xfffffffful
746 static unsigned long a_joboffset;
748 /* --- @a_jobidencode@ --- *
750 * Arguments: @admin_svcop *svc@ = pointer to a service operation
752 * Returns: A jobid for this job, in an internal static buffer.
754 * Use: Constructs a jobid. In order to dissuade people from
755 * predicting jobids, we obfuscate them.
757 * A `raw' jobid consists of two 16-bit fields. The low 16 bits
758 * are an index into a big array. The high 16 bits are a
759 * sequence number recording how many times that slot has been
762 * This `raw' jobid is then obfuscated by adding a randomly-
763 * generated offset, and multiplying (mod %$2^{32}$%) by a fixed
767 static const char *a_jobidencode(admin_svcop *svc)
769 admin_jobtable *j = &svc->prov->j;
774 assert(svc->index <= JOB_INDEXMASK);
775 seq = j->v[svc->index].seq;
776 assert(seq <= JOB_SEQMASK);
777 pre = (unsigned long)svc->index | ((unsigned long)seq << JOB_SHIFT);
778 sprintf(buf, "J%08lx", ((pre + a_joboffset) * 0x0f87a7a3ul) & 0xffffffff);
782 /* --- @a_jobiddecode@ --- *
784 * Arguments: @admin_jobtable *j@ = pointer to a job table
785 * @const char *jid@ = pointer to a jobid string
787 * Returns: A pointer to the job's @svcop@ structure.
790 static admin_svcop *a_jobiddecode(admin_jobtable *j, const char *jid)
797 for (i = 1; i < 9; i++) {
798 if (!isxdigit((unsigned char)jid[i]))
803 pre = strtoul(jid + 1, 0, 16);
804 pre = ((pre * 0xbd11c40bul) - a_joboffset) & 0xffffffff;
805 i = pre & JOB_INDEXMASK;
806 if (i >= j->n || j->v[i].seq != (pre >> JOB_SHIFT))
808 return (j->v[i].u.op);
811 /* --- @a_jobcreate@ --- *
813 * Arguments: @admin *a@ = pointer to administration client
815 * Returns: A pointer to a freshly-allocated @svcop@, or null.
817 * Use: Allocates a fresh @svcop@ and links it into a job table.
820 static admin_svcop *a_jobcreate(admin *a)
825 admin_jobtable *j = &a->j;
827 if (j->free != JOB_END) {
829 j->free = j->v[i].u.next;
832 if (j->sz > JOB_INDEXMASK)
837 j->v = xmalloc(j->sz * sizeof(*j->v));
840 j->v = xrealloc(j->v, j->sz * sizeof(*j->v), sz * sizeof(*j->v));
846 svc = xmalloc(sizeof(*svc));
849 svc->next = j->active;
851 if (j->active) j->active->prev = svc;
854 IF_TRACING(T_ADMIN, {
855 trace(T_ADMIN, "admin: created job %s (%u)", a_jobidencode(svc), i);
860 /* --- @a_jobdestroy@ --- *
862 * Arguments: @admin_svcop *svc@ = pointer to job block
866 * Use: Frees up a completed (or cancelled) job.
869 static void a_jobdestroy(admin_svcop *svc)
871 admin *a = svc->prov;
872 admin_jobtable *j = &a->j;
873 unsigned i = svc->index;
875 IF_TRACING(T_ADMIN, {
876 trace(T_ADMIN, "admin: destroying job %s (%u)", a_jobidencode(svc), i);
878 assert(j->v[i].u.op = svc);
879 j->v[i].u.next = j->free;
882 if (svc->next) svc->next->prev = svc->prev;
883 if (svc->prev) svc->prev->next = svc->next;
884 else j->active = svc->next;
887 /* --- @a_jobtableinit@ --- *
889 * Arguments: @admin_jobtable *j@ = pointer to job table
893 * Use: Initializes a job table.
896 static void a_jobtableinit(admin_jobtable *j)
899 a_joboffset = GR_RANGE(&rand_global, 0xffffffff) + 1;
906 /* --- @a_jobtablefinal@ --- *
908 * Arguments: @admin_jobtable *j@ = pointer to job table
912 * Use: Closes down a job table.
915 static void a_jobtablefinal(admin_jobtable *j)
917 admin_svcop *svc, *ssvc;
919 for (svc = j->active; svc; svc = ssvc) {
921 a_bgfail(&svc->bg, "provider-failed", A_END);
922 a_bgrelease(&svc->bg);
924 if (j->v) xfree(j->v);
927 /*----- Services infrastructure -------------------------------------------*/
929 /* --- @a_svcfind@ --- *
931 * Arguments: @admin *a@ = the requesting client
932 * @const char *name@ = service name wanted
934 * Returns: The service requested, or null.
936 * Use: Finds a service; reports an error if the service couldn't be
940 static admin_service *a_svcfind(admin *a, const char *name)
944 if ((svc = sym_find(&a_svcs, name, -1, 0, 0)) == 0) {
945 a_fail(a, "unknown-service", "%s", name, A_END);
951 /* --- @a_svcunlink@ --- *
953 * Arguments: @admin_service *svc@ = pointer to service structure
957 * Use: Unlinks the service from its provider, without issuing a
958 * message or freeing the structure. The version string is
962 static void a_svcunlink(admin_service *svc)
965 svc->next->prev = svc->prev;
967 svc->prev->next = svc->next;
969 svc->prov->svcs = svc->next;
973 /* --- @a_svcrelease@ --- *
975 * Arguments: @admin_service *svc@ = pointer to service structure
979 * Use: Releases a service and frees its structure.
982 static void a_svcrelease(admin_service *svc)
984 a_notify("SVCRELEASE", "%s", SYM_NAME(svc), A_END);
986 sym_remove(&a_svcs, svc);
989 /*----- Name resolution operations ----------------------------------------*/
991 /* --- @a_resolved@ --- *
993 * Arguments: @struct hostent *h@ = pointer to resolved hostname
994 * @void *v@ = pointer to resolver operation
998 * Use: Handles a completed name resolution.
1001 static void a_resolved(struct hostent *h, void *v)
1005 T( trace(T_ADMIN, "admin: resop %s resolved", BGTAG(r)); )
1008 a_bgfail(&r->bg, "resolve-error", "%s", r->addr, A_END);
1009 r->func(r, ARES_FAIL);
1011 memcpy(&r->sa.sin.sin_addr, h->h_addr, sizeof(struct in_addr));
1012 r->func(r, ARES_OK);
1016 a_bgrelease(&r->bg);
1019 /* --- @a_restimer@ --- *
1021 * Arguments: @struct timeval *tv@ = timer
1022 * @void *v@ = pointer to resolver operation
1026 * Use: Times out a resolver.
1029 static void a_restimer(struct timeval *tv, void *v)
1033 T( trace(T_ADMIN, "admin: resop %s timeout", BGTAG(r)); )
1034 a_bgfail(&r->bg, "resolver-timeout", "%s", r->addr, A_END);
1035 r->func(r, ARES_FAIL);
1038 a_bgrelease(&r->bg);
1041 /* --- @a_rescancel@ --- *
1043 * Arguments: @admin_bgop *bg@ = background operation
1047 * Use: Cancels an add operation.
1050 static void a_rescancel(admin_bgop *bg)
1052 admin_resop *r = (admin_resop *)bg;
1054 T( trace(T_ADMIN, "admin: cancel resop %s", BGTAG(r)); )
1055 r->func(r, ARES_FAIL);
1061 /* --- @a_resolve@ --- *
1063 * Arguments: @admin *a@ = administration connection
1064 * @admin_resop *r@ = resolver operation to run
1065 * @const char *tag@ = background operation tag
1066 * @void (*func)(struct admin_resop *, int@ = handler function
1067 * @unsigned ac@ = number of remaining arguments
1068 * @char *av[]@ = pointer to remaining arguments
1072 * Use: Cranks up a resolver job.
1075 static void a_resolve(admin *a, admin_resop *r, const char *tag,
1076 void (*func)(struct admin_resop *, int),
1077 unsigned ac, char *av[])
1084 /* --- Fill in the easy bits of address --- */
1086 r->bg.tag = "<starting>";
1089 if (mystrieq(av[i], "inet")) i++;
1091 a_fail(a, "bad-addr-syntax", "[inet] ADDRESS PORT", A_END);
1094 r->sa.sin.sin_family = AF_INET;
1095 r->sasz = sizeof(r->sa.sin);
1096 r->addr = xstrdup(av[i]);
1097 pt = strtoul(av[i + 1], &p, 0);
1099 struct servent *s = getservbyname(av[i + 1], "udp");
1101 a_fail(a, "unknown-service", "%s", av[i + 1], A_END);
1104 pt = ntohs(s->s_port);
1106 if (pt == 0 || pt >= 65536) {
1107 a_fail(a, "invalid-port", "%lu", pt, A_END);
1110 r->sa.sin.sin_port = htons(pt);
1112 /* --- Report backgrounding --- *
1114 * Do this for consistency of interface, even if we're going to get the
1115 * answer straight away.
1118 if (a_bgadd(a, &r->bg, tag, a_rescancel))
1120 T( trace(T_ADMIN, "admin: %u, resop %s, hostname `%s'",
1121 a->seq, BGTAG(r), r->addr); )
1123 /* --- If the name is numeric, do it the easy way --- */
1125 if (inet_aton(av[i], &r->sa.sin.sin_addr)) {
1126 T( trace(T_ADMIN, "admin: resop %s done the easy way", BGTAG(r)); )
1129 a_bgrelease(&r->bg);
1133 /* --- Store everything for later and crank up the resolver --- */
1135 gettimeofday(&tv, 0);
1136 tv.tv_sec += T_RESOLVE;
1137 sel_addtimer(&sel, &r->t, &tv, a_restimer, r);
1138 bres_byname(&r->r, r->addr, a_resolved, r);
1143 if (r->addr) xfree(r->addr);
1147 /*----- Option parsing ----------------------------------------------------*/
1149 #define OPTIONS(argc, argv, guts) do { \
1150 char **o_av = argv; \
1154 if (mystrieq(*o_av, "--")) { \
1159 if (**o_av == '-') \
1163 argc -= o_av - argv; \
1167 #define OPT(name, guts) if (mystrieq(*o_av, name)) { guts continue; }
1169 #define OPTARG(name, arg, guts) OPT(name, { \
1172 if (!arg) goto bad_syntax; \
1176 #define OPTTIME(name, arg, guts) OPTARG(name, o_arg, { \
1178 if ((arg = a_parsetime(o_arg)) < 0) { \
1179 a_fail(a, "bad-time-spec", "%s", o_arg, A_END); \
1185 /*----- Adding peers ------------------------------------------------------*/
1187 /* --- @a_doadd@ --- *
1189 * Arguments: @admin_resop *r@ = resolver operation
1190 * @int rc@ = how it worked
1194 * Use: Handles a completed resolution.
1197 static void a_doadd(admin_resop *r, int rc)
1199 admin_addop *add = (admin_addop *)r;
1201 T( trace(T_ADMIN, "admin: done add op %s", BGTAG(add)); )
1203 if (rc == ARES_OK) {
1204 add->peer.sasz = add->r.sasz;
1205 add->peer.sa = add->r.sa;
1206 if (p_find(add->peer.name))
1207 a_bgfail(&add->r.bg, "peer-exists", "%s", add->peer.name, A_END);
1208 else if (!p_create(&add->peer))
1209 a_bgfail(&add->r.bg, "peer-create-fail", "%s", add->peer.name, A_END);
1214 xfree(add->peer.name);
1217 /* --- @acmd_add@ --- *
1219 * Arguments: @admin *a@ = connection which requested the addition
1220 * @unsigned ac@ = argument count
1221 * @char *av[]@ = pointer to the argument list
1225 * Use: Adds a new peer.
1228 static void acmd_add(admin *a, unsigned ac, char *av[])
1230 const char *tag = 0;
1233 /* --- Set stuff up --- */
1235 add = xmalloc(sizeof(*add));
1238 add->peer.tops = tun_default;
1240 /* --- Parse options --- */
1243 OPTARG("-background", arg, { tag = arg; })
1244 OPTARG("-tunnel", arg, {
1248 a_fail(a, "unknown-tunnel", "%s", arg, A_END);
1251 if (mystrieq(arg, tunnels[i]->name)) {
1252 add->peer.tops = tunnels[i];
1257 OPTTIME("-keepalive", t, { add->peer.t_ka = t; })
1260 /* --- Make sure someone's not got there already --- */
1265 a_fail(a, "peer-exists", "%s", *av, A_END);
1268 add->peer.name = xstrdup(*av++);
1271 /* --- Crank up the resolver --- */
1273 a_resolve(a, &add->r, tag, a_doadd, ac, av);
1276 /* --- Clearing up --- */
1279 a_fail(a, "bad-syntax", "add", "[OPTIONS] PEER ADDR ...", A_END);
1281 if (add->peer.name) xfree(add->peer.name);
1286 /*----- Ping --------------------------------------------------------------*/
1288 /* --- @a_pingcancel@ --- *
1290 * Arguments: @admin_bgop *bg@ = background operation block
1294 * Use: Cancels a running ping.
1297 static void a_pingcancel(admin_bgop *bg)
1299 admin_pingop *pg = (admin_pingop *)bg;
1300 T( trace(T_ADMIN, "admin: cancel ping op %s", BGTAG(pg)); )
1301 p_pingdone(&pg->ping, PING_NONOTIFY);
1304 /* --- @a_pong@ --- *
1306 * Arguments: @int rc@ = return code
1307 * @void *v@ = ping operation block
1311 * Use: Collects what happened to a ping message.
1314 static void a_pong(int rc, void *v)
1316 admin_pingop *pg = v;
1322 gettimeofday(&tv, 0);
1323 tv_sub(&tv, &tv, &pg->pingtime);
1324 millis = (double)tv.tv_sec * 1000 + (double)tv.tv_usec/1000;
1325 a_bginfo(&pg->bg, "ping-ok", "%.1f", millis, A_END);
1329 a_bginfo(&pg->bg, "ping-timeout", A_END);
1333 a_bginfo(&pg->bg, "ping-peer-died", A_END);
1339 T( trace(T_ADMIN, "admin: ponged ping op %s", BGTAG(pg)); )
1340 a_bgrelease(&pg->bg);
1343 /* --- @acmd_ping@, @acmd_eping@ --- *
1345 * Arguments: @admin *a@ = connection which requested the ping
1346 * @unsigned ac@ = argument count
1347 * @char *av[]@ = pointer to the argument list
1351 * Use: Pings a peer.
1354 static void a_ping(admin *a, unsigned ac, char *av[],
1355 const char *cmd, unsigned msg)
1359 admin_pingop *pg = 0;
1360 const char *tag = 0;
1363 OPTARG("-background", arg, { tag = arg; })
1364 OPTTIME("-timeout", arg, { t = arg; })
1366 if (!*av || av[1]) goto bad_syntax;
1367 if ((p = a_findpeer(a, *av)) == 0)
1369 pg = xmalloc(sizeof(*pg));
1370 gettimeofday(&pg->pingtime, 0);
1371 if (a_bgadd(a, &pg->bg, tag, a_pingcancel))
1373 T( trace(T_ADMIN, "admin: ping op %s: %s to %s",
1374 BGTAG(pg), cmd, p_name(p)); )
1375 if (p_pingsend(p, &pg->ping, msg, t, a_pong, pg)) {
1376 a_bgfail(&pg->bg, "ping-send-failed", A_END);
1377 a_bgrelease(&pg->bg);
1382 a_fail(a, "bad-syntax", "%s", cmd, "[OPTIONS] PEER", cmd, A_END);
1388 static void acmd_ping(admin *a, unsigned ac, char *av[])
1389 { a_ping(a, ac, av, "ping", MISC_PING); }
1390 static void acmd_eping(admin *a, unsigned ac, char *av[])
1391 { a_ping(a, ac, av, "eping", MISC_EPING); }
1393 /*----- Service commands --------------------------------------------------*/
1395 static void acmd_svcclaim(admin *a, unsigned ac, char *av[])
1400 svc = sym_find(&a_svcs, av[0], -1, sizeof(*svc), &f);
1402 if (versioncmp(av[1], svc->version) <= 0) {
1405 "%s", SYM_NAME(svc),
1410 a_write(svc->prov, "SVCCLAIM", 0, "%s", av[0], "%s", av[1], A_END);
1414 svc->version = xstrdup(av[1]);
1415 svc->next = a->svcs;
1417 if (a->svcs) a->svcs->prev = svc;
1419 a_notify("SVCCLAIM", "%s", SYM_NAME(svc), "%s", svc->version, A_END);
1423 static void acmd_svcrelease(admin *a, unsigned ac, char *av[])
1427 if ((svc = a_svcfind(a, av[0])) == 0)
1429 if (svc->prov != a) {
1430 a_fail(a, "not-service-provider", "%s", SYM_NAME(svc), A_END);
1437 static void acmd_svcensure(admin *a, unsigned ac, char *av[])
1441 if ((svc = a_svcfind(a, av[0])) == 0)
1443 if (av[1] && versioncmp(svc->version, av[1]) < 0) {
1444 a_fail(a, "service-too-old",
1445 "%s", SYM_NAME(svc),
1453 static void acmd_svcquery(admin *a, unsigned ac, char *av[])
1457 if ((svc = a_svcfind(a, av[0])) != 0) {
1458 a_info(a, "name=%s", SYM_NAME(svc), "version=%s", svc->version, A_END);
1463 static void acmd_svclist(admin *a, unsigned ac, char *av[])
1468 for (sym_mkiter(&i, &a_svcs); (svc = sym_next(&i)) != 0; )
1469 a_info(a, "%s", SYM_NAME(svc), "%s", svc->version, A_END);
1473 static void a_canceljob(admin_bgop *bg)
1475 admin_svcop *svc = (admin_svcop *)bg;
1477 a_write(svc->prov, "SVCCANCEL", 0, "%s", a_jobidencode(svc), A_END);
1481 static void acmd_svcsubmit(admin *a, unsigned ac, char *av[])
1483 const char *tag = 0;
1486 const char *ver = 0;
1490 OPTARG("-background", arg, { tag = arg; })
1491 OPTARG("-version", arg, { ver = arg; })
1493 if (!*av) goto bad_syntax;
1494 if ((svc = a_svcfind(a, *av)) == 0) goto fail;
1495 if (ver && versioncmp(svc->version, ver) < 0) {
1496 a_fail(a, "service-too-old",
1497 "%s", SYM_NAME(svc),
1502 if ((svcop = a_jobcreate(svc->prov)) == 0) {
1503 a_fail(a, "provider-overloaded", A_END);
1506 if (a_bgadd(a, &svcop->bg, tag, a_canceljob)) {
1507 a_jobdestroy(svcop);
1510 a_write(svc->prov, "SVCJOB", 0,
1511 "%s", a_jobidencode(svcop),
1517 a_fail(a, "bad-syntax", "svcsubmit", "[OPTIONS] SERVICE ARGS...", A_END);
1524 static void a_replycmd(admin *a, const char *status, int donep, char *av[])
1528 if ((svc = a_jobiddecode(&a->j, av[0])) == 0) {
1529 a_fail(a, "unknown-jobid", av[0], A_END);
1532 a_write(svc->bg.a, status, svc->bg.tag, "?TOKENS", av + 1, A_END);
1535 a_bgrelease(&svc->bg);
1540 static void acmd_svcok(admin *a, unsigned ac, char *av[])
1541 { a_replycmd(a, "OK", 1, av); }
1542 static void acmd_svcinfo(admin *a, unsigned ac, char *av[])
1543 { a_replycmd(a, "INFO", 0, av); }
1544 static void acmd_svcfail(admin *a, unsigned ac, char *av[])
1545 { a_replycmd(a, "FAIL", 1, av); }
1547 /*----- Administration commands -------------------------------------------*/
1549 /* --- Miscellaneous commands --- */
1551 /* --- @traceish@ --- *
1553 * Arguments: @admin *a@ = connection to complain on
1554 * @unsigned ac@ = number of arguments
1555 * @char *av[]@ = vector of arguments
1556 * @const char *what@ = what we're messing with
1557 * @const trace_opt *tt@ = options table
1558 * @unsigned *ff@ = where the flags are
1560 * Returns: Nonzero if anything changed.
1562 * Use: Guts of trace-ish commands like `trace' and `watch'.
1565 static int traceish(admin *a, unsigned ac, char *av[],
1566 const char *what, const trace_opt *tt, unsigned *ff)
1570 if (!ac || strcmp(av[0], "?") == 0) {
1572 for (t = tt; t->ch; t++) {
1573 a_info(a, "*%c%c %s",
1574 t->ch, (*ff & t->f) == t->f ? '+' : ' ', t->help, A_END);
1584 case '+': sense = 1; break;
1585 case '-': sense = 0; break;
1587 for (t = tt; t->ch; t++) {
1589 if (sense) f |= t->f;
1594 a_fail(a, "bad-%s-option", what, "%c", *p, A_END);
1610 static void acmd_trace(admin *a, unsigned ac, char *av[])
1612 if (traceish(a, ac, av, "trace", tr_opts, &tr_flags))
1613 trace_level(tr_flags);
1618 static void acmd_watch(admin *a, unsigned ac, char *av[])
1619 { traceish(a, ac, av, "watch", w_opts, &a->f); }
1621 static void alertcmd(admin *a, unsigned f_and, unsigned f_eq,
1622 const char *status, char *av[])
1623 { a_alert(f_and, f_eq, status, "USER", "?TOKENS", av, A_END); a_ok(a); }
1624 static void acmd_notify(admin *a, unsigned ac, char *av[])
1625 { alertcmd(a, AF_NOTE, AF_NOTE, "NOTE", av); }
1626 static void acmd_warn(admin *a, unsigned ac, char *av[])
1627 { alertcmd(a, AF_WARN, AF_WARN, "WARN", av); }
1629 static void acmd_port(admin *a, unsigned ac, char *av[])
1630 { a_info(a, "%u", p_port(), A_END); a_ok(a); }
1632 static void acmd_daemon(admin *a, unsigned ac, char *av[])
1634 if (flags & F_DAEMON)
1635 a_fail(a, "already-daemon", A_END);
1637 a_notify("DAEMON", A_END);
1641 a_fail(a, "daemon-error", "?ERRNO", A_END);
1649 static void acmd_jobs(admin *a, unsigned ac, char *av[])
1653 for (bg = a->bg; bg; bg = bg->next) {
1655 a_info(a, "%s", bg->tag, A_END);
1660 static void acmd_bgcancel(admin *a, unsigned ac, char *av[])
1664 if ((bg = a_bgfind(a, av[0])) == 0)
1665 a_fail(a, "unknown-tag", "%s", av[0], A_END);
1673 static void acmd_list(admin *a, unsigned ac, char *av[])
1677 for (p = p_first(); p; p = p_next(p))
1678 a_info(a, "%s", p_name(p), A_END);
1682 static void acmd_ifname(admin *a, unsigned ac, char *av[])
1686 if ((p = a_findpeer(a, av[0])) != 0) {
1687 a_info(a, "%s", p_ifname(p), A_END);
1692 static void acmd_setifname(admin *a, unsigned ac, char *av[])
1696 if ((p = a_findpeer(a, av[0])) != 0) {
1697 a_notify("NEWIFNAME", "?PEER", p, "%s", p_ifname(p), "%s", av[1], A_END);
1698 p_setifname(p, av[1]);
1703 static void acmd_getchal(admin *a, unsigned ac, char *av[])
1707 buf_init(&b, buf_i, PKBUFSZ);
1709 a_info(a, "?B64", BBASE(&b), (size_t)BLEN(&b), A_END);
1713 static void acmd_checkchal(admin *a, unsigned ac, char *av[])
1720 base64_decode(&b64, av[0], strlen(av[0]), &d);
1721 base64_decode(&b64, 0, 0, &d);
1722 buf_init(&b, d.buf, d.len);
1723 if (c_check(&b) || BBAD(&b) || BLEFT(&b))
1724 a_fail(a, "invalid-challenge", A_END);
1730 static void acmd_greet(admin *a, unsigned ac, char *av[])
1736 if ((p = a_findpeer(a, av[0])) != 0) {
1738 base64_decode(&b64, av[1], strlen(av[1]), &d);
1739 base64_decode(&b64, 0, 0, &d);
1740 p_greet(p, d.buf, d.len);
1746 static void acmd_addr(admin *a, unsigned ac, char *av[])
1751 if ((p = a_findpeer(a, av[0])) != 0) {
1753 assert(ad->sa.sa_family == AF_INET);
1754 a_info(a, "?ADDR", ad, A_END);
1759 static void acmd_peerinfo(admin *a, unsigned ac, char *av[])
1764 if ((p = a_findpeer(a, av[0])) != 0) {
1766 a_info(a, "tunnel=%s", ps->tops->name, A_END);
1767 a_info(a, "keepalive=%lu", ps->t_ka, A_END);
1772 static void acmd_servinfo(admin *a, unsigned ac, char *av[])
1774 a_info(a, "implementation=edgeware-tripe", A_END);
1775 a_info(a, "version=%s", VERSION, A_END);
1776 a_info(a, "daemon=%s", BOOL(flags & F_DAEMON), A_END);
1780 static void acmd_stats(admin *a, unsigned ac, char *av[])
1785 if ((p = a_findpeer(a, av[0])) == 0)
1789 a_info(a, "start-time=%s", timestr(st->t_start), A_END);
1790 a_info(a, "last-packet-time=%s", timestr(st->t_last), A_END);
1791 a_info(a, "last-keyexch-time=%s", timestr(st->t_kx), A_END);
1792 a_info(a, "packets-in=%lu", st->n_in, "bytes-in=%lu", st->sz_in, A_END);
1794 "packets-out=%lu", st->n_out,
1795 "bytes-out=%lu", st->sz_out,
1798 "keyexch-packets-in=%lu", st->n_kxin,
1799 "keyexch-bytes-in=%lu", st->sz_kxin,
1802 "keyexch-packets-out=%lu", st->n_kxout,
1803 "keyexch-bytes-out=%lu", st->sz_kxout,
1806 "ip-packets-in=%lu", st->n_ipin,
1807 "ip-bytes-in=%lu", st->sz_ipin,
1810 "ip-packets-out=%lu", st->n_ipout,
1811 "ip-bytes-out=%lu", st->sz_ipout,
1813 a_info(a, "rejected-packets=%lu", st->n_reject, A_END);
1817 static void acmd_kill(admin *a, unsigned ac, char *av[])
1821 if ((p = a_findpeer(a, av[0])) != 0) {
1827 static void acmd_forcekx(admin *a, unsigned ac, char *av[])
1831 if ((p = a_findpeer(a, av[0])) != 0) {
1832 kx_start(&p->kx, 1);
1837 static void acmd_reload(admin *a, unsigned ac, char *av[])
1838 { p_keyreload(); a_ok(a); }
1840 static void acmd_quit(admin *a, unsigned ac, char *av[])
1842 a_warn("SERVER", "quit", "admin-request", A_END);
1847 static void acmd_version(admin *a, unsigned ac, char *av[])
1849 a_info(a, "%s", PACKAGE, "%s", VERSION, A_END);
1853 static void acmd_tunnels(admin *a, unsigned ac, char *av[])
1857 for (i = 0; tunnels[i]; i++)
1858 a_info(a, "%s", tunnels[i]->name, A_END);
1862 /* --- The command table and help --- */
1864 typedef struct acmd {
1867 unsigned argmin, argmax;
1868 void (*func)(admin */*a*/, unsigned /*ac*/, char */*av*/[]);
1871 static void acmd_help(admin */*a*/, unsigned /*ac*/, char */*av*/[]);
1873 static const acmd acmdtab[] = {
1874 { "add", "[OPTIONS] PEER ADDR ...", 2, 0xffff, acmd_add },
1875 { "addr", "PEER", 1, 1, acmd_addr },
1876 { "bgcancel", "TAG", 1, 1, acmd_bgcancel },
1877 { "checkchal", "CHAL", 1, 1, acmd_checkchal },
1878 { "daemon", 0, 0, 0, acmd_daemon },
1879 { "eping", "[OPTIONS] PEER", 1, 0xffff, acmd_eping },
1880 { "forcekx", "PEER", 1, 1, acmd_forcekx },
1881 { "getchal", 0, 0, 0, acmd_getchal },
1882 { "greet", "PEER CHAL", 2, 2, acmd_greet },
1883 { "help", 0, 0, 0, acmd_help },
1884 { "ifname", "PEER", 1, 1, acmd_ifname },
1885 { "jobs", 0, 0, 0, acmd_jobs },
1886 { "kill", "PEER", 1, 1, acmd_kill },
1887 { "list", 0, 0, 0, acmd_list },
1888 { "notify", "MESSAGE ...", 1, 0xffff, acmd_notify },
1889 { "peerinfo", "PEER", 1, 1, acmd_peerinfo },
1890 { "ping", "[OPTIONS] PEER", 1, 0xffff, acmd_ping },
1891 { "port", 0, 0, 0, acmd_port },
1892 { "quit", 0, 0, 0, acmd_quit },
1893 { "reload", 0, 0, 0, acmd_reload },
1894 { "servinfo", 0, 0, 0, acmd_servinfo },
1895 { "setifname", "PEER NEW-NAME", 2, 2, acmd_setifname },
1896 { "svcclaim", "SERVICE VERSION", 2, 2, acmd_svcclaim },
1897 { "svcensure", "SERVICE [VERSION]", 1, 2, acmd_svcensure },
1898 { "svcfail", "JOBID TOKENS...", 1, 0xffff, acmd_svcfail },
1899 { "svcinfo", "JOBID TOKENS...", 1, 0xffff, acmd_svcinfo },
1900 { "svclist", 0, 0, 0, acmd_svclist },
1901 { "svcok", "JOBID", 1, 1, acmd_svcok },
1902 { "svcquery", "SERVICE", 1, 1, acmd_svcquery },
1903 { "svcrelease", "SERVICE", 1, 1, acmd_svcrelease },
1904 { "svcsubmit", "[OPTIONS] SERVICE TOKENS...",
1905 2, 0xffff, acmd_svcsubmit },
1906 { "stats", "PEER", 1, 1, acmd_stats },
1908 { "trace", "[OPTIONS]", 0, 1, acmd_trace },
1910 { "tunnels", 0, 0, 0, acmd_tunnels },
1911 { "version", 0, 0, 0, acmd_version },
1912 { "warn", "MESSAGE ...", 1, 0xffff, acmd_warn },
1913 { "watch", "[OPTIONS]", 0, 1, acmd_watch },
1917 static void acmd_help(admin *a, unsigned ac, char *av[])
1921 for (c = acmdtab; c->name; c++) {
1923 a_info(a, "%s", c->name, "*%s", c->help, A_END);
1925 a_info(a, "%s", c->name, A_END);
1930 /*----- Connection handling -----------------------------------------------*/
1932 /* --- @a_destroypending@ --- *
1938 * Use: Destroys pending admin connections at a safe time.
1941 static void a_destroypending(void)
1944 admin_bgop *bg, *bbg;
1945 admin_service *svc, *ssvc;
1947 /* --- Destroy connections marked as pending --- */
1949 for (a = a_dead; a; a = aa) {
1951 assert(a->f & AF_DEAD);
1953 /* --- Report what we're doing --- */
1955 T( trace(T_ADMIN, "admin: completing destruction of connection %u",
1958 /* --- Abort any background jobs in progress --- */
1960 for (bg = a->bg; bg; bg = bbg) {
1963 if (bg->tag) xfree(bg->tag);
1967 /* --- Release services I hold, and abort pending jobs --- */
1969 for (svc = a->svcs; svc; svc = ssvc) {
1973 a_jobtablefinal(&a->j);
1975 /* --- Close file descriptors and selectory --- */
1977 selbuf_destroy(&a->b);
1978 if (a->b.reader.fd != a->w.fd) close(a->b.reader.fd);
1980 if (a_stdin == a) a_stdin = 0;
1987 /* --- All pending destruction completed --- */
1992 /* --- @a_destroy@ --- *
1994 * Arguments: @admin *a@ = pointer to an admin block
1998 * Use: Destroys an admin block. This requires a certain amount of
2002 static void freequeue(oqueue *q)
2006 for (o = q->hd; o; o = oo) {
2013 static void a_destroy(admin *a)
2018 if (a->next) a->next->prev = a->prev;
2019 if (a->prev) a->prev->next = a->next;
2020 else admins = a->next;
2022 if (a->out.hd) sel_rmfile(&a->w);
2029 T( trace(T_ADMIN, "admin: killing connection %u", a->seq); )
2032 /* --- @a_line@ --- *
2034 * Arguments: @char *p@ = pointer to the line read
2035 * @size_t len@ = length of the line
2036 * @void *vp@ = pointer to my admin block
2040 * Use: Handles a line of input.
2043 static void a_line(char *p, size_t len, void *vp)
2058 selbuf_disable(&a->b);
2062 ac = str_qsplit(p, av, 16, 0, STRF_QUOTE);
2065 for (c = acmdtab; c->name; c++) {
2066 if (mystrieq(av[0], c->name)) {
2068 if (c->argmin > ac || ac > c->argmax) {
2070 a_fail(a, "bad-syntax", "%s", c->name, "", A_END);
2072 a_fail(a, "bad-syntax", "%s", c->name, "%s", c->help, A_END);
2074 c->func(a, ac, av + 1);
2078 a_fail(a, "unknown-command", "%s", av[0], A_END);
2081 /* --- @a_create@ --- *
2083 * Arguments: @int fd_in, fd_out@ = file descriptors to use
2084 * @unsigned f@ = initial flags to set
2088 * Use: Creates a new admin connection.
2091 void a_create(int fd_in, int fd_out, unsigned f)
2093 admin *a = CREATE(admin);
2095 T( static unsigned seq = 0;
2097 T( trace(T_ADMIN, "admin: accepted connection %u", a->seq); )
2101 a_jobtableinit(&a->j);
2103 if (fd_in == STDIN_FILENO) a_stdin = a;
2104 fdflags(fd_in, O_NONBLOCK, O_NONBLOCK, FD_CLOEXEC, FD_CLOEXEC);
2105 if (fd_out != fd_in)
2106 fdflags(fd_out, O_NONBLOCK, O_NONBLOCK, FD_CLOEXEC, FD_CLOEXEC);
2107 selbuf_init(&a->b, &sel, fd_in, a_line, a);
2108 sel_initfile(&sel, &a->w, fd_out, SEL_WRITE, a_flush, a);
2109 a->out.hd = a->out.tl = 0;
2112 if (admins) admins->prev = a;
2116 /* --- @a_accept@ --- *
2118 * Arguments: @int fd@ = file descriptor to accept
2119 * @unsigned mode@ = what to do
2120 * @void *v@ = uninteresting pointer
2124 * Use: Accepts a new admin connection.
2127 static void a_accept(int fd, unsigned mode, void *v)
2130 struct sockaddr_un sun;
2131 size_t sz = sizeof(sun);
2133 if ((nfd = accept(fd, (struct sockaddr *)&sun, &sz)) < 0) {
2134 if (errno != EINTR && errno != EAGAIN && errno != EWOULDBLOCK &&
2135 errno != ECONNABORTED && errno != EPROTO)
2136 a_warn("ADMIN", "accept-error", "?ERRNO", A_END);
2139 a_create(nfd, nfd, 0);
2142 /* --- @a_preselect@ --- *
2148 * Use: Informs the admin module that we're about to select again,
2149 * and that it should do cleanup things it has delayed until a
2153 void a_preselect(void) { if (a_dead) a_destroypending(); }
2155 /* --- @a_daemon@ --- *
2161 * Use: Informs the admin module that it's a daemon.
2164 void a_daemon(void) { flags |= F_DAEMON; }
2166 /* --- @a_init@ --- *
2168 * Arguments: @const char *name@ = socket name to create
2172 * Use: Creates the admin listening socket.
2175 void a_init(const char *name)
2179 struct sockaddr_un sun;
2180 struct sigaction sa;
2183 /* --- Create services table --- */
2185 sym_create(&a_svcs);
2187 /* --- Set up the socket address --- */
2189 sz = strlen(name) + 1;
2190 if (sz > sizeof(sun.sun_path))
2191 die(EXIT_FAILURE, "socket name `%s' too long", name);
2193 sun.sun_family = AF_UNIX;
2194 memcpy(sun.sun_path, name, sz);
2195 sz += offsetof(struct sockaddr_un, sun_path);
2197 /* --- Attempt to bind to the socket --- */
2201 if ((fd = socket(PF_UNIX, SOCK_STREAM, 0)) < 0)
2202 die(EXIT_FAILURE, "couldn't create socket: %s", strerror(errno));
2203 if (bind(fd, (struct sockaddr *)&sun, sz) < 0) {
2206 if (errno != EADDRINUSE) {
2207 die(EXIT_FAILURE, "couldn't bind to address `%s': %s",
2208 sun.sun_path, strerror(e));
2211 die(EXIT_FAILURE, "too many retries; giving up");
2213 if (!connect(fd, (struct sockaddr *)&sun, sz)) {
2214 die(EXIT_FAILURE, "server already listening on admin socket `%s'",
2217 if (errno != ECONNREFUSED)
2218 die(EXIT_FAILURE, "couldn't bind to address: %s", strerror(e));
2219 if (stat(sun.sun_path, &st)) {
2220 die(EXIT_FAILURE, "couldn't stat `%s': %s",
2221 sun.sun_path, strerror(errno));
2223 if (!S_ISSOCK(st.st_mode))
2224 die(EXIT_FAILURE, "object `%s' isn't a socket", sun.sun_path);
2225 T( trace(T_ADMIN, "admin: stale socket found; removing it"); )
2226 unlink(sun.sun_path);
2230 chmod(sun.sun_path, 0600);
2231 fdflags(fd, O_NONBLOCK, O_NONBLOCK, FD_CLOEXEC, FD_CLOEXEC);
2233 die(EXIT_FAILURE, "couldn't listen on socket: %s", strerror(errno));
2235 /* --- Listen to the socket --- */
2237 sel_initfile(&sel, &sock, fd, SEL_READ, a_accept, 0);
2241 T( trace_custom(a_trace, 0);
2242 trace(T_ADMIN, "admin: enabled custom tracing"); )
2245 /* --- Set up signal handlers --- */
2247 sig_add(&s_term, SIGTERM, a_sigdie, 0);
2248 sig_add(&s_hup, SIGHUP, a_sighup, 0);
2249 signal(SIGPIPE, SIG_IGN);
2250 sigaction(SIGINT, 0, &sa);
2251 if (sa.sa_handler != SIG_IGN)
2252 sig_add(&s_int, SIGINT, a_sigdie, 0);
2255 /*----- That's all, folks -------------------------------------------------*/