chiark / gitweb /
admin: Improve handling of background jobs.
[tripe] / server / admin.c
1 /* -*-c-*-
2  *
3  * $Id$
4  *
5  * Admin interface for configuration
6  *
7  * (c) 2001 Straylight/Edgeware
8  */
9
10 /*----- Licensing notice --------------------------------------------------* 
11  *
12  * This file is part of Trivial IP Encryption (TrIPE).
13  *
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.
18  * 
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.
23  * 
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.
27  */
28
29 /*----- Header files ------------------------------------------------------*/
30
31 #include "tripe.h"
32
33 /*----- Global variables --------------------------------------------------*/
34
35 #ifndef NTRACE
36
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" },
48   { 0,          0,              0 }
49 };
50
51 unsigned tr_flags = 0;
52 #endif
53
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" },
59   { 0,          0,              0 }
60 };
61
62 /*----- Static variables --------------------------------------------------*/
63
64 static admin *admins;
65 static admin *a_dead;
66 static sel_file sock;
67 static const char *sockname;
68 static unsigned flags = 0;
69 static admin *a_stdin = 0;
70 static sig s_term, s_int, s_hup;
71
72 #define F_DAEMON 1u
73 #define F_INIT 2u
74
75 #define T_RESOLVE SEC(30)
76 #define T_PING SEC(5)
77
78 static void a_destroy(admin */*a*/);
79
80 #define BOOL(x) ((x) ? "t" : "nil")
81
82 /*----- Output functions --------------------------------------------------*/
83
84 /* --- @trywrite@ --- *
85  *
86  * Arguments:   @admin *a@ = pointer to an admin block
87  *              @const char *p@ = pointer to buffer to write
88  *              @size_t sz@ = size of data to write
89  *
90  * Returns:     The number of bytes written, or less than zero on error.
91  *
92  * Use:         Attempts to write data to a client.
93  */
94
95 static ssize_t trywrite(admin *a, const char *p, size_t sz)
96 {
97   ssize_t n, done = 0;
98
99 again:
100   if (!sz)
101     return (done);
102   n = write(a->w.fd, p, sz);
103   if (n > 0) {
104     done += n;
105     p += n;
106     sz -= n;
107     goto again;
108   }
109   if (n < 0) {
110     if (errno == EINTR)
111       goto again;
112     if (errno != EAGAIN && errno != EWOULDBLOCK) {
113       a_destroy(a);
114       a_warn("ADMIN", "client-write-error", "?ERRNO", A_END);
115       return (-1);
116     }
117   }
118   return (done);
119 }
120
121 /* --- @doqueue@ -- *
122  *
123  * Arguments:   @oqueue *q@ = pointer to output queue
124  *              @const char *p@ = pointer to buffer to write
125  *              @size_t sz@ = size of buffer
126  *
127  * Returns:     Nonzero if the queue was previously empty.
128  *
129  * Use:         Queues data to be written later.
130  */
131
132 static int doqueue(oqueue *q, const char *p, size_t sz)
133 {
134   obuf *o;
135   int rc = 0;
136   size_t n;
137
138   o = q->tl;
139   if (!o)
140     rc = 1;
141   else if (o->p_in < o->buf + OBUFSZ)
142     goto noalloc;
143
144   do {
145     o = xmalloc(sizeof(obuf));
146     o->next = 0;
147     o->p_in = o->p_out = o->buf;
148     if (q->tl)
149       q->tl->next = o;
150     else
151       q->hd = o;
152     q->tl = o;
153
154   noalloc:
155     n = o->buf + OBUFSZ - o->p_in;
156     if (n > sz)
157       n = sz;
158     memcpy(o->p_in, p, n);
159     o->p_in += n;
160     p += n;
161     sz -= n;
162   } while (sz);
163
164   return (rc);
165 }
166
167 /* --- @dosend@ --- *
168  *
169  * Arguemnts:   @admin *a@ = pointer to an admin block
170  *              @const char *p@ = pointer to buffer to write
171  *              @size_t sz@ = size of data to write
172  *
173  * Returns:     ---
174  *
175  * Use:         Sends data to an admin client.
176  */
177
178 static void dosend(admin *a, const char *p, size_t sz)
179 {
180   ssize_t n;
181
182   if (a->f & AF_DEAD)
183     return;
184   if (!a->out.hd) {
185     if ((n = trywrite(a, p, sz)) < 0)
186       return;
187     p += n;
188     sz -= n;
189     if (!sz)
190       return;
191   }
192   if (doqueue(&a->out, p, sz))
193     sel_addfile(&a->w);
194 }
195
196 /* --- @a_flush@ --- *
197  *
198  * Arguments:   @int fd@ = file descriptor
199  *              @unsigned mode@ = what's happening
200  *              @void *v@ = pointer to my admin block
201  *
202  * Returns:     ---
203  *
204  * Use:         Flushes buffers when a client is ready to read again.
205  */
206
207 static void a_flush(int fd, unsigned mode, void *v)
208 {
209   admin *a = v;
210   obuf *o, *oo;
211   ssize_t n;
212
213   o = a->out.hd;
214   while (o) {
215     if ((n = trywrite(a, o->p_out, o->p_in - o->p_out)) < 0)
216       return;
217     o->p_out += n;
218     if (o->p_in < o->p_out)
219       break;
220     oo = o;
221     o = o->next;
222     xfree(oo);
223   }
224   a->out.hd = o;
225   if (!o) {
226     a->out.tl = 0;
227     sel_rmfile(&a->w);
228   }
229 }
230
231 /*----- Utility functions -------------------------------------------------*/
232
233 /* --- @quotify@ --- *
234  *
235  * Arguments:   @dstr *d@ = where to write the answer
236  *              @const char *p@ = string to quotify
237  *
238  * Returns:     ---
239  *
240  * Use:         Quotes the given string if necessary, according to our
241  *              quoting rules.
242  */
243
244 static void quotify(dstr *d, const char *p)
245 {
246   if (d->len)
247     dstr_putc(d, ' ');
248   if (*p && !p[strcspn(p, "\"' \t\n\v")])
249     dstr_puts(d, p);
250   else {
251     dstr_putc(d, '\"');
252     while (*p) {
253       if (*p == '\\' || *p == '\"')
254         dstr_putc(d, '\\');
255       dstr_putc(d, *p++);
256     }
257     dstr_putc(d, '\"');
258   }
259 }
260
261 /* --- @a_vformat@ --- *
262  *
263  * Arguments:   @dstr *d@ = where to leave the formatted message
264  *              @const char *fmt@ = pointer to format string
265  *              @va_list ap@ = arguments in list
266  *
267  * Returns:     ---
268  *
269  * Use:         Main message token formatting driver.
270  */
271
272 static void a_vformat(dstr *d, const char *fmt, va_list ap)
273 {
274   dstr dd = DSTR_INIT;
275
276   while (fmt) {
277     if (*fmt == '*') {
278       dstr_putc(d, ' ');
279       dstr_vputf(d, fmt + 1, &ap);
280     } else if (*fmt == '?') {
281       if (strcmp(fmt, "?ADDR") == 0) {
282         const addr *a = va_arg(ap, const addr *);
283         switch (a->sa.sa_family) {
284           case AF_INET:
285             quotify(d, "INET");
286             quotify(d, inet_ntoa(a->sin.sin_addr));
287             dstr_putf(d, " %u", (unsigned)ntohs(a->sin.sin_port));
288             break;
289           default:
290             abort();
291         }
292       } else if (strcmp(fmt, "?B64") == 0) {
293         const octet *p = va_arg(ap, const octet *);
294         size_t n = va_arg(ap, size_t);
295         base64_ctx b64;
296         dstr_putc(d, ' ');
297         base64_init(&b64);
298         b64.indent = "";
299         b64.maxline = 0;
300         base64_encode(&b64, p, n, d);
301         base64_encode(&b64, 0, 0, d);
302         while (d->len && d->buf[d->len - 1] == '=') d->len--;
303       } else if (strcmp(fmt, "?PEER") == 0)
304         quotify(d, p_name(va_arg(ap, peer *)));
305       else if (strcmp(fmt, "?ERRNO") == 0) {
306         dstr_putf(d, " E%d", errno);
307         quotify(d, strerror(errno));
308       } else
309         abort();
310     } else {
311       if (*fmt == '!') fmt++;
312       DRESET(&dd);
313       dstr_vputf(&dd, fmt, &ap);
314       quotify(d, dd.buf);
315     }
316     fmt = va_arg(ap, const char *);
317   }
318
319   dstr_destroy(&dd);
320 }
321
322 /* --- @a_write@, @a_vwrite@ --- *
323  *
324  * Arguments:   @admin *a@ = admin connection to write to
325  *              @const char *status@ = status code to report
326  *              @const char *tag@ = tag string, or null
327  *              @const char *fmt@ = pointer to format string
328  *              @va_list ap@ = arguments in list
329  *              @...@ = other arguments
330  *
331  * Returns:     ---
332  *
333  * Use:         Sends a message to an admin connection.
334  */
335
336 static void a_vwrite(admin *a, const char *status, const char *tag,
337                      const char *fmt, va_list ap)
338 {
339   dstr d = DSTR_INIT;
340   if (tag) dstr_puts(&d, "BG");
341   dstr_puts(&d, status);
342   if (tag) quotify(&d, tag);
343   a_vformat(&d, fmt, ap);
344   dstr_putc(&d, '\n');
345   dosend(a, d.buf, d.len);
346   dstr_destroy(&d);
347 }
348
349 static void a_write(admin *a, const char *status, const char *tag,
350                     const char *fmt, ...)
351 {
352   va_list ap;
353   va_start(ap, fmt);
354   a_vwrite(a, status, tag, fmt, ap);
355   va_end(ap);
356 }
357
358 /* --- @a_ok@, @a_info@, @a_fail@ --- *
359  *
360  * Arguments:   @admin *a@ = connection
361  *              @const char *fmt@ = format string
362  *              @...@ = other arguments
363  *
364  * Returns:     ---
365  *
366  * Use:         Convenience functions for @a_write@.
367  */
368
369 static void a_ok(admin *a) { a_write(a, "OK", 0, A_END); }
370
371 static void a_info(admin *a, const char *fmt, ...)
372 {
373   va_list ap;
374   va_start(ap, fmt);
375   a_vwrite(a, "INFO", 0, fmt, ap);
376   va_end(ap);
377 }
378
379 static void a_fail(admin *a, const char *fmt, ...)
380 {
381   va_list ap;
382   va_start(ap, fmt);
383   a_vwrite(a, "FAIL", 0, fmt, ap);
384   va_end(ap);
385 }
386
387 /* --- @a_alert@, @a_valert@, @a_rawalert@ --- *
388  *
389  * Arguments:   @unsigned f_and, f_eq@ = filter for connections
390  *              @const char *status@ = status string
391  *              @const char *fmt@ = pointer to format string
392  *              @const char *p@ = pointer to raw string
393  *              @size_t sz@ = size of raw string
394  *              @va_list ap@ = arguments in list
395  *              @...@ = other arguments
396  *
397  * Returns:     ---
398  *
399  * Use:         Write a message to all admin connections matched by the given
400  *              filter.
401  */
402
403 static void a_rawalert(unsigned f_and, unsigned f_eq, const char *status,
404                        const char *p, size_t sz)
405 {
406   admin *a, *aa;
407   dstr d = DSTR_INIT;
408   
409   if (!(flags & F_INIT))
410     return;
411   dstr_puts(&d, status);
412   if (p) {
413     dstr_putc(&d, ' ');
414     dstr_putm(&d, p, sz);
415   }
416   dstr_putc(&d, '\n');
417   p = d.buf;
418   sz = d.len;
419   for (a = admins; a; a = aa) {
420     aa = a->next;
421     if ((a->f & f_and) == f_eq)
422       dosend(a, d.buf, d.len);
423   }
424   dstr_destroy(&d);
425 }
426
427 static void a_valert(unsigned f_and, unsigned f_eq, const char *tag,
428                      const char *fmt, va_list ap)
429 {
430   dstr d = DSTR_INIT;
431
432   if (!(flags & F_INIT))
433     return;
434   a_vformat(&d, fmt, ap);
435   a_rawalert(f_and, f_eq, tag, fmt ? d.buf : 0, fmt ? d.len : 0);
436   dstr_destroy(&d);
437 }
438
439 #if 0 /*unused*/
440 static void a_alert(unsigned f_and, unsigned f_eq, const char *tag,
441                     const char *fmt, ...)
442 {
443   va_list ap;
444   va_start(ap, fmt);
445   a_valert(f_and, f_eq, tag, fmt, ap);
446   va_end(ap);
447 }
448 #endif
449
450 /* --- @a_warn@ --- *
451  *
452  * Arguments:   @const char *fmt@ = pointer to format string
453  *              @...@ = other arguments
454  *
455  * Returns:     ---
456  *
457  * Use:         Informs all admin connections of a warning.
458  */
459
460 void a_warn(const char *fmt, ...)
461 {
462   va_list ap;
463
464   va_start(ap, fmt);
465   if (flags & F_INIT)
466     a_valert(0, 0, "WARN", fmt, ap);
467   else {
468     dstr d = DSTR_INIT;
469     fprintf(stderr, "%s: ", QUIS);
470     a_vformat(&d, fmt, ap);
471     dstr_putc(&d, '\n');
472     dstr_write(&d, stderr);
473     dstr_destroy(&d);
474   }
475   va_end(ap);
476 }
477
478 /* --- @a_trace@ --- *
479  *
480  * Arguments:   @const char *p@ = pointer to a buffer
481  *              @size_t sz@ = size of the buffer
482  *              @void *v@ = uninteresting pointer
483  *
484  * Returns:     ---
485  *
486  * Use:         Custom trace output handler.  Sends trace messages to
487  *              interested admin connections.
488  */
489
490 #ifndef NTRACE
491 static void a_trace(const char *p, size_t sz, void *v)
492   { a_rawalert(AF_TRACE, AF_TRACE, "TRACE", p, sz); }
493 #endif
494
495 /* --- @a_notify@ --- *
496  *
497  * Arguments:   @const char *fmt@ = pointer to format string
498  *              @...@ = other arguments
499  *
500  * Returns:     ---
501  *
502  * Use:         Sends a notification to interested admin connections.
503  */
504
505 void a_notify(const char *fmt, ...)
506 {
507   va_list ap;
508
509   va_start(ap, fmt);
510   a_valert(AF_NOTE, AF_NOTE, "NOTE", fmt, ap);
511   va_end(ap);
512 }
513
514 /* --- @a_quit@ --- *
515  *
516  * Arguments:   ---
517  *
518  * Returns:     ---
519  *
520  * Use:         Shuts things down nicely.
521  */
522
523 void a_quit(void)
524 {
525   peer *p;
526
527   close(sock.fd);
528   unlink(sockname);
529   while ((p = p_first()) != 0)
530     p_destroy(p);
531   exit(0);
532 }
533
534 /* --- @a_sigdie@ --- *
535  *
536  * Arguments:   @int sig@ = signal number
537  *              @void *v@ = an uninteresting argument
538  *
539  * Returns:     ---
540  *
541  * Use          Shuts down on receipt of a fatal signal.
542  */
543
544 static void a_sigdie(int sig, void *v)
545 {
546   char *p;
547   char buf[20];
548
549   switch (sig) {
550     case SIGTERM:       p = "SIGTERM"; break;
551     case SIGINT:        p = "SIGINT"; break;
552     default:
553       sprintf(buf, "%i", sig);
554       p = buf;
555       break;
556   }
557   a_warn("SERVER", "quit", "signal", "%s", p, A_END);
558   a_quit();
559 }
560
561 /* --- @a_sighup@ --- *
562  *
563  * Arguments:   @int sig@ = signal number
564  *              @void *v@ = an uninteresting argument
565  *
566  * Returns:     ---
567  *
568  * Use          Logs a message about SIGHUP not being useful.
569  */
570
571 static void a_sighup(int sig, void *v)
572 {
573   a_warn("SERVER", "ignore", "signal", "SIGHUP", A_END);
574 }
575
576 /* --- @a_parsetime@ --- *
577  *
578  * Arguments;   @const char *p@ = time string to parse
579  *
580  * Returns:     Time in seconds, or @< 0@ on error.
581  */
582
583 static long a_parsetime(const char *p)
584 {
585   char *q;
586   long t = strtol(p, &q, 0);
587
588   switch (*q) {
589     case 'd': t *= 24;
590     case 'h': t *= 60;
591     case 'm': t *= 60;
592     case 's': if (q[1] != 0)
593     default:    t = -1;
594     case 0:   break;
595   }
596   return (t);    
597 }
598
599 /* --- @a_findpeer@ --- *
600  *
601  * Arguments:   @admin *a@ = admin connection
602  *              @const char *pn@ = peer name
603  *
604  * Returns:     The peer, or null if not there.
605  *
606  * Use:         Finds a peer, reporting an error if it failed.
607  */
608
609 static peer *a_findpeer(admin *a, const char *pn)
610 {
611   peer *p;
612
613   if ((p = p_find(pn)) == 0)
614     a_fail(a, "unknown-peer", "%s", pn, A_END);
615   return (p);
616 }
617
618 /*----- Backgrounded operations -------------------------------------------*/
619
620 #define BGTAG(bg)                                                       \
621   (((admin_bgop *)(bg))->tag ? ((admin_bgop *)(bg))->tag : "<foreground>")
622
623 /* --- @a_bgfind@ --- *
624  *
625  * Arguments:   @admin *a@ = a client block
626  *              @const char *tag@ = the requested tag
627  *
628  * Returns:     The requested background job, or null.
629  */
630
631 static admin_bgop *a_bgfind(admin *a, const char *tag)
632 {
633   admin_bgop *bg;
634
635   for (bg = a->bg; bg; bg = bg->next) {
636     if (bg->tag && strcmp(tag, bg->tag) == 0)
637       return (bg);
638   }
639   return (0);
640 }
641
642 /* --- @a_bgrelease@ --- *
643  *
644  * Arguments:   @admin_bgop *bg@ = backgrounded operation
645  *
646  * Returns:     ---
647  *
648  * Use:         Removes a backgrounded operation from the queue, since
649  *              (presumably) it's done.
650  */
651
652 static void a_bgrelease(admin_bgop *bg)
653 {
654   admin *a = bg->a;
655
656   T( trace(T_ADMIN, "admin: release bgop %s", BGTAG(bg)); )
657   if (bg->tag) xfree(bg->tag);
658   else selbuf_enable(&a->b);
659   if (bg->next) bg->next->prev = bg->prev;
660   if (bg->prev) bg->prev->next = bg->next;
661   else a->bg = bg->next;
662   xfree(bg);
663   if (!a->bg && (a->f & AF_CLOSE)) a_destroy(a);
664 }
665
666 /* --- @a_bgok@, @a_bginfo@, @a_bgfail@ --- *
667  *
668  * Arguments:   @admin_bgop *bg@ = backgrounded operation
669  *              @const char *fmt@ = format string
670  *              @...@ = other arguments
671  *
672  * Returns:     ---
673  *
674  * Use:         Convenience functions for @a_write@.
675  */
676
677 static void a_bgok(admin_bgop *bg)
678   { a_write(bg->a, "OK", bg->tag, A_END); }
679
680 static void a_bginfo(admin_bgop *bg, const char *fmt, ...)
681 {
682   va_list ap;
683   va_start(ap, fmt);
684   a_vwrite(bg->a, "INFO", bg->tag, fmt, ap);
685   va_end(ap);
686 }
687
688 static void a_bgfail(admin_bgop *bg, const char *fmt, ...)
689 {
690   va_list ap;
691   va_start(ap, fmt);
692   a_vwrite(bg->a, "FAIL", bg->tag, fmt, ap);
693   va_end(ap);
694 }
695
696 /* --- @a_bgadd@ --- *
697  *
698  * Arguments:   @admin *a@ = administration connection
699  *              @admin_bgop *bg@ = pointer to background operation
700  *              @const char *tag@ = background tag, or null for foreground
701  *              @void (*cancel)(admin_bgop *)@ = cancel function
702  *
703  * Returns:     Zero for success, nonzero on failure.
704  *
705  * Use:         Links a background job into the list.
706  */
707
708 static int a_bgadd(admin *a, admin_bgop *bg, const char *tag,
709                    void (*cancel)(admin_bgop *))
710 {
711   if (tag) {
712     if (a_bgfind(a, tag)) {
713       a_fail(a, "tag-exists", "%s", tag, A_END);
714       return (-1);
715     }
716     bg->tag = xstrdup(tag);
717   }
718   else {
719     bg->tag = 0;
720     selbuf_disable(&a->b);
721   }
722   bg->a = a;
723   bg->cancel = cancel;
724   bg->next = a->bg;
725   bg->prev = 0;
726   if (a->bg) a->bg->prev = bg;
727   a->bg = bg;
728   T( trace(T_ADMIN, "admin: add bgop %s", BGTAG(bg)); )
729   if (tag) a_write(a, "DETACH", tag, A_END);
730   return (0);
731 }
732
733 /*----- Name resolution operations ----------------------------------------*/
734
735 /* --- @a_resolved@ --- *
736  *
737  * Arguments:   @struct hostent *h@ = pointer to resolved hostname
738  *              @void *v@ = pointer to resolver operation
739  *
740  * Returns:     ---
741  *
742  * Use:         Handles a completed name resolution.
743  */
744
745 static void a_resolved(struct hostent *h, void *v)
746 {
747   admin_resop *r = v;
748
749   T( trace(T_ADMIN, "admin: resop %s resolved", BGTAG(r)); )
750   TIMER;
751   if (!h) {
752     a_bgfail(&r->bg, "resolve-error", "%s", r->addr, A_END);
753     r->func(r, ARES_FAIL);
754   } else {
755     memcpy(&r->sa.sin.sin_addr, h->h_addr, sizeof(struct in_addr));
756     r->func(r, ARES_OK);
757   }
758   sel_rmtimer(&r->t);
759   xfree(r->addr);
760   a_bgrelease(&r->bg);
761
762
763 /* --- @a_restimer@ --- *
764  *
765  * Arguments:   @struct timeval *tv@ = timer
766  *              @void *v@ = pointer to resolver operation
767  *
768  * Returns:     ---
769  *
770  * Use:         Times out a resolver.
771  */
772
773 static void a_restimer(struct timeval *tv, void *v)
774 {
775   admin_resop *r = v;
776
777   T( trace(T_ADMIN, "admin: resop %s timeout", BGTAG(r)); )
778   a_bgfail(&r->bg, "resolver-timeout", "%s", r->addr, A_END);
779   r->func(r, ARES_FAIL);
780   bres_abort(&r->r);
781   xfree(r->addr);
782   a_bgrelease(&r->bg);
783 }
784
785 /* --- @a_rescancel@ --- *
786  *
787  * Arguments:   @admin_bgop *bg@ = background operation
788  *
789  * Returns:     ---
790  *
791  * Use:         Cancels an add operation.
792  */
793
794 static void a_rescancel(admin_bgop *bg)
795 {
796   admin_resop *r = (admin_resop *)bg;
797
798   T( trace(T_ADMIN, "admin: cancel resop %s", BGTAG(r)); )
799   r->func(r, ARES_FAIL);
800   sel_rmtimer(&r->t);
801   xfree(r->addr);
802   bres_abort(&r->r);
803 }
804
805 /* --- @a_resolve@ --- *
806  *
807  * Arguments:   @admin *a@ = administration connection
808  *              @admin_resop *r@ = resolver operation to run
809  *              @const char *tag@ = background operation tag
810  *              @void (*func)(struct admin_resop *, int@ = handler function
811  *              @unsigned ac@ = number of remaining arguments
812  *              @char *av[]@ = pointer to remaining arguments
813  *
814  * Returns:     ---
815  *
816  * Use:         Cranks up a resolver job.
817  */
818
819 static void a_resolve(admin *a, admin_resop *r, const char *tag,
820                       void (*func)(struct admin_resop *, int),
821                       unsigned ac, char *av[])
822 {
823   struct timeval tv;
824   unsigned long pt;
825   char *p;
826   int i = 0;
827
828   /* --- Fill in the easy bits of address --- */
829
830   r->bg.tag = "<starting>";
831   r->addr = 0;
832   r->func = func;
833   if (mystrieq(av[i], "inet")) i++;
834   if (ac - i != 2) {
835     a_fail(a, "bad-addr-syntax", "[inet] ADDRESS PORT", A_END);
836     goto fail;
837   }
838   r->sa.sin.sin_family = AF_INET;
839   r->sasz = sizeof(r->sa.sin);
840   r->addr = xstrdup(av[i]);
841   pt = strtoul(av[i + 1], &p, 0);
842   if (*p) {
843     struct servent *s = getservbyname(av[i + 1], "udp");
844     if (!s) {
845       a_fail(a, "unknown-service", "%s", av[i + 1], A_END);
846       goto fail;
847     }
848     pt = ntohs(s->s_port);
849   }
850   if (pt == 0 || pt >= 65536) {
851     a_fail(a, "invalid-port", "%lu", pt, A_END);
852     goto fail;
853   }
854   r->sa.sin.sin_port = htons(pt);
855
856   /* --- Report backgrounding --- *
857    *
858    * Do this for consistency of interface, even if we're going to get the
859    * answer straight away.
860    */
861
862   if (a_bgadd(a, &r->bg, tag, a_rescancel))
863     goto fail;
864   T( trace(T_ADMIN, "admin: %u, resop %s, hostname `%s'",
865            a->seq, BGTAG(r), r->addr); )
866
867   /* --- If the name is numeric, do it the easy way --- */
868   
869   if (inet_aton(av[i], &r->sa.sin.sin_addr)) {
870     T( trace(T_ADMIN, "admin: resop %s done the easy way", BGTAG(r)); )
871     func(r, ARES_OK);
872     xfree(r->addr);
873     a_bgrelease(&r->bg);
874     return;
875   }
876
877   /* --- Store everything for later and crank up the resolver --- */
878
879   gettimeofday(&tv, 0);
880   tv.tv_sec += T_RESOLVE;
881   sel_addtimer(&sel, &r->t, &tv, a_restimer, r);
882   bres_byname(&r->r, r->addr, a_resolved, r);
883   return;
884
885 fail:
886   func(r, ARES_FAIL);
887   if (r->addr) xfree(r->addr);
888   xfree(r);
889 }
890
891 /*----- Option parsing ----------------------------------------------------*/
892
893 #define OPTIONS(argc, argv, guts) do {                                  \
894   char **o_av = argv;                                                   \
895   for (;; o_av++) {                                                     \
896     if (!*o_av)                                                         \
897       break;                                                            \
898     if (mystrieq(*o_av, "--")) {                                        \
899       o_av++;                                                           \
900       break;                                                            \
901     }                                                                   \
902     guts                                                                \
903     if (**o_av == '-')                                                  \
904       goto bad_syntax;                                                  \
905     break;                                                              \
906   }                                                                     \
907   argc -= o_av - argv;                                                  \
908   argv = o_av;                                                          \
909 } while (0)
910
911 #define OPT(name, guts) if (mystrieq(*o_av, name)) { guts continue; }
912
913 #define OPTARG(name, arg, guts) OPT(name, {                             \
914   const char *arg;                                                      \
915   arg = *++o_av;                                                        \
916   if (!arg) goto bad_syntax;                                            \
917   guts                                                                  \
918 })
919
920 #define OPTTIME(name, arg, guts) OPTARG(name, o_arg, {                  \
921   long arg;                                                             \
922   if ((arg = a_parsetime(o_arg)) < 0) {                                 \
923     a_fail(a, "bad-time-spec", "%s", o_arg, A_END);                     \
924     goto fail;                                                          \
925   }                                                                     \
926   guts                                                                  \
927 })
928
929 /*----- Adding peers ------------------------------------------------------*/
930
931 /* --- @a_doadd@ --- *
932  *
933  * Arguments:   @admin_resop *r@ = resolver operation
934  *              @int rc@ = how it worked
935  *
936  * Returns:     ---
937  *
938  * Use:         Handles a completed resolution.
939  */
940
941 static void a_doadd(admin_resop *r, int rc)
942 {
943   admin_addop *add = (admin_addop *)r;
944
945   T( trace(T_ADMIN, "admin: done add op %s", BGTAG(add)); )
946
947   if (rc == ARES_OK) {
948     add->peer.sasz = add->r.sasz;
949     add->peer.sa = add->r.sa;
950     if (p_find(add->peer.name))
951       a_bgfail(&add->r.bg, "peer-exists", "%s", add->peer.name, A_END);
952     else if (!p_create(&add->peer))
953       a_bgfail(&add->r.bg, "peer-create-fail", "%s", add->peer.name, A_END);
954     else
955       a_bgok(&add->r.bg);
956   }
957
958   xfree(add->peer.name);
959 }
960
961 /* --- @acmd_add@ --- *
962  *
963  * Arguments:   @admin *a@ = connection which requested the addition
964  *              @unsigned ac@ = argument count
965  *              @char *av[]@ = pointer to the argument list
966  *
967  * Returns:     ---
968  *
969  * Use:         Adds a new peer.
970  */
971
972 static void acmd_add(admin *a, unsigned ac, char *av[])
973 {
974   const char *tag = 0;
975   admin_addop *add;
976
977   /* --- Set stuff up --- */
978
979   add = xmalloc(sizeof(*add));
980   add->peer.name = 0;
981   add->peer.t_ka = 0;
982   add->peer.tops = tun_default;
983
984   /* --- Parse options --- */
985
986   OPTIONS(ac, av, {
987     OPTARG("-background", arg, { tag = arg; })
988     OPTARG("-tunnel", arg, {
989       unsigned i;
990       for (i = 0;; i++) {
991         if (!tunnels[i]) {
992           a_fail(a, "unknown-tunnel", "%s", arg, A_END);
993           goto fail;
994         }
995         if (mystrieq(arg, tunnels[i]->name)) {
996           add->peer.tops = tunnels[i];
997           break;
998         }
999       }
1000     })
1001     OPTTIME("-keepalive", t, { add->peer.t_ka = t; })
1002   });
1003
1004   /* --- Make sure someone's not got there already --- */
1005
1006   if (!*av)
1007     goto bad_syntax;
1008   if (p_find(*av)) {
1009     a_fail(a, "peer-exists", "%s", *av, A_END);
1010     goto fail;
1011   }
1012   add->peer.name = xstrdup(*av++);
1013   ac--;
1014
1015   /* --- Crank up the resolver --- */
1016
1017   a_resolve(a, &add->r, tag, a_doadd, ac, av);
1018   return;
1019
1020   /* --- Clearing up --- */
1021
1022 bad_syntax:
1023   a_fail(a, "bad-syntax", "add", "[OPTIONS] PEER ADDR ...", A_END);
1024 fail:
1025   if (add->peer.name) xfree(add->peer.name);
1026   xfree(add);
1027   return;
1028 }
1029
1030 /*----- Ping --------------------------------------------------------------*/
1031
1032 /* --- @a_pingcancel@ --- *
1033  *
1034  * Arguments:   @admin_bgop *bg@ = background operation block
1035  *
1036  * Returns:     ---
1037  *
1038  * Use:         Cancels a running ping.
1039  */
1040
1041 static void a_pingcancel(admin_bgop *bg)
1042 {
1043   admin_pingop *pg = (admin_pingop *)bg;
1044   T( trace(T_ADMIN, "admin: cancel ping op %s", BGTAG(pg)); )
1045   p_pingdone(&pg->ping, PING_NONOTIFY);
1046 }
1047
1048 /* --- @a_pong@ --- *
1049  *
1050  * Arguments:   @int rc@ = return code
1051  *              @void *v@ = ping operation block
1052  *
1053  * Returns:     ---
1054  *
1055  * Use:         Collects what happened to a ping message.
1056  */
1057
1058 static void a_pong(int rc, void *v)
1059 {
1060   admin_pingop *pg = v;
1061   struct timeval tv;
1062   double millis;
1063
1064   switch (rc) {
1065     case PING_OK:
1066       gettimeofday(&tv, 0);
1067       tv_sub(&tv, &tv, &pg->pingtime);
1068       millis = (double)tv.tv_sec * 1000 + (double)tv.tv_usec/1000;
1069       a_bginfo(&pg->bg, "ping-ok", "%.1f", millis, A_END);
1070       a_bgok(&pg->bg);
1071       break;
1072     case PING_TIMEOUT:
1073       a_bginfo(&pg->bg, "ping-timeout", A_END);
1074       a_bgok(&pg->bg);
1075       break;
1076     case PING_PEERDIED:
1077       a_bginfo(&pg->bg, "ping-peer-died", A_END);
1078       a_bgok(&pg->bg);
1079       break;
1080     default:
1081       abort();
1082   }
1083   T( trace(T_ADMIN, "admin: ponged ping op %s", BGTAG(pg)); )
1084   a_bgrelease(&pg->bg);
1085 }
1086
1087 /* --- @acmd_ping@, @acmd_eping@ --- *
1088  *
1089  * Arguments:   @admin *a@ = connection which requested the ping
1090  *              @unsigned ac@ = argument count
1091  *              @char *av[]@ = pointer to the argument list
1092  *
1093  * Returns:     ---
1094  *
1095  * Use:         Pings a peer.
1096  */
1097
1098 static void a_ping(admin *a, unsigned ac, char *av[],
1099                    const char *cmd, unsigned msg)
1100 {
1101   long t = T_PING;
1102   peer *p;
1103   admin_pingop *pg = 0;
1104   const char *tag = 0;
1105
1106   OPTIONS(ac, av, {
1107     OPTARG("-background", arg, { tag = arg; })
1108     OPTTIME("-timeout", arg, { t = arg; })
1109   });
1110   if (!*av || av[1]) goto bad_syntax;
1111   if ((p = a_findpeer(a, *av)) == 0)
1112     return;
1113   pg = xmalloc(sizeof(*pg));
1114   gettimeofday(&pg->pingtime, 0);
1115   if (a_bgadd(a, &pg->bg, tag, a_pingcancel))
1116     goto fail;
1117   T( trace(T_ADMIN, "admin: ping op %s: %s to %s",
1118            BGTAG(pg), cmd, p_name(p)); )
1119   if (p_pingsend(p, &pg->ping, msg, t, a_pong, pg)) {
1120     a_bgfail(&pg->bg, "ping-send-failed", A_END);
1121     a_bgrelease(&pg->bg);
1122   }
1123   return;
1124     
1125 bad_syntax:
1126   a_fail(a, "bad-syntax", "%s", cmd, "[OPTIONS] PEER", cmd, A_END);
1127 fail:
1128   if (pg) xfree(pg);
1129   return;
1130 }
1131
1132 static void acmd_ping(admin *a, unsigned ac, char *av[])
1133   { a_ping(a, ac, av, "ping", MISC_PING); }
1134 static void acmd_eping(admin *a, unsigned ac, char *av[])
1135   { a_ping(a, ac, av, "eping", MISC_EPING); }
1136
1137 /*----- Administration commands -------------------------------------------*/
1138
1139 /* --- Miscellaneous commands --- */
1140
1141 /* --- @traceish@ --- *
1142  *
1143  * Arguments:   @admin *a@ = connection to complain on
1144  *              @unsigned ac@ = number of arguments
1145  *              @char *av[]@ = vector of arguments
1146  *              @const char *what@ = what we're messing with
1147  *              @const trace_opt *tt@ = options table
1148  *              @unsigned *ff@ = where the flags are
1149  *
1150  * Returns:     Nonzero if anything changed.
1151  *
1152  * Use:         Guts of trace-ish commands like `trace' and `watch'.
1153  */
1154
1155 static int traceish(admin *a, unsigned ac, char *av[],
1156                     const char *what, const trace_opt *tt, unsigned *ff)
1157 {
1158   int ch = 0;
1159
1160   if (!ac || strcmp(av[0], "?") == 0) {
1161     const trace_opt *t;
1162     for (t = tt; t->ch; t++) {
1163       a_info(a, "*%c%c %s",
1164              t->ch, (*ff & t->f) == t->f ? '+' : ' ', t->help, A_END);
1165     }
1166   } else {
1167     unsigned sense = 1;
1168     unsigned f = *ff;
1169     const trace_opt *t;
1170     char *p = av[0];
1171
1172     while (*p) {
1173       switch (*p) {
1174         case '+': sense = 1; break;
1175         case '-': sense = 0; break;
1176         default:
1177           for (t = tt; t->ch; t++) {
1178             if (t->ch == *p) {
1179               if (sense) f |= t->f;
1180               else f &= ~t->f;
1181               goto tropt_ok;
1182             }
1183           }
1184           a_fail(a, "bad-%s-option", what, "%c", *p, A_END);
1185           return (0);
1186         tropt_ok:;
1187           break;
1188       }
1189       p++;
1190     }
1191     *ff = f;
1192     ch = 1;
1193   }
1194   a_ok(a);
1195   return (ch);
1196 }
1197
1198 #ifndef NTRACE
1199
1200 static void acmd_trace(admin *a, unsigned ac, char *av[])
1201 {
1202   if (traceish(a, ac, av, "trace", tr_opts, &tr_flags))
1203     trace_level(tr_flags);
1204 }
1205
1206 #endif
1207
1208 static void acmd_watch(admin *a, unsigned ac, char *av[])
1209 {
1210   traceish(a, ac, av, "watch", w_opts, &a->f);
1211 }
1212
1213 static void alertcmd(admin *a, unsigned f_and, unsigned f_eq,
1214                      const char *tag, unsigned ac, char *av[])
1215 {
1216   dstr d = DSTR_INIT;
1217   unsigned i;
1218
1219   dstr_puts(&d, "USER");
1220   for (i = 0; i < ac; i++)
1221     quotify(&d, av[i]);
1222   dstr_putz(&d);
1223   a_rawalert(f_and, f_eq, tag, d.buf, d.len);
1224   dstr_destroy(&d);
1225   a_ok(a);
1226 }
1227
1228 static void acmd_notify(admin *a, unsigned ac, char *av[])
1229   { alertcmd(a, AF_NOTE, AF_NOTE, "NOTE", ac, av); }
1230 static void acmd_warn(admin *a, unsigned ac, char *av[])
1231   { alertcmd(a, AF_WARN, AF_WARN, "WARN", ac, av); }
1232
1233 static void acmd_port(admin *a, unsigned ac, char *av[])
1234 {
1235   a_info(a, "%u", p_port(), A_END);
1236   a_ok(a);
1237 }
1238
1239 static void acmd_daemon(admin *a, unsigned ac, char *av[])
1240 {
1241   if (flags & F_DAEMON)
1242     a_fail(a, "already-daemon", A_END);
1243   else {
1244     a_notify("DAEMON", A_END);
1245     if (a_stdin)
1246       a_destroy(a_stdin);
1247     if (u_daemon())
1248       a_fail(a, "daemon-error", "?ERRNO", A_END);
1249     else {
1250       flags |= F_DAEMON;
1251       a_ok(a);
1252     }
1253   }
1254 }
1255
1256 static void acmd_jobs(admin *a, unsigned ac, char *av[])
1257 {
1258   admin_bgop *bg;
1259
1260   for (bg = a->bg; bg; bg = bg->next) {
1261     assert(bg->tag);
1262     a_info(a, "%s", bg->tag, A_END);
1263   }
1264   a_ok(a);
1265 }
1266
1267 static void acmd_bgcancel(admin *a, unsigned ac, char *av[])
1268 {
1269   admin_bgop *bg;
1270
1271   if ((bg = a_bgfind(a, av[0])) == 0)
1272     a_fail(a, "unknown-tag", "%s", av[0], A_END);
1273   else {
1274     bg->cancel(bg);
1275     a_bgrelease(bg);
1276     a_ok(a);
1277   }
1278 }
1279
1280 static void acmd_list(admin *a, unsigned ac, char *av[])
1281 {
1282   peer *p;
1283   for (p = p_first(); p; p = p_next(p))
1284     a_info(a, "%s", p_name(p), A_END);
1285   a_ok(a);
1286 }
1287
1288 static void acmd_ifname(admin *a, unsigned ac, char *av[])
1289 {
1290   peer *p;
1291
1292   if ((p = a_findpeer(a, av[0])) != 0) {
1293     a_info(a, "%s", p_ifname(p), A_END);
1294     a_ok(a);
1295   }
1296 }
1297
1298 static void acmd_setifname(admin *a, unsigned ac, char *av[])
1299 {
1300   peer *p;
1301
1302   if ((p = a_findpeer(a, av[0])) != 0) {
1303     a_notify("NEWIFNAME", "?PEER", p, "%s", p_ifname(p), "%s", av[1], A_END);
1304     p_setifname(p, av[1]);
1305     a_ok(a);
1306   }  
1307 }
1308
1309 static void acmd_getchal(admin *a, unsigned ac, char *av[])
1310 {
1311   buf b;
1312
1313   buf_init(&b, buf_i, PKBUFSZ);
1314   c_new(&b);
1315   a_info(a, "?B64", BBASE(&b), (size_t)BLEN(&b), A_END);
1316   a_ok(a);
1317 }
1318
1319 static void acmd_checkchal(admin *a, unsigned ac, char *av[])
1320 {
1321   base64_ctx b64;
1322   buf b;
1323   dstr d = DSTR_INIT;
1324
1325   base64_init(&b64);
1326   base64_decode(&b64, av[0], strlen(av[0]), &d);
1327   base64_decode(&b64, 0, 0, &d);
1328   buf_init(&b, d.buf, d.len);
1329   if (c_check(&b) || BBAD(&b) || BLEFT(&b))
1330     a_fail(a, "invalid-challenge", A_END);
1331   else
1332     a_ok(a);
1333   dstr_destroy(&d);
1334 }
1335
1336 static void acmd_greet(admin *a, unsigned ac, char *av[])
1337 {
1338   peer *p;
1339   base64_ctx b64;
1340   dstr d = DSTR_INIT;
1341
1342   if ((p = a_findpeer(a, av[0])) != 0) {
1343     base64_init(&b64);
1344     base64_decode(&b64, av[1], strlen(av[1]), &d);
1345     base64_decode(&b64, 0, 0, &d);
1346     p_greet(p, d.buf, d.len);
1347     dstr_destroy(&d);
1348     a_ok(a);
1349   }
1350 }
1351
1352 static void acmd_addr(admin *a, unsigned ac, char *av[])
1353 {
1354   peer *p;
1355   const addr *ad;
1356
1357   if ((p = a_findpeer(a, av[0])) != 0) {
1358     ad = p_addr(p);
1359     assert(ad->sa.sa_family == AF_INET);
1360     a_info(a, "?ADDR", ad, A_END);
1361     a_ok(a);
1362   }
1363 }
1364
1365 static void acmd_peerinfo(admin *a, unsigned ac, char *av[])
1366 {
1367   peer *p;
1368   const peerspec *ps;
1369
1370   if ((p = a_findpeer(a, av[0])) != 0) {
1371     ps = p_spec(p);
1372     a_info(a, "tunnel=%s", ps->tops->name, A_END);
1373     a_info(a, "keepalive=%lu", ps->t_ka, A_END);
1374     a_ok(a);
1375   }
1376 }
1377
1378 static void acmd_servinfo(admin *a, unsigned ac, char *av[])
1379 {
1380   a_info(a, "implementation=edgeware-tripe", A_END);
1381   a_info(a, "version=%s", VERSION, A_END);
1382   a_info(a, "daemon=%s", BOOL(flags & F_DAEMON), A_END);
1383   a_ok(a);
1384 }
1385
1386 static void acmd_stats(admin *a, unsigned ac, char *av[])
1387 {
1388   peer *p;
1389   stats *st;
1390
1391   if ((p = a_findpeer(a, av[0])) == 0)
1392     return;
1393
1394   st = p_stats(p);
1395   a_info(a, "start-time=%s", timestr(st->t_start), A_END);
1396   a_info(a, "last-packet-time=%s", timestr(st->t_last), A_END);
1397   a_info(a, "last-keyexch-time=%s", timestr(st->t_kx), A_END);
1398   a_info(a, "packets-in=%lu bytes-in=%lu", st->n_in, st->sz_in, A_END);
1399   a_info(a, "packets-out=%lu bytes-out=%lu",
1400          st->n_out, st->sz_out, A_END);
1401   a_info(a, "keyexch-packets-in=%lu keyexch-bytes-in=%lu",
1402          st->n_kxin, st->sz_kxin, A_END);
1403   a_info(a, "keyexch-packets-out=%lu keyexch-bytes-out=%lu",
1404          st->n_kxout, st->sz_kxout, A_END);
1405   a_info(a, "ip-packets-in=%lu ip-bytes-in=%lu",
1406          st->n_ipin, st->sz_ipin, A_END);
1407   a_info(a, "ip-packets-out=%lu ip-bytes-out=%lu",
1408          st->n_ipout, st->sz_ipout, A_END);
1409   a_info(a, "rejected-packets=%lu", st->n_reject, A_END);
1410   a_ok(a);
1411 }
1412
1413 static void acmd_kill(admin *a, unsigned ac, char *av[])
1414 {
1415   peer *p;
1416   if ((p = a_findpeer(a, av[0])) != 0) {
1417     p_destroy(p);
1418     a_ok(a);
1419   }
1420 }
1421
1422 static void acmd_forcekx(admin *a, unsigned ac, char *av[])
1423 {
1424   peer *p;
1425   if ((p = a_findpeer(a, av[0])) != 0) {
1426     kx_start(&p->kx, 1);
1427     a_ok(a);
1428   }
1429 }
1430
1431 static void acmd_reload(admin *a, unsigned ac, char *av[])
1432   { p_keyreload(); a_ok(a); }
1433
1434 static void acmd_quit(admin *a, unsigned ac, char *av[])
1435 {
1436   a_warn("SERVER", "quit", "admin-request", A_END);
1437   a_ok(a);
1438   a_quit();
1439 }
1440
1441 static void acmd_version(admin *a, unsigned ac, char *av[])
1442 {
1443   a_info(a, "%s", PACKAGE, "%s", VERSION, A_END);
1444   a_ok(a);
1445 }
1446
1447 static void acmd_tunnels(admin *a, unsigned ac, char *av[])
1448 {
1449   int i;
1450   for (i = 0; tunnels[i]; i++)
1451     a_info(a, "%s", tunnels[i]->name, A_END);
1452   a_ok(a);
1453 }
1454
1455 /* --- The command table and help --- */
1456
1457 typedef struct acmd {
1458   const char *name;
1459   const char *help;
1460   unsigned argmin, argmax;
1461   void (*func)(admin */*a*/, unsigned /*ac*/, char */*av*/[]);
1462 } acmd;
1463
1464 static void acmd_help(admin */*a*/, unsigned /*ac*/, char */*av*/[]);
1465
1466 static const acmd acmdtab[] = {
1467   { "add",      "[OPTIONS] PEER ADDR ...", 2,   0xffff, acmd_add },
1468   { "addr",     "PEER",                 1,      1,      acmd_addr },
1469   { "bgcancel", "TAG",                  1,      1,      acmd_bgcancel },
1470   { "checkchal", "CHAL",                1,      1,      acmd_checkchal },
1471   { "daemon",   0,                      0,      0,      acmd_daemon },
1472   { "eping",    "[OPTIONS] PEER",       1,      0xffff, acmd_eping },
1473   { "forcekx",  "PEER",                 1,      1,      acmd_forcekx },
1474   { "getchal",  0,                      0,      0,      acmd_getchal },
1475   { "greet",    "PEER CHAL",            2,      2,      acmd_greet },
1476   { "help",     0,                      0,      0,      acmd_help },
1477   { "ifname",   "PEER",                 1,      1,      acmd_ifname },
1478   { "jobs",     0,                      0,      0,      acmd_jobs },
1479   { "kill",     "PEER",                 1,      1,      acmd_kill },
1480   { "list",     0,                      0,      0,      acmd_list },
1481   { "notify",   "MESSAGE ...",          1,      0xffff, acmd_notify },
1482   { "peerinfo", "PEER",                 1,      1,      acmd_peerinfo },
1483   { "ping",     "[OPTIONS] PEER",       1,      0xffff, acmd_ping },
1484   { "port",     0,                      0,      0,      acmd_port },
1485   { "quit",     0,                      0,      0,      acmd_quit },
1486   { "reload",   0,                      0,      0,      acmd_reload },
1487   { "servinfo", 0,                      0,      0,      acmd_servinfo },
1488   { "setifname", "PEER NEW-NAME",       2,      2,      acmd_setifname },
1489   { "stats",    "PEER",                 1,      1,      acmd_stats },
1490 #ifndef NTRACE
1491   { "trace",    "[OPTIONS]",            0,      1,      acmd_trace },
1492 #endif
1493   { "tunnels",  0,                      0,      0,      acmd_tunnels },
1494   { "version",  0,                      0,      0,      acmd_version },
1495   { "warn",     "MESSAGE ...",          1,      0xffff, acmd_warn },
1496   { "watch",    "[OPTIONS]",            0,      1,      acmd_watch },
1497   { 0,          0,                      0,      0,      0 }
1498 };
1499
1500 static void acmd_help(admin *a, unsigned ac, char *av[])
1501 {
1502   const acmd *c;
1503   for (c = acmdtab; c->name; c++) {
1504     if (c->help)
1505       a_info(a, "%s", c->name, "*%s", c->help, A_END);
1506     else 
1507       a_info(a, "%s", c->name, A_END);
1508   }
1509   a_ok(a);
1510 }
1511
1512 /*----- Connection handling -----------------------------------------------*/
1513
1514 /* --- @a_destroypending@ --- *
1515  *
1516  * Arguments:   ---
1517  *
1518  * Returns:     ---
1519  *
1520  * Use:         Destroys pending admin connections at a safe time.
1521  */
1522
1523 static void a_destroypending(void)
1524 {
1525   admin *a, *aa;
1526   admin_bgop *bg, *bbg;
1527
1528   /* --- Destroy connections marked as pending --- */
1529
1530   for (a = a_dead; a; a = aa) {
1531     aa = a->next;
1532     assert(a->f & AF_DEAD);
1533
1534     /* --- Report what we're doing --- */
1535
1536     T( trace(T_ADMIN, "admin: completing destruction of connection %u",
1537              a->seq); )
1538
1539     /* --- Abort any background jobs in progress --- */
1540
1541     for (bg = a->bg; bg; bg = bbg) {
1542       bbg = bg->next;
1543       bg->cancel(bg);
1544       if (bg->tag) xfree(bg->tag);
1545       xfree(bg);
1546     }
1547
1548     /* --- Close file descriptors and selectory --- */
1549
1550     selbuf_destroy(&a->b);
1551     if (a->b.reader.fd != a->w.fd) close(a->b.reader.fd);
1552     close(a->w.fd);
1553     if (a_stdin == a) a_stdin = 0;
1554
1555     /* --- Done --- */
1556
1557     DESTROY(a);
1558   }
1559
1560   /* --- All pending destruction completed --- */
1561
1562   a_dead = 0;
1563 }
1564
1565 /* --- @a_destroy@ --- *
1566  *
1567  * Arguments:   @admin *a@ = pointer to an admin block
1568  *
1569  * Returns:     ---
1570  *
1571  * Use:         Destroys an admin block.  This requires a certain amount of
1572  *              care.
1573  */
1574
1575 static void freequeue(oqueue *q)
1576 {
1577   obuf *o, *oo;
1578
1579   for (o = q->hd; o; o = oo) {
1580     oo = o->next;
1581     xfree(o);
1582   }
1583   q->hd = q->tl = 0;
1584 }
1585
1586 static void a_destroy(admin *a)
1587 {
1588   if (a->f & AF_DEAD)
1589     return;
1590
1591   if (a->next) a->next->prev = a->prev;
1592   if (a->prev) a->prev->next = a->next;
1593   else admins = a->next;
1594
1595   if (a->out.hd) sel_rmfile(&a->w);
1596   freequeue(&a->out);
1597
1598   a->f |= AF_DEAD;
1599   a->next = a_dead;
1600   a_dead = a;
1601
1602   T( trace(T_ADMIN, "admin: killing connection %u", a->seq); )
1603 }
1604
1605 /* --- @a_line@ --- *
1606  *
1607  * Arguments:   @char *p@ = pointer to the line read
1608  *              @size_t len@ = length of the line
1609  *              @void *vp@ = pointer to my admin block
1610  *
1611  * Returns:     ---
1612  *
1613  * Use:         Handles a line of input.
1614  */
1615
1616 static void a_line(char *p, size_t len, void *vp)
1617 {
1618   admin *a = vp;
1619   const acmd *c;
1620   char *av[16];
1621   size_t ac;
1622
1623   TIMER;
1624   if (a->f & AF_DEAD)
1625     return;
1626   if (!p) {
1627     if (!a->bg)
1628       a_destroy(a);
1629     else {
1630       a->f |= AF_CLOSE;
1631       selbuf_disable(&a->b);
1632     }
1633     return;
1634   }
1635   ac = str_qsplit(p, av, 16, 0, STRF_QUOTE);
1636   if (!ac)
1637     return;
1638   for (c = acmdtab; c->name; c++) {
1639     if (mystrieq(av[0], c->name)) {
1640       ac--;
1641       if (c->argmin > ac || ac > c->argmax) {
1642         if (!c->help)
1643           a_fail(a, "bad-syntax", "%s", c->name, "", A_END);
1644         else 
1645           a_fail(a, "bad-syntax", "%s", c->name, "%s", c->help, A_END);
1646       } else
1647         c->func(a, ac, av + 1);
1648       return;
1649     }
1650   }
1651   a_fail(a, "unknown-command", "%s", av[0], A_END);
1652 }
1653
1654 /* --- @a_create@ --- *
1655  *
1656  * Arguments:   @int fd_in, fd_out@ = file descriptors to use
1657  *              @unsigned f@ = initial flags to set
1658  *
1659  * Returns:     ---
1660  *
1661  * Use:         Creates a new admin connection.
1662  */
1663
1664 void a_create(int fd_in, int fd_out, unsigned f)
1665 {
1666   admin *a = CREATE(admin);
1667
1668   T( static unsigned seq = 0;
1669      a->seq = seq++; )
1670   T( trace(T_ADMIN, "admin: accepted connection %u", a->seq); )
1671   a->bg = 0;
1672   a->ref = 0;
1673   a->f = f;
1674   if (fd_in == STDIN_FILENO) a_stdin = a;
1675   fdflags(fd_in, O_NONBLOCK, O_NONBLOCK, FD_CLOEXEC, FD_CLOEXEC);
1676   if (fd_out != fd_in)
1677     fdflags(fd_out, O_NONBLOCK, O_NONBLOCK, FD_CLOEXEC, FD_CLOEXEC);
1678   selbuf_init(&a->b, &sel, fd_in, a_line, a);
1679   sel_initfile(&sel, &a->w, fd_out, SEL_WRITE, a_flush, a);
1680   a->out.hd = a->out.tl = 0;
1681   a->next = admins;
1682   a->prev = 0;
1683   if (admins) admins->prev = a;
1684   admins = a;
1685 }
1686
1687 /* --- @a_accept@ --- *
1688  *
1689  * Arguments:   @int fd@ = file descriptor to accept
1690  *              @unsigned mode@ = what to do
1691  *              @void *v@ = uninteresting pointer
1692  *
1693  * Returns:     ---
1694  *
1695  * Use:         Accepts a new admin connection.
1696  */
1697
1698 static void a_accept(int fd, unsigned mode, void *v)
1699 {
1700   int nfd;
1701   struct sockaddr_un sun;
1702   size_t sz = sizeof(sun);
1703
1704   if ((nfd = accept(fd, (struct sockaddr *)&sun, &sz)) < 0) {
1705     if (errno != EINTR && errno != EAGAIN && errno != EWOULDBLOCK &&
1706         errno != ECONNABORTED && errno != EPROTO)
1707       a_warn("ADMIN", "accept-error", "?ERRNO", A_END);
1708     return;
1709   }
1710   a_create(nfd, nfd, 0);
1711 }
1712
1713 /* --- @a_preselect@ --- *
1714  *
1715  * Arguments:   ---
1716  *
1717  * Returns:     ---
1718  *
1719  * Use:         Informs the admin module that we're about to select again,
1720  *              and that it should do cleanup things it has delayed until a
1721  *              `safe' time.
1722  */
1723
1724 void a_preselect(void) { if (a_dead) a_destroypending(); }
1725
1726 /* --- @a_daemon@ --- *
1727  *
1728  * Arguments:   ---
1729  *
1730  * Returns:     ---
1731  *
1732  * Use:         Informs the admin module that it's a daemon.
1733  */
1734
1735 void a_daemon(void)
1736 {
1737   flags |= F_DAEMON;
1738 }
1739
1740 /* --- @a_init@ --- *
1741  *
1742  * Arguments:   @const char *name@ = socket name to create
1743  *
1744  * Returns:     ---
1745  *
1746  * Use:         Creates the admin listening socket.
1747  */
1748
1749 void a_init(const char *name)
1750 {
1751   int fd;
1752   int n = 5;
1753   struct sockaddr_un sun;
1754   struct sigaction sa;
1755   size_t sz;
1756
1757   /* --- Set up the socket address --- */
1758
1759   sz = strlen(name) + 1;
1760   if (sz > sizeof(sun.sun_path))
1761     die(EXIT_FAILURE, "socket name `%s' too long", name);
1762   BURN(sun);
1763   sun.sun_family = AF_UNIX;
1764   memcpy(sun.sun_path, name, sz);
1765   sz += offsetof(struct sockaddr_un, sun_path);
1766
1767   /* --- Attempt to bind to the socket --- */
1768
1769   umask(0077);
1770 again:
1771   if ((fd = socket(PF_UNIX, SOCK_STREAM, 0)) < 0)
1772     die(EXIT_FAILURE, "couldn't create socket: %s", strerror(errno));
1773   if (bind(fd, (struct sockaddr *)&sun, sz) < 0) {
1774     struct stat st;
1775     int e = errno;
1776     if (errno != EADDRINUSE) {
1777       die(EXIT_FAILURE, "couldn't bind to address `%s': %s",
1778           sun.sun_path, strerror(e));
1779     }
1780     if (!n)
1781       die(EXIT_FAILURE, "too many retries; giving up");
1782     n--;
1783     if (!connect(fd, (struct sockaddr *)&sun, sz)) {
1784       die(EXIT_FAILURE, "server already listening on admin socket `%s'",
1785           sun.sun_path);
1786     }
1787     if (errno != ECONNREFUSED)
1788       die(EXIT_FAILURE, "couldn't bind to address: %s", strerror(e));
1789     if (stat(sun.sun_path, &st)) {
1790       die(EXIT_FAILURE, "couldn't stat `%s': %s",
1791           sun.sun_path, strerror(errno));
1792     }
1793     if (!S_ISSOCK(st.st_mode))
1794       die(EXIT_FAILURE, "object `%s' isn't a socket", sun.sun_path);
1795     T( trace(T_ADMIN, "admin: stale socket found; removing it"); )
1796     unlink(sun.sun_path);
1797     close(fd);
1798     goto again;
1799   }
1800   chmod(sun.sun_path, 0600);
1801   fdflags(fd, O_NONBLOCK, O_NONBLOCK, FD_CLOEXEC, FD_CLOEXEC);
1802   if (listen(fd, 5))
1803     die(EXIT_FAILURE, "couldn't listen on socket: %s", strerror(errno));
1804
1805   /* --- Listen to the socket --- */
1806
1807   sel_initfile(&sel, &sock, fd, SEL_READ, a_accept, 0);
1808   sel_addfile(&sock);
1809   sockname = name;
1810   bres_init(&sel);
1811   T( trace_custom(a_trace, 0);
1812      trace(T_ADMIN, "admin: enabled custom tracing"); )
1813   flags |= F_INIT;
1814
1815   /* --- Set up signal handlers --- */
1816
1817   sig_add(&s_term, SIGTERM, a_sigdie, 0);
1818   sig_add(&s_hup, SIGHUP, a_sighup, 0);
1819   signal(SIGPIPE, SIG_IGN);
1820   sigaction(SIGINT, 0, &sa);
1821   if (sa.sa_handler != SIG_IGN)
1822     sig_add(&s_int, SIGINT, a_sigdie, 0);
1823 }
1824
1825 /*----- That's all, folks -------------------------------------------------*/