]> 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 235bf5cb68ea93a3fc3c0aedea5b56f41666eb2e..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 "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)
@@ -225,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
@@ -256,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
  */
@@ -299,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
@@ -344,42 +327,11 @@ 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
-
-#ifdef OPENSSL_VERSION_NUMBER
-
-#define EVP_PKEY_key_type(k)              (EVP_PKEY_type(k->type))
-
-#define X509_NAME_get_entries(xs)         (xs->entries)
-#define X509_REVOKED_get_serialNumber(xs) (xs->serialNumber)
-
-#define X509_get_signature_algorithm(xs) (xs->cert_info->signature->algorithm)
-#define X509_get_key_algorithm(xs)       (xs->cert_info->key->algor->algorithm)
-
-#define X509_NAME_ENTRY_get_data_ptr(xs) (xs->value->data)
-#define X509_NAME_ENTRY_get_data_len(xs) (xs->value->length)
-
-#define SSL_CTX_get_extra_certs(ctx)       (ctx->extra_certs)
-#define SSL_CTX_set_extra_certs(ctx,value) {ctx->extra_certs = value;}
-
-#define SSL_CIPHER_get_name(s)             (s->name)
-#define SSL_CIPHER_get_valid(s)            (s->valid)
-
-#define SSL_SESSION_get_session_id(s)      (s->session_id)
-#define SSL_SESSION_get_session_id_length(s) (s->session_id_length)
-
-/*
- * Support for retrieving/overriding states
- */
-#ifndef SSL_get_state
-#define SSL_get_state(ssl) SSL_state(ssl)
-#endif
-
-#define SSL_set_state(ssl,val) (ssl)->state = val
-
 #endif
 
 #define ssl_verify_error_is_optional(errnum) \
@@ -446,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;
@@ -507,17 +457,15 @@ typedef struct {
     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;
     apr_hash_t     *tVHostKeys;
-    apr_hash_t     *tTmpKeys;
-    void           *pTmpKeys[SSL_TKPIDX_MAX];
+    void           *pTmpKeys[SSL_TMP_KEY_MAX];
     apr_hash_t     *tPublicCert;
     apr_hash_t     *tPrivateKey;
 #ifdef SSL_EXPERIMENTAL_ENGINE
@@ -535,25 +483,25 @@ typedef struct {
  */
 typedef struct {
     SSLModConfigRec *mc;
-    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];
+    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;
@@ -586,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;
 
 /*
@@ -646,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  */
@@ -703,22 +646,22 @@ 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 *);
@@ -727,20 +670,6 @@ void         ssl_pphrase_Handle(server_rec *, apr_pool_t *);
 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);
@@ -751,6 +680,11 @@ ssl_asn1_t *ssl_asn1_table_get(apr_hash_t *table,
 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 *);
@@ -780,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 *);
@@ -801,4 +735,5 @@ 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 *);
 
+#define APR_SHM_MAXSIZE (64 * 1024 * 1024)
 #endif /* __MOD_SSL_H__ */