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.30 2001/03/26 23:12:42 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 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_string(&encrypted, comment, strlen(comment));
 129
 130         /* Allocate space for the private part of the key in the buffer. */
 131         buffer_append_space(&encrypted, &cp, 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                 return 0;
 145         if (write(fd, buffer_ptr(&encrypted), buffer_len(&encrypted)) !=
 146             buffer_len(&encrypted)) {
 147                 debug("Write to key file %.200s failed: %.100s", filename,
 148                       strerror(errno));
 149                 buffer_free(&encrypted);
 150                 close(fd);
 151                 unlink(filename);
 152                 return 0;
 153         }
 154         close(fd);
 155         buffer_free(&encrypted);
 156         return 1;
 157 }
 158
 159 /* save SSH v2 key in OpenSSL PEM format */
 160 int
 161 key_save_private_pem(Key *key, const char *filename, const char *_passphrase,
 162     const char *comment)
 163 {
 164         FILE *fp;
 165         int fd;
 166         int success = 0;
 167         int len = strlen(_passphrase);
 168         char *passphrase = (len > 0) ? (char *)_passphrase : NULL;
 169         EVP_CIPHER *cipher = (len > 0) ? EVP_des_ede3_cbc() : NULL;
 170
 171         if (len > 0 && len <= 4) {
 172                 error("passphrase too short: %d bytes", len);
 173                 errno = 0;
 174                 return 0;
 175         }
 176         fd = open(filename, O_WRONLY | O_CREAT | O_TRUNC, 0600);
 177         if (fd < 0) {
 178                 debug("open %s failed", filename);
 179                 return 0;
 180         }
 181         fp = fdopen(fd, "w");
 182         if (fp == NULL ) {
 183                 debug("fdopen %s failed", filename);
 184                 close(fd);
 185                 return 0;
 186         }
 187         switch (key->type) {
 188         case KEY_DSA:
 189                 success = PEM_write_DSAPrivateKey(fp, key->dsa,
 190                     cipher, passphrase, len, NULL, NULL);
 191                 break;
 192         case KEY_RSA:
 193                 success = PEM_write_RSAPrivateKey(fp, key->rsa,
 194                     cipher, passphrase, len, NULL, NULL);
 195                 break;
 196         }
 197         fclose(fp);
 198         return success;
 199 }
 200
 201 int
 202 key_save_private(Key *key, const char *filename, const char *passphrase,
 203     const char *comment)
 204 {
 205         switch (key->type) {
 206         case KEY_RSA1:
 207                 return key_save_private_rsa1(key, filename, passphrase,
 208                     comment);
 209                 break;
 210         case KEY_DSA:
 211         case KEY_RSA:
 212                 return key_save_private_pem(key, filename, passphrase,
 213                     comment);
 214                 break;
 215         default:
 216                 break;
 217         }
 218         return 0;
 219 }
 220
 221 /*
 222  * Loads the public part of the ssh v1 key file.  Returns NULL if an error was
 223  * encountered (the file does not exist or is not readable), and the key
 224  * otherwise.
 225  */
 226
 227 Key *
 228 key_load_public_rsa1(int fd, const char *filename, char **commentp)
 229 {
 230         Buffer buffer;
 231         Key *pub;
 232         char *cp;
 233         int i;
 234         off_t len;
 235
 236         len = lseek(fd, (off_t) 0, SEEK_END);
 237         lseek(fd, (off_t) 0, SEEK_SET);
 238
 239         buffer_init(&buffer);
 240         buffer_append_space(&buffer, &cp, len);
 241
 242         if (read(fd, cp, (size_t) len) != (size_t) len) {
 243                 debug("Read from key file %.200s failed: %.100s", filename,
 244                     strerror(errno));
 245                 buffer_free(&buffer);
 246                 return NULL;
 247         }
 248
 249         /* Check that it is at least big enough to contain the ID string. */
 250         if (len < sizeof(authfile_id_string)) {
 251                 debug3("Bad RSA1 key file %.200s.", filename);
 252                 buffer_free(&buffer);
 253                 return NULL;
 254         }
 255         /*
 256          * Make sure it begins with the id string.  Consume the id string
 257          * from the buffer.
 258          */
 259         for (i = 0; i < sizeof(authfile_id_string); i++)
 260                 if (buffer_get_char(&buffer) != authfile_id_string[i]) {
 261                         debug3("Bad RSA1 key file %.200s.", filename);
 262                         buffer_free(&buffer);
 263                         return NULL;
 264                 }
 265         /* Skip cipher type and reserved data. */
 266         (void) buffer_get_char(&buffer);        /* cipher type */
 267         (void) buffer_get_int(&buffer);         /* reserved */
 268
 269         /* Read the public key from the buffer. */
 270         buffer_get_int(&buffer);
 271         pub = key_new(KEY_RSA1);
 272         buffer_get_bignum(&buffer, pub->rsa->n);
 273         buffer_get_bignum(&buffer, pub->rsa->e);
 274         if (commentp)
 275                 *commentp = buffer_get_string(&buffer, NULL);
 276         /* The encrypted private part is not parsed by this function. */
 277
 278         buffer_free(&buffer);
 279         return pub;
 280 }
 281
 282 /* load public key from private-key file, works only for SSH v1 */
 283 Key *
 284 key_load_public_type(int type, const char *filename, char **commentp)
 285 {
 286         Key *pub;
 287         int fd;
 288
 289         if (type == KEY_RSA1) {
 290                 fd = open(filename, O_RDONLY);
 291                 if (fd < 0)
 292                         return NULL;
 293                 pub = key_load_public_rsa1(fd, filename, commentp);
 294                 close(fd);
 295                 return pub;
 296         }
 297         return NULL;
 298 }
 299
 300 /*
 301  * Loads the private key from the file.  Returns 0 if an error is encountered
 302  * (file does not exist or is not readable, or passphrase is bad). This
 303  * initializes the private key.
 304  * Assumes we are called under uid of the owner of the file.
 305  */
 306
 307 Key *
 308 key_load_private_rsa1(int fd, const char *filename, const char *passphrase,
 309     char **commentp)
 310 {
 311         int i, check1, check2, cipher_type;
 312         off_t len;
 313         Buffer buffer, decrypted;
 314         char *cp;
 315         CipherContext ciphercontext;
 316         Cipher *cipher;
 317         BN_CTX *ctx;
 318         BIGNUM *aux;
 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         buffer_append_space(&buffer, &cp, 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("Bad 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("Bad 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         buffer_append_space(&decrypted, &cp, 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         ctx = BN_CTX_new();
 408         aux = BN_new();
 409
 410         BN_sub(aux, prv->rsa->q, BN_value_one());
 411         BN_mod(prv->rsa->dmq1, prv->rsa->d, aux, ctx);
 412
 413         BN_sub(aux, prv->rsa->p, BN_value_one());
 414         BN_mod(prv->rsa->dmp1, prv->rsa->d, aux, ctx);
 415
 416         BN_clear_free(aux);
 417         BN_CTX_free(ctx);
 418
 419         buffer_free(&decrypted);
 420         close(fd);
 421         return prv;
 422
 423 fail:
 424         if (commentp)
 425                 xfree(*commentp);
 426         close(fd);
 427         key_free(prv);
 428         return NULL;
 429 }
 430
 431 Key *
 432 key_load_private_pem(int fd, int type, const char *passphrase,
 433     char **commentp)
 434 {
 435         FILE *fp;
 436         EVP_PKEY *pk = NULL;
 437         Key *prv = NULL;
 438         char *name = "<no key>";
 439
 440         fp = fdopen(fd, "r");
 441         if (fp == NULL) {
 442                 error("fdopen failed");
 443                 close(fd);
 444                 return NULL;
 445         }
 446         pk = PEM_read_PrivateKey(fp, NULL, NULL, (char *)passphrase);
 447         if (pk == NULL) {
 448                 debug("PEM_read_PrivateKey failed");
 449                 (void)ERR_get_error();
 450         } else if (pk->type == EVP_PKEY_RSA &&
 451              (type == KEY_UNSPEC||type==KEY_RSA)) {
 452                 prv = key_new(KEY_UNSPEC);
 453                 prv->rsa = EVP_PKEY_get1_RSA(pk);
 454                 prv->type = KEY_RSA;
 455                 name = "rsa w/o comment";
 456 #ifdef DEBUG_PK
 457                 RSA_print_fp(stderr, prv->rsa, 8);
 458 #endif
 459         } else if (pk->type == EVP_PKEY_DSA &&
 460              (type == KEY_UNSPEC||type==KEY_DSA)) {
 461                 prv = key_new(KEY_UNSPEC);
 462                 prv->dsa = EVP_PKEY_get1_DSA(pk);
 463                 prv->type = KEY_DSA;
 464                 name = "dsa w/o comment";
 465 #ifdef DEBUG_PK
 466                 DSA_print_fp(stderr, prv->dsa, 8);
 467 #endif
 468         } else {
 469                 error("PEM_read_PrivateKey: mismatch or "
 470                     "unknown EVP_PKEY save_type %d", pk->save_type);
 471         }
 472         fclose(fp);
 473         if (pk != NULL)
 474                 EVP_PKEY_free(pk);
 475         if (prv != NULL && commentp)
 476                 *commentp = xstrdup(name);
 477         debug("read PEM private key done: type %s",
 478             prv ? key_type(prv) : "<unknown>");
 479         return prv;
 480 }
 481
 482 int
 483 key_perm_ok(int fd, const char *filename)
 484 {
 485         struct stat st;
 486
 487         /* check owner and modes */
 488 #ifdef HAVE_CYGWIN
 489         if (check_ntsec(filename))
 490 #endif
 491         if (fstat(fd, &st) < 0 ||
 492             (st.st_uid != 0 && getuid() != 0 && st.st_uid != getuid()) ||
 493             (st.st_mode & 077) != 0) {
 494                 close(fd);
 495                 error("@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@");
 496                 error("@         WARNING: UNPROTECTED PRIVATE KEY FILE!          @");
 497                 error("@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@");
 498                 error("Bad ownership or mode(0%3.3o) for '%s'.",
 499                     st.st_mode & 0777, filename);
 500                 error("It is recommended that your private key files are NOT accessible by others.");
 501                 error("This private key will be ignored.");
 502                 return 0;
 503         }
 504         return 1;
 505 }
 506
 507 Key *
 508 key_load_private_type(int type, const char *filename, const char *passphrase,
 509     char **commentp)
 510 {
 511         int fd;
 512
 513         fd = open(filename, O_RDONLY);
 514         if (fd < 0)
 515                 return NULL;
 516         if (!key_perm_ok(fd, filename)) {
 517                 debug("bad permissions: ignore key: %s", filename);
 518                 close(fd);
 519                 return NULL;
 520         }
 521         switch (type) {
 522         case KEY_RSA1:
 523                 return key_load_private_rsa1(fd, filename, passphrase,
 524                     commentp);
 525                 /* closes fd */
 526                 break;
 527         case KEY_DSA:
 528         case KEY_RSA:
 529         case KEY_UNSPEC:
 530                 return key_load_private_pem(fd, type, passphrase, commentp);
 531                 /* closes fd */
 532                 break;
 533         default:
 534                 close(fd);
 535                 break;
 536         }
 537         return NULL;
 538 }
 539
 540 Key *
 541 key_load_private(const char *filename, const char *passphrase,
 542     char **commentp)
 543 {
 544         Key *pub;
 545         int fd;
 546
 547         fd = open(filename, O_RDONLY);
 548         if (fd < 0)
 549                 return NULL;
 550         if (!key_perm_ok(fd, filename)) {
 551                 debug("bad permissions: ignore key: %s", filename);
 552                 close(fd);
 553                 return NULL;
 554         }
 555         pub = key_load_public_rsa1(fd, filename, commentp);
 556         lseek(fd, (off_t) 0, SEEK_SET);         /* rewind */
 557         if (pub == NULL) {
 558                 /* closes fd */
 559                 return key_load_private_pem(fd, KEY_UNSPEC, passphrase, NULL);
 560         } else {
 561                 /* it's a SSH v1 key if the public key part is readable */
 562                 key_free(pub);
 563                 /* closes fd */
 564                 return key_load_private_rsa1(fd, filename, passphrase, NULL);
 565         }
 566 }
 567
 568 int
 569 key_try_load_public(Key *k, const char *filename, char **commentp)
 570 {
 571         FILE *f;
 572         char line[4096];
 573         char *cp;
 574
 575         f = fopen(filename, "r");
 576         if (f != NULL) {
 577                 while (fgets(line, sizeof(line), f)) {
 578                         line[sizeof(line)-1] = '\0';
 579                         cp = line;
 580                         switch(*cp){
 581                         case '#':
 582                         case '\n':
 583                         case '\0':
 584                                 continue;
 585                         }
 586                         /* Skip leading whitespace. */
 587                         for (; *cp && (*cp == ' ' || *cp == '\t'); cp++)
 588                                 ;
 589                         if (*cp) {
 590                                 if (key_read(k, &cp) == 1) {
 591                                         if (commentp)
 592                                                 *commentp=xstrdup(filename);
 593                                         fclose(f);
 594                                         return 1;
 595                                 }
 596                         }
 597                 }
 598                 fclose(f);
 599         }
 600         return 0;
 601 }
 602
 603 /* load public key from ssh v1 private or any pubkey file */
 604 Key *
 605 key_load_public(const char *filename, char **commentp)
 606 {
 607         Key *pub;
 608         char file[MAXPATHLEN];
 609
 610         pub = key_load_public_type(KEY_RSA1, filename, commentp);
 611         if (pub != NULL)
 612                 return pub;
 613         pub = key_new(KEY_UNSPEC);
 614         if (key_try_load_public(pub, filename, commentp) == 1)
 615                 return pub;
 616         if ((strlcpy(file, filename, sizeof file) < sizeof(file)) &&
 617             (strlcat(file, ".pub", sizeof file) < sizeof(file)) &&
 618             (key_try_load_public(pub, file, commentp) == 1))
 619                 return pub;
 620         key_free(pub);
 621         return NULL;
 622 }