sslcontext.h

Go to the documentation of this file.

#ifndef DVSSL_SSLCONTEXT_H
#define DVSSL_SSLCONTEXT_H
// $Id: sslcontext.h,v 1.12 2008/03/15 10:15:25 dvermeir Exp $

/** @file 
 * This file defines Dv::Ssl::Context and its derived classes 
 * Dv::Ssl::ContextV2, Dv::Ssl::ContextV3 and Dv::Ssl::ContextV23.
*/

#include <string>
#include <stdexcept>

namespace Dv { 
  namespace Ssl { 
    /** Common base class represensting an SSL context. 
     * The constructors for a a Dv::Ssl::Socket and a Dv::Ssl::ServerSocket 
     * both have a required Dv::Ssl::Socket& argument.
     * 
     * Example usage: 
     * <ul> 
     * <li> For a server, the key and certificate file names are obligatory. 
     * @code 
     * try { 
     *   Dv::Ssl::ContextV23 context("key.pem", "cert.pem");
     *   Dv::Ssl::ServerSocket server(context, 9999); 
     *   ..
     * }
     * catch (std::exception& e) {
     *   ..
     * }
     * @endcode
     * <li> For a client, the key and certificate file are optional (and
     *  not used if present).
     * @code
     * try {
     *   Dv::Ssl::ContextV23    context;
     *   Dv::Ssl::Socket client(context, "host.domain", 9999);
     *   ..
     * }
     * catch (std::exception& e) {
     *   ..
     * }
     * @endcode
     * </ul>
     */ 
    class Context { 
      public:
        /** Destructor. */ 
        virtual ~Context();
        /** Return pointer to en openssl SSL_CTX structure. 
         * The pointer is declared void to avoid inclusion of openssl 
         * header files.
        */ 
        void* context() { return context_; } 
        /** Return name of private key filename or 0 if none.
         * @return name of private key filename
         * @return 0 if there is no private key filename
         */ 
        const std::string* rsa_private_key_file() const { return rsa_private_key_file_; }
        /** Return name of certificate filename or 0 if none.
         * @return name of certificate filename
         * @return 0 if there is no certificate filename
         */ 
        const std::string* certificate_file() const { return certificate_file_; } 
      protected: 
        /** Constructor is protected because only derived objects make sense. */ 
        Context() throw (std::runtime_error);
        /** Set private key file name associated with this context. 
         * @param filename to use as private key file
         * @return true if the operation succeeds
         * @return false if @a filename==0 or @a SSL_CTX_useBLBLA fails. 
         */ 
        bool rsa_private_key_file(const char* filename);
        /** Set certificate file name associated with this context. 
         * @param filename to use as certificate file
         * @return true if the operation succeeds
         * @return false if @a filename==0 or @a SSL_CTX_useBLBLA fails. 
         */ 
        bool certificate_file(const char* filename); 
        /** Pointer to SSL_CTX structure.  The pointer is
         * declared void to avoid inclusion of openssl header files. */
        void* context_; 
      private: 
        /** Forbidden. */
        Context(const Context&);
        /** Forbidden. */
        Context& operator=(const Context&); 
        std::string* rsa_private_key_file_;
        std::string* certificate_file_; 

        /** This class serves to initialize the openssl library. Only one 
         * static instance of this class is defined within the Dv::Ssl::Context
         * constructor. This ensures that the initialization within the constructor
         * Dv::Ssl::Init::Init() will be called exactly once. Similarly, the finalization will
         * be called at the end of the program by the Dv::Ssl::Init::~Init destructor.
         */
        class Init { 
          public: 
            /** Global initialization of openssl */
            Init() throw (std::runtime_error); 
            /** Finalization of openssl */
            ~Init(); 
        }; 
    }; 

    /** SSl V2 context. @sa Dv::Ssl::Context. */ 
    class ContextV2: public Context { 
      public: 
        /** Constructor.  If the context is to be used with a Dv::Ssl::ServerSocket object, 
         * both filename arguments are obligatory. If the context is to be used
         * with a Dv::Ssl::Socket object, the filename arguments 
         * are optional (but will not be used).
         */ 
        ContextV2(const char* keyfilename=0, const char* certfilename=0) 
          throw (std::runtime_error); 
        /** Destructor. */ 
        ~ContextV2(); 
    }; 

    /** SSl V23 context. @sa Dv::Ssl::Context. */ 
    class ContextV23: public Context { 
      public: 
        /** Constructor.  If the context is to be used with a Dv::Ssl::ServerSocket object, 
         * both filename arguments are obligatory. If the context is to be used with
         * a Dv::Ssl::Socket object, the filename arguments are optional
         * (but will not be used). */ 
        ContextV23(const char* keyfilename = 0, const char* certfilename = 0) 
          throw (std::runtime_error); 
        /** Destructor. */ 
        ~ContextV23(); 
    }; 

    /** SSl V3 context. @sa Dv::Ssl::Context. */ 
    class ContextV3: public Context { 
      public: 
        /** Constructor.  If the context is to be used with a Dv::Ssl::ServerSocket
         * object, both filename arguments are obligatory. If the context is to be used
         * with a Dv::Ssl::Socket object, the filename arguments are optional
         * (but will not be used). */ 
        ContextV3(const char* keyfilename = 0, const char* certfilename = 0) 
          throw (std::runtime_error);
        /** Destructor. */ 
        ~ContextV3(); 
    }; 
  }
}
#endif

---

dvssl-0.6.1 [15 March, 2008]