]> granicus.if.org Git - apache/blobdiff - modules/ssl/mod_ssl.h
de-hungarian-ize server config member names which are going to stay
[apache] / modules / ssl / mod_ssl.h
index 6e547c913c7cbdb7b1cf0394f796edf35c5f3ca9..665a9a2cd40df6ebb0eb441c00120eded7d20704 100644 (file)
@@ -11,7 +11,7 @@
 /* ====================================================================
  * The Apache Software License, Version 1.1
  *
- * Copyright (c) 2000-2001 The Apache Software Foundation.  All rights
+ * Copyright (c) 2000-2002 The Apache Software Foundation.  All rights
  * reserved.
  *
  * Redistribution and use in source and binary forms, with or without
 #ifndef __MOD_SSL_H__
 #define __MOD_SSL_H__
 
-#define MOD_SSL_VERSION "3.0a0"
-
 /* 
  * Optionally enable the experimental stuff, but allow the user to
  * override the decision which experimental parts are included by using
  * CFLAGS="-DSSL_EXPERIMENTAL_xxxx_IGNORE".
  */
 #ifdef SSL_EXPERIMENTAL
-#ifndef SSL_EXPERIMENTAL_PERDIRCA_IGNORE
-#define SSL_EXPERIMENTAL_PERDIRCA
-#endif
 #ifndef SSL_EXPERIMENTAL_PROXY_IGNORE
 #define SSL_EXPERIMENTAL_PROXY
 #endif
 #endif
 #endif /* SSL_EXPERIMENTAL */
 
+/* XXX: add configure check */
+#ifndef MODSSL_HAVE_SSL_SET_CERT_STORE
+#define MODSSL_HAVE_SSL_SET_CERT_STORE 0
+#endif 
+
 /*
  * Power up our brain...
  */
 #include "util_script.h"
 #include "util_filter.h"
 #include "mpm.h"
+#include "apr.h"
 #include "apr_strings.h"
 #include "apr_tables.h"
 #include "apr_lib.h"
 #include "apr_fnmatch.h"
 #include "apr_strings.h"
 #include "apr_dbm.h"
+#include "apr_rmm.h"
+#include "apr_shm.h"
 #include "apr_optional.h"
 
+#define MOD_SSL_VERSION AP_SERVER_BASEVERSION
+
 /* OpenSSL headers */
 #include <ssl.h>
 #include <err.h>
 #include <x509.h>
-#include <x509v3.h>
 #include <pem.h>
 #include <crypto.h>
 #include <evp.h>
 #include <engine.h>
 #endif
 
+#include "ssl_toolkit_compat.h"
+
+#ifdef HAVE_SSL_X509V3_H
+#include <x509v3.h>
+#endif
+
 /* mod_ssl headers */
 #include "ssl_expr.h"
 #include "ssl_util_ssl.h"
 
 #define strIsEmpty(s)    (s == NULL || s[0] == NUL)
 
-#define cfgMerge(el,unset)  new->el = (add->el == (unset)) ? base->el : add->el
-#define cfgMergeArray(el)   new->el = apr_array_append(p, add->el, base->el)
-#define cfgMergeTable(el)   new->el = apr_table_overlay(p, add->el, base->el)
-#define cfgMergeCtx(el)     new->el = apr_table_overlay(p, add->el, base->el)
+#define cfgMerge(el,unset)  mrg->el = (add->el == (unset)) ? base->el : add->el
+#define cfgMergeArray(el)   mrg->el = apr_array_append(p, add->el, base->el)
+#define cfgMergeTable(el)   mrg->el = apr_table_overlay(p, add->el, base->el)
+#define cfgMergeCtx(el)     mrg->el = apr_table_overlay(p, add->el, base->el)
 #define cfgMergeString(el)  cfgMerge(el, NULL)
 #define cfgMergeBool(el)    cfgMerge(el, UNSET)
 #define cfgMergeInt(el)     cfgMerge(el, UNSET)
 (SSLConnRec *)ap_get_module_config(c->conn_config, &ssl_module)
 #define myConnConfigSet(c, val) \
 ap_set_module_config(c->conn_config, &ssl_module, val)
-#define myModConfig(srv) (SSLModConfigRec *)ssl_util_getmodconfig(srv, "ssl_module")
 #define mySrvConfig(srv) (SSLSrvConfigRec *)ap_get_module_config(srv->module_config,  &ssl_module)
 #define myDirConfig(req) (SSLDirConfigRec *)ap_get_module_config(req->per_dir_config, &ssl_module)
+#define myModConfig(srv) (mySrvConfig((srv)))->mc
 
 #define myCtxVarSet(mc,num,val)  mc->rCtx.pV##num = val
 #define myCtxVarGet(mc,num,type) (type)(mc->rCtx.pV##num)
@@ -224,6 +234,7 @@ ap_set_module_config(c->conn_config, &ssl_module, val)
 #define SSL_NO_TIMESTAMP (1<<11)
 #define SSL_NO_LEVELID   (1<<12)
 #define SSL_NO_NEWLINE   (1<<13)
+#define SSL_INIT         (1<<14)
 
 /*
  * Defaults for the configuration
@@ -255,29 +266,6 @@ ap_set_module_config(c->conn_config, &ssl_module, val)
 #endif
 #endif
 
-/*
- * Check for OpenSSL version 
- */
-#if SSL_LIBRARY_VERSION < 0x00903100
-#error "mod_ssl requires OpenSSL 0.9.3 or higher"
-#endif
-
-/*
- * The own data structures
- */
-typedef struct {
-    apr_pool_t *pPool;
-    apr_pool_t *pSubPool;
-    apr_array_header_t *aData;
-} ssl_ds_array;
-
-typedef struct {
-    apr_pool_t *pPool;
-    apr_pool_t *pSubPool;
-    apr_array_header_t *aKey;
-    apr_array_header_t *aData;
-} ssl_ds_table;
-
 /*
  * Define the certificate algorithm types
  */
@@ -298,15 +286,11 @@ typedef int ssl_algo_t;
  * Define IDs for the temporary RSA keys and DH params
  */
 
-#define SSL_TKP_GEN        (0)
-#define SSL_TKP_ALLOC      (1)
-#define SSL_TKP_FREE       (2)
-
-#define SSL_TKPIDX_RSA512  (0)
-#define SSL_TKPIDX_RSA1024 (1)
-#define SSL_TKPIDX_DH512   (2)
-#define SSL_TKPIDX_DH1024  (3)
-#define SSL_TKPIDX_MAX     (4)
+#define SSL_TMP_KEY_RSA_512  (0)
+#define SSL_TMP_KEY_RSA_1024 (1)
+#define SSL_TMP_KEY_DH_512   (2)
+#define SSL_TMP_KEY_DH_1024  (3)
+#define SSL_TMP_KEY_MAX      (4)
 
 /*
  * Define the SSL options
@@ -343,6 +327,9 @@ typedef enum {
     SSL_CVERIFY_OPTIONAL_NO_CA  = 3
 } ssl_verify_t;
 
+#define SSL_VERIFY_PEER_STRICT \
+     (SSL_VERIFY_PEER|SSL_VERIFY_FAIL_IF_NO_PEER_CERT)
+
 #ifndef X509_V_ERR_CERT_UNTRUSTED
 #define X509_V_ERR_CERT_UNTRUSTED 27
 #endif
@@ -360,7 +347,8 @@ typedef enum {
 typedef enum {
     SSL_PPTYPE_UNSET   = UNSET,
     SSL_PPTYPE_BUILTIN = 0,
-    SSL_PPTYPE_FILTER  = 1
+    SSL_PPTYPE_FILTER  = 1,
+       SSL_PPTYPE_PIPE    = 2
 } ssl_pphrase_t;
 
 /*
@@ -410,10 +398,8 @@ typedef enum {
 typedef enum {
     SSL_RSSRC_BUILTIN = 1,
     SSL_RSSRC_FILE    = 2,
-    SSL_RSSRC_EXEC    = 3
-#if SSL_LIBRARY_VERSION >= 0x00905100
-   ,SSL_RSSRC_EGD     = 4
-#endif
+    SSL_RSSRC_EXEC    = 3,
+    SSL_RSSRC_EGD     = 4
 } ssl_rssrc_t;
 typedef struct {
     ssl_rsctx_t  nCtx;
@@ -428,6 +414,7 @@ typedef struct {
 typedef struct {
     long int       nData;
     unsigned char *cpData;
+    apr_time_t     source_mtime;
 } ssl_asn1_t;
 
 /*
@@ -441,8 +428,6 @@ typedef struct {
     BIO                *pbioWrite;
     ap_filter_t        *pInputFilter;
     ap_filter_t        *pOutputFilter;
-    apr_bucket_brigade *rawb;               /* encrypted input */
-    apr_bucket_brigade *b;                  /* decrypted input */
 } SSLFilterRec;
 
 typedef enum {
@@ -455,6 +440,7 @@ typedef enum {
 typedef struct {
     SSL *ssl;
     const char *client_dn;
+    X509 *client_cert;
     ssl_shutdown_type_e shutdown_type;
     const char *verify_info;
     const char *verify_error;
@@ -468,22 +454,20 @@ typedef struct {
     pid_t           pid;
     apr_pool_t     *pPool;
     BOOL            bFixed;
-    int             nInitCount;
     int             nSessionCacheMode;
     char           *szSessionCacheDataFile;
     int             nSessionCacheDataSize;
-#if 0 /* XXX */
-    AP_MM          *pSessionCacheDataMM;
-#endif
+    apr_shm_t      *pSessionCacheDataMM;
+    apr_rmm_t      *pSessionCacheDataRMM;
     apr_table_t    *tSessionCacheDataTable;
     ssl_mutexmode_t nMutexMode;
-    char           *szMutexFile;
+    const char     *szMutexFile;
     apr_lock_t     *pMutex;
     apr_array_header_t   *aRandSeed;
-    ssl_ds_table   *tTmpKeys;
-    void           *pTmpKeys[SSL_TKPIDX_MAX];
-    ssl_ds_table   *tPublicCert;
-    ssl_ds_table   *tPrivateKey;
+    apr_hash_t     *tVHostKeys;
+    void           *pTmpKeys[SSL_TMP_KEY_MAX];
+    apr_hash_t     *tPublicCert;
+    apr_hash_t     *tPrivateKey;
 #ifdef SSL_EXPERIMENTAL_ENGINE
     char           *szCryptoDevice;
 #endif
@@ -498,25 +482,26 @@ typedef struct {
  *  and all <VirtualHost> contexts)
  */
 typedef struct {
-    const char  *szVHostID;
-    int          nVHostID_length;
-    BOOL         bEnabled;
-    apr_table_t *ap_server_ctx;
-    const char  *szPublicCertFile[SSL_AIDX_MAX];
-    const char  *szPrivateKeyFile[SSL_AIDX_MAX];
+    SSLModConfigRec *mc;
+    BOOL         enabled;
+    const char  *vhost_id;
+    int          vhost_id_len;
+    const char  *log_file_name;
+    apr_file_t  *log_file;
+    int          log_level;
+    int          session_cache_timeout;
+
+    const char  *szPublicCertFiles[SSL_AIDX_MAX];
+    const char  *szPrivateKeyFiles[SSL_AIDX_MAX];
     const char  *szCertificateChain;
     const char  *szCACertificatePath;
     const char  *szCACertificateFile;
-    const char  *szLogFile;
     const char  *szCipherSuite;
-    apr_file_t  *fileLogFile;
-    int          nLogLevel;
     int          nVerifyDepth;
     ssl_verify_t nVerifyClient;
     X509        *pPublicCert[SSL_AIDX_MAX];
     EVP_PKEY    *pPrivateKey[SSL_AIDX_MAX];
     SSL_CTX     *pSSLCtx;
-    int          nSessionCacheTimeout;
     int          nPassPhraseDialogType;
     const char  *szPassPhraseDialogPath;
     ssl_proto_t  nProtocol;
@@ -549,13 +534,11 @@ typedef struct {
     ssl_opt_t     nOptions;
     ssl_opt_t     nOptionsAdd;
     ssl_opt_t     nOptionsDel;
-    char         *szCipherSuite;
+    const char   *szCipherSuite;
     ssl_verify_t  nVerifyClient;
     int           nVerifyDepth;
-#ifdef SSL_EXPERIMENTAL_PERDIRCA
-    char         *szCACertificatePath;
-    char         *szCACertificateFile;
-#endif
+    const char   *szCACertificatePath;
+    const char   *szCACertificateFile;
 } SSLDirConfigRec;
 
 /*
@@ -566,7 +549,7 @@ typedef struct {
 extern module AP_MODULE_DECLARE_DATA ssl_module;
 
 /*  configuration handling   */
-void         ssl_config_global_create(server_rec *);
+SSLModConfigRec *ssl_config_global_create(server_rec *);
 void         ssl_config_global_fix(SSLModConfigRec *);
 BOOL         ssl_config_global_isfixed(SSLModConfigRec *);
 void        *ssl_config_server_create(apr_pool_t *, server_rec *);
@@ -609,15 +592,12 @@ const char  *ssl_cmd_SSLProxyMachineCertificateFile(cmd_parms *, char *, char *)
 
 /*  module initialization  */
 int          ssl_init_Module(apr_pool_t *, apr_pool_t *, apr_pool_t *, server_rec *);
-void         ssl_init_SSLLibrary(void);
 void         ssl_init_Engine(server_rec *, apr_pool_t *);
-void         ssl_init_TmpKeysHandle(int, server_rec *, apr_pool_t *);
-void         ssl_init_ConfigureServer(server_rec *, apr_pool_t *, SSLSrvConfigRec *);
+void         ssl_init_ConfigureServer(server_rec *, apr_pool_t *, apr_pool_t *, SSLSrvConfigRec *);
 void         ssl_init_CheckServers(server_rec *, apr_pool_t *);
 STACK_OF(X509_NAME) 
             *ssl_init_FindCAList(server_rec *, apr_pool_t *, const char *, const char *);
 void         ssl_init_Child(apr_pool_t *, server_rec *);
-apr_status_t ssl_init_ChildKill(void *data);
 apr_status_t ssl_init_ModuleKill(void *data);
 
 /*  Apache API hooks  */
@@ -641,7 +621,11 @@ int          ssl_callback_SSLVerify_CRL(int, X509_STORE_CTX *, server_rec *);
 int          ssl_callback_NewSessionCacheEntry(SSL *, SSL_SESSION *);
 SSL_SESSION *ssl_callback_GetSessionCacheEntry(SSL *, unsigned char *, int, int *);
 void         ssl_callback_DelSessionCacheEntry(SSL_CTX *, SSL_SESSION *);
+#if SSL_LIBRARY_VERSION >= 0x00907000
+void         ssl_callback_LogTracingState(const SSL *, int, int);
+#else
 void         ssl_callback_LogTracingState(SSL *, int, int);
+#endif
 
 /*  Session Cache Support  */
 void         ssl_scache_init(server_rec *, apr_pool_t *);
@@ -662,55 +646,53 @@ SSL_SESSION *ssl_scache_dbm_retrieve(server_rec *, UCHAR *, int);
 void         ssl_scache_dbm_remove(server_rec *, UCHAR *, int);
 void         ssl_scache_dbm_expire(server_rec *);
 void         ssl_scache_dbm_status(server_rec *, apr_pool_t *, void (*)(char *, void *), void *);
-#if 0 /* XXX */
-void         ssl_scache_shmht_init(server_rec *, pool *);
+
+void         ssl_scache_shmht_init(server_rec *, apr_pool_t *);
 void         ssl_scache_shmht_kill(server_rec *);
 BOOL         ssl_scache_shmht_store(server_rec *, UCHAR *, int, time_t, SSL_SESSION *);
 SSL_SESSION *ssl_scache_shmht_retrieve(server_rec *, UCHAR *, int);
 void         ssl_scache_shmht_remove(server_rec *, UCHAR *, int);
 void         ssl_scache_shmht_expire(server_rec *);
-void         ssl_scache_shmht_status(server_rec *, pool *, void (*)(char *, void *), void *);
-void         ssl_scache_shmcb_init(server_rec *, pool *);
+void         ssl_scache_shmht_status(server_rec *, apr_pool_t *, void (*)(char *, void *), void *);
+
+void         ssl_scache_shmcb_init(server_rec *, apr_pool_t *);
 void         ssl_scache_shmcb_kill(server_rec *);
 BOOL         ssl_scache_shmcb_store(server_rec *, UCHAR *, int, time_t, SSL_SESSION *);
 SSL_SESSION *ssl_scache_shmcb_retrieve(server_rec *, UCHAR *, int);
 void         ssl_scache_shmcb_remove(server_rec *, UCHAR *, int);
 void         ssl_scache_shmcb_expire(server_rec *);
-void         ssl_scache_shmcb_status(server_rec *, pool *, void (*)(char *, void *), void *);
-#endif
+void         ssl_scache_shmcb_status(server_rec *, apr_pool_t *, void (*)(char *, void *), void *);
 
 /*  Pass Phrase Support  */
 void         ssl_pphrase_Handle(server_rec *, apr_pool_t *);
-int          ssl_pphrase_Handle_CB(char *, int, int, void *);
 
 /*  Diffie-Hellman Parameter Support  */
 DH           *ssl_dh_GetTmpParam(int);
 DH           *ssl_dh_GetParamFromFile(char *);
 
-/*  Data Structures */
-ssl_ds_array *ssl_ds_array_make(apr_pool_t *, int);
-BOOL          ssl_ds_array_isempty(ssl_ds_array *);
-void         *ssl_ds_array_push(ssl_ds_array *);
-void         *ssl_ds_array_get(ssl_ds_array *, int);
-void          ssl_ds_array_wipeout(ssl_ds_array *);
-void          ssl_ds_array_kill(ssl_ds_array *);
-ssl_ds_table *ssl_ds_table_make(apr_pool_t *, int);
-BOOL          ssl_ds_table_isempty(ssl_ds_table *);
-void         *ssl_ds_table_push(ssl_ds_table *, char *);
-void         *ssl_ds_table_get(ssl_ds_table *, char *);
-void          ssl_ds_table_wipeout(ssl_ds_table *);
-void          ssl_ds_table_kill(ssl_ds_table *);
+unsigned char *ssl_asn1_table_set(apr_hash_t *table,
+                                  const char *key,
+                                  long int length);
+
+ssl_asn1_t *ssl_asn1_table_get(apr_hash_t *table,
+                               const char *key);
+
+void ssl_asn1_table_unset(apr_hash_t *table,
+                          const char *key);
+
+const char *ssl_asn1_keystr(int keytype);
 
+const char *ssl_asn1_table_keyfmt(apr_pool_t *p,
+                                  const char *id,
+                                  int keytype);
 /*  Mutex Support  */
 int          ssl_mutex_init(server_rec *, apr_pool_t *);
 int          ssl_mutex_reinit(server_rec *, apr_pool_t *);
 int          ssl_mutex_on(server_rec *);
 int          ssl_mutex_off(server_rec *);
-int          ssl_mutex_kill(server_rec *);
 
 /*  Logfile Support  */
 void         ssl_log_open(server_rec *, server_rec *, apr_pool_t *);
-BOOL         ssl_log_applies(server_rec *, int);
 void         ssl_log(server_rec *, int, const char *, ...);
 void         ssl_die(void);
 
@@ -732,7 +714,7 @@ void         ssl_ext_proxy_register(apr_pool_t *p);
 /*  I/O  */
 void         ssl_io_filter_init(conn_rec *, SSL *);
 void         ssl_io_filter_register(apr_pool_t *);
-long         ssl_io_data_cb(BIO *, int, const char *, int, long, long);
+long         ssl_io_data_cb(BIO *, int, MODSSL_BIO_CB_ARG_TYPE *, int, long, long);
 
 /*  PRNG  */
 int          ssl_rand_seed(server_rec *, apr_pool_t *, ssl_rsctx_t, char *);
@@ -742,16 +724,16 @@ char        *ssl_util_vhostid(apr_pool_t *, server_rec *);
 void         ssl_util_strupper(char *);
 void         ssl_util_uuencode(char *, const char *, BOOL);
 void         ssl_util_uuencode_binary(unsigned char *, const unsigned char *, int, BOOL);
-apr_file_t  *ssl_util_ppopen(server_rec *, apr_pool_t *, char *);
+apr_file_t  *ssl_util_ppopen(server_rec *, apr_pool_t *, const char *,
+                             const char * const *);
 void         ssl_util_ppclose(server_rec *, apr_pool_t *, apr_file_t *);
-char        *ssl_util_readfilter(server_rec *, apr_pool_t *, char *);
+char        *ssl_util_readfilter(server_rec *, apr_pool_t *, const char *,
+                                 const char * const *);
 BOOL         ssl_util_path_check(ssl_pathcheck_t, const char *, apr_pool_t *);
 ssl_algo_t   ssl_util_algotypeof(X509 *, EVP_PKEY *); 
 char        *ssl_util_algotypestr(ssl_algo_t);
 char        *ssl_util_ptxtsub(apr_pool_t *, const char *, const char *, char *);
 void         ssl_util_thread_setup(server_rec *, apr_pool_t *);
-apr_status_t     ssl_util_setmodconfig(server_rec *, const char *, SSLModConfigRec *);
-SSLModConfigRec *ssl_util_getmodconfig(server_rec *, const char *);
-SSLModConfigRec *ssl_util_getmodconfig_ssl(SSL *, const char *);
 
+#define APR_SHM_MAXSIZE (64 * 1024 * 1024)
 #endif /* __MOD_SSL_H__ */