authfile.c

   1 /*
   2  * Author: Tatu Ylonen <ylo@cs.hut.fi>
   3  * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
   4  *                    All rights reserved
   5  * This file contains functions for reading and writing identity files, and
   6  * for reading the passphrase from the user.
   7  *
   8  * As far as I am concerned, the code I have written for this software
   9  * can be used freely for any purpose.  Any derived versions of this
  10  * software must be clearly marked as such, and if the derived work is
  11  * incompatible with the protocol description in the RFC file, it must be
  12  * called by a name other than "ssh" or "Secure Shell".
  13  *
  14  *
  15  * Copyright (c) 2000 Markus Friedl.  All rights reserved.
  16  *
  17  * Redistribution and use in source and binary forms, with or without
  18  * modification, are permitted provided that the following conditions
  19  * are met:
  20  * 1. Redistributions of source code must retain the above copyright
  21  *    notice, this list of conditions and the following disclaimer.
  22  * 2. Redistributions in binary form must reproduce the above copyright
  23  *    notice, this list of conditions and the following disclaimer in the
  24  *    documentation and/or other materials provided with the distribution.
  25  *
  26  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  27  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  28  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  29  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  30  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  31  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  32  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  33  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  34  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  35  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  36  */
  37
  38 #include "includes.h"
  39 RCSID("$OpenBSD: authfile.c,v 1.43 2001/12/27 18:22:16 markus Exp $");
  40
  41 #include <openssl/err.h>
  42 #include <openssl/evp.h>
  43 #include <openssl/pem.h>
  44
  45 #include "cipher.h"
  46 #include "xmalloc.h"
  47 #include "buffer.h"
  48 #include "bufaux.h"
  49 #include "key.h"
  50 #include "ssh.h"
  51 #include "log.h"
  52 #include "authfile.h"
  53
  54 /* Version identification string for SSH v1 identity files. */
  55 static const char authfile_id_string[] =
  56     "SSH PRIVATE KEY FILE FORMAT 1.1\n";
  57
  58 /*
  59  * Saves the authentication (private) key in a file, encrypting it with
  60  * passphrase.  The identification of the file (lowest 64 bits of n) will
  61  * precede the key to provide identification of the key without needing a
  62  * passphrase.
  63  */
  64
  65 static int
  66 key_save_private_rsa1(Key *key, const char *filename, const char *passphrase,
  67     const char *comment)
  68 {
  69         Buffer buffer, encrypted;
  70         char buf[100], *cp;
  71         int fd, i;
  72         CipherContext ciphercontext;
  73         Cipher *cipher;
  74         u_int32_t rand;
  75
  76         /*
  77          * If the passphrase is empty, use SSH_CIPHER_NONE to ease converting
  78          * to another cipher; otherwise use SSH_AUTHFILE_CIPHER.
  79          */
  80         if (strcmp(passphrase, "") == 0)
  81                 cipher = cipher_by_number(SSH_CIPHER_NONE);
  82         else
  83                 cipher = cipher_by_number(SSH_AUTHFILE_CIPHER);
  84         if (cipher == NULL)
  85                 fatal("save_private_key_rsa: bad cipher");
  86
  87         /* This buffer is used to built the secret part of the private key. */
  88         buffer_init(&buffer);
  89
  90         /* Put checkbytes for checking passphrase validity. */
  91         rand = arc4random();
  92         buf[0] = rand & 0xff;
  93         buf[1] = (rand >> 8) & 0xff;
  94         buf[2] = buf[0];
  95         buf[3] = buf[1];
  96         buffer_append(&buffer, buf, 4);
  97
  98         /*
  99          * Store the private key (n and e will not be stored because they
 100          * will be stored in plain text, and storing them also in encrypted
 101          * format would just give known plaintext).
 102          */
 103         buffer_put_bignum(&buffer, key->rsa->d);
 104         buffer_put_bignum(&buffer, key->rsa->iqmp);
 105         buffer_put_bignum(&buffer, key->rsa->q);        /* reverse from SSL p */
 106         buffer_put_bignum(&buffer, key->rsa->p);        /* reverse from SSL q */
 107
 108         /* Pad the part to be encrypted until its size is a multiple of 8. */
 109         while (buffer_len(&buffer) % 8 != 0)
 110                 buffer_put_char(&buffer, 0);
 111
 112         /* This buffer will be used to contain the data in the file. */
 113         buffer_init(&encrypted);
 114
 115         /* First store keyfile id string. */
 116         for (i = 0; authfile_id_string[i]; i++)
 117                 buffer_put_char(&encrypted, authfile_id_string[i]);
 118         buffer_put_char(&encrypted, 0);
 119
 120         /* Store cipher type. */
 121         buffer_put_char(&encrypted, cipher->number);
 122         buffer_put_int(&encrypted, 0);  /* For future extension */
 123
 124         /* Store public key.  This will be in plain text. */
 125         buffer_put_int(&encrypted, BN_num_bits(key->rsa->n));
 126         buffer_put_bignum(&encrypted, key->rsa->n);
 127         buffer_put_bignum(&encrypted, key->rsa->e);
 128         buffer_put_cstring(&encrypted, comment);
 129
 130         /* Allocate space for the private part of the key in the buffer. */
 131         cp = buffer_append_space(&encrypted, buffer_len(&buffer));
 132
 133         cipher_set_key_string(&ciphercontext, cipher, passphrase);
 134         cipher_encrypt(&ciphercontext, (u_char *) cp,
 135             (u_char *) buffer_ptr(&buffer), buffer_len(&buffer));
 136         memset(&ciphercontext, 0, sizeof(ciphercontext));
 137
 138         /* Destroy temporary data. */
 139         memset(buf, 0, sizeof(buf));
 140         buffer_free(&buffer);
 141
 142         fd = open(filename, O_WRONLY | O_CREAT | O_TRUNC, 0600);
 143         if (fd < 0) {
 144                 error("open %s failed: %s.", filename, strerror(errno));
 145                 return 0;
 146         }
 147         if (write(fd, buffer_ptr(&encrypted), buffer_len(&encrypted)) !=
 148             buffer_len(&encrypted)) {
 149                 error("write to key file %s failed: %s", filename,
 150                     strerror(errno));
 151                 buffer_free(&encrypted);
 152                 close(fd);
 153                 unlink(filename);
 154                 return 0;
 155         }
 156         close(fd);
 157         buffer_free(&encrypted);
 158         return 1;
 159 }
 160
 161 /* save SSH v2 key in OpenSSL PEM format */
 162 static int
 163 key_save_private_pem(Key *key, const char *filename, const char *_passphrase,
 164     const char *comment)
 165 {
 166         FILE *fp;
 167         int fd;
 168         int success = 0;
 169         int len = strlen(_passphrase);
 170         char *passphrase = (len > 0) ? (char *)_passphrase : NULL;
 171         EVP_CIPHER *cipher = (len > 0) ? EVP_des_ede3_cbc() : NULL;
 172
 173         if (len > 0 && len <= 4) {
 174                 error("passphrase too short: have %d bytes, need > 4", len);
 175                 return 0;
 176         }
 177         fd = open(filename, O_WRONLY | O_CREAT | O_TRUNC, 0600);
 178         if (fd < 0) {
 179                 error("open %s failed: %s.", filename, strerror(errno));
 180                 return 0;
 181         }
 182         fp = fdopen(fd, "w");
 183         if (fp == NULL ) {
 184                 error("fdopen %s failed: %s.", filename, strerror(errno));
 185                 close(fd);
 186                 return 0;
 187         }
 188         switch (key->type) {
 189         case KEY_DSA:
 190                 success = PEM_write_DSAPrivateKey(fp, key->dsa,
 191                     cipher, passphrase, len, NULL, NULL);
 192                 break;
 193         case KEY_RSA:
 194                 success = PEM_write_RSAPrivateKey(fp, key->rsa,
 195                     cipher, passphrase, len, NULL, NULL);
 196                 break;
 197         }
 198         fclose(fp);
 199         return success;
 200 }
 201
 202 int
 203 key_save_private(Key *key, const char *filename, const char *passphrase,
 204     const char *comment)
 205 {
 206         switch (key->type) {
 207         case KEY_RSA1:
 208                 return key_save_private_rsa1(key, filename, passphrase,
 209                     comment);
 210                 break;
 211         case KEY_DSA:
 212         case KEY_RSA:
 213                 return key_save_private_pem(key, filename, passphrase,
 214                     comment);
 215                 break;
 216         default:
 217                 break;
 218         }
 219         error("key_save_private: cannot save key type %d", key->type);
 220         return 0;
 221 }
 222
 223 /*
 224  * Loads the public part of the ssh v1 key file.  Returns NULL if an error was
 225  * encountered (the file does not exist or is not readable), and the key
 226  * otherwise.
 227  */
 228
 229 static Key *
 230 key_load_public_rsa1(int fd, const char *filename, char **commentp)
 231 {
 232         Buffer buffer;
 233         Key *pub;
 234         char *cp;
 235         int i;
 236         off_t len;
 237
 238         len = lseek(fd, (off_t) 0, SEEK_END);
 239         lseek(fd, (off_t) 0, SEEK_SET);
 240
 241         buffer_init(&buffer);
 242         cp = buffer_append_space(&buffer, len);
 243
 244         if (read(fd, cp, (size_t) len) != (size_t) len) {
 245                 debug("Read from key file %.200s failed: %.100s", filename,
 246                     strerror(errno));
 247                 buffer_free(&buffer);
 248                 return NULL;
 249         }
 250
 251         /* Check that it is at least big enough to contain the ID string. */
 252         if (len < sizeof(authfile_id_string)) {
 253                 debug3("Not a RSA1 key file %.200s.", filename);
 254                 buffer_free(&buffer);
 255                 return NULL;
 256         }
 257         /*
 258          * Make sure it begins with the id string.  Consume the id string
 259          * from the buffer.
 260          */
 261         for (i = 0; i < sizeof(authfile_id_string); i++)
 262                 if (buffer_get_char(&buffer) != authfile_id_string[i]) {
 263                         debug3("Not a RSA1 key file %.200s.", filename);
 264                         buffer_free(&buffer);
 265                         return NULL;
 266                 }
 267         /* Skip cipher type and reserved data. */
 268         (void) buffer_get_char(&buffer);        /* cipher type */
 269         (void) buffer_get_int(&buffer);         /* reserved */
 270
 271         /* Read the public key from the buffer. */
 272         buffer_get_int(&buffer);
 273         pub = key_new(KEY_RSA1);
 274         buffer_get_bignum(&buffer, pub->rsa->n);
 275         buffer_get_bignum(&buffer, pub->rsa->e);
 276         if (commentp)
 277                 *commentp = buffer_get_string(&buffer, NULL);
 278         /* The encrypted private part is not parsed by this function. */
 279
 280         buffer_free(&buffer);
 281         return pub;
 282 }
 283
 284 /* load public key from private-key file, works only for SSH v1 */
 285 Key *
 286 key_load_public_type(int type, const char *filename, char **commentp)
 287 {
 288         Key *pub;
 289         int fd;
 290
 291         if (type == KEY_RSA1) {
 292                 fd = open(filename, O_RDONLY);
 293                 if (fd < 0)
 294                         return NULL;
 295                 pub = key_load_public_rsa1(fd, filename, commentp);
 296                 close(fd);
 297                 return pub;
 298         }
 299         return NULL;
 300 }
 301
 302 /*
 303  * Loads the private key from the file.  Returns 0 if an error is encountered
 304  * (file does not exist or is not readable, or passphrase is bad). This
 305  * initializes the private key.
 306  * Assumes we are called under uid of the owner of the file.
 307  */
 308
 309 static Key *
 310 key_load_private_rsa1(int fd, const char *filename, const char *passphrase,
 311     char **commentp)
 312 {
 313         int i, check1, check2, cipher_type;
 314         off_t len;
 315         Buffer buffer, decrypted;
 316         char *cp;
 317         CipherContext ciphercontext;
 318         Cipher *cipher;
 319         Key *prv = NULL;
 320
 321         len = lseek(fd, (off_t) 0, SEEK_END);
 322         lseek(fd, (off_t) 0, SEEK_SET);
 323
 324         buffer_init(&buffer);
 325         cp = buffer_append_space(&buffer, len);
 326
 327         if (read(fd, cp, (size_t) len) != (size_t) len) {
 328                 debug("Read from key file %.200s failed: %.100s", filename,
 329                     strerror(errno));
 330                 buffer_free(&buffer);
 331                 close(fd);
 332                 return NULL;
 333         }
 334
 335         /* Check that it is at least big enough to contain the ID string. */
 336         if (len < sizeof(authfile_id_string)) {
 337                 debug3("Not a RSA1 key file %.200s.", filename);
 338                 buffer_free(&buffer);
 339                 close(fd);
 340                 return NULL;
 341         }
 342         /*
 343          * Make sure it begins with the id string.  Consume the id string
 344          * from the buffer.
 345          */
 346         for (i = 0; i < sizeof(authfile_id_string); i++)
 347                 if (buffer_get_char(&buffer) != authfile_id_string[i]) {
 348                         debug3("Not a RSA1 key file %.200s.", filename);
 349                         buffer_free(&buffer);
 350                         close(fd);
 351                         return NULL;
 352                 }
 353
 354         /* Read cipher type. */
 355         cipher_type = buffer_get_char(&buffer);
 356         (void) buffer_get_int(&buffer); /* Reserved data. */
 357
 358         /* Read the public key from the buffer. */
 359         buffer_get_int(&buffer);
 360         prv = key_new_private(KEY_RSA1);
 361
 362         buffer_get_bignum(&buffer, prv->rsa->n);
 363         buffer_get_bignum(&buffer, prv->rsa->e);
 364         if (commentp)
 365                 *commentp = buffer_get_string(&buffer, NULL);
 366         else
 367                 xfree(buffer_get_string(&buffer, NULL));
 368
 369         /* Check that it is a supported cipher. */
 370         cipher = cipher_by_number(cipher_type);
 371         if (cipher == NULL) {
 372                 debug("Unsupported cipher %d used in key file %.200s.",
 373                     cipher_type, filename);
 374                 buffer_free(&buffer);
 375                 goto fail;
 376         }
 377         /* Initialize space for decrypted data. */
 378         buffer_init(&decrypted);
 379         cp = buffer_append_space(&decrypted, buffer_len(&buffer));
 380
 381         /* Rest of the buffer is encrypted.  Decrypt it using the passphrase. */
 382         cipher_set_key_string(&ciphercontext, cipher, passphrase);
 383         cipher_decrypt(&ciphercontext, (u_char *) cp,
 384             (u_char *) buffer_ptr(&buffer), buffer_len(&buffer));
 385         memset(&ciphercontext, 0, sizeof(ciphercontext));
 386         buffer_free(&buffer);
 387
 388         check1 = buffer_get_char(&decrypted);
 389         check2 = buffer_get_char(&decrypted);
 390         if (check1 != buffer_get_char(&decrypted) ||
 391             check2 != buffer_get_char(&decrypted)) {
 392                 if (strcmp(passphrase, "") != 0)
 393                         debug("Bad passphrase supplied for key file %.200s.",
 394                             filename);
 395                 /* Bad passphrase. */
 396                 buffer_free(&decrypted);
 397                 goto fail;
 398         }
 399         /* Read the rest of the private key. */
 400         buffer_get_bignum(&decrypted, prv->rsa->d);
 401         buffer_get_bignum(&decrypted, prv->rsa->iqmp);          /* u */
 402         /* in SSL and SSH v1 p and q are exchanged */
 403         buffer_get_bignum(&decrypted, prv->rsa->q);             /* p */
 404         buffer_get_bignum(&decrypted, prv->rsa->p);             /* q */
 405
 406         /* calculate p-1 and q-1 */
 407         rsa_generate_additional_parameters(prv->rsa);
 408
 409         buffer_free(&decrypted);
 410         close(fd);
 411         return prv;
 412
 413 fail:
 414         if (commentp)
 415                 xfree(*commentp);
 416         close(fd);
 417         key_free(prv);
 418         return NULL;
 419 }
 420
 421 static Key *
 422 key_load_private_pem(int fd, int type, const char *passphrase,
 423     char **commentp)
 424 {
 425         FILE *fp;
 426         EVP_PKEY *pk = NULL;
 427         Key *prv = NULL;
 428         char *name = "<no key>";
 429
 430         fp = fdopen(fd, "r");
 431         if (fp == NULL) {
 432                 error("fdopen failed: %s", strerror(errno));
 433                 close(fd);
 434                 return NULL;
 435         }
 436         pk = PEM_read_PrivateKey(fp, NULL, NULL, (char *)passphrase);
 437         if (pk == NULL) {
 438                 debug("PEM_read_PrivateKey failed");
 439                 (void)ERR_get_error();
 440         } else if (pk->type == EVP_PKEY_RSA &&
 441             (type == KEY_UNSPEC||type==KEY_RSA)) {
 442                 prv = key_new(KEY_UNSPEC);
 443                 prv->rsa = EVP_PKEY_get1_RSA(pk);
 444                 prv->type = KEY_RSA;
 445                 name = "rsa w/o comment";
 446 #ifdef DEBUG_PK
 447                 RSA_print_fp(stderr, prv->rsa, 8);
 448 #endif
 449         } else if (pk->type == EVP_PKEY_DSA &&
 450             (type == KEY_UNSPEC||type==KEY_DSA)) {
 451                 prv = key_new(KEY_UNSPEC);
 452                 prv->dsa = EVP_PKEY_get1_DSA(pk);
 453                 prv->type = KEY_DSA;
 454                 name = "dsa w/o comment";
 455 #ifdef DEBUG_PK
 456                 DSA_print_fp(stderr, prv->dsa, 8);
 457 #endif
 458         } else {
 459                 error("PEM_read_PrivateKey: mismatch or "
 460                     "unknown EVP_PKEY save_type %d", pk->save_type);
 461         }
 462         fclose(fp);
 463         if (pk != NULL)
 464                 EVP_PKEY_free(pk);
 465         if (prv != NULL && commentp)
 466                 *commentp = xstrdup(name);
 467         debug("read PEM private key done: type %s",
 468             prv ? key_type(prv) : "<unknown>");
 469         return prv;
 470 }
 471
 472 static int
 473 key_perm_ok(int fd, const char *filename)
 474 {
 475         struct stat st;
 476
 477         if (fstat(fd, &st) < 0)
 478                 return 0;
 479         /*
 480          * if a key owned by the user is accessed, then we check the
 481          * permissions of the file. if the key owned by a different user,
 482          * then we don't care.
 483          */
 484 #ifdef HAVE_CYGWIN
 485         if (check_ntsec(filename))
 486 #endif
 487         if ((st.st_uid == getuid()) && (st.st_mode & 077) != 0) {
 488                 error("@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@");
 489                 error("@         WARNING: UNPROTECTED PRIVATE KEY FILE!          @");
 490                 error("@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@");
 491                 error("Permissions 0%3.3o for '%s' are too open.",
 492                     st.st_mode & 0777, filename);
 493                 error("It is recommended that your private key files are NOT accessible by others.");
 494                 error("This private key will be ignored.");
 495                 return 0;
 496         }
 497         return 1;
 498 }
 499
 500 Key *
 501 key_load_private_type(int type, const char *filename, const char *passphrase,
 502     char **commentp)
 503 {
 504         int fd;
 505
 506         fd = open(filename, O_RDONLY);
 507         if (fd < 0)
 508                 return NULL;
 509         if (!key_perm_ok(fd, filename)) {
 510                 error("bad permissions: ignore key: %s", filename);
 511                 close(fd);
 512                 return NULL;
 513         }
 514         switch (type) {
 515         case KEY_RSA1:
 516                 return key_load_private_rsa1(fd, filename, passphrase,
 517                     commentp);
 518                 /* closes fd */
 519                 break;
 520         case KEY_DSA:
 521         case KEY_RSA:
 522         case KEY_UNSPEC:
 523                 return key_load_private_pem(fd, type, passphrase, commentp);
 524                 /* closes fd */
 525                 break;
 526         default:
 527                 close(fd);
 528                 break;
 529         }
 530         return NULL;
 531 }
 532
 533 Key *
 534 key_load_private(const char *filename, const char *passphrase,
 535     char **commentp)
 536 {
 537         Key *pub, *prv;
 538         int fd;
 539
 540         fd = open(filename, O_RDONLY);
 541         if (fd < 0)
 542                 return NULL;
 543         if (!key_perm_ok(fd, filename)) {
 544                 error("bad permissions: ignore key: %s", filename);
 545                 close(fd);
 546                 return NULL;
 547         }
 548         pub = key_load_public_rsa1(fd, filename, commentp);
 549         lseek(fd, (off_t) 0, SEEK_SET);         /* rewind */
 550         if (pub == NULL) {
 551                 /* closes fd */
 552                 prv = key_load_private_pem(fd, KEY_UNSPEC, passphrase, NULL);
 553                 /* use the filename as a comment for PEM */
 554                 if (commentp && prv)
 555                         *commentp = xstrdup(filename);
 556         } else {
 557                 /* it's a SSH v1 key if the public key part is readable */
 558                 key_free(pub);
 559                 /* closes fd */
 560                 prv = key_load_private_rsa1(fd, filename, passphrase, NULL);
 561         }
 562         return prv;
 563 }
 564
 565 static int
 566 key_try_load_public(Key *k, const char *filename, char **commentp)
 567 {
 568         FILE *f;
 569         char line[4096];
 570         char *cp;
 571
 572         f = fopen(filename, "r");
 573         if (f != NULL) {
 574                 while (fgets(line, sizeof(line), f)) {
 575                         line[sizeof(line)-1] = '\0';
 576                         cp = line;
 577                         switch (*cp) {
 578                         case '#':
 579                         case '\n':
 580                         case '\0':
 581                                 continue;
 582                         }
 583                         /* Skip leading whitespace. */
 584                         for (; *cp && (*cp == ' ' || *cp == '\t'); cp++)
 585                                 ;
 586                         if (*cp) {
 587                                 if (key_read(k, &cp) == 1) {
 588                                         if (commentp)
 589                                                 *commentp=xstrdup(filename);
 590                                         fclose(f);
 591                                         return 1;
 592                                 }
 593                         }
 594                 }
 595                 fclose(f);
 596         }
 597         return 0;
 598 }
 599
 600 /* load public key from ssh v1 private or any pubkey file */
 601 Key *
 602 key_load_public(const char *filename, char **commentp)
 603 {
 604         Key *pub;
 605         char file[MAXPATHLEN];
 606
 607         pub = key_load_public_type(KEY_RSA1, filename, commentp);
 608         if (pub != NULL)
 609                 return pub;
 610         pub = key_new(KEY_UNSPEC);
 611         if (key_try_load_public(pub, filename, commentp) == 1)
 612                 return pub;
 613         if ((strlcpy(file, filename, sizeof file) < sizeof(file)) &&
 614             (strlcat(file, ".pub", sizeof file) < sizeof(file)) &&
 615             (key_try_load_public(pub, file, commentp) == 1))
 616                 return pub;
 617         key_free(pub);
 618         return NULL;
 619 }