3 * $Id: pixie.c,v 1.8 2001/01/25 22:19:31 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.8 2001/01/25 22:19:31 mdw
34 * Make flags be unsigned.
36 * Revision 1.7 2000/12/06 20:33:27 mdw
37 * Make flags be macros rather than enumerations, to ensure that they're
40 * Revision 1.6 2000/10/08 12:06:46 mdw
41 * Change size passed to socket function to be a @size_t@. Insert missing
42 * type name for flag declaration.
44 * Revision 1.5 2000/07/29 22:05:22 mdw
45 * Miscellaneous tidyings:
47 * * Change the timeout to something more appropriate for real use.
49 * * Check assumptions about object types when binding the socket. In
50 * particular, don't zap the socket if it's really something else.
52 * * In @p_request@, return a failure if the shell command returned
53 * nonzero. Fix a bug in @p_get@ which incorrectly passes on a success
54 * code when this happens.
56 * * Dispose of the locked memory in client mode to avoid being
59 * * Also in client mode, don't report closure from the server if we're
60 * running noninteractively.
62 * * Insert a missing option letter into the usage string.
64 * * Change to the root directory after forking in daemon mode.
66 * Revision 1.4 2000/06/17 11:50:53 mdw
67 * New pixie protocol allowing application to request passphrases and send
68 * them to the pixie. Use the secure arena interface for the input
69 * buffer. Extend the input buffer. Other minor fixes.
71 * Revision 1.3 1999/12/22 22:14:40 mdw
72 * Only produce initialization message if verbose.
74 * Revision 1.2 1999/12/22 22:13:42 mdw
75 * Fix bug in passphrase flushing loop.
77 * Revision 1.1 1999/12/22 15:58:41 mdw
78 * Passphrase pixie support.
82 /*----- Header files ------------------------------------------------------*/
97 #include <sys/types.h>
100 #include <sys/stat.h>
101 #include <sys/wait.h>
104 #include <sys/ioctl.h>
108 #include <sys/socket.h>
111 #include <mLib/alloc.h>
112 #include <mLib/dstr.h>
113 #include <mLib/fdflags.h>
114 #include <mLib/mdwopt.h>
115 #include <mLib/quis.h>
116 #include <mLib/report.h>
117 #include <mLib/sel.h>
118 #include <mLib/selbuf.h>
119 #include <mLib/sig.h>
120 #include <mLib/str.h>
121 #include <mLib/sub.h>
126 #include "passphrase.h"
129 /*----- Static variables --------------------------------------------------*/
131 static unsigned long timeout
= 900;
132 static sel_state sel
;
133 static unsigned verbose
= 1;
134 static const char *command
= 0;
136 static unsigned flags
= 0;
141 /*----- Event logging -----------------------------------------------------*/
145 * Arguments: @const char *p@ = @printf@-style format string
146 * @...@ = extra arguments to fill in
150 * Use: Writes out a timestamped log message.
153 static void log(const char *p
, ...)
158 if (!(flags
& F_SYSLOG
)) {
160 struct tm
*tm
= localtime(&t
);
162 d
.len
+= strftime(d
.buf
, d
.sz
, "%Y-%m-%d %H:%M:%S ", tm
);
165 dstr_vputf(&d
, p
, ap
);
168 if (flags
& F_SYSLOG
)
169 syslog(LOG_NOTICE
, "%s", d
.buf
);
172 dstr_write(&d
, stderr
);
177 /*----- Passphrase management ---------------------------------------------*/
179 /* --- Data structures --- */
181 typedef struct phrase
{
191 /* --- Variables --- */
193 #define P_ROOT ((phrase *)&p_root)
194 static struct { phrase
*next
; phrase
*prev
; } p_root
= { P_ROOT
, P_ROOT
};
196 /* --- @p_free@ --- *
198 * Arguments: @phrase *p@ = pointer to phrase block
202 * Use: Frees a phrase block.
205 static void p_free(phrase
*p
)
208 sel_rmtimer(&p
->timer
);
211 p
->next
->prev
= p
->prev
;
212 p
->prev
->next
= p
->next
;
216 /* --- @p_timer@ --- *
218 * Arguments: @struct timeval *tv@ = current time
219 * @void *p@ = pointer to phrase
223 * Use: Expires a passphrase.
226 static void p_timer(struct timeval
*tv
, void *p
)
230 log("expiring passphrase `%s'", pp
->tag
);
234 /* --- @p_alloc@ --- *
236 * Arguments: @size_t sz@ = amount of memory required
238 * Returns: Pointer to allocated memory, or null.
240 * Use: Allocates some locked memory, flushing old passphrases if
241 * there's not enough space.
244 static void *p_alloc(size_t sz
)
248 if ((p
= l_alloc(&lm
, sz
)) != 0)
250 if (P_ROOT
->next
== P_ROOT
)
253 log("flushing passphrase `%s' to free up needed space",
256 p_free(P_ROOT
->next
);
260 /* --- @p_find@ --- *
262 * Arguments: @const char *tag@ = pointer to tag to find
264 * Returns: Pointer to passphrase block, or null.
266 * Use: Finds a passphrase with a given tag.
269 static phrase
*p_find(const char *tag
)
273 for (p
= P_ROOT
->next
; p
!= P_ROOT
; p
= p
->next
) {
274 if (strcmp(p
->tag
, tag
) == 0) {
277 sel_rmtimer(&p
->timer
);
278 gettimeofday(&tv
, 0);
280 sel_addtimer(&sel
, &p
->timer
, &tv
, p_timer
, p
);
282 p
->next
->prev
= p
->prev
;
283 p
->prev
->next
= p
->next
;
285 p
->prev
= P_ROOT
->prev
;
286 P_ROOT
->prev
->next
= p
;
296 * Arguments: @const char *tag@ = pointer to tag string
297 * @const char *p@ = pointer to passphrase
298 * @unsigned long t@ = expiry timeout
300 * Returns: Pointer to newly-added passphrase.
302 * Use: Adds a new passphrase. The tag must not already exist.
305 static phrase
*p_add(const char *tag
, const char *p
, unsigned long t
)
307 size_t sz
= strlen(p
) + 1;
308 char *l
= p_alloc(sz
);
311 /* --- Make sure the locked memory was allocated --- */
316 /* --- Fill in some other bits of the block --- */
321 pp
->tag
= xstrdup(tag
);
324 /* --- Set the timer --- */
329 gettimeofday(&tv
, 0);
331 sel_addtimer(&sel
, &pp
->timer
, &tv
, p_timer
, pp
);
334 /* --- Link the block into the chain --- */
337 pp
->prev
= P_ROOT
->prev
;
338 P_ROOT
->prev
->next
= pp
;
343 /* --- @p_flush@ --- *
345 * Arguments: @const char *tag@ = pointer to tag string, or zero for all
349 * Use: Immediately flushes either a single phrase or all of them.
352 static void p_flush(const char *tag
)
356 if (!tag
&& verbose
> 1)
357 log("flushing all passphrases");
359 while (p
!= P_ROOT
) {
360 phrase
*pp
= p
->next
;
363 else if (strcmp(p
->tag
, tag
) == 0) {
365 log("flushing passphrase `%s'", tag
);
373 /*----- Reading passphrases -----------------------------------------------*/
375 /* --- @p_request@ --- *
377 * Arguments: @const char *msg@ = message string
378 * @const char *tag@ = pointer to tag string
379 * @char *buf@ = pointer to (locked) buffer
380 * @size_t sz@ = size of buffer
382 * Returns: Zero if all went well, nonzero otherwise.
384 * Use: Requests a passphrase from the user.
387 static int p_request(const char *msg
, const char *tag
, char *buf
, size_t sz
)
389 /* --- If there's a passphrase-fetching command, run it --- */
399 /* --- Substitute the prompt string into the command --- */
403 const char *q
= strchr(p
, '%');
426 /* --- Create a pipe and start a child process --- */
430 if ((kid
= fork()) < 0)
433 /* --- Child process --- */
437 if (dup2(fd
[1], STDOUT_FILENO
) < 0)
440 execl("/bin/sh", "sh", "-c", d
.buf
, (void *)0);
444 /* --- Read the data back into my buffer --- */
447 if ((r
= read(fd
[0], buf
, sz
- 1)) >= 0) {
448 char *q
= memchr(buf
, '\n', r
);
454 waitpid(kid
, &rc
, 0);
456 if (r
< 0 || rc
!= 0)
460 /* --- Tidy up when things go wrong --- */
471 /* --- Read a passphrase from the terminal --- *
473 * Use the standard Catacomb passphrase-reading function, so it'll read the
474 * passphrase from a file descriptor or something if the appropriate
475 * environment variable is set.
481 dstr_putf(&d
, "%s %s: ", msg
, tag
);
482 rc
= pixie_getpass(d
.buf
, buf
, sz
);
489 /* --- Sort out the buffer --- *
491 * Strip leading spaces.
497 while (isspace((unsigned char)*p
))
500 memmove(buf
, p
, len
);
511 * Arguments: @const char **q@ = where to store the result
512 * @const char *tag@ = pointer to tag string
513 * @unsigned mode@ = reading mode (verify?)
514 * @time_t exp@ = expiry time suggestion
516 * Returns: Zero if successful, @-1@ on a read failure, or @+1@ if the
517 * passphrase is missing and there is no fetcher. (This will
518 * always happen if there is no fetcher and @mode@ is
521 * Use: Reads a passphrase from somewhere.
524 static int p_get(const char **q
, const char *tag
, unsigned mode
, time_t exp
)
531 /* --- Write a log message --- */
534 log("passphrase `%s' requested", tag
);
536 /* --- If there is no fetcher, life is simpler --- */
538 if (!(flags
& F_FETCH
)) {
539 if (mode
== PMODE_VERIFY
)
541 if ((p
= p_find(tag
)) == 0)
547 /* --- Try to find the phrase --- */
549 if (mode
== PMODE_VERIFY
)
551 if (mode
== PMODE_VERIFY
|| (p
= p_find(tag
)) == 0) {
552 if ((pp
= p_alloc(LBUFSZ
)) == 0)
554 if (p_request(mode
== PMODE_READ ?
"Passphrase" : "New passphrase",
555 tag
, pp
, LBUFSZ
) < 0)
557 p
= p_add(tag
, pp
, exp
);
562 /* --- If verification is requested, verify the passphrase --- */
564 if (mode
== PMODE_VERIFY
) {
565 if (!pp
&& (pp
= p_alloc(LBUFSZ
)) == 0)
567 if (p_request("Verify passphrase", tag
, pp
, LBUFSZ
) < 0)
569 if (strcmp(pp
, p
->p
) != 0) {
571 log("passphrases for `%s' don't match", tag
);
577 /* --- Tidy up and return the passphrase --- */
580 memset(pp
, 0, LBUFSZ
);
586 /* --- Tidy up if things went wrong --- */
590 memset(pp
, 0, LBUFSZ
);
598 /*----- Server command parsing --------------------------------------------*/
600 /* --- Data structures --- */
602 typedef struct pixserv
{
611 #define PIXSERV_TIMEOUT 30
613 /* --- @pixserv_expire@ --- *
615 * Arguments: @struct timeval *tv@ = pointer to current time
616 * @void *p@ = pointer to server block
620 * Use: Expires a pixie connection if the remote end decides he's not
621 * interested any more.
624 static void pixserv_expire(struct timeval
*tv
, void *p
)
627 if (px
->fd
!= px
->b
.reader
.fd
)
629 selbuf_destroy(&px
->b
);
630 close(px
->b
.reader
.fd
);
634 /* --- @pixserv_write@ --- *
636 * Arguments: @pixserv *px@ = pointer to server block
637 * @const char *p@ = pointer to skeleton string
638 * @...@ = other arguments to fill in
642 * Use: Formats a string and emits it to the output file.
645 static void pixserv_write(pixserv
*px
, const char *p
, ...)
651 dstr_vputf(&d
, p
, ap
);
652 write(px
->fd
, d
.buf
, d
.len
);
657 /* --- @pixserv_timeout@ --- *
659 * Arguments: @const char *p@ = pointer to timeout string
661 * Returns: Timeout in seconds.
663 * Use: Translates a string to a timeout value in seconds.
666 static unsigned long pixserv_timeout(const char *p
)
674 t
= strtoul(p
, &q
, 0);
679 case 's': if (q
[1] != 0)
686 /* --- @pixserv_line@ --- *
688 * Arguments: @char *s@ = pointer to the line read
689 * @void *p@ = pointer to server block
693 * Use: Handles a line read from the client.
696 static void pixserv_line(char *s
, void *p
)
702 /* --- Handle an end-of-file --- */
704 if (!(px
->f
& px_stdin
))
705 sel_rmtimer(&px
->timer
);
707 if (px
->fd
!= px
->b
.reader
.fd
)
709 selbuf_destroy(&px
->b
);
710 close(px
->b
.reader
.fd
);
714 /* --- Fiddle the timeout --- */
716 if (!(px
->f
& px_stdin
)) {
718 gettimeofday(&tv
, 0);
719 tv
.tv_sec
+= PIXSERV_TIMEOUT
;
720 sel_addtimer(&sel
, &px
->timer
, &tv
, pixserv_expire
, px
);
723 /* --- Scan out the first word --- */
725 if ((q
= str_getword(&s
)) == 0)
727 for (qq
= q
; *qq
; qq
++)
728 *qq
= tolower((unsigned char)*qq
);
730 /* --- Handle a help request --- */
732 if (strcmp(q
, "help") == 0) {
734 INFO Commands supported:\n\
737 INFO PASS tag [expire]\n\
738 INFO VERIFY tag [expire]\n\
740 INFO SET tag [expire] -- phrase\n\
746 /* --- List the passphrases --- */
748 else if (strcmp(q
, "list") == 0) {
751 for (p
= P_ROOT
->next
; p
!= P_ROOT
; p
= p
->next
) {
753 pixserv_write(px
, "ITEM %s no-expire\n", p
->tag
);
756 gettimeofday(&tv
, 0);
757 TV_SUB(&tv
, &p
->timer
.tv
, &tv
);
758 pixserv_write(px
, "ITEM %s %i\n", p
->tag
, tv
.tv_sec
);
761 pixserv_write(px
, "OK\n");
764 /* --- Request a passphrase --- */
766 else if ((mode
= PMODE_READ
, strcmp(q
, "pass") == 0) ||
767 (mode
= PMODE_VERIFY
, strcmp(q
, "verify") == 0)) {
772 if ((q
= str_getword(&s
)) == 0)
773 pixserv_write(px
, "FAIL missing tag\n");
774 else if ((t
= pixserv_timeout(s
)) == 0)
775 pixserv_write(px
, "FAIL bad timeout\n");
777 rc
= p_get(&p
, q
, mode
, t
> timeout ? timeout
: t
);
780 pixserv_write(px
, "OK %s\n", p
);
783 pixserv_write(px
, "FAIL error reading passphrase\n");
786 pixserv_write(px
, "MISSING\n");
792 /* --- Flush existing passphrases --- */
794 else if (strcmp(q
, "flush") == 0) {
797 pixserv_write(px
, "OK\n");
800 /* --- Set a passphrase --- */
802 else if (strcmp(q
, "set") == 0) {
805 if ((tag
= str_getword(&s
)) == 0)
806 pixserv_write(px
, "FAIL missing tag\n");
807 else if ((q
= str_getword(&s
)) == 0)
808 pixserv_write(px
, "FAIL no passphrase\n");
810 if (strcmp(q
, "--") != 0) {
811 t
= pixserv_timeout(q
);
814 t
= pixserv_timeout(0);
816 pixserv_write(px
, "FAIL no passphrase\n");
817 else if (strcmp(q
, "--") != 0)
818 pixserv_write(px
, "FAIL rubbish found before passphrase\n");
822 pixserv_write(px
, "OK\n");
827 /* --- Shut the server down --- */
829 else if (strcmp(q
, "quit") == 0) {
831 log("%s client requested shutdown",
832 px
->f
& px_stdin ?
"local" : "remote");
833 pixserv_write(px
, "OK\n");
837 /* --- Report an error for other commands --- */
840 pixserv_write(px
, "FAIL unknown command `%s'\n", q
);
843 /* --- @pixserv_create@ --- *
845 * Arguments: @int fd@ = file descriptor to read from
846 * @int ofd@ = file descriptor to write to
848 * Returns: Pointer to the new connection.
850 * Use: Creates a new Pixie server instance for a new connection.
853 static pixserv
*pixserv_create(int fd
, int ofd
)
855 pixserv
*px
= CREATE(pixserv
);
857 fdflags(fd
, O_NONBLOCK
, O_NONBLOCK
, FD_CLOEXEC
, FD_CLOEXEC
);
859 fdflags(ofd
, O_NONBLOCK
, O_NONBLOCK
, FD_CLOEXEC
, FD_CLOEXEC
);
861 selbuf_init(&px
->b
, &sel
, fd
, pixserv_line
, px
);
862 px
->b
.b
.a
= arena_secure
;
863 selbuf_setsize(&px
->b
, 1024);
864 gettimeofday(&tv
, 0);
865 tv
.tv_sec
+= PIXSERV_TIMEOUT
;
866 sel_addtimer(&sel
, &px
->timer
, &tv
, pixserv_expire
, px
);
871 /* --- @pixserv_accept@ --- *
873 * Arguments: @int fd@ = file descriptor
874 * @unsigned mode@ = what's happened
875 * @void *p@ = an uninteresting argument
879 * Use: Accepts a new connection.
882 static void pixserv_accept(int fd
, unsigned mode
, void *p
)
885 struct sockaddr_un sun
;
886 size_t sunsz
= sizeof(sun
);
888 if (mode
!= SEL_READ
)
890 if ((nfd
= accept(fd
, (struct sockaddr
*)&sun
, &sunsz
)) < 0) {
892 log("new connection failed: %s", strerror(errno
));
895 pixserv_create(nfd
, nfd
);
898 /*----- Setting up the server ---------------------------------------------*/
900 /* --- @unlinksocket@ --- *
906 * Use: Tidies up the socket when it's finished with.
909 static char *sockpath
;
911 static void unlinksocket(void)
917 /* --- @pix_sigdie@ --- *
919 * Arguments: @int sig@ = signal number
920 * @void *p@ = uninteresting argument
924 * Use: Shuts down the program after a fatal signal.
927 static void pix_sigdie(int sig
, void *p
)
934 case SIGTERM
: p
= "SIGTERM"; break;
935 case SIGINT
: p
= "SIGINT"; break;
937 sprintf(buf
, "signal %i", sig
);
941 log("shutting down on %s", p
);
946 /* --- @pix_sigflush@ --- *
948 * Arguments: @int sig@ = signal number
949 * @void *p@ = uninteresting argument
953 * Use: Flushes the passphrase cache on receipt of a signal.
956 static void pix_sigflush(int sig
, void *p
)
963 case SIGHUP
: p
= "SIGHUP"; break;
964 case SIGQUIT
: p
= "SIGQUIT"; break;
966 sprintf(buf
, "signal %i", sig
);
970 log("received %s; flushing passphrases", p
);
975 /* --- @pix_setup@ --- *
977 * Arguments: @struct sockaddr_un *sun@ = pointer to address to use
978 * @size_t sz@ = size of socket address
982 * Use: Sets up the pixie's Unix-domain socket.
985 static void pix_setup(struct sockaddr_un
*sun
, size_t sz
)
989 /* --- Set up the parent directory --- */
992 char *p
= sun
->sun_path
;
993 char *q
= strrchr(p
, '/');
1003 if (stat(d
.buf
, &st
))
1004 die(1, "couldn't stat `%s': %s", d
.buf
, strerror(errno
));
1005 if (!S_ISDIR(st
.st_mode
))
1006 die(1, "object `%s' isn't a directory", d
.buf
);
1007 if (st
.st_mode
& 0077)
1008 die(1, "parent directory `%s' has group or world access", d
.buf
);
1013 /* --- Initialize the socket --- */
1021 if ((fd
= socket(PF_UNIX
, SOCK_STREAM
, 0)) < 0)
1022 die(1, "couldn't create socket: %s", strerror(errno
));
1023 if (bind(fd
, (struct sockaddr
*)sun
, sz
) < 0) {
1025 if (errno
!= EADDRINUSE
)
1026 die(1, "couldn't bind to address: %s", strerror(e
));
1028 die(1, "too many retries; giving up");
1030 if (connect(fd
, (struct sockaddr
*)sun
, sz
)) {
1032 if (errno
!= ECONNREFUSED
)
1033 die(1, "couldn't bind to address: %s", strerror(e
));
1034 if (stat(sun
->sun_path
, &st
))
1035 die(1, "couldn't stat `%s': %s", sun
->sun_path
, strerror(errno
));
1036 if (!S_ISSOCK(st
.st_mode
))
1037 die(1, "object `%s' isn't a socket", sun
->sun_path
);
1039 log("stale socket found; removing it");
1040 unlink(sun
->sun_path
);
1044 log("server already running; shutting it down");
1045 write(fd
, "QUIT\n", 5);
1051 chmod(sun
->sun_path
, 0600);
1052 fdflags(fd
, O_NONBLOCK
, O_NONBLOCK
, FD_CLOEXEC
, FD_CLOEXEC
);
1054 die(1, "couldn't listen on socket: %s", strerror(errno
));
1057 /* --- Set up the rest of the server --- */
1060 static sel_file serv
;
1061 sockpath
= sun
->sun_path
;
1062 atexit(unlinksocket
);
1063 sel_initfile(&sel
, &serv
, fd
, SEL_READ
, pixserv_accept
, 0);
1068 /*----- Client support code -----------------------------------------------*/
1070 /* --- Variables --- */
1072 static selbuf c_server
, c_client
;
1073 static unsigned c_flags
= 0;
1075 #define cf_uclose 1u
1076 #define cf_sclose 2u
1078 /* --- Line handler functions --- */
1080 static void c_uline(char *s
, void *p
)
1084 selbuf_destroy(&c_client
);
1085 shutdown(c_server
.reader
.fd
, 1);
1086 c_flags
|= cf_uclose
;
1090 write(c_server
.reader
.fd
, s
, sz
);
1094 static void c_sline(char *s
, void *p
)
1097 selbuf_destroy(&c_server
);
1098 if (!(c_flags
& cf_uclose
)) {
1099 moan("server closed the connection");
1100 selbuf_destroy(&c_client
);
1107 /* --- @pix_client@ --- *
1109 * Arguments: @struct sockaddr_un *sun@ = pointer to socket address
1110 * @size_t sz@ = size of socket address
1111 * @char *argv[]@ = pointer to arguments to send
1115 * Use: Performs client-side actions for the passphrase pixie.
1118 static void pix_client(struct sockaddr_un
*sun
, size_t sz
, char *argv
[])
1122 /* --- Dispose of locked memory --- */
1126 /* --- Open the socket --- */
1128 if ((fd
= socket(PF_UNIX
, SOCK_STREAM
, 0)) < 0)
1129 die(1, "couldn't create socket: %s", strerror(errno
));
1130 if (connect(fd
, (struct sockaddr
*)sun
, sz
))
1131 die(1, "couldn't connect to server: %s", strerror(errno
));
1132 selbuf_init(&c_server
, &sel
, fd
, c_sline
, 0);
1134 /* --- If there are any arguments, turn them into a string --- */
1137 selbuf_init(&c_client
, &sel
, STDIN_FILENO
, c_uline
, 0);
1146 write(fd
, d
.buf
, d
.len
);
1148 c_flags
|= cf_uclose
;
1152 /* --- And repeat --- */
1158 /*----- Main code ---------------------------------------------------------*/
1160 /* --- @help@, @version@, @usage@ --- *
1162 * Arguments: @FILE *fp@ = stream to write on
1166 * Use: Emit helpful messages.
1169 static void usage(FILE *fp
)
1173 $ [-qvfidl] [-c command] [-t timeout] [-s socket]\n\
1174 $ [-s socket] -C [command args...]\n\
1178 static void version(FILE *fp
)
1180 pquis(fp
, "$, Catacomb version " VERSION
"\n");
1183 static void help(FILE *fp
)
1189 The Catacomb passphrase pixie collects and caches passphrases used to\n\
1190 protect important keys. Options provided:\n\
1192 -h, --help Show this help text.\n\
1193 -V, --version Show the program's version number.\n\
1194 -u, --usage Show a (very) terse usage summary.\n\
1196 -C, --client Connect to a running pixie as a client.\n\
1198 -q, --quiet Emit fewer log messages.\n\
1199 -v, --version Emit more log messages.\n\
1200 -s, --socket=FILE Name the pixie's socket.\n\
1201 -c, --command=COMMAND Shell command to read a passphrase.\n\
1202 -f, --fetch Fetch passphrases from the terminal.\n\
1203 -t, --timeout=TIMEOUT Length of time to retain a passphrase in memory.\n\
1204 -i, --interactive Allow commands to be typed interactively.\n\
1205 -d, --daemon Fork into the background after initialization.\n\
1206 -l, --syslog Emit log messages to the system log.\n\
1208 The COMMAND may contain `%m' and `%t' markers which are replaced by a\n\
1209 prompt message and the passphrase tag respectively. The TIMEOUT is an\n\
1210 integer, optionally followed by `d', `h', `m' or `s' to specify units of\n\
1211 days, hours, minutes or seconds respectively.\n\
1213 In client mode, if a command is specified on the command line, it is sent\n\
1214 to the running server; otherwise the program reads requests from stdin.\n\
1215 Responses from the pixie are written to stdout. Send a HELP request for\n\
1216 a quick summary of the pixie communication protocol.\n\
1222 * Arguments: @int argc@ = number of arguments
1223 * @char *argv[]@ = vector of argument values
1225 * Returns: Zero if OK.
1227 * Use: Main program. Listens on a socket and responds with a PGP
1228 * passphrase when asked.
1231 int main(int argc
, char *argv
[])
1234 struct sockaddr_un
*sun
;
1242 #define f_syslog 16u
1244 /* --- Initialize libraries --- */
1249 /* --- Set up the locked memory area --- */
1254 /* --- Parse command line arguments --- */
1257 static struct option opts
[] = {
1259 /* --- Standard GNUy help options --- */
1261 { "help", 0, 0, 'h' },
1262 { "version", 0, 0, 'V' },
1263 { "usage", 0, 0, 'u' },
1265 /* --- Other options --- */
1267 { "quiet", 0, 0, 'q' },
1268 { "verbose", 0, 0, 'v' },
1269 { "client", 0, 0, 'C' },
1270 { "socket", OPTF_ARGREQ
, 0, 's' },
1271 { "command", OPTF_ARGREQ
, 0, 'c' },
1272 { "fetch", 0, 0, 'f' },
1273 { "timeout", OPTF_ARGREQ
, 0, 't' },
1274 { "interactive", 0, 0, 'i' },
1275 { "stdin", 0, 0, 'i' },
1276 { "daemon", 0, 0, 'd' },
1277 { "log", 0, 0, 'l' },
1278 { "syslog", 0, 0, 'l' },
1280 /* --- Magic terminator --- */
1285 int i
= mdwopt(argc
, argv
, "hVuqvCs:c:ft:idl", opts
, 0, 0, 0);
1291 /* --- GNUy help options --- */
1303 /* --- Other interesting things --- */
1319 if ((timeout
= pixserv_timeout(optarg
)) == 0)
1320 die(1, "bad timeout `%s'", optarg
);
1339 /* --- Something else --- */
1347 if (f
& f_bogus
|| (optind
< argc
&& !(f
& f_client
))) {
1352 /* --- Set up the socket address --- */
1354 sun
= pixie_address(path
, &sz
);
1356 /* --- Initialize selectory --- */
1359 signal(SIGPIPE
, SIG_IGN
);
1361 /* --- Be a client if a client's wanted --- */
1364 pix_client(sun
, sz
, argv
+ optind
);
1366 /* --- Open the syslog if requested --- */
1370 openlog(QUIS
, 0, LOG_DAEMON
);
1373 /* --- Check on the locked memory area --- */
1377 int rc
= l_report(&lm
, &d
);
1379 die(EXIT_FAILURE
, d
.buf
);
1380 else if (rc
&& verbose
) {
1382 log("couldn't lock passphrase buffer");
1385 arena_setsecure(&lm
.a
);
1388 /* --- Set signal behaviours --- */
1391 static sig sigint
, sigterm
, sigquit
, sighup
;
1393 sig_add(&sigint
, SIGINT
, pix_sigdie
, 0);
1394 sig_add(&sigterm
, SIGTERM
, pix_sigdie
, 0);
1395 sig_add(&sigquit
, SIGQUIT
, pix_sigflush
, 0);
1396 sig_add(&sighup
, SIGHUP
, pix_sigflush
, 0);
1399 /* --- Set up the server --- */
1403 pixserv
*px
= pixserv_create(STDIN_FILENO
, STDOUT_FILENO
);
1404 sel_rmtimer(&px
->timer
);
1408 /* --- Fork into the background if requested --- */
1413 if (((f
& f_stdin
) &&
1414 (isatty(STDIN_FILENO
) || isatty(STDOUT_FILENO
))) ||
1415 (!command
&& (flags
& F_FETCH
)))
1416 die(1, "can't become a daemon if terminal required");
1418 if ((kid
= fork()) < 0)
1419 die(1, "fork failed: %s", strerror(errno
));
1425 if ((fd
= open("/dev/tty", O_RDONLY
)) >= 0) {
1426 ioctl(fd
, TIOCNOTTY
);
1439 log("initialized ok");
1445 /*----- That's all, folks -------------------------------------------------*/