3 * $Id: pixie.c,v 1.10 2001/02/21 20:03:54 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.10 2001/02/21 20:03:54 mdw
34 * Handle select errors (by bombing out). Cosmetic tweak.
36 * Revision 1.9 2001/02/03 16:06:44 mdw
37 * Don't set a handler for @SIGINT@ if it's ignored at startup. Add some
38 * error handling for the @select@ loop.
40 * Revision 1.8 2001/01/25 22:19:31 mdw
41 * Make flags be unsigned.
43 * Revision 1.7 2000/12/06 20:33:27 mdw
44 * Make flags be macros rather than enumerations, to ensure that they're
47 * Revision 1.6 2000/10/08 12:06:46 mdw
48 * Change size passed to socket function to be a @size_t@. Insert missing
49 * type name for flag declaration.
51 * Revision 1.5 2000/07/29 22:05:22 mdw
52 * Miscellaneous tidyings:
54 * * Change the timeout to something more appropriate for real use.
56 * * Check assumptions about object types when binding the socket. In
57 * particular, don't zap the socket if it's really something else.
59 * * In @p_request@, return a failure if the shell command returned
60 * nonzero. Fix a bug in @p_get@ which incorrectly passes on a success
61 * code when this happens.
63 * * Dispose of the locked memory in client mode to avoid being
66 * * Also in client mode, don't report closure from the server if we're
67 * running noninteractively.
69 * * Insert a missing option letter into the usage string.
71 * * Change to the root directory after forking in daemon mode.
73 * Revision 1.4 2000/06/17 11:50:53 mdw
74 * New pixie protocol allowing application to request passphrases and send
75 * them to the pixie. Use the secure arena interface for the input
76 * buffer. Extend the input buffer. Other minor fixes.
78 * Revision 1.3 1999/12/22 22:14:40 mdw
79 * Only produce initialization message if verbose.
81 * Revision 1.2 1999/12/22 22:13:42 mdw
82 * Fix bug in passphrase flushing loop.
84 * Revision 1.1 1999/12/22 15:58:41 mdw
85 * Passphrase pixie support.
89 /*----- Header files ------------------------------------------------------*/
104 #include <sys/types.h>
105 #include <sys/time.h>
107 #include <sys/stat.h>
108 #include <sys/wait.h>
111 #include <sys/ioctl.h>
115 #include <sys/socket.h>
118 #include <mLib/alloc.h>
119 #include <mLib/dstr.h>
120 #include <mLib/fdflags.h>
121 #include <mLib/mdwopt.h>
122 #include <mLib/quis.h>
123 #include <mLib/report.h>
124 #include <mLib/sel.h>
125 #include <mLib/selbuf.h>
126 #include <mLib/sig.h>
127 #include <mLib/str.h>
128 #include <mLib/sub.h>
133 #include "passphrase.h"
136 /*----- Static variables --------------------------------------------------*/
138 static unsigned long timeout
= 900;
139 static sel_state sel
;
140 static unsigned verbose
= 1;
141 static const char *command
= 0;
143 static unsigned flags
= 0;
148 /*----- Event logging -----------------------------------------------------*/
152 * Arguments: @const char *p@ = @printf@-style format string
153 * @...@ = extra arguments to fill in
157 * Use: Writes out a timestamped log message.
160 static void log(const char *p
, ...)
165 if (!(flags
& F_SYSLOG
)) {
167 struct tm
*tm
= localtime(&t
);
169 d
.len
+= strftime(d
.buf
, d
.sz
, "%Y-%m-%d %H:%M:%S ", tm
);
172 dstr_vputf(&d
, p
, ap
);
175 if (flags
& F_SYSLOG
)
176 syslog(LOG_NOTICE
, "%s", d
.buf
);
179 dstr_write(&d
, stderr
);
184 /*----- Passphrase management ---------------------------------------------*/
186 /* --- Data structures --- */
188 typedef struct phrase
{
198 /* --- Variables --- */
200 #define P_ROOT ((phrase *)&p_root)
201 static struct { phrase
*next
; phrase
*prev
; } p_root
= { P_ROOT
, P_ROOT
};
203 /* --- @p_free@ --- *
205 * Arguments: @phrase *p@ = pointer to phrase block
209 * Use: Frees a phrase block.
212 static void p_free(phrase
*p
)
215 sel_rmtimer(&p
->timer
);
218 p
->next
->prev
= p
->prev
;
219 p
->prev
->next
= p
->next
;
223 /* --- @p_timer@ --- *
225 * Arguments: @struct timeval *tv@ = current time
226 * @void *p@ = pointer to phrase
230 * Use: Expires a passphrase.
233 static void p_timer(struct timeval
*tv
, void *p
)
237 log("expiring passphrase `%s'", pp
->tag
);
241 /* --- @p_alloc@ --- *
243 * Arguments: @size_t sz@ = amount of memory required
245 * Returns: Pointer to allocated memory, or null.
247 * Use: Allocates some locked memory, flushing old passphrases if
248 * there's not enough space.
251 static void *p_alloc(size_t sz
)
255 if ((p
= l_alloc(&lm
, sz
)) != 0)
257 if (P_ROOT
->next
== P_ROOT
)
260 log("flushing passphrase `%s' to free up needed space",
263 p_free(P_ROOT
->next
);
267 /* --- @p_find@ --- *
269 * Arguments: @const char *tag@ = pointer to tag to find
271 * Returns: Pointer to passphrase block, or null.
273 * Use: Finds a passphrase with a given tag.
276 static phrase
*p_find(const char *tag
)
280 for (p
= P_ROOT
->next
; p
!= P_ROOT
; p
= p
->next
) {
281 if (strcmp(p
->tag
, tag
) == 0) {
284 sel_rmtimer(&p
->timer
);
285 gettimeofday(&tv
, 0);
287 sel_addtimer(&sel
, &p
->timer
, &tv
, p_timer
, p
);
289 p
->next
->prev
= p
->prev
;
290 p
->prev
->next
= p
->next
;
292 p
->prev
= P_ROOT
->prev
;
293 P_ROOT
->prev
->next
= p
;
303 * Arguments: @const char *tag@ = pointer to tag string
304 * @const char *p@ = pointer to passphrase
305 * @unsigned long t@ = expiry timeout
307 * Returns: Pointer to newly-added passphrase.
309 * Use: Adds a new passphrase. The tag must not already exist.
312 static phrase
*p_add(const char *tag
, const char *p
, unsigned long t
)
314 size_t sz
= strlen(p
) + 1;
315 char *l
= p_alloc(sz
);
318 /* --- Make sure the locked memory was allocated --- */
323 /* --- Fill in some other bits of the block --- */
328 pp
->tag
= xstrdup(tag
);
331 /* --- Set the timer --- */
336 gettimeofday(&tv
, 0);
338 sel_addtimer(&sel
, &pp
->timer
, &tv
, p_timer
, pp
);
341 /* --- Link the block into the chain --- */
344 pp
->prev
= P_ROOT
->prev
;
345 P_ROOT
->prev
->next
= pp
;
350 /* --- @p_flush@ --- *
352 * Arguments: @const char *tag@ = pointer to tag string, or zero for all
356 * Use: Immediately flushes either a single phrase or all of them.
359 static void p_flush(const char *tag
)
363 if (!tag
&& verbose
> 1)
364 log("flushing all passphrases");
366 while (p
!= P_ROOT
) {
367 phrase
*pp
= p
->next
;
370 else if (strcmp(p
->tag
, tag
) == 0) {
372 log("flushing passphrase `%s'", tag
);
380 /*----- Reading passphrases -----------------------------------------------*/
382 /* --- @p_request@ --- *
384 * Arguments: @const char *msg@ = message string
385 * @const char *tag@ = pointer to tag string
386 * @char *buf@ = pointer to (locked) buffer
387 * @size_t sz@ = size of buffer
389 * Returns: Zero if all went well, nonzero otherwise.
391 * Use: Requests a passphrase from the user.
394 static int p_request(const char *msg
, const char *tag
, char *buf
, size_t sz
)
396 /* --- If there's a passphrase-fetching command, run it --- */
406 /* --- Substitute the prompt string into the command --- */
410 const char *q
= strchr(p
, '%');
433 /* --- Create a pipe and start a child process --- */
437 if ((kid
= fork()) < 0)
440 /* --- Child process --- */
444 if (dup2(fd
[1], STDOUT_FILENO
) < 0)
447 execl("/bin/sh", "sh", "-c", d
.buf
, (void *)0);
451 /* --- Read the data back into my buffer --- */
454 if ((r
= read(fd
[0], buf
, sz
- 1)) >= 0) {
455 char *q
= memchr(buf
, '\n', r
);
461 waitpid(kid
, &rc
, 0);
463 if (r
< 0 || rc
!= 0)
467 /* --- Tidy up when things go wrong --- */
478 /* --- Read a passphrase from the terminal --- *
480 * Use the standard Catacomb passphrase-reading function, so it'll read the
481 * passphrase from a file descriptor or something if the appropriate
482 * environment variable is set.
488 dstr_putf(&d
, "%s %s: ", msg
, tag
);
489 rc
= pixie_getpass(d
.buf
, buf
, sz
);
496 /* --- Sort out the buffer --- *
498 * Strip leading spaces.
504 while (isspace((unsigned char)*p
))
507 memmove(buf
, p
, len
);
518 * Arguments: @const char **q@ = where to store the result
519 * @const char *tag@ = pointer to tag string
520 * @unsigned mode@ = reading mode (verify?)
521 * @time_t exp@ = expiry time suggestion
523 * Returns: Zero if successful, @-1@ on a read failure, or @+1@ if the
524 * passphrase is missing and there is no fetcher. (This will
525 * always happen if there is no fetcher and @mode@ is
528 * Use: Reads a passphrase from somewhere.
531 static int p_get(const char **q
, const char *tag
, unsigned mode
, time_t exp
)
538 /* --- Write a log message --- */
541 log("passphrase `%s' requested", tag
);
543 /* --- If there is no fetcher, life is simpler --- */
545 if (!(flags
& F_FETCH
)) {
546 if (mode
== PMODE_VERIFY
)
548 if ((p
= p_find(tag
)) == 0)
554 /* --- Try to find the phrase --- */
556 if (mode
== PMODE_VERIFY
)
558 if (mode
== PMODE_VERIFY
|| (p
= p_find(tag
)) == 0) {
559 if ((pp
= p_alloc(LBUFSZ
)) == 0)
561 if (p_request(mode
== PMODE_READ ?
"Passphrase" : "New passphrase",
562 tag
, pp
, LBUFSZ
) < 0)
564 p
= p_add(tag
, pp
, exp
);
569 /* --- If verification is requested, verify the passphrase --- */
571 if (mode
== PMODE_VERIFY
) {
572 if (!pp
&& (pp
= p_alloc(LBUFSZ
)) == 0)
574 if (p_request("Verify passphrase", tag
, pp
, LBUFSZ
) < 0)
576 if (strcmp(pp
, p
->p
) != 0) {
578 log("passphrases for `%s' don't match", tag
);
584 /* --- Tidy up and return the passphrase --- */
587 memset(pp
, 0, LBUFSZ
);
593 /* --- Tidy up if things went wrong --- */
597 memset(pp
, 0, LBUFSZ
);
605 /*----- Server command parsing --------------------------------------------*/
607 /* --- Data structures --- */
609 typedef struct pixserv
{
618 #define PIXSERV_TIMEOUT 30
620 /* --- @pixserv_expire@ --- *
622 * Arguments: @struct timeval *tv@ = pointer to current time
623 * @void *p@ = pointer to server block
627 * Use: Expires a pixie connection if the remote end decides he's not
628 * interested any more.
631 static void pixserv_expire(struct timeval
*tv
, void *p
)
634 if (px
->fd
!= px
->b
.reader
.fd
)
636 selbuf_destroy(&px
->b
);
637 close(px
->b
.reader
.fd
);
641 /* --- @pixserv_write@ --- *
643 * Arguments: @pixserv *px@ = pointer to server block
644 * @const char *p@ = pointer to skeleton string
645 * @...@ = other arguments to fill in
649 * Use: Formats a string and emits it to the output file.
652 static void pixserv_write(pixserv
*px
, const char *p
, ...)
658 dstr_vputf(&d
, p
, ap
);
659 write(px
->fd
, d
.buf
, d
.len
);
664 /* --- @pixserv_timeout@ --- *
666 * Arguments: @const char *p@ = pointer to timeout string
668 * Returns: Timeout in seconds.
670 * Use: Translates a string to a timeout value in seconds.
673 static unsigned long pixserv_timeout(const char *p
)
681 t
= strtoul(p
, &q
, 0);
686 case 's': if (q
[1] != 0)
693 /* --- @pixserv_line@ --- *
695 * Arguments: @char *s@ = pointer to the line read
696 * @void *p@ = pointer to server block
700 * Use: Handles a line read from the client.
703 static void pixserv_line(char *s
, void *p
)
709 /* --- Handle an end-of-file --- */
711 if (!(px
->f
& px_stdin
))
712 sel_rmtimer(&px
->timer
);
714 if (px
->fd
!= px
->b
.reader
.fd
)
716 selbuf_destroy(&px
->b
);
717 close(px
->b
.reader
.fd
);
721 /* --- Fiddle the timeout --- */
723 if (!(px
->f
& px_stdin
)) {
725 gettimeofday(&tv
, 0);
726 tv
.tv_sec
+= PIXSERV_TIMEOUT
;
727 sel_addtimer(&sel
, &px
->timer
, &tv
, pixserv_expire
, px
);
730 /* --- Scan out the first word --- */
732 if ((q
= str_getword(&s
)) == 0)
734 for (qq
= q
; *qq
; qq
++)
735 *qq
= tolower((unsigned char)*qq
);
737 /* --- Handle a help request --- */
739 if (strcmp(q
, "help") == 0) {
741 INFO Commands supported:\n\
744 INFO PASS tag [expire]\n\
745 INFO VERIFY tag [expire]\n\
747 INFO SET tag [expire] -- phrase\n\
753 /* --- List the passphrases --- */
755 else if (strcmp(q
, "list") == 0) {
758 for (p
= P_ROOT
->next
; p
!= P_ROOT
; p
= p
->next
) {
760 pixserv_write(px
, "ITEM %s no-expire\n", p
->tag
);
763 gettimeofday(&tv
, 0);
764 TV_SUB(&tv
, &p
->timer
.tv
, &tv
);
765 pixserv_write(px
, "ITEM %s %i\n", p
->tag
, tv
.tv_sec
);
768 pixserv_write(px
, "OK\n");
771 /* --- Request a passphrase --- */
773 else if ((mode
= PMODE_READ
, strcmp(q
, "pass") == 0) ||
774 (mode
= PMODE_VERIFY
, strcmp(q
, "verify") == 0)) {
779 if ((q
= str_getword(&s
)) == 0)
780 pixserv_write(px
, "FAIL missing tag\n");
781 else if ((t
= pixserv_timeout(s
)) == 0)
782 pixserv_write(px
, "FAIL bad timeout\n");
784 rc
= p_get(&p
, q
, mode
, t
> timeout ? timeout
: t
);
787 pixserv_write(px
, "OK %s\n", p
);
790 pixserv_write(px
, "FAIL error reading passphrase\n");
793 pixserv_write(px
, "MISSING\n");
799 /* --- Flush existing passphrases --- */
801 else if (strcmp(q
, "flush") == 0) {
804 pixserv_write(px
, "OK\n");
807 /* --- Set a passphrase --- */
809 else if (strcmp(q
, "set") == 0) {
812 if ((tag
= str_getword(&s
)) == 0)
813 pixserv_write(px
, "FAIL missing tag\n");
814 else if ((q
= str_getword(&s
)) == 0)
815 pixserv_write(px
, "FAIL no passphrase\n");
817 if (strcmp(q
, "--") != 0) {
818 t
= pixserv_timeout(q
);
821 t
= pixserv_timeout(0);
823 pixserv_write(px
, "FAIL no passphrase\n");
824 else if (strcmp(q
, "--") != 0)
825 pixserv_write(px
, "FAIL rubbish found before passphrase\n");
829 pixserv_write(px
, "OK\n");
834 /* --- Shut the server down --- */
836 else if (strcmp(q
, "quit") == 0) {
838 log("%s client requested shutdown",
839 px
->f
& px_stdin ?
"local" : "remote");
840 pixserv_write(px
, "OK\n");
844 /* --- Report an error for other commands --- */
847 pixserv_write(px
, "FAIL unknown command `%s'\n", q
);
850 /* --- @pixserv_create@ --- *
852 * Arguments: @int fd@ = file descriptor to read from
853 * @int ofd@ = file descriptor to write to
855 * Returns: Pointer to the new connection.
857 * Use: Creates a new Pixie server instance for a new connection.
860 static pixserv
*pixserv_create(int fd
, int ofd
)
862 pixserv
*px
= CREATE(pixserv
);
864 fdflags(fd
, O_NONBLOCK
, O_NONBLOCK
, FD_CLOEXEC
, FD_CLOEXEC
);
866 fdflags(ofd
, O_NONBLOCK
, O_NONBLOCK
, FD_CLOEXEC
, FD_CLOEXEC
);
868 selbuf_init(&px
->b
, &sel
, fd
, pixserv_line
, px
);
869 px
->b
.b
.a
= arena_secure
;
870 selbuf_setsize(&px
->b
, 1024);
871 gettimeofday(&tv
, 0);
872 tv
.tv_sec
+= PIXSERV_TIMEOUT
;
873 sel_addtimer(&sel
, &px
->timer
, &tv
, pixserv_expire
, px
);
878 /* --- @pixserv_accept@ --- *
880 * Arguments: @int fd@ = file descriptor
881 * @unsigned mode@ = what's happened
882 * @void *p@ = an uninteresting argument
886 * Use: Accepts a new connection.
889 static void pixserv_accept(int fd
, unsigned mode
, void *p
)
892 struct sockaddr_un sun
;
893 size_t sunsz
= sizeof(sun
);
895 if (mode
!= SEL_READ
)
897 if ((nfd
= accept(fd
, (struct sockaddr
*)&sun
, &sunsz
)) < 0) {
899 log("new connection failed: %s", strerror(errno
));
902 pixserv_create(nfd
, nfd
);
905 /*----- Setting up the server ---------------------------------------------*/
907 /* --- @unlinksocket@ --- *
913 * Use: Tidies up the socket when it's finished with.
916 static char *sockpath
;
918 static void unlinksocket(void)
924 /* --- @pix_sigdie@ --- *
926 * Arguments: @int sig@ = signal number
927 * @void *p@ = uninteresting argument
931 * Use: Shuts down the program after a fatal signal.
934 static void pix_sigdie(int sig
, void *p
)
941 case SIGTERM
: p
= "SIGTERM"; break;
942 case SIGINT
: p
= "SIGINT"; break;
944 sprintf(buf
, "signal %i", sig
);
948 log("shutting down on %s", p
);
953 /* --- @pix_sigflush@ --- *
955 * Arguments: @int sig@ = signal number
956 * @void *p@ = uninteresting argument
960 * Use: Flushes the passphrase cache on receipt of a signal.
963 static void pix_sigflush(int sig
, void *p
)
970 case SIGHUP
: p
= "SIGHUP"; break;
971 case SIGQUIT
: p
= "SIGQUIT"; break;
973 sprintf(buf
, "signal %i", sig
);
977 log("received %s; flushing passphrases", p
);
982 /* --- @pix_setup@ --- *
984 * Arguments: @struct sockaddr_un *sun@ = pointer to address to use
985 * @size_t sz@ = size of socket address
989 * Use: Sets up the pixie's Unix-domain socket.
992 static void pix_setup(struct sockaddr_un
*sun
, size_t sz
)
996 /* --- Set up the parent directory --- */
999 char *p
= sun
->sun_path
;
1000 char *q
= strrchr(p
, '/');
1006 DPUTM(&d
, p
, q
- p
);
1010 if (stat(d
.buf
, &st
))
1011 die(1, "couldn't stat `%s': %s", d
.buf
, strerror(errno
));
1012 if (!S_ISDIR(st
.st_mode
))
1013 die(1, "object `%s' isn't a directory", d
.buf
);
1014 if (st
.st_mode
& 0077)
1015 die(1, "parent directory `%s' has group or world access", d
.buf
);
1020 /* --- Initialize the socket --- */
1028 if ((fd
= socket(PF_UNIX
, SOCK_STREAM
, 0)) < 0)
1029 die(1, "couldn't create socket: %s", strerror(errno
));
1030 if (bind(fd
, (struct sockaddr
*)sun
, sz
) < 0) {
1032 if (errno
!= EADDRINUSE
)
1033 die(1, "couldn't bind to address: %s", strerror(e
));
1035 die(1, "too many retries; giving up");
1037 if (connect(fd
, (struct sockaddr
*)sun
, sz
)) {
1039 if (errno
!= ECONNREFUSED
)
1040 die(1, "couldn't bind to address: %s", strerror(e
));
1041 if (stat(sun
->sun_path
, &st
))
1042 die(1, "couldn't stat `%s': %s", sun
->sun_path
, strerror(errno
));
1043 if (!S_ISSOCK(st
.st_mode
))
1044 die(1, "object `%s' isn't a socket", sun
->sun_path
);
1046 log("stale socket found; removing it");
1047 unlink(sun
->sun_path
);
1051 log("server already running; shutting it down");
1052 write(fd
, "QUIT\n", 5);
1058 chmod(sun
->sun_path
, 0600);
1059 fdflags(fd
, O_NONBLOCK
, O_NONBLOCK
, FD_CLOEXEC
, FD_CLOEXEC
);
1061 die(1, "couldn't listen on socket: %s", strerror(errno
));
1064 /* --- Set up the rest of the server --- */
1067 static sel_file serv
;
1068 sockpath
= sun
->sun_path
;
1069 atexit(unlinksocket
);
1070 sel_initfile(&sel
, &serv
, fd
, SEL_READ
, pixserv_accept
, 0);
1075 /*----- Client support code -----------------------------------------------*/
1077 /* --- Variables --- */
1079 static selbuf c_server
, c_client
;
1080 static unsigned c_flags
= 0;
1082 #define cf_uclose 1u
1083 #define cf_sclose 2u
1085 /* --- Line handler functions --- */
1087 static void c_uline(char *s
, void *p
)
1091 selbuf_destroy(&c_client
);
1092 shutdown(c_server
.reader
.fd
, 1);
1093 c_flags
|= cf_uclose
;
1097 write(c_server
.reader
.fd
, s
, sz
);
1101 static void c_sline(char *s
, void *p
)
1104 selbuf_destroy(&c_server
);
1105 if (!(c_flags
& cf_uclose
)) {
1106 moan("server closed the connection");
1107 selbuf_destroy(&c_client
);
1114 /* --- @pix_client@ --- *
1116 * Arguments: @struct sockaddr_un *sun@ = pointer to socket address
1117 * @size_t sz@ = size of socket address
1118 * @char *argv[]@ = pointer to arguments to send
1122 * Use: Performs client-side actions for the passphrase pixie.
1125 static void pix_client(struct sockaddr_un
*sun
, size_t sz
, char *argv
[])
1129 /* --- Dispose of locked memory --- */
1133 /* --- Open the socket --- */
1135 if ((fd
= socket(PF_UNIX
, SOCK_STREAM
, 0)) < 0)
1136 die(1, "couldn't create socket: %s", strerror(errno
));
1137 if (connect(fd
, (struct sockaddr
*)sun
, sz
))
1138 die(1, "couldn't connect to server: %s", strerror(errno
));
1139 selbuf_init(&c_server
, &sel
, fd
, c_sline
, 0);
1141 /* --- If there are any arguments, turn them into a string --- */
1144 selbuf_init(&c_client
, &sel
, STDIN_FILENO
, c_uline
, 0);
1153 write(fd
, d
.buf
, d
.len
);
1155 c_flags
|= cf_uclose
;
1159 /* --- And repeat --- */
1162 if (sel_select(&sel
))
1163 die(EXIT_FAILURE
, "select error: %s", strerror(errno
));
1167 /*----- Main code ---------------------------------------------------------*/
1169 /* --- @help@, @version@, @usage@ --- *
1171 * Arguments: @FILE *fp@ = stream to write on
1175 * Use: Emit helpful messages.
1178 static void usage(FILE *fp
)
1182 $ [-qvfidl] [-c command] [-t timeout] [-s socket]\n\
1183 $ [-s socket] -C [command args...]\n\
1187 static void version(FILE *fp
)
1189 pquis(fp
, "$, Catacomb version " VERSION
"\n");
1192 static void help(FILE *fp
)
1198 The Catacomb passphrase pixie collects and caches passphrases used to\n\
1199 protect important keys. Options provided:\n\
1201 -h, --help Show this help text.\n\
1202 -V, --version Show the program's version number.\n\
1203 -u, --usage Show a (very) terse usage summary.\n\
1205 -C, --client Connect to a running pixie as a client.\n\
1207 -q, --quiet Emit fewer log messages.\n\
1208 -v, --version Emit more log messages.\n\
1209 -s, --socket=FILE Name the pixie's socket.\n\
1210 -c, --command=COMMAND Shell command to read a passphrase.\n\
1211 -f, --fetch Fetch passphrases from the terminal.\n\
1212 -t, --timeout=TIMEOUT Length of time to retain a passphrase in memory.\n\
1213 -i, --interactive Allow commands to be typed interactively.\n\
1214 -d, --daemon Fork into the background after initialization.\n\
1215 -l, --syslog Emit log messages to the system log.\n\
1217 The COMMAND may contain `%m' and `%t' markers which are replaced by a\n\
1218 prompt message and the passphrase tag respectively. The TIMEOUT is an\n\
1219 integer, optionally followed by `d', `h', `m' or `s' to specify units of\n\
1220 days, hours, minutes or seconds respectively.\n\
1222 In client mode, if a command is specified on the command line, it is sent\n\
1223 to the running server; otherwise the program reads requests from stdin.\n\
1224 Responses from the pixie are written to stdout. Send a HELP request for\n\
1225 a quick summary of the pixie communication protocol.\n\
1231 * Arguments: @int argc@ = number of arguments
1232 * @char *argv[]@ = vector of argument values
1234 * Returns: Zero if OK.
1236 * Use: Main program. Listens on a socket and responds with a PGP
1237 * passphrase when asked.
1240 int main(int argc
, char *argv
[])
1243 struct sockaddr_un
*sun
;
1251 #define f_syslog 16u
1253 /* --- Initialize libraries --- */
1258 /* --- Set up the locked memory area --- */
1263 /* --- Parse command line arguments --- */
1266 static struct option opts
[] = {
1268 /* --- Standard GNUy help options --- */
1270 { "help", 0, 0, 'h' },
1271 { "version", 0, 0, 'V' },
1272 { "usage", 0, 0, 'u' },
1274 /* --- Other options --- */
1276 { "quiet", 0, 0, 'q' },
1277 { "verbose", 0, 0, 'v' },
1278 { "client", 0, 0, 'C' },
1279 { "socket", OPTF_ARGREQ
, 0, 's' },
1280 { "command", OPTF_ARGREQ
, 0, 'c' },
1281 { "fetch", 0, 0, 'f' },
1282 { "timeout", OPTF_ARGREQ
, 0, 't' },
1283 { "interactive", 0, 0, 'i' },
1284 { "stdin", 0, 0, 'i' },
1285 { "daemon", 0, 0, 'd' },
1286 { "log", 0, 0, 'l' },
1287 { "syslog", 0, 0, 'l' },
1289 /* --- Magic terminator --- */
1294 int i
= mdwopt(argc
, argv
, "hVuqvCs:c:ft:idl", opts
, 0, 0, 0);
1300 /* --- GNUy help options --- */
1312 /* --- Other interesting things --- */
1328 if ((timeout
= pixserv_timeout(optarg
)) == 0)
1329 die(1, "bad timeout `%s'", optarg
);
1348 /* --- Something else --- */
1356 if (f
& f_bogus
|| (optind
< argc
&& !(f
& f_client
))) {
1361 /* --- Set up the socket address --- */
1363 sun
= pixie_address(path
, &sz
);
1365 /* --- Initialize selectory --- */
1368 signal(SIGPIPE
, SIG_IGN
);
1370 /* --- Be a client if a client's wanted --- */
1373 pix_client(sun
, sz
, argv
+ optind
);
1375 /* --- Open the syslog if requested --- */
1379 openlog(QUIS
, 0, LOG_DAEMON
);
1382 /* --- Check on the locked memory area --- */
1386 int rc
= l_report(&lm
, &d
);
1388 die(EXIT_FAILURE
, d
.buf
);
1389 else if (rc
&& verbose
) {
1391 log("couldn't lock passphrase buffer");
1394 arena_setsecure(&lm
.a
);
1397 /* --- Set signal behaviours --- */
1400 static sig sigint
, sigterm
, sigquit
, sighup
;
1401 struct sigaction sa
;
1403 sigaction(SIGINT
, 0, &sa
);
1404 if (sa
.sa_handler
!= SIG_IGN
)
1405 sig_add(&sigint
, SIGINT
, pix_sigdie
, 0);
1406 sig_add(&sigterm
, SIGTERM
, pix_sigdie
, 0);
1407 sig_add(&sigquit
, SIGQUIT
, pix_sigflush
, 0);
1408 sig_add(&sighup
, SIGHUP
, pix_sigflush
, 0);
1411 /* --- Set up the server --- */
1415 pixserv
*px
= pixserv_create(STDIN_FILENO
, STDOUT_FILENO
);
1416 sel_rmtimer(&px
->timer
);
1420 /* --- Fork into the background if requested --- */
1425 if (((f
& f_stdin
) &&
1426 (isatty(STDIN_FILENO
) || isatty(STDOUT_FILENO
))) ||
1427 (!command
&& (flags
& F_FETCH
)))
1428 die(1, "can't become a daemon if terminal required");
1430 if ((kid
= fork()) < 0)
1431 die(1, "fork failed: %s", strerror(errno
));
1437 if ((fd
= open("/dev/tty", O_RDONLY
)) >= 0) {
1438 ioctl(fd
, TIOCNOTTY
);
1451 log("initialized ok");
1456 if (!sel_select(&sel
))
1458 else if (errno
!= EINTR
&& errno
!= EAGAIN
) {
1459 log("error from select: %s", strerror(errno
));
1462 log("too many consecutive select errors: bailing out");
1471 /*----- That's all, folks -------------------------------------------------*/