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.95 2002/03/21 16:54:53 markus Exp $");
17 #include <openssl/evp.h>
18 #include <openssl/pem.h>
27 #include "pathnames.h"
35 /* Number of bits in the RSA/DSA key. This value can be changed on the command line. */
39 * Flag indicating that we just want to change the passphrase. This can be
40 * set on the command line.
42 int change_passphrase = 0;
45 * Flag indicating that we just want to change the comment. This can be set
46 * on the command line.
48 int change_comment = 0;
52 /* Flag indicating that we just want to see the key fingerprint */
53 int print_fingerprint = 0;
54 int print_bubblebabble = 0;
56 /* The identity file name, given on the command line or entered by the user. */
57 char identity_file[1024];
58 int have_identity = 0;
60 /* This is set to the passphrase if given on the command line. */
61 char *identity_passphrase = NULL;
63 /* This is set to the new passphrase if given on the command line. */
64 char *identity_new_passphrase = NULL;
66 /* This is set to the new comment if given on the command line. */
67 char *identity_comment = NULL;
69 /* Dump public key file in format used by real and the original SSH 2 */
70 int convert_to_ssh2 = 0;
71 int convert_from_ssh2 = 0;
74 char *key_type_name = NULL;
77 #ifdef HAVE___PROGNAME
78 extern char *__progname;
83 char hostname[MAXHOSTNAMELEN];
86 ask_filename(struct passwd *pw, const char *prompt)
91 if (key_type_name == NULL)
92 name = _PATH_SSH_CLIENT_ID_RSA;
94 switch (key_type_from_name(key_type_name)) {
96 name = _PATH_SSH_CLIENT_IDENTITY;
99 name = _PATH_SSH_CLIENT_ID_DSA;
102 name = _PATH_SSH_CLIENT_ID_RSA;
105 fprintf(stderr, "bad key type");
110 snprintf(identity_file, sizeof(identity_file), "%s/%s", pw->pw_dir, name);
111 fprintf(stderr, "%s (%s): ", prompt, identity_file);
113 if (fgets(buf, sizeof(buf), stdin) == NULL)
115 if (strchr(buf, '\n'))
116 *strchr(buf, '\n') = 0;
117 if (strcmp(buf, "") != 0)
118 strlcpy(identity_file, buf, sizeof(identity_file));
123 load_identity(char *filename)
128 prv = key_load_private(filename, "", NULL);
130 if (identity_passphrase)
131 pass = xstrdup(identity_passphrase);
133 pass = read_passphrase("Enter passphrase: ",
135 prv = key_load_private(filename, pass, NULL);
136 memset(pass, 0, strlen(pass));
142 #define SSH_COM_PUBLIC_BEGIN "---- BEGIN SSH2 PUBLIC KEY ----"
143 #define SSH_COM_PUBLIC_END "---- END SSH2 PUBLIC KEY ----"
144 #define SSH_COM_PRIVATE_BEGIN "---- BEGIN SSH2 ENCRYPTED PRIVATE KEY ----"
145 #define SSH_COM_PRIVATE_KEY_MAGIC 0x3f6ff9eb
148 do_convert_to_ssh2(struct passwd *pw)
156 ask_filename(pw, "Enter file in which the key is");
157 if (stat(identity_file, &st) < 0) {
158 perror(identity_file);
161 if ((k = key_load_public(identity_file, NULL)) == NULL) {
162 if ((k = load_identity(identity_file)) == NULL) {
163 fprintf(stderr, "load failed\n");
167 if (key_to_blob(k, &blob, &len) <= 0) {
168 fprintf(stderr, "key_to_blob failed\n");
171 fprintf(stdout, "%s\n", SSH_COM_PUBLIC_BEGIN);
173 "Comment: \"%d-bit %s, converted from OpenSSH by %s@%s\"\n",
174 key_size(k), key_type(k),
175 pw->pw_name, hostname);
176 dump_base64(stdout, blob, len);
177 fprintf(stdout, "%s\n", SSH_COM_PUBLIC_END);
184 buffer_get_bignum_bits(Buffer *b, BIGNUM *value)
186 int bits = buffer_get_int(b);
187 int bytes = (bits + 7) / 8;
189 if (buffer_len(b) < bytes)
190 fatal("buffer_get_bignum_bits: input buffer too small: "
191 "need %d have %d", bytes, buffer_len(b));
192 BN_bin2bn(buffer_ptr(b), bytes, value);
193 buffer_consume(b, bytes);
197 do_convert_private_ssh2_from_blob(u_char *blob, u_int blen)
202 u_char *sig, data[] = "abcde12345";
203 int magic, rlen, ktype, i1, i2, i3, i4;
208 buffer_append(&b, blob, blen);
210 magic = buffer_get_int(&b);
211 if (magic != SSH_COM_PRIVATE_KEY_MAGIC) {
212 error("bad magic 0x%x != 0x%x", magic, SSH_COM_PRIVATE_KEY_MAGIC);
216 i1 = buffer_get_int(&b);
217 type = buffer_get_string(&b, NULL);
218 cipher = buffer_get_string(&b, NULL);
219 i2 = buffer_get_int(&b);
220 i3 = buffer_get_int(&b);
221 i4 = buffer_get_int(&b);
222 debug("ignore (%d %d %d %d)", i1,i2,i3,i4);
223 if (strcmp(cipher, "none") != 0) {
224 error("unsupported cipher %s", cipher);
232 if (strstr(type, "dsa")) {
234 } else if (strstr(type, "rsa")) {
240 key = key_new_private(ktype);
245 buffer_get_bignum_bits(&b, key->dsa->p);
246 buffer_get_bignum_bits(&b, key->dsa->g);
247 buffer_get_bignum_bits(&b, key->dsa->q);
248 buffer_get_bignum_bits(&b, key->dsa->pub_key);
249 buffer_get_bignum_bits(&b, key->dsa->priv_key);
252 e = buffer_get_char(&b);
256 e += buffer_get_char(&b);
259 e += buffer_get_char(&b);
262 if (!BN_set_word(key->rsa->e, e)) {
267 buffer_get_bignum_bits(&b, key->rsa->d);
268 buffer_get_bignum_bits(&b, key->rsa->n);
269 buffer_get_bignum_bits(&b, key->rsa->iqmp);
270 buffer_get_bignum_bits(&b, key->rsa->q);
271 buffer_get_bignum_bits(&b, key->rsa->p);
272 rsa_generate_additional_parameters(key->rsa);
275 rlen = buffer_len(&b);
277 error("do_convert_private_ssh2_from_blob: "
278 "remaining bytes in key blob %d", rlen);
282 key_sign(key, &sig, &slen, data, sizeof(data));
283 key_verify(key, sig, slen, data, sizeof(data));
289 do_convert_from_ssh2(struct passwd *pw)
297 int escaped = 0, private = 0, ok;
301 ask_filename(pw, "Enter file in which the key is");
302 if (stat(identity_file, &st) < 0) {
303 perror(identity_file);
306 fp = fopen(identity_file, "r");
308 perror(identity_file);
312 while (fgets(line, sizeof(line), fp)) {
313 if (!(p = strchr(line, '\n'))) {
314 fprintf(stderr, "input line too long.\n");
317 if (p > line && p[-1] == '\\')
319 if (strncmp(line, "----", 4) == 0 ||
320 strstr(line, ": ") != NULL) {
321 if (strstr(line, SSH_COM_PRIVATE_BEGIN) != NULL)
323 if (strstr(line, " END ") != NULL) {
326 /* fprintf(stderr, "ignore: %s", line); */
331 /* fprintf(stderr, "escaped: %s", line); */
335 strlcat(encoded, line, sizeof(encoded));
337 blen = uudecode(encoded, blob, sizeof(blob));
339 fprintf(stderr, "uudecode failed.\n");
343 do_convert_private_ssh2_from_blob(blob, blen) :
344 key_from_blob(blob, blen);
346 fprintf(stderr, "decode blob failed.\n");
350 (k->type == KEY_DSA ?
351 PEM_write_DSAPrivateKey(stdout, k->dsa, NULL, NULL, 0, NULL, NULL) :
352 PEM_write_RSAPrivateKey(stdout, k->rsa, NULL, NULL, 0, NULL, NULL)) :
353 key_write(k, stdout);
355 fprintf(stderr, "key write failed");
360 fprintf(stdout, "\n");
366 do_print_public(struct passwd *pw)
372 ask_filename(pw, "Enter file in which the key is");
373 if (stat(identity_file, &st) < 0) {
374 perror(identity_file);
377 prv = load_identity(identity_file);
379 fprintf(stderr, "load failed\n");
382 if (!key_write(prv, stdout))
383 fprintf(stderr, "key_write failed");
385 fprintf(stdout, "\n");
391 do_upload(struct passwd *pw, const char *sc_reader_id)
398 ask_filename(pw, "Enter file in which the key is");
399 if (stat(identity_file, &st) < 0) {
400 perror(identity_file);
403 prv = load_identity(identity_file);
405 error("load failed");
408 ret = sc_put_key(prv, sc_reader_id);
412 log("loading key done");
417 do_download(struct passwd *pw, const char *sc_reader_id)
421 pub = sc_get_key(sc_reader_id);
423 fatal("cannot read public key from smartcard");
424 key_write(pub, stdout);
426 fprintf(stdout, "\n");
429 #endif /* SMARTCARD */
432 do_fingerprint(struct passwd *pw)
436 char *comment = NULL, *cp, *ep, line[16*1024], *fp;
437 int i, skip = 0, num = 1, invalid = 1;
442 fptype = print_bubblebabble ? SSH_FP_SHA1 : SSH_FP_MD5;
443 rep = print_bubblebabble ? SSH_FP_BUBBLEBABBLE : SSH_FP_HEX;
446 ask_filename(pw, "Enter file in which the key is");
447 if (stat(identity_file, &st) < 0) {
448 perror(identity_file);
451 public = key_load_public(identity_file, &comment);
452 if (public != NULL) {
453 fp = key_fingerprint(public, fptype, rep);
454 printf("%d %s %s\n", key_size(public), fp, comment);
463 f = fopen(identity_file, "r");
465 while (fgets(line, sizeof(line), f)) {
466 i = strlen(line) - 1;
467 if (line[i] != '\n') {
468 error("line %d too long: %.40s...", num, line);
479 /* Skip leading whitespace, empty and comment lines. */
480 for (cp = line; *cp == ' ' || *cp == '\t'; cp++)
482 if (!*cp || *cp == '\n' || *cp == '#')
484 i = strtol(cp, &ep, 10);
485 if (i == 0 || ep == NULL || (*ep != ' ' && *ep != '\t')) {
488 for (; *cp && (quoted || (*cp != ' ' && *cp != '\t')); cp++) {
489 if (*cp == '\\' && cp[1] == '"')
490 cp++; /* Skip both */
499 public = key_new(KEY_RSA1);
500 if (key_read(public, &cp) != 1) {
503 public = key_new(KEY_UNSPEC);
504 if (key_read(public, &cp) != 1) {
509 comment = *cp ? cp : comment;
510 fp = key_fingerprint(public, fptype, rep);
511 printf("%d %s %s\n", key_size(public), fp,
512 comment ? comment : "no comment");
520 printf("%s is not a public key file.\n", identity_file);
527 * Perform changing a passphrase. The argument is the passwd structure
528 * for the current user.
531 do_change_passphrase(struct passwd *pw)
534 char *old_passphrase, *passphrase1, *passphrase2;
539 ask_filename(pw, "Enter file in which the key is");
540 if (stat(identity_file, &st) < 0) {
541 perror(identity_file);
544 /* Try to load the file with empty passphrase. */
545 private = key_load_private(identity_file, "", &comment);
546 if (private == NULL) {
547 if (identity_passphrase)
548 old_passphrase = xstrdup(identity_passphrase);
551 read_passphrase("Enter old passphrase: ",
553 private = key_load_private(identity_file, old_passphrase,
555 memset(old_passphrase, 0, strlen(old_passphrase));
556 xfree(old_passphrase);
557 if (private == NULL) {
558 printf("Bad passphrase.\n");
562 printf("Key has comment '%s'\n", comment);
564 /* Ask the new passphrase (twice). */
565 if (identity_new_passphrase) {
566 passphrase1 = xstrdup(identity_new_passphrase);
570 read_passphrase("Enter new passphrase (empty for no "
571 "passphrase): ", RP_ALLOW_STDIN);
572 passphrase2 = read_passphrase("Enter same passphrase again: ",
575 /* Verify that they are the same. */
576 if (strcmp(passphrase1, passphrase2) != 0) {
577 memset(passphrase1, 0, strlen(passphrase1));
578 memset(passphrase2, 0, strlen(passphrase2));
581 printf("Pass phrases do not match. Try again.\n");
584 /* Destroy the other copy. */
585 memset(passphrase2, 0, strlen(passphrase2));
589 /* Save the file using the new passphrase. */
590 if (!key_save_private(private, identity_file, passphrase1, comment)) {
591 printf("Saving the key failed: %s.\n", identity_file);
592 memset(passphrase1, 0, strlen(passphrase1));
598 /* Destroy the passphrase and the copy of the key in memory. */
599 memset(passphrase1, 0, strlen(passphrase1));
601 key_free(private); /* Destroys contents */
604 printf("Your identification has been saved with the new passphrase.\n");
609 * Change the comment of a private key file.
612 do_change_comment(struct passwd *pw)
614 char new_comment[1024], *comment, *passphrase;
622 ask_filename(pw, "Enter file in which the key is");
623 if (stat(identity_file, &st) < 0) {
624 perror(identity_file);
627 private = key_load_private(identity_file, "", &comment);
628 if (private == NULL) {
629 if (identity_passphrase)
630 passphrase = xstrdup(identity_passphrase);
631 else if (identity_new_passphrase)
632 passphrase = xstrdup(identity_new_passphrase);
634 passphrase = read_passphrase("Enter passphrase: ",
636 /* Try to load using the passphrase. */
637 private = key_load_private(identity_file, passphrase, &comment);
638 if (private == NULL) {
639 memset(passphrase, 0, strlen(passphrase));
641 printf("Bad passphrase.\n");
645 passphrase = xstrdup("");
647 if (private->type != KEY_RSA1) {
648 fprintf(stderr, "Comments are only supported for RSA1 keys.\n");
652 printf("Key now has comment '%s'\n", comment);
654 if (identity_comment) {
655 strlcpy(new_comment, identity_comment, sizeof(new_comment));
657 printf("Enter new comment: ");
659 if (!fgets(new_comment, sizeof(new_comment), stdin)) {
660 memset(passphrase, 0, strlen(passphrase));
664 if (strchr(new_comment, '\n'))
665 *strchr(new_comment, '\n') = 0;
668 /* Save the file using the new passphrase. */
669 if (!key_save_private(private, identity_file, passphrase, new_comment)) {
670 printf("Saving the key failed: %s.\n", identity_file);
671 memset(passphrase, 0, strlen(passphrase));
677 memset(passphrase, 0, strlen(passphrase));
679 public = key_from_private(private);
682 strlcat(identity_file, ".pub", sizeof(identity_file));
683 fd = open(identity_file, O_WRONLY | O_CREAT | O_TRUNC, 0644);
685 printf("Could not save your public key in %s\n", identity_file);
690 printf("fdopen %s failed", identity_file);
693 if (!key_write(public, f))
694 fprintf(stderr, "write key failed");
696 fprintf(f, " %s\n", new_comment);
701 printf("The comment in your key file has been changed.\n");
708 fprintf(stderr, "Usage: %s [options]\n", __progname);
709 fprintf(stderr, "Options:\n");
710 fprintf(stderr, " -b bits Number of bits in the key to create.\n");
711 fprintf(stderr, " -c Change comment in private and public key files.\n");
712 fprintf(stderr, " -e Convert OpenSSH to IETF SECSH key file.\n");
713 fprintf(stderr, " -f filename Filename of the key file.\n");
714 fprintf(stderr, " -i Convert IETF SECSH to OpenSSH key file.\n");
715 fprintf(stderr, " -l Show fingerprint of key file.\n");
716 fprintf(stderr, " -p Change passphrase of private key file.\n");
717 fprintf(stderr, " -q Quiet.\n");
718 fprintf(stderr, " -y Read private key file and print public key.\n");
719 fprintf(stderr, " -t type Specify type of key to create.\n");
720 fprintf(stderr, " -B Show bubblebabble digest of key file.\n");
721 fprintf(stderr, " -C comment Provide new comment.\n");
722 fprintf(stderr, " -N phrase Provide new passphrase.\n");
723 fprintf(stderr, " -P phrase Provide old passphrase.\n");
725 fprintf(stderr, " -D reader Download public key from smartcard.\n");
726 fprintf(stderr, " -U reader Upload private key to smartcard.\n");
727 #endif /* SMARTCARD */
733 * Main program for key management.
736 main(int ac, char **av)
738 char dotsshdir[MAXPATHLEN], comment[1024], *passphrase1, *passphrase2;
739 char *reader_id = NULL;
740 Key *private, *public;
743 int opt, type, fd, download = 0;
749 __progname = get_progname(av[0]);
751 SSLeay_add_all_algorithms();
753 /* we need this for the home * directory. */
754 pw = getpwuid(getuid());
756 printf("You don't exist, go away!\n");
759 if (gethostname(hostname, sizeof(hostname)) < 0) {
760 perror("gethostname");
764 while ((opt = getopt(ac, av, "deiqpclBRxXyb:f:t:U:D:P:N:C:")) != -1) {
768 if (bits < 512 || bits > 32768) {
769 printf("Bits has bad value.\n");
774 print_fingerprint = 1;
777 print_bubblebabble = 1;
780 change_passphrase = 1;
786 strlcpy(identity_file, optarg, sizeof(identity_file));
790 identity_passphrase = optarg;
793 identity_new_passphrase = optarg;
796 identity_comment = optarg;
813 convert_from_ssh2 = 1;
819 key_type_name = "dsa";
822 key_type_name = optarg;
835 printf("Too many arguments.\n");
838 if (change_passphrase && change_comment) {
839 printf("Can only have one of -p and -c.\n");
842 if (print_fingerprint || print_bubblebabble)
844 if (change_passphrase)
845 do_change_passphrase(pw);
847 do_convert_to_ssh2(pw);
849 do_change_comment(pw);
852 if (reader_id != NULL) {
855 do_download(pw, reader_id);
857 do_upload(pw, reader_id);
858 #else /* SMARTCARD */
859 fatal("no support for smartcards.");
860 #endif /* SMARTCARD */
867 if (convert_from_ssh2)
868 do_convert_from_ssh2(pw);
870 if (key_type_name == NULL) {
871 printf("You must specify a key type (-t).\n");
874 type = key_type_from_name(key_type_name);
875 if (type == KEY_UNSPEC) {
876 fprintf(stderr, "unknown key type %s\n", key_type_name);
880 printf("Generating public/private %s key pair.\n", key_type_name);
881 private = key_generate(type, bits);
882 if (private == NULL) {
883 fprintf(stderr, "key_generate failed");
886 public = key_from_private(private);
889 ask_filename(pw, "Enter file in which to save the key");
891 /* Create ~/.ssh directory if it doesn\'t already exist. */
892 snprintf(dotsshdir, sizeof dotsshdir, "%s/%s", pw->pw_dir, _PATH_SSH_USER_DIR);
893 if (strstr(identity_file, dotsshdir) != NULL &&
894 stat(dotsshdir, &st) < 0) {
895 if (mkdir(dotsshdir, 0700) < 0)
896 error("Could not create directory '%s'.", dotsshdir);
898 printf("Created directory '%s'.\n", dotsshdir);
900 /* If the file already exists, ask the user to confirm. */
901 if (stat(identity_file, &st) >= 0) {
903 printf("%s already exists.\n", identity_file);
904 printf("Overwrite (y/n)? ");
906 if (fgets(yesno, sizeof(yesno), stdin) == NULL)
908 if (yesno[0] != 'y' && yesno[0] != 'Y')
911 /* Ask for a passphrase (twice). */
912 if (identity_passphrase)
913 passphrase1 = xstrdup(identity_passphrase);
914 else if (identity_new_passphrase)
915 passphrase1 = xstrdup(identity_new_passphrase);
919 read_passphrase("Enter passphrase (empty for no "
920 "passphrase): ", RP_ALLOW_STDIN);
921 passphrase2 = read_passphrase("Enter same passphrase again: ",
923 if (strcmp(passphrase1, passphrase2) != 0) {
925 * The passphrases do not match. Clear them and
928 memset(passphrase1, 0, strlen(passphrase1));
929 memset(passphrase2, 0, strlen(passphrase2));
932 printf("Passphrases do not match. Try again.\n");
933 goto passphrase_again;
935 /* Clear the other copy of the passphrase. */
936 memset(passphrase2, 0, strlen(passphrase2));
940 if (identity_comment) {
941 strlcpy(comment, identity_comment, sizeof(comment));
943 /* Create default commend field for the passphrase. */
944 snprintf(comment, sizeof comment, "%s@%s", pw->pw_name, hostname);
947 /* Save the key with the given passphrase and comment. */
948 if (!key_save_private(private, identity_file, passphrase1, comment)) {
949 printf("Saving the key failed: %s.\n", identity_file);
950 memset(passphrase1, 0, strlen(passphrase1));
954 /* Clear the passphrase. */
955 memset(passphrase1, 0, strlen(passphrase1));
958 /* Clear the private key and the random number generator. */
963 printf("Your identification has been saved in %s.\n", identity_file);
965 strlcat(identity_file, ".pub", sizeof(identity_file));
966 fd = open(identity_file, O_WRONLY | O_CREAT | O_TRUNC, 0644);
968 printf("Could not save your public key in %s\n", identity_file);
973 printf("fdopen %s failed", identity_file);
976 if (!key_write(public, f))
977 fprintf(stderr, "write key failed");
978 fprintf(f, " %s\n", comment);
982 char *fp = key_fingerprint(public, SSH_FP_MD5, SSH_FP_HEX);
983 printf("Your public key has been saved in %s.\n",
985 printf("The key fingerprint is:\n");
986 printf("%s %s\n", fp, comment);