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