aolserver/nsopenssl/nsopenssl.c

/*
 * The contents of this file are subject to the AOLserver Public License
 * Version 1.1 (the "License"); you may not use this file except in
 * compliance with the License. You may obtain a copy of the License at
 * http://aolserver.com.
 *
 * Software distributed under the License is distributed on an "AS IS"
 * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
 * the License for the specific language governing rights and limitations
 * under the License.
 *
 * Alternatively, the contents of this file may be used under the terms
 * of the GNU General Public License (the "GPL"), in which case the
 * provisions of GPL are applicable instead of those above.  If you wish
 * to allow use of your version of this file only under the terms of the
 * GPL and not to allow others to use your version of this file under the
 * License, indicate your decision by deleting the provisions above and
 * replace them with the notice and other provisions required by the GPL.
 * If you do not delete the provisions above, a recipient may use your
 * version of this file under either the License or the GPL.
 *
 * Copyright (C) 2000-2003 Scott S. Goodwin
 *
 * Module originally written by Stefan Arentz. Early contributions made by
 * Freddie Mendoze and Rob Mayoff.
 *
 * Portions created by AOL are Copyright (C) 1999 America Online, Inc.
 * All Rights Reserved.
 */

/*
 * nsopenssl.c --
 *
 *    Implements SSLv2, SSLv3 and TLSv1 module using OpenSSL.
 */

static const char *RCSID = "@(#) $Header: /cvsroot-fuse/aolserver/nsopenssl/nsopenssl.c,v 1.77 2004/11/20 06:42:54 dossy Exp $, compiled: " __DATE__ " " __TIME__;

#include "nsopenssl.h"

extern Tcl_HashTable NsOpenSSLServers;
extern void     NsOpenSSLDriversLoad(char *server);
extern int      <a href="/cvs/aolserver/nsopenssl/sslcontext.c#A_NsMakeTmpRSAKey">NsMakeTmpRSAKey</a>(int keylen);

static Ns_Mutex *locks;
static Ns_DriverProc <a href="/cvs/aolserver/nsopenssl/nsopenssl.c#A_OpenSSLProc">OpenSSLProc</a>;

static int      <a href="/cvs/aolserver/nsopenssl/nsopenssl.c#A_InitOpenSSL">InitOpenSSL</a>(void);
static void     <a href="/cvs/aolserver/nsopenssl/nsopenssl.c#A_InitServerState">InitServerState</a>(char *server);
static int      <a href="/cvs/aolserver/nsopenssl/nsopenssl.c#A_SeedPRNG">SeedPRNG</a>(void);
static void     <a href="/cvs/aolserver/nsopenssl/nsopenssl.c#A_ThreadLockCallback">ThreadLockCallback</a>(int mode, int n, const char *file, int line);
static unsigned long <a href="/cvs/aolserver/nsopenssl/nsopenssl.c#A_ThreadIdCallback">ThreadIdCallback</a>(void);
static struct CRYPTO_dynlock_value *<a href="/cvs/aolserver/nsopenssl/nsopenssl.c#A_ThreadDynlockCreateCallback">ThreadDynlockCreateCallback</a>(char *file, int line);
static void     <a href="/cvs/aolserver/nsopenssl/nsopenssl.c#A_ThreadDynlockLockCallback">ThreadDynlockLockCallback</a>(int mode, struct CRYPTO_dynlock_value *dynlock, const char *file, int line);
static void     <a href="/cvs/aolserver/nsopenssl/nsopenssl.c#A_ThreadDynlockDestroyCallback">ThreadDynlockDestroyCallback</a>(struct CRYPTO_dynlock_value *dynlock, const char *file, int line);
static void     <a href="/cvs/aolserver/nsopenssl/nsopenssl.c#A_ServerShutdown">ServerShutdown</a>(void *arg);
static void     <a href="/cvs/aolserver/nsopenssl/nsopenssl.c#A_LoadSSLContexts">LoadSSLContexts</a>(char *server);
static NsOpenSSLContext *<a href="/cvs/aolserver/nsopenssl/nsopenssl.c#A_LoadSSLContext">LoadSSLContext</a>(char *server, char *name);
static int      <a href="/cvs/aolserver/nsopenssl/nsopenssl.c#A_InitSSLDriver">InitSSLDriver</a>(char *server, NsOpenSSLDriver *ssldriver);
static void     <a href="/cvs/aolserver/nsopenssl/nsopenssl.c#A_LoadSSLDrivers">LoadSSLDrivers</a>(char *server);

int Ns_ModuleVersion = 1;


/*
 *----------------------------------------------------------------------
 *
 * Ns_ModuleInit --
 *
 *     nsopenssl module initialization.
 *
 * Results:
 *     NS_OK or NS_ERROR
 *
 * Side effects:
 *
 *----------------------------------------------------------------------
 */

int
Ns_ModuleInit(char *server, char *module)
{
    static int  initialized = NS_FALSE;
    int         i;

    /* 
     * Initialize one-time global stuff.
     */

    if (initialized == NS_FALSE) {
        if (!STREQ(module, MODULE)) {
            <a href="/cvs/aolserver/aolserver/nsd/log.c#A_Ns_Log">Ns_Log</a>(Fatal, "Module '%s' should be named '%s'", module, MODULE);
        }
        if (<a href="/cvs/aolserver/nsopenssl/nsopenssl.c#A_InitOpenSSL">InitOpenSSL</a>() == NS_ERROR) {
            <a href="/cvs/aolserver/aolserver/nsd/log.c#A_Ns_Log">Ns_Log</a>(Error, "%s: OpenSSL failed to initialize", MODULE);
            return NS_ERROR;
        }
        Tcl_InitHashTable(&NsOpenSSLServers, TCL_STRING_KEYS);

        /*
         * Pre-generate temporary RSA keys for 512 and 1024 bit keys.
         */

        <a href="/cvs/aolserver/nsopenssl/sslcontext.c#A_NsMakeTmpRSAKey">NsMakeTmpRSAKey</a>(512);
        <a href="/cvs/aolserver/nsopenssl/sslcontext.c#A_NsMakeTmpRSAKey">NsMakeTmpRSAKey</a>(1024);

        initialized = NS_TRUE;
    }

    /* 
     * Initialize this virtual server's state information 
     */

    <a href="/cvs/aolserver/nsopenssl/nsopenssl.c#A_InitServerState">InitServerState</a>(server);

    /* 
     * Load this virtual server's SSL contexts from the configuration file.
     */

    <a href="/cvs/aolserver/nsopenssl/nsopenssl.c#A_LoadSSLContexts">LoadSSLContexts</a>(server);

    /*
     * Load and start the driver(s) for this virtual server.  A driver manages
     * one SSL port; for a virtual server to use more than one port, you must
     * define a driver for each port.  A driver must be associated with a named
     * SSL context.
     */

    <a href="/cvs/aolserver/nsopenssl/nsopenssl.c#A_LoadSSLDrivers">LoadSSLDrivers</a>(server);

    /* 
     * Create the nsopenssl Tcl commands for this virtual server's interps.
     */

    <a href="/cvs/aolserver/nsopenssl/tclcmds.c#A_NsOpenSSLTclInit">NsOpenSSLTclInit</a>(server);

    /*
     * Register a cleanup function to run at server shutdown time.
     */

    <a href="/cvs/aolserver/aolserver/nsd/callbacks.c#A_Ns_RegisterAtShutdown">Ns_RegisterAtShutdown</a>(<a href="/cvs/aolserver/nsopenssl/nsopenssl.c#A_ServerShutdown">ServerShutdown</a>, (void *) server);

    return NS_OK;
}

/*
 *----------------------------------------------------------------------
 *
 * <a href="/cvs/aolserver/nsopenssl/nsopenssl.c#A_NsOpenSSLDebug">NsOpenSSLDebug</a> --
 *
 *    Write message to log file. When not in debug mode, no logging is done,
 *    function just returns.
 *
 *----------------------------------------------------------------------
 */

#if 0
extern void
<a href="/cvs/aolserver/nsopenssl/nsopenssl.c#A_NsOpenSSLDebug">NsOpenSSLDebug</a>(char *fmt, ...)
{
    va_list ap;
    Ns_LogSeverity severity = "Debug";
    char buf[1000];

    //va_start(ap, fmt);
    sprintf(&buf, fmt, ap);
    <a href="/cvs/aolserver/aolserver/nsd/log.c#A_Ns_Log">Ns_Log</a>(severity, &buf);
    //va_end(ap);

}
#endif


/*
 *----------------------------------------------------------------------
 *
 * <a href="/cvs/aolserver/nsopenssl/nsopenssl.c#A_InitServerState">InitServerState</a> --
 *
 *     Initialize a virtual server's state storage. This holds pointers to SSL
 *     contexts stored by name, as well as default client and server SSL
 *     contexts to use in cases where the programmer didn't explicitly name one
 *     to use.
 *
 * Results:
 *
 * Side effects:
 *
 *----------------------------------------------------------------------
 */

static void
<a href="/cvs/aolserver/nsopenssl/nsopenssl.c#A_InitServerState">InitServerState</a>(char *server)
{
    Server        *thisServer = NULL;
    Tcl_HashEntry *hPtr       = NULL;
    int            new        = 0;
    Ns_DString     ds;
    char          *lockName   = NULL;

    <a href="/cvs/aolserver/aolserver/nsd/dstring.c#A_Ns_DStringInit">Ns_DStringInit</a>(&ds);
    thisServer = ns_malloc(sizeof(Server));
    if (thisServer == NULL) {
        <a href="/cvs/aolserver/aolserver/nsd/log.c#A_Ns_Log">Ns_Log</a>(Fatal, "%s (%s): memory allocation failed");
    }
    thisServer->server = server;
    thisServer->defaultservercontext = NULL;
    thisServer->defaultclientcontext = NULL;
    thisServer->nextSessionCacheId = 1;
    Ns_MutexInit(&thisServer->lock);
    <a href="/cvs/aolserver/aolserver/nsd/dstring.c#A_Ns_DStringPrintf">Ns_DStringPrintf</a>(&ds, "server:%s", server);
    lockName = <a href="/cvs/aolserver/aolserver/nsd/dstring.c#A_Ns_DStringExport">Ns_DStringExport</a>(&ds);
    Ns_MutexSetName2(&thisServer->lock, MODULE_SHORT, lockName);
    <a href="/cvs/aolserver/aolserver/nsd/dstring.c#A_Ns_DStringTrunc">Ns_DStringTrunc</a>(&ds, 0);
    ns_free(lockName);
    lockName = NULL;
    hPtr = Tcl_CreateHashEntry(&NsOpenSSLServers, server, &new);
    Tcl_SetHashValue(hPtr, thisServer);
    Tcl_InitHashTable(&thisServer->sslcontexts, TCL_STRING_KEYS);
    Tcl_InitHashTable(&thisServer->ssldrivers, TCL_STRING_KEYS);

    return;
}


/*
 *----------------------------------------------------------------------
 *
 * <a href="/cvs/aolserver/nsopenssl/nsopenssl.c#A_LoadSSLContexts">LoadSSLContexts</a> --
 *
 *       Load the SSL context for a virtual server.
 *
 * Results:
 *       NS_OK or NS_ERROR
 *
 * Side effects:
 *       Registers driver with AOLserver core.
 *
 *----------------------------------------------------------------------
 */

static void
<a href="/cvs/aolserver/nsopenssl/nsopenssl.c#A_LoadSSLContexts">LoadSSLContexts</a>(char *server)
{
    Server           *thisServer  = <a href="/cvs/aolserver/nsopenssl/sslcontext.c#A_NsOpenSSLServerGet">NsOpenSSLServerGet</a>(server);
    NsOpenSSLContext *sslcontext  = NULL;
    Ns_Set           *sslcontexts = NULL;
    Ns_Set           *defaults    = NULL;
    char             *path        = NULL;
    char             *name        = NULL;
    char             *value       = NULL;
    int               i           = 0;

    path = <a href="/cvs/aolserver/aolserver/nsd/config.c#A_Ns_ConfigGetPath">Ns_ConfigGetPath</a>(server, MODULE, "sslcontexts", NULL);
    sslcontexts = <a href="/cvs/aolserver/aolserver/nsd/config.c#A_Ns_ConfigGetSection">Ns_ConfigGetSection</a>(path);

    /* 
     * If no SSL contexts are defined for this virtual server, we won't start
     * any drivers for it, and we won't be able to use SSL at all. I'll soon be
     * adding the capability to build SSL contexts with the Tcl API dynamically
     * so it will make sense to do this at some point in the future if you want
     * to manage SSL conns but not through the AOLserver comm API.
     */

    if (sslcontexts == NULL) {
        <a href="/cvs/aolserver/aolserver/nsd/log.c#A_Ns_Log">Ns_Log</a>(Notice, "%s (%s): no SSL contexts defined for this server", 
                server, MODULE);
        return;
    }
    for (i = 0; i < Ns_SetSize(sslcontexts); ++i) {
        name = Ns_SetKey(sslcontexts, i);
        <a href="/cvs/aolserver/aolserver/nsd/log.c#A_Ns_Log">Ns_Log</a>(Notice, "%s (%s): loading SSL context '%s'", MODULE, server, name);
        sslcontext = <a href="/cvs/aolserver/nsopenssl/nsopenssl.c#A_LoadSSLContext">LoadSSLContext</a>(server, name);
        <a href="/cvs/aolserver/nsopenssl/sslcontext.c#A_NsOpenSSLContextAdd">NsOpenSSLContextAdd</a>(server, sslcontext);
        if (<a href="/cvs/aolserver/nsopenssl/sslcontext.c#A_NsOpenSSLContextInit">NsOpenSSLContextInit</a>(server, sslcontext) == NS_ERROR) {
            <a href="/cvs/aolserver/aolserver/nsd/log.c#A_Ns_Log">Ns_Log</a>(Error, "%s (%s): SSL context '%s' left uninitialized",
                    MODULE, server, name);
        }
    }

    /*
     * Set default server SSL client and server contexts. These are used in
     * cases where the C or Tcl programmer does not specify what named SSL
     * context to use.
     */

    path = <a href="/cvs/aolserver/aolserver/nsd/config.c#A_Ns_ConfigGetPath">Ns_ConfigGetPath</a>(server, MODULE, "defaults", NULL);
    defaults = <a href="/cvs/aolserver/aolserver/nsd/config.c#A_Ns_ConfigGetSection">Ns_ConfigGetSection</a>(path);
    if (defaults == NULL) {
        <a href="/cvs/aolserver/aolserver/nsd/log.c#A_Ns_Log">Ns_Log</a>(Notice, "%s (%s): no default SSL contexts defined for this server", 
                MODULE, server);
        return;
    }
    for (i = 0; i < Ns_SetSize(defaults); ++i) {
        name = Ns_SetKey(defaults, i);
        value = <a href="/cvs/aolserver/aolserver/nsd/config.c#A_Ns_ConfigGetValue">Ns_ConfigGetValue</a>(path, name);
        sslcontext = <a href="/cvs/aolserver/nsopenssl/sslcontext.c#A_Ns_OpenSSLServerSSLContextGet">Ns_OpenSSLServerSSLContextGet</a>(server, value);
        if (sslcontext != NULL) {
            <a href="/cvs/aolserver/aolserver/nsd/log.c#A_Ns_Log">Ns_Log</a>(Notice, "%s (%s): default SSL context for %s is %s", MODULE, server, name, value);
            if (STRIEQ(name, "server")) {
                thisServer->defaultservercontext = value;
                <a href="/cvs/aolserver/aolserver/nsd/log.c#A_Ns_Log">Ns_Log</a>(Notice, "default server SSL context: %s", thisServer->defaultservercontext);
            } else if (STRIEQ(name, "client")) {
                thisServer->defaultclientcontext = value;
                <a href="/cvs/aolserver/aolserver/nsd/log.c#A_Ns_Log">Ns_Log</a>(Notice, "default client SSL context: %s", thisServer->defaultclientcontext);
            } else {
                <a href="/cvs/aolserver/aolserver/nsd/log.c#A_Ns_Log">Ns_Log</a>(Error, "%s (%s): bad parameter '%s' for default contexts",
                        MODULE, server, name);
            }
        } else {
            <a href="/cvs/aolserver/aolserver/nsd/log.c#A_Ns_Log">Ns_Log</a>(Error, "%s (%s): SSL context '%s' doesn't exist; can't use it as a default",
                    MODULE, server, value);
        }
    }
}


/*
 *----------------------------------------------------------------------
 *
 * <a href="/cvs/aolserver/nsopenssl/nsopenssl.c#A_LoadSSLContext">LoadSSLContext</a> --
 *
 *     Load values for a given SSL context from the configuration file.
 *
 * Results:
 *     Pointer to SSL Context or NULL
 *
 * Side effects:
 *     Memory may be allocated
 *
 *----------------------------------------------------------------------
 */

static NsOpenSSLContext *
<a href="/cvs/aolserver/nsopenssl/nsopenssl.c#A_LoadSSLContext">LoadSSLContext</a>(char *server, char *name)
{
    NsOpenSSLContext *sslcontext           = NULL;
    char             *role                 = NULL;
    char             *path                 = NULL;
    char             *moduleDir            = NULL;
    char             *certFile             = NULL;
    char             *keyFile              = NULL;
    char             *caFile               = NULL;
    char             *caDir                = NULL;
    char             *protocols            = NULL;
    char             *cipherSuite          = NULL;
    int               sessionCache         = DEFAULT_SESSION_CACHE;
    int               sessionCacheSize     = DEFAULT_SESSION_CACHE_SIZE;
    int               sessionCacheTimeout  = DEFAULT_SESSION_CACHE_TIMEOUT;
    int               peerVerify           = DEFAULT_PEER_VERIFY;
    int               peerVerifyDepth      = DEFAULT_PEER_VERIFY_DEPTH;
    int               trace                = DEFAULT_TRACE;

    path = <a href="/cvs/aolserver/aolserver/nsd/config.c#A_Ns_ConfigGetPath">Ns_ConfigGetPath</a>(server, MODULE, "sslcontext", name, NULL);
    if (path == NULL) {
        <a href="/cvs/aolserver/aolserver/nsd/log.c#A_Ns_Log">Ns_Log</a>(Error, "%s (%s): failed to find SSL context '%s' in configuration file",
                MODULE, server, name);
        return NULL;
    }
    sslcontext = <a href="/cvs/aolserver/nsopenssl/sslcontext.c#A_NsOpenSSLContextCreate">NsOpenSSLContextCreate</a>(server, name);

    /*
     * Must be "client" or "server"
     */

    role = <a href="/cvs/aolserver/aolserver/nsd/config.c#A_Ns_ConfigGetValue">Ns_ConfigGetValue</a>(path, "role");
    if (role != NULL) {
        <a href="/cvs/aolserver/nsopenssl/sslcontext.c#A_NsOpenSSLContextRoleSet">NsOpenSSLContextRoleSet</a>(server, sslcontext, role);
    }

    /*
     * A default module directory is automatically set when the SSL context was
     * created, but you can override in the config file.
     */

    moduleDir = <a href="/cvs/aolserver/aolserver/nsd/config.c#A_Ns_ConfigGetValue">Ns_ConfigGetValue</a>(path, "moduledir");
    if (moduleDir != NULL) {
        <a href="/cvs/aolserver/nsopenssl/sslcontext.c#A_NsOpenSSLContextModuleDirSet">NsOpenSSLContextModuleDirSet</a>(server, sslcontext, moduleDir);
    }

    /*
     * SSL clients don't require certificates, but SSL servers do. If certfile
     * or keyfile are NULL, are not found, or are not accessible, we'll fail
     * later when we try to instantiate the SSL context.
     */

    certFile = <a href="/cvs/aolserver/aolserver/nsd/config.c#A_Ns_ConfigGetValue">Ns_ConfigGetValue</a>(path, "certfile");
    if (certFile != NULL) {
        <a href="/cvs/aolserver/nsopenssl/sslcontext.c#A_NsOpenSSLContextCertFileSet">NsOpenSSLContextCertFileSet</a>(server, sslcontext, certFile);
    }
    keyFile = <a href="/cvs/aolserver/aolserver/nsd/config.c#A_Ns_ConfigGetValue">Ns_ConfigGetValue</a>(path, "keyfile");
    if (keyFile != NULL) {
        <a href="/cvs/aolserver/nsopenssl/sslcontext.c#A_NsOpenSSLContextKeyFileSet">NsOpenSSLContextKeyFileSet</a>(server, sslcontext, keyFile);
    }

    /*
     * The default protocols and ciphersuites are good for general use.
     */

    protocols = <a href="/cvs/aolserver/aolserver/nsd/config.c#A_Ns_ConfigGetValue">Ns_ConfigGetValue</a>(path, "protocols");
    if (protocols != NULL) {
        <a href="/cvs/aolserver/nsopenssl/sslcontext.c#A_NsOpenSSLContextProtocolsSet">NsOpenSSLContextProtocolsSet</a>(server, sslcontext, protocols);
    }
    cipherSuite = <a href="/cvs/aolserver/aolserver/nsd/config.c#A_Ns_ConfigGetValue">Ns_ConfigGetValue</a>(path, "ciphersuite");
    if (cipherSuite != NULL) {
        <a href="/cvs/aolserver/nsopenssl/sslcontext.c#A_NsOpenSSLContextCipherSuiteSet">NsOpenSSLContextCipherSuiteSet</a>(server, sslcontext, cipherSuite);
    }

    /*
     * The CA file/dir isn't necessary unless you actually do cert
     * verification. The CA file is simply a bunch of PEM-format CA
     * certificates concatenated together.
     */

    caFile = <a href="/cvs/aolserver/aolserver/nsd/config.c#A_Ns_ConfigGetValue">Ns_ConfigGetValue</a>(path, "cafile");
    if (caFile != NULL) {
        <a href="/cvs/aolserver/nsopenssl/sslcontext.c#A_NsOpenSSLContextCAFileSet">NsOpenSSLContextCAFileSet</a>(server, sslcontext, caFile);
    }
    caDir = <a href="/cvs/aolserver/aolserver/nsd/config.c#A_Ns_ConfigGetValue">Ns_ConfigGetValue</a>(path, "cadir");
    if (caDir != NULL) {
        <a href="/cvs/aolserver/nsopenssl/sslcontext.c#A_NsOpenSSLContextCADirSet">NsOpenSSLContextCADirSet</a>(server, sslcontext, caDir);
    }

    /*
     * Peer verification will cause the server to request a client certificate.
     * If you aren't sure whether to turn it on or not, leave it off!
     */

    if (<a href="/cvs/aolserver/aolserver/nsd/config.c#A_Ns_ConfigGetBool">Ns_ConfigGetBool</a>(path, "peerverify", &peerVerify) == NS_TRUE) {
        <a href="/cvs/aolserver/nsopenssl/sslcontext.c#A_NsOpenSSLContextPeerVerifySet">NsOpenSSLContextPeerVerifySet</a>(server, sslcontext, peerVerify);
    }

    /*
     * A certificate may be at the bottom of a chain. Verify depth determines
     * how many levels down from the root cert you're willing to trust..
     */

    if (<a href="/cvs/aolserver/aolserver/nsd/config.c#A_Ns_ConfigGetInt">Ns_ConfigGetInt</a>(path, "peerverifydepth", &peerVerifyDepth) == NS_TRUE) {
        <a href="/cvs/aolserver/nsopenssl/sslcontext.c#A_NsOpenSSLContextPeerVerifyDepthSet">NsOpenSSLContextPeerVerifyDepthSet</a>(server, sslcontext, peerVerifyDepth);
    }

    /*
     * Session caching defaults to on, and should always be on if you
     * have web browsers connecting. Some versions of MSIE and Netscape will
     * fail if you don't have session caching on.
     */

    <a href="/cvs/aolserver/aolserver/nsd/config.c#A_Ns_ConfigGetBool">Ns_ConfigGetBool</a>(path, "sessioncache", &sessionCache);
    if (sessionCache == NS_TRUE) {
        <a href="/cvs/aolserver/nsopenssl/sslcontext.c#A_NsOpenSSLContextSessionCacheSet">NsOpenSSLContextSessionCacheSet</a>(server, sslcontext, sessionCache);
    }
    if (<a href="/cvs/aolserver/aolserver/nsd/config.c#A_Ns_ConfigGetInt">Ns_ConfigGetInt</a>(path, "sessioncachesize", &sessionCacheSize) == NS_TRUE) {
        <a href="/cvs/aolserver/nsopenssl/sslcontext.c#A_NsOpenSSLContextSessionCacheSizeSet">NsOpenSSLContextSessionCacheSizeSet</a>(server, sslcontext, sessionCacheSize);
    }
    if (<a href="/cvs/aolserver/aolserver/nsd/config.c#A_Ns_ConfigGetInt">Ns_ConfigGetInt</a>(path, "sessioncachetimeout", &sessionCacheTimeout) == NS_TRUE) {
        <a href="/cvs/aolserver/nsopenssl/sslcontext.c#A_NsOpenSSLContextSessionCacheTimeoutSet">NsOpenSSLContextSessionCacheTimeoutSet</a>(server, sslcontext, sessionCacheTimeout);
    }

    /*
     * Trace SSL handshake.
     */

    <a href="/cvs/aolserver/aolserver/nsd/config.c#A_Ns_ConfigGetBool">Ns_ConfigGetBool</a>(path, "trace", &trace);
    if (trace == NS_TRUE) {
        <a href="/cvs/aolserver/nsopenssl/sslcontext.c#A_NsOpenSSLContextTraceSet">NsOpenSSLContextTraceSet</a>(server, sslcontext, 1);
    } else {
        <a href="/cvs/aolserver/nsopenssl/sslcontext.c#A_NsOpenSSLContextTraceSet">NsOpenSSLContextTraceSet</a>(server, sslcontext, 0);
    }

    return sslcontext;
}


/*
 *----------------------------------------------------------------------
 *
 * <a href="/cvs/aolserver/nsopenssl/nsopenssl.c#A_ServerShutdown">ServerShutdown</a> --
 *
 *      Cleanup function to run at server shutdown.
 *
 * Results:
 *      None.
 *
 * Side effects:
 *      None.
 *
 *----------------------------------------------------------------------
 */

static void
<a href="/cvs/aolserver/nsopenssl/nsopenssl.c#A_ServerShutdown">ServerShutdown</a>(void *arg)
{
    char *server = (char *) arg;

    <a href="/cvs/aolserver/aolserver/nsd/log.c#A_Ns_Log">Ns_Log</a>(Notice, "Shutdown called for server %s", server);

    /*
     *   for each vserver.driver
     *       for each vserver.driver.conn
     *           close, free
     *       endfor
     *       free vserver.driver
     *   endfor
     *   free vserver
     */

    return;
}


/*
 *----------------------------------------------------------------------
 *
 * <a href="/cvs/aolserver/nsopenssl/nsopenssl.c#A_InitOpenSSL">InitOpenSSL</a> --
 *
 *       Initialize the OpenSSL library.
 *
 * Results:
 *       NS_OK
 *
 * Side effects:
 *       Sets OpenSSL threading callbacks, seeds the pseudo random number
 *       generator, initializes SSL session caching id generation.
 *
 *----------------------------------------------------------------------
 */

static int
<a href="/cvs/aolserver/nsopenssl/nsopenssl.c#A_InitOpenSSL">InitOpenSSL</a>(void)
{
    int        i         = 0;
    int        seedcnt   = 0;
    size_t     num_locks = 0;
    char      *lockName  = NULL;
    Ns_DString ds;

    <a href="/cvs/aolserver/aolserver/nsd/dstring.c#A_Ns_DStringInit">Ns_DStringInit</a>(&ds);

    /*
     * Initialize OpenSSL callbacks
     */

    if (CRYPTO_set_mem_functions(ns_malloc, ns_realloc, ns_free) == 0)
        <a href="/cvs/aolserver/aolserver/nsd/log.c#A_Ns_Log">Ns_Log</a>(Warning, "%s: OpenSSL memory callbacks failed in <a href="/cvs/aolserver/nsopenssl/nsopenssl.c#A_InitOpenSSL">InitOpenSSL</a>",
                MODULE);
    num_locks = CRYPTO_num_locks();
    locks = ns_calloc(num_locks, sizeof(*locks));
    for (i = 0; i < num_locks; i++) {
        <a href="/cvs/aolserver/aolserver/nsd/dstring.c#A_Ns_DStringPrintf">Ns_DStringPrintf</a>(&ds, "crypto:%d", i);
        lockName = <a href="/cvs/aolserver/aolserver/nsd/dstring.c#A_Ns_DStringExport">Ns_DStringExport</a>(&ds);
        Ns_MutexSetName2(locks + i, MODULE_SHORT, lockName);
        <a href="/cvs/aolserver/aolserver/nsd/dstring.c#A_Ns_DStringTrunc">Ns_DStringTrunc</a>(&ds, 0);
        ns_free(lockName);
        lockName = NULL;
    }
    <a href="/cvs/aolserver/aolserver/nsd/dstring.c#A_Ns_DStringFree">Ns_DStringFree</a>(&ds);
    CRYPTO_set_locking_callback(<a href="/cvs/aolserver/nsopenssl/nsopenssl.c#A_ThreadLockCallback">ThreadLockCallback</a>);
    CRYPTO_set_id_callback(<a href="/cvs/aolserver/nsopenssl/nsopenssl.c#A_ThreadIdCallback">ThreadIdCallback</a>);

    /*
     * Initialize the OpenSSL library itself
     */

    SSL_load_error_strings();
    OpenSSL_add_ssl_algorithms();
    SSL_library_init();
    X509V3_add_standard_extensions();

    /*
     * Seed the OpenSSL Pseudo-Random Number Generator.
     */

    while (! RAND_status() && seedcnt < 3) {
        seedcnt++;
        <a href="/cvs/aolserver/aolserver/nsd/log.c#A_Ns_Log">Ns_Log</a>(Notice, "%s: Seeding OpenSSL's PRNG", MODULE);
        <a href="/cvs/aolserver/nsopenssl/nsopenssl.c#A_SeedPRNG">SeedPRNG</a>();
    }
    if (! RAND_status()) {
        <a href="/cvs/aolserver/aolserver/nsd/log.c#A_Ns_Log">Ns_Log</a>(Warning, "%s: PRNG fails to have enough entropy after %d tries", 
                MODULE, seedcnt);
    }

    return NS_OK;
}


/*
 *----------------------------------------------------------------------
 *
 * <a href="/cvs/aolserver/nsopenssl/nsopenssl.c#A_SeedPRNG">SeedPRNG</a> --
 *
 *       Seed OpenSSL's PRNG. OpenSSL will seed the PRNG transparently if
 *       /dev/urandom is available.
 *
 * Results:
 *       NS_TRUE or NS_FALSE.
 *
 * Side effects:
 *       An NS_FALSE will result in the connection failing. This function
 *       might be called at any time by the temporary key generating
 *       function if the PRNG is not sufficiently entropinous (yes, I
 *       made that word up).
 *       
 *
 *----------------------------------------------------------------------
 */

static int
<a href="/cvs/aolserver/nsopenssl/nsopenssl.c#A_SeedPRNG">SeedPRNG</a>(void)
{
    double *buf_ptr       = NULL;
    double *bufoffset_ptr = NULL;
    char   *path          = NULL;
    char   *randomFile    = NULL;
    size_t  size          = 0;
    int     i             = 0;
    int     seedBytes     = 0;
    int     readBytes     = 0;
    int     maxBytes      = 0;

    if (RAND_status()) {
        return NS_TRUE;
    } 
    path = <a href="/cvs/aolserver/aolserver/nsd/config.c#A_Ns_ConfigGetPath">Ns_ConfigGetPath</a>(NULL, MODULE, NULL);
    if (<a href="/cvs/aolserver/aolserver/nsd/config.c#A_Ns_ConfigGetInt">Ns_ConfigGetInt</a>(path, "seedbytes", &seedBytes) == NS_FALSE) {
        seedBytes = DEFAULT_SEEDBYTES;
    }
    if (<a href="/cvs/aolserver/aolserver/nsd/config.c#A_Ns_ConfigGetInt">Ns_ConfigGetInt</a>(path, "maxbytes", &maxBytes) == NS_FALSE) {
        maxBytes = DEFAULT_MAXBYTES;
    }

    /*
     * Try to use the file specified by the user. If PRNG fails to seed here,
     * you might try increasing the seedBytes parameter in nsd.tcl.
     */

    randomFile = <a href="/cvs/aolserver/aolserver/nsd/config.c#A_Ns_ConfigGetValue">Ns_ConfigGetValue</a>(path, "randomfile");
    if (randomFile != NULL && access(randomFile, F_OK) == 0) {
        if ((readBytes = RAND_load_file(randomFile, maxBytes))) {
            <a href="/cvs/aolserver/aolserver/nsd/log.c#A_Ns_Log">Ns_Log</a>(Notice, "%s: Obtained %d random bytes from %s",
                    MODULE, readBytes, randomFile);
        } else {
            <a href="/cvs/aolserver/aolserver/nsd/log.c#A_Ns_Log">Ns_Log</a>(Warning, "%s: Unable to retrieve any random data from %s",
                    MODULE, randomFile);
        }
    } else {
        <a href="/cvs/aolserver/aolserver/nsd/log.c#A_Ns_Log">Ns_Log</a>(Warning, "%s: No randomFile set and/or found", MODULE);
    }
    if (RAND_status()) {
        return NS_TRUE;
    }

    /*
     * Use <a href="/cvs/aolserver/aolserver/nsd/random.c#A_Ns_DRand">Ns_DRand</a>(), passing it seedBytes as the second argument to RAND_add.
     */

    size = sizeof(double) * seedBytes;
    buf_ptr = Ns_Malloc(size);
    bufoffset_ptr = buf_ptr;
    for (i = 0; i < seedBytes; i++) {
        *bufoffset_ptr = <a href="/cvs/aolserver/aolserver/nsd/random.c#A_Ns_DRand">Ns_DRand</a>();
        bufoffset_ptr++;
    }
    RAND_add(buf_ptr, seedBytes, (double) seedBytes);
    ns_free(buf_ptr);
    if (!RAND_status()) {
        <a href="/cvs/aolserver/aolserver/nsd/log.c#A_Ns_Log">Ns_Log</a>(Warning, "%s: failed to seed PRNG", MODULE);
        return NS_FALSE;
    }

    return NS_TRUE;
}


/*
 *----------------------------------------------------------------------
 *
 * <a href="/cvs/aolserver/nsopenssl/nsopenssl.c#A_ThreadLockCallback">ThreadLockCallback</a> --
 *
 *      Lock or unlock a mutex for OpenSSL.
 *
 * Results:
 *      None.
 *
 * Side effects:
 *      None.
 *
 *----------------------------------------------------------------------
 */

static void
<a href="/cvs/aolserver/nsopenssl/nsopenssl.c#A_ThreadLockCallback">ThreadLockCallback</a>(int mode, int n, const char *file, int line)
{
    if (mode & CRYPTO_LOCK) {
        Ns_MutexLock(locks + n);
    } else {
        Ns_MutexUnlock(locks + n);
    }
}


/*
 *----------------------------------------------------------------------
 *
 * <a href="/cvs/aolserver/nsopenssl/nsopenssl.c#A_ThreadIdCallback">ThreadIdCallback</a> --
 *
 *      Return this thread's id for OpenSSL.
 *
 * Results:
 *      None.
 *
 * Side effects:
 *      None.
 *
 *----------------------------------------------------------------------
 */

static unsigned long
<a href="/cvs/aolserver/nsopenssl/nsopenssl.c#A_ThreadIdCallback">ThreadIdCallback</a>(void)
{
    return (unsigned long) Ns_ThreadId();
}


/*
 *----------------------------------------------------------------------
 *
 * <a href="/cvs/aolserver/nsopenssl/nsopenssl.c#A_ThreadDynlockCreateCallback">ThreadDynlockCreateCallback</a> --
 *
 *      Create a dynamically-allocated mutex for OpenSSL.
 *
 * Results:
 *      None.
 *
 * Side effects:
 *      None.
 *
 *----------------------------------------------------------------------
 */

static struct CRYPTO_dynlock_value *
<a href="/cvs/aolserver/nsopenssl/nsopenssl.c#A_ThreadDynlockCreateCallback">ThreadDynlockCreateCallback</a>(char *file, int line)
{
    Ns_Mutex   *lock = NULL;
    Ns_DString  ds;

    <a href="/cvs/aolserver/aolserver/nsd/dstring.c#A_Ns_DStringInit">Ns_DStringInit</a>(&ds);
    lock = ns_calloc(1, sizeof(*lock));
    <a href="/cvs/aolserver/aolserver/nsd/dstring.c#A_Ns_DStringVarAppend">Ns_DStringVarAppend</a>(&ds, "openssl: ", file, ": ");
    <a href="/cvs/aolserver/aolserver/nsd/dstring.c#A_Ns_DStringPrintf">Ns_DStringPrintf</a>(&ds, "%d", line);
    Ns_MutexSetName2(lock, MODULE, <a href="/cvs/aolserver/aolserver/nsd/dstring.c#A_Ns_DStringValue">Ns_DStringValue</a>(&ds));

    return (struct CRYPTO_dynlock_value *) lock;
}


/*
 *----------------------------------------------------------------------
 *
 * <a href="/cvs/aolserver/nsopenssl/nsopenssl.c#A_ThreadDynlockLockCallback">ThreadDynlockLockCallback</a> --
 *
 *      Lock or unlock a dynamically-allocated mutex for OpenSSL.
 *
 * Results:
 *      None.
 *
 * Side effects:
 *      None.
 *
 *----------------------------------------------------------------------
 */

static void
<a href="/cvs/aolserver/nsopenssl/nsopenssl.c#A_ThreadDynlockLockCallback">ThreadDynlockLockCallback</a>(int mode, struct CRYPTO_dynlock_value *dynlock,
        const char *file, int line)
{
    if (mode & CRYPTO_LOCK) {
        Ns_MutexLock((Ns_Mutex *) dynlock);
    } else {
        Ns_MutexUnlock((Ns_Mutex *) dynlock);
    }
}


/*
 *----------------------------------------------------------------------
 *
 * <a href="/cvs/aolserver/nsopenssl/nsopenssl.c#A_ThreadDynlockDestroyCallback">ThreadDynlockDestroyCallback</a> --
 *
 *      Destroy a dynamically-allocated mutex for OpenSSL.
 *
 * Results:
 *      None.
 *
 * Side effects:
 *      None.
 *
 *----------------------------------------------------------------------
 */

static void
<a href="/cvs/aolserver/nsopenssl/nsopenssl.c#A_ThreadDynlockDestroyCallback">ThreadDynlockDestroyCallback</a>(struct CRYPTO_dynlock_value *dynlock,
        const char *file, int line)
{
    Ns_MutexDestroy((Ns_Mutex *) dynlock);
}


/*
 *----------------------------------------------------------------------
 *
 * <a href="/cvs/aolserver/nsopenssl/nsopenssl.c#A_LoadSSLDrivers">LoadSSLDrivers</a> --
 *
 *       Load the SSL drivers for a virtual server.
 *
 * Results:
 *       NS_OK or NS_ERROR
 *
 * Side effects:
 *       Registers driver with AOLserver core.
 *
 *----------------------------------------------------------------------
 */

static void
<a href="/cvs/aolserver/nsopenssl/nsopenssl.c#A_LoadSSLDrivers">LoadSSLDrivers</a>(char *server)
{
    NsOpenSSLContext *sslcontext     = NULL;
    NsOpenSSLDriver  *ssldriver      = NULL;
    Ns_Set           *ssldrivers     = NULL;
    char             *path           = NULL;
    char             *name           = NULL; 
    char             *sslcontextname = NULL;
    int               i              = 0;

    path = <a href="/cvs/aolserver/aolserver/nsd/config.c#A_Ns_ConfigGetPath">Ns_ConfigGetPath</a>(server, MODULE, "ssldrivers", NULL);
    ssldrivers = <a href="/cvs/aolserver/aolserver/nsd/config.c#A_Ns_ConfigGetSection">Ns_ConfigGetSection</a>(path);
    if (ssldrivers == NULL) {
        <a href="/cvs/aolserver/aolserver/nsd/log.c#A_Ns_Log">Ns_Log</a>(Notice, "%s (%s): no SSL drivers defined for this server", 
                MODULE, server);
        return;
    }
    for (i = 0; i < Ns_SetSize(ssldrivers); ++i) {
        name = Ns_SetKey(ssldrivers, i);
        <a href="/cvs/aolserver/aolserver/nsd/log.c#A_Ns_Log">Ns_Log</a>(Notice, "%s (%s): loading '%s' SSL driver", MODULE, server, name);
        path = <a href="/cvs/aolserver/aolserver/nsd/config.c#A_Ns_ConfigGetPath">Ns_ConfigGetPath</a>(server, MODULE, "ssldriver", name, NULL);
        if (path == NULL) {
            <a href="/cvs/aolserver/aolserver/nsd/log.c#A_Ns_Log">Ns_Log</a>(Error, "%s (%s): SSL driver '%s' not defined in configuration file",
                    MODULE, server, name);
            continue;
        }
        sslcontextname = <a href="/cvs/aolserver/aolserver/nsd/config.c#A_Ns_ConfigGetValue">Ns_ConfigGetValue</a>(path, "sslcontext");
        if (sslcontextname == NULL) {
            <a href="/cvs/aolserver/aolserver/nsd/log.c#A_Ns_Log">Ns_Log</a>(Error, "%s (%s): 'sslcontext' parameter not defined for driver '%s'",
                    MODULE, server, name);
            continue;
        }
        sslcontext = <a href="/cvs/aolserver/nsopenssl/sslcontext.c#A_Ns_OpenSSLServerSSLContextGet">Ns_OpenSSLServerSSLContextGet</a>(server, sslcontextname);
        if (sslcontext == NULL) {
            <a href="/cvs/aolserver/aolserver/nsd/log.c#A_Ns_Log">Ns_Log</a>(Error, "%s (%s): SSL context '%s' needed by driver '%s' not found",
                    MODULE, server, sslcontextname, name);
            continue;
        }

        /*
         * Create the driver.
         */

        ssldriver = ns_calloc(1, sizeof(NsOpenSSLDriver));
        ssldriver->server     = server;
        ssldriver->sslcontext = sslcontext;
        ssldriver->name       = name;
        ssldriver->path       = path;
        ssldriver->refcnt     = 0;
        if (!<a href="/cvs/aolserver/aolserver/nsd/config.c#A_Ns_ConfigGetInt">Ns_ConfigGetInt</a>(path, "port", &ssldriver->port)) {
            ssldriver->port = 443;
        }

        /*
         * Crank up the driver
         */

        if (<a href="/cvs/aolserver/nsopenssl/nsopenssl.c#A_InitSSLDriver">InitSSLDriver</a>(server, ssldriver) != NS_OK) { 

        }
    }
}


/*
 *----------------------------------------------------------------------
 *
 * <a href="/cvs/aolserver/nsopenssl/nsopenssl.c#A_InitSSLDriver">InitSSLDriver</a> --
 *
 *       Initialize an SSL driver.
 *
 * Results:
 *       NS_OK or NS_ERROR
 *
 * Side effects:
 *       Registers driver with AOLserver core.
 *
 *----------------------------------------------------------------------
 */

static int
<a href="/cvs/aolserver/nsopenssl/nsopenssl.c#A_InitSSLDriver">InitSSLDriver</a>(char *server, NsOpenSSLDriver *ssldriver)
{
    Ns_DriverInitData  init;
    Server            *thisServer = NULL;
    Tcl_HashEntry     *hPtr       = NULL;
    int                new        = 0;

    /*
     * Register the driver with AOLserver.
     */

    init.version = NS_DRIVER_VERSION_1;
    init.name    = MODULE;
    init.proc    = <a href="/cvs/aolserver/nsopenssl/nsopenssl.c#A_OpenSSLProc">OpenSSLProc</a>;
    init.opts    = NS_DRIVER_SSL;
    init.arg     = ssldriver;
    init.path    = ssldriver->path;

    if (<a href="/cvs/aolserver/aolserver/nsd/driver.c#A_Ns_DriverInit">Ns_DriverInit</a>(server, MODULE, &init) != NS_ERROR) {
        return NS_ERROR;
    }

    /*
     * Add the driver to the virtual server's state info.
     */

    thisServer = <a href="/cvs/aolserver/nsopenssl/sslcontext.c#A_NsOpenSSLServerGet">NsOpenSSLServerGet</a>(server);
    Ns_MutexLock(&thisServer->lock);
    hPtr = Tcl_CreateHashEntry(&thisServer->ssldrivers, ssldriver->name, &new);
    if (new) {
        Tcl_SetHashValue(hPtr, ssldriver);
    } else {
        <a href="/cvs/aolserver/aolserver/nsd/log.c#A_Ns_Log">Ns_Log</a>(Error, "%s (%s): duplicate SSL driver name: %s",
                MODULE, server, ssldriver->name);
        return NS_ERROR;
    }
    Ns_MutexUnlock(&thisServer->lock);

    return NS_OK;
}


/*
 *----------------------------------------------------------------------
 *
 * <a href="/cvs/aolserver/nsopenssl/nsopenssl.c#A_DestroySSLDriver">DestroySSLDriver</a> --
 *
 *      Destroy an SSL driver.
 *
 * Results:
 *      None.
 *
 * Side effects:
 *      None.
 *
 *----------------------------------------------------------------------
 */

#if 0
static void
<a href="/cvs/aolserver/nsopenssl/nsopenssl.c#A_DestroySSLDriver">DestroySSLDriver</a>(NsOpenSSLDriver *ssldriver)
{
    NsOpenSSLConn *sslconn;

    if (ssldriver == NULL) {
        return;
    }

    <a href="/cvs/aolserver/aolserver/nsd/log.c#A_Ns_Log">Ns_Log</a>(Notice, "%s (%s): shutting down driver '%s'", MODULE, 
            ssldriver->server, ssldriver->name);

    /*
     * Destroy connections that are still tied to this driver. We need to lock
     * the driver struct, set a flag that denotes it as no longer usable so new
     * conns that come in before we've free'd it will be refused.
     */

    /* XXX lock */
    if (ssldriver->refcnt > 0) {
        while ((sslconn = ssldriver->firstFreeConn) != NULL) {
            ssldriver->firstFreeConn = sslconn->next;
            /* XXX doesn't this need to have it's contents free'd? */
            ns_free(sslconn);
        }
    }

    Ns_MutexDestroy(&ssldriver->lock);

    /* XXX should an SSL context be deallocated when it's refcnt reaches 0 ??? */
    if (ssldriver->sslcontext != NULL) 
        ssldriver->sslcontext->refcnt--;

    ns_free(ssldriver);

    /*
     * Remove driver from server state linked list.
     */

    return;
}
#endif


/*            
 *----------------------------------------------------------------------
 *
 * <a href="/cvs/aolserver/nsopenssl/nsopenssl.c#A_OpenSSLProc">OpenSSLProc</a> --
 *
 *      SSL driver callback proc.  This driver performs the necessary
 *      handshake and encryption of SSL.
 *
 * Results:   
 *      For close, always 0.  For keep, 0 if connection could be
 *      properly flushed, -1 otherwise.  For send and recv, # of bytes
 *      processed or -1 on error.
 *
 * Side effects:
 *      None. 
 *            
 *----------------------------------------------------------------------
 */

static int
<a href="/cvs/aolserver/nsopenssl/nsopenssl.c#A_OpenSSLProc">OpenSSLProc</a>(Ns_DriverCmd cmd, Ns_Sock *sock, struct iovec *bufs, int nbufs)
{
    NsOpenSSLDriver *driver = (NsOpenSSLDriver *) sock->driver->arg;
    NsOpenSSLConn   *conn   = (NsOpenSSLConn *)   sock->arg;
    int n = -1, total, op;

    switch (cmd) {
        case DriverRecv:
        case DriverSend:
            if (conn == NULL) {
                /* 
                 * If first connection, wrap SSL around the socket.
                 */

                conn = NsOpenSSLConnCreate(sock->sock, driver->sslcontext);
                conn->refcnt++;
                conn->peerport  = driver->port;
                conn->recvwait  = sock->driver->recvwait;
                conn->sendwait  = sock->driver->sendwait;
                sock->arg       = (void *) conn;
            }

            /* 
             * Process each buffer one at a time.
             */

            op = (cmd == DriverSend) ? NSOPENSSL_SEND : NSOPENSSL_RECV;
            total = 0;
            do {
                n = NsOpenSSLConnOp(conn->ssl, bufs->iov_base,
                        (int) bufs->iov_len, op);
                if (n > 0) {
                    total += n;
                }
                ++bufs;
            } while (n > 0 && --nbufs > 0);
            if (n > 0) {
                n = total;
            }
            break;

        case DriverKeep:
            if (conn != NULL && NsOpenSSLConnFlush(conn) == NS_OK) {
                n = 0;
            } else {
                n = -1;
            }
            break;

        case DriverClose:
            if (conn != NULL) {
                (void) NsOpenSSLConnFlush(conn);
                NsOpenSSLConnDestroy(conn);
                sock->arg = NULL;
            }
            n = 0;
            break;

        default:
            <a href="/cvs/aolserver/aolserver/nsd/log.c#A_Ns_Log">Ns_Log</a>(Error, "%s (%s): Unsupported driver command '%d'", 
                    MODULE, driver->server, cmd);
            n = -1;
            break;
    }
    return n;
}
