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