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.60 2001/04/23 22:14:13 markus Exp $");
17 #include <openssl/evp.h>
18 #include <openssl/pem.h>
27 #include "pathnames.h"
31 /* Number of bits in the RSA/DSA key. This value can be changed on the command line. */
35 * Flag indicating that we just want to change the passphrase. This can be
36 * set on the command line.
38 int change_passphrase = 0;
41 * Flag indicating that we just want to change the comment. This can be set
42 * on the command line.
44 int change_comment = 0;
48 /* Flag indicating that we just want to see the key fingerprint */
49 int print_fingerprint = 0;
50 int print_bubblebabble = 0;
52 /* The identity file name, given on the command line or entered by the user. */
53 char identity_file[1024];
54 int have_identity = 0;
56 /* This is set to the passphrase if given on the command line. */
57 char *identity_passphrase = NULL;
59 /* This is set to the new passphrase if given on the command line. */
60 char *identity_new_passphrase = NULL;
62 /* This is set to the new comment if given on the command line. */
63 char *identity_comment = NULL;
65 /* Dump public key file in format used by real and the original SSH 2 */
66 int convert_to_ssh2 = 0;
67 int convert_from_ssh2 = 0;
70 /* default to RSA for SSH-1 */
71 char *key_type_name = "rsa1";
74 extern char *__progname;
76 char hostname[MAXHOSTNAMELEN];
79 ask_filename(struct passwd *pw, const char *prompt)
84 switch (key_type_from_name(key_type_name)) {
86 name = _PATH_SSH_CLIENT_IDENTITY;
89 name = _PATH_SSH_CLIENT_ID_DSA;
92 name = _PATH_SSH_CLIENT_ID_RSA;
95 fprintf(stderr, "bad key type");
99 snprintf(identity_file, sizeof(identity_file), "%s/%s", pw->pw_dir, name);
100 fprintf(stderr, "%s (%s): ", prompt, identity_file);
102 if (fgets(buf, sizeof(buf), stdin) == NULL)
104 if (strchr(buf, '\n'))
105 *strchr(buf, '\n') = 0;
106 if (strcmp(buf, "") != 0)
107 strlcpy(identity_file, buf, sizeof(identity_file));
112 try_load_pem_key(char *filename)
117 prv = key_load_private(filename, "", NULL);
119 pass = read_passphrase("Enter passphrase: ", 1);
120 prv = key_load_private(filename, pass, NULL);
121 memset(pass, 0, strlen(pass));
127 #define SSH_COM_PUBLIC_BEGIN "---- BEGIN SSH2 PUBLIC KEY ----"
128 #define SSH_COM_PUBLIC_END "---- END SSH2 PUBLIC KEY ----"
129 #define SSH_COM_PRIVATE_BEGIN "---- BEGIN SSH2 ENCRYPTED PRIVATE KEY ----"
130 #define SSH_COM_PRIVATE_KEY_MAGIC 0x3f6ff9eb
133 do_convert_to_ssh2(struct passwd *pw)
141 ask_filename(pw, "Enter file in which the key is");
142 if (stat(identity_file, &st) < 0) {
143 perror(identity_file);
146 if ((k = key_load_public(identity_file, NULL)) == NULL) {
147 if ((k = try_load_pem_key(identity_file)) == NULL) {
148 fprintf(stderr, "load failed\n");
152 key_to_blob(k, &blob, &len);
153 fprintf(stdout, "%s\n", SSH_COM_PUBLIC_BEGIN);
155 "Comment: \"%d-bit %s, converted from OpenSSH by %s@%s\"\n",
156 key_size(k), key_type(k),
157 pw->pw_name, hostname);
158 dump_base64(stdout, blob, len);
159 fprintf(stdout, "%s\n", SSH_COM_PUBLIC_END);
166 buffer_get_bignum_bits(Buffer *b, BIGNUM *value)
168 int bits = buffer_get_int(b);
169 int bytes = (bits + 7) / 8;
171 if (buffer_len(b) < bytes)
172 fatal("buffer_get_bignum_bits: input buffer too small: "
173 "need %d have %d", bytes, buffer_len(b));
174 BN_bin2bn((u_char *)buffer_ptr(b), bytes, value);
175 buffer_consume(b, bytes);
179 do_convert_private_ssh2_from_blob(char *blob, int blen)
183 int ignore, magic, rlen, ktype;
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);
202 if (strcmp(cipher, "none") != 0) {
203 error("unsupported cipher %s", cipher);
211 if (strstr(type, "dsa")) {
213 } else if (strstr(type, "rsa")) {
219 key = key_new_private(ktype);
224 buffer_get_bignum_bits(&b, key->dsa->p);
225 buffer_get_bignum_bits(&b, key->dsa->g);
226 buffer_get_bignum_bits(&b, key->dsa->q);
227 buffer_get_bignum_bits(&b, key->dsa->pub_key);
228 buffer_get_bignum_bits(&b, key->dsa->priv_key);
231 if (!BN_set_word(key->rsa->e, (u_long) buffer_get_char(&b))) {
236 buffer_get_bignum_bits(&b, key->rsa->d);
237 buffer_get_bignum_bits(&b, key->rsa->n);
238 buffer_get_bignum_bits(&b, key->rsa->iqmp);
239 buffer_get_bignum_bits(&b, key->rsa->q);
240 buffer_get_bignum_bits(&b, key->rsa->p);
241 generate_additional_parameters(key->rsa);
244 rlen = buffer_len(&b);
246 error("do_convert_private_ssh2_from_blob: "
247 "remaining bytes in key blob %d", rlen);
252 u_char *sig, data[10] = "abcde12345";
254 key_sign(key, &sig, &slen, data, sizeof data);
255 key_verify(key, sig, slen, data, sizeof data);
263 do_convert_from_ssh2(struct passwd *pw)
271 int escaped = 0, private = 0, ok;
275 ask_filename(pw, "Enter file in which the key is");
276 if (stat(identity_file, &st) < 0) {
277 perror(identity_file);
280 fp = fopen(identity_file, "r");
282 perror(identity_file);
286 while (fgets(line, sizeof(line), fp)) {
287 if (!(p = strchr(line, '\n'))) {
288 fprintf(stderr, "input line too long.\n");
291 if (p > line && p[-1] == '\\')
293 if (strncmp(line, "----", 4) == 0 ||
294 strstr(line, ": ") != NULL) {
295 if (strstr(line, SSH_COM_PRIVATE_BEGIN) != NULL)
297 /* fprintf(stderr, "ignore: %s", line); */
302 /* fprintf(stderr, "escaped: %s", line); */
306 strlcat(encoded, line, sizeof(encoded));
308 blen = uudecode(encoded, (u_char *)blob, sizeof(blob));
310 fprintf(stderr, "uudecode failed.\n");
314 do_convert_private_ssh2_from_blob(blob, blen) :
315 key_from_blob(blob, blen);
317 fprintf(stderr, "decode blob failed.\n");
321 (k->type == KEY_DSA ?
322 PEM_write_DSAPrivateKey(stdout, k->dsa, NULL, NULL, 0, NULL, NULL) :
323 PEM_write_RSAPrivateKey(stdout, k->rsa, NULL, NULL, 0, NULL, NULL)) :
324 key_write(k, stdout);
326 fprintf(stderr, "key write failed");
330 fprintf(stdout, "\n");
336 do_print_public(struct passwd *pw)
342 ask_filename(pw, "Enter file in which the key is");
343 if (stat(identity_file, &st) < 0) {
344 perror(identity_file);
347 prv = try_load_pem_key(identity_file);
349 fprintf(stderr, "load failed\n");
352 if (!key_write(prv, stdout))
353 fprintf(stderr, "key_write failed");
355 fprintf(stdout, "\n");
360 do_fingerprint(struct passwd *pw)
364 char *comment = NULL, *cp, *ep, line[16*1024], *fp;
365 int i, skip = 0, num = 1, invalid = 1, rep, fptype;
368 fptype = print_bubblebabble ? SSH_FP_SHA1 : SSH_FP_MD5;
369 rep = print_bubblebabble ? SSH_FP_BUBBLEBABBLE : SSH_FP_HEX;
372 ask_filename(pw, "Enter file in which the key is");
373 if (stat(identity_file, &st) < 0) {
374 perror(identity_file);
377 public = key_load_public(identity_file, &comment);
378 if (public != NULL) {
379 fp = key_fingerprint(public, fptype, rep);
380 printf("%d %s %s\n", key_size(public), fp, comment);
389 f = fopen(identity_file, "r");
391 while (fgets(line, sizeof(line), f)) {
392 i = strlen(line) - 1;
393 if (line[i] != '\n') {
394 error("line %d too long: %.40s...", num, line);
405 /* Skip leading whitespace, empty and comment lines. */
406 for (cp = line; *cp == ' ' || *cp == '\t'; cp++)
408 if (!*cp || *cp == '\n' || *cp == '#')
410 i = strtol(cp, &ep, 10);
411 if (i == 0 || ep == NULL || (*ep != ' ' && *ep != '\t')) {
414 for (; *cp && (quoted || (*cp != ' ' && *cp != '\t')); cp++) {
415 if (*cp == '\\' && cp[1] == '"')
416 cp++; /* Skip both */
425 public = key_new(KEY_RSA1);
426 if (key_read(public, &cp) != 1) {
429 public = key_new(KEY_UNSPEC);
430 if (key_read(public, &cp) != 1) {
435 comment = *cp ? cp : comment;
436 fp = key_fingerprint(public, fptype, rep);
437 printf("%d %s %s\n", key_size(public), fp,
438 comment ? comment : "no comment");
446 printf("%s is not a valid key file.\n", identity_file);
453 * Perform changing a passphrase. The argument is the passwd structure
454 * for the current user.
457 do_change_passphrase(struct passwd *pw)
460 char *old_passphrase, *passphrase1, *passphrase2;
465 ask_filename(pw, "Enter file in which the key is");
466 if (stat(identity_file, &st) < 0) {
467 perror(identity_file);
470 /* Try to load the file with empty passphrase. */
471 private = key_load_private(identity_file, "", &comment);
472 if (private == NULL) {
473 if (identity_passphrase)
474 old_passphrase = xstrdup(identity_passphrase);
476 old_passphrase = read_passphrase("Enter old passphrase: ", 1);
477 private = key_load_private(identity_file, old_passphrase , &comment);
478 memset(old_passphrase, 0, strlen(old_passphrase));
479 xfree(old_passphrase);
480 if (private == NULL) {
481 printf("Bad passphrase.\n");
485 printf("Key has comment '%s'\n", comment);
487 /* Ask the new passphrase (twice). */
488 if (identity_new_passphrase) {
489 passphrase1 = xstrdup(identity_new_passphrase);
493 read_passphrase("Enter new passphrase (empty for no passphrase): ", 1);
494 passphrase2 = read_passphrase("Enter same passphrase again: ", 1);
496 /* Verify that they are the same. */
497 if (strcmp(passphrase1, passphrase2) != 0) {
498 memset(passphrase1, 0, strlen(passphrase1));
499 memset(passphrase2, 0, strlen(passphrase2));
502 printf("Pass phrases do not match. Try again.\n");
505 /* Destroy the other copy. */
506 memset(passphrase2, 0, strlen(passphrase2));
510 /* Save the file using the new passphrase. */
511 if (!key_save_private(private, identity_file, passphrase1, comment)) {
512 printf("Saving the key failed: %s.\n", identity_file);
513 memset(passphrase1, 0, strlen(passphrase1));
519 /* Destroy the passphrase and the copy of the key in memory. */
520 memset(passphrase1, 0, strlen(passphrase1));
522 key_free(private); /* Destroys contents */
525 printf("Your identification has been saved with the new passphrase.\n");
530 * Change the comment of a private key file.
533 do_change_comment(struct passwd *pw)
535 char new_comment[1024], *comment, *passphrase;
543 ask_filename(pw, "Enter file in which the key is");
544 if (stat(identity_file, &st) < 0) {
545 perror(identity_file);
548 private = key_load_private(identity_file, "", &comment);
549 if (private == NULL) {
550 if (identity_passphrase)
551 passphrase = xstrdup(identity_passphrase);
552 else if (identity_new_passphrase)
553 passphrase = xstrdup(identity_new_passphrase);
555 passphrase = read_passphrase("Enter passphrase: ", 1);
556 /* Try to load using the passphrase. */
557 private = key_load_private(identity_file, passphrase, &comment);
558 if (private == NULL) {
559 memset(passphrase, 0, strlen(passphrase));
561 printf("Bad passphrase.\n");
565 passphrase = xstrdup("");
567 if (private->type != KEY_RSA1) {
568 fprintf(stderr, "Comments are only supported for RSA1 keys.\n");
572 printf("Key now has comment '%s'\n", comment);
574 if (identity_comment) {
575 strlcpy(new_comment, identity_comment, sizeof(new_comment));
577 printf("Enter new comment: ");
579 if (!fgets(new_comment, sizeof(new_comment), stdin)) {
580 memset(passphrase, 0, strlen(passphrase));
584 if (strchr(new_comment, '\n'))
585 *strchr(new_comment, '\n') = 0;
588 /* Save the file using the new passphrase. */
589 if (!key_save_private(private, identity_file, passphrase, new_comment)) {
590 printf("Saving the key failed: %s.\n", identity_file);
591 memset(passphrase, 0, strlen(passphrase));
597 memset(passphrase, 0, strlen(passphrase));
599 public = key_from_private(private);
602 strlcat(identity_file, ".pub", sizeof(identity_file));
603 fd = open(identity_file, O_WRONLY | O_CREAT | O_TRUNC, 0644);
605 printf("Could not save your public key in %s\n", identity_file);
610 printf("fdopen %s failed", identity_file);
613 if (!key_write(public, f))
614 fprintf(stderr, "write key failed");
616 fprintf(f, " %s\n", new_comment);
621 printf("The comment in your key file has been changed.\n");
628 printf("Usage: %s [-ceilpqyB] [-t type] [-b bits] [-f file] [-C comment] "
629 "[-N new-pass] [-P pass]\n", __progname);
634 * Main program for key management.
637 main(int ac, char **av)
639 char dotsshdir[16 * 1024], comment[1024], *passphrase1, *passphrase2;
640 Key *private, *public;
649 SSLeay_add_all_algorithms();
651 /* we need this for the home * directory. */
652 pw = getpwuid(getuid());
654 printf("You don't exist, go away!\n");
657 if (gethostname(hostname, sizeof(hostname)) < 0) {
658 perror("gethostname");
662 while ((opt = getopt(ac, av, "deiqpclBRxXyb:f:t:P:N:C:")) != -1) {
666 if (bits < 512 || bits > 32768) {
667 printf("Bits has bad value.\n");
673 print_fingerprint = 1;
677 print_bubblebabble = 1;
681 change_passphrase = 1;
689 strlcpy(identity_file, optarg, sizeof(identity_file));
694 identity_passphrase = optarg;
698 identity_new_passphrase = optarg;
702 identity_comment = optarg;
723 convert_from_ssh2 = 1;
731 key_type_name = "dsa";
735 key_type_name = optarg;
744 printf("Too many arguments.\n");
747 if (change_passphrase && change_comment) {
748 printf("Can only have one of -p and -c.\n");
751 if (print_fingerprint || print_bubblebabble)
753 if (change_passphrase)
754 do_change_passphrase(pw);
756 do_change_comment(pw);
758 do_convert_to_ssh2(pw);
759 if (convert_from_ssh2)
760 do_convert_from_ssh2(pw);
766 type = key_type_from_name(key_type_name);
767 if (type == KEY_UNSPEC) {
768 fprintf(stderr, "unknown key type %s\n", key_type_name);
772 printf("Generating public/private %s key pair.\n", key_type_name);
773 private = key_generate(type, bits);
774 if (private == NULL) {
775 fprintf(stderr, "key_generate failed");
778 public = key_from_private(private);
781 ask_filename(pw, "Enter file in which to save the key");
783 /* Create ~/.ssh directory if it doesn\'t already exist. */
784 snprintf(dotsshdir, sizeof dotsshdir, "%s/%s", pw->pw_dir, _PATH_SSH_USER_DIR);
785 if (strstr(identity_file, dotsshdir) != NULL &&
786 stat(dotsshdir, &st) < 0) {
787 if (mkdir(dotsshdir, 0700) < 0)
788 error("Could not create directory '%s'.", dotsshdir);
790 printf("Created directory '%s'.\n", dotsshdir);
792 /* If the file already exists, ask the user to confirm. */
793 if (stat(identity_file, &st) >= 0) {
795 printf("%s already exists.\n", identity_file);
796 printf("Overwrite (y/n)? ");
798 if (fgets(yesno, sizeof(yesno), stdin) == NULL)
800 if (yesno[0] != 'y' && yesno[0] != 'Y')
803 /* Ask for a passphrase (twice). */
804 if (identity_passphrase)
805 passphrase1 = xstrdup(identity_passphrase);
806 else if (identity_new_passphrase)
807 passphrase1 = xstrdup(identity_new_passphrase);
811 read_passphrase("Enter passphrase (empty for no passphrase): ", 1);
812 passphrase2 = read_passphrase("Enter same passphrase again: ", 1);
813 if (strcmp(passphrase1, passphrase2) != 0) {
814 /* The passphrases do not match. Clear them and retry. */
815 memset(passphrase1, 0, strlen(passphrase1));
816 memset(passphrase2, 0, strlen(passphrase2));
819 printf("Passphrases do not match. Try again.\n");
820 goto passphrase_again;
822 /* Clear the other copy of the passphrase. */
823 memset(passphrase2, 0, strlen(passphrase2));
827 if (identity_comment) {
828 strlcpy(comment, identity_comment, sizeof(comment));
830 /* Create default commend field for the passphrase. */
831 snprintf(comment, sizeof comment, "%s@%s", pw->pw_name, hostname);
834 /* Save the key with the given passphrase and comment. */
835 if (!key_save_private(private, identity_file, passphrase1, comment)) {
836 printf("Saving the key failed: %s.\n", identity_file);
837 memset(passphrase1, 0, strlen(passphrase1));
841 /* Clear the passphrase. */
842 memset(passphrase1, 0, strlen(passphrase1));
845 /* Clear the private key and the random number generator. */
850 printf("Your identification has been saved in %s.\n", identity_file);
852 strlcat(identity_file, ".pub", sizeof(identity_file));
853 fd = open(identity_file, O_WRONLY | O_CREAT | O_TRUNC, 0644);
855 printf("Could not save your public key in %s\n", identity_file);
860 printf("fdopen %s failed", identity_file);
863 if (!key_write(public, f))
864 fprintf(stderr, "write key failed");
865 fprintf(f, " %s\n", comment);
869 char *fp = key_fingerprint(public, SSH_FP_MD5, SSH_FP_HEX);
870 printf("Your public key has been saved in %s.\n",
872 printf("The key fingerprint is:\n");
873 printf("%s %s\n", fp, comment);