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_format@ --- *
318 * Arguments: @dstr *d@ = where to leave the formatted message
319 * @const char *fmt@ = pointer to format string
323 * Use: Writes a tokenized message into a string, for later
327 void a_format(dstr
*d
, const char *fmt
, ...)
332 a_vformat(d
, fmt
, ap
);
336 /* --- @a_write@, @a_vwrite@ --- *
338 * Arguments: @admin *a@ = admin connection to write to
339 * @const char *status@ = status code to report
340 * @const char *tag@ = tag string, or null
341 * @const char *fmt@ = pointer to format string
342 * @va_list ap@ = arguments in list
343 * @...@ = other arguments
347 * Use: Sends a message to an admin connection.
350 static void a_vwrite(admin
*a
, const char *status
, const char *tag
,
351 const char *fmt
, va_list ap
)
355 if (tag
) dstr_puts(&d
, "BG");
356 dstr_puts(&d
, status
);
357 if (tag
) u_quotify(&d
, tag
);
358 a_vformat(&d
, fmt
, ap
);
360 dosend(a
, d
.buf
, d
.len
);
364 static void a_write(admin
*a
, const char *status
, const char *tag
,
365 const char *fmt
, ...)
370 a_vwrite(a
, status
, tag
, fmt
, ap
);
374 /* --- @a_ok@, @a_info@, @a_fail@ --- *
376 * Arguments: @admin *a@ = connection
377 * @const char *fmt@ = format string
378 * @...@ = other arguments
382 * Use: Convenience functions for @a_write@.
385 static void a_ok(admin
*a
) { a_write(a
, "OK", 0, A_END
); }
387 static void a_info(admin
*a
, const char *fmt
, ...)
392 a_vwrite(a
, "INFO", 0, fmt
, ap
);
396 static void a_fail(admin
*a
, const char *fmt
, ...)
401 a_vwrite(a
, "FAIL", 0, fmt
, ap
);
405 /* --- @a_alert@, @a_valert@, @a_rawalert@ --- *
407 * Arguments: @unsigned f_and, f_eq@ = filter for connections
408 * @const char *status@ = status string
409 * @const char *fmt@ = pointer to format string
410 * @const char *p@ = pointer to raw string
411 * @size_t sz@ = size of raw string
412 * @va_list ap@ = arguments in list
413 * @...@ = other arguments
417 * Use: Write a message to all admin connections matched by the given
421 static void a_rawalert(unsigned f_and
, unsigned f_eq
, const char *status
,
422 const char *p
, size_t sz
)
427 if (!(flags
& F_INIT
))
429 dstr_puts(&d
, status
);
432 dstr_putm(&d
, p
, sz
);
437 for (a
= admins
; a
; a
= aa
) {
439 if ((a
->f
& f_and
) == f_eq
)
440 dosend(a
, d
.buf
, d
.len
);
445 static void a_valert(unsigned f_and
, unsigned f_eq
, const char *status
,
446 const char *fmt
, va_list ap
)
450 if (!(flags
& F_INIT
))
452 a_vformat(&d
, fmt
, ap
);
453 a_rawalert(f_and
, f_eq
, status
, fmt ? d
.buf
: 0, fmt ? d
.len
: 0);
457 static void a_alert(unsigned f_and
, unsigned f_eq
, const char *status
,
458 const char *fmt
, ...)
463 a_valert(f_and
, f_eq
, status
, fmt
, ap
);
467 /* --- @a_warn@ --- *
469 * Arguments: @const char *fmt@ = pointer to format string
470 * @...@ = other arguments
474 * Use: Informs all admin connections of a warning.
477 void a_warn(const char *fmt
, ...)
483 a_valert(0, 0, "WARN", fmt
, ap
);
486 fprintf(stderr
, "%s: ", QUIS
);
487 a_vformat(&d
, fmt
, ap
);
489 dstr_write(&d
, stderr
);
495 /* --- @a_trace@ --- *
497 * Arguments: @const char *p@ = pointer to a buffer
498 * @size_t sz@ = size of the buffer
499 * @void *v@ = uninteresting pointer
503 * Use: Custom trace output handler. Sends trace messages to
504 * interested admin connections.
508 static void a_trace(const char *p
, size_t sz
, void *v
)
509 { a_rawalert(AF_TRACE
, AF_TRACE
, "TRACE", p
, sz
); }
512 /* --- @a_notify@ --- *
514 * Arguments: @const char *fmt@ = pointer to format string
515 * @...@ = other arguments
519 * Use: Sends a notification to interested admin connections.
522 void a_notify(const char *fmt
, ...)
527 a_valert(AF_NOTE
, AF_NOTE
, "NOTE", fmt
, ap
);
531 /* --- @a_quit@ --- *
537 * Use: Shuts things down nicely.
544 FOREACH_PEER(p
, { p_destroy(p
); });
549 /* --- @a_sigdie@ --- *
551 * Arguments: @int sig@ = signal number
552 * @void *v@ = an uninteresting argument
556 * Use Shuts down on receipt of a fatal signal.
559 static void a_sigdie(int sig
, void *v
)
565 case SIGTERM
: p
= "SIGTERM"; break;
566 case SIGINT
: p
= "SIGINT"; break;
568 sprintf(buf
, "%i", sig
);
572 a_warn("SERVER", "quit", "signal", "%s", p
, A_END
);
576 /* --- @a_sighup@ --- *
578 * Arguments: @int sig@ = signal number
579 * @void *v@ = an uninteresting argument
583 * Use Logs a message about SIGHUP not being useful.
586 static void a_sighup(int sig
, void *v
)
587 { a_warn("SERVER", "ignore", "signal", "SIGHUP", A_END
); }
589 /* --- @a_parsetime@ --- *
591 * Arguments; @const char *p@ = time string to parse
593 * Returns: Time in seconds, or @< 0@ on error.
596 static long a_parsetime(const char *p
)
599 long t
= strtol(p
, &q
, 0);
605 case 's': if (q
[1] != 0)
612 /* --- @a_findpeer@ --- *
614 * Arguments: @admin *a@ = admin connection
615 * @const char *pn@ = peer name
617 * Returns: The peer, or null if not there.
619 * Use: Finds a peer, reporting an error if it failed.
622 static peer
*a_findpeer(admin
*a
, const char *pn
)
626 if ((p
= p_find(pn
)) == 0)
627 a_fail(a
, "unknown-peer", "%s", pn
, A_END
);
631 /*----- Backgrounded operations -------------------------------------------*/
634 (((admin_bgop *)(bg))->tag ? ((admin_bgop *)(bg))->tag : "<foreground>")
636 /* --- @a_bgfind@ --- *
638 * Arguments: @admin *a@ = a client block
639 * @const char *tag@ = the requested tag
641 * Returns: The requested background job, or null.
644 static admin_bgop
*a_bgfind(admin
*a
, const char *tag
)
648 for (bg
= a
->bg
; bg
; bg
= bg
->next
) {
649 if (bg
->tag
&& strcmp(tag
, bg
->tag
) == 0)
655 /* --- @a_bgrelease@ --- *
657 * Arguments: @admin_bgop *bg@ = backgrounded operation
661 * Use: Removes a backgrounded operation from the queue, since
662 * (presumably) it's done.
665 static void a_bgrelease(admin_bgop
*bg
)
669 T( trace(T_ADMIN
, "admin: release bgop %s", BGTAG(bg
)); )
670 if (bg
->tag
) xfree(bg
->tag
);
671 else selbuf_enable(&a
->b
);
672 if (bg
->next
) bg
->next
->prev
= bg
->prev
;
673 if (bg
->prev
) bg
->prev
->next
= bg
->next
;
674 else a
->bg
= bg
->next
;
676 if (!a
->bg
&& (a
->f
& AF_CLOSE
)) a_destroy(a
);
679 /* --- @a_bgok@, @a_bginfo@, @a_bgfail@ --- *
681 * Arguments: @admin_bgop *bg@ = backgrounded operation
682 * @const char *fmt@ = format string
683 * @...@ = other arguments
687 * Use: Convenience functions for @a_write@.
690 static void a_bgok(admin_bgop
*bg
)
691 { a_write(bg
->a
, "OK", bg
->tag
, A_END
); }
693 static void a_bginfo(admin_bgop
*bg
, const char *fmt
, ...)
697 a_vwrite(bg
->a
, "INFO", bg
->tag
, fmt
, ap
);
701 static void a_bgfail(admin_bgop
*bg
, const char *fmt
, ...)
705 a_vwrite(bg
->a
, "FAIL", bg
->tag
, fmt
, ap
);
709 /* --- @a_bgadd@ --- *
711 * Arguments: @admin *a@ = administration connection
712 * @admin_bgop *bg@ = pointer to background operation
713 * @const char *tag@ = background tag, or null for foreground
714 * @void (*cancel)(admin_bgop *)@ = cancel function
716 * Returns: Zero for success, nonzero on failure.
718 * Use: Links a background job into the list.
721 static int a_bgadd(admin
*a
, admin_bgop
*bg
, const char *tag
,
722 void (*cancel
)(admin_bgop
*))
725 if (a_bgfind(a
, tag
)) {
726 a_fail(a
, "tag-exists", "%s", tag
, A_END
);
729 bg
->tag
= xstrdup(tag
);
733 selbuf_disable(&a
->b
);
739 if (a
->bg
) a
->bg
->prev
= bg
;
741 T( trace(T_ADMIN
, "admin: add bgop %s", BGTAG(bg
)); )
742 if (tag
) a_write(a
, "DETACH", tag
, A_END
);
746 /*----- Job table manipulation --------------------------------------------*/
749 #define JOB_INDEXMASK ((1ul << JOB_SHIFT) - 1)
750 #define JOB_SEQMASK ((1ul << (32 - JOB_SHIFT)) - 1)
752 #define JOB_END 0xfffffffful
754 static unsigned long a_joboffset
;
756 /* --- @a_jobidencode@ --- *
758 * Arguments: @admin_svcop *svc@ = pointer to a service operation
760 * Returns: A jobid for this job, in an internal static buffer.
762 * Use: Constructs a jobid. In order to dissuade people from
763 * predicting jobids, we obfuscate them.
765 * A `raw' jobid consists of two 16-bit fields. The low 16 bits
766 * are an index into a big array. The high 16 bits are a
767 * sequence number recording how many times that slot has been
770 * This `raw' jobid is then obfuscated by adding a randomly-
771 * generated offset, and multiplying (mod %$2^{32}$%) by a fixed
775 static const char *a_jobidencode(admin_svcop
*svc
)
777 admin_jobtable
*j
= &svc
->prov
->j
;
782 assert(svc
->index
<= JOB_INDEXMASK
);
783 seq
= j
->v
[svc
->index
].seq
;
784 assert(seq
<= JOB_SEQMASK
);
785 pre
= (unsigned long)svc
->index
| ((unsigned long)seq
<< JOB_SHIFT
);
786 sprintf(buf
, "J%08lx", ((pre
+ a_joboffset
) * 0x0f87a7a3ul
) & 0xffffffff);
790 /* --- @a_jobiddecode@ --- *
792 * Arguments: @admin_jobtable *j@ = pointer to a job table
793 * @const char *jid@ = pointer to a jobid string
795 * Returns: A pointer to the job's @svcop@ structure.
798 static admin_svcop
*a_jobiddecode(admin_jobtable
*j
, const char *jid
)
805 for (i
= 1; i
< 9; i
++) {
806 if (!isxdigit((unsigned char)jid
[i
]))
811 pre
= strtoul(jid
+ 1, 0, 16);
812 pre
= ((pre
* 0xbd11c40bul
) - a_joboffset
) & 0xffffffff;
813 i
= pre
& JOB_INDEXMASK
;
814 if (i
>= j
->n
|| j
->v
[i
].seq
!= (pre
>> JOB_SHIFT
))
816 return (j
->v
[i
].u
.op
);
819 /* --- @a_jobcreate@ --- *
821 * Arguments: @admin *a@ = pointer to administration client
823 * Returns: A pointer to a freshly-allocated @svcop@, or null.
825 * Use: Allocates a fresh @svcop@ and links it into a job table.
828 static admin_svcop
*a_jobcreate(admin
*a
)
833 admin_jobtable
*j
= &a
->j
;
835 if (j
->free
!= JOB_END
) {
837 j
->free
= j
->v
[i
].u
.next
;
840 if (j
->sz
> JOB_INDEXMASK
)
845 j
->v
= xmalloc(j
->sz
* sizeof(*j
->v
));
848 j
->v
= xrealloc(j
->v
, j
->sz
* sizeof(*j
->v
), sz
* sizeof(*j
->v
));
854 svc
= xmalloc(sizeof(*svc
));
857 svc
->next
= j
->active
;
859 if (j
->active
) j
->active
->prev
= svc
;
862 IF_TRACING(T_ADMIN
, {
863 trace(T_ADMIN
, "admin: created job %s (%u)", a_jobidencode(svc
), i
);
868 /* --- @a_jobdestroy@ --- *
870 * Arguments: @admin_svcop *svc@ = pointer to job block
874 * Use: Frees up a completed (or cancelled) job.
877 static void a_jobdestroy(admin_svcop
*svc
)
879 admin
*a
= svc
->prov
;
880 admin_jobtable
*j
= &a
->j
;
881 unsigned i
= svc
->index
;
883 IF_TRACING(T_ADMIN
, {
884 trace(T_ADMIN
, "admin: destroying job %s (%u)", a_jobidencode(svc
), i
);
886 assert(j
->v
[i
].u
.op
= svc
);
887 j
->v
[i
].u
.next
= j
->free
;
890 if (svc
->next
) svc
->next
->prev
= svc
->prev
;
891 if (svc
->prev
) svc
->prev
->next
= svc
->next
;
892 else j
->active
= svc
->next
;
895 /* --- @a_jobtableinit@ --- *
897 * Arguments: @admin_jobtable *j@ = pointer to job table
901 * Use: Initializes a job table.
904 static void a_jobtableinit(admin_jobtable
*j
)
907 a_joboffset
= GR_RANGE(&rand_global
, 0xffffffff) + 1;
914 /* --- @a_jobtablefinal@ --- *
916 * Arguments: @admin_jobtable *j@ = pointer to job table
920 * Use: Closes down a job table.
923 static void a_jobtablefinal(admin_jobtable
*j
)
925 admin_svcop
*svc
, *ssvc
;
927 for (svc
= j
->active
; svc
; svc
= ssvc
) {
929 a_bgfail(&svc
->bg
, "provider-failed", A_END
);
930 a_bgrelease(&svc
->bg
);
932 if (j
->v
) xfree(j
->v
);
935 /*----- Services infrastructure -------------------------------------------*/
937 /* --- @a_svcfind@ --- *
939 * Arguments: @admin *a@ = the requesting client
940 * @const char *name@ = service name wanted
942 * Returns: The service requested, or null.
944 * Use: Finds a service; reports an error if the service couldn't be
948 static admin_service
*a_svcfind(admin
*a
, const char *name
)
952 if ((svc
= sym_find(&a_svcs
, name
, -1, 0, 0)) == 0) {
953 a_fail(a
, "unknown-service", "%s", name
, A_END
);
959 /* --- @a_svcunlink@ --- *
961 * Arguments: @admin_service *svc@ = pointer to service structure
965 * Use: Unlinks the service from its provider, without issuing a
966 * message or freeing the structure. The version string is
970 static void a_svcunlink(admin_service
*svc
)
973 svc
->next
->prev
= svc
->prev
;
975 svc
->prev
->next
= svc
->next
;
977 svc
->prov
->svcs
= svc
->next
;
981 /* --- @a_svcrelease@ --- *
983 * Arguments: @admin_service *svc@ = pointer to service structure
987 * Use: Releases a service and frees its structure.
990 static void a_svcrelease(admin_service
*svc
)
992 a_notify("SVCRELEASE", "%s", SYM_NAME(svc
), A_END
);
994 sym_remove(&a_svcs
, svc
);
997 /*----- Name resolution operations ----------------------------------------*/
999 /* --- @a_resolved@ --- *
1001 * Arguments: @struct hostent *h@ = pointer to resolved hostname
1002 * @void *v@ = pointer to resolver operation
1006 * Use: Handles a completed name resolution.
1009 static void a_resolved(struct hostent
*h
, void *v
)
1013 T( trace(T_ADMIN
, "admin: resop %s resolved", BGTAG(r
)); )
1016 a_bgfail(&r
->bg
, "resolve-error", "%s", r
->addr
, A_END
);
1017 r
->func(r
, ARES_FAIL
);
1019 memcpy(&r
->sa
.sin
.sin_addr
, h
->h_addr
, sizeof(struct in_addr
));
1020 r
->func(r
, ARES_OK
);
1024 a_bgrelease(&r
->bg
);
1027 /* --- @a_restimer@ --- *
1029 * Arguments: @struct timeval *tv@ = timer
1030 * @void *v@ = pointer to resolver operation
1034 * Use: Times out a resolver.
1037 static void a_restimer(struct timeval
*tv
, void *v
)
1041 T( trace(T_ADMIN
, "admin: resop %s timeout", BGTAG(r
)); )
1042 a_bgfail(&r
->bg
, "resolver-timeout", "%s", r
->addr
, A_END
);
1043 r
->func(r
, ARES_FAIL
);
1046 a_bgrelease(&r
->bg
);
1049 /* --- @a_rescancel@ --- *
1051 * Arguments: @admin_bgop *bg@ = background operation
1055 * Use: Cancels an add operation.
1058 static void a_rescancel(admin_bgop
*bg
)
1060 admin_resop
*r
= (admin_resop
*)bg
;
1062 T( trace(T_ADMIN
, "admin: cancel resop %s", BGTAG(r
)); )
1063 r
->func(r
, ARES_FAIL
);
1069 /* --- @a_resolve@ --- *
1071 * Arguments: @admin *a@ = administration connection
1072 * @admin_resop *r@ = resolver operation to run
1073 * @const char *tag@ = background operation tag
1074 * @void (*func)(struct admin_resop *, int@ = handler function
1075 * @unsigned ac@ = number of remaining arguments
1076 * @char *av[]@ = pointer to remaining arguments
1080 * Use: Cranks up a resolver job.
1083 static void a_resolve(admin
*a
, admin_resop
*r
, const char *tag
,
1084 void (*func
)(struct admin_resop
*, int),
1085 unsigned ac
, char *av
[])
1092 /* --- Fill in the easy bits of address --- */
1094 r
->bg
.tag
= "<starting>";
1097 if (mystrieq(av
[i
], "inet")) i
++;
1098 if (ac
- i
!= 1 && ac
- i
!= 2) {
1099 a_fail(a
, "bad-addr-syntax", "[inet] ADDRESS [PORT]", A_END
);
1102 r
->sa
.sin
.sin_family
= AF_INET
;
1103 r
->sasz
= sizeof(r
->sa
.sin
);
1104 r
->addr
= xstrdup(av
[i
]);
1108 pt
= strtoul(av
[i
+ 1], &p
, 0);
1110 struct servent
*s
= getservbyname(av
[i
+ 1], "udp");
1112 a_fail(a
, "unknown-service", "%s", av
[i
+ 1], A_END
);
1115 pt
= ntohs(s
->s_port
);
1118 if (pt
== 0 || pt
>= 65536) {
1119 a_fail(a
, "invalid-port", "%lu", pt
, A_END
);
1122 r
->sa
.sin
.sin_port
= htons(pt
);
1124 /* --- Report backgrounding --- *
1126 * Do this for consistency of interface, even if we're going to get the
1127 * answer straight away.
1130 if (a_bgadd(a
, &r
->bg
, tag
, a_rescancel
))
1132 T( trace(T_ADMIN
, "admin: %u, resop %s, hostname `%s'",
1133 a
->seq
, BGTAG(r
), r
->addr
); )
1135 /* --- If the name is numeric, do it the easy way --- */
1137 if (inet_aton(av
[i
], &r
->sa
.sin
.sin_addr
)) {
1138 T( trace(T_ADMIN
, "admin: resop %s done the easy way", BGTAG(r
)); )
1141 a_bgrelease(&r
->bg
);
1145 /* --- Store everything for later and crank up the resolver --- */
1147 gettimeofday(&tv
, 0);
1148 tv
.tv_sec
+= T_RESOLVE
;
1149 sel_addtimer(&sel
, &r
->t
, &tv
, a_restimer
, r
);
1150 bres_byname(&r
->r
, r
->addr
, a_resolved
, r
);
1155 if (r
->addr
) xfree(r
->addr
);
1159 /*----- Option parsing ----------------------------------------------------*/
1161 #define OPTIONS(argc, argv, guts) do { \
1162 char **o_av = argv; \
1166 if (mystrieq(*o_av, "--")) { \
1171 if (**o_av == '-') \
1175 argc -= o_av - argv; \
1179 #define OPT(name, guts) if (mystrieq(*o_av, name)) { guts continue; }
1181 #define OPTARG(name, arg, guts) OPT(name, { \
1184 if (!arg) goto bad_syntax; \
1188 #define OPTTIME(name, arg, guts) OPTARG(name, o_arg, { \
1190 if ((arg = a_parsetime(o_arg)) < 0) { \
1191 a_fail(a, "bad-time-spec", "%s", o_arg, A_END); \
1197 /*----- Adding peers ------------------------------------------------------*/
1199 /* --- @a_doadd@ --- *
1201 * Arguments: @admin_resop *r@ = resolver operation
1202 * @int rc@ = how it worked
1206 * Use: Handles a completed resolution.
1209 static void a_doadd(admin_resop
*r
, int rc
)
1211 admin_addop
*add
= (admin_addop
*)r
;
1213 T( trace(T_ADMIN
, "admin: done add op %s", BGTAG(add
)); )
1215 if (rc
== ARES_OK
) {
1216 add
->peer
.sasz
= add
->r
.sasz
;
1217 add
->peer
.sa
= add
->r
.sa
;
1218 if (p_findbyaddr(&add
->r
.sa
))
1219 a_bgfail(&add
->r
.bg
, "peer-addr-exists", "?ADDR", &add
->r
.sa
, A_END
);
1220 else if (p_find(add
->peer
.name
))
1221 a_bgfail(&add
->r
.bg
, "peer-exists", "%s", add
->peer
.name
, A_END
);
1222 else if (!p_create(&add
->peer
))
1223 a_bgfail(&add
->r
.bg
, "peer-create-fail", "%s", add
->peer
.name
, A_END
);
1228 if (add
->peer
.tag
) xfree(add
->peer
.tag
);
1229 xfree(add
->peer
.name
);
1232 /* --- @acmd_add@ --- *
1234 * Arguments: @admin *a@ = connection which requested the addition
1235 * @unsigned ac@ = argument count
1236 * @char *av[]@ = pointer to the argument list
1240 * Use: Adds a new peer.
1243 static void acmd_add(admin
*a
, unsigned ac
, char *av
[])
1245 const char *tag
= 0;
1248 /* --- Set stuff up --- */
1250 add
= xmalloc(sizeof(*add
));
1253 add
->peer
.privtag
= 0;
1255 add
->peer
.tops
= tun_default
;
1258 /* --- Parse options --- */
1261 OPTARG("-background", arg
, { tag
= arg
; })
1262 OPTARG("-tunnel", arg
, {
1266 a_fail(a
, "unknown-tunnel", "%s", arg
, A_END
);
1269 if (mystrieq(arg
, tunnels
[i
]->name
)) {
1270 add
->peer
.tops
= tunnels
[i
];
1275 OPTTIME("-keepalive", t
, { add
->peer
.t_ka
= t
; })
1276 OPT("-cork", { add
->peer
.f
|= KXF_CORK
; })
1277 OPTARG("-key", arg
, {
1279 xfree(add
->peer
.tag
);
1280 add
->peer
.tag
= xstrdup(arg
);
1282 OPT("-mobile", { add
->peer
.f
|= PSF_MOBILE
; })
1283 OPTARG("-priv", arg
, {
1284 if (add
->peer
.privtag
)
1285 xfree(add
->peer
.privtag
);
1286 add
->peer
.privtag
= xstrdup(arg
);
1290 /* --- Make sure someone's not got there already --- */
1292 if (!av
[0] || !av
[1])
1295 a_fail(a
, "peer-exists", "%s", *av
, A_END
);
1298 add
->peer
.name
= xstrdup(*av
++);
1301 /* --- Crank up the resolver --- */
1303 a_resolve(a
, &add
->r
, tag
, a_doadd
, ac
, av
);
1306 /* --- Clearing up --- */
1309 a_fail(a
, "bad-syntax", "add", "[OPTIONS] PEER ADDR ...", A_END
);
1311 if (add
->peer
.name
) xfree(add
->peer
.name
);
1312 if (add
->peer
.tag
) xfree(add
->peer
.tag
);
1313 if (add
->peer
.privtag
) xfree(add
->peer
.privtag
);
1318 /*----- Ping --------------------------------------------------------------*/
1320 /* --- @a_pingcancel@ --- *
1322 * Arguments: @admin_bgop *bg@ = background operation block
1326 * Use: Cancels a running ping.
1329 static void a_pingcancel(admin_bgop
*bg
)
1331 admin_pingop
*pg
= (admin_pingop
*)bg
;
1332 T( trace(T_ADMIN
, "admin: cancel ping op %s", BGTAG(pg
)); )
1333 p_pingdone(&pg
->ping
, PING_NONOTIFY
);
1336 /* --- @a_pong@ --- *
1338 * Arguments: @int rc@ = return code
1339 * @void *v@ = ping operation block
1343 * Use: Collects what happened to a ping message.
1346 static void a_pong(int rc
, void *v
)
1348 admin_pingop
*pg
= v
;
1354 gettimeofday(&tv
, 0);
1355 tv_sub(&tv
, &tv
, &pg
->pingtime
);
1356 millis
= (double)tv
.tv_sec
* 1000 + (double)tv
.tv_usec
/1000;
1357 a_bginfo(&pg
->bg
, "ping-ok", "%.1f", millis
, A_END
);
1361 a_bginfo(&pg
->bg
, "ping-timeout", A_END
);
1365 a_bginfo(&pg
->bg
, "ping-peer-died", A_END
);
1371 T( trace(T_ADMIN
, "admin: ponged ping op %s", BGTAG(pg
)); )
1372 a_bgrelease(&pg
->bg
);
1375 /* --- @acmd_ping@, @acmd_eping@ --- *
1377 * Arguments: @admin *a@ = connection which requested the ping
1378 * @unsigned ac@ = argument count
1379 * @char *av[]@ = pointer to the argument list
1383 * Use: Pings a peer.
1386 static void a_ping(admin
*a
, unsigned ac
, char *av
[],
1387 const char *cmd
, unsigned msg
)
1391 admin_pingop
*pg
= 0;
1392 const char *tag
= 0;
1395 OPTARG("-background", arg
, { tag
= arg
; })
1396 OPTTIME("-timeout", arg
, { t
= arg
; })
1398 if (!*av
|| av
[1]) goto bad_syntax
;
1399 if ((p
= a_findpeer(a
, *av
)) == 0)
1401 pg
= xmalloc(sizeof(*pg
));
1402 gettimeofday(&pg
->pingtime
, 0);
1403 if (a_bgadd(a
, &pg
->bg
, tag
, a_pingcancel
))
1405 T( trace(T_ADMIN
, "admin: ping op %s: %s to %s",
1406 BGTAG(pg
), cmd
, p_name(p
)); )
1407 if (p_pingsend(p
, &pg
->ping
, msg
, t
, a_pong
, pg
)) {
1408 a_bgfail(&pg
->bg
, "ping-send-failed", A_END
);
1409 a_bgrelease(&pg
->bg
);
1414 a_fail(a
, "bad-syntax", "%s", cmd
, "[OPTIONS] PEER", cmd
, A_END
);
1420 static void acmd_ping(admin
*a
, unsigned ac
, char *av
[])
1421 { a_ping(a
, ac
, av
, "ping", MISC_PING
); }
1422 static void acmd_eping(admin
*a
, unsigned ac
, char *av
[])
1423 { a_ping(a
, ac
, av
, "eping", MISC_EPING
); }
1425 /*----- Service commands --------------------------------------------------*/
1427 static void acmd_svcclaim(admin
*a
, unsigned ac
, char *av
[])
1432 svc
= sym_find(&a_svcs
, av
[0], -1, sizeof(*svc
), &f
);
1434 if (versioncmp(av
[1], svc
->version
) <= 0) {
1437 "%s", SYM_NAME(svc
),
1442 a_write(svc
->prov
, "SVCCLAIM", 0, "%s", av
[0], "%s", av
[1], A_END
);
1446 svc
->version
= xstrdup(av
[1]);
1447 svc
->next
= a
->svcs
;
1449 if (a
->svcs
) a
->svcs
->prev
= svc
;
1451 a_notify("SVCCLAIM", "%s", SYM_NAME(svc
), "%s", svc
->version
, A_END
);
1455 static void acmd_svcrelease(admin
*a
, unsigned ac
, char *av
[])
1459 if ((svc
= a_svcfind(a
, av
[0])) == 0)
1461 if (svc
->prov
!= a
) {
1462 a_fail(a
, "not-service-provider", "%s", SYM_NAME(svc
), A_END
);
1469 static void acmd_svcensure(admin
*a
, unsigned ac
, char *av
[])
1473 if ((svc
= a_svcfind(a
, av
[0])) == 0)
1475 if (av
[1] && versioncmp(svc
->version
, av
[1]) < 0) {
1476 a_fail(a
, "service-too-old",
1477 "%s", SYM_NAME(svc
),
1485 static void acmd_svcquery(admin
*a
, unsigned ac
, char *av
[])
1489 if ((svc
= a_svcfind(a
, av
[0])) != 0) {
1490 a_info(a
, "name=%s", SYM_NAME(svc
), "version=%s", svc
->version
, A_END
);
1495 static void acmd_svclist(admin
*a
, unsigned ac
, char *av
[])
1500 for (sym_mkiter(&i
, &a_svcs
); (svc
= sym_next(&i
)) != 0; )
1501 a_info(a
, "%s", SYM_NAME(svc
), "%s", svc
->version
, A_END
);
1505 static void a_canceljob(admin_bgop
*bg
)
1507 admin_svcop
*svc
= (admin_svcop
*)bg
;
1509 a_write(svc
->prov
, "SVCCANCEL", 0, "%s", a_jobidencode(svc
), A_END
);
1513 static void acmd_svcsubmit(admin
*a
, unsigned ac
, char *av
[])
1515 const char *tag
= 0;
1518 const char *ver
= 0;
1522 OPTARG("-background", arg
, { tag
= arg
; })
1523 OPTARG("-version", arg
, { ver
= arg
; })
1525 if (!*av
) goto bad_syntax
;
1526 if ((svc
= a_svcfind(a
, *av
)) == 0) goto fail
;
1527 if (ver
&& versioncmp(svc
->version
, ver
) < 0) {
1528 a_fail(a
, "service-too-old",
1529 "%s", SYM_NAME(svc
),
1534 if ((svcop
= a_jobcreate(svc
->prov
)) == 0) {
1535 a_fail(a
, "provider-overloaded", A_END
);
1538 if (a_bgadd(a
, &svcop
->bg
, tag
, a_canceljob
)) {
1539 a_jobdestroy(svcop
);
1542 a_write(svc
->prov
, "SVCJOB", 0,
1543 "%s", a_jobidencode(svcop
),
1549 a_fail(a
, "bad-syntax", "svcsubmit", "[OPTIONS] SERVICE ARGS...", A_END
);
1556 static void a_replycmd(admin
*a
, const char *status
, int donep
, char *av
[])
1560 if ((svc
= a_jobiddecode(&a
->j
, av
[0])) == 0) {
1561 a_fail(a
, "unknown-jobid", av
[0], A_END
);
1564 a_write(svc
->bg
.a
, status
, svc
->bg
.tag
, "?TOKENS", av
+ 1, A_END
);
1567 a_bgrelease(&svc
->bg
);
1572 static void acmd_svcok(admin
*a
, unsigned ac
, char *av
[])
1573 { a_replycmd(a
, "OK", 1, av
); }
1574 static void acmd_svcinfo(admin
*a
, unsigned ac
, char *av
[])
1575 { a_replycmd(a
, "INFO", 0, av
); }
1576 static void acmd_svcfail(admin
*a
, unsigned ac
, char *av
[])
1577 { a_replycmd(a
, "FAIL", 1, av
); }
1579 /*----- Administration commands -------------------------------------------*/
1581 /* --- Miscellaneous commands --- */
1583 /* --- @traceish@ --- *
1585 * Arguments: @admin *a@ = connection to complain on
1586 * @unsigned ac@ = number of arguments
1587 * @char *av[]@ = vector of arguments
1588 * @const char *what@ = what we're messing with
1589 * @const trace_opt *tt@ = options table
1590 * @unsigned *ff@ = where the flags are
1592 * Returns: Nonzero if anything changed.
1594 * Use: Guts of trace-ish commands like `trace' and `watch'.
1597 static int traceish(admin
*a
, unsigned ac
, char *av
[],
1598 const char *what
, const trace_opt
*tt
, unsigned *ff
)
1602 if (!ac
|| strcmp(av
[0], "?") == 0) {
1604 for (t
= tt
; t
->ch
; t
++) {
1605 a_info(a
, "*%c%c %s",
1606 t
->ch
, (*ff
& t
->f
) == t
->f ?
'+' : ' ', t
->help
, A_END
);
1616 case '+': sense
= 1; break;
1617 case '-': sense
= 0; break;
1619 for (t
= tt
; t
->ch
; t
++) {
1621 if (sense
) f
|= t
->f
;
1626 a_fail(a
, "bad-%s-option", what
, "%c", *p
, A_END
);
1642 static void acmd_trace(admin
*a
, unsigned ac
, char *av
[])
1644 if (traceish(a
, ac
, av
, "trace", tr_opts
, &tr_flags
))
1645 trace_level(tr_flags
);
1650 static void acmd_watch(admin
*a
, unsigned ac
, char *av
[])
1651 { traceish(a
, ac
, av
, "watch", w_opts
, &a
->f
); }
1653 static void alertcmd(admin
*a
, unsigned f_and
, unsigned f_eq
,
1654 const char *status
, char *av
[])
1655 { a_alert(f_and
, f_eq
, status
, "USER", "?TOKENS", av
, A_END
); a_ok(a
); }
1656 static void acmd_notify(admin
*a
, unsigned ac
, char *av
[])
1657 { alertcmd(a
, AF_NOTE
, AF_NOTE
, "NOTE", av
); }
1658 static void acmd_warn(admin
*a
, unsigned ac
, char *av
[])
1659 { alertcmd(a
, AF_WARN
, AF_WARN
, "WARN", av
); }
1661 static void acmd_port(admin
*a
, unsigned ac
, char *av
[])
1662 { a_info(a
, "%u", p_port(), A_END
); a_ok(a
); }
1664 static void acmd_daemon(admin
*a
, unsigned ac
, char *av
[])
1666 if (flags
& F_DAEMON
)
1667 a_fail(a
, "already-daemon", A_END
);
1669 a_notify("DAEMON", A_END
);
1673 a_fail(a
, "daemon-error", "?ERRNO", A_END
);
1681 static void acmd_jobs(admin
*a
, unsigned ac
, char *av
[])
1685 for (bg
= a
->bg
; bg
; bg
= bg
->next
) {
1687 a_info(a
, "%s", bg
->tag
, A_END
);
1692 static void acmd_bgcancel(admin
*a
, unsigned ac
, char *av
[])
1696 if ((bg
= a_bgfind(a
, av
[0])) == 0)
1697 a_fail(a
, "unknown-tag", "%s", av
[0], A_END
);
1705 static void acmd_algs(admin
*a
, unsigned ac
, char *av
[])
1710 const algswitch
*algs
;
1715 if ((p
= a_findpeer(a
, av
[0])) == 0) return;
1722 "kx-group=%s", g
->ops
->name
,
1723 "kx-group-order-bits=%lu", (unsigned long)mp_bits(g
->r
),
1724 "kx-group-elt-bits=%lu", (unsigned long)g
->nbits
,
1727 "hash=%s", algs
->h
->name
,
1728 "mgf=%s", algs
->mgf
->name
,
1729 "hash-sz=%lu", (unsigned long)algs
->h
->hashsz
,
1732 "cipher=%s", algs
->c
->name
,
1733 "cipher-keysz=%lu", (unsigned long)algs
->cksz
,
1734 "cipher-blksz=%lu", (unsigned long)algs
->c
->blksz
,
1737 "cipher-data-limit=%lu", (unsigned long)algs
->expsz
,
1740 "mac=%s", algs
->m
->name
,
1741 "mac-keysz=%lu", (unsigned long)algs
->mksz
,
1742 "mac-tagsz=%lu", (unsigned long)algs
->tagsz
,
1747 static void acmd_list(admin
*a
, unsigned ac
, char *av
[])
1749 FOREACH_PEER(p
, { a_info(a
, "%s", p_name(p
), A_END
); });
1753 static void acmd_ifname(admin
*a
, unsigned ac
, char *av
[])
1757 if ((p
= a_findpeer(a
, av
[0])) != 0) {
1758 a_info(a
, "%s", p_ifname(p
), A_END
);
1763 static void acmd_setifname(admin
*a
, unsigned ac
, char *av
[])
1767 if ((p
= a_findpeer(a
, av
[0])) != 0) {
1768 a_notify("NEWIFNAME", "?PEER", p
, "%s", p_ifname(p
), "%s", av
[1], A_END
);
1769 p_setifname(p
, av
[1]);
1774 static void acmd_getchal(admin
*a
, unsigned ac
, char *av
[])
1778 buf_init(&b
, buf_i
, PKBUFSZ
);
1780 a_info(a
, "?B64", BBASE(&b
), (size_t)BLEN(&b
), A_END
);
1784 static void acmd_checkchal(admin
*a
, unsigned ac
, char *av
[])
1791 base64_decode(&b64
, av
[0], strlen(av
[0]), &d
);
1792 base64_decode(&b64
, 0, 0, &d
);
1793 buf_init(&b
, d
.buf
, d
.len
);
1794 if (c_check(&b
) || BBAD(&b
) || BLEFT(&b
))
1795 a_fail(a
, "invalid-challenge", A_END
);
1801 static void acmd_greet(admin
*a
, unsigned ac
, char *av
[])
1807 if ((p
= a_findpeer(a
, av
[0])) != 0) {
1809 base64_decode(&b64
, av
[1], strlen(av
[1]), &d
);
1810 base64_decode(&b64
, 0, 0, &d
);
1811 p_greet(p
, d
.buf
, d
.len
);
1817 static void acmd_addr(admin
*a
, unsigned ac
, char *av
[])
1822 if ((p
= a_findpeer(a
, av
[0])) != 0) {
1824 assert(ad
->sa
.sa_family
== AF_INET
);
1825 a_info(a
, "?ADDR", ad
, A_END
);
1830 static void acmd_peerinfo(admin
*a
, unsigned ac
, char *av
[])
1835 if ((p
= a_findpeer(a
, av
[0])) != 0) {
1837 a_info(a
, "tunnel=%s", ps
->tops
->name
, A_END
);
1838 a_info(a
, "key=%s", p_tag(p
),
1839 "current-key=%s", p
->kx
.kpub
->tag
, A_END
);
1840 a_info(a
, "private-key=%s", p_privtag(p
),
1841 "current-private-key=%s", p
->kx
.kpriv
->tag
, A_END
);
1842 a_info(a
, "keepalive=%lu", ps
->t_ka
, A_END
);
1847 static void acmd_servinfo(admin
*a
, unsigned ac
, char *av
[])
1849 a_info(a
, "implementation=edgeware-tripe", A_END
);
1850 a_info(a
, "version=%s", VERSION
, A_END
);
1851 a_info(a
, "daemon=%s", BOOL(flags
& F_DAEMON
), A_END
);
1855 static void acmd_stats(admin
*a
, unsigned ac
, char *av
[])
1860 if ((p
= a_findpeer(a
, av
[0])) == 0)
1864 a_info(a
, "start-time=%s", timestr(st
->t_start
), A_END
);
1865 a_info(a
, "last-packet-time=%s", timestr(st
->t_last
), A_END
);
1866 a_info(a
, "last-keyexch-time=%s", timestr(st
->t_kx
), A_END
);
1867 a_info(a
, "packets-in=%lu", st
->n_in
, "bytes-in=%lu", st
->sz_in
, A_END
);
1869 "packets-out=%lu", st
->n_out
,
1870 "bytes-out=%lu", st
->sz_out
,
1873 "keyexch-packets-in=%lu", st
->n_kxin
,
1874 "keyexch-bytes-in=%lu", st
->sz_kxin
,
1877 "keyexch-packets-out=%lu", st
->n_kxout
,
1878 "keyexch-bytes-out=%lu", st
->sz_kxout
,
1881 "ip-packets-in=%lu", st
->n_ipin
,
1882 "ip-bytes-in=%lu", st
->sz_ipin
,
1885 "ip-packets-out=%lu", st
->n_ipout
,
1886 "ip-bytes-out=%lu", st
->sz_ipout
,
1888 a_info(a
, "rejected-packets=%lu", st
->n_reject
, A_END
);
1892 static void acmd_kill(admin
*a
, unsigned ac
, char *av
[])
1896 if ((p
= a_findpeer(a
, av
[0])) != 0) {
1902 static void acmd_forcekx(admin
*a
, unsigned ac
, char *av
[])
1906 if ((p
= a_findpeer(a
, av
[0])) != 0) {
1907 kx_start(&p
->kx
, 1);
1912 static void acmd_reload(admin
*a
, unsigned ac
, char *av
[])
1913 { p_keyreload(); a_ok(a
); }
1915 static void acmd_quit(admin
*a
, unsigned ac
, char *av
[])
1917 a_warn("SERVER", "quit", "admin-request", A_END
);
1922 static void acmd_version(admin
*a
, unsigned ac
, char *av
[])
1924 a_info(a
, "%s", PACKAGE
, "%s", VERSION
, A_END
);
1928 static void acmd_tunnels(admin
*a
, unsigned ac
, char *av
[])
1932 for (i
= 0; tunnels
[i
]; i
++)
1933 a_info(a
, "%s", tunnels
[i
]->name
, A_END
);
1937 /* --- The command table and help --- */
1939 typedef struct acmd
{
1942 unsigned argmin
, argmax
;
1943 void (*func
)(admin */
*a*/
, unsigned /*ac*/, char */
*av*/
[]);
1946 static void acmd_help(admin */
*a*/
, unsigned /*ac*/, char */
*av*/
[]);
1948 static const acmd acmdtab
[] = {
1949 { "add", "[OPTIONS] PEER ADDR ...", 2, 0xffff, acmd_add
},
1950 { "addr", "PEER", 1, 1, acmd_addr
},
1951 { "algs", "[PEER]", 0, 1, acmd_algs
},
1952 { "bgcancel", "TAG", 1, 1, acmd_bgcancel
},
1953 { "checkchal", "CHAL", 1, 1, acmd_checkchal
},
1954 { "daemon", 0, 0, 0, acmd_daemon
},
1955 { "eping", "[OPTIONS] PEER", 1, 0xffff, acmd_eping
},
1956 { "forcekx", "PEER", 1, 1, acmd_forcekx
},
1957 { "getchal", 0, 0, 0, acmd_getchal
},
1958 { "greet", "PEER CHAL", 2, 2, acmd_greet
},
1959 { "help", 0, 0, 0, acmd_help
},
1960 { "ifname", "PEER", 1, 1, acmd_ifname
},
1961 { "jobs", 0, 0, 0, acmd_jobs
},
1962 { "kill", "PEER", 1, 1, acmd_kill
},
1963 { "list", 0, 0, 0, acmd_list
},
1964 { "notify", "MESSAGE ...", 1, 0xffff, acmd_notify
},
1965 { "peerinfo", "PEER", 1, 1, acmd_peerinfo
},
1966 { "ping", "[OPTIONS] PEER", 1, 0xffff, acmd_ping
},
1967 { "port", 0, 0, 0, acmd_port
},
1968 { "quit", 0, 0, 0, acmd_quit
},
1969 { "reload", 0, 0, 0, acmd_reload
},
1970 { "servinfo", 0, 0, 0, acmd_servinfo
},
1971 { "setifname", "PEER NEW-NAME", 2, 2, acmd_setifname
},
1972 { "svcclaim", "SERVICE VERSION", 2, 2, acmd_svcclaim
},
1973 { "svcensure", "SERVICE [VERSION]", 1, 2, acmd_svcensure
},
1974 { "svcfail", "JOBID TOKENS...", 1, 0xffff, acmd_svcfail
},
1975 { "svcinfo", "JOBID TOKENS...", 1, 0xffff, acmd_svcinfo
},
1976 { "svclist", 0, 0, 0, acmd_svclist
},
1977 { "svcok", "JOBID", 1, 1, acmd_svcok
},
1978 { "svcquery", "SERVICE", 1, 1, acmd_svcquery
},
1979 { "svcrelease", "SERVICE", 1, 1, acmd_svcrelease
},
1980 { "svcsubmit", "[OPTIONS] SERVICE TOKENS...",
1981 2, 0xffff, acmd_svcsubmit
},
1982 { "stats", "PEER", 1, 1, acmd_stats
},
1984 { "trace", "[OPTIONS]", 0, 1, acmd_trace
},
1986 { "tunnels", 0, 0, 0, acmd_tunnels
},
1987 { "version", 0, 0, 0, acmd_version
},
1988 { "warn", "MESSAGE ...", 1, 0xffff, acmd_warn
},
1989 { "watch", "[OPTIONS]", 0, 1, acmd_watch
},
1993 static void acmd_help(admin
*a
, unsigned ac
, char *av
[])
1997 for (c
= acmdtab
; c
->name
; c
++) {
1999 a_info(a
, "%s", c
->name
, "*%s", c
->help
, A_END
);
2001 a_info(a
, "%s", c
->name
, A_END
);
2006 /*----- Connection handling -----------------------------------------------*/
2008 /* --- @a_destroypending@ --- *
2014 * Use: Destroys pending admin connections at a safe time.
2017 static void a_destroypending(void)
2019 admin
*a
, *aa
, *head
;
2020 admin_bgop
*bg
, *bbg
;
2021 admin_service
*svc
, *ssvc
;
2023 /* --- Destroy connections marked as pending --- *
2025 * Slightly messy. Killing clients may cause others to finally die. Make
2026 * sure that they can be put on the list without clobbering anything or
2033 for (a
= head
; a
; a
= aa
) {
2035 assert(a
->f
& AF_DEAD
);
2037 /* --- Report what we're doing --- */
2039 T( trace(T_ADMIN
, "admin: completing destruction of connection %u",
2042 /* --- If this is the foreground client then shut down --- */
2044 if (a
->f
& AF_FOREGROUND
) {
2045 T( trace(T_ADMIN
, "admin: foreground client quit: shutting down"); )
2046 a_warn("SERVER", "quit", "foreground-eof", A_END
);
2050 /* --- Abort any background jobs in progress --- */
2052 for (bg
= a
->bg
; bg
; bg
= bbg
) {
2055 if (bg
->tag
) xfree(bg
->tag
);
2059 /* --- Release services I hold, and abort pending jobs --- */
2061 for (svc
= a
->svcs
; svc
; svc
= ssvc
) {
2065 a_jobtablefinal(&a
->j
);
2067 /* --- Close file descriptors and selectory --- */
2069 selbuf_destroy(&a
->b
);
2070 if (a
->b
.reader
.fd
!= a
->w
.fd
) close(a
->b
.reader
.fd
);
2072 if (a_stdin
== a
) a_stdin
= 0;
2081 /* --- @a_destroy@ --- *
2083 * Arguments: @admin *a@ = pointer to an admin block
2087 * Use: Destroys an admin block. This requires a certain amount of
2091 static void freequeue(oqueue
*q
)
2095 for (o
= q
->hd
; o
; o
= oo
) {
2102 static void a_destroy(admin
*a
)
2107 if (a
->next
) a
->next
->prev
= a
->prev
;
2108 if (a
->prev
) a
->prev
->next
= a
->next
;
2109 else admins
= a
->next
;
2111 if (a
->out
.hd
) sel_rmfile(&a
->w
);
2118 T( trace(T_ADMIN
, "admin: killing connection %u", a
->seq
); )
2121 /* --- @a_line@ --- *
2123 * Arguments: @char *p@ = pointer to the line read
2124 * @size_t len@ = length of the line
2125 * @void *vp@ = pointer to my admin block
2129 * Use: Handles a line of input.
2132 static void a_line(char *p
, size_t len
, void *vp
)
2147 selbuf_disable(&a
->b
);
2151 ac
= str_qsplit(p
, av
, N(av
) - 1, 0, STRF_QUOTE
);
2155 for (c
= acmdtab
; c
->name
; c
++) {
2156 if (mystrieq(av
[0], c
->name
)) {
2158 if (c
->argmin
> ac
|| ac
> c
->argmax
) {
2160 a_fail(a
, "bad-syntax", "%s", c
->name
, "", A_END
);
2162 a_fail(a
, "bad-syntax", "%s", c
->name
, "%s", c
->help
, A_END
);
2164 c
->func(a
, ac
, av
+ 1);
2168 a_fail(a
, "unknown-command", "%s", av
[0], A_END
);
2171 /* --- @a_create@ --- *
2173 * Arguments: @int fd_in, fd_out@ = file descriptors to use
2174 * @unsigned f@ = initial flags to set
2178 * Use: Creates a new admin connection.
2181 void a_create(int fd_in
, int fd_out
, unsigned f
)
2183 admin
*a
= CREATE(admin
);
2185 T( static unsigned seq
= 0;
2187 T( trace(T_ADMIN
, "admin: accepted connection %u", a
->seq
); )
2191 a_jobtableinit(&a
->j
);
2193 if (fd_in
== STDIN_FILENO
) a_stdin
= a
;
2194 fdflags(fd_in
, O_NONBLOCK
, O_NONBLOCK
, FD_CLOEXEC
, FD_CLOEXEC
);
2195 if (fd_out
!= fd_in
)
2196 fdflags(fd_out
, O_NONBLOCK
, O_NONBLOCK
, FD_CLOEXEC
, FD_CLOEXEC
);
2197 selbuf_init(&a
->b
, &sel
, fd_in
, a_line
, a
);
2198 sel_initfile(&sel
, &a
->w
, fd_out
, SEL_WRITE
, a_flush
, a
);
2199 a
->out
.hd
= a
->out
.tl
= 0;
2202 if (admins
) admins
->prev
= a
;
2206 /* --- @a_accept@ --- *
2208 * Arguments: @int fd@ = file descriptor to accept
2209 * @unsigned mode@ = what to do
2210 * @void *v@ = uninteresting pointer
2214 * Use: Accepts a new admin connection.
2217 static void a_accept(int fd
, unsigned mode
, void *v
)
2220 struct sockaddr_un sun
;
2221 size_t sz
= sizeof(sun
);
2223 if ((nfd
= accept(fd
, (struct sockaddr
*)&sun
, &sz
)) < 0) {
2224 if (errno
!= EINTR
&& errno
!= EAGAIN
&& errno
!= EWOULDBLOCK
&&
2225 errno
!= ECONNABORTED
&& errno
!= EPROTO
)
2226 a_warn("ADMIN", "accept-error", "?ERRNO", A_END
);
2229 a_create(nfd
, nfd
, 0);
2232 /* --- @a_preselect@ --- *
2238 * Use: Informs the admin module that we're about to select again,
2239 * and that it should do cleanup things it has delayed until a
2243 void a_preselect(void) { if (a_dead
) a_destroypending(); }
2245 /* --- @a_daemon@ --- *
2251 * Use: Informs the admin module that it's a daemon.
2254 void a_daemon(void) { flags
|= F_DAEMON
; }
2256 /* --- @a_init@ --- *
2258 * Arguments: @const char *name@ = socket name to create
2259 * @uid_t u@ = user to own the socket
2260 * @gid_t g@ = group to own the socket
2261 * @mode_t m@ = permissions to set on the socket
2265 * Use: Creates the admin listening socket.
2268 void a_init(const char *name
, uid_t u
, gid_t g
, mode_t m
)
2272 struct sockaddr_un sun
;
2273 struct sigaction sa
;
2277 /* --- Create services table --- */
2279 sym_create(&a_svcs
);
2281 /* --- Set up the socket address --- */
2283 sz
= strlen(name
) + 1;
2284 if (sz
> sizeof(sun
.sun_path
))
2285 die(EXIT_FAILURE
, "socket name `%s' too long", name
);
2287 sun
.sun_family
= AF_UNIX
;
2288 memcpy(sun
.sun_path
, name
, sz
);
2289 sz
+= offsetof(struct sockaddr_un
, sun_path
);
2291 /* --- Attempt to bind to the socket --- */
2293 omask
= umask(0077);
2295 if ((fd
= socket(PF_UNIX
, SOCK_STREAM
, 0)) < 0)
2296 die(EXIT_FAILURE
, "couldn't create socket: %s", strerror(errno
));
2297 if (bind(fd
, (struct sockaddr
*)&sun
, sz
) < 0) {
2300 if (errno
!= EADDRINUSE
) {
2301 die(EXIT_FAILURE
, "couldn't bind to address `%s': %s",
2302 sun
.sun_path
, strerror(e
));
2305 die(EXIT_FAILURE
, "too many retries; giving up");
2307 if (!connect(fd
, (struct sockaddr
*)&sun
, sz
)) {
2308 die(EXIT_FAILURE
, "server already listening on admin socket `%s'",
2311 if (errno
!= ECONNREFUSED
)
2312 die(EXIT_FAILURE
, "couldn't bind to address: %s", strerror(e
));
2313 if (stat(sun
.sun_path
, &st
)) {
2314 die(EXIT_FAILURE
, "couldn't stat `%s': %s",
2315 sun
.sun_path
, strerror(errno
));
2317 if (!S_ISSOCK(st
.st_mode
))
2318 die(EXIT_FAILURE
, "object `%s' isn't a socket", sun
.sun_path
);
2319 T( trace(T_ADMIN
, "admin: stale socket found; removing it"); )
2320 unlink(sun
.sun_path
);
2324 if (chown(sun
.sun_path
, u
, g
)) {
2325 die(EXIT_FAILURE
, "failed to set socket owner: %s",
2328 if (chmod(sun
.sun_path
, m
)) {
2329 die(EXIT_FAILURE
, "failed to set socket permissions: %s",
2333 fdflags(fd
, O_NONBLOCK
, O_NONBLOCK
, FD_CLOEXEC
, FD_CLOEXEC
);
2335 die(EXIT_FAILURE
, "couldn't listen on socket: %s", strerror(errno
));
2337 /* --- Listen to the socket --- */
2339 sel_initfile(&sel
, &sock
, fd
, SEL_READ
, a_accept
, 0);
2343 T( trace_custom(a_trace
, 0);
2344 trace(T_ADMIN
, "admin: enabled custom tracing"); )
2347 /* --- Set up signal handlers --- */
2349 sig_add(&s_term
, SIGTERM
, a_sigdie
, 0);
2350 sig_add(&s_hup
, SIGHUP
, a_sighup
, 0);
2351 signal(SIGPIPE
, SIG_IGN
);
2352 sigaction(SIGINT
, 0, &sa
);
2353 if (sa
.sa_handler
!= SIG_IGN
)
2354 sig_add(&s_int
, SIGINT
, a_sigdie
, 0);
2357 /*----- That's all, folks -------------------------------------------------*/