c4433e45005e3e34c1375405af64723977da55d0
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.
244 static void a_vformat(dstr
*d
, const char *fmt
, va_list ap
)
251 dstr_vputf(d
, fmt
+ 1, &ap
);
252 } else if (*fmt
== '?') {
253 if (strcmp(fmt
, "?ADDR") == 0) {
254 const addr
*a
= va_arg(ap
, const addr
*);
255 switch (a
->sa
.sa_family
) {
257 u_quotify(d
, "INET");
258 u_quotify(d
, inet_ntoa(a
->sin
.sin_addr
));
259 dstr_putf(d
, " %u", (unsigned)ntohs(a
->sin
.sin_port
));
264 } else if (strcmp(fmt
, "?B64") == 0) {
265 const octet
*p
= va_arg(ap
, const octet
*);
266 size_t n
= va_arg(ap
, size_t);
272 base64_encode(&b64
, p
, n
, d
);
273 base64_encode(&b64
, 0, 0, d
);
274 while (d
->len
&& d
->buf
[d
->len
- 1] == '=') d
->len
--;
275 } else if (strcmp(fmt
, "?TOKENS") == 0) {
276 const char *const *av
= va_arg(ap
, const char *const *);
277 while (*av
) u_quotify(d
, *av
++);
278 } else if (strcmp(fmt
, "?PEER") == 0)
279 u_quotify(d
, p_name(va_arg(ap
, peer
*)));
280 else if (strcmp(fmt
, "?ERRNO") == 0) {
281 dstr_putf(d
, " E%d", errno
);
282 u_quotify(d
, strerror(errno
));
286 if (*fmt
== '!') fmt
++;
288 dstr_vputf(&dd
, fmt
, &ap
);
289 u_quotify(d
, dd
.buf
);
291 fmt
= va_arg(ap
, const char *);
297 /* --- @a_write@, @a_vwrite@ --- *
299 * Arguments: @admin *a@ = admin connection to write to
300 * @const char *status@ = status code to report
301 * @const char *tag@ = tag string, or null
302 * @const char *fmt@ = pointer to format string
303 * @va_list ap@ = arguments in list
304 * @...@ = other arguments
308 * Use: Sends a message to an admin connection.
311 static void a_vwrite(admin
*a
, const char *status
, const char *tag
,
312 const char *fmt
, va_list ap
)
316 if (tag
) dstr_puts(&d
, "BG");
317 dstr_puts(&d
, status
);
318 if (tag
) u_quotify(&d
, tag
);
319 a_vformat(&d
, fmt
, ap
);
321 dosend(a
, d
.buf
, d
.len
);
325 static void a_write(admin
*a
, const char *status
, const char *tag
,
326 const char *fmt
, ...)
331 a_vwrite(a
, status
, tag
, fmt
, ap
);
335 /* --- @a_ok@, @a_info@, @a_fail@ --- *
337 * Arguments: @admin *a@ = connection
338 * @const char *fmt@ = format string
339 * @...@ = other arguments
343 * Use: Convenience functions for @a_write@.
346 static void a_ok(admin
*a
) { a_write(a
, "OK", 0, A_END
); }
348 static void a_info(admin
*a
, const char *fmt
, ...)
353 a_vwrite(a
, "INFO", 0, fmt
, ap
);
357 static void a_fail(admin
*a
, const char *fmt
, ...)
362 a_vwrite(a
, "FAIL", 0, fmt
, ap
);
366 /* --- @a_alert@, @a_valert@, @a_rawalert@ --- *
368 * Arguments: @unsigned f_and, f_eq@ = filter for connections
369 * @const char *status@ = status string
370 * @const char *fmt@ = pointer to format string
371 * @const char *p@ = pointer to raw string
372 * @size_t sz@ = size of raw string
373 * @va_list ap@ = arguments in list
374 * @...@ = other arguments
378 * Use: Write a message to all admin connections matched by the given
382 static void a_rawalert(unsigned f_and
, unsigned f_eq
, const char *status
,
383 const char *p
, size_t sz
)
388 if (!(flags
& F_INIT
))
390 dstr_puts(&d
, status
);
393 dstr_putm(&d
, p
, sz
);
398 for (a
= admins
; a
; a
= aa
) {
400 if ((a
->f
& f_and
) == f_eq
)
401 dosend(a
, d
.buf
, d
.len
);
406 static void a_valert(unsigned f_and
, unsigned f_eq
, const char *status
,
407 const char *fmt
, va_list ap
)
411 if (!(flags
& F_INIT
))
413 a_vformat(&d
, fmt
, ap
);
414 a_rawalert(f_and
, f_eq
, status
, fmt ? d
.buf
: 0, fmt ? d
.len
: 0);
418 static void a_alert(unsigned f_and
, unsigned f_eq
, const char *status
,
419 const char *fmt
, ...)
424 a_valert(f_and
, f_eq
, status
, fmt
, ap
);
428 /* --- @a_warn@ --- *
430 * Arguments: @const char *fmt@ = pointer to format string
431 * @...@ = other arguments
435 * Use: Informs all admin connections of a warning.
438 void a_warn(const char *fmt
, ...)
444 a_valert(0, 0, "WARN", fmt
, ap
);
447 fprintf(stderr
, "%s: ", QUIS
);
448 a_vformat(&d
, fmt
, ap
);
450 dstr_write(&d
, stderr
);
456 /* --- @a_trace@ --- *
458 * Arguments: @const char *p@ = pointer to a buffer
459 * @size_t sz@ = size of the buffer
460 * @void *v@ = uninteresting pointer
464 * Use: Custom trace output handler. Sends trace messages to
465 * interested admin connections.
469 static void a_trace(const char *p
, size_t sz
, void *v
)
470 { a_rawalert(AF_TRACE
, AF_TRACE
, "TRACE", p
, sz
); }
473 /* --- @a_notify@ --- *
475 * Arguments: @const char *fmt@ = pointer to format string
476 * @...@ = other arguments
480 * Use: Sends a notification to interested admin connections.
483 void a_notify(const char *fmt
, ...)
488 a_valert(AF_NOTE
, AF_NOTE
, "NOTE", fmt
, ap
);
492 /* --- @a_quit@ --- *
498 * Use: Shuts things down nicely.
505 FOREACH_PEER(p
, { p_destroy(p
); });
509 /* --- @a_sigdie@ --- *
511 * Arguments: @int sig@ = signal number
512 * @void *v@ = an uninteresting argument
516 * Use Shuts down on receipt of a fatal signal.
519 static void a_sigdie(int sig
, void *v
)
525 case SIGTERM
: p
= "SIGTERM"; break;
526 case SIGINT
: p
= "SIGINT"; break;
528 sprintf(buf
, "%i", sig
);
532 a_warn("SERVER", "quit", "signal", "%s", p
, A_END
);
536 /* --- @a_sighup@ --- *
538 * Arguments: @int sig@ = signal number
539 * @void *v@ = an uninteresting argument
543 * Use Logs a message about SIGHUP not being useful.
546 static void a_sighup(int sig
, void *v
)
547 { a_warn("SERVER", "ignore", "signal", "SIGHUP", A_END
); }
549 /* --- @a_parsetime@ --- *
551 * Arguments; @const char *p@ = time string to parse
553 * Returns: Time in seconds, or @< 0@ on error.
556 static long a_parsetime(const char *p
)
559 long t
= strtol(p
, &q
, 0);
565 case 's': if (q
[1] != 0)
572 /* --- @a_findpeer@ --- *
574 * Arguments: @admin *a@ = admin connection
575 * @const char *pn@ = peer name
577 * Returns: The peer, or null if not there.
579 * Use: Finds a peer, reporting an error if it failed.
582 static peer
*a_findpeer(admin
*a
, const char *pn
)
586 if ((p
= p_find(pn
)) == 0)
587 a_fail(a
, "unknown-peer", "%s", pn
, A_END
);
591 /*----- Backgrounded operations -------------------------------------------*/
594 (((admin_bgop *)(bg))->tag ? ((admin_bgop *)(bg))->tag : "<foreground>")
596 /* --- @a_bgfind@ --- *
598 * Arguments: @admin *a@ = a client block
599 * @const char *tag@ = the requested tag
601 * Returns: The requested background job, or null.
604 static admin_bgop
*a_bgfind(admin
*a
, const char *tag
)
608 for (bg
= a
->bg
; bg
; bg
= bg
->next
) {
609 if (bg
->tag
&& strcmp(tag
, bg
->tag
) == 0)
615 /* --- @a_bgrelease@ --- *
617 * Arguments: @admin_bgop *bg@ = backgrounded operation
621 * Use: Removes a backgrounded operation from the queue, since
622 * (presumably) it's done.
625 static void a_bgrelease(admin_bgop
*bg
)
629 T( trace(T_ADMIN
, "admin: release bgop %s", BGTAG(bg
)); )
630 if (bg
->tag
) xfree(bg
->tag
);
631 else selbuf_enable(&a
->b
);
632 if (bg
->next
) bg
->next
->prev
= bg
->prev
;
633 if (bg
->prev
) bg
->prev
->next
= bg
->next
;
634 else a
->bg
= bg
->next
;
636 if (!a
->bg
&& (a
->f
& AF_CLOSE
)) a_destroy(a
);
639 /* --- @a_bgok@, @a_bginfo@, @a_bgfail@ --- *
641 * Arguments: @admin_bgop *bg@ = backgrounded operation
642 * @const char *fmt@ = format string
643 * @...@ = other arguments
647 * Use: Convenience functions for @a_write@.
650 static void a_bgok(admin_bgop
*bg
)
651 { a_write(bg
->a
, "OK", bg
->tag
, A_END
); }
653 static void a_bginfo(admin_bgop
*bg
, const char *fmt
, ...)
657 a_vwrite(bg
->a
, "INFO", bg
->tag
, fmt
, ap
);
661 static void a_bgfail(admin_bgop
*bg
, const char *fmt
, ...)
665 a_vwrite(bg
->a
, "FAIL", bg
->tag
, fmt
, ap
);
669 /* --- @a_bgadd@ --- *
671 * Arguments: @admin *a@ = administration connection
672 * @admin_bgop *bg@ = pointer to background operation
673 * @const char *tag@ = background tag, or null for foreground
674 * @void (*cancel)(admin_bgop *)@ = cancel function
676 * Returns: Zero for success, nonzero on failure.
678 * Use: Links a background job into the list.
681 static int a_bgadd(admin
*a
, admin_bgop
*bg
, const char *tag
,
682 void (*cancel
)(admin_bgop
*))
685 if (a_bgfind(a
, tag
)) {
686 a_fail(a
, "tag-exists", "%s", tag
, A_END
);
689 bg
->tag
= xstrdup(tag
);
693 selbuf_disable(&a
->b
);
699 if (a
->bg
) a
->bg
->prev
= bg
;
701 T( trace(T_ADMIN
, "admin: add bgop %s", BGTAG(bg
)); )
702 if (tag
) a_write(a
, "DETACH", tag
, A_END
);
706 /*----- Job table manipulation --------------------------------------------*/
709 #define JOB_INDEXMASK ((1ul << JOB_SHIFT) - 1)
710 #define JOB_SEQMASK ((1ul << (32 - JOB_SHIFT)) - 1)
712 #define JOB_END 0xfffffffful
714 static unsigned long a_joboffset
;
716 /* --- @a_jobidencode@ --- *
718 * Arguments: @admin_svcop *svc@ = pointer to a service operation
720 * Returns: A jobid for this job, in an internal static buffer.
722 * Use: Constructs a jobid. In order to dissuade people from
723 * predicting jobids, we obfuscate them.
725 * A `raw' jobid consists of two 16-bit fields. The low 16 bits
726 * are an index into a big array. The high 16 bits are a
727 * sequence number recording how many times that slot has been
730 * This `raw' jobid is then obfuscated by adding a randomly-
731 * generated offset, and multiplying (mod %$2^{32}$%) by a fixed
735 static const char *a_jobidencode(admin_svcop
*svc
)
737 admin_jobtable
*j
= &svc
->prov
->j
;
742 assert(svc
->index
<= JOB_INDEXMASK
);
743 seq
= j
->v
[svc
->index
].seq
;
744 assert(seq
<= JOB_SEQMASK
);
745 pre
= (unsigned long)svc
->index
| ((unsigned long)seq
<< JOB_SHIFT
);
746 sprintf(buf
, "J%08lx", ((pre
+ a_joboffset
) * 0x0f87a7a3ul
) & 0xffffffff);
750 /* --- @a_jobiddecode@ --- *
752 * Arguments: @admin_jobtable *j@ = pointer to a job table
753 * @const char *jid@ = pointer to a jobid string
755 * Returns: A pointer to the job's @svcop@ structure.
758 static admin_svcop
*a_jobiddecode(admin_jobtable
*j
, const char *jid
)
765 for (i
= 1; i
< 9; i
++) {
766 if (!isxdigit((unsigned char)jid
[i
]))
771 pre
= strtoul(jid
+ 1, 0, 16);
772 pre
= ((pre
* 0xbd11c40bul
) - a_joboffset
) & 0xffffffff;
773 i
= pre
& JOB_INDEXMASK
;
774 if (i
>= j
->n
|| j
->v
[i
].seq
!= (pre
>> JOB_SHIFT
))
776 return (j
->v
[i
].u
.op
);
779 /* --- @a_jobcreate@ --- *
781 * Arguments: @admin *a@ = pointer to administration client
783 * Returns: A pointer to a freshly-allocated @svcop@, or null.
785 * Use: Allocates a fresh @svcop@ and links it into a job table.
788 static admin_svcop
*a_jobcreate(admin
*a
)
793 admin_jobtable
*j
= &a
->j
;
795 if (j
->free
!= JOB_END
) {
797 j
->free
= j
->v
[i
].u
.next
;
800 if (j
->sz
> JOB_INDEXMASK
)
805 j
->v
= xmalloc(j
->sz
* sizeof(*j
->v
));
808 j
->v
= xrealloc(j
->v
, j
->sz
* sizeof(*j
->v
), sz
* sizeof(*j
->v
));
814 svc
= xmalloc(sizeof(*svc
));
817 svc
->next
= j
->active
;
819 if (j
->active
) j
->active
->prev
= svc
;
822 IF_TRACING(T_ADMIN
, {
823 trace(T_ADMIN
, "admin: created job %s (%u)", a_jobidencode(svc
), i
);
828 /* --- @a_jobdestroy@ --- *
830 * Arguments: @admin_svcop *svc@ = pointer to job block
834 * Use: Frees up a completed (or cancelled) job.
837 static void a_jobdestroy(admin_svcop
*svc
)
839 admin
*a
= svc
->prov
;
840 admin_jobtable
*j
= &a
->j
;
841 unsigned i
= svc
->index
;
843 IF_TRACING(T_ADMIN
, {
844 trace(T_ADMIN
, "admin: destroying job %s (%u)", a_jobidencode(svc
), i
);
846 assert(j
->v
[i
].u
.op
= svc
);
847 j
->v
[i
].u
.next
= j
->free
;
850 if (svc
->next
) svc
->next
->prev
= svc
->prev
;
851 if (svc
->prev
) svc
->prev
->next
= svc
->next
;
852 else j
->active
= svc
->next
;
855 /* --- @a_jobtableinit@ --- *
857 * Arguments: @admin_jobtable *j@ = pointer to job table
861 * Use: Initializes a job table.
864 static void a_jobtableinit(admin_jobtable
*j
)
867 a_joboffset
= GR_RANGE(&rand_global
, 0xffffffff) + 1;
874 /* --- @a_jobtablefinal@ --- *
876 * Arguments: @admin_jobtable *j@ = pointer to job table
880 * Use: Closes down a job table.
883 static void a_jobtablefinal(admin_jobtable
*j
)
885 admin_svcop
*svc
, *ssvc
;
887 for (svc
= j
->active
; svc
; svc
= ssvc
) {
889 a_bgfail(&svc
->bg
, "provider-failed", A_END
);
890 a_bgrelease(&svc
->bg
);
892 if (j
->v
) xfree(j
->v
);
895 /*----- Services infrastructure -------------------------------------------*/
897 /* --- @a_svcfind@ --- *
899 * Arguments: @admin *a@ = the requesting client
900 * @const char *name@ = service name wanted
902 * Returns: The service requested, or null.
904 * Use: Finds a service; reports an error if the service couldn't be
908 static admin_service
*a_svcfind(admin
*a
, const char *name
)
912 if ((svc
= sym_find(&a_svcs
, name
, -1, 0, 0)) == 0) {
913 a_fail(a
, "unknown-service", "%s", name
, A_END
);
919 /* --- @a_svcunlink@ --- *
921 * Arguments: @admin_service *svc@ = pointer to service structure
925 * Use: Unlinks the service from its provider, without issuing a
926 * message or freeing the structure. The version string is
930 static void a_svcunlink(admin_service
*svc
)
933 svc
->next
->prev
= svc
->prev
;
935 svc
->prev
->next
= svc
->next
;
937 svc
->prov
->svcs
= svc
->next
;
941 /* --- @a_svcrelease@ --- *
943 * Arguments: @admin_service *svc@ = pointer to service structure
947 * Use: Releases a service and frees its structure.
950 static void a_svcrelease(admin_service
*svc
)
952 a_notify("SVCRELEASE", "%s", SYM_NAME(svc
), A_END
);
954 sym_remove(&a_svcs
, svc
);
957 /*----- Name resolution operations ----------------------------------------*/
959 /* --- @a_resolved@ --- *
961 * Arguments: @struct hostent *h@ = pointer to resolved hostname
962 * @void *v@ = pointer to resolver operation
966 * Use: Handles a completed name resolution.
969 static void a_resolved(struct hostent
*h
, void *v
)
973 T( trace(T_ADMIN
, "admin: resop %s resolved", BGTAG(r
)); )
976 a_bgfail(&r
->bg
, "resolve-error", "%s", r
->addr
, A_END
);
977 r
->func(r
, ARES_FAIL
);
979 memcpy(&r
->sa
.sin
.sin_addr
, h
->h_addr
, sizeof(struct in_addr
));
987 /* --- @a_restimer@ --- *
989 * Arguments: @struct timeval *tv@ = timer
990 * @void *v@ = pointer to resolver operation
994 * Use: Times out a resolver.
997 static void a_restimer(struct timeval
*tv
, void *v
)
1001 T( trace(T_ADMIN
, "admin: resop %s timeout", BGTAG(r
)); )
1002 a_bgfail(&r
->bg
, "resolver-timeout", "%s", r
->addr
, A_END
);
1003 r
->func(r
, ARES_FAIL
);
1006 a_bgrelease(&r
->bg
);
1009 /* --- @a_rescancel@ --- *
1011 * Arguments: @admin_bgop *bg@ = background operation
1015 * Use: Cancels an add operation.
1018 static void a_rescancel(admin_bgop
*bg
)
1020 admin_resop
*r
= (admin_resop
*)bg
;
1022 T( trace(T_ADMIN
, "admin: cancel resop %s", BGTAG(r
)); )
1023 r
->func(r
, ARES_FAIL
);
1029 /* --- @a_resolve@ --- *
1031 * Arguments: @admin *a@ = administration connection
1032 * @admin_resop *r@ = resolver operation to run
1033 * @const char *tag@ = background operation tag
1034 * @void (*func)(struct admin_resop *, int@ = handler function
1035 * @unsigned ac@ = number of remaining arguments
1036 * @char *av[]@ = pointer to remaining arguments
1040 * Use: Cranks up a resolver job.
1043 static void a_resolve(admin
*a
, admin_resop
*r
, const char *tag
,
1044 void (*func
)(struct admin_resop
*, int),
1045 unsigned ac
, char *av
[])
1052 /* --- Fill in the easy bits of address --- */
1054 r
->bg
.tag
= "<starting>";
1057 if (mystrieq(av
[i
], "inet")) i
++;
1058 if (ac
- i
!= 1 && ac
- i
!= 2) {
1059 a_fail(a
, "bad-addr-syntax", "[inet] ADDRESS [PORT]", A_END
);
1062 r
->sa
.sin
.sin_family
= AF_INET
;
1063 r
->sasz
= sizeof(r
->sa
.sin
);
1064 r
->addr
= xstrdup(av
[i
]);
1068 pt
= strtoul(av
[i
+ 1], &p
, 0);
1070 struct servent
*s
= getservbyname(av
[i
+ 1], "udp");
1072 a_fail(a
, "unknown-service", "%s", av
[i
+ 1], A_END
);
1075 pt
= ntohs(s
->s_port
);
1078 if (pt
== 0 || pt
>= 65536) {
1079 a_fail(a
, "invalid-port", "%lu", pt
, A_END
);
1082 r
->sa
.sin
.sin_port
= htons(pt
);
1084 /* --- Report backgrounding --- *
1086 * Do this for consistency of interface, even if we're going to get the
1087 * answer straight away.
1090 if (a_bgadd(a
, &r
->bg
, tag
, a_rescancel
))
1092 T( trace(T_ADMIN
, "admin: %u, resop %s, hostname `%s'",
1093 a
->seq
, BGTAG(r
), r
->addr
); )
1095 /* --- If the name is numeric, do it the easy way --- */
1097 if (inet_aton(av
[i
], &r
->sa
.sin
.sin_addr
)) {
1098 T( trace(T_ADMIN
, "admin: resop %s done the easy way", BGTAG(r
)); )
1101 a_bgrelease(&r
->bg
);
1105 /* --- Store everything for later and crank up the resolver --- */
1107 gettimeofday(&tv
, 0);
1108 tv
.tv_sec
+= T_RESOLVE
;
1109 sel_addtimer(&sel
, &r
->t
, &tv
, a_restimer
, r
);
1110 bres_byname(&r
->r
, r
->addr
, a_resolved
, r
);
1115 if (r
->addr
) xfree(r
->addr
);
1119 /*----- Option parsing ----------------------------------------------------*/
1121 #define OPTIONS(argc, argv, guts) do { \
1122 char **o_av = argv; \
1126 if (mystrieq(*o_av, "--")) { \
1131 if (**o_av == '-') \
1135 argc -= o_av - argv; \
1139 #define OPT(name, guts) if (mystrieq(*o_av, name)) { guts continue; }
1141 #define OPTARG(name, arg, guts) OPT(name, { \
1144 if (!arg) goto bad_syntax; \
1148 #define OPTTIME(name, arg, guts) OPTARG(name, o_arg, { \
1150 if ((arg = a_parsetime(o_arg)) < 0) { \
1151 a_fail(a, "bad-time-spec", "%s", o_arg, A_END); \
1157 /*----- Adding peers ------------------------------------------------------*/
1159 /* --- @a_doadd@ --- *
1161 * Arguments: @admin_resop *r@ = resolver operation
1162 * @int rc@ = how it worked
1166 * Use: Handles a completed resolution.
1169 static void a_doadd(admin_resop
*r
, int rc
)
1171 admin_addop
*add
= (admin_addop
*)r
;
1173 T( trace(T_ADMIN
, "admin: done add op %s", BGTAG(add
)); )
1175 if (rc
== ARES_OK
) {
1176 add
->peer
.sasz
= add
->r
.sasz
;
1177 add
->peer
.sa
= add
->r
.sa
;
1178 if (p_findbyaddr(&add
->r
.sa
))
1179 a_bgfail(&add
->r
.bg
, "peer-addr-exists", "?ADDR", &add
->r
.sa
, A_END
);
1180 else if (p_find(add
->peer
.name
))
1181 a_bgfail(&add
->r
.bg
, "peer-exists", "%s", add
->peer
.name
, A_END
);
1182 else if (!p_create(&add
->peer
))
1183 a_bgfail(&add
->r
.bg
, "peer-create-fail", "%s", add
->peer
.name
, A_END
);
1188 xfree(add
->peer
.name
);
1191 /* --- @acmd_add@ --- *
1193 * Arguments: @admin *a@ = connection which requested the addition
1194 * @unsigned ac@ = argument count
1195 * @char *av[]@ = pointer to the argument list
1199 * Use: Adds a new peer.
1202 static void acmd_add(admin
*a
, unsigned ac
, char *av
[])
1204 const char *tag
= 0;
1207 /* --- Set stuff up --- */
1209 add
= xmalloc(sizeof(*add
));
1212 add
->peer
.tops
= tun_default
;
1215 /* --- Parse options --- */
1218 OPTARG("-background", arg
, { tag
= arg
; })
1219 OPTARG("-tunnel", arg
, {
1223 a_fail(a
, "unknown-tunnel", "%s", arg
, A_END
);
1226 if (mystrieq(arg
, tunnels
[i
]->name
)) {
1227 add
->peer
.tops
= tunnels
[i
];
1232 OPTTIME("-keepalive", t
, { add
->peer
.t_ka
= t
; })
1233 OPT("-cork", { add
->peer
.kxf
|= KXF_CORK
; })
1236 /* --- Make sure someone's not got there already --- */
1238 if (!av
[0] || !av
[1])
1241 a_fail(a
, "peer-exists", "%s", *av
, A_END
);
1244 add
->peer
.name
= xstrdup(*av
++);
1247 /* --- Crank up the resolver --- */
1249 a_resolve(a
, &add
->r
, tag
, a_doadd
, ac
, av
);
1252 /* --- Clearing up --- */
1255 a_fail(a
, "bad-syntax", "add", "[OPTIONS] PEER ADDR ...", A_END
);
1257 if (add
->peer
.name
) xfree(add
->peer
.name
);
1262 /*----- Ping --------------------------------------------------------------*/
1264 /* --- @a_pingcancel@ --- *
1266 * Arguments: @admin_bgop *bg@ = background operation block
1270 * Use: Cancels a running ping.
1273 static void a_pingcancel(admin_bgop
*bg
)
1275 admin_pingop
*pg
= (admin_pingop
*)bg
;
1276 T( trace(T_ADMIN
, "admin: cancel ping op %s", BGTAG(pg
)); )
1277 p_pingdone(&pg
->ping
, PING_NONOTIFY
);
1280 /* --- @a_pong@ --- *
1282 * Arguments: @int rc@ = return code
1283 * @void *v@ = ping operation block
1287 * Use: Collects what happened to a ping message.
1290 static void a_pong(int rc
, void *v
)
1292 admin_pingop
*pg
= v
;
1298 gettimeofday(&tv
, 0);
1299 tv_sub(&tv
, &tv
, &pg
->pingtime
);
1300 millis
= (double)tv
.tv_sec
* 1000 + (double)tv
.tv_usec
/1000;
1301 a_bginfo(&pg
->bg
, "ping-ok", "%.1f", millis
, A_END
);
1305 a_bginfo(&pg
->bg
, "ping-timeout", A_END
);
1309 a_bginfo(&pg
->bg
, "ping-peer-died", A_END
);
1315 T( trace(T_ADMIN
, "admin: ponged ping op %s", BGTAG(pg
)); )
1316 a_bgrelease(&pg
->bg
);
1319 /* --- @acmd_ping@, @acmd_eping@ --- *
1321 * Arguments: @admin *a@ = connection which requested the ping
1322 * @unsigned ac@ = argument count
1323 * @char *av[]@ = pointer to the argument list
1327 * Use: Pings a peer.
1330 static void a_ping(admin
*a
, unsigned ac
, char *av
[],
1331 const char *cmd
, unsigned msg
)
1335 admin_pingop
*pg
= 0;
1336 const char *tag
= 0;
1339 OPTARG("-background", arg
, { tag
= arg
; })
1340 OPTTIME("-timeout", arg
, { t
= arg
; })
1342 if (!*av
|| av
[1]) goto bad_syntax
;
1343 if ((p
= a_findpeer(a
, *av
)) == 0)
1345 pg
= xmalloc(sizeof(*pg
));
1346 gettimeofday(&pg
->pingtime
, 0);
1347 if (a_bgadd(a
, &pg
->bg
, tag
, a_pingcancel
))
1349 T( trace(T_ADMIN
, "admin: ping op %s: %s to %s",
1350 BGTAG(pg
), cmd
, p_name(p
)); )
1351 if (p_pingsend(p
, &pg
->ping
, msg
, t
, a_pong
, pg
)) {
1352 a_bgfail(&pg
->bg
, "ping-send-failed", A_END
);
1353 a_bgrelease(&pg
->bg
);
1358 a_fail(a
, "bad-syntax", "%s", cmd
, "[OPTIONS] PEER", cmd
, A_END
);
1364 static void acmd_ping(admin
*a
, unsigned ac
, char *av
[])
1365 { a_ping(a
, ac
, av
, "ping", MISC_PING
); }
1366 static void acmd_eping(admin
*a
, unsigned ac
, char *av
[])
1367 { a_ping(a
, ac
, av
, "eping", MISC_EPING
); }
1369 /*----- Service commands --------------------------------------------------*/
1371 static void acmd_svcclaim(admin
*a
, unsigned ac
, char *av
[])
1376 svc
= sym_find(&a_svcs
, av
[0], -1, sizeof(*svc
), &f
);
1378 if (versioncmp(av
[1], svc
->version
) <= 0) {
1381 "%s", SYM_NAME(svc
),
1386 a_write(svc
->prov
, "SVCCLAIM", 0, "%s", av
[0], "%s", av
[1], A_END
);
1390 svc
->version
= xstrdup(av
[1]);
1391 svc
->next
= a
->svcs
;
1393 if (a
->svcs
) a
->svcs
->prev
= svc
;
1395 a_notify("SVCCLAIM", "%s", SYM_NAME(svc
), "%s", svc
->version
, A_END
);
1399 static void acmd_svcrelease(admin
*a
, unsigned ac
, char *av
[])
1403 if ((svc
= a_svcfind(a
, av
[0])) == 0)
1405 if (svc
->prov
!= a
) {
1406 a_fail(a
, "not-service-provider", "%s", SYM_NAME(svc
), A_END
);
1413 static void acmd_svcensure(admin
*a
, unsigned ac
, char *av
[])
1417 if ((svc
= a_svcfind(a
, av
[0])) == 0)
1419 if (av
[1] && versioncmp(svc
->version
, av
[1]) < 0) {
1420 a_fail(a
, "service-too-old",
1421 "%s", SYM_NAME(svc
),
1429 static void acmd_svcquery(admin
*a
, unsigned ac
, char *av
[])
1433 if ((svc
= a_svcfind(a
, av
[0])) != 0) {
1434 a_info(a
, "name=%s", SYM_NAME(svc
), "version=%s", svc
->version
, A_END
);
1439 static void acmd_svclist(admin
*a
, unsigned ac
, char *av
[])
1444 for (sym_mkiter(&i
, &a_svcs
); (svc
= sym_next(&i
)) != 0; )
1445 a_info(a
, "%s", SYM_NAME(svc
), "%s", svc
->version
, A_END
);
1449 static void a_canceljob(admin_bgop
*bg
)
1451 admin_svcop
*svc
= (admin_svcop
*)bg
;
1453 a_write(svc
->prov
, "SVCCANCEL", 0, "%s", a_jobidencode(svc
), A_END
);
1457 static void acmd_svcsubmit(admin
*a
, unsigned ac
, char *av
[])
1459 const char *tag
= 0;
1462 const char *ver
= 0;
1466 OPTARG("-background", arg
, { tag
= arg
; })
1467 OPTARG("-version", arg
, { ver
= arg
; })
1469 if (!*av
) goto bad_syntax
;
1470 if ((svc
= a_svcfind(a
, *av
)) == 0) goto fail
;
1471 if (ver
&& versioncmp(svc
->version
, ver
) < 0) {
1472 a_fail(a
, "service-too-old",
1473 "%s", SYM_NAME(svc
),
1478 if ((svcop
= a_jobcreate(svc
->prov
)) == 0) {
1479 a_fail(a
, "provider-overloaded", A_END
);
1482 if (a_bgadd(a
, &svcop
->bg
, tag
, a_canceljob
)) {
1483 a_jobdestroy(svcop
);
1486 a_write(svc
->prov
, "SVCJOB", 0,
1487 "%s", a_jobidencode(svcop
),
1493 a_fail(a
, "bad-syntax", "svcsubmit", "[OPTIONS] SERVICE ARGS...", A_END
);
1500 static void a_replycmd(admin
*a
, const char *status
, int donep
, char *av
[])
1504 if ((svc
= a_jobiddecode(&a
->j
, av
[0])) == 0) {
1505 a_fail(a
, "unknown-jobid", av
[0], A_END
);
1508 a_write(svc
->bg
.a
, status
, svc
->bg
.tag
, "?TOKENS", av
+ 1, A_END
);
1511 a_bgrelease(&svc
->bg
);
1516 static void acmd_svcok(admin
*a
, unsigned ac
, char *av
[])
1517 { a_replycmd(a
, "OK", 1, av
); }
1518 static void acmd_svcinfo(admin
*a
, unsigned ac
, char *av
[])
1519 { a_replycmd(a
, "INFO", 0, av
); }
1520 static void acmd_svcfail(admin
*a
, unsigned ac
, char *av
[])
1521 { a_replycmd(a
, "FAIL", 1, av
); }
1523 /*----- Administration commands -------------------------------------------*/
1525 /* --- Miscellaneous commands --- */
1527 /* --- @traceish@ --- *
1529 * Arguments: @admin *a@ = connection to complain on
1530 * @unsigned ac@ = number of arguments
1531 * @char *av[]@ = vector of arguments
1532 * @const char *what@ = what we're messing with
1533 * @const trace_opt *tt@ = options table
1534 * @unsigned *ff@ = where the flags are
1536 * Returns: Nonzero if anything changed.
1538 * Use: Guts of trace-ish commands like `trace' and `watch'.
1541 static int traceish(admin
*a
, unsigned ac
, char *av
[],
1542 const char *what
, const trace_opt
*tt
, unsigned *ff
)
1546 if (!ac
|| strcmp(av
[0], "?") == 0) {
1548 for (t
= tt
; t
->ch
; t
++) {
1549 a_info(a
, "*%c%c %s",
1550 t
->ch
, (*ff
& t
->f
) == t
->f ?
'+' : ' ', t
->help
, A_END
);
1560 case '+': sense
= 1; break;
1561 case '-': sense
= 0; break;
1563 for (t
= tt
; t
->ch
; t
++) {
1565 if (sense
) f
|= t
->f
;
1570 a_fail(a
, "bad-%s-option", what
, "%c", *p
, A_END
);
1586 static void acmd_trace(admin
*a
, unsigned ac
, char *av
[])
1588 if (traceish(a
, ac
, av
, "trace", tr_opts
, &tr_flags
))
1589 trace_level(tr_flags
);
1594 static void acmd_watch(admin
*a
, unsigned ac
, char *av
[])
1595 { traceish(a
, ac
, av
, "watch", w_opts
, &a
->f
); }
1597 static void alertcmd(admin
*a
, unsigned f_and
, unsigned f_eq
,
1598 const char *status
, char *av
[])
1599 { a_alert(f_and
, f_eq
, status
, "USER", "?TOKENS", av
, A_END
); a_ok(a
); }
1600 static void acmd_notify(admin
*a
, unsigned ac
, char *av
[])
1601 { alertcmd(a
, AF_NOTE
, AF_NOTE
, "NOTE", av
); }
1602 static void acmd_warn(admin
*a
, unsigned ac
, char *av
[])
1603 { alertcmd(a
, AF_WARN
, AF_WARN
, "WARN", av
); }
1605 static void acmd_port(admin
*a
, unsigned ac
, char *av
[])
1606 { a_info(a
, "%u", p_port(), A_END
); a_ok(a
); }
1608 static void acmd_daemon(admin
*a
, unsigned ac
, char *av
[])
1610 if (flags
& F_DAEMON
)
1611 a_fail(a
, "already-daemon", A_END
);
1613 a_notify("DAEMON", A_END
);
1617 a_fail(a
, "daemon-error", "?ERRNO", A_END
);
1625 static void acmd_jobs(admin
*a
, unsigned ac
, char *av
[])
1629 for (bg
= a
->bg
; bg
; bg
= bg
->next
) {
1631 a_info(a
, "%s", bg
->tag
, A_END
);
1636 static void acmd_bgcancel(admin
*a
, unsigned ac
, char *av
[])
1640 if ((bg
= a_bgfind(a
, av
[0])) == 0)
1641 a_fail(a
, "unknown-tag", "%s", av
[0], A_END
);
1649 static void acmd_list(admin
*a
, unsigned ac
, char *av
[])
1651 FOREACH_PEER(p
, { a_info(a
, "%s", p_name(p
), A_END
); });
1655 static void acmd_ifname(admin
*a
, unsigned ac
, char *av
[])
1659 if ((p
= a_findpeer(a
, av
[0])) != 0) {
1660 a_info(a
, "%s", p_ifname(p
), A_END
);
1665 static void acmd_setifname(admin
*a
, unsigned ac
, char *av
[])
1669 if ((p
= a_findpeer(a
, av
[0])) != 0) {
1670 a_notify("NEWIFNAME", "?PEER", p
, "%s", p_ifname(p
), "%s", av
[1], A_END
);
1671 p_setifname(p
, av
[1]);
1676 static void acmd_getchal(admin
*a
, unsigned ac
, char *av
[])
1680 buf_init(&b
, buf_i
, PKBUFSZ
);
1682 a_info(a
, "?B64", BBASE(&b
), (size_t)BLEN(&b
), A_END
);
1686 static void acmd_checkchal(admin
*a
, unsigned ac
, char *av
[])
1693 base64_decode(&b64
, av
[0], strlen(av
[0]), &d
);
1694 base64_decode(&b64
, 0, 0, &d
);
1695 buf_init(&b
, d
.buf
, d
.len
);
1696 if (c_check(&b
) || BBAD(&b
) || BLEFT(&b
))
1697 a_fail(a
, "invalid-challenge", A_END
);
1703 static void acmd_greet(admin
*a
, unsigned ac
, char *av
[])
1709 if ((p
= a_findpeer(a
, av
[0])) != 0) {
1711 base64_decode(&b64
, av
[1], strlen(av
[1]), &d
);
1712 base64_decode(&b64
, 0, 0, &d
);
1713 p_greet(p
, d
.buf
, d
.len
);
1719 static void acmd_addr(admin
*a
, unsigned ac
, char *av
[])
1724 if ((p
= a_findpeer(a
, av
[0])) != 0) {
1726 assert(ad
->sa
.sa_family
== AF_INET
);
1727 a_info(a
, "?ADDR", ad
, A_END
);
1732 static void acmd_peerinfo(admin
*a
, unsigned ac
, char *av
[])
1737 if ((p
= a_findpeer(a
, av
[0])) != 0) {
1739 a_info(a
, "tunnel=%s", ps
->tops
->name
, A_END
);
1740 a_info(a
, "keepalive=%lu", ps
->t_ka
, A_END
);
1745 static void acmd_servinfo(admin
*a
, unsigned ac
, char *av
[])
1747 a_info(a
, "implementation=edgeware-tripe", A_END
);
1748 a_info(a
, "version=%s", VERSION
, A_END
);
1749 a_info(a
, "daemon=%s", BOOL(flags
& F_DAEMON
), A_END
);
1753 static void acmd_stats(admin
*a
, unsigned ac
, char *av
[])
1758 if ((p
= a_findpeer(a
, av
[0])) == 0)
1762 a_info(a
, "start-time=%s", timestr(st
->t_start
), A_END
);
1763 a_info(a
, "last-packet-time=%s", timestr(st
->t_last
), A_END
);
1764 a_info(a
, "last-keyexch-time=%s", timestr(st
->t_kx
), A_END
);
1765 a_info(a
, "packets-in=%lu", st
->n_in
, "bytes-in=%lu", st
->sz_in
, A_END
);
1767 "packets-out=%lu", st
->n_out
,
1768 "bytes-out=%lu", st
->sz_out
,
1771 "keyexch-packets-in=%lu", st
->n_kxin
,
1772 "keyexch-bytes-in=%lu", st
->sz_kxin
,
1775 "keyexch-packets-out=%lu", st
->n_kxout
,
1776 "keyexch-bytes-out=%lu", st
->sz_kxout
,
1779 "ip-packets-in=%lu", st
->n_ipin
,
1780 "ip-bytes-in=%lu", st
->sz_ipin
,
1783 "ip-packets-out=%lu", st
->n_ipout
,
1784 "ip-bytes-out=%lu", st
->sz_ipout
,
1786 a_info(a
, "rejected-packets=%lu", st
->n_reject
, A_END
);
1790 static void acmd_kill(admin
*a
, unsigned ac
, char *av
[])
1794 if ((p
= a_findpeer(a
, av
[0])) != 0) {
1800 static void acmd_forcekx(admin
*a
, unsigned ac
, char *av
[])
1804 if ((p
= a_findpeer(a
, av
[0])) != 0) {
1805 kx_start(&p
->kx
, 1);
1810 static void acmd_reload(admin
*a
, unsigned ac
, char *av
[])
1811 { p_keyreload(); a_ok(a
); }
1813 static void acmd_quit(admin
*a
, unsigned ac
, char *av
[])
1815 a_warn("SERVER", "quit", "admin-request", A_END
);
1820 static void acmd_version(admin
*a
, unsigned ac
, char *av
[])
1822 a_info(a
, "%s", PACKAGE
, "%s", VERSION
, A_END
);
1826 static void acmd_tunnels(admin
*a
, unsigned ac
, char *av
[])
1830 for (i
= 0; tunnels
[i
]; i
++)
1831 a_info(a
, "%s", tunnels
[i
]->name
, A_END
);
1835 /* --- The command table and help --- */
1837 typedef struct acmd
{
1840 unsigned argmin
, argmax
;
1841 void (*func
)(admin */
*a*/
, unsigned /*ac*/, char */
*av*/
[]);
1844 static void acmd_help(admin */
*a*/
, unsigned /*ac*/, char */
*av*/
[]);
1846 static const acmd acmdtab
[] = {
1847 { "add", "[OPTIONS] PEER ADDR ...", 2, 0xffff, acmd_add
},
1848 { "addr", "PEER", 1, 1, acmd_addr
},
1849 { "bgcancel", "TAG", 1, 1, acmd_bgcancel
},
1850 { "checkchal", "CHAL", 1, 1, acmd_checkchal
},
1851 { "daemon", 0, 0, 0, acmd_daemon
},
1852 { "eping", "[OPTIONS] PEER", 1, 0xffff, acmd_eping
},
1853 { "forcekx", "PEER", 1, 1, acmd_forcekx
},
1854 { "getchal", 0, 0, 0, acmd_getchal
},
1855 { "greet", "PEER CHAL", 2, 2, acmd_greet
},
1856 { "help", 0, 0, 0, acmd_help
},
1857 { "ifname", "PEER", 1, 1, acmd_ifname
},
1858 { "jobs", 0, 0, 0, acmd_jobs
},
1859 { "kill", "PEER", 1, 1, acmd_kill
},
1860 { "list", 0, 0, 0, acmd_list
},
1861 { "notify", "MESSAGE ...", 1, 0xffff, acmd_notify
},
1862 { "peerinfo", "PEER", 1, 1, acmd_peerinfo
},
1863 { "ping", "[OPTIONS] PEER", 1, 0xffff, acmd_ping
},
1864 { "port", 0, 0, 0, acmd_port
},
1865 { "quit", 0, 0, 0, acmd_quit
},
1866 { "reload", 0, 0, 0, acmd_reload
},
1867 { "servinfo", 0, 0, 0, acmd_servinfo
},
1868 { "setifname", "PEER NEW-NAME", 2, 2, acmd_setifname
},
1869 { "svcclaim", "SERVICE VERSION", 2, 2, acmd_svcclaim
},
1870 { "svcensure", "SERVICE [VERSION]", 1, 2, acmd_svcensure
},
1871 { "svcfail", "JOBID TOKENS...", 1, 0xffff, acmd_svcfail
},
1872 { "svcinfo", "JOBID TOKENS...", 1, 0xffff, acmd_svcinfo
},
1873 { "svclist", 0, 0, 0, acmd_svclist
},
1874 { "svcok", "JOBID", 1, 1, acmd_svcok
},
1875 { "svcquery", "SERVICE", 1, 1, acmd_svcquery
},
1876 { "svcrelease", "SERVICE", 1, 1, acmd_svcrelease
},
1877 { "svcsubmit", "[OPTIONS] SERVICE TOKENS...",
1878 2, 0xffff, acmd_svcsubmit
},
1879 { "stats", "PEER", 1, 1, acmd_stats
},
1881 { "trace", "[OPTIONS]", 0, 1, acmd_trace
},
1883 { "tunnels", 0, 0, 0, acmd_tunnels
},
1884 { "version", 0, 0, 0, acmd_version
},
1885 { "warn", "MESSAGE ...", 1, 0xffff, acmd_warn
},
1886 { "watch", "[OPTIONS]", 0, 1, acmd_watch
},
1890 static void acmd_help(admin
*a
, unsigned ac
, char *av
[])
1894 for (c
= acmdtab
; c
->name
; c
++) {
1896 a_info(a
, "%s", c
->name
, "*%s", c
->help
, A_END
);
1898 a_info(a
, "%s", c
->name
, A_END
);
1903 /*----- Connection handling -----------------------------------------------*/
1905 /* --- @a_destroypending@ --- *
1911 * Use: Destroys pending admin connections at a safe time.
1914 static void a_destroypending(void)
1916 admin
*a
, *aa
, *head
;
1917 admin_bgop
*bg
, *bbg
;
1918 admin_service
*svc
, *ssvc
;
1920 /* --- Destroy connections marked as pending --- *
1922 * Slightly messy. Killing clients may cause others to finally die. Make
1923 * sure that they can be put on the list without clobbering anything or
1930 for (a
= head
; a
; a
= aa
) {
1932 assert(a
->f
& AF_DEAD
);
1934 /* --- Report what we're doing --- */
1936 T( trace(T_ADMIN
, "admin: completing destruction of connection %u",
1939 /* --- If this is the foreground client then shut down --- */
1941 if (a
->f
& AF_FOREGROUND
) {
1942 T( trace(T_ADMIN
, "admin: foreground client quit: shutting down"); )
1943 a_warn("SERVER", "quit", "foreground-eof", A_END
);
1947 /* --- Abort any background jobs in progress --- */
1949 for (bg
= a
->bg
; bg
; bg
= bbg
) {
1952 if (bg
->tag
) xfree(bg
->tag
);
1956 /* --- Release services I hold, and abort pending jobs --- */
1958 for (svc
= a
->svcs
; svc
; svc
= ssvc
) {
1962 a_jobtablefinal(&a
->j
);
1964 /* --- Close file descriptors and selectory --- */
1966 selbuf_destroy(&a
->b
);
1967 if (a
->b
.reader
.fd
!= a
->w
.fd
) close(a
->b
.reader
.fd
);
1969 if (a_stdin
== a
) a_stdin
= 0;
1978 /* --- @a_destroy@ --- *
1980 * Arguments: @admin *a@ = pointer to an admin block
1984 * Use: Destroys an admin block. This requires a certain amount of
1988 static void freequeue(oqueue
*q
)
1992 for (o
= q
->hd
; o
; o
= oo
) {
1999 static void a_destroy(admin
*a
)
2004 if (a
->next
) a
->next
->prev
= a
->prev
;
2005 if (a
->prev
) a
->prev
->next
= a
->next
;
2006 else admins
= a
->next
;
2008 if (a
->out
.hd
) sel_rmfile(&a
->w
);
2015 T( trace(T_ADMIN
, "admin: killing connection %u", a
->seq
); )
2018 /* --- @a_line@ --- *
2020 * Arguments: @char *p@ = pointer to the line read
2021 * @size_t len@ = length of the line
2022 * @void *vp@ = pointer to my admin block
2026 * Use: Handles a line of input.
2029 static void a_line(char *p
, size_t len
, void *vp
)
2044 selbuf_disable(&a
->b
);
2048 ac
= str_qsplit(p
, av
, N(av
) - 1, 0, STRF_QUOTE
);
2052 for (c
= acmdtab
; c
->name
; c
++) {
2053 if (mystrieq(av
[0], c
->name
)) {
2055 if (c
->argmin
> ac
|| ac
> c
->argmax
) {
2057 a_fail(a
, "bad-syntax", "%s", c
->name
, "", A_END
);
2059 a_fail(a
, "bad-syntax", "%s", c
->name
, "%s", c
->help
, A_END
);
2061 c
->func(a
, ac
, av
+ 1);
2065 a_fail(a
, "unknown-command", "%s", av
[0], A_END
);
2068 /* --- @a_create@ --- *
2070 * Arguments: @int fd_in, fd_out@ = file descriptors to use
2071 * @unsigned f@ = initial flags to set
2075 * Use: Creates a new admin connection.
2078 void a_create(int fd_in
, int fd_out
, unsigned f
)
2080 admin
*a
= CREATE(admin
);
2082 T( static unsigned seq
= 0;
2084 T( trace(T_ADMIN
, "admin: accepted connection %u", a
->seq
); )
2088 a_jobtableinit(&a
->j
);
2090 if (fd_in
== STDIN_FILENO
) a_stdin
= a
;
2091 fdflags(fd_in
, O_NONBLOCK
, O_NONBLOCK
, FD_CLOEXEC
, FD_CLOEXEC
);
2092 if (fd_out
!= fd_in
)
2093 fdflags(fd_out
, O_NONBLOCK
, O_NONBLOCK
, FD_CLOEXEC
, FD_CLOEXEC
);
2094 selbuf_init(&a
->b
, &sel
, fd_in
, a_line
, a
);
2095 sel_initfile(&sel
, &a
->w
, fd_out
, SEL_WRITE
, a_flush
, a
);
2096 a
->out
.hd
= a
->out
.tl
= 0;
2099 if (admins
) admins
->prev
= a
;
2103 /* --- @a_accept@ --- *
2105 * Arguments: @int fd@ = file descriptor to accept
2106 * @unsigned mode@ = what to do
2107 * @void *v@ = uninteresting pointer
2111 * Use: Accepts a new admin connection.
2114 static void a_accept(int fd
, unsigned mode
, void *v
)
2117 struct sockaddr_un sun
;
2118 size_t sz
= sizeof(sun
);
2120 if ((nfd
= accept(fd
, (struct sockaddr
*)&sun
, &sz
)) < 0) {
2121 if (errno
!= EINTR
&& errno
!= EAGAIN
&& errno
!= EWOULDBLOCK
&&
2122 errno
!= ECONNABORTED
&& errno
!= EPROTO
)
2123 a_warn("ADMIN", "accept-error", "?ERRNO", A_END
);
2126 a_create(nfd
, nfd
, 0);
2129 /* --- @a_preselect@ --- *
2135 * Use: Informs the admin module that we're about to select again,
2136 * and that it should do cleanup things it has delayed until a
2140 void a_preselect(void) { if (a_dead
) a_destroypending(); }
2142 /* --- @a_daemon@ --- *
2148 * Use: Informs the admin module that it's a daemon.
2151 void a_daemon(void) { flags
|= F_DAEMON
; }
2153 /* --- @a_init@ --- *
2155 * Arguments: @const char *name@ = socket name to create
2159 * Use: Creates the admin listening socket.
2162 void a_init(const char *name
)
2166 struct sockaddr_un sun
;
2167 struct sigaction sa
;
2170 /* --- Create services table --- */
2172 sym_create(&a_svcs
);
2174 /* --- Set up the socket address --- */
2176 sz
= strlen(name
) + 1;
2177 if (sz
> sizeof(sun
.sun_path
))
2178 die(EXIT_FAILURE
, "socket name `%s' too long", name
);
2180 sun
.sun_family
= AF_UNIX
;
2181 memcpy(sun
.sun_path
, name
, sz
);
2182 sz
+= offsetof(struct sockaddr_un
, sun_path
);
2184 /* --- Attempt to bind to the socket --- */
2188 if ((fd
= socket(PF_UNIX
, SOCK_STREAM
, 0)) < 0)
2189 die(EXIT_FAILURE
, "couldn't create socket: %s", strerror(errno
));
2190 if (bind(fd
, (struct sockaddr
*)&sun
, sz
) < 0) {
2193 if (errno
!= EADDRINUSE
) {
2194 die(EXIT_FAILURE
, "couldn't bind to address `%s': %s",
2195 sun
.sun_path
, strerror(e
));
2198 die(EXIT_FAILURE
, "too many retries; giving up");
2200 if (!connect(fd
, (struct sockaddr
*)&sun
, sz
)) {
2201 die(EXIT_FAILURE
, "server already listening on admin socket `%s'",
2204 if (errno
!= ECONNREFUSED
)
2205 die(EXIT_FAILURE
, "couldn't bind to address: %s", strerror(e
));
2206 if (stat(sun
.sun_path
, &st
)) {
2207 die(EXIT_FAILURE
, "couldn't stat `%s': %s",
2208 sun
.sun_path
, strerror(errno
));
2210 if (!S_ISSOCK(st
.st_mode
))
2211 die(EXIT_FAILURE
, "object `%s' isn't a socket", sun
.sun_path
);
2212 T( trace(T_ADMIN
, "admin: stale socket found; removing it"); )
2213 unlink(sun
.sun_path
);
2217 chmod(sun
.sun_path
, 0600);
2218 fdflags(fd
, O_NONBLOCK
, O_NONBLOCK
, FD_CLOEXEC
, FD_CLOEXEC
);
2220 die(EXIT_FAILURE
, "couldn't listen on socket: %s", strerror(errno
));
2222 /* --- Listen to the socket --- */
2224 sel_initfile(&sel
, &sock
, fd
, SEL_READ
, a_accept
, 0);
2228 T( trace_custom(a_trace
, 0);
2229 trace(T_ADMIN
, "admin: enabled custom tracing"); )
2232 /* --- Set up signal handlers --- */
2234 sig_add(&s_term
, SIGTERM
, a_sigdie
, 0);
2235 sig_add(&s_hup
, SIGHUP
, a_sighup
, 0);
2236 signal(SIGPIPE
, SIG_IGN
);
2237 sigaction(SIGINT
, 0, &sa
);
2238 if (sa
.sa_handler
!= SIG_IGN
)
2239 sig_add(&s_int
, SIGINT
, a_sigdie
, 0);
2242 /*----- That's all, folks -------------------------------------------------*/