Add notion of `ephemeral' associations and a goodbye protocol.
[tripe] / server / admin.c
CommitLineData
410c8acf 1/* -*-c-*-
2 *
410c8acf 3 * Admin interface for configuration
4 *
5 * (c) 2001 Straylight/Edgeware
6 */
7
e04c2d50 8/*----- Licensing notice --------------------------------------------------*
410c8acf 9 *
10 * This file is part of Trivial IP Encryption (TrIPE).
11 *
11ad66c2
MW
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.
e04c2d50 16 *
11ad66c2
MW
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.
e04c2d50 21 *
410c8acf 22 * You should have received a copy of the GNU General Public License
11ad66c2 23 * along with TrIPE. If not, see <https://www.gnu.org/licenses/>.
410c8acf 24 */
25
410c8acf 26/*----- Header files ------------------------------------------------------*/
27
28#include "tripe.h"
29
30/*----- Global variables --------------------------------------------------*/
31
32#ifndef NTRACE
33
34const trace_opt tr_opts[] = {
35 { 't', T_TUNNEL, "tunnel events" },
36 { 'r', T_PEER, "peer events" },
37 { 'a', T_ADMIN, "admin interface" },
410c8acf 38 { 's', T_KEYSET, "symmetric keyset management" },
39 { 'x', T_KEYEXCH, "key exchange" },
40 { 'm', T_KEYMGMT, "key management" },
37941236 41 { 'l', T_CHAL, "challenge management" },
388e0319 42 { 'v', T_PRIVSEP, "privilege separation" },
37941236 43 { 'p', T_PACKET, "packet contents" },
44 { 'c', T_CRYPTO, "crypto details" },
410c8acf 45 { 'A', T_ALL, "all of the above" },
46 { 0, 0, 0 }
47};
48
49unsigned tr_flags = 0;
50#endif
51
3cdc3f3a 52static const trace_opt w_opts[] = {
8ed35e02 53#ifndef NTRACE
3cdc3f3a 54 { 't', AF_TRACE, "trace messages" },
8ed35e02 55#endif
3cdc3f3a 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
410c8acf 62/*----- Static variables --------------------------------------------------*/
63
64static admin *admins;
c511e1f9 65static admin *a_dead;
410c8acf 66static sel_file sock;
67static const char *sockname;
be6a1b7a 68static sym_table a_svcs;
410c8acf 69static unsigned flags = 0;
70static admin *a_stdin = 0;
71static sig s_term, s_int, s_hup;
72
73#define F_DAEMON 1u
74#define F_INIT 2u
46dde080 75#define F_FOREGROUND 4u
410c8acf 76
77#define T_RESOLVE SEC(30)
0ba8de86 78#define T_PING SEC(5)
410c8acf 79
fd3cf232 80static void a_destroy(admin */*a*/);
fd3cf232 81
060ca767 82#define BOOL(x) ((x) ? "t" : "nil")
83
fd3cf232 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
97static ssize_t trywrite(admin *a, const char *p, size_t sz)
98{
99 ssize_t n, done = 0;
100
101again:
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);
f43df819 116 a_warn("ADMIN", "client-write-error", "?ERRNO", A_END);
fd3cf232 117 return (-1);
118 }
119 }
120 return (done);
121}
122
de014da6 123/* --- @doqueue@ -- *
fd3cf232 124 *
de014da6 125 * Arguments: @oqueue *q@ = pointer to output queue
fd3cf232 126 * @const char *p@ = pointer to buffer to write
de014da6 127 * @size_t sz@ = size of buffer
fd3cf232 128 *
de014da6 129 * Returns: Nonzero if the queue was previously empty.
fd3cf232 130 *
de014da6 131 * Use: Queues data to be written later.
fd3cf232 132 */
133
de014da6 134static int doqueue(oqueue *q, const char *p, size_t sz)
fd3cf232 135{
fd3cf232 136 obuf *o;
de014da6 137 int rc = 0;
138 size_t n;
fd3cf232 139
de014da6 140 o = q->tl;
fd3cf232 141 if (!o)
de014da6 142 rc = 1;
fd3cf232 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;
de014da6 150 if (q->tl)
151 q->tl->next = o;
fd3cf232 152 else
de014da6 153 q->hd = o;
154 q->tl = o;
fd3cf232 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);
de014da6 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
180static 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);
fd3cf232 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
209static void a_flush(int fd, unsigned mode, void *v)
210{
211 admin *a = v;
212 obuf *o, *oo;
213 ssize_t n;
214
de014da6 215 o = a->out.hd;
fd3cf232 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 }
de014da6 226 a->out.hd = o;
fd3cf232 227 if (!o) {
de014da6 228 a->out.tl = 0;
fd3cf232 229 sel_rmfile(&a->w);
230 }
231}
232
410c8acf 233/*----- Utility functions -------------------------------------------------*/
234
f43df819
MW
235/* --- @a_vformat@ --- *
236 *
237 * Arguments: @dstr *d@ = where to leave the formatted message
238 * @const char *fmt@ = pointer to format string
b730d38c 239 * @va_list *ap@ = arguments in list
f43df819
MW
240 *
241 * Returns: ---
242 *
7f73baaf
MW
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
f43df819
MW
262 */
263
b730d38c 264void a_vformat(dstr *d, const char *fmt, va_list *ap)
f43df819
MW
265{
266 dstr dd = DSTR_INIT;
267
268 while (fmt) {
269 if (*fmt == '*') {
6ebbf072 270 if (d->len) dstr_putc(d, ' ');
b730d38c 271 dstr_vputf(d, fmt + 1, ap);
f43df819
MW
272 } else if (*fmt == '?') {
273 if (strcmp(fmt, "?ADDR") == 0) {
844abf94 274 const addr *a = va_arg(*ap, const addr *);
f43df819
MW
275 switch (a->sa.sa_family) {
276 case AF_INET:
0ed0735f
MW
277 u_quotify(d, "INET");
278 u_quotify(d, inet_ntoa(a->sin.sin_addr));
f43df819
MW
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) {
844abf94
MW
285 const octet *p = va_arg(*ap, const octet *);
286 size_t n = va_arg(*ap, size_t);
37d4c59e 287 codec *b64 = base64_class.encoder(CDCF_NOEQPAD, "", 0);
f43df819 288 dstr_putc(d, ' ');
37d4c59e
MW
289 b64->ops->code(b64, p, n, d);
290 b64->ops->code(b64, 0, 0, d);
291 b64->ops->destroy(b64);
3331936b 292 } else if (strcmp(fmt, "?TOKENS") == 0) {
844abf94 293 const char *const *av = va_arg(*ap, const char *const *);
0ed0735f 294 while (*av) u_quotify(d, *av++);
f43df819 295 } else if (strcmp(fmt, "?PEER") == 0)
844abf94 296 u_quotify(d, p_name(va_arg(*ap, peer *)));
f43df819
MW
297 else if (strcmp(fmt, "?ERRNO") == 0) {
298 dstr_putf(d, " E%d", errno);
0ed0735f 299 u_quotify(d, strerror(errno));
f43df819
MW
300 } else
301 abort();
302 } else {
303 if (*fmt == '!') fmt++;
304 DRESET(&dd);
b730d38c 305 dstr_vputf(&dd, fmt, ap);
0ed0735f 306 u_quotify(d, dd.buf);
f43df819 307 }
844abf94 308 fmt = va_arg(*ap, const char *);
f43df819 309 }
918a33b7 310 dstr_putz(d);
f43df819
MW
311
312 dstr_destroy(&dd);
313}
314
f241e36c
MW
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
326void a_format(dstr *d, const char *fmt, ...)
327{
328 va_list ap;
329
330 va_start(ap, fmt);
b730d38c 331 a_vformat(d, fmt, &ap);
f241e36c
MW
332 va_end(ap);
333}
334
3cdc3f3a 335/* --- @a_write@, @a_vwrite@ --- *
410c8acf 336 *
337 * Arguments: @admin *a@ = admin connection to write to
de014da6 338 * @const char *status@ = status code to report
339 * @const char *tag@ = tag string, or null
410c8acf 340 * @const char *fmt@ = pointer to format string
844abf94 341 * @va_list *ap@ = arguments in list
410c8acf 342 * @...@ = other arguments
343 *
344 * Returns: ---
345 *
346 * Use: Sends a message to an admin connection.
347 */
348
de014da6 349static void a_vwrite(admin *a, const char *status, const char *tag,
b730d38c 350 const char *fmt, va_list *ap)
410c8acf 351{
410c8acf 352 dstr d = DSTR_INIT;
f98df549 353
de014da6 354 if (tag) dstr_puts(&d, "BG");
355 dstr_puts(&d, status);
0ed0735f 356 if (tag) u_quotify(&d, tag);
f43df819 357 a_vformat(&d, fmt, ap);
3cdc3f3a 358 dstr_putc(&d, '\n');
359 dosend(a, d.buf, d.len);
360 dstr_destroy(&d);
361}
362
de014da6 363static void a_write(admin *a, const char *status, const char *tag,
364 const char *fmt, ...)
3cdc3f3a 365{
366 va_list ap;
f98df549 367
410c8acf 368 va_start(ap, fmt);
b730d38c 369 a_vwrite(a, status, tag, fmt, &ap);
410c8acf 370 va_end(ap);
3cdc3f3a 371}
372
fe182f61 373/* --- @a_ok@, @a_fail@ --- *
3cdc3f3a 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
f43df819 384static void a_ok(admin *a) { a_write(a, "OK", 0, A_END); }
3cdc3f3a 385
fe182f61 386static void a_fail(admin *a, const char *fmt, ...)
3cdc3f3a 387{
388 va_list ap;
f98df549 389
3cdc3f3a 390 va_start(ap, fmt);
fe182f61 391 a_vwrite(a, "FAIL", 0, fmt, &ap);
3cdc3f3a 392 va_end(ap);
393}
394
fe182f61
MW
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
406void a_info(admin *a, const char *fmt, ...)
3cdc3f3a 407{
408 va_list ap;
f98df549 409
3cdc3f3a 410 va_start(ap, fmt);
fe182f61 411 a_vwrite(a, "INFO", 0, fmt, &ap);
3cdc3f3a 412 va_end(ap);
413}
414
415/* --- @a_alert@, @a_valert@, @a_rawalert@ --- *
416 *
417 * Arguments: @unsigned f_and, f_eq@ = filter for connections
de014da6 418 * @const char *status@ = status string
3cdc3f3a 419 * @const char *fmt@ = pointer to format string
de014da6 420 * @const char *p@ = pointer to raw string
3cdc3f3a 421 * @size_t sz@ = size of raw string
844abf94 422 * @va_list *ap@ = arguments in list
3cdc3f3a 423 * @...@ = other arguments
424 *
425 * Returns: ---
426 *
427 * Use: Write a message to all admin connections matched by the given
428 * filter.
429 */
430
de014da6 431static void a_rawalert(unsigned f_and, unsigned f_eq, const char *status,
3cdc3f3a 432 const char *p, size_t sz)
433{
434 admin *a, *aa;
435 dstr d = DSTR_INIT;
e04c2d50 436
3cdc3f3a 437 if (!(flags & F_INIT))
438 return;
de014da6 439 dstr_puts(&d, status);
440 if (p) {
441 dstr_putc(&d, ' ');
3cdc3f3a 442 dstr_putm(&d, p, sz);
de014da6 443 }
3cdc3f3a 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 }
410c8acf 452 dstr_destroy(&d);
453}
454
b9adb829 455static void a_valert(unsigned f_and, unsigned f_eq, const char *status,
b730d38c 456 const char *fmt, va_list *ap)
3cdc3f3a 457{
458 dstr d = DSTR_INIT;
459
460 if (!(flags & F_INIT))
461 return;
f43df819 462 a_vformat(&d, fmt, ap);
b9adb829 463 a_rawalert(f_and, f_eq, status, fmt ? d.buf : 0, fmt ? d.len : 0);
3cdc3f3a 464 dstr_destroy(&d);
465}
466
b9adb829 467static void a_alert(unsigned f_and, unsigned f_eq, const char *status,
3cdc3f3a 468 const char *fmt, ...)
469{
470 va_list ap;
f98df549 471
3cdc3f3a 472 va_start(ap, fmt);
b730d38c 473 a_valert(f_and, f_eq, status, fmt, &ap);
3cdc3f3a 474 va_end(ap);
475}
3cdc3f3a 476
410c8acf 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
487void a_warn(const char *fmt, ...)
488{
489 va_list ap;
410c8acf 490
410c8acf 491 va_start(ap, fmt);
3cdc3f3a 492 if (flags & F_INIT)
b730d38c 493 a_valert(0, 0, "WARN", fmt, &ap);
410c8acf 494 else {
f43df819 495 dstr d = DSTR_INIT;
3cdc3f3a 496 fprintf(stderr, "%s: ", QUIS);
b730d38c 497 a_vformat(&d, fmt, &ap);
f43df819
MW
498 dstr_putc(&d, '\n');
499 dstr_write(&d, stderr);
500 dstr_destroy(&d);
410c8acf 501 }
3cdc3f3a 502 va_end(ap);
410c8acf 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 *
3cdc3f3a 513 * Use: Custom trace output handler. Sends trace messages to
514 * interested admin connections.
410c8acf 515 */
516
517#ifndef NTRACE
518static void a_trace(const char *p, size_t sz, void *v)
de014da6 519 { a_rawalert(AF_TRACE, AF_TRACE, "TRACE", p, sz); }
410c8acf 520#endif
521
3cdc3f3a 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
532void a_notify(const char *fmt, ...)
533{
534 va_list ap;
535
536 va_start(ap, fmt);
b730d38c 537 a_valert(AF_NOTE, AF_NOTE, "NOTE", fmt, &ap);
3cdc3f3a 538 va_end(ap);
539}
540
410c8acf 541/* --- @a_quit@ --- *
542 *
543 * Arguments: ---
544 *
545 * Returns: ---
546 *
547 * Use: Shuts things down nicely.
548 */
549
550void a_quit(void)
551{
552 close(sock.fd);
553 unlink(sockname);
067aa5f0 554 FOREACH_PEER(p, { p_destroy(p, 1); });
388e0319 555 ps_quit();
410c8acf 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
569static 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:
3cdc3f3a 578 sprintf(buf, "%i", sig);
410c8acf 579 p = buf;
580 break;
581 }
f43df819 582 a_warn("SERVER", "quit", "signal", "%s", p, A_END);
410c8acf 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
596static void a_sighup(int sig, void *v)
f98df549 597 { a_warn("SERVER", "ignore", "signal", "SIGHUP", A_END); }
410c8acf 598
0ba8de86 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
606static 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)
e04c2d50 616 default: t = -1;
0ba8de86 617 case 0: break;
618 }
e04c2d50 619 return (t);
0ba8de86 620}
621
37941236 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
632static peer *a_findpeer(admin *a, const char *pn)
633{
634 peer *p;
635
636 if ((p = p_find(pn)) == 0)
f43df819 637 a_fail(a, "unknown-peer", "%s", pn, A_END);
37941236 638 return (p);
639}
640
de014da6 641/*----- Backgrounded operations -------------------------------------------*/
642
060ca767 643#define BGTAG(bg) \
644 (((admin_bgop *)(bg))->tag ? ((admin_bgop *)(bg))->tag : "<foreground>")
645
ff92ffd3
MW
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
654static 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
de014da6 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
675static void a_bgrelease(admin_bgop *bg)
676{
677 admin *a = bg->a;
678
060ca767 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;
de014da6 685 xfree(bg);
547a9c13 686 if (!a->bg && (a->f & AF_CLOSE)) a_destroy(a);
de014da6 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
700static void a_bgok(admin_bgop *bg)
f43df819 701 { a_write(bg->a, "OK", bg->tag, A_END); }
de014da6 702
703static void a_bginfo(admin_bgop *bg, const char *fmt, ...)
704{
705 va_list ap;
706 va_start(ap, fmt);
b730d38c 707 a_vwrite(bg->a, "INFO", bg->tag, fmt, &ap);
de014da6 708 va_end(ap);
709}
710
711static void a_bgfail(admin_bgop *bg, const char *fmt, ...)
712{
713 va_list ap;
714 va_start(ap, fmt);
b730d38c 715 a_vwrite(bg->a, "FAIL", bg->tag, fmt, &ap);
de014da6 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 *
ff92ffd3 726 * Returns: Zero for success, nonzero on failure.
de014da6 727 *
728 * Use: Links a background job into the list.
729 */
730
ff92ffd3
MW
731static int a_bgadd(admin *a, admin_bgop *bg, const char *tag,
732 void (*cancel)(admin_bgop *))
de014da6 733{
ff92ffd3
MW
734 if (tag) {
735 if (a_bgfind(a, tag)) {
736 a_fail(a, "tag-exists", "%s", tag, A_END);
737 return (-1);
738 }
de014da6 739 bg->tag = xstrdup(tag);
ff92ffd3 740 }
de014da6 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;
060ca767 749 if (a->bg) a->bg->prev = bg;
de014da6 750 a->bg = bg;
060ca767 751 T( trace(T_ADMIN, "admin: add bgop %s", BGTAG(bg)); )
f43df819 752 if (tag) a_write(a, "DETACH", tag, A_END);
ff92ffd3 753 return (0);
de014da6 754}
755
5d46c0f8
MW
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
764static 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
785static 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
808static 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
838static 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
887static 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
914static 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
933static 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
be6a1b7a
MW
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
958static 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
980static 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
1000static 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);
de014da6 1005}
1006
37941236 1007/*----- Name resolution operations ----------------------------------------*/
de014da6 1008
37941236 1009/* --- @a_resolved@ --- *
de014da6 1010 *
37941236 1011 * Arguments: @struct hostent *h@ = pointer to resolved hostname
1012 * @void *v@ = pointer to resolver operation
de014da6 1013 *
1014 * Returns: ---
1015 *
37941236 1016 * Use: Handles a completed name resolution.
de014da6 1017 */
1018
37941236 1019static void a_resolved(struct hostent *h, void *v)
de014da6 1020{
37941236 1021 admin_resop *r = v;
1022
1023 T( trace(T_ADMIN, "admin: resop %s resolved", BGTAG(r)); )
f4c9c08f 1024 QUICKRAND;
37941236 1025 if (!h) {
f43df819 1026 a_bgfail(&r->bg, "resolve-error", "%s", r->addr, A_END);
37941236 1027 r->func(r, ARES_FAIL);
1028 } else {
1029 memcpy(&r->sa.sin.sin_addr, h->h_addr, sizeof(struct in_addr));
1030 r->func(r, ARES_OK);
1031 }
1032 sel_rmtimer(&r->t);
1033 xfree(r->addr);
1034 a_bgrelease(&r->bg);
e04c2d50 1035}
de014da6 1036
37941236 1037/* --- @a_restimer@ --- *
de014da6 1038 *
37941236 1039 * Arguments: @struct timeval *tv@ = timer
1040 * @void *v@ = pointer to resolver operation
de014da6 1041 *
1042 * Returns: ---
1043 *
37941236 1044 * Use: Times out a resolver.
de014da6 1045 */
1046
37941236 1047static void a_restimer(struct timeval *tv, void *v)
de014da6 1048{
37941236 1049 admin_resop *r = v;
1050
1051 T( trace(T_ADMIN, "admin: resop %s timeout", BGTAG(r)); )
f43df819 1052 a_bgfail(&r->bg, "resolver-timeout", "%s", r->addr, A_END);
37941236 1053 r->func(r, ARES_FAIL);
1054 bres_abort(&r->r);
1055 xfree(r->addr);
1056 a_bgrelease(&r->bg);
de014da6 1057}
1058
37941236 1059/* --- @a_rescancel@ --- *
de014da6 1060 *
37941236 1061 * Arguments: @admin_bgop *bg@ = background operation
de014da6 1062 *
1063 * Returns: ---
1064 *
37941236 1065 * Use: Cancels an add operation.
de014da6 1066 */
1067
37941236 1068static void a_rescancel(admin_bgop *bg)
de014da6 1069{
37941236 1070 admin_resop *r = (admin_resop *)bg;
1071
1072 T( trace(T_ADMIN, "admin: cancel resop %s", BGTAG(r)); )
1073 r->func(r, ARES_FAIL);
1074 sel_rmtimer(&r->t);
1075 xfree(r->addr);
1076 bres_abort(&r->r);
de014da6 1077}
37941236 1078
1079/* --- @a_resolve@ --- *
410c8acf 1080 *
37941236 1081 * Arguments: @admin *a@ = administration connection
1082 * @admin_resop *r@ = resolver operation to run
1083 * @const char *tag@ = background operation tag
1084 * @void (*func)(struct admin_resop *, int@ = handler function
1085 * @unsigned ac@ = number of remaining arguments
1086 * @char *av[]@ = pointer to remaining arguments
410c8acf 1087 *
1088 * Returns: ---
1089 *
37941236 1090 * Use: Cranks up a resolver job.
410c8acf 1091 */
1092
37941236 1093static void a_resolve(admin *a, admin_resop *r, const char *tag,
1094 void (*func)(struct admin_resop *, int),
1095 unsigned ac, char *av[])
410c8acf 1096{
37941236 1097 struct timeval tv;
1098 unsigned long pt;
1099 char *p;
1100 int i = 0;
fd3cf232 1101
37941236 1102 /* --- Fill in the easy bits of address --- */
1103
452bf3f6 1104 r->bg.tag = "<starting>";
37941236 1105 r->addr = 0;
1106 r->func = func;
1107 if (mystrieq(av[i], "inet")) i++;
165efde7
MW
1108 if (ac - i != 1 && ac - i != 2) {
1109 a_fail(a, "bad-addr-syntax", "[inet] ADDRESS [PORT]", A_END);
37941236 1110 goto fail;
1111 }
1112 r->sa.sin.sin_family = AF_INET;
37941236 1113 r->addr = xstrdup(av[i]);
6f88042a 1114 if (!av[i + 1])
165efde7
MW
1115 pt = TRIPE_PORT;
1116 else {
1117 pt = strtoul(av[i + 1], &p, 0);
1118 if (*p) {
1119 struct servent *s = getservbyname(av[i + 1], "udp");
1120 if (!s) {
1121 a_fail(a, "unknown-service", "%s", av[i + 1], A_END);
1122 goto fail;
1123 }
1124 pt = ntohs(s->s_port);
37941236 1125 }
410c8acf 1126 }
37941236 1127 if (pt == 0 || pt >= 65536) {
f43df819 1128 a_fail(a, "invalid-port", "%lu", pt, A_END);
37941236 1129 goto fail;
1130 }
1131 r->sa.sin.sin_port = htons(pt);
1132
1133 /* --- Report backgrounding --- *
1134 *
1135 * Do this for consistency of interface, even if we're going to get the
1136 * answer straight away.
1137 */
1138
ff92ffd3
MW
1139 if (a_bgadd(a, &r->bg, tag, a_rescancel))
1140 goto fail;
37941236 1141 T( trace(T_ADMIN, "admin: %u, resop %s, hostname `%s'",
1142 a->seq, BGTAG(r), r->addr); )
1143
1144 /* --- If the name is numeric, do it the easy way --- */
e04c2d50 1145
37941236 1146 if (inet_aton(av[i], &r->sa.sin.sin_addr)) {
1147 T( trace(T_ADMIN, "admin: resop %s done the easy way", BGTAG(r)); )
1148 func(r, ARES_OK);
1149 xfree(r->addr);
1150 a_bgrelease(&r->bg);
1151 return;
1152 }
1153
1154 /* --- Store everything for later and crank up the resolver --- */
1155
1156 gettimeofday(&tv, 0);
1157 tv.tv_sec += T_RESOLVE;
1158 sel_addtimer(&sel, &r->t, &tv, a_restimer, r);
1159 bres_byname(&r->r, r->addr, a_resolved, r);
1160 return;
1161
1162fail:
1163 func(r, ARES_FAIL);
1164 if (r->addr) xfree(r->addr);
1165 xfree(r);
410c8acf 1166}
1167
e7a4d919
MW
1168/*----- Option parsing ----------------------------------------------------*/
1169
1170#define OPTIONS(argc, argv, guts) do { \
1171 char **o_av = argv; \
1172 for (;; o_av++) { \
1173 if (!*o_av) \
1174 break; \
1175 if (mystrieq(*o_av, "--")) { \
1176 o_av++; \
1177 break; \
1178 } \
1179 guts \
1180 if (**o_av == '-') \
1181 goto bad_syntax; \
1182 break; \
1183 } \
1184 argc -= o_av - argv; \
1185 argv = o_av; \
1186} while (0)
1187
1188#define OPT(name, guts) if (mystrieq(*o_av, name)) { guts continue; }
1189
1190#define OPTARG(name, arg, guts) OPT(name, { \
1191 const char *arg; \
1192 arg = *++o_av; \
1193 if (!arg) goto bad_syntax; \
1194 guts \
1195})
1196
1197#define OPTTIME(name, arg, guts) OPTARG(name, o_arg, { \
1198 long arg; \
1199 if ((arg = a_parsetime(o_arg)) < 0) { \
1200 a_fail(a, "bad-time-spec", "%s", o_arg, A_END); \
1201 goto fail; \
1202 } \
1203 guts \
1204})
1205
37941236 1206/*----- Adding peers ------------------------------------------------------*/
1207
1208/* --- @a_doadd@ --- *
410c8acf 1209 *
37941236 1210 * Arguments: @admin_resop *r@ = resolver operation
1211 * @int rc@ = how it worked
410c8acf 1212 *
1213 * Returns: ---
1214 *
37941236 1215 * Use: Handles a completed resolution.
410c8acf 1216 */
1217
37941236 1218static void a_doadd(admin_resop *r, int rc)
410c8acf 1219{
37941236 1220 admin_addop *add = (admin_addop *)r;
1221
1222 T( trace(T_ADMIN, "admin: done add op %s", BGTAG(add)); )
1223
1224 if (rc == ARES_OK) {
37941236 1225 add->peer.sa = add->r.sa;
c8e02c8a
MW
1226 if (p_findbyaddr(&add->r.sa))
1227 a_bgfail(&add->r.bg, "peer-addr-exists", "?ADDR", &add->r.sa, A_END);
1228 else if (p_find(add->peer.name))
f43df819 1229 a_bgfail(&add->r.bg, "peer-exists", "%s", add->peer.name, A_END);
37941236 1230 else if (!p_create(&add->peer))
f43df819 1231 a_bgfail(&add->r.bg, "peer-create-fail", "%s", add->peer.name, A_END);
37941236 1232 else
1233 a_bgok(&add->r.bg);
1234 }
de014da6 1235
48b84569 1236 if (add->peer.tag) xfree(add->peer.tag);
71862c07 1237 if (add->peer.privtag) xfree(add->peer.privtag);
8362ac1c 1238 if (add->peer.knock) xfree(add->peer.knock);
37941236 1239 xfree(add->peer.name);
410c8acf 1240}
1241
1242/* --- @acmd_add@ --- *
1243 *
1244 * Arguments: @admin *a@ = connection which requested the addition
1245 * @unsigned ac@ = argument count
1246 * @char *av[]@ = pointer to the argument list
1247 *
1248 * Returns: ---
1249 *
1250 * Use: Adds a new peer.
1251 */
1252
1253static void acmd_add(admin *a, unsigned ac, char *av[])
1254{
de014da6 1255 const char *tag = 0;
9986f0b5 1256 admin_addop *add;
410c8acf 1257
0ba8de86 1258 /* --- Set stuff up --- */
1259
de014da6 1260 add = xmalloc(sizeof(*add));
9986f0b5 1261 add->peer.name = 0;
48b84569 1262 add->peer.tag = 0;
fe2a5dcf 1263 add->peer.privtag = 0;
8362ac1c 1264 add->peer.knock = 0;
de014da6 1265 add->peer.t_ka = 0;
1266 add->peer.tops = tun_default;
8743c776 1267 add->peer.f = 0;
37941236 1268
42da2a58 1269 /* --- Parse options --- */
1270
e7a4d919
MW
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);
37941236 1278 goto fail;
42da2a58 1279 }
e7a4d919
MW
1280 if (mystrieq(arg, tunnels[i]->name)) {
1281 add->peer.tops = tunnels[i];
42da2a58 1282 break;
1283 }
1284 }
e7a4d919
MW
1285 })
1286 OPTTIME("-keepalive", t, { add->peer.t_ka = t; })
8743c776 1287 OPT("-cork", { add->peer.f |= KXF_CORK; })
067aa5f0 1288 OPT("-ephemeral", { add->peer.f |= PSF_EPHEM; })
48b84569 1289 OPTARG("-key", arg, {
97b8d61c 1290 if (add->peer.tag) xfree(add->peer.tag);
48b84569
MW
1291 add->peer.tag = xstrdup(arg);
1292 })
067aa5f0 1293 OPT("-mobile", { add->peer.f |= PSF_MOBILE | PSF_EPHEM; })
fe2a5dcf 1294 OPTARG("-priv", arg, {
97b8d61c 1295 if (add->peer.privtag) xfree(add->peer.privtag);
fe2a5dcf
MW
1296 add->peer.privtag = xstrdup(arg);
1297 })
8362ac1c
MW
1298 OPTARG("-knock", arg, {
1299 if (add->peer.knock) xfree(add->peer.knock);
1300 add->peer.knock = xstrdup(arg);
067aa5f0 1301 add->peer.f |= PSF_EPHEM;
8362ac1c 1302 })
e7a4d919 1303 });
42da2a58 1304
9986f0b5
MW
1305 /* --- Make sure someone's not got there already --- */
1306
bcf3764a 1307 if (!av[0] || !av[1])
9986f0b5 1308 goto bad_syntax;
e7a4d919
MW
1309 if (p_find(*av)) {
1310 a_fail(a, "peer-exists", "%s", *av, A_END);
9986f0b5 1311 goto fail;
42da2a58 1312 }
e7a4d919
MW
1313 add->peer.name = xstrdup(*av++);
1314 ac--;
42da2a58 1315
37941236 1316 /* --- Crank up the resolver --- */
de014da6 1317
e7a4d919 1318 a_resolve(a, &add->r, tag, a_doadd, ac, av);
42da2a58 1319 return;
1320
37941236 1321 /* --- Clearing up --- */
1322
42da2a58 1323bad_syntax:
9986f0b5 1324 a_fail(a, "bad-syntax", "add", "[OPTIONS] PEER ADDR ...", A_END);
de014da6 1325fail:
9986f0b5 1326 if (add->peer.name) xfree(add->peer.name);
48b84569 1327 if (add->peer.tag) xfree(add->peer.tag);
fe2a5dcf 1328 if (add->peer.privtag) xfree(add->peer.privtag);
8362ac1c 1329 if (add->peer.knock) xfree(add->peer.knock);
37941236 1330 xfree(add);
0ba8de86 1331 return;
1332}
1333
1334/*----- Ping --------------------------------------------------------------*/
1335
de014da6 1336/* --- @a_pingcancel@ --- *
1337 *
1338 * Arguments: @admin_bgop *bg@ = background operation block
1339 *
1340 * Returns: ---
1341 *
1342 * Use: Cancels a running ping.
1343 */
1344
1345static void a_pingcancel(admin_bgop *bg)
1346{
1347 admin_pingop *pg = (admin_pingop *)bg;
060ca767 1348 T( trace(T_ADMIN, "admin: cancel ping op %s", BGTAG(pg)); )
de014da6 1349 p_pingdone(&pg->ping, PING_NONOTIFY);
1350}
1351
0ba8de86 1352/* --- @a_pong@ --- *
1353 *
1354 * Arguments: @int rc@ = return code
de014da6 1355 * @void *v@ = ping operation block
0ba8de86 1356 *
1357 * Returns: ---
1358 *
1359 * Use: Collects what happened to a ping message.
1360 */
1361
de014da6 1362static void a_pong(int rc, void *v)
0ba8de86 1363{
de014da6 1364 admin_pingop *pg = v;
0ba8de86 1365 struct timeval tv;
1366 double millis;
1367
0ba8de86 1368 switch (rc) {
1369 case PING_OK:
1370 gettimeofday(&tv, 0);
de014da6 1371 tv_sub(&tv, &tv, &pg->pingtime);
0ba8de86 1372 millis = (double)tv.tv_sec * 1000 + (double)tv.tv_usec/1000;
f43df819 1373 a_bginfo(&pg->bg, "ping-ok", "%.1f", millis, A_END);
de014da6 1374 a_bgok(&pg->bg);
0ba8de86 1375 break;
1376 case PING_TIMEOUT:
f43df819 1377 a_bginfo(&pg->bg, "ping-timeout", A_END);
de014da6 1378 a_bgok(&pg->bg);
0ba8de86 1379 break;
1380 case PING_PEERDIED:
f43df819 1381 a_bginfo(&pg->bg, "ping-peer-died", A_END);
de014da6 1382 a_bgok(&pg->bg);
0ba8de86 1383 break;
1384 default:
1385 abort();
1386 }
060ca767 1387 T( trace(T_ADMIN, "admin: ponged ping op %s", BGTAG(pg)); )
de014da6 1388 a_bgrelease(&pg->bg);
0ba8de86 1389}
1390
1391/* --- @acmd_ping@, @acmd_eping@ --- *
1392 *
1393 * Arguments: @admin *a@ = connection which requested the ping
1394 * @unsigned ac@ = argument count
1395 * @char *av[]@ = pointer to the argument list
1396 *
1397 * Returns: ---
1398 *
1399 * Use: Pings a peer.
1400 */
1401
1402static void a_ping(admin *a, unsigned ac, char *av[],
1403 const char *cmd, unsigned msg)
1404{
1405 long t = T_PING;
0ba8de86 1406 peer *p;
de014da6 1407 admin_pingop *pg = 0;
1408 const char *tag = 0;
0ba8de86 1409
e7a4d919
MW
1410 OPTIONS(ac, av, {
1411 OPTARG("-background", arg, { tag = arg; })
1412 OPTTIME("-timeout", arg, { t = arg; })
1413 });
1414 if (!*av || av[1]) goto bad_syntax;
1415 if ((p = a_findpeer(a, *av)) == 0)
0ba8de86 1416 return;
de014da6 1417 pg = xmalloc(sizeof(*pg));
1418 gettimeofday(&pg->pingtime, 0);
ff92ffd3
MW
1419 if (a_bgadd(a, &pg->bg, tag, a_pingcancel))
1420 goto fail;
060ca767 1421 T( trace(T_ADMIN, "admin: ping op %s: %s to %s",
1422 BGTAG(pg), cmd, p_name(p)); )
de014da6 1423 if (p_pingsend(p, &pg->ping, msg, t, a_pong, pg)) {
f43df819 1424 a_bgfail(&pg->bg, "ping-send-failed", A_END);
de014da6 1425 a_bgrelease(&pg->bg);
1426 }
0ba8de86 1427 return;
e04c2d50 1428
0ba8de86 1429bad_syntax:
f43df819 1430 a_fail(a, "bad-syntax", "%s", cmd, "[OPTIONS] PEER", cmd, A_END);
e7a4d919 1431fail:
ff92ffd3 1432 if (pg) xfree(pg);
42da2a58 1433 return;
410c8acf 1434}
1435
0ba8de86 1436static void acmd_ping(admin *a, unsigned ac, char *av[])
1437 { a_ping(a, ac, av, "ping", MISC_PING); }
1438static void acmd_eping(admin *a, unsigned ac, char *av[])
1439 { a_ping(a, ac, av, "eping", MISC_EPING); }
0ba8de86 1440
be6a1b7a
MW
1441/*----- Service commands --------------------------------------------------*/
1442
1443static void acmd_svcclaim(admin *a, unsigned ac, char *av[])
1444{
1445 admin_service *svc;
1446 unsigned f;
1447
1448 svc = sym_find(&a_svcs, av[0], -1, sizeof(*svc), &f);
1449 if (f) {
1450 if (versioncmp(av[1], svc->version) <= 0) {
1451 a_fail(a,
1452 "service-exists",
1453 "%s", SYM_NAME(svc),
1454 "%s", svc->version,
1455 A_END);
1456 return;
1457 }
1458 a_write(svc->prov, "SVCCLAIM", 0, "%s", av[0], "%s", av[1], A_END);
1459 a_svcunlink(svc);
1460 }
1461 svc->prov = a;
1462 svc->version = xstrdup(av[1]);
1463 svc->next = a->svcs;
1464 svc->prev = 0;
1465 if (a->svcs) a->svcs->prev = svc;
1466 a->svcs = svc;
1467 a_notify("SVCCLAIM", "%s", SYM_NAME(svc), "%s", svc->version, A_END);
1468 a_ok(a);
1469}
1470
1471static void acmd_svcrelease(admin *a, unsigned ac, char *av[])
1472{
1473 admin_service *svc;
1474
1475 if ((svc = a_svcfind(a, av[0])) == 0)
1476 return;
1477 if (svc->prov != a) {
1478 a_fail(a, "not-service-provider", "%s", SYM_NAME(svc), A_END);
1479 return;
1480 }
1481 a_svcrelease(svc);
1482 a_ok(a);
1483}
1484
1485static void acmd_svcensure(admin *a, unsigned ac, char *av[])
1486{
1487 admin_service *svc;
1488
1489 if ((svc = a_svcfind(a, av[0])) == 0)
1490 return;
1491 if (av[1] && versioncmp(svc->version, av[1]) < 0) {
1492 a_fail(a, "service-too-old",
1493 "%s", SYM_NAME(svc),
1494 "%s", svc->version,
1495 A_END);
1496 return;
1497 }
1498 a_ok(a);
1499}
1500
1501static void acmd_svcquery(admin *a, unsigned ac, char *av[])
1502{
1503 admin_service *svc;
1504
1505 if ((svc = a_svcfind(a, av[0])) != 0) {
1506 a_info(a, "name=%s", SYM_NAME(svc), "version=%s", svc->version, A_END);
1507 a_ok(a);
1508 }
1509}
1510
1511static void acmd_svclist(admin *a, unsigned ac, char *av[])
1512{
1513 admin_service *svc;
1514 sym_iter i;
1515
1516 for (sym_mkiter(&i, &a_svcs); (svc = sym_next(&i)) != 0; )
1517 a_info(a, "%s", SYM_NAME(svc), "%s", svc->version, A_END);
1518 a_ok(a);
1519}
1520
ef2f29c9
MW
1521static void a_canceljob(admin_bgop *bg)
1522{
1523 admin_svcop *svc = (admin_svcop *)bg;
1524
1525 a_write(svc->prov, "SVCCANCEL", 0, "%s", a_jobidencode(svc), A_END);
1526 a_jobdestroy(svc);
1527}
1528
1529static void acmd_svcsubmit(admin *a, unsigned ac, char *av[])
1530{
1531 const char *tag = 0;
1532 admin_service *svc;
1533 admin_svcop *svcop;
1534 const char *ver = 0;
1535 dstr d = DSTR_INIT;
1536
1537 OPTIONS(ac, av, {
1538 OPTARG("-background", arg, { tag = arg; })
1539 OPTARG("-version", arg, { ver = arg; })
1540 });
1541 if (!*av) goto bad_syntax;
1542 if ((svc = a_svcfind(a, *av)) == 0) goto fail;
1543 if (ver && versioncmp(svc->version, ver) < 0) {
1544 a_fail(a, "service-too-old",
1545 "%s", SYM_NAME(svc),
1546 "%s", svc->version,
1547 A_END);
1548 goto fail;
1549 }
1550 if ((svcop = a_jobcreate(svc->prov)) == 0) {
1551 a_fail(a, "provider-overloaded", A_END);
1552 goto fail;
1553 }
1554 if (a_bgadd(a, &svcop->bg, tag, a_canceljob)) {
1555 a_jobdestroy(svcop);
1556 goto fail;
1557 }
1558 a_write(svc->prov, "SVCJOB", 0,
1559 "%s", a_jobidencode(svcop),
1560 "?TOKENS", av,
1561 A_END);
1562 goto done;
1563
1564bad_syntax:
1565 a_fail(a, "bad-syntax", "svcsubmit", "[OPTIONS] SERVICE ARGS...", A_END);
1566fail:
1567done:
1568 dstr_destroy(&d);
1569 return;
1570}
1571
1572static void a_replycmd(admin *a, const char *status, int donep, char *av[])
1573{
1574 admin_svcop *svc;
1575
1576 if ((svc = a_jobiddecode(&a->j, av[0])) == 0) {
1577 a_fail(a, "unknown-jobid", av[0], A_END);
1578 return;
1579 }
1580 a_write(svc->bg.a, status, svc->bg.tag, "?TOKENS", av + 1, A_END);
1581 if (donep) {
1582 a_jobdestroy(svc);
1583 a_bgrelease(&svc->bg);
1584 }
1585 a_ok(a);
1586}
1587
1588static void acmd_svcok(admin *a, unsigned ac, char *av[])
1589 { a_replycmd(a, "OK", 1, av); }
1590static void acmd_svcinfo(admin *a, unsigned ac, char *av[])
1591 { a_replycmd(a, "INFO", 0, av); }
1592static void acmd_svcfail(admin *a, unsigned ac, char *av[])
1593 { a_replycmd(a, "FAIL", 1, av); }
1594
410c8acf 1595/*----- Administration commands -------------------------------------------*/
1596
1597/* --- Miscellaneous commands --- */
1598
3cdc3f3a 1599/* --- @traceish@ --- *
1600 *
1601 * Arguments: @admin *a@ = connection to complain on
1602 * @unsigned ac@ = number of arguments
1603 * @char *av[]@ = vector of arguments
1604 * @const char *what@ = what we're messing with
1605 * @const trace_opt *tt@ = options table
1606 * @unsigned *ff@ = where the flags are
1607 *
1608 * Returns: Nonzero if anything changed.
1609 *
1610 * Use: Guts of trace-ish commands like `trace' and `watch'.
1611 */
410c8acf 1612
3cdc3f3a 1613static int traceish(admin *a, unsigned ac, char *av[],
1614 const char *what, const trace_opt *tt, unsigned *ff)
410c8acf 1615{
3cdc3f3a 1616 int ch = 0;
1617
410c8acf 1618 if (!ac || strcmp(av[0], "?") == 0) {
1619 const trace_opt *t;
3cdc3f3a 1620 for (t = tt; t->ch; t++) {
f43df819
MW
1621 a_info(a, "*%c%c %s",
1622 t->ch, (*ff & t->f) == t->f ? '+' : ' ', t->help, A_END);
410c8acf 1623 }
1624 } else {
1625 unsigned sense = 1;
3cdc3f3a 1626 unsigned f = *ff;
1627 const trace_opt *t;
410c8acf 1628 char *p = av[0];
1629
1630 while (*p) {
1631 switch (*p) {
1632 case '+': sense = 1; break;
1633 case '-': sense = 0; break;
1634 default:
3cdc3f3a 1635 for (t = tt; t->ch; t++) {
1636 if (t->ch == *p) {
1637 if (sense) f |= t->f;
1638 else f &= ~t->f;
410c8acf 1639 goto tropt_ok;
1640 }
1641 }
f43df819 1642 a_fail(a, "bad-%s-option", what, "%c", *p, A_END);
3cdc3f3a 1643 return (0);
e04c2d50 1644 tropt_ok:;
410c8acf 1645 break;
1646 }
1647 p++;
1648 }
3cdc3f3a 1649 *ff = f;
1650 ch = 1;
410c8acf 1651 }
3cdc3f3a 1652 a_ok(a);
1653 return (ch);
1654}
1655
1656#ifndef NTRACE
1657
1658static void acmd_trace(admin *a, unsigned ac, char *av[])
1659{
1660 if (traceish(a, ac, av, "trace", tr_opts, &tr_flags))
1661 trace_level(tr_flags);
410c8acf 1662}
1663
1664#endif
1665
3cdc3f3a 1666static void acmd_watch(admin *a, unsigned ac, char *av[])
f98df549 1667 { traceish(a, ac, av, "watch", w_opts, &a->f); }
3cdc3f3a 1668
3cdc3f3a 1669static void alertcmd(admin *a, unsigned f_and, unsigned f_eq,
3331936b
MW
1670 const char *status, char *av[])
1671 { a_alert(f_and, f_eq, status, "USER", "?TOKENS", av, A_END); a_ok(a); }
3cdc3f3a 1672static void acmd_notify(admin *a, unsigned ac, char *av[])
3331936b 1673 { alertcmd(a, AF_NOTE, AF_NOTE, "NOTE", av); }
3cdc3f3a 1674static void acmd_warn(admin *a, unsigned ac, char *av[])
3331936b 1675 { alertcmd(a, AF_WARN, AF_WARN, "WARN", av); }
3cdc3f3a 1676
410c8acf 1677static void acmd_port(admin *a, unsigned ac, char *av[])
f98df549 1678 { a_info(a, "%u", p_port(), A_END); a_ok(a); }
410c8acf 1679
410c8acf 1680static void acmd_daemon(admin *a, unsigned ac, char *av[])
1681{
1682 if (flags & F_DAEMON)
f43df819 1683 a_fail(a, "already-daemon", A_END);
410c8acf 1684 else {
f43df819 1685 a_notify("DAEMON", A_END);
93bee2c4 1686 if (a_stdin)
410c8acf 1687 a_destroy(a_stdin);
19dd2531 1688 if (daemonize())
f43df819 1689 a_fail(a, "daemon-error", "?ERRNO", A_END);
93bee2c4 1690 else {
410c8acf 1691 flags |= F_DAEMON;
3cdc3f3a 1692 a_ok(a);
93bee2c4 1693 }
410c8acf 1694 }
1695}
1696
ff92ffd3
MW
1697static void acmd_jobs(admin *a, unsigned ac, char *av[])
1698{
1699 admin_bgop *bg;
1700
1701 for (bg = a->bg; bg; bg = bg->next) {
1702 assert(bg->tag);
1703 a_info(a, "%s", bg->tag, A_END);
1704 }
1705 a_ok(a);
1706}
1707
1708static void acmd_bgcancel(admin *a, unsigned ac, char *av[])
1709{
1710 admin_bgop *bg;
1711
1712 if ((bg = a_bgfind(a, av[0])) == 0)
1713 a_fail(a, "unknown-tag", "%s", av[0], A_END);
1714 else {
1715 bg->cancel(bg);
1716 a_bgrelease(bg);
1717 a_ok(a);
1718 }
1719}
1720
449991a3
MW
1721static void acmd_algs(admin *a, unsigned ac, char *av[])
1722{
35c8b547
MW
1723 peer *p;
1724 const kdata *kd;
5b9f3d37 1725 const dhgrp *g;
35c8b547
MW
1726 const algswitch *algs;
1727
1728 if (!ac)
1729 kd = master;
1730 else {
1731 if ((p = a_findpeer(a, av[0])) == 0) return;
1732 kd = p->kx.kpriv;
1733 }
5b9f3d37 1734 g = kd->grp;
35c8b547
MW
1735 algs = &kd->algs;
1736
5b9f3d37 1737 g->ops->grpinfo(g, a);
449991a3 1738 a_info(a,
35c8b547
MW
1739 "hash=%s", algs->h->name,
1740 "mgf=%s", algs->mgf->name,
1741 "hash-sz=%lu", (unsigned long)algs->h->hashsz,
449991a3
MW
1742 A_END);
1743 a_info(a,
c70a7c5c
MW
1744 "bulk-transform=%s", algs->bulk->ops->name,
1745 "bulk-overhead=%lu",
1746 (unsigned long)algs->bulk->ops->overhead(algs->bulk),
449991a3 1747 A_END);
c70a7c5c 1748 algs->bulk->ops->alginfo(algs->bulk, a);
449991a3 1749 a_info(a,
c70a7c5c
MW
1750 "cipher-data-limit=%lu",
1751 (unsigned long)algs->bulk->ops->expsz(algs->bulk),
449991a3 1752 A_END);
449991a3
MW
1753 a_ok(a);
1754}
1755
410c8acf 1756static void acmd_list(admin *a, unsigned ac, char *av[])
1757{
c8e02c8a 1758 FOREACH_PEER(p, { a_info(a, "%s", p_name(p), A_END); });
3cdc3f3a 1759 a_ok(a);
410c8acf 1760}
1761
1762static void acmd_ifname(admin *a, unsigned ac, char *av[])
1763{
1764 peer *p;
1765
37941236 1766 if ((p = a_findpeer(a, av[0])) != 0) {
f43df819 1767 a_info(a, "%s", p_ifname(p), A_END);
3cdc3f3a 1768 a_ok(a);
1769 }
410c8acf 1770}
1771
64cf2223
MW
1772static void acmd_setifname(admin *a, unsigned ac, char *av[])
1773{
1774 peer *p;
1775
1776 if ((p = a_findpeer(a, av[0])) != 0) {
1777 a_notify("NEWIFNAME", "?PEER", p, "%s", p_ifname(p), "%s", av[1], A_END);
1778 p_setifname(p, av[1]);
1779 a_ok(a);
e04c2d50 1780 }
64cf2223
MW
1781}
1782
37941236 1783static void acmd_getchal(admin *a, unsigned ac, char *av[])
1784{
1785 buf b;
1786
1787 buf_init(&b, buf_i, PKBUFSZ);
3deadf73 1788 c_new(0, 0, &b);
f43df819 1789 a_info(a, "?B64", BBASE(&b), (size_t)BLEN(&b), A_END);
37941236 1790 a_ok(a);
1791}
1792
1793static void acmd_checkchal(admin *a, unsigned ac, char *av[])
1794{
37d4c59e
MW
1795 codec *b64 = base64_class.decoder(CDCF_NOEQPAD);
1796 int err;
37941236 1797 buf b;
1798 dstr d = DSTR_INIT;
1799
37d4c59e
MW
1800 if ((err = b64->ops->code(b64, av[0], strlen(av[0]), &d)) != 0 ||
1801 (err = b64->ops->code(b64, 0, 0, &d)) != 0)
1802 a_fail(a, "bad-base64", "%s", codec_strerror(err), A_END);
1803 else {
1804 buf_init(&b, d.buf, d.len);
3deadf73 1805 if (c_check(0, 0, &b) || BBAD(&b) || BLEFT(&b))
37d4c59e
MW
1806 a_fail(a, "invalid-challenge", A_END);
1807 else
1808 a_ok(a);
1809 }
1810 b64->ops->destroy(b64);
37941236 1811 dstr_destroy(&d);
1812}
1813
1814static void acmd_greet(admin *a, unsigned ac, char *av[])
1815{
1816 peer *p;
37d4c59e
MW
1817 int err;
1818 codec *b64;
37941236 1819 dstr d = DSTR_INIT;
1820
37d4c59e
MW
1821 if ((p = a_findpeer(a, av[0])) == 0) return;
1822 b64 = base64_class.decoder(CDCF_NOEQPAD);
1823 if ((err = b64->ops->code(b64, av[1], strlen(av[1]), &d)) != 0 ||
1824 (err = b64->ops->code(b64, 0, 0, &d)) != 0)
1825 a_fail(a, "bad-base64", "%s", codec_strerror(err), A_END);
1826 else {
37941236 1827 p_greet(p, d.buf, d.len);
37941236 1828 a_ok(a);
1829 }
37d4c59e
MW
1830 b64->ops->destroy(b64);
1831 dstr_destroy(&d);
37941236 1832}
1833
410c8acf 1834static void acmd_addr(admin *a, unsigned ac, char *av[])
1835{
1836 peer *p;
1837 const addr *ad;
1838
37941236 1839 if ((p = a_findpeer(a, av[0])) != 0) {
410c8acf 1840 ad = p_addr(p);
1841 assert(ad->sa.sa_family == AF_INET);
f43df819 1842 a_info(a, "?ADDR", ad, A_END);
3cdc3f3a 1843 a_ok(a);
410c8acf 1844 }
1845}
1846
060ca767 1847static void acmd_peerinfo(admin *a, unsigned ac, char *av[])
1848{
1849 peer *p;
1850 const peerspec *ps;
f3c6d21c 1851 const char *ptag;
060ca767 1852
37941236 1853 if ((p = a_findpeer(a, av[0])) != 0) {
1854 ps = p_spec(p);
f43df819 1855 a_info(a, "tunnel=%s", ps->tops->name, A_END);
8362ac1c 1856 if (ps->knock) a_info(a, "knock=%s", ps->knock, A_END);
fe2a5dcf
MW
1857 a_info(a, "key=%s", p_tag(p),
1858 "current-key=%s", p->kx.kpub->tag, A_END);
f3c6d21c
MW
1859 if ((ptag = p_privtag(p)) == 0) ptag = "(default)";
1860 a_info(a, "private-key=%s", ptag,
fe2a5dcf 1861 "current-private-key=%s", p->kx.kpriv->tag, A_END);
f43df819 1862 a_info(a, "keepalive=%lu", ps->t_ka, A_END);
bd322830
MW
1863 a_info(a, "corked=%s", BOOL(p->kx.f&KXF_CORK),
1864 "mobile=%s", BOOL(ps->f&PSF_MOBILE),
067aa5f0 1865 "ephemeral=%s", BOOL(ps->f&PSF_EPHEM),
bd322830 1866 A_END);
37941236 1867 a_ok(a);
060ca767 1868 }
060ca767 1869}
1870
1871static void acmd_servinfo(admin *a, unsigned ac, char *av[])
1872{
f43df819
MW
1873 a_info(a, "implementation=edgeware-tripe", A_END);
1874 a_info(a, "version=%s", VERSION, A_END);
1875 a_info(a, "daemon=%s", BOOL(flags & F_DAEMON), A_END);
060ca767 1876 a_ok(a);
1877}
1878
c7053da9 1879static void acmd_stats(admin *a, unsigned ac, char *av[])
1880{
1881 peer *p;
1882 stats *st;
1883
37941236 1884 if ((p = a_findpeer(a, av[0])) == 0)
060ca767 1885 return;
060ca767 1886
1887 st = p_stats(p);
f43df819
MW
1888 a_info(a, "start-time=%s", timestr(st->t_start), A_END);
1889 a_info(a, "last-packet-time=%s", timestr(st->t_last), A_END);
1890 a_info(a, "last-keyexch-time=%s", timestr(st->t_kx), A_END);
18ad8913
MW
1891 a_info(a, "packets-in=%lu", st->n_in, "bytes-in=%lu", st->sz_in, A_END);
1892 a_info(a,
1893 "packets-out=%lu", st->n_out,
1894 "bytes-out=%lu", st->sz_out,
1895 A_END);
1896 a_info(a,
1897 "keyexch-packets-in=%lu", st->n_kxin,
1898 "keyexch-bytes-in=%lu", st->sz_kxin,
1899 A_END);
1900 a_info(a,
1901 "keyexch-packets-out=%lu", st->n_kxout,
1902 "keyexch-bytes-out=%lu", st->sz_kxout,
1903 A_END);
1904 a_info(a,
1905 "ip-packets-in=%lu", st->n_ipin,
1906 "ip-bytes-in=%lu", st->sz_ipin,
1907 A_END);
1908 a_info(a,
e04c2d50 1909 "ip-packets-out=%lu", st->n_ipout,
18ad8913
MW
1910 "ip-bytes-out=%lu", st->sz_ipout,
1911 A_END);
f43df819 1912 a_info(a, "rejected-packets=%lu", st->n_reject, A_END);
060ca767 1913 a_ok(a);
c7053da9 1914}
1915
410c8acf 1916static void acmd_kill(admin *a, unsigned ac, char *av[])
1917{
1918 peer *p;
f98df549 1919
37941236 1920 if ((p = a_findpeer(a, av[0])) != 0) {
067aa5f0 1921 p_destroy(p, 1);
3cdc3f3a 1922 a_ok(a);
410c8acf 1923 }
1924}
1925
0ba8de86 1926static void acmd_forcekx(admin *a, unsigned ac, char *av[])
1927{
1928 peer *p;
f98df549 1929
37941236 1930 if ((p = a_findpeer(a, av[0])) != 0) {
de014da6 1931 kx_start(&p->kx, 1);
0ba8de86 1932 a_ok(a);
1933 }
1934}
1935
de014da6 1936static void acmd_reload(admin *a, unsigned ac, char *av[])
1937 { p_keyreload(); a_ok(a); }
1938
410c8acf 1939static void acmd_quit(admin *a, unsigned ac, char *av[])
1940{
f43df819 1941 a_warn("SERVER", "quit", "admin-request", A_END);
3cdc3f3a 1942 a_ok(a);
410c8acf 1943 a_quit();
1944}
1945
3cdc3f3a 1946static void acmd_version(admin *a, unsigned ac, char *av[])
1947{
f43df819 1948 a_info(a, "%s", PACKAGE, "%s", VERSION, A_END);
3cdc3f3a 1949 a_ok(a);
1950}
1951
42da2a58 1952static void acmd_tunnels(admin *a, unsigned ac, char *av[])
1953{
1954 int i;
f98df549 1955
42da2a58 1956 for (i = 0; tunnels[i]; i++)
f43df819 1957 a_info(a, "%s", tunnels[i]->name, A_END);
42da2a58 1958 a_ok(a);
1959}
1960
410c8acf 1961/* --- The command table and help --- */
1962
1963typedef struct acmd {
1964 const char *name;
1965 const char *help;
1966 unsigned argmin, argmax;
1967 void (*func)(admin */*a*/, unsigned /*ac*/, char */*av*/[]);
1968} acmd;
1969
1970static void acmd_help(admin */*a*/, unsigned /*ac*/, char */*av*/[]);
1971
1972static const acmd acmdtab[] = {
9986f0b5 1973 { "add", "[OPTIONS] PEER ADDR ...", 2, 0xffff, acmd_add },
f43df819 1974 { "addr", "PEER", 1, 1, acmd_addr },
35c8b547 1975 { "algs", "[PEER]", 0, 1, acmd_algs },
ff92ffd3 1976 { "bgcancel", "TAG", 1, 1, acmd_bgcancel },
f43df819
MW
1977 { "checkchal", "CHAL", 1, 1, acmd_checkchal },
1978 { "daemon", 0, 0, 0, acmd_daemon },
1979 { "eping", "[OPTIONS] PEER", 1, 0xffff, acmd_eping },
1980 { "forcekx", "PEER", 1, 1, acmd_forcekx },
1981 { "getchal", 0, 0, 0, acmd_getchal },
1982 { "greet", "PEER CHAL", 2, 2, acmd_greet },
1983 { "help", 0, 0, 0, acmd_help },
1984 { "ifname", "PEER", 1, 1, acmd_ifname },
ff92ffd3 1985 { "jobs", 0, 0, 0, acmd_jobs },
f43df819
MW
1986 { "kill", "PEER", 1, 1, acmd_kill },
1987 { "list", 0, 0, 0, acmd_list },
1988 { "notify", "MESSAGE ...", 1, 0xffff, acmd_notify },
1989 { "peerinfo", "PEER", 1, 1, acmd_peerinfo },
1990 { "ping", "[OPTIONS] PEER", 1, 0xffff, acmd_ping },
1991 { "port", 0, 0, 0, acmd_port },
1992 { "quit", 0, 0, 0, acmd_quit },
1993 { "reload", 0, 0, 0, acmd_reload },
1994 { "servinfo", 0, 0, 0, acmd_servinfo },
64cf2223 1995 { "setifname", "PEER NEW-NAME", 2, 2, acmd_setifname },
405fc4da 1996 { "stats", "PEER", 1, 1, acmd_stats },
be6a1b7a
MW
1997 { "svcclaim", "SERVICE VERSION", 2, 2, acmd_svcclaim },
1998 { "svcensure", "SERVICE [VERSION]", 1, 2, acmd_svcensure },
ef2f29c9
MW
1999 { "svcfail", "JOBID TOKENS...", 1, 0xffff, acmd_svcfail },
2000 { "svcinfo", "JOBID TOKENS...", 1, 0xffff, acmd_svcinfo },
be6a1b7a 2001 { "svclist", 0, 0, 0, acmd_svclist },
ef2f29c9 2002 { "svcok", "JOBID", 1, 1, acmd_svcok },
be6a1b7a
MW
2003 { "svcquery", "SERVICE", 1, 1, acmd_svcquery },
2004 { "svcrelease", "SERVICE", 1, 1, acmd_svcrelease },
ef2f29c9
MW
2005 { "svcsubmit", "[OPTIONS] SERVICE TOKENS...",
2006 2, 0xffff, acmd_svcsubmit },
de014da6 2007#ifndef NTRACE
f43df819 2008 { "trace", "[OPTIONS]", 0, 1, acmd_trace },
de014da6 2009#endif
f43df819
MW
2010 { "tunnels", 0, 0, 0, acmd_tunnels },
2011 { "version", 0, 0, 0, acmd_version },
2012 { "warn", "MESSAGE ...", 1, 0xffff, acmd_warn },
e04c2d50 2013 { "watch", "[OPTIONS]", 0, 1, acmd_watch },
410c8acf 2014 { 0, 0, 0, 0, 0 }
2015};
2016
2017static void acmd_help(admin *a, unsigned ac, char *av[])
2018{
2019 const acmd *c;
f98df549 2020
f43df819
MW
2021 for (c = acmdtab; c->name; c++) {
2022 if (c->help)
2023 a_info(a, "%s", c->name, "*%s", c->help, A_END);
e04c2d50 2024 else
f43df819
MW
2025 a_info(a, "%s", c->name, A_END);
2026 }
3cdc3f3a 2027 a_ok(a);
410c8acf 2028}
2029
2030/*----- Connection handling -----------------------------------------------*/
2031
c511e1f9 2032/* --- @a_destroypending@ --- *
410c8acf 2033 *
c511e1f9 2034 * Arguments: ---
fd3cf232 2035 *
2036 * Returns: ---
2037 *
c511e1f9 2038 * Use: Destroys pending admin connections at a safe time.
fd3cf232 2039 */
2040
c511e1f9 2041static void a_destroypending(void)
410c8acf 2042{
94593d1b 2043 admin *a, *aa, *head;
de014da6 2044 admin_bgop *bg, *bbg;
be6a1b7a 2045 admin_service *svc, *ssvc;
de014da6 2046
94593d1b
MW
2047 /* --- Destroy connections marked as pending --- *
2048 *
2049 * Slightly messy. Killing clients may cause others to finally die. Make
2050 * sure that they can be put on the list without clobbering anything or
2051 * getting lost.
2052 */
fd3cf232 2053
94593d1b
MW
2054 while (a_dead) {
2055 head = a_dead;
2056 a_dead = 0;
2057 for (a = head; a; a = aa) {
2058 aa = a->next;
2059 assert(a->f & AF_DEAD);
c511e1f9 2060
94593d1b 2061 /* --- Report what we're doing --- */
c511e1f9 2062
94593d1b
MW
2063 T( trace(T_ADMIN, "admin: completing destruction of connection %u",
2064 a->seq); )
c511e1f9 2065
94593d1b 2066 /* --- If this is the foreground client then shut down --- */
46dde080 2067
94593d1b
MW
2068 if (a->f & AF_FOREGROUND) {
2069 T( trace(T_ADMIN, "admin: foreground client quit: shutting down"); )
2070 a_warn("SERVER", "quit", "foreground-eof", A_END);
2071 a_quit();
2072 }
46dde080 2073
94593d1b 2074 /* --- Abort any background jobs in progress --- */
c511e1f9 2075
94593d1b
MW
2076 for (bg = a->bg; bg; bg = bbg) {
2077 bbg = bg->next;
2078 bg->cancel(bg);
2079 if (bg->tag) xfree(bg->tag);
2080 xfree(bg);
2081 }
c511e1f9 2082
94593d1b 2083 /* --- Release services I hold, and abort pending jobs --- */
be6a1b7a 2084
94593d1b
MW
2085 for (svc = a->svcs; svc; svc = ssvc) {
2086 ssvc = svc->next;
2087 a_svcrelease(svc);
2088 }
2089 a_jobtablefinal(&a->j);
be6a1b7a 2090
94593d1b 2091 /* --- Close file descriptors and selectory --- */
c511e1f9 2092
94593d1b
MW
2093 selbuf_destroy(&a->b);
2094 if (a->b.reader.fd != a->w.fd) close(a->b.reader.fd);
2095 close(a->w.fd);
2096 if (a_stdin == a) a_stdin = 0;
c511e1f9 2097
94593d1b 2098 /* --- Done --- */
c511e1f9 2099
94593d1b
MW
2100 DESTROY(a);
2101 }
410c8acf 2102 }
060ca767 2103}
2104
fd3cf232 2105/* --- @a_destroy@ --- *
2106 *
2107 * Arguments: @admin *a@ = pointer to an admin block
2108 *
2109 * Returns: ---
2110 *
2111 * Use: Destroys an admin block. This requires a certain amount of
2112 * care.
2113 */
2114
de014da6 2115static void freequeue(oqueue *q)
2116{
2117 obuf *o, *oo;
2118
2119 for (o = q->hd; o; o = oo) {
2120 oo = o->next;
2121 xfree(o);
2122 }
2123 q->hd = q->tl = 0;
2124}
2125
fd3cf232 2126static void a_destroy(admin *a)
2127{
fd3cf232 2128 if (a->f & AF_DEAD)
2129 return;
2130
c511e1f9
MW
2131 if (a->next) a->next->prev = a->prev;
2132 if (a->prev) a->prev->next = a->next;
2133 else admins = a->next;
fd3cf232 2134
c511e1f9 2135 if (a->out.hd) sel_rmfile(&a->w);
de014da6 2136 freequeue(&a->out);
fd3cf232 2137
c511e1f9
MW
2138 a->f |= AF_DEAD;
2139 a->next = a_dead;
2140 a_dead = a;
fd3cf232 2141
c511e1f9 2142 T( trace(T_ADMIN, "admin: killing connection %u", a->seq); )
fd3cf232 2143}
2144
410c8acf 2145/* --- @a_line@ --- *
2146 *
2147 * Arguments: @char *p@ = pointer to the line read
3008eabf 2148 * @size_t len@ = length of the line
410c8acf 2149 * @void *vp@ = pointer to my admin block
2150 *
2151 * Returns: ---
2152 *
2153 * Use: Handles a line of input.
2154 */
2155
3008eabf 2156static void a_line(char *p, size_t len, void *vp)
410c8acf 2157{
2158 admin *a = vp;
2159 const acmd *c;
6f88042a 2160 char *av[16 + 1];
410c8acf 2161 size_t ac;
2162
f4c9c08f 2163 QUICKRAND;
fd3cf232 2164 if (a->f & AF_DEAD)
2165 return;
410c8acf 2166 if (!p) {
de014da6 2167 if (!a->bg)
2168 a_destroy(a);
2169 else {
2170 a->f |= AF_CLOSE;
2171 selbuf_disable(&a->b);
2172 }
410c8acf 2173 return;
2174 }
6f88042a 2175 ac = str_qsplit(p, av, N(av) - 1, 0, STRF_QUOTE);
410c8acf 2176 if (!ac)
2177 return;
6f88042a 2178 av[ac] = 0;
410c8acf 2179 for (c = acmdtab; c->name; c++) {
3cdc3f3a 2180 if (mystrieq(av[0], c->name)) {
410c8acf 2181 ac--;
f43df819
MW
2182 if (c->argmin > ac || ac > c->argmax) {
2183 if (!c->help)
2184 a_fail(a, "bad-syntax", "%s", c->name, "", A_END);
e04c2d50 2185 else
f43df819 2186 a_fail(a, "bad-syntax", "%s", c->name, "%s", c->help, A_END);
c511e1f9 2187 } else
410c8acf 2188 c->func(a, ac, av + 1);
2189 return;
2190 }
2191 }
f43df819 2192 a_fail(a, "unknown-command", "%s", av[0], A_END);
410c8acf 2193}
2194
2195/* --- @a_create@ --- *
2196 *
2197 * Arguments: @int fd_in, fd_out@ = file descriptors to use
3cdc3f3a 2198 * @unsigned f@ = initial flags to set
410c8acf 2199 *
2200 * Returns: ---
2201 *
2202 * Use: Creates a new admin connection.
2203 */
2204
3cdc3f3a 2205void a_create(int fd_in, int fd_out, unsigned f)
410c8acf 2206{
2207 admin *a = CREATE(admin);
3cdc3f3a 2208
93bee2c4 2209 T( static unsigned seq = 0;
2210 a->seq = seq++; )
410c8acf 2211 T( trace(T_ADMIN, "admin: accepted connection %u", a->seq); )
de014da6 2212 a->bg = 0;
042d5c20 2213 a->ref = 0;
be6a1b7a 2214 a->svcs = 0;
5d46c0f8 2215 a_jobtableinit(&a->j);
3cdc3f3a 2216 a->f = f;
de014da6 2217 if (fd_in == STDIN_FILENO) a_stdin = a;
fd3cf232 2218 fdflags(fd_in, O_NONBLOCK, O_NONBLOCK, FD_CLOEXEC, FD_CLOEXEC);
410c8acf 2219 if (fd_out != fd_in)
fd3cf232 2220 fdflags(fd_out, O_NONBLOCK, O_NONBLOCK, FD_CLOEXEC, FD_CLOEXEC);
410c8acf 2221 selbuf_init(&a->b, &sel, fd_in, a_line, a);
fd3cf232 2222 sel_initfile(&sel, &a->w, fd_out, SEL_WRITE, a_flush, a);
de014da6 2223 a->out.hd = a->out.tl = 0;
410c8acf 2224 a->next = admins;
2225 a->prev = 0;
de014da6 2226 if (admins) admins->prev = a;
410c8acf 2227 admins = a;
2228}
2229
2230/* --- @a_accept@ --- *
2231 *
2232 * Arguments: @int fd@ = file descriptor to accept
2233 * @unsigned mode@ = what to do
2234 * @void *v@ = uninteresting pointer
2235 *
2236 * Returns: ---
2237 *
2238 * Use: Accepts a new admin connection.
2239 */
2240
2241static void a_accept(int fd, unsigned mode, void *v)
2242{
2243 int nfd;
2244 struct sockaddr_un sun;
cb160b86 2245 socklen_t sz = sizeof(sun);
410c8acf 2246
2247 if ((nfd = accept(fd, (struct sockaddr *)&sun, &sz)) < 0) {
1ecee057 2248 if (errno != EINTR && errno != EAGAIN && errno != EWOULDBLOCK &&
2249 errno != ECONNABORTED && errno != EPROTO)
f43df819 2250 a_warn("ADMIN", "accept-error", "?ERRNO", A_END);
410c8acf 2251 return;
2252 }
3cdc3f3a 2253 a_create(nfd, nfd, 0);
410c8acf 2254}
2255
c511e1f9
MW
2256/* --- @a_preselect@ --- *
2257 *
2258 * Arguments: ---
2259 *
2260 * Returns: ---
2261 *
2262 * Use: Informs the admin module that we're about to select again,
2263 * and that it should do cleanup things it has delayed until a
2264 * `safe' time.
2265 */
2266
2267void a_preselect(void) { if (a_dead) a_destroypending(); }
2268
410c8acf 2269/* --- @a_daemon@ --- *
2270 *
2271 * Arguments: ---
2272 *
2273 * Returns: ---
2274 *
2275 * Use: Informs the admin module that it's a daemon.
2276 */
2277
f98df549 2278void a_daemon(void) { flags |= F_DAEMON; }
410c8acf 2279
2280/* --- @a_init@ --- *
2281 *
2282 * Arguments: @const char *name@ = socket name to create
aa2405e8
MW
2283 * @uid_t u@ = user to own the socket
2284 * @gid_t g@ = group to own the socket
a9279e37 2285 * @mode_t m@ = permissions to set on the socket
410c8acf 2286 *
2287 * Returns: ---
2288 *
2289 * Use: Creates the admin listening socket.
2290 */
2291
a9279e37 2292void a_init(const char *name, uid_t u, gid_t g, mode_t m)
410c8acf 2293{
2294 int fd;
2295 int n = 5;
2296 struct sockaddr_un sun;
2297 struct sigaction sa;
2298 size_t sz;
879483d7 2299 mode_t omask;
410c8acf 2300
be6a1b7a
MW
2301 /* --- Create services table --- */
2302
2303 sym_create(&a_svcs);
2304
410c8acf 2305 /* --- Set up the socket address --- */
2306
2307 sz = strlen(name) + 1;
2308 if (sz > sizeof(sun.sun_path))
2309 die(EXIT_FAILURE, "socket name `%s' too long", name);
2310 BURN(sun);
2311 sun.sun_family = AF_UNIX;
2312 memcpy(sun.sun_path, name, sz);
2313 sz += offsetof(struct sockaddr_un, sun_path);
2314
2315 /* --- Attempt to bind to the socket --- */
2316
879483d7 2317 omask = umask(0077);
410c8acf 2318again:
2319 if ((fd = socket(PF_UNIX, SOCK_STREAM, 0)) < 0)
2320 die(EXIT_FAILURE, "couldn't create socket: %s", strerror(errno));
2321 if (bind(fd, (struct sockaddr *)&sun, sz) < 0) {
2322 struct stat st;
2323 int e = errno;
2324 if (errno != EADDRINUSE) {
2325 die(EXIT_FAILURE, "couldn't bind to address `%s': %s",
2326 sun.sun_path, strerror(e));
2327 }
2328 if (!n)
2329 die(EXIT_FAILURE, "too many retries; giving up");
2330 n--;
2331 if (!connect(fd, (struct sockaddr *)&sun, sz)) {
2332 die(EXIT_FAILURE, "server already listening on admin socket `%s'",
2333 sun.sun_path);
2334 }
2335 if (errno != ECONNREFUSED)
2336 die(EXIT_FAILURE, "couldn't bind to address: %s", strerror(e));
2337 if (stat(sun.sun_path, &st)) {
2338 die(EXIT_FAILURE, "couldn't stat `%s': %s",
2339 sun.sun_path, strerror(errno));
2340 }
2341 if (!S_ISSOCK(st.st_mode))
2342 die(EXIT_FAILURE, "object `%s' isn't a socket", sun.sun_path);
c7053da9 2343 T( trace(T_ADMIN, "admin: stale socket found; removing it"); )
410c8acf 2344 unlink(sun.sun_path);
2345 close(fd);
2346 goto again;
2347 }
aa2405e8 2348 if (chown(sun.sun_path, u, g)) {
9e0161ce
MW
2349 die(EXIT_FAILURE, "failed to set socket owner: %s",
2350 strerror(errno));
aa2405e8 2351 }
a9279e37
MW
2352 if (chmod(sun.sun_path, m)) {
2353 die(EXIT_FAILURE, "failed to set socket permissions: %s",
2354 strerror(errno));
2355 }
879483d7 2356 umask(omask);
410c8acf 2357 fdflags(fd, O_NONBLOCK, O_NONBLOCK, FD_CLOEXEC, FD_CLOEXEC);
2358 if (listen(fd, 5))
2359 die(EXIT_FAILURE, "couldn't listen on socket: %s", strerror(errno));
2360
2361 /* --- Listen to the socket --- */
2362
2363 sel_initfile(&sel, &sock, fd, SEL_READ, a_accept, 0);
2364 sel_addfile(&sock);
2365 sockname = name;
2366 bres_init(&sel);
2367 T( trace_custom(a_trace, 0);
2368 trace(T_ADMIN, "admin: enabled custom tracing"); )
2369 flags |= F_INIT;
2370
2371 /* --- Set up signal handlers --- */
2372
2373 sig_add(&s_term, SIGTERM, a_sigdie, 0);
2374 sig_add(&s_hup, SIGHUP, a_sighup, 0);
2375 sigaction(SIGINT, 0, &sa);
2376 if (sa.sa_handler != SIG_IGN)
2377 sig_add(&s_int, SIGINT, a_sigdie, 0);
2378}
2379
2380/*----- That's all, folks -------------------------------------------------*/