Annotation of src/usr.bin/ssh/ssh-add.c, Revision 1.99
1.99 ! djm 1: /* $OpenBSD: ssh-add.c,v 1.98 2010/08/16 04:06:06 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.7 markus 136: add_file(AuthenticationConnection *ac, const char *filename)
1.1 deraadt 137: {
1.93 djm 138: Key *private, *cert;
1.36 markus 139: char *comment = NULL;
1.93 djm 140: char msg[1024], *certpath;
1.76 dtucker 141: int fd, perms_ok, ret = -1;
1.12 markus 142:
1.83 stevesk 143: if ((fd = open(filename, O_RDONLY)) < 0) {
1.19 markus 144: perror(filename);
1.46 djm 145: return -1;
1.19 markus 146: }
1.76 dtucker 147:
148: /*
149: * Since we'll try to load a keyfile multiple times, permission errors
150: * will occur multiple times, so check perms first and bail if wrong.
151: */
152: perms_ok = key_perm_ok(fd, filename);
153: close(fd);
154: if (!perms_ok)
155: return -1;
156:
1.12 markus 157: /* At first, try empty passphrase */
1.31 markus 158: private = key_load_private(filename, "", &comment);
159: if (comment == NULL)
160: comment = xstrdup(filename);
1.33 markus 161: /* try last */
162: if (private == NULL && pass != NULL)
163: private = key_load_private(filename, pass, NULL);
1.31 markus 164: if (private == NULL) {
1.33 markus 165: /* clear passphrase since it did not work */
166: clear_pass();
1.37 markus 167: snprintf(msg, sizeof msg, "Enter passphrase for %.200s: ",
1.72 djm 168: comment);
1.12 markus 169: for (;;) {
1.40 markus 170: pass = read_passphrase(msg, RP_ALLOW_STDIN);
1.12 markus 171: if (strcmp(pass, "") == 0) {
1.35 markus 172: clear_pass();
1.31 markus 173: xfree(comment);
1.46 djm 174: return -1;
1.12 markus 175: }
1.31 markus 176: private = key_load_private(filename, pass, &comment);
177: if (private != NULL)
1.12 markus 178: break;
1.33 markus 179: clear_pass();
1.68 markus 180: snprintf(msg, sizeof msg,
181: "Bad passphrase, try again for %.200s: ", comment);
1.12 markus 182: }
183: }
1.60 markus 184:
1.69 djm 185: if (ssh_add_identity_constrained(ac, private, comment, lifetime,
186: confirm)) {
1.60 markus 187: fprintf(stderr, "Identity added: %s (%s)\n", filename, comment);
188: ret = 0;
189: if (lifetime != 0)
1.64 deraadt 190: fprintf(stderr,
1.60 markus 191: "Lifetime set to %d seconds\n", lifetime);
1.69 djm 192: if (confirm != 0)
1.65 markus 193: fprintf(stderr,
1.96 djm 194: "The user must confirm each use of the key\n");
1.60 markus 195: } else {
1.12 markus 196: fprintf(stderr, "Could not add identity: %s\n", filename);
1.56 markus 197: }
198:
1.93 djm 199:
200: /* Now try to add the certificate flavour too */
201: xasprintf(&certpath, "%s-cert.pub", filename);
1.96 djm 202: if ((cert = key_load_public(certpath, NULL)) == NULL)
203: goto out;
204:
205: if (!key_equal_public(cert, private)) {
206: error("Certificate %s does not match private key %s",
207: certpath, filename);
1.93 djm 208: key_free(cert);
1.96 djm 209: goto out;
210: }
1.93 djm 211:
1.96 djm 212: /* Graft with private bits */
213: if (key_to_certified(private, key_cert_is_legacy(cert)) != 0) {
214: error("%s: key_to_certified failed", __func__);
215: key_free(cert);
216: goto out;
1.94 otto 217: }
1.96 djm 218: key_cert_copy(cert, private);
219: key_free(cert);
1.93 djm 220:
1.96 djm 221: if (!ssh_add_identity_constrained(ac, private, comment,
222: lifetime, confirm)) {
223: error("Certificate %s (%s) add failed", certpath,
224: private->cert->key_id);
225: }
226: fprintf(stderr, "Certificate added: %s (%s)\n", certpath,
227: private->cert->key_id);
228: if (lifetime != 0)
229: fprintf(stderr, "Lifetime set to %d seconds\n", lifetime);
230: if (confirm != 0)
231: fprintf(stderr, "The user must confirm each use of the key\n");
232: out:
1.93 djm 233: xfree(certpath);
1.31 markus 234: xfree(comment);
1.16 markus 235: key_free(private);
1.47 deraadt 236:
1.46 djm 237: return ret;
1.1 deraadt 238: }
239:
1.46 djm 240: static int
1.44 markus 241: update_card(AuthenticationConnection *ac, int add, const char *id)
1.42 markus 242: {
1.53 rees 243: char *pin;
1.66 markus 244: int ret = -1;
1.53 rees 245:
1.92 markus 246: pin = read_passphrase("Enter passphrase for PKCS#11: ", RP_ALLOW_STDIN);
1.53 rees 247: if (pin == NULL)
248: return -1;
249:
1.67 djm 250: if (ssh_update_card(ac, add, id, pin, lifetime, confirm)) {
1.44 markus 251: fprintf(stderr, "Card %s: %s\n",
1.47 deraadt 252: add ? "added" : "removed", id);
1.66 markus 253: ret = 0;
1.46 djm 254: } else {
1.44 markus 255: fprintf(stderr, "Could not %s card: %s\n",
1.47 deraadt 256: add ? "add" : "remove", id);
1.66 markus 257: ret = -1;
1.46 djm 258: }
1.66 markus 259: xfree(pin);
260: return ret;
1.42 markus 261: }
262:
1.50 markus 263: static int
1.30 markus 264: list_identities(AuthenticationConnection *ac, int do_fp)
1.1 deraadt 265: {
1.19 markus 266: Key *key;
1.30 markus 267: char *comment, *fp;
1.19 markus 268: int had_identities = 0;
269: int version;
1.12 markus 270:
1.19 markus 271: for (version = 1; version <= 2; version++) {
272: for (key = ssh_get_first_identity(ac, &comment, version);
1.47 deraadt 273: key != NULL;
274: key = ssh_get_next_identity(ac, &comment, version)) {
1.19 markus 275: had_identities = 1;
1.30 markus 276: if (do_fp) {
277: fp = key_fingerprint(key, SSH_FP_MD5,
278: SSH_FP_HEX);
1.23 markus 279: printf("%d %s %s (%s)\n",
1.30 markus 280: key_size(key), fp, comment, key_type(key));
281: xfree(fp);
1.12 markus 282: } else {
1.19 markus 283: if (!key_write(key, stdout))
284: fprintf(stderr, "key_write failed");
285: fprintf(stdout, " %s\n", comment);
1.12 markus 286: }
1.19 markus 287: key_free(key);
288: xfree(comment);
1.12 markus 289: }
290: }
1.50 markus 291: if (!had_identities) {
1.12 markus 292: printf("The agent has no identities.\n");
1.50 markus 293: return -1;
294: }
295: return 0;
1.1 deraadt 296: }
297:
1.48 djm 298: static int
1.54 markus 299: lock_agent(AuthenticationConnection *ac, int lock)
300: {
301: char prompt[100], *p1, *p2;
302: int passok = 1, ret = -1;
1.61 deraadt 303:
1.54 markus 304: strlcpy(prompt, "Enter lock password: ", sizeof(prompt));
305: p1 = read_passphrase(prompt, RP_ALLOW_STDIN);
306: if (lock) {
307: strlcpy(prompt, "Again: ", sizeof prompt);
308: p2 = read_passphrase(prompt, RP_ALLOW_STDIN);
309: if (strcmp(p1, p2) != 0) {
310: fprintf(stderr, "Passwords do not match.\n");
311: passok = 0;
312: }
313: memset(p2, 0, strlen(p2));
314: xfree(p2);
315: }
316: if (passok && ssh_lock_agent(ac, lock, p1)) {
317: fprintf(stderr, "Agent %slocked.\n", lock ? "" : "un");
318: ret = 0;
319: } else
320: fprintf(stderr, "Failed to %slock agent.\n", lock ? "" : "un");
321: memset(p1, 0, strlen(p1));
322: xfree(p1);
1.62 markus 323: return (ret);
1.54 markus 324: }
325:
326: static int
1.48 djm 327: do_file(AuthenticationConnection *ac, int deleting, char *file)
328: {
329: if (deleting) {
330: if (delete_file(ac, file) == -1)
331: return -1;
332: } else {
333: if (add_file(ac, file) == -1)
334: return -1;
335: }
336: return 0;
337: }
338:
1.42 markus 339: static void
340: usage(void)
341: {
1.90 sobrado 342: fprintf(stderr, "usage: %s [options] [file ...]\n", __progname);
1.45 jakob 343: fprintf(stderr, "Options:\n");
344: fprintf(stderr, " -l List fingerprints of all identities.\n");
345: fprintf(stderr, " -L List public key parameters of all identities.\n");
346: fprintf(stderr, " -d Delete identity.\n");
347: fprintf(stderr, " -D Delete all identities.\n");
1.55 markus 348: fprintf(stderr, " -x Lock agent.\n");
1.63 markus 349: fprintf(stderr, " -X Unlock agent.\n");
1.56 markus 350: fprintf(stderr, " -t life Set lifetime (in seconds) when adding identities.\n");
1.65 markus 351: fprintf(stderr, " -c Require confirmation to sign using identities\n");
1.92 markus 352: fprintf(stderr, " -s pkcs11 Add keys from PKCS#11 provider.\n");
353: fprintf(stderr, " -e pkcs11 Remove keys provided by PKCS#11 provider.\n");
1.42 markus 354: }
355:
1.2 provos 356: int
1.7 markus 357: main(int argc, char **argv)
1.1 deraadt 358: {
1.43 markus 359: extern char *optarg;
360: extern int optind;
1.12 markus 361: AuthenticationConnection *ac = NULL;
1.92 markus 362: char *pkcs11provider = NULL;
1.46 djm 363: int i, ch, deleting = 0, ret = 0;
1.73 djm 364:
365: /* Ensure that fds 0, 1 and 2 are open or directed to /dev/null */
366: sanitise_stdfd();
1.12 markus 367:
1.98 djm 368: SSLeay_add_all_algorithms();
1.19 markus 369:
1.12 markus 370: /* At first, get a connection to the authentication agent. */
371: ac = ssh_get_authentication_connection();
372: if (ac == NULL) {
1.74 deraadt 373: fprintf(stderr,
374: "Could not open a connection to your authentication agent.\n");
1.50 markus 375: exit(2);
1.12 markus 376: }
1.65 markus 377: while ((ch = getopt(argc, argv, "lLcdDxXe:s:t:")) != -1) {
1.43 markus 378: switch (ch) {
379: case 'l':
380: case 'L':
1.50 markus 381: if (list_identities(ac, ch == 'l' ? 1 : 0) == -1)
1.54 markus 382: ret = 1;
383: goto done;
384: case 'x':
385: case 'X':
386: if (lock_agent(ac, ch == 'x' ? 1 : 0) == -1)
1.50 markus 387: ret = 1;
1.43 markus 388: goto done;
1.65 markus 389: case 'c':
390: confirm = 1;
1.43 markus 391: break;
392: case 'd':
1.12 markus 393: deleting = 1;
1.43 markus 394: break;
395: case 'D':
1.46 djm 396: if (delete_all(ac) == -1)
397: ret = 1;
1.43 markus 398: goto done;
399: case 's':
1.92 markus 400: pkcs11provider = optarg;
1.43 markus 401: break;
402: case 'e':
1.47 deraadt 403: deleting = 1;
1.92 markus 404: pkcs11provider = optarg;
1.56 markus 405: break;
406: case 't':
1.57 stevesk 407: if ((lifetime = convtime(optarg)) == -1) {
408: fprintf(stderr, "Invalid lifetime\n");
409: ret = 1;
410: goto done;
411: }
1.43 markus 412: break;
413: default:
414: usage();
1.46 djm 415: ret = 1;
416: goto done;
1.42 markus 417: }
418: }
1.43 markus 419: argc -= optind;
420: argv += optind;
1.92 markus 421: if (pkcs11provider != NULL) {
422: if (update_card(ac, !deleting, pkcs11provider) == -1)
1.46 djm 423: ret = 1;
1.43 markus 424: goto done;
1.12 markus 425: }
1.43 markus 426: if (argc == 0) {
1.48 djm 427: char buf[MAXPATHLEN];
428: struct passwd *pw;
1.52 markus 429: struct stat st;
430: int count = 0;
1.48 djm 431:
432: if ((pw = getpwuid(getuid())) == NULL) {
1.20 deraadt 433: fprintf(stderr, "No user found with uid %u\n",
434: (u_int)getuid());
1.46 djm 435: ret = 1;
436: goto done;
1.12 markus 437: }
1.48 djm 438:
1.71 deraadt 439: for (i = 0; default_files[i]; i++) {
1.51 markus 440: snprintf(buf, sizeof(buf), "%s/%s", pw->pw_dir,
1.48 djm 441: default_files[i]);
1.52 markus 442: if (stat(buf, &st) < 0)
443: continue;
1.48 djm 444: if (do_file(ac, deleting, buf) == -1)
1.46 djm 445: ret = 1;
1.52 markus 446: else
447: count++;
1.46 djm 448: }
1.52 markus 449: if (count == 0)
450: ret = 1;
1.43 markus 451: } else {
1.71 deraadt 452: for (i = 0; i < argc; i++) {
1.49 deraadt 453: if (do_file(ac, deleting, argv[i]) == -1)
1.48 djm 454: ret = 1;
1.43 markus 455: }
1.12 markus 456: }
1.33 markus 457: clear_pass();
1.43 markus 458:
459: done:
1.12 markus 460: ssh_close_authentication_connection(ac);
1.46 djm 461: return ret;
1.1 deraadt 462: }