granicus.if.org Git - apache/blob - modules/ssl/mod_ssl.h

   1 /*                      _             _
   2 **  _ __ ___   ___   __| |    ___ ___| |  mod_ssl
   3 ** | '_ ` _ \ / _ \ / _` |   / __/ __| |  Apache Interface to OpenSSL
   4 ** | | | | | | (_) | (_| |   \__ \__ \ |  www.modssl.org
   5 ** |_| |_| |_|\___/ \__,_|___|___/___/_|  ftp.modssl.org
   6 **                      |_____|
   7 **  mod_ssl.h
   8 **  Global header
   9 */
  10
  11 /* ====================================================================
  12  * The Apache Software License, Version 1.1
  13  *
  14  * Copyright (c) 2000-2001 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                              /* ``The Apache Group: a collection
  60                                   of talented individuals who are
  61                                   trying to perfect the art of
  62                                   never finishing something.''
  63                                              -- Rob Hartill         */
  64 #ifndef __MOD_SSL_H__
  65 #define __MOD_SSL_H__
  66
  67 #define MOD_SSL_VERSION "3.0a0"
  68
  69 /*
  70  * Optionally enable the experimental stuff, but allow the user to
  71  * override the decision which experimental parts are included by using
  72  * CFLAGS="-DSSL_EXPERIMENTAL_xxxx_IGNORE".
  73  */
  74 #ifdef SSL_EXPERIMENTAL
  75 #ifndef SSL_EXPERIMENTAL_PERDIRCA_IGNORE
  76 #define SSL_EXPERIMENTAL_PERDIRCA
  77 #endif
  78 #ifndef SSL_EXPERIMENTAL_PROXY_IGNORE
  79 #define SSL_EXPERIMENTAL_PROXY
  80 #endif
  81 #ifdef SSL_ENGINE
  82 #ifndef SSL_EXPERIMENTAL_ENGINE_IGNORE
  83 #define SSL_EXPERIMENTAL_ENGINE
  84 #endif
  85 #endif
  86 #endif /* SSL_EXPERIMENTAL */
  87
  88 /*
  89  * Power up our brain...
  90  */
  91
  92 /* Apache headers */
  93 #include "httpd.h"
  94 #include "http_config.h"
  95 #include "http_core.h"
  96 #include "http_log.h"
  97 #include "http_main.h"
  98 #include "http_connection.h"
  99 #include "http_request.h"
 100 #include "http_protocol.h"
 101 #include "util_script.h"
 102 #include "util_filter.h"
 103 #include "mpm.h"
 104 #include "apr.h"
 105 #include "apr_strings.h"
 106 #include "apr_tables.h"
 107 #include "apr_lib.h"
 108 #include "apr_fnmatch.h"
 109 #include "apr_strings.h"
 110 #include "apr_dbm.h"
 111 #include "apr_optional.h"
 112
 113 /* OpenSSL headers */
 114 #include <ssl.h>
 115 #include <err.h>
 116 #include <x509.h>
 117 #include <x509v3.h>
 118 #include <pem.h>
 119 #include <crypto.h>
 120 #include <evp.h>
 121 #include <rand.h>
 122 #ifdef SSL_EXPERIMENTAL_ENGINE
 123 #include <engine.h>
 124 #endif
 125
 126 /* mod_ssl headers */
 127 #include "ssl_expr.h"
 128 #include "ssl_util_ssl.h"
 129 #include "ssl_util_table.h"
 130
 131 /* The #ifdef macros are only defined AFTER including the above
 132  * therefore we cannot include these system files at the top  :-(
 133  */
 134 #if APR_HAVE_SYS_TIME_H
 135 #include <sys/time.h>
 136 #endif
 137 #if APR_HAVE_UNISTD_H
 138 #include <unistd.h> /* needed for STDIN_FILENO et.al., at least on FreeBSD */
 139 #endif
 140
 141 /*
 142  * Provide reasonable default for some defines
 143  */
 144 #ifndef FALSE
 145 #define FALSE (0)
 146 #endif
 147 #ifndef TRUE
 148 #define TRUE (!FALSE)
 149 #endif
 150 #ifndef PFALSE
 151 #define PFALSE ((void *)FALSE)
 152 #endif
 153 #ifndef PTRUE
 154 #define PTRUE ((void *)TRUE)
 155 #endif
 156 #ifndef UNSET
 157 #define UNSET (-1)
 158 #endif
 159 #ifndef NUL
 160 #define NUL '\0'
 161 #endif
 162 #ifndef RAND_MAX
 163 #include <limits.h>
 164 #define RAND_MAX INT_MAX
 165 #endif
 166
 167 /*
 168  * Provide reasonable defines for some types
 169  */
 170 #ifndef BOOL
 171 #define BOOL unsigned int
 172 #endif
 173 #ifndef UCHAR
 174 #define UCHAR unsigned char
 175 #endif
 176
 177 /*
 178  * Provide useful shorthands
 179  */
 180 #define strEQ(s1,s2)     (strcmp(s1,s2)        == 0)
 181 #define strNE(s1,s2)     (strcmp(s1,s2)        != 0)
 182 #define strEQn(s1,s2,n)  (strncmp(s1,s2,n)     == 0)
 183 #define strNEn(s1,s2,n)  (strncmp(s1,s2,n)     != 0)
 184
 185 #define strcEQ(s1,s2)    (strcasecmp(s1,s2)    == 0)
 186 #define strcNE(s1,s2)    (strcasecmp(s1,s2)    != 0)
 187 #define strcEQn(s1,s2,n) (strncasecmp(s1,s2,n) == 0)
 188 #define strcNEn(s1,s2,n) (strncasecmp(s1,s2,n) != 0)
 189
 190 #define strIsEmpty(s)    (s == NULL || s[0] == NUL)
 191
 192 #define cfgMerge(el,unset)  new->el = (add->el == (unset)) ? base->el : add->el
 193 #define cfgMergeArray(el)   new->el = apr_array_append(p, add->el, base->el)
 194 #define cfgMergeTable(el)   new->el = apr_table_overlay(p, add->el, base->el)
 195 #define cfgMergeCtx(el)     new->el = apr_table_overlay(p, add->el, base->el)
 196 #define cfgMergeString(el)  cfgMerge(el, NULL)
 197 #define cfgMergeBool(el)    cfgMerge(el, UNSET)
 198 #define cfgMergeInt(el)     cfgMerge(el, UNSET)
 199
 200 #define myConnConfig(c) \
 201 (SSLConnRec *)ap_get_module_config(c->conn_config, &ssl_module)
 202 #define myConnConfigSet(c, val) \
 203 ap_set_module_config(c->conn_config, &ssl_module, val)
 204 #define mySrvConfig(srv) (SSLSrvConfigRec *)ap_get_module_config(srv->module_config,  &ssl_module)
 205 #define myDirConfig(req) (SSLDirConfigRec *)ap_get_module_config(req->per_dir_config, &ssl_module)
 206 #define myModConfig(srv) (mySrvConfig((srv)))->mc
 207
 208 #define myCtxVarSet(mc,num,val)  mc->rCtx.pV##num = val
 209 #define myCtxVarGet(mc,num,type) (type)(mc->rCtx.pV##num)
 210
 211 /*
 212  * SSL Logging
 213  */
 214 #define SSL_LOG_NONE    (1<<0)
 215 #define SSL_LOG_ERROR   (1<<1)
 216 #define SSL_LOG_WARN    (1<<2)
 217 #define SSL_LOG_INFO    (1<<3)
 218 #define SSL_LOG_TRACE   (1<<4)
 219 #define SSL_LOG_DEBUG   (1<<5)
 220 #define SSL_LOG_MASK    (SSL_LOG_ERROR|SSL_LOG_WARN|SSL_LOG_INFO|SSL_LOG_TRACE|SSL_LOG_DEBUG)
 221
 222 #define SSL_ADD_NONE     (1<<8)
 223 #define SSL_ADD_ERRNO    (1<<9)
 224 #define SSL_ADD_SSLERR   (1<<10)
 225 #define SSL_NO_TIMESTAMP (1<<11)
 226 #define SSL_NO_LEVELID   (1<<12)
 227 #define SSL_NO_NEWLINE   (1<<13)
 228
 229 /*
 230  * Defaults for the configuration
 231  */
 232 #ifndef SSL_SESSION_CACHE_TIMEOUT
 233 #define SSL_SESSION_CACHE_TIMEOUT  300
 234 #endif
 235
 236 /*
 237  * Support for MM library
 238  */
 239 #define SSL_MM_FILE_MODE ( APR_UREAD | APR_UWRITE | APR_GREAD | APR_WREAD )
 240
 241 /*
 242  * Support for DBM library
 243  */
 244 #define SSL_DBM_FILE_MODE ( APR_UREAD | APR_UWRITE | APR_GREAD | APR_WREAD )
 245
 246 #if !defined(SSL_DBM_FILE_SUFFIX_DIR) && !defined(SSL_DBM_FILE_SUFFIX_PAG)
 247 #if defined(DBM_SUFFIX)
 248 #define SSL_DBM_FILE_SUFFIX_DIR DBM_SUFFIX
 249 #define SSL_DBM_FILE_SUFFIX_PAG DBM_SUFFIX
 250 #elif defined(__FreeBSD__) || (defined(DB_LOCK) && defined(DB_SHMEM))
 251 #define SSL_DBM_FILE_SUFFIX_DIR ".db"
 252 #define SSL_DBM_FILE_SUFFIX_PAG ".db"
 253 #else
 254 #define SSL_DBM_FILE_SUFFIX_DIR ".dir"
 255 #define SSL_DBM_FILE_SUFFIX_PAG ".pag"
 256 #endif
 257 #endif
 258
 259 /*
 260  * Check for OpenSSL version
 261  */
 262 #if SSL_LIBRARY_VERSION < 0x00903100
 263 #error "mod_ssl requires OpenSSL 0.9.3 or higher"
 264 #endif
 265
 266 /*
 267  * The own data structures
 268  */
 269 typedef struct {
 270     apr_pool_t *pPool;
 271     apr_pool_t *pSubPool;
 272     apr_array_header_t *aData;
 273 } ssl_ds_array;
 274
 275 typedef struct {
 276     apr_pool_t *pPool;
 277     apr_pool_t *pSubPool;
 278     apr_array_header_t *aKey;
 279     apr_array_header_t *aData;
 280 } ssl_ds_table;
 281
 282 /*
 283  * Define the certificate algorithm types
 284  */
 285
 286 typedef int ssl_algo_t;
 287
 288 #define SSL_ALGO_UNKNOWN (0)
 289 #define SSL_ALGO_RSA     (1<<0)
 290 #define SSL_ALGO_DSA     (1<<1)
 291 #define SSL_ALGO_ALL     (SSL_ALGO_RSA|SSL_ALGO_DSA)
 292
 293 #define SSL_AIDX_RSA     (0)
 294 #define SSL_AIDX_DSA     (1)
 295 #define SSL_AIDX_MAX     (2)
 296
 297
 298 /*
 299  * Define IDs for the temporary RSA keys and DH params
 300  */
 301
 302 #define SSL_TKP_GEN        (0)
 303 #define SSL_TKP_ALLOC      (1)
 304 #define SSL_TKP_FREE       (2)
 305
 306 #define SSL_TKPIDX_RSA512  (0)
 307 #define SSL_TKPIDX_RSA1024 (1)
 308 #define SSL_TKPIDX_DH512   (2)
 309 #define SSL_TKPIDX_DH1024  (3)
 310 #define SSL_TKPIDX_MAX     (4)
 311
 312 /*
 313  * Define the SSL options
 314  */
 315 #define SSL_OPT_NONE           (0)
 316 #define SSL_OPT_RELSET         (1<<0)
 317 #define SSL_OPT_STDENVVARS     (1<<1)
 318 #define SSL_OPT_COMPATENVVARS  (1<<2)
 319 #define SSL_OPT_EXPORTCERTDATA (1<<3)
 320 #define SSL_OPT_FAKEBASICAUTH  (1<<4)
 321 #define SSL_OPT_STRICTREQUIRE  (1<<5)
 322 #define SSL_OPT_OPTRENEGOTIATE (1<<6)
 323 #define SSL_OPT_ALL            (SSL_OPT_STDENVVARS|SSL_OPT_COMPATENVVAR|SSL_OPT_EXPORTCERTDATA|SSL_OPT_FAKEBASICAUTH|SSL_OPT_STRICTREQUIRE|SSL_OPT_OPTRENEGOTIATE)
 324 typedef int ssl_opt_t;
 325
 326 /*
 327  * Define the SSL Protocol options
 328  */
 329 #define SSL_PROTOCOL_NONE  (0)
 330 #define SSL_PROTOCOL_SSLV2 (1<<0)
 331 #define SSL_PROTOCOL_SSLV3 (1<<1)
 332 #define SSL_PROTOCOL_TLSV1 (1<<2)
 333 #define SSL_PROTOCOL_ALL   (SSL_PROTOCOL_SSLV2|SSL_PROTOCOL_SSLV3|SSL_PROTOCOL_TLSV1)
 334 typedef int ssl_proto_t;
 335
 336 /*
 337  * Define the SSL verify levels
 338  */
 339 typedef enum {
 340     SSL_CVERIFY_UNSET           = UNSET,
 341     SSL_CVERIFY_NONE            = 0,
 342     SSL_CVERIFY_OPTIONAL        = 1,
 343     SSL_CVERIFY_REQUIRE         = 2,
 344     SSL_CVERIFY_OPTIONAL_NO_CA  = 3
 345 } ssl_verify_t;
 346
 347 #ifndef X509_V_ERR_CERT_UNTRUSTED
 348 #define X509_V_ERR_CERT_UNTRUSTED 27
 349
 350 #endif
 351
 352 #ifdef OPENSSL_VERSION_NUMBER
 353
 354 #define EVP_PKEY_key_type(k)              (EVP_PKEY_type(k->type))
 355
 356 #define X509_NAME_get_entries(xs)         (xs->entries)
 357 #define X509_REVOKED_get_serialNumber(xs) (xs->serialNumber)
 358
 359 #define X509_get_signature_algorithm(xs) (xs->cert_info->signature->algorithm)
 360 #define X509_get_key_algorithm(xs)       (xs->cert_info->key->algor->algorithm)
 361
 362 #define X509_NAME_ENTRY_get_data_ptr(xs) (xs->value->data)
 363 #define X509_NAME_ENTRY_get_data_len(xs) (xs->value->length)
 364
 365 #define SSL_CTX_get_extra_certs(ctx)       (ctx->extra_certs)
 366 #define SSL_CTX_set_extra_certs(ctx,value) {ctx->extra_certs = value;}
 367
 368 #define SSL_CIPHER_get_name(s)             (s->name)
 369 #define SSL_CIPHER_get_valid(s)            (s->valid)
 370
 371 #define SSL_SESSION_get_session_id(s)      (s->session_id)
 372 #define SSL_SESSION_get_session_id_length(s) (s->session_id_length)
 373
 374 /*
 375  * Support for retrieving/overriding states
 376  */
 377 #ifndef SSL_get_state
 378 #define SSL_get_state(ssl) SSL_state(ssl)
 379 #endif
 380
 381 #define SSL_set_state(ssl,val) (ssl)->state = val
 382
 383 #endif
 384
 385 #define ssl_verify_error_is_optional(errnum) \
 386    ((errnum == X509_V_ERR_DEPTH_ZERO_SELF_SIGNED_CERT) \
 387     || (errnum == X509_V_ERR_SELF_SIGNED_CERT_IN_CHAIN) \
 388     || (errnum == X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT_LOCALLY) \
 389     || (errnum == X509_V_ERR_CERT_UNTRUSTED) \
 390     || (errnum == X509_V_ERR_UNABLE_TO_VERIFY_LEAF_SIGNATURE))
 391
 392 /*
 393  * Define the SSL pass phrase dialog types
 394  */
 395 typedef enum {
 396     SSL_PPTYPE_UNSET   = UNSET,
 397     SSL_PPTYPE_BUILTIN = 0,
 398     SSL_PPTYPE_FILTER  = 1
 399 } ssl_pphrase_t;
 400
 401 /*
 402  * Define the Path Checking modes
 403  */
 404 #define SSL_PCM_EXISTS     1
 405 #define SSL_PCM_ISREG      2
 406 #define SSL_PCM_ISDIR      4
 407 #define SSL_PCM_ISNONZERO  8
 408 typedef unsigned int ssl_pathcheck_t;
 409
 410 /*
 411  * Define the SSL session cache modes and structures
 412  */
 413 typedef enum {
 414     SSL_SCMODE_UNSET = UNSET,
 415     SSL_SCMODE_NONE  = 0,
 416     SSL_SCMODE_DBM   = 1,
 417     SSL_SCMODE_SHMHT = 2,
 418     SSL_SCMODE_SHMCB = 3
 419 } ssl_scmode_t;
 420
 421 /*
 422  * Define the SSL mutex modes
 423  */
 424 typedef enum {
 425     SSL_MUTEXMODE_UNSET  = UNSET,
 426     SSL_MUTEXMODE_NONE   = 0,
 427     SSL_MUTEXMODE_USED   = 1
 428 } ssl_mutexmode_t;
 429
 430 /*
 431  * Define the SSL requirement structure
 432  */
 433 typedef struct {
 434     char     *cpExpr;
 435     ssl_expr *mpExpr;
 436 } ssl_require_t;
 437
 438 /*
 439  * Define the SSL random number generator seeding source
 440  */
 441 typedef enum {
 442     SSL_RSCTX_STARTUP = 1,
 443     SSL_RSCTX_CONNECT = 2
 444 } ssl_rsctx_t;
 445 typedef enum {
 446     SSL_RSSRC_BUILTIN = 1,
 447     SSL_RSSRC_FILE    = 2,
 448     SSL_RSSRC_EXEC    = 3
 449 #if SSL_LIBRARY_VERSION >= 0x00905100
 450    ,SSL_RSSRC_EGD     = 4
 451 #endif
 452 } ssl_rssrc_t;
 453 typedef struct {
 454     ssl_rsctx_t  nCtx;
 455     ssl_rssrc_t  nSrc;
 456     char        *cpPath;
 457     int          nBytes;
 458 } ssl_randseed_t;
 459
 460 /*
 461  * Define the structure of an ASN.1 anything
 462  */
 463 typedef struct {
 464     long int       nData;
 465     unsigned char *cpData;
 466 } ssl_asn1_t;
 467
 468 /*
 469  * Define the mod_ssl per-module configuration structure
 470  * (i.e. the global configuration for each httpd process)
 471  */
 472
 473 typedef struct {
 474     SSL                *pssl;
 475     BIO                *pbioRead;
 476     BIO                *pbioWrite;
 477     ap_filter_t        *pInputFilter;
 478     ap_filter_t        *pOutputFilter;
 479 } SSLFilterRec;
 480
 481 typedef enum {
 482     SSL_SHUTDOWN_TYPE_UNSET,
 483     SSL_SHUTDOWN_TYPE_STANDARD,
 484     SSL_SHUTDOWN_TYPE_UNCLEAN,
 485     SSL_SHUTDOWN_TYPE_ACCURATE
 486 } ssl_shutdown_type_e;
 487
 488 typedef struct {
 489     SSL *ssl;
 490     const char *client_dn;
 491     X509 *client_cert;
 492     ssl_shutdown_type_e shutdown_type;
 493     const char *verify_info;
 494     const char *verify_error;
 495     int verify_depth;
 496     int log_level; /* for avoiding expensive logging */
 497 } SSLConnRec;
 498
 499 #define SSLConnLogApplies(sslconn, level) (sslconn->log_level >= level)
 500
 501 typedef struct {
 502     pid_t           pid;
 503     apr_pool_t     *pPool;
 504     BOOL            bFixed;
 505     int             nInitCount;
 506     int             nSessionCacheMode;
 507     char           *szSessionCacheDataFile;
 508     int             nSessionCacheDataSize;
 509 #if 0 /* XXX */
 510     AP_MM          *pSessionCacheDataMM;
 511 #endif
 512     apr_table_t    *tSessionCacheDataTable;
 513     ssl_mutexmode_t nMutexMode;
 514     char           *szMutexFile;
 515     apr_lock_t     *pMutex;
 516     apr_array_header_t   *aRandSeed;
 517     int             nScoreboardSize; /* used for builtin random seed */
 518     ssl_ds_table   *tTmpKeys;
 519     void           *pTmpKeys[SSL_TKPIDX_MAX];
 520     ssl_ds_table   *tPublicCert;
 521     ssl_ds_table   *tPrivateKey;
 522 #ifdef SSL_EXPERIMENTAL_ENGINE
 523     char           *szCryptoDevice;
 524 #endif
 525     struct {
 526         void *pV1, *pV2, *pV3, *pV4, *pV5, *pV6, *pV7, *pV8, *pV9, *pV10;
 527     } rCtx;
 528 } SSLModConfigRec;
 529
 530 /*
 531  * Define the mod_ssl per-server configuration structure
 532  * (i.e. the configuration for the main server
 533  *  and all <VirtualHost> contexts)
 534  */
 535 typedef struct {
 536     SSLModConfigRec *mc;
 537     const char  *szVHostID;
 538     int          nVHostID_length;
 539     BOOL         bEnabled;
 540     apr_table_t *ap_server_ctx;
 541     const char  *szPublicCertFile[SSL_AIDX_MAX];
 542     const char  *szPrivateKeyFile[SSL_AIDX_MAX];
 543     const char  *szCertificateChain;
 544     const char  *szCACertificatePath;
 545     const char  *szCACertificateFile;
 546     const char  *szLogFile;
 547     const char  *szCipherSuite;
 548     apr_file_t  *fileLogFile;
 549     int          nLogLevel;
 550     int          nVerifyDepth;
 551     ssl_verify_t nVerifyClient;
 552     X509        *pPublicCert[SSL_AIDX_MAX];
 553     EVP_PKEY    *pPrivateKey[SSL_AIDX_MAX];
 554     SSL_CTX     *pSSLCtx;
 555     int          nSessionCacheTimeout;
 556     int          nPassPhraseDialogType;
 557     const char  *szPassPhraseDialogPath;
 558     ssl_proto_t  nProtocol;
 559     const char  *szCARevocationPath;
 560     const char  *szCARevocationFile;
 561     X509_STORE  *pRevocationStore;
 562 #ifdef SSL_EXPERIMENTAL_PROXY
 563     /* Configuration details for proxy operation */
 564     ssl_proto_t  nProxyProtocol;
 565     int          bProxyVerify;
 566     int          nProxyVerifyDepth;
 567     const char  *szProxyCACertificatePath;
 568     const char  *szProxyCACertificateFile;
 569     const char  *szProxyClientCertificateFile;
 570     const char  *szProxyClientCertificatePath;
 571     const char  *szProxyCipherSuite;
 572     SSL_CTX     *pSSLProxyCtx;
 573     STACK_OF(X509_INFO) *skProxyClientCerts;
 574 #endif
 575 } SSLSrvConfigRec;
 576
 577 /*
 578  * Define the mod_ssl per-directory configuration structure
 579  * (i.e. the local configuration for all <Directory>
 580  *  and .htaccess contexts)
 581  */
 582 typedef struct {
 583     BOOL          bSSLRequired;
 584     apr_array_header_t *aRequirement;
 585     ssl_opt_t     nOptions;
 586     ssl_opt_t     nOptionsAdd;
 587     ssl_opt_t     nOptionsDel;
 588     char         *szCipherSuite;
 589     ssl_verify_t  nVerifyClient;
 590     int           nVerifyDepth;
 591 #ifdef SSL_EXPERIMENTAL_PERDIRCA
 592     char         *szCACertificatePath;
 593     char         *szCACertificateFile;
 594 #endif
 595 } SSLDirConfigRec;
 596
 597 /*
 598  *  function prototypes
 599  */
 600
 601 /*  API glue structures  */
 602 extern module AP_MODULE_DECLARE_DATA ssl_module;
 603
 604 /*  configuration handling   */
 605 SSLModConfigRec *ssl_config_global_create(server_rec *);
 606 void         ssl_config_global_fix(SSLModConfigRec *);
 607 BOOL         ssl_config_global_isfixed(SSLModConfigRec *);
 608 void        *ssl_config_server_create(apr_pool_t *, server_rec *);
 609 void        *ssl_config_server_merge(apr_pool_t *, void *, void *);
 610 void        *ssl_config_perdir_create(apr_pool_t *, char *);
 611 void        *ssl_config_perdir_merge(apr_pool_t *, void *, void *);
 612 const char  *ssl_cmd_SSLMutex(cmd_parms *, void *, const char *);
 613 const char  *ssl_cmd_SSLPassPhraseDialog(cmd_parms *, void *, const char *);
 614 const char  *ssl_cmd_SSLCryptoDevice(cmd_parms *, void *, const char *);
 615 const char  *ssl_cmd_SSLRandomSeed(cmd_parms *, void *, const char *, const char *, const char *);
 616 const char  *ssl_cmd_SSLEngine(cmd_parms *, void *, int);
 617 const char  *ssl_cmd_SSLCipherSuite(cmd_parms *, void *, const char *);
 618 const char  *ssl_cmd_SSLCertificateFile(cmd_parms *, void *, const char *);
 619 const char  *ssl_cmd_SSLCertificateKeyFile(cmd_parms *, void *, const char *);
 620 const char  *ssl_cmd_SSLCertificateChainFile(cmd_parms *, void *, const char *);
 621 const char  *ssl_cmd_SSLCACertificatePath(cmd_parms *, void *, const char *);
 622 const char  *ssl_cmd_SSLCACertificateFile(cmd_parms *, void *, const char *);
 623 const char  *ssl_cmd_SSLCARevocationPath(cmd_parms *, void *, const char *);
 624 const char  *ssl_cmd_SSLCARevocationFile(cmd_parms *, void *, const char *);
 625 const char  *ssl_cmd_SSLVerifyClient(cmd_parms *, void *, const char *);
 626 const char  *ssl_cmd_SSLVerifyDepth(cmd_parms *, void *, const char *);
 627 const char  *ssl_cmd_SSLSessionCache(cmd_parms *, void *, const char *);
 628 const char  *ssl_cmd_SSLSessionCacheTimeout(cmd_parms *, void *, const char *);
 629 const char  *ssl_cmd_SSLLog(cmd_parms *, void *, const char *);
 630 const char  *ssl_cmd_SSLLogLevel(cmd_parms *, void *, const char *);
 631 const char  *ssl_cmd_SSLProtocol(cmd_parms *, void *, const char *);
 632 const char  *ssl_cmd_SSLOptions(cmd_parms *, void *, const char *);
 633 const char  *ssl_cmd_SSLRequireSSL(cmd_parms *, void *);
 634 const char  *ssl_cmd_SSLRequire(cmd_parms *, void *, const char *);
 635 #ifdef SSL_EXPERIMENTAL_PROXY
 636 const char  *ssl_cmd_SSLProxyProtocol(cmd_parms *, char *, const char *);
 637 const char  *ssl_cmd_SSLProxyCipherSuite(cmd_parms *, char *, char *);
 638 const char  *ssl_cmd_SSLProxyVerify(cmd_parms *, char *, int);
 639 const char  *ssl_cmd_SSLProxyVerifyDepth(cmd_parms *, char *, char *);
 640 const char  *ssl_cmd_SSLProxyCACertificatePath(cmd_parms *, char *, char *);
 641 const char  *ssl_cmd_SSLProxyCACertificateFile(cmd_parms *, char *, char *);
 642 const char  *ssl_cmd_SSLProxyMachineCertificatePath(cmd_parms *, char *, char *);
 643 const char  *ssl_cmd_SSLProxyMachineCertificateFile(cmd_parms *, char *, char *);
 644 #endif
 645
 646 /*  module initialization  */
 647 int          ssl_init_Module(apr_pool_t *, apr_pool_t *, apr_pool_t *, server_rec *);
 648 void         ssl_init_SSLLibrary(void);
 649 void         ssl_init_Engine(server_rec *, apr_pool_t *);
 650 void         ssl_init_TmpKeysHandle(int, server_rec *, apr_pool_t *);
 651 void         ssl_init_ConfigureServer(server_rec *, apr_pool_t *, SSLSrvConfigRec *);
 652 void         ssl_init_CheckServers(server_rec *, apr_pool_t *);
 653 STACK_OF(X509_NAME)
 654             *ssl_init_FindCAList(server_rec *, apr_pool_t *, const char *, const char *);
 655 void         ssl_init_Child(apr_pool_t *, server_rec *);
 656 apr_status_t ssl_init_ChildKill(void *data);
 657 apr_status_t ssl_init_ModuleKill(void *data);
 658
 659 /*  Apache API hooks  */
 660 void         ssl_hook_NewConnection(conn_rec *);
 661 void         ssl_hook_TimeoutConnection(int);
 662 int          ssl_hook_process_connection(SSLFilterRec *pRec);
 663 apr_status_t ssl_hook_CloseConnection(SSLFilterRec *);
 664 int          ssl_hook_Translate(request_rec *);
 665 int          ssl_hook_Auth(request_rec *);
 666 int          ssl_hook_UserCheck(request_rec *);
 667 int          ssl_hook_Access(request_rec *);
 668 int          ssl_hook_Fixup(request_rec *);
 669 int          ssl_hook_ReadReq(request_rec *);
 670 int          ssl_hook_Handler(request_rec *);
 671
 672 /*  OpenSSL callbacks */
 673 RSA         *ssl_callback_TmpRSA(SSL *, int, int);
 674 DH          *ssl_callback_TmpDH(SSL *, int, int);
 675 int          ssl_callback_SSLVerify(int, X509_STORE_CTX *);
 676 int          ssl_callback_SSLVerify_CRL(int, X509_STORE_CTX *, server_rec *);
 677 int          ssl_callback_NewSessionCacheEntry(SSL *, SSL_SESSION *);
 678 SSL_SESSION *ssl_callback_GetSessionCacheEntry(SSL *, unsigned char *, int, int *);
 679 void         ssl_callback_DelSessionCacheEntry(SSL_CTX *, SSL_SESSION *);
 680 #if SSL_LIBRARY_VERSION >= 0x00907000
 681 void         ssl_callback_LogTracingState(const SSL *, int, int);
 682 #else
 683 void         ssl_callback_LogTracingState(SSL *, int, int);
 684 #endif
 685
 686 /*  Session Cache Support  */
 687 void         ssl_scache_init(server_rec *, apr_pool_t *);
 688 #if 0 /* XXX */
 689 void         ssl_scache_status_register(apr_pool_t *p);
 690 #endif
 691 void         ssl_scache_kill(server_rec *);
 692 BOOL         ssl_scache_store(server_rec *, UCHAR *, int, time_t, SSL_SESSION *);
 693 SSL_SESSION *ssl_scache_retrieve(server_rec *, UCHAR *, int);
 694 void         ssl_scache_remove(server_rec *, UCHAR *, int);
 695 void         ssl_scache_expire(server_rec *);
 696 void         ssl_scache_status(server_rec *, apr_pool_t *, void (*)(char *, void *), void *);
 697 char        *ssl_scache_id2sz(UCHAR *, int);
 698 void         ssl_scache_dbm_init(server_rec *, apr_pool_t *);
 699 void         ssl_scache_dbm_kill(server_rec *);
 700 BOOL         ssl_scache_dbm_store(server_rec *, UCHAR *, int, time_t, SSL_SESSION *);
 701 SSL_SESSION *ssl_scache_dbm_retrieve(server_rec *, UCHAR *, int);
 702 void         ssl_scache_dbm_remove(server_rec *, UCHAR *, int);
 703 void         ssl_scache_dbm_expire(server_rec *);
 704 void         ssl_scache_dbm_status(server_rec *, apr_pool_t *, void (*)(char *, void *), void *);
 705 #if 0 /* XXX */
 706 void         ssl_scache_shmht_init(server_rec *, pool *);
 707 void         ssl_scache_shmht_kill(server_rec *);
 708 BOOL         ssl_scache_shmht_store(server_rec *, UCHAR *, int, time_t, SSL_SESSION *);
 709 SSL_SESSION *ssl_scache_shmht_retrieve(server_rec *, UCHAR *, int);
 710 void         ssl_scache_shmht_remove(server_rec *, UCHAR *, int);
 711 void         ssl_scache_shmht_expire(server_rec *);
 712 void         ssl_scache_shmht_status(server_rec *, pool *, void (*)(char *, void *), void *);
 713 void         ssl_scache_shmcb_init(server_rec *, pool *);
 714 void         ssl_scache_shmcb_kill(server_rec *);
 715 BOOL         ssl_scache_shmcb_store(server_rec *, UCHAR *, int, time_t, SSL_SESSION *);
 716 SSL_SESSION *ssl_scache_shmcb_retrieve(server_rec *, UCHAR *, int);
 717 void         ssl_scache_shmcb_remove(server_rec *, UCHAR *, int);
 718 void         ssl_scache_shmcb_expire(server_rec *);
 719 void         ssl_scache_shmcb_status(server_rec *, pool *, void (*)(char *, void *), void *);
 720 #endif
 721
 722 /*  Pass Phrase Support  */
 723 void         ssl_pphrase_Handle(server_rec *, apr_pool_t *);
 724 int          ssl_pphrase_Handle_CB(char *, int, int, void *);
 725
 726 /*  Diffie-Hellman Parameter Support  */
 727 DH           *ssl_dh_GetTmpParam(int);
 728 DH           *ssl_dh_GetParamFromFile(char *);
 729
 730 /*  Data Structures */
 731 ssl_ds_array *ssl_ds_array_make(apr_pool_t *, int);
 732 BOOL          ssl_ds_array_isempty(ssl_ds_array *);
 733 void         *ssl_ds_array_push(ssl_ds_array *);
 734 void         *ssl_ds_array_get(ssl_ds_array *, int);
 735 void          ssl_ds_array_wipeout(ssl_ds_array *);
 736 void          ssl_ds_array_kill(ssl_ds_array *);
 737 ssl_ds_table *ssl_ds_table_make(apr_pool_t *, int);
 738 BOOL          ssl_ds_table_isempty(ssl_ds_table *);
 739 void         *ssl_ds_table_push(ssl_ds_table *, char *);
 740 void         *ssl_ds_table_get(ssl_ds_table *, char *);
 741 void          ssl_ds_table_wipeout(ssl_ds_table *);
 742 void          ssl_ds_table_kill(ssl_ds_table *);
 743
 744 /*  Mutex Support  */
 745 int          ssl_mutex_init(server_rec *, apr_pool_t *);
 746 int          ssl_mutex_reinit(server_rec *, apr_pool_t *);
 747 int          ssl_mutex_on(server_rec *);
 748 int          ssl_mutex_off(server_rec *);
 749
 750 /*  Logfile Support  */
 751 void         ssl_log_open(server_rec *, server_rec *, apr_pool_t *);
 752 void         ssl_log(server_rec *, int, const char *, ...);
 753 void         ssl_die(void);
 754
 755 /*  Variables  */
 756 void         ssl_var_register(void);
 757 char        *ssl_var_lookup(apr_pool_t *, server_rec *, conn_rec *, request_rec *, char *);
 758 void         ssl_var_log_config_register(apr_pool_t *p);
 759
 760 APR_DECLARE_OPTIONAL_FN(char *, ssl_var_lookup,
 761                         (apr_pool_t *, server_rec *,
 762                          conn_rec *, request_rec *,
 763                          char *));
 764
 765 /*  Proxy Extensions  */
 766 #if 0 /* XXX */
 767 void         ssl_ext_proxy_register(apr_pool_t *p);
 768 #endif /* -0- */
 769
 770 /*  I/O  */
 771 void         ssl_io_filter_init(conn_rec *, SSL *);
 772 void         ssl_io_filter_register(apr_pool_t *);
 773 long         ssl_io_data_cb(BIO *, int, const char *, int, long, long);
 774
 775 /*  PRNG  */
 776 int          ssl_rand_seed(server_rec *, apr_pool_t *, ssl_rsctx_t, char *);
 777
 778 /*  Utility Functions  */
 779 char        *ssl_util_vhostid(apr_pool_t *, server_rec *);
 780 void         ssl_util_strupper(char *);
 781 void         ssl_util_uuencode(char *, const char *, BOOL);
 782 void         ssl_util_uuencode_binary(unsigned char *, const unsigned char *, int, BOOL);
 783 apr_file_t  *ssl_util_ppopen(server_rec *, apr_pool_t *, const char *,
 784                              const char * const *);
 785 void         ssl_util_ppclose(server_rec *, apr_pool_t *, apr_file_t *);
 786 char        *ssl_util_readfilter(server_rec *, apr_pool_t *, const char *,
 787                                  const char * const *);
 788 BOOL         ssl_util_path_check(ssl_pathcheck_t, const char *, apr_pool_t *);
 789 ssl_algo_t   ssl_util_algotypeof(X509 *, EVP_PKEY *);
 790 char        *ssl_util_algotypestr(ssl_algo_t);
 791 char        *ssl_util_ptxtsub(apr_pool_t *, const char *, const char *, char *);
 792 void         ssl_util_thread_setup(server_rec *, apr_pool_t *);
 793
 794 #endif /* __MOD_SSL_H__ */