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.67 2001/06/27 05:35:42 markus Exp $");
17 #include <openssl/evp.h>
18 #include <openssl/pem.h>
31 #include "pathnames.h"
36 /* Number of bits in the RSA/DSA key. This value can be changed on the command line. */
40 * Flag indicating that we just want to change the passphrase. This can be
41 * set on the command line.
43 int change_passphrase = 0;
46 * Flag indicating that we just want to change the comment. This can be set
47 * on the command line.
49 int change_comment = 0;
53 /* Flag indicating that we just want to see the key fingerprint */
54 int print_fingerprint = 0;
55 int print_bubblebabble = 0;
57 /* The identity file name, given on the command line or entered by the user. */
58 char identity_file[1024];
59 int have_identity = 0;
61 /* This is set to the passphrase if given on the command line. */
62 char *identity_passphrase = NULL;
64 /* This is set to the new passphrase if given on the command line. */
65 char *identity_new_passphrase = NULL;
67 /* This is set to the new comment if given on the command line. */
68 char *identity_comment = NULL;
70 /* Dump public key file in format used by real and the original SSH 2 */
71 int convert_to_ssh2 = 0;
72 int convert_from_ssh2 = 0;
75 /* default to RSA for SSH-1 */
76 char *key_type_name = "rsa1";
79 #ifdef HAVE___PROGNAME
80 extern char *__progname;
85 char hostname[MAXHOSTNAMELEN];
88 ask_filename(struct passwd *pw, const char *prompt)
93 switch (key_type_from_name(key_type_name)) {
95 name = _PATH_SSH_CLIENT_IDENTITY;
98 name = _PATH_SSH_CLIENT_ID_DSA;
101 name = _PATH_SSH_CLIENT_ID_RSA;
104 fprintf(stderr, "bad key type");
108 snprintf(identity_file, sizeof(identity_file), "%s/%s", pw->pw_dir, name);
109 fprintf(stderr, "%s (%s): ", prompt, identity_file);
111 if (fgets(buf, sizeof(buf), stdin) == NULL)
113 if (strchr(buf, '\n'))
114 *strchr(buf, '\n') = 0;
115 if (strcmp(buf, "") != 0)
116 strlcpy(identity_file, buf, sizeof(identity_file));
121 load_identity(char *filename)
126 prv = key_load_private(filename, "", NULL);
128 if (identity_passphrase)
129 pass = xstrdup(identity_passphrase);
131 pass = read_passphrase("Enter passphrase: ",
133 prv = key_load_private(filename, pass, NULL);
134 memset(pass, 0, strlen(pass));
140 #define SSH_COM_PUBLIC_BEGIN "---- BEGIN SSH2 PUBLIC KEY ----"
141 #define SSH_COM_PUBLIC_END "---- END SSH2 PUBLIC KEY ----"
142 #define SSH_COM_PRIVATE_BEGIN "---- BEGIN SSH2 ENCRYPTED PRIVATE KEY ----"
143 #define SSH_COM_PRIVATE_KEY_MAGIC 0x3f6ff9eb
146 do_convert_to_ssh2(struct passwd *pw)
154 ask_filename(pw, "Enter file in which the key is");
155 if (stat(identity_file, &st) < 0) {
156 perror(identity_file);
159 if ((k = key_load_public(identity_file, NULL)) == NULL) {
160 if ((k = load_identity(identity_file)) == NULL) {
161 fprintf(stderr, "load failed\n");
165 key_to_blob(k, &blob, &len);
166 fprintf(stdout, "%s\n", SSH_COM_PUBLIC_BEGIN);
168 "Comment: \"%d-bit %s, converted from OpenSSH by %s@%s\"\n",
169 key_size(k), key_type(k),
170 pw->pw_name, hostname);
171 dump_base64(stdout, blob, len);
172 fprintf(stdout, "%s\n", SSH_COM_PUBLIC_END);
179 buffer_get_bignum_bits(Buffer *b, BIGNUM *value)
181 int bits = buffer_get_int(b);
182 int bytes = (bits + 7) / 8;
184 if (buffer_len(b) < bytes)
185 fatal("buffer_get_bignum_bits: input buffer too small: "
186 "need %d have %d", bytes, buffer_len(b));
187 BN_bin2bn((u_char *)buffer_ptr(b), bytes, value);
188 buffer_consume(b, bytes);
192 do_convert_private_ssh2_from_blob(char *blob, int blen)
197 u_char *sig, data[10] = "abcde12345";
198 int magic, rlen, ktype, i1, i2, i3, i4;
203 buffer_append(&b, blob, blen);
205 magic = buffer_get_int(&b);
206 if (magic != SSH_COM_PRIVATE_KEY_MAGIC) {
207 error("bad magic 0x%x != 0x%x", magic, SSH_COM_PRIVATE_KEY_MAGIC);
211 i1 = buffer_get_int(&b);
212 type = buffer_get_string(&b, NULL);
213 cipher = buffer_get_string(&b, NULL);
214 i2 = buffer_get_int(&b);
215 i3 = buffer_get_int(&b);
216 i4 = buffer_get_int(&b);
217 debug("ignore (%d %d %d %d)", i1,i2,i3,i4);
218 if (strcmp(cipher, "none") != 0) {
219 error("unsupported cipher %s", cipher);
227 if (strstr(type, "dsa")) {
229 } else if (strstr(type, "rsa")) {
235 key = key_new_private(ktype);
240 buffer_get_bignum_bits(&b, key->dsa->p);
241 buffer_get_bignum_bits(&b, key->dsa->g);
242 buffer_get_bignum_bits(&b, key->dsa->q);
243 buffer_get_bignum_bits(&b, key->dsa->pub_key);
244 buffer_get_bignum_bits(&b, key->dsa->priv_key);
247 e = buffer_get_char(&b);
251 e += buffer_get_char(&b);
254 e += buffer_get_char(&b);
257 if (!BN_set_word(key->rsa->e, e)) {
262 buffer_get_bignum_bits(&b, key->rsa->d);
263 buffer_get_bignum_bits(&b, key->rsa->n);
264 buffer_get_bignum_bits(&b, key->rsa->iqmp);
265 buffer_get_bignum_bits(&b, key->rsa->q);
266 buffer_get_bignum_bits(&b, key->rsa->p);
267 generate_additional_parameters(key->rsa);
270 rlen = buffer_len(&b);
272 error("do_convert_private_ssh2_from_blob: "
273 "remaining bytes in key blob %d", rlen);
277 key_sign(key, &sig, &slen, data, sizeof(data));
278 key_verify(key, sig, slen, data, sizeof(data));
284 do_convert_from_ssh2(struct passwd *pw)
292 int escaped = 0, private = 0, ok;
296 ask_filename(pw, "Enter file in which the key is");
297 if (stat(identity_file, &st) < 0) {
298 perror(identity_file);
301 fp = fopen(identity_file, "r");
303 perror(identity_file);
307 while (fgets(line, sizeof(line), fp)) {
308 if (!(p = strchr(line, '\n'))) {
309 fprintf(stderr, "input line too long.\n");
312 if (p > line && p[-1] == '\\')
314 if (strncmp(line, "----", 4) == 0 ||
315 strstr(line, ": ") != NULL) {
316 if (strstr(line, SSH_COM_PRIVATE_BEGIN) != NULL)
318 if (strstr(line, " END ") != NULL) {
321 /* fprintf(stderr, "ignore: %s", line); */
326 /* fprintf(stderr, "escaped: %s", line); */
330 strlcat(encoded, line, sizeof(encoded));
332 blen = uudecode(encoded, (u_char *)blob, sizeof(blob));
334 fprintf(stderr, "uudecode failed.\n");
338 do_convert_private_ssh2_from_blob(blob, blen) :
339 key_from_blob(blob, blen);
341 fprintf(stderr, "decode blob failed.\n");
345 (k->type == KEY_DSA ?
346 PEM_write_DSAPrivateKey(stdout, k->dsa, NULL, NULL, 0, NULL, NULL) :
347 PEM_write_RSAPrivateKey(stdout, k->rsa, NULL, NULL, 0, NULL, NULL)) :
348 key_write(k, stdout);
350 fprintf(stderr, "key write failed");
354 fprintf(stdout, "\n");
360 do_print_public(struct passwd *pw)
366 ask_filename(pw, "Enter file in which the key is");
367 if (stat(identity_file, &st) < 0) {
368 perror(identity_file);
371 prv = load_identity(identity_file);
373 fprintf(stderr, "load failed\n");
376 if (!key_write(prv, stdout))
377 fprintf(stderr, "key_write failed");
379 fprintf(stdout, "\n");
383 #define NUM_RSA_KEY_ELEMENTS 5+1
384 #define COPY_RSA_KEY(x, i) \
386 len = BN_num_bytes(prv->rsa->x); \
387 elements[i] = xmalloc(len); \
388 error("#bytes %d", len); \
389 if (BN_bn2bin(prv->rsa->x, elements[i]) < 0) \
394 do_upload(struct passwd *pw, int reader)
397 fatal("no support for smartcards.");
401 u_char *elements[NUM_RSA_KEY_ELEMENTS];
404 u_char AUT0[] = {0xad, 0x9f, 0x61, 0xfe, 0xfa, 0x20, 0xce, 0x63};
405 int len, status = 1, i, fd = -1, ret;
409 ask_filename(pw, "Enter file in which the key is");
410 if (stat(identity_file, &st) < 0) {
411 perror(identity_file);
414 prv = load_identity(identity_file);
416 error("load failed");
419 for (i = 0; i < NUM_RSA_KEY_ELEMENTS; i++)
423 COPY_RSA_KEY(iqmp, 2);
424 COPY_RSA_KEY(dmq1, 3);
425 COPY_RSA_KEY(dmp1, 4);
427 len = BN_num_bytes(prv->rsa->n);
428 fd = scopen(reader, 0, NULL);
430 error("scopen failed %d.", fd);
433 ret = screset(fd, atr, NULL);
435 error("screset failed.");
438 if ((cla = cyberflex_inq_class(fd)) < 0) {
439 error("cyberflex_inq_class failed");
442 if (cyberflex_verify_AUT0(fd, cla, AUT0, sizeof(AUT0)) < 0) {
443 error("cyberflex_verify_AUT0 failed");
448 if (cyberflex_load_rsa_priv(fd, cla, key_fid, 5, 8*len, elements) < 0)
450 log("cyberflex_load_rsa_priv done");
453 if (cyberflex_load_rsa_pub(fd, cla, key_fid, len, elements[5]) < 0)
455 log("cyberflex_load_rsa_pub done");
457 log("loading key done");
461 for (i = 0; i < NUM_RSA_KEY_ELEMENTS; i++)
470 do_fingerprint(struct passwd *pw)
474 char *comment = NULL, *cp, *ep, line[16*1024], *fp;
475 int i, skip = 0, num = 1, invalid = 1, rep, fptype;
478 fptype = print_bubblebabble ? SSH_FP_SHA1 : SSH_FP_MD5;
479 rep = print_bubblebabble ? SSH_FP_BUBBLEBABBLE : SSH_FP_HEX;
482 ask_filename(pw, "Enter file in which the key is");
483 if (stat(identity_file, &st) < 0) {
484 perror(identity_file);
487 public = key_load_public(identity_file, &comment);
488 if (public != NULL) {
489 fp = key_fingerprint(public, fptype, rep);
490 printf("%d %s %s\n", key_size(public), fp, comment);
499 f = fopen(identity_file, "r");
501 while (fgets(line, sizeof(line), f)) {
502 i = strlen(line) - 1;
503 if (line[i] != '\n') {
504 error("line %d too long: %.40s...", num, line);
515 /* Skip leading whitespace, empty and comment lines. */
516 for (cp = line; *cp == ' ' || *cp == '\t'; cp++)
518 if (!*cp || *cp == '\n' || *cp == '#')
520 i = strtol(cp, &ep, 10);
521 if (i == 0 || ep == NULL || (*ep != ' ' && *ep != '\t')) {
524 for (; *cp && (quoted || (*cp != ' ' && *cp != '\t')); cp++) {
525 if (*cp == '\\' && cp[1] == '"')
526 cp++; /* Skip both */
535 public = key_new(KEY_RSA1);
536 if (key_read(public, &cp) != 1) {
539 public = key_new(KEY_UNSPEC);
540 if (key_read(public, &cp) != 1) {
545 comment = *cp ? cp : comment;
546 fp = key_fingerprint(public, fptype, rep);
547 printf("%d %s %s\n", key_size(public), fp,
548 comment ? comment : "no comment");
556 printf("%s is not a valid key file.\n", identity_file);
563 * Perform changing a passphrase. The argument is the passwd structure
564 * for the current user.
567 do_change_passphrase(struct passwd *pw)
570 char *old_passphrase, *passphrase1, *passphrase2;
575 ask_filename(pw, "Enter file in which the key is");
576 if (stat(identity_file, &st) < 0) {
577 perror(identity_file);
580 /* Try to load the file with empty passphrase. */
581 private = key_load_private(identity_file, "", &comment);
582 if (private == NULL) {
583 if (identity_passphrase)
584 old_passphrase = xstrdup(identity_passphrase);
587 read_passphrase("Enter old passphrase: ",
589 private = key_load_private(identity_file, old_passphrase,
591 memset(old_passphrase, 0, strlen(old_passphrase));
592 xfree(old_passphrase);
593 if (private == NULL) {
594 printf("Bad passphrase.\n");
598 printf("Key has comment '%s'\n", comment);
600 /* Ask the new passphrase (twice). */
601 if (identity_new_passphrase) {
602 passphrase1 = xstrdup(identity_new_passphrase);
606 read_passphrase("Enter new passphrase (empty for no "
607 "passphrase): ", RP_ALLOW_STDIN);
608 passphrase2 = read_passphrase("Enter same passphrase again: ",
611 /* Verify that they are the same. */
612 if (strcmp(passphrase1, passphrase2) != 0) {
613 memset(passphrase1, 0, strlen(passphrase1));
614 memset(passphrase2, 0, strlen(passphrase2));
617 printf("Pass phrases do not match. Try again.\n");
620 /* Destroy the other copy. */
621 memset(passphrase2, 0, strlen(passphrase2));
625 /* Save the file using the new passphrase. */
626 if (!key_save_private(private, identity_file, passphrase1, comment)) {
627 printf("Saving the key failed: %s.\n", identity_file);
628 memset(passphrase1, 0, strlen(passphrase1));
634 /* Destroy the passphrase and the copy of the key in memory. */
635 memset(passphrase1, 0, strlen(passphrase1));
637 key_free(private); /* Destroys contents */
640 printf("Your identification has been saved with the new passphrase.\n");
645 * Change the comment of a private key file.
648 do_change_comment(struct passwd *pw)
650 char new_comment[1024], *comment, *passphrase;
658 ask_filename(pw, "Enter file in which the key is");
659 if (stat(identity_file, &st) < 0) {
660 perror(identity_file);
663 private = key_load_private(identity_file, "", &comment);
664 if (private == NULL) {
665 if (identity_passphrase)
666 passphrase = xstrdup(identity_passphrase);
667 else if (identity_new_passphrase)
668 passphrase = xstrdup(identity_new_passphrase);
670 passphrase = read_passphrase("Enter passphrase: ",
672 /* Try to load using the passphrase. */
673 private = key_load_private(identity_file, passphrase, &comment);
674 if (private == NULL) {
675 memset(passphrase, 0, strlen(passphrase));
677 printf("Bad passphrase.\n");
681 passphrase = xstrdup("");
683 if (private->type != KEY_RSA1) {
684 fprintf(stderr, "Comments are only supported for RSA1 keys.\n");
688 printf("Key now has comment '%s'\n", comment);
690 if (identity_comment) {
691 strlcpy(new_comment, identity_comment, sizeof(new_comment));
693 printf("Enter new comment: ");
695 if (!fgets(new_comment, sizeof(new_comment), stdin)) {
696 memset(passphrase, 0, strlen(passphrase));
700 if (strchr(new_comment, '\n'))
701 *strchr(new_comment, '\n') = 0;
704 /* Save the file using the new passphrase. */
705 if (!key_save_private(private, identity_file, passphrase, new_comment)) {
706 printf("Saving the key failed: %s.\n", identity_file);
707 memset(passphrase, 0, strlen(passphrase));
713 memset(passphrase, 0, strlen(passphrase));
715 public = key_from_private(private);
718 strlcat(identity_file, ".pub", sizeof(identity_file));
719 fd = open(identity_file, O_WRONLY | O_CREAT | O_TRUNC, 0644);
721 printf("Could not save your public key in %s\n", identity_file);
726 printf("fdopen %s failed", identity_file);
729 if (!key_write(public, f))
730 fprintf(stderr, "write key failed");
732 fprintf(f, " %s\n", new_comment);
737 printf("The comment in your key file has been changed.\n");
744 printf("Usage: %s [-ceilpqyB] [-t type] [-b bits] [-f file] [-C comment] "
745 "[-N new-pass] [-P pass]\n", __progname);
750 * Main program for key management.
753 main(int ac, char **av)
755 char dotsshdir[16 * 1024], comment[1024], *passphrase1, *passphrase2;
756 Key *private, *public;
758 int opt, type, fd, reader = -1;
765 __progname = get_progname(av[0]);
769 SSLeay_add_all_algorithms();
771 /* we need this for the home * directory. */
772 pw = getpwuid(getuid());
774 printf("You don't exist, go away!\n");
777 if (gethostname(hostname, sizeof(hostname)) < 0) {
778 perror("gethostname");
782 while ((opt = getopt(ac, av, "deiqpclBRxXyb:f:t:u:P:N:C:")) != -1) {
786 if (bits < 512 || bits > 32768) {
787 printf("Bits has bad value.\n");
792 print_fingerprint = 1;
795 print_bubblebabble = 1;
798 change_passphrase = 1;
804 strlcpy(identity_file, optarg, sizeof(identity_file));
808 identity_passphrase = optarg;
811 identity_new_passphrase = optarg;
814 identity_comment = optarg;
831 convert_from_ssh2 = 1;
837 key_type_name = "dsa";
840 key_type_name = optarg;
843 reader = atoi(optarg); /*XXX*/
851 printf("Too many arguments.\n");
854 if (change_passphrase && change_comment) {
855 printf("Can only have one of -p and -c.\n");
858 if (print_fingerprint || print_bubblebabble)
860 if (change_passphrase)
861 do_change_passphrase(pw);
863 do_change_comment(pw);
865 do_convert_to_ssh2(pw);
866 if (convert_from_ssh2)
867 do_convert_from_ssh2(pw);
871 do_upload(pw, reader);
875 type = key_type_from_name(key_type_name);
876 if (type == KEY_UNSPEC) {
877 fprintf(stderr, "unknown key type %s\n", key_type_name);
881 printf("Generating public/private %s key pair.\n", key_type_name);
882 private = key_generate(type, bits);
883 if (private == NULL) {
884 fprintf(stderr, "key_generate failed");
887 public = key_from_private(private);
890 ask_filename(pw, "Enter file in which to save the key");
892 /* Create ~/.ssh directory if it doesn\'t already exist. */
893 snprintf(dotsshdir, sizeof dotsshdir, "%s/%s", pw->pw_dir, _PATH_SSH_USER_DIR);
894 if (strstr(identity_file, dotsshdir) != NULL &&
895 stat(dotsshdir, &st) < 0) {
896 if (mkdir(dotsshdir, 0700) < 0)
897 error("Could not create directory '%s'.", dotsshdir);
899 printf("Created directory '%s'.\n", dotsshdir);
901 /* If the file already exists, ask the user to confirm. */
902 if (stat(identity_file, &st) >= 0) {
904 printf("%s already exists.\n", identity_file);
905 printf("Overwrite (y/n)? ");
907 if (fgets(yesno, sizeof(yesno), stdin) == NULL)
909 if (yesno[0] != 'y' && yesno[0] != 'Y')
912 /* Ask for a passphrase (twice). */
913 if (identity_passphrase)
914 passphrase1 = xstrdup(identity_passphrase);
915 else if (identity_new_passphrase)
916 passphrase1 = xstrdup(identity_new_passphrase);
920 read_passphrase("Enter passphrase (empty for no "
921 "passphrase): ", RP_ALLOW_STDIN);
922 passphrase2 = read_passphrase("Enter same passphrase again: ",
924 if (strcmp(passphrase1, passphrase2) != 0) {
926 * The passphrases do not match. Clear them and
929 memset(passphrase1, 0, strlen(passphrase1));
930 memset(passphrase2, 0, strlen(passphrase2));
933 printf("Passphrases do not match. Try again.\n");
934 goto passphrase_again;
936 /* Clear the other copy of the passphrase. */
937 memset(passphrase2, 0, strlen(passphrase2));
941 if (identity_comment) {
942 strlcpy(comment, identity_comment, sizeof(comment));
944 /* Create default commend field for the passphrase. */
945 snprintf(comment, sizeof comment, "%s@%s", pw->pw_name, hostname);
948 /* Save the key with the given passphrase and comment. */
949 if (!key_save_private(private, identity_file, passphrase1, comment)) {
950 printf("Saving the key failed: %s.\n", identity_file);
951 memset(passphrase1, 0, strlen(passphrase1));
955 /* Clear the passphrase. */
956 memset(passphrase1, 0, strlen(passphrase1));
959 /* Clear the private key and the random number generator. */
964 printf("Your identification has been saved in %s.\n", identity_file);
966 strlcat(identity_file, ".pub", sizeof(identity_file));
967 fd = open(identity_file, O_WRONLY | O_CREAT | O_TRUNC, 0644);
969 printf("Could not save your public key in %s\n", identity_file);
974 printf("fdopen %s failed", identity_file);
977 if (!key_write(public, f))
978 fprintf(stderr, "write key failed");
979 fprintf(f, " %s\n", comment);
983 char *fp = key_fingerprint(public, SSH_FP_MD5, SSH_FP_HEX);
984 printf("Your public key has been saved in %s.\n",
986 printf("The key fingerprint is:\n");
987 printf("%s %s\n", fp, comment);