2 ** _ __ ___ ___ __| | ___ ___| | mod_ssl
3 ** | '_ ` _ \ / _ \ / _` | / __/ __| | Apache Interface to OpenSSL
4 ** | | | | | | (_) | (_| | \__ \__ \ | www.modssl.org
5 ** |_| |_| |_|\___/ \__,_|___|___/___/_| ftp.modssl.org
8 ** Initialization of Servers
11 /* ====================================================================
12 * The Apache Software License, Version 1.1
14 * Copyright (c) 2000-2003 The Apache Software Foundation. All rights
17 * Redistribution and use in source and binary forms, with or without
18 * modification, are permitted provided that the following conditions
21 * 1. Redistributions of source code must retain the above copyright
22 * notice, this list of conditions and the following disclaimer.
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
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.
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.
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.
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
57 * ====================================================================
64 /* _________________________________________________________________
66 ** Module Initialization
67 ** _________________________________________________________________
70 static char *ssl_add_version_component(apr_pool_t *p,
74 char *val = ssl_var_lookup(p, s, NULL, NULL, name);
77 ap_add_version_component(p, val);
83 static char *version_components[] = {
84 "SSL_VERSION_PRODUCT",
85 "SSL_VERSION_INTERFACE",
86 "SSL_VERSION_LIBRARY",
90 static void ssl_add_version_components(apr_pool_t *p,
93 char *vals[sizeof(version_components)/sizeof(char *)];
96 for (i=0; version_components[i]; i++) {
97 vals[i] = ssl_add_version_component(p, s,
98 version_components[i]);
101 ap_log_error(APLOG_MARK, APLOG_INFO, 0, s,
102 "Server: %s, Interface: %s, Library: %s",
103 AP_SERVER_BASEVERSION,
104 vals[1], /* SSL_VERSION_INTERFACE */
105 vals[2]); /* SSL_VERSION_LIBRARY */
110 * Initialize SSL library
112 static void ssl_init_SSLLibrary(server_rec *s)
114 ap_log_error(APLOG_MARK, APLOG_INFO, 0, s,
115 "Init: Initializing %s library", SSL_LIBRARY_NAME);
117 SSL_load_error_strings();
122 * Handle the Temporary RSA Keys and DH Params
125 #define MODSSL_TMP_KEY_FREE(mc, type, idx) \
126 if (mc->pTmpKeys[idx]) { \
127 type##_free((type *)mc->pTmpKeys[idx]); \
128 mc->pTmpKeys[idx] = NULL; \
131 #define MODSSL_TMP_KEYS_FREE(mc, type) \
132 MODSSL_TMP_KEY_FREE(mc, type, SSL_TMP_KEY_##type##_512); \
133 MODSSL_TMP_KEY_FREE(mc, type, SSL_TMP_KEY_##type##_1024)
135 static void ssl_tmp_keys_free(server_rec *s)
137 SSLModConfigRec *mc = myModConfig(s);
139 MODSSL_TMP_KEYS_FREE(mc, RSA);
140 MODSSL_TMP_KEYS_FREE(mc, DH);
143 static int ssl_tmp_key_init_rsa(server_rec *s,
146 SSLModConfigRec *mc = myModConfig(s);
148 if (!(mc->pTmpKeys[idx] =
149 RSA_generate_key(bits, RSA_F4, NULL, NULL)))
151 ap_log_error(APLOG_MARK, APLOG_ERR, 0, s,
152 "Init: Failed to generate temporary "
153 "%d bit RSA private key", bits);
160 static int ssl_tmp_key_init_dh(server_rec *s,
163 SSLModConfigRec *mc = myModConfig(s);
165 if (!(mc->pTmpKeys[idx] =
166 ssl_dh_GetTmpParam(bits)))
168 ap_log_error(APLOG_MARK, APLOG_ERR, 0, s,
169 "Init: Failed to generate temporary "
170 "%d bit DH parameters", bits);
177 #define MODSSL_TMP_KEY_INIT_RSA(s, bits) \
178 ssl_tmp_key_init_rsa(s, bits, SSL_TMP_KEY_RSA_##bits)
180 #define MODSSL_TMP_KEY_INIT_DH(s, bits) \
181 ssl_tmp_key_init_dh(s, bits, SSL_TMP_KEY_DH_##bits)
183 static int ssl_tmp_keys_init(server_rec *s)
185 ap_log_error(APLOG_MARK, APLOG_INFO, 0, s,
186 "Init: Generating temporary RSA private keys (512/1024 bits)");
188 if (MODSSL_TMP_KEY_INIT_RSA(s, 512) ||
189 MODSSL_TMP_KEY_INIT_RSA(s, 1024)) {
193 ap_log_error(APLOG_MARK, APLOG_INFO, 0, s,
194 "Init: Generating temporary DH parameters (512/1024 bits)");
196 if (MODSSL_TMP_KEY_INIT_DH(s, 512) ||
197 MODSSL_TMP_KEY_INIT_DH(s, 1024)) {
205 * Per-module initialization
207 int ssl_init_Module(apr_pool_t *p, apr_pool_t *plog,
209 server_rec *base_server)
211 SSLModConfigRec *mc = myModConfig(base_server);
216 * Let us cleanup on restarts and exists
218 apr_pool_cleanup_register(p, base_server,
220 apr_pool_cleanup_null);
223 * Any init round fixes the global config
225 ssl_config_global_create(base_server); /* just to avoid problems */
226 ssl_config_global_fix(mc);
229 * try to fix the configuration and open the dedicated SSL
230 * logfile as early as possible
232 for (s = base_server; s; s = s->next) {
244 * Create the server host:port string because we need it a lot
246 sc->vhost_id = ssl_util_vhostid(p, s);
247 sc->vhost_id_len = strlen(sc->vhost_id);
250 /* If sc->enabled is UNSET, then SSL is optional on this vhost */
251 /* Fix up stuff that may not have been set */
252 if (sc->enabled == UNSET) {
256 if (sc->proxy_enabled == UNSET) {
257 sc->proxy_enabled = FALSE;
260 if (sc->session_cache_timeout == UNSET) {
261 sc->session_cache_timeout = SSL_SESSION_CACHE_TIMEOUT;
264 if (sc->server->pphrase_dialog_type == SSL_PPTYPE_UNSET) {
265 sc->server->pphrase_dialog_type = SSL_PPTYPE_BUILTIN;
271 * SSL external crypto device ("engine") support
273 #ifdef SSL_EXPERIMENTAL_ENGINE
274 ssl_init_Engine(base_server, p);
277 ssl_init_SSLLibrary(base_server);
280 ssl_util_thread_setup(p);
284 * Seed the Pseudo Random Number Generator (PRNG)
285 * only need ptemp here; nothing inside allocated from the pool
286 * needs to live once we return from ssl_rand_seed().
288 ssl_rand_seed(base_server, ptemp, SSL_RSCTX_STARTUP, "Init: ");
291 * read server private keys/public certs into memory.
292 * decrypting any encrypted keys via configured SSLPassPhraseDialogs
293 * anything that needs to live longer than ptemp needs to also survive
294 * restarts, in which case they'll live inside s->process->pool.
296 ssl_pphrase_Handle(base_server, ptemp);
298 if (ssl_tmp_keys_init(base_server)) {
303 * initialize the mutex handling
305 if (!ssl_mutex_init(base_server, p)) {
306 return HTTP_INTERNAL_SERVER_ERROR;
310 * initialize session caching
312 ssl_scache_init(base_server, p);
317 ap_log_error(APLOG_MARK, APLOG_INFO, 0, base_server,
318 "Init: Initializing (virtual) servers for SSL");
320 for (s = base_server; s; s = s->next) {
323 * Either now skip this server when SSL is disabled for
324 * it or give out some information about what we're
329 * Read the server certificate and key
331 ssl_init_ConfigureServer(s, p, ptemp, sc);
335 * Configuration consistency checks
337 ssl_init_CheckServers(base_server, ptemp);
340 * Announce mod_ssl and SSL library in HTTP Server field
341 * as ``mod_ssl/X.X.X OpenSSL/X.X.X''
343 ssl_add_version_components(p, base_server);
345 SSL_init_app_data2_idx(); /* for SSL_get_app_data2() at request time */
351 * Support for external a Crypto Device ("engine"), usually
352 * a hardware accellerator card for crypto operations.
354 #ifdef SSL_EXPERIMENTAL_ENGINE
355 void ssl_init_Engine(server_rec *s, apr_pool_t *p)
357 SSLModConfigRec *mc = myModConfig(s);
360 if (mc->szCryptoDevice) {
361 if (!(e = ENGINE_by_id(mc->szCryptoDevice))) {
362 ap_log_error(APLOG_MARK, APLOG_ERR, 0, s,
363 "Init: Failed to load Crypto Device API `%s'",
368 if (strEQ(mc->szCryptoDevice, "chil")) {
369 ENGINE_ctrl(e, ENGINE_CTRL_CHIL_SET_FORKCHECK, 1, 0, 0);
372 if (!ENGINE_set_default(e, ENGINE_METHOD_ALL)) {
373 ap_log_error(APLOG_MARK, APLOG_ERR, 0, s,
374 "Init: Failed to enable Crypto Device API `%s'",
384 static void ssl_init_server_check(server_rec *s,
390 * check for important parameters and the
391 * possibility that the user forgot to set them.
393 if (!mctx->pks->cert_files[0]) {
394 ap_log_error(APLOG_MARK, APLOG_ERR, 0, s,
395 "No SSL Certificate set [hint: SSLCertificateFile]");
400 * Check for problematic re-initializations
402 if (mctx->pks->certs[SSL_AIDX_RSA] ||
403 mctx->pks->certs[SSL_AIDX_DSA])
405 ap_log_error(APLOG_MARK, APLOG_ERR, 0, s,
406 "Illegal attempt to re-initialise SSL for server "
407 "(theoretically shouldn't happen!)");
412 static void ssl_init_ctx_protocol(server_rec *s,
418 SSL_METHOD *method = NULL;
420 int protocol = mctx->protocol;
423 * Create the new per-server SSL context
425 if (protocol == SSL_PROTOCOL_NONE) {
426 ap_log_error(APLOG_MARK, APLOG_ERR, 0, s,
427 "No SSL protocols available [hint: SSLProtocol]");
432 (protocol & SSL_PROTOCOL_SSLV2 ? "SSLv2, " : ""),
433 (protocol & SSL_PROTOCOL_SSLV3 ? "SSLv3, " : ""),
434 (protocol & SSL_PROTOCOL_TLSV1 ? "TLSv1, " : ""),
436 cp[strlen(cp)-2] = NUL;
438 ap_log_error(APLOG_MARK, APLOG_DEBUG, 0, s,
439 "Creating new SSL context (protocols: %s)", cp);
441 if (protocol == SSL_PROTOCOL_SSLV2) {
443 SSLv2_client_method() : /* proxy */
444 SSLv2_server_method(); /* server */
445 ctx = SSL_CTX_new(method); /* only SSLv2 is left */
449 SSLv23_client_method() : /* proxy */
450 SSLv23_server_method(); /* server */
451 ctx = SSL_CTX_new(method); /* be more flexible */
456 SSL_CTX_set_options(ctx, SSL_OP_ALL);
458 if (!(protocol & SSL_PROTOCOL_SSLV2)) {
459 SSL_CTX_set_options(ctx, SSL_OP_NO_SSLv2);
462 if (!(protocol & SSL_PROTOCOL_SSLV3)) {
463 SSL_CTX_set_options(ctx, SSL_OP_NO_SSLv3);
466 if (!(protocol & SSL_PROTOCOL_TLSV1)) {
467 SSL_CTX_set_options(ctx, SSL_OP_NO_TLSv1);
470 SSL_CTX_set_app_data(ctx, s);
473 * Configure additional context ingredients
475 SSL_CTX_set_options(ctx, SSL_OP_SINGLE_DH_USE);
478 static void ssl_init_ctx_session_cache(server_rec *s,
483 SSL_CTX *ctx = mctx->ssl_ctx;
484 SSLModConfigRec *mc = myModConfig(s);
485 long cache_mode = SSL_SESS_CACHE_OFF;
487 if (mc->nSessionCacheMode != SSL_SCMODE_NONE) {
488 /* SSL_SESS_CACHE_NO_INTERNAL_LOOKUP will force OpenSSL
489 * to ignore process local-caching and
490 * to always get/set/delete sessions using mod_ssl's callbacks.
492 cache_mode = SSL_SESS_CACHE_SERVER|SSL_SESS_CACHE_NO_INTERNAL_LOOKUP;
495 SSL_CTX_set_session_cache_mode(ctx, cache_mode);
497 SSL_CTX_sess_set_new_cb(ctx, ssl_callback_NewSessionCacheEntry);
498 SSL_CTX_sess_set_get_cb(ctx, ssl_callback_GetSessionCacheEntry);
499 SSL_CTX_sess_set_remove_cb(ctx, ssl_callback_DelSessionCacheEntry);
502 static void ssl_init_ctx_callbacks(server_rec *s,
507 SSL_CTX *ctx = mctx->ssl_ctx;
509 SSL_CTX_set_tmp_rsa_callback(ctx, ssl_callback_TmpRSA);
510 SSL_CTX_set_tmp_dh_callback(ctx, ssl_callback_TmpDH);
512 if (s->loglevel >= APLOG_DEBUG) {
513 /* this callback only logs if LogLevel >= info */
514 SSL_CTX_set_info_callback(ctx, ssl_callback_LogTracingState);
518 static void ssl_init_ctx_verify(server_rec *s,
523 SSL_CTX *ctx = mctx->ssl_ctx;
525 int verify = SSL_VERIFY_NONE;
526 STACK_OF(X509_NAME) *ca_list;
528 if (mctx->auth.verify_mode == SSL_CVERIFY_UNSET) {
529 mctx->auth.verify_mode = SSL_CVERIFY_NONE;
532 if (mctx->auth.verify_depth == UNSET) {
533 mctx->auth.verify_depth = 1;
537 * Configure callbacks for SSL context
539 if (mctx->auth.verify_mode == SSL_CVERIFY_REQUIRE) {
540 verify |= SSL_VERIFY_PEER_STRICT;
543 if ((mctx->auth.verify_mode == SSL_CVERIFY_OPTIONAL) ||
544 (mctx->auth.verify_mode == SSL_CVERIFY_OPTIONAL_NO_CA))
546 verify |= SSL_VERIFY_PEER;
549 SSL_CTX_set_verify(ctx, verify, ssl_callback_SSLVerify);
552 * Configure Client Authentication details
554 if (mctx->auth.ca_cert_file || mctx->auth.ca_cert_path) {
555 ap_log_error(APLOG_MARK, APLOG_DEBUG, 0, s,
556 "Configuring client authentication");
558 if (!SSL_CTX_load_verify_locations(ctx,
559 mctx->auth.ca_cert_file,
560 mctx->auth.ca_cert_path))
562 ap_log_error(APLOG_MARK, APLOG_ERR, 0, s,
563 "Unable to configure verify locations "
564 "for client authentication");
565 ssl_log_ssl_error(APLOG_MARK, APLOG_ERR, s);
569 ca_list = ssl_init_FindCAList(s, ptemp,
570 mctx->auth.ca_cert_file,
571 mctx->auth.ca_cert_path);
573 ap_log_error(APLOG_MARK, APLOG_ERR, 0, s,
574 "Unable to determine list of available "
575 "CA certificates for client authentication");
579 SSL_CTX_set_client_CA_list(ctx, (STACK *)ca_list);
583 * Give a warning when no CAs were configured but client authentication
584 * should take place. This cannot work.
586 if (mctx->auth.verify_mode == SSL_CVERIFY_REQUIRE) {
587 ca_list = (STACK_OF(X509_NAME) *)SSL_CTX_get_client_CA_list(ctx);
589 if (sk_X509_NAME_num(ca_list) == 0) {
590 ap_log_error(APLOG_MARK, APLOG_WARNING, 0, s,
591 "Init: Oops, you want to request client "
592 "authentication, but no CAs are known for "
593 "verification!? [Hint: SSLCACertificate*]");
598 static void ssl_init_ctx_cipher_suite(server_rec *s,
603 SSL_CTX *ctx = mctx->ssl_ctx;
604 const char *suite = mctx->auth.cipher_suite;
607 * Configure SSL Cipher Suite
613 ap_log_error(APLOG_MARK, APLOG_DEBUG, 0, s,
614 "Configuring permitted SSL ciphers [%s]",
617 if (!SSL_CTX_set_cipher_list(ctx, suite)) {
618 ap_log_error(APLOG_MARK, APLOG_ERR, 0, s,
619 "Unable to configure permitted SSL ciphers");
620 ssl_log_ssl_error(APLOG_MARK, APLOG_ERR, s);
625 static void ssl_init_ctx_crl(server_rec *s,
631 * Configure Certificate Revocation List (CRL) Details
634 if (!(mctx->crl_file || mctx->crl_path)) {
638 ap_log_error(APLOG_MARK, APLOG_DEBUG, 0, s,
639 "Configuring certificate revocation facility");
642 SSL_X509_STORE_create((char *)mctx->crl_file,
643 (char *)mctx->crl_path);
646 ap_log_error(APLOG_MARK, APLOG_ERR, 0, s,
647 "Unable to configure X.509 CRL storage "
648 "for certificate revocation");
649 ssl_log_ssl_error(APLOG_MARK, APLOG_ERR, s);
654 static void ssl_init_ctx_cert_chain(server_rec *s,
659 BOOL skip_first = FALSE;
661 const char *chain = mctx->cert_chain;
664 * Optionally configure extra server certificate chain certificates.
665 * This is usually done by OpenSSL automatically when one of the
666 * server cert issuers are found under SSLCACertificatePath or in
667 * SSLCACertificateFile. But because these are intended for client
668 * authentication it can conflict. For instance when you use a
669 * Global ID server certificate you've to send out the intermediate
670 * CA certificate, too. When you would just configure this with
671 * SSLCACertificateFile and also use client authentication mod_ssl
672 * would accept all clients also issued by this CA. Obviously this
673 * isn't what we want in this situation. So this feature here exists
674 * to allow one to explicity configure CA certificates which are
675 * used only for the server certificate chain.
681 for (i = 0; (i < SSL_AIDX_MAX) && mctx->pks->cert_files[i]; i++) {
682 if (strEQ(mctx->pks->cert_files[i], chain)) {
688 n = SSL_CTX_use_certificate_chain(mctx->ssl_ctx,
692 ap_log_error(APLOG_MARK, APLOG_ERR, 0, s,
693 "Failed to configure CA certificate chain!");
697 ap_log_error(APLOG_MARK, APLOG_DEBUG, 0, s,
698 "Configuring server certificate chain "
699 "(%d CA certificate%s)",
700 n, n == 1 ? "" : "s");
703 static void ssl_init_ctx(server_rec *s,
708 ssl_init_ctx_protocol(s, p, ptemp, mctx);
710 ssl_init_ctx_session_cache(s, p, ptemp, mctx);
712 ssl_init_ctx_callbacks(s, p, ptemp, mctx);
714 ssl_init_ctx_verify(s, p, ptemp, mctx);
716 ssl_init_ctx_cipher_suite(s, p, ptemp, mctx);
718 ssl_init_ctx_crl(s, p, ptemp, mctx);
721 /* XXX: proxy support? */
722 ssl_init_ctx_cert_chain(s, p, ptemp, mctx);
726 static int ssl_server_import_cert(server_rec *s,
731 SSLModConfigRec *mc = myModConfig(s);
734 const char *type = ssl_asn1_keystr(idx);
737 if (!(asn1 = ssl_asn1_table_get(mc->tPublicCert, id))) {
741 ap_log_error(APLOG_MARK, APLOG_DEBUG, 0, s,
742 "Configuring %s server certificate", type);
745 if (!(cert = d2i_X509(NULL, &ptr, asn1->nData))) {
746 ap_log_error(APLOG_MARK, APLOG_ERR, 0, s,
747 "Unable to import %s server certificate", type);
748 ssl_log_ssl_error(APLOG_MARK, APLOG_ERR, s);
752 if (SSL_CTX_use_certificate(mctx->ssl_ctx, cert) <= 0) {
753 ap_log_error(APLOG_MARK, APLOG_ERR, 0, s,
754 "Unable to configure %s server certificate", type);
755 ssl_log_ssl_error(APLOG_MARK, APLOG_ERR, s);
759 mctx->pks->certs[idx] = cert;
764 static int ssl_server_import_key(server_rec *s,
769 SSLModConfigRec *mc = myModConfig(s);
772 const char *type = ssl_asn1_keystr(idx);
773 int pkey_type = (idx == SSL_AIDX_RSA) ? EVP_PKEY_RSA : EVP_PKEY_DSA;
776 if (!(asn1 = ssl_asn1_table_get(mc->tPrivateKey, id))) {
780 ap_log_error(APLOG_MARK, APLOG_DEBUG, 0, s,
781 "Configuring %s server private key", type);
784 if (!(pkey = d2i_PrivateKey(pkey_type, NULL, &ptr, asn1->nData)))
786 ap_log_error(APLOG_MARK, APLOG_ERR, 0, s,
787 "Unable to import %s server private key", type);
788 ssl_log_ssl_error(APLOG_MARK, APLOG_ERR, s);
792 if (SSL_CTX_use_PrivateKey(mctx->ssl_ctx, pkey) <= 0) {
793 ap_log_error(APLOG_MARK, APLOG_ERR, 0, s,
794 "Unable to configure %s server private key", type);
795 ssl_log_ssl_error(APLOG_MARK, APLOG_ERR, s);
800 * XXX: wonder if this is still needed, this is old todo doc.
801 * (see http://www.psy.uq.edu.au/~ftp/Crypto/ssleay/TODO.html)
803 if ((pkey_type == EVP_PKEY_DSA) && mctx->pks->certs[idx]) {
804 EVP_PKEY *pubkey = X509_get_pubkey(mctx->pks->certs[idx]);
806 if (pubkey && EVP_PKEY_missing_parameters(pubkey)) {
807 EVP_PKEY_copy_parameters(pubkey, pkey);
808 ap_log_error(APLOG_MARK, APLOG_ERR, 0, s,
809 "Copying DSA parameters from private key to certificate");
810 ssl_log_ssl_error(APLOG_MARK, APLOG_ERR, s);
811 EVP_PKEY_free(pubkey);
815 mctx->pks->keys[idx] = pkey;
820 static void ssl_check_public_cert(server_rec *s,
833 * Some information about the certificate(s)
836 if (SSL_X509_isSGC(cert)) {
837 ap_log_error(APLOG_MARK, APLOG_INFO, 0, s,
838 "%s server certificate enables "
839 "Server Gated Cryptography (SGC)",
840 ssl_asn1_keystr(type));
843 if (SSL_X509_getBC(cert, &is_ca, &pathlen)) {
845 ap_log_error(APLOG_MARK, APLOG_WARNING, 0, s,
846 "%s server certificate is a CA certificate "
847 "(BasicConstraints: CA == TRUE !?)",
848 ssl_asn1_keystr(type));
852 ap_log_error(APLOG_MARK, APLOG_WARNING, 0, s,
853 "%s server certificate is not a leaf certificate "
854 "(BasicConstraints: pathlen == %d > 0 !?)",
855 ssl_asn1_keystr(type), pathlen);
859 if (SSL_X509_getCN(ptemp, cert, &cn)) {
860 int fnm_flags = FNM_PERIOD|FNM_CASE_BLIND;
862 if (apr_fnmatch_test(cn) &&
863 (apr_fnmatch(cn, s->server_hostname,
864 fnm_flags) == FNM_NOMATCH))
866 ap_log_error(APLOG_MARK, APLOG_WARNING, 0, s,
867 "%s server certificate wildcard CommonName (CN) `%s' "
868 "does NOT match server name!?",
869 ssl_asn1_keystr(type), cn);
871 else if (strNE(s->server_hostname, cn)) {
872 ap_log_error(APLOG_MARK, APLOG_WARNING, 0, s,
873 "%s server certificate CommonName (CN) `%s' "
874 "does NOT match server name!?",
875 ssl_asn1_keystr(type), cn);
880 static void ssl_init_server_certs(server_rec *s,
885 const char *rsa_id, *dsa_id;
886 const char *vhost_id = mctx->sc->vhost_id;
888 int have_rsa, have_dsa;
890 rsa_id = ssl_asn1_table_keyfmt(ptemp, vhost_id, SSL_AIDX_RSA);
891 dsa_id = ssl_asn1_table_keyfmt(ptemp, vhost_id, SSL_AIDX_DSA);
893 have_rsa = ssl_server_import_cert(s, mctx, rsa_id, SSL_AIDX_RSA);
894 have_dsa = ssl_server_import_cert(s, mctx, dsa_id, SSL_AIDX_DSA);
896 if (!(have_rsa || have_dsa)) {
897 ap_log_error(APLOG_MARK, APLOG_ERR, 0, s,
898 "Oops, no RSA or DSA server certificate found?!");
902 for (i = 0; i < SSL_AIDX_MAX; i++) {
903 ssl_check_public_cert(s, ptemp, mctx->pks->certs[i], i);
906 have_rsa = ssl_server_import_key(s, mctx, rsa_id, SSL_AIDX_RSA);
907 have_dsa = ssl_server_import_key(s, mctx, dsa_id, SSL_AIDX_DSA);
909 if (!(have_rsa || have_dsa)) {
910 ap_log_error(APLOG_MARK, APLOG_ERR, 0, s,
911 "Oops, no RSA or DSA server private key found?!");
916 static void ssl_init_proxy_certs(server_rec *s,
922 STACK_OF(X509_INFO) *sk;
923 modssl_pk_proxy_t *pkp = mctx->pkp;
925 SSL_CTX_set_client_cert_cb(mctx->ssl_ctx,
926 ssl_callback_proxy_cert);
928 if (!(pkp->cert_file || pkp->cert_path)) {
932 sk = sk_X509_INFO_new_null();
934 if (pkp->cert_file) {
935 SSL_X509_INFO_load_file(ptemp, sk, pkp->cert_file);
938 if (pkp->cert_path) {
939 SSL_X509_INFO_load_path(ptemp, sk, pkp->cert_path);
942 if ((ncerts = sk_X509_INFO_num(sk)) > 0) {
943 ap_log_error(APLOG_MARK, APLOG_DEBUG, 0, s,
944 "loaded %d client certs for SSL proxy",
950 ap_log_error(APLOG_MARK, APLOG_WARNING, 0, s,
951 "no client certs found for SSL proxy");
952 sk_X509_INFO_free(sk);
956 static void ssl_init_proxy_ctx(server_rec *s,
961 ssl_init_ctx(s, p, ptemp, sc->proxy);
963 ssl_init_proxy_certs(s, p, ptemp, sc->proxy);
966 static void ssl_init_server_ctx(server_rec *s,
971 ssl_init_server_check(s, p, ptemp, sc->server);
973 ssl_init_ctx(s, p, ptemp, sc->server);
975 ssl_init_server_certs(s, p, ptemp, sc->server);
979 * Configure a particular server
981 void ssl_init_ConfigureServer(server_rec *s,
986 /* A bit of a hack, but initialize the server if SSL is optional or
990 ap_log_error(APLOG_MARK, APLOG_INFO, 0, s,
991 "Configuring server for SSL protocol");
992 ssl_init_server_ctx(s, p, ptemp, sc);
995 if (sc->proxy_enabled) {
996 ssl_init_proxy_ctx(s, p, ptemp, sc);
1000 void ssl_init_CheckServers(server_rec *base_server, apr_pool_t *p)
1003 SSLSrvConfigRec *sc;
1008 BOOL conflict = FALSE;
1011 * Give out warnings when a server has HTTPS configured
1012 * for the HTTP port or vice versa
1014 for (s = base_server; s; s = s->next) {
1015 sc = mySrvConfig(s);
1017 if ((sc->enabled == TRUE) && (s->port == DEFAULT_HTTP_PORT)) {
1018 ap_log_error(APLOG_MARK, APLOG_WARNING, 0,
1020 "Init: (%s) You configured HTTPS(%d) "
1021 "on the standard HTTP(%d) port!",
1022 ssl_util_vhostid(p, s),
1023 DEFAULT_HTTPS_PORT, DEFAULT_HTTP_PORT);
1026 if (!sc->enabled && (s->port == DEFAULT_HTTPS_PORT)) {
1027 ap_log_error(APLOG_MARK, APLOG_WARNING, 0,
1029 "Init: (%s) You configured HTTP(%d) "
1030 "on the standard HTTPS(%d) port!",
1031 ssl_util_vhostid(p, s),
1032 DEFAULT_HTTP_PORT, DEFAULT_HTTPS_PORT);
1037 * Give out warnings when more than one SSL-aware virtual server uses the
1038 * same IP:port. This doesn't work because mod_ssl then will always use
1039 * just the certificate/keys of one virtual host (which one cannot be said
1040 * easily - but that doesn't matter here).
1042 table = apr_hash_make(p);
1044 for (s = base_server; s; s = s->next) {
1045 sc = mySrvConfig(s);
1047 if (!(sc->enabled && s->addrs)) {
1051 key = apr_psprintf(p, "%pA:%u",
1052 &s->addrs->host_addr, s->addrs->host_port);
1055 if ((ps = (server_rec *)apr_hash_get(table, key, klen))) {
1056 ap_log_error(APLOG_MARK, APLOG_WARNING, 0,
1058 "Init: SSL server IP/port conflict: "
1059 "%s (%s:%d) vs. %s (%s:%d)",
1060 ssl_util_vhostid(p, s),
1061 (s->defn_name ? s->defn_name : "unknown"),
1062 s->defn_line_number,
1063 ssl_util_vhostid(p, ps),
1064 (ps->defn_name ? ps->defn_name : "unknown"),
1065 ps->defn_line_number);
1070 apr_hash_set(table, key, klen, s);
1074 ap_log_error(APLOG_MARK, APLOG_WARNING, 0, base_server,
1075 "Init: You should not use name-based "
1076 "virtual hosts in conjunction with SSL!!");
1080 static int ssl_init_FindCAList_X509NameCmp(X509_NAME **a, X509_NAME **b)
1082 return(X509_NAME_cmp(*a, *b));
1085 static void ssl_init_PushCAList(STACK_OF(X509_NAME) *ca_list,
1086 server_rec *s, const char *file)
1089 STACK_OF(X509_NAME) *sk;
1091 sk = (STACK_OF(X509_NAME) *)SSL_load_client_CA_file(file);
1097 for (n = 0; n < sk_X509_NAME_num(sk); n++) {
1099 X509_NAME *name = sk_X509_NAME_value(sk, n);
1101 ap_log_error(APLOG_MARK, APLOG_DEBUG, 0, s,
1102 "CA certificate: %s",
1103 X509_NAME_oneline(name, name_buf, sizeof(name_buf)));
1106 * note that SSL_load_client_CA_file() checks for duplicates,
1107 * but since we call it multiple times when reading a directory
1108 * we must also check for duplicates ourselves.
1111 if (sk_X509_NAME_find(ca_list, name) < 0) {
1112 /* this will be freed when ca_list is */
1113 sk_X509_NAME_push(ca_list, name);
1116 /* need to free this ourselves, else it will leak */
1117 X509_NAME_free(name);
1121 sk_X509_NAME_free(sk);
1124 STACK_OF(X509_NAME) *ssl_init_FindCAList(server_rec *s,
1126 const char *ca_file,
1127 const char *ca_path)
1129 STACK_OF(X509_NAME) *ca_list;
1132 * Start with a empty stack/list where new
1133 * entries get added in sorted order.
1135 ca_list = sk_X509_NAME_new(ssl_init_FindCAList_X509NameCmp);
1138 * Process CA certificate bundle file
1141 ssl_init_PushCAList(ca_list, s, ca_file);
1145 * Process CA certificate path files
1149 apr_finfo_t direntry;
1150 apr_int32_t finfo_flags = APR_FINFO_TYPE|APR_FINFO_NAME;
1153 if ((rv = apr_dir_open(&dir, ca_path, ptemp)) != APR_SUCCESS) {
1154 ap_log_error(APLOG_MARK, APLOG_ERR, rv, s,
1155 "Failed to open SSLCACertificatePath `%s'",
1160 while ((apr_dir_read(&direntry, finfo_flags, dir)) == APR_SUCCESS) {
1162 if (direntry.filetype == APR_DIR) {
1163 continue; /* don't try to load directories */
1165 file = apr_pstrcat(ptemp, ca_path, "/", direntry.name, NULL);
1166 ssl_init_PushCAList(ca_list, s, file);
1175 sk_X509_NAME_set_cmp_func(ca_list, NULL);
1180 void ssl_init_Child(apr_pool_t *p, server_rec *s)
1182 SSLModConfigRec *mc = myModConfig(s);
1183 mc->pid = getpid(); /* only call getpid() once per-process */
1185 /* XXX: there should be an ap_srand() function */
1186 srand((unsigned int)time(NULL));
1188 /* open the mutex lockfile */
1189 ssl_mutex_reinit(s, p);
1192 #define MODSSL_CFG_ITEM_FREE(func, item) \
1198 static void ssl_init_ctx_cleanup(modssl_ctx_t *mctx)
1200 MODSSL_CFG_ITEM_FREE(X509_STORE_free, mctx->crl);
1202 MODSSL_CFG_ITEM_FREE(SSL_CTX_free, mctx->ssl_ctx);
1205 static void ssl_init_ctx_cleanup_proxy(modssl_ctx_t *mctx)
1207 ssl_init_ctx_cleanup(mctx);
1209 if (mctx->pkp->certs) {
1210 sk_X509_INFO_pop_free(mctx->pkp->certs, X509_INFO_free);
1214 static void ssl_init_ctx_cleanup_server(modssl_ctx_t *mctx)
1218 ssl_init_ctx_cleanup(mctx);
1220 for (i=0; i < SSL_AIDX_MAX; i++) {
1221 MODSSL_CFG_ITEM_FREE(X509_free,
1222 mctx->pks->certs[i]);
1224 MODSSL_CFG_ITEM_FREE(EVP_PKEY_free,
1225 mctx->pks->keys[i]);
1229 apr_status_t ssl_init_ModuleKill(void *data)
1231 SSLSrvConfigRec *sc;
1232 server_rec *base_server = (server_rec *)data;
1236 * Drop the session cache and mutex
1238 ssl_scache_kill(base_server);
1241 * Destroy the temporary keys and params
1243 ssl_tmp_keys_free(base_server);
1246 * Free the non-pool allocated structures
1247 * in the per-server configurations
1249 for (s = base_server; s; s = s->next) {
1250 sc = mySrvConfig(s);
1252 ssl_init_ctx_cleanup_proxy(sc->proxy);
1254 ssl_init_ctx_cleanup_server(sc->server);
1258 * Try to kill the internals of the SSL library.
1261 ERR_remove_state(0);