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 1
  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 #if 0 /* XXX */
  73 #ifdef SSL_EXPERIMENTAL
  74 #ifndef SSL_EXPERIMENTAL_PERDIRCA_IGNORE
  75 #define SSL_EXPERIMENTAL_PERDIRCA
  76 #endif
  77 #ifndef SSL_EXPERIMENTAL_PROXY_IGNORE
  78 #define SSL_EXPERIMENTAL_PROXY
  79 #endif
  80 #ifdef SSL_ENGINE
  81 #ifndef SSL_EXPERIMENTAL_ENGINE_IGNORE
  82 #define SSL_EXPERIMENTAL_ENGINE
  83 #endif
  84 #endif
  85 #endif /* SSL_EXPERIMENTAL */
  86 #endif /* XXX */
  87
  88 /*
  89  * Power up our brain...
  90  */
  91
  92 /* OS headers */
  93 #include <stdio.h>
  94 #include <stdlib.h>
  95 #include <stdarg.h>
  96 #include <errno.h>
  97 #include <sys/types.h>
  98 #include <sys/stat.h>
  99 #include <time.h>
 100 #ifndef WIN32
 101 #include <sys/time.h>
 102 #endif
 103 #ifdef WIN32
 104 #include <wincrypt.h>
 105 #include <winsock2.h>
 106 #endif
 107
 108 /* OpenSSL headers */
 109 #include <openssl/ssl.h>
 110 #include <openssl/err.h>
 111 #include <openssl/x509.h>
 112 #include <openssl/x509v3.h>
 113 #include <openssl/pem.h>
 114 #include <openssl/crypto.h>
 115 #include <openssl/evp.h>
 116 #include <openssl/rand.h>
 117 #ifdef SSL_EXPERIMENTAL_ENGINE
 118 #include <openssl/engine.h>
 119 #endif
 120
 121 /* Apache headers */
 122 #define CORE_PRIVATE
 123 #include "ap_config.h"
 124 #include "httpd.h"
 125 #include "http_config.h"
 126 #include "http_protocol.h"
 127 #include "http_request.h"
 128 #include "http_main.h"
 129 #include "http_core.h"
 130 #include "http_log.h"
 131 #include "scoreboard.h"
 132 #include "util_md5.h"
 133 #include "apr_fnmatch.h"
 134 #undef CORE_PRIVATE
 135
 136 /* mod_ssl headers */
 137 #if 0 /* XXX */
 138 #include "ssl_expr.h"
 139 #include "ssl_util_ssl.h"
 140 #include "ssl_util_table.h"
 141 #endif /* XXX */
 142
 143 /*
 144  * Provide reasonable default for some defines
 145  */
 146 #ifndef FALSE
 147 #define FALSE (0)
 148 #endif
 149 #ifndef TRUE
 150 #define TRUE (!FALSE)
 151 #endif
 152 #ifndef PFALSE
 153 #define PFALSE ((void *)FALSE)
 154 #endif
 155 #ifndef PTRUE
 156 #define PTRUE ((void *)TRUE)
 157 #endif
 158 #ifndef UNSET
 159 #define UNSET (-1)
 160 #endif
 161 #ifndef NUL
 162 #define NUL '\0'
 163 #endif
 164 #ifndef RAND_MAX
 165 #include <limits.h>
 166 #define RAND_MAX INT_MAX
 167 #endif
 168
 169 /*
 170  * Provide reasonable defines for some types
 171  */
 172 #ifndef BOOL
 173 #define BOOL unsigned int
 174 #endif
 175 #ifndef UCHAR
 176 #define UCHAR unsigned char
 177 #endif
 178
 179 /*
 180  * Provide useful shorthands
 181  */
 182 #define strEQ(s1,s2)     (strcmp(s1,s2)        == 0)
 183 #define strNE(s1,s2)     (strcmp(s1,s2)        != 0)
 184 #define strEQn(s1,s2,n)  (strncmp(s1,s2,n)     == 0)
 185 #define strNEn(s1,s2,n)  (strncmp(s1,s2,n)     != 0)
 186
 187 #define strcEQ(s1,s2)    (strcasecmp(s1,s2)    == 0)
 188 #define strcNE(s1,s2)    (strcasecmp(s1,s2)    != 0)
 189 #define strcEQn(s1,s2,n) (strncasecmp(s1,s2,n) == 0)
 190 #define strcNEn(s1,s2,n) (strncasecmp(s1,s2,n) != 0)
 191
 192 #define strIsEmpty(s)    (s == NULL || s[0] == NUL)
 193
 194 #if 0 /* XXX */
 195 #define cfgMerge(el,unset)  new->el = add->el == unset ? base->el : add->el
 196 #define cfgMergeArray(el)   new->el = ap_append_arrays(p, add->el, base->el)
 197 #define cfgMergeTable(el)   new->el = ap_overlay_tables(p, add->el, base->el)
 198 #define cfgMergeCtx(el)     new->el = ap_ctx_overlay(p, add->el, base->el)
 199 #define cfgMergeString(el)  cfgMerge(el, NULL)
 200 #define cfgMergeBool(el)    cfgMerge(el, UNSET)
 201 #define cfgMergeInt(el)     cfgMerge(el, UNSET)
 202
 203 #define myModConfig()    (SSLModConfigRec *)ap_ctx_get(ap_global_ctx, "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 #endif /* XXX */
 210
 211 #define AP_ALL_CMD(name, args, desc) \
 212         { "SSL"#name, ssl_cmd_SSL##name, NULL, RSRC_CONF|OR_AUTHCFG, args, desc },
 213 #define AP_SRV_CMD(name, args, desc) \
 214         { "SSL"#name, ssl_cmd_SSL##name, NULL, RSRC_CONF, args, desc },
 215 #define AP_DIR_CMD(name, type, args, desc) \
 216         { "SSL"#name, ssl_cmd_SSL##name, NULL, OR_##type, args, desc },
 217 #define AP_END_CMD \
 218         { NULL }
 219
 220 #if 0 /* XXX */
 221 /*
 222  * SSL Logging
 223  */
 224 #define SSL_LOG_NONE    (1<<0)
 225 #define SSL_LOG_ERROR   (1<<1)
 226 #define SSL_LOG_WARN    (1<<2)
 227 #define SSL_LOG_INFO    (1<<3)
 228 #define SSL_LOG_TRACE   (1<<4)
 229 #define SSL_LOG_DEBUG   (1<<5)
 230 #define SSL_LOG_MASK    (SSL_LOG_ERROR|SSL_LOG_WARN|SSL_LOG_INFO|SSL_LOG_TRACE|SSL_LOG_DEBUG)
 231
 232 #define SSL_ADD_NONE     (1<<8)
 233 #define SSL_ADD_ERRNO    (1<<9)
 234 #define SSL_ADD_SSLERR   (1<<10)
 235 #define SSL_NO_TIMESTAMP (1<<11)
 236 #define SSL_NO_LEVELID   (1<<12)
 237 #define SSL_NO_NEWLINE   (1<<13)
 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 file locking: Try to determine whether we should use fcntl() or
 248  * flock().  Would be better ap_config.h could provide this... :-(
 249   */
 250 #if defined(USE_FCNTL_SERIALIZED_ACCEPT)
 251 #define SSL_USE_FCNTL 1
 252 #include <fcntl.h>
 253 #endif
 254 #if defined(USE_FLOCK_SERIALIZED_ACCEPT)
 255 #define SSL_USE_FLOCK 1
 256 #include <sys/file.h>
 257 #endif
 258 #if !defined(SSL_USE_FCNTL) && !defined(SSL_USE_FLOCK)
 259 #define SSL_USE_FLOCK 1
 260 #if !defined(MPE) && !defined(WIN32)
 261 #include <sys/file.h>
 262 #endif
 263 #ifndef LOCK_UN
 264 #undef SSL_USE_FLOCK
 265 #define SSL_USE_FCNTL 1
 266 #include <fcntl.h>
 267 #endif
 268 #endif
 269 #ifdef AIX
 270 #undef SSL_USE_FLOCK
 271 #define SSL_USE_FCNTL 1
 272 #include <fcntl.h>
 273 #endif
 274
 275 /*
 276  * Support for Mutex
 277  */
 278 #ifndef WIN32
 279 #define SSL_MUTEX_LOCK_MODE ( S_IRUSR|S_IWUSR )
 280 #else
 281 #define SSL_MUTEX_LOCK_MODE (_S_IREAD|_S_IWRITE )
 282 #endif
 283 #if defined(USE_SYSVSEM_SERIALIZED_ACCEPT) ||\
 284     (defined(__FreeBSD__) && defined(__FreeBSD_version) &&\
 285      __FreeBSD_version >= 300000) ||\
 286     (defined(LINUX) && defined(__GLIBC__) && defined(__GLIBC_MINOR__) &&\
 287      LINUX >= 2 && __GLIBC__ >= 2 && __GLIBC_MINOR__ >= 1) ||\
 288     defined(SOLARIS2) || defined(__hpux) ||\
 289     (defined (__digital__) && defined (__unix__))
 290 #define SSL_CAN_USE_SEM
 291 #define SSL_HAVE_IPCSEM
 292 #include <sys/types.h>
 293 #include <sys/ipc.h>
 294 #include <sys/sem.h>
 295 /*
 296  * Some platforms have a `union semun' pre-defined but Single Unix
 297  * Specification (SUSv2) says in semctl(2): `If required, it is of
 298  * type union semun, which the application program must explicitly
 299  * declare'. So we define it always ourself to avoid problems (but under
 300  * a different name to avoid a namespace clash).
 301  */
 302 union ssl_ipc_semun {
 303     long val;
 304     struct semid_ds *buf;
 305     unsigned short int *array;
 306 };
 307 #endif
 308 #ifdef WIN32
 309 #define SSL_CAN_USE_SEM
 310 #define SSL_HAVE_W32SEM
 311 #include "multithread.h"
 312 #include <process.h>
 313 #endif
 314
 315 /*
 316  * Support for MM library
 317  */
 318 #ifndef WIN32
 319 #define SSL_MM_FILE_MODE ( S_IRUSR|S_IWUSR )
 320 #else
 321 #define SSL_MM_FILE_MODE ( _S_IREAD|_S_IWRITE )
 322 #endif
 323
 324 /*
 325  * Support for DBM library
 326  */
 327 #ifndef WIN32
 328 #define SSL_DBM_FILE_MODE ( S_IRUSR|S_IWUSR )
 329 #else
 330 #define SSL_USE_SDBM
 331 #define SSL_DBM_FILE_MODE ( _S_IREAD|_S_IWRITE )
 332 #endif
 333
 334 #ifdef SSL_USE_SDBM
 335 #include "ssl_util_sdbm.h"
 336 #define ssl_dbm_open     sdbm_open
 337 #define ssl_dbm_close    sdbm_close
 338 #define ssl_dbm_store    sdbm_store
 339 #define ssl_dbm_fetch    sdbm_fetch
 340 #define ssl_dbm_delete   sdbm_delete
 341 #define ssl_dbm_firstkey sdbm_firstkey
 342 #define ssl_dbm_nextkey  sdbm_nextkey
 343 #define SSL_DBM_FILE_SUFFIX_DIR ".dir"
 344 #define SSL_DBM_FILE_SUFFIX_PAG ".pag"
 345 #else /* !SSL_USE_SDBM */
 346 #if defined(__GLIBC__) && defined(__GLIBC_MINOR__) \
 347     && __GLIBC__ >= 2 && __GLIBC_MINOR__ >= 1
 348 #include <db1/ndbm.h>
 349 #else
 350 #include <ndbm.h>
 351 #endif
 352 #define ssl_dbm_open     dbm_open
 353 #define ssl_dbm_close    dbm_close
 354 #define ssl_dbm_store    dbm_store
 355 #define ssl_dbm_fetch    dbm_fetch
 356 #define ssl_dbm_delete   dbm_delete
 357 #define ssl_dbm_firstkey dbm_firstkey
 358 #define ssl_dbm_nextkey  dbm_nextkey
 359 #if !defined(SSL_DBM_FILE_SUFFIX_DIR) && !defined(SSL_DBM_FILE_SUFFIX_PAG)
 360 #if defined(DBM_SUFFIX)
 361 #define SSL_DBM_FILE_SUFFIX_DIR DBM_SUFFIX
 362 #define SSL_DBM_FILE_SUFFIX_PAG DBM_SUFFIX
 363 #elif defined(__FreeBSD__) || (defined(DB_LOCK) && defined(DB_SHMEM))
 364 #define SSL_DBM_FILE_SUFFIX_DIR ".db"
 365 #define SSL_DBM_FILE_SUFFIX_PAG ".db"
 366 #else
 367 #define SSL_DBM_FILE_SUFFIX_DIR ".dir"
 368 #define SSL_DBM_FILE_SUFFIX_PAG ".pag"
 369 #endif
 370 #endif
 371 #endif /* !SSL_USE_SDBM */
 372
 373 /*
 374  * Check for OpenSSL version
 375  */
 376 #if SSL_LIBRARY_VERSION < 0x00903100
 377 #error "mod_ssl requires OpenSSL 0.9.3 or higher"
 378 #endif
 379
 380 /*
 381  * The own data structures
 382  */
 383 typedef struct {
 384     pool *pPool;
 385     pool *pSubPool;
 386     array_header *aData;
 387 } ssl_ds_array;
 388
 389 typedef struct {
 390     pool *pPool;
 391     pool *pSubPool;
 392     array_header *aKey;
 393     array_header *aData;
 394 } ssl_ds_table;
 395
 396 /*
 397  * Define the certificate algorithm types
 398  */
 399
 400 typedef int ssl_algo_t;
 401
 402 #define SSL_ALGO_UNKNOWN (0)
 403 #define SSL_ALGO_RSA     (1<<0)
 404 #define SSL_ALGO_DSA     (1<<1)
 405 #define SSL_ALGO_ALL     (SSL_ALGO_RSA|SSL_ALGO_DSA)
 406
 407 #define SSL_AIDX_RSA     (0)
 408 #define SSL_AIDX_DSA     (1)
 409 #define SSL_AIDX_MAX     (2)
 410
 411 /*
 412  * Define IDs for the temporary RSA keys and DH params
 413  */
 414
 415 #define SSL_TKP_GEN        (0)
 416 #define SSL_TKP_ALLOC      (1)
 417 #define SSL_TKP_FREE       (2)
 418
 419 #define SSL_TKPIDX_RSA512  (0)
 420 #define SSL_TKPIDX_RSA1024 (1)
 421 #define SSL_TKPIDX_DH512   (2)
 422 #define SSL_TKPIDX_DH1024  (3)
 423 #define SSL_TKPIDX_MAX     (4)
 424
 425 /*
 426  * Define the SSL options
 427  */
 428 #define SSL_OPT_NONE           (0)
 429 #define SSL_OPT_RELSET         (1<<0)
 430 #define SSL_OPT_STDENVVARS     (1<<1)
 431 #define SSL_OPT_COMPATENVVARS  (1<<2)
 432 #define SSL_OPT_EXPORTCERTDATA (1<<3)
 433 #define SSL_OPT_FAKEBASICAUTH  (1<<4)
 434 #define SSL_OPT_STRICTREQUIRE  (1<<5)
 435 #define SSL_OPT_OPTRENEGOTIATE (1<<6)
 436 #define SSL_OPT_ALL            (SSL_OPT_STDENVVARS|SSL_OPT_COMPATENVVAR|SSL_OPT_EXPORTCERTDATA|SSL_OPT_FAKEBASICAUTH|SSL_OPT_STRICTREQUIRE|SSL_OPT_OPTRENEGOTIATE)
 437 typedef int ssl_opt_t;
 438
 439 /*
 440  * Define the SSL Protocol options
 441  */
 442 #define SSL_PROTOCOL_NONE  (0)
 443 #define SSL_PROTOCOL_SSLV2 (1<<0)
 444 #define SSL_PROTOCOL_SSLV3 (1<<1)
 445 #define SSL_PROTOCOL_TLSV1 (1<<2)
 446 #define SSL_PROTOCOL_ALL   (SSL_PROTOCOL_SSLV2|SSL_PROTOCOL_SSLV3|SSL_PROTOCOL_TLSV1)
 447 typedef int ssl_proto_t;
 448
 449 /*
 450  * Define the SSL verify levels
 451  */
 452 typedef enum {
 453     SSL_CVERIFY_UNSET           = UNSET,
 454     SSL_CVERIFY_NONE            = 0,
 455     SSL_CVERIFY_OPTIONAL        = 1,
 456     SSL_CVERIFY_REQUIRE         = 2,
 457     SSL_CVERIFY_OPTIONAL_NO_CA  = 3
 458 } ssl_verify_t;
 459
 460 /*
 461  * Define the SSL pass phrase dialog types
 462  */
 463 typedef enum {
 464     SSL_PPTYPE_UNSET   = UNSET,
 465     SSL_PPTYPE_BUILTIN = 0,
 466     SSL_PPTYPE_FILTER  = 1
 467 } ssl_pphrase_t;
 468
 469 /*
 470  * Define the Path Checking modes
 471  */
 472 #define SSL_PCM_EXISTS     1
 473 #define SSL_PCM_ISREG      2
 474 #define SSL_PCM_ISDIR      4
 475 #define SSL_PCM_ISNONZERO  8
 476 typedef unsigned int ssl_pathcheck_t;
 477
 478 /*
 479  * Define the SSL session cache modes and structures
 480  */
 481 typedef enum {
 482     SSL_SCMODE_UNSET = UNSET,
 483     SSL_SCMODE_NONE  = 0,
 484     SSL_SCMODE_DBM   = 1,
 485     SSL_SCMODE_SHMHT = 2,
 486     SSL_SCMODE_SHMCB = 3
 487 } ssl_scmode_t;
 488
 489 /*
 490  * Define the SSL mutex modes
 491  */
 492 typedef enum {
 493     SSL_MUTEXMODE_UNSET  = UNSET,
 494     SSL_MUTEXMODE_NONE   = 0,
 495     SSL_MUTEXMODE_FILE   = 1,
 496     SSL_MUTEXMODE_SEM    = 2
 497 } ssl_mutexmode_t;
 498
 499 /*
 500  * Define the SSL requirement structure
 501  */
 502 typedef struct {
 503     char     *cpExpr;
 504     ssl_expr *mpExpr;
 505 } ssl_require_t;
 506
 507 /*
 508  * Define the SSL random number generator seeding source
 509  */
 510 typedef enum {
 511     SSL_RSCTX_STARTUP = 1,
 512     SSL_RSCTX_CONNECT = 2
 513 } ssl_rsctx_t;
 514 typedef enum {
 515     SSL_RSSRC_BUILTIN = 1,
 516     SSL_RSSRC_FILE    = 2,
 517     SSL_RSSRC_EXEC    = 3
 518 #if SSL_LIBRARY_VERSION >= 0x00905100
 519    ,SSL_RSSRC_EGD     = 4
 520 #endif
 521 } ssl_rssrc_t;
 522 typedef struct {
 523     ssl_rsctx_t  nCtx;
 524     ssl_rssrc_t  nSrc;
 525     char        *cpPath;
 526     int          nBytes;
 527 } ssl_randseed_t;
 528
 529 /*
 530  * Define the structure of an ASN.1 anything
 531  */
 532 typedef struct {
 533     long int       nData;
 534     unsigned char *cpData;
 535 } ssl_asn1_t;
 536
 537 /*
 538  * Define the mod_ssl per-module configuration structure
 539  * (i.e. the global configuration for each httpd process)
 540  */
 541
 542 typedef struct {
 543     pool           *pPool;
 544     BOOL            bFixed;
 545     int             nInitCount;
 546     int             nSessionCacheMode;
 547     char           *szSessionCacheDataFile;
 548     int             nSessionCacheDataSize;
 549     AP_MM          *pSessionCacheDataMM;
 550     table_t        *tSessionCacheDataTable;
 551     ssl_mutexmode_t nMutexMode;
 552     char           *szMutexFile;
 553     int             nMutexFD;
 554     int             nMutexSEMID;
 555     array_header   *aRandSeed;
 556     ssl_ds_table   *tTmpKeys;
 557     void           *pTmpKeys[SSL_TKPIDX_MAX];
 558     ssl_ds_table   *tPublicCert;
 559     ssl_ds_table   *tPrivateKey;
 560 #ifdef SSL_EXPERIMENTAL_ENGINE
 561     char           *szCryptoDevice;
 562 #endif
 563     struct {
 564         void *pV1, *pV2, *pV3, *pV4, *pV5, *pV6, *pV7, *pV8, *pV9, *pV10;
 565     } rCtx;
 566 #ifdef SSL_VENDOR
 567     ap_ctx         *ctx;
 568 #endif
 569 } SSLModConfigRec;
 570
 571 /*
 572  * Define the mod_ssl per-server configuration structure
 573  * (i.e. the configuration for the main server
 574  *  and all <VirtualHost> contexts)
 575  */
 576 typedef struct {
 577     BOOL         bEnabled;
 578     char        *szPublicCertFile[SSL_AIDX_MAX];
 579     char        *szPrivateKeyFile[SSL_AIDX_MAX];
 580     char        *szCertificateChain;
 581     char        *szCACertificatePath;
 582     char        *szCACertificateFile;
 583     char        *szLogFile;
 584     char        *szCipherSuite;
 585     FILE        *fileLogFile;
 586     int          nLogLevel;
 587     int          nVerifyDepth;
 588     ssl_verify_t nVerifyClient;
 589     X509        *pPublicCert[SSL_AIDX_MAX];
 590     EVP_PKEY    *pPrivateKey[SSL_AIDX_MAX];
 591     SSL_CTX     *pSSLCtx;
 592     int          nSessionCacheTimeout;
 593     int          nPassPhraseDialogType;
 594     char        *szPassPhraseDialogPath;
 595     ssl_proto_t  nProtocol;
 596     char        *szCARevocationPath;
 597     char        *szCARevocationFile;
 598     X509_STORE  *pRevocationStore;
 599 #ifdef SSL_EXPERIMENTAL_PROXY
 600     /* Configuration details for proxy operation */
 601     ssl_proto_t  nProxyProtocol;
 602     int          bProxyVerify;
 603     int          nProxyVerifyDepth;
 604     char        *szProxyCACertificatePath;
 605     char        *szProxyCACertificateFile;
 606     char        *szProxyClientCertificateFile;
 607     char        *szProxyClientCertificatePath;
 608     char        *szProxyCipherSuite;
 609     SSL_CTX     *pSSLProxyCtx;
 610     STACK_OF(X509_INFO) *skProxyClientCerts;
 611 #endif
 612 #ifdef SSL_VENDOR
 613     ap_ctx      *ctx;
 614 #endif
 615 } SSLSrvConfigRec;
 616
 617 /*
 618  * Define the mod_ssl per-directory configuration structure
 619  * (i.e. the local configuration for all <Directory>
 620  *  and .htaccess contexts)
 621  */
 622 #endif /* XXX */
 623 typedef struct {
 624 #if 0 /* XXX */
 625     BOOL          bSSLRequired;
 626     array_header *aRequirement;
 627     ssl_opt_t     nOptions;
 628     ssl_opt_t     nOptionsAdd;
 629     ssl_opt_t     nOptionsDel;
 630     char         *szCipherSuite;
 631     ssl_verify_t  nVerifyClient;
 632     int           nVerifyDepth;
 633 #ifdef SSL_EXPERIMENTAL_PERDIRCA
 634     char         *szCACertificatePath;
 635     char         *szCACertificateFile;
 636 #endif
 637 #ifdef SSL_VENDOR
 638     ap_ctx       *ctx;
 639 #endif
 640 #endif /* XXX */
 641 } SSLDirConfigRec;
 642 #if 0 /* XXX */
 643
 644 /*
 645  *  function prototypes
 646  */
 647
 648 /*  API glue structures  */
 649 extern module MODULE_VAR_EXPORT ssl_module;
 650
 651 /*  configuration handling   */
 652 void         ssl_config_global_create(void);
 653 void         ssl_config_global_fix(void);
 654 BOOL         ssl_config_global_isfixed(void);
 655 void        *ssl_config_server_create(pool *, server_rec *);
 656 void        *ssl_config_server_merge(pool *, void *, void *);
 657 void        *ssl_config_perdir_create(pool *, char *);
 658 void        *ssl_config_perdir_merge(pool *, void *, void *);
 659 #endif /* XXX */
 660 const char  *ssl_cmd_SSLMutex(cmd_parms *, char *, char *);
 661 const char  *ssl_cmd_SSLPassPhraseDialog(cmd_parms *, char *, char *);
 662 const char  *ssl_cmd_SSLCryptoDevice(cmd_parms *, char *, char *);
 663 const char  *ssl_cmd_SSLRandomSeed(cmd_parms *, char *, char *, char *, char *);
 664 const char  *ssl_cmd_SSLEngine(cmd_parms *, char *, int);
 665 const char  *ssl_cmd_SSLCipherSuite(cmd_parms *, SSLDirConfigRec *, char *);
 666 const char  *ssl_cmd_SSLCertificateFile(cmd_parms *, char *, char *);
 667 const char  *ssl_cmd_SSLCertificateKeyFile(cmd_parms *, char *, char *);
 668 const char  *ssl_cmd_SSLCertificateChainFile(cmd_parms *, char *, char *);
 669 const char  *ssl_cmd_SSLCACertificatePath(cmd_parms *, SSLDirConfigRec *, char *);
 670 const char  *ssl_cmd_SSLCACertificateFile(cmd_parms *, SSLDirConfigRec *, char *);
 671 const char  *ssl_cmd_SSLCARevocationPath(cmd_parms *, SSLDirConfigRec *, char *);
 672 const char  *ssl_cmd_SSLCARevocationFile(cmd_parms *, SSLDirConfigRec *, char *);
 673 const char  *ssl_cmd_SSLVerifyClient(cmd_parms *, SSLDirConfigRec *, char *);
 674 const char  *ssl_cmd_SSLVerifyDepth(cmd_parms *, SSLDirConfigRec *, char *);
 675 const char  *ssl_cmd_SSLSessionCache(cmd_parms *, char *, char *);
 676 const char  *ssl_cmd_SSLSessionCacheTimeout(cmd_parms *, char *, char *);
 677 const char  *ssl_cmd_SSLLog(cmd_parms *, char *, char *);
 678 const char  *ssl_cmd_SSLLogLevel(cmd_parms *, char *, char *);
 679 const char  *ssl_cmd_SSLProtocol(cmd_parms *, char *, const char *);
 680 const char  *ssl_cmd_SSLOptions(cmd_parms *, SSLDirConfigRec *, const char *);
 681 const char  *ssl_cmd_SSLRequireSSL(cmd_parms *, SSLDirConfigRec *, char *);
 682 const char  *ssl_cmd_SSLRequire(cmd_parms *, SSLDirConfigRec *, char *);
 683 #ifdef SSL_EXPERIMENTAL_PROXY
 684 const char  *ssl_cmd_SSLProxyProtocol(cmd_parms *, char *, const char *);
 685 const char  *ssl_cmd_SSLProxyCipherSuite(cmd_parms *, char *, char *);
 686 const char  *ssl_cmd_SSLProxyVerify(cmd_parms *, char *, int);
 687 const char  *ssl_cmd_SSLProxyVerifyDepth(cmd_parms *, char *, char *);
 688 const char  *ssl_cmd_SSLProxyCACertificatePath(cmd_parms *, char *, char *);
 689 const char  *ssl_cmd_SSLProxyCACertificateFile(cmd_parms *, char *, char *);
 690 const char  *ssl_cmd_SSLProxyMachineCertificatePath(cmd_parms *, char *, char *);
 691 const char  *ssl_cmd_SSLProxyMachineCertificateFile(cmd_parms *, char *, char *);
 692 #endif
 693 #if 0 /* XXX */
 694
 695 /*  module initialization  */
 696 void         ssl_init_Module(server_rec *, pool *);
 697 void         ssl_init_SSLLibrary(void);
 698 void         ssl_init_Engine(server_rec *, pool *);
 699 void         ssl_init_TmpKeysHandle(int, server_rec *, pool *);
 700 void         ssl_init_ConfigureServer(server_rec *, pool *, SSLSrvConfigRec *);
 701 void         ssl_init_CheckServers(server_rec *, pool *);
 702 STACK_OF(X509_NAME)
 703             *ssl_init_FindCAList(server_rec *, pool *, char *, char *);
 704 void         ssl_init_Child(server_rec *, pool *);
 705 void         ssl_init_ChildKill(void *);
 706 void         ssl_init_ModuleKill(void *);
 707
 708 /*  Apache API hooks  */
 709 void         ssl_hook_AddModule(module *);
 710 void         ssl_hook_RemoveModule(module *);
 711 char        *ssl_hook_RewriteCommand(cmd_parms *, void *, const char *);
 712 void         ssl_hook_NewConnection(conn_rec *);
 713 void         ssl_hook_TimeoutConnection(int);
 714 void         ssl_hook_CloseConnection(conn_rec *);
 715 int          ssl_hook_Translate(request_rec *);
 716 int          ssl_hook_Auth(request_rec *);
 717 int          ssl_hook_UserCheck(request_rec *);
 718 int          ssl_hook_Access(request_rec *);
 719 int          ssl_hook_Fixup(request_rec *);
 720 int          ssl_hook_ReadReq(request_rec *);
 721 int          ssl_hook_Handler(request_rec *);
 722
 723 /*  OpenSSL callbacks */
 724 RSA         *ssl_callback_TmpRSA(SSL *, int, int);
 725 DH          *ssl_callback_TmpDH(SSL *, int, int);
 726 int          ssl_callback_SSLVerify(int, X509_STORE_CTX *);
 727 int          ssl_callback_SSLVerify_CRL(int, X509_STORE_CTX *, server_rec *);
 728 int          ssl_callback_NewSessionCacheEntry(SSL *, SSL_SESSION *);
 729 SSL_SESSION *ssl_callback_GetSessionCacheEntry(SSL *, unsigned char *, int, int *);
 730 void         ssl_callback_DelSessionCacheEntry(SSL_CTX *, SSL_SESSION *);
 731 void         ssl_callback_LogTracingState(SSL *, int, int);
 732
 733 /*  Session Cache Support  */
 734 void         ssl_scache_init(server_rec *, pool *);
 735 void         ssl_scache_kill(server_rec *);
 736 BOOL         ssl_scache_store(server_rec *, UCHAR *, int, time_t, SSL_SESSION *);
 737 SSL_SESSION *ssl_scache_retrieve(server_rec *, UCHAR *, int);
 738 void         ssl_scache_remove(server_rec *, UCHAR *, int);
 739 void         ssl_scache_expire(server_rec *);
 740 void         ssl_scache_status(server_rec *, pool *, void (*)(char *, void *), void *);
 741 char        *ssl_scache_id2sz(UCHAR *, int);
 742 void         ssl_scache_dbm_init(server_rec *, pool *);
 743 void         ssl_scache_dbm_kill(server_rec *);
 744 BOOL         ssl_scache_dbm_store(server_rec *, UCHAR *, int, time_t, SSL_SESSION *);
 745 SSL_SESSION *ssl_scache_dbm_retrieve(server_rec *, UCHAR *, int);
 746 void         ssl_scache_dbm_remove(server_rec *, UCHAR *, int);
 747 void         ssl_scache_dbm_expire(server_rec *);
 748 void         ssl_scache_dbm_status(server_rec *, pool *, void (*)(char *, void *), void *);
 749 void         ssl_scache_shmht_init(server_rec *, pool *);
 750 void         ssl_scache_shmht_kill(server_rec *);
 751 BOOL         ssl_scache_shmht_store(server_rec *, UCHAR *, int, time_t, SSL_SESSION *);
 752 SSL_SESSION *ssl_scache_shmht_retrieve(server_rec *, UCHAR *, int);
 753 void         ssl_scache_shmht_remove(server_rec *, UCHAR *, int);
 754 void         ssl_scache_shmht_expire(server_rec *);
 755 void         ssl_scache_shmht_status(server_rec *, pool *, void (*)(char *, void *), void *);
 756 void         ssl_scache_shmcb_init(server_rec *, pool *);
 757 void         ssl_scache_shmcb_kill(server_rec *);
 758 BOOL         ssl_scache_shmcb_store(server_rec *, UCHAR *, int, time_t, SSL_SESSION *);
 759 SSL_SESSION *ssl_scache_shmcb_retrieve(server_rec *, UCHAR *, int);
 760 void         ssl_scache_shmcb_remove(server_rec *, UCHAR *, int);
 761 void         ssl_scache_shmcb_expire(server_rec *);
 762 void         ssl_scache_shmcb_status(server_rec *, pool *, void (*)(char *, void *), void *);
 763
 764 /*  Pass Phrase Support  */
 765 void         ssl_pphrase_Handle(server_rec *, pool *);
 766 int          ssl_pphrase_Handle_CB(char *, int, int);
 767
 768 /*  Diffie-Hellman Parameter Support  */
 769 DH           *ssl_dh_GetTmpParam(int);
 770 DH           *ssl_dh_GetParamFromFile(char *);
 771
 772 /*  Data Structures */
 773 ssl_ds_array *ssl_ds_array_make(pool *, int);
 774 BOOL          ssl_ds_array_isempty(ssl_ds_array *);
 775 void         *ssl_ds_array_push(ssl_ds_array *);
 776 void         *ssl_ds_array_get(ssl_ds_array *, int);
 777 void          ssl_ds_array_wipeout(ssl_ds_array *);
 778 void          ssl_ds_array_kill(ssl_ds_array *);
 779 ssl_ds_table *ssl_ds_table_make(pool *, int);
 780 BOOL          ssl_ds_table_isempty(ssl_ds_table *);
 781 void         *ssl_ds_table_push(ssl_ds_table *, char *);
 782 void         *ssl_ds_table_get(ssl_ds_table *, char *);
 783 void          ssl_ds_table_wipeout(ssl_ds_table *);
 784 void          ssl_ds_table_kill(ssl_ds_table *);
 785
 786 /*  Mutex Support  */
 787 void         ssl_mutex_init(server_rec *, pool *);
 788 void         ssl_mutex_reinit(server_rec *, pool *);
 789 void         ssl_mutex_on(server_rec *);
 790 void         ssl_mutex_off(server_rec *);
 791 void         ssl_mutex_kill(server_rec *s);
 792 void         ssl_mutex_file_create(server_rec *, pool *);
 793 void         ssl_mutex_file_open(server_rec *, pool *);
 794 void         ssl_mutex_file_remove(void *);
 795 BOOL         ssl_mutex_file_acquire(void);
 796 BOOL         ssl_mutex_file_release(void);
 797 void         ssl_mutex_sem_create(server_rec *, pool *);
 798 void         ssl_mutex_sem_open(server_rec *, pool *);
 799 void         ssl_mutex_sem_remove(void *);
 800 BOOL         ssl_mutex_sem_acquire(void);
 801 BOOL         ssl_mutex_sem_release(void);
 802
 803 /*  Logfile Support  */
 804 void         ssl_log_open(server_rec *, server_rec *, pool *);
 805 BOOL         ssl_log_applies(server_rec *, int);
 806 void         ssl_log(server_rec *, int, const char *, ...);
 807 void         ssl_die(void);
 808
 809 /*  Variables  */
 810 void         ssl_var_register(void);
 811 void         ssl_var_unregister(void);
 812 char        *ssl_var_lookup(pool *, server_rec *, conn_rec *, request_rec *, char *);
 813
 814 /*  I/O  */
 815 void         ssl_io_register(void);
 816 void         ssl_io_unregister(void);
 817 long         ssl_io_data_cb(BIO *, int, const char *, int, long, long);
 818 #ifndef SSL_CONSERVATIVE
 819 void         ssl_io_suck(request_rec *, SSL *);
 820 #endif
 821
 822 /*  PRNG  */
 823 int          ssl_rand_seed(server_rec *, pool *, ssl_rsctx_t, char *);
 824
 825 /*  Extensions  */
 826 void         ssl_ext_register(void);
 827 void         ssl_ext_unregister(void);
 828
 829 /*  Compatibility  */
 830 #ifdef SSL_COMPAT
 831 char        *ssl_compat_directive(server_rec *, pool *, const char *);
 832 void         ssl_compat_variables(request_rec *);
 833 #endif
 834
 835 /*  Utility Functions  */
 836 char        *ssl_util_server_root_relative(pool *, char *, char *);
 837 char        *ssl_util_vhostid(pool *, server_rec *);
 838 void         ssl_util_strupper(char *);
 839 void         ssl_util_uuencode(char *, const char *, BOOL);
 840 void         ssl_util_uuencode_binary(unsigned char *, const unsigned char *, int, BOOL);
 841 FILE        *ssl_util_ppopen(server_rec *, pool *, char *);
 842 int          ssl_util_ppopen_child(void *, child_info *);
 843 void         ssl_util_ppclose(server_rec *, pool *, FILE *);
 844 char        *ssl_util_readfilter(server_rec *, pool *, char *);
 845 BOOL         ssl_util_path_check(ssl_pathcheck_t, char *);
 846 ssl_algo_t   ssl_util_algotypeof(X509 *, EVP_PKEY *);
 847 char        *ssl_util_algotypestr(ssl_algo_t);
 848 char        *ssl_util_ptxtsub(pool *, const char *, const char *, char *);
 849 void         ssl_util_thread_setup(void);
 850
 851 /*  Vendor extension support  */
 852 #if defined(SSL_VENDOR) && defined(SSL_VENDOR_OBJS)
 853 void         ssl_vendor_register(void);
 854 void         ssl_vendor_unregister(void);
 855 #endif
 856
 857 #endif /* XXX */
 858
 859 #endif /* MOD_SSL_H */