2 * Unix Pageant, more or less similar to ssh-agent.
12 #include <sys/types.h>
17 #define PUTTY_DO_GLOBALS /* actually _define_ globals */
23 SockAddr unix_sock_addr(const char *path);
24 Socket new_unix_listener(SockAddr listenaddr, Plug plug);
26 void fatalbox(char *p, ...)
29 fprintf(stderr, "FATAL ERROR: ");
31 vfprintf(stderr, p, ap);
36 void modalfatalbox(char *p, ...)
39 fprintf(stderr, "FATAL ERROR: ");
41 vfprintf(stderr, p, ap);
46 void nonfatal(char *p, ...)
49 fprintf(stderr, "ERROR: ");
51 vfprintf(stderr, p, ap);
55 void connection_fatal(void *frontend, char *p, ...)
58 fprintf(stderr, "FATAL ERROR: ");
60 vfprintf(stderr, p, ap);
65 void cmdline_error(char *p, ...)
68 fprintf(stderr, "pageant: ");
70 vfprintf(stderr, p, ap);
76 FILE *pageant_logfp = NULL;
77 void pageant_log(void *ctx, const char *fmt, va_list ap)
82 fprintf(pageant_logfp, "pageant: ");
83 vfprintf(pageant_logfp, fmt, ap);
84 fprintf(pageant_logfp, "\n");
88 * In Pageant our selects are synchronous, so these functions are
91 int uxsel_input_add(int fd, int rwx) { return 0; }
92 void uxsel_input_remove(int id) { }
97 void random_save_seed(void) {}
98 void random_destroy_seed(void) {}
99 void noise_ultralight(unsigned long data) {}
100 char *platform_default_s(const char *name) { return NULL; }
101 int platform_default_i(const char *name, int def) { return def; }
102 FontSpec *platform_default_fontspec(const char *name) { return fontspec_new(""); }
103 Filename *platform_default_filename(const char *name) { return filename_from_str(""); }
104 char *x_get_default(const char *key) { return NULL; }
105 void log_eventlog(void *handle, const char *event) {}
108 * Short description of parameters.
110 static void usage(void)
112 printf("Pageant: SSH agent\n");
118 static void version(void)
120 printf("pageant: %s\n", ver);
124 void keylist_update(void)
126 /* Nothing needs doing in Unix Pageant */
129 #define PAGEANT_DIR_PREFIX "/tmp/pageant"
131 const char *const appname = "Pageant";
133 static int time_to_die = FALSE;
135 /* Stub functions to permit linking against x11fwd.c. These never get
136 * used, because in LIFE_X11 mode we connect to the X server using a
137 * straightforward Socket and don't try to create an ersatz SSH
139 int sshfwd_write(struct ssh_channel *c, char *data, int len) { return 0; }
140 void sshfwd_write_eof(struct ssh_channel *c) { }
141 void sshfwd_unclean_close(struct ssh_channel *c, const char *err) { }
142 void sshfwd_unthrottle(struct ssh_channel *c, int bufsize) {}
143 Conf *sshfwd_get_conf(struct ssh_channel *c) { return NULL; }
144 void sshfwd_x11_sharing_handover(struct ssh_channel *c,
145 void *share_cs, void *share_chan,
146 const char *peer_addr, int peer_port,
147 int endian, int protomajor, int protominor,
148 const void *initial_data, int initial_len) {}
149 void sshfwd_x11_is_local(struct ssh_channel *c) {}
152 * These functions are part of the plug for our connection to the X
153 * display, so they do get called. They needn't actually do anything,
154 * except that x11_closing has to signal back to the main loop that
155 * it's time to terminate.
157 static void x11_log(Plug p, int type, SockAddr addr, int port,
158 const char *error_msg, int error_code) {}
159 static int x11_receive(Plug plug, int urgent, char *data, int len) {return 0;}
160 static void x11_sent(Plug plug, int bufsize) {}
161 static int x11_closing(Plug plug, const char *error_msg, int error_code,
167 struct X11Connection {
168 const struct plug_function_table *fn;
172 void pageant_print_env(int pid)
174 printf("SSH_AUTH_SOCK=%s; export SSH_AUTH_SOCK;\n"
175 "SSH_AGENT_PID=%d; export SSH_AGENT_PID;\n",
176 socketname, (int)pid);
179 void pageant_fork_and_print_env(int retain_tty)
185 } else if (pid != 0) {
186 pageant_print_env(pid);
191 * Having forked off, we now daemonise ourselves as best we can.
192 * It's good practice in general to setsid() ourself out of any
193 * process group we didn't want to be part of, and to chdir("/")
194 * to avoid holding any directories open that we don't need in
195 * case someone wants to umount them; also, we should definitely
196 * close standard output (because it will very likely be pointing
197 * at a pipe from which some parent process is trying to read our
198 * environment variable dump, so if we hold open another copy of
199 * it then that process will never finish reading). We close
200 * standard input too on general principles, but not standard
201 * error, since we might need to shout a panicky error message
204 if (chdir("/") < 0) {
205 /* should there be an error condition, nothing we can do about
211 /* Get out of our previous process group, to avoid being
212 * blasted by passing signals. But keep our controlling tty,
213 * so we can keep checking to see if we still have one. */
216 /* Do that, but also leave our entire session and detach from
217 * the controlling tty (if any). */
224 void sigchld(int signum)
226 if (write(signalpipe[1], "x", 1) <= 0)
227 /* not much we can do about it */;
230 #define TTY_LIFE_POLL_INTERVAL (TICKSPERSEC * 30)
231 void *dummy_timer_ctx;
232 static void tty_life_timer(void *ctx, unsigned long now)
234 schedule_timer(TTY_LIFE_POLL_INTERVAL, tty_life_timer, &dummy_timer_ctx);
241 KEYACT_CLIENT_DEL_ALL,
243 KEYACT_CLIENT_PUBLIC_OPENSSH,
246 struct cmdline_key_action {
247 struct cmdline_key_action *next;
249 const char *filename;
252 int is_agent_action(keyact action)
254 return action == KEYACT_AGENT_LOAD;
257 struct cmdline_key_action *keyact_head = NULL, *keyact_tail = NULL;
259 void add_keyact(keyact action, const char *filename)
261 struct cmdline_key_action *a = snew(struct cmdline_key_action);
263 a->filename = filename;
266 keyact_tail->next = a;
272 char **exec_args = NULL;
274 LIFE_UNSPEC, LIFE_X11, LIFE_TTY, LIFE_DEBUG, LIFE_PERM, LIFE_EXEC
275 } life = LIFE_UNSPEC;
276 const char *display = NULL;
278 static char *askpass(const char *comment)
280 prompts_t *p = new_prompts(NULL);
284 * FIXME: if we don't have a terminal, and have to do this by X11,
285 * there's a big missing piece.
288 p->to_server = FALSE;
289 p->name = dupstr("Pageant passphrase prompt");
291 dupprintf("Enter passphrase to load key '%s': ", comment),
293 ret = console_get_userpass_input(p, NULL, 0);
297 perror("pageant: unable to read passphrase");
301 char *passphrase = dupstr(p->prompts[0]->result);
307 static int unix_add_keyfile(const char *filename_str)
309 Filename *filename = filename_from_str(filename_str);
316 * Try without a passphrase.
318 status = pageant_add_keyfile(filename, NULL, &err);
319 if (status == PAGEANT_ACTION_OK) {
321 } else if (status == PAGEANT_ACTION_FAILURE) {
322 fprintf(stderr, "pageant: %s: %s\n", filename_str, err);
329 * And now try prompting for a passphrase.
332 char *passphrase = askpass(err);
337 status = pageant_add_keyfile(filename, passphrase, &err);
339 smemclr(passphrase, strlen(passphrase));
343 if (status == PAGEANT_ACTION_OK) {
345 } else if (status == PAGEANT_ACTION_FAILURE) {
346 fprintf(stderr, "pageant: %s: %s\n", filename_str, err);
355 filename_free(filename);
359 void key_list_callback(void *ctx, const char *fingerprint,
360 const char *comment, struct pageant_pubkey *key)
362 printf("%s %s\n", fingerprint, comment);
365 struct key_find_ctx {
367 int match_fp, match_comment;
368 struct pageant_pubkey *found;
372 int match_fingerprint_string(const char *string, const char *fingerprint)
376 /* Find the hash in the fingerprint string. It'll be the word at the end. */
377 hash = strrchr(fingerprint, ' ');
381 /* Now see if the search string is a prefix of the full hash,
382 * neglecting colons and case differences. */
384 while (*string == ':') string++;
385 while (*hash == ':') hash++;
388 if (tolower((unsigned char)*string) != tolower((unsigned char)*hash))
395 void key_find_callback(void *vctx, const char *fingerprint,
396 const char *comment, struct pageant_pubkey *key)
398 struct key_find_ctx *ctx = (struct key_find_ctx *)vctx;
400 if ((ctx->match_comment && !strcmp(ctx->string, comment)) ||
401 (ctx->match_fp && match_fingerprint_string(ctx->string, fingerprint)))
404 ctx->found = pageant_pubkey_copy(key);
409 struct pageant_pubkey *find_key(const char *string, char **retstr)
411 struct key_find_ctx actx, *ctx = &actx;
412 struct pageant_pubkey key_in, *key_ret;
413 int try_file = TRUE, try_fp = TRUE, try_comment = TRUE;
414 int file_errors = FALSE;
417 * Trim off disambiguating prefixes telling us how to interpret
418 * the provided string.
420 if (!strncmp(string, "file:", 5)) {
422 try_fp = try_comment = FALSE;
423 file_errors = TRUE; /* also report failure to load the file */
424 } else if (!strncmp(string, "comment:", 8)) {
426 try_file = try_fp = FALSE;
427 } else if (!strncmp(string, "fp:", 3)) {
429 try_file = try_comment = FALSE;
430 } else if (!strncmp(string, "fingerprint:", 12)) {
432 try_file = try_comment = FALSE;
436 * Try interpreting the string as a key file name.
439 Filename *fn = filename_from_str(string);
440 int keytype = key_type(fn);
441 if (keytype == SSH_KEYTYPE_SSH1 ||
442 keytype == SSH_KEYTYPE_SSH1_PUBLIC) {
445 if (!rsakey_pubblob(fn, &key_in.blob, &key_in.bloblen,
448 *retstr = dupprintf("unable to load file '%s': %s",
456 * If we've successfully loaded the file, stop here - we
457 * already have a key blob and need not go to the agent to
460 key_in.ssh_version = 1;
461 key_ret = pageant_pubkey_copy(&key_in);
465 } else if (keytype == SSH_KEYTYPE_SSH2 ||
466 keytype == SSH_KEYTYPE_SSH2_PUBLIC_RFC4716 ||
467 keytype == SSH_KEYTYPE_SSH2_PUBLIC_OPENSSH) {
470 if ((key_in.blob = ssh2_userkey_loadpub(fn, NULL,
472 NULL, &error)) == NULL) {
474 *retstr = dupprintf("unable to load file '%s': %s",
482 * If we've successfully loaded the file, stop here - we
483 * already have a key blob and need not go to the agent to
486 key_in.ssh_version = 2;
487 key_ret = pageant_pubkey_copy(&key_in);
493 *retstr = dupprintf("unable to load key file '%s': %s",
494 string, key_type_to_str(keytype));
503 * Failing that, go through the keys in the agent, and match
504 * against fingerprints and comments as appropriate.
506 ctx->string = string;
507 ctx->match_fp = try_fp;
508 ctx->match_comment = try_comment;
511 if (pageant_enum_keys(key_find_callback, ctx, retstr) ==
512 PAGEANT_ACTION_FAILURE)
515 if (ctx->nfound == 0) {
516 *retstr = dupstr("no key matched");
519 } else if (ctx->nfound > 1) {
520 *retstr = dupstr("multiple keys matched");
522 pageant_pubkey_free(ctx->found);
530 void run_client(void)
532 const struct cmdline_key_action *act;
533 struct pageant_pubkey *key;
537 if (!agent_exists()) {
538 fprintf(stderr, "pageant: no agent running to talk to\n");
542 for (act = keyact_head; act; act = act->next) {
543 switch (act->action) {
544 case KEYACT_CLIENT_ADD:
545 if (!unix_add_keyfile(act->filename))
548 case KEYACT_CLIENT_LIST:
549 if (pageant_enum_keys(key_list_callback, NULL, &retstr) ==
550 PAGEANT_ACTION_FAILURE) {
551 fprintf(stderr, "pageant: listing keys: %s\n", retstr);
556 case KEYACT_CLIENT_DEL:
558 if (!(key = find_key(act->filename, &retstr)) ||
559 pageant_delete_key(key, &retstr) == PAGEANT_ACTION_FAILURE) {
560 fprintf(stderr, "pageant: deleting key '%s': %s\n",
561 act->filename, retstr);
566 pageant_pubkey_free(key);
568 case KEYACT_CLIENT_PUBLIC_OPENSSH:
569 case KEYACT_CLIENT_PUBLIC:
571 if (!(key = find_key(act->filename, &retstr))) {
572 fprintf(stderr, "pageant: finding key '%s': %s\n",
573 act->filename, retstr);
577 FILE *fp = stdout; /* FIXME: add a -o option? */
579 if (key->ssh_version == 1) {
581 memset(&rkey, 0, sizeof(rkey));
582 rkey.comment = dupstr(key->comment);
583 makekey(key->blob, key->bloblen, &rkey, NULL, 0);
584 ssh1_write_pubkey(fp, &rkey);
587 ssh2_write_pubkey(fp, key->comment, key->blob,key->bloblen,
588 (act->action == KEYACT_CLIENT_PUBLIC ?
589 SSH_KEYTYPE_SSH2_PUBLIC_RFC4716 :
590 SSH_KEYTYPE_SSH2_PUBLIC_OPENSSH));
592 pageant_pubkey_free(key);
595 case KEYACT_CLIENT_DEL_ALL:
596 fprintf(stderr, "NYI\n");
600 assert(0 && "Invalid client action found");
611 char *username, *socketdir;
612 struct pageant_listen_state *pl;
617 int i, fdcount, fdsize, fdstate;
618 int termination_pid = -1;
621 const struct cmdline_key_action *act;
624 fdcount = fdsize = 0;
629 * Start by loading any keys provided on the command line.
631 for (act = keyact_head; act; act = act->next) {
632 assert(act->action == KEYACT_AGENT_LOAD);
633 if (!unix_add_keyfile(act->filename))
640 * Set up a listening socket and run Pageant on it.
642 username = get_username();
643 socketdir = dupprintf("%s.%s", PAGEANT_DIR_PREFIX, username);
645 assert(*socketdir == '/');
646 if ((err = make_dir_and_check_ours(socketdir)) != NULL) {
647 fprintf(stderr, "pageant: %s: %s\n", socketdir, err);
650 socketname = dupprintf("%s/pageant.%d", socketdir, (int)getpid());
651 pl = pageant_listener_new();
652 sock = new_unix_listener(unix_sock_addr(socketname), (Plug)pl);
653 if ((err = sk_socket_error(sock)) != NULL) {
654 fprintf(stderr, "pageant: %s: %s\n", socketname, err);
657 pageant_listener_got_socket(pl, sock);
660 conf_set_int(conf, CONF_proxy_type, PROXY_NONE);
663 * Lifetime preparations.
665 signalpipe[0] = signalpipe[1] = -1;
666 if (life == LIFE_X11) {
667 struct X11Display *disp;
671 struct X11Connection *conn;
673 static const struct plug_function_table fn_table = {
682 display = getenv("DISPLAY");
684 fprintf(stderr, "pageant: no DISPLAY for -X mode\n");
687 disp = x11_setup_display(display, conf);
689 conn = snew(struct X11Connection);
690 conn->fn = &fn_table;
691 s = new_connection(sk_addr_dup(disp->addr),
692 disp->realhost, disp->port,
693 0, 1, 0, 0, (Plug)conn, conf);
694 if ((err = sk_socket_error(s)) != NULL) {
695 fprintf(stderr, "pageant: unable to connect to X server: %s", err);
698 greeting = x11_make_greeting('B', 11, 0, disp->localauthproto,
700 disp->localauthdatalen,
701 NULL, 0, &greetinglen);
702 sk_write(s, greeting, greetinglen);
703 smemclr(greeting, greetinglen);
706 pageant_fork_and_print_env(FALSE);
707 } else if (life == LIFE_TTY) {
708 schedule_timer(TTY_LIFE_POLL_INTERVAL,
709 tty_life_timer, &dummy_timer_ctx);
710 pageant_fork_and_print_env(TRUE);
711 } else if (life == LIFE_PERM) {
712 pageant_fork_and_print_env(FALSE);
713 } else if (life == LIFE_DEBUG) {
714 pageant_print_env(getpid());
715 pageant_logfp = stdout;
716 } else if (life == LIFE_EXEC) {
722 * Set up the pipe we'll use to tell us about SIGCHLD.
724 if (pipe(signalpipe) < 0) {
728 putty_signal(SIGCHLD, sigchld);
734 } else if (pid == 0) {
735 setenv("SSH_AUTH_SOCK", socketname, TRUE);
736 setenv("SSH_AGENT_PID", dupprintf("%d", (int)agentpid), TRUE);
737 execvp(exec_args[0], exec_args);
741 termination_pid = pid;
746 * Now we've decided on our logging arrangements, pass them on to
749 pageant_listener_set_logfn(pl, NULL, pageant_logfp ? pageant_log : NULL);
751 now = GETTICKCOUNT();
753 while (!time_to_die) {
754 fd_set rset, wset, xset;
765 if (signalpipe[0] >= 0) {
766 FD_SET_MAX(signalpipe[0], maxfd, rset);
769 /* Count the currently active fds. */
771 for (fd = first_fd(&fdstate, &rwx); fd >= 0;
772 fd = next_fd(&fdstate, &rwx)) i++;
774 /* Expand the fdlist buffer if necessary. */
777 fdlist = sresize(fdlist, fdsize, int);
781 * Add all currently open fds to the select sets, and store
782 * them in fdlist as well.
785 for (fd = first_fd(&fdstate, &rwx); fd >= 0;
786 fd = next_fd(&fdstate, &rwx)) {
787 fdlist[fdcount++] = fd;
789 FD_SET_MAX(fd, maxfd, rset);
791 FD_SET_MAX(fd, maxfd, wset);
793 FD_SET_MAX(fd, maxfd, xset);
796 if (toplevel_callback_pending()) {
800 ret = select(maxfd, &rset, &wset, &xset, &tv);
801 } else if (run_timers(now, &next)) {
807 now = GETTICKCOUNT();
808 if (now - then > next - then)
812 tv.tv_sec = ticks / 1000;
813 tv.tv_usec = ticks % 1000 * 1000;
814 ret = select(maxfd, &rset, &wset, &xset, &tv);
818 now = GETTICKCOUNT();
820 ret = select(maxfd, &rset, &wset, &xset, NULL);
823 if (ret < 0 && errno == EINTR)
831 if (life == LIFE_TTY) {
833 * Every time we wake up (whether it was due to tty_timer
834 * elapsing or for any other reason), poll to see if we
835 * still have a controlling terminal. If we don't, then
836 * our containing tty session has ended, so it's time to
837 * clean up and leave.
839 int fd = open("/dev/tty", O_RDONLY);
841 if (errno != ENXIO) {
842 perror("/dev/tty: open");
852 for (i = 0; i < fdcount; i++) {
855 * We must process exceptional notifications before
856 * ordinary readability ones, or we may go straight
857 * past the urgent marker.
859 if (FD_ISSET(fd, &xset))
860 select_result(fd, 4);
861 if (FD_ISSET(fd, &rset))
862 select_result(fd, 1);
863 if (FD_ISSET(fd, &wset))
864 select_result(fd, 2);
867 if (signalpipe[0] >= 0 && FD_ISSET(signalpipe[0], &rset)) {
869 if (read(signalpipe[0], c, 1) <= 0)
871 /* ignore its value; it'll be `x' */
875 pid = waitpid(-1, &status, WNOHANG);
878 if (pid == termination_pid)
883 run_toplevel_callbacks();
887 * When we come here, we're terminating, and should clean up our
888 * Unix socket file if possible.
890 if (unlink(socketname) < 0) {
891 fprintf(stderr, "pageant: %s: %s\n", socketname, strerror(errno));
896 int main(int argc, char **argv)
898 int doing_opts = TRUE;
899 keyact curr_keyact = KEYACT_AGENT_LOAD;
902 * Process the command line.
906 if (*p == '-' && doing_opts) {
907 if (!strcmp(p, "-V") || !strcmp(p, "--version")) {
909 } else if (!strcmp(p, "--help")) {
912 } else if (!strcmp(p, "-v")) {
913 pageant_logfp = stderr;
914 } else if (!strcmp(p, "-a")) {
915 curr_keyact = KEYACT_CLIENT_ADD;
916 } else if (!strcmp(p, "-d")) {
917 curr_keyact = KEYACT_CLIENT_DEL;
918 } else if (!strcmp(p, "-D")) {
919 add_keyact(KEYACT_CLIENT_DEL_ALL, NULL);
920 } else if (!strcmp(p, "-l")) {
921 add_keyact(KEYACT_CLIENT_LIST, NULL);
922 } else if (!strcmp(p, "--public")) {
923 curr_keyact = KEYACT_CLIENT_PUBLIC;
924 } else if (!strcmp(p, "--public-openssh")) {
925 curr_keyact = KEYACT_CLIENT_PUBLIC_OPENSSH;
926 } else if (!strcmp(p, "-X")) {
928 } else if (!strcmp(p, "-T")) {
930 } else if (!strcmp(p, "--debug")) {
932 } else if (!strcmp(p, "--permanent")) {
934 } else if (!strcmp(p, "--exec")) {
936 /* Now all subsequent arguments go to the exec command. */
939 argc = 0; /* force end of option processing */
941 fprintf(stderr, "pageant: expected a command "
945 } else if (!strcmp(p, "--")) {
950 * Non-option arguments (apart from those after --exec,
951 * which are treated specially above) are interpreted as
952 * the names of private key files to either add or delete
955 add_keyact(curr_keyact, p);
959 if (life == LIFE_EXEC && !exec_args) {
960 fprintf(stderr, "pageant: expected a command with --exec\n");
965 * Block SIGPIPE, so that we'll get EPIPE individually on
966 * particular network connections that go wrong.
968 putty_signal(SIGPIPE, SIG_IGN);
974 * Now distinguish our two main running modes. Either we're
975 * actually starting up an agent, in which case we should have a
976 * lifetime mode, and no key actions of KEYACT_CLIENT_* type; or
977 * else we're contacting an existing agent to add or remove keys,
978 * in which case we should have no lifetime mode, and no key
979 * actions of KEYACT_AGENT_* type.
982 int has_agent_actions = FALSE;
983 int has_client_actions = FALSE;
984 int has_lifetime = FALSE;
985 const struct cmdline_key_action *act;
987 for (act = keyact_head; act; act = act->next) {
988 if (is_agent_action(act->action))
989 has_agent_actions = TRUE;
991 has_client_actions = TRUE;
993 if (life != LIFE_UNSPEC)
996 if (has_lifetime && has_client_actions) {
997 fprintf(stderr, "pageant: client key actions (-a, -d, -D, -l, -L)"
998 " do not go with an agent lifetime option\n");
1001 if (!has_lifetime && has_agent_actions) {
1002 fprintf(stderr, "pageant: expected an agent lifetime option with"
1003 " bare key file arguments\n");
1006 if (!has_lifetime && !has_client_actions) {
1007 fprintf(stderr, "pageant: expected an agent lifetime option"
1008 " or a client key action\n");
1014 } else if (has_client_actions) {