- (dtucker) [openbsd-compat/fake-rfc2553.h] rename ssh_gai_strerror hack
[openssh-git.git] / ssh-keygen.c
blobadacbff0b1ebd408dad79dab2eee887ee1167781
1 /* $OpenBSD: ssh-keygen.c,v 1.165 2008/01/19 22:37:19 djm Exp $ */
2 /*
3 * Author: Tatu Ylonen <ylo@cs.hut.fi>
4 * Copyright (c) 1994 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
5 * All rights reserved
6 * Identity and host key generation and maintenance.
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".
15 #include "includes.h"
17 #include <sys/types.h>
18 #include <sys/socket.h>
19 #include <sys/stat.h>
20 #include <sys/param.h>
22 #include <openssl/evp.h>
23 #include <openssl/pem.h>
25 #include <errno.h>
26 #include <fcntl.h>
27 #include <netdb.h>
28 #ifdef HAVE_PATHS_H
29 # include <paths.h>
30 #endif
31 #include <pwd.h>
32 #include <stdarg.h>
33 #include <stdio.h>
34 #include <stdlib.h>
35 #include <string.h>
36 #include <unistd.h>
38 #include "xmalloc.h"
39 #include "key.h"
40 #include "rsa.h"
41 #include "authfile.h"
42 #include "uuencode.h"
43 #include "buffer.h"
44 #include "pathnames.h"
45 #include "log.h"
46 #include "misc.h"
47 #include "match.h"
48 #include "hostfile.h"
49 #include "dns.h"
51 #ifdef SMARTCARD
52 #include "scard.h"
53 #endif
55 /* Number of bits in the RSA/DSA key. This value can be set on the command line. */
56 #define DEFAULT_BITS 2048
57 #define DEFAULT_BITS_DSA 1024
58 u_int32_t bits = 0;
61 * Flag indicating that we just want to change the passphrase. This can be
62 * set on the command line.
64 int change_passphrase = 0;
67 * Flag indicating that we just want to change the comment. This can be set
68 * on the command line.
70 int change_comment = 0;
72 int quiet = 0;
74 /* Flag indicating that we want to hash a known_hosts file */
75 int hash_hosts = 0;
76 /* Flag indicating that we want lookup a host in known_hosts file */
77 int find_host = 0;
78 /* Flag indicating that we want to delete a host from a known_hosts file */
79 int delete_host = 0;
81 /* Flag indicating that we just want to see the key fingerprint */
82 int print_fingerprint = 0;
83 int print_bubblebabble = 0;
85 /* The identity file name, given on the command line or entered by the user. */
86 char identity_file[1024];
87 int have_identity = 0;
89 /* This is set to the passphrase if given on the command line. */
90 char *identity_passphrase = NULL;
92 /* This is set to the new passphrase if given on the command line. */
93 char *identity_new_passphrase = NULL;
95 /* This is set to the new comment if given on the command line. */
96 char *identity_comment = NULL;
98 /* Dump public key file in format used by real and the original SSH 2 */
99 int convert_to_ssh2 = 0;
100 int convert_from_ssh2 = 0;
101 int print_public = 0;
102 int print_generic = 0;
104 char *key_type_name = NULL;
106 /* argv0 */
107 extern char *__progname;
109 char hostname[MAXHOSTNAMELEN];
111 /* moduli.c */
112 int gen_candidates(FILE *, u_int32_t, u_int32_t, BIGNUM *);
113 int prime_test(FILE *, FILE *, u_int32_t, u_int32_t);
115 static void
116 ask_filename(struct passwd *pw, const char *prompt)
118 char buf[1024];
119 char *name = NULL;
121 if (key_type_name == NULL)
122 name = _PATH_SSH_CLIENT_ID_RSA;
123 else {
124 switch (key_type_from_name(key_type_name)) {
125 case KEY_RSA1:
126 name = _PATH_SSH_CLIENT_IDENTITY;
127 break;
128 case KEY_DSA:
129 name = _PATH_SSH_CLIENT_ID_DSA;
130 break;
131 case KEY_RSA:
132 name = _PATH_SSH_CLIENT_ID_RSA;
133 break;
134 default:
135 fprintf(stderr, "bad key type");
136 exit(1);
137 break;
140 snprintf(identity_file, sizeof(identity_file), "%s/%s", pw->pw_dir, name);
141 fprintf(stderr, "%s (%s): ", prompt, identity_file);
142 if (fgets(buf, sizeof(buf), stdin) == NULL)
143 exit(1);
144 buf[strcspn(buf, "\n")] = '\0';
145 if (strcmp(buf, "") != 0)
146 strlcpy(identity_file, buf, sizeof(identity_file));
147 have_identity = 1;
150 static Key *
151 load_identity(char *filename)
153 char *pass;
154 Key *prv;
156 prv = key_load_private(filename, "", NULL);
157 if (prv == NULL) {
158 if (identity_passphrase)
159 pass = xstrdup(identity_passphrase);
160 else
161 pass = read_passphrase("Enter passphrase: ",
162 RP_ALLOW_STDIN);
163 prv = key_load_private(filename, pass, NULL);
164 memset(pass, 0, strlen(pass));
165 xfree(pass);
167 return prv;
170 #define SSH_COM_PUBLIC_BEGIN "---- BEGIN SSH2 PUBLIC KEY ----"
171 #define SSH_COM_PUBLIC_END "---- END SSH2 PUBLIC KEY ----"
172 #define SSH_COM_PRIVATE_BEGIN "---- BEGIN SSH2 ENCRYPTED PRIVATE KEY ----"
173 #define SSH_COM_PRIVATE_KEY_MAGIC 0x3f6ff9eb
175 static void
176 do_convert_to_ssh2(struct passwd *pw)
178 Key *k;
179 u_int len;
180 u_char *blob;
181 struct stat st;
183 if (!have_identity)
184 ask_filename(pw, "Enter file in which the key is");
185 if (stat(identity_file, &st) < 0) {
186 perror(identity_file);
187 exit(1);
189 if ((k = key_load_public(identity_file, NULL)) == NULL) {
190 if ((k = load_identity(identity_file)) == NULL) {
191 fprintf(stderr, "load failed\n");
192 exit(1);
195 if (k->type == KEY_RSA1) {
196 fprintf(stderr, "version 1 keys are not supported\n");
197 exit(1);
199 if (key_to_blob(k, &blob, &len) <= 0) {
200 fprintf(stderr, "key_to_blob failed\n");
201 exit(1);
203 fprintf(stdout, "%s\n", SSH_COM_PUBLIC_BEGIN);
204 fprintf(stdout,
205 "Comment: \"%u-bit %s, converted from OpenSSH by %s@%s\"\n",
206 key_size(k), key_type(k),
207 pw->pw_name, hostname);
208 dump_base64(stdout, blob, len);
209 fprintf(stdout, "%s\n", SSH_COM_PUBLIC_END);
210 key_free(k);
211 xfree(blob);
212 exit(0);
215 static void
216 buffer_get_bignum_bits(Buffer *b, BIGNUM *value)
218 u_int bignum_bits = buffer_get_int(b);
219 u_int bytes = (bignum_bits + 7) / 8;
221 if (buffer_len(b) < bytes)
222 fatal("buffer_get_bignum_bits: input buffer too small: "
223 "need %d have %d", bytes, buffer_len(b));
224 if (BN_bin2bn(buffer_ptr(b), bytes, value) == NULL)
225 fatal("buffer_get_bignum_bits: BN_bin2bn failed");
226 buffer_consume(b, bytes);
229 static Key *
230 do_convert_private_ssh2_from_blob(u_char *blob, u_int blen)
232 Buffer b;
233 Key *key = NULL;
234 char *type, *cipher;
235 u_char *sig, data[] = "abcde12345";
236 int magic, rlen, ktype, i1, i2, i3, i4;
237 u_int slen;
238 u_long e;
240 buffer_init(&b);
241 buffer_append(&b, blob, blen);
243 magic = buffer_get_int(&b);
244 if (magic != SSH_COM_PRIVATE_KEY_MAGIC) {
245 error("bad magic 0x%x != 0x%x", magic, SSH_COM_PRIVATE_KEY_MAGIC);
246 buffer_free(&b);
247 return NULL;
249 i1 = buffer_get_int(&b);
250 type = buffer_get_string(&b, NULL);
251 cipher = buffer_get_string(&b, NULL);
252 i2 = buffer_get_int(&b);
253 i3 = buffer_get_int(&b);
254 i4 = buffer_get_int(&b);
255 debug("ignore (%d %d %d %d)", i1, i2, i3, i4);
256 if (strcmp(cipher, "none") != 0) {
257 error("unsupported cipher %s", cipher);
258 xfree(cipher);
259 buffer_free(&b);
260 xfree(type);
261 return NULL;
263 xfree(cipher);
265 if (strstr(type, "dsa")) {
266 ktype = KEY_DSA;
267 } else if (strstr(type, "rsa")) {
268 ktype = KEY_RSA;
269 } else {
270 buffer_free(&b);
271 xfree(type);
272 return NULL;
274 key = key_new_private(ktype);
275 xfree(type);
277 switch (key->type) {
278 case KEY_DSA:
279 buffer_get_bignum_bits(&b, key->dsa->p);
280 buffer_get_bignum_bits(&b, key->dsa->g);
281 buffer_get_bignum_bits(&b, key->dsa->q);
282 buffer_get_bignum_bits(&b, key->dsa->pub_key);
283 buffer_get_bignum_bits(&b, key->dsa->priv_key);
284 break;
285 case KEY_RSA:
286 e = buffer_get_char(&b);
287 debug("e %lx", e);
288 if (e < 30) {
289 e <<= 8;
290 e += buffer_get_char(&b);
291 debug("e %lx", e);
292 e <<= 8;
293 e += buffer_get_char(&b);
294 debug("e %lx", e);
296 if (!BN_set_word(key->rsa->e, e)) {
297 buffer_free(&b);
298 key_free(key);
299 return NULL;
301 buffer_get_bignum_bits(&b, key->rsa->d);
302 buffer_get_bignum_bits(&b, key->rsa->n);
303 buffer_get_bignum_bits(&b, key->rsa->iqmp);
304 buffer_get_bignum_bits(&b, key->rsa->q);
305 buffer_get_bignum_bits(&b, key->rsa->p);
306 rsa_generate_additional_parameters(key->rsa);
307 break;
309 rlen = buffer_len(&b);
310 if (rlen != 0)
311 error("do_convert_private_ssh2_from_blob: "
312 "remaining bytes in key blob %d", rlen);
313 buffer_free(&b);
315 /* try the key */
316 key_sign(key, &sig, &slen, data, sizeof(data));
317 key_verify(key, sig, slen, data, sizeof(data));
318 xfree(sig);
319 return key;
322 static int
323 get_line(FILE *fp, char *line, size_t len)
325 int c;
326 size_t pos = 0;
328 line[0] = '\0';
329 while ((c = fgetc(fp)) != EOF) {
330 if (pos >= len - 1) {
331 fprintf(stderr, "input line too long.\n");
332 exit(1);
334 switch (c) {
335 case '\r':
336 c = fgetc(fp);
337 if (c != EOF && c != '\n' && ungetc(c, fp) == EOF) {
338 fprintf(stderr, "unget: %s\n", strerror(errno));
339 exit(1);
341 return pos;
342 case '\n':
343 return pos;
345 line[pos++] = c;
346 line[pos] = '\0';
348 /* We reached EOF */
349 return -1;
352 static void
353 do_convert_from_ssh2(struct passwd *pw)
355 Key *k;
356 int blen;
357 u_int len;
358 char line[1024];
359 u_char blob[8096];
360 char encoded[8096];
361 struct stat st;
362 int escaped = 0, private = 0, ok;
363 FILE *fp;
365 if (!have_identity)
366 ask_filename(pw, "Enter file in which the key is");
367 if (stat(identity_file, &st) < 0) {
368 perror(identity_file);
369 exit(1);
371 fp = fopen(identity_file, "r");
372 if (fp == NULL) {
373 perror(identity_file);
374 exit(1);
376 encoded[0] = '\0';
377 while ((blen = get_line(fp, line, sizeof(line))) != -1) {
378 if (line[blen - 1] == '\\')
379 escaped++;
380 if (strncmp(line, "----", 4) == 0 ||
381 strstr(line, ": ") != NULL) {
382 if (strstr(line, SSH_COM_PRIVATE_BEGIN) != NULL)
383 private = 1;
384 if (strstr(line, " END ") != NULL) {
385 break;
387 /* fprintf(stderr, "ignore: %s", line); */
388 continue;
390 if (escaped) {
391 escaped--;
392 /* fprintf(stderr, "escaped: %s", line); */
393 continue;
395 strlcat(encoded, line, sizeof(encoded));
397 len = strlen(encoded);
398 if (((len % 4) == 3) &&
399 (encoded[len-1] == '=') &&
400 (encoded[len-2] == '=') &&
401 (encoded[len-3] == '='))
402 encoded[len-3] = '\0';
403 blen = uudecode(encoded, blob, sizeof(blob));
404 if (blen < 0) {
405 fprintf(stderr, "uudecode failed.\n");
406 exit(1);
408 k = private ?
409 do_convert_private_ssh2_from_blob(blob, blen) :
410 key_from_blob(blob, blen);
411 if (k == NULL) {
412 fprintf(stderr, "decode blob failed.\n");
413 exit(1);
415 ok = private ?
416 (k->type == KEY_DSA ?
417 PEM_write_DSAPrivateKey(stdout, k->dsa, NULL, NULL, 0, NULL, NULL) :
418 PEM_write_RSAPrivateKey(stdout, k->rsa, NULL, NULL, 0, NULL, NULL)) :
419 key_write(k, stdout);
420 if (!ok) {
421 fprintf(stderr, "key write failed");
422 exit(1);
424 key_free(k);
425 if (!private)
426 fprintf(stdout, "\n");
427 fclose(fp);
428 exit(0);
431 static void
432 do_print_public(struct passwd *pw)
434 Key *prv;
435 struct stat st;
437 if (!have_identity)
438 ask_filename(pw, "Enter file in which the key is");
439 if (stat(identity_file, &st) < 0) {
440 perror(identity_file);
441 exit(1);
443 prv = load_identity(identity_file);
444 if (prv == NULL) {
445 fprintf(stderr, "load failed\n");
446 exit(1);
448 if (!key_write(prv, stdout))
449 fprintf(stderr, "key_write failed");
450 key_free(prv);
451 fprintf(stdout, "\n");
452 exit(0);
455 #ifdef SMARTCARD
456 static void
457 do_upload(struct passwd *pw, const char *sc_reader_id)
459 Key *prv = NULL;
460 struct stat st;
461 int ret;
463 if (!have_identity)
464 ask_filename(pw, "Enter file in which the key is");
465 if (stat(identity_file, &st) < 0) {
466 perror(identity_file);
467 exit(1);
469 prv = load_identity(identity_file);
470 if (prv == NULL) {
471 error("load failed");
472 exit(1);
474 ret = sc_put_key(prv, sc_reader_id);
475 key_free(prv);
476 if (ret < 0)
477 exit(1);
478 logit("loading key done");
479 exit(0);
482 static void
483 do_download(struct passwd *pw, const char *sc_reader_id)
485 Key **keys = NULL;
486 int i;
488 keys = sc_get_keys(sc_reader_id, NULL);
489 if (keys == NULL)
490 fatal("cannot read public key from smartcard");
491 for (i = 0; keys[i]; i++) {
492 key_write(keys[i], stdout);
493 key_free(keys[i]);
494 fprintf(stdout, "\n");
496 xfree(keys);
497 exit(0);
499 #endif /* SMARTCARD */
501 static void
502 do_fingerprint(struct passwd *pw)
504 FILE *f;
505 Key *public;
506 char *comment = NULL, *cp, *ep, line[16*1024], *fp;
507 int i, skip = 0, num = 0, invalid = 1;
508 enum fp_rep rep;
509 enum fp_type fptype;
510 struct stat st;
512 fptype = print_bubblebabble ? SSH_FP_SHA1 : SSH_FP_MD5;
513 rep = print_bubblebabble ? SSH_FP_BUBBLEBABBLE : SSH_FP_HEX;
515 if (!have_identity)
516 ask_filename(pw, "Enter file in which the key is");
517 if (stat(identity_file, &st) < 0) {
518 perror(identity_file);
519 exit(1);
521 public = key_load_public(identity_file, &comment);
522 if (public != NULL) {
523 fp = key_fingerprint(public, fptype, rep);
524 printf("%u %s %s\n", key_size(public), fp, comment);
525 key_free(public);
526 xfree(comment);
527 xfree(fp);
528 exit(0);
530 if (comment) {
531 xfree(comment);
532 comment = NULL;
535 f = fopen(identity_file, "r");
536 if (f != NULL) {
537 while (fgets(line, sizeof(line), f)) {
538 if ((cp = strchr(line, '\n')) == NULL) {
539 error("line %d too long: %.40s...",
540 num + 1, line);
541 skip = 1;
542 continue;
544 num++;
545 if (skip) {
546 skip = 0;
547 continue;
549 *cp = '\0';
551 /* Skip leading whitespace, empty and comment lines. */
552 for (cp = line; *cp == ' ' || *cp == '\t'; cp++)
554 if (!*cp || *cp == '\n' || *cp == '#')
555 continue;
556 i = strtol(cp, &ep, 10);
557 if (i == 0 || ep == NULL || (*ep != ' ' && *ep != '\t')) {
558 int quoted = 0;
559 comment = cp;
560 for (; *cp && (quoted || (*cp != ' ' &&
561 *cp != '\t')); cp++) {
562 if (*cp == '\\' && cp[1] == '"')
563 cp++; /* Skip both */
564 else if (*cp == '"')
565 quoted = !quoted;
567 if (!*cp)
568 continue;
569 *cp++ = '\0';
571 ep = cp;
572 public = key_new(KEY_RSA1);
573 if (key_read(public, &cp) != 1) {
574 cp = ep;
575 key_free(public);
576 public = key_new(KEY_UNSPEC);
577 if (key_read(public, &cp) != 1) {
578 key_free(public);
579 continue;
582 comment = *cp ? cp : comment;
583 fp = key_fingerprint(public, fptype, rep);
584 printf("%u %s %s\n", key_size(public), fp,
585 comment ? comment : "no comment");
586 xfree(fp);
587 key_free(public);
588 invalid = 0;
590 fclose(f);
592 if (invalid) {
593 printf("%s is not a public key file.\n", identity_file);
594 exit(1);
596 exit(0);
599 static void
600 print_host(FILE *f, const char *name, Key *public, int hash)
602 if (hash && (name = host_hash(name, NULL, 0)) == NULL)
603 fatal("hash_host failed");
604 fprintf(f, "%s ", name);
605 if (!key_write(public, f))
606 fatal("key_write failed");
607 fprintf(f, "\n");
610 static void
611 do_known_hosts(struct passwd *pw, const char *name)
613 FILE *in, *out = stdout;
614 Key *public;
615 char *cp, *cp2, *kp, *kp2;
616 char line[16*1024], tmp[MAXPATHLEN], old[MAXPATHLEN];
617 int c, skip = 0, inplace = 0, num = 0, invalid = 0, has_unhashed = 0;
619 if (!have_identity) {
620 cp = tilde_expand_filename(_PATH_SSH_USER_HOSTFILE, pw->pw_uid);
621 if (strlcpy(identity_file, cp, sizeof(identity_file)) >=
622 sizeof(identity_file))
623 fatal("Specified known hosts path too long");
624 xfree(cp);
625 have_identity = 1;
627 if ((in = fopen(identity_file, "r")) == NULL)
628 fatal("fopen: %s", strerror(errno));
631 * Find hosts goes to stdout, hash and deletions happen in-place
632 * A corner case is ssh-keygen -HF foo, which should go to stdout
634 if (!find_host && (hash_hosts || delete_host)) {
635 if (strlcpy(tmp, identity_file, sizeof(tmp)) >= sizeof(tmp) ||
636 strlcat(tmp, ".XXXXXXXXXX", sizeof(tmp)) >= sizeof(tmp) ||
637 strlcpy(old, identity_file, sizeof(old)) >= sizeof(old) ||
638 strlcat(old, ".old", sizeof(old)) >= sizeof(old))
639 fatal("known_hosts path too long");
640 umask(077);
641 if ((c = mkstemp(tmp)) == -1)
642 fatal("mkstemp: %s", strerror(errno));
643 if ((out = fdopen(c, "w")) == NULL) {
644 c = errno;
645 unlink(tmp);
646 fatal("fdopen: %s", strerror(c));
648 inplace = 1;
651 while (fgets(line, sizeof(line), in)) {
652 if ((cp = strchr(line, '\n')) == NULL) {
653 error("line %d too long: %.40s...", num + 1, line);
654 skip = 1;
655 invalid = 1;
656 continue;
658 num++;
659 if (skip) {
660 skip = 0;
661 continue;
663 *cp = '\0';
665 /* Skip leading whitespace, empty and comment lines. */
666 for (cp = line; *cp == ' ' || *cp == '\t'; cp++)
668 if (!*cp || *cp == '\n' || *cp == '#') {
669 if (inplace)
670 fprintf(out, "%s\n", cp);
671 continue;
673 /* Find the end of the host name portion. */
674 for (kp = cp; *kp && *kp != ' ' && *kp != '\t'; kp++)
676 if (*kp == '\0' || *(kp + 1) == '\0') {
677 error("line %d missing key: %.40s...",
678 num, line);
679 invalid = 1;
680 continue;
682 *kp++ = '\0';
683 kp2 = kp;
685 public = key_new(KEY_RSA1);
686 if (key_read(public, &kp) != 1) {
687 kp = kp2;
688 key_free(public);
689 public = key_new(KEY_UNSPEC);
690 if (key_read(public, &kp) != 1) {
691 error("line %d invalid key: %.40s...",
692 num, line);
693 key_free(public);
694 invalid = 1;
695 continue;
699 if (*cp == HASH_DELIM) {
700 if (find_host || delete_host) {
701 cp2 = host_hash(name, cp, strlen(cp));
702 if (cp2 == NULL) {
703 error("line %d: invalid hashed "
704 "name: %.64s...", num, line);
705 invalid = 1;
706 continue;
708 c = (strcmp(cp2, cp) == 0);
709 if (find_host && c) {
710 printf("# Host %s found: "
711 "line %d type %s\n", name,
712 num, key_type(public));
713 print_host(out, cp, public, 0);
715 if (delete_host && !c)
716 print_host(out, cp, public, 0);
717 } else if (hash_hosts)
718 print_host(out, cp, public, 0);
719 } else {
720 if (find_host || delete_host) {
721 c = (match_hostname(name, cp,
722 strlen(cp)) == 1);
723 if (find_host && c) {
724 printf("# Host %s found: "
725 "line %d type %s\n", name,
726 num, key_type(public));
727 print_host(out, name, public,
728 hash_hosts);
730 if (delete_host && !c)
731 print_host(out, cp, public, 0);
732 } else if (hash_hosts) {
733 for (cp2 = strsep(&cp, ",");
734 cp2 != NULL && *cp2 != '\0';
735 cp2 = strsep(&cp, ",")) {
736 if (strcspn(cp2, "*?!") != strlen(cp2))
737 fprintf(stderr, "Warning: "
738 "ignoring host name with "
739 "metacharacters: %.64s\n",
740 cp2);
741 else
742 print_host(out, cp2, public, 1);
744 has_unhashed = 1;
747 key_free(public);
749 fclose(in);
751 if (invalid) {
752 fprintf(stderr, "%s is not a valid known_hosts file.\n",
753 identity_file);
754 if (inplace) {
755 fprintf(stderr, "Not replacing existing known_hosts "
756 "file because of errors\n");
757 fclose(out);
758 unlink(tmp);
760 exit(1);
763 if (inplace) {
764 fclose(out);
766 /* Backup existing file */
767 if (unlink(old) == -1 && errno != ENOENT)
768 fatal("unlink %.100s: %s", old, strerror(errno));
769 if (link(identity_file, old) == -1)
770 fatal("link %.100s to %.100s: %s", identity_file, old,
771 strerror(errno));
772 /* Move new one into place */
773 if (rename(tmp, identity_file) == -1) {
774 error("rename\"%s\" to \"%s\": %s", tmp, identity_file,
775 strerror(errno));
776 unlink(tmp);
777 unlink(old);
778 exit(1);
781 fprintf(stderr, "%s updated.\n", identity_file);
782 fprintf(stderr, "Original contents retained as %s\n", old);
783 if (has_unhashed) {
784 fprintf(stderr, "WARNING: %s contains unhashed "
785 "entries\n", old);
786 fprintf(stderr, "Delete this file to ensure privacy "
787 "of hostnames\n");
791 exit(0);
795 * Perform changing a passphrase. The argument is the passwd structure
796 * for the current user.
798 static void
799 do_change_passphrase(struct passwd *pw)
801 char *comment;
802 char *old_passphrase, *passphrase1, *passphrase2;
803 struct stat st;
804 Key *private;
806 if (!have_identity)
807 ask_filename(pw, "Enter file in which the key is");
808 if (stat(identity_file, &st) < 0) {
809 perror(identity_file);
810 exit(1);
812 /* Try to load the file with empty passphrase. */
813 private = key_load_private(identity_file, "", &comment);
814 if (private == NULL) {
815 if (identity_passphrase)
816 old_passphrase = xstrdup(identity_passphrase);
817 else
818 old_passphrase =
819 read_passphrase("Enter old passphrase: ",
820 RP_ALLOW_STDIN);
821 private = key_load_private(identity_file, old_passphrase,
822 &comment);
823 memset(old_passphrase, 0, strlen(old_passphrase));
824 xfree(old_passphrase);
825 if (private == NULL) {
826 printf("Bad passphrase.\n");
827 exit(1);
830 printf("Key has comment '%s'\n", comment);
832 /* Ask the new passphrase (twice). */
833 if (identity_new_passphrase) {
834 passphrase1 = xstrdup(identity_new_passphrase);
835 passphrase2 = NULL;
836 } else {
837 passphrase1 =
838 read_passphrase("Enter new passphrase (empty for no "
839 "passphrase): ", RP_ALLOW_STDIN);
840 passphrase2 = read_passphrase("Enter same passphrase again: ",
841 RP_ALLOW_STDIN);
843 /* Verify that they are the same. */
844 if (strcmp(passphrase1, passphrase2) != 0) {
845 memset(passphrase1, 0, strlen(passphrase1));
846 memset(passphrase2, 0, strlen(passphrase2));
847 xfree(passphrase1);
848 xfree(passphrase2);
849 printf("Pass phrases do not match. Try again.\n");
850 exit(1);
852 /* Destroy the other copy. */
853 memset(passphrase2, 0, strlen(passphrase2));
854 xfree(passphrase2);
857 /* Save the file using the new passphrase. */
858 if (!key_save_private(private, identity_file, passphrase1, comment)) {
859 printf("Saving the key failed: %s.\n", identity_file);
860 memset(passphrase1, 0, strlen(passphrase1));
861 xfree(passphrase1);
862 key_free(private);
863 xfree(comment);
864 exit(1);
866 /* Destroy the passphrase and the copy of the key in memory. */
867 memset(passphrase1, 0, strlen(passphrase1));
868 xfree(passphrase1);
869 key_free(private); /* Destroys contents */
870 xfree(comment);
872 printf("Your identification has been saved with the new passphrase.\n");
873 exit(0);
877 * Print the SSHFP RR.
879 static int
880 do_print_resource_record(struct passwd *pw, char *fname, char *hname)
882 Key *public;
883 char *comment = NULL;
884 struct stat st;
886 if (fname == NULL)
887 ask_filename(pw, "Enter file in which the key is");
888 if (stat(fname, &st) < 0) {
889 if (errno == ENOENT)
890 return 0;
891 perror(fname);
892 exit(1);
894 public = key_load_public(fname, &comment);
895 if (public != NULL) {
896 export_dns_rr(hname, public, stdout, print_generic);
897 key_free(public);
898 xfree(comment);
899 return 1;
901 if (comment)
902 xfree(comment);
904 printf("failed to read v2 public key from %s.\n", fname);
905 exit(1);
909 * Change the comment of a private key file.
911 static void
912 do_change_comment(struct passwd *pw)
914 char new_comment[1024], *comment, *passphrase;
915 Key *private;
916 Key *public;
917 struct stat st;
918 FILE *f;
919 int fd;
921 if (!have_identity)
922 ask_filename(pw, "Enter file in which the key is");
923 if (stat(identity_file, &st) < 0) {
924 perror(identity_file);
925 exit(1);
927 private = key_load_private(identity_file, "", &comment);
928 if (private == NULL) {
929 if (identity_passphrase)
930 passphrase = xstrdup(identity_passphrase);
931 else if (identity_new_passphrase)
932 passphrase = xstrdup(identity_new_passphrase);
933 else
934 passphrase = read_passphrase("Enter passphrase: ",
935 RP_ALLOW_STDIN);
936 /* Try to load using the passphrase. */
937 private = key_load_private(identity_file, passphrase, &comment);
938 if (private == NULL) {
939 memset(passphrase, 0, strlen(passphrase));
940 xfree(passphrase);
941 printf("Bad passphrase.\n");
942 exit(1);
944 } else {
945 passphrase = xstrdup("");
947 if (private->type != KEY_RSA1) {
948 fprintf(stderr, "Comments are only supported for RSA1 keys.\n");
949 key_free(private);
950 exit(1);
952 printf("Key now has comment '%s'\n", comment);
954 if (identity_comment) {
955 strlcpy(new_comment, identity_comment, sizeof(new_comment));
956 } else {
957 printf("Enter new comment: ");
958 fflush(stdout);
959 if (!fgets(new_comment, sizeof(new_comment), stdin)) {
960 memset(passphrase, 0, strlen(passphrase));
961 key_free(private);
962 exit(1);
964 new_comment[strcspn(new_comment, "\n")] = '\0';
967 /* Save the file using the new passphrase. */
968 if (!key_save_private(private, identity_file, passphrase, new_comment)) {
969 printf("Saving the key failed: %s.\n", identity_file);
970 memset(passphrase, 0, strlen(passphrase));
971 xfree(passphrase);
972 key_free(private);
973 xfree(comment);
974 exit(1);
976 memset(passphrase, 0, strlen(passphrase));
977 xfree(passphrase);
978 public = key_from_private(private);
979 key_free(private);
981 strlcat(identity_file, ".pub", sizeof(identity_file));
982 fd = open(identity_file, O_WRONLY | O_CREAT | O_TRUNC, 0644);
983 if (fd == -1) {
984 printf("Could not save your public key in %s\n", identity_file);
985 exit(1);
987 f = fdopen(fd, "w");
988 if (f == NULL) {
989 printf("fdopen %s failed", identity_file);
990 exit(1);
992 if (!key_write(public, f))
993 fprintf(stderr, "write key failed");
994 key_free(public);
995 fprintf(f, " %s\n", new_comment);
996 fclose(f);
998 xfree(comment);
1000 printf("The comment in your key file has been changed.\n");
1001 exit(0);
1004 static void
1005 usage(void)
1007 fprintf(stderr, "usage: %s [options]\n", __progname);
1008 fprintf(stderr, "Options:\n");
1009 fprintf(stderr, " -a trials Number of trials for screening DH-GEX moduli.\n");
1010 fprintf(stderr, " -B Show bubblebabble digest of key file.\n");
1011 fprintf(stderr, " -b bits Number of bits in the key to create.\n");
1012 fprintf(stderr, " -C comment Provide new comment.\n");
1013 fprintf(stderr, " -c Change comment in private and public key files.\n");
1014 #ifdef SMARTCARD
1015 fprintf(stderr, " -D reader Download public key from smartcard.\n");
1016 #endif /* SMARTCARD */
1017 fprintf(stderr, " -e Convert OpenSSH to RFC 4716 key file.\n");
1018 fprintf(stderr, " -F hostname Find hostname in known hosts file.\n");
1019 fprintf(stderr, " -f filename Filename of the key file.\n");
1020 fprintf(stderr, " -G file Generate candidates for DH-GEX moduli.\n");
1021 fprintf(stderr, " -g Use generic DNS resource record format.\n");
1022 fprintf(stderr, " -H Hash names in known_hosts file.\n");
1023 fprintf(stderr, " -i Convert RFC 4716 to OpenSSH key file.\n");
1024 fprintf(stderr, " -l Show fingerprint of key file.\n");
1025 fprintf(stderr, " -M memory Amount of memory (MB) to use for generating DH-GEX moduli.\n");
1026 fprintf(stderr, " -N phrase Provide new passphrase.\n");
1027 fprintf(stderr, " -P phrase Provide old passphrase.\n");
1028 fprintf(stderr, " -p Change passphrase of private key file.\n");
1029 fprintf(stderr, " -q Quiet.\n");
1030 fprintf(stderr, " -R hostname Remove host from known_hosts file.\n");
1031 fprintf(stderr, " -r hostname Print DNS resource record.\n");
1032 fprintf(stderr, " -S start Start point (hex) for generating DH-GEX moduli.\n");
1033 fprintf(stderr, " -T file Screen candidates for DH-GEX moduli.\n");
1034 fprintf(stderr, " -t type Specify type of key to create.\n");
1035 #ifdef SMARTCARD
1036 fprintf(stderr, " -U reader Upload private key to smartcard.\n");
1037 #endif /* SMARTCARD */
1038 fprintf(stderr, " -v Verbose.\n");
1039 fprintf(stderr, " -W gen Generator to use for generating DH-GEX moduli.\n");
1040 fprintf(stderr, " -y Read private key file and print public key.\n");
1042 exit(1);
1046 * Main program for key management.
1049 main(int argc, char **argv)
1051 char dotsshdir[MAXPATHLEN], comment[1024], *passphrase1, *passphrase2;
1052 char out_file[MAXPATHLEN], *reader_id = NULL;
1053 char *rr_hostname = NULL;
1054 Key *private, *public;
1055 struct passwd *pw;
1056 struct stat st;
1057 int opt, type, fd, download = 0;
1058 u_int32_t memory = 0, generator_wanted = 0, trials = 100;
1059 int do_gen_candidates = 0, do_screen_candidates = 0;
1060 int log_level = SYSLOG_LEVEL_INFO;
1061 BIGNUM *start = NULL;
1062 FILE *f;
1063 const char *errstr;
1065 extern int optind;
1066 extern char *optarg;
1068 /* Ensure that fds 0, 1 and 2 are open or directed to /dev/null */
1069 sanitise_stdfd();
1071 __progname = ssh_get_progname(argv[0]);
1073 SSLeay_add_all_algorithms();
1074 log_init(argv[0], SYSLOG_LEVEL_INFO, SYSLOG_FACILITY_USER, 1);
1076 init_rng();
1077 seed_rng();
1079 /* we need this for the home * directory. */
1080 pw = getpwuid(getuid());
1081 if (!pw) {
1082 printf("You don't exist, go away!\n");
1083 exit(1);
1085 if (gethostname(hostname, sizeof(hostname)) < 0) {
1086 perror("gethostname");
1087 exit(1);
1090 while ((opt = getopt(argc, argv,
1091 "degiqpclBHvxXyF:b:f:t:U:D:P:N:C:r:g:R:T:G:M:S:a:W:")) != -1) {
1092 switch (opt) {
1093 case 'b':
1094 bits = (u_int32_t)strtonum(optarg, 768, 32768, &errstr);
1095 if (errstr)
1096 fatal("Bits has bad value %s (%s)",
1097 optarg, errstr);
1098 break;
1099 case 'F':
1100 find_host = 1;
1101 rr_hostname = optarg;
1102 break;
1103 case 'H':
1104 hash_hosts = 1;
1105 break;
1106 case 'R':
1107 delete_host = 1;
1108 rr_hostname = optarg;
1109 break;
1110 case 'l':
1111 print_fingerprint = 1;
1112 break;
1113 case 'B':
1114 print_bubblebabble = 1;
1115 break;
1116 case 'p':
1117 change_passphrase = 1;
1118 break;
1119 case 'c':
1120 change_comment = 1;
1121 break;
1122 case 'f':
1123 if (strlcpy(identity_file, optarg, sizeof(identity_file)) >=
1124 sizeof(identity_file))
1125 fatal("Identity filename too long");
1126 have_identity = 1;
1127 break;
1128 case 'g':
1129 print_generic = 1;
1130 break;
1131 case 'P':
1132 identity_passphrase = optarg;
1133 break;
1134 case 'N':
1135 identity_new_passphrase = optarg;
1136 break;
1137 case 'C':
1138 identity_comment = optarg;
1139 break;
1140 case 'q':
1141 quiet = 1;
1142 break;
1143 case 'e':
1144 case 'x':
1145 /* export key */
1146 convert_to_ssh2 = 1;
1147 break;
1148 case 'i':
1149 case 'X':
1150 /* import key */
1151 convert_from_ssh2 = 1;
1152 break;
1153 case 'y':
1154 print_public = 1;
1155 break;
1156 case 'd':
1157 key_type_name = "dsa";
1158 break;
1159 case 't':
1160 key_type_name = optarg;
1161 break;
1162 case 'D':
1163 download = 1;
1164 /*FALLTHROUGH*/
1165 case 'U':
1166 reader_id = optarg;
1167 break;
1168 case 'v':
1169 if (log_level == SYSLOG_LEVEL_INFO)
1170 log_level = SYSLOG_LEVEL_DEBUG1;
1171 else {
1172 if (log_level >= SYSLOG_LEVEL_DEBUG1 &&
1173 log_level < SYSLOG_LEVEL_DEBUG3)
1174 log_level++;
1176 break;
1177 case 'r':
1178 rr_hostname = optarg;
1179 break;
1180 case 'W':
1181 generator_wanted = (u_int32_t)strtonum(optarg, 1,
1182 UINT_MAX, &errstr);
1183 if (errstr)
1184 fatal("Desired generator has bad value: %s (%s)",
1185 optarg, errstr);
1186 break;
1187 case 'a':
1188 trials = (u_int32_t)strtonum(optarg, 1, UINT_MAX, &errstr);
1189 if (errstr)
1190 fatal("Invalid number of trials: %s (%s)",
1191 optarg, errstr);
1192 break;
1193 case 'M':
1194 memory = (u_int32_t)strtonum(optarg, 1, UINT_MAX, &errstr);
1195 if (errstr) {
1196 fatal("Memory limit is %s: %s", errstr, optarg);
1198 break;
1199 case 'G':
1200 do_gen_candidates = 1;
1201 if (strlcpy(out_file, optarg, sizeof(out_file)) >=
1202 sizeof(out_file))
1203 fatal("Output filename too long");
1204 break;
1205 case 'T':
1206 do_screen_candidates = 1;
1207 if (strlcpy(out_file, optarg, sizeof(out_file)) >=
1208 sizeof(out_file))
1209 fatal("Output filename too long");
1210 break;
1211 case 'S':
1212 /* XXX - also compare length against bits */
1213 if (BN_hex2bn(&start, optarg) == 0)
1214 fatal("Invalid start point.");
1215 break;
1216 case '?':
1217 default:
1218 usage();
1222 /* reinit */
1223 log_init(argv[0], log_level, SYSLOG_FACILITY_USER, 1);
1225 if (optind < argc) {
1226 printf("Too many arguments.\n");
1227 usage();
1229 if (change_passphrase && change_comment) {
1230 printf("Can only have one of -p and -c.\n");
1231 usage();
1233 if (delete_host || hash_hosts || find_host)
1234 do_known_hosts(pw, rr_hostname);
1235 if (print_fingerprint || print_bubblebabble)
1236 do_fingerprint(pw);
1237 if (change_passphrase)
1238 do_change_passphrase(pw);
1239 if (change_comment)
1240 do_change_comment(pw);
1241 if (convert_to_ssh2)
1242 do_convert_to_ssh2(pw);
1243 if (convert_from_ssh2)
1244 do_convert_from_ssh2(pw);
1245 if (print_public)
1246 do_print_public(pw);
1247 if (rr_hostname != NULL) {
1248 unsigned int n = 0;
1250 if (have_identity) {
1251 n = do_print_resource_record(pw,
1252 identity_file, rr_hostname);
1253 if (n == 0) {
1254 perror(identity_file);
1255 exit(1);
1257 exit(0);
1258 } else {
1260 n += do_print_resource_record(pw,
1261 _PATH_HOST_RSA_KEY_FILE, rr_hostname);
1262 n += do_print_resource_record(pw,
1263 _PATH_HOST_DSA_KEY_FILE, rr_hostname);
1265 if (n == 0)
1266 fatal("no keys found.");
1267 exit(0);
1270 if (reader_id != NULL) {
1271 #ifdef SMARTCARD
1272 if (download)
1273 do_download(pw, reader_id);
1274 else
1275 do_upload(pw, reader_id);
1276 #else /* SMARTCARD */
1277 fatal("no support for smartcards.");
1278 #endif /* SMARTCARD */
1281 if (do_gen_candidates) {
1282 FILE *out = fopen(out_file, "w");
1284 if (out == NULL) {
1285 error("Couldn't open modulus candidate file \"%s\": %s",
1286 out_file, strerror(errno));
1287 return (1);
1289 if (bits == 0)
1290 bits = DEFAULT_BITS;
1291 if (gen_candidates(out, memory, bits, start) != 0)
1292 fatal("modulus candidate generation failed");
1294 return (0);
1297 if (do_screen_candidates) {
1298 FILE *in;
1299 FILE *out = fopen(out_file, "w");
1301 if (have_identity && strcmp(identity_file, "-") != 0) {
1302 if ((in = fopen(identity_file, "r")) == NULL) {
1303 fatal("Couldn't open modulus candidate "
1304 "file \"%s\": %s", identity_file,
1305 strerror(errno));
1307 } else
1308 in = stdin;
1310 if (out == NULL) {
1311 fatal("Couldn't open moduli file \"%s\": %s",
1312 out_file, strerror(errno));
1314 if (prime_test(in, out, trials, generator_wanted) != 0)
1315 fatal("modulus screening failed");
1316 return (0);
1319 arc4random_stir();
1321 if (key_type_name == NULL)
1322 key_type_name = "rsa";
1324 type = key_type_from_name(key_type_name);
1325 if (type == KEY_UNSPEC) {
1326 fprintf(stderr, "unknown key type %s\n", key_type_name);
1327 exit(1);
1329 if (bits == 0)
1330 bits = (type == KEY_DSA) ? DEFAULT_BITS_DSA : DEFAULT_BITS;
1331 if (type == KEY_DSA && bits != 1024)
1332 fatal("DSA keys must be 1024 bits");
1333 if (!quiet)
1334 printf("Generating public/private %s key pair.\n", key_type_name);
1335 private = key_generate(type, bits);
1336 if (private == NULL) {
1337 fprintf(stderr, "key_generate failed");
1338 exit(1);
1340 public = key_from_private(private);
1342 if (!have_identity)
1343 ask_filename(pw, "Enter file in which to save the key");
1345 /* Create ~/.ssh directory if it doesn't already exist. */
1346 snprintf(dotsshdir, sizeof dotsshdir, "%s/%s", pw->pw_dir, _PATH_SSH_USER_DIR);
1347 if (strstr(identity_file, dotsshdir) != NULL &&
1348 stat(dotsshdir, &st) < 0) {
1349 if (mkdir(dotsshdir, 0700) < 0)
1350 error("Could not create directory '%s'.", dotsshdir);
1351 else if (!quiet)
1352 printf("Created directory '%s'.\n", dotsshdir);
1354 /* If the file already exists, ask the user to confirm. */
1355 if (stat(identity_file, &st) >= 0) {
1356 char yesno[3];
1357 printf("%s already exists.\n", identity_file);
1358 printf("Overwrite (y/n)? ");
1359 fflush(stdout);
1360 if (fgets(yesno, sizeof(yesno), stdin) == NULL)
1361 exit(1);
1362 if (yesno[0] != 'y' && yesno[0] != 'Y')
1363 exit(1);
1365 /* Ask for a passphrase (twice). */
1366 if (identity_passphrase)
1367 passphrase1 = xstrdup(identity_passphrase);
1368 else if (identity_new_passphrase)
1369 passphrase1 = xstrdup(identity_new_passphrase);
1370 else {
1371 passphrase_again:
1372 passphrase1 =
1373 read_passphrase("Enter passphrase (empty for no "
1374 "passphrase): ", RP_ALLOW_STDIN);
1375 passphrase2 = read_passphrase("Enter same passphrase again: ",
1376 RP_ALLOW_STDIN);
1377 if (strcmp(passphrase1, passphrase2) != 0) {
1379 * The passphrases do not match. Clear them and
1380 * retry.
1382 memset(passphrase1, 0, strlen(passphrase1));
1383 memset(passphrase2, 0, strlen(passphrase2));
1384 xfree(passphrase1);
1385 xfree(passphrase2);
1386 printf("Passphrases do not match. Try again.\n");
1387 goto passphrase_again;
1389 /* Clear the other copy of the passphrase. */
1390 memset(passphrase2, 0, strlen(passphrase2));
1391 xfree(passphrase2);
1394 if (identity_comment) {
1395 strlcpy(comment, identity_comment, sizeof(comment));
1396 } else {
1397 /* Create default commend field for the passphrase. */
1398 snprintf(comment, sizeof comment, "%s@%s", pw->pw_name, hostname);
1401 /* Save the key with the given passphrase and comment. */
1402 if (!key_save_private(private, identity_file, passphrase1, comment)) {
1403 printf("Saving the key failed: %s.\n", identity_file);
1404 memset(passphrase1, 0, strlen(passphrase1));
1405 xfree(passphrase1);
1406 exit(1);
1408 /* Clear the passphrase. */
1409 memset(passphrase1, 0, strlen(passphrase1));
1410 xfree(passphrase1);
1412 /* Clear the private key and the random number generator. */
1413 key_free(private);
1414 arc4random_stir();
1416 if (!quiet)
1417 printf("Your identification has been saved in %s.\n", identity_file);
1419 strlcat(identity_file, ".pub", sizeof(identity_file));
1420 fd = open(identity_file, O_WRONLY | O_CREAT | O_TRUNC, 0644);
1421 if (fd == -1) {
1422 printf("Could not save your public key in %s\n", identity_file);
1423 exit(1);
1425 f = fdopen(fd, "w");
1426 if (f == NULL) {
1427 printf("fdopen %s failed", identity_file);
1428 exit(1);
1430 if (!key_write(public, f))
1431 fprintf(stderr, "write key failed");
1432 fprintf(f, " %s\n", comment);
1433 fclose(f);
1435 if (!quiet) {
1436 char *fp = key_fingerprint(public, SSH_FP_MD5, SSH_FP_HEX);
1437 printf("Your public key has been saved in %s.\n",
1438 identity_file);
1439 printf("The key fingerprint is:\n");
1440 printf("%s %s\n", fp, comment);
1441 xfree(fp);
1444 key_free(public);
1445 exit(0);