2 * Author: Tatu Ylonen <ylo@cs.hut.fi>
3 * Copyright (c) 1994 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
5 * Identity and host key generation and maintenance.
7 * As far as I am concerned, the code I have written for this software
8 * can be used freely for any purpose. Any derived versions of this
9 * software must be clearly marked as such, and if the derived work is
10 * incompatible with the protocol description in the RFC file, it must be
11 * called by a name other than "ssh" or "Secure Shell".
15 RCSID("$OpenBSD: ssh-keygen.c,v 1.51 2001/03/21 14:20:45 jakob Exp $");
17 #include <openssl/evp.h>
18 #include <openssl/pem.h>
26 #include "pathnames.h"
30 /* Number of bits in the RSA/DSA key. This value can be changed on the command line. */
34 * Flag indicating that we just want to change the passphrase. This can be
35 * set on the command line.
37 int change_passphrase = 0;
40 * Flag indicating that we just want to change the comment. This can be set
41 * on the command line.
43 int change_comment = 0;
47 /* Flag indicating that we just want to see the key fingerprint */
48 int print_fingerprint = 0;
49 int print_bubblebabble = 0;
51 /* The identity file name, given on the command line or entered by the user. */
52 char identity_file[1024];
53 int have_identity = 0;
55 /* This is set to the passphrase if given on the command line. */
56 char *identity_passphrase = NULL;
58 /* This is set to the new passphrase if given on the command line. */
59 char *identity_new_passphrase = NULL;
61 /* This is set to the new comment if given on the command line. */
62 char *identity_comment = NULL;
64 /* Dump public key file in format used by real and the original SSH 2 */
65 int convert_to_ssh2 = 0;
66 int convert_from_ssh2 = 0;
69 /* default to RSA for SSH-1 */
70 char *key_type_name = "rsa1";
73 #ifdef HAVE___PROGNAME
74 extern char *__progname;
79 char hostname[MAXHOSTNAMELEN];
82 ask_filename(struct passwd *pw, const char *prompt)
87 switch (key_type_from_name(key_type_name)) {
89 name = _PATH_SSH_CLIENT_IDENTITY;
92 name = _PATH_SSH_CLIENT_ID_DSA;
95 name = _PATH_SSH_CLIENT_ID_RSA;
98 fprintf(stderr, "bad key type");
102 snprintf(identity_file, sizeof(identity_file), "%s/%s", pw->pw_dir, name);
103 fprintf(stderr, "%s (%s): ", prompt, identity_file);
105 if (fgets(buf, sizeof(buf), stdin) == NULL)
107 if (strchr(buf, '\n'))
108 *strchr(buf, '\n') = 0;
109 if (strcmp(buf, "") != 0)
110 strlcpy(identity_file, buf, sizeof(identity_file));
115 try_load_key(char *filename, Key *k)
118 if (!load_private_key(filename, "", k, NULL)) {
119 char *pass = read_passphrase("Enter passphrase: ", 1);
120 if (!load_private_key(filename, pass, k, NULL)) {
123 memset(pass, 0, strlen(pass));
129 #define SSH_COM_PUBLIC_BEGIN "---- BEGIN SSH2 PUBLIC KEY ----"
130 #define SSH_COM_PUBLIC_END "---- END SSH2 PUBLIC KEY ----"
131 #define SSH_COM_PRIVATE_BEGIN "---- BEGIN SSH2 ENCRYPTED PRIVATE KEY ----"
132 #define SSH_COM_PRIVATE_KEY_MAGIC 0x3f6ff9eb
135 do_convert_to_ssh2(struct passwd *pw)
143 ask_filename(pw, "Enter file in which the key is");
144 if (stat(identity_file, &st) < 0) {
145 perror(identity_file);
148 k = key_new(KEY_UNSPEC);
149 if (!try_load_key(identity_file, k)) {
150 fprintf(stderr, "load failed\n");
153 key_to_blob(k, &blob, &len);
154 fprintf(stdout, "%s\n", SSH_COM_PUBLIC_BEGIN);
156 "Comment: \"%d-bit %s, converted from OpenSSH by %s@%s\"\n",
157 key_size(k), key_type(k),
158 pw->pw_name, hostname);
159 dump_base64(stdout, blob, len);
160 fprintf(stdout, "%s\n", SSH_COM_PUBLIC_END);
167 buffer_get_bignum_bits(Buffer *b, BIGNUM *value)
169 int bits = buffer_get_int(b);
170 int bytes = (bits + 7) / 8;
171 if (buffer_len(b) < bytes)
172 fatal("buffer_get_bignum_bits: input buffer too small");
173 BN_bin2bn((u_char *)buffer_ptr(b), bytes, value);
174 buffer_consume(b, bytes);
178 do_convert_private_ssh2_from_blob(char *blob, int blen)
183 int ignore, magic, rlen;
187 buffer_append(&b, blob, blen);
189 magic = buffer_get_int(&b);
190 if (magic != SSH_COM_PRIVATE_KEY_MAGIC) {
191 error("bad magic 0x%x != 0x%x", magic, SSH_COM_PRIVATE_KEY_MAGIC);
195 ignore = buffer_get_int(&b);
196 type = buffer_get_string(&b, NULL);
197 cipher = buffer_get_string(&b, NULL);
198 ignore = buffer_get_int(&b);
199 ignore = buffer_get_int(&b);
200 ignore = buffer_get_int(&b);
203 if (strcmp(cipher, "none") != 0) {
204 error("unsupported cipher %s", cipher);
211 key = key_new(KEY_DSA);
213 dsa->priv_key = BN_new();
214 if (dsa->priv_key == NULL) {
215 error("alloc priv_key failed");
219 buffer_get_bignum_bits(&b, dsa->p);
220 buffer_get_bignum_bits(&b, dsa->g);
221 buffer_get_bignum_bits(&b, dsa->q);
222 buffer_get_bignum_bits(&b, dsa->pub_key);
223 buffer_get_bignum_bits(&b, dsa->priv_key);
224 rlen = buffer_len(&b);
226 error("do_convert_private_ssh2_from_blob: remaining bytes in key blob %d", rlen);
232 do_convert_from_ssh2(struct passwd *pw)
240 int escaped = 0, private = 0, ok;
244 ask_filename(pw, "Enter file in which the key is");
245 if (stat(identity_file, &st) < 0) {
246 perror(identity_file);
249 fp = fopen(identity_file, "r");
251 perror(identity_file);
255 while (fgets(line, sizeof(line), fp)) {
256 if (!(p = strchr(line, '\n'))) {
257 fprintf(stderr, "input line too long.\n");
260 if (p > line && p[-1] == '\\')
262 if (strncmp(line, "----", 4) == 0 ||
263 strstr(line, ": ") != NULL) {
264 if (strstr(line, SSH_COM_PRIVATE_BEGIN) != NULL)
266 fprintf(stderr, "ignore: %s", line);
271 fprintf(stderr, "escaped: %s", line);
275 strlcat(encoded, line, sizeof(encoded));
277 blen = uudecode(encoded, (u_char *)blob, sizeof(blob));
279 fprintf(stderr, "uudecode failed.\n");
283 do_convert_private_ssh2_from_blob(blob, blen) :
284 key_from_blob(blob, blen);
286 fprintf(stderr, "decode blob failed.\n");
290 PEM_write_DSAPrivateKey(stdout, k->dsa, NULL, NULL, 0, NULL, NULL) :
291 key_write(k, stdout);
293 fprintf(stderr, "key write failed");
297 fprintf(stdout, "\n");
303 do_print_public(struct passwd *pw)
309 ask_filename(pw, "Enter file in which the key is");
310 if (stat(identity_file, &st) < 0) {
311 perror(identity_file);
314 k = key_new(KEY_UNSPEC);
315 if (!try_load_key(identity_file, k)) {
316 fprintf(stderr, "load failed\n");
319 if (!key_write(k, stdout))
320 fprintf(stderr, "key_write failed");
322 fprintf(stdout, "\n");
327 do_fingerprint(struct passwd *pw)
331 char *comment = NULL, *cp, *ep, line[16*1024], *fp;
332 int i, skip = 0, num = 1, invalid = 1, success = 0, rep, type;
335 type = print_bubblebabble ? SSH_FP_SHA1 : SSH_FP_MD5;
336 rep = print_bubblebabble ? SSH_FP_BUBBLEBABBLE : SSH_FP_HEX;
339 ask_filename(pw, "Enter file in which the key is");
340 if (stat(identity_file, &st) < 0) {
341 perror(identity_file);
344 public = key_new(KEY_RSA1);
345 if (load_public_key(identity_file, public, &comment)) {
349 public = key_new(KEY_UNSPEC);
350 if (try_load_public_key(identity_file, public, &comment))
353 debug("try_load_public_key KEY_UNSPEC failed");
356 fp = key_fingerprint(public, type, rep);
357 printf("%d %s %s\n", key_size(public),
365 f = fopen(identity_file, "r");
367 while (fgets(line, sizeof(line), f)) {
368 i = strlen(line) - 1;
369 if (line[i] != '\n') {
370 error("line %d too long: %.40s...", num, line);
381 /* Skip leading whitespace, empty and comment lines. */
382 for (cp = line; *cp == ' ' || *cp == '\t'; cp++)
384 if (!*cp || *cp == '\n' || *cp == '#')
386 i = strtol(cp, &ep, 10);
387 if (i == 0 || ep == NULL || (*ep != ' ' && *ep != '\t')) {
390 for (; *cp && (quoted || (*cp != ' ' && *cp != '\t')); cp++) {
391 if (*cp == '\\' && cp[1] == '"')
392 cp++; /* Skip both */
401 public = key_new(KEY_RSA1);
402 if (key_read(public, &cp) != 1) {
405 public = key_new(KEY_UNSPEC);
406 if (key_read(public, &cp) != 1) {
411 comment = *cp ? cp : comment;
412 fp = key_fingerprint(public, type, rep);
413 printf("%d %s %s\n", key_size(public), fp,
414 comment ? comment : "no comment");
422 printf("%s is not a valid key file.\n", identity_file);
429 * Perform changing a passphrase. The argument is the passwd structure
430 * for the current user.
433 do_change_passphrase(struct passwd *pw)
436 char *old_passphrase, *passphrase1, *passphrase2;
443 ask_filename(pw, "Enter file in which the key is");
444 if (stat(identity_file, &st) < 0) {
445 perror(identity_file);
448 public = key_new(type);
449 if (!load_public_key(identity_file, public, NULL)) {
452 /* Clear the public key since we are just about to load the whole file. */
455 /* Try to load the file with empty passphrase. */
456 private = key_new(type);
457 if (!load_private_key(identity_file, "", private, &comment)) {
458 if (identity_passphrase)
459 old_passphrase = xstrdup(identity_passphrase);
461 old_passphrase = read_passphrase("Enter old passphrase: ", 1);
462 if (!load_private_key(identity_file, old_passphrase, private, &comment)) {
463 memset(old_passphrase, 0, strlen(old_passphrase));
464 xfree(old_passphrase);
465 printf("Bad passphrase.\n");
468 memset(old_passphrase, 0, strlen(old_passphrase));
469 xfree(old_passphrase);
471 printf("Key has comment '%s'\n", comment);
473 /* Ask the new passphrase (twice). */
474 if (identity_new_passphrase) {
475 passphrase1 = xstrdup(identity_new_passphrase);
479 read_passphrase("Enter new passphrase (empty for no passphrase): ", 1);
480 passphrase2 = read_passphrase("Enter same passphrase again: ", 1);
482 /* Verify that they are the same. */
483 if (strcmp(passphrase1, passphrase2) != 0) {
484 memset(passphrase1, 0, strlen(passphrase1));
485 memset(passphrase2, 0, strlen(passphrase2));
488 printf("Pass phrases do not match. Try again.\n");
491 /* Destroy the other copy. */
492 memset(passphrase2, 0, strlen(passphrase2));
496 /* Save the file using the new passphrase. */
497 if (!save_private_key(identity_file, passphrase1, private, comment)) {
498 printf("Saving the key failed: %s: %s.\n",
499 identity_file, strerror(errno));
500 memset(passphrase1, 0, strlen(passphrase1));
506 /* Destroy the passphrase and the copy of the key in memory. */
507 memset(passphrase1, 0, strlen(passphrase1));
509 key_free(private); /* Destroys contents */
512 printf("Your identification has been saved with the new passphrase.\n");
517 * Change the comment of a private key file.
520 do_change_comment(struct passwd *pw)
522 char new_comment[1024], *comment, *passphrase;
523 Key *private, *public;
529 ask_filename(pw, "Enter file in which the key is");
530 if (stat(identity_file, &st) < 0) {
531 perror(identity_file);
535 * Try to load the public key from the file the verify that it is
536 * readable and of the proper format.
538 public = key_new(KEY_RSA1);
539 if (!load_public_key(identity_file, public, NULL)) {
540 printf("%s is not a valid key file.\n", identity_file);
541 printf("Comments are only supported in RSA1 keys\n");
545 private = key_new(KEY_RSA1);
546 if (load_private_key(identity_file, "", private, &comment))
547 passphrase = xstrdup("");
549 if (identity_passphrase)
550 passphrase = xstrdup(identity_passphrase);
551 else if (identity_new_passphrase)
552 passphrase = xstrdup(identity_new_passphrase);
554 passphrase = read_passphrase("Enter passphrase: ", 1);
555 /* Try to load using the passphrase. */
556 if (!load_private_key(identity_file, passphrase, private, &comment)) {
557 memset(passphrase, 0, strlen(passphrase));
559 printf("Bad passphrase.\n");
563 printf("Key now has comment '%s'\n", comment);
565 if (identity_comment) {
566 strlcpy(new_comment, identity_comment, sizeof(new_comment));
568 printf("Enter new comment: ");
570 if (!fgets(new_comment, sizeof(new_comment), stdin)) {
571 memset(passphrase, 0, strlen(passphrase));
575 if (strchr(new_comment, '\n'))
576 *strchr(new_comment, '\n') = 0;
579 /* Save the file using the new passphrase. */
580 if (!save_private_key(identity_file, passphrase, private, new_comment)) {
581 printf("Saving the key failed: %s: %s.\n",
582 identity_file, strerror(errno));
583 memset(passphrase, 0, strlen(passphrase));
589 memset(passphrase, 0, strlen(passphrase));
593 strlcat(identity_file, ".pub", sizeof(identity_file));
594 fd = open(identity_file, O_WRONLY | O_CREAT | O_TRUNC, 0644);
596 printf("Could not save your public key in %s\n", identity_file);
601 printf("fdopen %s failed", identity_file);
604 if (!key_write(public, f))
605 fprintf(stderr, "write key failed");
607 fprintf(f, " %s\n", new_comment);
612 printf("The comment in your key file has been changed.\n");
619 printf("Usage: %s [-lBpqxXyc] [-t type] [-b bits] [-f file] [-C comment] "
620 "[-N new-pass] [-P pass]\n", __progname);
625 * Main program for key management.
628 main(int ac, char **av)
630 char dotsshdir[16 * 1024], comment[1024], *passphrase1, *passphrase2;
631 Key *private, *public;
640 __progname = get_progname(av[0]);
644 SSLeay_add_all_algorithms();
646 /* we need this for the home * directory. */
647 pw = getpwuid(getuid());
649 printf("You don't exist, go away!\n");
652 if (gethostname(hostname, sizeof(hostname)) < 0) {
653 perror("gethostname");
657 while ((opt = getopt(ac, av, "dqpclBRxXyb:f:t:P:N:C:")) != -1) {
661 if (bits < 512 || bits > 32768) {
662 printf("Bits has bad value.\n");
668 print_fingerprint = 1;
672 print_bubblebabble = 1;
676 change_passphrase = 1;
684 strlcpy(identity_file, optarg, sizeof(identity_file));
689 identity_passphrase = optarg;
693 identity_new_passphrase = optarg;
697 identity_comment = optarg;
714 convert_from_ssh2 = 1;
722 key_type_name = "dsa";
726 key_type_name = optarg;
735 printf("Too many arguments.\n");
738 if (change_passphrase && change_comment) {
739 printf("Can only have one of -p and -c.\n");
742 if (print_fingerprint || print_bubblebabble)
744 if (change_passphrase)
745 do_change_passphrase(pw);
747 do_change_comment(pw);
749 do_convert_to_ssh2(pw);
750 if (convert_from_ssh2)
751 do_convert_from_ssh2(pw);
757 type = key_type_from_name(key_type_name);
758 if (type == KEY_UNSPEC) {
759 fprintf(stderr, "unknown key type %s\n", key_type_name);
763 printf("Generating public/private %s key pair.\n", key_type_name);
764 private = key_generate(type, bits);
765 if (private == NULL) {
766 fprintf(stderr, "key_generate failed");
769 public = key_from_private(private);
772 ask_filename(pw, "Enter file in which to save the key");
774 /* Create ~/.ssh directory if it doesn\'t already exist. */
775 snprintf(dotsshdir, sizeof dotsshdir, "%s/%s", pw->pw_dir, _PATH_SSH_USER_DIR);
776 if (strstr(identity_file, dotsshdir) != NULL &&
777 stat(dotsshdir, &st) < 0) {
778 if (mkdir(dotsshdir, 0700) < 0)
779 error("Could not create directory '%s'.", dotsshdir);
781 printf("Created directory '%s'.\n", dotsshdir);
783 /* If the file already exists, ask the user to confirm. */
784 if (stat(identity_file, &st) >= 0) {
786 printf("%s already exists.\n", identity_file);
787 printf("Overwrite (y/n)? ");
789 if (fgets(yesno, sizeof(yesno), stdin) == NULL)
791 if (yesno[0] != 'y' && yesno[0] != 'Y')
794 /* Ask for a passphrase (twice). */
795 if (identity_passphrase)
796 passphrase1 = xstrdup(identity_passphrase);
797 else if (identity_new_passphrase)
798 passphrase1 = xstrdup(identity_new_passphrase);
802 read_passphrase("Enter passphrase (empty for no passphrase): ", 1);
803 passphrase2 = read_passphrase("Enter same passphrase again: ", 1);
804 if (strcmp(passphrase1, passphrase2) != 0) {
805 /* The passphrases do not match. Clear them and retry. */
806 memset(passphrase1, 0, strlen(passphrase1));
807 memset(passphrase2, 0, strlen(passphrase2));
810 printf("Passphrases do not match. Try again.\n");
811 goto passphrase_again;
813 /* Clear the other copy of the passphrase. */
814 memset(passphrase2, 0, strlen(passphrase2));
818 if (identity_comment) {
819 strlcpy(comment, identity_comment, sizeof(comment));
821 /* Create default commend field for the passphrase. */
822 snprintf(comment, sizeof comment, "%s@%s", pw->pw_name, hostname);
825 /* Save the key with the given passphrase and comment. */
826 if (!save_private_key(identity_file, passphrase1, private, comment)) {
827 printf("Saving the key failed: %s: %s.\n",
828 identity_file, strerror(errno));
829 memset(passphrase1, 0, strlen(passphrase1));
833 /* Clear the passphrase. */
834 memset(passphrase1, 0, strlen(passphrase1));
837 /* Clear the private key and the random number generator. */
842 printf("Your identification has been saved in %s.\n", identity_file);
844 strlcat(identity_file, ".pub", sizeof(identity_file));
845 fd = open(identity_file, O_WRONLY | O_CREAT | O_TRUNC, 0644);
847 printf("Could not save your public key in %s\n", identity_file);
852 printf("fdopen %s failed", identity_file);
855 if (!key_write(public, f))
856 fprintf(stderr, "write key failed");
857 fprintf(f, " %s\n", comment);
861 char *fp = key_fingerprint(public, SSH_FP_MD5, SSH_FP_HEX);
862 printf("Your public key has been saved in %s.\n",
864 printf("The key fingerprint is:\n");
865 printf("%s %s\n", fp, comment);