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