2 * Generic SSH public-key handling operations. In particular,
\r
3 * reading of SSH public-key files, and also the generic `sign'
\r
4 * operation for SSH-2 (which checks the type of the key and
\r
5 * dispatches to the appropriate key-type specific function).
\r
16 #define rsa_signature "SSH PRIVATE KEY FILE FORMAT 1.1\n"
\r
18 #define BASE64_TOINT(x) ( (x)-'A'<26 ? (x)-'A'+0 :\
\r
19 (x)-'a'<26 ? (x)-'a'+26 :\
\r
20 (x)-'0'<10 ? (x)-'0'+52 :\
\r
24 static int key_type_fp(FILE *fp);
\r
26 static int loadrsakey_main(FILE * fp, struct RSAKey *key, int pub_only,
\r
27 char **commentptr, const char *passphrase,
\r
30 unsigned char buf[16384];
\r
31 unsigned char keybuf[16];
\r
33 int i, j, ciphertype;
\r
35 struct MD5Context md5c;
\r
40 /* Slurp the whole file (minus the header) into a buffer. */
\r
41 len = fread(buf, 1, sizeof(buf), fp);
\r
43 if (len < 0 || len == sizeof(buf)) {
\r
44 *error = "error reading file";
\r
45 goto end; /* file too big or not read */
\r
49 *error = "file format error";
\r
52 * A zero byte. (The signature includes a terminating NUL.)
\r
54 if (len - i < 1 || buf[i] != 0)
\r
58 /* One byte giving encryption type, and one reserved uint32. */
\r
61 ciphertype = buf[i];
\r
62 if (ciphertype != 0 && ciphertype != SSH_CIPHER_3DES)
\r
66 goto end; /* reserved field not present */
\r
67 if (buf[i] != 0 || buf[i + 1] != 0 || buf[i + 2] != 0
\r
68 || buf[i + 3] != 0) goto end; /* reserved field nonzero, panic! */
\r
71 /* Now the serious stuff. An ordinary SSH-1 public key. */
\r
72 j = makekey(buf + i, len - i, key, NULL, 1);
\r
74 goto end; /* overran */
\r
77 /* Next, the comment field. */
\r
78 j = toint(GET_32BIT(buf + i));
\r
80 if (j < 0 || len - i < j)
\r
82 comment = snewn(j + 1, char);
\r
84 memcpy(comment, buf + i, j);
\r
89 *commentptr = dupstr(comment);
\r
91 key->comment = comment;
\r
101 ret = ciphertype != 0;
\r
107 * Decrypt remainder of buffer.
\r
111 MD5Update(&md5c, (unsigned char *)passphrase, strlen(passphrase));
\r
112 MD5Final(keybuf, &md5c);
\r
113 des3_decrypt_pubkey(keybuf, buf + i, (len - i + 7) & ~7);
\r
114 smemclr(keybuf, sizeof(keybuf)); /* burn the evidence */
\r
118 * We are now in the secret part of the key. The first four
\r
119 * bytes should be of the form a, b, a, b.
\r
123 if (buf[i] != buf[i + 2] || buf[i + 1] != buf[i + 3]) {
\r
124 *error = "wrong passphrase";
\r
131 * After that, we have one further bignum which is our
\r
132 * decryption exponent, and then the three auxiliary values
\r
135 j = makeprivate(buf + i, len - i, key);
\r
136 if (j < 0) goto end;
\r
138 j = ssh1_read_bignum(buf + i, len - i, &key->iqmp);
\r
139 if (j < 0) goto end;
\r
141 j = ssh1_read_bignum(buf + i, len - i, &key->q);
\r
142 if (j < 0) goto end;
\r
144 j = ssh1_read_bignum(buf + i, len - i, &key->p);
\r
145 if (j < 0) goto end;
\r
148 if (!rsa_verify(key)) {
\r
149 *error = "rsa_verify failed";
\r
156 smemclr(buf, sizeof(buf)); /* burn the evidence */
\r
160 int loadrsakey(const Filename *filename, struct RSAKey *key,
\r
161 const char *passphrase, const char **errorstr)
\r
166 const char *error = NULL;
\r
168 fp = f_open(filename, "rb", FALSE);
\r
170 error = "can't open file";
\r
175 * Read the first line of the file and see if it's a v1 private
\r
178 if (fgets(buf, sizeof(buf), fp) && !strcmp(buf, rsa_signature)) {
\r
180 * This routine will take care of calling fclose() for us.
\r
182 ret = loadrsakey_main(fp, key, FALSE, NULL, passphrase, &error);
\r
188 * Otherwise, we have nothing. Return empty-handed.
\r
190 error = "not an SSH-1 RSA file";
\r
195 if ((ret != 1) && errorstr)
\r
201 * See whether an RSA key is encrypted. Return its comment field as
\r
204 int rsakey_encrypted(const Filename *filename, char **comment)
\r
209 fp = f_open(filename, "rb", FALSE);
\r
211 return 0; /* doesn't even exist */
\r
214 * Read the first line of the file and see if it's a v1 private
\r
217 if (fgets(buf, sizeof(buf), fp) && !strcmp(buf, rsa_signature)) {
\r
220 * This routine will take care of calling fclose() for us.
\r
222 return loadrsakey_main(fp, NULL, FALSE, comment, NULL, &dummy);
\r
225 return 0; /* wasn't the right kind of file */
\r
229 * Return a malloc'ed chunk of memory containing the public blob of
\r
230 * an RSA key, as given in the agent protocol (modulus bits,
\r
231 * exponent, modulus).
\r
233 int rsakey_pubblob(const Filename *filename, void **blob, int *bloblen,
\r
234 char **commentptr, const char **errorstr)
\r
240 const char *error = NULL;
\r
242 /* Default return if we fail. */
\r
247 fp = f_open(filename, "rb", FALSE);
\r
249 error = "can't open file";
\r
254 * Read the first line of the file and see if it's a v1 private
\r
257 if (fgets(buf, sizeof(buf), fp) && !strcmp(buf, rsa_signature)) {
\r
258 memset(&key, 0, sizeof(key));
\r
259 if (loadrsakey_main(fp, &key, TRUE, commentptr, NULL, &error)) {
\r
260 *blob = rsa_public_blob(&key, bloblen);
\r
264 fp = NULL; /* loadrsakey_main unconditionally closes fp */
\r
267 * Try interpreting the file as an SSH-1 public key.
\r
269 char *line, *p, *bitsp, *expp, *modp, *commentp;
\r
272 line = chomp(fgetline(fp));
\r
276 p += strspn(p, "0123456789");
\r
278 goto not_public_either;
\r
282 p += strspn(p, "0123456789");
\r
284 goto not_public_either;
\r
288 p += strspn(p, "0123456789");
\r
291 goto not_public_either;
\r
298 memset(&key, 0, sizeof(key));
\r
299 key.exponent = bignum_from_decimal(expp);
\r
300 key.modulus = bignum_from_decimal(modp);
\r
301 if (atoi(bitsp) != bignum_bitcount(key.modulus)) {
\r
302 freebn(key.exponent);
\r
303 freebn(key.modulus);
\r
305 error = "key bit count does not match in SSH-1 public key file";
\r
309 *commentptr = commentp ? dupstr(commentp) : NULL;
\r
310 *blob = rsa_public_blob(&key, bloblen);
\r
318 error = "not an SSH-1 RSA file";
\r
324 if ((ret != 1) && errorstr)
\r
330 * Save an RSA key file. Return nonzero on success.
\r
332 int saversakey(const Filename *filename, struct RSAKey *key, char *passphrase)
\r
334 unsigned char buf[16384];
\r
335 unsigned char keybuf[16];
\r
336 struct MD5Context md5c;
\r
337 unsigned char *p, *estart;
\r
341 * Write the initial signature.
\r
344 memcpy(p, rsa_signature, sizeof(rsa_signature));
\r
345 p += sizeof(rsa_signature);
\r
348 * One byte giving encryption type, and one reserved (zero)
\r
351 *p++ = (passphrase ? SSH_CIPHER_3DES : 0);
\r
356 * An ordinary SSH-1 public key consists of: a uint32
\r
357 * containing the bit count, then two bignums containing the
\r
358 * modulus and exponent respectively.
\r
360 PUT_32BIT(p, bignum_bitcount(key->modulus));
\r
362 p += ssh1_write_bignum(p, key->modulus);
\r
363 p += ssh1_write_bignum(p, key->exponent);
\r
366 * A string containing the comment field.
\r
368 if (key->comment) {
\r
369 PUT_32BIT(p, strlen(key->comment));
\r
371 memcpy(p, key->comment, strlen(key->comment));
\r
372 p += strlen(key->comment);
\r
379 * The encrypted portion starts here.
\r
384 * Two bytes, then the same two bytes repeated.
\r
386 *p++ = random_byte();
\r
387 *p++ = random_byte();
\r
393 * Four more bignums: the decryption exponent, then iqmp, then
\r
396 p += ssh1_write_bignum(p, key->private_exponent);
\r
397 p += ssh1_write_bignum(p, key->iqmp);
\r
398 p += ssh1_write_bignum(p, key->q);
\r
399 p += ssh1_write_bignum(p, key->p);
\r
402 * Now write zeros until the encrypted portion is a multiple of
\r
405 while ((p - estart) % 8)
\r
409 * Now encrypt the encrypted portion.
\r
413 MD5Update(&md5c, (unsigned char *)passphrase, strlen(passphrase));
\r
414 MD5Final(keybuf, &md5c);
\r
415 des3_encrypt_pubkey(keybuf, estart, p - estart);
\r
416 smemclr(keybuf, sizeof(keybuf)); /* burn the evidence */
\r
420 * Done. Write the result to the file.
\r
422 fp = f_open(filename, "wb", TRUE);
\r
424 int ret = (fwrite(buf, 1, p - buf, fp) == (size_t) (p - buf));
\r
432 /* ----------------------------------------------------------------------
\r
433 * SSH-2 private key load/store functions.
\r
437 * PuTTY's own format for SSH-2 keys is as follows:
\r
439 * The file is text. Lines are terminated by CRLF, although CR-only
\r
440 * and LF-only are tolerated on input.
\r
442 * The first line says "PuTTY-User-Key-File-2: " plus the name of the
\r
443 * algorithm ("ssh-dss", "ssh-rsa" etc).
\r
445 * The next line says "Encryption: " plus an encryption type.
\r
446 * Currently the only supported encryption types are "aes256-cbc"
\r
449 * The next line says "Comment: " plus the comment string.
\r
451 * Next there is a line saying "Public-Lines: " plus a number N.
\r
452 * The following N lines contain a base64 encoding of the public
\r
453 * part of the key. This is encoded as the standard SSH-2 public key
\r
454 * blob (with no initial length): so for RSA, for example, it will
\r
461 * Next, there is a line saying "Private-Lines: " plus a number N,
\r
462 * and then N lines containing the (potentially encrypted) private
\r
463 * part of the key. For the key type "ssh-rsa", this will be
\r
466 * mpint private_exponent
\r
467 * mpint p (the larger of the two primes)
\r
468 * mpint q (the smaller prime)
\r
469 * mpint iqmp (the inverse of q modulo p)
\r
470 * data padding (to reach a multiple of the cipher block size)
\r
472 * And for "ssh-dss", it will be composed of
\r
474 * mpint x (the private key parameter)
\r
475 * [ string hash 20-byte hash of mpints p || q || g only in old format ]
\r
477 * Finally, there is a line saying "Private-MAC: " plus a hex
\r
478 * representation of a HMAC-SHA-1 of:
\r
480 * string name of algorithm ("ssh-dss", "ssh-rsa")
\r
481 * string encryption type
\r
483 * string public-blob
\r
484 * string private-plaintext (the plaintext version of the
\r
485 * private part, including the final
\r
488 * The key to the MAC is itself a SHA-1 hash of:
\r
490 * data "putty-private-key-file-mac-key"
\r
493 * (An empty passphrase is used for unencrypted keys.)
\r
495 * If the key is encrypted, the encryption key is derived from the
\r
496 * passphrase by means of a succession of SHA-1 hashes. Each hash
\r
499 * uint32 sequence-number
\r
502 * where the sequence-number increases from zero. As many of these
\r
503 * hashes are used as necessary.
\r
505 * For backwards compatibility with snapshots between 0.51 and
\r
506 * 0.52, we also support the older key file format, which begins
\r
507 * with "PuTTY-User-Key-File-1" (version number differs). In this
\r
508 * format the Private-MAC: field only covers the private-plaintext
\r
509 * field and nothing else (and without the 4-byte string length on
\r
510 * the front too). Moreover, the Private-MAC: field can be replaced
\r
511 * with a Private-Hash: field which is a plain SHA-1 hash instead of
\r
512 * an HMAC (this was generated for unencrypted keys).
\r
515 static int read_header(FILE * fp, char *header)
\r
522 if (c == '\n' || c == '\r' || c == EOF)
\r
523 return 0; /* failure */
\r
529 return 1; /* success! */
\r
532 return 0; /* failure */
\r
536 return 0; /* failure */
\r
539 static char *read_body(FILE * fp)
\r
547 text = snewn(size, char);
\r
553 if (c == '\r' || c == '\n' || c == EOF) {
\r
556 if (c != '\r' && c != '\n')
\r
561 if (len + 1 >= size) {
\r
563 text = sresize(text, size, char);
\r
570 static unsigned char *read_blob(FILE * fp, int nlines, int *bloblen)
\r
572 unsigned char *blob;
\r
577 /* We expect at most 64 base64 characters, ie 48 real bytes, per line. */
\r
578 blob = snewn(48 * nlines, unsigned char);
\r
580 for (i = 0; i < nlines; i++) {
\r
581 line = read_body(fp);
\r
586 linelen = strlen(line);
\r
587 if (linelen % 4 != 0 || linelen > 64) {
\r
592 for (j = 0; j < linelen; j += 4) {
\r
593 k = base64_decode_atom(line + j, blob + len);
\r
608 * Magic error return value for when the passphrase is wrong.
\r
610 struct ssh2_userkey ssh2_wrong_passphrase = {
\r
614 const struct ssh_signkey *find_pubkey_alg_len(int namelen, const char *name)
\r
616 if (match_ssh_id(namelen, name, "ssh-rsa"))
\r
618 else if (match_ssh_id(namelen, name, "ssh-dss"))
\r
620 else if (match_ssh_id(namelen, name, "ecdsa-sha2-nistp256"))
\r
621 return &ssh_ecdsa_nistp256;
\r
622 else if (match_ssh_id(namelen, name, "ecdsa-sha2-nistp384"))
\r
623 return &ssh_ecdsa_nistp384;
\r
624 else if (match_ssh_id(namelen, name, "ecdsa-sha2-nistp521"))
\r
625 return &ssh_ecdsa_nistp521;
\r
626 else if (match_ssh_id(namelen, name, "ssh-ed25519"))
\r
627 return &ssh_ecdsa_ed25519;
\r
632 const struct ssh_signkey *find_pubkey_alg(const char *name)
\r
634 return find_pubkey_alg_len(strlen(name), name);
\r
637 struct ssh2_userkey *ssh2_load_userkey(const Filename *filename,
\r
638 const char *passphrase,
\r
639 const char **errorstr)
\r
642 char header[40], *b, *encryption, *comment, *mac;
\r
643 const struct ssh_signkey *alg;
\r
644 struct ssh2_userkey *ret;
\r
645 int cipher, cipherblk;
\r
646 unsigned char *public_blob, *private_blob;
\r
647 int public_blob_len, private_blob_len;
\r
648 int i, is_mac, old_fmt;
\r
649 int passlen = passphrase ? strlen(passphrase) : 0;
\r
650 const char *error = NULL;
\r
652 ret = NULL; /* return NULL for most errors */
\r
653 encryption = comment = mac = NULL;
\r
654 public_blob = private_blob = NULL;
\r
656 fp = f_open(filename, "rb", FALSE);
\r
658 error = "can't open file";
\r
662 /* Read the first header line which contains the key type. */
\r
663 if (!read_header(fp, header))
\r
665 if (0 == strcmp(header, "PuTTY-User-Key-File-2")) {
\r
667 } else if (0 == strcmp(header, "PuTTY-User-Key-File-1")) {
\r
668 /* this is an old key file; warn and then continue */
\r
669 old_keyfile_warning();
\r
671 } else if (0 == strncmp(header, "PuTTY-User-Key-File-", 20)) {
\r
672 /* this is a key file FROM THE FUTURE; refuse it, but with a
\r
673 * more specific error message than the generic one below */
\r
674 error = "PuTTY key format too new";
\r
677 error = "not a PuTTY SSH-2 private key";
\r
680 error = "file format error";
\r
681 if ((b = read_body(fp)) == NULL)
\r
683 /* Select key algorithm structure. */
\r
684 alg = find_pubkey_alg(b);
\r
691 /* Read the Encryption header line. */
\r
692 if (!read_header(fp, header) || 0 != strcmp(header, "Encryption"))
\r
694 if ((encryption = read_body(fp)) == NULL)
\r
696 if (!strcmp(encryption, "aes256-cbc")) {
\r
699 } else if (!strcmp(encryption, "none")) {
\r
706 /* Read the Comment header line. */
\r
707 if (!read_header(fp, header) || 0 != strcmp(header, "Comment"))
\r
709 if ((comment = read_body(fp)) == NULL)
\r
712 /* Read the Public-Lines header line and the public blob. */
\r
713 if (!read_header(fp, header) || 0 != strcmp(header, "Public-Lines"))
\r
715 if ((b = read_body(fp)) == NULL)
\r
719 if ((public_blob = read_blob(fp, i, &public_blob_len)) == NULL)
\r
722 /* Read the Private-Lines header line and the Private blob. */
\r
723 if (!read_header(fp, header) || 0 != strcmp(header, "Private-Lines"))
\r
725 if ((b = read_body(fp)) == NULL)
\r
729 if ((private_blob = read_blob(fp, i, &private_blob_len)) == NULL)
\r
732 /* Read the Private-MAC or Private-Hash header line. */
\r
733 if (!read_header(fp, header))
\r
735 if (0 == strcmp(header, "Private-MAC")) {
\r
736 if ((mac = read_body(fp)) == NULL)
\r
739 } else if (0 == strcmp(header, "Private-Hash") && old_fmt) {
\r
740 if ((mac = read_body(fp)) == NULL)
\r
750 * Decrypt the private blob.
\r
753 unsigned char key[40];
\r
758 if (private_blob_len % cipherblk)
\r
762 SHA_Bytes(&s, "\0\0\0\0", 4);
\r
763 SHA_Bytes(&s, passphrase, passlen);
\r
764 SHA_Final(&s, key + 0);
\r
766 SHA_Bytes(&s, "\0\0\0\1", 4);
\r
767 SHA_Bytes(&s, passphrase, passlen);
\r
768 SHA_Final(&s, key + 20);
\r
769 aes256_decrypt_pubkey(key, private_blob, private_blob_len);
\r
777 unsigned char binary[20];
\r
778 unsigned char *macdata;
\r
783 /* MAC (or hash) only covers the private blob. */
\r
784 macdata = private_blob;
\r
785 maclen = private_blob_len;
\r
789 int namelen = strlen(alg->name);
\r
790 int enclen = strlen(encryption);
\r
791 int commlen = strlen(comment);
\r
792 maclen = (4 + namelen +
\r
795 4 + public_blob_len +
\r
796 4 + private_blob_len);
\r
797 macdata = snewn(maclen, unsigned char);
\r
799 #define DO_STR(s,len) PUT_32BIT(p,(len));memcpy(p+4,(s),(len));p+=4+(len)
\r
800 DO_STR(alg->name, namelen);
\r
801 DO_STR(encryption, enclen);
\r
802 DO_STR(comment, commlen);
\r
803 DO_STR(public_blob, public_blob_len);
\r
804 DO_STR(private_blob, private_blob_len);
\r
811 unsigned char mackey[20];
\r
812 char header[] = "putty-private-key-file-mac-key";
\r
815 SHA_Bytes(&s, header, sizeof(header)-1);
\r
816 if (cipher && passphrase)
\r
817 SHA_Bytes(&s, passphrase, passlen);
\r
818 SHA_Final(&s, mackey);
\r
820 hmac_sha1_simple(mackey, 20, macdata, maclen, binary);
\r
822 smemclr(mackey, sizeof(mackey));
\r
823 smemclr(&s, sizeof(s));
\r
825 SHA_Simple(macdata, maclen, binary);
\r
828 if (free_macdata) {
\r
829 smemclr(macdata, maclen);
\r
833 for (i = 0; i < 20; i++)
\r
834 sprintf(realmac + 2 * i, "%02x", binary[i]);
\r
836 if (strcmp(mac, realmac)) {
\r
837 /* An incorrect MAC is an unconditional Error if the key is
\r
838 * unencrypted. Otherwise, it means Wrong Passphrase. */
\r
840 error = "wrong passphrase";
\r
841 ret = SSH2_WRONG_PASSPHRASE;
\r
843 error = "MAC failed";
\r
853 * Create and return the key.
\r
855 ret = snew(struct ssh2_userkey);
\r
857 ret->comment = comment;
\r
858 ret->data = alg->createkey(alg, public_blob, public_blob_len,
\r
859 private_blob, private_blob_len);
\r
863 error = "createkey failed";
\r
866 sfree(public_blob);
\r
867 smemclr(private_blob, private_blob_len);
\r
868 sfree(private_blob);
\r
875 * Error processing.
\r
887 sfree(public_blob);
\r
888 if (private_blob) {
\r
889 smemclr(private_blob, private_blob_len);
\r
890 sfree(private_blob);
\r
897 unsigned char *rfc4716_loadpub(FILE *fp, char **algorithm,
\r
898 int *pub_blob_len, char **commentptr,
\r
899 const char **errorstr)
\r
902 char *line, *colon, *value;
\r
903 char *comment = NULL;
\r
904 unsigned char *pubblob = NULL;
\r
905 int pubbloblen, pubblobsize;
\r
907 unsigned char base64out[3];
\r
911 line = chomp(fgetline(fp));
\r
912 if (!line || 0 != strcmp(line, "---- BEGIN SSH2 PUBLIC KEY ----")) {
\r
913 error = "invalid begin line in SSH-2 public key file";
\r
916 sfree(line); line = NULL;
\r
919 line = chomp(fgetline(fp));
\r
921 error = "truncated SSH-2 public key file";
\r
924 colon = strstr(line, ": ");
\r
930 if (!strcmp(line, "Comment")) {
\r
933 /* Remove containing double quotes, if present */
\r
935 if (*p == '"' && p[strlen(p)-1] == '"') {
\r
936 p[strlen(p)-1] = '\0';
\r
940 /* Remove \-escaping, not in RFC4716 but seen in the wild
\r
942 for (q = line; *p; p++) {
\r
943 if (*p == '\\' && p[1])
\r
949 sfree(comment); /* *just* in case of multiple Comment headers */
\r
950 comment = dupstr(line);
\r
951 } else if (!strcmp(line, "Subject") ||
\r
952 !strncmp(line, "x-", 2)) {
\r
953 /* Headers we recognise and ignore. Do nothing. */
\r
955 error = "unrecognised header in SSH-2 public key file";
\r
959 sfree(line); line = NULL;
\r
963 * Now line contains the initial line of base64 data. Loop round
\r
964 * while it still does contain base64.
\r
966 pubblobsize = 4096;
\r
967 pubblob = snewn(pubblobsize, unsigned char);
\r
970 while (line && line[0] != '-') {
\r
972 for (p = line; *p; p++) {
\r
973 base64in[base64bytes++] = *p;
\r
974 if (base64bytes == 4) {
\r
975 int n = base64_decode_atom(base64in, base64out);
\r
976 if (pubbloblen + n > pubblobsize) {
\r
977 pubblobsize = (pubbloblen + n) * 5 / 4 + 1024;
\r
978 pubblob = sresize(pubblob, pubblobsize, unsigned char);
\r
980 memcpy(pubblob + pubbloblen, base64out, n);
\r
985 sfree(line); line = NULL;
\r
986 line = chomp(fgetline(fp));
\r
990 * Finally, check the END line makes sense.
\r
992 if (!line || 0 != strcmp(line, "---- END SSH2 PUBLIC KEY ----")) {
\r
993 error = "invalid end line in SSH-2 public key file";
\r
996 sfree(line); line = NULL;
\r
999 * OK, we now have a public blob and optionally a comment. We must
\r
1000 * return the key algorithm string too, so look for that at the
\r
1001 * start of the public blob.
\r
1003 if (pubbloblen < 4) {
\r
1004 error = "not enough data in SSH-2 public key file";
\r
1007 alglen = toint(GET_32BIT(pubblob));
\r
1008 if (alglen < 0 || alglen > pubbloblen-4) {
\r
1009 error = "invalid algorithm prefix in SSH-2 public key file";
\r
1013 *algorithm = dupprintf("%.*s", alglen, pubblob+4);
\r
1015 *pub_blob_len = pubbloblen;
\r
1017 *commentptr = comment;
\r
1027 *errorstr = error;
\r
1031 unsigned char *openssh_loadpub(FILE *fp, char **algorithm,
\r
1032 int *pub_blob_len, char **commentptr,
\r
1033 const char **errorstr)
\r
1035 const char *error;
\r
1036 char *line, *base64;
\r
1037 char *comment = NULL;
\r
1038 unsigned char *pubblob = NULL;
\r
1039 int pubbloblen, pubblobsize;
\r
1042 line = chomp(fgetline(fp));
\r
1044 base64 = strchr(line, ' ');
\r
1046 error = "no key blob in OpenSSH public key file";
\r
1051 comment = strchr(base64, ' ');
\r
1053 *comment++ = '\0';
\r
1054 comment = dupstr(comment);
\r
1057 pubblobsize = strlen(base64) / 4 * 3;
\r
1058 pubblob = snewn(pubblobsize, unsigned char);
\r
1061 while (!memchr(base64, '\0', 4)) {
\r
1062 assert(pubbloblen + 3 <= pubblobsize);
\r
1063 pubbloblen += base64_decode_atom(base64, pubblob + pubbloblen);
\r
1067 error = "invalid length for base64 data in OpenSSH public key file";
\r
1072 * Sanity check: the first word on the line should be the key
\r
1073 * algorithm, and should match the encoded string at the start of
\r
1074 * the public blob.
\r
1076 alglen = strlen(line);
\r
1077 if (pubbloblen < alglen + 4 ||
\r
1078 GET_32BIT(pubblob) != alglen ||
\r
1079 0 != memcmp(pubblob + 4, line, alglen)) {
\r
1080 error = "key algorithms do not match in OpenSSH public key file";
\r
1088 *algorithm = dupstr(line);
\r
1090 *pub_blob_len = pubbloblen;
\r
1092 *commentptr = comment;
\r
1103 *errorstr = error;
\r
1107 unsigned char *ssh2_userkey_loadpub(const Filename *filename, char **algorithm,
\r
1108 int *pub_blob_len, char **commentptr,
\r
1109 const char **errorstr)
\r
1112 char header[40], *b;
\r
1113 const struct ssh_signkey *alg;
\r
1114 unsigned char *public_blob;
\r
1115 int public_blob_len;
\r
1117 const char *error = NULL;
\r
1118 char *comment = NULL;
\r
1120 public_blob = NULL;
\r
1122 fp = f_open(filename, "rb", FALSE);
\r
1124 error = "can't open file";
\r
1128 /* Initially, check if this is a public-only key file. Sometimes
\r
1129 * we'll be asked to read a public blob from one of those. */
\r
1130 type = key_type_fp(fp);
\r
1131 if (type == SSH_KEYTYPE_SSH2_PUBLIC_RFC4716) {
\r
1132 unsigned char *ret = rfc4716_loadpub(fp, algorithm, pub_blob_len,
\r
1133 commentptr, errorstr);
\r
1136 } else if (type == SSH_KEYTYPE_SSH2_PUBLIC_OPENSSH) {
\r
1137 unsigned char *ret = openssh_loadpub(fp, algorithm, pub_blob_len,
\r
1138 commentptr, errorstr);
\r
1141 } else if (type != SSH_KEYTYPE_SSH2) {
\r
1142 error = "not a PuTTY SSH-2 private key";
\r
1146 /* Read the first header line which contains the key type. */
\r
1147 if (!read_header(fp, header)
\r
1148 || (0 != strcmp(header, "PuTTY-User-Key-File-2") &&
\r
1149 0 != strcmp(header, "PuTTY-User-Key-File-1"))) {
\r
1150 if (0 == strncmp(header, "PuTTY-User-Key-File-", 20))
\r
1151 error = "PuTTY key format too new";
\r
1153 error = "not a PuTTY SSH-2 private key";
\r
1156 error = "file format error";
\r
1157 if ((b = read_body(fp)) == NULL)
\r
1159 /* Select key algorithm structure. */
\r
1160 alg = find_pubkey_alg(b);
\r
1166 /* Read the Encryption header line. */
\r
1167 if (!read_header(fp, header) || 0 != strcmp(header, "Encryption"))
\r
1169 if ((b = read_body(fp)) == NULL)
\r
1171 sfree(b); /* we don't care */
\r
1173 /* Read the Comment header line. */
\r
1174 if (!read_header(fp, header) || 0 != strcmp(header, "Comment"))
\r
1176 if ((comment = read_body(fp)) == NULL)
\r
1180 *commentptr = comment;
\r
1184 /* Read the Public-Lines header line and the public blob. */
\r
1185 if (!read_header(fp, header) || 0 != strcmp(header, "Public-Lines"))
\r
1187 if ((b = read_body(fp)) == NULL)
\r
1191 if ((public_blob = read_blob(fp, i, &public_blob_len)) == NULL)
\r
1196 *pub_blob_len = public_blob_len;
\r
1198 *algorithm = dupstr(alg->name);
\r
1199 return public_blob;
\r
1202 * Error processing.
\r
1208 sfree(public_blob);
\r
1210 *errorstr = error;
\r
1211 if (comment && commentptr) {
\r
1213 *commentptr = NULL;
\r
1218 int ssh2_userkey_encrypted(const Filename *filename, char **commentptr)
\r
1221 char header[40], *b, *comment;
\r
1225 *commentptr = NULL;
\r
1227 fp = f_open(filename, "rb", FALSE);
\r
1230 if (!read_header(fp, header)
\r
1231 || (0 != strcmp(header, "PuTTY-User-Key-File-2") &&
\r
1232 0 != strcmp(header, "PuTTY-User-Key-File-1"))) {
\r
1236 if ((b = read_body(fp)) == NULL) {
\r
1240 sfree(b); /* we don't care about key type here */
\r
1241 /* Read the Encryption header line. */
\r
1242 if (!read_header(fp, header) || 0 != strcmp(header, "Encryption")) {
\r
1246 if ((b = read_body(fp)) == NULL) {
\r
1251 /* Read the Comment header line. */
\r
1252 if (!read_header(fp, header) || 0 != strcmp(header, "Comment")) {
\r
1257 if ((comment = read_body(fp)) == NULL) {
\r
1264 *commentptr = comment;
\r
1269 if (!strcmp(b, "aes256-cbc"))
\r
1277 int base64_lines(int datalen)
\r
1279 /* When encoding, we use 64 chars/line, which equals 48 real chars. */
\r
1280 return (datalen + 47) / 48;
\r
1283 void base64_encode(FILE *fp, const unsigned char *data, int datalen, int cpl)
\r
1289 while (datalen > 0) {
\r
1290 n = (datalen < 3 ? datalen : 3);
\r
1291 base64_encode_atom(data, n, out);
\r
1294 for (i = 0; i < 4; i++) {
\r
1295 if (linelen >= cpl) {
\r
1299 fputc(out[i], fp);
\r
1306 int ssh2_save_userkey(const Filename *filename, struct ssh2_userkey *key,
\r
1310 unsigned char *pub_blob, *priv_blob, *priv_blob_encrypted;
\r
1311 int pub_blob_len, priv_blob_len, priv_encrypted_len;
\r
1315 const char *cipherstr;
\r
1316 unsigned char priv_mac[20];
\r
1319 * Fetch the key component blobs.
\r
1321 pub_blob = key->alg->public_blob(key->data, &pub_blob_len);
\r
1322 priv_blob = key->alg->private_blob(key->data, &priv_blob_len);
\r
1323 if (!pub_blob || !priv_blob) {
\r
1330 * Determine encryption details, and encrypt the private blob.
\r
1333 cipherstr = "aes256-cbc";
\r
1336 cipherstr = "none";
\r
1339 priv_encrypted_len = priv_blob_len + cipherblk - 1;
\r
1340 priv_encrypted_len -= priv_encrypted_len % cipherblk;
\r
1341 priv_blob_encrypted = snewn(priv_encrypted_len, unsigned char);
\r
1342 memset(priv_blob_encrypted, 0, priv_encrypted_len);
\r
1343 memcpy(priv_blob_encrypted, priv_blob, priv_blob_len);
\r
1344 /* Create padding based on the SHA hash of the unpadded blob. This prevents
\r
1345 * too easy a known-plaintext attack on the last block. */
\r
1346 SHA_Simple(priv_blob, priv_blob_len, priv_mac);
\r
1347 assert(priv_encrypted_len - priv_blob_len < 20);
\r
1348 memcpy(priv_blob_encrypted + priv_blob_len, priv_mac,
\r
1349 priv_encrypted_len - priv_blob_len);
\r
1351 /* Now create the MAC. */
\r
1353 unsigned char *macdata;
\r
1356 int namelen = strlen(key->alg->name);
\r
1357 int enclen = strlen(cipherstr);
\r
1358 int commlen = strlen(key->comment);
\r
1360 unsigned char mackey[20];
\r
1361 char header[] = "putty-private-key-file-mac-key";
\r
1363 maclen = (4 + namelen +
\r
1366 4 + pub_blob_len +
\r
1367 4 + priv_encrypted_len);
\r
1368 macdata = snewn(maclen, unsigned char);
\r
1370 #define DO_STR(s,len) PUT_32BIT(p,(len));memcpy(p+4,(s),(len));p+=4+(len)
\r
1371 DO_STR(key->alg->name, namelen);
\r
1372 DO_STR(cipherstr, enclen);
\r
1373 DO_STR(key->comment, commlen);
\r
1374 DO_STR(pub_blob, pub_blob_len);
\r
1375 DO_STR(priv_blob_encrypted, priv_encrypted_len);
\r
1378 SHA_Bytes(&s, header, sizeof(header)-1);
\r
1380 SHA_Bytes(&s, passphrase, strlen(passphrase));
\r
1381 SHA_Final(&s, mackey);
\r
1382 hmac_sha1_simple(mackey, 20, macdata, maclen, priv_mac);
\r
1383 smemclr(macdata, maclen);
\r
1385 smemclr(mackey, sizeof(mackey));
\r
1386 smemclr(&s, sizeof(s));
\r
1390 unsigned char key[40];
\r
1393 passlen = strlen(passphrase);
\r
1396 SHA_Bytes(&s, "\0\0\0\0", 4);
\r
1397 SHA_Bytes(&s, passphrase, passlen);
\r
1398 SHA_Final(&s, key + 0);
\r
1400 SHA_Bytes(&s, "\0\0\0\1", 4);
\r
1401 SHA_Bytes(&s, passphrase, passlen);
\r
1402 SHA_Final(&s, key + 20);
\r
1403 aes256_encrypt_pubkey(key, priv_blob_encrypted,
\r
1404 priv_encrypted_len);
\r
1406 smemclr(key, sizeof(key));
\r
1407 smemclr(&s, sizeof(s));
\r
1410 fp = f_open(filename, "w", TRUE);
\r
1413 smemclr(priv_blob, priv_blob_len);
\r
1415 smemclr(priv_blob_encrypted, priv_blob_len);
\r
1416 sfree(priv_blob_encrypted);
\r
1419 fprintf(fp, "PuTTY-User-Key-File-2: %s\n", key->alg->name);
\r
1420 fprintf(fp, "Encryption: %s\n", cipherstr);
\r
1421 fprintf(fp, "Comment: %s\n", key->comment);
\r
1422 fprintf(fp, "Public-Lines: %d\n", base64_lines(pub_blob_len));
\r
1423 base64_encode(fp, pub_blob, pub_blob_len, 64);
\r
1424 fprintf(fp, "Private-Lines: %d\n", base64_lines(priv_encrypted_len));
\r
1425 base64_encode(fp, priv_blob_encrypted, priv_encrypted_len, 64);
\r
1426 fprintf(fp, "Private-MAC: ");
\r
1427 for (i = 0; i < 20; i++)
\r
1428 fprintf(fp, "%02x", priv_mac[i]);
\r
1429 fprintf(fp, "\n");
\r
1433 smemclr(priv_blob, priv_blob_len);
\r
1435 smemclr(priv_blob_encrypted, priv_blob_len);
\r
1436 sfree(priv_blob_encrypted);
\r
1440 /* ----------------------------------------------------------------------
\r
1441 * Output public keys.
\r
1443 char *ssh1_pubkey_str(struct RSAKey *key)
\r
1446 char *dec1, *dec2;
\r
1448 dec1 = bignum_decimal(key->exponent);
\r
1449 dec2 = bignum_decimal(key->modulus);
\r
1450 buffer = dupprintf("%d %s %s%s%s", bignum_bitcount(key->modulus),
\r
1452 key->comment ? " " : "",
\r
1453 key->comment ? key->comment : "");
\r
1459 void ssh1_write_pubkey(FILE *fp, struct RSAKey *key)
\r
1461 char *buffer = ssh1_pubkey_str(key);
\r
1462 fprintf(fp, "%s\n", buffer);
\r
1466 static char *ssh2_pubkey_openssh_str_internal(const char *comment,
\r
1467 const void *v_pub_blob,
\r
1470 const unsigned char *ssh2blob = (const unsigned char *)v_pub_blob;
\r
1476 if (pub_len < 4) {
\r
1479 alglen = GET_32BIT(ssh2blob);
\r
1480 if (alglen > 0 && alglen < pub_len - 4) {
\r
1481 alg = (const char *)ssh2blob + 4;
\r
1488 alg = "INVALID-ALGORITHM";
\r
1489 alglen = strlen(alg);
\r
1492 buffer = snewn(alglen +
\r
1493 4 * ((pub_len+2) / 3) +
\r
1494 (comment ? strlen(comment) : 0) + 3, char);
\r
1495 p = buffer + sprintf(buffer, "%.*s ", alglen, alg);
\r
1497 while (i < pub_len) {
\r
1498 int n = (pub_len - i < 3 ? pub_len - i : 3);
\r
1499 base64_encode_atom(ssh2blob + i, n, p);
\r
1505 strcpy(p, comment);
\r
1512 char *ssh2_pubkey_openssh_str(struct ssh2_userkey *key)
\r
1515 unsigned char *blob;
\r
1518 blob = key->alg->public_blob(key->data, &bloblen);
\r
1519 ret = ssh2_pubkey_openssh_str_internal(key->comment, blob, bloblen);
\r
1525 void ssh2_write_pubkey(FILE *fp, const char *comment,
\r
1526 const void *v_pub_blob, int pub_len,
\r
1529 unsigned char *pub_blob = (unsigned char *)v_pub_blob;
\r
1531 if (keytype == SSH_KEYTYPE_SSH2_PUBLIC_RFC4716) {
\r
1535 fprintf(fp, "---- BEGIN SSH2 PUBLIC KEY ----\n");
\r
1538 fprintf(fp, "Comment: \"");
\r
1539 for (p = comment; *p; p++) {
\r
1540 if (*p == '\\' || *p == '\"')
\r
1544 fprintf(fp, "\"\n");
\r
1549 while (i < pub_len) {
\r
1551 int n = (pub_len - i < 3 ? pub_len - i : 3);
\r
1552 base64_encode_atom(pub_blob + i, n, buf);
\r
1556 if (++column >= 16) {
\r
1564 fprintf(fp, "---- END SSH2 PUBLIC KEY ----\n");
\r
1565 } else if (keytype == SSH_KEYTYPE_SSH2_PUBLIC_OPENSSH) {
\r
1566 char *buffer = ssh2_pubkey_openssh_str_internal(comment,
\r
1567 v_pub_blob, pub_len);
\r
1568 fprintf(fp, "%s\n", buffer);
\r
1571 assert(0 && "Bad key type in ssh2_write_pubkey");
\r
1575 /* ----------------------------------------------------------------------
\r
1576 * Utility functions to compute SSH-2 fingerprints in a uniform way.
\r
1578 char *ssh2_fingerprint_blob(const void *blob, int bloblen)
\r
1580 unsigned char digest[16];
\r
1581 char fingerprint_str[16*3];
\r
1582 const char *algstr;
\r
1584 const struct ssh_signkey *alg;
\r
1588 * The fingerprint hash itself is always just the MD5 of the blob.
\r
1590 MD5Simple(blob, bloblen, digest);
\r
1591 for (i = 0; i < 16; i++)
\r
1592 sprintf(fingerprint_str + i*3, "%02x%s", digest[i], i==15 ? "" : ":");
\r
1595 * Identify the key algorithm, if possible.
\r
1597 alglen = toint(GET_32BIT((const unsigned char *)blob));
\r
1598 if (alglen > 0 && alglen < bloblen-4) {
\r
1599 algstr = (const char *)blob + 4;
\r
1602 * If we can actually identify the algorithm as one we know
\r
1603 * about, get hold of the key's bit count too.
\r
1605 alg = find_pubkey_alg_len(alglen, algstr);
\r
1607 int bits = alg->pubkey_bits(alg, blob, bloblen);
\r
1608 return dupprintf("%.*s %d %s", alglen, algstr,
\r
1609 bits, fingerprint_str);
\r
1611 return dupprintf("%.*s %s", alglen, algstr, fingerprint_str);
\r
1615 * No algorithm available (which means a seriously confused
\r
1616 * key blob, but there we go). Return only the hash.
\r
1618 return dupstr(fingerprint_str);
\r
1622 char *ssh2_fingerprint(const struct ssh_signkey *alg, void *data)
\r
1625 unsigned char *blob = alg->public_blob(data, &len);
\r
1626 char *ret = ssh2_fingerprint_blob(blob, len);
\r
1631 /* ----------------------------------------------------------------------
\r
1632 * Determine the type of a private key file.
\r
1634 static int key_type_fp(FILE *fp)
\r
1637 const char public_std_sig[] = "---- BEGIN SSH2 PUBLIC KEY";
\r
1638 const char putty2_sig[] = "PuTTY-User-Key-File-";
\r
1639 const char sshcom_sig[] = "---- BEGIN SSH2 ENCRYPTED PRIVAT";
\r
1640 const char openssh_new_sig[] = "-----BEGIN OPENSSH PRIVATE KEY";
\r
1641 const char openssh_sig[] = "-----BEGIN ";
\r
1645 i = fread(buf, 1, sizeof(buf)-1, fp);
\r
1649 return SSH_KEYTYPE_UNOPENABLE;
\r
1651 return SSH_KEYTYPE_UNKNOWN;
\r
1652 assert(i > 0 && i < sizeof(buf));
\r
1654 if (!memcmp(buf, rsa_signature, sizeof(rsa_signature)-1))
\r
1655 return SSH_KEYTYPE_SSH1;
\r
1656 if (!memcmp(buf, public_std_sig, sizeof(public_std_sig)-1))
\r
1657 return SSH_KEYTYPE_SSH2_PUBLIC_RFC4716;
\r
1658 if (!memcmp(buf, putty2_sig, sizeof(putty2_sig)-1))
\r
1659 return SSH_KEYTYPE_SSH2;
\r
1660 if (!memcmp(buf, openssh_new_sig, sizeof(openssh_new_sig)-1))
\r
1661 return SSH_KEYTYPE_OPENSSH_NEW;
\r
1662 if (!memcmp(buf, openssh_sig, sizeof(openssh_sig)-1))
\r
1663 return SSH_KEYTYPE_OPENSSH_PEM;
\r
1664 if (!memcmp(buf, sshcom_sig, sizeof(sshcom_sig)-1))
\r
1665 return SSH_KEYTYPE_SSHCOM;
\r
1666 if ((p = buf + strspn(buf, "0123456789"), *p == ' ') &&
\r
1667 (p = p+1 + strspn(p+1, "0123456789"), *p == ' ') &&
\r
1668 (p = p+1 + strspn(p+1, "0123456789"), *p == ' ' || *p == '\n' || !*p))
\r
1669 return SSH_KEYTYPE_SSH1_PUBLIC;
\r
1670 if ((p = buf + strcspn(buf, " "), find_pubkey_alg_len(p-buf, buf)) &&
\r
1671 (p = p+1 + strspn(p+1, "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghij"
\r
1672 "klmnopqrstuvwxyz+/="),
\r
1673 *p == ' ' || *p == '\n' || !*p))
\r
1674 return SSH_KEYTYPE_SSH2_PUBLIC_OPENSSH;
\r
1675 return SSH_KEYTYPE_UNKNOWN; /* unrecognised or EOF */
\r
1678 int key_type(const Filename *filename)
\r
1683 fp = f_open(filename, "r", FALSE);
\r
1685 return SSH_KEYTYPE_UNOPENABLE;
\r
1686 ret = key_type_fp(fp);
\r
1692 * Convert the type word to a string, for `wrong type' error
\r
1695 const char *key_type_to_str(int type)
\r
1698 case SSH_KEYTYPE_UNOPENABLE: return "unable to open file"; break;
\r
1699 case SSH_KEYTYPE_UNKNOWN: return "not a recognised key file format"; break;
\r
1700 case SSH_KEYTYPE_SSH1_PUBLIC: return "SSH-1 public key"; break;
\r
1701 case SSH_KEYTYPE_SSH2_PUBLIC_RFC4716: return "SSH-2 public key (RFC 4716 format)"; break;
\r
1702 case SSH_KEYTYPE_SSH2_PUBLIC_OPENSSH: return "SSH-2 public key (OpenSSH format)"; break;
\r
1703 case SSH_KEYTYPE_SSH1: return "SSH-1 private key"; break;
\r
1704 case SSH_KEYTYPE_SSH2: return "PuTTY SSH-2 private key"; break;
\r
1705 case SSH_KEYTYPE_OPENSSH_PEM: return "OpenSSH SSH-2 private key (old PEM format)"; break;
\r
1706 case SSH_KEYTYPE_OPENSSH_NEW: return "OpenSSH SSH-2 private key (new format)"; break;
\r
1707 case SSH_KEYTYPE_SSHCOM: return "ssh.com SSH-2 private key"; break;
\r
1709 * This function is called with a key type derived from
\r
1710 * looking at an actual key file, so the output-only type
\r
1711 * OPENSSH_AUTO should never get here, and is much an INTERNAL
\r
1712 * ERROR as a code we don't even understand.
\r
1714 case SSH_KEYTYPE_OPENSSH_AUTO: return "INTERNAL ERROR (OPENSSH_AUTO)"; break;
\r
1715 default: return "INTERNAL ERROR"; break;
\r