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