1 /* $OpenBSD: ssh-add.c,v 1.113 2014/07/09 14:15:56 benno 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>
42 #include <sys/param.h>
44 #include <openssl/evp.h>
45 #include "openbsd-compat/openssl-compat.h"
63 #include "pathnames.h"
68 extern char *__progname
;
70 /* Default files to add */
71 static char *default_files
[] = {
72 _PATH_SSH_CLIENT_ID_RSA
,
73 _PATH_SSH_CLIENT_ID_DSA
,
74 #ifdef OPENSSL_HAS_ECC
75 _PATH_SSH_CLIENT_ID_ECDSA
,
77 _PATH_SSH_CLIENT_ID_ED25519
,
78 _PATH_SSH_CLIENT_IDENTITY
,
82 /* Default lifetime (0 == forever) */
83 static int lifetime
= 0;
85 /* User has to confirm key use */
86 static int confirm
= 0;
88 /* we keep a cache of one passphrases */
89 static char *pass
= NULL
;
94 explicit_bzero(pass
, strlen(pass
));
101 delete_file(AuthenticationConnection
*ac
, const char *filename
, int key_only
)
103 Key
*public = NULL
, *cert
= NULL
;
104 char *certpath
= NULL
, *comment
= NULL
;
107 public = key_load_public(filename
, &comment
);
108 if (public == NULL
) {
109 printf("Bad key file %s\n", filename
);
112 if (ssh_remove_identity(ac
, public)) {
113 fprintf(stderr
, "Identity removed: %s (%s)\n", filename
, comment
);
116 fprintf(stderr
, "Could not remove identity: %s\n", filename
);
121 /* Now try to delete the corresponding certificate too */
124 xasprintf(&certpath
, "%s-cert.pub", filename
);
125 if ((cert
= key_load_public(certpath
, &comment
)) == NULL
)
127 if (!key_equal_public(cert
, public))
128 fatal("Certificate %s does not match private key %s",
131 if (ssh_remove_identity(ac
, cert
)) {
132 fprintf(stderr
, "Identity removed: %s (%s)\n", certpath
,
136 fprintf(stderr
, "Could not remove identity: %s\n", certpath
);
149 /* Send a request to remove all identities. */
151 delete_all(AuthenticationConnection
*ac
)
155 if (ssh_remove_all_identities(ac
, 1))
157 /* ignore error-code for ssh2 */
158 ssh_remove_all_identities(ac
, 2);
161 fprintf(stderr
, "All identities removed.\n");
163 fprintf(stderr
, "Failed to remove all identities.\n");
169 add_file(AuthenticationConnection
*ac
, const char *filename
, int key_only
)
172 char *comment
= NULL
;
173 char msg
[1024], *certpath
= NULL
;
174 int r
, fd
, perms_ok
, ret
= -1;
177 if (strcmp(filename
, "-") == 0) {
179 filename
= "(stdin)";
180 } else if ((fd
= open(filename
, O_RDONLY
)) < 0) {
186 * Since we'll try to load a keyfile multiple times, permission errors
187 * will occur multiple times, so check perms first and bail if wrong.
189 if (fd
!= STDIN_FILENO
) {
190 perms_ok
= key_perm_ok(fd
, filename
);
196 buffer_init(&keyblob
);
197 if (!key_load_file(fd
, filename
, &keyblob
)) {
198 buffer_free(&keyblob
);
204 /* At first, try empty passphrase */
205 if ((r
= sshkey_parse_private_fileblob(&keyblob
, "", filename
,
206 &private, &comment
)) != 0 && r
!= SSH_ERR_KEY_WRONG_PASSPHRASE
)
207 fatal("Cannot parse %s: %s", filename
, ssh_err(r
));
209 if (private == NULL
&& pass
!= NULL
) {
210 if ((r
= sshkey_parse_private_fileblob(&keyblob
, pass
, filename
,
211 &private, &comment
)) != 0 &&
212 r
!= SSH_ERR_KEY_WRONG_PASSPHRASE
)
213 fatal("Cannot parse %s: %s", filename
, ssh_err(r
));
216 comment
= xstrdup(filename
);
217 if (private == NULL
) {
218 /* clear passphrase since it did not work */
220 snprintf(msg
, sizeof msg
, "Enter passphrase for %.200s: ",
223 pass
= read_passphrase(msg
, RP_ALLOW_STDIN
);
224 if (strcmp(pass
, "") == 0) {
227 buffer_free(&keyblob
);
230 if ((r
= sshkey_parse_private_fileblob(&keyblob
,
231 pass
, filename
, &private, NULL
)) != 0 &&
232 r
!= SSH_ERR_KEY_WRONG_PASSPHRASE
)
233 fatal("Cannot parse %s: %s",
234 filename
, ssh_err(r
));
238 snprintf(msg
, sizeof msg
,
239 "Bad passphrase, try again for %.200s: ", comment
);
242 buffer_free(&keyblob
);
244 if (ssh_add_identity_constrained(ac
, private, comment
, lifetime
,
246 fprintf(stderr
, "Identity added: %s (%s)\n", filename
, comment
);
250 "Lifetime set to %d seconds\n", lifetime
);
253 "The user must confirm each use of the key\n");
255 fprintf(stderr
, "Could not add identity: %s\n", filename
);
258 /* Skip trying to load the cert if requested */
262 /* Now try to add the certificate flavour too */
263 xasprintf(&certpath
, "%s-cert.pub", filename
);
264 if ((cert
= key_load_public(certpath
, NULL
)) == NULL
)
267 if (!key_equal_public(cert
, private)) {
268 error("Certificate %s does not match private key %s",
274 /* Graft with private bits */
275 if (key_to_certified(private, key_cert_is_legacy(cert
)) != 0) {
276 error("%s: key_to_certified failed", __func__
);
280 key_cert_copy(cert
, private);
283 if (!ssh_add_identity_constrained(ac
, private, comment
,
284 lifetime
, confirm
)) {
285 error("Certificate %s (%s) add failed", certpath
,
286 private->cert
->key_id
);
288 fprintf(stderr
, "Certificate added: %s (%s)\n", certpath
,
289 private->cert
->key_id
);
291 fprintf(stderr
, "Lifetime set to %d seconds\n", lifetime
);
293 fprintf(stderr
, "The user must confirm each use of the key\n");
295 if (certpath
!= NULL
)
304 update_card(AuthenticationConnection
*ac
, int add
, const char *id
)
310 if ((pin
= read_passphrase("Enter passphrase for PKCS#11: ",
311 RP_ALLOW_STDIN
)) == NULL
)
315 if (ssh_update_card(ac
, add
, id
, pin
== NULL
? "" : pin
,
316 lifetime
, confirm
)) {
317 fprintf(stderr
, "Card %s: %s\n",
318 add
? "added" : "removed", id
);
321 fprintf(stderr
, "Could not %s card: %s\n",
322 add
? "add" : "remove", id
);
330 list_identities(AuthenticationConnection
*ac
, int do_fp
)
334 int had_identities
= 0;
337 for (version
= 1; version
<= 2; version
++) {
338 for (key
= ssh_get_first_identity(ac
, &comment
, version
);
340 key
= ssh_get_next_identity(ac
, &comment
, version
)) {
343 fp
= key_fingerprint(key
, SSH_FP_MD5
,
345 printf("%d %s %s (%s)\n",
346 key_size(key
), fp
, comment
, key_type(key
));
349 if (!key_write(key
, stdout
))
350 fprintf(stderr
, "key_write failed");
351 fprintf(stdout
, " %s\n", comment
);
357 if (!had_identities
) {
358 printf("The agent has no identities.\n");
365 lock_agent(AuthenticationConnection
*ac
, int lock
)
367 char prompt
[100], *p1
, *p2
;
368 int passok
= 1, ret
= -1;
370 strlcpy(prompt
, "Enter lock password: ", sizeof(prompt
));
371 p1
= read_passphrase(prompt
, RP_ALLOW_STDIN
);
373 strlcpy(prompt
, "Again: ", sizeof prompt
);
374 p2
= read_passphrase(prompt
, RP_ALLOW_STDIN
);
375 if (strcmp(p1
, p2
) != 0) {
376 fprintf(stderr
, "Passwords do not match.\n");
379 explicit_bzero(p2
, strlen(p2
));
382 if (passok
&& ssh_lock_agent(ac
, lock
, p1
)) {
383 fprintf(stderr
, "Agent %slocked.\n", lock
? "" : "un");
386 fprintf(stderr
, "Failed to %slock agent.\n", lock
? "" : "un");
387 explicit_bzero(p1
, strlen(p1
));
393 do_file(AuthenticationConnection
*ac
, int deleting
, int key_only
, char *file
)
396 if (delete_file(ac
, file
, key_only
) == -1)
399 if (add_file(ac
, file
, key_only
) == -1)
408 fprintf(stderr
, "usage: %s [options] [file ...]\n", __progname
);
409 fprintf(stderr
, "Options:\n");
410 fprintf(stderr
, " -l List fingerprints of all identities.\n");
411 fprintf(stderr
, " -L List public key parameters of all identities.\n");
412 fprintf(stderr
, " -k Load only keys and not certificates.\n");
413 fprintf(stderr
, " -c Require confirmation to sign using identities\n");
414 fprintf(stderr
, " -t life Set lifetime (in seconds) when adding identities.\n");
415 fprintf(stderr
, " -d Delete identity.\n");
416 fprintf(stderr
, " -D Delete all identities.\n");
417 fprintf(stderr
, " -x Lock agent.\n");
418 fprintf(stderr
, " -X Unlock agent.\n");
419 fprintf(stderr
, " -s pkcs11 Add keys from PKCS#11 provider.\n");
420 fprintf(stderr
, " -e pkcs11 Remove keys provided by PKCS#11 provider.\n");
424 main(int argc
, char **argv
)
428 AuthenticationConnection
*ac
= NULL
;
429 char *pkcs11provider
= NULL
;
430 int i
, ch
, deleting
= 0, ret
= 0, key_only
= 0;
432 /* Ensure that fds 0, 1 and 2 are open or directed to /dev/null */
435 __progname
= ssh_get_progname(argv
[0]);
438 OpenSSL_add_all_algorithms();
442 /* At first, get a connection to the authentication agent. */
443 ac
= ssh_get_authentication_connection();
446 "Could not open a connection to your authentication agent.\n");
449 while ((ch
= getopt(argc
, argv
, "klLcdDxXe:s:t:")) != -1) {
456 if (list_identities(ac
, ch
== 'l' ? 1 : 0) == -1)
461 if (lock_agent(ac
, ch
== 'x' ? 1 : 0) == -1)
471 if (delete_all(ac
) == -1)
475 pkcs11provider
= optarg
;
479 pkcs11provider
= optarg
;
482 if ((lifetime
= convtime(optarg
)) == -1) {
483 fprintf(stderr
, "Invalid lifetime\n");
496 if (pkcs11provider
!= NULL
) {
497 if (update_card(ac
, !deleting
, pkcs11provider
) == -1)
502 char buf
[MAXPATHLEN
];
507 if ((pw
= getpwuid(getuid())) == NULL
) {
508 fprintf(stderr
, "No user found with uid %u\n",
514 for (i
= 0; default_files
[i
]; i
++) {
515 snprintf(buf
, sizeof(buf
), "%s/%s", pw
->pw_dir
,
517 if (stat(buf
, &st
) < 0)
519 if (do_file(ac
, deleting
, key_only
, buf
) == -1)
527 for (i
= 0; i
< argc
; i
++) {
528 if (do_file(ac
, deleting
, key_only
, argv
[i
]) == -1)
535 ssh_close_authentication_connection(ac
);