3 * $Id: pixie.c,v 1.11 2002/01/13 13:43:05 mdw Exp $
5 * Passphrase pixie for Catacomb
7 * (c) 1999 Straylight/Edgeware
10 /*----- Licensing notice --------------------------------------------------*
12 * This file is part of Catacomb.
14 * Catacomb is free software; you can redistribute it and/or modify
15 * it under the terms of the GNU Library General Public License as
16 * published by the Free Software Foundation; either version 2 of the
17 * License, or (at your option) any later version.
19 * Catacomb is distributed in the hope that it will be useful,
20 * but WITHOUT ANY WARRANTY; without even the implied warranty of
21 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 * GNU Library General Public License for more details.
24 * You should have received a copy of the GNU Library General Public
25 * License along with Catacomb; if not, write to the Free
26 * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
30 /*----- Revision history --------------------------------------------------*
33 * Revision 1.11 2002/01/13 13:43:05 mdw
34 * Fix bug in daemon mode.
36 * Revision 1.10 2001/02/21 20:03:54 mdw
37 * Handle select errors (by bombing out). Cosmetic tweak.
39 * Revision 1.9 2001/02/03 16:06:44 mdw
40 * Don't set a handler for @SIGINT@ if it's ignored at startup. Add some
41 * error handling for the @select@ loop.
43 * Revision 1.8 2001/01/25 22:19:31 mdw
44 * Make flags be unsigned.
46 * Revision 1.7 2000/12/06 20:33:27 mdw
47 * Make flags be macros rather than enumerations, to ensure that they're
50 * Revision 1.6 2000/10/08 12:06:46 mdw
51 * Change size passed to socket function to be a @size_t@. Insert missing
52 * type name for flag declaration.
54 * Revision 1.5 2000/07/29 22:05:22 mdw
55 * Miscellaneous tidyings:
57 * * Change the timeout to something more appropriate for real use.
59 * * Check assumptions about object types when binding the socket. In
60 * particular, don't zap the socket if it's really something else.
62 * * In @p_request@, return a failure if the shell command returned
63 * nonzero. Fix a bug in @p_get@ which incorrectly passes on a success
64 * code when this happens.
66 * * Dispose of the locked memory in client mode to avoid being
69 * * Also in client mode, don't report closure from the server if we're
70 * running noninteractively.
72 * * Insert a missing option letter into the usage string.
74 * * Change to the root directory after forking in daemon mode.
76 * Revision 1.4 2000/06/17 11:50:53 mdw
77 * New pixie protocol allowing application to request passphrases and send
78 * them to the pixie. Use the secure arena interface for the input
79 * buffer. Extend the input buffer. Other minor fixes.
81 * Revision 1.3 1999/12/22 22:14:40 mdw
82 * Only produce initialization message if verbose.
84 * Revision 1.2 1999/12/22 22:13:42 mdw
85 * Fix bug in passphrase flushing loop.
87 * Revision 1.1 1999/12/22 15:58:41 mdw
88 * Passphrase pixie support.
92 /*----- Header files ------------------------------------------------------*/
107 #include <sys/types.h>
108 #include <sys/time.h>
110 #include <sys/stat.h>
111 #include <sys/wait.h>
114 #include <sys/ioctl.h>
118 #include <sys/socket.h>
121 #include <mLib/alloc.h>
122 #include <mLib/dstr.h>
123 #include <mLib/fdflags.h>
124 #include <mLib/mdwopt.h>
125 #include <mLib/quis.h>
126 #include <mLib/report.h>
127 #include <mLib/sel.h>
128 #include <mLib/selbuf.h>
129 #include <mLib/sig.h>
130 #include <mLib/str.h>
131 #include <mLib/sub.h>
136 #include "passphrase.h"
139 /*----- Static variables --------------------------------------------------*/
141 static unsigned long timeout
= 900;
142 static sel_state sel
;
143 static unsigned verbose
= 1;
144 static const char *command
= 0;
146 static unsigned flags
= 0;
151 /*----- Event logging -----------------------------------------------------*/
155 * Arguments: @const char *p@ = @printf@-style format string
156 * @...@ = extra arguments to fill in
160 * Use: Writes out a timestamped log message.
163 static void log(const char *p
, ...)
168 if (!(flags
& F_SYSLOG
)) {
170 struct tm
*tm
= localtime(&t
);
172 d
.len
+= strftime(d
.buf
, d
.sz
, "%Y-%m-%d %H:%M:%S ", tm
);
175 dstr_vputf(&d
, p
, ap
);
178 if (flags
& F_SYSLOG
)
179 syslog(LOG_NOTICE
, "%s", d
.buf
);
182 dstr_write(&d
, stderr
);
187 /*----- Passphrase management ---------------------------------------------*/
189 /* --- Data structures --- */
191 typedef struct phrase
{
201 /* --- Variables --- */
203 #define P_ROOT ((phrase *)&p_root)
204 static struct { phrase
*next
; phrase
*prev
; } p_root
= { P_ROOT
, P_ROOT
};
206 /* --- @p_free@ --- *
208 * Arguments: @phrase *p@ = pointer to phrase block
212 * Use: Frees a phrase block.
215 static void p_free(phrase
*p
)
218 sel_rmtimer(&p
->timer
);
221 p
->next
->prev
= p
->prev
;
222 p
->prev
->next
= p
->next
;
226 /* --- @p_timer@ --- *
228 * Arguments: @struct timeval *tv@ = current time
229 * @void *p@ = pointer to phrase
233 * Use: Expires a passphrase.
236 static void p_timer(struct timeval
*tv
, void *p
)
240 log("expiring passphrase `%s'", pp
->tag
);
244 /* --- @p_alloc@ --- *
246 * Arguments: @size_t sz@ = amount of memory required
248 * Returns: Pointer to allocated memory, or null.
250 * Use: Allocates some locked memory, flushing old passphrases if
251 * there's not enough space.
254 static void *p_alloc(size_t sz
)
258 if ((p
= l_alloc(&lm
, sz
)) != 0)
260 if (P_ROOT
->next
== P_ROOT
)
263 log("flushing passphrase `%s' to free up needed space",
266 p_free(P_ROOT
->next
);
270 /* --- @p_find@ --- *
272 * Arguments: @const char *tag@ = pointer to tag to find
274 * Returns: Pointer to passphrase block, or null.
276 * Use: Finds a passphrase with a given tag.
279 static phrase
*p_find(const char *tag
)
283 for (p
= P_ROOT
->next
; p
!= P_ROOT
; p
= p
->next
) {
284 if (strcmp(p
->tag
, tag
) == 0) {
287 sel_rmtimer(&p
->timer
);
288 gettimeofday(&tv
, 0);
290 sel_addtimer(&sel
, &p
->timer
, &tv
, p_timer
, p
);
292 p
->next
->prev
= p
->prev
;
293 p
->prev
->next
= p
->next
;
295 p
->prev
= P_ROOT
->prev
;
296 P_ROOT
->prev
->next
= p
;
306 * Arguments: @const char *tag@ = pointer to tag string
307 * @const char *p@ = pointer to passphrase
308 * @unsigned long t@ = expiry timeout
310 * Returns: Pointer to newly-added passphrase.
312 * Use: Adds a new passphrase. The tag must not already exist.
315 static phrase
*p_add(const char *tag
, const char *p
, unsigned long t
)
317 size_t sz
= strlen(p
) + 1;
318 char *l
= p_alloc(sz
);
321 /* --- Make sure the locked memory was allocated --- */
326 /* --- Fill in some other bits of the block --- */
331 pp
->tag
= xstrdup(tag
);
334 /* --- Set the timer --- */
339 gettimeofday(&tv
, 0);
341 sel_addtimer(&sel
, &pp
->timer
, &tv
, p_timer
, pp
);
344 /* --- Link the block into the chain --- */
347 pp
->prev
= P_ROOT
->prev
;
348 P_ROOT
->prev
->next
= pp
;
353 /* --- @p_flush@ --- *
355 * Arguments: @const char *tag@ = pointer to tag string, or zero for all
359 * Use: Immediately flushes either a single phrase or all of them.
362 static void p_flush(const char *tag
)
366 if (!tag
&& verbose
> 1)
367 log("flushing all passphrases");
369 while (p
!= P_ROOT
) {
370 phrase
*pp
= p
->next
;
373 else if (strcmp(p
->tag
, tag
) == 0) {
375 log("flushing passphrase `%s'", tag
);
383 /*----- Reading passphrases -----------------------------------------------*/
385 /* --- @p_request@ --- *
387 * Arguments: @const char *msg@ = message string
388 * @const char *tag@ = pointer to tag string
389 * @char *buf@ = pointer to (locked) buffer
390 * @size_t sz@ = size of buffer
392 * Returns: Zero if all went well, nonzero otherwise.
394 * Use: Requests a passphrase from the user.
397 static int p_request(const char *msg
, const char *tag
, char *buf
, size_t sz
)
399 /* --- If there's a passphrase-fetching command, run it --- */
409 /* --- Substitute the prompt string into the command --- */
413 const char *q
= strchr(p
, '%');
436 /* --- Create a pipe and start a child process --- */
440 if ((kid
= fork()) < 0)
443 /* --- Child process --- */
447 if (dup2(fd
[1], STDOUT_FILENO
) < 0)
450 execl("/bin/sh", "sh", "-c", d
.buf
, (void *)0);
454 /* --- Read the data back into my buffer --- */
457 if ((r
= read(fd
[0], buf
, sz
- 1)) >= 0) {
458 char *q
= memchr(buf
, '\n', r
);
464 waitpid(kid
, &rc
, 0);
466 if (r
< 0 || rc
!= 0)
470 /* --- Tidy up when things go wrong --- */
481 /* --- Read a passphrase from the terminal --- *
483 * Use the standard Catacomb passphrase-reading function, so it'll read the
484 * passphrase from a file descriptor or something if the appropriate
485 * environment variable is set.
491 dstr_putf(&d
, "%s %s: ", msg
, tag
);
492 rc
= pixie_getpass(d
.buf
, buf
, sz
);
499 /* --- Sort out the buffer --- *
501 * Strip leading spaces.
507 while (isspace((unsigned char)*p
))
510 memmove(buf
, p
, len
);
521 * Arguments: @const char **q@ = where to store the result
522 * @const char *tag@ = pointer to tag string
523 * @unsigned mode@ = reading mode (verify?)
524 * @time_t exp@ = expiry time suggestion
526 * Returns: Zero if successful, @-1@ on a read failure, or @+1@ if the
527 * passphrase is missing and there is no fetcher. (This will
528 * always happen if there is no fetcher and @mode@ is
531 * Use: Reads a passphrase from somewhere.
534 static int p_get(const char **q
, const char *tag
, unsigned mode
, time_t exp
)
541 /* --- Write a log message --- */
544 log("passphrase `%s' requested", tag
);
546 /* --- If there is no fetcher, life is simpler --- */
548 if (!(flags
& F_FETCH
)) {
549 if (mode
== PMODE_VERIFY
)
551 if ((p
= p_find(tag
)) == 0)
557 /* --- Try to find the phrase --- */
559 if (mode
== PMODE_VERIFY
)
561 if (mode
== PMODE_VERIFY
|| (p
= p_find(tag
)) == 0) {
562 if ((pp
= p_alloc(LBUFSZ
)) == 0)
564 if (p_request(mode
== PMODE_READ ?
"Passphrase" : "New passphrase",
565 tag
, pp
, LBUFSZ
) < 0)
567 p
= p_add(tag
, pp
, exp
);
572 /* --- If verification is requested, verify the passphrase --- */
574 if (mode
== PMODE_VERIFY
) {
575 if (!pp
&& (pp
= p_alloc(LBUFSZ
)) == 0)
577 if (p_request("Verify passphrase", tag
, pp
, LBUFSZ
) < 0)
579 if (strcmp(pp
, p
->p
) != 0) {
581 log("passphrases for `%s' don't match", tag
);
587 /* --- Tidy up and return the passphrase --- */
590 memset(pp
, 0, LBUFSZ
);
596 /* --- Tidy up if things went wrong --- */
600 memset(pp
, 0, LBUFSZ
);
608 /*----- Server command parsing --------------------------------------------*/
610 /* --- Data structures --- */
612 typedef struct pixserv
{
621 #define PIXSERV_TIMEOUT 30
623 /* --- @pixserv_expire@ --- *
625 * Arguments: @struct timeval *tv@ = pointer to current time
626 * @void *p@ = pointer to server block
630 * Use: Expires a pixie connection if the remote end decides he's not
631 * interested any more.
634 static void pixserv_expire(struct timeval
*tv
, void *p
)
637 if (px
->fd
!= px
->b
.reader
.fd
)
639 selbuf_destroy(&px
->b
);
640 close(px
->b
.reader
.fd
);
644 /* --- @pixserv_write@ --- *
646 * Arguments: @pixserv *px@ = pointer to server block
647 * @const char *p@ = pointer to skeleton string
648 * @...@ = other arguments to fill in
652 * Use: Formats a string and emits it to the output file.
655 static void pixserv_write(pixserv
*px
, const char *p
, ...)
661 dstr_vputf(&d
, p
, ap
);
662 write(px
->fd
, d
.buf
, d
.len
);
667 /* --- @pixserv_timeout@ --- *
669 * Arguments: @const char *p@ = pointer to timeout string
671 * Returns: Timeout in seconds.
673 * Use: Translates a string to a timeout value in seconds.
676 static unsigned long pixserv_timeout(const char *p
)
684 t
= strtoul(p
, &q
, 0);
689 case 's': if (q
[1] != 0)
696 /* --- @pixserv_line@ --- *
698 * Arguments: @char *s@ = pointer to the line read
699 * @void *p@ = pointer to server block
703 * Use: Handles a line read from the client.
706 static void pixserv_line(char *s
, void *p
)
712 /* --- Handle an end-of-file --- */
714 if (!(px
->f
& px_stdin
))
715 sel_rmtimer(&px
->timer
);
717 if (px
->fd
!= px
->b
.reader
.fd
)
719 selbuf_destroy(&px
->b
);
720 close(px
->b
.reader
.fd
);
724 /* --- Fiddle the timeout --- */
726 if (!(px
->f
& px_stdin
)) {
728 gettimeofday(&tv
, 0);
729 tv
.tv_sec
+= PIXSERV_TIMEOUT
;
730 sel_addtimer(&sel
, &px
->timer
, &tv
, pixserv_expire
, px
);
733 /* --- Scan out the first word --- */
735 if ((q
= str_getword(&s
)) == 0)
737 for (qq
= q
; *qq
; qq
++)
738 *qq
= tolower((unsigned char)*qq
);
740 /* --- Handle a help request --- */
742 if (strcmp(q
, "help") == 0) {
744 INFO Commands supported:\n\
747 INFO PASS tag [expire]\n\
748 INFO VERIFY tag [expire]\n\
750 INFO SET tag [expire] -- phrase\n\
756 /* --- List the passphrases --- */
758 else if (strcmp(q
, "list") == 0) {
761 for (p
= P_ROOT
->next
; p
!= P_ROOT
; p
= p
->next
) {
763 pixserv_write(px
, "ITEM %s no-expire\n", p
->tag
);
766 gettimeofday(&tv
, 0);
767 TV_SUB(&tv
, &p
->timer
.tv
, &tv
);
768 pixserv_write(px
, "ITEM %s %i\n", p
->tag
, tv
.tv_sec
);
771 pixserv_write(px
, "OK\n");
774 /* --- Request a passphrase --- */
776 else if ((mode
= PMODE_READ
, strcmp(q
, "pass") == 0) ||
777 (mode
= PMODE_VERIFY
, strcmp(q
, "verify") == 0)) {
782 if ((q
= str_getword(&s
)) == 0)
783 pixserv_write(px
, "FAIL missing tag\n");
784 else if ((t
= pixserv_timeout(s
)) == 0)
785 pixserv_write(px
, "FAIL bad timeout\n");
787 rc
= p_get(&p
, q
, mode
, t
> timeout ? timeout
: t
);
790 pixserv_write(px
, "OK %s\n", p
);
793 pixserv_write(px
, "FAIL error reading passphrase\n");
796 pixserv_write(px
, "MISSING\n");
802 /* --- Flush existing passphrases --- */
804 else if (strcmp(q
, "flush") == 0) {
807 pixserv_write(px
, "OK\n");
810 /* --- Set a passphrase --- */
812 else if (strcmp(q
, "set") == 0) {
815 if ((tag
= str_getword(&s
)) == 0)
816 pixserv_write(px
, "FAIL missing tag\n");
817 else if ((q
= str_getword(&s
)) == 0)
818 pixserv_write(px
, "FAIL no passphrase\n");
820 if (strcmp(q
, "--") != 0) {
821 t
= pixserv_timeout(q
);
824 t
= pixserv_timeout(0);
826 pixserv_write(px
, "FAIL no passphrase\n");
827 else if (strcmp(q
, "--") != 0)
828 pixserv_write(px
, "FAIL rubbish found before passphrase\n");
832 pixserv_write(px
, "OK\n");
837 /* --- Shut the server down --- */
839 else if (strcmp(q
, "quit") == 0) {
841 log("%s client requested shutdown",
842 px
->f
& px_stdin ?
"local" : "remote");
843 pixserv_write(px
, "OK\n");
847 /* --- Report an error for other commands --- */
850 pixserv_write(px
, "FAIL unknown command `%s'\n", q
);
853 /* --- @pixserv_create@ --- *
855 * Arguments: @int fd@ = file descriptor to read from
856 * @int ofd@ = file descriptor to write to
858 * Returns: Pointer to the new connection.
860 * Use: Creates a new Pixie server instance for a new connection.
863 static pixserv
*pixserv_create(int fd
, int ofd
)
865 pixserv
*px
= CREATE(pixserv
);
867 fdflags(fd
, O_NONBLOCK
, O_NONBLOCK
, FD_CLOEXEC
, FD_CLOEXEC
);
869 fdflags(ofd
, O_NONBLOCK
, O_NONBLOCK
, FD_CLOEXEC
, FD_CLOEXEC
);
871 selbuf_init(&px
->b
, &sel
, fd
, pixserv_line
, px
);
872 px
->b
.b
.a
= arena_secure
;
873 selbuf_setsize(&px
->b
, 1024);
874 gettimeofday(&tv
, 0);
875 tv
.tv_sec
+= PIXSERV_TIMEOUT
;
876 sel_addtimer(&sel
, &px
->timer
, &tv
, pixserv_expire
, px
);
881 /* --- @pixserv_accept@ --- *
883 * Arguments: @int fd@ = file descriptor
884 * @unsigned mode@ = what's happened
885 * @void *p@ = an uninteresting argument
889 * Use: Accepts a new connection.
892 static void pixserv_accept(int fd
, unsigned mode
, void *p
)
895 struct sockaddr_un sun
;
896 size_t sunsz
= sizeof(sun
);
898 if (mode
!= SEL_READ
)
900 if ((nfd
= accept(fd
, (struct sockaddr
*)&sun
, &sunsz
)) < 0) {
902 log("new connection failed: %s", strerror(errno
));
905 pixserv_create(nfd
, nfd
);
908 /*----- Setting up the server ---------------------------------------------*/
910 /* --- @unlinksocket@ --- *
916 * Use: Tidies up the socket when it's finished with.
919 static char *sockpath
;
921 static void unlinksocket(void)
927 /* --- @pix_sigdie@ --- *
929 * Arguments: @int sig@ = signal number
930 * @void *p@ = uninteresting argument
934 * Use: Shuts down the program after a fatal signal.
937 static void pix_sigdie(int sig
, void *p
)
944 case SIGTERM
: p
= "SIGTERM"; break;
945 case SIGINT
: p
= "SIGINT"; break;
947 sprintf(buf
, "signal %i", sig
);
951 log("shutting down on %s", p
);
956 /* --- @pix_sigflush@ --- *
958 * Arguments: @int sig@ = signal number
959 * @void *p@ = uninteresting argument
963 * Use: Flushes the passphrase cache on receipt of a signal.
966 static void pix_sigflush(int sig
, void *p
)
973 case SIGHUP
: p
= "SIGHUP"; break;
974 case SIGQUIT
: p
= "SIGQUIT"; break;
976 sprintf(buf
, "signal %i", sig
);
980 log("received %s; flushing passphrases", p
);
985 /* --- @pix_setup@ --- *
987 * Arguments: @struct sockaddr_un *sun@ = pointer to address to use
988 * @size_t sz@ = size of socket address
992 * Use: Sets up the pixie's Unix-domain socket.
995 static void pix_setup(struct sockaddr_un
*sun
, size_t sz
)
999 /* --- Set up the parent directory --- */
1002 char *p
= sun
->sun_path
;
1003 char *q
= strrchr(p
, '/');
1009 DPUTM(&d
, p
, q
- p
);
1013 if (stat(d
.buf
, &st
))
1014 die(1, "couldn't stat `%s': %s", d
.buf
, strerror(errno
));
1015 if (!S_ISDIR(st
.st_mode
))
1016 die(1, "object `%s' isn't a directory", d
.buf
);
1017 if (st
.st_mode
& 0077)
1018 die(1, "parent directory `%s' has group or world access", d
.buf
);
1023 /* --- Initialize the socket --- */
1031 if ((fd
= socket(PF_UNIX
, SOCK_STREAM
, 0)) < 0)
1032 die(1, "couldn't create socket: %s", strerror(errno
));
1033 if (bind(fd
, (struct sockaddr
*)sun
, sz
) < 0) {
1035 if (errno
!= EADDRINUSE
)
1036 die(1, "couldn't bind to address: %s", strerror(e
));
1038 die(1, "too many retries; giving up");
1040 if (connect(fd
, (struct sockaddr
*)sun
, sz
)) {
1042 if (errno
!= ECONNREFUSED
)
1043 die(1, "couldn't bind to address: %s", strerror(e
));
1044 if (stat(sun
->sun_path
, &st
))
1045 die(1, "couldn't stat `%s': %s", sun
->sun_path
, strerror(errno
));
1046 if (!S_ISSOCK(st
.st_mode
))
1047 die(1, "object `%s' isn't a socket", sun
->sun_path
);
1049 log("stale socket found; removing it");
1050 unlink(sun
->sun_path
);
1054 log("server already running; shutting it down");
1055 write(fd
, "QUIT\n", 5);
1061 chmod(sun
->sun_path
, 0600);
1062 fdflags(fd
, O_NONBLOCK
, O_NONBLOCK
, FD_CLOEXEC
, FD_CLOEXEC
);
1064 die(1, "couldn't listen on socket: %s", strerror(errno
));
1067 /* --- Set up the rest of the server --- */
1070 static sel_file serv
;
1071 sockpath
= sun
->sun_path
;
1072 atexit(unlinksocket
);
1073 sel_initfile(&sel
, &serv
, fd
, SEL_READ
, pixserv_accept
, 0);
1078 /*----- Client support code -----------------------------------------------*/
1080 /* --- Variables --- */
1082 static selbuf c_server
, c_client
;
1083 static unsigned c_flags
= 0;
1085 #define cf_uclose 1u
1086 #define cf_sclose 2u
1088 /* --- Line handler functions --- */
1090 static void c_uline(char *s
, void *p
)
1094 selbuf_destroy(&c_client
);
1095 shutdown(c_server
.reader
.fd
, 1);
1096 c_flags
|= cf_uclose
;
1100 write(c_server
.reader
.fd
, s
, sz
);
1104 static void c_sline(char *s
, void *p
)
1107 selbuf_destroy(&c_server
);
1108 if (!(c_flags
& cf_uclose
)) {
1109 moan("server closed the connection");
1110 selbuf_destroy(&c_client
);
1117 /* --- @pix_client@ --- *
1119 * Arguments: @struct sockaddr_un *sun@ = pointer to socket address
1120 * @size_t sz@ = size of socket address
1121 * @char *argv[]@ = pointer to arguments to send
1125 * Use: Performs client-side actions for the passphrase pixie.
1128 static void pix_client(struct sockaddr_un
*sun
, size_t sz
, char *argv
[])
1132 /* --- Dispose of locked memory --- */
1136 /* --- Open the socket --- */
1138 if ((fd
= socket(PF_UNIX
, SOCK_STREAM
, 0)) < 0)
1139 die(1, "couldn't create socket: %s", strerror(errno
));
1140 if (connect(fd
, (struct sockaddr
*)sun
, sz
))
1141 die(1, "couldn't connect to server: %s", strerror(errno
));
1142 selbuf_init(&c_server
, &sel
, fd
, c_sline
, 0);
1144 /* --- If there are any arguments, turn them into a string --- */
1147 selbuf_init(&c_client
, &sel
, STDIN_FILENO
, c_uline
, 0);
1156 write(fd
, d
.buf
, d
.len
);
1158 c_flags
|= cf_uclose
;
1162 /* --- And repeat --- */
1165 if (sel_select(&sel
))
1166 die(EXIT_FAILURE
, "select error: %s", strerror(errno
));
1170 /*----- Main code ---------------------------------------------------------*/
1172 /* --- @help@, @version@, @usage@ --- *
1174 * Arguments: @FILE *fp@ = stream to write on
1178 * Use: Emit helpful messages.
1181 static void usage(FILE *fp
)
1185 $ [-qvfidl] [-c command] [-t timeout] [-s socket]\n\
1186 $ [-s socket] -C [command args...]\n\
1190 static void version(FILE *fp
)
1192 pquis(fp
, "$, Catacomb version " VERSION
"\n");
1195 static void help(FILE *fp
)
1201 The Catacomb passphrase pixie collects and caches passphrases used to\n\
1202 protect important keys. Options provided:\n\
1204 -h, --help Show this help text.\n\
1205 -V, --version Show the program's version number.\n\
1206 -u, --usage Show a (very) terse usage summary.\n\
1208 -C, --client Connect to a running pixie as a client.\n\
1210 -q, --quiet Emit fewer log messages.\n\
1211 -v, --version Emit more log messages.\n\
1212 -s, --socket=FILE Name the pixie's socket.\n\
1213 -c, --command=COMMAND Shell command to read a passphrase.\n\
1214 -f, --fetch Fetch passphrases from the terminal.\n\
1215 -t, --timeout=TIMEOUT Length of time to retain a passphrase in memory.\n\
1216 -i, --interactive Allow commands to be typed interactively.\n\
1217 -d, --daemon Fork into the background after initialization.\n\
1218 -l, --syslog Emit log messages to the system log.\n\
1220 The COMMAND may contain `%m' and `%t' markers which are replaced by a\n\
1221 prompt message and the passphrase tag respectively. The TIMEOUT is an\n\
1222 integer, optionally followed by `d', `h', `m' or `s' to specify units of\n\
1223 days, hours, minutes or seconds respectively.\n\
1225 In client mode, if a command is specified on the command line, it is sent\n\
1226 to the running server; otherwise the program reads requests from stdin.\n\
1227 Responses from the pixie are written to stdout. Send a HELP request for\n\
1228 a quick summary of the pixie communication protocol.\n\
1234 * Arguments: @int argc@ = number of arguments
1235 * @char *argv[]@ = vector of argument values
1237 * Returns: Zero if OK.
1239 * Use: Main program. Listens on a socket and responds with a PGP
1240 * passphrase when asked.
1243 int main(int argc
, char *argv
[])
1246 struct sockaddr_un
*sun
;
1254 #define f_syslog 16u
1256 /* --- Initialize libraries --- */
1261 /* --- Set up the locked memory area --- */
1266 /* --- Parse command line arguments --- */
1269 static struct option opts
[] = {
1271 /* --- Standard GNUy help options --- */
1273 { "help", 0, 0, 'h' },
1274 { "version", 0, 0, 'V' },
1275 { "usage", 0, 0, 'u' },
1277 /* --- Other options --- */
1279 { "quiet", 0, 0, 'q' },
1280 { "verbose", 0, 0, 'v' },
1281 { "client", 0, 0, 'C' },
1282 { "socket", OPTF_ARGREQ
, 0, 's' },
1283 { "command", OPTF_ARGREQ
, 0, 'c' },
1284 { "fetch", 0, 0, 'f' },
1285 { "timeout", OPTF_ARGREQ
, 0, 't' },
1286 { "interactive", 0, 0, 'i' },
1287 { "stdin", 0, 0, 'i' },
1288 { "daemon", 0, 0, 'd' },
1289 { "log", 0, 0, 'l' },
1290 { "syslog", 0, 0, 'l' },
1292 /* --- Magic terminator --- */
1297 int i
= mdwopt(argc
, argv
, "hVuqvCs:c:ft:idl", opts
, 0, 0, 0);
1303 /* --- GNUy help options --- */
1315 /* --- Other interesting things --- */
1331 if ((timeout
= pixserv_timeout(optarg
)) == 0)
1332 die(1, "bad timeout `%s'", optarg
);
1351 /* --- Something else --- */
1359 if (f
& f_bogus
|| (optind
< argc
&& !(f
& f_client
))) {
1364 /* --- Set up the socket address --- */
1366 sun
= pixie_address(path
, &sz
);
1368 /* --- Initialize selectory --- */
1371 signal(SIGPIPE
, SIG_IGN
);
1373 /* --- Be a client if a client's wanted --- */
1376 pix_client(sun
, sz
, argv
+ optind
);
1378 /* --- Open the syslog if requested --- */
1382 openlog(QUIS
, 0, LOG_DAEMON
);
1385 /* --- Check on the locked memory area --- */
1389 int rc
= l_report(&lm
, &d
);
1391 die(EXIT_FAILURE
, d
.buf
);
1392 else if (rc
&& verbose
) {
1394 log("couldn't lock passphrase buffer");
1397 arena_setsecure(&lm
.a
);
1400 /* --- Set signal behaviours --- */
1403 static sig sigint
, sigterm
, sigquit
, sighup
;
1404 struct sigaction sa
;
1406 sigaction(SIGINT
, 0, &sa
);
1407 if (sa
.sa_handler
!= SIG_IGN
)
1408 sig_add(&sigint
, SIGINT
, pix_sigdie
, 0);
1409 sig_add(&sigterm
, SIGTERM
, pix_sigdie
, 0);
1410 sig_add(&sigquit
, SIGQUIT
, pix_sigflush
, 0);
1411 sig_add(&sighup
, SIGHUP
, pix_sigflush
, 0);
1414 /* --- Set up the server --- */
1418 pixserv
*px
= pixserv_create(STDIN_FILENO
, STDOUT_FILENO
);
1419 sel_rmtimer(&px
->timer
);
1423 /* --- Fork into the background if requested --- */
1428 if (((f
& f_stdin
) &&
1429 (isatty(STDIN_FILENO
) || isatty(STDOUT_FILENO
))) ||
1430 (!command
&& (flags
& F_FETCH
)))
1431 die(1, "can't become a daemon if terminal required");
1433 if ((kid
= fork()) < 0)
1434 die(1, "fork failed: %s", strerror(errno
));
1440 if ((fd
= open("/dev/tty", O_RDONLY
)) >= 0) {
1441 ioctl(fd
, TIOCNOTTY
);
1454 log("initialized ok");
1459 if (!sel_select(&sel
))
1461 else if (errno
!= EINTR
&& errno
!= EAGAIN
) {
1462 log("error from select: %s", strerror(errno
));
1465 log("too many consecutive select errors: bailing out");
1474 /*----- That's all, folks -------------------------------------------------*/