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
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation; either version 2 of the License, or
15 * (at your option) any later version.
17 * TrIPE is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
22 * You should have received a copy of the GNU General Public License
23 * along with TrIPE; if not, write to the Free Software Foundation,
24 * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
27 /*----- Header files ------------------------------------------------------*/
31 /*----- Global variables --------------------------------------------------*/
35 const trace_opt tr_opts
[] = {
36 { 't', T_TUNNEL
, "tunnel events" },
37 { 'r', T_PEER
, "peer events" },
38 { 'a', T_ADMIN
, "admin interface" },
39 { 's', T_KEYSET
, "symmetric keyset management" },
40 { 'x', T_KEYEXCH
, "key exchange" },
41 { 'm', T_KEYMGMT
, "key management" },
42 { 'l', T_CHAL
, "challenge management" },
43 { 'v', T_PRIVSEP
, "privilege separation" },
44 { 'p', T_PACKET
, "packet contents" },
45 { 'c', T_CRYPTO
, "crypto details" },
46 { 'A', T_ALL
, "all of the above" },
50 unsigned tr_flags
= 0;
53 static const trace_opt w_opts
[] = {
54 { 't', AF_TRACE
, "trace messages" },
55 { 'n', AF_NOTE
, "asynchronous notifications" },
56 { 'w', AF_WARN
, "warnings" },
57 { 'A', AF_ALLMSGS
, "all of the above" },
61 /*----- Static variables --------------------------------------------------*/
66 static const char *sockname
;
67 static sym_table a_svcs
;
68 static unsigned flags
= 0;
69 static admin
*a_stdin
= 0;
70 static sig s_term
, s_int
, s_hup
;
74 #define F_FOREGROUND 4u
76 #define T_RESOLVE SEC(30)
79 static void a_destroy(admin */
*a*/
);
81 #define BOOL(x) ((x) ? "t" : "nil")
83 /*----- Output functions --------------------------------------------------*/
85 /* --- @trywrite@ --- *
87 * Arguments: @admin *a@ = pointer to an admin block
88 * @const char *p@ = pointer to buffer to write
89 * @size_t sz@ = size of data to write
91 * Returns: The number of bytes written, or less than zero on error.
93 * Use: Attempts to write data to a client.
96 static ssize_t
trywrite(admin
*a
, const char *p
, size_t sz
)
103 n
= write(a
->w
.fd
, p
, sz
);
113 if (errno
!= EAGAIN
&& errno
!= EWOULDBLOCK
) {
115 a_warn("ADMIN", "client-write-error", "?ERRNO", A_END
);
122 /* --- @doqueue@ -- *
124 * Arguments: @oqueue *q@ = pointer to output queue
125 * @const char *p@ = pointer to buffer to write
126 * @size_t sz@ = size of buffer
128 * Returns: Nonzero if the queue was previously empty.
130 * Use: Queues data to be written later.
133 static int doqueue(oqueue
*q
, const char *p
, size_t sz
)
142 else if (o
->p_in
< o
->buf
+ OBUFSZ
)
146 o
= xmalloc(sizeof(obuf
));
148 o
->p_in
= o
->p_out
= o
->buf
;
156 n
= o
->buf
+ OBUFSZ
- o
->p_in
;
159 memcpy(o
->p_in
, p
, n
);
168 /* --- @dosend@ --- *
170 * Arguemnts: @admin *a@ = pointer to an admin block
171 * @const char *p@ = pointer to buffer to write
172 * @size_t sz@ = size of data to write
176 * Use: Sends data to an admin client.
179 static void dosend(admin
*a
, const char *p
, size_t sz
)
186 if ((n
= trywrite(a
, p
, sz
)) < 0)
193 if (doqueue(&a
->out
, p
, sz
))
197 /* --- @a_flush@ --- *
199 * Arguments: @int fd@ = file descriptor
200 * @unsigned mode@ = what's happening
201 * @void *v@ = pointer to my admin block
205 * Use: Flushes buffers when a client is ready to read again.
208 static void a_flush(int fd
, unsigned mode
, void *v
)
216 if ((n
= trywrite(a
, o
->p_out
, o
->p_in
- o
->p_out
)) < 0)
219 if (o
->p_in
< o
->p_out
)
232 /*----- Utility functions -------------------------------------------------*/
234 /* --- @a_vformat@ --- *
236 * Arguments: @dstr *d@ = where to leave the formatted message
237 * @const char *fmt@ = pointer to format string
238 * @va_list ap@ = arguments in list
242 * Use: Main message token formatting driver. The arguments are
243 * interleaved formatting tokens and their parameters, finally
244 * terminated by an entry @A_END@.
248 * * "*..." ... -- pretokenized @dstr_putf@-like string
250 * * "?ADDR" SOCKADDR -- a socket address, to be converted
252 * * "?B64" BUFFER SIZE -- binary data to be base64-encoded
254 * * "?TOKENS" VECTOR -- null-terminated vector of tokens
256 * * "?PEER" PEER -- peer's name
258 * * "?ERRNO" ERRNO -- system error code
260 * * "[!]..." ... -- @dstr_putf@-like string as single token
263 void a_vformat(dstr
*d
, const char *fmt
, va_list ap
)
269 if (d
->len
) dstr_putc(d
, ' ');
270 dstr_vputf(d
, fmt
+ 1, &ap
);
271 } else if (*fmt
== '?') {
272 if (strcmp(fmt
, "?ADDR") == 0) {
273 const addr
*a
= va_arg(ap
, const addr
*);
274 switch (a
->sa
.sa_family
) {
276 u_quotify(d
, "INET");
277 u_quotify(d
, inet_ntoa(a
->sin
.sin_addr
));
278 dstr_putf(d
, " %u", (unsigned)ntohs(a
->sin
.sin_port
));
283 } else if (strcmp(fmt
, "?B64") == 0) {
284 const octet
*p
= va_arg(ap
, const octet
*);
285 size_t n
= va_arg(ap
, size_t);
291 base64_encode(&b64
, p
, n
, d
);
292 base64_encode(&b64
, 0, 0, d
);
293 while (d
->len
&& d
->buf
[d
->len
- 1] == '=') d
->len
--;
294 } else if (strcmp(fmt
, "?TOKENS") == 0) {
295 const char *const *av
= va_arg(ap
, const char *const *);
296 while (*av
) u_quotify(d
, *av
++);
297 } else if (strcmp(fmt
, "?PEER") == 0)
298 u_quotify(d
, p_name(va_arg(ap
, peer
*)));
299 else if (strcmp(fmt
, "?ERRNO") == 0) {
300 dstr_putf(d
, " E%d", errno
);
301 u_quotify(d
, strerror(errno
));
305 if (*fmt
== '!') fmt
++;
307 dstr_vputf(&dd
, fmt
, &ap
);
308 u_quotify(d
, dd
.buf
);
310 fmt
= va_arg(ap
, const char *);
316 /* --- @a_write@, @a_vwrite@ --- *
318 * Arguments: @admin *a@ = admin connection to write to
319 * @const char *status@ = status code to report
320 * @const char *tag@ = tag string, or null
321 * @const char *fmt@ = pointer to format string
322 * @va_list ap@ = arguments in list
323 * @...@ = other arguments
327 * Use: Sends a message to an admin connection.
330 static void a_vwrite(admin
*a
, const char *status
, const char *tag
,
331 const char *fmt
, va_list ap
)
335 if (tag
) dstr_puts(&d
, "BG");
336 dstr_puts(&d
, status
);
337 if (tag
) u_quotify(&d
, tag
);
338 a_vformat(&d
, fmt
, ap
);
340 dosend(a
, d
.buf
, d
.len
);
344 static void a_write(admin
*a
, const char *status
, const char *tag
,
345 const char *fmt
, ...)
350 a_vwrite(a
, status
, tag
, fmt
, ap
);
354 /* --- @a_ok@, @a_info@, @a_fail@ --- *
356 * Arguments: @admin *a@ = connection
357 * @const char *fmt@ = format string
358 * @...@ = other arguments
362 * Use: Convenience functions for @a_write@.
365 static void a_ok(admin
*a
) { a_write(a
, "OK", 0, A_END
); }
367 static void a_info(admin
*a
, const char *fmt
, ...)
372 a_vwrite(a
, "INFO", 0, fmt
, ap
);
376 static void a_fail(admin
*a
, const char *fmt
, ...)
381 a_vwrite(a
, "FAIL", 0, fmt
, ap
);
385 /* --- @a_alert@, @a_valert@, @a_rawalert@ --- *
387 * Arguments: @unsigned f_and, f_eq@ = filter for connections
388 * @const char *status@ = status string
389 * @const char *fmt@ = pointer to format string
390 * @const char *p@ = pointer to raw string
391 * @size_t sz@ = size of raw string
392 * @va_list ap@ = arguments in list
393 * @...@ = other arguments
397 * Use: Write a message to all admin connections matched by the given
401 static void a_rawalert(unsigned f_and
, unsigned f_eq
, const char *status
,
402 const char *p
, size_t sz
)
407 if (!(flags
& F_INIT
))
409 dstr_puts(&d
, status
);
412 dstr_putm(&d
, p
, sz
);
417 for (a
= admins
; a
; a
= aa
) {
419 if ((a
->f
& f_and
) == f_eq
)
420 dosend(a
, d
.buf
, d
.len
);
425 static void a_valert(unsigned f_and
, unsigned f_eq
, const char *status
,
426 const char *fmt
, va_list ap
)
430 if (!(flags
& F_INIT
))
432 a_vformat(&d
, fmt
, ap
);
433 a_rawalert(f_and
, f_eq
, status
, fmt ? d
.buf
: 0, fmt ? d
.len
: 0);
437 static void a_alert(unsigned f_and
, unsigned f_eq
, const char *status
,
438 const char *fmt
, ...)
443 a_valert(f_and
, f_eq
, status
, fmt
, ap
);
447 /* --- @a_warn@ --- *
449 * Arguments: @const char *fmt@ = pointer to format string
450 * @...@ = other arguments
454 * Use: Informs all admin connections of a warning.
457 void a_warn(const char *fmt
, ...)
463 a_valert(0, 0, "WARN", fmt
, ap
);
466 fprintf(stderr
, "%s: ", QUIS
);
467 a_vformat(&d
, fmt
, ap
);
469 dstr_write(&d
, stderr
);
475 /* --- @a_trace@ --- *
477 * Arguments: @const char *p@ = pointer to a buffer
478 * @size_t sz@ = size of the buffer
479 * @void *v@ = uninteresting pointer
483 * Use: Custom trace output handler. Sends trace messages to
484 * interested admin connections.
488 static void a_trace(const char *p
, size_t sz
, void *v
)
489 { a_rawalert(AF_TRACE
, AF_TRACE
, "TRACE", p
, sz
); }
492 /* --- @a_notify@ --- *
494 * Arguments: @const char *fmt@ = pointer to format string
495 * @...@ = other arguments
499 * Use: Sends a notification to interested admin connections.
502 void a_notify(const char *fmt
, ...)
507 a_valert(AF_NOTE
, AF_NOTE
, "NOTE", fmt
, ap
);
511 /* --- @a_quit@ --- *
517 * Use: Shuts things down nicely.
524 FOREACH_PEER(p
, { p_destroy(p
); });
529 /* --- @a_sigdie@ --- *
531 * Arguments: @int sig@ = signal number
532 * @void *v@ = an uninteresting argument
536 * Use Shuts down on receipt of a fatal signal.
539 static void a_sigdie(int sig
, void *v
)
545 case SIGTERM
: p
= "SIGTERM"; break;
546 case SIGINT
: p
= "SIGINT"; break;
548 sprintf(buf
, "%i", sig
);
552 a_warn("SERVER", "quit", "signal", "%s", p
, A_END
);
556 /* --- @a_sighup@ --- *
558 * Arguments: @int sig@ = signal number
559 * @void *v@ = an uninteresting argument
563 * Use Logs a message about SIGHUP not being useful.
566 static void a_sighup(int sig
, void *v
)
567 { a_warn("SERVER", "ignore", "signal", "SIGHUP", A_END
); }
569 /* --- @a_parsetime@ --- *
571 * Arguments; @const char *p@ = time string to parse
573 * Returns: Time in seconds, or @< 0@ on error.
576 static long a_parsetime(const char *p
)
579 long t
= strtol(p
, &q
, 0);
585 case 's': if (q
[1] != 0)
592 /* --- @a_findpeer@ --- *
594 * Arguments: @admin *a@ = admin connection
595 * @const char *pn@ = peer name
597 * Returns: The peer, or null if not there.
599 * Use: Finds a peer, reporting an error if it failed.
602 static peer
*a_findpeer(admin
*a
, const char *pn
)
606 if ((p
= p_find(pn
)) == 0)
607 a_fail(a
, "unknown-peer", "%s", pn
, A_END
);
611 /*----- Backgrounded operations -------------------------------------------*/
614 (((admin_bgop *)(bg))->tag ? ((admin_bgop *)(bg))->tag : "<foreground>")
616 /* --- @a_bgfind@ --- *
618 * Arguments: @admin *a@ = a client block
619 * @const char *tag@ = the requested tag
621 * Returns: The requested background job, or null.
624 static admin_bgop
*a_bgfind(admin
*a
, const char *tag
)
628 for (bg
= a
->bg
; bg
; bg
= bg
->next
) {
629 if (bg
->tag
&& strcmp(tag
, bg
->tag
) == 0)
635 /* --- @a_bgrelease@ --- *
637 * Arguments: @admin_bgop *bg@ = backgrounded operation
641 * Use: Removes a backgrounded operation from the queue, since
642 * (presumably) it's done.
645 static void a_bgrelease(admin_bgop
*bg
)
649 T( trace(T_ADMIN
, "admin: release bgop %s", BGTAG(bg
)); )
650 if (bg
->tag
) xfree(bg
->tag
);
651 else selbuf_enable(&a
->b
);
652 if (bg
->next
) bg
->next
->prev
= bg
->prev
;
653 if (bg
->prev
) bg
->prev
->next
= bg
->next
;
654 else a
->bg
= bg
->next
;
656 if (!a
->bg
&& (a
->f
& AF_CLOSE
)) a_destroy(a
);
659 /* --- @a_bgok@, @a_bginfo@, @a_bgfail@ --- *
661 * Arguments: @admin_bgop *bg@ = backgrounded operation
662 * @const char *fmt@ = format string
663 * @...@ = other arguments
667 * Use: Convenience functions for @a_write@.
670 static void a_bgok(admin_bgop
*bg
)
671 { a_write(bg
->a
, "OK", bg
->tag
, A_END
); }
673 static void a_bginfo(admin_bgop
*bg
, const char *fmt
, ...)
677 a_vwrite(bg
->a
, "INFO", bg
->tag
, fmt
, ap
);
681 static void a_bgfail(admin_bgop
*bg
, const char *fmt
, ...)
685 a_vwrite(bg
->a
, "FAIL", bg
->tag
, fmt
, ap
);
689 /* --- @a_bgadd@ --- *
691 * Arguments: @admin *a@ = administration connection
692 * @admin_bgop *bg@ = pointer to background operation
693 * @const char *tag@ = background tag, or null for foreground
694 * @void (*cancel)(admin_bgop *)@ = cancel function
696 * Returns: Zero for success, nonzero on failure.
698 * Use: Links a background job into the list.
701 static int a_bgadd(admin
*a
, admin_bgop
*bg
, const char *tag
,
702 void (*cancel
)(admin_bgop
*))
705 if (a_bgfind(a
, tag
)) {
706 a_fail(a
, "tag-exists", "%s", tag
, A_END
);
709 bg
->tag
= xstrdup(tag
);
713 selbuf_disable(&a
->b
);
719 if (a
->bg
) a
->bg
->prev
= bg
;
721 T( trace(T_ADMIN
, "admin: add bgop %s", BGTAG(bg
)); )
722 if (tag
) a_write(a
, "DETACH", tag
, A_END
);
726 /*----- Job table manipulation --------------------------------------------*/
729 #define JOB_INDEXMASK ((1ul << JOB_SHIFT) - 1)
730 #define JOB_SEQMASK ((1ul << (32 - JOB_SHIFT)) - 1)
732 #define JOB_END 0xfffffffful
734 static unsigned long a_joboffset
;
736 /* --- @a_jobidencode@ --- *
738 * Arguments: @admin_svcop *svc@ = pointer to a service operation
740 * Returns: A jobid for this job, in an internal static buffer.
742 * Use: Constructs a jobid. In order to dissuade people from
743 * predicting jobids, we obfuscate them.
745 * A `raw' jobid consists of two 16-bit fields. The low 16 bits
746 * are an index into a big array. The high 16 bits are a
747 * sequence number recording how many times that slot has been
750 * This `raw' jobid is then obfuscated by adding a randomly-
751 * generated offset, and multiplying (mod %$2^{32}$%) by a fixed
755 static const char *a_jobidencode(admin_svcop
*svc
)
757 admin_jobtable
*j
= &svc
->prov
->j
;
762 assert(svc
->index
<= JOB_INDEXMASK
);
763 seq
= j
->v
[svc
->index
].seq
;
764 assert(seq
<= JOB_SEQMASK
);
765 pre
= (unsigned long)svc
->index
| ((unsigned long)seq
<< JOB_SHIFT
);
766 sprintf(buf
, "J%08lx", ((pre
+ a_joboffset
) * 0x0f87a7a3ul
) & 0xffffffff);
770 /* --- @a_jobiddecode@ --- *
772 * Arguments: @admin_jobtable *j@ = pointer to a job table
773 * @const char *jid@ = pointer to a jobid string
775 * Returns: A pointer to the job's @svcop@ structure.
778 static admin_svcop
*a_jobiddecode(admin_jobtable
*j
, const char *jid
)
785 for (i
= 1; i
< 9; i
++) {
786 if (!isxdigit((unsigned char)jid
[i
]))
791 pre
= strtoul(jid
+ 1, 0, 16);
792 pre
= ((pre
* 0xbd11c40bul
) - a_joboffset
) & 0xffffffff;
793 i
= pre
& JOB_INDEXMASK
;
794 if (i
>= j
->n
|| j
->v
[i
].seq
!= (pre
>> JOB_SHIFT
))
796 return (j
->v
[i
].u
.op
);
799 /* --- @a_jobcreate@ --- *
801 * Arguments: @admin *a@ = pointer to administration client
803 * Returns: A pointer to a freshly-allocated @svcop@, or null.
805 * Use: Allocates a fresh @svcop@ and links it into a job table.
808 static admin_svcop
*a_jobcreate(admin
*a
)
813 admin_jobtable
*j
= &a
->j
;
815 if (j
->free
!= JOB_END
) {
817 j
->free
= j
->v
[i
].u
.next
;
820 if (j
->sz
> JOB_INDEXMASK
)
825 j
->v
= xmalloc(j
->sz
* sizeof(*j
->v
));
828 j
->v
= xrealloc(j
->v
, j
->sz
* sizeof(*j
->v
), sz
* sizeof(*j
->v
));
834 svc
= xmalloc(sizeof(*svc
));
837 svc
->next
= j
->active
;
839 if (j
->active
) j
->active
->prev
= svc
;
842 IF_TRACING(T_ADMIN
, {
843 trace(T_ADMIN
, "admin: created job %s (%u)", a_jobidencode(svc
), i
);
848 /* --- @a_jobdestroy@ --- *
850 * Arguments: @admin_svcop *svc@ = pointer to job block
854 * Use: Frees up a completed (or cancelled) job.
857 static void a_jobdestroy(admin_svcop
*svc
)
859 admin
*a
= svc
->prov
;
860 admin_jobtable
*j
= &a
->j
;
861 unsigned i
= svc
->index
;
863 IF_TRACING(T_ADMIN
, {
864 trace(T_ADMIN
, "admin: destroying job %s (%u)", a_jobidencode(svc
), i
);
866 assert(j
->v
[i
].u
.op
= svc
);
867 j
->v
[i
].u
.next
= j
->free
;
870 if (svc
->next
) svc
->next
->prev
= svc
->prev
;
871 if (svc
->prev
) svc
->prev
->next
= svc
->next
;
872 else j
->active
= svc
->next
;
875 /* --- @a_jobtableinit@ --- *
877 * Arguments: @admin_jobtable *j@ = pointer to job table
881 * Use: Initializes a job table.
884 static void a_jobtableinit(admin_jobtable
*j
)
887 a_joboffset
= GR_RANGE(&rand_global
, 0xffffffff) + 1;
894 /* --- @a_jobtablefinal@ --- *
896 * Arguments: @admin_jobtable *j@ = pointer to job table
900 * Use: Closes down a job table.
903 static void a_jobtablefinal(admin_jobtable
*j
)
905 admin_svcop
*svc
, *ssvc
;
907 for (svc
= j
->active
; svc
; svc
= ssvc
) {
909 a_bgfail(&svc
->bg
, "provider-failed", A_END
);
910 a_bgrelease(&svc
->bg
);
912 if (j
->v
) xfree(j
->v
);
915 /*----- Services infrastructure -------------------------------------------*/
917 /* --- @a_svcfind@ --- *
919 * Arguments: @admin *a@ = the requesting client
920 * @const char *name@ = service name wanted
922 * Returns: The service requested, or null.
924 * Use: Finds a service; reports an error if the service couldn't be
928 static admin_service
*a_svcfind(admin
*a
, const char *name
)
932 if ((svc
= sym_find(&a_svcs
, name
, -1, 0, 0)) == 0) {
933 a_fail(a
, "unknown-service", "%s", name
, A_END
);
939 /* --- @a_svcunlink@ --- *
941 * Arguments: @admin_service *svc@ = pointer to service structure
945 * Use: Unlinks the service from its provider, without issuing a
946 * message or freeing the structure. The version string is
950 static void a_svcunlink(admin_service
*svc
)
953 svc
->next
->prev
= svc
->prev
;
955 svc
->prev
->next
= svc
->next
;
957 svc
->prov
->svcs
= svc
->next
;
961 /* --- @a_svcrelease@ --- *
963 * Arguments: @admin_service *svc@ = pointer to service structure
967 * Use: Releases a service and frees its structure.
970 static void a_svcrelease(admin_service
*svc
)
972 a_notify("SVCRELEASE", "%s", SYM_NAME(svc
), A_END
);
974 sym_remove(&a_svcs
, svc
);
977 /*----- Name resolution operations ----------------------------------------*/
979 /* --- @a_resolved@ --- *
981 * Arguments: @struct hostent *h@ = pointer to resolved hostname
982 * @void *v@ = pointer to resolver operation
986 * Use: Handles a completed name resolution.
989 static void a_resolved(struct hostent
*h
, void *v
)
993 T( trace(T_ADMIN
, "admin: resop %s resolved", BGTAG(r
)); )
996 a_bgfail(&r
->bg
, "resolve-error", "%s", r
->addr
, A_END
);
997 r
->func(r
, ARES_FAIL
);
999 memcpy(&r
->sa
.sin
.sin_addr
, h
->h_addr
, sizeof(struct in_addr
));
1000 r
->func(r
, ARES_OK
);
1004 a_bgrelease(&r
->bg
);
1007 /* --- @a_restimer@ --- *
1009 * Arguments: @struct timeval *tv@ = timer
1010 * @void *v@ = pointer to resolver operation
1014 * Use: Times out a resolver.
1017 static void a_restimer(struct timeval
*tv
, void *v
)
1021 T( trace(T_ADMIN
, "admin: resop %s timeout", BGTAG(r
)); )
1022 a_bgfail(&r
->bg
, "resolver-timeout", "%s", r
->addr
, A_END
);
1023 r
->func(r
, ARES_FAIL
);
1026 a_bgrelease(&r
->bg
);
1029 /* --- @a_rescancel@ --- *
1031 * Arguments: @admin_bgop *bg@ = background operation
1035 * Use: Cancels an add operation.
1038 static void a_rescancel(admin_bgop
*bg
)
1040 admin_resop
*r
= (admin_resop
*)bg
;
1042 T( trace(T_ADMIN
, "admin: cancel resop %s", BGTAG(r
)); )
1043 r
->func(r
, ARES_FAIL
);
1049 /* --- @a_resolve@ --- *
1051 * Arguments: @admin *a@ = administration connection
1052 * @admin_resop *r@ = resolver operation to run
1053 * @const char *tag@ = background operation tag
1054 * @void (*func)(struct admin_resop *, int@ = handler function
1055 * @unsigned ac@ = number of remaining arguments
1056 * @char *av[]@ = pointer to remaining arguments
1060 * Use: Cranks up a resolver job.
1063 static void a_resolve(admin
*a
, admin_resop
*r
, const char *tag
,
1064 void (*func
)(struct admin_resop
*, int),
1065 unsigned ac
, char *av
[])
1072 /* --- Fill in the easy bits of address --- */
1074 r
->bg
.tag
= "<starting>";
1077 if (mystrieq(av
[i
], "inet")) i
++;
1078 if (ac
- i
!= 1 && ac
- i
!= 2) {
1079 a_fail(a
, "bad-addr-syntax", "[inet] ADDRESS [PORT]", A_END
);
1082 r
->sa
.sin
.sin_family
= AF_INET
;
1083 r
->sasz
= sizeof(r
->sa
.sin
);
1084 r
->addr
= xstrdup(av
[i
]);
1088 pt
= strtoul(av
[i
+ 1], &p
, 0);
1090 struct servent
*s
= getservbyname(av
[i
+ 1], "udp");
1092 a_fail(a
, "unknown-service", "%s", av
[i
+ 1], A_END
);
1095 pt
= ntohs(s
->s_port
);
1098 if (pt
== 0 || pt
>= 65536) {
1099 a_fail(a
, "invalid-port", "%lu", pt
, A_END
);
1102 r
->sa
.sin
.sin_port
= htons(pt
);
1104 /* --- Report backgrounding --- *
1106 * Do this for consistency of interface, even if we're going to get the
1107 * answer straight away.
1110 if (a_bgadd(a
, &r
->bg
, tag
, a_rescancel
))
1112 T( trace(T_ADMIN
, "admin: %u, resop %s, hostname `%s'",
1113 a
->seq
, BGTAG(r
), r
->addr
); )
1115 /* --- If the name is numeric, do it the easy way --- */
1117 if (inet_aton(av
[i
], &r
->sa
.sin
.sin_addr
)) {
1118 T( trace(T_ADMIN
, "admin: resop %s done the easy way", BGTAG(r
)); )
1121 a_bgrelease(&r
->bg
);
1125 /* --- Store everything for later and crank up the resolver --- */
1127 gettimeofday(&tv
, 0);
1128 tv
.tv_sec
+= T_RESOLVE
;
1129 sel_addtimer(&sel
, &r
->t
, &tv
, a_restimer
, r
);
1130 bres_byname(&r
->r
, r
->addr
, a_resolved
, r
);
1135 if (r
->addr
) xfree(r
->addr
);
1139 /*----- Option parsing ----------------------------------------------------*/
1141 #define OPTIONS(argc, argv, guts) do { \
1142 char **o_av = argv; \
1146 if (mystrieq(*o_av, "--")) { \
1151 if (**o_av == '-') \
1155 argc -= o_av - argv; \
1159 #define OPT(name, guts) if (mystrieq(*o_av, name)) { guts continue; }
1161 #define OPTARG(name, arg, guts) OPT(name, { \
1164 if (!arg) goto bad_syntax; \
1168 #define OPTTIME(name, arg, guts) OPTARG(name, o_arg, { \
1170 if ((arg = a_parsetime(o_arg)) < 0) { \
1171 a_fail(a, "bad-time-spec", "%s", o_arg, A_END); \
1177 /*----- Adding peers ------------------------------------------------------*/
1179 /* --- @a_doadd@ --- *
1181 * Arguments: @admin_resop *r@ = resolver operation
1182 * @int rc@ = how it worked
1186 * Use: Handles a completed resolution.
1189 static void a_doadd(admin_resop
*r
, int rc
)
1191 admin_addop
*add
= (admin_addop
*)r
;
1193 T( trace(T_ADMIN
, "admin: done add op %s", BGTAG(add
)); )
1195 if (rc
== ARES_OK
) {
1196 add
->peer
.sasz
= add
->r
.sasz
;
1197 add
->peer
.sa
= add
->r
.sa
;
1198 if (p_findbyaddr(&add
->r
.sa
))
1199 a_bgfail(&add
->r
.bg
, "peer-addr-exists", "?ADDR", &add
->r
.sa
, A_END
);
1200 else if (p_find(add
->peer
.name
))
1201 a_bgfail(&add
->r
.bg
, "peer-exists", "%s", add
->peer
.name
, A_END
);
1202 else if (!p_create(&add
->peer
))
1203 a_bgfail(&add
->r
.bg
, "peer-create-fail", "%s", add
->peer
.name
, A_END
);
1208 if (add
->peer
.tag
) xfree(add
->peer
.tag
);
1209 xfree(add
->peer
.name
);
1212 /* --- @acmd_add@ --- *
1214 * Arguments: @admin *a@ = connection which requested the addition
1215 * @unsigned ac@ = argument count
1216 * @char *av[]@ = pointer to the argument list
1220 * Use: Adds a new peer.
1223 static void acmd_add(admin
*a
, unsigned ac
, char *av
[])
1225 const char *tag
= 0;
1228 /* --- Set stuff up --- */
1230 add
= xmalloc(sizeof(*add
));
1234 add
->peer
.tops
= tun_default
;
1237 /* --- Parse options --- */
1240 OPTARG("-background", arg
, { tag
= arg
; })
1241 OPTARG("-tunnel", arg
, {
1245 a_fail(a
, "unknown-tunnel", "%s", arg
, A_END
);
1248 if (mystrieq(arg
, tunnels
[i
]->name
)) {
1249 add
->peer
.tops
= tunnels
[i
];
1254 OPTTIME("-keepalive", t
, { add
->peer
.t_ka
= t
; })
1255 OPT("-cork", { add
->peer
.kxf
|= KXF_CORK
; })
1256 OPTARG("-key", arg
, {
1258 xfree(add
->peer
.tag
);
1259 add
->peer
.tag
= xstrdup(arg
);
1263 /* --- Make sure someone's not got there already --- */
1265 if (!av
[0] || !av
[1])
1268 a_fail(a
, "peer-exists", "%s", *av
, A_END
);
1271 add
->peer
.name
= xstrdup(*av
++);
1274 /* --- Crank up the resolver --- */
1276 a_resolve(a
, &add
->r
, tag
, a_doadd
, ac
, av
);
1279 /* --- Clearing up --- */
1282 a_fail(a
, "bad-syntax", "add", "[OPTIONS] PEER ADDR ...", A_END
);
1284 if (add
->peer
.name
) xfree(add
->peer
.name
);
1285 if (add
->peer
.tag
) xfree(add
->peer
.tag
);
1290 /*----- Ping --------------------------------------------------------------*/
1292 /* --- @a_pingcancel@ --- *
1294 * Arguments: @admin_bgop *bg@ = background operation block
1298 * Use: Cancels a running ping.
1301 static void a_pingcancel(admin_bgop
*bg
)
1303 admin_pingop
*pg
= (admin_pingop
*)bg
;
1304 T( trace(T_ADMIN
, "admin: cancel ping op %s", BGTAG(pg
)); )
1305 p_pingdone(&pg
->ping
, PING_NONOTIFY
);
1308 /* --- @a_pong@ --- *
1310 * Arguments: @int rc@ = return code
1311 * @void *v@ = ping operation block
1315 * Use: Collects what happened to a ping message.
1318 static void a_pong(int rc
, void *v
)
1320 admin_pingop
*pg
= v
;
1326 gettimeofday(&tv
, 0);
1327 tv_sub(&tv
, &tv
, &pg
->pingtime
);
1328 millis
= (double)tv
.tv_sec
* 1000 + (double)tv
.tv_usec
/1000;
1329 a_bginfo(&pg
->bg
, "ping-ok", "%.1f", millis
, A_END
);
1333 a_bginfo(&pg
->bg
, "ping-timeout", A_END
);
1337 a_bginfo(&pg
->bg
, "ping-peer-died", A_END
);
1343 T( trace(T_ADMIN
, "admin: ponged ping op %s", BGTAG(pg
)); )
1344 a_bgrelease(&pg
->bg
);
1347 /* --- @acmd_ping@, @acmd_eping@ --- *
1349 * Arguments: @admin *a@ = connection which requested the ping
1350 * @unsigned ac@ = argument count
1351 * @char *av[]@ = pointer to the argument list
1355 * Use: Pings a peer.
1358 static void a_ping(admin
*a
, unsigned ac
, char *av
[],
1359 const char *cmd
, unsigned msg
)
1363 admin_pingop
*pg
= 0;
1364 const char *tag
= 0;
1367 OPTARG("-background", arg
, { tag
= arg
; })
1368 OPTTIME("-timeout", arg
, { t
= arg
; })
1370 if (!*av
|| av
[1]) goto bad_syntax
;
1371 if ((p
= a_findpeer(a
, *av
)) == 0)
1373 pg
= xmalloc(sizeof(*pg
));
1374 gettimeofday(&pg
->pingtime
, 0);
1375 if (a_bgadd(a
, &pg
->bg
, tag
, a_pingcancel
))
1377 T( trace(T_ADMIN
, "admin: ping op %s: %s to %s",
1378 BGTAG(pg
), cmd
, p_name(p
)); )
1379 if (p_pingsend(p
, &pg
->ping
, msg
, t
, a_pong
, pg
)) {
1380 a_bgfail(&pg
->bg
, "ping-send-failed", A_END
);
1381 a_bgrelease(&pg
->bg
);
1386 a_fail(a
, "bad-syntax", "%s", cmd
, "[OPTIONS] PEER", cmd
, A_END
);
1392 static void acmd_ping(admin
*a
, unsigned ac
, char *av
[])
1393 { a_ping(a
, ac
, av
, "ping", MISC_PING
); }
1394 static void acmd_eping(admin
*a
, unsigned ac
, char *av
[])
1395 { a_ping(a
, ac
, av
, "eping", MISC_EPING
); }
1397 /*----- Service commands --------------------------------------------------*/
1399 static void acmd_svcclaim(admin
*a
, unsigned ac
, char *av
[])
1404 svc
= sym_find(&a_svcs
, av
[0], -1, sizeof(*svc
), &f
);
1406 if (versioncmp(av
[1], svc
->version
) <= 0) {
1409 "%s", SYM_NAME(svc
),
1414 a_write(svc
->prov
, "SVCCLAIM", 0, "%s", av
[0], "%s", av
[1], A_END
);
1418 svc
->version
= xstrdup(av
[1]);
1419 svc
->next
= a
->svcs
;
1421 if (a
->svcs
) a
->svcs
->prev
= svc
;
1423 a_notify("SVCCLAIM", "%s", SYM_NAME(svc
), "%s", svc
->version
, A_END
);
1427 static void acmd_svcrelease(admin
*a
, unsigned ac
, char *av
[])
1431 if ((svc
= a_svcfind(a
, av
[0])) == 0)
1433 if (svc
->prov
!= a
) {
1434 a_fail(a
, "not-service-provider", "%s", SYM_NAME(svc
), A_END
);
1441 static void acmd_svcensure(admin
*a
, unsigned ac
, char *av
[])
1445 if ((svc
= a_svcfind(a
, av
[0])) == 0)
1447 if (av
[1] && versioncmp(svc
->version
, av
[1]) < 0) {
1448 a_fail(a
, "service-too-old",
1449 "%s", SYM_NAME(svc
),
1457 static void acmd_svcquery(admin
*a
, unsigned ac
, char *av
[])
1461 if ((svc
= a_svcfind(a
, av
[0])) != 0) {
1462 a_info(a
, "name=%s", SYM_NAME(svc
), "version=%s", svc
->version
, A_END
);
1467 static void acmd_svclist(admin
*a
, unsigned ac
, char *av
[])
1472 for (sym_mkiter(&i
, &a_svcs
); (svc
= sym_next(&i
)) != 0; )
1473 a_info(a
, "%s", SYM_NAME(svc
), "%s", svc
->version
, A_END
);
1477 static void a_canceljob(admin_bgop
*bg
)
1479 admin_svcop
*svc
= (admin_svcop
*)bg
;
1481 a_write(svc
->prov
, "SVCCANCEL", 0, "%s", a_jobidencode(svc
), A_END
);
1485 static void acmd_svcsubmit(admin
*a
, unsigned ac
, char *av
[])
1487 const char *tag
= 0;
1490 const char *ver
= 0;
1494 OPTARG("-background", arg
, { tag
= arg
; })
1495 OPTARG("-version", arg
, { ver
= arg
; })
1497 if (!*av
) goto bad_syntax
;
1498 if ((svc
= a_svcfind(a
, *av
)) == 0) goto fail
;
1499 if (ver
&& versioncmp(svc
->version
, ver
) < 0) {
1500 a_fail(a
, "service-too-old",
1501 "%s", SYM_NAME(svc
),
1506 if ((svcop
= a_jobcreate(svc
->prov
)) == 0) {
1507 a_fail(a
, "provider-overloaded", A_END
);
1510 if (a_bgadd(a
, &svcop
->bg
, tag
, a_canceljob
)) {
1511 a_jobdestroy(svcop
);
1514 a_write(svc
->prov
, "SVCJOB", 0,
1515 "%s", a_jobidencode(svcop
),
1521 a_fail(a
, "bad-syntax", "svcsubmit", "[OPTIONS] SERVICE ARGS...", A_END
);
1528 static void a_replycmd(admin
*a
, const char *status
, int donep
, char *av
[])
1532 if ((svc
= a_jobiddecode(&a
->j
, av
[0])) == 0) {
1533 a_fail(a
, "unknown-jobid", av
[0], A_END
);
1536 a_write(svc
->bg
.a
, status
, svc
->bg
.tag
, "?TOKENS", av
+ 1, A_END
);
1539 a_bgrelease(&svc
->bg
);
1544 static void acmd_svcok(admin
*a
, unsigned ac
, char *av
[])
1545 { a_replycmd(a
, "OK", 1, av
); }
1546 static void acmd_svcinfo(admin
*a
, unsigned ac
, char *av
[])
1547 { a_replycmd(a
, "INFO", 0, av
); }
1548 static void acmd_svcfail(admin
*a
, unsigned ac
, char *av
[])
1549 { a_replycmd(a
, "FAIL", 1, av
); }
1551 /*----- Administration commands -------------------------------------------*/
1553 /* --- Miscellaneous commands --- */
1555 /* --- @traceish@ --- *
1557 * Arguments: @admin *a@ = connection to complain on
1558 * @unsigned ac@ = number of arguments
1559 * @char *av[]@ = vector of arguments
1560 * @const char *what@ = what we're messing with
1561 * @const trace_opt *tt@ = options table
1562 * @unsigned *ff@ = where the flags are
1564 * Returns: Nonzero if anything changed.
1566 * Use: Guts of trace-ish commands like `trace' and `watch'.
1569 static int traceish(admin
*a
, unsigned ac
, char *av
[],
1570 const char *what
, const trace_opt
*tt
, unsigned *ff
)
1574 if (!ac
|| strcmp(av
[0], "?") == 0) {
1576 for (t
= tt
; t
->ch
; t
++) {
1577 a_info(a
, "*%c%c %s",
1578 t
->ch
, (*ff
& t
->f
) == t
->f ?
'+' : ' ', t
->help
, A_END
);
1588 case '+': sense
= 1; break;
1589 case '-': sense
= 0; break;
1591 for (t
= tt
; t
->ch
; t
++) {
1593 if (sense
) f
|= t
->f
;
1598 a_fail(a
, "bad-%s-option", what
, "%c", *p
, A_END
);
1614 static void acmd_trace(admin
*a
, unsigned ac
, char *av
[])
1616 if (traceish(a
, ac
, av
, "trace", tr_opts
, &tr_flags
))
1617 trace_level(tr_flags
);
1622 static void acmd_watch(admin
*a
, unsigned ac
, char *av
[])
1623 { traceish(a
, ac
, av
, "watch", w_opts
, &a
->f
); }
1625 static void alertcmd(admin
*a
, unsigned f_and
, unsigned f_eq
,
1626 const char *status
, char *av
[])
1627 { a_alert(f_and
, f_eq
, status
, "USER", "?TOKENS", av
, A_END
); a_ok(a
); }
1628 static void acmd_notify(admin
*a
, unsigned ac
, char *av
[])
1629 { alertcmd(a
, AF_NOTE
, AF_NOTE
, "NOTE", av
); }
1630 static void acmd_warn(admin
*a
, unsigned ac
, char *av
[])
1631 { alertcmd(a
, AF_WARN
, AF_WARN
, "WARN", av
); }
1633 static void acmd_port(admin
*a
, unsigned ac
, char *av
[])
1634 { a_info(a
, "%u", p_port(), A_END
); a_ok(a
); }
1636 static void acmd_daemon(admin
*a
, unsigned ac
, char *av
[])
1638 if (flags
& F_DAEMON
)
1639 a_fail(a
, "already-daemon", A_END
);
1641 a_notify("DAEMON", A_END
);
1645 a_fail(a
, "daemon-error", "?ERRNO", A_END
);
1653 static void acmd_jobs(admin
*a
, unsigned ac
, char *av
[])
1657 for (bg
= a
->bg
; bg
; bg
= bg
->next
) {
1659 a_info(a
, "%s", bg
->tag
, A_END
);
1664 static void acmd_bgcancel(admin
*a
, unsigned ac
, char *av
[])
1668 if ((bg
= a_bgfind(a
, av
[0])) == 0)
1669 a_fail(a
, "unknown-tag", "%s", av
[0], A_END
);
1677 static void acmd_algs(admin
*a
, unsigned ac
, char *av
[])
1680 "kx-group=%s", gg
->ops
->name
,
1681 "kx-group-order-bits=%lu", (unsigned long)mp_bits(gg
->r
),
1682 "kx-group-elt-bits=%lu", (unsigned long)gg
->nbits
,
1685 "hash=%s", algs
.h
->name
,
1686 "mgf=%s", algs
.mgf
->name
,
1687 "hash-sz=%lu", (unsigned long)algs
.h
->hashsz
,
1690 "cipher=%s", algs
.c
->name
,
1691 "cipher-keysz=%lu", (unsigned long)algs
.cksz
,
1692 "cipher-blksz=%lu", (unsigned long)algs
.c
->blksz
,
1695 "cipher-data-limit=%lu", (unsigned long)algs
.expsz
,
1698 "mac=%s", algs
.m
->name
,
1699 "mac-keysz=%lu", (unsigned long)algs
.mksz
,
1700 "mac-tagsz=%lu", (unsigned long)algs
.tagsz
,
1705 static void acmd_list(admin
*a
, unsigned ac
, char *av
[])
1707 FOREACH_PEER(p
, { a_info(a
, "%s", p_name(p
), A_END
); });
1711 static void acmd_ifname(admin
*a
, unsigned ac
, char *av
[])
1715 if ((p
= a_findpeer(a
, av
[0])) != 0) {
1716 a_info(a
, "%s", p_ifname(p
), A_END
);
1721 static void acmd_setifname(admin
*a
, unsigned ac
, char *av
[])
1725 if ((p
= a_findpeer(a
, av
[0])) != 0) {
1726 a_notify("NEWIFNAME", "?PEER", p
, "%s", p_ifname(p
), "%s", av
[1], A_END
);
1727 p_setifname(p
, av
[1]);
1732 static void acmd_getchal(admin
*a
, unsigned ac
, char *av
[])
1736 buf_init(&b
, buf_i
, PKBUFSZ
);
1738 a_info(a
, "?B64", BBASE(&b
), (size_t)BLEN(&b
), A_END
);
1742 static void acmd_checkchal(admin
*a
, unsigned ac
, char *av
[])
1749 base64_decode(&b64
, av
[0], strlen(av
[0]), &d
);
1750 base64_decode(&b64
, 0, 0, &d
);
1751 buf_init(&b
, d
.buf
, d
.len
);
1752 if (c_check(&b
) || BBAD(&b
) || BLEFT(&b
))
1753 a_fail(a
, "invalid-challenge", A_END
);
1759 static void acmd_greet(admin
*a
, unsigned ac
, char *av
[])
1765 if ((p
= a_findpeer(a
, av
[0])) != 0) {
1767 base64_decode(&b64
, av
[1], strlen(av
[1]), &d
);
1768 base64_decode(&b64
, 0, 0, &d
);
1769 p_greet(p
, d
.buf
, d
.len
);
1775 static void acmd_addr(admin
*a
, unsigned ac
, char *av
[])
1780 if ((p
= a_findpeer(a
, av
[0])) != 0) {
1782 assert(ad
->sa
.sa_family
== AF_INET
);
1783 a_info(a
, "?ADDR", ad
, A_END
);
1788 static void acmd_peerinfo(admin
*a
, unsigned ac
, char *av
[])
1793 if ((p
= a_findpeer(a
, av
[0])) != 0) {
1795 a_info(a
, "tunnel=%s", ps
->tops
->name
, A_END
);
1796 a_info(a
, "key=%s", p_tag(p
), A_END
);
1797 a_info(a
, "keepalive=%lu", ps
->t_ka
, A_END
);
1802 static void acmd_servinfo(admin
*a
, unsigned ac
, char *av
[])
1804 a_info(a
, "implementation=edgeware-tripe", A_END
);
1805 a_info(a
, "version=%s", VERSION
, A_END
);
1806 a_info(a
, "daemon=%s", BOOL(flags
& F_DAEMON
), A_END
);
1810 static void acmd_stats(admin
*a
, unsigned ac
, char *av
[])
1815 if ((p
= a_findpeer(a
, av
[0])) == 0)
1819 a_info(a
, "start-time=%s", timestr(st
->t_start
), A_END
);
1820 a_info(a
, "last-packet-time=%s", timestr(st
->t_last
), A_END
);
1821 a_info(a
, "last-keyexch-time=%s", timestr(st
->t_kx
), A_END
);
1822 a_info(a
, "packets-in=%lu", st
->n_in
, "bytes-in=%lu", st
->sz_in
, A_END
);
1824 "packets-out=%lu", st
->n_out
,
1825 "bytes-out=%lu", st
->sz_out
,
1828 "keyexch-packets-in=%lu", st
->n_kxin
,
1829 "keyexch-bytes-in=%lu", st
->sz_kxin
,
1832 "keyexch-packets-out=%lu", st
->n_kxout
,
1833 "keyexch-bytes-out=%lu", st
->sz_kxout
,
1836 "ip-packets-in=%lu", st
->n_ipin
,
1837 "ip-bytes-in=%lu", st
->sz_ipin
,
1840 "ip-packets-out=%lu", st
->n_ipout
,
1841 "ip-bytes-out=%lu", st
->sz_ipout
,
1843 a_info(a
, "rejected-packets=%lu", st
->n_reject
, A_END
);
1847 static void acmd_kill(admin
*a
, unsigned ac
, char *av
[])
1851 if ((p
= a_findpeer(a
, av
[0])) != 0) {
1857 static void acmd_forcekx(admin
*a
, unsigned ac
, char *av
[])
1861 if ((p
= a_findpeer(a
, av
[0])) != 0) {
1862 kx_start(&p
->kx
, 1);
1867 static void acmd_reload(admin
*a
, unsigned ac
, char *av
[])
1868 { p_keyreload(); a_ok(a
); }
1870 static void acmd_quit(admin
*a
, unsigned ac
, char *av
[])
1872 a_warn("SERVER", "quit", "admin-request", A_END
);
1877 static void acmd_version(admin
*a
, unsigned ac
, char *av
[])
1879 a_info(a
, "%s", PACKAGE
, "%s", VERSION
, A_END
);
1883 static void acmd_tunnels(admin
*a
, unsigned ac
, char *av
[])
1887 for (i
= 0; tunnels
[i
]; i
++)
1888 a_info(a
, "%s", tunnels
[i
]->name
, A_END
);
1892 /* --- The command table and help --- */
1894 typedef struct acmd
{
1897 unsigned argmin
, argmax
;
1898 void (*func
)(admin */
*a*/
, unsigned /*ac*/, char */
*av*/
[]);
1901 static void acmd_help(admin */
*a*/
, unsigned /*ac*/, char */
*av*/
[]);
1903 static const acmd acmdtab
[] = {
1904 { "add", "[OPTIONS] PEER ADDR ...", 2, 0xffff, acmd_add
},
1905 { "addr", "PEER", 1, 1, acmd_addr
},
1906 { "algs", 0, 0, 0, acmd_algs
},
1907 { "bgcancel", "TAG", 1, 1, acmd_bgcancel
},
1908 { "checkchal", "CHAL", 1, 1, acmd_checkchal
},
1909 { "daemon", 0, 0, 0, acmd_daemon
},
1910 { "eping", "[OPTIONS] PEER", 1, 0xffff, acmd_eping
},
1911 { "forcekx", "PEER", 1, 1, acmd_forcekx
},
1912 { "getchal", 0, 0, 0, acmd_getchal
},
1913 { "greet", "PEER CHAL", 2, 2, acmd_greet
},
1914 { "help", 0, 0, 0, acmd_help
},
1915 { "ifname", "PEER", 1, 1, acmd_ifname
},
1916 { "jobs", 0, 0, 0, acmd_jobs
},
1917 { "kill", "PEER", 1, 1, acmd_kill
},
1918 { "list", 0, 0, 0, acmd_list
},
1919 { "notify", "MESSAGE ...", 1, 0xffff, acmd_notify
},
1920 { "peerinfo", "PEER", 1, 1, acmd_peerinfo
},
1921 { "ping", "[OPTIONS] PEER", 1, 0xffff, acmd_ping
},
1922 { "port", 0, 0, 0, acmd_port
},
1923 { "quit", 0, 0, 0, acmd_quit
},
1924 { "reload", 0, 0, 0, acmd_reload
},
1925 { "servinfo", 0, 0, 0, acmd_servinfo
},
1926 { "setifname", "PEER NEW-NAME", 2, 2, acmd_setifname
},
1927 { "svcclaim", "SERVICE VERSION", 2, 2, acmd_svcclaim
},
1928 { "svcensure", "SERVICE [VERSION]", 1, 2, acmd_svcensure
},
1929 { "svcfail", "JOBID TOKENS...", 1, 0xffff, acmd_svcfail
},
1930 { "svcinfo", "JOBID TOKENS...", 1, 0xffff, acmd_svcinfo
},
1931 { "svclist", 0, 0, 0, acmd_svclist
},
1932 { "svcok", "JOBID", 1, 1, acmd_svcok
},
1933 { "svcquery", "SERVICE", 1, 1, acmd_svcquery
},
1934 { "svcrelease", "SERVICE", 1, 1, acmd_svcrelease
},
1935 { "svcsubmit", "[OPTIONS] SERVICE TOKENS...",
1936 2, 0xffff, acmd_svcsubmit
},
1937 { "stats", "PEER", 1, 1, acmd_stats
},
1939 { "trace", "[OPTIONS]", 0, 1, acmd_trace
},
1941 { "tunnels", 0, 0, 0, acmd_tunnels
},
1942 { "version", 0, 0, 0, acmd_version
},
1943 { "warn", "MESSAGE ...", 1, 0xffff, acmd_warn
},
1944 { "watch", "[OPTIONS]", 0, 1, acmd_watch
},
1948 static void acmd_help(admin
*a
, unsigned ac
, char *av
[])
1952 for (c
= acmdtab
; c
->name
; c
++) {
1954 a_info(a
, "%s", c
->name
, "*%s", c
->help
, A_END
);
1956 a_info(a
, "%s", c
->name
, A_END
);
1961 /*----- Connection handling -----------------------------------------------*/
1963 /* --- @a_destroypending@ --- *
1969 * Use: Destroys pending admin connections at a safe time.
1972 static void a_destroypending(void)
1974 admin
*a
, *aa
, *head
;
1975 admin_bgop
*bg
, *bbg
;
1976 admin_service
*svc
, *ssvc
;
1978 /* --- Destroy connections marked as pending --- *
1980 * Slightly messy. Killing clients may cause others to finally die. Make
1981 * sure that they can be put on the list without clobbering anything or
1988 for (a
= head
; a
; a
= aa
) {
1990 assert(a
->f
& AF_DEAD
);
1992 /* --- Report what we're doing --- */
1994 T( trace(T_ADMIN
, "admin: completing destruction of connection %u",
1997 /* --- If this is the foreground client then shut down --- */
1999 if (a
->f
& AF_FOREGROUND
) {
2000 T( trace(T_ADMIN
, "admin: foreground client quit: shutting down"); )
2001 a_warn("SERVER", "quit", "foreground-eof", A_END
);
2005 /* --- Abort any background jobs in progress --- */
2007 for (bg
= a
->bg
; bg
; bg
= bbg
) {
2010 if (bg
->tag
) xfree(bg
->tag
);
2014 /* --- Release services I hold, and abort pending jobs --- */
2016 for (svc
= a
->svcs
; svc
; svc
= ssvc
) {
2020 a_jobtablefinal(&a
->j
);
2022 /* --- Close file descriptors and selectory --- */
2024 selbuf_destroy(&a
->b
);
2025 if (a
->b
.reader
.fd
!= a
->w
.fd
) close(a
->b
.reader
.fd
);
2027 if (a_stdin
== a
) a_stdin
= 0;
2036 /* --- @a_destroy@ --- *
2038 * Arguments: @admin *a@ = pointer to an admin block
2042 * Use: Destroys an admin block. This requires a certain amount of
2046 static void freequeue(oqueue
*q
)
2050 for (o
= q
->hd
; o
; o
= oo
) {
2057 static void a_destroy(admin
*a
)
2062 if (a
->next
) a
->next
->prev
= a
->prev
;
2063 if (a
->prev
) a
->prev
->next
= a
->next
;
2064 else admins
= a
->next
;
2066 if (a
->out
.hd
) sel_rmfile(&a
->w
);
2073 T( trace(T_ADMIN
, "admin: killing connection %u", a
->seq
); )
2076 /* --- @a_line@ --- *
2078 * Arguments: @char *p@ = pointer to the line read
2079 * @size_t len@ = length of the line
2080 * @void *vp@ = pointer to my admin block
2084 * Use: Handles a line of input.
2087 static void a_line(char *p
, size_t len
, void *vp
)
2102 selbuf_disable(&a
->b
);
2106 ac
= str_qsplit(p
, av
, N(av
) - 1, 0, STRF_QUOTE
);
2110 for (c
= acmdtab
; c
->name
; c
++) {
2111 if (mystrieq(av
[0], c
->name
)) {
2113 if (c
->argmin
> ac
|| ac
> c
->argmax
) {
2115 a_fail(a
, "bad-syntax", "%s", c
->name
, "", A_END
);
2117 a_fail(a
, "bad-syntax", "%s", c
->name
, "%s", c
->help
, A_END
);
2119 c
->func(a
, ac
, av
+ 1);
2123 a_fail(a
, "unknown-command", "%s", av
[0], A_END
);
2126 /* --- @a_create@ --- *
2128 * Arguments: @int fd_in, fd_out@ = file descriptors to use
2129 * @unsigned f@ = initial flags to set
2133 * Use: Creates a new admin connection.
2136 void a_create(int fd_in
, int fd_out
, unsigned f
)
2138 admin
*a
= CREATE(admin
);
2140 T( static unsigned seq
= 0;
2142 T( trace(T_ADMIN
, "admin: accepted connection %u", a
->seq
); )
2146 a_jobtableinit(&a
->j
);
2148 if (fd_in
== STDIN_FILENO
) a_stdin
= a
;
2149 fdflags(fd_in
, O_NONBLOCK
, O_NONBLOCK
, FD_CLOEXEC
, FD_CLOEXEC
);
2150 if (fd_out
!= fd_in
)
2151 fdflags(fd_out
, O_NONBLOCK
, O_NONBLOCK
, FD_CLOEXEC
, FD_CLOEXEC
);
2152 selbuf_init(&a
->b
, &sel
, fd_in
, a_line
, a
);
2153 sel_initfile(&sel
, &a
->w
, fd_out
, SEL_WRITE
, a_flush
, a
);
2154 a
->out
.hd
= a
->out
.tl
= 0;
2157 if (admins
) admins
->prev
= a
;
2161 /* --- @a_accept@ --- *
2163 * Arguments: @int fd@ = file descriptor to accept
2164 * @unsigned mode@ = what to do
2165 * @void *v@ = uninteresting pointer
2169 * Use: Accepts a new admin connection.
2172 static void a_accept(int fd
, unsigned mode
, void *v
)
2175 struct sockaddr_un sun
;
2176 size_t sz
= sizeof(sun
);
2178 if ((nfd
= accept(fd
, (struct sockaddr
*)&sun
, &sz
)) < 0) {
2179 if (errno
!= EINTR
&& errno
!= EAGAIN
&& errno
!= EWOULDBLOCK
&&
2180 errno
!= ECONNABORTED
&& errno
!= EPROTO
)
2181 a_warn("ADMIN", "accept-error", "?ERRNO", A_END
);
2184 a_create(nfd
, nfd
, 0);
2187 /* --- @a_preselect@ --- *
2193 * Use: Informs the admin module that we're about to select again,
2194 * and that it should do cleanup things it has delayed until a
2198 void a_preselect(void) { if (a_dead
) a_destroypending(); }
2200 /* --- @a_daemon@ --- *
2206 * Use: Informs the admin module that it's a daemon.
2209 void a_daemon(void) { flags
|= F_DAEMON
; }
2211 /* --- @a_init@ --- *
2213 * Arguments: @const char *name@ = socket name to create
2214 * @uid_t u@ = user to own the socket
2215 * @gid_t g@ = group to own the socket
2216 * @mode_t m@ = permissions to set on the socket
2220 * Use: Creates the admin listening socket.
2223 void a_init(const char *name
, uid_t u
, gid_t g
, mode_t m
)
2227 struct sockaddr_un sun
;
2228 struct sigaction sa
;
2232 /* --- Create services table --- */
2234 sym_create(&a_svcs
);
2236 /* --- Set up the socket address --- */
2238 sz
= strlen(name
) + 1;
2239 if (sz
> sizeof(sun
.sun_path
))
2240 die(EXIT_FAILURE
, "socket name `%s' too long", name
);
2242 sun
.sun_family
= AF_UNIX
;
2243 memcpy(sun
.sun_path
, name
, sz
);
2244 sz
+= offsetof(struct sockaddr_un
, sun_path
);
2246 /* --- Attempt to bind to the socket --- */
2248 omask
= umask(0077);
2250 if ((fd
= socket(PF_UNIX
, SOCK_STREAM
, 0)) < 0)
2251 die(EXIT_FAILURE
, "couldn't create socket: %s", strerror(errno
));
2252 if (bind(fd
, (struct sockaddr
*)&sun
, sz
) < 0) {
2255 if (errno
!= EADDRINUSE
) {
2256 die(EXIT_FAILURE
, "couldn't bind to address `%s': %s",
2257 sun
.sun_path
, strerror(e
));
2260 die(EXIT_FAILURE
, "too many retries; giving up");
2262 if (!connect(fd
, (struct sockaddr
*)&sun
, sz
)) {
2263 die(EXIT_FAILURE
, "server already listening on admin socket `%s'",
2266 if (errno
!= ECONNREFUSED
)
2267 die(EXIT_FAILURE
, "couldn't bind to address: %s", strerror(e
));
2268 if (stat(sun
.sun_path
, &st
)) {
2269 die(EXIT_FAILURE
, "couldn't stat `%s': %s",
2270 sun
.sun_path
, strerror(errno
));
2272 if (!S_ISSOCK(st
.st_mode
))
2273 die(EXIT_FAILURE
, "object `%s' isn't a socket", sun
.sun_path
);
2274 T( trace(T_ADMIN
, "admin: stale socket found; removing it"); )
2275 unlink(sun
.sun_path
);
2279 if (chown(sun
.sun_path
, u
, g
)) {
2280 die(EXIT_FAILURE
, "failed to set socket owner: %s",
2283 if (chmod(sun
.sun_path
, m
)) {
2284 die(EXIT_FAILURE
, "failed to set socket permissions: %s",
2288 fdflags(fd
, O_NONBLOCK
, O_NONBLOCK
, FD_CLOEXEC
, FD_CLOEXEC
);
2290 die(EXIT_FAILURE
, "couldn't listen on socket: %s", strerror(errno
));
2292 /* --- Listen to the socket --- */
2294 sel_initfile(&sel
, &sock
, fd
, SEL_READ
, a_accept
, 0);
2298 T( trace_custom(a_trace
, 0);
2299 trace(T_ADMIN
, "admin: enabled custom tracing"); )
2302 /* --- Set up signal handlers --- */
2304 sig_add(&s_term
, SIGTERM
, a_sigdie
, 0);
2305 sig_add(&s_hup
, SIGHUP
, a_sighup
, 0);
2306 signal(SIGPIPE
, SIG_IGN
);
2307 sigaction(SIGINT
, 0, &sa
);
2308 if (sa
.sa_handler
!= SIG_IGN
)
2309 sig_add(&s_int
, SIGINT
, a_sigdie
, 0);
2312 /*----- That's all, folks -------------------------------------------------*/