Annotation of src/usr.bin/ssh/ssh-add.c, Revision 1.103
1.103 ! djm 1: /* $OpenBSD: ssh-add.c,v 1.102 2011/10/18 05:00:48 djm Exp $ */
1.1 deraadt 2: /*
1.13 deraadt 3: * Author: Tatu Ylonen <ylo@cs.hut.fi>
4: * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
5: * All rights reserved
6: * Adds an identity to the authentication server, or removes an identity.
1.19 markus 7: *
1.22 deraadt 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".
13: *
1.19 markus 14: * SSH2 implementation,
1.41 markus 15: * Copyright (c) 2000, 2001 Markus Friedl. All rights reserved.
1.22 deraadt 16: *
17: * Redistribution and use in source and binary forms, with or without
18: * modification, are permitted provided that the following conditions
19: * are met:
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.
25: *
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.
1.13 deraadt 36: */
1.1 deraadt 37:
1.75 stevesk 38: #include <sys/types.h>
39: #include <sys/stat.h>
1.86 stevesk 40: #include <sys/param.h>
1.16 markus 41:
1.19 markus 42: #include <openssl/evp.h>
1.81 stevesk 43:
1.82 stevesk 44: #include <fcntl.h>
1.81 stevesk 45: #include <pwd.h>
1.88 stevesk 46: #include <stdio.h>
1.87 stevesk 47: #include <stdlib.h>
1.85 stevesk 48: #include <string.h>
1.84 stevesk 49: #include <unistd.h>
1.1 deraadt 50:
1.89 deraadt 51: #include "xmalloc.h"
1.27 markus 52: #include "ssh.h"
1.1 deraadt 53: #include "rsa.h"
1.27 markus 54: #include "log.h"
1.16 markus 55: #include "key.h"
1.89 deraadt 56: #include "buffer.h"
1.18 markus 57: #include "authfd.h"
1.16 markus 58: #include "authfile.h"
1.25 markus 59: #include "pathnames.h"
1.57 stevesk 60: #include "misc.h"
1.1 deraadt 61:
1.45 jakob 62: /* argv0 */
63: extern char *__progname;
64:
1.48 djm 65: /* Default files to add */
66: static char *default_files[] = {
67: _PATH_SSH_CLIENT_ID_RSA,
68: _PATH_SSH_CLIENT_ID_DSA,
1.99 djm 69: _PATH_SSH_CLIENT_ID_ECDSA,
1.51 markus 70: _PATH_SSH_CLIENT_IDENTITY,
1.48 djm 71: NULL
72: };
73:
1.56 markus 74: /* Default lifetime (0 == forever) */
1.57 stevesk 75: static int lifetime = 0;
1.48 djm 76:
1.65 markus 77: /* User has to confirm key use */
78: static int confirm = 0;
79:
1.33 markus 80: /* we keep a cache of one passphrases */
81: static char *pass = NULL;
1.39 itojun 82: static void
1.33 markus 83: clear_pass(void)
84: {
85: if (pass) {
86: memset(pass, 0, strlen(pass));
87: xfree(pass);
88: pass = NULL;
89: }
90: }
91:
1.46 djm 92: static int
1.7 markus 93: delete_file(AuthenticationConnection *ac, const char *filename)
1.1 deraadt 94: {
1.16 markus 95: Key *public;
1.32 markus 96: char *comment = NULL;
1.46 djm 97: int ret = -1;
1.1 deraadt 98:
1.31 markus 99: public = key_load_public(filename, &comment);
100: if (public == NULL) {
101: printf("Bad key file %s\n", filename);
1.46 djm 102: return -1;
1.12 markus 103: }
1.46 djm 104: if (ssh_remove_identity(ac, public)) {
1.12 markus 105: fprintf(stderr, "Identity removed: %s (%s)\n", filename, comment);
1.46 djm 106: ret = 0;
107: } else
1.12 markus 108: fprintf(stderr, "Could not remove identity: %s\n", filename);
1.46 djm 109:
1.16 markus 110: key_free(public);
1.12 markus 111: xfree(comment);
1.47 deraadt 112:
1.46 djm 113: return ret;
1.1 deraadt 114: }
115:
1.19 markus 116: /* Send a request to remove all identities. */
1.46 djm 117: static int
1.7 markus 118: delete_all(AuthenticationConnection *ac)
1.1 deraadt 119: {
1.46 djm 120: int ret = -1;
1.19 markus 121:
1.46 djm 122: if (ssh_remove_all_identities(ac, 1))
123: ret = 0;
1.19 markus 124: /* ignore error-code for ssh2 */
125: ssh_remove_all_identities(ac, 2);
126:
1.46 djm 127: if (ret == 0)
1.12 markus 128: fprintf(stderr, "All identities removed.\n");
129: else
1.24 markus 130: fprintf(stderr, "Failed to remove all identities.\n");
1.46 djm 131:
132: return ret;
1.1 deraadt 133: }
134:
1.46 djm 135: static int
1.102 djm 136: add_file(AuthenticationConnection *ac, const char *filename, int key_only)
1.1 deraadt 137: {
1.93 djm 138: Key *private, *cert;
1.36 markus 139: char *comment = NULL;
1.102 djm 140: char msg[1024], *certpath = NULL;
1.76 dtucker 141: int fd, perms_ok, ret = -1;
1.101 djm 142: Buffer keyblob;
1.12 markus 143:
1.101 djm 144: if (strcmp(filename, "-") == 0) {
145: fd = STDIN_FILENO;
146: filename = "(stdin)";
147: } else if ((fd = open(filename, O_RDONLY)) < 0) {
1.19 markus 148: perror(filename);
1.46 djm 149: return -1;
1.19 markus 150: }
1.76 dtucker 151:
152: /*
153: * Since we'll try to load a keyfile multiple times, permission errors
154: * will occur multiple times, so check perms first and bail if wrong.
155: */
1.101 djm 156: if (fd != STDIN_FILENO) {
157: perms_ok = key_perm_ok(fd, filename);
158: if (!perms_ok) {
159: close(fd);
160: return -1;
161: }
162: }
163: buffer_init(&keyblob);
164: if (!key_load_file(fd, filename, &keyblob)) {
165: buffer_free(&keyblob);
166: close(fd);
167: return -1;
168: }
1.76 dtucker 169: close(fd);
170:
1.12 markus 171: /* At first, try empty passphrase */
1.101 djm 172: private = key_parse_private(&keyblob, filename, "", &comment);
1.31 markus 173: if (comment == NULL)
174: comment = xstrdup(filename);
1.33 markus 175: /* try last */
176: if (private == NULL && pass != NULL)
1.101 djm 177: private = key_parse_private(&keyblob, filename, pass, NULL);
1.31 markus 178: if (private == NULL) {
1.33 markus 179: /* clear passphrase since it did not work */
180: clear_pass();
1.37 markus 181: snprintf(msg, sizeof msg, "Enter passphrase for %.200s: ",
1.72 djm 182: comment);
1.12 markus 183: for (;;) {
1.40 markus 184: pass = read_passphrase(msg, RP_ALLOW_STDIN);
1.12 markus 185: if (strcmp(pass, "") == 0) {
1.35 markus 186: clear_pass();
1.31 markus 187: xfree(comment);
1.101 djm 188: buffer_free(&keyblob);
1.46 djm 189: return -1;
1.12 markus 190: }
1.101 djm 191: private = key_parse_private(&keyblob, filename, pass,
192: &comment);
1.31 markus 193: if (private != NULL)
1.12 markus 194: break;
1.33 markus 195: clear_pass();
1.68 markus 196: snprintf(msg, sizeof msg,
197: "Bad passphrase, try again for %.200s: ", comment);
1.12 markus 198: }
199: }
1.101 djm 200: buffer_free(&keyblob);
1.60 markus 201:
1.69 djm 202: if (ssh_add_identity_constrained(ac, private, comment, lifetime,
203: confirm)) {
1.60 markus 204: fprintf(stderr, "Identity added: %s (%s)\n", filename, comment);
205: ret = 0;
206: if (lifetime != 0)
1.64 deraadt 207: fprintf(stderr,
1.60 markus 208: "Lifetime set to %d seconds\n", lifetime);
1.69 djm 209: if (confirm != 0)
1.65 markus 210: fprintf(stderr,
1.96 djm 211: "The user must confirm each use of the key\n");
1.60 markus 212: } else {
1.12 markus 213: fprintf(stderr, "Could not add identity: %s\n", filename);
1.56 markus 214: }
215:
1.102 djm 216: /* Skip trying to load the cert if requested */
217: if (key_only)
218: goto out;
1.93 djm 219:
220: /* Now try to add the certificate flavour too */
221: xasprintf(&certpath, "%s-cert.pub", filename);
1.96 djm 222: if ((cert = key_load_public(certpath, NULL)) == NULL)
223: goto out;
224:
225: if (!key_equal_public(cert, private)) {
226: error("Certificate %s does not match private key %s",
227: certpath, filename);
1.93 djm 228: key_free(cert);
1.96 djm 229: goto out;
230: }
1.93 djm 231:
1.96 djm 232: /* Graft with private bits */
233: if (key_to_certified(private, key_cert_is_legacy(cert)) != 0) {
234: error("%s: key_to_certified failed", __func__);
235: key_free(cert);
236: goto out;
1.94 otto 237: }
1.96 djm 238: key_cert_copy(cert, private);
239: key_free(cert);
1.93 djm 240:
1.96 djm 241: if (!ssh_add_identity_constrained(ac, private, comment,
242: lifetime, confirm)) {
243: error("Certificate %s (%s) add failed", certpath,
244: private->cert->key_id);
245: }
246: fprintf(stderr, "Certificate added: %s (%s)\n", certpath,
247: private->cert->key_id);
248: if (lifetime != 0)
249: fprintf(stderr, "Lifetime set to %d seconds\n", lifetime);
250: if (confirm != 0)
251: fprintf(stderr, "The user must confirm each use of the key\n");
252: out:
1.102 djm 253: if (certpath != NULL)
254: xfree(certpath);
1.31 markus 255: xfree(comment);
1.16 markus 256: key_free(private);
1.47 deraadt 257:
1.46 djm 258: return ret;
1.1 deraadt 259: }
260:
1.46 djm 261: static int
1.44 markus 262: update_card(AuthenticationConnection *ac, int add, const char *id)
1.42 markus 263: {
1.53 rees 264: char *pin;
1.66 markus 265: int ret = -1;
1.53 rees 266:
1.92 markus 267: pin = read_passphrase("Enter passphrase for PKCS#11: ", RP_ALLOW_STDIN);
1.53 rees 268: if (pin == NULL)
269: return -1;
270:
1.67 djm 271: if (ssh_update_card(ac, add, id, pin, lifetime, confirm)) {
1.44 markus 272: fprintf(stderr, "Card %s: %s\n",
1.47 deraadt 273: add ? "added" : "removed", id);
1.66 markus 274: ret = 0;
1.46 djm 275: } else {
1.44 markus 276: fprintf(stderr, "Could not %s card: %s\n",
1.47 deraadt 277: add ? "add" : "remove", id);
1.66 markus 278: ret = -1;
1.46 djm 279: }
1.66 markus 280: xfree(pin);
281: return ret;
1.42 markus 282: }
283:
1.50 markus 284: static int
1.30 markus 285: list_identities(AuthenticationConnection *ac, int do_fp)
1.1 deraadt 286: {
1.19 markus 287: Key *key;
1.30 markus 288: char *comment, *fp;
1.19 markus 289: int had_identities = 0;
290: int version;
1.12 markus 291:
1.19 markus 292: for (version = 1; version <= 2; version++) {
293: for (key = ssh_get_first_identity(ac, &comment, version);
1.47 deraadt 294: key != NULL;
295: key = ssh_get_next_identity(ac, &comment, version)) {
1.19 markus 296: had_identities = 1;
1.30 markus 297: if (do_fp) {
298: fp = key_fingerprint(key, SSH_FP_MD5,
299: SSH_FP_HEX);
1.23 markus 300: printf("%d %s %s (%s)\n",
1.30 markus 301: key_size(key), fp, comment, key_type(key));
302: xfree(fp);
1.12 markus 303: } else {
1.19 markus 304: if (!key_write(key, stdout))
305: fprintf(stderr, "key_write failed");
306: fprintf(stdout, " %s\n", comment);
1.12 markus 307: }
1.19 markus 308: key_free(key);
309: xfree(comment);
1.12 markus 310: }
311: }
1.50 markus 312: if (!had_identities) {
1.12 markus 313: printf("The agent has no identities.\n");
1.50 markus 314: return -1;
315: }
316: return 0;
1.1 deraadt 317: }
318:
1.48 djm 319: static int
1.54 markus 320: lock_agent(AuthenticationConnection *ac, int lock)
321: {
322: char prompt[100], *p1, *p2;
323: int passok = 1, ret = -1;
1.61 deraadt 324:
1.54 markus 325: strlcpy(prompt, "Enter lock password: ", sizeof(prompt));
326: p1 = read_passphrase(prompt, RP_ALLOW_STDIN);
327: if (lock) {
328: strlcpy(prompt, "Again: ", sizeof prompt);
329: p2 = read_passphrase(prompt, RP_ALLOW_STDIN);
330: if (strcmp(p1, p2) != 0) {
331: fprintf(stderr, "Passwords do not match.\n");
332: passok = 0;
333: }
334: memset(p2, 0, strlen(p2));
335: xfree(p2);
336: }
337: if (passok && ssh_lock_agent(ac, lock, p1)) {
338: fprintf(stderr, "Agent %slocked.\n", lock ? "" : "un");
339: ret = 0;
340: } else
341: fprintf(stderr, "Failed to %slock agent.\n", lock ? "" : "un");
342: memset(p1, 0, strlen(p1));
343: xfree(p1);
1.62 markus 344: return (ret);
1.54 markus 345: }
346:
347: static int
1.102 djm 348: do_file(AuthenticationConnection *ac, int deleting, int key_only, char *file)
1.48 djm 349: {
350: if (deleting) {
351: if (delete_file(ac, file) == -1)
352: return -1;
353: } else {
1.102 djm 354: if (add_file(ac, file, key_only) == -1)
1.48 djm 355: return -1;
356: }
357: return 0;
358: }
359:
1.42 markus 360: static void
361: usage(void)
362: {
1.90 sobrado 363: fprintf(stderr, "usage: %s [options] [file ...]\n", __progname);
1.45 jakob 364: fprintf(stderr, "Options:\n");
365: fprintf(stderr, " -l List fingerprints of all identities.\n");
366: fprintf(stderr, " -L List public key parameters of all identities.\n");
1.103 ! djm 367: fprintf(stderr, " -k Load only keys and not certificates.\n");
! 368: fprintf(stderr, " -c Require confirmation to sign using identities\n");
! 369: fprintf(stderr, " -t life Set lifetime (in seconds) when adding identities.\n");
1.45 jakob 370: fprintf(stderr, " -d Delete identity.\n");
371: fprintf(stderr, " -D Delete all identities.\n");
1.55 markus 372: fprintf(stderr, " -x Lock agent.\n");
1.63 markus 373: fprintf(stderr, " -X Unlock agent.\n");
1.92 markus 374: fprintf(stderr, " -s pkcs11 Add keys from PKCS#11 provider.\n");
375: fprintf(stderr, " -e pkcs11 Remove keys provided by PKCS#11 provider.\n");
1.42 markus 376: }
377:
1.2 provos 378: int
1.7 markus 379: main(int argc, char **argv)
1.1 deraadt 380: {
1.43 markus 381: extern char *optarg;
382: extern int optind;
1.12 markus 383: AuthenticationConnection *ac = NULL;
1.92 markus 384: char *pkcs11provider = NULL;
1.102 djm 385: int i, ch, deleting = 0, ret = 0, key_only = 0;
1.73 djm 386:
387: /* Ensure that fds 0, 1 and 2 are open or directed to /dev/null */
388: sanitise_stdfd();
1.12 markus 389:
1.100 djm 390: OpenSSL_add_all_algorithms();
1.19 markus 391:
1.12 markus 392: /* At first, get a connection to the authentication agent. */
393: ac = ssh_get_authentication_connection();
394: if (ac == NULL) {
1.74 deraadt 395: fprintf(stderr,
396: "Could not open a connection to your authentication agent.\n");
1.50 markus 397: exit(2);
1.12 markus 398: }
1.102 djm 399: while ((ch = getopt(argc, argv, "klLcdDxXe:s:t:")) != -1) {
1.43 markus 400: switch (ch) {
1.102 djm 401: case 'k':
402: key_only = 1;
403: break;
1.43 markus 404: case 'l':
405: case 'L':
1.50 markus 406: if (list_identities(ac, ch == 'l' ? 1 : 0) == -1)
1.54 markus 407: ret = 1;
408: goto done;
409: case 'x':
410: case 'X':
411: if (lock_agent(ac, ch == 'x' ? 1 : 0) == -1)
1.50 markus 412: ret = 1;
1.43 markus 413: goto done;
1.65 markus 414: case 'c':
415: confirm = 1;
1.43 markus 416: break;
417: case 'd':
1.12 markus 418: deleting = 1;
1.43 markus 419: break;
420: case 'D':
1.46 djm 421: if (delete_all(ac) == -1)
422: ret = 1;
1.43 markus 423: goto done;
424: case 's':
1.92 markus 425: pkcs11provider = optarg;
1.43 markus 426: break;
427: case 'e':
1.47 deraadt 428: deleting = 1;
1.92 markus 429: pkcs11provider = optarg;
1.56 markus 430: break;
431: case 't':
1.57 stevesk 432: if ((lifetime = convtime(optarg)) == -1) {
433: fprintf(stderr, "Invalid lifetime\n");
434: ret = 1;
435: goto done;
436: }
1.43 markus 437: break;
438: default:
439: usage();
1.46 djm 440: ret = 1;
441: goto done;
1.42 markus 442: }
443: }
1.43 markus 444: argc -= optind;
445: argv += optind;
1.92 markus 446: if (pkcs11provider != NULL) {
447: if (update_card(ac, !deleting, pkcs11provider) == -1)
1.46 djm 448: ret = 1;
1.43 markus 449: goto done;
1.12 markus 450: }
1.43 markus 451: if (argc == 0) {
1.48 djm 452: char buf[MAXPATHLEN];
453: struct passwd *pw;
1.52 markus 454: struct stat st;
455: int count = 0;
1.48 djm 456:
457: if ((pw = getpwuid(getuid())) == NULL) {
1.20 deraadt 458: fprintf(stderr, "No user found with uid %u\n",
459: (u_int)getuid());
1.46 djm 460: ret = 1;
461: goto done;
1.12 markus 462: }
1.48 djm 463:
1.71 deraadt 464: for (i = 0; default_files[i]; i++) {
1.51 markus 465: snprintf(buf, sizeof(buf), "%s/%s", pw->pw_dir,
1.48 djm 466: default_files[i]);
1.52 markus 467: if (stat(buf, &st) < 0)
468: continue;
1.102 djm 469: if (do_file(ac, deleting, key_only, buf) == -1)
1.46 djm 470: ret = 1;
1.52 markus 471: else
472: count++;
1.46 djm 473: }
1.52 markus 474: if (count == 0)
475: ret = 1;
1.43 markus 476: } else {
1.71 deraadt 477: for (i = 0; i < argc; i++) {
1.102 djm 478: if (do_file(ac, deleting, key_only, argv[i]) == -1)
1.48 djm 479: ret = 1;
1.43 markus 480: }
1.12 markus 481: }
1.33 markus 482: clear_pass();
1.43 markus 483:
484: done:
1.12 markus 485: ssh_close_authentication_connection(ac);
1.46 djm 486: return ret;
1.1 deraadt 487: }