3 * $Id: pixie.c,v 1.12 2002/01/13 13:50:42 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.12 2002/01/13 13:50:42 mdw
34 * Various fixes tracking mLib changes.
36 * Revision 1.11 2002/01/13 13:43:05 mdw
37 * Fix bug in daemon mode.
39 * Revision 1.10 2001/02/21 20:03:54 mdw
40 * Handle select errors (by bombing out). Cosmetic tweak.
42 * Revision 1.9 2001/02/03 16:06:44 mdw
43 * Don't set a handler for @SIGINT@ if it's ignored at startup. Add some
44 * error handling for the @select@ loop.
46 * Revision 1.8 2001/01/25 22:19:31 mdw
47 * Make flags be unsigned.
49 * Revision 1.7 2000/12/06 20:33:27 mdw
50 * Make flags be macros rather than enumerations, to ensure that they're
53 * Revision 1.6 2000/10/08 12:06:46 mdw
54 * Change size passed to socket function to be a @size_t@. Insert missing
55 * type name for flag declaration.
57 * Revision 1.5 2000/07/29 22:05:22 mdw
58 * Miscellaneous tidyings:
60 * * Change the timeout to something more appropriate for real use.
62 * * Check assumptions about object types when binding the socket. In
63 * particular, don't zap the socket if it's really something else.
65 * * In @p_request@, return a failure if the shell command returned
66 * nonzero. Fix a bug in @p_get@ which incorrectly passes on a success
67 * code when this happens.
69 * * Dispose of the locked memory in client mode to avoid being
72 * * Also in client mode, don't report closure from the server if we're
73 * running noninteractively.
75 * * Insert a missing option letter into the usage string.
77 * * Change to the root directory after forking in daemon mode.
79 * Revision 1.4 2000/06/17 11:50:53 mdw
80 * New pixie protocol allowing application to request passphrases and send
81 * them to the pixie. Use the secure arena interface for the input
82 * buffer. Extend the input buffer. Other minor fixes.
84 * Revision 1.3 1999/12/22 22:14:40 mdw
85 * Only produce initialization message if verbose.
87 * Revision 1.2 1999/12/22 22:13:42 mdw
88 * Fix bug in passphrase flushing loop.
90 * Revision 1.1 1999/12/22 15:58:41 mdw
91 * Passphrase pixie support.
95 /*----- Header files ------------------------------------------------------*/
110 #include <sys/types.h>
111 #include <sys/time.h>
113 #include <sys/stat.h>
114 #include <sys/wait.h>
117 #include <sys/ioctl.h>
121 #include <sys/socket.h>
124 #include <mLib/alloc.h>
125 #include <mLib/dstr.h>
126 #include <mLib/fdflags.h>
127 #include <mLib/mdwopt.h>
128 #include <mLib/quis.h>
129 #include <mLib/report.h>
130 #include <mLib/sel.h>
131 #include <mLib/selbuf.h>
132 #include <mLib/sig.h>
133 #include <mLib/str.h>
134 #include <mLib/sub.h>
139 #include "passphrase.h"
142 /*----- Static variables --------------------------------------------------*/
144 static unsigned long timeout
= 900;
145 static sel_state sel
;
146 static unsigned verbose
= 1;
147 static const char *command
= 0;
149 static unsigned flags
= 0;
154 /*----- Event logging -----------------------------------------------------*/
158 * Arguments: @const char *p@ = @printf@-style format string
159 * @...@ = extra arguments to fill in
163 * Use: Writes out a timestamped log message.
166 static void log(const char *p
, ...)
171 if (!(flags
& F_SYSLOG
)) {
173 struct tm
*tm
= localtime(&t
);
175 d
.len
+= strftime(d
.buf
, d
.sz
, "%Y-%m-%d %H:%M:%S ", tm
);
178 dstr_vputf(&d
, p
, &ap
);
181 if (flags
& F_SYSLOG
)
182 syslog(LOG_NOTICE
, "%s", d
.buf
);
185 dstr_write(&d
, stderr
);
190 /*----- Passphrase management ---------------------------------------------*/
192 /* --- Data structures --- */
194 typedef struct phrase
{
204 /* --- Variables --- */
206 #define P_ROOT ((phrase *)&p_root)
207 static struct { phrase
*next
; phrase
*prev
; } p_root
= { P_ROOT
, P_ROOT
};
209 /* --- @p_free@ --- *
211 * Arguments: @phrase *p@ = pointer to phrase block
215 * Use: Frees a phrase block.
218 static void p_free(phrase
*p
)
221 sel_rmtimer(&p
->timer
);
224 p
->next
->prev
= p
->prev
;
225 p
->prev
->next
= p
->next
;
229 /* --- @p_timer@ --- *
231 * Arguments: @struct timeval *tv@ = current time
232 * @void *p@ = pointer to phrase
236 * Use: Expires a passphrase.
239 static void p_timer(struct timeval
*tv
, void *p
)
243 log("expiring passphrase `%s'", pp
->tag
);
247 /* --- @p_alloc@ --- *
249 * Arguments: @size_t sz@ = amount of memory required
251 * Returns: Pointer to allocated memory, or null.
253 * Use: Allocates some locked memory, flushing old passphrases if
254 * there's not enough space.
257 static void *p_alloc(size_t sz
)
261 if ((p
= l_alloc(&lm
, sz
)) != 0)
263 if (P_ROOT
->next
== P_ROOT
)
266 log("flushing passphrase `%s' to free up needed space",
269 p_free(P_ROOT
->next
);
273 /* --- @p_find@ --- *
275 * Arguments: @const char *tag@ = pointer to tag to find
277 * Returns: Pointer to passphrase block, or null.
279 * Use: Finds a passphrase with a given tag.
282 static phrase
*p_find(const char *tag
)
286 for (p
= P_ROOT
->next
; p
!= P_ROOT
; p
= p
->next
) {
287 if (strcmp(p
->tag
, tag
) == 0) {
290 sel_rmtimer(&p
->timer
);
291 gettimeofday(&tv
, 0);
293 sel_addtimer(&sel
, &p
->timer
, &tv
, p_timer
, p
);
295 p
->next
->prev
= p
->prev
;
296 p
->prev
->next
= p
->next
;
298 p
->prev
= P_ROOT
->prev
;
299 P_ROOT
->prev
->next
= p
;
309 * Arguments: @const char *tag@ = pointer to tag string
310 * @const char *p@ = pointer to passphrase
311 * @unsigned long t@ = expiry timeout
313 * Returns: Pointer to newly-added passphrase.
315 * Use: Adds a new passphrase. The tag must not already exist.
318 static phrase
*p_add(const char *tag
, const char *p
, unsigned long t
)
320 size_t sz
= strlen(p
) + 1;
321 char *l
= p_alloc(sz
);
324 /* --- Make sure the locked memory was allocated --- */
329 /* --- Fill in some other bits of the block --- */
334 pp
->tag
= xstrdup(tag
);
337 /* --- Set the timer --- */
342 gettimeofday(&tv
, 0);
344 sel_addtimer(&sel
, &pp
->timer
, &tv
, p_timer
, pp
);
347 /* --- Link the block into the chain --- */
350 pp
->prev
= P_ROOT
->prev
;
351 P_ROOT
->prev
->next
= pp
;
356 /* --- @p_flush@ --- *
358 * Arguments: @const char *tag@ = pointer to tag string, or zero for all
362 * Use: Immediately flushes either a single phrase or all of them.
365 static void p_flush(const char *tag
)
369 if (!tag
&& verbose
> 1)
370 log("flushing all passphrases");
372 while (p
!= P_ROOT
) {
373 phrase
*pp
= p
->next
;
376 else if (strcmp(p
->tag
, tag
) == 0) {
378 log("flushing passphrase `%s'", tag
);
386 /*----- Reading passphrases -----------------------------------------------*/
388 /* --- @p_request@ --- *
390 * Arguments: @const char *msg@ = message string
391 * @const char *tag@ = pointer to tag string
392 * @char *buf@ = pointer to (locked) buffer
393 * @size_t sz@ = size of buffer
395 * Returns: Zero if all went well, nonzero otherwise.
397 * Use: Requests a passphrase from the user.
400 static int p_request(const char *msg
, const char *tag
, char *buf
, size_t sz
)
402 /* --- If there's a passphrase-fetching command, run it --- */
412 /* --- Substitute the prompt string into the command --- */
416 const char *q
= strchr(p
, '%');
439 /* --- Create a pipe and start a child process --- */
443 if ((kid
= fork()) < 0)
446 /* --- Child process --- */
450 if (dup2(fd
[1], STDOUT_FILENO
) < 0)
453 execl("/bin/sh", "sh", "-c", d
.buf
, (void *)0);
457 /* --- Read the data back into my buffer --- */
460 if ((r
= read(fd
[0], buf
, sz
- 1)) >= 0) {
461 char *q
= memchr(buf
, '\n', r
);
467 waitpid(kid
, &rc
, 0);
469 if (r
< 0 || rc
!= 0)
473 /* --- Tidy up when things go wrong --- */
484 /* --- Read a passphrase from the terminal --- *
486 * Use the standard Catacomb passphrase-reading function, so it'll read the
487 * passphrase from a file descriptor or something if the appropriate
488 * environment variable is set.
494 dstr_putf(&d
, "%s %s: ", msg
, tag
);
495 rc
= pixie_getpass(d
.buf
, buf
, sz
);
502 /* --- Sort out the buffer --- *
504 * Strip leading spaces.
510 while (isspace((unsigned char)*p
))
513 memmove(buf
, p
, len
);
524 * Arguments: @const char **q@ = where to store the result
525 * @const char *tag@ = pointer to tag string
526 * @unsigned mode@ = reading mode (verify?)
527 * @time_t exp@ = expiry time suggestion
529 * Returns: Zero if successful, @-1@ on a read failure, or @+1@ if the
530 * passphrase is missing and there is no fetcher. (This will
531 * always happen if there is no fetcher and @mode@ is
534 * Use: Reads a passphrase from somewhere.
537 static int p_get(const char **q
, const char *tag
, unsigned mode
, time_t exp
)
544 /* --- Write a log message --- */
547 log("passphrase `%s' requested", tag
);
549 /* --- If there is no fetcher, life is simpler --- */
551 if (!(flags
& F_FETCH
)) {
552 if (mode
== PMODE_VERIFY
)
554 if ((p
= p_find(tag
)) == 0)
560 /* --- Try to find the phrase --- */
562 if (mode
== PMODE_VERIFY
)
564 if (mode
== PMODE_VERIFY
|| (p
= p_find(tag
)) == 0) {
565 if ((pp
= p_alloc(LBUFSZ
)) == 0)
567 if (p_request(mode
== PMODE_READ ?
"Passphrase" : "New passphrase",
568 tag
, pp
, LBUFSZ
) < 0)
570 p
= p_add(tag
, pp
, exp
);
575 /* --- If verification is requested, verify the passphrase --- */
577 if (mode
== PMODE_VERIFY
) {
578 if (!pp
&& (pp
= p_alloc(LBUFSZ
)) == 0)
580 if (p_request("Verify passphrase", tag
, pp
, LBUFSZ
) < 0)
582 if (strcmp(pp
, p
->p
) != 0) {
584 log("passphrases for `%s' don't match", tag
);
590 /* --- Tidy up and return the passphrase --- */
593 memset(pp
, 0, LBUFSZ
);
599 /* --- Tidy up if things went wrong --- */
603 memset(pp
, 0, LBUFSZ
);
611 /*----- Server command parsing --------------------------------------------*/
613 /* --- Data structures --- */
615 typedef struct pixserv
{
624 #define PIXSERV_TIMEOUT 30
626 /* --- @pixserv_expire@ --- *
628 * Arguments: @struct timeval *tv@ = pointer to current time
629 * @void *p@ = pointer to server block
633 * Use: Expires a pixie connection if the remote end decides he's not
634 * interested any more.
637 static void pixserv_expire(struct timeval
*tv
, void *p
)
640 if (px
->fd
!= px
->b
.reader
.fd
)
642 selbuf_destroy(&px
->b
);
643 close(px
->b
.reader
.fd
);
647 /* --- @pixserv_write@ --- *
649 * Arguments: @pixserv *px@ = pointer to server block
650 * @const char *p@ = pointer to skeleton string
651 * @...@ = other arguments to fill in
655 * Use: Formats a string and emits it to the output file.
658 static void pixserv_write(pixserv
*px
, const char *p
, ...)
664 dstr_vputf(&d
, p
, &ap
);
665 write(px
->fd
, d
.buf
, d
.len
);
670 /* --- @pixserv_timeout@ --- *
672 * Arguments: @const char *p@ = pointer to timeout string
674 * Returns: Timeout in seconds.
676 * Use: Translates a string to a timeout value in seconds.
679 static unsigned long pixserv_timeout(const char *p
)
687 t
= strtoul(p
, &q
, 0);
692 case 's': if (q
[1] != 0)
699 /* --- @pixserv_line@ --- *
701 * Arguments: @char *s@ = pointer to the line read
702 * @size_t len@ = length of the line
703 * @void *p@ = pointer to server block
707 * Use: Handles a line read from the client.
710 static void pixserv_line(char *s
, size_t len
, void *p
)
716 /* --- Handle an end-of-file --- */
718 if (!(px
->f
& px_stdin
))
719 sel_rmtimer(&px
->timer
);
721 if (px
->fd
!= px
->b
.reader
.fd
)
723 selbuf_destroy(&px
->b
);
724 close(px
->b
.reader
.fd
);
728 /* --- Fiddle the timeout --- */
730 if (!(px
->f
& px_stdin
)) {
732 gettimeofday(&tv
, 0);
733 tv
.tv_sec
+= PIXSERV_TIMEOUT
;
734 sel_addtimer(&sel
, &px
->timer
, &tv
, pixserv_expire
, px
);
737 /* --- Scan out the first word --- */
739 if ((q
= str_getword(&s
)) == 0)
741 for (qq
= q
; *qq
; qq
++)
742 *qq
= tolower((unsigned char)*qq
);
744 /* --- Handle a help request --- */
746 if (strcmp(q
, "help") == 0) {
748 INFO Commands supported:\n\
751 INFO PASS tag [expire]\n\
752 INFO VERIFY tag [expire]\n\
754 INFO SET tag [expire] -- phrase\n\
760 /* --- List the passphrases --- */
762 else if (strcmp(q
, "list") == 0) {
765 for (p
= P_ROOT
->next
; p
!= P_ROOT
; p
= p
->next
) {
767 pixserv_write(px
, "ITEM %s no-expire\n", p
->tag
);
770 gettimeofday(&tv
, 0);
771 TV_SUB(&tv
, &p
->timer
.tv
, &tv
);
772 pixserv_write(px
, "ITEM %s %i\n", p
->tag
, tv
.tv_sec
);
775 pixserv_write(px
, "OK\n");
778 /* --- Request a passphrase --- */
780 else if ((mode
= PMODE_READ
, strcmp(q
, "pass") == 0) ||
781 (mode
= PMODE_VERIFY
, strcmp(q
, "verify") == 0)) {
786 if ((q
= str_getword(&s
)) == 0)
787 pixserv_write(px
, "FAIL missing tag\n");
788 else if ((t
= pixserv_timeout(s
)) == 0)
789 pixserv_write(px
, "FAIL bad timeout\n");
791 rc
= p_get(&p
, q
, mode
, t
> timeout ? timeout
: t
);
794 pixserv_write(px
, "OK %s\n", p
);
797 pixserv_write(px
, "FAIL error reading passphrase\n");
800 pixserv_write(px
, "MISSING\n");
806 /* --- Flush existing passphrases --- */
808 else if (strcmp(q
, "flush") == 0) {
811 pixserv_write(px
, "OK\n");
814 /* --- Set a passphrase --- */
816 else if (strcmp(q
, "set") == 0) {
819 if ((tag
= str_getword(&s
)) == 0)
820 pixserv_write(px
, "FAIL missing tag\n");
821 else if ((q
= str_getword(&s
)) == 0)
822 pixserv_write(px
, "FAIL no passphrase\n");
824 if (strcmp(q
, "--") != 0) {
825 t
= pixserv_timeout(q
);
828 t
= pixserv_timeout(0);
830 pixserv_write(px
, "FAIL no passphrase\n");
831 else if (strcmp(q
, "--") != 0)
832 pixserv_write(px
, "FAIL rubbish found before passphrase\n");
836 pixserv_write(px
, "OK\n");
841 /* --- Shut the server down --- */
843 else if (strcmp(q
, "quit") == 0) {
845 log("%s client requested shutdown",
846 px
->f
& px_stdin ?
"local" : "remote");
847 pixserv_write(px
, "OK\n");
851 /* --- Report an error for other commands --- */
854 pixserv_write(px
, "FAIL unknown command `%s'\n", q
);
857 /* --- @pixserv_create@ --- *
859 * Arguments: @int fd@ = file descriptor to read from
860 * @int ofd@ = file descriptor to write to
862 * Returns: Pointer to the new connection.
864 * Use: Creates a new Pixie server instance for a new connection.
867 static pixserv
*pixserv_create(int fd
, int ofd
)
869 pixserv
*px
= CREATE(pixserv
);
871 fdflags(fd
, O_NONBLOCK
, O_NONBLOCK
, FD_CLOEXEC
, FD_CLOEXEC
);
873 fdflags(ofd
, O_NONBLOCK
, O_NONBLOCK
, FD_CLOEXEC
, FD_CLOEXEC
);
875 selbuf_init(&px
->b
, &sel
, fd
, pixserv_line
, px
);
876 px
->b
.b
.a
= arena_secure
;
877 selbuf_setsize(&px
->b
, 1024);
878 gettimeofday(&tv
, 0);
879 tv
.tv_sec
+= PIXSERV_TIMEOUT
;
880 sel_addtimer(&sel
, &px
->timer
, &tv
, pixserv_expire
, px
);
885 /* --- @pixserv_accept@ --- *
887 * Arguments: @int fd@ = file descriptor
888 * @unsigned mode@ = what's happened
889 * @void *p@ = an uninteresting argument
893 * Use: Accepts a new connection.
896 static void pixserv_accept(int fd
, unsigned mode
, void *p
)
899 struct sockaddr_un sun
;
900 size_t sunsz
= sizeof(sun
);
902 if (mode
!= SEL_READ
)
904 if ((nfd
= accept(fd
, (struct sockaddr
*)&sun
, &sunsz
)) < 0) {
906 log("new connection failed: %s", strerror(errno
));
909 pixserv_create(nfd
, nfd
);
912 /*----- Setting up the server ---------------------------------------------*/
914 /* --- @unlinksocket@ --- *
920 * Use: Tidies up the socket when it's finished with.
923 static char *sockpath
;
925 static void unlinksocket(void)
931 /* --- @pix_sigdie@ --- *
933 * Arguments: @int sig@ = signal number
934 * @void *p@ = uninteresting argument
938 * Use: Shuts down the program after a fatal signal.
941 static void pix_sigdie(int sig
, void *p
)
948 case SIGTERM
: p
= "SIGTERM"; break;
949 case SIGINT
: p
= "SIGINT"; break;
951 sprintf(buf
, "signal %i", sig
);
955 log("shutting down on %s", p
);
960 /* --- @pix_sigflush@ --- *
962 * Arguments: @int sig@ = signal number
963 * @void *p@ = uninteresting argument
967 * Use: Flushes the passphrase cache on receipt of a signal.
970 static void pix_sigflush(int sig
, void *p
)
977 case SIGHUP
: p
= "SIGHUP"; break;
978 case SIGQUIT
: p
= "SIGQUIT"; break;
980 sprintf(buf
, "signal %i", sig
);
984 log("received %s; flushing passphrases", p
);
989 /* --- @pix_setup@ --- *
991 * Arguments: @struct sockaddr_un *sun@ = pointer to address to use
992 * @size_t sz@ = size of socket address
996 * Use: Sets up the pixie's Unix-domain socket.
999 static void pix_setup(struct sockaddr_un
*sun
, size_t sz
)
1003 /* --- Set up the parent directory --- */
1006 char *p
= sun
->sun_path
;
1007 char *q
= strrchr(p
, '/');
1013 DPUTM(&d
, p
, q
- p
);
1017 if (stat(d
.buf
, &st
))
1018 die(1, "couldn't stat `%s': %s", d
.buf
, strerror(errno
));
1019 if (!S_ISDIR(st
.st_mode
))
1020 die(1, "object `%s' isn't a directory", d
.buf
);
1021 if (st
.st_mode
& 0077)
1022 die(1, "parent directory `%s' has group or world access", d
.buf
);
1027 /* --- Initialize the socket --- */
1035 if ((fd
= socket(PF_UNIX
, SOCK_STREAM
, 0)) < 0)
1036 die(1, "couldn't create socket: %s", strerror(errno
));
1037 if (bind(fd
, (struct sockaddr
*)sun
, sz
) < 0) {
1039 if (errno
!= EADDRINUSE
)
1040 die(1, "couldn't bind to address: %s", strerror(e
));
1042 die(1, "too many retries; giving up");
1044 if (connect(fd
, (struct sockaddr
*)sun
, sz
)) {
1046 if (errno
!= ECONNREFUSED
)
1047 die(1, "couldn't bind to address: %s", strerror(e
));
1048 if (stat(sun
->sun_path
, &st
))
1049 die(1, "couldn't stat `%s': %s", sun
->sun_path
, strerror(errno
));
1050 if (!S_ISSOCK(st
.st_mode
))
1051 die(1, "object `%s' isn't a socket", sun
->sun_path
);
1053 log("stale socket found; removing it");
1054 unlink(sun
->sun_path
);
1058 log("server already running; shutting it down");
1059 write(fd
, "QUIT\n", 5);
1065 chmod(sun
->sun_path
, 0600);
1066 fdflags(fd
, O_NONBLOCK
, O_NONBLOCK
, FD_CLOEXEC
, FD_CLOEXEC
);
1068 die(1, "couldn't listen on socket: %s", strerror(errno
));
1071 /* --- Set up the rest of the server --- */
1074 static sel_file serv
;
1075 sockpath
= sun
->sun_path
;
1076 atexit(unlinksocket
);
1077 sel_initfile(&sel
, &serv
, fd
, SEL_READ
, pixserv_accept
, 0);
1082 /*----- Client support code -----------------------------------------------*/
1084 /* --- Variables --- */
1086 static selbuf c_server
, c_client
;
1087 static unsigned c_flags
= 0;
1089 #define cf_uclose 1u
1090 #define cf_sclose 2u
1092 /* --- Line handler functions --- */
1094 static void c_uline(char *s
, size_t len
, void *p
)
1097 selbuf_destroy(&c_client
);
1098 shutdown(c_server
.reader
.fd
, 1);
1099 c_flags
|= cf_uclose
;
1102 write(c_server
.reader
.fd
, s
, len
);
1106 static void c_sline(char *s
, size_t len
, void *p
)
1109 selbuf_destroy(&c_server
);
1110 if (!(c_flags
& cf_uclose
)) {
1111 moan("server closed the connection");
1112 selbuf_destroy(&c_client
);
1119 /* --- @pix_client@ --- *
1121 * Arguments: @struct sockaddr_un *sun@ = pointer to socket address
1122 * @size_t sz@ = size of socket address
1123 * @char *argv[]@ = pointer to arguments to send
1127 * Use: Performs client-side actions for the passphrase pixie.
1130 static void pix_client(struct sockaddr_un
*sun
, size_t sz
, char *argv
[])
1134 /* --- Dispose of locked memory --- */
1138 /* --- Open the socket --- */
1140 if ((fd
= socket(PF_UNIX
, SOCK_STREAM
, 0)) < 0)
1141 die(1, "couldn't create socket: %s", strerror(errno
));
1142 if (connect(fd
, (struct sockaddr
*)sun
, sz
))
1143 die(1, "couldn't connect to server: %s", strerror(errno
));
1144 selbuf_init(&c_server
, &sel
, fd
, c_sline
, 0);
1146 /* --- If there are any arguments, turn them into a string --- */
1149 selbuf_init(&c_client
, &sel
, STDIN_FILENO
, c_uline
, 0);
1158 write(fd
, d
.buf
, d
.len
);
1160 c_flags
|= cf_uclose
;
1164 /* --- And repeat --- */
1167 if (sel_select(&sel
))
1168 die(EXIT_FAILURE
, "select error: %s", strerror(errno
));
1172 /*----- Main code ---------------------------------------------------------*/
1174 /* --- @help@, @version@, @usage@ --- *
1176 * Arguments: @FILE *fp@ = stream to write on
1180 * Use: Emit helpful messages.
1183 static void usage(FILE *fp
)
1187 $ [-qvfidl] [-c command] [-t timeout] [-s socket]\n\
1188 $ [-s socket] -C [command args...]\n\
1192 static void version(FILE *fp
)
1194 pquis(fp
, "$, Catacomb version " VERSION
"\n");
1197 static void help(FILE *fp
)
1203 The Catacomb passphrase pixie collects and caches passphrases used to\n\
1204 protect important keys. Options provided:\n\
1206 -h, --help Show this help text.\n\
1207 -V, --version Show the program's version number.\n\
1208 -u, --usage Show a (very) terse usage summary.\n\
1210 -C, --client Connect to a running pixie as a client.\n\
1212 -q, --quiet Emit fewer log messages.\n\
1213 -v, --version Emit more log messages.\n\
1214 -s, --socket=FILE Name the pixie's socket.\n\
1215 -c, --command=COMMAND Shell command to read a passphrase.\n\
1216 -f, --fetch Fetch passphrases from the terminal.\n\
1217 -t, --timeout=TIMEOUT Length of time to retain a passphrase in memory.\n\
1218 -i, --interactive Allow commands to be typed interactively.\n\
1219 -d, --daemon Fork into the background after initialization.\n\
1220 -l, --syslog Emit log messages to the system log.\n\
1222 The COMMAND may contain `%m' and `%t' markers which are replaced by a\n\
1223 prompt message and the passphrase tag respectively. The TIMEOUT is an\n\
1224 integer, optionally followed by `d', `h', `m' or `s' to specify units of\n\
1225 days, hours, minutes or seconds respectively.\n\
1227 In client mode, if a command is specified on the command line, it is sent\n\
1228 to the running server; otherwise the program reads requests from stdin.\n\
1229 Responses from the pixie are written to stdout. Send a HELP request for\n\
1230 a quick summary of the pixie communication protocol.\n\
1236 * Arguments: @int argc@ = number of arguments
1237 * @char *argv[]@ = vector of argument values
1239 * Returns: Zero if OK.
1241 * Use: Main program. Listens on a socket and responds with a PGP
1242 * passphrase when asked.
1245 int main(int argc
, char *argv
[])
1248 struct sockaddr_un
*sun
;
1256 #define f_syslog 16u
1258 /* --- Initialize libraries --- */
1263 /* --- Set up the locked memory area --- */
1268 /* --- Parse command line arguments --- */
1271 static struct option opts
[] = {
1273 /* --- Standard GNUy help options --- */
1275 { "help", 0, 0, 'h' },
1276 { "version", 0, 0, 'V' },
1277 { "usage", 0, 0, 'u' },
1279 /* --- Other options --- */
1281 { "quiet", 0, 0, 'q' },
1282 { "verbose", 0, 0, 'v' },
1283 { "client", 0, 0, 'C' },
1284 { "socket", OPTF_ARGREQ
, 0, 's' },
1285 { "command", OPTF_ARGREQ
, 0, 'c' },
1286 { "fetch", 0, 0, 'f' },
1287 { "timeout", OPTF_ARGREQ
, 0, 't' },
1288 { "interactive", 0, 0, 'i' },
1289 { "stdin", 0, 0, 'i' },
1290 { "daemon", 0, 0, 'd' },
1291 { "log", 0, 0, 'l' },
1292 { "syslog", 0, 0, 'l' },
1294 /* --- Magic terminator --- */
1299 int i
= mdwopt(argc
, argv
, "hVuqvCs:c:ft:idl", opts
, 0, 0, 0);
1305 /* --- GNUy help options --- */
1317 /* --- Other interesting things --- */
1333 if ((timeout
= pixserv_timeout(optarg
)) == 0)
1334 die(1, "bad timeout `%s'", optarg
);
1353 /* --- Something else --- */
1361 if (f
& f_bogus
|| (optind
< argc
&& !(f
& f_client
))) {
1366 /* --- Set up the socket address --- */
1368 sun
= pixie_address(path
, &sz
);
1370 /* --- Initialize selectory --- */
1373 signal(SIGPIPE
, SIG_IGN
);
1375 /* --- Be a client if a client's wanted --- */
1378 pix_client(sun
, sz
, argv
+ optind
);
1380 /* --- Open the syslog if requested --- */
1384 openlog(QUIS
, 0, LOG_DAEMON
);
1387 /* --- Check on the locked memory area --- */
1391 int rc
= l_report(&lm
, &d
);
1393 die(EXIT_FAILURE
, d
.buf
);
1394 else if (rc
&& verbose
) {
1396 log("couldn't lock passphrase buffer");
1399 arena_setsecure(&lm
.a
);
1402 /* --- Set signal behaviours --- */
1405 static sig sigint
, sigterm
, sigquit
, sighup
;
1406 struct sigaction sa
;
1408 sigaction(SIGINT
, 0, &sa
);
1409 if (sa
.sa_handler
!= SIG_IGN
)
1410 sig_add(&sigint
, SIGINT
, pix_sigdie
, 0);
1411 sig_add(&sigterm
, SIGTERM
, pix_sigdie
, 0);
1412 sig_add(&sigquit
, SIGQUIT
, pix_sigflush
, 0);
1413 sig_add(&sighup
, SIGHUP
, pix_sigflush
, 0);
1416 /* --- Set up the server --- */
1420 pixserv
*px
= pixserv_create(STDIN_FILENO
, STDOUT_FILENO
);
1421 sel_rmtimer(&px
->timer
);
1425 /* --- Fork into the background if requested --- */
1430 if (((f
& f_stdin
) &&
1431 (isatty(STDIN_FILENO
) || isatty(STDOUT_FILENO
))) ||
1432 (!command
&& (flags
& F_FETCH
)))
1433 die(1, "can't become a daemon if terminal required");
1435 if ((kid
= fork()) < 0)
1436 die(1, "fork failed: %s", strerror(errno
));
1442 if ((fd
= open("/dev/tty", O_RDONLY
)) >= 0) {
1443 ioctl(fd
, TIOCNOTTY
);
1456 log("initialized ok");
1461 if (!sel_select(&sel
))
1463 else if (errno
!= EINTR
&& errno
!= EAGAIN
) {
1464 log("error from select: %s", strerror(errno
));
1467 log("too many consecutive select errors: bailing out");
1476 /*----- That's all, folks -------------------------------------------------*/