3b99848c74473a8689943c1d811894b55753a815
[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 xfree(add->peer.name);
1239 }
1240
1241 /* --- @acmd_add@ --- *
1242 *
1243 * Arguments: @admin *a@ = connection which requested the addition
1244 * @unsigned ac@ = argument count
1245 * @char *av[]@ = pointer to the argument list
1246 *
1247 * Returns: ---
1248 *
1249 * Use: Adds a new peer.
1250 */
1251
1252 static void acmd_add(admin *a, unsigned ac, char *av[])
1253 {
1254 const char *tag = 0;
1255 admin_addop *add;
1256
1257 /* --- Set stuff up --- */
1258
1259 add = xmalloc(sizeof(*add));
1260 add->peer.name = 0;
1261 add->peer.tag = 0;
1262 add->peer.privtag = 0;
1263 add->peer.t_ka = 0;
1264 add->peer.tops = tun_default;
1265 add->peer.f = 0;
1266
1267 /* --- Parse options --- */
1268
1269 OPTIONS(ac, av, {
1270 OPTARG("-background", arg, { tag = arg; })
1271 OPTARG("-tunnel", arg, {
1272 unsigned i;
1273 for (i = 0;; i++) {
1274 if (!tunnels[i]) {
1275 a_fail(a, "unknown-tunnel", "%s", arg, A_END);
1276 goto fail;
1277 }
1278 if (mystrieq(arg, tunnels[i]->name)) {
1279 add->peer.tops = tunnels[i];
1280 break;
1281 }
1282 }
1283 })
1284 OPTTIME("-keepalive", t, { add->peer.t_ka = t; })
1285 OPT("-cork", { add->peer.f |= KXF_CORK; })
1286 OPTARG("-key", arg, {
1287 if (add->peer.tag) xfree(add->peer.tag);
1288 add->peer.tag = xstrdup(arg);
1289 })
1290 OPT("-mobile", { add->peer.f |= PSF_MOBILE; })
1291 OPTARG("-priv", arg, {
1292 if (add->peer.privtag) xfree(add->peer.privtag);
1293 add->peer.privtag = xstrdup(arg);
1294 })
1295 });
1296
1297 /* --- Make sure someone's not got there already --- */
1298
1299 if (!av[0] || !av[1])
1300 goto bad_syntax;
1301 if (p_find(*av)) {
1302 a_fail(a, "peer-exists", "%s", *av, A_END);
1303 goto fail;
1304 }
1305 add->peer.name = xstrdup(*av++);
1306 ac--;
1307
1308 /* --- Crank up the resolver --- */
1309
1310 a_resolve(a, &add->r, tag, a_doadd, ac, av);
1311 return;
1312
1313 /* --- Clearing up --- */
1314
1315 bad_syntax:
1316 a_fail(a, "bad-syntax", "add", "[OPTIONS] PEER ADDR ...", A_END);
1317 fail:
1318 if (add->peer.name) xfree(add->peer.name);
1319 if (add->peer.tag) xfree(add->peer.tag);
1320 if (add->peer.privtag) xfree(add->peer.privtag);
1321 xfree(add);
1322 return;
1323 }
1324
1325 /*----- Ping --------------------------------------------------------------*/
1326
1327 /* --- @a_pingcancel@ --- *
1328 *
1329 * Arguments: @admin_bgop *bg@ = background operation block
1330 *
1331 * Returns: ---
1332 *
1333 * Use: Cancels a running ping.
1334 */
1335
1336 static void a_pingcancel(admin_bgop *bg)
1337 {
1338 admin_pingop *pg = (admin_pingop *)bg;
1339 T( trace(T_ADMIN, "admin: cancel ping op %s", BGTAG(pg)); )
1340 p_pingdone(&pg->ping, PING_NONOTIFY);
1341 }
1342
1343 /* --- @a_pong@ --- *
1344 *
1345 * Arguments: @int rc@ = return code
1346 * @void *v@ = ping operation block
1347 *
1348 * Returns: ---
1349 *
1350 * Use: Collects what happened to a ping message.
1351 */
1352
1353 static void a_pong(int rc, void *v)
1354 {
1355 admin_pingop *pg = v;
1356 struct timeval tv;
1357 double millis;
1358
1359 switch (rc) {
1360 case PING_OK:
1361 gettimeofday(&tv, 0);
1362 tv_sub(&tv, &tv, &pg->pingtime);
1363 millis = (double)tv.tv_sec * 1000 + (double)tv.tv_usec/1000;
1364 a_bginfo(&pg->bg, "ping-ok", "%.1f", millis, A_END);
1365 a_bgok(&pg->bg);
1366 break;
1367 case PING_TIMEOUT:
1368 a_bginfo(&pg->bg, "ping-timeout", A_END);
1369 a_bgok(&pg->bg);
1370 break;
1371 case PING_PEERDIED:
1372 a_bginfo(&pg->bg, "ping-peer-died", A_END);
1373 a_bgok(&pg->bg);
1374 break;
1375 default:
1376 abort();
1377 }
1378 T( trace(T_ADMIN, "admin: ponged ping op %s", BGTAG(pg)); )
1379 a_bgrelease(&pg->bg);
1380 }
1381
1382 /* --- @acmd_ping@, @acmd_eping@ --- *
1383 *
1384 * Arguments: @admin *a@ = connection which requested the ping
1385 * @unsigned ac@ = argument count
1386 * @char *av[]@ = pointer to the argument list
1387 *
1388 * Returns: ---
1389 *
1390 * Use: Pings a peer.
1391 */
1392
1393 static void a_ping(admin *a, unsigned ac, char *av[],
1394 const char *cmd, unsigned msg)
1395 {
1396 long t = T_PING;
1397 peer *p;
1398 admin_pingop *pg = 0;
1399 const char *tag = 0;
1400
1401 OPTIONS(ac, av, {
1402 OPTARG("-background", arg, { tag = arg; })
1403 OPTTIME("-timeout", arg, { t = arg; })
1404 });
1405 if (!*av || av[1]) goto bad_syntax;
1406 if ((p = a_findpeer(a, *av)) == 0)
1407 return;
1408 pg = xmalloc(sizeof(*pg));
1409 gettimeofday(&pg->pingtime, 0);
1410 if (a_bgadd(a, &pg->bg, tag, a_pingcancel))
1411 goto fail;
1412 T( trace(T_ADMIN, "admin: ping op %s: %s to %s",
1413 BGTAG(pg), cmd, p_name(p)); )
1414 if (p_pingsend(p, &pg->ping, msg, t, a_pong, pg)) {
1415 a_bgfail(&pg->bg, "ping-send-failed", A_END);
1416 a_bgrelease(&pg->bg);
1417 }
1418 return;
1419
1420 bad_syntax:
1421 a_fail(a, "bad-syntax", "%s", cmd, "[OPTIONS] PEER", cmd, A_END);
1422 fail:
1423 if (pg) xfree(pg);
1424 return;
1425 }
1426
1427 static void acmd_ping(admin *a, unsigned ac, char *av[])
1428 { a_ping(a, ac, av, "ping", MISC_PING); }
1429 static void acmd_eping(admin *a, unsigned ac, char *av[])
1430 { a_ping(a, ac, av, "eping", MISC_EPING); }
1431
1432 /*----- Service commands --------------------------------------------------*/
1433
1434 static void acmd_svcclaim(admin *a, unsigned ac, char *av[])
1435 {
1436 admin_service *svc;
1437 unsigned f;
1438
1439 svc = sym_find(&a_svcs, av[0], -1, sizeof(*svc), &f);
1440 if (f) {
1441 if (versioncmp(av[1], svc->version) <= 0) {
1442 a_fail(a,
1443 "service-exists",
1444 "%s", SYM_NAME(svc),
1445 "%s", svc->version,
1446 A_END);
1447 return;
1448 }
1449 a_write(svc->prov, "SVCCLAIM", 0, "%s", av[0], "%s", av[1], A_END);
1450 a_svcunlink(svc);
1451 }
1452 svc->prov = a;
1453 svc->version = xstrdup(av[1]);
1454 svc->next = a->svcs;
1455 svc->prev = 0;
1456 if (a->svcs) a->svcs->prev = svc;
1457 a->svcs = svc;
1458 a_notify("SVCCLAIM", "%s", SYM_NAME(svc), "%s", svc->version, A_END);
1459 a_ok(a);
1460 }
1461
1462 static void acmd_svcrelease(admin *a, unsigned ac, char *av[])
1463 {
1464 admin_service *svc;
1465
1466 if ((svc = a_svcfind(a, av[0])) == 0)
1467 return;
1468 if (svc->prov != a) {
1469 a_fail(a, "not-service-provider", "%s", SYM_NAME(svc), A_END);
1470 return;
1471 }
1472 a_svcrelease(svc);
1473 a_ok(a);
1474 }
1475
1476 static void acmd_svcensure(admin *a, unsigned ac, char *av[])
1477 {
1478 admin_service *svc;
1479
1480 if ((svc = a_svcfind(a, av[0])) == 0)
1481 return;
1482 if (av[1] && versioncmp(svc->version, av[1]) < 0) {
1483 a_fail(a, "service-too-old",
1484 "%s", SYM_NAME(svc),
1485 "%s", svc->version,
1486 A_END);
1487 return;
1488 }
1489 a_ok(a);
1490 }
1491
1492 static void acmd_svcquery(admin *a, unsigned ac, char *av[])
1493 {
1494 admin_service *svc;
1495
1496 if ((svc = a_svcfind(a, av[0])) != 0) {
1497 a_info(a, "name=%s", SYM_NAME(svc), "version=%s", svc->version, A_END);
1498 a_ok(a);
1499 }
1500 }
1501
1502 static void acmd_svclist(admin *a, unsigned ac, char *av[])
1503 {
1504 admin_service *svc;
1505 sym_iter i;
1506
1507 for (sym_mkiter(&i, &a_svcs); (svc = sym_next(&i)) != 0; )
1508 a_info(a, "%s", SYM_NAME(svc), "%s", svc->version, A_END);
1509 a_ok(a);
1510 }
1511
1512 static void a_canceljob(admin_bgop *bg)
1513 {
1514 admin_svcop *svc = (admin_svcop *)bg;
1515
1516 a_write(svc->prov, "SVCCANCEL", 0, "%s", a_jobidencode(svc), A_END);
1517 a_jobdestroy(svc);
1518 }
1519
1520 static void acmd_svcsubmit(admin *a, unsigned ac, char *av[])
1521 {
1522 const char *tag = 0;
1523 admin_service *svc;
1524 admin_svcop *svcop;
1525 const char *ver = 0;
1526 dstr d = DSTR_INIT;
1527
1528 OPTIONS(ac, av, {
1529 OPTARG("-background", arg, { tag = arg; })
1530 OPTARG("-version", arg, { ver = arg; })
1531 });
1532 if (!*av) goto bad_syntax;
1533 if ((svc = a_svcfind(a, *av)) == 0) goto fail;
1534 if (ver && versioncmp(svc->version, ver) < 0) {
1535 a_fail(a, "service-too-old",
1536 "%s", SYM_NAME(svc),
1537 "%s", svc->version,
1538 A_END);
1539 goto fail;
1540 }
1541 if ((svcop = a_jobcreate(svc->prov)) == 0) {
1542 a_fail(a, "provider-overloaded", A_END);
1543 goto fail;
1544 }
1545 if (a_bgadd(a, &svcop->bg, tag, a_canceljob)) {
1546 a_jobdestroy(svcop);
1547 goto fail;
1548 }
1549 a_write(svc->prov, "SVCJOB", 0,
1550 "%s", a_jobidencode(svcop),
1551 "?TOKENS", av,
1552 A_END);
1553 goto done;
1554
1555 bad_syntax:
1556 a_fail(a, "bad-syntax", "svcsubmit", "[OPTIONS] SERVICE ARGS...", A_END);
1557 fail:
1558 done:
1559 dstr_destroy(&d);
1560 return;
1561 }
1562
1563 static void a_replycmd(admin *a, const char *status, int donep, char *av[])
1564 {
1565 admin_svcop *svc;
1566
1567 if ((svc = a_jobiddecode(&a->j, av[0])) == 0) {
1568 a_fail(a, "unknown-jobid", av[0], A_END);
1569 return;
1570 }
1571 a_write(svc->bg.a, status, svc->bg.tag, "?TOKENS", av + 1, A_END);
1572 if (donep) {
1573 a_jobdestroy(svc);
1574 a_bgrelease(&svc->bg);
1575 }
1576 a_ok(a);
1577 }
1578
1579 static void acmd_svcok(admin *a, unsigned ac, char *av[])
1580 { a_replycmd(a, "OK", 1, av); }
1581 static void acmd_svcinfo(admin *a, unsigned ac, char *av[])
1582 { a_replycmd(a, "INFO", 0, av); }
1583 static void acmd_svcfail(admin *a, unsigned ac, char *av[])
1584 { a_replycmd(a, "FAIL", 1, av); }
1585
1586 /*----- Administration commands -------------------------------------------*/
1587
1588 /* --- Miscellaneous commands --- */
1589
1590 /* --- @traceish@ --- *
1591 *
1592 * Arguments: @admin *a@ = connection to complain on
1593 * @unsigned ac@ = number of arguments
1594 * @char *av[]@ = vector of arguments
1595 * @const char *what@ = what we're messing with
1596 * @const trace_opt *tt@ = options table
1597 * @unsigned *ff@ = where the flags are
1598 *
1599 * Returns: Nonzero if anything changed.
1600 *
1601 * Use: Guts of trace-ish commands like `trace' and `watch'.
1602 */
1603
1604 static int traceish(admin *a, unsigned ac, char *av[],
1605 const char *what, const trace_opt *tt, unsigned *ff)
1606 {
1607 int ch = 0;
1608
1609 if (!ac || strcmp(av[0], "?") == 0) {
1610 const trace_opt *t;
1611 for (t = tt; t->ch; t++) {
1612 a_info(a, "*%c%c %s",
1613 t->ch, (*ff & t->f) == t->f ? '+' : ' ', t->help, A_END);
1614 }
1615 } else {
1616 unsigned sense = 1;
1617 unsigned f = *ff;
1618 const trace_opt *t;
1619 char *p = av[0];
1620
1621 while (*p) {
1622 switch (*p) {
1623 case '+': sense = 1; break;
1624 case '-': sense = 0; break;
1625 default:
1626 for (t = tt; t->ch; t++) {
1627 if (t->ch == *p) {
1628 if (sense) f |= t->f;
1629 else f &= ~t->f;
1630 goto tropt_ok;
1631 }
1632 }
1633 a_fail(a, "bad-%s-option", what, "%c", *p, A_END);
1634 return (0);
1635 tropt_ok:;
1636 break;
1637 }
1638 p++;
1639 }
1640 *ff = f;
1641 ch = 1;
1642 }
1643 a_ok(a);
1644 return (ch);
1645 }
1646
1647 #ifndef NTRACE
1648
1649 static void acmd_trace(admin *a, unsigned ac, char *av[])
1650 {
1651 if (traceish(a, ac, av, "trace", tr_opts, &tr_flags))
1652 trace_level(tr_flags);
1653 }
1654
1655 #endif
1656
1657 static void acmd_watch(admin *a, unsigned ac, char *av[])
1658 { traceish(a, ac, av, "watch", w_opts, &a->f); }
1659
1660 static void alertcmd(admin *a, unsigned f_and, unsigned f_eq,
1661 const char *status, char *av[])
1662 { a_alert(f_and, f_eq, status, "USER", "?TOKENS", av, A_END); a_ok(a); }
1663 static void acmd_notify(admin *a, unsigned ac, char *av[])
1664 { alertcmd(a, AF_NOTE, AF_NOTE, "NOTE", av); }
1665 static void acmd_warn(admin *a, unsigned ac, char *av[])
1666 { alertcmd(a, AF_WARN, AF_WARN, "WARN", av); }
1667
1668 static void acmd_port(admin *a, unsigned ac, char *av[])
1669 {
1670 int i;
1671
1672 if (ac) {
1673 for (i = 0; i < NADDRFAM; i++)
1674 if (mystrieq(av[0], aftab[i].name)) goto found;
1675 a_fail(a, "unknown-address-family", "%s", av[0], A_END);
1676 return;
1677 found:
1678 assert(udpsock[i].fd >= 0);
1679 } else {
1680 for (i = 0; i < NADDRFAM; i++)
1681 if (udpsock[i].fd >= 0) goto found;
1682 abort();
1683 }
1684 a_info(a, "%u", p_port(i), A_END);
1685 a_ok(a);
1686 }
1687
1688 static void acmd_daemon(admin *a, unsigned ac, char *av[])
1689 {
1690 if (flags & F_DAEMON)
1691 a_fail(a, "already-daemon", A_END);
1692 else {
1693 a_notify("DAEMON", A_END);
1694 if (a_stdin)
1695 a_destroy(a_stdin);
1696 if (daemonize())
1697 a_fail(a, "daemon-error", "?ERRNO", A_END);
1698 else {
1699 flags |= F_DAEMON;
1700 a_ok(a);
1701 }
1702 }
1703 }
1704
1705 static void acmd_jobs(admin *a, unsigned ac, char *av[])
1706 {
1707 admin_bgop *bg;
1708
1709 for (bg = a->bg; bg; bg = bg->next) {
1710 assert(bg->tag);
1711 a_info(a, "%s", bg->tag, A_END);
1712 }
1713 a_ok(a);
1714 }
1715
1716 static void acmd_bgcancel(admin *a, unsigned ac, char *av[])
1717 {
1718 admin_bgop *bg;
1719
1720 if ((bg = a_bgfind(a, av[0])) == 0)
1721 a_fail(a, "unknown-tag", "%s", av[0], A_END);
1722 else {
1723 bg->cancel(bg);
1724 a_bgrelease(bg);
1725 a_ok(a);
1726 }
1727 }
1728
1729 static void acmd_algs(admin *a, unsigned ac, char *av[])
1730 {
1731 peer *p;
1732 const kdata *kd;
1733 const dhgrp *g;
1734 const algswitch *algs;
1735
1736 if (!ac)
1737 kd = master;
1738 else {
1739 if ((p = a_findpeer(a, av[0])) == 0) return;
1740 kd = p->kx.kpriv;
1741 }
1742 g = kd->grp;
1743 algs = &kd->algs;
1744
1745 g->ops->grpinfo(g, a);
1746 a_info(a,
1747 "hash=%s", algs->h->name,
1748 "mgf=%s", algs->mgf->name,
1749 "hash-sz=%lu", (unsigned long)algs->h->hashsz,
1750 A_END);
1751 a_info(a,
1752 "bulk-transform=%s", algs->bulk->ops->name,
1753 "bulk-overhead=%lu",
1754 (unsigned long)algs->bulk->ops->overhead(algs->bulk),
1755 A_END);
1756 algs->bulk->ops->alginfo(algs->bulk, a);
1757 a_info(a,
1758 "cipher-data-limit=%lu",
1759 (unsigned long)algs->bulk->ops->expsz(algs->bulk),
1760 A_END);
1761 a_ok(a);
1762 }
1763
1764 static void acmd_list(admin *a, unsigned ac, char *av[])
1765 {
1766 FOREACH_PEER(p, { a_info(a, "%s", p_name(p), A_END); });
1767 a_ok(a);
1768 }
1769
1770 static void acmd_ifname(admin *a, unsigned ac, char *av[])
1771 {
1772 peer *p;
1773
1774 if ((p = a_findpeer(a, av[0])) != 0) {
1775 a_info(a, "%s", p_ifname(p), A_END);
1776 a_ok(a);
1777 }
1778 }
1779
1780 static void acmd_setifname(admin *a, unsigned ac, char *av[])
1781 {
1782 peer *p;
1783
1784 if ((p = a_findpeer(a, av[0])) != 0) {
1785 a_notify("NEWIFNAME", "?PEER", p, "%s", p_ifname(p), "%s", av[1], A_END);
1786 p_setifname(p, av[1]);
1787 a_ok(a);
1788 }
1789 }
1790
1791 static void acmd_getchal(admin *a, unsigned ac, char *av[])
1792 {
1793 buf b;
1794
1795 buf_init(&b, buf_i, PKBUFSZ);
1796 c_new(&b);
1797 a_info(a, "?B64", BBASE(&b), (size_t)BLEN(&b), A_END);
1798 a_ok(a);
1799 }
1800
1801 static void acmd_checkchal(admin *a, unsigned ac, char *av[])
1802 {
1803 codec *b64 = base64_class.decoder(CDCF_NOEQPAD);
1804 int err;
1805 buf b;
1806 dstr d = DSTR_INIT;
1807
1808 if ((err = b64->ops->code(b64, av[0], strlen(av[0]), &d)) != 0 ||
1809 (err = b64->ops->code(b64, 0, 0, &d)) != 0)
1810 a_fail(a, "bad-base64", "%s", codec_strerror(err), A_END);
1811 else {
1812 buf_init(&b, d.buf, d.len);
1813 if (c_check(&b) || BBAD(&b) || BLEFT(&b))
1814 a_fail(a, "invalid-challenge", A_END);
1815 else
1816 a_ok(a);
1817 }
1818 b64->ops->destroy(b64);
1819 dstr_destroy(&d);
1820 }
1821
1822 static void acmd_greet(admin *a, unsigned ac, char *av[])
1823 {
1824 peer *p;
1825 int err;
1826 codec *b64;
1827 dstr d = DSTR_INIT;
1828
1829 if ((p = a_findpeer(a, av[0])) == 0) return;
1830 b64 = base64_class.decoder(CDCF_NOEQPAD);
1831 if ((err = b64->ops->code(b64, av[1], strlen(av[1]), &d)) != 0 ||
1832 (err = b64->ops->code(b64, 0, 0, &d)) != 0)
1833 a_fail(a, "bad-base64", "%s", codec_strerror(err), A_END);
1834 else {
1835 p_greet(p, d.buf, d.len);
1836 a_ok(a);
1837 }
1838 b64->ops->destroy(b64);
1839 dstr_destroy(&d);
1840 }
1841
1842 static void acmd_addr(admin *a, unsigned ac, char *av[])
1843 {
1844 peer *p;
1845 const addr *ad;
1846
1847 if ((p = a_findpeer(a, av[0])) != 0) {
1848 ad = p_addr(p);
1849 assert(ad->sa.sa_family == AF_INET);
1850 a_info(a, "?ADDR", ad, A_END);
1851 a_ok(a);
1852 }
1853 }
1854
1855 static void acmd_peerinfo(admin *a, unsigned ac, char *av[])
1856 {
1857 peer *p;
1858 const peerspec *ps;
1859 const char *ptag;
1860
1861 if ((p = a_findpeer(a, av[0])) != 0) {
1862 ps = p_spec(p);
1863 a_info(a, "tunnel=%s", ps->tops->name, A_END);
1864 a_info(a, "key=%s", p_tag(p),
1865 "current-key=%s", p->kx.kpub->tag, A_END);
1866 if ((ptag = p_privtag(p)) == 0) ptag = "(default)";
1867 a_info(a, "private-key=%s", ptag,
1868 "current-private-key=%s", p->kx.kpriv->tag, A_END);
1869 a_info(a, "keepalive=%lu", ps->t_ka, A_END);
1870 a_info(a, "corked=%s", BOOL(p->kx.f&KXF_CORK),
1871 "mobile=%s", BOOL(ps->f&PSF_MOBILE),
1872 A_END);
1873 a_ok(a);
1874 }
1875 }
1876
1877 static void acmd_servinfo(admin *a, unsigned ac, char *av[])
1878 {
1879 a_info(a, "implementation=edgeware-tripe", A_END);
1880 a_info(a, "version=%s", VERSION, A_END);
1881 a_info(a, "daemon=%s", BOOL(flags & F_DAEMON), A_END);
1882 a_ok(a);
1883 }
1884
1885 static void acmd_stats(admin *a, unsigned ac, char *av[])
1886 {
1887 peer *p;
1888 stats *st;
1889
1890 if ((p = a_findpeer(a, av[0])) == 0)
1891 return;
1892
1893 st = p_stats(p);
1894 a_info(a, "start-time=%s", timestr(st->t_start), A_END);
1895 a_info(a, "last-packet-time=%s", timestr(st->t_last), A_END);
1896 a_info(a, "last-keyexch-time=%s", timestr(st->t_kx), A_END);
1897 a_info(a, "packets-in=%lu", st->n_in, "bytes-in=%lu", st->sz_in, A_END);
1898 a_info(a,
1899 "packets-out=%lu", st->n_out,
1900 "bytes-out=%lu", st->sz_out,
1901 A_END);
1902 a_info(a,
1903 "keyexch-packets-in=%lu", st->n_kxin,
1904 "keyexch-bytes-in=%lu", st->sz_kxin,
1905 A_END);
1906 a_info(a,
1907 "keyexch-packets-out=%lu", st->n_kxout,
1908 "keyexch-bytes-out=%lu", st->sz_kxout,
1909 A_END);
1910 a_info(a,
1911 "ip-packets-in=%lu", st->n_ipin,
1912 "ip-bytes-in=%lu", st->sz_ipin,
1913 A_END);
1914 a_info(a,
1915 "ip-packets-out=%lu", st->n_ipout,
1916 "ip-bytes-out=%lu", st->sz_ipout,
1917 A_END);
1918 a_info(a, "rejected-packets=%lu", st->n_reject, A_END);
1919 a_ok(a);
1920 }
1921
1922 static void acmd_kill(admin *a, unsigned ac, char *av[])
1923 {
1924 peer *p;
1925
1926 if ((p = a_findpeer(a, av[0])) != 0) {
1927 p_destroy(p);
1928 a_ok(a);
1929 }
1930 }
1931
1932 static void acmd_forcekx(admin *a, unsigned ac, char *av[])
1933 {
1934 peer *p;
1935
1936 if ((p = a_findpeer(a, av[0])) != 0) {
1937 kx_start(&p->kx, 1);
1938 a_ok(a);
1939 }
1940 }
1941
1942 static void acmd_reload(admin *a, unsigned ac, char *av[])
1943 { p_keyreload(); a_ok(a); }
1944
1945 static void acmd_quit(admin *a, unsigned ac, char *av[])
1946 {
1947 a_warn("SERVER", "quit", "admin-request", A_END);
1948 a_ok(a);
1949 a_quit();
1950 }
1951
1952 static void acmd_version(admin *a, unsigned ac, char *av[])
1953 {
1954 a_info(a, "%s", PACKAGE, "%s", VERSION, A_END);
1955 a_ok(a);
1956 }
1957
1958 static void acmd_tunnels(admin *a, unsigned ac, char *av[])
1959 {
1960 int i;
1961
1962 for (i = 0; tunnels[i]; i++)
1963 a_info(a, "%s", tunnels[i]->name, A_END);
1964 a_ok(a);
1965 }
1966
1967 /* --- The command table and help --- */
1968
1969 typedef struct acmd {
1970 const char *name;
1971 const char *help;
1972 unsigned argmin, argmax;
1973 void (*func)(admin */*a*/, unsigned /*ac*/, char */*av*/[]);
1974 } acmd;
1975
1976 static void acmd_help(admin */*a*/, unsigned /*ac*/, char */*av*/[]);
1977
1978 static const acmd acmdtab[] = {
1979 { "add", "[OPTIONS] PEER ADDR ...", 2, 0xffff, acmd_add },
1980 { "addr", "PEER", 1, 1, acmd_addr },
1981 { "algs", "[PEER]", 0, 1, acmd_algs },
1982 { "bgcancel", "TAG", 1, 1, acmd_bgcancel },
1983 { "checkchal", "CHAL", 1, 1, acmd_checkchal },
1984 { "daemon", 0, 0, 0, acmd_daemon },
1985 { "eping", "[OPTIONS] PEER", 1, 0xffff, acmd_eping },
1986 { "forcekx", "PEER", 1, 1, acmd_forcekx },
1987 { "getchal", 0, 0, 0, acmd_getchal },
1988 { "greet", "PEER CHAL", 2, 2, acmd_greet },
1989 { "help", 0, 0, 0, acmd_help },
1990 { "ifname", "PEER", 1, 1, acmd_ifname },
1991 { "jobs", 0, 0, 0, acmd_jobs },
1992 { "kill", "PEER", 1, 1, acmd_kill },
1993 { "list", 0, 0, 0, acmd_list },
1994 { "notify", "MESSAGE ...", 1, 0xffff, acmd_notify },
1995 { "peerinfo", "PEER", 1, 1, acmd_peerinfo },
1996 { "ping", "[OPTIONS] PEER", 1, 0xffff, acmd_ping },
1997 { "port", "[FAMILY]", 0, 1, acmd_port },
1998 { "quit", 0, 0, 0, acmd_quit },
1999 { "reload", 0, 0, 0, acmd_reload },
2000 { "servinfo", 0, 0, 0, acmd_servinfo },
2001 { "setifname", "PEER NEW-NAME", 2, 2, acmd_setifname },
2002 { "stats", "PEER", 1, 1, acmd_stats },
2003 { "svcclaim", "SERVICE VERSION", 2, 2, acmd_svcclaim },
2004 { "svcensure", "SERVICE [VERSION]", 1, 2, acmd_svcensure },
2005 { "svcfail", "JOBID TOKENS...", 1, 0xffff, acmd_svcfail },
2006 { "svcinfo", "JOBID TOKENS...", 1, 0xffff, acmd_svcinfo },
2007 { "svclist", 0, 0, 0, acmd_svclist },
2008 { "svcok", "JOBID", 1, 1, acmd_svcok },
2009 { "svcquery", "SERVICE", 1, 1, acmd_svcquery },
2010 { "svcrelease", "SERVICE", 1, 1, acmd_svcrelease },
2011 { "svcsubmit", "[OPTIONS] SERVICE TOKENS...",
2012 2, 0xffff, acmd_svcsubmit },
2013 #ifndef NTRACE
2014 { "trace", "[OPTIONS]", 0, 1, acmd_trace },
2015 #endif
2016 { "tunnels", 0, 0, 0, acmd_tunnels },
2017 { "version", 0, 0, 0, acmd_version },
2018 { "warn", "MESSAGE ...", 1, 0xffff, acmd_warn },
2019 { "watch", "[OPTIONS]", 0, 1, acmd_watch },
2020 { 0, 0, 0, 0, 0 }
2021 };
2022
2023 static void acmd_help(admin *a, unsigned ac, char *av[])
2024 {
2025 const acmd *c;
2026
2027 for (c = acmdtab; c->name; c++) {
2028 if (c->help)
2029 a_info(a, "%s", c->name, "*%s", c->help, A_END);
2030 else
2031 a_info(a, "%s", c->name, A_END);
2032 }
2033 a_ok(a);
2034 }
2035
2036 /*----- Connection handling -----------------------------------------------*/
2037
2038 /* --- @a_destroypending@ --- *
2039 *
2040 * Arguments: ---
2041 *
2042 * Returns: ---
2043 *
2044 * Use: Destroys pending admin connections at a safe time.
2045 */
2046
2047 static void a_destroypending(void)
2048 {
2049 admin *a, *aa, *head;
2050 admin_bgop *bg, *bbg;
2051 admin_service *svc, *ssvc;
2052
2053 /* --- Destroy connections marked as pending --- *
2054 *
2055 * Slightly messy. Killing clients may cause others to finally die. Make
2056 * sure that they can be put on the list without clobbering anything or
2057 * getting lost.
2058 */
2059
2060 while (a_dead) {
2061 head = a_dead;
2062 a_dead = 0;
2063 for (a = head; a; a = aa) {
2064 aa = a->next;
2065 assert(a->f & AF_DEAD);
2066
2067 /* --- Report what we're doing --- */
2068
2069 T( trace(T_ADMIN, "admin: completing destruction of connection %u",
2070 a->seq); )
2071
2072 /* --- If this is the foreground client then shut down --- */
2073
2074 if (a->f & AF_FOREGROUND) {
2075 T( trace(T_ADMIN, "admin: foreground client quit: shutting down"); )
2076 a_warn("SERVER", "quit", "foreground-eof", A_END);
2077 a_quit();
2078 }
2079
2080 /* --- Abort any background jobs in progress --- */
2081
2082 for (bg = a->bg; bg; bg = bbg) {
2083 bbg = bg->next;
2084 bg->cancel(bg);
2085 if (bg->tag) xfree(bg->tag);
2086 xfree(bg);
2087 }
2088
2089 /* --- Release services I hold, and abort pending jobs --- */
2090
2091 for (svc = a->svcs; svc; svc = ssvc) {
2092 ssvc = svc->next;
2093 a_svcrelease(svc);
2094 }
2095 a_jobtablefinal(&a->j);
2096
2097 /* --- Close file descriptors and selectory --- */
2098
2099 selbuf_destroy(&a->b);
2100 if (a->b.reader.fd != a->w.fd) close(a->b.reader.fd);
2101 close(a->w.fd);
2102 if (a_stdin == a) a_stdin = 0;
2103
2104 /* --- Done --- */
2105
2106 DESTROY(a);
2107 }
2108 }
2109 }
2110
2111 /* --- @a_destroy@ --- *
2112 *
2113 * Arguments: @admin *a@ = pointer to an admin block
2114 *
2115 * Returns: ---
2116 *
2117 * Use: Destroys an admin block. This requires a certain amount of
2118 * care.
2119 */
2120
2121 static void freequeue(oqueue *q)
2122 {
2123 obuf *o, *oo;
2124
2125 for (o = q->hd; o; o = oo) {
2126 oo = o->next;
2127 xfree(o);
2128 }
2129 q->hd = q->tl = 0;
2130 }
2131
2132 static void a_destroy(admin *a)
2133 {
2134 if (a->f & AF_DEAD)
2135 return;
2136
2137 if (a->next) a->next->prev = a->prev;
2138 if (a->prev) a->prev->next = a->next;
2139 else admins = a->next;
2140
2141 if (a->out.hd) sel_rmfile(&a->w);
2142 freequeue(&a->out);
2143
2144 a->f |= AF_DEAD;
2145 a->next = a_dead;
2146 a_dead = a;
2147
2148 T( trace(T_ADMIN, "admin: killing connection %u", a->seq); )
2149 }
2150
2151 /* --- @a_line@ --- *
2152 *
2153 * Arguments: @char *p@ = pointer to the line read
2154 * @size_t len@ = length of the line
2155 * @void *vp@ = pointer to my admin block
2156 *
2157 * Returns: ---
2158 *
2159 * Use: Handles a line of input.
2160 */
2161
2162 static void a_line(char *p, size_t len, void *vp)
2163 {
2164 admin *a = vp;
2165 const acmd *c;
2166 char *av[16 + 1];
2167 size_t ac;
2168
2169 QUICKRAND;
2170 if (a->f & AF_DEAD)
2171 return;
2172 if (!p) {
2173 if (!a->bg)
2174 a_destroy(a);
2175 else {
2176 a->f |= AF_CLOSE;
2177 selbuf_disable(&a->b);
2178 }
2179 return;
2180 }
2181 ac = str_qsplit(p, av, N(av) - 1, 0, STRF_QUOTE);
2182 if (!ac)
2183 return;
2184 av[ac] = 0;
2185 for (c = acmdtab; c->name; c++) {
2186 if (mystrieq(av[0], c->name)) {
2187 ac--;
2188 if (c->argmin > ac || ac > c->argmax) {
2189 if (!c->help)
2190 a_fail(a, "bad-syntax", "%s", c->name, "", A_END);
2191 else
2192 a_fail(a, "bad-syntax", "%s", c->name, "%s", c->help, A_END);
2193 } else
2194 c->func(a, ac, av + 1);
2195 return;
2196 }
2197 }
2198 a_fail(a, "unknown-command", "%s", av[0], A_END);
2199 }
2200
2201 /* --- @a_create@ --- *
2202 *
2203 * Arguments: @int fd_in, fd_out@ = file descriptors to use
2204 * @unsigned f@ = initial flags to set
2205 *
2206 * Returns: ---
2207 *
2208 * Use: Creates a new admin connection.
2209 */
2210
2211 void a_create(int fd_in, int fd_out, unsigned f)
2212 {
2213 admin *a = CREATE(admin);
2214
2215 T( static unsigned seq = 0;
2216 a->seq = seq++; )
2217 T( trace(T_ADMIN, "admin: accepted connection %u", a->seq); )
2218 a->bg = 0;
2219 a->ref = 0;
2220 a->svcs = 0;
2221 a_jobtableinit(&a->j);
2222 a->f = f;
2223 if (fd_in == STDIN_FILENO) a_stdin = a;
2224 fdflags(fd_in, O_NONBLOCK, O_NONBLOCK, FD_CLOEXEC, FD_CLOEXEC);
2225 if (fd_out != fd_in)
2226 fdflags(fd_out, O_NONBLOCK, O_NONBLOCK, FD_CLOEXEC, FD_CLOEXEC);
2227 selbuf_init(&a->b, &sel, fd_in, a_line, a);
2228 sel_initfile(&sel, &a->w, fd_out, SEL_WRITE, a_flush, a);
2229 a->out.hd = a->out.tl = 0;
2230 a->next = admins;
2231 a->prev = 0;
2232 if (admins) admins->prev = a;
2233 admins = a;
2234 }
2235
2236 /* --- @a_accept@ --- *
2237 *
2238 * Arguments: @int fd@ = file descriptor to accept
2239 * @unsigned mode@ = what to do
2240 * @void *v@ = uninteresting pointer
2241 *
2242 * Returns: ---
2243 *
2244 * Use: Accepts a new admin connection.
2245 */
2246
2247 static void a_accept(int fd, unsigned mode, void *v)
2248 {
2249 int nfd;
2250 struct sockaddr_un sun;
2251 socklen_t sz = sizeof(sun);
2252
2253 if ((nfd = accept(fd, (struct sockaddr *)&sun, &sz)) < 0) {
2254 if (errno != EINTR && errno != EAGAIN && errno != EWOULDBLOCK &&
2255 errno != ECONNABORTED && errno != EPROTO)
2256 a_warn("ADMIN", "accept-error", "?ERRNO", A_END);
2257 return;
2258 }
2259 a_create(nfd, nfd, 0);
2260 }
2261
2262 /* --- @a_preselect@ --- *
2263 *
2264 * Arguments: ---
2265 *
2266 * Returns: ---
2267 *
2268 * Use: Informs the admin module that we're about to select again,
2269 * and that it should do cleanup things it has delayed until a
2270 * `safe' time.
2271 */
2272
2273 void a_preselect(void) { if (a_dead) a_destroypending(); }
2274
2275 /* --- @a_daemon@ --- *
2276 *
2277 * Arguments: ---
2278 *
2279 * Returns: ---
2280 *
2281 * Use: Informs the admin module that it's a daemon.
2282 */
2283
2284 void a_daemon(void) { flags |= F_DAEMON; }
2285
2286 /* --- @a_init@ --- *
2287 *
2288 * Arguments: @const char *name@ = socket name to create
2289 * @uid_t u@ = user to own the socket
2290 * @gid_t g@ = group to own the socket
2291 * @mode_t m@ = permissions to set on the socket
2292 *
2293 * Returns: ---
2294 *
2295 * Use: Creates the admin listening socket.
2296 */
2297
2298 void a_init(const char *name, uid_t u, gid_t g, mode_t m)
2299 {
2300 int fd;
2301 int n = 5;
2302 struct sockaddr_un sun;
2303 struct sigaction sa;
2304 size_t sz;
2305 mode_t omask;
2306
2307 /* --- Create services table --- */
2308
2309 sym_create(&a_svcs);
2310
2311 /* --- Set up the socket address --- */
2312
2313 sz = strlen(name) + 1;
2314 if (sz > sizeof(sun.sun_path))
2315 die(EXIT_FAILURE, "socket name `%s' too long", name);
2316 BURN(sun);
2317 sun.sun_family = AF_UNIX;
2318 memcpy(sun.sun_path, name, sz);
2319 sz += offsetof(struct sockaddr_un, sun_path);
2320
2321 /* --- Attempt to bind to the socket --- */
2322
2323 omask = umask(0077);
2324 again:
2325 if ((fd = socket(PF_UNIX, SOCK_STREAM, 0)) < 0)
2326 die(EXIT_FAILURE, "couldn't create socket: %s", strerror(errno));
2327 if (bind(fd, (struct sockaddr *)&sun, sz) < 0) {
2328 struct stat st;
2329 int e = errno;
2330 if (errno != EADDRINUSE) {
2331 die(EXIT_FAILURE, "couldn't bind to address `%s': %s",
2332 sun.sun_path, strerror(e));
2333 }
2334 if (!n)
2335 die(EXIT_FAILURE, "too many retries; giving up");
2336 n--;
2337 if (!connect(fd, (struct sockaddr *)&sun, sz)) {
2338 die(EXIT_FAILURE, "server already listening on admin socket `%s'",
2339 sun.sun_path);
2340 }
2341 if (errno != ECONNREFUSED)
2342 die(EXIT_FAILURE, "couldn't bind to address: %s", strerror(e));
2343 if (stat(sun.sun_path, &st)) {
2344 die(EXIT_FAILURE, "couldn't stat `%s': %s",
2345 sun.sun_path, strerror(errno));
2346 }
2347 if (!S_ISSOCK(st.st_mode))
2348 die(EXIT_FAILURE, "object `%s' isn't a socket", sun.sun_path);
2349 T( trace(T_ADMIN, "admin: stale socket found; removing it"); )
2350 unlink(sun.sun_path);
2351 close(fd);
2352 goto again;
2353 }
2354 if (chown(sun.sun_path, u, g)) {
2355 die(EXIT_FAILURE, "failed to set socket owner: %s",
2356 strerror(errno));
2357 }
2358 if (chmod(sun.sun_path, m)) {
2359 die(EXIT_FAILURE, "failed to set socket permissions: %s",
2360 strerror(errno));
2361 }
2362 umask(omask);
2363 fdflags(fd, O_NONBLOCK, O_NONBLOCK, FD_CLOEXEC, FD_CLOEXEC);
2364 if (listen(fd, 5))
2365 die(EXIT_FAILURE, "couldn't listen on socket: %s", strerror(errno));
2366
2367 /* --- Listen to the socket --- */
2368
2369 sel_initfile(&sel, &sock, fd, SEL_READ, a_accept, 0);
2370 sel_addfile(&sock);
2371 sockname = name;
2372 bres_init(&sel);
2373 T( trace_custom(a_trace, 0);
2374 trace(T_ADMIN, "admin: enabled custom tracing"); )
2375 flags |= F_INIT;
2376
2377 /* --- Set up signal handlers --- */
2378
2379 sig_add(&s_term, SIGTERM, a_sigdie, 0);
2380 sig_add(&s_hup, SIGHUP, a_sighup, 0);
2381 sigaction(SIGINT, 0, &sa);
2382 if (sa.sa_handler != SIG_IGN)
2383 sig_add(&s_int, SIGINT, a_sigdie, 0);
2384 }
2385
2386 /*----- That's all, folks -------------------------------------------------*/