sslsocket.h

Go to the documentation of this file.

#ifndef  DV_SSL_SSLSOCKET_H
#define  DV_SSL_SSLSOCKET_H
// $Id: sslsocket.h,v 1.10 2008/03/15 10:15:25 dvermeir Exp $

#include  <dvssl/sslbuffer.h>
#include  <dvnet/socket.h>

namespace Dv { 
  namespace Ssl { 
    class ServerSocket; 
    /** An iostream derived from Dv::Net::Socket. 
     * Example usage:
     * @code
     * Dv::Ssl::ContextV23 context;
     * Dv::Ssl::Socket client(context, "host.domain", 9999);
     * 
     * if (!client) {
     *   std::cerr << "connection failed: " << client.strerror() << endl;
     *   return 1;
     * }
     *
     * Dv::Ssl::X509Certificate cert(client);
     * std::cout << "client: certificate name = " << cert.name() << std::endl
     *   << "client: certificate issuer = " << cert.issuer() << std::endl;
     *
     * const std::string out("hello world");
     * client << out << std::endl;
     *
     * std::string line;
     * std::getline(client, line);
     * if (line!=out) {
     *   std::cerr << "Client expected \"" << out << "\", got \"" << line << "\"" << std::endl;
     *   return 1;
     * }
     *
     * std::cout << "Client exit status:" << client.strerror() << std::endl;
     * return client.error();
     * @endcode
     */ 
    class Socket: public Net::Socket { 
      /** Dv::Ssl::ServerSocket is a friend. */ 
      friend class Dv::Ssl::ServerSocket; 
      public: 
        /** Extra error codes (see Dv::Net::Socket) for SSL connections. */
        enum { SSL_CONNECTION_FAILED = -30, SSL_ACCEPT_FAILED = -31 }; 
        /** Constructor.  The Dv::Ssl::Context parameter need not contain private key or 
         * certificate file information since it is not used. 
         * @param context existing Dv::Ssl::Context object.
         * @param host name of host to connect to
         * @param port on host to connect to
         * @param bufsize size of input and output buffers
         * @param delay (in milliseconds) time allowed for any I/O operation to complete. 
         *   A value of 0 means ``wait forever''. Note that timedout() makes no sense
         *   if delay is 0.
         * @param min_debug_level if a debug_master is connected, logging info
         *   will only be written if the master's level is at least @a min_debug_level
         * @param debug_master from where debug info will be taken
         * @see Dv::DebugSlave
         * @warning the Dv::Ssl::Socket object does not own the Dv::Ssl::Context
         */ 
        Socket(Context& context,const std::string& host,int port, 
            size_t bufsize = 1024, int delay=0, unsigned int min_debug_level = 0,
            Debugable* debug_master = 0); 
        /** Destructor. */ 
        ~Socket(); 
        /** Return SSL* pointer, opaque to avoid inclusion of openssl header files. 
         * @return pointer to underlying SSL structure
         */
        void* ssl() const; 
        /** Return string representation of used cipher. 
         * @return pointer to string representation of used cypher 
         */
        const char* cipher() const; 
        /** Overrides Dv::Net::Socket::strerror.
         * @return string representation of last error.
         */ 
        std::string strerror() const; 
      private: 
        /** Constructor version used by Dv::Ssl::Socket::fs2socket.
         * @param context existing Dv::Ssl::Context object.
         * @param fd underlying file descriptor
         * @param bufsize size of input and output buffer
         * @param delay (in milliseconds) time allowed for any I/O operation to complete. 
         *   A value of 0 means ``wait forever''. Note that timedout() makes no sense
         *   if delay is 0.
         * @param min_debug_level if a debug_master is connected, logging info
         *   will only be written if the master's level is at least @a min_debug_level
         * @param debug_master from where debug info will be taken
         * @see Dv::DebugSlave
         * @warning the Dv::Ssl::Socket object does not own the Dv::Ssl::Context
         */ 
        Socket(Context& context,int fd,size_t bufsize=1024, int delay = 0,
            unsigned int min_debug_level = 0, Debugable* debug_master = 0); 
        /** This function is used internally by Dv::Ssl::ServerSocket::accept.
         * @param ctxt existing Dv::Ssl::Context object.
         * @param fd underlying file descriptor
         * @param bufsz size of input and output buffer
         * @param delay (in milliseconds) time allowed for any I/O operation to complete. 
         *   A value of 0 means ``wait forever''. Note that timedout() makes no sense
         *   if delay is 0.
         * @param min_debug_level if a debug_master is connected, logging info
         *   will only be written if the master's level is at least @a min_debug_level
         * @param debug_master from where debug info will be taken
         * @see Dv::DebugSlave
         * @warning the Dv::Ssl::Socket object does not own the Dv::Ssl::Context
         */ 
        static Dv::shared_ptr<Dv::Ssl::Socket> fd2sslsocket(Dv::Ssl::Context& ctxt, 
            int fd, size_t bufsz=1024, int delay=0, unsigned int min_debug_level = 0, 
            Debugable* debug_master = 0); 
        /** Associated SSL context. */ 
        Context& context_; 
        /** Associated streambuf. */ 
        Buffer* sslbuf_; 
    }; 
  }
}
#endif

---

dvssl-0.6.1 [15 March, 2008]