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