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