3 * Admin interface for configuration
5 * (c) 2001 Straylight/Edgeware
8 /*----- Licensing notice --------------------------------------------------*
10 * This file is part of Trivial IP Encryption (TrIPE).
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.
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
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/>.
26 /*----- Header files ------------------------------------------------------*/
30 /*----- Global variables --------------------------------------------------*/
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" },
49 unsigned tr_flags
= 0;
52 static const trace_opt w_opts
[] = {
54 { 't', AF_TRACE
, "trace messages" },
56 { 'n', AF_NOTE
, "asynchronous notifications" },
57 { 'w', AF_WARN
, "warnings" },
58 { 'A', AF_ALLMSGS
, "all of the above" },
62 /*----- Static variables --------------------------------------------------*/
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
;
75 #define F_FOREGROUND 4u
77 #define T_RESOLVE SEC(30)
80 static void a_destroy(admin */
*a*/
);
82 #define BOOL(x) ((x) ? "t" : "nil")
84 /*----- Output functions --------------------------------------------------*/
86 /* --- @trywrite@ --- *
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
92 * Returns: The number of bytes written, or less than zero on error.
94 * Use: Attempts to write data to a client.
97 static ssize_t
trywrite(admin
*a
, const char *p
, size_t sz
)
104 n
= write(a
->w
.fd
, p
, sz
);
114 if (errno
!= EAGAIN
&& errno
!= EWOULDBLOCK
) {
116 a_warn("ADMIN", "client-write-error", "?ERRNO", A_END
);
123 /* --- @doqueue@ -- *
125 * Arguments: @oqueue *q@ = pointer to output queue
126 * @const char *p@ = pointer to buffer to write
127 * @size_t sz@ = size of buffer
129 * Returns: Nonzero if the queue was previously empty.
131 * Use: Queues data to be written later.
134 static int doqueue(oqueue
*q
, const char *p
, size_t sz
)
143 else if (o
->p_in
< o
->buf
+ OBUFSZ
)
147 o
= xmalloc(sizeof(obuf
));
149 o
->p_in
= o
->p_out
= o
->buf
;
157 n
= o
->buf
+ OBUFSZ
- o
->p_in
;
160 memcpy(o
->p_in
, p
, n
);
169 /* --- @dosend@ --- *
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
177 * Use: Sends data to an admin client.
180 static void dosend(admin
*a
, const char *p
, size_t sz
)
187 if ((n
= trywrite(a
, p
, sz
)) < 0)
194 if (doqueue(&a
->out
, p
, sz
))
198 /* --- @a_flush@ --- *
200 * Arguments: @int fd@ = file descriptor
201 * @unsigned mode@ = what's happening
202 * @void *v@ = pointer to my admin block
206 * Use: Flushes buffers when a client is ready to read again.
209 static void a_flush(int fd
, unsigned mode
, void *v
)
217 if ((n
= trywrite(a
, o
->p_out
, o
->p_in
- o
->p_out
)) < 0)
220 if (o
->p_in
< o
->p_out
)
233 /*----- Utility functions -------------------------------------------------*/
235 /* --- @a_vformat@ --- *
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
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@.
249 * * "*..." ... -- pretokenized @dstr_putf@-like string
251 * * "?ADDR" SOCKADDR -- a socket address, to be converted
253 * * "?B64" BUFFER SIZE -- binary data to be base64-encoded
255 * * "?TOKENS" VECTOR -- null-terminated vector of tokens
257 * * "?PEER" PEER -- peer's name
259 * * "?ERRNO" ERRNO -- system error code
261 * * "[!]..." ... -- @dstr_putf@-like string as single token
264 void a_vformat(dstr
*d
, const char *fmt
, va_list *ap
)
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
) {
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
));
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);
292 base64_encode(&b64
, p
, n
, d
);
293 base64_encode(&b64
, 0, 0, d
);
294 while (d
->len
&& d
->buf
[d
->len
- 1] == '=') d
->len
--;
295 } else if (strcmp(fmt
, "?TOKENS") == 0) {
296 const char *const *av
= va_arg(*ap
, const char *const *);
297 while (*av
) u_quotify(d
, *av
++);
298 } else if (strcmp(fmt
, "?PEER") == 0)
299 u_quotify(d
, p_name(va_arg(*ap
, peer
*)));
300 else if (strcmp(fmt
, "?ERRNO") == 0) {
301 dstr_putf(d
, " E%d", errno
);
302 u_quotify(d
, strerror(errno
));
306 if (*fmt
== '!') fmt
++;
308 dstr_vputf(&dd
, fmt
, ap
);
309 u_quotify(d
, dd
.buf
);
311 fmt
= va_arg(*ap
, const char *);
318 /* --- @a_format@ --- *
320 * Arguments: @dstr *d@ = where to leave the formatted message
321 * @const char *fmt@ = pointer to format string
325 * Use: Writes a tokenized message into a string, for later
329 void a_format(dstr
*d
, const char *fmt
, ...)
334 a_vformat(d
, fmt
, &ap
);
338 /* --- @a_write@, @a_vwrite@ --- *
340 * Arguments: @admin *a@ = admin connection to write to
341 * @const char *status@ = status code to report
342 * @const char *tag@ = tag string, or null
343 * @const char *fmt@ = pointer to format string
344 * @va_list *ap@ = arguments in list
345 * @...@ = other arguments
349 * Use: Sends a message to an admin connection.
352 static void a_vwrite(admin
*a
, const char *status
, const char *tag
,
353 const char *fmt
, va_list *ap
)
357 if (tag
) dstr_puts(&d
, "BG");
358 dstr_puts(&d
, status
);
359 if (tag
) u_quotify(&d
, tag
);
360 a_vformat(&d
, fmt
, ap
);
362 dosend(a
, d
.buf
, d
.len
);
366 static void a_write(admin
*a
, const char *status
, const char *tag
,
367 const char *fmt
, ...)
372 a_vwrite(a
, status
, tag
, fmt
, &ap
);
376 /* --- @a_ok@, @a_fail@ --- *
378 * Arguments: @admin *a@ = connection
379 * @const char *fmt@ = format string
380 * @...@ = other arguments
384 * Use: Convenience functions for @a_write@.
387 static void a_ok(admin
*a
) { a_write(a
, "OK", 0, A_END
); }
389 static void a_fail(admin
*a
, const char *fmt
, ...)
394 a_vwrite(a
, "FAIL", 0, fmt
, &ap
);
398 /* --- @a_info@ --- *
400 * Arguments: @admin *a@ = connection
401 * @const char *fmt@ = format string
402 * @...@ = other arguments
406 * Use: Report information to an admin client.
409 void a_info(admin
*a
, const char *fmt
, ...)
414 a_vwrite(a
, "INFO", 0, fmt
, &ap
);
418 /* --- @a_alert@, @a_valert@, @a_rawalert@ --- *
420 * Arguments: @unsigned f_and, f_eq@ = filter for connections
421 * @const char *status@ = status string
422 * @const char *fmt@ = pointer to format string
423 * @const char *p@ = pointer to raw string
424 * @size_t sz@ = size of raw string
425 * @va_list *ap@ = arguments in list
426 * @...@ = other arguments
430 * Use: Write a message to all admin connections matched by the given
434 static void a_rawalert(unsigned f_and
, unsigned f_eq
, const char *status
,
435 const char *p
, size_t sz
)
440 if (!(flags
& F_INIT
))
442 dstr_puts(&d
, status
);
445 dstr_putm(&d
, p
, sz
);
450 for (a
= admins
; a
; a
= aa
) {
452 if ((a
->f
& f_and
) == f_eq
)
453 dosend(a
, d
.buf
, d
.len
);
458 static void a_valert(unsigned f_and
, unsigned f_eq
, const char *status
,
459 const char *fmt
, va_list *ap
)
463 if (!(flags
& F_INIT
))
465 a_vformat(&d
, fmt
, ap
);
466 a_rawalert(f_and
, f_eq
, status
, fmt ? d
.buf
: 0, fmt ? d
.len
: 0);
470 static void a_alert(unsigned f_and
, unsigned f_eq
, const char *status
,
471 const char *fmt
, ...)
476 a_valert(f_and
, f_eq
, status
, fmt
, &ap
);
480 /* --- @a_warn@ --- *
482 * Arguments: @const char *fmt@ = pointer to format string
483 * @...@ = other arguments
487 * Use: Informs all admin connections of a warning.
490 void a_warn(const char *fmt
, ...)
496 a_valert(0, 0, "WARN", fmt
, &ap
);
499 fprintf(stderr
, "%s: ", QUIS
);
500 a_vformat(&d
, fmt
, &ap
);
502 dstr_write(&d
, stderr
);
508 /* --- @a_trace@ --- *
510 * Arguments: @const char *p@ = pointer to a buffer
511 * @size_t sz@ = size of the buffer
512 * @void *v@ = uninteresting pointer
516 * Use: Custom trace output handler. Sends trace messages to
517 * interested admin connections.
521 static void a_trace(const char *p
, size_t sz
, void *v
)
522 { a_rawalert(AF_TRACE
, AF_TRACE
, "TRACE", p
, sz
); }
525 /* --- @a_notify@ --- *
527 * Arguments: @const char *fmt@ = pointer to format string
528 * @...@ = other arguments
532 * Use: Sends a notification to interested admin connections.
535 void a_notify(const char *fmt
, ...)
540 a_valert(AF_NOTE
, AF_NOTE
, "NOTE", fmt
, &ap
);
544 /* --- @a_quit@ --- *
550 * Use: Shuts things down nicely.
557 FOREACH_PEER(p
, { p_destroy(p
); });
562 /* --- @a_sigdie@ --- *
564 * Arguments: @int sig@ = signal number
565 * @void *v@ = an uninteresting argument
569 * Use Shuts down on receipt of a fatal signal.
572 static void a_sigdie(int sig
, void *v
)
578 case SIGTERM
: p
= "SIGTERM"; break;
579 case SIGINT
: p
= "SIGINT"; break;
581 sprintf(buf
, "%i", sig
);
585 a_warn("SERVER", "quit", "signal", "%s", p
, A_END
);
589 /* --- @a_sighup@ --- *
591 * Arguments: @int sig@ = signal number
592 * @void *v@ = an uninteresting argument
596 * Use Logs a message about SIGHUP not being useful.
599 static void a_sighup(int sig
, void *v
)
600 { a_warn("SERVER", "ignore", "signal", "SIGHUP", A_END
); }
602 /* --- @a_parsetime@ --- *
604 * Arguments; @const char *p@ = time string to parse
606 * Returns: Time in seconds, or @< 0@ on error.
609 static long a_parsetime(const char *p
)
612 long t
= strtol(p
, &q
, 0);
618 case 's': if (q
[1] != 0)
625 /* --- @a_findpeer@ --- *
627 * Arguments: @admin *a@ = admin connection
628 * @const char *pn@ = peer name
630 * Returns: The peer, or null if not there.
632 * Use: Finds a peer, reporting an error if it failed.
635 static peer
*a_findpeer(admin
*a
, const char *pn
)
639 if ((p
= p_find(pn
)) == 0)
640 a_fail(a
, "unknown-peer", "%s", pn
, A_END
);
644 /*----- Backgrounded operations -------------------------------------------*/
647 (((admin_bgop *)(bg))->tag ? ((admin_bgop *)(bg))->tag : "<foreground>")
649 /* --- @a_bgfind@ --- *
651 * Arguments: @admin *a@ = a client block
652 * @const char *tag@ = the requested tag
654 * Returns: The requested background job, or null.
657 static admin_bgop
*a_bgfind(admin
*a
, const char *tag
)
661 for (bg
= a
->bg
; bg
; bg
= bg
->next
) {
662 if (bg
->tag
&& strcmp(tag
, bg
->tag
) == 0)
668 /* --- @a_bgrelease@ --- *
670 * Arguments: @admin_bgop *bg@ = backgrounded operation
674 * Use: Removes a backgrounded operation from the queue, since
675 * (presumably) it's done.
678 static void a_bgrelease(admin_bgop
*bg
)
682 T( trace(T_ADMIN
, "admin: release bgop %s", BGTAG(bg
)); )
683 if (bg
->tag
) xfree(bg
->tag
);
684 else selbuf_enable(&a
->b
);
685 if (bg
->next
) bg
->next
->prev
= bg
->prev
;
686 if (bg
->prev
) bg
->prev
->next
= bg
->next
;
687 else a
->bg
= bg
->next
;
689 if (!a
->bg
&& (a
->f
& AF_CLOSE
)) a_destroy(a
);
692 /* --- @a_bgok@, @a_bginfo@, @a_bgfail@ --- *
694 * Arguments: @admin_bgop *bg@ = backgrounded operation
695 * @const char *fmt@ = format string
696 * @...@ = other arguments
700 * Use: Convenience functions for @a_write@.
703 static void a_bgok(admin_bgop
*bg
)
704 { a_write(bg
->a
, "OK", bg
->tag
, A_END
); }
706 static void a_bginfo(admin_bgop
*bg
, const char *fmt
, ...)
710 a_vwrite(bg
->a
, "INFO", bg
->tag
, fmt
, &ap
);
714 static void a_bgfail(admin_bgop
*bg
, const char *fmt
, ...)
718 a_vwrite(bg
->a
, "FAIL", bg
->tag
, fmt
, &ap
);
722 /* --- @a_bgadd@ --- *
724 * Arguments: @admin *a@ = administration connection
725 * @admin_bgop *bg@ = pointer to background operation
726 * @const char *tag@ = background tag, or null for foreground
727 * @void (*cancel)(admin_bgop *)@ = cancel function
729 * Returns: Zero for success, nonzero on failure.
731 * Use: Links a background job into the list.
734 static int a_bgadd(admin
*a
, admin_bgop
*bg
, const char *tag
,
735 void (*cancel
)(admin_bgop
*))
738 if (a_bgfind(a
, tag
)) {
739 a_fail(a
, "tag-exists", "%s", tag
, A_END
);
742 bg
->tag
= xstrdup(tag
);
746 selbuf_disable(&a
->b
);
752 if (a
->bg
) a
->bg
->prev
= bg
;
754 T( trace(T_ADMIN
, "admin: add bgop %s", BGTAG(bg
)); )
755 if (tag
) a_write(a
, "DETACH", tag
, A_END
);
759 /*----- Job table manipulation --------------------------------------------*/
762 #define JOB_INDEXMASK ((1ul << JOB_SHIFT) - 1)
763 #define JOB_SEQMASK ((1ul << (32 - JOB_SHIFT)) - 1)
765 #define JOB_END 0xfffffffful
767 static unsigned long a_joboffset
;
769 /* --- @a_jobidencode@ --- *
771 * Arguments: @admin_svcop *svc@ = pointer to a service operation
773 * Returns: A jobid for this job, in an internal static buffer.
775 * Use: Constructs a jobid. In order to dissuade people from
776 * predicting jobids, we obfuscate them.
778 * A `raw' jobid consists of two 16-bit fields. The low 16 bits
779 * are an index into a big array. The high 16 bits are a
780 * sequence number recording how many times that slot has been
783 * This `raw' jobid is then obfuscated by adding a randomly-
784 * generated offset, and multiplying (mod %$2^{32}$%) by a fixed
788 static const char *a_jobidencode(admin_svcop
*svc
)
790 admin_jobtable
*j
= &svc
->prov
->j
;
795 assert(svc
->index
<= JOB_INDEXMASK
);
796 seq
= j
->v
[svc
->index
].seq
;
797 assert(seq
<= JOB_SEQMASK
);
798 pre
= (unsigned long)svc
->index
| ((unsigned long)seq
<< JOB_SHIFT
);
799 sprintf(buf
, "J%08lx", ((pre
+ a_joboffset
) * 0x0f87a7a3ul
) & 0xffffffff);
803 /* --- @a_jobiddecode@ --- *
805 * Arguments: @admin_jobtable *j@ = pointer to a job table
806 * @const char *jid@ = pointer to a jobid string
808 * Returns: A pointer to the job's @svcop@ structure.
811 static admin_svcop
*a_jobiddecode(admin_jobtable
*j
, const char *jid
)
818 for (i
= 1; i
< 9; i
++) {
819 if (!isxdigit((unsigned char)jid
[i
]))
824 pre
= strtoul(jid
+ 1, 0, 16);
825 pre
= ((pre
* 0xbd11c40bul
) - a_joboffset
) & 0xffffffff;
826 i
= pre
& JOB_INDEXMASK
;
827 if (i
>= j
->n
|| j
->v
[i
].seq
!= (pre
>> JOB_SHIFT
))
829 return (j
->v
[i
].u
.op
);
832 /* --- @a_jobcreate@ --- *
834 * Arguments: @admin *a@ = pointer to administration client
836 * Returns: A pointer to a freshly-allocated @svcop@, or null.
838 * Use: Allocates a fresh @svcop@ and links it into a job table.
841 static admin_svcop
*a_jobcreate(admin
*a
)
846 admin_jobtable
*j
= &a
->j
;
848 if (j
->free
!= JOB_END
) {
850 j
->free
= j
->v
[i
].u
.next
;
853 if (j
->sz
> JOB_INDEXMASK
)
858 j
->v
= xmalloc(j
->sz
* sizeof(*j
->v
));
861 j
->v
= xrealloc(j
->v
, j
->sz
* sizeof(*j
->v
), sz
* sizeof(*j
->v
));
867 svc
= xmalloc(sizeof(*svc
));
870 svc
->next
= j
->active
;
872 if (j
->active
) j
->active
->prev
= svc
;
875 IF_TRACING(T_ADMIN
, {
876 trace(T_ADMIN
, "admin: created job %s (%u)", a_jobidencode(svc
), i
);
881 /* --- @a_jobdestroy@ --- *
883 * Arguments: @admin_svcop *svc@ = pointer to job block
887 * Use: Frees up a completed (or cancelled) job.
890 static void a_jobdestroy(admin_svcop
*svc
)
892 admin
*a
= svc
->prov
;
893 admin_jobtable
*j
= &a
->j
;
894 unsigned i
= svc
->index
;
896 IF_TRACING(T_ADMIN
, {
897 trace(T_ADMIN
, "admin: destroying job %s (%u)", a_jobidencode(svc
), i
);
899 assert(j
->v
[i
].u
.op
= svc
);
900 j
->v
[i
].u
.next
= j
->free
;
903 if (svc
->next
) svc
->next
->prev
= svc
->prev
;
904 if (svc
->prev
) svc
->prev
->next
= svc
->next
;
905 else j
->active
= svc
->next
;
908 /* --- @a_jobtableinit@ --- *
910 * Arguments: @admin_jobtable *j@ = pointer to job table
914 * Use: Initializes a job table.
917 static void a_jobtableinit(admin_jobtable
*j
)
920 a_joboffset
= GR_RANGE(&rand_global
, 0xffffffff) + 1;
927 /* --- @a_jobtablefinal@ --- *
929 * Arguments: @admin_jobtable *j@ = pointer to job table
933 * Use: Closes down a job table.
936 static void a_jobtablefinal(admin_jobtable
*j
)
938 admin_svcop
*svc
, *ssvc
;
940 for (svc
= j
->active
; svc
; svc
= ssvc
) {
942 a_bgfail(&svc
->bg
, "provider-failed", A_END
);
943 a_bgrelease(&svc
->bg
);
945 if (j
->v
) xfree(j
->v
);
948 /*----- Services infrastructure -------------------------------------------*/
950 /* --- @a_svcfind@ --- *
952 * Arguments: @admin *a@ = the requesting client
953 * @const char *name@ = service name wanted
955 * Returns: The service requested, or null.
957 * Use: Finds a service; reports an error if the service couldn't be
961 static admin_service
*a_svcfind(admin
*a
, const char *name
)
965 if ((svc
= sym_find(&a_svcs
, name
, -1, 0, 0)) == 0) {
966 a_fail(a
, "unknown-service", "%s", name
, A_END
);
972 /* --- @a_svcunlink@ --- *
974 * Arguments: @admin_service *svc@ = pointer to service structure
978 * Use: Unlinks the service from its provider, without issuing a
979 * message or freeing the structure. The version string is
983 static void a_svcunlink(admin_service
*svc
)
986 svc
->next
->prev
= svc
->prev
;
988 svc
->prev
->next
= svc
->next
;
990 svc
->prov
->svcs
= svc
->next
;
994 /* --- @a_svcrelease@ --- *
996 * Arguments: @admin_service *svc@ = pointer to service structure
1000 * Use: Releases a service and frees its structure.
1003 static void a_svcrelease(admin_service
*svc
)
1005 a_notify("SVCRELEASE", "%s", SYM_NAME(svc
), A_END
);
1007 sym_remove(&a_svcs
, svc
);
1010 /*----- Name resolution operations ----------------------------------------*/
1012 /* --- @a_resolved@ --- *
1014 * Arguments: @struct hostent *h@ = pointer to resolved hostname
1015 * @void *v@ = pointer to resolver operation
1019 * Use: Handles a completed name resolution.
1022 static void a_resolved(struct hostent
*h
, void *v
)
1026 T( trace(T_ADMIN
, "admin: resop %s resolved", BGTAG(r
)); )
1029 a_bgfail(&r
->bg
, "resolve-error", "%s", r
->addr
, A_END
);
1030 r
->func(r
, ARES_FAIL
);
1032 memcpy(&r
->sa
.sin
.sin_addr
, h
->h_addr
, sizeof(struct in_addr
));
1033 r
->func(r
, ARES_OK
);
1037 a_bgrelease(&r
->bg
);
1040 /* --- @a_restimer@ --- *
1042 * Arguments: @struct timeval *tv@ = timer
1043 * @void *v@ = pointer to resolver operation
1047 * Use: Times out a resolver.
1050 static void a_restimer(struct timeval
*tv
, void *v
)
1054 T( trace(T_ADMIN
, "admin: resop %s timeout", BGTAG(r
)); )
1055 a_bgfail(&r
->bg
, "resolver-timeout", "%s", r
->addr
, A_END
);
1056 r
->func(r
, ARES_FAIL
);
1059 a_bgrelease(&r
->bg
);
1062 /* --- @a_rescancel@ --- *
1064 * Arguments: @admin_bgop *bg@ = background operation
1068 * Use: Cancels an add operation.
1071 static void a_rescancel(admin_bgop
*bg
)
1073 admin_resop
*r
= (admin_resop
*)bg
;
1075 T( trace(T_ADMIN
, "admin: cancel resop %s", BGTAG(r
)); )
1076 r
->func(r
, ARES_FAIL
);
1082 /* --- @a_resolve@ --- *
1084 * Arguments: @admin *a@ = administration connection
1085 * @admin_resop *r@ = resolver operation to run
1086 * @const char *tag@ = background operation tag
1087 * @void (*func)(struct admin_resop *, int@ = handler function
1088 * @unsigned ac@ = number of remaining arguments
1089 * @char *av[]@ = pointer to remaining arguments
1093 * Use: Cranks up a resolver job.
1096 static void a_resolve(admin
*a
, admin_resop
*r
, const char *tag
,
1097 void (*func
)(struct admin_resop
*, int),
1098 unsigned ac
, char *av
[])
1105 /* --- Fill in the easy bits of address --- */
1107 r
->bg
.tag
= "<starting>";
1110 if (mystrieq(av
[i
], "inet")) i
++;
1111 if (ac
- i
!= 1 && ac
- i
!= 2) {
1112 a_fail(a
, "bad-addr-syntax", "[inet] ADDRESS [PORT]", A_END
);
1115 r
->sa
.sin
.sin_family
= AF_INET
;
1116 r
->sasz
= sizeof(r
->sa
.sin
);
1117 r
->addr
= xstrdup(av
[i
]);
1121 pt
= strtoul(av
[i
+ 1], &p
, 0);
1123 struct servent
*s
= getservbyname(av
[i
+ 1], "udp");
1125 a_fail(a
, "unknown-service", "%s", av
[i
+ 1], A_END
);
1128 pt
= ntohs(s
->s_port
);
1131 if (pt
== 0 || pt
>= 65536) {
1132 a_fail(a
, "invalid-port", "%lu", pt
, A_END
);
1135 r
->sa
.sin
.sin_port
= htons(pt
);
1137 /* --- Report backgrounding --- *
1139 * Do this for consistency of interface, even if we're going to get the
1140 * answer straight away.
1143 if (a_bgadd(a
, &r
->bg
, tag
, a_rescancel
))
1145 T( trace(T_ADMIN
, "admin: %u, resop %s, hostname `%s'",
1146 a
->seq
, BGTAG(r
), r
->addr
); )
1148 /* --- If the name is numeric, do it the easy way --- */
1150 if (inet_aton(av
[i
], &r
->sa
.sin
.sin_addr
)) {
1151 T( trace(T_ADMIN
, "admin: resop %s done the easy way", BGTAG(r
)); )
1154 a_bgrelease(&r
->bg
);
1158 /* --- Store everything for later and crank up the resolver --- */
1160 gettimeofday(&tv
, 0);
1161 tv
.tv_sec
+= T_RESOLVE
;
1162 sel_addtimer(&sel
, &r
->t
, &tv
, a_restimer
, r
);
1163 bres_byname(&r
->r
, r
->addr
, a_resolved
, r
);
1168 if (r
->addr
) xfree(r
->addr
);
1172 /*----- Option parsing ----------------------------------------------------*/
1174 #define OPTIONS(argc, argv, guts) do { \
1175 char **o_av = argv; \
1179 if (mystrieq(*o_av, "--")) { \
1184 if (**o_av == '-') \
1188 argc -= o_av - argv; \
1192 #define OPT(name, guts) if (mystrieq(*o_av, name)) { guts continue; }
1194 #define OPTARG(name, arg, guts) OPT(name, { \
1197 if (!arg) goto bad_syntax; \
1201 #define OPTTIME(name, arg, guts) OPTARG(name, o_arg, { \
1203 if ((arg = a_parsetime(o_arg)) < 0) { \
1204 a_fail(a, "bad-time-spec", "%s", o_arg, A_END); \
1210 /*----- Adding peers ------------------------------------------------------*/
1212 /* --- @a_doadd@ --- *
1214 * Arguments: @admin_resop *r@ = resolver operation
1215 * @int rc@ = how it worked
1219 * Use: Handles a completed resolution.
1222 static void a_doadd(admin_resop
*r
, int rc
)
1224 admin_addop
*add
= (admin_addop
*)r
;
1226 T( trace(T_ADMIN
, "admin: done add op %s", BGTAG(add
)); )
1228 if (rc
== ARES_OK
) {
1229 add
->peer
.sasz
= add
->r
.sasz
;
1230 add
->peer
.sa
= add
->r
.sa
;
1231 if (p_findbyaddr(&add
->r
.sa
))
1232 a_bgfail(&add
->r
.bg
, "peer-addr-exists", "?ADDR", &add
->r
.sa
, A_END
);
1233 else if (p_find(add
->peer
.name
))
1234 a_bgfail(&add
->r
.bg
, "peer-exists", "%s", add
->peer
.name
, A_END
);
1235 else if (!p_create(&add
->peer
))
1236 a_bgfail(&add
->r
.bg
, "peer-create-fail", "%s", add
->peer
.name
, A_END
);
1241 if (add
->peer
.tag
) xfree(add
->peer
.tag
);
1242 xfree(add
->peer
.name
);
1245 /* --- @acmd_add@ --- *
1247 * Arguments: @admin *a@ = connection which requested the addition
1248 * @unsigned ac@ = argument count
1249 * @char *av[]@ = pointer to the argument list
1253 * Use: Adds a new peer.
1256 static void acmd_add(admin
*a
, unsigned ac
, char *av
[])
1258 const char *tag
= 0;
1261 /* --- Set stuff up --- */
1263 add
= xmalloc(sizeof(*add
));
1266 add
->peer
.privtag
= 0;
1268 add
->peer
.tops
= tun_default
;
1271 /* --- Parse options --- */
1274 OPTARG("-background", arg
, { tag
= arg
; })
1275 OPTARG("-tunnel", arg
, {
1279 a_fail(a
, "unknown-tunnel", "%s", arg
, A_END
);
1282 if (mystrieq(arg
, tunnels
[i
]->name
)) {
1283 add
->peer
.tops
= tunnels
[i
];
1288 OPTTIME("-keepalive", t
, { add
->peer
.t_ka
= t
; })
1289 OPT("-cork", { add
->peer
.f
|= KXF_CORK
; })
1290 OPTARG("-key", arg
, {
1292 xfree(add
->peer
.tag
);
1293 add
->peer
.tag
= xstrdup(arg
);
1295 OPT("-mobile", { add
->peer
.f
|= PSF_MOBILE
; })
1296 OPTARG("-priv", arg
, {
1297 if (add
->peer
.privtag
)
1298 xfree(add
->peer
.privtag
);
1299 add
->peer
.privtag
= xstrdup(arg
);
1303 /* --- Make sure someone's not got there already --- */
1305 if (!av
[0] || !av
[1])
1308 a_fail(a
, "peer-exists", "%s", *av
, A_END
);
1311 add
->peer
.name
= xstrdup(*av
++);
1314 /* --- Crank up the resolver --- */
1316 a_resolve(a
, &add
->r
, tag
, a_doadd
, ac
, av
);
1319 /* --- Clearing up --- */
1322 a_fail(a
, "bad-syntax", "add", "[OPTIONS] PEER ADDR ...", A_END
);
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
);
1331 /*----- Ping --------------------------------------------------------------*/
1333 /* --- @a_pingcancel@ --- *
1335 * Arguments: @admin_bgop *bg@ = background operation block
1339 * Use: Cancels a running ping.
1342 static void a_pingcancel(admin_bgop
*bg
)
1344 admin_pingop
*pg
= (admin_pingop
*)bg
;
1345 T( trace(T_ADMIN
, "admin: cancel ping op %s", BGTAG(pg
)); )
1346 p_pingdone(&pg
->ping
, PING_NONOTIFY
);
1349 /* --- @a_pong@ --- *
1351 * Arguments: @int rc@ = return code
1352 * @void *v@ = ping operation block
1356 * Use: Collects what happened to a ping message.
1359 static void a_pong(int rc
, void *v
)
1361 admin_pingop
*pg
= v
;
1367 gettimeofday(&tv
, 0);
1368 tv_sub(&tv
, &tv
, &pg
->pingtime
);
1369 millis
= (double)tv
.tv_sec
* 1000 + (double)tv
.tv_usec
/1000;
1370 a_bginfo(&pg
->bg
, "ping-ok", "%.1f", millis
, A_END
);
1374 a_bginfo(&pg
->bg
, "ping-timeout", A_END
);
1378 a_bginfo(&pg
->bg
, "ping-peer-died", A_END
);
1384 T( trace(T_ADMIN
, "admin: ponged ping op %s", BGTAG(pg
)); )
1385 a_bgrelease(&pg
->bg
);
1388 /* --- @acmd_ping@, @acmd_eping@ --- *
1390 * Arguments: @admin *a@ = connection which requested the ping
1391 * @unsigned ac@ = argument count
1392 * @char *av[]@ = pointer to the argument list
1396 * Use: Pings a peer.
1399 static void a_ping(admin
*a
, unsigned ac
, char *av
[],
1400 const char *cmd
, unsigned msg
)
1404 admin_pingop
*pg
= 0;
1405 const char *tag
= 0;
1408 OPTARG("-background", arg
, { tag
= arg
; })
1409 OPTTIME("-timeout", arg
, { t
= arg
; })
1411 if (!*av
|| av
[1]) goto bad_syntax
;
1412 if ((p
= a_findpeer(a
, *av
)) == 0)
1414 pg
= xmalloc(sizeof(*pg
));
1415 gettimeofday(&pg
->pingtime
, 0);
1416 if (a_bgadd(a
, &pg
->bg
, tag
, a_pingcancel
))
1418 T( trace(T_ADMIN
, "admin: ping op %s: %s to %s",
1419 BGTAG(pg
), cmd
, p_name(p
)); )
1420 if (p_pingsend(p
, &pg
->ping
, msg
, t
, a_pong
, pg
)) {
1421 a_bgfail(&pg
->bg
, "ping-send-failed", A_END
);
1422 a_bgrelease(&pg
->bg
);
1427 a_fail(a
, "bad-syntax", "%s", cmd
, "[OPTIONS] PEER", cmd
, A_END
);
1433 static void acmd_ping(admin
*a
, unsigned ac
, char *av
[])
1434 { a_ping(a
, ac
, av
, "ping", MISC_PING
); }
1435 static void acmd_eping(admin
*a
, unsigned ac
, char *av
[])
1436 { a_ping(a
, ac
, av
, "eping", MISC_EPING
); }
1438 /*----- Service commands --------------------------------------------------*/
1440 static void acmd_svcclaim(admin
*a
, unsigned ac
, char *av
[])
1445 svc
= sym_find(&a_svcs
, av
[0], -1, sizeof(*svc
), &f
);
1447 if (versioncmp(av
[1], svc
->version
) <= 0) {
1450 "%s", SYM_NAME(svc
),
1455 a_write(svc
->prov
, "SVCCLAIM", 0, "%s", av
[0], "%s", av
[1], A_END
);
1459 svc
->version
= xstrdup(av
[1]);
1460 svc
->next
= a
->svcs
;
1462 if (a
->svcs
) a
->svcs
->prev
= svc
;
1464 a_notify("SVCCLAIM", "%s", SYM_NAME(svc
), "%s", svc
->version
, A_END
);
1468 static void acmd_svcrelease(admin
*a
, unsigned ac
, char *av
[])
1472 if ((svc
= a_svcfind(a
, av
[0])) == 0)
1474 if (svc
->prov
!= a
) {
1475 a_fail(a
, "not-service-provider", "%s", SYM_NAME(svc
), A_END
);
1482 static void acmd_svcensure(admin
*a
, unsigned ac
, char *av
[])
1486 if ((svc
= a_svcfind(a
, av
[0])) == 0)
1488 if (av
[1] && versioncmp(svc
->version
, av
[1]) < 0) {
1489 a_fail(a
, "service-too-old",
1490 "%s", SYM_NAME(svc
),
1498 static void acmd_svcquery(admin
*a
, unsigned ac
, char *av
[])
1502 if ((svc
= a_svcfind(a
, av
[0])) != 0) {
1503 a_info(a
, "name=%s", SYM_NAME(svc
), "version=%s", svc
->version
, A_END
);
1508 static void acmd_svclist(admin
*a
, unsigned ac
, char *av
[])
1513 for (sym_mkiter(&i
, &a_svcs
); (svc
= sym_next(&i
)) != 0; )
1514 a_info(a
, "%s", SYM_NAME(svc
), "%s", svc
->version
, A_END
);
1518 static void a_canceljob(admin_bgop
*bg
)
1520 admin_svcop
*svc
= (admin_svcop
*)bg
;
1522 a_write(svc
->prov
, "SVCCANCEL", 0, "%s", a_jobidencode(svc
), A_END
);
1526 static void acmd_svcsubmit(admin
*a
, unsigned ac
, char *av
[])
1528 const char *tag
= 0;
1531 const char *ver
= 0;
1535 OPTARG("-background", arg
, { tag
= arg
; })
1536 OPTARG("-version", arg
, { ver
= arg
; })
1538 if (!*av
) goto bad_syntax
;
1539 if ((svc
= a_svcfind(a
, *av
)) == 0) goto fail
;
1540 if (ver
&& versioncmp(svc
->version
, ver
) < 0) {
1541 a_fail(a
, "service-too-old",
1542 "%s", SYM_NAME(svc
),
1547 if ((svcop
= a_jobcreate(svc
->prov
)) == 0) {
1548 a_fail(a
, "provider-overloaded", A_END
);
1551 if (a_bgadd(a
, &svcop
->bg
, tag
, a_canceljob
)) {
1552 a_jobdestroy(svcop
);
1555 a_write(svc
->prov
, "SVCJOB", 0,
1556 "%s", a_jobidencode(svcop
),
1562 a_fail(a
, "bad-syntax", "svcsubmit", "[OPTIONS] SERVICE ARGS...", A_END
);
1569 static void a_replycmd(admin
*a
, const char *status
, int donep
, char *av
[])
1573 if ((svc
= a_jobiddecode(&a
->j
, av
[0])) == 0) {
1574 a_fail(a
, "unknown-jobid", av
[0], A_END
);
1577 a_write(svc
->bg
.a
, status
, svc
->bg
.tag
, "?TOKENS", av
+ 1, A_END
);
1580 a_bgrelease(&svc
->bg
);
1585 static void acmd_svcok(admin
*a
, unsigned ac
, char *av
[])
1586 { a_replycmd(a
, "OK", 1, av
); }
1587 static void acmd_svcinfo(admin
*a
, unsigned ac
, char *av
[])
1588 { a_replycmd(a
, "INFO", 0, av
); }
1589 static void acmd_svcfail(admin
*a
, unsigned ac
, char *av
[])
1590 { a_replycmd(a
, "FAIL", 1, av
); }
1592 /*----- Administration commands -------------------------------------------*/
1594 /* --- Miscellaneous commands --- */
1596 /* --- @traceish@ --- *
1598 * Arguments: @admin *a@ = connection to complain on
1599 * @unsigned ac@ = number of arguments
1600 * @char *av[]@ = vector of arguments
1601 * @const char *what@ = what we're messing with
1602 * @const trace_opt *tt@ = options table
1603 * @unsigned *ff@ = where the flags are
1605 * Returns: Nonzero if anything changed.
1607 * Use: Guts of trace-ish commands like `trace' and `watch'.
1610 static int traceish(admin
*a
, unsigned ac
, char *av
[],
1611 const char *what
, const trace_opt
*tt
, unsigned *ff
)
1615 if (!ac
|| strcmp(av
[0], "?") == 0) {
1617 for (t
= tt
; t
->ch
; t
++) {
1618 a_info(a
, "*%c%c %s",
1619 t
->ch
, (*ff
& t
->f
) == t
->f ?
'+' : ' ', t
->help
, A_END
);
1629 case '+': sense
= 1; break;
1630 case '-': sense
= 0; break;
1632 for (t
= tt
; t
->ch
; t
++) {
1634 if (sense
) f
|= t
->f
;
1639 a_fail(a
, "bad-%s-option", what
, "%c", *p
, A_END
);
1655 static void acmd_trace(admin
*a
, unsigned ac
, char *av
[])
1657 if (traceish(a
, ac
, av
, "trace", tr_opts
, &tr_flags
))
1658 trace_level(tr_flags
);
1663 static void acmd_watch(admin
*a
, unsigned ac
, char *av
[])
1664 { traceish(a
, ac
, av
, "watch", w_opts
, &a
->f
); }
1666 static void alertcmd(admin
*a
, unsigned f_and
, unsigned f_eq
,
1667 const char *status
, char *av
[])
1668 { a_alert(f_and
, f_eq
, status
, "USER", "?TOKENS", av
, A_END
); a_ok(a
); }
1669 static void acmd_notify(admin
*a
, unsigned ac
, char *av
[])
1670 { alertcmd(a
, AF_NOTE
, AF_NOTE
, "NOTE", av
); }
1671 static void acmd_warn(admin
*a
, unsigned ac
, char *av
[])
1672 { alertcmd(a
, AF_WARN
, AF_WARN
, "WARN", av
); }
1674 static void acmd_port(admin
*a
, unsigned ac
, char *av
[])
1675 { a_info(a
, "%u", p_port(), A_END
); a_ok(a
); }
1677 static void acmd_daemon(admin
*a
, unsigned ac
, char *av
[])
1679 if (flags
& F_DAEMON
)
1680 a_fail(a
, "already-daemon", A_END
);
1682 a_notify("DAEMON", A_END
);
1686 a_fail(a
, "daemon-error", "?ERRNO", A_END
);
1694 static void acmd_jobs(admin
*a
, unsigned ac
, char *av
[])
1698 for (bg
= a
->bg
; bg
; bg
= bg
->next
) {
1700 a_info(a
, "%s", bg
->tag
, A_END
);
1705 static void acmd_bgcancel(admin
*a
, unsigned ac
, char *av
[])
1709 if ((bg
= a_bgfind(a
, av
[0])) == 0)
1710 a_fail(a
, "unknown-tag", "%s", av
[0], A_END
);
1718 static void acmd_algs(admin
*a
, unsigned ac
, char *av
[])
1723 const algswitch
*algs
;
1728 if ((p
= a_findpeer(a
, av
[0])) == 0) return;
1734 g
->ops
->grpinfo(g
, a
);
1736 "hash=%s", algs
->h
->name
,
1737 "mgf=%s", algs
->mgf
->name
,
1738 "hash-sz=%lu", (unsigned long)algs
->h
->hashsz
,
1741 "bulk-transform=%s", algs
->bulk
->ops
->name
,
1742 "bulk-overhead=%lu",
1743 (unsigned long)algs
->bulk
->ops
->overhead(algs
->bulk
),
1745 algs
->bulk
->ops
->alginfo(algs
->bulk
, a
);
1747 "cipher-data-limit=%lu",
1748 (unsigned long)algs
->bulk
->ops
->expsz(algs
->bulk
),
1753 static void acmd_list(admin
*a
, unsigned ac
, char *av
[])
1755 FOREACH_PEER(p
, { a_info(a
, "%s", p_name(p
), A_END
); });
1759 static void acmd_ifname(admin
*a
, unsigned ac
, char *av
[])
1763 if ((p
= a_findpeer(a
, av
[0])) != 0) {
1764 a_info(a
, "%s", p_ifname(p
), A_END
);
1769 static void acmd_setifname(admin
*a
, unsigned ac
, char *av
[])
1773 if ((p
= a_findpeer(a
, av
[0])) != 0) {
1774 a_notify("NEWIFNAME", "?PEER", p
, "%s", p_ifname(p
), "%s", av
[1], A_END
);
1775 p_setifname(p
, av
[1]);
1780 static void acmd_getchal(admin
*a
, unsigned ac
, char *av
[])
1784 buf_init(&b
, buf_i
, PKBUFSZ
);
1786 a_info(a
, "?B64", BBASE(&b
), (size_t)BLEN(&b
), A_END
);
1790 static void acmd_checkchal(admin
*a
, unsigned ac
, char *av
[])
1797 base64_decode(&b64
, av
[0], strlen(av
[0]), &d
);
1798 base64_decode(&b64
, 0, 0, &d
);
1799 buf_init(&b
, d
.buf
, d
.len
);
1800 if (c_check(&b
) || BBAD(&b
) || BLEFT(&b
))
1801 a_fail(a
, "invalid-challenge", A_END
);
1807 static void acmd_greet(admin
*a
, unsigned ac
, char *av
[])
1813 if ((p
= a_findpeer(a
, av
[0])) != 0) {
1815 base64_decode(&b64
, av
[1], strlen(av
[1]), &d
);
1816 base64_decode(&b64
, 0, 0, &d
);
1817 p_greet(p
, d
.buf
, d
.len
);
1823 static void acmd_addr(admin
*a
, unsigned ac
, char *av
[])
1828 if ((p
= a_findpeer(a
, av
[0])) != 0) {
1830 assert(ad
->sa
.sa_family
== AF_INET
);
1831 a_info(a
, "?ADDR", ad
, A_END
);
1836 static void acmd_peerinfo(admin
*a
, unsigned ac
, char *av
[])
1842 if ((p
= a_findpeer(a
, av
[0])) != 0) {
1844 a_info(a
, "tunnel=%s", ps
->tops
->name
, A_END
);
1845 a_info(a
, "key=%s", p_tag(p
),
1846 "current-key=%s", p
->kx
.kpub
->tag
, A_END
);
1847 if ((ptag
= p_privtag(p
)) == 0) ptag
= "(default)";
1848 a_info(a
, "private-key=%s", ptag
,
1849 "current-private-key=%s", p
->kx
.kpriv
->tag
, A_END
);
1850 a_info(a
, "keepalive=%lu", ps
->t_ka
, A_END
);
1855 static void acmd_servinfo(admin
*a
, unsigned ac
, char *av
[])
1857 a_info(a
, "implementation=edgeware-tripe", A_END
);
1858 a_info(a
, "version=%s", VERSION
, A_END
);
1859 a_info(a
, "daemon=%s", BOOL(flags
& F_DAEMON
), A_END
);
1863 static void acmd_stats(admin
*a
, unsigned ac
, char *av
[])
1868 if ((p
= a_findpeer(a
, av
[0])) == 0)
1872 a_info(a
, "start-time=%s", timestr(st
->t_start
), A_END
);
1873 a_info(a
, "last-packet-time=%s", timestr(st
->t_last
), A_END
);
1874 a_info(a
, "last-keyexch-time=%s", timestr(st
->t_kx
), A_END
);
1875 a_info(a
, "packets-in=%lu", st
->n_in
, "bytes-in=%lu", st
->sz_in
, A_END
);
1877 "packets-out=%lu", st
->n_out
,
1878 "bytes-out=%lu", st
->sz_out
,
1881 "keyexch-packets-in=%lu", st
->n_kxin
,
1882 "keyexch-bytes-in=%lu", st
->sz_kxin
,
1885 "keyexch-packets-out=%lu", st
->n_kxout
,
1886 "keyexch-bytes-out=%lu", st
->sz_kxout
,
1889 "ip-packets-in=%lu", st
->n_ipin
,
1890 "ip-bytes-in=%lu", st
->sz_ipin
,
1893 "ip-packets-out=%lu", st
->n_ipout
,
1894 "ip-bytes-out=%lu", st
->sz_ipout
,
1896 a_info(a
, "rejected-packets=%lu", st
->n_reject
, A_END
);
1900 static void acmd_kill(admin
*a
, unsigned ac
, char *av
[])
1904 if ((p
= a_findpeer(a
, av
[0])) != 0) {
1910 static void acmd_forcekx(admin
*a
, unsigned ac
, char *av
[])
1914 if ((p
= a_findpeer(a
, av
[0])) != 0) {
1915 kx_start(&p
->kx
, 1);
1920 static void acmd_reload(admin
*a
, unsigned ac
, char *av
[])
1921 { p_keyreload(); a_ok(a
); }
1923 static void acmd_quit(admin
*a
, unsigned ac
, char *av
[])
1925 a_warn("SERVER", "quit", "admin-request", A_END
);
1930 static void acmd_version(admin
*a
, unsigned ac
, char *av
[])
1932 a_info(a
, "%s", PACKAGE
, "%s", VERSION
, A_END
);
1936 static void acmd_tunnels(admin
*a
, unsigned ac
, char *av
[])
1940 for (i
= 0; tunnels
[i
]; i
++)
1941 a_info(a
, "%s", tunnels
[i
]->name
, A_END
);
1945 /* --- The command table and help --- */
1947 typedef struct acmd
{
1950 unsigned argmin
, argmax
;
1951 void (*func
)(admin */
*a*/
, unsigned /*ac*/, char */
*av*/
[]);
1954 static void acmd_help(admin */
*a*/
, unsigned /*ac*/, char */
*av*/
[]);
1956 static const acmd acmdtab
[] = {
1957 { "add", "[OPTIONS] PEER ADDR ...", 2, 0xffff, acmd_add
},
1958 { "addr", "PEER", 1, 1, acmd_addr
},
1959 { "algs", "[PEER]", 0, 1, acmd_algs
},
1960 { "bgcancel", "TAG", 1, 1, acmd_bgcancel
},
1961 { "checkchal", "CHAL", 1, 1, acmd_checkchal
},
1962 { "daemon", 0, 0, 0, acmd_daemon
},
1963 { "eping", "[OPTIONS] PEER", 1, 0xffff, acmd_eping
},
1964 { "forcekx", "PEER", 1, 1, acmd_forcekx
},
1965 { "getchal", 0, 0, 0, acmd_getchal
},
1966 { "greet", "PEER CHAL", 2, 2, acmd_greet
},
1967 { "help", 0, 0, 0, acmd_help
},
1968 { "ifname", "PEER", 1, 1, acmd_ifname
},
1969 { "jobs", 0, 0, 0, acmd_jobs
},
1970 { "kill", "PEER", 1, 1, acmd_kill
},
1971 { "list", 0, 0, 0, acmd_list
},
1972 { "notify", "MESSAGE ...", 1, 0xffff, acmd_notify
},
1973 { "peerinfo", "PEER", 1, 1, acmd_peerinfo
},
1974 { "ping", "[OPTIONS] PEER", 1, 0xffff, acmd_ping
},
1975 { "port", 0, 0, 0, acmd_port
},
1976 { "quit", 0, 0, 0, acmd_quit
},
1977 { "reload", 0, 0, 0, acmd_reload
},
1978 { "servinfo", 0, 0, 0, acmd_servinfo
},
1979 { "setifname", "PEER NEW-NAME", 2, 2, acmd_setifname
},
1980 { "svcclaim", "SERVICE VERSION", 2, 2, acmd_svcclaim
},
1981 { "svcensure", "SERVICE [VERSION]", 1, 2, acmd_svcensure
},
1982 { "svcfail", "JOBID TOKENS...", 1, 0xffff, acmd_svcfail
},
1983 { "svcinfo", "JOBID TOKENS...", 1, 0xffff, acmd_svcinfo
},
1984 { "svclist", 0, 0, 0, acmd_svclist
},
1985 { "svcok", "JOBID", 1, 1, acmd_svcok
},
1986 { "svcquery", "SERVICE", 1, 1, acmd_svcquery
},
1987 { "svcrelease", "SERVICE", 1, 1, acmd_svcrelease
},
1988 { "svcsubmit", "[OPTIONS] SERVICE TOKENS...",
1989 2, 0xffff, acmd_svcsubmit
},
1990 { "stats", "PEER", 1, 1, acmd_stats
},
1992 { "trace", "[OPTIONS]", 0, 1, acmd_trace
},
1994 { "tunnels", 0, 0, 0, acmd_tunnels
},
1995 { "version", 0, 0, 0, acmd_version
},
1996 { "warn", "MESSAGE ...", 1, 0xffff, acmd_warn
},
1997 { "watch", "[OPTIONS]", 0, 1, acmd_watch
},
2001 static void acmd_help(admin
*a
, unsigned ac
, char *av
[])
2005 for (c
= acmdtab
; c
->name
; c
++) {
2007 a_info(a
, "%s", c
->name
, "*%s", c
->help
, A_END
);
2009 a_info(a
, "%s", c
->name
, A_END
);
2014 /*----- Connection handling -----------------------------------------------*/
2016 /* --- @a_destroypending@ --- *
2022 * Use: Destroys pending admin connections at a safe time.
2025 static void a_destroypending(void)
2027 admin
*a
, *aa
, *head
;
2028 admin_bgop
*bg
, *bbg
;
2029 admin_service
*svc
, *ssvc
;
2031 /* --- Destroy connections marked as pending --- *
2033 * Slightly messy. Killing clients may cause others to finally die. Make
2034 * sure that they can be put on the list without clobbering anything or
2041 for (a
= head
; a
; a
= aa
) {
2043 assert(a
->f
& AF_DEAD
);
2045 /* --- Report what we're doing --- */
2047 T( trace(T_ADMIN
, "admin: completing destruction of connection %u",
2050 /* --- If this is the foreground client then shut down --- */
2052 if (a
->f
& AF_FOREGROUND
) {
2053 T( trace(T_ADMIN
, "admin: foreground client quit: shutting down"); )
2054 a_warn("SERVER", "quit", "foreground-eof", A_END
);
2058 /* --- Abort any background jobs in progress --- */
2060 for (bg
= a
->bg
; bg
; bg
= bbg
) {
2063 if (bg
->tag
) xfree(bg
->tag
);
2067 /* --- Release services I hold, and abort pending jobs --- */
2069 for (svc
= a
->svcs
; svc
; svc
= ssvc
) {
2073 a_jobtablefinal(&a
->j
);
2075 /* --- Close file descriptors and selectory --- */
2077 selbuf_destroy(&a
->b
);
2078 if (a
->b
.reader
.fd
!= a
->w
.fd
) close(a
->b
.reader
.fd
);
2080 if (a_stdin
== a
) a_stdin
= 0;
2089 /* --- @a_destroy@ --- *
2091 * Arguments: @admin *a@ = pointer to an admin block
2095 * Use: Destroys an admin block. This requires a certain amount of
2099 static void freequeue(oqueue
*q
)
2103 for (o
= q
->hd
; o
; o
= oo
) {
2110 static void a_destroy(admin
*a
)
2115 if (a
->next
) a
->next
->prev
= a
->prev
;
2116 if (a
->prev
) a
->prev
->next
= a
->next
;
2117 else admins
= a
->next
;
2119 if (a
->out
.hd
) sel_rmfile(&a
->w
);
2126 T( trace(T_ADMIN
, "admin: killing connection %u", a
->seq
); )
2129 /* --- @a_line@ --- *
2131 * Arguments: @char *p@ = pointer to the line read
2132 * @size_t len@ = length of the line
2133 * @void *vp@ = pointer to my admin block
2137 * Use: Handles a line of input.
2140 static void a_line(char *p
, size_t len
, void *vp
)
2155 selbuf_disable(&a
->b
);
2159 ac
= str_qsplit(p
, av
, N(av
) - 1, 0, STRF_QUOTE
);
2163 for (c
= acmdtab
; c
->name
; c
++) {
2164 if (mystrieq(av
[0], c
->name
)) {
2166 if (c
->argmin
> ac
|| ac
> c
->argmax
) {
2168 a_fail(a
, "bad-syntax", "%s", c
->name
, "", A_END
);
2170 a_fail(a
, "bad-syntax", "%s", c
->name
, "%s", c
->help
, A_END
);
2172 c
->func(a
, ac
, av
+ 1);
2176 a_fail(a
, "unknown-command", "%s", av
[0], A_END
);
2179 /* --- @a_create@ --- *
2181 * Arguments: @int fd_in, fd_out@ = file descriptors to use
2182 * @unsigned f@ = initial flags to set
2186 * Use: Creates a new admin connection.
2189 void a_create(int fd_in
, int fd_out
, unsigned f
)
2191 admin
*a
= CREATE(admin
);
2193 T( static unsigned seq
= 0;
2195 T( trace(T_ADMIN
, "admin: accepted connection %u", a
->seq
); )
2199 a_jobtableinit(&a
->j
);
2201 if (fd_in
== STDIN_FILENO
) a_stdin
= a
;
2202 fdflags(fd_in
, O_NONBLOCK
, O_NONBLOCK
, FD_CLOEXEC
, FD_CLOEXEC
);
2203 if (fd_out
!= fd_in
)
2204 fdflags(fd_out
, O_NONBLOCK
, O_NONBLOCK
, FD_CLOEXEC
, FD_CLOEXEC
);
2205 selbuf_init(&a
->b
, &sel
, fd_in
, a_line
, a
);
2206 sel_initfile(&sel
, &a
->w
, fd_out
, SEL_WRITE
, a_flush
, a
);
2207 a
->out
.hd
= a
->out
.tl
= 0;
2210 if (admins
) admins
->prev
= a
;
2214 /* --- @a_accept@ --- *
2216 * Arguments: @int fd@ = file descriptor to accept
2217 * @unsigned mode@ = what to do
2218 * @void *v@ = uninteresting pointer
2222 * Use: Accepts a new admin connection.
2225 static void a_accept(int fd
, unsigned mode
, void *v
)
2228 struct sockaddr_un sun
;
2229 socklen_t sz
= sizeof(sun
);
2231 if ((nfd
= accept(fd
, (struct sockaddr
*)&sun
, &sz
)) < 0) {
2232 if (errno
!= EINTR
&& errno
!= EAGAIN
&& errno
!= EWOULDBLOCK
&&
2233 errno
!= ECONNABORTED
&& errno
!= EPROTO
)
2234 a_warn("ADMIN", "accept-error", "?ERRNO", A_END
);
2237 a_create(nfd
, nfd
, 0);
2240 /* --- @a_preselect@ --- *
2246 * Use: Informs the admin module that we're about to select again,
2247 * and that it should do cleanup things it has delayed until a
2251 void a_preselect(void) { if (a_dead
) a_destroypending(); }
2253 /* --- @a_daemon@ --- *
2259 * Use: Informs the admin module that it's a daemon.
2262 void a_daemon(void) { flags
|= F_DAEMON
; }
2264 /* --- @a_init@ --- *
2266 * Arguments: @const char *name@ = socket name to create
2267 * @uid_t u@ = user to own the socket
2268 * @gid_t g@ = group to own the socket
2269 * @mode_t m@ = permissions to set on the socket
2273 * Use: Creates the admin listening socket.
2276 void a_init(const char *name
, uid_t u
, gid_t g
, mode_t m
)
2280 struct sockaddr_un sun
;
2281 struct sigaction sa
;
2285 /* --- Create services table --- */
2287 sym_create(&a_svcs
);
2289 /* --- Set up the socket address --- */
2291 sz
= strlen(name
) + 1;
2292 if (sz
> sizeof(sun
.sun_path
))
2293 die(EXIT_FAILURE
, "socket name `%s' too long", name
);
2295 sun
.sun_family
= AF_UNIX
;
2296 memcpy(sun
.sun_path
, name
, sz
);
2297 sz
+= offsetof(struct sockaddr_un
, sun_path
);
2299 /* --- Attempt to bind to the socket --- */
2301 omask
= umask(0077);
2303 if ((fd
= socket(PF_UNIX
, SOCK_STREAM
, 0)) < 0)
2304 die(EXIT_FAILURE
, "couldn't create socket: %s", strerror(errno
));
2305 if (bind(fd
, (struct sockaddr
*)&sun
, sz
) < 0) {
2308 if (errno
!= EADDRINUSE
) {
2309 die(EXIT_FAILURE
, "couldn't bind to address `%s': %s",
2310 sun
.sun_path
, strerror(e
));
2313 die(EXIT_FAILURE
, "too many retries; giving up");
2315 if (!connect(fd
, (struct sockaddr
*)&sun
, sz
)) {
2316 die(EXIT_FAILURE
, "server already listening on admin socket `%s'",
2319 if (errno
!= ECONNREFUSED
)
2320 die(EXIT_FAILURE
, "couldn't bind to address: %s", strerror(e
));
2321 if (stat(sun
.sun_path
, &st
)) {
2322 die(EXIT_FAILURE
, "couldn't stat `%s': %s",
2323 sun
.sun_path
, strerror(errno
));
2325 if (!S_ISSOCK(st
.st_mode
))
2326 die(EXIT_FAILURE
, "object `%s' isn't a socket", sun
.sun_path
);
2327 T( trace(T_ADMIN
, "admin: stale socket found; removing it"); )
2328 unlink(sun
.sun_path
);
2332 if (chown(sun
.sun_path
, u
, g
)) {
2333 die(EXIT_FAILURE
, "failed to set socket owner: %s",
2336 if (chmod(sun
.sun_path
, m
)) {
2337 die(EXIT_FAILURE
, "failed to set socket permissions: %s",
2341 fdflags(fd
, O_NONBLOCK
, O_NONBLOCK
, FD_CLOEXEC
, FD_CLOEXEC
);
2343 die(EXIT_FAILURE
, "couldn't listen on socket: %s", strerror(errno
));
2345 /* --- Listen to the socket --- */
2347 sel_initfile(&sel
, &sock
, fd
, SEL_READ
, a_accept
, 0);
2351 T( trace_custom(a_trace
, 0);
2352 trace(T_ADMIN
, "admin: enabled custom tracing"); )
2355 /* --- Set up signal handlers --- */
2357 sig_add(&s_term
, SIGTERM
, a_sigdie
, 0);
2358 sig_add(&s_hup
, SIGHUP
, a_sighup
, 0);
2359 signal(SIGPIPE
, SIG_IGN
);
2360 sigaction(SIGINT
, 0, &sa
);
2361 if (sa
.sa_handler
!= SIG_IGN
)
2362 sig_add(&s_int
, SIGINT
, a_sigdie
, 0);
2365 /*----- That's all, folks -------------------------------------------------*/