3 * $Id: pixie.c,v 1.9 2001/02/03 16:06:44 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.9 2001/02/03 16:06:44 mdw
34 * Don't set a handler for @SIGINT@ if it's ignored at startup. Add some
35 * error handling for the @select@ loop.
37 * Revision 1.8 2001/01/25 22:19:31 mdw
38 * Make flags be unsigned.
40 * Revision 1.7 2000/12/06 20:33:27 mdw
41 * Make flags be macros rather than enumerations, to ensure that they're
44 * Revision 1.6 2000/10/08 12:06:46 mdw
45 * Change size passed to socket function to be a @size_t@. Insert missing
46 * type name for flag declaration.
48 * Revision 1.5 2000/07/29 22:05:22 mdw
49 * Miscellaneous tidyings:
51 * * Change the timeout to something more appropriate for real use.
53 * * Check assumptions about object types when binding the socket. In
54 * particular, don't zap the socket if it's really something else.
56 * * In @p_request@, return a failure if the shell command returned
57 * nonzero. Fix a bug in @p_get@ which incorrectly passes on a success
58 * code when this happens.
60 * * Dispose of the locked memory in client mode to avoid being
63 * * Also in client mode, don't report closure from the server if we're
64 * running noninteractively.
66 * * Insert a missing option letter into the usage string.
68 * * Change to the root directory after forking in daemon mode.
70 * Revision 1.4 2000/06/17 11:50:53 mdw
71 * New pixie protocol allowing application to request passphrases and send
72 * them to the pixie. Use the secure arena interface for the input
73 * buffer. Extend the input buffer. Other minor fixes.
75 * Revision 1.3 1999/12/22 22:14:40 mdw
76 * Only produce initialization message if verbose.
78 * Revision 1.2 1999/12/22 22:13:42 mdw
79 * Fix bug in passphrase flushing loop.
81 * Revision 1.1 1999/12/22 15:58:41 mdw
82 * Passphrase pixie support.
86 /*----- Header files ------------------------------------------------------*/
101 #include <sys/types.h>
102 #include <sys/time.h>
104 #include <sys/stat.h>
105 #include <sys/wait.h>
108 #include <sys/ioctl.h>
112 #include <sys/socket.h>
115 #include <mLib/alloc.h>
116 #include <mLib/dstr.h>
117 #include <mLib/fdflags.h>
118 #include <mLib/mdwopt.h>
119 #include <mLib/quis.h>
120 #include <mLib/report.h>
121 #include <mLib/sel.h>
122 #include <mLib/selbuf.h>
123 #include <mLib/sig.h>
124 #include <mLib/str.h>
125 #include <mLib/sub.h>
130 #include "passphrase.h"
133 /*----- Static variables --------------------------------------------------*/
135 static unsigned long timeout
= 900;
136 static sel_state sel
;
137 static unsigned verbose
= 1;
138 static const char *command
= 0;
140 static unsigned flags
= 0;
145 /*----- Event logging -----------------------------------------------------*/
149 * Arguments: @const char *p@ = @printf@-style format string
150 * @...@ = extra arguments to fill in
154 * Use: Writes out a timestamped log message.
157 static void log(const char *p
, ...)
162 if (!(flags
& F_SYSLOG
)) {
164 struct tm
*tm
= localtime(&t
);
166 d
.len
+= strftime(d
.buf
, d
.sz
, "%Y-%m-%d %H:%M:%S ", tm
);
169 dstr_vputf(&d
, p
, ap
);
172 if (flags
& F_SYSLOG
)
173 syslog(LOG_NOTICE
, "%s", d
.buf
);
176 dstr_write(&d
, stderr
);
181 /*----- Passphrase management ---------------------------------------------*/
183 /* --- Data structures --- */
185 typedef struct phrase
{
195 /* --- Variables --- */
197 #define P_ROOT ((phrase *)&p_root)
198 static struct { phrase
*next
; phrase
*prev
; } p_root
= { P_ROOT
, P_ROOT
};
200 /* --- @p_free@ --- *
202 * Arguments: @phrase *p@ = pointer to phrase block
206 * Use: Frees a phrase block.
209 static void p_free(phrase
*p
)
212 sel_rmtimer(&p
->timer
);
215 p
->next
->prev
= p
->prev
;
216 p
->prev
->next
= p
->next
;
220 /* --- @p_timer@ --- *
222 * Arguments: @struct timeval *tv@ = current time
223 * @void *p@ = pointer to phrase
227 * Use: Expires a passphrase.
230 static void p_timer(struct timeval
*tv
, void *p
)
234 log("expiring passphrase `%s'", pp
->tag
);
238 /* --- @p_alloc@ --- *
240 * Arguments: @size_t sz@ = amount of memory required
242 * Returns: Pointer to allocated memory, or null.
244 * Use: Allocates some locked memory, flushing old passphrases if
245 * there's not enough space.
248 static void *p_alloc(size_t sz
)
252 if ((p
= l_alloc(&lm
, sz
)) != 0)
254 if (P_ROOT
->next
== P_ROOT
)
257 log("flushing passphrase `%s' to free up needed space",
260 p_free(P_ROOT
->next
);
264 /* --- @p_find@ --- *
266 * Arguments: @const char *tag@ = pointer to tag to find
268 * Returns: Pointer to passphrase block, or null.
270 * Use: Finds a passphrase with a given tag.
273 static phrase
*p_find(const char *tag
)
277 for (p
= P_ROOT
->next
; p
!= P_ROOT
; p
= p
->next
) {
278 if (strcmp(p
->tag
, tag
) == 0) {
281 sel_rmtimer(&p
->timer
);
282 gettimeofday(&tv
, 0);
284 sel_addtimer(&sel
, &p
->timer
, &tv
, p_timer
, p
);
286 p
->next
->prev
= p
->prev
;
287 p
->prev
->next
= p
->next
;
289 p
->prev
= P_ROOT
->prev
;
290 P_ROOT
->prev
->next
= p
;
300 * Arguments: @const char *tag@ = pointer to tag string
301 * @const char *p@ = pointer to passphrase
302 * @unsigned long t@ = expiry timeout
304 * Returns: Pointer to newly-added passphrase.
306 * Use: Adds a new passphrase. The tag must not already exist.
309 static phrase
*p_add(const char *tag
, const char *p
, unsigned long t
)
311 size_t sz
= strlen(p
) + 1;
312 char *l
= p_alloc(sz
);
315 /* --- Make sure the locked memory was allocated --- */
320 /* --- Fill in some other bits of the block --- */
325 pp
->tag
= xstrdup(tag
);
328 /* --- Set the timer --- */
333 gettimeofday(&tv
, 0);
335 sel_addtimer(&sel
, &pp
->timer
, &tv
, p_timer
, pp
);
338 /* --- Link the block into the chain --- */
341 pp
->prev
= P_ROOT
->prev
;
342 P_ROOT
->prev
->next
= pp
;
347 /* --- @p_flush@ --- *
349 * Arguments: @const char *tag@ = pointer to tag string, or zero for all
353 * Use: Immediately flushes either a single phrase or all of them.
356 static void p_flush(const char *tag
)
360 if (!tag
&& verbose
> 1)
361 log("flushing all passphrases");
363 while (p
!= P_ROOT
) {
364 phrase
*pp
= p
->next
;
367 else if (strcmp(p
->tag
, tag
) == 0) {
369 log("flushing passphrase `%s'", tag
);
377 /*----- Reading passphrases -----------------------------------------------*/
379 /* --- @p_request@ --- *
381 * Arguments: @const char *msg@ = message string
382 * @const char *tag@ = pointer to tag string
383 * @char *buf@ = pointer to (locked) buffer
384 * @size_t sz@ = size of buffer
386 * Returns: Zero if all went well, nonzero otherwise.
388 * Use: Requests a passphrase from the user.
391 static int p_request(const char *msg
, const char *tag
, char *buf
, size_t sz
)
393 /* --- If there's a passphrase-fetching command, run it --- */
403 /* --- Substitute the prompt string into the command --- */
407 const char *q
= strchr(p
, '%');
430 /* --- Create a pipe and start a child process --- */
434 if ((kid
= fork()) < 0)
437 /* --- Child process --- */
441 if (dup2(fd
[1], STDOUT_FILENO
) < 0)
444 execl("/bin/sh", "sh", "-c", d
.buf
, (void *)0);
448 /* --- Read the data back into my buffer --- */
451 if ((r
= read(fd
[0], buf
, sz
- 1)) >= 0) {
452 char *q
= memchr(buf
, '\n', r
);
458 waitpid(kid
, &rc
, 0);
460 if (r
< 0 || rc
!= 0)
464 /* --- Tidy up when things go wrong --- */
475 /* --- Read a passphrase from the terminal --- *
477 * Use the standard Catacomb passphrase-reading function, so it'll read the
478 * passphrase from a file descriptor or something if the appropriate
479 * environment variable is set.
485 dstr_putf(&d
, "%s %s: ", msg
, tag
);
486 rc
= pixie_getpass(d
.buf
, buf
, sz
);
493 /* --- Sort out the buffer --- *
495 * Strip leading spaces.
501 while (isspace((unsigned char)*p
))
504 memmove(buf
, p
, len
);
515 * Arguments: @const char **q@ = where to store the result
516 * @const char *tag@ = pointer to tag string
517 * @unsigned mode@ = reading mode (verify?)
518 * @time_t exp@ = expiry time suggestion
520 * Returns: Zero if successful, @-1@ on a read failure, or @+1@ if the
521 * passphrase is missing and there is no fetcher. (This will
522 * always happen if there is no fetcher and @mode@ is
525 * Use: Reads a passphrase from somewhere.
528 static int p_get(const char **q
, const char *tag
, unsigned mode
, time_t exp
)
535 /* --- Write a log message --- */
538 log("passphrase `%s' requested", tag
);
540 /* --- If there is no fetcher, life is simpler --- */
542 if (!(flags
& F_FETCH
)) {
543 if (mode
== PMODE_VERIFY
)
545 if ((p
= p_find(tag
)) == 0)
551 /* --- Try to find the phrase --- */
553 if (mode
== PMODE_VERIFY
)
555 if (mode
== PMODE_VERIFY
|| (p
= p_find(tag
)) == 0) {
556 if ((pp
= p_alloc(LBUFSZ
)) == 0)
558 if (p_request(mode
== PMODE_READ ?
"Passphrase" : "New passphrase",
559 tag
, pp
, LBUFSZ
) < 0)
561 p
= p_add(tag
, pp
, exp
);
566 /* --- If verification is requested, verify the passphrase --- */
568 if (mode
== PMODE_VERIFY
) {
569 if (!pp
&& (pp
= p_alloc(LBUFSZ
)) == 0)
571 if (p_request("Verify passphrase", tag
, pp
, LBUFSZ
) < 0)
573 if (strcmp(pp
, p
->p
) != 0) {
575 log("passphrases for `%s' don't match", tag
);
581 /* --- Tidy up and return the passphrase --- */
584 memset(pp
, 0, LBUFSZ
);
590 /* --- Tidy up if things went wrong --- */
594 memset(pp
, 0, LBUFSZ
);
602 /*----- Server command parsing --------------------------------------------*/
604 /* --- Data structures --- */
606 typedef struct pixserv
{
615 #define PIXSERV_TIMEOUT 30
617 /* --- @pixserv_expire@ --- *
619 * Arguments: @struct timeval *tv@ = pointer to current time
620 * @void *p@ = pointer to server block
624 * Use: Expires a pixie connection if the remote end decides he's not
625 * interested any more.
628 static void pixserv_expire(struct timeval
*tv
, void *p
)
631 if (px
->fd
!= px
->b
.reader
.fd
)
633 selbuf_destroy(&px
->b
);
634 close(px
->b
.reader
.fd
);
638 /* --- @pixserv_write@ --- *
640 * Arguments: @pixserv *px@ = pointer to server block
641 * @const char *p@ = pointer to skeleton string
642 * @...@ = other arguments to fill in
646 * Use: Formats a string and emits it to the output file.
649 static void pixserv_write(pixserv
*px
, const char *p
, ...)
655 dstr_vputf(&d
, p
, ap
);
656 write(px
->fd
, d
.buf
, d
.len
);
661 /* --- @pixserv_timeout@ --- *
663 * Arguments: @const char *p@ = pointer to timeout string
665 * Returns: Timeout in seconds.
667 * Use: Translates a string to a timeout value in seconds.
670 static unsigned long pixserv_timeout(const char *p
)
678 t
= strtoul(p
, &q
, 0);
683 case 's': if (q
[1] != 0)
690 /* --- @pixserv_line@ --- *
692 * Arguments: @char *s@ = pointer to the line read
693 * @void *p@ = pointer to server block
697 * Use: Handles a line read from the client.
700 static void pixserv_line(char *s
, void *p
)
706 /* --- Handle an end-of-file --- */
708 if (!(px
->f
& px_stdin
))
709 sel_rmtimer(&px
->timer
);
711 if (px
->fd
!= px
->b
.reader
.fd
)
713 selbuf_destroy(&px
->b
);
714 close(px
->b
.reader
.fd
);
718 /* --- Fiddle the timeout --- */
720 if (!(px
->f
& px_stdin
)) {
722 gettimeofday(&tv
, 0);
723 tv
.tv_sec
+= PIXSERV_TIMEOUT
;
724 sel_addtimer(&sel
, &px
->timer
, &tv
, pixserv_expire
, px
);
727 /* --- Scan out the first word --- */
729 if ((q
= str_getword(&s
)) == 0)
731 for (qq
= q
; *qq
; qq
++)
732 *qq
= tolower((unsigned char)*qq
);
734 /* --- Handle a help request --- */
736 if (strcmp(q
, "help") == 0) {
738 INFO Commands supported:\n\
741 INFO PASS tag [expire]\n\
742 INFO VERIFY tag [expire]\n\
744 INFO SET tag [expire] -- phrase\n\
750 /* --- List the passphrases --- */
752 else if (strcmp(q
, "list") == 0) {
755 for (p
= P_ROOT
->next
; p
!= P_ROOT
; p
= p
->next
) {
757 pixserv_write(px
, "ITEM %s no-expire\n", p
->tag
);
760 gettimeofday(&tv
, 0);
761 TV_SUB(&tv
, &p
->timer
.tv
, &tv
);
762 pixserv_write(px
, "ITEM %s %i\n", p
->tag
, tv
.tv_sec
);
765 pixserv_write(px
, "OK\n");
768 /* --- Request a passphrase --- */
770 else if ((mode
= PMODE_READ
, strcmp(q
, "pass") == 0) ||
771 (mode
= PMODE_VERIFY
, strcmp(q
, "verify") == 0)) {
776 if ((q
= str_getword(&s
)) == 0)
777 pixserv_write(px
, "FAIL missing tag\n");
778 else if ((t
= pixserv_timeout(s
)) == 0)
779 pixserv_write(px
, "FAIL bad timeout\n");
781 rc
= p_get(&p
, q
, mode
, t
> timeout ? timeout
: t
);
784 pixserv_write(px
, "OK %s\n", p
);
787 pixserv_write(px
, "FAIL error reading passphrase\n");
790 pixserv_write(px
, "MISSING\n");
796 /* --- Flush existing passphrases --- */
798 else if (strcmp(q
, "flush") == 0) {
801 pixserv_write(px
, "OK\n");
804 /* --- Set a passphrase --- */
806 else if (strcmp(q
, "set") == 0) {
809 if ((tag
= str_getword(&s
)) == 0)
810 pixserv_write(px
, "FAIL missing tag\n");
811 else if ((q
= str_getword(&s
)) == 0)
812 pixserv_write(px
, "FAIL no passphrase\n");
814 if (strcmp(q
, "--") != 0) {
815 t
= pixserv_timeout(q
);
818 t
= pixserv_timeout(0);
820 pixserv_write(px
, "FAIL no passphrase\n");
821 else if (strcmp(q
, "--") != 0)
822 pixserv_write(px
, "FAIL rubbish found before passphrase\n");
826 pixserv_write(px
, "OK\n");
831 /* --- Shut the server down --- */
833 else if (strcmp(q
, "quit") == 0) {
835 log("%s client requested shutdown",
836 px
->f
& px_stdin ?
"local" : "remote");
837 pixserv_write(px
, "OK\n");
841 /* --- Report an error for other commands --- */
844 pixserv_write(px
, "FAIL unknown command `%s'\n", q
);
847 /* --- @pixserv_create@ --- *
849 * Arguments: @int fd@ = file descriptor to read from
850 * @int ofd@ = file descriptor to write to
852 * Returns: Pointer to the new connection.
854 * Use: Creates a new Pixie server instance for a new connection.
857 static pixserv
*pixserv_create(int fd
, int ofd
)
859 pixserv
*px
= CREATE(pixserv
);
861 fdflags(fd
, O_NONBLOCK
, O_NONBLOCK
, FD_CLOEXEC
, FD_CLOEXEC
);
863 fdflags(ofd
, O_NONBLOCK
, O_NONBLOCK
, FD_CLOEXEC
, FD_CLOEXEC
);
865 selbuf_init(&px
->b
, &sel
, fd
, pixserv_line
, px
);
866 px
->b
.b
.a
= arena_secure
;
867 selbuf_setsize(&px
->b
, 1024);
868 gettimeofday(&tv
, 0);
869 tv
.tv_sec
+= PIXSERV_TIMEOUT
;
870 sel_addtimer(&sel
, &px
->timer
, &tv
, pixserv_expire
, px
);
875 /* --- @pixserv_accept@ --- *
877 * Arguments: @int fd@ = file descriptor
878 * @unsigned mode@ = what's happened
879 * @void *p@ = an uninteresting argument
883 * Use: Accepts a new connection.
886 static void pixserv_accept(int fd
, unsigned mode
, void *p
)
889 struct sockaddr_un sun
;
890 size_t sunsz
= sizeof(sun
);
892 if (mode
!= SEL_READ
)
894 if ((nfd
= accept(fd
, (struct sockaddr
*)&sun
, &sunsz
)) < 0) {
896 log("new connection failed: %s", strerror(errno
));
899 pixserv_create(nfd
, nfd
);
902 /*----- Setting up the server ---------------------------------------------*/
904 /* --- @unlinksocket@ --- *
910 * Use: Tidies up the socket when it's finished with.
913 static char *sockpath
;
915 static void unlinksocket(void)
921 /* --- @pix_sigdie@ --- *
923 * Arguments: @int sig@ = signal number
924 * @void *p@ = uninteresting argument
928 * Use: Shuts down the program after a fatal signal.
931 static void pix_sigdie(int sig
, void *p
)
938 case SIGTERM
: p
= "SIGTERM"; break;
939 case SIGINT
: p
= "SIGINT"; break;
941 sprintf(buf
, "signal %i", sig
);
945 log("shutting down on %s", p
);
950 /* --- @pix_sigflush@ --- *
952 * Arguments: @int sig@ = signal number
953 * @void *p@ = uninteresting argument
957 * Use: Flushes the passphrase cache on receipt of a signal.
960 static void pix_sigflush(int sig
, void *p
)
967 case SIGHUP
: p
= "SIGHUP"; break;
968 case SIGQUIT
: p
= "SIGQUIT"; break;
970 sprintf(buf
, "signal %i", sig
);
974 log("received %s; flushing passphrases", p
);
979 /* --- @pix_setup@ --- *
981 * Arguments: @struct sockaddr_un *sun@ = pointer to address to use
982 * @size_t sz@ = size of socket address
986 * Use: Sets up the pixie's Unix-domain socket.
989 static void pix_setup(struct sockaddr_un
*sun
, size_t sz
)
993 /* --- Set up the parent directory --- */
996 char *p
= sun
->sun_path
;
997 char *q
= strrchr(p
, '/');
1003 DPUTM(&d
, p
, q
- p
);
1007 if (stat(d
.buf
, &st
))
1008 die(1, "couldn't stat `%s': %s", d
.buf
, strerror(errno
));
1009 if (!S_ISDIR(st
.st_mode
))
1010 die(1, "object `%s' isn't a directory", d
.buf
);
1011 if (st
.st_mode
& 0077)
1012 die(1, "parent directory `%s' has group or world access", d
.buf
);
1017 /* --- Initialize the socket --- */
1025 if ((fd
= socket(PF_UNIX
, SOCK_STREAM
, 0)) < 0)
1026 die(1, "couldn't create socket: %s", strerror(errno
));
1027 if (bind(fd
, (struct sockaddr
*)sun
, sz
) < 0) {
1029 if (errno
!= EADDRINUSE
)
1030 die(1, "couldn't bind to address: %s", strerror(e
));
1032 die(1, "too many retries; giving up");
1034 if (connect(fd
, (struct sockaddr
*)sun
, sz
)) {
1036 if (errno
!= ECONNREFUSED
)
1037 die(1, "couldn't bind to address: %s", strerror(e
));
1038 if (stat(sun
->sun_path
, &st
))
1039 die(1, "couldn't stat `%s': %s", sun
->sun_path
, strerror(errno
));
1040 if (!S_ISSOCK(st
.st_mode
))
1041 die(1, "object `%s' isn't a socket", sun
->sun_path
);
1043 log("stale socket found; removing it");
1044 unlink(sun
->sun_path
);
1048 log("server already running; shutting it down");
1049 write(fd
, "QUIT\n", 5);
1055 chmod(sun
->sun_path
, 0600);
1056 fdflags(fd
, O_NONBLOCK
, O_NONBLOCK
, FD_CLOEXEC
, FD_CLOEXEC
);
1058 die(1, "couldn't listen on socket: %s", strerror(errno
));
1061 /* --- Set up the rest of the server --- */
1064 static sel_file serv
;
1065 sockpath
= sun
->sun_path
;
1066 atexit(unlinksocket
);
1067 sel_initfile(&sel
, &serv
, fd
, SEL_READ
, pixserv_accept
, 0);
1072 /*----- Client support code -----------------------------------------------*/
1074 /* --- Variables --- */
1076 static selbuf c_server
, c_client
;
1077 static unsigned c_flags
= 0;
1079 #define cf_uclose 1u
1080 #define cf_sclose 2u
1082 /* --- Line handler functions --- */
1084 static void c_uline(char *s
, void *p
)
1088 selbuf_destroy(&c_client
);
1089 shutdown(c_server
.reader
.fd
, 1);
1090 c_flags
|= cf_uclose
;
1094 write(c_server
.reader
.fd
, s
, sz
);
1098 static void c_sline(char *s
, void *p
)
1101 selbuf_destroy(&c_server
);
1102 if (!(c_flags
& cf_uclose
)) {
1103 moan("server closed the connection");
1104 selbuf_destroy(&c_client
);
1111 /* --- @pix_client@ --- *
1113 * Arguments: @struct sockaddr_un *sun@ = pointer to socket address
1114 * @size_t sz@ = size of socket address
1115 * @char *argv[]@ = pointer to arguments to send
1119 * Use: Performs client-side actions for the passphrase pixie.
1122 static void pix_client(struct sockaddr_un
*sun
, size_t sz
, char *argv
[])
1126 /* --- Dispose of locked memory --- */
1130 /* --- Open the socket --- */
1132 if ((fd
= socket(PF_UNIX
, SOCK_STREAM
, 0)) < 0)
1133 die(1, "couldn't create socket: %s", strerror(errno
));
1134 if (connect(fd
, (struct sockaddr
*)sun
, sz
))
1135 die(1, "couldn't connect to server: %s", strerror(errno
));
1136 selbuf_init(&c_server
, &sel
, fd
, c_sline
, 0);
1138 /* --- If there are any arguments, turn them into a string --- */
1141 selbuf_init(&c_client
, &sel
, STDIN_FILENO
, c_uline
, 0);
1150 write(fd
, d
.buf
, d
.len
);
1152 c_flags
|= cf_uclose
;
1156 /* --- And repeat --- */
1162 /*----- Main code ---------------------------------------------------------*/
1164 /* --- @help@, @version@, @usage@ --- *
1166 * Arguments: @FILE *fp@ = stream to write on
1170 * Use: Emit helpful messages.
1173 static void usage(FILE *fp
)
1177 $ [-qvfidl] [-c command] [-t timeout] [-s socket]\n\
1178 $ [-s socket] -C [command args...]\n\
1182 static void version(FILE *fp
)
1184 pquis(fp
, "$, Catacomb version " VERSION
"\n");
1187 static void help(FILE *fp
)
1193 The Catacomb passphrase pixie collects and caches passphrases used to\n\
1194 protect important keys. Options provided:\n\
1196 -h, --help Show this help text.\n\
1197 -V, --version Show the program's version number.\n\
1198 -u, --usage Show a (very) terse usage summary.\n\
1200 -C, --client Connect to a running pixie as a client.\n\
1202 -q, --quiet Emit fewer log messages.\n\
1203 -v, --version Emit more log messages.\n\
1204 -s, --socket=FILE Name the pixie's socket.\n\
1205 -c, --command=COMMAND Shell command to read a passphrase.\n\
1206 -f, --fetch Fetch passphrases from the terminal.\n\
1207 -t, --timeout=TIMEOUT Length of time to retain a passphrase in memory.\n\
1208 -i, --interactive Allow commands to be typed interactively.\n\
1209 -d, --daemon Fork into the background after initialization.\n\
1210 -l, --syslog Emit log messages to the system log.\n\
1212 The COMMAND may contain `%m' and `%t' markers which are replaced by a\n\
1213 prompt message and the passphrase tag respectively. The TIMEOUT is an\n\
1214 integer, optionally followed by `d', `h', `m' or `s' to specify units of\n\
1215 days, hours, minutes or seconds respectively.\n\
1217 In client mode, if a command is specified on the command line, it is sent\n\
1218 to the running server; otherwise the program reads requests from stdin.\n\
1219 Responses from the pixie are written to stdout. Send a HELP request for\n\
1220 a quick summary of the pixie communication protocol.\n\
1226 * Arguments: @int argc@ = number of arguments
1227 * @char *argv[]@ = vector of argument values
1229 * Returns: Zero if OK.
1231 * Use: Main program. Listens on a socket and responds with a PGP
1232 * passphrase when asked.
1235 int main(int argc
, char *argv
[])
1238 struct sockaddr_un
*sun
;
1246 #define f_syslog 16u
1248 /* --- Initialize libraries --- */
1253 /* --- Set up the locked memory area --- */
1258 /* --- Parse command line arguments --- */
1261 static struct option opts
[] = {
1263 /* --- Standard GNUy help options --- */
1265 { "help", 0, 0, 'h' },
1266 { "version", 0, 0, 'V' },
1267 { "usage", 0, 0, 'u' },
1269 /* --- Other options --- */
1271 { "quiet", 0, 0, 'q' },
1272 { "verbose", 0, 0, 'v' },
1273 { "client", 0, 0, 'C' },
1274 { "socket", OPTF_ARGREQ
, 0, 's' },
1275 { "command", OPTF_ARGREQ
, 0, 'c' },
1276 { "fetch", 0, 0, 'f' },
1277 { "timeout", OPTF_ARGREQ
, 0, 't' },
1278 { "interactive", 0, 0, 'i' },
1279 { "stdin", 0, 0, 'i' },
1280 { "daemon", 0, 0, 'd' },
1281 { "log", 0, 0, 'l' },
1282 { "syslog", 0, 0, 'l' },
1284 /* --- Magic terminator --- */
1289 int i
= mdwopt(argc
, argv
, "hVuqvCs:c:ft:idl", opts
, 0, 0, 0);
1295 /* --- GNUy help options --- */
1307 /* --- Other interesting things --- */
1323 if ((timeout
= pixserv_timeout(optarg
)) == 0)
1324 die(1, "bad timeout `%s'", optarg
);
1343 /* --- Something else --- */
1351 if (f
& f_bogus
|| (optind
< argc
&& !(f
& f_client
))) {
1356 /* --- Set up the socket address --- */
1358 sun
= pixie_address(path
, &sz
);
1360 /* --- Initialize selectory --- */
1363 signal(SIGPIPE
, SIG_IGN
);
1365 /* --- Be a client if a client's wanted --- */
1368 pix_client(sun
, sz
, argv
+ optind
);
1370 /* --- Open the syslog if requested --- */
1374 openlog(QUIS
, 0, LOG_DAEMON
);
1377 /* --- Check on the locked memory area --- */
1381 int rc
= l_report(&lm
, &d
);
1383 die(EXIT_FAILURE
, d
.buf
);
1384 else if (rc
&& verbose
) {
1386 log("couldn't lock passphrase buffer");
1389 arena_setsecure(&lm
.a
);
1392 /* --- Set signal behaviours --- */
1395 static sig sigint
, sigterm
, sigquit
, sighup
;
1396 struct sigaction sa
;
1398 sigaction(SIGINT
, 0, &sa
);
1399 if (sa
.sa_handler
!= SIG_IGN
)
1400 sig_add(&sigint
, SIGINT
, pix_sigdie
, 0);
1401 sig_add(&sigterm
, SIGTERM
, pix_sigdie
, 0);
1402 sig_add(&sigquit
, SIGQUIT
, pix_sigflush
, 0);
1403 sig_add(&sighup
, SIGHUP
, pix_sigflush
, 0);
1406 /* --- Set up the server --- */
1410 pixserv
*px
= pixserv_create(STDIN_FILENO
, STDOUT_FILENO
);
1411 sel_rmtimer(&px
->timer
);
1415 /* --- Fork into the background if requested --- */
1420 if (((f
& f_stdin
) &&
1421 (isatty(STDIN_FILENO
) || isatty(STDOUT_FILENO
))) ||
1422 (!command
&& (flags
& F_FETCH
)))
1423 die(1, "can't become a daemon if terminal required");
1425 if ((kid
= fork()) < 0)
1426 die(1, "fork failed: %s", strerror(errno
));
1432 if ((fd
= open("/dev/tty", O_RDONLY
)) >= 0) {
1433 ioctl(fd
, TIOCNOTTY
);
1446 log("initialized ok");
1451 if (!sel_select(&sel
))
1453 else if (errno
!= EINTR
&& errno
!= EAGAIN
) {
1454 log("error from select: %s", strerror(errno
));
1457 log("too many consecutive select errors: bailing out");
1466 /*----- That's all, folks -------------------------------------------------*/