chiark - git - mdw - tripe/blob - server/admin.c

   1 /* -*-c-*-
   2  *
   3  * Admin interface for configuration
   4  *
   5  * (c) 2001 Straylight/Edgeware
   6  */
   7
   8 /*----- Licensing notice --------------------------------------------------*
   9  *
  10  * This file is part of Trivial IP Encryption (TrIPE).
  11  *
  12  * TrIPE is free software: you can redistribute it and/or modify it under
  13  * the terms of the GNU General Public License as published by the Free
  14  * Software Foundation; either version 3 of the License, or (at your
  15  * option) any later version.
  16  *
  17  * TrIPE is distributed in the hope that it will be useful, but WITHOUT
  18  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  19  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  20  * for more details.
  21  *
  22  * You should have received a copy of the GNU General Public License
  23  * along with TrIPE.  If not, see <https://www.gnu.org/licenses/>.
  24  */
  25
  26 /*----- Header files ------------------------------------------------------*/
  27
  28 #include "tripe.h"
  29
  30 /*----- Global variables --------------------------------------------------*/
  31
  32 #ifndef NTRACE
  33
  34 const trace_opt tr_opts[] = {
  35   { 't',        T_TUNNEL,       "tunnel events" },
  36   { 'r',        T_PEER,         "peer events" },
  37   { 'a',        T_ADMIN,        "admin interface" },
  38   { 's',        T_KEYSET,       "symmetric keyset management" },
  39   { 'x',        T_KEYEXCH,      "key exchange" },
  40   { 'm',        T_KEYMGMT,      "key management" },
  41   { 'l',        T_CHAL,         "challenge management" },
  42   { 'v',        T_PRIVSEP,      "privilege separation" },
  43   { 'p',        T_PACKET,       "packet contents" },
  44   { 'c',        T_CRYPTO,       "crypto details" },
  45   { 'A',        T_ALL,          "all of the above" },
  46   { 0,          0,              0 }
  47 };
  48
  49 unsigned tr_flags = 0;
  50 #endif
  51
  52 static const trace_opt w_opts[] = {
  53 #ifndef NTRACE
  54   { 't',        AF_TRACE,       "trace messages" },
  55 #endif
  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 sym_table a_svcs;
  69 static unsigned flags = 0;
  70 static admin *a_stdin = 0;
  71 static sig s_term, s_int, s_hup;
  72
  73 #define F_DAEMON 1u
  74 #define F_INIT 2u
  75 #define F_FOREGROUND 4u
  76
  77 #define T_RESOLVE SEC(30)
  78 #define T_PING SEC(5)
  79
  80 static void a_destroy(admin */*a*/);
  81
  82 #define BOOL(x) ((x) ? "t" : "nil")
  83
  84 /*----- Output functions --------------------------------------------------*/
  85
  86 /* --- @trywrite@ --- *
  87  *
  88  * Arguments:   @admin *a@ = pointer to an admin block
  89  *              @const char *p@ = pointer to buffer to write
  90  *              @size_t sz@ = size of data to write
  91  *
  92  * Returns:     The number of bytes written, or less than zero on error.
  93  *
  94  * Use:         Attempts to write data to a client.
  95  */
  96
  97 static ssize_t trywrite(admin *a, const char *p, size_t sz)
  98 {
  99   ssize_t n, done = 0;
 100
 101 again:
 102   if (!sz)
 103     return (done);
 104   n = write(a->w.fd, p, sz);
 105   if (n > 0) {
 106     done += n;
 107     p += n;
 108     sz -= n;
 109     goto again;
 110   }
 111   if (n < 0) {
 112     if (errno == EINTR)
 113       goto again;
 114     if (errno != EAGAIN && errno != EWOULDBLOCK) {
 115       a_destroy(a);
 116       a_warn("ADMIN", "client-write-error", "?ERRNO", A_END);
 117       return (-1);
 118     }
 119   }
 120   return (done);
 121 }
 122
 123 /* --- @doqueue@ -- *
 124  *
 125  * Arguments:   @oqueue *q@ = pointer to output queue
 126  *              @const char *p@ = pointer to buffer to write
 127  *              @size_t sz@ = size of buffer
 128  *
 129  * Returns:     Nonzero if the queue was previously empty.
 130  *
 131  * Use:         Queues data to be written later.
 132  */
 133
 134 static int doqueue(oqueue *q, const char *p, size_t sz)
 135 {
 136   obuf *o;
 137   int rc = 0;
 138   size_t n;
 139
 140   o = q->tl;
 141   if (!o)
 142     rc = 1;
 143   else if (o->p_in < o->buf + OBUFSZ)
 144     goto noalloc;
 145
 146   do {
 147     o = xmalloc(sizeof(obuf));
 148     o->next = 0;
 149     o->p_in = o->p_out = o->buf;
 150     if (q->tl)
 151       q->tl->next = o;
 152     else
 153       q->hd = o;
 154     q->tl = o;
 155
 156   noalloc:
 157     n = o->buf + OBUFSZ - o->p_in;
 158     if (n > sz)
 159       n = sz;
 160     memcpy(o->p_in, p, n);
 161     o->p_in += n;
 162     p += n;
 163     sz -= n;
 164   } while (sz);
 165
 166   return (rc);
 167 }
 168
 169 /* --- @dosend@ --- *
 170  *
 171  * Arguemnts:   @admin *a@ = pointer to an admin block
 172  *              @const char *p@ = pointer to buffer to write
 173  *              @size_t sz@ = size of data to write
 174  *
 175  * Returns:     ---
 176  *
 177  * Use:         Sends data to an admin client.
 178  */
 179
 180 static void dosend(admin *a, const char *p, size_t sz)
 181 {
 182   ssize_t n;
 183
 184   if (a->f & AF_DEAD)
 185     return;
 186   if (!a->out.hd) {
 187     if ((n = trywrite(a, p, sz)) < 0)
 188       return;
 189     p += n;
 190     sz -= n;
 191     if (!sz)
 192       return;
 193   }
 194   if (doqueue(&a->out, p, sz))
 195     sel_addfile(&a->w);
 196 }
 197
 198 /* --- @a_flush@ --- *
 199  *
 200  * Arguments:   @int fd@ = file descriptor
 201  *              @unsigned mode@ = what's happening
 202  *              @void *v@ = pointer to my admin block
 203  *
 204  * Returns:     ---
 205  *
 206  * Use:         Flushes buffers when a client is ready to read again.
 207  */
 208
 209 static void a_flush(int fd, unsigned mode, void *v)
 210 {
 211   admin *a = v;
 212   obuf *o, *oo;
 213   ssize_t n;
 214
 215   o = a->out.hd;
 216   while (o) {
 217     if ((n = trywrite(a, o->p_out, o->p_in - o->p_out)) < 0)
 218       return;
 219     o->p_out += n;
 220     if (o->p_in < o->p_out)
 221       break;
 222     oo = o;
 223     o = o->next;
 224     xfree(oo);
 225   }
 226   a->out.hd = o;
 227   if (!o) {
 228     a->out.tl = 0;
 229     sel_rmfile(&a->w);
 230   }
 231 }
 232
 233 /*----- Utility functions -------------------------------------------------*/
 234
 235 /* --- @a_vformat@ --- *
 236  *
 237  * Arguments:   @dstr *d@ = where to leave the formatted message
 238  *              @const char *fmt@ = pointer to format string
 239  *              @va_list *ap@ = arguments in list
 240  *
 241  * Returns:     ---
 242  *
 243  * Use:         Main message token formatting driver.  The arguments are
 244  *              interleaved formatting tokens and their parameters, finally
 245  *              terminated by an entry @A_END@.
 246  *
 247  *              Tokens recognized:
 248  *
 249  *                * "*..." ... -- pretokenized @dstr_putf@-like string
 250  *
 251  *                * "?ADDR" SOCKADDR -- a socket address, to be converted
 252  *
 253  *                * "?B64" BUFFER SIZE -- binary data to be base64-encoded
 254  *
 255  *                * "?TOKENS" VECTOR -- null-terminated vector of tokens
 256  *
 257  *                * "?PEER" PEER -- peer's name
 258  *
 259  *                * "?ERRNO" ERRNO -- system error code
 260  *
 261  *                * "[!]..." ... -- @dstr_putf@-like string as single token
 262  */
 263
 264 void a_vformat(dstr *d, const char *fmt, va_list *ap)
 265 {
 266   dstr dd = DSTR_INIT;
 267
 268   while (fmt) {
 269     if (*fmt == '*') {
 270       if (d->len) dstr_putc(d, ' ');
 271       dstr_vputf(d, fmt + 1, ap);
 272     } else if (*fmt == '?') {
 273       if (strcmp(fmt, "?ADDR") == 0) {
 274         const addr *a = va_arg(*ap, const addr *);
 275         switch (a->sa.sa_family) {
 276           case AF_INET:
 277             u_quotify(d, "INET");
 278             u_quotify(d, inet_ntoa(a->sin.sin_addr));
 279             dstr_putf(d, " %u", (unsigned)ntohs(a->sin.sin_port));
 280             break;
 281           default:
 282             abort();
 283         }
 284       } else if (strcmp(fmt, "?B64") == 0) {
 285         const octet *p = va_arg(*ap, const octet *);
 286         size_t n = va_arg(*ap, size_t);
 287         codec *b64 = base64_class.encoder(CDCF_NOEQPAD, "", 0);
 288         dstr_putc(d, ' ');
 289         b64->ops->code(b64, p, n, d);
 290         b64->ops->code(b64, 0, 0, d);
 291         b64->ops->destroy(b64);
 292       } else if (strcmp(fmt, "?TOKENS") == 0) {
 293         const char *const *av = va_arg(*ap, const char *const *);
 294         while (*av) u_quotify(d, *av++);
 295       } else if (strcmp(fmt, "?PEER") == 0)
 296         u_quotify(d, p_name(va_arg(*ap, peer *)));
 297       else if (strcmp(fmt, "?ERRNO") == 0) {
 298         dstr_putf(d, " E%d", errno);
 299         u_quotify(d, strerror(errno));
 300       } else
 301         abort();
 302     } else {
 303       if (*fmt == '!') fmt++;
 304       DRESET(&dd);
 305       dstr_vputf(&dd, fmt, ap);
 306       u_quotify(d, dd.buf);
 307     }
 308     fmt = va_arg(*ap, const char *);
 309   }
 310   dstr_putz(d);
 311
 312   dstr_destroy(&dd);
 313 }
 314
 315 /* --- @a_format@ --- *
 316  *
 317  * Arguments:   @dstr *d@ = where to leave the formatted message
 318  *              @const char *fmt@ = pointer to format string
 319  *
 320  * Returns:     ---
 321  *
 322  * Use:         Writes a tokenized message into a string, for later
 323  *              presentation.
 324  */
 325
 326 void a_format(dstr *d, const char *fmt, ...)
 327 {
 328   va_list ap;
 329
 330   va_start(ap, fmt);
 331   a_vformat(d, fmt, &ap);
 332   va_end(ap);
 333 }
 334
 335 /* --- @a_write@, @a_vwrite@ --- *
 336  *
 337  * Arguments:   @admin *a@ = admin connection to write to
 338  *              @const char *status@ = status code to report
 339  *              @const char *tag@ = tag string, or null
 340  *              @const char *fmt@ = pointer to format string
 341  *              @va_list *ap@ = arguments in list
 342  *              @...@ = other arguments
 343  *
 344  * Returns:     ---
 345  *
 346  * Use:         Sends a message to an admin connection.
 347  */
 348
 349 static void a_vwrite(admin *a, const char *status, const char *tag,
 350                      const char *fmt, va_list *ap)
 351 {
 352   dstr d = DSTR_INIT;
 353
 354   if (tag) dstr_puts(&d, "BG");
 355   dstr_puts(&d, status);
 356   if (tag) u_quotify(&d, tag);
 357   a_vformat(&d, fmt, ap);
 358   dstr_putc(&d, '\n');
 359   dosend(a, d.buf, d.len);
 360   dstr_destroy(&d);
 361 }
 362
 363 static void a_write(admin *a, const char *status, const char *tag,
 364                     const char *fmt, ...)
 365 {
 366   va_list ap;
 367
 368   va_start(ap, fmt);
 369   a_vwrite(a, status, tag, fmt, &ap);
 370   va_end(ap);
 371 }
 372
 373 /* --- @a_ok@, @a_fail@ --- *
 374  *
 375  * Arguments:   @admin *a@ = connection
 376  *              @const char *fmt@ = format string
 377  *              @...@ = other arguments
 378  *
 379  * Returns:     ---
 380  *
 381  * Use:         Convenience functions for @a_write@.
 382  */
 383
 384 static void a_ok(admin *a) { a_write(a, "OK", 0, A_END); }
 385
 386 static void a_fail(admin *a, const char *fmt, ...)
 387 {
 388   va_list ap;
 389
 390   va_start(ap, fmt);
 391   a_vwrite(a, "FAIL", 0, fmt, &ap);
 392   va_end(ap);
 393 }
 394
 395 /* --- @a_info@ --- *
 396  *
 397  * Arguments:   @admin *a@ = connection
 398  *              @const char *fmt@ = format string
 399  *              @...@ = other arguments
 400  *
 401  * Returns:     ---
 402  *
 403  * Use:         Report information to an admin client.
 404  */
 405
 406 void a_info(admin *a, const char *fmt, ...)
 407 {
 408   va_list ap;
 409
 410   va_start(ap, fmt);
 411   a_vwrite(a, "INFO", 0, fmt, &ap);
 412   va_end(ap);
 413 }
 414
 415 /* --- @a_alert@, @a_valert@, @a_rawalert@ --- *
 416  *
 417  * Arguments:   @unsigned f_and, f_eq@ = filter for connections
 418  *              @const char *status@ = status string
 419  *              @const char *fmt@ = pointer to format string
 420  *              @const char *p@ = pointer to raw string
 421  *              @size_t sz@ = size of raw string
 422  *              @va_list *ap@ = arguments in list
 423  *              @...@ = other arguments
 424  *
 425  * Returns:     ---
 426  *
 427  * Use:         Write a message to all admin connections matched by the given
 428  *              filter.
 429  */
 430
 431 static void a_rawalert(unsigned f_and, unsigned f_eq, const char *status,
 432                        const char *p, size_t sz)
 433 {
 434   admin *a, *aa;
 435   dstr d = DSTR_INIT;
 436
 437   if (!(flags & F_INIT))
 438     return;
 439   dstr_puts(&d, status);
 440   if (p) {
 441     dstr_putc(&d, ' ');
 442     dstr_putm(&d, p, sz);
 443   }
 444   dstr_putc(&d, '\n');
 445   p = d.buf;
 446   sz = d.len;
 447   for (a = admins; a; a = aa) {
 448     aa = a->next;
 449     if ((a->f & f_and) == f_eq)
 450       dosend(a, d.buf, d.len);
 451   }
 452   dstr_destroy(&d);
 453 }
 454
 455 static void a_valert(unsigned f_and, unsigned f_eq, const char *status,
 456                      const char *fmt, va_list *ap)
 457 {
 458   dstr d = DSTR_INIT;
 459
 460   if (!(flags & F_INIT))
 461     return;
 462   a_vformat(&d, fmt, ap);
 463   a_rawalert(f_and, f_eq, status, fmt ? d.buf : 0, fmt ? d.len : 0);
 464   dstr_destroy(&d);
 465 }
 466
 467 static void a_alert(unsigned f_and, unsigned f_eq, const char *status,
 468                     const char *fmt, ...)
 469 {
 470   va_list ap;
 471
 472   va_start(ap, fmt);
 473   a_valert(f_and, f_eq, status, fmt, &ap);
 474   va_end(ap);
 475 }
 476
 477 /* --- @a_warn@ --- *
 478  *
 479  * Arguments:   @const char *fmt@ = pointer to format string
 480  *              @...@ = other arguments
 481  *
 482  * Returns:     ---
 483  *
 484  * Use:         Informs all admin connections of a warning.
 485  */
 486
 487 void a_warn(const char *fmt, ...)
 488 {
 489   va_list ap;
 490
 491   va_start(ap, fmt);
 492   if (flags & F_INIT)
 493     a_valert(0, 0, "WARN", fmt, &ap);
 494   else {
 495     dstr d = DSTR_INIT;
 496     fprintf(stderr, "%s: ", QUIS);
 497     a_vformat(&d, fmt, &ap);
 498     dstr_putc(&d, '\n');
 499     dstr_write(&d, stderr);
 500     dstr_destroy(&d);
 501   }
 502   va_end(ap);
 503 }
 504
 505 /* --- @a_trace@ --- *
 506  *
 507  * Arguments:   @const char *p@ = pointer to a buffer
 508  *              @size_t sz@ = size of the buffer
 509  *              @void *v@ = uninteresting pointer
 510  *
 511  * Returns:     ---
 512  *
 513  * Use:         Custom trace output handler.  Sends trace messages to
 514  *              interested admin connections.
 515  */
 516
 517 #ifndef NTRACE
 518 static void a_trace(const char *p, size_t sz, void *v)
 519   { a_rawalert(AF_TRACE, AF_TRACE, "TRACE", p, sz); }
 520 #endif
 521
 522 /* --- @a_notify@ --- *
 523  *
 524  * Arguments:   @const char *fmt@ = pointer to format string
 525  *              @...@ = other arguments
 526  *
 527  * Returns:     ---
 528  *
 529  * Use:         Sends a notification to interested admin connections.
 530  */
 531
 532 void a_notify(const char *fmt, ...)
 533 {
 534   va_list ap;
 535
 536   va_start(ap, fmt);
 537   a_valert(AF_NOTE, AF_NOTE, "NOTE", fmt, &ap);
 538   va_end(ap);
 539 }
 540
 541 /* --- @a_quit@ --- *
 542  *
 543  * Arguments:   ---
 544  *
 545  * Returns:     ---
 546  *
 547  * Use:         Shuts things down nicely.
 548  */
 549
 550 void a_quit(void)
 551 {
 552   close(sock.fd);
 553   unlink(sockname);
 554   FOREACH_PEER(p, { p_destroy(p); });
 555   ps_quit();
 556   exit(0);
 557 }
 558
 559 /* --- @a_sigdie@ --- *
 560  *
 561  * Arguments:   @int sig@ = signal number
 562  *              @void *v@ = an uninteresting argument
 563  *
 564  * Returns:     ---
 565  *
 566  * Use          Shuts down on receipt of a fatal signal.
 567  */
 568
 569 static void a_sigdie(int sig, void *v)
 570 {
 571   char *p;
 572   char buf[20];
 573
 574   switch (sig) {
 575     case SIGTERM:       p = "SIGTERM"; break;
 576     case SIGINT:        p = "SIGINT"; break;
 577     default:
 578       sprintf(buf, "%i", sig);
 579       p = buf;
 580       break;
 581   }
 582   a_warn("SERVER", "quit", "signal", "%s", p, A_END);
 583   a_quit();
 584 }
 585
 586 /* --- @a_sighup@ --- *
 587  *
 588  * Arguments:   @int sig@ = signal number
 589  *              @void *v@ = an uninteresting argument
 590  *
 591  * Returns:     ---
 592  *
 593  * Use          Logs a message about SIGHUP not being useful.
 594  */
 595
 596 static void a_sighup(int sig, void *v)
 597   { a_warn("SERVER", "ignore", "signal", "SIGHUP", A_END); }
 598
 599 /* --- @a_parsetime@ --- *
 600  *
 601  * Arguments;   @const char *p@ = time string to parse
 602  *
 603  * Returns:     Time in seconds, or @< 0@ on error.
 604  */
 605
 606 static long a_parsetime(const char *p)
 607 {
 608   char *q;
 609   long t = strtol(p, &q, 0);
 610
 611   switch (*q) {
 612     case 'd': t *= 24;
 613     case 'h': t *= 60;
 614     case 'm': t *= 60;
 615     case 's': if (q[1] != 0)
 616     default:    t = -1;
 617     case 0:   break;
 618   }
 619   return (t);
 620 }
 621
 622 /* --- @a_findpeer@ --- *
 623  *
 624  * Arguments:   @admin *a@ = admin connection
 625  *              @const char *pn@ = peer name
 626  *
 627  * Returns:     The peer, or null if not there.
 628  *
 629  * Use:         Finds a peer, reporting an error if it failed.
 630  */
 631
 632 static peer *a_findpeer(admin *a, const char *pn)
 633 {
 634   peer *p;
 635
 636   if ((p = p_find(pn)) == 0)
 637     a_fail(a, "unknown-peer", "%s", pn, A_END);
 638   return (p);
 639 }
 640
 641 /*----- Backgrounded operations -------------------------------------------*/
 642
 643 #define BGTAG(bg)                                                       \
 644   (((admin_bgop *)(bg))->tag ? ((admin_bgop *)(bg))->tag : "<foreground>")
 645
 646 /* --- @a_bgfind@ --- *
 647  *
 648  * Arguments:   @admin *a@ = a client block
 649  *              @const char *tag@ = the requested tag
 650  *
 651  * Returns:     The requested background job, or null.
 652  */
 653
 654 static admin_bgop *a_bgfind(admin *a, const char *tag)
 655 {
 656   admin_bgop *bg;
 657
 658   for (bg = a->bg; bg; bg = bg->next) {
 659     if (bg->tag && strcmp(tag, bg->tag) == 0)
 660       return (bg);
 661   }
 662   return (0);
 663 }
 664
 665 /* --- @a_bgrelease@ --- *
 666  *
 667  * Arguments:   @admin_bgop *bg@ = backgrounded operation
 668  *
 669  * Returns:     ---
 670  *
 671  * Use:         Removes a backgrounded operation from the queue, since
 672  *              (presumably) it's done.
 673  */
 674
 675 static void a_bgrelease(admin_bgop *bg)
 676 {
 677   admin *a = bg->a;
 678
 679   T( trace(T_ADMIN, "admin: release bgop %s", BGTAG(bg)); )
 680   if (bg->tag) xfree(bg->tag);
 681   else selbuf_enable(&a->b);
 682   if (bg->next) bg->next->prev = bg->prev;
 683   if (bg->prev) bg->prev->next = bg->next;
 684   else a->bg = bg->next;
 685   xfree(bg);
 686   if (!a->bg && (a->f & AF_CLOSE)) a_destroy(a);
 687 }
 688
 689 /* --- @a_bgok@, @a_bginfo@, @a_bgfail@ --- *
 690  *
 691  * Arguments:   @admin_bgop *bg@ = backgrounded operation
 692  *              @const char *fmt@ = format string
 693  *              @...@ = other arguments
 694  *
 695  * Returns:     ---
 696  *
 697  * Use:         Convenience functions for @a_write@.
 698  */
 699
 700 static void a_bgok(admin_bgop *bg)
 701   { a_write(bg->a, "OK", bg->tag, A_END); }
 702
 703 static void a_bginfo(admin_bgop *bg, const char *fmt, ...)
 704 {
 705   va_list ap;
 706   va_start(ap, fmt);
 707   a_vwrite(bg->a, "INFO", bg->tag, fmt, &ap);
 708   va_end(ap);
 709 }
 710
 711 static void a_bgfail(admin_bgop *bg, const char *fmt, ...)
 712 {
 713   va_list ap;
 714   va_start(ap, fmt);
 715   a_vwrite(bg->a, "FAIL", bg->tag, fmt, &ap);
 716   va_end(ap);
 717 }
 718
 719 /* --- @a_bgadd@ --- *
 720  *
 721  * Arguments:   @admin *a@ = administration connection
 722  *              @admin_bgop *bg@ = pointer to background operation
 723  *              @const char *tag@ = background tag, or null for foreground
 724  *              @void (*cancel)(admin_bgop *)@ = cancel function
 725  *
 726  * Returns:     Zero for success, nonzero on failure.
 727  *
 728  * Use:         Links a background job into the list.
 729  */
 730
 731 static int a_bgadd(admin *a, admin_bgop *bg, const char *tag,
 732                    void (*cancel)(admin_bgop *))
 733 {
 734   if (tag) {
 735     if (a_bgfind(a, tag)) {
 736       a_fail(a, "tag-exists", "%s", tag, A_END);
 737       return (-1);
 738     }
 739     bg->tag = xstrdup(tag);
 740   }
 741   else {
 742     bg->tag = 0;
 743     selbuf_disable(&a->b);
 744   }
 745   bg->a = a;
 746   bg->cancel = cancel;
 747   bg->next = a->bg;
 748   bg->prev = 0;
 749   if (a->bg) a->bg->prev = bg;
 750   a->bg = bg;
 751   T( trace(T_ADMIN, "admin: add bgop %s", BGTAG(bg)); )
 752   if (tag) a_write(a, "DETACH", tag, A_END);
 753   return (0);
 754 }
 755
 756 /*----- Job table manipulation --------------------------------------------*/
 757
 758 #define JOB_SHIFT 16
 759 #define JOB_INDEXMASK ((1ul << JOB_SHIFT) - 1)
 760 #define JOB_SEQMASK ((1ul << (32 - JOB_SHIFT)) - 1)
 761
 762 #define JOB_END 0xfffffffful
 763
 764 static unsigned long a_joboffset;
 765
 766 /* --- @a_jobidencode@ --- *
 767  *
 768  * Arguments:   @admin_svcop *svc@ = pointer to a service operation
 769  *
 770  * Returns:     A jobid for this job, in an internal static buffer.
 771  *
 772  * Use:         Constructs a jobid.  In order to dissuade people from
 773  *              predicting jobids, we obfuscate them.
 774  *
 775  *              A `raw' jobid consists of two 16-bit fields.  The low 16 bits
 776  *              are an index into a big array.  The high 16 bits are a
 777  *              sequence number recording how many times that slot has been
 778  *              reused.
 779  *
 780  *              This `raw' jobid is then obfuscated by adding a randomly-
 781  *              generated offset, and multiplying (mod %$2^{32}$%) by a fixed
 782  *              odd constant.
 783  */
 784
 785 static const char *a_jobidencode(admin_svcop *svc)
 786 {
 787   admin_jobtable *j = &svc->prov->j;
 788   static char buf[10];
 789   unsigned long pre;
 790   unsigned seq;
 791
 792   assert(svc->index <= JOB_INDEXMASK);
 793   seq = j->v[svc->index].seq;
 794   assert(seq <= JOB_SEQMASK);
 795   pre = (unsigned long)svc->index | ((unsigned long)seq << JOB_SHIFT);
 796   sprintf(buf, "J%08lx", ((pre + a_joboffset) * 0x0f87a7a3ul) & 0xffffffff);
 797   return (buf);
 798 }
 799
 800 /* --- @a_jobiddecode@ --- *
 801  *
 802  * Arguments:   @admin_jobtable *j@ = pointer to a job table
 803  *              @const char *jid@ = pointer to a jobid string
 804  *
 805  * Returns:     A pointer to the job's @svcop@ structure.
 806  */
 807
 808 static admin_svcop *a_jobiddecode(admin_jobtable *j, const char *jid)
 809 {
 810   unsigned i;
 811   unsigned long pre;
 812
 813   if (jid[0] != 'J')
 814     return (0);
 815   for (i = 1; i < 9; i++) {
 816     if (!isxdigit((unsigned char)jid[i]))
 817       return (0);
 818   }
 819   if (jid[9] != 0)
 820     return (0);
 821   pre = strtoul(jid + 1, 0, 16);
 822   pre = ((pre * 0xbd11c40bul) - a_joboffset) & 0xffffffff;
 823   i = pre & JOB_INDEXMASK;
 824   if (i >= j->n || j->v[i].seq != (pre >> JOB_SHIFT))
 825     return (0);
 826   return (j->v[i].u.op);
 827 }
 828
 829 /* --- @a_jobcreate@ --- *
 830  *
 831  * Arguments:   @admin *a@ = pointer to administration client
 832  *
 833  * Returns:     A pointer to a freshly-allocated @svcop@, or null.
 834  *
 835  * Use:         Allocates a fresh @svcop@ and links it into a job table.
 836  */
 837
 838 static admin_svcop *a_jobcreate(admin *a)
 839 {
 840   admin_svcop *svc;
 841   unsigned i;
 842   unsigned sz;
 843   admin_jobtable *j = &a->j;
 844
 845   if (j->free != JOB_END) {
 846     i = j->free;
 847     j->free = j->v[i].u.next;
 848   } else {
 849     if (j->n == j->sz) {
 850       if (j->sz > JOB_INDEXMASK)
 851         return (0);
 852       sz = j->sz;
 853       if (!sz) {
 854         j->sz = 16;
 855         j->v = xmalloc(j->sz * sizeof(*j->v));
 856       } else {
 857         j->sz = sz << 1;
 858         j->v = xrealloc(j->v, j->sz * sizeof(*j->v), sz * sizeof(*j->v));
 859       }
 860     }
 861     i = j->n++;
 862     j->v[i].seq = 0;
 863   }
 864   svc = xmalloc(sizeof(*svc));
 865   svc->index = i;
 866   svc->prov = a;
 867   svc->next = j->active;
 868   svc->prev = 0;
 869   if (j->active) j->active->prev = svc;
 870   j->active = svc;
 871   j->v[i].u.op = svc;
 872   IF_TRACING(T_ADMIN, {
 873     trace(T_ADMIN, "admin: created job %s (%u)", a_jobidencode(svc), i);
 874   })
 875   return (svc);
 876 }
 877
 878 /* --- @a_jobdestroy@ --- *
 879  *
 880  * Arguments:   @admin_svcop *svc@ = pointer to job block
 881  *
 882  * Returns:     ---
 883  *
 884  * Use:         Frees up a completed (or cancelled) job.
 885  */
 886
 887 static void a_jobdestroy(admin_svcop *svc)
 888 {
 889   admin *a = svc->prov;
 890   admin_jobtable *j = &a->j;
 891   unsigned i = svc->index;
 892
 893   IF_TRACING(T_ADMIN, {
 894     trace(T_ADMIN, "admin: destroying job %s (%u)", a_jobidencode(svc), i);
 895   })
 896   assert(j->v[i].u.op = svc);
 897   j->v[i].u.next = j->free;
 898   j->v[i].seq++;
 899   j->free = i;
 900   if (svc->next) svc->next->prev = svc->prev;
 901   if (svc->prev) svc->prev->next = svc->next;
 902   else j->active = svc->next;
 903 }
 904
 905 /* --- @a_jobtableinit@ --- *
 906  *
 907  * Arguments:   @admin_jobtable *j@ = pointer to job table
 908  *
 909  * Returns:     ---
 910  *
 911  * Use:         Initializes a job table.
 912  */
 913
 914 static void a_jobtableinit(admin_jobtable *j)
 915 {
 916   if (!a_joboffset)
 917     a_joboffset = GR_RANGE(&rand_global, 0xffffffff) + 1;
 918   j->n = j->sz = 0;
 919   j->active = 0;
 920   j->free = JOB_END;
 921   j->v = 0;
 922 }
 923
 924 /* --- @a_jobtablefinal@ --- *
 925  *
 926  * Arguments:   @admin_jobtable *j@ = pointer to job table
 927  *
 928  * Returns:     ---
 929  *
 930  * Use:         Closes down a job table.
 931  */
 932
 933 static void a_jobtablefinal(admin_jobtable *j)
 934 {
 935   admin_svcop *svc, *ssvc;
 936
 937   for (svc = j->active; svc; svc = ssvc) {
 938     ssvc = svc->next;
 939     a_bgfail(&svc->bg, "provider-failed", A_END);
 940     a_bgrelease(&svc->bg);
 941   }
 942   if (j->v) xfree(j->v);
 943 }
 944
 945 /*----- Services infrastructure -------------------------------------------*/
 946
 947 /* --- @a_svcfind@ --- *
 948  *
 949  * Arguments:   @admin *a@ = the requesting client
 950  *              @const char *name@ = service name wanted
 951  *
 952  * Returns:     The service requested, or null.
 953  *
 954  * Use:         Finds a service; reports an error if the service couldn't be
 955  *              found.
 956  */
 957
 958 static admin_service *a_svcfind(admin *a, const char *name)
 959 {
 960   admin_service *svc;
 961
 962   if ((svc = sym_find(&a_svcs, name, -1, 0, 0)) == 0) {
 963     a_fail(a, "unknown-service", "%s", name, A_END);
 964     return (0);
 965   }
 966   return (svc);
 967 }
 968
 969 /* --- @a_svcunlink@ --- *
 970  *
 971  * Arguments:   @admin_service *svc@ = pointer to service structure
 972  *
 973  * Returns:     ---
 974  *
 975  * Use:         Unlinks the service from its provider, without issuing a
 976  *              message or freeing the structure.  The version string is
 977  *              freed, however.
 978  */
 979
 980 static void a_svcunlink(admin_service *svc)
 981 {
 982   if (svc->next)
 983     svc->next->prev = svc->prev;
 984   if (svc->prev)
 985     svc->prev->next = svc->next;
 986   else
 987     svc->prov->svcs = svc->next;
 988   xfree(svc->version);
 989 }
 990
 991 /* --- @a_svcrelease@ --- *
 992  *
 993  * Arguments:   @admin_service *svc@ = pointer to service structure
 994  *
 995  * Returns:     ---
 996  *
 997  * Use:         Releases a service and frees its structure.
 998  */
 999
1000 static void a_svcrelease(admin_service *svc)
1001 {
1002   a_notify("SVCRELEASE", "%s", SYM_NAME(svc), A_END);
1003   a_svcunlink(svc);
1004   sym_remove(&a_svcs, svc);
1005 }
1006
1007 /*----- Name resolution operations ----------------------------------------*/
1008
1009 /* --- @a_resolved@ --- *
1010  *
1011  * Arguments:   @struct hostent *h@ = pointer to resolved hostname
1012  *              @void *v@ = pointer to resolver operation
1013  *
1014  * Returns:     ---
1015  *
1016  * Use:         Handles a completed name resolution.
1017  */
1018
1019 static void a_resolved(struct hostent *h, void *v)
1020 {
1021   admin_resop *r = v;
1022
1023   QUICKRAND;
1024   if (!h) {
1025     T( trace(T_ADMIN, "admin: resop %s failed: %s",
1026              BGTAG(r), hstrerror(h_errno)); )
1027     a_bgfail(&r->bg, "resolve-error", "%s", r->addr, A_END);
1028     r->func(r, ARES_FAIL);
1029   } else {
1030     T( trace(T_ADMIN, "admin: resop %s ok", BGTAG(r)); )
1031     memcpy(&r->sa.sin.sin_addr, h->h_addr, sizeof(struct in_addr));
1032     r->func(r, ARES_OK);
1033   }
1034   sel_rmtimer(&r->t);
1035   xfree(r->addr);
1036   a_bgrelease(&r->bg);
1037 }
1038
1039 /* --- @a_restimer@ --- *
1040  *
1041  * Arguments:   @struct timeval *tv@ = timer
1042  *              @void *v@ = pointer to resolver operation
1043  *
1044  * Returns:     ---
1045  *
1046  * Use:         Times out a resolver.
1047  */
1048
1049 static void a_restimer(struct timeval *tv, void *v)
1050 {
1051   admin_resop *r = v;
1052
1053   T( trace(T_ADMIN, "admin: resop %s timeout", BGTAG(r)); )
1054   a_bgfail(&r->bg, "resolver-timeout", "%s", r->addr, A_END);
1055   r->func(r, ARES_FAIL);
1056   bres_abort(&r->r);
1057   xfree(r->addr);
1058   a_bgrelease(&r->bg);
1059 }
1060
1061 /* --- @a_rescancel@ --- *
1062  *
1063  * Arguments:   @admin_bgop *bg@ = background operation
1064  *
1065  * Returns:     ---
1066  *
1067  * Use:         Cancels an add operation.
1068  */
1069
1070 static void a_rescancel(admin_bgop *bg)
1071 {
1072   admin_resop *r = (admin_resop *)bg;
1073
1074   T( trace(T_ADMIN, "admin: cancel resop %s", BGTAG(r)); )
1075   r->func(r, ARES_FAIL);
1076   sel_rmtimer(&r->t);
1077   xfree(r->addr);
1078   bres_abort(&r->r);
1079 }
1080
1081 /* --- @a_resolve@ --- *
1082  *
1083  * Arguments:   @admin *a@ = administration connection
1084  *              @admin_resop *r@ = resolver operation to run
1085  *              @const char *tag@ = background operation tag
1086  *              @void (*func)(struct admin_resop *, int@ = handler function
1087  *              @unsigned ac@ = number of remaining arguments
1088  *              @char *av[]@ = pointer to remaining arguments
1089  *
1090  * Returns:     ---
1091  *
1092  * Use:         Cranks up a resolver job.
1093  */
1094
1095 static void a_resolve(admin *a, admin_resop *r, const char *tag,
1096                       void (*func)(struct admin_resop *, int),
1097                       unsigned ac, char *av[])
1098 {
1099   struct timeval tv;
1100   unsigned long pt;
1101   char *p;
1102   int i = 0;
1103
1104   /* --- Fill in the easy bits of address --- */
1105
1106   r->bg.tag = "<starting>";
1107   r->addr = 0;
1108   r->func = func;
1109   if (mystrieq(av[i], "inet")) i++;
1110   if (ac - i != 1 && ac - i != 2) {
1111     a_fail(a, "bad-addr-syntax", "[inet] ADDRESS [PORT]", A_END);
1112     goto fail;
1113   }
1114   r->sa.sin.sin_family = AF_INET;
1115   r->addr = xstrdup(av[i]);
1116   if (!av[i + 1])
1117     pt = TRIPE_PORT;
1118   else {
1119     pt = strtoul(av[i + 1], &p, 0);
1120     if (*p) {
1121       struct servent *s = getservbyname(av[i + 1], "udp");
1122       if (!s) {
1123         a_fail(a, "unknown-service", "%s", av[i + 1], A_END);
1124         goto fail;
1125       }
1126       pt = ntohs(s->s_port);
1127     }
1128   }
1129   if (pt == 0 || pt >= 65536) {
1130     a_fail(a, "invalid-port", "%lu", pt, A_END);
1131     goto fail;
1132   }
1133   r->sa.sin.sin_port = htons(pt);
1134
1135   /* --- Report backgrounding --- *
1136    *
1137    * Do this for consistency of interface, even if we're going to get the
1138    * answer straight away.
1139    */
1140
1141   if (a_bgadd(a, &r->bg, tag, a_rescancel))
1142     goto fail;
1143   T( trace(T_ADMIN, "admin: %u, resop %s, hostname `%s'",
1144            a->seq, BGTAG(r), r->addr); )
1145
1146   /* --- If the name is numeric, do it the easy way --- */
1147
1148   if (inet_aton(av[i], &r->sa.sin.sin_addr)) {
1149     T( trace(T_ADMIN, "admin: resop %s done the easy way", BGTAG(r)); )
1150     func(r, ARES_OK);
1151     xfree(r->addr);
1152     a_bgrelease(&r->bg);
1153     return;
1154   }
1155
1156   /* --- Store everything for later and crank up the resolver --- */
1157
1158   gettimeofday(&tv, 0);
1159   tv.tv_sec += T_RESOLVE;
1160   sel_addtimer(&sel, &r->t, &tv, a_restimer, r);
1161   bres_byname(&r->r, r->addr, a_resolved, r);
1162   return;
1163
1164 fail:
1165   func(r, ARES_FAIL);
1166   if (r->addr) xfree(r->addr);
1167   xfree(r);
1168 }
1169
1170 /*----- Option parsing ----------------------------------------------------*/
1171
1172 #define OPTIONS(argc, argv, guts) do {                                  \
1173   char **o_av = argv;                                                   \
1174   for (;; o_av++) {                                                     \
1175     if (!*o_av)                                                         \
1176       break;                                                            \
1177     if (mystrieq(*o_av, "--")) {                                        \
1178       o_av++;                                                           \
1179       break;                                                            \
1180     }                                                                   \
1181     guts                                                                \
1182     if (**o_av == '-')                                                  \
1183       goto bad_syntax;                                                  \
1184     break;                                                              \
1185   }                                                                     \
1186   argc -= o_av - argv;                                                  \
1187   argv = o_av;                                                          \
1188 } while (0)
1189
1190 #define OPT(name, guts) if (mystrieq(*o_av, name)) { guts continue; }
1191
1192 #define OPTARG(name, arg, guts) OPT(name, {                             \
1193   const char *arg;                                                      \
1194   arg = *++o_av;                                                        \
1195   if (!arg) goto bad_syntax;                                            \
1196   guts                                                                  \
1197 })
1198
1199 #define OPTTIME(name, arg, guts) OPTARG(name, o_arg, {                  \
1200   long arg;                                                             \
1201   if ((arg = a_parsetime(o_arg)) < 0) {                                 \
1202     a_fail(a, "bad-time-spec", "%s", o_arg, A_END);                     \
1203     goto fail;                                                          \
1204   }                                                                     \
1205   guts                                                                  \
1206 })
1207
1208 /*----- Adding peers ------------------------------------------------------*/
1209
1210 /* --- @a_doadd@ --- *
1211  *
1212  * Arguments:   @admin_resop *r@ = resolver operation
1213  *              @int rc@ = how it worked
1214  *
1215  * Returns:     ---
1216  *
1217  * Use:         Handles a completed resolution.
1218  */
1219
1220 static void a_doadd(admin_resop *r, int rc)
1221 {
1222   admin_addop *add = (admin_addop *)r;
1223
1224   T( trace(T_ADMIN, "admin: done add op %s", BGTAG(add)); )
1225
1226   if (rc == ARES_OK) {
1227     add->peer.sa = add->r.sa;
1228     if (p_findbyaddr(&add->r.sa))
1229       a_bgfail(&add->r.bg, "peer-addr-exists", "?ADDR", &add->r.sa, A_END);
1230     else if (p_find(add->peer.name))
1231       a_bgfail(&add->r.bg, "peer-exists", "%s", add->peer.name, A_END);
1232     else if (!p_create(&add->peer))
1233       a_bgfail(&add->r.bg, "peer-create-fail", "%s", add->peer.name, A_END);
1234     else
1235       a_bgok(&add->r.bg);
1236   }
1237
1238   if (add->peer.tag) xfree(add->peer.tag);
1239   if (add->peer.privtag) xfree(add->peer.privtag);
1240   xfree(add->peer.name);
1241 }
1242
1243 /* --- @acmd_add@ --- *
1244  *
1245  * Arguments:   @admin *a@ = connection which requested the addition
1246  *              @unsigned ac@ = argument count
1247  *              @char *av[]@ = pointer to the argument list
1248  *
1249  * Returns:     ---
1250  *
1251  * Use:         Adds a new peer.
1252  */
1253
1254 static void acmd_add(admin *a, unsigned ac, char *av[])
1255 {
1256   const char *tag = 0;
1257   admin_addop *add;
1258
1259   /* --- Set stuff up --- */
1260
1261   add = xmalloc(sizeof(*add));
1262   add->peer.name = 0;
1263   add->peer.tag = 0;
1264   add->peer.privtag = 0;
1265   add->peer.t_ka = 0;
1266   add->peer.tops = tun_default;
1267   add->peer.f = 0;
1268
1269   /* --- Parse options --- */
1270
1271   OPTIONS(ac, av, {
1272     OPTARG("-background", arg, { tag = arg; })
1273     OPTARG("-tunnel", arg, {
1274       unsigned i;
1275       for (i = 0;; i++) {
1276         if (!tunnels[i]) {
1277           a_fail(a, "unknown-tunnel", "%s", arg, A_END);
1278           goto fail;
1279         }
1280         if (mystrieq(arg, tunnels[i]->name)) {
1281           add->peer.tops = tunnels[i];
1282           break;
1283         }
1284       }
1285     })
1286     OPTTIME("-keepalive", t, { add->peer.t_ka = t; })
1287     OPT("-cork", { add->peer.f |= KXF_CORK; })
1288     OPTARG("-key", arg, {
1289       if (add->peer.tag) xfree(add->peer.tag);
1290       add->peer.tag = xstrdup(arg);
1291     })
1292     OPT("-mobile", { add->peer.f |= PSF_MOBILE; })
1293     OPTARG("-priv", arg, {
1294       if (add->peer.privtag) xfree(add->peer.privtag);
1295       add->peer.privtag = xstrdup(arg);
1296     })
1297   });
1298
1299   /* --- Make sure someone's not got there already --- */
1300
1301   if (!av[0] || !av[1])
1302     goto bad_syntax;
1303   if (p_find(*av)) {
1304     a_fail(a, "peer-exists", "%s", *av, A_END);
1305     goto fail;
1306   }
1307   add->peer.name = xstrdup(*av++);
1308   ac--;
1309
1310   /* --- Crank up the resolver --- */
1311
1312   a_resolve(a, &add->r, tag, a_doadd, ac, av);
1313   return;
1314
1315   /* --- Clearing up --- */
1316
1317 bad_syntax:
1318   a_fail(a, "bad-syntax", "add", "[OPTIONS] PEER ADDR ...", A_END);
1319 fail:
1320   if (add->peer.name) xfree(add->peer.name);
1321   if (add->peer.tag) xfree(add->peer.tag);
1322   if (add->peer.privtag) xfree(add->peer.privtag);
1323   xfree(add);
1324   return;
1325 }
1326
1327 /*----- Ping --------------------------------------------------------------*/
1328
1329 /* --- @a_pingcancel@ --- *
1330  *
1331  * Arguments:   @admin_bgop *bg@ = background operation block
1332  *
1333  * Returns:     ---
1334  *
1335  * Use:         Cancels a running ping.
1336  */
1337
1338 static void a_pingcancel(admin_bgop *bg)
1339 {
1340   admin_pingop *pg = (admin_pingop *)bg;
1341   T( trace(T_ADMIN, "admin: cancel ping op %s", BGTAG(pg)); )
1342   p_pingdone(&pg->ping, PING_NONOTIFY);
1343 }
1344
1345 /* --- @a_pong@ --- *
1346  *
1347  * Arguments:   @int rc@ = return code
1348  *              @void *v@ = ping operation block
1349  *
1350  * Returns:     ---
1351  *
1352  * Use:         Collects what happened to a ping message.
1353  */
1354
1355 static void a_pong(int rc, void *v)
1356 {
1357   admin_pingop *pg = v;
1358   struct timeval tv;
1359   double millis;
1360
1361   switch (rc) {
1362     case PING_OK:
1363       gettimeofday(&tv, 0);
1364       tv_sub(&tv, &tv, &pg->pingtime);
1365       millis = (double)tv.tv_sec * 1000 + (double)tv.tv_usec/1000;
1366       a_bginfo(&pg->bg, "ping-ok", "%.1f", millis, A_END);
1367       a_bgok(&pg->bg);
1368       break;
1369     case PING_TIMEOUT:
1370       a_bginfo(&pg->bg, "ping-timeout", A_END);
1371       a_bgok(&pg->bg);
1372       break;
1373     case PING_PEERDIED:
1374       a_bginfo(&pg->bg, "ping-peer-died", A_END);
1375       a_bgok(&pg->bg);
1376       break;
1377     default:
1378       abort();
1379   }
1380   T( trace(T_ADMIN, "admin: ponged ping op %s", BGTAG(pg)); )
1381   a_bgrelease(&pg->bg);
1382 }
1383
1384 /* --- @acmd_ping@, @acmd_eping@ --- *
1385  *
1386  * Arguments:   @admin *a@ = connection which requested the ping
1387  *              @unsigned ac@ = argument count
1388  *              @char *av[]@ = pointer to the argument list
1389  *
1390  * Returns:     ---
1391  *
1392  * Use:         Pings a peer.
1393  */
1394
1395 static void a_ping(admin *a, unsigned ac, char *av[],
1396                    const char *cmd, unsigned msg)
1397 {
1398   long t = T_PING;
1399   peer *p;
1400   admin_pingop *pg = 0;
1401   const char *tag = 0;
1402
1403   OPTIONS(ac, av, {
1404     OPTARG("-background", arg, { tag = arg; })
1405     OPTTIME("-timeout", arg, { t = arg; })
1406   });
1407   if (!*av || av[1]) goto bad_syntax;
1408   if ((p = a_findpeer(a, *av)) == 0)
1409     return;
1410   pg = xmalloc(sizeof(*pg));
1411   gettimeofday(&pg->pingtime, 0);
1412   if (a_bgadd(a, &pg->bg, tag, a_pingcancel))
1413     goto fail;
1414   T( trace(T_ADMIN, "admin: ping op %s: %s to %s",
1415            BGTAG(pg), cmd, p_name(p)); )
1416   if (p_pingsend(p, &pg->ping, msg, t, a_pong, pg)) {
1417     a_bgfail(&pg->bg, "ping-send-failed", A_END);
1418     a_bgrelease(&pg->bg);
1419   }
1420   return;
1421
1422 bad_syntax:
1423   a_fail(a, "bad-syntax", "%s", cmd, "[OPTIONS] PEER", cmd, A_END);
1424 fail:
1425   if (pg) xfree(pg);
1426   return;
1427 }
1428
1429 static void acmd_ping(admin *a, unsigned ac, char *av[])
1430   { a_ping(a, ac, av, "ping", MISC_PING); }
1431 static void acmd_eping(admin *a, unsigned ac, char *av[])
1432   { a_ping(a, ac, av, "eping", MISC_EPING); }
1433
1434 /*----- Service commands --------------------------------------------------*/
1435
1436 static void acmd_svcclaim(admin *a, unsigned ac, char *av[])
1437 {
1438   admin_service *svc;
1439   unsigned f;
1440
1441   svc = sym_find(&a_svcs, av[0], -1, sizeof(*svc), &f);
1442   if (f) {
1443     if (versioncmp(av[1], svc->version) <= 0) {
1444       a_fail(a,
1445              "service-exists",
1446              "%s", SYM_NAME(svc),
1447              "%s", svc->version,
1448              A_END);
1449       return;
1450     }
1451     a_write(svc->prov, "SVCCLAIM", 0, "%s", av[0], "%s", av[1], A_END);
1452     a_svcunlink(svc);
1453   }
1454   svc->prov = a;
1455   svc->version = xstrdup(av[1]);
1456   svc->next = a->svcs;
1457   svc->prev = 0;
1458   if (a->svcs) a->svcs->prev = svc;
1459   a->svcs = svc;
1460   a_notify("SVCCLAIM", "%s", SYM_NAME(svc), "%s", svc->version, A_END);
1461   a_ok(a);
1462 }
1463
1464 static void acmd_svcrelease(admin *a, unsigned ac, char *av[])
1465 {
1466   admin_service *svc;
1467
1468   if ((svc = a_svcfind(a, av[0])) == 0)
1469     return;
1470   if (svc->prov != a) {
1471     a_fail(a, "not-service-provider", "%s", SYM_NAME(svc), A_END);
1472     return;
1473   }
1474   a_svcrelease(svc);
1475   a_ok(a);
1476 }
1477
1478 static void acmd_svcensure(admin *a, unsigned ac, char *av[])
1479 {
1480   admin_service *svc;
1481
1482   if ((svc = a_svcfind(a, av[0])) == 0)
1483     return;
1484   if (av[1] && versioncmp(svc->version, av[1]) < 0) {
1485     a_fail(a, "service-too-old",
1486            "%s", SYM_NAME(svc),
1487            "%s", svc->version,
1488            A_END);
1489     return;
1490   }
1491   a_ok(a);
1492 }
1493
1494 static void acmd_svcquery(admin *a, unsigned ac, char *av[])
1495 {
1496   admin_service *svc;
1497
1498   if ((svc = a_svcfind(a, av[0])) != 0) {
1499     a_info(a, "name=%s", SYM_NAME(svc), "version=%s", svc->version, A_END);
1500     a_ok(a);
1501   }
1502 }
1503
1504 static void acmd_svclist(admin *a, unsigned ac, char *av[])
1505 {
1506   admin_service *svc;
1507   sym_iter i;
1508
1509   for (sym_mkiter(&i, &a_svcs); (svc = sym_next(&i)) != 0; )
1510     a_info(a, "%s", SYM_NAME(svc), "%s", svc->version, A_END);
1511   a_ok(a);
1512 }
1513
1514 static void a_canceljob(admin_bgop *bg)
1515 {
1516   admin_svcop *svc = (admin_svcop *)bg;
1517
1518   a_write(svc->prov, "SVCCANCEL", 0, "%s", a_jobidencode(svc), A_END);
1519   a_jobdestroy(svc);
1520 }
1521
1522 static void acmd_svcsubmit(admin *a, unsigned ac, char *av[])
1523 {
1524   const char *tag = 0;
1525   admin_service *svc;
1526   admin_svcop *svcop;
1527   const char *ver = 0;
1528   dstr d = DSTR_INIT;
1529
1530   OPTIONS(ac, av, {
1531     OPTARG("-background", arg, { tag = arg; })
1532     OPTARG("-version", arg, { ver = arg; })
1533   });
1534   if (!*av) goto bad_syntax;
1535   if ((svc = a_svcfind(a, *av)) == 0) goto fail;
1536   if (ver && versioncmp(svc->version, ver) < 0) {
1537     a_fail(a, "service-too-old",
1538            "%s", SYM_NAME(svc),
1539            "%s", svc->version,
1540            A_END);
1541     goto fail;
1542   }
1543   if ((svcop = a_jobcreate(svc->prov)) == 0) {
1544     a_fail(a, "provider-overloaded", A_END);
1545     goto fail;
1546   }
1547   if (a_bgadd(a, &svcop->bg, tag, a_canceljob)) {
1548     a_jobdestroy(svcop);
1549     goto fail;
1550   }
1551   a_write(svc->prov, "SVCJOB", 0,
1552           "%s", a_jobidencode(svcop),
1553           "?TOKENS", av,
1554           A_END);
1555   goto done;
1556
1557 bad_syntax:
1558   a_fail(a, "bad-syntax", "svcsubmit", "[OPTIONS] SERVICE ARGS...", A_END);
1559 fail:
1560 done:
1561   dstr_destroy(&d);
1562   return;
1563 }
1564
1565 static void a_replycmd(admin *a, const char *status, int donep, char *av[])
1566 {
1567   admin_svcop *svc;
1568
1569   if ((svc = a_jobiddecode(&a->j, av[0])) == 0) {
1570     a_fail(a, "unknown-jobid", av[0], A_END);
1571     return;
1572   }
1573   a_write(svc->bg.a, status, svc->bg.tag, "?TOKENS", av + 1, A_END);
1574   if (donep) {
1575     a_jobdestroy(svc);
1576     a_bgrelease(&svc->bg);
1577   }
1578   a_ok(a);
1579 }
1580
1581 static void acmd_svcok(admin *a, unsigned ac, char *av[])
1582   { a_replycmd(a, "OK", 1, av); }
1583 static void acmd_svcinfo(admin *a, unsigned ac, char *av[])
1584   { a_replycmd(a, "INFO", 0, av); }
1585 static void acmd_svcfail(admin *a, unsigned ac, char *av[])
1586   { a_replycmd(a, "FAIL", 1, av); }
1587
1588 /*----- Administration commands -------------------------------------------*/
1589
1590 /* --- Miscellaneous commands --- */
1591
1592 /* --- @traceish@ --- *
1593  *
1594  * Arguments:   @admin *a@ = connection to complain on
1595  *              @unsigned ac@ = number of arguments
1596  *              @char *av[]@ = vector of arguments
1597  *              @const char *what@ = what we're messing with
1598  *              @const trace_opt *tt@ = options table
1599  *              @unsigned *ff@ = where the flags are
1600  *
1601  * Returns:     Nonzero if anything changed.
1602  *
1603  * Use:         Guts of trace-ish commands like `trace' and `watch'.
1604  */
1605
1606 static int traceish(admin *a, unsigned ac, char *av[],
1607                     const char *what, const trace_opt *tt, unsigned *ff)
1608 {
1609   int ch = 0;
1610
1611   if (!ac || strcmp(av[0], "?") == 0) {
1612     const trace_opt *t;
1613     for (t = tt; t->ch; t++) {
1614       a_info(a, "*%c%c %s",
1615              t->ch, (*ff & t->f) == t->f ? '+' : ' ', t->help, A_END);
1616     }
1617   } else {
1618     unsigned sense = 1;
1619     unsigned f = *ff;
1620     const trace_opt *t;
1621     char *p = av[0];
1622
1623     while (*p) {
1624       switch (*p) {
1625         case '+': sense = 1; break;
1626         case '-': sense = 0; break;
1627         default:
1628           for (t = tt; t->ch; t++) {
1629             if (t->ch == *p) {
1630               if (sense) f |= t->f;
1631               else f &= ~t->f;
1632               goto tropt_ok;
1633             }
1634           }
1635           a_fail(a, "bad-%s-option", what, "%c", *p, A_END);
1636           return (0);
1637         tropt_ok:;
1638           break;
1639       }
1640       p++;
1641     }
1642     *ff = f;
1643     ch = 1;
1644   }
1645   a_ok(a);
1646   return (ch);
1647 }
1648
1649 #ifndef NTRACE
1650
1651 static void acmd_trace(admin *a, unsigned ac, char *av[])
1652 {
1653   if (traceish(a, ac, av, "trace", tr_opts, &tr_flags))
1654     trace_level(tr_flags);
1655 }
1656
1657 #endif
1658
1659 static void acmd_watch(admin *a, unsigned ac, char *av[])
1660   { traceish(a, ac, av, "watch", w_opts, &a->f); }
1661
1662 static void alertcmd(admin *a, unsigned f_and, unsigned f_eq,
1663                      const char *status, char *av[])
1664   { a_alert(f_and, f_eq, status, "USER", "?TOKENS", av, A_END); a_ok(a); }
1665 static void acmd_notify(admin *a, unsigned ac, char *av[])
1666   { alertcmd(a, AF_NOTE, AF_NOTE, "NOTE", av); }
1667 static void acmd_warn(admin *a, unsigned ac, char *av[])
1668   { alertcmd(a, AF_WARN, AF_WARN, "WARN", av); }
1669
1670 static void acmd_port(admin *a, unsigned ac, char *av[])
1671 {
1672   int i;
1673
1674   if (ac) {
1675     for (i = 0; i < NADDRFAM; i++)
1676       if (mystrieq(av[0], aftab[i].name)) goto found;
1677     a_fail(a, "unknown-address-family", "%s", av[0], A_END);
1678     return;
1679   found:
1680     assert(udpsock[i].fd >= 0);
1681   } else {
1682     for (i = 0; i < NADDRFAM; i++)
1683       if (udpsock[i].fd >= 0) goto found;
1684     abort();
1685   }
1686   a_info(a, "%u", p_port(i), A_END);
1687   a_ok(a);
1688 }
1689
1690 static void acmd_daemon(admin *a, unsigned ac, char *av[])
1691 {
1692   if (flags & F_DAEMON)
1693     a_fail(a, "already-daemon", A_END);
1694   else {
1695     a_notify("DAEMON", A_END);
1696     if (a_stdin)
1697       a_destroy(a_stdin);
1698     if (daemonize())
1699       a_fail(a, "daemon-error", "?ERRNO", A_END);
1700     else {
1701       flags |= F_DAEMON;
1702       a_ok(a);
1703     }
1704   }
1705 }
1706
1707 static void acmd_jobs(admin *a, unsigned ac, char *av[])
1708 {
1709   admin_bgop *bg;
1710
1711   for (bg = a->bg; bg; bg = bg->next) {
1712     assert(bg->tag);
1713     a_info(a, "%s", bg->tag, A_END);
1714   }
1715   a_ok(a);
1716 }
1717
1718 static void acmd_bgcancel(admin *a, unsigned ac, char *av[])
1719 {
1720   admin_bgop *bg;
1721
1722   if ((bg = a_bgfind(a, av[0])) == 0)
1723     a_fail(a, "unknown-tag", "%s", av[0], A_END);
1724   else {
1725     bg->cancel(bg);
1726     a_bgrelease(bg);
1727     a_ok(a);
1728   }
1729 }
1730
1731 static void acmd_algs(admin *a, unsigned ac, char *av[])
1732 {
1733   peer *p;
1734   const kdata *kd;
1735   const dhgrp *g;
1736   const algswitch *algs;
1737
1738   if (!ac)
1739     kd = master;
1740   else {
1741     if ((p = a_findpeer(a, av[0])) == 0) return;
1742     kd = p->kx.kpriv;
1743   }
1744   g = kd->grp;
1745   algs = &kd->algs;
1746
1747   g->ops->grpinfo(g, a);
1748   a_info(a,
1749          "hash=%s", algs->h->name,
1750          "mgf=%s", algs->mgf->name,
1751          "hash-sz=%lu", (unsigned long)algs->h->hashsz,
1752          A_END);
1753   a_info(a,
1754          "bulk-transform=%s", algs->bulk->ops->name,
1755          "bulk-overhead=%lu",
1756          (unsigned long)algs->bulk->ops->overhead(algs->bulk),
1757          A_END);
1758   algs->bulk->ops->alginfo(algs->bulk, a);
1759   a_info(a,
1760          "cipher-data-limit=%lu",
1761          (unsigned long)algs->bulk->ops->expsz(algs->bulk),
1762          A_END);
1763   a_ok(a);
1764 }
1765
1766 static void acmd_list(admin *a, unsigned ac, char *av[])
1767 {
1768   FOREACH_PEER(p, {  a_info(a, "%s", p_name(p), A_END); });
1769   a_ok(a);
1770 }
1771
1772 static void acmd_ifname(admin *a, unsigned ac, char *av[])
1773 {
1774   peer *p;
1775
1776   if ((p = a_findpeer(a, av[0])) != 0) {
1777     a_info(a, "%s", p_ifname(p), A_END);
1778     a_ok(a);
1779   }
1780 }
1781
1782 static void acmd_setifname(admin *a, unsigned ac, char *av[])
1783 {
1784   peer *p;
1785
1786   if ((p = a_findpeer(a, av[0])) != 0) {
1787     a_notify("NEWIFNAME", "?PEER", p, "%s", p_ifname(p), "%s", av[1], A_END);
1788     p_setifname(p, av[1]);
1789     a_ok(a);
1790   }
1791 }
1792
1793 static void acmd_getchal(admin *a, unsigned ac, char *av[])
1794 {
1795   buf b;
1796
1797   buf_init(&b, buf_i, PKBUFSZ);
1798   c_new(&b);
1799   a_info(a, "?B64", BBASE(&b), (size_t)BLEN(&b), A_END);
1800   a_ok(a);
1801 }
1802
1803 static void acmd_checkchal(admin *a, unsigned ac, char *av[])
1804 {
1805   codec *b64 = base64_class.decoder(CDCF_NOEQPAD);
1806   int err;
1807   buf b;
1808   dstr d = DSTR_INIT;
1809
1810   if ((err = b64->ops->code(b64, av[0], strlen(av[0]), &d)) != 0 ||
1811       (err = b64->ops->code(b64, 0, 0, &d)) != 0)
1812     a_fail(a, "bad-base64", "%s", codec_strerror(err), A_END);
1813   else {
1814     buf_init(&b, d.buf, d.len);
1815     if (c_check(&b) || BBAD(&b) || BLEFT(&b))
1816       a_fail(a, "invalid-challenge", A_END);
1817     else
1818       a_ok(a);
1819   }
1820   b64->ops->destroy(b64);
1821   dstr_destroy(&d);
1822 }
1823
1824 static void acmd_greet(admin *a, unsigned ac, char *av[])
1825 {
1826   peer *p;
1827   int err;
1828   codec *b64;
1829   dstr d = DSTR_INIT;
1830
1831   if ((p = a_findpeer(a, av[0])) == 0) return;
1832   b64 = base64_class.decoder(CDCF_NOEQPAD);
1833   if ((err = b64->ops->code(b64, av[1], strlen(av[1]), &d)) != 0 ||
1834       (err = b64->ops->code(b64, 0, 0, &d)) != 0)
1835     a_fail(a, "bad-base64", "%s", codec_strerror(err), A_END);
1836   else {
1837     p_greet(p, d.buf, d.len);
1838     a_ok(a);
1839   }
1840   b64->ops->destroy(b64);
1841   dstr_destroy(&d);
1842 }
1843
1844 static void acmd_addr(admin *a, unsigned ac, char *av[])
1845 {
1846   peer *p;
1847   const addr *ad;
1848
1849   if ((p = a_findpeer(a, av[0])) != 0) {
1850     ad = p_addr(p);
1851     assert(ad->sa.sa_family == AF_INET);
1852     a_info(a, "?ADDR", ad, A_END);
1853     a_ok(a);
1854   }
1855 }
1856
1857 static void acmd_peerinfo(admin *a, unsigned ac, char *av[])
1858 {
1859   peer *p;
1860   const peerspec *ps;
1861   const char *ptag;
1862
1863   if ((p = a_findpeer(a, av[0])) != 0) {
1864     ps = p_spec(p);
1865     a_info(a, "tunnel=%s", ps->tops->name, A_END);
1866     a_info(a, "key=%s", p_tag(p),
1867            "current-key=%s", p->kx.kpub->tag, A_END);
1868     if ((ptag = p_privtag(p)) == 0) ptag = "(default)";
1869     a_info(a, "private-key=%s", ptag,
1870            "current-private-key=%s", p->kx.kpriv->tag, A_END);
1871     a_info(a, "keepalive=%lu", ps->t_ka, A_END);
1872     a_info(a, "corked=%s", BOOL(p->kx.f&KXF_CORK),
1873            "mobile=%s", BOOL(ps->f&PSF_MOBILE),
1874            A_END);
1875     a_ok(a);
1876   }
1877 }
1878
1879 static void acmd_servinfo(admin *a, unsigned ac, char *av[])
1880 {
1881   a_info(a, "implementation=edgeware-tripe", A_END);
1882   a_info(a, "version=%s", VERSION, A_END);
1883   a_info(a, "daemon=%s", BOOL(flags & F_DAEMON), A_END);
1884   a_ok(a);
1885 }
1886
1887 static void acmd_stats(admin *a, unsigned ac, char *av[])
1888 {
1889   peer *p;
1890   stats *st;
1891
1892   if ((p = a_findpeer(a, av[0])) == 0)
1893     return;
1894
1895   st = p_stats(p);
1896   a_info(a, "start-time=%s", timestr(st->t_start), A_END);
1897   a_info(a, "last-packet-time=%s", timestr(st->t_last), A_END);
1898   a_info(a, "last-keyexch-time=%s", timestr(st->t_kx), A_END);
1899   a_info(a, "packets-in=%lu", st->n_in, "bytes-in=%lu", st->sz_in, A_END);
1900   a_info(a,
1901          "packets-out=%lu", st->n_out,
1902          "bytes-out=%lu", st->sz_out,
1903          A_END);
1904   a_info(a,
1905          "keyexch-packets-in=%lu", st->n_kxin,
1906          "keyexch-bytes-in=%lu", st->sz_kxin,
1907          A_END);
1908   a_info(a,
1909          "keyexch-packets-out=%lu", st->n_kxout,
1910          "keyexch-bytes-out=%lu", st->sz_kxout,
1911          A_END);
1912   a_info(a,
1913          "ip-packets-in=%lu", st->n_ipin,
1914          "ip-bytes-in=%lu", st->sz_ipin,
1915          A_END);
1916   a_info(a,
1917          "ip-packets-out=%lu", st->n_ipout,
1918          "ip-bytes-out=%lu", st->sz_ipout,
1919          A_END);
1920   a_info(a, "rejected-packets=%lu", st->n_reject, A_END);
1921   a_ok(a);
1922 }
1923
1924 static void acmd_kill(admin *a, unsigned ac, char *av[])
1925 {
1926   peer *p;
1927
1928   if ((p = a_findpeer(a, av[0])) != 0) {
1929     p_destroy(p);
1930     a_ok(a);
1931   }
1932 }
1933
1934 static void acmd_forcekx(admin *a, unsigned ac, char *av[])
1935 {
1936   peer *p;
1937
1938   if ((p = a_findpeer(a, av[0])) != 0) {
1939     kx_start(&p->kx, 1);
1940     a_ok(a);
1941   }
1942 }
1943
1944 static void acmd_reload(admin *a, unsigned ac, char *av[])
1945   { p_keyreload(); a_ok(a); }
1946
1947 static void acmd_quit(admin *a, unsigned ac, char *av[])
1948 {
1949   a_warn("SERVER", "quit", "admin-request", A_END);
1950   a_ok(a);
1951   a_quit();
1952 }
1953
1954 static void acmd_version(admin *a, unsigned ac, char *av[])
1955 {
1956   a_info(a, "%s", PACKAGE, "%s", VERSION, A_END);
1957   a_ok(a);
1958 }
1959
1960 static void acmd_tunnels(admin *a, unsigned ac, char *av[])
1961 {
1962   int i;
1963
1964   for (i = 0; tunnels[i]; i++)
1965     a_info(a, "%s", tunnels[i]->name, A_END);
1966   a_ok(a);
1967 }
1968
1969 /* --- The command table and help --- */
1970
1971 typedef struct acmd {
1972   const char *name;
1973   const char *help;
1974   unsigned argmin, argmax;
1975   void (*func)(admin */*a*/, unsigned /*ac*/, char */*av*/[]);
1976 } acmd;
1977
1978 static void acmd_help(admin */*a*/, unsigned /*ac*/, char */*av*/[]);
1979
1980 static const acmd acmdtab[] = {
1981   { "add",      "[OPTIONS] PEER ADDR ...", 2,   0xffff, acmd_add },
1982   { "addr",     "PEER",                 1,      1,      acmd_addr },
1983   { "algs",     "[PEER]",               0,      1,      acmd_algs },
1984   { "bgcancel", "TAG",                  1,      1,      acmd_bgcancel },
1985   { "checkchal", "CHAL",                1,      1,      acmd_checkchal },
1986   { "daemon",   0,                      0,      0,      acmd_daemon },
1987   { "eping",    "[OPTIONS] PEER",       1,      0xffff, acmd_eping },
1988   { "forcekx",  "PEER",                 1,      1,      acmd_forcekx },
1989   { "getchal",  0,                      0,      0,      acmd_getchal },
1990   { "greet",    "PEER CHAL",            2,      2,      acmd_greet },
1991   { "help",     0,                      0,      0,      acmd_help },
1992   { "ifname",   "PEER",                 1,      1,      acmd_ifname },
1993   { "jobs",     0,                      0,      0,      acmd_jobs },
1994   { "kill",     "PEER",                 1,      1,      acmd_kill },
1995   { "list",     0,                      0,      0,      acmd_list },
1996   { "notify",   "MESSAGE ...",          1,      0xffff, acmd_notify },
1997   { "peerinfo", "PEER",                 1,      1,      acmd_peerinfo },
1998   { "ping",     "[OPTIONS] PEER",       1,      0xffff, acmd_ping },
1999   { "port",     "[FAMILY]",             0,      1,      acmd_port },
2000   { "quit",     0,                      0,      0,      acmd_quit },
2001   { "reload",   0,                      0,      0,      acmd_reload },
2002   { "servinfo", 0,                      0,      0,      acmd_servinfo },
2003   { "setifname", "PEER NEW-NAME",       2,      2,      acmd_setifname },
2004   { "stats",    "PEER",                 1,      1,      acmd_stats },
2005   { "svcclaim", "SERVICE VERSION",      2,      2,      acmd_svcclaim },
2006   { "svcensure", "SERVICE [VERSION]",   1,      2,      acmd_svcensure },
2007   { "svcfail",  "JOBID TOKENS...",      1,      0xffff, acmd_svcfail },
2008   { "svcinfo",  "JOBID TOKENS...",      1,      0xffff, acmd_svcinfo },
2009   { "svclist",  0,                      0,      0,      acmd_svclist },
2010   { "svcok",    "JOBID",                1,      1,      acmd_svcok },
2011   { "svcquery", "SERVICE",              1,      1,      acmd_svcquery },
2012   { "svcrelease", "SERVICE",            1,      1,      acmd_svcrelease },
2013   { "svcsubmit", "[OPTIONS] SERVICE TOKENS...",
2014                                         2,      0xffff, acmd_svcsubmit },
2015 #ifndef NTRACE
2016   { "trace",    "[OPTIONS]",            0,      1,      acmd_trace },
2017 #endif
2018   { "tunnels",  0,                      0,      0,      acmd_tunnels },
2019   { "version",  0,                      0,      0,      acmd_version },
2020   { "warn",     "MESSAGE ...",          1,      0xffff, acmd_warn },
2021   { "watch",    "[OPTIONS]",            0,      1,      acmd_watch },
2022   { 0,          0,                      0,      0,      0 }
2023 };
2024
2025 static void acmd_help(admin *a, unsigned ac, char *av[])
2026 {
2027   const acmd *c;
2028
2029   for (c = acmdtab; c->name; c++) {
2030     if (c->help)
2031       a_info(a, "%s", c->name, "*%s", c->help, A_END);
2032     else
2033       a_info(a, "%s", c->name, A_END);
2034   }
2035   a_ok(a);
2036 }
2037
2038 /*----- Connection handling -----------------------------------------------*/
2039
2040 /* --- @a_destroypending@ --- *
2041  *
2042  * Arguments:   ---
2043  *
2044  * Returns:     ---
2045  *
2046  * Use:         Destroys pending admin connections at a safe time.
2047  */
2048
2049 static void a_destroypending(void)
2050 {
2051   admin *a, *aa, *head;
2052   admin_bgop *bg, *bbg;
2053   admin_service *svc, *ssvc;
2054
2055   /* --- Destroy connections marked as pending --- *
2056    *
2057    * Slightly messy.  Killing clients may cause others to finally die.  Make
2058    * sure that they can be put on the list without clobbering anything or
2059    * getting lost.
2060    */
2061
2062   while (a_dead) {
2063     head = a_dead;
2064     a_dead = 0;
2065     for (a = head; a; a = aa) {
2066       aa = a->next;
2067       assert(a->f & AF_DEAD);
2068
2069       /* --- Report what we're doing --- */
2070
2071       T( trace(T_ADMIN, "admin: completing destruction of connection %u",
2072                a->seq); )
2073
2074       /* --- If this is the foreground client then shut down --- */
2075
2076       if (a->f & AF_FOREGROUND) {
2077         T( trace(T_ADMIN, "admin: foreground client quit: shutting down"); )
2078         a_warn("SERVER", "quit", "foreground-eof", A_END);
2079         a_quit();
2080       }
2081
2082       /* --- Abort any background jobs in progress --- */
2083
2084       for (bg = a->bg; bg; bg = bbg) {
2085         bbg = bg->next;
2086         bg->cancel(bg);
2087         if (bg->tag) xfree(bg->tag);
2088         xfree(bg);
2089       }
2090
2091       /* --- Release services I hold, and abort pending jobs --- */
2092
2093       for (svc = a->svcs; svc; svc = ssvc) {
2094         ssvc = svc->next;
2095         a_svcrelease(svc);
2096       }
2097       a_jobtablefinal(&a->j);
2098
2099       /* --- Close file descriptors and selectory --- */
2100
2101       selbuf_destroy(&a->b);
2102       if (a->b.reader.fd != a->w.fd) close(a->b.reader.fd);
2103       close(a->w.fd);
2104       if (a_stdin == a) a_stdin = 0;
2105
2106       /* --- Done --- */
2107
2108       DESTROY(a);
2109     }
2110   }
2111 }
2112
2113 /* --- @a_destroy@ --- *
2114  *
2115  * Arguments:   @admin *a@ = pointer to an admin block
2116  *
2117  * Returns:     ---
2118  *
2119  * Use:         Destroys an admin block.  This requires a certain amount of
2120  *              care.
2121  */
2122
2123 static void freequeue(oqueue *q)
2124 {
2125   obuf *o, *oo;
2126
2127   for (o = q->hd; o; o = oo) {
2128     oo = o->next;
2129     xfree(o);
2130   }
2131   q->hd = q->tl = 0;
2132 }
2133
2134 static void a_destroy(admin *a)
2135 {
2136   if (a->f & AF_DEAD)
2137     return;
2138
2139   if (a->next) a->next->prev = a->prev;
2140   if (a->prev) a->prev->next = a->next;
2141   else admins = a->next;
2142
2143   if (a->out.hd) sel_rmfile(&a->w);
2144   freequeue(&a->out);
2145
2146   a->f |= AF_DEAD;
2147   a->next = a_dead;
2148   a_dead = a;
2149
2150   T( trace(T_ADMIN, "admin: killing connection %u", a->seq); )
2151 }
2152
2153 /* --- @a_line@ --- *
2154  *
2155  * Arguments:   @char *p@ = pointer to the line read
2156  *              @size_t len@ = length of the line
2157  *              @void *vp@ = pointer to my admin block
2158  *
2159  * Returns:     ---
2160  *
2161  * Use:         Handles a line of input.
2162  */
2163
2164 static void a_line(char *p, size_t len, void *vp)
2165 {
2166   admin *a = vp;
2167   const acmd *c;
2168   char *av[16 + 1];
2169   size_t ac;
2170
2171   QUICKRAND;
2172   if (a->f & AF_DEAD)
2173     return;
2174   if (!p) {
2175     if (!a->bg)
2176       a_destroy(a);
2177     else {
2178       a->f |= AF_CLOSE;
2179       selbuf_disable(&a->b);
2180     }
2181     return;
2182   }
2183   ac = str_qsplit(p, av, N(av) - 1, 0, STRF_QUOTE);
2184   if (!ac)
2185     return;
2186   av[ac] = 0;
2187   for (c = acmdtab; c->name; c++) {
2188     if (mystrieq(av[0], c->name)) {
2189       ac--;
2190       if (c->argmin > ac || ac > c->argmax) {
2191         if (!c->help)
2192           a_fail(a, "bad-syntax", "%s", c->name, "", A_END);
2193         else
2194           a_fail(a, "bad-syntax", "%s", c->name, "%s", c->help, A_END);
2195       } else
2196         c->func(a, ac, av + 1);
2197       return;
2198     }
2199   }
2200   a_fail(a, "unknown-command", "%s", av[0], A_END);
2201 }
2202
2203 /* --- @a_create@ --- *
2204  *
2205  * Arguments:   @int fd_in, fd_out@ = file descriptors to use
2206  *              @unsigned f@ = initial flags to set
2207  *
2208  * Returns:     ---
2209  *
2210  * Use:         Creates a new admin connection.
2211  */
2212
2213 void a_create(int fd_in, int fd_out, unsigned f)
2214 {
2215   admin *a = CREATE(admin);
2216
2217   T( static unsigned seq = 0;
2218      a->seq = seq++; )
2219   T( trace(T_ADMIN, "admin: accepted connection %u", a->seq); )
2220   a->bg = 0;
2221   a->ref = 0;
2222   a->svcs = 0;
2223   a_jobtableinit(&a->j);
2224   a->f = f;
2225   if (fd_in == STDIN_FILENO) a_stdin = a;
2226   fdflags(fd_in, O_NONBLOCK, O_NONBLOCK, FD_CLOEXEC, FD_CLOEXEC);
2227   if (fd_out != fd_in)
2228     fdflags(fd_out, O_NONBLOCK, O_NONBLOCK, FD_CLOEXEC, FD_CLOEXEC);
2229   selbuf_init(&a->b, &sel, fd_in, a_line, a);
2230   sel_initfile(&sel, &a->w, fd_out, SEL_WRITE, a_flush, a);
2231   a->out.hd = a->out.tl = 0;
2232   a->next = admins;
2233   a->prev = 0;
2234   if (admins) admins->prev = a;
2235   admins = a;
2236 }
2237
2238 /* --- @a_accept@ --- *
2239  *
2240  * Arguments:   @int fd@ = file descriptor to accept
2241  *              @unsigned mode@ = what to do
2242  *              @void *v@ = uninteresting pointer
2243  *
2244  * Returns:     ---
2245  *
2246  * Use:         Accepts a new admin connection.
2247  */
2248
2249 static void a_accept(int fd, unsigned mode, void *v)
2250 {
2251   int nfd;
2252   struct sockaddr_un sun;
2253   socklen_t sz = sizeof(sun);
2254
2255   if ((nfd = accept(fd, (struct sockaddr *)&sun, &sz)) < 0) {
2256     if (errno != EINTR && errno != EAGAIN && errno != EWOULDBLOCK &&
2257         errno != ECONNABORTED && errno != EPROTO)
2258       a_warn("ADMIN", "accept-error", "?ERRNO", A_END);
2259     return;
2260   }
2261   a_create(nfd, nfd, 0);
2262 }
2263
2264 /* --- @a_preselect@ --- *
2265  *
2266  * Arguments:   ---
2267  *
2268  * Returns:     ---
2269  *
2270  * Use:         Informs the admin module that we're about to select again,
2271  *              and that it should do cleanup things it has delayed until a
2272  *              `safe' time.
2273  */
2274
2275 void a_preselect(void) { if (a_dead) a_destroypending(); }
2276
2277 /* --- @a_daemon@ --- *
2278  *
2279  * Arguments:   ---
2280  *
2281  * Returns:     ---
2282  *
2283  * Use:         Informs the admin module that it's a daemon.
2284  */
2285
2286 void a_daemon(void) { flags |= F_DAEMON; }
2287
2288 /* --- @a_init@ --- *
2289  *
2290  * Arguments:   @const char *name@ = socket name to create
2291  *              @uid_t u@ = user to own the socket
2292  *              @gid_t g@ = group to own the socket
2293  *              @mode_t m@ = permissions to set on the socket
2294  *
2295  * Returns:     ---
2296  *
2297  * Use:         Creates the admin listening socket.
2298  */
2299
2300 void a_init(const char *name, uid_t u, gid_t g, mode_t m)
2301 {
2302   int fd;
2303   int n = 5;
2304   struct sockaddr_un sun;
2305   struct sigaction sa;
2306   size_t sz;
2307   mode_t omask;
2308
2309   /* --- Create services table --- */
2310
2311   sym_create(&a_svcs);
2312
2313   /* --- Set up the socket address --- */
2314
2315   sz = strlen(name) + 1;
2316   if (sz > sizeof(sun.sun_path))
2317     die(EXIT_FAILURE, "socket name `%s' too long", name);
2318   BURN(sun);
2319   sun.sun_family = AF_UNIX;
2320   memcpy(sun.sun_path, name, sz);
2321   sz += offsetof(struct sockaddr_un, sun_path);
2322
2323   /* --- Attempt to bind to the socket --- */
2324
2325   omask = umask(0077);
2326 again:
2327   if ((fd = socket(PF_UNIX, SOCK_STREAM, 0)) < 0)
2328     die(EXIT_FAILURE, "couldn't create socket: %s", strerror(errno));
2329   if (bind(fd, (struct sockaddr *)&sun, sz) < 0) {
2330     struct stat st;
2331     int e = errno;
2332     if (errno != EADDRINUSE) {
2333       die(EXIT_FAILURE, "couldn't bind to address `%s': %s",
2334           sun.sun_path, strerror(e));
2335     }
2336     if (!n)
2337       die(EXIT_FAILURE, "too many retries; giving up");
2338     n--;
2339     if (!connect(fd, (struct sockaddr *)&sun, sz)) {
2340       die(EXIT_FAILURE, "server already listening on admin socket `%s'",
2341           sun.sun_path);
2342     }
2343     if (errno != ECONNREFUSED)
2344       die(EXIT_FAILURE, "couldn't bind to address: %s", strerror(e));
2345     if (stat(sun.sun_path, &st)) {
2346       die(EXIT_FAILURE, "couldn't stat `%s': %s",
2347           sun.sun_path, strerror(errno));
2348     }
2349     if (!S_ISSOCK(st.st_mode))
2350       die(EXIT_FAILURE, "object `%s' isn't a socket", sun.sun_path);
2351     T( trace(T_ADMIN, "admin: stale socket found; removing it"); )
2352     unlink(sun.sun_path);
2353     close(fd);
2354     goto again;
2355   }
2356   if (chown(sun.sun_path, u, g)) {
2357     die(EXIT_FAILURE, "failed to set socket owner: %s",
2358         strerror(errno));
2359   }
2360   if (chmod(sun.sun_path, m)) {
2361     die(EXIT_FAILURE, "failed to set socket permissions: %s",
2362         strerror(errno));
2363   }
2364   umask(omask);
2365   fdflags(fd, O_NONBLOCK, O_NONBLOCK, FD_CLOEXEC, FD_CLOEXEC);
2366   if (listen(fd, 5))
2367     die(EXIT_FAILURE, "couldn't listen on socket: %s", strerror(errno));
2368
2369   /* --- Listen to the socket --- */
2370
2371   sel_initfile(&sel, &sock, fd, SEL_READ, a_accept, 0);
2372   sel_addfile(&sock);
2373   sockname = name;
2374   bres_init(&sel);
2375   T( trace_custom(a_trace, 0);
2376      trace(T_ADMIN, "admin: enabled custom tracing"); )
2377   flags |= F_INIT;
2378
2379   /* --- Set up signal handlers --- */
2380
2381   sig_add(&s_term, SIGTERM, a_sigdie, 0);
2382   sig_add(&s_hup, SIGHUP, a_sighup, 0);
2383   sigaction(SIGINT, 0, &sa);
2384   if (sa.sa_handler != SIG_IGN)
2385     sig_add(&s_int, SIGINT, a_sigdie, 0);
2386 }
2387
2388 /*----- That's all, folks -------------------------------------------------*/