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