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.62 2001/06/23 06:41:10 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 #ifdef HAVE___PROGNAME
75 extern char *__progname;
80 char hostname[MAXHOSTNAMELEN];
83 ask_filename(struct passwd *pw, const char *prompt)
88 switch (key_type_from_name(key_type_name)) {
90 name = _PATH_SSH_CLIENT_IDENTITY;
93 name = _PATH_SSH_CLIENT_ID_DSA;
96 name = _PATH_SSH_CLIENT_ID_RSA;
99 fprintf(stderr, "bad key type");
103 snprintf(identity_file, sizeof(identity_file), "%s/%s", pw->pw_dir, name);
104 fprintf(stderr, "%s (%s): ", prompt, identity_file);
106 if (fgets(buf, sizeof(buf), stdin) == NULL)
108 if (strchr(buf, '\n'))
109 *strchr(buf, '\n') = 0;
110 if (strcmp(buf, "") != 0)
111 strlcpy(identity_file, buf, sizeof(identity_file));
116 load_identity(char *filename)
121 prv = key_load_private(filename, "", NULL);
123 if (identity_passphrase)
124 pass = xstrdup(identity_passphrase);
126 pass = read_passphrase("Enter passphrase: ", 1);
127 prv = key_load_private(filename, pass, NULL);
128 memset(pass, 0, strlen(pass));
134 #define SSH_COM_PUBLIC_BEGIN "---- BEGIN SSH2 PUBLIC KEY ----"
135 #define SSH_COM_PUBLIC_END "---- END SSH2 PUBLIC KEY ----"
136 #define SSH_COM_PRIVATE_BEGIN "---- BEGIN SSH2 ENCRYPTED PRIVATE KEY ----"
137 #define SSH_COM_PRIVATE_KEY_MAGIC 0x3f6ff9eb
140 do_convert_to_ssh2(struct passwd *pw)
148 ask_filename(pw, "Enter file in which the key is");
149 if (stat(identity_file, &st) < 0) {
150 perror(identity_file);
153 if ((k = key_load_public(identity_file, NULL)) == NULL) {
154 if ((k = load_identity(identity_file)) == NULL) {
155 fprintf(stderr, "load failed\n");
159 key_to_blob(k, &blob, &len);
160 fprintf(stdout, "%s\n", SSH_COM_PUBLIC_BEGIN);
162 "Comment: \"%d-bit %s, converted from OpenSSH by %s@%s\"\n",
163 key_size(k), key_type(k),
164 pw->pw_name, hostname);
165 dump_base64(stdout, blob, len);
166 fprintf(stdout, "%s\n", SSH_COM_PUBLIC_END);
173 buffer_get_bignum_bits(Buffer *b, BIGNUM *value)
175 int bits = buffer_get_int(b);
176 int bytes = (bits + 7) / 8;
178 if (buffer_len(b) < bytes)
179 fatal("buffer_get_bignum_bits: input buffer too small: "
180 "need %d have %d", bytes, buffer_len(b));
181 BN_bin2bn((u_char *)buffer_ptr(b), bytes, value);
182 buffer_consume(b, bytes);
186 do_convert_private_ssh2_from_blob(char *blob, int blen)
190 int magic, rlen, ktype, i1, i2, i3, i4;
195 buffer_append(&b, blob, blen);
197 magic = buffer_get_int(&b);
198 if (magic != SSH_COM_PRIVATE_KEY_MAGIC) {
199 error("bad magic 0x%x != 0x%x", magic, SSH_COM_PRIVATE_KEY_MAGIC);
203 i1 = buffer_get_int(&b);
204 type = buffer_get_string(&b, NULL);
205 cipher = buffer_get_string(&b, NULL);
206 i2 = buffer_get_int(&b);
207 i3 = buffer_get_int(&b);
208 i4 = buffer_get_int(&b);
209 debug("ignore (%d %d %d %d)", i1,i2,i3,i4);
210 if (strcmp(cipher, "none") != 0) {
211 error("unsupported cipher %s", cipher);
219 if (strstr(type, "dsa")) {
221 } else if (strstr(type, "rsa")) {
227 key = key_new_private(ktype);
232 buffer_get_bignum_bits(&b, key->dsa->p);
233 buffer_get_bignum_bits(&b, key->dsa->g);
234 buffer_get_bignum_bits(&b, key->dsa->q);
235 buffer_get_bignum_bits(&b, key->dsa->pub_key);
236 buffer_get_bignum_bits(&b, key->dsa->priv_key);
239 e = buffer_get_char(&b);
243 e += buffer_get_char(&b);
246 e += buffer_get_char(&b);
249 if (!BN_set_word(key->rsa->e, e)) {
254 buffer_get_bignum_bits(&b, key->rsa->d);
255 buffer_get_bignum_bits(&b, key->rsa->n);
256 buffer_get_bignum_bits(&b, key->rsa->iqmp);
257 buffer_get_bignum_bits(&b, key->rsa->q);
258 buffer_get_bignum_bits(&b, key->rsa->p);
259 generate_additional_parameters(key->rsa);
262 rlen = buffer_len(&b);
264 error("do_convert_private_ssh2_from_blob: "
265 "remaining bytes in key blob %d", rlen);
270 u_char *sig, data[10] = "abcde12345";
272 key_sign(key, &sig, &slen, data, sizeof(data));
273 key_verify(key, sig, slen, data, sizeof(data));
281 do_convert_from_ssh2(struct passwd *pw)
289 int escaped = 0, private = 0, ok;
293 ask_filename(pw, "Enter file in which the key is");
294 if (stat(identity_file, &st) < 0) {
295 perror(identity_file);
298 fp = fopen(identity_file, "r");
300 perror(identity_file);
304 while (fgets(line, sizeof(line), fp)) {
305 if (!(p = strchr(line, '\n'))) {
306 fprintf(stderr, "input line too long.\n");
309 if (p > line && p[-1] == '\\')
311 if (strncmp(line, "----", 4) == 0 ||
312 strstr(line, ": ") != NULL) {
313 if (strstr(line, SSH_COM_PRIVATE_BEGIN) != NULL)
315 /* fprintf(stderr, "ignore: %s", line); */
320 /* fprintf(stderr, "escaped: %s", line); */
324 strlcat(encoded, line, sizeof(encoded));
326 blen = uudecode(encoded, (u_char *)blob, sizeof(blob));
328 fprintf(stderr, "uudecode failed.\n");
332 do_convert_private_ssh2_from_blob(blob, blen) :
333 key_from_blob(blob, blen);
335 fprintf(stderr, "decode blob failed.\n");
339 (k->type == KEY_DSA ?
340 PEM_write_DSAPrivateKey(stdout, k->dsa, NULL, NULL, 0, NULL, NULL) :
341 PEM_write_RSAPrivateKey(stdout, k->rsa, NULL, NULL, 0, NULL, NULL)) :
342 key_write(k, stdout);
344 fprintf(stderr, "key write failed");
348 fprintf(stdout, "\n");
354 do_print_public(struct passwd *pw)
360 ask_filename(pw, "Enter file in which the key is");
361 if (stat(identity_file, &st) < 0) {
362 perror(identity_file);
365 prv = load_identity(identity_file);
367 fprintf(stderr, "load failed\n");
370 if (!key_write(prv, stdout))
371 fprintf(stderr, "key_write failed");
373 fprintf(stdout, "\n");
378 do_fingerprint(struct passwd *pw)
382 char *comment = NULL, *cp, *ep, line[16*1024], *fp;
383 int i, skip = 0, num = 1, invalid = 1, rep, fptype;
386 fptype = print_bubblebabble ? SSH_FP_SHA1 : SSH_FP_MD5;
387 rep = print_bubblebabble ? SSH_FP_BUBBLEBABBLE : SSH_FP_HEX;
390 ask_filename(pw, "Enter file in which the key is");
391 if (stat(identity_file, &st) < 0) {
392 perror(identity_file);
395 public = key_load_public(identity_file, &comment);
396 if (public != NULL) {
397 fp = key_fingerprint(public, fptype, rep);
398 printf("%d %s %s\n", key_size(public), fp, comment);
407 f = fopen(identity_file, "r");
409 while (fgets(line, sizeof(line), f)) {
410 i = strlen(line) - 1;
411 if (line[i] != '\n') {
412 error("line %d too long: %.40s...", num, line);
423 /* Skip leading whitespace, empty and comment lines. */
424 for (cp = line; *cp == ' ' || *cp == '\t'; cp++)
426 if (!*cp || *cp == '\n' || *cp == '#')
428 i = strtol(cp, &ep, 10);
429 if (i == 0 || ep == NULL || (*ep != ' ' && *ep != '\t')) {
432 for (; *cp && (quoted || (*cp != ' ' && *cp != '\t')); cp++) {
433 if (*cp == '\\' && cp[1] == '"')
434 cp++; /* Skip both */
443 public = key_new(KEY_RSA1);
444 if (key_read(public, &cp) != 1) {
447 public = key_new(KEY_UNSPEC);
448 if (key_read(public, &cp) != 1) {
453 comment = *cp ? cp : comment;
454 fp = key_fingerprint(public, fptype, rep);
455 printf("%d %s %s\n", key_size(public), fp,
456 comment ? comment : "no comment");
464 printf("%s is not a valid key file.\n", identity_file);
471 * Perform changing a passphrase. The argument is the passwd structure
472 * for the current user.
475 do_change_passphrase(struct passwd *pw)
478 char *old_passphrase, *passphrase1, *passphrase2;
483 ask_filename(pw, "Enter file in which the key is");
484 if (stat(identity_file, &st) < 0) {
485 perror(identity_file);
488 /* Try to load the file with empty passphrase. */
489 private = key_load_private(identity_file, "", &comment);
490 if (private == NULL) {
491 if (identity_passphrase)
492 old_passphrase = xstrdup(identity_passphrase);
494 old_passphrase = read_passphrase("Enter old passphrase: ", 1);
495 private = key_load_private(identity_file, old_passphrase , &comment);
496 memset(old_passphrase, 0, strlen(old_passphrase));
497 xfree(old_passphrase);
498 if (private == NULL) {
499 printf("Bad passphrase.\n");
503 printf("Key has comment '%s'\n", comment);
505 /* Ask the new passphrase (twice). */
506 if (identity_new_passphrase) {
507 passphrase1 = xstrdup(identity_new_passphrase);
511 read_passphrase("Enter new passphrase (empty for no passphrase): ", 1);
512 passphrase2 = read_passphrase("Enter same passphrase again: ", 1);
514 /* Verify that they are the same. */
515 if (strcmp(passphrase1, passphrase2) != 0) {
516 memset(passphrase1, 0, strlen(passphrase1));
517 memset(passphrase2, 0, strlen(passphrase2));
520 printf("Pass phrases do not match. Try again.\n");
523 /* Destroy the other copy. */
524 memset(passphrase2, 0, strlen(passphrase2));
528 /* Save the file using the new passphrase. */
529 if (!key_save_private(private, identity_file, passphrase1, comment)) {
530 printf("Saving the key failed: %s.\n", identity_file);
531 memset(passphrase1, 0, strlen(passphrase1));
537 /* Destroy the passphrase and the copy of the key in memory. */
538 memset(passphrase1, 0, strlen(passphrase1));
540 key_free(private); /* Destroys contents */
543 printf("Your identification has been saved with the new passphrase.\n");
548 * Change the comment of a private key file.
551 do_change_comment(struct passwd *pw)
553 char new_comment[1024], *comment, *passphrase;
561 ask_filename(pw, "Enter file in which the key is");
562 if (stat(identity_file, &st) < 0) {
563 perror(identity_file);
566 private = key_load_private(identity_file, "", &comment);
567 if (private == NULL) {
568 if (identity_passphrase)
569 passphrase = xstrdup(identity_passphrase);
570 else if (identity_new_passphrase)
571 passphrase = xstrdup(identity_new_passphrase);
573 passphrase = read_passphrase("Enter passphrase: ", 1);
574 /* Try to load using the passphrase. */
575 private = key_load_private(identity_file, passphrase, &comment);
576 if (private == NULL) {
577 memset(passphrase, 0, strlen(passphrase));
579 printf("Bad passphrase.\n");
583 passphrase = xstrdup("");
585 if (private->type != KEY_RSA1) {
586 fprintf(stderr, "Comments are only supported for RSA1 keys.\n");
590 printf("Key now has comment '%s'\n", comment);
592 if (identity_comment) {
593 strlcpy(new_comment, identity_comment, sizeof(new_comment));
595 printf("Enter new comment: ");
597 if (!fgets(new_comment, sizeof(new_comment), stdin)) {
598 memset(passphrase, 0, strlen(passphrase));
602 if (strchr(new_comment, '\n'))
603 *strchr(new_comment, '\n') = 0;
606 /* Save the file using the new passphrase. */
607 if (!key_save_private(private, identity_file, passphrase, new_comment)) {
608 printf("Saving the key failed: %s.\n", identity_file);
609 memset(passphrase, 0, strlen(passphrase));
615 memset(passphrase, 0, strlen(passphrase));
617 public = key_from_private(private);
620 strlcat(identity_file, ".pub", sizeof(identity_file));
621 fd = open(identity_file, O_WRONLY | O_CREAT | O_TRUNC, 0644);
623 printf("Could not save your public key in %s\n", identity_file);
628 printf("fdopen %s failed", identity_file);
631 if (!key_write(public, f))
632 fprintf(stderr, "write key failed");
634 fprintf(f, " %s\n", new_comment);
639 printf("The comment in your key file has been changed.\n");
646 printf("Usage: %s [-ceilpqyB] [-t type] [-b bits] [-f file] [-C comment] "
647 "[-N new-pass] [-P pass]\n", __progname);
652 * Main program for key management.
655 main(int ac, char **av)
657 char dotsshdir[16 * 1024], comment[1024], *passphrase1, *passphrase2;
658 Key *private, *public;
667 __progname = get_progname(av[0]);
671 SSLeay_add_all_algorithms();
673 /* we need this for the home * directory. */
674 pw = getpwuid(getuid());
676 printf("You don't exist, go away!\n");
679 if (gethostname(hostname, sizeof(hostname)) < 0) {
680 perror("gethostname");
684 while ((opt = getopt(ac, av, "deiqpclBRxXyb:f:t:P:N:C:")) != -1) {
688 if (bits < 512 || bits > 32768) {
689 printf("Bits has bad value.\n");
695 print_fingerprint = 1;
699 print_bubblebabble = 1;
703 change_passphrase = 1;
711 strlcpy(identity_file, optarg, sizeof(identity_file));
716 identity_passphrase = optarg;
720 identity_new_passphrase = optarg;
724 identity_comment = optarg;
745 convert_from_ssh2 = 1;
753 key_type_name = "dsa";
757 key_type_name = optarg;
766 printf("Too many arguments.\n");
769 if (change_passphrase && change_comment) {
770 printf("Can only have one of -p and -c.\n");
773 if (print_fingerprint || print_bubblebabble)
775 if (change_passphrase)
776 do_change_passphrase(pw);
778 do_change_comment(pw);
780 do_convert_to_ssh2(pw);
781 if (convert_from_ssh2)
782 do_convert_from_ssh2(pw);
788 type = key_type_from_name(key_type_name);
789 if (type == KEY_UNSPEC) {
790 fprintf(stderr, "unknown key type %s\n", key_type_name);
794 printf("Generating public/private %s key pair.\n", key_type_name);
795 private = key_generate(type, bits);
796 if (private == NULL) {
797 fprintf(stderr, "key_generate failed");
800 public = key_from_private(private);
803 ask_filename(pw, "Enter file in which to save the key");
805 /* Create ~/.ssh directory if it doesn\'t already exist. */
806 snprintf(dotsshdir, sizeof dotsshdir, "%s/%s", pw->pw_dir, _PATH_SSH_USER_DIR);
807 if (strstr(identity_file, dotsshdir) != NULL &&
808 stat(dotsshdir, &st) < 0) {
809 if (mkdir(dotsshdir, 0700) < 0)
810 error("Could not create directory '%s'.", dotsshdir);
812 printf("Created directory '%s'.\n", dotsshdir);
814 /* If the file already exists, ask the user to confirm. */
815 if (stat(identity_file, &st) >= 0) {
817 printf("%s already exists.\n", identity_file);
818 printf("Overwrite (y/n)? ");
820 if (fgets(yesno, sizeof(yesno), stdin) == NULL)
822 if (yesno[0] != 'y' && yesno[0] != 'Y')
825 /* Ask for a passphrase (twice). */
826 if (identity_passphrase)
827 passphrase1 = xstrdup(identity_passphrase);
828 else if (identity_new_passphrase)
829 passphrase1 = xstrdup(identity_new_passphrase);
833 read_passphrase("Enter passphrase (empty for no passphrase): ", 1);
834 passphrase2 = read_passphrase("Enter same passphrase again: ", 1);
835 if (strcmp(passphrase1, passphrase2) != 0) {
836 /* The passphrases do not match. Clear them and retry. */
837 memset(passphrase1, 0, strlen(passphrase1));
838 memset(passphrase2, 0, strlen(passphrase2));
841 printf("Passphrases do not match. Try again.\n");
842 goto passphrase_again;
844 /* Clear the other copy of the passphrase. */
845 memset(passphrase2, 0, strlen(passphrase2));
849 if (identity_comment) {
850 strlcpy(comment, identity_comment, sizeof(comment));
852 /* Create default commend field for the passphrase. */
853 snprintf(comment, sizeof comment, "%s@%s", pw->pw_name, hostname);
856 /* Save the key with the given passphrase and comment. */
857 if (!key_save_private(private, identity_file, passphrase1, comment)) {
858 printf("Saving the key failed: %s.\n", identity_file);
859 memset(passphrase1, 0, strlen(passphrase1));
863 /* Clear the passphrase. */
864 memset(passphrase1, 0, strlen(passphrase1));
867 /* Clear the private key and the random number generator. */
872 printf("Your identification has been saved in %s.\n", identity_file);
874 strlcat(identity_file, ".pub", sizeof(identity_file));
875 fd = open(identity_file, O_WRONLY | O_CREAT | O_TRUNC, 0644);
877 printf("Could not save your public key in %s\n", identity_file);
882 printf("fdopen %s failed", identity_file);
885 if (!key_write(public, f))
886 fprintf(stderr, "write key failed");
887 fprintf(f, " %s\n", comment);
891 char *fp = key_fingerprint(public, SSH_FP_MD5, SSH_FP_HEX);
892 printf("Your public key has been saved in %s.\n",
894 printf("The key fingerprint is:\n");
895 printf("%s %s\n", fp, comment);