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