1 /* $OpenBSD: ssh-add.c,v 1.128 2016/02/15 09:47:49 dtucker Exp $ */
3 * Author: Tatu Ylonen <ylo@cs.hut.fi>
4 * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
6 * Adds an identity to the authentication server, or removes an identity.
8 * As far as I am concerned, the code I have written for this software
9 * can be used freely for any purpose. Any derived versions of this
10 * software must be clearly marked as such, and if the derived work is
11 * incompatible with the protocol description in the RFC file, it must be
12 * called by a name other than "ssh" or "Secure Shell".
14 * SSH2 implementation,
15 * Copyright (c) 2000, 2001 Markus Friedl. All rights reserved.
17 * Redistribution and use in source and binary forms, with or without
18 * modification, are permitted provided that the following conditions
20 * 1. Redistributions of source code must retain the above copyright
21 * notice, this list of conditions and the following disclaimer.
22 * 2. Redistributions in binary form must reproduce the above copyright
23 * notice, this list of conditions and the following disclaimer in the
24 * documentation and/or other materials provided with the distribution.
26 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
27 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
28 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
29 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
30 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
31 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
32 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
33 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
34 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
35 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
40 #include <sys/types.h>
43 #include <openssl/evp.h>
44 #include "openbsd-compat/openssl-compat.h"
64 #include "pathnames.h"
70 extern char *__progname;
72 /* Default files to add */
73 static char *default_files[] = {
75 _PATH_SSH_CLIENT_ID_RSA,
76 _PATH_SSH_CLIENT_ID_DSA,
77 #ifdef OPENSSL_HAS_ECC
78 _PATH_SSH_CLIENT_ID_ECDSA,
80 #endif /* WITH_OPENSSL */
81 _PATH_SSH_CLIENT_ID_ED25519,
83 _PATH_SSH_CLIENT_IDENTITY,
88 static int fingerprint_hash = SSH_FP_HASH_DEFAULT;
90 /* Default lifetime (0 == forever) */
91 static int lifetime = 0;
93 /* User has to confirm key use */
94 static int confirm = 0;
96 /* we keep a cache of one passphrase */
97 static char *pass = NULL;
102 explicit_bzero(pass, strlen(pass));
109 delete_file(int agent_fd, const char *filename, int key_only)
111 struct sshkey *public, *cert = NULL;
112 char *certpath = NULL, *comment = NULL;
115 if ((r = sshkey_load_public(filename, &public, &comment)) != 0) {
116 printf("Bad key file %s: %s\n", filename, ssh_err(r));
119 if ((r = ssh_remove_identity(agent_fd, public)) == 0) {
120 fprintf(stderr, "Identity removed: %s (%s)\n", filename, comment);
123 fprintf(stderr, "Could not remove identity \"%s\": %s\n",
124 filename, ssh_err(r));
129 /* Now try to delete the corresponding certificate too */
132 xasprintf(&certpath, "%s-cert.pub", filename);
133 if ((r = sshkey_load_public(certpath, &cert, &comment)) != 0) {
134 if (r != SSH_ERR_SYSTEM_ERROR || errno != ENOENT)
135 error("Failed to load certificate \"%s\": %s",
136 certpath, ssh_err(r));
140 if (!sshkey_equal_public(cert, public))
141 fatal("Certificate %s does not match private key %s",
144 if ((r = ssh_remove_identity(agent_fd, cert)) == 0) {
145 fprintf(stderr, "Identity removed: %s (%s)\n", certpath,
149 fprintf(stderr, "Could not remove identity \"%s\": %s\n",
150 certpath, ssh_err(r));
161 /* Send a request to remove all identities. */
163 delete_all(int agent_fd)
167 if (ssh_remove_all_identities(agent_fd, 2) == 0)
169 /* ignore error-code for ssh1 */
170 ssh_remove_all_identities(agent_fd, 1);
173 fprintf(stderr, "All identities removed.\n");
175 fprintf(stderr, "Failed to remove all identities.\n");
181 add_file(int agent_fd, const char *filename, int key_only)
183 struct sshkey *private, *cert;
184 char *comment = NULL;
185 char msg[1024], *certpath = NULL;
187 struct sshbuf *keyblob;
189 if (strcmp(filename, "-") == 0) {
191 filename = "(stdin)";
192 } else if ((fd = open(filename, O_RDONLY)) < 0) {
198 * Since we'll try to load a keyfile multiple times, permission errors
199 * will occur multiple times, so check perms first and bail if wrong.
201 if (fd != STDIN_FILENO) {
202 if (sshkey_perm_ok(fd, filename) != 0) {
207 if ((keyblob = sshbuf_new()) == NULL)
208 fatal("%s: sshbuf_new failed", __func__);
209 if ((r = sshkey_load_file(fd, keyblob)) != 0) {
210 fprintf(stderr, "Error loading key \"%s\": %s\n",
211 filename, ssh_err(r));
212 sshbuf_free(keyblob);
218 /* At first, try empty passphrase */
219 if ((r = sshkey_parse_private_fileblob(keyblob, "", &private,
220 &comment)) != 0 && r != SSH_ERR_KEY_WRONG_PASSPHRASE) {
221 fprintf(stderr, "Error loading key \"%s\": %s\n",
222 filename, ssh_err(r));
226 if (private == NULL && pass != NULL) {
227 if ((r = sshkey_parse_private_fileblob(keyblob, pass, &private,
228 &comment)) != 0 && r != SSH_ERR_KEY_WRONG_PASSPHRASE) {
229 fprintf(stderr, "Error loading key \"%s\": %s\n",
230 filename, ssh_err(r));
234 if (private == NULL) {
235 /* clear passphrase since it did not work */
237 snprintf(msg, sizeof msg, "Enter passphrase for %s%s: ",
238 filename, confirm ? " (will confirm each use)" : "");
240 pass = read_passphrase(msg, RP_ALLOW_STDIN);
241 if (strcmp(pass, "") == 0)
243 if ((r = sshkey_parse_private_fileblob(keyblob, pass,
244 &private, &comment)) == 0)
246 else if (r != SSH_ERR_KEY_WRONG_PASSPHRASE) {
248 "Error loading key \"%s\": %s\n",
249 filename, ssh_err(r));
252 sshbuf_free(keyblob);
256 snprintf(msg, sizeof msg,
257 "Bad passphrase, try again for %s%s: ", filename,
258 confirm ? " (will confirm each use)" : "");
261 if (comment == NULL || *comment == '\0')
262 comment = xstrdup(filename);
263 sshbuf_free(keyblob);
265 if ((r = ssh_add_identity_constrained(agent_fd, private, comment,
266 lifetime, confirm)) == 0) {
267 fprintf(stderr, "Identity added: %s (%s)\n", filename, comment);
271 "Lifetime set to %d seconds\n", lifetime);
274 "The user must confirm each use of the key\n");
276 fprintf(stderr, "Could not add identity \"%s\": %s\n",
277 filename, ssh_err(r));
280 /* Skip trying to load the cert if requested */
284 /* Now try to add the certificate flavour too */
285 xasprintf(&certpath, "%s-cert.pub", filename);
286 if ((r = sshkey_load_public(certpath, &cert, NULL)) != 0) {
287 if (r != SSH_ERR_SYSTEM_ERROR || errno != ENOENT)
288 error("Failed to load certificate \"%s\": %s",
289 certpath, ssh_err(r));
293 if (!sshkey_equal_public(cert, private)) {
294 error("Certificate %s does not match private key %s",
300 /* Graft with private bits */
301 if ((r = sshkey_to_certified(private)) != 0) {
302 error("%s: sshkey_to_certified: %s", __func__, ssh_err(r));
306 if ((r = sshkey_cert_copy(cert, private)) != 0) {
307 error("%s: key_cert_copy: %s", __func__, ssh_err(r));
313 if ((r = ssh_add_identity_constrained(agent_fd, private, comment,
314 lifetime, confirm)) != 0) {
315 error("Certificate %s (%s) add failed: %s", certpath,
316 private->cert->key_id, ssh_err(r));
319 fprintf(stderr, "Certificate added: %s (%s)\n", certpath,
320 private->cert->key_id);
322 fprintf(stderr, "Lifetime set to %d seconds\n", lifetime);
324 fprintf(stderr, "The user must confirm each use of the key\n");
328 sshkey_free(private);
334 update_card(int agent_fd, int add, const char *id)
340 if ((pin = read_passphrase("Enter passphrase for PKCS#11: ",
341 RP_ALLOW_STDIN)) == NULL)
345 if ((r = ssh_update_card(agent_fd, add, id, pin == NULL ? "" : pin,
346 lifetime, confirm)) == 0) {
347 fprintf(stderr, "Card %s: %s\n",
348 add ? "added" : "removed", id);
351 fprintf(stderr, "Could not %s card \"%s\": %s\n",
352 add ? "add" : "remove", id, ssh_err(r));
360 list_identities(int agent_fd, int do_fp)
363 int r, had_identities = 0;
364 struct ssh_identitylist *idlist;
372 for (; version <= 2; version++) {
373 if ((r = ssh_fetch_identitylist(agent_fd, version,
375 if (r != SSH_ERR_AGENT_NO_IDENTITIES)
376 fprintf(stderr, "error fetching identities for "
377 "protocol %d: %s\n", version, ssh_err(r));
380 for (i = 0; i < idlist->nkeys; i++) {
383 fp = sshkey_fingerprint(idlist->keys[i],
384 fingerprint_hash, SSH_FP_DEFAULT);
385 printf("%u %s %s (%s)\n",
386 sshkey_size(idlist->keys[i]),
387 fp == NULL ? "(null)" : fp,
389 sshkey_type(idlist->keys[i]));
392 if ((r = sshkey_write(idlist->keys[i],
394 fprintf(stderr, "sshkey_write: %s\n",
398 fprintf(stdout, " %s\n", idlist->comments[i]);
401 ssh_free_identitylist(idlist);
403 if (!had_identities) {
404 printf("The agent has no identities.\n");
411 lock_agent(int agent_fd, int lock)
413 char prompt[100], *p1, *p2;
414 int r, passok = 1, ret = -1;
416 strlcpy(prompt, "Enter lock password: ", sizeof(prompt));
417 p1 = read_passphrase(prompt, RP_ALLOW_STDIN);
419 strlcpy(prompt, "Again: ", sizeof prompt);
420 p2 = read_passphrase(prompt, RP_ALLOW_STDIN);
421 if (strcmp(p1, p2) != 0) {
422 fprintf(stderr, "Passwords do not match.\n");
425 explicit_bzero(p2, strlen(p2));
429 if ((r = ssh_lock_agent(agent_fd, lock, p1)) == 0) {
430 fprintf(stderr, "Agent %slocked.\n", lock ? "" : "un");
433 fprintf(stderr, "Failed to %slock agent: %s\n",
434 lock ? "" : "un", ssh_err(r));
437 explicit_bzero(p1, strlen(p1));
443 do_file(int agent_fd, int deleting, int key_only, char *file)
446 if (delete_file(agent_fd, file, key_only) == -1)
449 if (add_file(agent_fd, file, key_only) == -1)
458 fprintf(stderr, "usage: %s [options] [file ...]\n", __progname);
459 fprintf(stderr, "Options:\n");
460 fprintf(stderr, " -l List fingerprints of all identities.\n");
461 fprintf(stderr, " -E hash Specify hash algorithm used for fingerprints.\n");
462 fprintf(stderr, " -L List public key parameters of all identities.\n");
463 fprintf(stderr, " -k Load only keys and not certificates.\n");
464 fprintf(stderr, " -c Require confirmation to sign using identities\n");
465 fprintf(stderr, " -t life Set lifetime (in seconds) when adding identities.\n");
466 fprintf(stderr, " -d Delete identity.\n");
467 fprintf(stderr, " -D Delete all identities.\n");
468 fprintf(stderr, " -x Lock agent.\n");
469 fprintf(stderr, " -X Unlock agent.\n");
470 fprintf(stderr, " -s pkcs11 Add keys from PKCS#11 provider.\n");
471 fprintf(stderr, " -e pkcs11 Remove keys provided by PKCS#11 provider.\n");
475 main(int argc, char **argv)
480 char *pkcs11provider = NULL;
481 int r, i, ch, deleting = 0, ret = 0, key_only = 0;
482 int xflag = 0, lflag = 0, Dflag = 0;
484 ssh_malloc_init(); /* must be called before any mallocs */
485 /* Ensure that fds 0, 1 and 2 are open or directed to /dev/null */
488 __progname = ssh_get_progname(argv[0]);
492 OpenSSL_add_all_algorithms();
495 setvbuf(stdout, NULL, _IOLBF, 0);
497 /* First, get a connection to the authentication agent. */
498 switch (r = ssh_get_authentication_socket(&agent_fd)) {
501 case SSH_ERR_AGENT_NOT_PRESENT:
502 fprintf(stderr, "Could not open a connection to your "
503 "authentication agent.\n");
506 fprintf(stderr, "Error connecting to agent: %s\n", ssh_err(r));
510 while ((ch = getopt(argc, argv, "klLcdDxXE:e:s:t:")) != -1) {
513 fingerprint_hash = ssh_digest_alg_by_name(optarg);
514 if (fingerprint_hash == -1)
515 fatal("Invalid hash algorithm \"%s\"", optarg);
523 fatal("-%c flag already specified", lflag);
529 fatal("-%c flag already specified", xflag);
542 pkcs11provider = optarg;
546 pkcs11provider = optarg;
549 if ((lifetime = convtime(optarg)) == -1) {
550 fprintf(stderr, "Invalid lifetime\n");
562 if ((xflag != 0) + (lflag != 0) + (Dflag != 0) > 1)
563 fatal("Invalid combination of actions");
565 if (lock_agent(agent_fd, xflag == 'x' ? 1 : 0) == -1)
569 if (list_identities(agent_fd, lflag == 'l' ? 1 : 0) == -1)
573 if (delete_all(agent_fd) == -1)
580 if (pkcs11provider != NULL) {
581 if (update_card(agent_fd, !deleting, pkcs11provider) == -1)
591 if ((pw = getpwuid(getuid())) == NULL) {
592 fprintf(stderr, "No user found with uid %u\n",
598 for (i = 0; default_files[i]; i++) {
599 snprintf(buf, sizeof(buf), "%s/%s", pw->pw_dir,
601 if (stat(buf, &st) < 0)
603 if (do_file(agent_fd, deleting, key_only, buf) == -1)
611 for (i = 0; i < argc; i++) {
612 if (do_file(agent_fd, deleting, key_only,
620 ssh_close_authentication_socket(agent_fd);