1 /* $OpenBSD: ssh-add.c,v 1.96 2010/05/14 00:47:22 djm 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"
67 extern char *__progname;
69 /* Default files to add */
70 static char *default_files[] = {
71 _PATH_SSH_CLIENT_ID_RSA,
72 _PATH_SSH_CLIENT_ID_DSA,
73 _PATH_SSH_CLIENT_IDENTITY,
77 /* Default lifetime (0 == forever) */
78 static int lifetime = 0;
80 /* User has to confirm key use */
81 static int confirm = 0;
83 /* we keep a cache of one passphrases */
84 static char *pass = NULL;
89 memset(pass, 0, strlen(pass));
96 delete_file(AuthenticationConnection *ac, const char *filename)
102 public = key_load_public(filename, &comment);
103 if (public == NULL) {
104 printf("Bad key file %s\n", filename);
107 if (ssh_remove_identity(ac, public)) {
108 fprintf(stderr, "Identity removed: %s (%s)\n", filename, comment);
111 fprintf(stderr, "Could not remove identity: %s\n", filename);
119 /* Send a request to remove all identities. */
121 delete_all(AuthenticationConnection *ac)
125 if (ssh_remove_all_identities(ac, 1))
127 /* ignore error-code for ssh2 */
128 ssh_remove_all_identities(ac, 2);
131 fprintf(stderr, "All identities removed.\n");
133 fprintf(stderr, "Failed to remove all identities.\n");
139 add_file(AuthenticationConnection *ac, const char *filename)
142 char *comment = NULL;
143 char msg[1024], *certpath;
144 int fd, perms_ok, ret = -1;
146 if ((fd = open(filename, O_RDONLY)) < 0) {
152 * Since we'll try to load a keyfile multiple times, permission errors
153 * will occur multiple times, so check perms first and bail if wrong.
155 perms_ok = key_perm_ok(fd, filename);
160 /* At first, try empty passphrase */
161 private = key_load_private(filename, "", &comment);
163 comment = xstrdup(filename);
165 if (private == NULL && pass != NULL)
166 private = key_load_private(filename, pass, NULL);
167 if (private == NULL) {
168 /* clear passphrase since it did not work */
170 snprintf(msg, sizeof msg, "Enter passphrase for %.200s: ",
173 pass = read_passphrase(msg, RP_ALLOW_STDIN);
174 if (strcmp(pass, "") == 0) {
179 private = key_load_private(filename, pass, &comment);
183 snprintf(msg, sizeof msg,
184 "Bad passphrase, try again for %.200s: ", comment);
188 if (ssh_add_identity_constrained(ac, private, comment, lifetime,
190 fprintf(stderr, "Identity added: %s (%s)\n", filename, comment);
194 "Lifetime set to %d seconds\n", lifetime);
197 "The user must confirm each use of the key\n");
199 fprintf(stderr, "Could not add identity: %s\n", filename);
203 /* Now try to add the certificate flavour too */
204 xasprintf(&certpath, "%s-cert.pub", filename);
205 if ((cert = key_load_public(certpath, NULL)) == NULL)
208 if (!key_equal_public(cert, private)) {
209 error("Certificate %s does not match private key %s",
215 /* Graft with private bits */
216 if (key_to_certified(private, key_cert_is_legacy(cert)) != 0) {
217 error("%s: key_to_certified failed", __func__);
221 key_cert_copy(cert, private);
224 if (!ssh_add_identity_constrained(ac, private, comment,
225 lifetime, confirm)) {
226 error("Certificate %s (%s) add failed", certpath,
227 private->cert->key_id);
229 fprintf(stderr, "Certificate added: %s (%s)\n", certpath,
230 private->cert->key_id);
232 fprintf(stderr, "Lifetime set to %d seconds\n", lifetime);
234 fprintf(stderr, "The user must confirm each use of the key\n");
244 update_card(AuthenticationConnection *ac, int add, const char *id)
249 pin = read_passphrase("Enter passphrase for PKCS#11: ", RP_ALLOW_STDIN);
253 if (ssh_update_card(ac, add, id, pin, lifetime, confirm)) {
254 fprintf(stderr, "Card %s: %s\n",
255 add ? "added" : "removed", id);
258 fprintf(stderr, "Could not %s card: %s\n",
259 add ? "add" : "remove", id);
267 list_identities(AuthenticationConnection *ac, int do_fp)
271 int had_identities = 0;
274 for (version = 1; version <= 2; version++) {
275 for (key = ssh_get_first_identity(ac, &comment, version);
277 key = ssh_get_next_identity(ac, &comment, version)) {
280 fp = key_fingerprint(key, SSH_FP_MD5,
282 printf("%d %s %s (%s)\n",
283 key_size(key), fp, comment, key_type(key));
286 if (!key_write(key, stdout))
287 fprintf(stderr, "key_write failed");
288 fprintf(stdout, " %s\n", comment);
294 if (!had_identities) {
295 printf("The agent has no identities.\n");
302 lock_agent(AuthenticationConnection *ac, int lock)
304 char prompt[100], *p1, *p2;
305 int passok = 1, ret = -1;
307 strlcpy(prompt, "Enter lock password: ", sizeof(prompt));
308 p1 = read_passphrase(prompt, RP_ALLOW_STDIN);
310 strlcpy(prompt, "Again: ", sizeof prompt);
311 p2 = read_passphrase(prompt, RP_ALLOW_STDIN);
312 if (strcmp(p1, p2) != 0) {
313 fprintf(stderr, "Passwords do not match.\n");
316 memset(p2, 0, strlen(p2));
319 if (passok && ssh_lock_agent(ac, lock, p1)) {
320 fprintf(stderr, "Agent %slocked.\n", lock ? "" : "un");
323 fprintf(stderr, "Failed to %slock agent.\n", lock ? "" : "un");
324 memset(p1, 0, strlen(p1));
330 do_file(AuthenticationConnection *ac, int deleting, char *file)
333 if (delete_file(ac, file) == -1)
336 if (add_file(ac, file) == -1)
345 fprintf(stderr, "usage: %s [options] [file ...]\n", __progname);
346 fprintf(stderr, "Options:\n");
347 fprintf(stderr, " -l List fingerprints of all identities.\n");
348 fprintf(stderr, " -L List public key parameters of all identities.\n");
349 fprintf(stderr, " -d Delete identity.\n");
350 fprintf(stderr, " -D Delete all identities.\n");
351 fprintf(stderr, " -x Lock agent.\n");
352 fprintf(stderr, " -X Unlock agent.\n");
353 fprintf(stderr, " -t life Set lifetime (in seconds) when adding identities.\n");
354 fprintf(stderr, " -c Require confirmation to sign using identities\n");
355 fprintf(stderr, " -s pkcs11 Add keys from PKCS#11 provider.\n");
356 fprintf(stderr, " -e pkcs11 Remove keys provided by PKCS#11 provider.\n");
360 main(int argc, char **argv)
364 AuthenticationConnection *ac = NULL;
365 char *pkcs11provider = NULL;
366 int i, ch, deleting = 0, ret = 0;
368 /* Ensure that fds 0, 1 and 2 are open or directed to /dev/null */
371 __progname = ssh_get_progname(argv[0]);
375 SSLeay_add_all_algorithms();
377 /* At first, get a connection to the authentication agent. */
378 ac = ssh_get_authentication_connection();
381 "Could not open a connection to your authentication agent.\n");
384 while ((ch = getopt(argc, argv, "lLcdDxXe:s:t:")) != -1) {
388 if (list_identities(ac, ch == 'l' ? 1 : 0) == -1)
393 if (lock_agent(ac, ch == 'x' ? 1 : 0) == -1)
403 if (delete_all(ac) == -1)
407 pkcs11provider = optarg;
411 pkcs11provider = optarg;
414 if ((lifetime = convtime(optarg)) == -1) {
415 fprintf(stderr, "Invalid lifetime\n");
428 if (pkcs11provider != NULL) {
429 if (update_card(ac, !deleting, pkcs11provider) == -1)
434 char buf[MAXPATHLEN];
439 if ((pw = getpwuid(getuid())) == NULL) {
440 fprintf(stderr, "No user found with uid %u\n",
446 for (i = 0; default_files[i]; i++) {
447 snprintf(buf, sizeof(buf), "%s/%s", pw->pw_dir,
449 if (stat(buf, &st) < 0)
451 if (do_file(ac, deleting, buf) == -1)
459 for (i = 0; i < argc; i++) {
460 if (do_file(ac, deleting, argv[i]) == -1)
467 ssh_close_authentication_connection(ac);