OW_SSLCtxMgr.hpp

Go to the documentation of this file.

/*******************************************************************************
* Copyright (C) 2001-2004 Vintela, Inc. All rights reserved.
* Copyright (C) 2004 Novell, Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
*  - Redistributions of source code must retain the above copyright notice,
*    this list of conditions and the following disclaimer.
*
*  - Redistributions in binary form must reproduce the above copyright notice,
*    this list of conditions and the following disclaimer in the documentation
*    and/or other materials provided with the distribution.
*
*  - Neither the name of Vintela, Inc. nor the names of its
*    contributors may be used to endorse or promote products derived from this
*    software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS''
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL Vintela, Inc. OR THE CONTRIBUTORS
* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*******************************************************************************/

#ifndef OW_SSLCtxMgr_HPP_INCLUDE_GUARD_
#define OW_SSLCtxMgr_HPP_INCLUDE_GUARD_
#include "OW_config.h"
#include "OW_SSLException.hpp"
#include "OW_IntrusiveCountableBase.hpp"
#include "OW_IntrusiveReference.hpp"
#include "OW_Map.hpp"
#ifdef OW_HAVE_OPENSSL
#include "OW_String.hpp"
#include <openssl/crypto.h>
#include <openssl/ssl.h>
#include <openssl/bio.h>
#define OW_SSLCTX_MAX_CN_LEN 256
#define OW_SSL_RETRY_LIMIT 20

namespace OW_NAMESPACE
{

typedef int (*certVerifyFuncPtr_t)(X509* cert, const String& hostName);

// TODO: Make this class be a singleton.
class OW_COMMON_API SSLCtxMgr
{
public:
   static int pem_passwd_cb(char* buf, int size, int rwflag, void *userData);
   static bool checkClientCert(SSL* ssl, const String& hostName);
   static bool checkServerCert(SSL* ssl, const String& hostName);
   static void initClient(const String& certFile = String(), const String& keyFile = String());
   static void initServer(const String& certFile, const String& keyFile = String());
   static SSL_CTX* getSSLCtxServer()
   {
      return m_ctxServer;
   }
   static SSL_CTX* getSSLCtxClient()
   {
      return m_ctxClient;
   }
   static int sslRead(SSL* ssl, char* buf, int len); 
   static int sslWrite(SSL* ssl, const char* buf, int len);
   static bool isClient() { return m_ctxClient != NULL; }
   static bool isServer() { return m_ctxServer != NULL; }
   static void setClientCertVerifyCallback(certVerifyFuncPtr_t cbfunc)
      { m_clientCertVerifyCB = cbfunc; }
   static void setServerCertVerifyCallback(certVerifyFuncPtr_t cbfunc)
      { m_serverCertVerifyCB = cbfunc; }
   // set type to NOT_INIT and free memory.
   static void uninit(); 
   static void generateEphRSAKey(SSL_CTX* ctx);

   static String getOpenSSLErrorDescription();

private:

   friend class SSLCtxBase;

   static SSL_CTX* m_ctxClient;
   static SSL_CTX* m_ctxServer;
   static certVerifyFuncPtr_t m_clientCertVerifyCB;
   static certVerifyFuncPtr_t m_serverCertVerifyCB;
   static SSL_CTX* initCtx(const String& certfile, const String& keyfile);
   static void loadDHParams(SSL_CTX* ctx, const String& file);
   static void uninitServer();
   static void uninitClient();

   // don't allow instantiation
   SSLCtxMgr();
   SSLCtxMgr(const SSLCtxMgr&);
   SSLCtxMgr& operator=(const SSLCtxMgr&);

   static bool checkCert(SSL* ssl, const String& hostName, certVerifyFuncPtr_t cbFunc);
};

struct OW_COMMON_API SSLOpts
{
   SSLOpts(); 
   String certfile; 
   String keyfile; 
   String trustStore; 
   enum VerifyMode_t
   {
      MODE_DISABLED, 
      MODE_REQUIRED, 
      MODE_OPTIONAL, 
      MODE_AUTOUPDATE
   }; 
   VerifyMode_t verifyMode; 
}; 


class OW_COMMON_API SSLCtxBase
{
public: 
   SSL_CTX* getSSLCtx() const; 

protected: 
   SSLCtxBase(const SSLOpts& opts); 
   virtual ~SSLCtxBase(); 
   SSL_CTX* m_ctx; 
};

class OW_COMMON_API SSLServerCtx : public SSLCtxBase, public IntrusiveCountableBase
{
public: 
   SSLServerCtx(const SSLOpts& opts); 
        static const int SSL_DATA_INDEX = 0; 
};

class OW_COMMON_API SSLClientCtx : public SSLCtxBase, public IntrusiveCountableBase
{
public: 
   SSLClientCtx(const SSLOpts& opts = SSLOpts()); 
};

typedef IntrusiveReference<SSLServerCtx> SSLServerCtxRef; 
typedef IntrusiveReference<SSLClientCtx> SSLClientCtxRef; 

class OW_COMMON_API SSLTrustStore: public IntrusiveCountableBase
{
public: 
   SSLTrustStore(const String& storeLocation); 
   void addCertificate(X509* cert, const String& user, const String& uid); 
   bool getUser(const String& certhash, String& user, String& uid); 

   static String getCertMD5Fingerprint(X509* cert); 
private: 
   String m_store; 
   String m_mapfile; 
   struct UserInfo
   {
      String user; 
      String uid; 
   };

#ifdef OW_WIN32
#pragma warning (push)
#pragma warning (disable: 4251)
#endif

   Map<String, UserInfo> m_map; 

#ifdef OW_WIN32
#pragma warning (pop)
#endif

   void readMap(); 
   void writeMap(); 

};

typedef IntrusiveReference<SSLTrustStore> SSLTrustStoreRef; 

struct OW_COMMON_API OWSSLContext
{
   enum CertVerifyState_t
   {
      VERIFY_NONE, 
      VERIFY_PASS, 
      VERIFY_FAIL
   }; 
    OWSSLContext(); 
    ~OWSSLContext(); 
    CertVerifyState_t peerCertPassedVerify; 
};



#else // ifdef OW_HAVE_OPENSSL

namespace OW_NAMESPACE
{

class OW_COMMON_API SSLServerCtx : public IntrusiveCountableBase
{
};

class OW_COMMON_API SSLClientCtx : public IntrusiveCountableBase
{
};

#endif // ifdef OW_HAVE_OPENSSL

typedef IntrusiveReference<SSLServerCtx> SSLServerCtxRef; 
typedef IntrusiveReference<SSLClientCtx> SSLClientCtxRef; 

} // end namespace OW_NAMESPACE


#endif

---