4e87e48c81799847f11f756035e23879d1722697
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 { 'p', T_PACKET
, "packet contents" },
44 { 'c', T_CRYPTO
, "crypto details" },
45 { 'A', T_ALL
, "all of the above" },
49 unsigned tr_flags
= 0;
52 static const trace_opt w_opts
[] = {
53 { 't', AF_TRACE
, "trace messages" },
54 { 'n', AF_NOTE
, "asynchronous notifications" },
55 { 'w', AF_WARN
, "warnings" },
56 { 'A', AF_ALLMSGS
, "all of the above" },
60 /*----- Static variables --------------------------------------------------*/
65 static const char *sockname
;
66 static sym_table a_svcs
;
67 static unsigned flags
= 0;
68 static admin
*a_stdin
= 0;
69 static sig s_term
, s_int
, s_hup
;
73 #define F_FOREGROUND 4u
75 #define T_RESOLVE SEC(30)
78 static void a_destroy(admin */
*a*/
);
80 #define BOOL(x) ((x) ? "t" : "nil")
82 /*----- Output functions --------------------------------------------------*/
84 /* --- @trywrite@ --- *
86 * Arguments: @admin *a@ = pointer to an admin block
87 * @const char *p@ = pointer to buffer to write
88 * @size_t sz@ = size of data to write
90 * Returns: The number of bytes written, or less than zero on error.
92 * Use: Attempts to write data to a client.
95 static ssize_t
trywrite(admin
*a
, const char *p
, size_t sz
)
102 n
= write(a
->w
.fd
, p
, sz
);
112 if (errno
!= EAGAIN
&& errno
!= EWOULDBLOCK
) {
114 a_warn("ADMIN", "client-write-error", "?ERRNO", A_END
);
121 /* --- @doqueue@ -- *
123 * Arguments: @oqueue *q@ = pointer to output queue
124 * @const char *p@ = pointer to buffer to write
125 * @size_t sz@ = size of buffer
127 * Returns: Nonzero if the queue was previously empty.
129 * Use: Queues data to be written later.
132 static int doqueue(oqueue
*q
, const char *p
, size_t sz
)
141 else if (o
->p_in
< o
->buf
+ OBUFSZ
)
145 o
= xmalloc(sizeof(obuf
));
147 o
->p_in
= o
->p_out
= o
->buf
;
155 n
= o
->buf
+ OBUFSZ
- o
->p_in
;
158 memcpy(o
->p_in
, p
, n
);
167 /* --- @dosend@ --- *
169 * Arguemnts: @admin *a@ = pointer to an admin block
170 * @const char *p@ = pointer to buffer to write
171 * @size_t sz@ = size of data to write
175 * Use: Sends data to an admin client.
178 static void dosend(admin
*a
, const char *p
, size_t sz
)
185 if ((n
= trywrite(a
, p
, sz
)) < 0)
192 if (doqueue(&a
->out
, p
, sz
))
196 /* --- @a_flush@ --- *
198 * Arguments: @int fd@ = file descriptor
199 * @unsigned mode@ = what's happening
200 * @void *v@ = pointer to my admin block
204 * Use: Flushes buffers when a client is ready to read again.
207 static void a_flush(int fd
, unsigned mode
, void *v
)
215 if ((n
= trywrite(a
, o
->p_out
, o
->p_in
- o
->p_out
)) < 0)
218 if (o
->p_in
< o
->p_out
)
231 /*----- Utility functions -------------------------------------------------*/
233 /* --- @a_vformat@ --- *
235 * Arguments: @dstr *d@ = where to leave the formatted message
236 * @const char *fmt@ = pointer to format string
237 * @va_list ap@ = arguments in list
241 * Use: Main message token formatting driver. The arguments are
242 * interleaved formatting tokens and their parameters, finally
243 * terminated by an entry @A_END@.
247 * * "*..." ... -- pretokenized @dstr_putf@-like string
249 * * "?ADDR" SOCKADDR -- a socket address, to be converted
251 * * "?B64" BUFFER SIZE -- binary data to be base64-encoded
253 * * "?TOKENS" VECTOR -- null-terminated vector of tokens
255 * * "?PEER" PEER -- peer's name
257 * * "?ERRNO" ERRNO -- system error code
259 * * "[!]..." ... -- @dstr_putf@-like string as single token
262 void a_vformat(dstr
*d
, const char *fmt
, va_list ap
)
268 if (d
->len
) dstr_putc(d
, ' ');
269 dstr_vputf(d
, fmt
+ 1, &ap
);
270 } else if (*fmt
== '?') {
271 if (strcmp(fmt
, "?ADDR") == 0) {
272 const addr
*a
= va_arg(ap
, const addr
*);
273 switch (a
->sa
.sa_family
) {
275 u_quotify(d
, "INET");
276 u_quotify(d
, inet_ntoa(a
->sin
.sin_addr
));
277 dstr_putf(d
, " %u", (unsigned)ntohs(a
->sin
.sin_port
));
282 } else if (strcmp(fmt
, "?B64") == 0) {
283 const octet
*p
= va_arg(ap
, const octet
*);
284 size_t n
= va_arg(ap
, size_t);
290 base64_encode(&b64
, p
, n
, d
);
291 base64_encode(&b64
, 0, 0, d
);
292 while (d
->len
&& d
->buf
[d
->len
- 1] == '=') d
->len
--;
293 } else if (strcmp(fmt
, "?TOKENS") == 0) {
294 const char *const *av
= va_arg(ap
, const char *const *);
295 while (*av
) u_quotify(d
, *av
++);
296 } else if (strcmp(fmt
, "?PEER") == 0)
297 u_quotify(d
, p_name(va_arg(ap
, peer
*)));
298 else if (strcmp(fmt
, "?ERRNO") == 0) {
299 dstr_putf(d
, " E%d", errno
);
300 u_quotify(d
, strerror(errno
));
304 if (*fmt
== '!') fmt
++;
306 dstr_vputf(&dd
, fmt
, &ap
);
307 u_quotify(d
, dd
.buf
);
309 fmt
= va_arg(ap
, const char *);
315 /* --- @a_write@, @a_vwrite@ --- *
317 * Arguments: @admin *a@ = admin connection to write to
318 * @const char *status@ = status code to report
319 * @const char *tag@ = tag string, or null
320 * @const char *fmt@ = pointer to format string
321 * @va_list ap@ = arguments in list
322 * @...@ = other arguments
326 * Use: Sends a message to an admin connection.
329 static void a_vwrite(admin
*a
, const char *status
, const char *tag
,
330 const char *fmt
, va_list ap
)
334 if (tag
) dstr_puts(&d
, "BG");
335 dstr_puts(&d
, status
);
336 if (tag
) u_quotify(&d
, tag
);
337 a_vformat(&d
, fmt
, ap
);
339 dosend(a
, d
.buf
, d
.len
);
343 static void a_write(admin
*a
, const char *status
, const char *tag
,
344 const char *fmt
, ...)
349 a_vwrite(a
, status
, tag
, fmt
, ap
);
353 /* --- @a_ok@, @a_info@, @a_fail@ --- *
355 * Arguments: @admin *a@ = connection
356 * @const char *fmt@ = format string
357 * @...@ = other arguments
361 * Use: Convenience functions for @a_write@.
364 static void a_ok(admin
*a
) { a_write(a
, "OK", 0, A_END
); }
366 static void a_info(admin
*a
, const char *fmt
, ...)
371 a_vwrite(a
, "INFO", 0, fmt
, ap
);
375 static void a_fail(admin
*a
, const char *fmt
, ...)
380 a_vwrite(a
, "FAIL", 0, fmt
, ap
);
384 /* --- @a_alert@, @a_valert@, @a_rawalert@ --- *
386 * Arguments: @unsigned f_and, f_eq@ = filter for connections
387 * @const char *status@ = status string
388 * @const char *fmt@ = pointer to format string
389 * @const char *p@ = pointer to raw string
390 * @size_t sz@ = size of raw string
391 * @va_list ap@ = arguments in list
392 * @...@ = other arguments
396 * Use: Write a message to all admin connections matched by the given
400 static void a_rawalert(unsigned f_and
, unsigned f_eq
, const char *status
,
401 const char *p
, size_t sz
)
406 if (!(flags
& F_INIT
))
408 dstr_puts(&d
, status
);
411 dstr_putm(&d
, p
, sz
);
416 for (a
= admins
; a
; a
= aa
) {
418 if ((a
->f
& f_and
) == f_eq
)
419 dosend(a
, d
.buf
, d
.len
);
424 static void a_valert(unsigned f_and
, unsigned f_eq
, const char *status
,
425 const char *fmt
, va_list ap
)
429 if (!(flags
& F_INIT
))
431 a_vformat(&d
, fmt
, ap
);
432 a_rawalert(f_and
, f_eq
, status
, fmt ? d
.buf
: 0, fmt ? d
.len
: 0);
436 static void a_alert(unsigned f_and
, unsigned f_eq
, const char *status
,
437 const char *fmt
, ...)
442 a_valert(f_and
, f_eq
, status
, fmt
, ap
);
446 /* --- @a_warn@ --- *
448 * Arguments: @const char *fmt@ = pointer to format string
449 * @...@ = other arguments
453 * Use: Informs all admin connections of a warning.
456 void a_warn(const char *fmt
, ...)
462 a_valert(0, 0, "WARN", fmt
, ap
);
465 fprintf(stderr
, "%s: ", QUIS
);
466 a_vformat(&d
, fmt
, ap
);
468 dstr_write(&d
, stderr
);
474 /* --- @a_trace@ --- *
476 * Arguments: @const char *p@ = pointer to a buffer
477 * @size_t sz@ = size of the buffer
478 * @void *v@ = uninteresting pointer
482 * Use: Custom trace output handler. Sends trace messages to
483 * interested admin connections.
487 static void a_trace(const char *p
, size_t sz
, void *v
)
488 { a_rawalert(AF_TRACE
, AF_TRACE
, "TRACE", p
, sz
); }
491 /* --- @a_notify@ --- *
493 * Arguments: @const char *fmt@ = pointer to format string
494 * @...@ = other arguments
498 * Use: Sends a notification to interested admin connections.
501 void a_notify(const char *fmt
, ...)
506 a_valert(AF_NOTE
, AF_NOTE
, "NOTE", fmt
, ap
);
510 /* --- @a_quit@ --- *
516 * Use: Shuts things down nicely.
523 FOREACH_PEER(p
, { p_destroy(p
); });
527 /* --- @a_sigdie@ --- *
529 * Arguments: @int sig@ = signal number
530 * @void *v@ = an uninteresting argument
534 * Use Shuts down on receipt of a fatal signal.
537 static void a_sigdie(int sig
, void *v
)
543 case SIGTERM
: p
= "SIGTERM"; break;
544 case SIGINT
: p
= "SIGINT"; break;
546 sprintf(buf
, "%i", sig
);
550 a_warn("SERVER", "quit", "signal", "%s", p
, A_END
);
554 /* --- @a_sighup@ --- *
556 * Arguments: @int sig@ = signal number
557 * @void *v@ = an uninteresting argument
561 * Use Logs a message about SIGHUP not being useful.
564 static void a_sighup(int sig
, void *v
)
565 { a_warn("SERVER", "ignore", "signal", "SIGHUP", A_END
); }
567 /* --- @a_parsetime@ --- *
569 * Arguments; @const char *p@ = time string to parse
571 * Returns: Time in seconds, or @< 0@ on error.
574 static long a_parsetime(const char *p
)
577 long t
= strtol(p
, &q
, 0);
583 case 's': if (q
[1] != 0)
590 /* --- @a_findpeer@ --- *
592 * Arguments: @admin *a@ = admin connection
593 * @const char *pn@ = peer name
595 * Returns: The peer, or null if not there.
597 * Use: Finds a peer, reporting an error if it failed.
600 static peer
*a_findpeer(admin
*a
, const char *pn
)
604 if ((p
= p_find(pn
)) == 0)
605 a_fail(a
, "unknown-peer", "%s", pn
, A_END
);
609 /*----- Backgrounded operations -------------------------------------------*/
612 (((admin_bgop *)(bg))->tag ? ((admin_bgop *)(bg))->tag : "<foreground>")
614 /* --- @a_bgfind@ --- *
616 * Arguments: @admin *a@ = a client block
617 * @const char *tag@ = the requested tag
619 * Returns: The requested background job, or null.
622 static admin_bgop
*a_bgfind(admin
*a
, const char *tag
)
626 for (bg
= a
->bg
; bg
; bg
= bg
->next
) {
627 if (bg
->tag
&& strcmp(tag
, bg
->tag
) == 0)
633 /* --- @a_bgrelease@ --- *
635 * Arguments: @admin_bgop *bg@ = backgrounded operation
639 * Use: Removes a backgrounded operation from the queue, since
640 * (presumably) it's done.
643 static void a_bgrelease(admin_bgop
*bg
)
647 T( trace(T_ADMIN
, "admin: release bgop %s", BGTAG(bg
)); )
648 if (bg
->tag
) xfree(bg
->tag
);
649 else selbuf_enable(&a
->b
);
650 if (bg
->next
) bg
->next
->prev
= bg
->prev
;
651 if (bg
->prev
) bg
->prev
->next
= bg
->next
;
652 else a
->bg
= bg
->next
;
654 if (!a
->bg
&& (a
->f
& AF_CLOSE
)) a_destroy(a
);
657 /* --- @a_bgok@, @a_bginfo@, @a_bgfail@ --- *
659 * Arguments: @admin_bgop *bg@ = backgrounded operation
660 * @const char *fmt@ = format string
661 * @...@ = other arguments
665 * Use: Convenience functions for @a_write@.
668 static void a_bgok(admin_bgop
*bg
)
669 { a_write(bg
->a
, "OK", bg
->tag
, A_END
); }
671 static void a_bginfo(admin_bgop
*bg
, const char *fmt
, ...)
675 a_vwrite(bg
->a
, "INFO", bg
->tag
, fmt
, ap
);
679 static void a_bgfail(admin_bgop
*bg
, const char *fmt
, ...)
683 a_vwrite(bg
->a
, "FAIL", bg
->tag
, fmt
, ap
);
687 /* --- @a_bgadd@ --- *
689 * Arguments: @admin *a@ = administration connection
690 * @admin_bgop *bg@ = pointer to background operation
691 * @const char *tag@ = background tag, or null for foreground
692 * @void (*cancel)(admin_bgop *)@ = cancel function
694 * Returns: Zero for success, nonzero on failure.
696 * Use: Links a background job into the list.
699 static int a_bgadd(admin
*a
, admin_bgop
*bg
, const char *tag
,
700 void (*cancel
)(admin_bgop
*))
703 if (a_bgfind(a
, tag
)) {
704 a_fail(a
, "tag-exists", "%s", tag
, A_END
);
707 bg
->tag
= xstrdup(tag
);
711 selbuf_disable(&a
->b
);
717 if (a
->bg
) a
->bg
->prev
= bg
;
719 T( trace(T_ADMIN
, "admin: add bgop %s", BGTAG(bg
)); )
720 if (tag
) a_write(a
, "DETACH", tag
, A_END
);
724 /*----- Job table manipulation --------------------------------------------*/
727 #define JOB_INDEXMASK ((1ul << JOB_SHIFT) - 1)
728 #define JOB_SEQMASK ((1ul << (32 - JOB_SHIFT)) - 1)
730 #define JOB_END 0xfffffffful
732 static unsigned long a_joboffset
;
734 /* --- @a_jobidencode@ --- *
736 * Arguments: @admin_svcop *svc@ = pointer to a service operation
738 * Returns: A jobid for this job, in an internal static buffer.
740 * Use: Constructs a jobid. In order to dissuade people from
741 * predicting jobids, we obfuscate them.
743 * A `raw' jobid consists of two 16-bit fields. The low 16 bits
744 * are an index into a big array. The high 16 bits are a
745 * sequence number recording how many times that slot has been
748 * This `raw' jobid is then obfuscated by adding a randomly-
749 * generated offset, and multiplying (mod %$2^{32}$%) by a fixed
753 static const char *a_jobidencode(admin_svcop
*svc
)
755 admin_jobtable
*j
= &svc
->prov
->j
;
760 assert(svc
->index
<= JOB_INDEXMASK
);
761 seq
= j
->v
[svc
->index
].seq
;
762 assert(seq
<= JOB_SEQMASK
);
763 pre
= (unsigned long)svc
->index
| ((unsigned long)seq
<< JOB_SHIFT
);
764 sprintf(buf
, "J%08lx", ((pre
+ a_joboffset
) * 0x0f87a7a3ul
) & 0xffffffff);
768 /* --- @a_jobiddecode@ --- *
770 * Arguments: @admin_jobtable *j@ = pointer to a job table
771 * @const char *jid@ = pointer to a jobid string
773 * Returns: A pointer to the job's @svcop@ structure.
776 static admin_svcop
*a_jobiddecode(admin_jobtable
*j
, const char *jid
)
783 for (i
= 1; i
< 9; i
++) {
784 if (!isxdigit((unsigned char)jid
[i
]))
789 pre
= strtoul(jid
+ 1, 0, 16);
790 pre
= ((pre
* 0xbd11c40bul
) - a_joboffset
) & 0xffffffff;
791 i
= pre
& JOB_INDEXMASK
;
792 if (i
>= j
->n
|| j
->v
[i
].seq
!= (pre
>> JOB_SHIFT
))
794 return (j
->v
[i
].u
.op
);
797 /* --- @a_jobcreate@ --- *
799 * Arguments: @admin *a@ = pointer to administration client
801 * Returns: A pointer to a freshly-allocated @svcop@, or null.
803 * Use: Allocates a fresh @svcop@ and links it into a job table.
806 static admin_svcop
*a_jobcreate(admin
*a
)
811 admin_jobtable
*j
= &a
->j
;
813 if (j
->free
!= JOB_END
) {
815 j
->free
= j
->v
[i
].u
.next
;
818 if (j
->sz
> JOB_INDEXMASK
)
823 j
->v
= xmalloc(j
->sz
* sizeof(*j
->v
));
826 j
->v
= xrealloc(j
->v
, j
->sz
* sizeof(*j
->v
), sz
* sizeof(*j
->v
));
832 svc
= xmalloc(sizeof(*svc
));
835 svc
->next
= j
->active
;
837 if (j
->active
) j
->active
->prev
= svc
;
840 IF_TRACING(T_ADMIN
, {
841 trace(T_ADMIN
, "admin: created job %s (%u)", a_jobidencode(svc
), i
);
846 /* --- @a_jobdestroy@ --- *
848 * Arguments: @admin_svcop *svc@ = pointer to job block
852 * Use: Frees up a completed (or cancelled) job.
855 static void a_jobdestroy(admin_svcop
*svc
)
857 admin
*a
= svc
->prov
;
858 admin_jobtable
*j
= &a
->j
;
859 unsigned i
= svc
->index
;
861 IF_TRACING(T_ADMIN
, {
862 trace(T_ADMIN
, "admin: destroying job %s (%u)", a_jobidencode(svc
), i
);
864 assert(j
->v
[i
].u
.op
= svc
);
865 j
->v
[i
].u
.next
= j
->free
;
868 if (svc
->next
) svc
->next
->prev
= svc
->prev
;
869 if (svc
->prev
) svc
->prev
->next
= svc
->next
;
870 else j
->active
= svc
->next
;
873 /* --- @a_jobtableinit@ --- *
875 * Arguments: @admin_jobtable *j@ = pointer to job table
879 * Use: Initializes a job table.
882 static void a_jobtableinit(admin_jobtable
*j
)
885 a_joboffset
= GR_RANGE(&rand_global
, 0xffffffff) + 1;
892 /* --- @a_jobtablefinal@ --- *
894 * Arguments: @admin_jobtable *j@ = pointer to job table
898 * Use: Closes down a job table.
901 static void a_jobtablefinal(admin_jobtable
*j
)
903 admin_svcop
*svc
, *ssvc
;
905 for (svc
= j
->active
; svc
; svc
= ssvc
) {
907 a_bgfail(&svc
->bg
, "provider-failed", A_END
);
908 a_bgrelease(&svc
->bg
);
910 if (j
->v
) xfree(j
->v
);
913 /*----- Services infrastructure -------------------------------------------*/
915 /* --- @a_svcfind@ --- *
917 * Arguments: @admin *a@ = the requesting client
918 * @const char *name@ = service name wanted
920 * Returns: The service requested, or null.
922 * Use: Finds a service; reports an error if the service couldn't be
926 static admin_service
*a_svcfind(admin
*a
, const char *name
)
930 if ((svc
= sym_find(&a_svcs
, name
, -1, 0, 0)) == 0) {
931 a_fail(a
, "unknown-service", "%s", name
, A_END
);
937 /* --- @a_svcunlink@ --- *
939 * Arguments: @admin_service *svc@ = pointer to service structure
943 * Use: Unlinks the service from its provider, without issuing a
944 * message or freeing the structure. The version string is
948 static void a_svcunlink(admin_service
*svc
)
951 svc
->next
->prev
= svc
->prev
;
953 svc
->prev
->next
= svc
->next
;
955 svc
->prov
->svcs
= svc
->next
;
959 /* --- @a_svcrelease@ --- *
961 * Arguments: @admin_service *svc@ = pointer to service structure
965 * Use: Releases a service and frees its structure.
968 static void a_svcrelease(admin_service
*svc
)
970 a_notify("SVCRELEASE", "%s", SYM_NAME(svc
), A_END
);
972 sym_remove(&a_svcs
, svc
);
975 /*----- Name resolution operations ----------------------------------------*/
977 /* --- @a_resolved@ --- *
979 * Arguments: @struct hostent *h@ = pointer to resolved hostname
980 * @void *v@ = pointer to resolver operation
984 * Use: Handles a completed name resolution.
987 static void a_resolved(struct hostent
*h
, void *v
)
991 T( trace(T_ADMIN
, "admin: resop %s resolved", BGTAG(r
)); )
994 a_bgfail(&r
->bg
, "resolve-error", "%s", r
->addr
, A_END
);
995 r
->func(r
, ARES_FAIL
);
997 memcpy(&r
->sa
.sin
.sin_addr
, h
->h_addr
, sizeof(struct in_addr
));
1002 a_bgrelease(&r
->bg
);
1005 /* --- @a_restimer@ --- *
1007 * Arguments: @struct timeval *tv@ = timer
1008 * @void *v@ = pointer to resolver operation
1012 * Use: Times out a resolver.
1015 static void a_restimer(struct timeval
*tv
, void *v
)
1019 T( trace(T_ADMIN
, "admin: resop %s timeout", BGTAG(r
)); )
1020 a_bgfail(&r
->bg
, "resolver-timeout", "%s", r
->addr
, A_END
);
1021 r
->func(r
, ARES_FAIL
);
1024 a_bgrelease(&r
->bg
);
1027 /* --- @a_rescancel@ --- *
1029 * Arguments: @admin_bgop *bg@ = background operation
1033 * Use: Cancels an add operation.
1036 static void a_rescancel(admin_bgop
*bg
)
1038 admin_resop
*r
= (admin_resop
*)bg
;
1040 T( trace(T_ADMIN
, "admin: cancel resop %s", BGTAG(r
)); )
1041 r
->func(r
, ARES_FAIL
);
1047 /* --- @a_resolve@ --- *
1049 * Arguments: @admin *a@ = administration connection
1050 * @admin_resop *r@ = resolver operation to run
1051 * @const char *tag@ = background operation tag
1052 * @void (*func)(struct admin_resop *, int@ = handler function
1053 * @unsigned ac@ = number of remaining arguments
1054 * @char *av[]@ = pointer to remaining arguments
1058 * Use: Cranks up a resolver job.
1061 static void a_resolve(admin
*a
, admin_resop
*r
, const char *tag
,
1062 void (*func
)(struct admin_resop
*, int),
1063 unsigned ac
, char *av
[])
1070 /* --- Fill in the easy bits of address --- */
1072 r
->bg
.tag
= "<starting>";
1075 if (mystrieq(av
[i
], "inet")) i
++;
1076 if (ac
- i
!= 1 && ac
- i
!= 2) {
1077 a_fail(a
, "bad-addr-syntax", "[inet] ADDRESS [PORT]", A_END
);
1080 r
->sa
.sin
.sin_family
= AF_INET
;
1081 r
->sasz
= sizeof(r
->sa
.sin
);
1082 r
->addr
= xstrdup(av
[i
]);
1086 pt
= strtoul(av
[i
+ 1], &p
, 0);
1088 struct servent
*s
= getservbyname(av
[i
+ 1], "udp");
1090 a_fail(a
, "unknown-service", "%s", av
[i
+ 1], A_END
);
1093 pt
= ntohs(s
->s_port
);
1096 if (pt
== 0 || pt
>= 65536) {
1097 a_fail(a
, "invalid-port", "%lu", pt
, A_END
);
1100 r
->sa
.sin
.sin_port
= htons(pt
);
1102 /* --- Report backgrounding --- *
1104 * Do this for consistency of interface, even if we're going to get the
1105 * answer straight away.
1108 if (a_bgadd(a
, &r
->bg
, tag
, a_rescancel
))
1110 T( trace(T_ADMIN
, "admin: %u, resop %s, hostname `%s'",
1111 a
->seq
, BGTAG(r
), r
->addr
); )
1113 /* --- If the name is numeric, do it the easy way --- */
1115 if (inet_aton(av
[i
], &r
->sa
.sin
.sin_addr
)) {
1116 T( trace(T_ADMIN
, "admin: resop %s done the easy way", BGTAG(r
)); )
1119 a_bgrelease(&r
->bg
);
1123 /* --- Store everything for later and crank up the resolver --- */
1125 gettimeofday(&tv
, 0);
1126 tv
.tv_sec
+= T_RESOLVE
;
1127 sel_addtimer(&sel
, &r
->t
, &tv
, a_restimer
, r
);
1128 bres_byname(&r
->r
, r
->addr
, a_resolved
, r
);
1133 if (r
->addr
) xfree(r
->addr
);
1137 /*----- Option parsing ----------------------------------------------------*/
1139 #define OPTIONS(argc, argv, guts) do { \
1140 char **o_av = argv; \
1144 if (mystrieq(*o_av, "--")) { \
1149 if (**o_av == '-') \
1153 argc -= o_av - argv; \
1157 #define OPT(name, guts) if (mystrieq(*o_av, name)) { guts continue; }
1159 #define OPTARG(name, arg, guts) OPT(name, { \
1162 if (!arg) goto bad_syntax; \
1166 #define OPTTIME(name, arg, guts) OPTARG(name, o_arg, { \
1168 if ((arg = a_parsetime(o_arg)) < 0) { \
1169 a_fail(a, "bad-time-spec", "%s", o_arg, A_END); \
1175 /*----- Adding peers ------------------------------------------------------*/
1177 /* --- @a_doadd@ --- *
1179 * Arguments: @admin_resop *r@ = resolver operation
1180 * @int rc@ = how it worked
1184 * Use: Handles a completed resolution.
1187 static void a_doadd(admin_resop
*r
, int rc
)
1189 admin_addop
*add
= (admin_addop
*)r
;
1191 T( trace(T_ADMIN
, "admin: done add op %s", BGTAG(add
)); )
1193 if (rc
== ARES_OK
) {
1194 add
->peer
.sasz
= add
->r
.sasz
;
1195 add
->peer
.sa
= add
->r
.sa
;
1196 if (p_findbyaddr(&add
->r
.sa
))
1197 a_bgfail(&add
->r
.bg
, "peer-addr-exists", "?ADDR", &add
->r
.sa
, A_END
);
1198 else if (p_find(add
->peer
.name
))
1199 a_bgfail(&add
->r
.bg
, "peer-exists", "%s", add
->peer
.name
, A_END
);
1200 else if (!p_create(&add
->peer
))
1201 a_bgfail(&add
->r
.bg
, "peer-create-fail", "%s", add
->peer
.name
, A_END
);
1206 xfree(add
->peer
.name
);
1209 /* --- @acmd_add@ --- *
1211 * Arguments: @admin *a@ = connection which requested the addition
1212 * @unsigned ac@ = argument count
1213 * @char *av[]@ = pointer to the argument list
1217 * Use: Adds a new peer.
1220 static void acmd_add(admin
*a
, unsigned ac
, char *av
[])
1222 const char *tag
= 0;
1225 /* --- Set stuff up --- */
1227 add
= xmalloc(sizeof(*add
));
1230 add
->peer
.tops
= tun_default
;
1233 /* --- Parse options --- */
1236 OPTARG("-background", arg
, { tag
= arg
; })
1237 OPTARG("-tunnel", arg
, {
1241 a_fail(a
, "unknown-tunnel", "%s", arg
, A_END
);
1244 if (mystrieq(arg
, tunnels
[i
]->name
)) {
1245 add
->peer
.tops
= tunnels
[i
];
1250 OPTTIME("-keepalive", t
, { add
->peer
.t_ka
= t
; })
1251 OPT("-cork", { add
->peer
.kxf
|= KXF_CORK
; })
1254 /* --- Make sure someone's not got there already --- */
1256 if (!av
[0] || !av
[1])
1259 a_fail(a
, "peer-exists", "%s", *av
, A_END
);
1262 add
->peer
.name
= xstrdup(*av
++);
1265 /* --- Crank up the resolver --- */
1267 a_resolve(a
, &add
->r
, tag
, a_doadd
, ac
, av
);
1270 /* --- Clearing up --- */
1273 a_fail(a
, "bad-syntax", "add", "[OPTIONS] PEER ADDR ...", A_END
);
1275 if (add
->peer
.name
) xfree(add
->peer
.name
);
1280 /*----- Ping --------------------------------------------------------------*/
1282 /* --- @a_pingcancel@ --- *
1284 * Arguments: @admin_bgop *bg@ = background operation block
1288 * Use: Cancels a running ping.
1291 static void a_pingcancel(admin_bgop
*bg
)
1293 admin_pingop
*pg
= (admin_pingop
*)bg
;
1294 T( trace(T_ADMIN
, "admin: cancel ping op %s", BGTAG(pg
)); )
1295 p_pingdone(&pg
->ping
, PING_NONOTIFY
);
1298 /* --- @a_pong@ --- *
1300 * Arguments: @int rc@ = return code
1301 * @void *v@ = ping operation block
1305 * Use: Collects what happened to a ping message.
1308 static void a_pong(int rc
, void *v
)
1310 admin_pingop
*pg
= v
;
1316 gettimeofday(&tv
, 0);
1317 tv_sub(&tv
, &tv
, &pg
->pingtime
);
1318 millis
= (double)tv
.tv_sec
* 1000 + (double)tv
.tv_usec
/1000;
1319 a_bginfo(&pg
->bg
, "ping-ok", "%.1f", millis
, A_END
);
1323 a_bginfo(&pg
->bg
, "ping-timeout", A_END
);
1327 a_bginfo(&pg
->bg
, "ping-peer-died", A_END
);
1333 T( trace(T_ADMIN
, "admin: ponged ping op %s", BGTAG(pg
)); )
1334 a_bgrelease(&pg
->bg
);
1337 /* --- @acmd_ping@, @acmd_eping@ --- *
1339 * Arguments: @admin *a@ = connection which requested the ping
1340 * @unsigned ac@ = argument count
1341 * @char *av[]@ = pointer to the argument list
1345 * Use: Pings a peer.
1348 static void a_ping(admin
*a
, unsigned ac
, char *av
[],
1349 const char *cmd
, unsigned msg
)
1353 admin_pingop
*pg
= 0;
1354 const char *tag
= 0;
1357 OPTARG("-background", arg
, { tag
= arg
; })
1358 OPTTIME("-timeout", arg
, { t
= arg
; })
1360 if (!*av
|| av
[1]) goto bad_syntax
;
1361 if ((p
= a_findpeer(a
, *av
)) == 0)
1363 pg
= xmalloc(sizeof(*pg
));
1364 gettimeofday(&pg
->pingtime
, 0);
1365 if (a_bgadd(a
, &pg
->bg
, tag
, a_pingcancel
))
1367 T( trace(T_ADMIN
, "admin: ping op %s: %s to %s",
1368 BGTAG(pg
), cmd
, p_name(p
)); )
1369 if (p_pingsend(p
, &pg
->ping
, msg
, t
, a_pong
, pg
)) {
1370 a_bgfail(&pg
->bg
, "ping-send-failed", A_END
);
1371 a_bgrelease(&pg
->bg
);
1376 a_fail(a
, "bad-syntax", "%s", cmd
, "[OPTIONS] PEER", cmd
, A_END
);
1382 static void acmd_ping(admin
*a
, unsigned ac
, char *av
[])
1383 { a_ping(a
, ac
, av
, "ping", MISC_PING
); }
1384 static void acmd_eping(admin
*a
, unsigned ac
, char *av
[])
1385 { a_ping(a
, ac
, av
, "eping", MISC_EPING
); }
1387 /*----- Service commands --------------------------------------------------*/
1389 static void acmd_svcclaim(admin
*a
, unsigned ac
, char *av
[])
1394 svc
= sym_find(&a_svcs
, av
[0], -1, sizeof(*svc
), &f
);
1396 if (versioncmp(av
[1], svc
->version
) <= 0) {
1399 "%s", SYM_NAME(svc
),
1404 a_write(svc
->prov
, "SVCCLAIM", 0, "%s", av
[0], "%s", av
[1], A_END
);
1408 svc
->version
= xstrdup(av
[1]);
1409 svc
->next
= a
->svcs
;
1411 if (a
->svcs
) a
->svcs
->prev
= svc
;
1413 a_notify("SVCCLAIM", "%s", SYM_NAME(svc
), "%s", svc
->version
, A_END
);
1417 static void acmd_svcrelease(admin
*a
, unsigned ac
, char *av
[])
1421 if ((svc
= a_svcfind(a
, av
[0])) == 0)
1423 if (svc
->prov
!= a
) {
1424 a_fail(a
, "not-service-provider", "%s", SYM_NAME(svc
), A_END
);
1431 static void acmd_svcensure(admin
*a
, unsigned ac
, char *av
[])
1435 if ((svc
= a_svcfind(a
, av
[0])) == 0)
1437 if (av
[1] && versioncmp(svc
->version
, av
[1]) < 0) {
1438 a_fail(a
, "service-too-old",
1439 "%s", SYM_NAME(svc
),
1447 static void acmd_svcquery(admin
*a
, unsigned ac
, char *av
[])
1451 if ((svc
= a_svcfind(a
, av
[0])) != 0) {
1452 a_info(a
, "name=%s", SYM_NAME(svc
), "version=%s", svc
->version
, A_END
);
1457 static void acmd_svclist(admin
*a
, unsigned ac
, char *av
[])
1462 for (sym_mkiter(&i
, &a_svcs
); (svc
= sym_next(&i
)) != 0; )
1463 a_info(a
, "%s", SYM_NAME(svc
), "%s", svc
->version
, A_END
);
1467 static void a_canceljob(admin_bgop
*bg
)
1469 admin_svcop
*svc
= (admin_svcop
*)bg
;
1471 a_write(svc
->prov
, "SVCCANCEL", 0, "%s", a_jobidencode(svc
), A_END
);
1475 static void acmd_svcsubmit(admin
*a
, unsigned ac
, char *av
[])
1477 const char *tag
= 0;
1480 const char *ver
= 0;
1484 OPTARG("-background", arg
, { tag
= arg
; })
1485 OPTARG("-version", arg
, { ver
= arg
; })
1487 if (!*av
) goto bad_syntax
;
1488 if ((svc
= a_svcfind(a
, *av
)) == 0) goto fail
;
1489 if (ver
&& versioncmp(svc
->version
, ver
) < 0) {
1490 a_fail(a
, "service-too-old",
1491 "%s", SYM_NAME(svc
),
1496 if ((svcop
= a_jobcreate(svc
->prov
)) == 0) {
1497 a_fail(a
, "provider-overloaded", A_END
);
1500 if (a_bgadd(a
, &svcop
->bg
, tag
, a_canceljob
)) {
1501 a_jobdestroy(svcop
);
1504 a_write(svc
->prov
, "SVCJOB", 0,
1505 "%s", a_jobidencode(svcop
),
1511 a_fail(a
, "bad-syntax", "svcsubmit", "[OPTIONS] SERVICE ARGS...", A_END
);
1518 static void a_replycmd(admin
*a
, const char *status
, int donep
, char *av
[])
1522 if ((svc
= a_jobiddecode(&a
->j
, av
[0])) == 0) {
1523 a_fail(a
, "unknown-jobid", av
[0], A_END
);
1526 a_write(svc
->bg
.a
, status
, svc
->bg
.tag
, "?TOKENS", av
+ 1, A_END
);
1529 a_bgrelease(&svc
->bg
);
1534 static void acmd_svcok(admin
*a
, unsigned ac
, char *av
[])
1535 { a_replycmd(a
, "OK", 1, av
); }
1536 static void acmd_svcinfo(admin
*a
, unsigned ac
, char *av
[])
1537 { a_replycmd(a
, "INFO", 0, av
); }
1538 static void acmd_svcfail(admin
*a
, unsigned ac
, char *av
[])
1539 { a_replycmd(a
, "FAIL", 1, av
); }
1541 /*----- Administration commands -------------------------------------------*/
1543 /* --- Miscellaneous commands --- */
1545 /* --- @traceish@ --- *
1547 * Arguments: @admin *a@ = connection to complain on
1548 * @unsigned ac@ = number of arguments
1549 * @char *av[]@ = vector of arguments
1550 * @const char *what@ = what we're messing with
1551 * @const trace_opt *tt@ = options table
1552 * @unsigned *ff@ = where the flags are
1554 * Returns: Nonzero if anything changed.
1556 * Use: Guts of trace-ish commands like `trace' and `watch'.
1559 static int traceish(admin
*a
, unsigned ac
, char *av
[],
1560 const char *what
, const trace_opt
*tt
, unsigned *ff
)
1564 if (!ac
|| strcmp(av
[0], "?") == 0) {
1566 for (t
= tt
; t
->ch
; t
++) {
1567 a_info(a
, "*%c%c %s",
1568 t
->ch
, (*ff
& t
->f
) == t
->f ?
'+' : ' ', t
->help
, A_END
);
1578 case '+': sense
= 1; break;
1579 case '-': sense
= 0; break;
1581 for (t
= tt
; t
->ch
; t
++) {
1583 if (sense
) f
|= t
->f
;
1588 a_fail(a
, "bad-%s-option", what
, "%c", *p
, A_END
);
1604 static void acmd_trace(admin
*a
, unsigned ac
, char *av
[])
1606 if (traceish(a
, ac
, av
, "trace", tr_opts
, &tr_flags
))
1607 trace_level(tr_flags
);
1612 static void acmd_watch(admin
*a
, unsigned ac
, char *av
[])
1613 { traceish(a
, ac
, av
, "watch", w_opts
, &a
->f
); }
1615 static void alertcmd(admin
*a
, unsigned f_and
, unsigned f_eq
,
1616 const char *status
, char *av
[])
1617 { a_alert(f_and
, f_eq
, status
, "USER", "?TOKENS", av
, A_END
); a_ok(a
); }
1618 static void acmd_notify(admin
*a
, unsigned ac
, char *av
[])
1619 { alertcmd(a
, AF_NOTE
, AF_NOTE
, "NOTE", av
); }
1620 static void acmd_warn(admin
*a
, unsigned ac
, char *av
[])
1621 { alertcmd(a
, AF_WARN
, AF_WARN
, "WARN", av
); }
1623 static void acmd_port(admin
*a
, unsigned ac
, char *av
[])
1624 { a_info(a
, "%u", p_port(), A_END
); a_ok(a
); }
1626 static void acmd_daemon(admin
*a
, unsigned ac
, char *av
[])
1628 if (flags
& F_DAEMON
)
1629 a_fail(a
, "already-daemon", A_END
);
1631 a_notify("DAEMON", A_END
);
1635 a_fail(a
, "daemon-error", "?ERRNO", A_END
);
1643 static void acmd_jobs(admin
*a
, unsigned ac
, char *av
[])
1647 for (bg
= a
->bg
; bg
; bg
= bg
->next
) {
1649 a_info(a
, "%s", bg
->tag
, A_END
);
1654 static void acmd_bgcancel(admin
*a
, unsigned ac
, char *av
[])
1658 if ((bg
= a_bgfind(a
, av
[0])) == 0)
1659 a_fail(a
, "unknown-tag", "%s", av
[0], A_END
);
1667 static void acmd_list(admin
*a
, unsigned ac
, char *av
[])
1669 FOREACH_PEER(p
, { a_info(a
, "%s", p_name(p
), A_END
); });
1673 static void acmd_ifname(admin
*a
, unsigned ac
, char *av
[])
1677 if ((p
= a_findpeer(a
, av
[0])) != 0) {
1678 a_info(a
, "%s", p_ifname(p
), A_END
);
1683 static void acmd_setifname(admin
*a
, unsigned ac
, char *av
[])
1687 if ((p
= a_findpeer(a
, av
[0])) != 0) {
1688 a_notify("NEWIFNAME", "?PEER", p
, "%s", p_ifname(p
), "%s", av
[1], A_END
);
1689 p_setifname(p
, av
[1]);
1694 static void acmd_getchal(admin
*a
, unsigned ac
, char *av
[])
1698 buf_init(&b
, buf_i
, PKBUFSZ
);
1700 a_info(a
, "?B64", BBASE(&b
), (size_t)BLEN(&b
), A_END
);
1704 static void acmd_checkchal(admin
*a
, unsigned ac
, char *av
[])
1711 base64_decode(&b64
, av
[0], strlen(av
[0]), &d
);
1712 base64_decode(&b64
, 0, 0, &d
);
1713 buf_init(&b
, d
.buf
, d
.len
);
1714 if (c_check(&b
) || BBAD(&b
) || BLEFT(&b
))
1715 a_fail(a
, "invalid-challenge", A_END
);
1721 static void acmd_greet(admin
*a
, unsigned ac
, char *av
[])
1727 if ((p
= a_findpeer(a
, av
[0])) != 0) {
1729 base64_decode(&b64
, av
[1], strlen(av
[1]), &d
);
1730 base64_decode(&b64
, 0, 0, &d
);
1731 p_greet(p
, d
.buf
, d
.len
);
1737 static void acmd_addr(admin
*a
, unsigned ac
, char *av
[])
1742 if ((p
= a_findpeer(a
, av
[0])) != 0) {
1744 assert(ad
->sa
.sa_family
== AF_INET
);
1745 a_info(a
, "?ADDR", ad
, A_END
);
1750 static void acmd_peerinfo(admin
*a
, unsigned ac
, char *av
[])
1755 if ((p
= a_findpeer(a
, av
[0])) != 0) {
1757 a_info(a
, "tunnel=%s", ps
->tops
->name
, A_END
);
1758 a_info(a
, "keepalive=%lu", ps
->t_ka
, A_END
);
1763 static void acmd_servinfo(admin
*a
, unsigned ac
, char *av
[])
1765 a_info(a
, "implementation=edgeware-tripe", A_END
);
1766 a_info(a
, "version=%s", VERSION
, A_END
);
1767 a_info(a
, "daemon=%s", BOOL(flags
& F_DAEMON
), A_END
);
1771 static void acmd_stats(admin
*a
, unsigned ac
, char *av
[])
1776 if ((p
= a_findpeer(a
, av
[0])) == 0)
1780 a_info(a
, "start-time=%s", timestr(st
->t_start
), A_END
);
1781 a_info(a
, "last-packet-time=%s", timestr(st
->t_last
), A_END
);
1782 a_info(a
, "last-keyexch-time=%s", timestr(st
->t_kx
), A_END
);
1783 a_info(a
, "packets-in=%lu", st
->n_in
, "bytes-in=%lu", st
->sz_in
, A_END
);
1785 "packets-out=%lu", st
->n_out
,
1786 "bytes-out=%lu", st
->sz_out
,
1789 "keyexch-packets-in=%lu", st
->n_kxin
,
1790 "keyexch-bytes-in=%lu", st
->sz_kxin
,
1793 "keyexch-packets-out=%lu", st
->n_kxout
,
1794 "keyexch-bytes-out=%lu", st
->sz_kxout
,
1797 "ip-packets-in=%lu", st
->n_ipin
,
1798 "ip-bytes-in=%lu", st
->sz_ipin
,
1801 "ip-packets-out=%lu", st
->n_ipout
,
1802 "ip-bytes-out=%lu", st
->sz_ipout
,
1804 a_info(a
, "rejected-packets=%lu", st
->n_reject
, A_END
);
1808 static void acmd_kill(admin
*a
, unsigned ac
, char *av
[])
1812 if ((p
= a_findpeer(a
, av
[0])) != 0) {
1818 static void acmd_forcekx(admin
*a
, unsigned ac
, char *av
[])
1822 if ((p
= a_findpeer(a
, av
[0])) != 0) {
1823 kx_start(&p
->kx
, 1);
1828 static void acmd_reload(admin
*a
, unsigned ac
, char *av
[])
1829 { p_keyreload(); a_ok(a
); }
1831 static void acmd_quit(admin
*a
, unsigned ac
, char *av
[])
1833 a_warn("SERVER", "quit", "admin-request", A_END
);
1838 static void acmd_version(admin
*a
, unsigned ac
, char *av
[])
1840 a_info(a
, "%s", PACKAGE
, "%s", VERSION
, A_END
);
1844 static void acmd_tunnels(admin
*a
, unsigned ac
, char *av
[])
1848 for (i
= 0; tunnels
[i
]; i
++)
1849 a_info(a
, "%s", tunnels
[i
]->name
, A_END
);
1853 /* --- The command table and help --- */
1855 typedef struct acmd
{
1858 unsigned argmin
, argmax
;
1859 void (*func
)(admin */
*a*/
, unsigned /*ac*/, char */
*av*/
[]);
1862 static void acmd_help(admin */
*a*/
, unsigned /*ac*/, char */
*av*/
[]);
1864 static const acmd acmdtab
[] = {
1865 { "add", "[OPTIONS] PEER ADDR ...", 2, 0xffff, acmd_add
},
1866 { "addr", "PEER", 1, 1, acmd_addr
},
1867 { "bgcancel", "TAG", 1, 1, acmd_bgcancel
},
1868 { "checkchal", "CHAL", 1, 1, acmd_checkchal
},
1869 { "daemon", 0, 0, 0, acmd_daemon
},
1870 { "eping", "[OPTIONS] PEER", 1, 0xffff, acmd_eping
},
1871 { "forcekx", "PEER", 1, 1, acmd_forcekx
},
1872 { "getchal", 0, 0, 0, acmd_getchal
},
1873 { "greet", "PEER CHAL", 2, 2, acmd_greet
},
1874 { "help", 0, 0, 0, acmd_help
},
1875 { "ifname", "PEER", 1, 1, acmd_ifname
},
1876 { "jobs", 0, 0, 0, acmd_jobs
},
1877 { "kill", "PEER", 1, 1, acmd_kill
},
1878 { "list", 0, 0, 0, acmd_list
},
1879 { "notify", "MESSAGE ...", 1, 0xffff, acmd_notify
},
1880 { "peerinfo", "PEER", 1, 1, acmd_peerinfo
},
1881 { "ping", "[OPTIONS] PEER", 1, 0xffff, acmd_ping
},
1882 { "port", 0, 0, 0, acmd_port
},
1883 { "quit", 0, 0, 0, acmd_quit
},
1884 { "reload", 0, 0, 0, acmd_reload
},
1885 { "servinfo", 0, 0, 0, acmd_servinfo
},
1886 { "setifname", "PEER NEW-NAME", 2, 2, acmd_setifname
},
1887 { "svcclaim", "SERVICE VERSION", 2, 2, acmd_svcclaim
},
1888 { "svcensure", "SERVICE [VERSION]", 1, 2, acmd_svcensure
},
1889 { "svcfail", "JOBID TOKENS...", 1, 0xffff, acmd_svcfail
},
1890 { "svcinfo", "JOBID TOKENS...", 1, 0xffff, acmd_svcinfo
},
1891 { "svclist", 0, 0, 0, acmd_svclist
},
1892 { "svcok", "JOBID", 1, 1, acmd_svcok
},
1893 { "svcquery", "SERVICE", 1, 1, acmd_svcquery
},
1894 { "svcrelease", "SERVICE", 1, 1, acmd_svcrelease
},
1895 { "svcsubmit", "[OPTIONS] SERVICE TOKENS...",
1896 2, 0xffff, acmd_svcsubmit
},
1897 { "stats", "PEER", 1, 1, acmd_stats
},
1899 { "trace", "[OPTIONS]", 0, 1, acmd_trace
},
1901 { "tunnels", 0, 0, 0, acmd_tunnels
},
1902 { "version", 0, 0, 0, acmd_version
},
1903 { "warn", "MESSAGE ...", 1, 0xffff, acmd_warn
},
1904 { "watch", "[OPTIONS]", 0, 1, acmd_watch
},
1908 static void acmd_help(admin
*a
, unsigned ac
, char *av
[])
1912 for (c
= acmdtab
; c
->name
; c
++) {
1914 a_info(a
, "%s", c
->name
, "*%s", c
->help
, A_END
);
1916 a_info(a
, "%s", c
->name
, A_END
);
1921 /*----- Connection handling -----------------------------------------------*/
1923 /* --- @a_destroypending@ --- *
1929 * Use: Destroys pending admin connections at a safe time.
1932 static void a_destroypending(void)
1934 admin
*a
, *aa
, *head
;
1935 admin_bgop
*bg
, *bbg
;
1936 admin_service
*svc
, *ssvc
;
1938 /* --- Destroy connections marked as pending --- *
1940 * Slightly messy. Killing clients may cause others to finally die. Make
1941 * sure that they can be put on the list without clobbering anything or
1948 for (a
= head
; a
; a
= aa
) {
1950 assert(a
->f
& AF_DEAD
);
1952 /* --- Report what we're doing --- */
1954 T( trace(T_ADMIN
, "admin: completing destruction of connection %u",
1957 /* --- If this is the foreground client then shut down --- */
1959 if (a
->f
& AF_FOREGROUND
) {
1960 T( trace(T_ADMIN
, "admin: foreground client quit: shutting down"); )
1961 a_warn("SERVER", "quit", "foreground-eof", A_END
);
1965 /* --- Abort any background jobs in progress --- */
1967 for (bg
= a
->bg
; bg
; bg
= bbg
) {
1970 if (bg
->tag
) xfree(bg
->tag
);
1974 /* --- Release services I hold, and abort pending jobs --- */
1976 for (svc
= a
->svcs
; svc
; svc
= ssvc
) {
1980 a_jobtablefinal(&a
->j
);
1982 /* --- Close file descriptors and selectory --- */
1984 selbuf_destroy(&a
->b
);
1985 if (a
->b
.reader
.fd
!= a
->w
.fd
) close(a
->b
.reader
.fd
);
1987 if (a_stdin
== a
) a_stdin
= 0;
1996 /* --- @a_destroy@ --- *
1998 * Arguments: @admin *a@ = pointer to an admin block
2002 * Use: Destroys an admin block. This requires a certain amount of
2006 static void freequeue(oqueue
*q
)
2010 for (o
= q
->hd
; o
; o
= oo
) {
2017 static void a_destroy(admin
*a
)
2022 if (a
->next
) a
->next
->prev
= a
->prev
;
2023 if (a
->prev
) a
->prev
->next
= a
->next
;
2024 else admins
= a
->next
;
2026 if (a
->out
.hd
) sel_rmfile(&a
->w
);
2033 T( trace(T_ADMIN
, "admin: killing connection %u", a
->seq
); )
2036 /* --- @a_line@ --- *
2038 * Arguments: @char *p@ = pointer to the line read
2039 * @size_t len@ = length of the line
2040 * @void *vp@ = pointer to my admin block
2044 * Use: Handles a line of input.
2047 static void a_line(char *p
, size_t len
, void *vp
)
2062 selbuf_disable(&a
->b
);
2066 ac
= str_qsplit(p
, av
, N(av
) - 1, 0, STRF_QUOTE
);
2070 for (c
= acmdtab
; c
->name
; c
++) {
2071 if (mystrieq(av
[0], c
->name
)) {
2073 if (c
->argmin
> ac
|| ac
> c
->argmax
) {
2075 a_fail(a
, "bad-syntax", "%s", c
->name
, "", A_END
);
2077 a_fail(a
, "bad-syntax", "%s", c
->name
, "%s", c
->help
, A_END
);
2079 c
->func(a
, ac
, av
+ 1);
2083 a_fail(a
, "unknown-command", "%s", av
[0], A_END
);
2086 /* --- @a_create@ --- *
2088 * Arguments: @int fd_in, fd_out@ = file descriptors to use
2089 * @unsigned f@ = initial flags to set
2093 * Use: Creates a new admin connection.
2096 void a_create(int fd_in
, int fd_out
, unsigned f
)
2098 admin
*a
= CREATE(admin
);
2100 T( static unsigned seq
= 0;
2102 T( trace(T_ADMIN
, "admin: accepted connection %u", a
->seq
); )
2106 a_jobtableinit(&a
->j
);
2108 if (fd_in
== STDIN_FILENO
) a_stdin
= a
;
2109 fdflags(fd_in
, O_NONBLOCK
, O_NONBLOCK
, FD_CLOEXEC
, FD_CLOEXEC
);
2110 if (fd_out
!= fd_in
)
2111 fdflags(fd_out
, O_NONBLOCK
, O_NONBLOCK
, FD_CLOEXEC
, FD_CLOEXEC
);
2112 selbuf_init(&a
->b
, &sel
, fd_in
, a_line
, a
);
2113 sel_initfile(&sel
, &a
->w
, fd_out
, SEL_WRITE
, a_flush
, a
);
2114 a
->out
.hd
= a
->out
.tl
= 0;
2117 if (admins
) admins
->prev
= a
;
2121 /* --- @a_accept@ --- *
2123 * Arguments: @int fd@ = file descriptor to accept
2124 * @unsigned mode@ = what to do
2125 * @void *v@ = uninteresting pointer
2129 * Use: Accepts a new admin connection.
2132 static void a_accept(int fd
, unsigned mode
, void *v
)
2135 struct sockaddr_un sun
;
2136 size_t sz
= sizeof(sun
);
2138 if ((nfd
= accept(fd
, (struct sockaddr
*)&sun
, &sz
)) < 0) {
2139 if (errno
!= EINTR
&& errno
!= EAGAIN
&& errno
!= EWOULDBLOCK
&&
2140 errno
!= ECONNABORTED
&& errno
!= EPROTO
)
2141 a_warn("ADMIN", "accept-error", "?ERRNO", A_END
);
2144 a_create(nfd
, nfd
, 0);
2147 /* --- @a_preselect@ --- *
2153 * Use: Informs the admin module that we're about to select again,
2154 * and that it should do cleanup things it has delayed until a
2158 void a_preselect(void) { if (a_dead
) a_destroypending(); }
2160 /* --- @a_daemon@ --- *
2166 * Use: Informs the admin module that it's a daemon.
2169 void a_daemon(void) { flags
|= F_DAEMON
; }
2171 /* --- @a_init@ --- *
2173 * Arguments: @const char *name@ = socket name to create
2174 * @uid_t u@ = user to own the socket
2175 * @gid_t g@ = group to own the socket
2179 * Use: Creates the admin listening socket.
2182 void a_init(const char *name
, uid_t u
, gid_t g
)
2186 struct sockaddr_un sun
;
2187 struct sigaction sa
;
2190 /* --- Create services table --- */
2192 sym_create(&a_svcs
);
2194 /* --- Set up the socket address --- */
2196 sz
= strlen(name
) + 1;
2197 if (sz
> sizeof(sun
.sun_path
))
2198 die(EXIT_FAILURE
, "socket name `%s' too long", name
);
2200 sun
.sun_family
= AF_UNIX
;
2201 memcpy(sun
.sun_path
, name
, sz
);
2202 sz
+= offsetof(struct sockaddr_un
, sun_path
);
2204 /* --- Attempt to bind to the socket --- */
2208 if ((fd
= socket(PF_UNIX
, SOCK_STREAM
, 0)) < 0)
2209 die(EXIT_FAILURE
, "couldn't create socket: %s", strerror(errno
));
2210 if (bind(fd
, (struct sockaddr
*)&sun
, sz
) < 0) {
2213 if (errno
!= EADDRINUSE
) {
2214 die(EXIT_FAILURE
, "couldn't bind to address `%s': %s",
2215 sun
.sun_path
, strerror(e
));
2218 die(EXIT_FAILURE
, "too many retries; giving up");
2220 if (!connect(fd
, (struct sockaddr
*)&sun
, sz
)) {
2221 die(EXIT_FAILURE
, "server already listening on admin socket `%s'",
2224 if (errno
!= ECONNREFUSED
)
2225 die(EXIT_FAILURE
, "couldn't bind to address: %s", strerror(e
));
2226 if (stat(sun
.sun_path
, &st
)) {
2227 die(EXIT_FAILURE
, "couldn't stat `%s': %s",
2228 sun
.sun_path
, strerror(errno
));
2230 if (!S_ISSOCK(st
.st_mode
))
2231 die(EXIT_FAILURE
, "object `%s' isn't a socket", sun
.sun_path
);
2232 T( trace(T_ADMIN
, "admin: stale socket found; removing it"); )
2233 unlink(sun
.sun_path
);
2237 chmod(sun
.sun_path
, 0600);
2238 if (chown(sun
.sun_path
, u
, g
)) {
2240 "admin: failed to give away socket: %s",
2243 fdflags(fd
, O_NONBLOCK
, O_NONBLOCK
, FD_CLOEXEC
, FD_CLOEXEC
);
2245 die(EXIT_FAILURE
, "couldn't listen on socket: %s", strerror(errno
));
2247 /* --- Listen to the socket --- */
2249 sel_initfile(&sel
, &sock
, fd
, SEL_READ
, a_accept
, 0);
2253 T( trace_custom(a_trace
, 0);
2254 trace(T_ADMIN
, "admin: enabled custom tracing"); )
2257 /* --- Set up signal handlers --- */
2259 sig_add(&s_term
, SIGTERM
, a_sigdie
, 0);
2260 sig_add(&s_hup
, SIGHUP
, a_sighup
, 0);
2261 signal(SIGPIPE
, SIG_IGN
);
2262 sigaction(SIGINT
, 0, &sa
);
2263 if (sa
.sa_handler
!= SIG_IGN
)
2264 sig_add(&s_int
, SIGINT
, a_sigdie
, 0);
2267 /*----- That's all, folks -------------------------------------------------*/