granicus.if.org Git - apache/blob - modules/ssl/ssl_engine_init.c

   1 /*                      _             _
   2 **  _ __ ___   ___   __| |    ___ ___| |  mod_ssl
   3 ** | '_ ` _ \ / _ \ / _` |   / __/ __| |  Apache Interface to OpenSSL
   4 ** | | | | | | (_) | (_| |   \__ \__ \ |  www.modssl.org
   5 ** |_| |_| |_|\___/ \__,_|___|___/___/_|  ftp.modssl.org
   6 **                      |_____|
   7 **  ssl_engine_init.c
   8 **  Initialization of Servers
   9 */
  10
  11 /* ====================================================================
  12  * The Apache Software License, Version 1.1
  13  *
  14  * Copyright (c) 2000-2002 The Apache Software Foundation.  All rights
  15  * 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  *
  21  * 1. Redistributions of source code must retain the above copyright
  22  *    notice, this list of conditions and the following disclaimer.
  23  *
  24  * 2. Redistributions in binary form must reproduce the above copyright
  25  *    notice, this list of conditions and the following disclaimer in
  26  *    the documentation and/or other materials provided with the
  27  *    distribution.
  28  *
  29  * 3. The end-user documentation included with the redistribution,
  30  *    if any, must include the following acknowledgment:
  31  *       "This product includes software developed by the
  32  *        Apache Software Foundation (http://www.apache.org/)."
  33  *    Alternately, this acknowledgment may appear in the software itself,
  34  *    if and wherever such third-party acknowledgments normally appear.
  35  *
  36  * 4. The names "Apache" and "Apache Software Foundation" must
  37  *    not be used to endorse or promote products derived from this
  38  *    software without prior written permission. For written
  39  *    permission, please contact apache@apache.org.
  40  *
  41  * 5. Products derived from this software may not be called "Apache",
  42  *    nor may "Apache" appear in their name, without prior written
  43  *    permission of the Apache Software Foundation.
  44  *
  45  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
  46  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  47  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  48  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
  49  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  50  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  51  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  52  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  53  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  54  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  55  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  56  * SUCH DAMAGE.
  57  * ====================================================================
  58  */
  59                              /* ``Recursive, adj.;
  60                                   see Recursive.''
  61                                         -- Unknown   */
  62 #include "mod_ssl.h"
  63
  64 /*  _________________________________________________________________
  65 **
  66 **  Module Initialization
  67 **  _________________________________________________________________
  68 */
  69
  70 static char *ssl_add_version_component(apr_pool_t *p,
  71                                        server_rec *s,
  72                                        char *name)
  73 {
  74     char *val = ssl_var_lookup(p, s, NULL, NULL, name);
  75
  76     if (val && *val) {
  77         ap_add_version_component(p, val);
  78     }
  79
  80     return val;
  81 }
  82
  83 static char *version_components[] = {
  84     "SSL_VERSION_PRODUCT",
  85     "SSL_VERSION_INTERFACE",
  86     "SSL_VERSION_LIBRARY",
  87     NULL
  88 };
  89
  90 static void ssl_add_version_components(apr_pool_t *p,
  91                                        server_rec *s)
  92 {
  93     char *vals[sizeof(version_components)/sizeof(char *)];
  94     int i;
  95
  96     for (i=0; version_components[i]; i++) {
  97         vals[i] = ssl_add_version_component(p, s,
  98                                             version_components[i]);
  99     }
 100
 101     ssl_log(s, SSL_LOG_INFO,
 102             "Server: %s, Interface: %s, Library: %s",
 103             AP_SERVER_BASEVERSION,
 104             vals[1],  /* SSL_VERSION_INTERFACE */
 105             vals[2]); /* SSL_VERSION_LIBRARY */
 106 }
 107
 108
 109 /*
 110  *  Initialize SSL library
 111  */
 112 static void ssl_init_SSLLibrary(server_rec *s)
 113 {
 114     ssl_log(s, SSL_LOG_INFO,
 115             "Init: Initializing %s library", SSL_LIBRARY_NAME);
 116
 117     CRYPTO_malloc_init();
 118     SSL_load_error_strings();
 119     SSL_library_init();
 120 }
 121
 122 /*
 123  * Handle the Temporary RSA Keys and DH Params
 124  */
 125
 126 #define MODSSL_TMP_KEY_FREE(mc, type, idx) \
 127     if (mc->pTmpKeys[idx]) { \
 128         type##_free((type *)mc->pTmpKeys[idx]); \
 129         mc->pTmpKeys[idx] = NULL; \
 130     }
 131
 132 #define MODSSL_TMP_KEYS_FREE(mc, type) \
 133     MODSSL_TMP_KEY_FREE(mc, type, SSL_TMP_KEY_##type##_512); \
 134     MODSSL_TMP_KEY_FREE(mc, type, SSL_TMP_KEY_##type##_1024)
 135
 136 static void ssl_tmp_keys_free(server_rec *s)
 137 {
 138     SSLModConfigRec *mc = myModConfig(s);
 139
 140     MODSSL_TMP_KEYS_FREE(mc, RSA);
 141     MODSSL_TMP_KEYS_FREE(mc, DH);
 142 }
 143
 144 static void ssl_tmp_key_init_rsa(server_rec *s,
 145                                  int bits, int idx)
 146 {
 147     SSLModConfigRec *mc = myModConfig(s);
 148
 149     if (!(mc->pTmpKeys[idx] =
 150           RSA_generate_key(bits, RSA_F4, NULL, NULL)))
 151     {
 152         ssl_log(s, SSL_LOG_ERROR,
 153                 "Init: Failed to generate temporary "
 154                 "%d bit RSA private key", bits);
 155         ssl_die();
 156     }
 157
 158 }
 159
 160 static void ssl_tmp_key_init_dh(server_rec *s,
 161                                 int bits, int idx)
 162 {
 163     SSLModConfigRec *mc = myModConfig(s);
 164
 165     if (!(mc->pTmpKeys[idx] =
 166           ssl_dh_GetTmpParam(bits)))
 167     {
 168         ssl_log(s, SSL_LOG_ERROR,
 169                 "Init: Failed to generate temporary "
 170                 "%d bit DH parameters", bits);
 171         ssl_die();
 172     }
 173 }
 174
 175 #define MODSSL_TMP_KEY_INIT_RSA(s, bits) \
 176     ssl_tmp_key_init_rsa(s, bits, SSL_TMP_KEY_RSA_##bits)
 177
 178 #define MODSSL_TMP_KEY_INIT_DH(s, bits) \
 179     ssl_tmp_key_init_dh(s, bits, SSL_TMP_KEY_DH_##bits)
 180
 181 static void ssl_tmp_keys_init(server_rec *s)
 182 {
 183     ssl_log(s, SSL_LOG_INFO,
 184             "Init: Generating temporary RSA private keys (512/1024 bits)");
 185
 186     MODSSL_TMP_KEY_INIT_RSA(s, 512);
 187     MODSSL_TMP_KEY_INIT_RSA(s, 1024);
 188
 189     ssl_log(s, SSL_LOG_INFO,
 190             "Init: Generating temporary DH parameters (512/1024 bits)");
 191
 192     MODSSL_TMP_KEY_INIT_DH(s, 512);
 193     MODSSL_TMP_KEY_INIT_DH(s, 1024);
 194 }
 195
 196 /*
 197  *  Per-module initialization
 198  */
 199 int ssl_init_Module(apr_pool_t *p, apr_pool_t *plog,
 200                     apr_pool_t *ptemp,
 201                     server_rec *base_server)
 202 {
 203     SSLModConfigRec *mc = myModConfig(base_server);
 204     SSLSrvConfigRec *sc;
 205     server_rec *s;
 206
 207     /*
 208      * Let us cleanup on restarts and exists
 209      */
 210     apr_pool_cleanup_register(p, base_server,
 211                               ssl_init_ModuleKill,
 212                               apr_pool_cleanup_null);
 213
 214     /*
 215      * Any init round fixes the global config
 216      */
 217     ssl_config_global_create(base_server); /* just to avoid problems */
 218     ssl_config_global_fix(mc);
 219
 220     /*
 221      *  try to fix the configuration and open the dedicated SSL
 222      *  logfile as early as possible
 223      */
 224     for (s = base_server; s; s = s->next) {
 225         sc = mySrvConfig(s);
 226
 227         /*
 228          * Create the server host:port string because we need it a lot
 229          */
 230         sc->szVHostID = ssl_util_vhostid(p, s);
 231         sc->nVHostID_length = strlen(sc->szVHostID);
 232
 233         /* Fix up stuff that may not have been set */
 234         if (sc->bEnabled == UNSET) {
 235             sc->bEnabled = FALSE;
 236         }
 237
 238         if (sc->nSessionCacheTimeout == UNSET) {
 239             sc->nSessionCacheTimeout = SSL_SESSION_CACHE_TIMEOUT;
 240         }
 241
 242         if (sc->nPassPhraseDialogType == SSL_PPTYPE_UNSET) {
 243             sc->nPassPhraseDialogType = SSL_PPTYPE_BUILTIN;
 244         }
 245
 246         /* Open the dedicated SSL logfile */
 247         ssl_log_open(base_server, s, p);
 248     }
 249
 250     ssl_init_SSLLibrary(base_server);
 251
 252 #if APR_HAS_THREADS
 253     ssl_util_thread_setup(base_server, p);
 254 #endif
 255
 256     /*
 257      * Seed the Pseudo Random Number Generator (PRNG)
 258      * only need ptemp here; nothing inside allocated from the pool
 259      * needs to live once we return from ssl_rand_seed().
 260      */
 261     ssl_rand_seed(base_server, ptemp, SSL_RSCTX_STARTUP, "Init: ");
 262
 263     /*
 264      * read server private keys/public certs into memory.
 265      * decrypting any encrypted keys via configured SSLPassPhraseDialogs
 266      * anything that needs to live longer than ptemp needs to also survive
 267      * restarts, in which case they'll live inside s->process->pool.
 268      */
 269     ssl_pphrase_Handle(base_server, ptemp);
 270
 271     ssl_tmp_keys_init(base_server);
 272
 273     /*
 274      * SSL external crypto device ("engine") support
 275      */
 276 #ifdef SSL_EXPERIMENTAL_ENGINE
 277     ssl_init_Engine(base_server, p);
 278 #endif
 279
 280     /*
 281      * initialize the mutex handling
 282      */
 283     if (!ssl_mutex_init(base_server, p)) {
 284         return HTTP_INTERNAL_SERVER_ERROR;
 285     }
 286
 287     /*
 288      * initialize session caching
 289      */
 290     ssl_scache_init(base_server, p);
 291
 292     /*
 293      *  initialize servers
 294      */
 295     ssl_log(base_server, SSL_LOG_INFO,
 296             "Init: Initializing (virtual) servers for SSL");
 297
 298     for (s = base_server; s; s = s->next) {
 299         sc = mySrvConfig(s);
 300         /*
 301          * Either now skip this server when SSL is disabled for
 302          * it or give out some information about what we're
 303          * configuring.
 304          */
 305         if (!sc->bEnabled) {
 306             continue;
 307         }
 308
 309         ssl_log(s, SSL_LOG_INFO|SSL_INIT,
 310                 "Configuring server for SSL protocol");
 311
 312         /*
 313          * Read the server certificate and key
 314          */
 315         ssl_init_ConfigureServer(s, p, ptemp, sc);
 316     }
 317
 318     /*
 319      * Configuration consistency checks
 320      */
 321     ssl_init_CheckServers(base_server, ptemp);
 322
 323     /*
 324      *  Announce mod_ssl and SSL library in HTTP Server field
 325      *  as ``mod_ssl/X.X.X OpenSSL/X.X.X''
 326      */
 327     ssl_add_version_components(p, base_server);
 328
 329     SSL_init_app_data2_idx(); /* for SSL_get_app_data2() at request time */
 330
 331     return OK;
 332 }
 333
 334 /*
 335  * Support for external a Crypto Device ("engine"), usually
 336  * a hardware accellerator card for crypto operations.
 337  */
 338 #ifdef SSL_EXPERIMENTAL_ENGINE
 339 void ssl_init_Engine(server_rec *s, apr_pool_t *p)
 340 {
 341     SSLModConfigRec *mc = myModConfig(s);
 342     ENGINE *e;
 343
 344     if (mc->szCryptoDevice) {
 345         if (!(e = ENGINE_by_id(mc->szCryptoDevice))) {
 346             ssl_log(s, SSL_LOG_ERROR,
 347                     "Init: Failed to load Crypto Device API `%s'",
 348                     mc->szCryptoDevice);
 349             ssl_die();
 350         }
 351
 352         if (strEQ(mc->szCryptoDevice, "chil")) {
 353             ENGINE_ctrl(e, ENGINE_CTRL_CHIL_SET_FORKCHECK, 1, 0, 0);
 354         }
 355
 356         if (!ENGINE_set_default(e, ENGINE_METHOD_ALL)) {
 357             ssl_log(s, SSL_LOG_ERROR,
 358                     "Init: Failed to enable Crypto Device API `%s'",
 359                     mc->szCryptoDevice);
 360             ssl_die();
 361         }
 362
 363         ENGINE_free(e);
 364     }
 365 }
 366 #endif
 367
 368 static void ssl_init_check_server(server_rec *s,
 369                                   apr_pool_t *p,
 370                                   apr_pool_t *ptemp,
 371                                   SSLSrvConfigRec *sc)
 372 {
 373     /*
 374      * check for important parameters and the
 375      * possibility that the user forgot to set them.
 376      */
 377     if (!sc->szPublicCertFiles[0]) {
 378         ssl_log(s, SSL_LOG_ERROR|SSL_INIT,
 379                 "No SSL Certificate set [hint: SSLCertificateFile]");
 380         ssl_die();
 381     }
 382
 383     /*
 384      *  Check for problematic re-initializations
 385      */
 386     if (sc->pPublicCert[SSL_AIDX_RSA] ||
 387         sc->pPublicCert[SSL_AIDX_DSA])
 388     {
 389         ssl_log(s, SSL_LOG_ERROR|SSL_INIT,
 390                 "Illegal attempt to re-initialise SSL for server "
 391                 "(theoretically shouldn't happen!)");
 392         ssl_die();
 393     }
 394 }
 395
 396 static SSL_CTX *ssl_init_ctx(server_rec *s,
 397                              apr_pool_t *p,
 398                              apr_pool_t *ptemp,
 399                              SSLSrvConfigRec *sc)
 400 {
 401     SSL_CTX *ctx = NULL;
 402     char *cp;
 403     int protocol = sc->nProtocol;
 404
 405     /*
 406      *  Create the new per-server SSL context
 407      */
 408     if (protocol == SSL_PROTOCOL_NONE) {
 409         ssl_log(s, SSL_LOG_ERROR|SSL_INIT,
 410                 "No SSL protocols available [hint: SSLProtocol]");
 411         ssl_die();
 412     }
 413
 414     cp = apr_pstrcat(p,
 415                      (protocol & SSL_PROTOCOL_SSLV2 ? "SSLv2, " : ""),
 416                      (protocol & SSL_PROTOCOL_SSLV3 ? "SSLv3, " : ""),
 417                      (protocol & SSL_PROTOCOL_TLSV1 ? "TLSv1, " : ""),
 418                      NULL);
 419     cp[strlen(cp)-2] = NUL;
 420
 421     ssl_log(s, SSL_LOG_TRACE|SSL_INIT,
 422             "Creating new SSL context (protocols: %s)", cp);
 423
 424     if (protocol == SSL_PROTOCOL_SSLV2) {
 425         ctx = SSL_CTX_new(SSLv2_server_method());  /* only SSLv2 is left */
 426     }
 427     else {
 428         ctx = SSL_CTX_new(SSLv23_server_method()); /* be more flexible */
 429     }
 430
 431     sc->pSSLCtx = ctx;
 432
 433     SSL_CTX_set_options(ctx, SSL_OP_ALL);
 434
 435     if (!(protocol & SSL_PROTOCOL_SSLV2)) {
 436         SSL_CTX_set_options(ctx, SSL_OP_NO_SSLv2);
 437     }
 438
 439     if (!(protocol & SSL_PROTOCOL_SSLV3)) {
 440         SSL_CTX_set_options(ctx, SSL_OP_NO_SSLv3);
 441     }
 442
 443     if (!(protocol & SSL_PROTOCOL_TLSV1)) {
 444         SSL_CTX_set_options(ctx, SSL_OP_NO_TLSv1);
 445     }
 446
 447     SSL_CTX_set_app_data(ctx, s);
 448
 449     /*
 450      * Configure additional context ingredients
 451      */
 452     SSL_CTX_set_options(ctx, SSL_OP_SINGLE_DH_USE);
 453
 454     return ctx;
 455 }
 456
 457 static void ssl_init_session_cache_ctx(server_rec *s,
 458                                        apr_pool_t *p,
 459                                        apr_pool_t *ptemp,
 460                                        SSLSrvConfigRec *sc)
 461 {
 462     SSL_CTX *ctx = sc->pSSLCtx;
 463     SSLModConfigRec *mc = myModConfig(s);
 464     long cache_mode = SSL_SESS_CACHE_OFF;
 465
 466     if (mc->nSessionCacheMode != SSL_SCMODE_NONE) {
 467         /* SSL_SESS_CACHE_NO_INTERNAL_LOOKUP will force OpenSSL
 468          * to ignore process local-caching and
 469          * to always get/set/delete sessions using mod_ssl's callbacks.
 470          */
 471         cache_mode = SSL_SESS_CACHE_SERVER|SSL_SESS_CACHE_NO_INTERNAL_LOOKUP;
 472     }
 473
 474     SSL_CTX_set_session_cache_mode(ctx, cache_mode);
 475
 476     SSL_CTX_sess_set_new_cb(ctx,    ssl_callback_NewSessionCacheEntry);
 477     SSL_CTX_sess_set_get_cb(ctx,    ssl_callback_GetSessionCacheEntry);
 478     SSL_CTX_sess_set_remove_cb(ctx, ssl_callback_DelSessionCacheEntry);
 479 }
 480
 481 static void ssl_init_verify(server_rec *s,
 482                             apr_pool_t *p,
 483                             apr_pool_t *ptemp,
 484                             SSLSrvConfigRec *sc)
 485 {
 486     SSL_CTX *ctx = sc->pSSLCtx;
 487
 488     int verify = SSL_VERIFY_NONE;
 489     STACK_OF(X509_NAME) *ca_list;
 490
 491     if (sc->nVerifyClient == SSL_CVERIFY_UNSET) {
 492         sc->nVerifyClient = SSL_CVERIFY_NONE;
 493     }
 494
 495     if (sc->nVerifyDepth == UNSET) {
 496         sc->nVerifyDepth = 1;
 497     }
 498
 499     /*
 500      *  Configure callbacks for SSL context
 501      */
 502     if (sc->nVerifyClient == SSL_CVERIFY_REQUIRE) {
 503         verify |= SSL_VERIFY_PEER_STRICT;
 504     }
 505
 506     if ((sc->nVerifyClient == SSL_CVERIFY_OPTIONAL) ||
 507         (sc->nVerifyClient == SSL_CVERIFY_OPTIONAL_NO_CA))
 508     {
 509         verify |= SSL_VERIFY_PEER;
 510     }
 511
 512     SSL_CTX_set_verify(ctx, verify,  ssl_callback_SSLVerify);
 513
 514     /*
 515      * Configure Client Authentication details
 516      */
 517     if (sc->szCACertificateFile || sc->szCACertificatePath) {
 518         ssl_log(s, SSL_LOG_TRACE|SSL_INIT,
 519                 "Configuring client authentication");
 520
 521         if (!SSL_CTX_load_verify_locations(ctx,
 522                                            sc->szCACertificateFile,
 523                                            sc->szCACertificatePath))
 524         {
 525             ssl_log(s, SSL_LOG_ERROR|SSL_ADD_SSLERR|SSL_INIT,
 526                     "Unable to configure verify locations "
 527                     "for client authentication");
 528             ssl_die();
 529         }
 530
 531         ca_list = ssl_init_FindCAList(s, ptemp,
 532                                       sc->szCACertificateFile,
 533                                       sc->szCACertificatePath);
 534         if (!ca_list) {
 535             ssl_log(s, SSL_LOG_ERROR|SSL_INIT,
 536                     "Unable to determine list of available "
 537                     "CA certificates for client authentication");
 538             ssl_die();
 539         }
 540
 541         SSL_CTX_set_client_CA_list(ctx, (STACK *)ca_list);
 542     }
 543
 544     /*
 545      * Give a warning when no CAs were configured but client authentication
 546      * should take place. This cannot work.
 547      */
 548     if (sc->nVerifyClient == SSL_CVERIFY_REQUIRE) {
 549         ca_list = (STACK_OF(X509_NAME) *)SSL_CTX_get_client_CA_list(ctx);
 550
 551         if (sk_X509_NAME_num(ca_list) == 0) {
 552             ssl_log(s, SSL_LOG_WARN,
 553                     "Init: Oops, you want to request client authentication, "
 554                     "but no CAs are known for verification!? "
 555                     "[Hint: SSLCACertificate*]");
 556         }
 557     }
 558 }
 559
 560 static void ssl_init_cipher_suite(server_rec *s,
 561                                   apr_pool_t *p,
 562                                   apr_pool_t *ptemp,
 563                                   SSLSrvConfigRec *sc)
 564 {
 565     SSL_CTX *ctx = sc->pSSLCtx;
 566     const char *suite = sc->szCipherSuite;
 567
 568     /*
 569      *  Configure SSL Cipher Suite
 570      */
 571     if (!suite) {
 572         return;
 573     }
 574
 575     ssl_log(s, SSL_LOG_TRACE|SSL_INIT,
 576             "Configuring permitted SSL ciphers [%s]",
 577             suite);
 578
 579     if (!SSL_CTX_set_cipher_list(ctx, suite)) {
 580         ssl_log(s, SSL_LOG_ERROR|SSL_ADD_SSLERR|SSL_INIT,
 581                 "Unable to configure permitted SSL ciphers");
 582         ssl_die();
 583     }
 584 }
 585
 586 static void ssl_init_crl(server_rec *s,
 587                          apr_pool_t *p,
 588                          apr_pool_t *ptemp,
 589                          SSLSrvConfigRec *sc)
 590 {
 591     /*
 592      * Configure Certificate Revocation List (CRL) Details
 593      */
 594
 595     if (!(sc->szCARevocationFile || sc->szCARevocationPath)) {
 596         return;
 597     }
 598
 599     ssl_log(s, SSL_LOG_TRACE|SSL_INIT,
 600             "Configuring certificate revocation facility");
 601
 602     sc->pRevocationStore =
 603         SSL_X509_STORE_create((char *)sc->szCARevocationFile,
 604                               (char *)sc->szCARevocationPath);
 605
 606     if (!sc->pRevocationStore) {
 607         ssl_log(s, SSL_LOG_ERROR|SSL_ADD_SSLERR|SSL_INIT,
 608                 "Unable to configure X.509 CRL storage "
 609                 "for certificate revocation");
 610         ssl_die();
 611     }
 612 }
 613
 614 static void ssl_init_cert_chain(server_rec *s,
 615                                 apr_pool_t *p,
 616                                 apr_pool_t *ptemp,
 617                                 SSLSrvConfigRec *sc)
 618 {
 619     BOOL skip_first = TRUE;
 620     int i, n;
 621     const char *chain = sc->szCertificateChain;
 622
 623     /*
 624      * Optionally configure extra server certificate chain certificates.
 625      * This is usually done by OpenSSL automatically when one of the
 626      * server cert issuers are found under SSLCACertificatePath or in
 627      * SSLCACertificateFile. But because these are intended for client
 628      * authentication it can conflict. For instance when you use a
 629      * Global ID server certificate you've to send out the intermediate
 630      * CA certificate, too. When you would just configure this with
 631      * SSLCACertificateFile and also use client authentication mod_ssl
 632      * would accept all clients also issued by this CA. Obviously this
 633      * isn't what we want in this situation. So this feature here exists
 634      * to allow one to explicity configure CA certificates which are
 635      * used only for the server certificate chain.
 636      */
 637     if (!chain) {
 638         return;
 639     }
 640
 641     for (i = 0; (i < SSL_AIDX_MAX) && sc->szPublicCertFiles[i]; i++) {
 642         if (strEQ(sc->szPublicCertFiles[i], chain)) {
 643             skip_first = TRUE;
 644             break;
 645         }
 646     }
 647
 648     n = SSL_CTX_use_certificate_chain(sc->pSSLCtx,
 649                                       (char *)chain,
 650                                       skip_first, NULL);
 651     if (n < 0) {
 652         ssl_log(s, SSL_LOG_ERROR|SSL_INIT,
 653                 "Failed to configure CA certificate chain!");
 654         ssl_die();
 655     }
 656
 657     ssl_log(s, SSL_LOG_TRACE|SSL_INIT,
 658             "Configuring server certificate chain "
 659             "(%d CA certificate%s)",
 660             n, n == 1 ? "" : "s");
 661 }
 662
 663 static int ssl_server_import_cert(server_rec *s,
 664                                   SSLSrvConfigRec *sc,
 665                                   const char *id,
 666                                   int idx)
 667 {
 668     SSLModConfigRec *mc = myModConfig(s);
 669     ssl_asn1_t *asn1;
 670     unsigned char *ptr;
 671     const char *type = ssl_asn1_keystr(idx);
 672     X509 *cert;
 673
 674     if (!(asn1 = ssl_asn1_table_get(mc->tPublicCert, id))) {
 675         return FALSE;
 676     }
 677
 678     ssl_log(s, SSL_LOG_TRACE|SSL_INIT,
 679             "Configuring %s server certificate", type);
 680
 681     ptr = asn1->cpData;
 682     if (!(cert = d2i_X509(NULL, &ptr, asn1->nData))) {
 683         ssl_log(s, SSL_LOG_ERROR|SSL_ADD_SSLERR|SSL_INIT,
 684                 "Unable to import %s server certificate", type);
 685         ssl_die();
 686     }
 687
 688     if (SSL_CTX_use_certificate(sc->pSSLCtx, cert) <= 0) {
 689         ssl_log(s, SSL_LOG_ERROR|SSL_ADD_SSLERR|SSL_INIT,
 690                 "Unable to configure %s server certificate", type);
 691         ssl_die();
 692     }
 693
 694     sc->pPublicCert[idx] = cert;
 695
 696     return TRUE;
 697 }
 698
 699 static int ssl_server_import_key(server_rec *s,
 700                                  SSLSrvConfigRec *sc,
 701                                  const char *id,
 702                                  int idx)
 703 {
 704     SSLModConfigRec *mc = myModConfig(s);
 705     ssl_asn1_t *asn1;
 706     unsigned char *ptr;
 707     const char *type = ssl_asn1_keystr(idx);
 708     int pkey_type = (idx == SSL_AIDX_RSA) ? EVP_PKEY_RSA : EVP_PKEY_DSA;
 709     EVP_PKEY *pkey;
 710
 711     if (!(asn1 = ssl_asn1_table_get(mc->tPrivateKey, id))) {
 712         return FALSE;
 713     }
 714
 715     ssl_log(s, SSL_LOG_TRACE|SSL_INIT,
 716             "Configuring %s server private key", type);
 717
 718     ptr = asn1->cpData;
 719     if (!(pkey = d2i_PrivateKey(pkey_type, NULL, &ptr, asn1->nData)))
 720     {
 721         ssl_log(s, SSL_LOG_ERROR|SSL_ADD_SSLERR|SSL_INIT,
 722                 "Unable to import %s server private key", type);
 723         ssl_die();
 724     }
 725
 726     if (SSL_CTX_use_PrivateKey(sc->pSSLCtx, pkey) <= 0) {
 727         ssl_log(s, SSL_LOG_ERROR|SSL_ADD_SSLERR|SSL_INIT,
 728                 "Unable to configure %s server private key", type);
 729         ssl_die();
 730     }
 731
 732     /*
 733      * XXX: wonder if this is still needed, this is old todo doc.
 734      * (see http://www.psy.uq.edu.au/~ftp/Crypto/ssleay/TODO.html)
 735      */
 736     if ((pkey_type == EVP_PKEY_DSA) && sc->pPublicCert[idx]) {
 737         EVP_PKEY *pubkey = X509_get_pubkey(sc->pPublicCert[idx]);
 738
 739         if (pubkey && EVP_PKEY_missing_parameters(pubkey)) {
 740             EVP_PKEY_copy_parameters(pubkey, pkey);
 741             ssl_log(s, SSL_LOG_ERROR|SSL_ADD_SSLERR|SSL_INIT,
 742                     "Copying DSA parameters from private key to certificate");
 743         }
 744     }
 745
 746     sc->pPrivateKey[idx] = pkey;
 747
 748     return TRUE;
 749 }
 750
 751 static void ssl_check_public_cert(server_rec *s,
 752                                   apr_pool_t *ptemp,
 753                                   X509 *cert,
 754                                   int type)
 755 {
 756     int is_ca, pathlen;
 757     char *cn;
 758
 759     if (!cert) {
 760         return;
 761     }
 762
 763     /*
 764      * Some information about the certificate(s)
 765      */
 766
 767     if (SSL_X509_isSGC(cert)) {
 768         ssl_log(s, SSL_LOG_INFO|SSL_INIT,
 769                 "%s server certificate enables "
 770                 "Server Gated Cryptography (SGC)",
 771                 ssl_asn1_keystr(type));
 772     }
 773
 774     if (SSL_X509_getBC(cert, &is_ca, &pathlen)) {
 775         if (is_ca) {
 776             ssl_log(s, SSL_LOG_WARN|SSL_INIT,
 777                     "%s server certificate is a CA certificate "
 778                     "(BasicConstraints: CA == TRUE !?)",
 779                     ssl_asn1_keystr(type));
 780         }
 781
 782         if (pathlen > 0) {
 783             ssl_log(s, SSL_LOG_WARN|SSL_INIT,
 784                     "%s server certificate is not a leaf certificate "
 785                     "(BasicConstraints: pathlen == %d > 0 !?)",
 786                     ssl_asn1_keystr(type), pathlen);
 787         }
 788     }
 789
 790     if (SSL_X509_getCN(ptemp, cert, &cn)) {
 791         int fnm_flags = FNM_PERIOD|FNM_CASE_BLIND;
 792
 793         if (apr_is_fnmatch(cn) &&
 794             (apr_fnmatch(cn, s->server_hostname,
 795                          fnm_flags) == FNM_NOMATCH))
 796         {
 797             ssl_log(s, SSL_LOG_WARN|SSL_INIT,
 798                     "%s server certificate wildcard CommonName (CN) `%s' "
 799                     "does NOT match server name!?",
 800                     ssl_asn1_keystr(type), cn);
 801         }
 802         else if (strNE(s->server_hostname, cn)) {
 803             ssl_log(s, SSL_LOG_WARN|SSL_INIT,
 804                     "%s server certificate CommonName (CN) `%s' "
 805                     "does NOT match server name!?",
 806                     ssl_asn1_keystr(type), cn);
 807         }
 808     }
 809 }
 810
 811 static void ssl_init_server_certs(server_rec *s,
 812                                   apr_pool_t *p,
 813                                   apr_pool_t *ptemp,
 814                                   SSLSrvConfigRec *sc)
 815 {
 816     const char *rsa_id, *dsa_id;
 817     const char *vhost_id = sc->szVHostID;
 818     int i;
 819     int have_rsa, have_dsa;
 820
 821     rsa_id = ssl_asn1_table_keyfmt(ptemp, vhost_id, SSL_AIDX_RSA);
 822     dsa_id = ssl_asn1_table_keyfmt(ptemp, vhost_id, SSL_AIDX_DSA);
 823
 824     have_rsa = ssl_server_import_cert(s, sc, rsa_id, SSL_AIDX_RSA);
 825     have_dsa = ssl_server_import_cert(s, sc, dsa_id, SSL_AIDX_DSA);
 826
 827     if (!(have_rsa || have_dsa)) {
 828         ssl_log(s, SSL_LOG_ERROR|SSL_INIT,
 829                 "Oops, no RSA or DSA server certificate found?!");
 830         ssl_log(s, SSL_LOG_ERROR|SSL_INIT,
 831                 "You have to perform a *full* server restart "
 832                 "when you added or removed a certificate and/or key file");
 833         ssl_die();
 834     }
 835
 836     for (i = 0; i < SSL_AIDX_MAX; i++) {
 837         ssl_check_public_cert(s, ptemp, sc->pPublicCert[i], i);
 838     }
 839
 840     have_rsa = ssl_server_import_key(s, sc, rsa_id, SSL_AIDX_RSA);
 841     have_dsa = ssl_server_import_key(s, sc, dsa_id, SSL_AIDX_DSA);
 842
 843     if (!(have_rsa || have_dsa)) {
 844         ssl_log(s, SSL_LOG_ERROR|SSL_INIT,
 845                 "Oops, no RSA or DSA server private key found?!");
 846         ssl_die();
 847     }
 848 }
 849
 850 /*
 851  * Configure a particular server
 852  */
 853 void ssl_init_ConfigureServer(server_rec *s,
 854                               apr_pool_t *p,
 855                               apr_pool_t *ptemp,
 856                               SSLSrvConfigRec *sc)
 857 {
 858     SSL_CTX *ctx;
 859
 860     ssl_init_check_server(s, p, ptemp, sc);
 861
 862     ctx = ssl_init_ctx(s, p, ptemp, sc);
 863
 864     ssl_init_session_cache_ctx(s, p, ptemp, sc);
 865
 866     ssl_init_verify(s, p, ptemp, sc);
 867
 868     ssl_init_cipher_suite(s, p, ptemp, sc);
 869
 870     ssl_init_crl(s, p, ptemp, sc);
 871
 872     ssl_init_cert_chain(s, p, ptemp, sc);
 873
 874     SSL_CTX_set_tmp_rsa_callback(ctx, ssl_callback_TmpRSA);
 875     SSL_CTX_set_tmp_dh_callback(ctx,  ssl_callback_TmpDH);
 876
 877     if (sc->nLogLevel >= SSL_LOG_INFO) {
 878         /* this callback only logs if SSLLogLevel >= info */
 879         SSL_CTX_set_info_callback(ctx, ssl_callback_LogTracingState);
 880     }
 881
 882     ssl_init_server_certs(s, p, ptemp, sc);
 883 }
 884
 885 void ssl_init_CheckServers(server_rec *base_server, apr_pool_t *p)
 886 {
 887     server_rec *s, *ps;
 888     SSLSrvConfigRec *sc;
 889     apr_hash_t *table;
 890     const char *key;
 891     apr_ssize_t klen;
 892
 893     BOOL conflict = FALSE;
 894
 895     /*
 896      * Give out warnings when a server has HTTPS configured
 897      * for the HTTP port or vice versa
 898      */
 899     for (s = base_server; s; s = s->next) {
 900         sc = mySrvConfig(s);
 901
 902         if (sc->bEnabled && (s->port == DEFAULT_HTTP_PORT)) {
 903             ssl_log(base_server, SSL_LOG_WARN,
 904                     "Init: (%s) You configured HTTPS(%d) "
 905                     "on the standard HTTP(%d) port!",
 906                     ssl_util_vhostid(p, s),
 907                     DEFAULT_HTTPS_PORT, DEFAULT_HTTP_PORT);
 908         }
 909
 910         if (!sc->bEnabled && (s->port == DEFAULT_HTTPS_PORT)) {
 911             ssl_log(base_server, SSL_LOG_WARN,
 912                     "Init: (%s) You configured HTTP(%d) "
 913                     "on the standard HTTPS(%d) port!",
 914                     ssl_util_vhostid(p, s),
 915                     DEFAULT_HTTP_PORT, DEFAULT_HTTPS_PORT);
 916         }
 917     }
 918
 919     /*
 920      * Give out warnings when more than one SSL-aware virtual server uses the
 921      * same IP:port. This doesn't work because mod_ssl then will always use
 922      * just the certificate/keys of one virtual host (which one cannot be said
 923      * easily - but that doesn't matter here).
 924      */
 925     table = apr_hash_make(p);
 926
 927     for (s = base_server; s; s = s->next) {
 928         sc = mySrvConfig(s);
 929
 930         if (!sc->bEnabled) {
 931             continue;
 932         }
 933
 934         key = apr_psprintf(p, "%pA:%u",
 935                            &s->addrs->host_addr, s->addrs->host_port);
 936         klen = strlen(key);
 937
 938         if ((ps = (server_rec *)apr_hash_get(table, key, klen))) {
 939             ssl_log(base_server, SSL_LOG_WARN,
 940                     "Init: SSL server IP/port conflict: "
 941                     "%s (%s:%d) vs. %s (%s:%d)",
 942                     ssl_util_vhostid(p, s),
 943                     (s->defn_name ? s->defn_name : "unknown"),
 944                     s->defn_line_number,
 945                     ssl_util_vhostid(p, ps),
 946                     (ps->defn_name ? ps->defn_name : "unknown"),
 947                     ps->defn_line_number);
 948             conflict = TRUE;
 949             continue;
 950         }
 951
 952         apr_hash_set(table, key, klen, s);
 953     }
 954
 955     if (conflict) {
 956         ssl_log(base_server, SSL_LOG_WARN,
 957                 "Init: You should not use name-based "
 958                 "virtual hosts in conjunction with SSL!!");
 959     }
 960 }
 961
 962 static int ssl_init_FindCAList_X509NameCmp(X509_NAME **a, X509_NAME **b)
 963 {
 964     return(X509_NAME_cmp(*a, *b));
 965 }
 966
 967 static void ssl_init_PushCAList(STACK_OF(X509_NAME) *ca_list,
 968                                 server_rec *s, const char *file)
 969 {
 970     int n;
 971     STACK_OF(X509_NAME) *sk;
 972
 973     sk = (STACK_OF(X509_NAME) *)SSL_load_client_CA_file(file);
 974
 975     if (!sk) {
 976         return;
 977     }
 978
 979     for (n = 0; n < sk_X509_NAME_num(sk); n++) {
 980         char name_buf[256];
 981         X509_NAME *name = sk_X509_NAME_value(sk, n);
 982
 983         ssl_log(s, SSL_LOG_TRACE,
 984                 "CA certificate: %s",
 985                 X509_NAME_oneline(name, name_buf, sizeof(name_buf)));
 986
 987         /*
 988          * note that SSL_load_client_CA_file() checks for duplicates,
 989          * but since we call it multiple times when reading a directory
 990          * we must also check for duplicates ourselves.
 991          */
 992
 993         if (sk_X509_NAME_find(ca_list, name) < 0) {
 994             /* this will be freed when ca_list is */
 995             sk_X509_NAME_push(ca_list, name);
 996         }
 997         else {
 998             /* need to free this ourselves, else it will leak */
 999             X509_NAME_free(name);
1000         }
1001     }
1002
1003     sk_X509_NAME_free(sk);
1004 }
1005
1006 STACK_OF(X509_NAME) *ssl_init_FindCAList(server_rec *s,
1007                                          apr_pool_t *ptemp,
1008                                          const char *ca_file,
1009                                          const char *ca_path)
1010 {
1011     STACK_OF(X509_NAME) *ca_list;
1012
1013     /*
1014      * Start with a empty stack/list where new
1015      * entries get added in sorted order.
1016      */
1017     ca_list = sk_X509_NAME_new(ssl_init_FindCAList_X509NameCmp);
1018
1019     /*
1020      * Process CA certificate bundle file
1021      */
1022     if (ca_file) {
1023         ssl_init_PushCAList(ca_list, s, ca_file);
1024     }
1025
1026     /*
1027      * Process CA certificate path files
1028      */
1029     if (ca_path) {
1030         apr_dir_t *dir;
1031         apr_finfo_t direntry;
1032         apr_int32_t finfo_flags = APR_FINFO_MIN|APR_FINFO_NAME;
1033
1034         if (apr_dir_open(&dir, ca_path, ptemp) != APR_SUCCESS) {
1035             ssl_log(s, SSL_LOG_ERROR|SSL_ADD_ERRNO|SSL_INIT,
1036                     "Failed to open SSLCACertificatePath `%s'",
1037                     ca_path);
1038             ssl_die();
1039         }
1040
1041         while ((apr_dir_read(&direntry, finfo_flags, dir)) == APR_SUCCESS) {
1042             const char *file;
1043             if (direntry.filetype == APR_DIR) {
1044                 continue; /* don't try to load directories */
1045             }
1046             file = apr_pstrcat(ptemp, ca_path, "/", direntry.name, NULL);
1047             ssl_init_PushCAList(ca_list, s, file);
1048         }
1049
1050         apr_dir_close(dir);
1051     }
1052
1053     /*
1054      * Cleanup
1055      */
1056     sk_X509_NAME_set_cmp_func(ca_list, NULL);
1057
1058     return ca_list;
1059 }
1060
1061 void ssl_init_Child(apr_pool_t *p, server_rec *s)
1062 {
1063     SSLModConfigRec *mc = myModConfig(s);
1064     mc->pid = getpid(); /* only call getpid() once per-process */
1065
1066     /* XXX: there should be an ap_srand() function */
1067     srand((unsigned int)time(NULL));
1068
1069     /* open the mutex lockfile */
1070     ssl_mutex_reinit(s, p);
1071 }
1072
1073 #define MODSSL_CFG_ITEM_FREE(func, item) \
1074     if (item) { \
1075         func(item); \
1076         item = NULL; \
1077     }
1078
1079 apr_status_t ssl_init_ModuleKill(void *data)
1080 {
1081     SSLSrvConfigRec *sc;
1082     server_rec *base_server = (server_rec *)data;
1083     server_rec *s;
1084
1085     /*
1086      * Drop the session cache and mutex
1087      */
1088     ssl_scache_kill(base_server);
1089
1090     /*
1091      * Destroy the temporary keys and params
1092      */
1093     ssl_tmp_keys_free(base_server);
1094
1095     /*
1096      * Free the non-pool allocated structures
1097      * in the per-server configurations
1098      */
1099     for (s = base_server; s; s = s->next) {
1100         int i;
1101         sc = mySrvConfig(s);
1102
1103         for (i=0; i < SSL_AIDX_MAX; i++) {
1104             MODSSL_CFG_ITEM_FREE(X509_free,
1105                                  sc->pPublicCert[i]);
1106
1107             MODSSL_CFG_ITEM_FREE(EVP_PKEY_free,
1108                                  sc->pPrivateKey[i]);
1109         }
1110
1111         MODSSL_CFG_ITEM_FREE(X509_STORE_free,
1112                              sc->pRevocationStore);
1113
1114         MODSSL_CFG_ITEM_FREE(SSL_CTX_free,
1115                              sc->pSSLCtx);
1116     }
1117
1118     /*
1119      * Try to kill the internals of the SSL library.
1120      */
1121     ERR_free_strings();
1122     ERR_remove_state(0);
1123     EVP_cleanup();
1124
1125     return APR_SUCCESS;
1126 }
1127