sshpubk.c

   1 /*
   2  * Generic SSH public-key handling operations. In particular,
   3  * reading of SSH public-key files, and also the generic `sign'
   4  * operation for SSH-2 (which checks the type of the key and
   5  * dispatches to the appropriate key-type specific function).
   6  */
   7
   8 #include <stdio.h>
   9 #include <stdlib.h>
  10 #include <assert.h>
  11
  12 #include "putty.h"
  13 #include "ssh.h"
  14 #include "misc.h"
  15
  16 #define rsa_signature "SSH PRIVATE KEY FILE FORMAT 1.1\n"
  17
  18 #define BASE64_TOINT(x) ( (x)-'A'<26 ? (x)-'A'+0 :\
  19                           (x)-'a'<26 ? (x)-'a'+26 :\
  20                           (x)-'0'<10 ? (x)-'0'+52 :\
  21                           (x)=='+' ? 62 : \
  22                           (x)=='/' ? 63 : 0 )
  23
  24 static int loadrsakey_main(FILE * fp, struct RSAKey *key, int pub_only,
  25                            char **commentptr, char *passphrase,
  26                            const char **error)
  27 {
  28     unsigned char buf[16384];
  29     unsigned char keybuf[16];
  30     int len;
  31     int i, j, ciphertype;
  32     int ret = 0;
  33     struct MD5Context md5c;
  34     char *comment;
  35
  36     *error = NULL;
  37
  38     /* Slurp the whole file (minus the header) into a buffer. */
  39     len = fread(buf, 1, sizeof(buf), fp);
  40     fclose(fp);
  41     if (len < 0 || len == sizeof(buf)) {
  42         *error = "error reading file";
  43         goto end;                      /* file too big or not read */
  44     }
  45
  46     i = 0;
  47     *error = "file format error";
  48
  49     /*
  50      * A zero byte. (The signature includes a terminating NUL.)
  51      */
  52     if (len - i < 1 || buf[i] != 0)
  53         goto end;
  54     i++;
  55
  56     /* One byte giving encryption type, and one reserved uint32. */
  57     if (len - i < 1)
  58         goto end;
  59     ciphertype = buf[i];
  60     if (ciphertype != 0 && ciphertype != SSH_CIPHER_3DES)
  61         goto end;
  62     i++;
  63     if (len - i < 4)
  64         goto end;                      /* reserved field not present */
  65     if (buf[i] != 0 || buf[i + 1] != 0 || buf[i + 2] != 0
  66         || buf[i + 3] != 0) goto end;  /* reserved field nonzero, panic! */
  67     i += 4;
  68
  69     /* Now the serious stuff. An ordinary SSH-1 public key. */
  70     j = makekey(buf + i, len, key, NULL, 1);
  71     if (j < 0)
  72         goto end;                      /* overran */
  73     i += j;
  74
  75     /* Next, the comment field. */
  76     j = toint(GET_32BIT(buf + i));
  77     i += 4;
  78     if (j < 0 || len - i < j)
  79         goto end;
  80     comment = snewn(j + 1, char);
  81     if (comment) {
  82         memcpy(comment, buf + i, j);
  83         comment[j] = '\0';
  84     }
  85     i += j;
  86     if (commentptr)
  87         *commentptr = dupstr(comment);
  88     if (key)
  89         key->comment = comment;
  90     else
  91         sfree(comment);
  92
  93     if (pub_only) {
  94         ret = 1;
  95         goto end;
  96     }
  97
  98     if (!key) {
  99         ret = ciphertype != 0;
 100         *error = NULL;
 101         goto end;
 102     }
 103
 104     /*
 105      * Decrypt remainder of buffer.
 106      */
 107     if (ciphertype) {
 108         MD5Init(&md5c);
 109         MD5Update(&md5c, (unsigned char *)passphrase, strlen(passphrase));
 110         MD5Final(keybuf, &md5c);
 111         des3_decrypt_pubkey(keybuf, buf + i, (len - i + 7) & ~7);
 112         smemclr(keybuf, sizeof(keybuf));        /* burn the evidence */
 113     }
 114
 115     /*
 116      * We are now in the secret part of the key. The first four
 117      * bytes should be of the form a, b, a, b.
 118      */
 119     if (len - i < 4)
 120         goto end;
 121     if (buf[i] != buf[i + 2] || buf[i + 1] != buf[i + 3]) {
 122         *error = "wrong passphrase";
 123         ret = -1;
 124         goto end;
 125     }
 126     i += 4;
 127
 128     /*
 129      * After that, we have one further bignum which is our
 130      * decryption exponent, and then the three auxiliary values
 131      * (iqmp, q, p).
 132      */
 133     j = makeprivate(buf + i, len - i, key);
 134     if (j < 0) goto end;
 135     i += j;
 136     j = ssh1_read_bignum(buf + i, len - i, &key->iqmp);
 137     if (j < 0) goto end;
 138     i += j;
 139     j = ssh1_read_bignum(buf + i, len - i, &key->q);
 140     if (j < 0) goto end;
 141     i += j;
 142     j = ssh1_read_bignum(buf + i, len - i, &key->p);
 143     if (j < 0) goto end;
 144     i += j;
 145
 146     if (!rsa_verify(key)) {
 147         *error = "rsa_verify failed";
 148         freersakey(key);
 149         ret = 0;
 150     } else
 151         ret = 1;
 152
 153   end:
 154     smemclr(buf, sizeof(buf));       /* burn the evidence */
 155     return ret;
 156 }
 157
 158 int loadrsakey(const Filename *filename, struct RSAKey *key, char *passphrase,
 159                const char **errorstr)
 160 {
 161     FILE *fp;
 162     char buf[64];
 163     int ret = 0;
 164     const char *error = NULL;
 165
 166     fp = f_open(filename, "rb", FALSE);
 167     if (!fp) {
 168         error = "can't open file";
 169         goto end;
 170     }
 171
 172     /*
 173      * Read the first line of the file and see if it's a v1 private
 174      * key file.
 175      */
 176     if (fgets(buf, sizeof(buf), fp) && !strcmp(buf, rsa_signature)) {
 177         /*
 178          * This routine will take care of calling fclose() for us.
 179          */
 180         ret = loadrsakey_main(fp, key, FALSE, NULL, passphrase, &error);
 181         fp = NULL;
 182         goto end;
 183     }
 184
 185     /*
 186      * Otherwise, we have nothing. Return empty-handed.
 187      */
 188     error = "not an SSH-1 RSA file";
 189
 190   end:
 191     if (fp)
 192         fclose(fp);
 193     if ((ret != 1) && errorstr)
 194         *errorstr = error;
 195     return ret;
 196 }
 197
 198 /*
 199  * See whether an RSA key is encrypted. Return its comment field as
 200  * well.
 201  */
 202 int rsakey_encrypted(const Filename *filename, char **comment)
 203 {
 204     FILE *fp;
 205     char buf[64];
 206
 207     fp = f_open(filename, "rb", FALSE);
 208     if (!fp)
 209         return 0;                      /* doesn't even exist */
 210
 211     /*
 212      * Read the first line of the file and see if it's a v1 private
 213      * key file.
 214      */
 215     if (fgets(buf, sizeof(buf), fp) && !strcmp(buf, rsa_signature)) {
 216         const char *dummy;
 217         /*
 218          * This routine will take care of calling fclose() for us.
 219          */
 220         return loadrsakey_main(fp, NULL, FALSE, comment, NULL, &dummy);
 221     }
 222     fclose(fp);
 223     return 0;                          /* wasn't the right kind of file */
 224 }
 225
 226 /*
 227  * Return a malloc'ed chunk of memory containing the public blob of
 228  * an RSA key, as given in the agent protocol (modulus bits,
 229  * exponent, modulus).
 230  */
 231 int rsakey_pubblob(const Filename *filename, void **blob, int *bloblen,
 232                    char **commentptr, const char **errorstr)
 233 {
 234     FILE *fp;
 235     char buf[64];
 236     struct RSAKey key;
 237     int ret;
 238     const char *error = NULL;
 239
 240     /* Default return if we fail. */
 241     *blob = NULL;
 242     *bloblen = 0;
 243     ret = 0;
 244
 245     fp = f_open(filename, "rb", FALSE);
 246     if (!fp) {
 247         error = "can't open file";
 248         goto end;
 249     }
 250
 251     /*
 252      * Read the first line of the file and see if it's a v1 private
 253      * key file.
 254      */
 255     if (fgets(buf, sizeof(buf), fp) && !strcmp(buf, rsa_signature)) {
 256         memset(&key, 0, sizeof(key));
 257         if (loadrsakey_main(fp, &key, TRUE, commentptr, NULL, &error)) {
 258             *blob = rsa_public_blob(&key, bloblen);
 259             freersakey(&key);
 260             ret = 1;
 261         }
 262         fp = NULL; /* loadrsakey_main unconditionally closes fp */
 263     } else {
 264         error = "not an SSH-1 RSA file";
 265     }
 266
 267   end:
 268     if (fp)
 269         fclose(fp);
 270     if ((ret != 1) && errorstr)
 271         *errorstr = error;
 272     return ret;
 273 }
 274
 275 /*
 276  * Save an RSA key file. Return nonzero on success.
 277  */
 278 int saversakey(const Filename *filename, struct RSAKey *key, char *passphrase)
 279 {
 280     unsigned char buf[16384];
 281     unsigned char keybuf[16];
 282     struct MD5Context md5c;
 283     unsigned char *p, *estart;
 284     FILE *fp;
 285
 286     /*
 287      * Write the initial signature.
 288      */
 289     p = buf;
 290     memcpy(p, rsa_signature, sizeof(rsa_signature));
 291     p += sizeof(rsa_signature);
 292
 293     /*
 294      * One byte giving encryption type, and one reserved (zero)
 295      * uint32.
 296      */
 297     *p++ = (passphrase ? SSH_CIPHER_3DES : 0);
 298     PUT_32BIT(p, 0);
 299     p += 4;
 300
 301     /*
 302      * An ordinary SSH-1 public key consists of: a uint32
 303      * containing the bit count, then two bignums containing the
 304      * modulus and exponent respectively.
 305      */
 306     PUT_32BIT(p, bignum_bitcount(key->modulus));
 307     p += 4;
 308     p += ssh1_write_bignum(p, key->modulus);
 309     p += ssh1_write_bignum(p, key->exponent);
 310
 311     /*
 312      * A string containing the comment field.
 313      */
 314     if (key->comment) {
 315         PUT_32BIT(p, strlen(key->comment));
 316         p += 4;
 317         memcpy(p, key->comment, strlen(key->comment));
 318         p += strlen(key->comment);
 319     } else {
 320         PUT_32BIT(p, 0);
 321         p += 4;
 322     }
 323
 324     /*
 325      * The encrypted portion starts here.
 326      */
 327     estart = p;
 328
 329     /*
 330      * Two bytes, then the same two bytes repeated.
 331      */
 332     *p++ = random_byte();
 333     *p++ = random_byte();
 334     p[0] = p[-2];
 335     p[1] = p[-1];
 336     p += 2;
 337
 338     /*
 339      * Four more bignums: the decryption exponent, then iqmp, then
 340      * q, then p.
 341      */
 342     p += ssh1_write_bignum(p, key->private_exponent);
 343     p += ssh1_write_bignum(p, key->iqmp);
 344     p += ssh1_write_bignum(p, key->q);
 345     p += ssh1_write_bignum(p, key->p);
 346
 347     /*
 348      * Now write zeros until the encrypted portion is a multiple of
 349      * 8 bytes.
 350      */
 351     while ((p - estart) % 8)
 352         *p++ = '\0';
 353
 354     /*
 355      * Now encrypt the encrypted portion.
 356      */
 357     if (passphrase) {
 358         MD5Init(&md5c);
 359         MD5Update(&md5c, (unsigned char *)passphrase, strlen(passphrase));
 360         MD5Final(keybuf, &md5c);
 361         des3_encrypt_pubkey(keybuf, estart, p - estart);
 362         smemclr(keybuf, sizeof(keybuf));        /* burn the evidence */
 363     }
 364
 365     /*
 366      * Done. Write the result to the file.
 367      */
 368     fp = f_open(filename, "wb", TRUE);
 369     if (fp) {
 370         int ret = (fwrite(buf, 1, p - buf, fp) == (size_t) (p - buf));
 371         if (fclose(fp))
 372             ret = 0;
 373         return ret;
 374     } else
 375         return 0;
 376 }
 377
 378 /* ----------------------------------------------------------------------
 379  * SSH-2 private key load/store functions.
 380  */
 381
 382 /*
 383  * PuTTY's own format for SSH-2 keys is as follows:
 384  *
 385  * The file is text. Lines are terminated by CRLF, although CR-only
 386  * and LF-only are tolerated on input.
 387  *
 388  * The first line says "PuTTY-User-Key-File-2: " plus the name of the
 389  * algorithm ("ssh-dss", "ssh-rsa" etc).
 390  *
 391  * The next line says "Encryption: " plus an encryption type.
 392  * Currently the only supported encryption types are "aes256-cbc"
 393  * and "none".
 394  *
 395  * The next line says "Comment: " plus the comment string.
 396  *
 397  * Next there is a line saying "Public-Lines: " plus a number N.
 398  * The following N lines contain a base64 encoding of the public
 399  * part of the key. This is encoded as the standard SSH-2 public key
 400  * blob (with no initial length): so for RSA, for example, it will
 401  * read
 402  *
 403  *    string "ssh-rsa"
 404  *    mpint  exponent
 405  *    mpint  modulus
 406  *
 407  * Next, there is a line saying "Private-Lines: " plus a number N,
 408  * and then N lines containing the (potentially encrypted) private
 409  * part of the key. For the key type "ssh-rsa", this will be
 410  * composed of
 411  *
 412  *    mpint  private_exponent
 413  *    mpint  p                  (the larger of the two primes)
 414  *    mpint  q                  (the smaller prime)
 415  *    mpint  iqmp               (the inverse of q modulo p)
 416  *    data   padding            (to reach a multiple of the cipher block size)
 417  *
 418  * And for "ssh-dss", it will be composed of
 419  *
 420  *    mpint  x                  (the private key parameter)
 421  *  [ string hash   20-byte hash of mpints p || q || g   only in old format ]
 422  *
 423  * Finally, there is a line saying "Private-MAC: " plus a hex
 424  * representation of a HMAC-SHA-1 of:
 425  *
 426  *    string  name of algorithm ("ssh-dss", "ssh-rsa")
 427  *    string  encryption type
 428  *    string  comment
 429  *    string  public-blob
 430  *    string  private-plaintext (the plaintext version of the
 431  *                               private part, including the final
 432  *                               padding)
 433  *
 434  * The key to the MAC is itself a SHA-1 hash of:
 435  *
 436  *    data    "putty-private-key-file-mac-key"
 437  *    data    passphrase
 438  *
 439  * (An empty passphrase is used for unencrypted keys.)
 440  *
 441  * If the key is encrypted, the encryption key is derived from the
 442  * passphrase by means of a succession of SHA-1 hashes. Each hash
 443  * is the hash of:
 444  *
 445  *    uint32  sequence-number
 446  *    data    passphrase
 447  *
 448  * where the sequence-number increases from zero. As many of these
 449  * hashes are used as necessary.
 450  *
 451  * For backwards compatibility with snapshots between 0.51 and
 452  * 0.52, we also support the older key file format, which begins
 453  * with "PuTTY-User-Key-File-1" (version number differs). In this
 454  * format the Private-MAC: field only covers the private-plaintext
 455  * field and nothing else (and without the 4-byte string length on
 456  * the front too). Moreover, the Private-MAC: field can be replaced
 457  * with a Private-Hash: field which is a plain SHA-1 hash instead of
 458  * an HMAC (this was generated for unencrypted keys).
 459  */
 460
 461 static int read_header(FILE * fp, char *header)
 462 {
 463     int len = 39;
 464     int c;
 465
 466     while (1) {
 467         c = fgetc(fp);
 468         if (c == '\n' || c == '\r' || c == EOF)
 469             return 0;                  /* failure */
 470         if (c == ':') {
 471             c = fgetc(fp);
 472             if (c != ' ')
 473                 return 0;
 474             *header = '\0';
 475             return 1;                  /* success! */
 476         }
 477         if (len == 0)
 478             return 0;                  /* failure */
 479         *header++ = c;
 480         len--;
 481     }
 482     return 0;                          /* failure */
 483 }
 484
 485 static char *read_body(FILE * fp)
 486 {
 487     char *text;
 488     int len;
 489     int size;
 490     int c;
 491
 492     size = 128;
 493     text = snewn(size, char);
 494     len = 0;
 495     text[len] = '\0';
 496
 497     while (1) {
 498         c = fgetc(fp);
 499         if (c == '\r' || c == '\n' || c == EOF) {
 500             if (c != EOF) {
 501                 c = fgetc(fp);
 502                 if (c != '\r' && c != '\n')
 503                     ungetc(c, fp);
 504             }
 505             return text;
 506         }
 507         if (len + 1 >= size) {
 508             size += 128;
 509             text = sresize(text, size, char);
 510         }
 511         text[len++] = c;
 512         text[len] = '\0';
 513     }
 514 }
 515
 516 static unsigned char *read_blob(FILE * fp, int nlines, int *bloblen)
 517 {
 518     unsigned char *blob;
 519     char *line;
 520     int linelen, len;
 521     int i, j, k;
 522
 523     /* We expect at most 64 base64 characters, ie 48 real bytes, per line. */
 524     blob = snewn(48 * nlines, unsigned char);
 525     len = 0;
 526     for (i = 0; i < nlines; i++) {
 527         line = read_body(fp);
 528         if (!line) {
 529             sfree(blob);
 530             return NULL;
 531         }
 532         linelen = strlen(line);
 533         if (linelen % 4 != 0 || linelen > 64) {
 534             sfree(blob);
 535             sfree(line);
 536             return NULL;
 537         }
 538         for (j = 0; j < linelen; j += 4) {
 539             k = base64_decode_atom(line + j, blob + len);
 540             if (!k) {
 541                 sfree(line);
 542                 sfree(blob);
 543                 return NULL;
 544             }
 545             len += k;
 546         }
 547         sfree(line);
 548     }
 549     *bloblen = len;
 550     return blob;
 551 }
 552
 553 /*
 554  * Magic error return value for when the passphrase is wrong.
 555  */
 556 struct ssh2_userkey ssh2_wrong_passphrase = {
 557     NULL, NULL, NULL
 558 };
 559
 560 const struct ssh_signkey *find_pubkey_alg(const char *name)
 561 {
 562     if (!strcmp(name, "ssh-rsa"))
 563         return &ssh_rsa;
 564     else if (!strcmp(name, "ssh-dss"))
 565         return &ssh_dss;
 566     else if (!strcmp(name, "ecdsa-sha2-nistp256"))
 567         return &ssh_ecdsa_nistp256;
 568     else if (!strcmp(name, "ecdsa-sha2-nistp384"))
 569         return &ssh_ecdsa_nistp384;
 570     else if (!strcmp(name, "ecdsa-sha2-nistp521"))
 571         return &ssh_ecdsa_nistp521;
 572     else
 573         return NULL;
 574 }
 575
 576 struct ssh2_userkey *ssh2_load_userkey(const Filename *filename,
 577                                        char *passphrase, const char **errorstr)
 578 {
 579     FILE *fp;
 580     char header[40], *b, *encryption, *comment, *mac;
 581     const struct ssh_signkey *alg;
 582     struct ssh2_userkey *ret;
 583     int cipher, cipherblk;
 584     unsigned char *public_blob, *private_blob;
 585     int public_blob_len, private_blob_len;
 586     int i, is_mac, old_fmt;
 587     int passlen = passphrase ? strlen(passphrase) : 0;
 588     const char *error = NULL;
 589
 590     ret = NULL;                        /* return NULL for most errors */
 591     encryption = comment = mac = NULL;
 592     public_blob = private_blob = NULL;
 593
 594     fp = f_open(filename, "rb", FALSE);
 595     if (!fp) {
 596         error = "can't open file";
 597         goto error;
 598     }
 599
 600     /* Read the first header line which contains the key type. */
 601     if (!read_header(fp, header))
 602         goto error;
 603     if (0 == strcmp(header, "PuTTY-User-Key-File-2")) {
 604         old_fmt = 0;
 605     } else if (0 == strcmp(header, "PuTTY-User-Key-File-1")) {
 606         /* this is an old key file; warn and then continue */
 607         old_keyfile_warning();
 608         old_fmt = 1;
 609     } else if (0 == strncmp(header, "PuTTY-User-Key-File-", 20)) {
 610         /* this is a key file FROM THE FUTURE; refuse it, but with a
 611          * more specific error message than the generic one below */
 612         error = "PuTTY key format too new";
 613         goto error;
 614     } else {
 615         error = "not a PuTTY SSH-2 private key";
 616         goto error;
 617     }
 618     error = "file format error";
 619     if ((b = read_body(fp)) == NULL)
 620         goto error;
 621     /* Select key algorithm structure. */
 622     alg = find_pubkey_alg(b);
 623     if (!alg) {
 624         sfree(b);
 625         goto error;
 626     }
 627     sfree(b);
 628
 629     /* Read the Encryption header line. */
 630     if (!read_header(fp, header) || 0 != strcmp(header, "Encryption"))
 631         goto error;
 632     if ((encryption = read_body(fp)) == NULL)
 633         goto error;
 634     if (!strcmp(encryption, "aes256-cbc")) {
 635         cipher = 1;
 636         cipherblk = 16;
 637     } else if (!strcmp(encryption, "none")) {
 638         cipher = 0;
 639         cipherblk = 1;
 640     } else {
 641         goto error;
 642     }
 643
 644     /* Read the Comment header line. */
 645     if (!read_header(fp, header) || 0 != strcmp(header, "Comment"))
 646         goto error;
 647     if ((comment = read_body(fp)) == NULL)
 648         goto error;
 649
 650     /* Read the Public-Lines header line and the public blob. */
 651     if (!read_header(fp, header) || 0 != strcmp(header, "Public-Lines"))
 652         goto error;
 653     if ((b = read_body(fp)) == NULL)
 654         goto error;
 655     i = atoi(b);
 656     sfree(b);
 657     if ((public_blob = read_blob(fp, i, &public_blob_len)) == NULL)
 658         goto error;
 659
 660     /* Read the Private-Lines header line and the Private blob. */
 661     if (!read_header(fp, header) || 0 != strcmp(header, "Private-Lines"))
 662         goto error;
 663     if ((b = read_body(fp)) == NULL)
 664         goto error;
 665     i = atoi(b);
 666     sfree(b);
 667     if ((private_blob = read_blob(fp, i, &private_blob_len)) == NULL)
 668         goto error;
 669
 670     /* Read the Private-MAC or Private-Hash header line. */
 671     if (!read_header(fp, header))
 672         goto error;
 673     if (0 == strcmp(header, "Private-MAC")) {
 674         if ((mac = read_body(fp)) == NULL)
 675             goto error;
 676         is_mac = 1;
 677     } else if (0 == strcmp(header, "Private-Hash") && old_fmt) {
 678         if ((mac = read_body(fp)) == NULL)
 679             goto error;
 680         is_mac = 0;
 681     } else
 682         goto error;
 683
 684     fclose(fp);
 685     fp = NULL;
 686
 687     /*
 688      * Decrypt the private blob.
 689      */
 690     if (cipher) {
 691         unsigned char key[40];
 692         SHA_State s;
 693
 694         if (!passphrase)
 695             goto error;
 696         if (private_blob_len % cipherblk)
 697             goto error;
 698
 699         SHA_Init(&s);
 700         SHA_Bytes(&s, "\0\0\0\0", 4);
 701         SHA_Bytes(&s, passphrase, passlen);
 702         SHA_Final(&s, key + 0);
 703         SHA_Init(&s);
 704         SHA_Bytes(&s, "\0\0\0\1", 4);
 705         SHA_Bytes(&s, passphrase, passlen);
 706         SHA_Final(&s, key + 20);
 707         aes256_decrypt_pubkey(key, private_blob, private_blob_len);
 708     }
 709
 710     /*
 711      * Verify the MAC.
 712      */
 713     {
 714         char realmac[41];
 715         unsigned char binary[20];
 716         unsigned char *macdata;
 717         int maclen;
 718         int free_macdata;
 719
 720         if (old_fmt) {
 721             /* MAC (or hash) only covers the private blob. */
 722             macdata = private_blob;
 723             maclen = private_blob_len;
 724             free_macdata = 0;
 725         } else {
 726             unsigned char *p;
 727             int namelen = strlen(alg->name);
 728             int enclen = strlen(encryption);
 729             int commlen = strlen(comment);
 730             maclen = (4 + namelen +
 731                       4 + enclen +
 732                       4 + commlen +
 733                       4 + public_blob_len +
 734                       4 + private_blob_len);
 735             macdata = snewn(maclen, unsigned char);
 736             p = macdata;
 737 #define DO_STR(s,len) PUT_32BIT(p,(len));memcpy(p+4,(s),(len));p+=4+(len)
 738             DO_STR(alg->name, namelen);
 739             DO_STR(encryption, enclen);
 740             DO_STR(comment, commlen);
 741             DO_STR(public_blob, public_blob_len);
 742             DO_STR(private_blob, private_blob_len);
 743
 744             free_macdata = 1;
 745         }
 746
 747         if (is_mac) {
 748             SHA_State s;
 749             unsigned char mackey[20];
 750             char header[] = "putty-private-key-file-mac-key";
 751
 752             SHA_Init(&s);
 753             SHA_Bytes(&s, header, sizeof(header)-1);
 754             if (cipher && passphrase)
 755                 SHA_Bytes(&s, passphrase, passlen);
 756             SHA_Final(&s, mackey);
 757
 758             hmac_sha1_simple(mackey, 20, macdata, maclen, binary);
 759
 760             smemclr(mackey, sizeof(mackey));
 761             smemclr(&s, sizeof(s));
 762         } else {
 763             SHA_Simple(macdata, maclen, binary);
 764         }
 765
 766         if (free_macdata) {
 767             smemclr(macdata, maclen);
 768             sfree(macdata);
 769         }
 770
 771         for (i = 0; i < 20; i++)
 772             sprintf(realmac + 2 * i, "%02x", binary[i]);
 773
 774         if (strcmp(mac, realmac)) {
 775             /* An incorrect MAC is an unconditional Error if the key is
 776              * unencrypted. Otherwise, it means Wrong Passphrase. */
 777             if (cipher) {
 778                 error = "wrong passphrase";
 779                 ret = SSH2_WRONG_PASSPHRASE;
 780             } else {
 781                 error = "MAC failed";
 782                 ret = NULL;
 783             }
 784             goto error;
 785         }
 786     }
 787     sfree(mac);
 788     mac = NULL;
 789
 790     /*
 791      * Create and return the key.
 792      */
 793     ret = snew(struct ssh2_userkey);
 794     ret->alg = alg;
 795     ret->comment = comment;
 796     ret->data = alg->createkey(public_blob, public_blob_len,
 797                                private_blob, private_blob_len);
 798     if (!ret->data) {
 799         sfree(ret);
 800         ret = NULL;
 801         error = "createkey failed";
 802         goto error;
 803     }
 804     sfree(public_blob);
 805     sfree(private_blob);
 806     sfree(encryption);
 807     if (errorstr)
 808         *errorstr = NULL;
 809     return ret;
 810
 811     /*
 812      * Error processing.
 813      */
 814   error:
 815     if (fp)
 816         fclose(fp);
 817     if (comment)
 818         sfree(comment);
 819     if (encryption)
 820         sfree(encryption);
 821     if (mac)
 822         sfree(mac);
 823     if (public_blob)
 824         sfree(public_blob);
 825     if (private_blob)
 826         sfree(private_blob);
 827     if (errorstr)
 828         *errorstr = error;
 829     return ret;
 830 }
 831
 832 unsigned char *ssh2_userkey_loadpub(const Filename *filename, char **algorithm,
 833                                     int *pub_blob_len, char **commentptr,
 834                                     const char **errorstr)
 835 {
 836     FILE *fp;
 837     char header[40], *b;
 838     const struct ssh_signkey *alg;
 839     unsigned char *public_blob;
 840     int public_blob_len;
 841     int i;
 842     const char *error = NULL;
 843     char *comment;
 844
 845     public_blob = NULL;
 846
 847     fp = f_open(filename, "rb", FALSE);
 848     if (!fp) {
 849         error = "can't open file";
 850         goto error;
 851     }
 852
 853     /* Read the first header line which contains the key type. */
 854     if (!read_header(fp, header)
 855         || (0 != strcmp(header, "PuTTY-User-Key-File-2") &&
 856             0 != strcmp(header, "PuTTY-User-Key-File-1"))) {
 857         if (0 == strncmp(header, "PuTTY-User-Key-File-", 20))
 858             error = "PuTTY key format too new";
 859         else
 860             error = "not a PuTTY SSH-2 private key";
 861         goto error;
 862     }
 863     error = "file format error";
 864     if ((b = read_body(fp)) == NULL)
 865         goto error;
 866     /* Select key algorithm structure. */
 867     alg = find_pubkey_alg(b);
 868     if (!alg) {
 869         sfree(b);
 870         goto error;
 871     }
 872     sfree(b);
 873
 874     /* Read the Encryption header line. */
 875     if (!read_header(fp, header) || 0 != strcmp(header, "Encryption"))
 876         goto error;
 877     if ((b = read_body(fp)) == NULL)
 878         goto error;
 879     sfree(b);                          /* we don't care */
 880
 881     /* Read the Comment header line. */
 882     if (!read_header(fp, header) || 0 != strcmp(header, "Comment"))
 883         goto error;
 884     if ((comment = read_body(fp)) == NULL)
 885         goto error;
 886
 887     if (commentptr)
 888         *commentptr = comment;
 889     else
 890         sfree(comment);
 891
 892     /* Read the Public-Lines header line and the public blob. */
 893     if (!read_header(fp, header) || 0 != strcmp(header, "Public-Lines"))
 894         goto error;
 895     if ((b = read_body(fp)) == NULL)
 896         goto error;
 897     i = atoi(b);
 898     sfree(b);
 899     if ((public_blob = read_blob(fp, i, &public_blob_len)) == NULL)
 900         goto error;
 901
 902     fclose(fp);
 903     if (pub_blob_len)
 904         *pub_blob_len = public_blob_len;
 905     if (algorithm)
 906         *algorithm = alg->name;
 907     return public_blob;
 908
 909     /*
 910      * Error processing.
 911      */
 912   error:
 913     if (fp)
 914         fclose(fp);
 915     if (public_blob)
 916         sfree(public_blob);
 917     if (errorstr)
 918         *errorstr = error;
 919     return NULL;
 920 }
 921
 922 int ssh2_userkey_encrypted(const Filename *filename, char **commentptr)
 923 {
 924     FILE *fp;
 925     char header[40], *b, *comment;
 926     int ret;
 927
 928     if (commentptr)
 929         *commentptr = NULL;
 930
 931     fp = f_open(filename, "rb", FALSE);
 932     if (!fp)
 933         return 0;
 934     if (!read_header(fp, header)
 935         || (0 != strcmp(header, "PuTTY-User-Key-File-2") &&
 936             0 != strcmp(header, "PuTTY-User-Key-File-1"))) {
 937         fclose(fp);
 938         return 0;
 939     }
 940     if ((b = read_body(fp)) == NULL) {
 941         fclose(fp);
 942         return 0;
 943     }
 944     sfree(b);                          /* we don't care about key type here */
 945     /* Read the Encryption header line. */
 946     if (!read_header(fp, header) || 0 != strcmp(header, "Encryption")) {
 947         fclose(fp);
 948         return 0;
 949     }
 950     if ((b = read_body(fp)) == NULL) {
 951         fclose(fp);
 952         return 0;
 953     }
 954
 955     /* Read the Comment header line. */
 956     if (!read_header(fp, header) || 0 != strcmp(header, "Comment")) {
 957         fclose(fp);
 958         sfree(b);
 959         return 1;
 960     }
 961     if ((comment = read_body(fp)) == NULL) {
 962         fclose(fp);
 963         sfree(b);
 964         return 1;
 965     }
 966
 967     if (commentptr)
 968         *commentptr = comment;
 969     else
 970         sfree(comment);
 971
 972     fclose(fp);
 973     if (!strcmp(b, "aes256-cbc"))
 974         ret = 1;
 975     else
 976         ret = 0;
 977     sfree(b);
 978     return ret;
 979 }
 980
 981 int base64_lines(int datalen)
 982 {
 983     /* When encoding, we use 64 chars/line, which equals 48 real chars. */
 984     return (datalen + 47) / 48;
 985 }
 986
 987 void base64_encode(FILE * fp, unsigned char *data, int datalen, int cpl)
 988 {
 989     int linelen = 0;
 990     char out[4];
 991     int n, i;
 992
 993     while (datalen > 0) {
 994         n = (datalen < 3 ? datalen : 3);
 995         base64_encode_atom(data, n, out);
 996         data += n;
 997         datalen -= n;
 998         for (i = 0; i < 4; i++) {
 999             if (linelen >= cpl) {
1000                 linelen = 0;
1001                 fputc('\n', fp);
1002             }
1003             fputc(out[i], fp);
1004             linelen++;
1005         }
1006     }
1007     fputc('\n', fp);
1008 }
1009
1010 int ssh2_save_userkey(const Filename *filename, struct ssh2_userkey *key,
1011                       char *passphrase)
1012 {
1013     FILE *fp;
1014     unsigned char *pub_blob, *priv_blob, *priv_blob_encrypted;
1015     int pub_blob_len, priv_blob_len, priv_encrypted_len;
1016     int passlen;
1017     int cipherblk;
1018     int i;
1019     char *cipherstr;
1020     unsigned char priv_mac[20];
1021
1022     /*
1023      * Fetch the key component blobs.
1024      */
1025     pub_blob = key->alg->public_blob(key->data, &pub_blob_len);
1026     priv_blob = key->alg->private_blob(key->data, &priv_blob_len);
1027     if (!pub_blob || !priv_blob) {
1028         sfree(pub_blob);
1029         sfree(priv_blob);
1030         return 0;
1031     }
1032
1033     /*
1034      * Determine encryption details, and encrypt the private blob.
1035      */
1036     if (passphrase) {
1037         cipherstr = "aes256-cbc";
1038         cipherblk = 16;
1039     } else {
1040         cipherstr = "none";
1041         cipherblk = 1;
1042     }
1043     priv_encrypted_len = priv_blob_len + cipherblk - 1;
1044     priv_encrypted_len -= priv_encrypted_len % cipherblk;
1045     priv_blob_encrypted = snewn(priv_encrypted_len, unsigned char);
1046     memset(priv_blob_encrypted, 0, priv_encrypted_len);
1047     memcpy(priv_blob_encrypted, priv_blob, priv_blob_len);
1048     /* Create padding based on the SHA hash of the unpadded blob. This prevents
1049      * too easy a known-plaintext attack on the last block. */
1050     SHA_Simple(priv_blob, priv_blob_len, priv_mac);
1051     assert(priv_encrypted_len - priv_blob_len < 20);
1052     memcpy(priv_blob_encrypted + priv_blob_len, priv_mac,
1053            priv_encrypted_len - priv_blob_len);
1054
1055     /* Now create the MAC. */
1056     {
1057         unsigned char *macdata;
1058         int maclen;
1059         unsigned char *p;
1060         int namelen = strlen(key->alg->name);
1061         int enclen = strlen(cipherstr);
1062         int commlen = strlen(key->comment);
1063         SHA_State s;
1064         unsigned char mackey[20];
1065         char header[] = "putty-private-key-file-mac-key";
1066
1067         maclen = (4 + namelen +
1068                   4 + enclen +
1069                   4 + commlen +
1070                   4 + pub_blob_len +
1071                   4 + priv_encrypted_len);
1072         macdata = snewn(maclen, unsigned char);
1073         p = macdata;
1074 #define DO_STR(s,len) PUT_32BIT(p,(len));memcpy(p+4,(s),(len));p+=4+(len)
1075         DO_STR(key->alg->name, namelen);
1076         DO_STR(cipherstr, enclen);
1077         DO_STR(key->comment, commlen);
1078         DO_STR(pub_blob, pub_blob_len);
1079         DO_STR(priv_blob_encrypted, priv_encrypted_len);
1080
1081         SHA_Init(&s);
1082         SHA_Bytes(&s, header, sizeof(header)-1);
1083         if (passphrase)
1084             SHA_Bytes(&s, passphrase, strlen(passphrase));
1085         SHA_Final(&s, mackey);
1086         hmac_sha1_simple(mackey, 20, macdata, maclen, priv_mac);
1087         smemclr(macdata, maclen);
1088         sfree(macdata);
1089         smemclr(mackey, sizeof(mackey));
1090         smemclr(&s, sizeof(s));
1091     }
1092
1093     if (passphrase) {
1094         unsigned char key[40];
1095         SHA_State s;
1096
1097         passlen = strlen(passphrase);
1098
1099         SHA_Init(&s);
1100         SHA_Bytes(&s, "\0\0\0\0", 4);
1101         SHA_Bytes(&s, passphrase, passlen);
1102         SHA_Final(&s, key + 0);
1103         SHA_Init(&s);
1104         SHA_Bytes(&s, "\0\0\0\1", 4);
1105         SHA_Bytes(&s, passphrase, passlen);
1106         SHA_Final(&s, key + 20);
1107         aes256_encrypt_pubkey(key, priv_blob_encrypted,
1108                               priv_encrypted_len);
1109
1110         smemclr(key, sizeof(key));
1111         smemclr(&s, sizeof(s));
1112     }
1113
1114     fp = f_open(filename, "w", TRUE);
1115     if (!fp)
1116         return 0;
1117     fprintf(fp, "PuTTY-User-Key-File-2: %s\n", key->alg->name);
1118     fprintf(fp, "Encryption: %s\n", cipherstr);
1119     fprintf(fp, "Comment: %s\n", key->comment);
1120     fprintf(fp, "Public-Lines: %d\n", base64_lines(pub_blob_len));
1121     base64_encode(fp, pub_blob, pub_blob_len, 64);
1122     fprintf(fp, "Private-Lines: %d\n", base64_lines(priv_encrypted_len));
1123     base64_encode(fp, priv_blob_encrypted, priv_encrypted_len, 64);
1124     fprintf(fp, "Private-MAC: ");
1125     for (i = 0; i < 20; i++)
1126         fprintf(fp, "%02x", priv_mac[i]);
1127     fprintf(fp, "\n");
1128     fclose(fp);
1129
1130     sfree(pub_blob);
1131     smemclr(priv_blob, priv_blob_len);
1132     sfree(priv_blob);
1133     sfree(priv_blob_encrypted);
1134     return 1;
1135 }
1136
1137 /* ----------------------------------------------------------------------
1138  * A function to determine the type of a private key file. Returns
1139  * 0 on failure, 1 or 2 on success.
1140  */
1141 int key_type(const Filename *filename)
1142 {
1143     FILE *fp;
1144     char buf[32];
1145     const char putty2_sig[] = "PuTTY-User-Key-File-";
1146     const char sshcom_sig[] = "---- BEGIN SSH2 ENCRYPTED PRIVAT";
1147     const char openssh_sig[] = "-----BEGIN ";
1148     int i;
1149
1150     fp = f_open(filename, "r", FALSE);
1151     if (!fp)
1152         return SSH_KEYTYPE_UNOPENABLE;
1153     i = fread(buf, 1, sizeof(buf), fp);
1154     fclose(fp);
1155     if (i < 0)
1156         return SSH_KEYTYPE_UNOPENABLE;
1157     if (i < 32)
1158         return SSH_KEYTYPE_UNKNOWN;
1159     if (!memcmp(buf, rsa_signature, sizeof(rsa_signature)-1))
1160         return SSH_KEYTYPE_SSH1;
1161     if (!memcmp(buf, putty2_sig, sizeof(putty2_sig)-1))
1162         return SSH_KEYTYPE_SSH2;
1163     if (!memcmp(buf, openssh_sig, sizeof(openssh_sig)-1))
1164         return SSH_KEYTYPE_OPENSSH;
1165     if (!memcmp(buf, sshcom_sig, sizeof(sshcom_sig)-1))
1166         return SSH_KEYTYPE_SSHCOM;
1167     return SSH_KEYTYPE_UNKNOWN;        /* unrecognised or EOF */
1168 }
1169
1170 /*
1171  * Convert the type word to a string, for `wrong type' error
1172  * messages.
1173  */
1174 char *key_type_to_str(int type)
1175 {
1176     switch (type) {
1177       case SSH_KEYTYPE_UNOPENABLE: return "unable to open file"; break;
1178       case SSH_KEYTYPE_UNKNOWN: return "not a private key"; break;
1179       case SSH_KEYTYPE_SSH1: return "SSH-1 private key"; break;
1180       case SSH_KEYTYPE_SSH2: return "PuTTY SSH-2 private key"; break;
1181       case SSH_KEYTYPE_OPENSSH: return "OpenSSH SSH-2 private key"; break;
1182       case SSH_KEYTYPE_SSHCOM: return "ssh.com SSH-2 private key"; break;
1183       default: return "INTERNAL ERROR"; break;
1184     }
1185 }