net::config::stream::tls::ConfigSocketClient< ConfigSocketClientBaseT > Class Template Reference

#include <ConfigSocketClient.h>

Inheritance diagram for net::config::stream::tls::ConfigSocketClient< ConfigSocketClientBaseT >:

Collaboration diagram for net::config::stream::tls::ConfigSocketClient< ConfigSocketClientBaseT >:

Public Member Functions
SSL_CTX *	getSslCtx ()
Public Member Functions inherited from net::config::ConfigInstance
	ConfigInstance (ConfigInstance &)=delete
	ConfigInstance (ConfigInstance &&)=delete
ConfigInstance &	operator= (ConfigInstance &)=delete
ConfigInstance &	operator= (ConfigInstance &&)=delete
Role	getRole ()
const std::string &	getInstanceName () const
void	setInstanceName (const std::string &instanceName)
bool	getDisabled () const
void	setDisabled (bool disabled=true)
Public Member Functions inherited from net::config::ConfigTlsClient
ConfigTlsClient &	setSni (const std::string &sni)
std::string	getSni () const
Public Member Functions inherited from net::config::ConfigTls
ConfigTls &	setInitTimeout (const utils::Timeval &newInitTimeout)
utils::Timeval	getInitTimeout () const
ConfigTls &	setShutdownTimeout (const utils::Timeval &newShutdownTimeout)
utils::Timeval	getShutdownTimeout () const
ConfigTls &	setCert (const std::string &cert)
std::string	getCert () const
ConfigTls &	setCertKey (const std::string &certKey)
std::string	getCertKey () const
ConfigTls &	setCertKeyPassword (const std::string &certKeyPassword)
std::string	getCertKeyPassword () const
ConfigTls &	setCaCert (const std::string &caCert)
std::string	getCaCert () const
ConfigTls &	setCaCertDir (const std::string &caCertDir)
std::string	getCaCertDir () const
ConfigTls &	setCaCertUseDefaultDir (bool set=true)
bool	getCaCertUseDefaultDir () const
ConfigTls &	setCaCertAcceptUnknown (bool set=true)
bool	getCaCertAcceptUnknown () const
ConfigTls &	setCipherList (const std::string &cipherList)
std::string	getCipherList () const
ConfigTls &	setSslOptions (ssl_option_t sslOptions)
ssl_option_t	getSslOptions () const
ConfigTls &	setNoCloseNotifyIsEOF (bool noCloseNotifyIsEOF=true)
bool	getNoCloseNotifyIsEOF () const

Protected Member Functions
	ConfigSocketClient (const std::string &name)
	~ConfigSocketClient () override
Protected Member Functions inherited from net::config::ConfigInstance
	ConfigInstance (const std::string &instanceName, Role role)
virtual	~ConfigInstance ()
Protected Member Functions inherited from net::config::ConfigTlsClient
	ConfigTlsClient (ConfigInstance *instance)
Protected Member Functions inherited from net::config::ConfigTls
	ConfigTls (ConfigInstance *instance)
Protected Member Functions inherited from net::config::ConfigSection
	ConfigSection (ConfigInstance *instance, const std::string &name, const std::string &description)
	ConfigSection (const ConfigSection &)=delete
	ConfigSection (ConfigSection &&)=delete
ConfigSection &	operator= (const ConfigSection &)=delete
ConfigSection &	operator= (ConfigSection &&)=delete
CLI::Option *	addOption (const std::string &name, const std::string &description)
CLI::Option *	addOption (const std::string &name, const std::string &description, const std::string &typeName)
CLI::Option *	addOption (const std::string &name, const std::string &description, const std::string &typeName, const CLI::Validator &additionalValidator)
template<typename ValueTypeT >
CLI::Option *	addOption (const std::string &name, const std::string &description, const std::string &typeName, ValueTypeT defaultValue)
template<typename ValueTypeT >
CLI::Option *	addOption (const std::string &name, const std::string &description, const std::string &typeName, ValueTypeT defaultValue, const CLI::Validator &additionalValidator)
CLI::Option *	addFlag (const std::string &name, const std::string &description, const std::string &typeName)
CLI::Option *	addFlag (const std::string &name, const std::string &description, const std::string &typeName, const CLI::Validator &additionalValidator)
template<typename ValueTypeT >
CLI::Option *	addFlag (const std::string &name, const std::string &description, const std::string &typeName, ValueTypeT defaultValue)
template<typename ValueTypeT >
CLI::Option *	addFlag (const std::string &name, const std::string &description, const std::string &typeName, ValueTypeT defaultValue, const CLI::Validator &additionalValidator)
CLI::Option *	addFlagFunction (const std::string &name, const std::function< void()> &callback, const std::string &description, const std::string &typeName, const std::string &defaultValue)
CLI::Option *	addFlagFunction (const std::string &name, const std::function< void()> &callback, const std::string &description, const std::string &typeName, const std::string &defaultValue, const CLI::Validator &validator)
void	required (CLI::Option *opt, bool req=true)
bool	required () const
template<typename ValueType >
CLI::Option *	addOption (const std::string &name, const std::string &description, const std::string &typeName, ValueType defaultValue)
template<typename ValueType >
CLI::Option *	addOption (const std::string &name, const std::string &description, const std::string &typeName, ValueType defaultValue, const CLI::Validator &additionalValidator)
template<typename ValueType >
CLI::Option *	addFlag (const std::string &name, const std::string &description, const std::string &typeName, ValueType defaultValue)
template<typename ValueType >
CLI::Option *	addFlag (const std::string &name, const std::string &description, const std::string &typeName, ValueType defaultValue, const CLI::Validator &additionalValidator)

Private Attributes
SSL_CTX *	sslCtx = nullptr

Additional Inherited Members
Public Types inherited from net::config::ConfigInstance
enum class	Role { SERVER , CLIENT }
using	Instance = ConfigInstance
Public Types inherited from net::config::ConfigTlsClient
using	Tls = ConfigTlsClient
Protected Attributes inherited from net::config::ConfigSection
CLI::App *	section = nullptr

Detailed Description

template<typename ConfigSocketClientBaseT>
class net::config::stream::tls::ConfigSocketClient< ConfigSocketClientBaseT >

Definition at line 55 of file ConfigSocketClient.h.

Constructor & Destructor Documentation

ConfigSocketClient()

template<typename ConfigSocketClientBase >

net::config::stream::tls::ConfigSocketClient< ConfigSocketClientBase >::ConfigSocketClient ( const std::string &  name )

explicitprotected

Definition at line 51 of file ConfigSocketClient.hpp.

        : net::config::ConfigInstance(name, net::config::ConfigInstance::Role::CLIENT)
        , ConfigSocketClientBase(this)
        , net::config::ConfigTlsClient(this) {
    }

References net::config::ConfigInstance::CLIENT.

Referenced by net::in::stream::tls::config::ConfigSocketClient::ConfigSocketClient(), net::in6::stream::tls::config::ConfigSocketClient::ConfigSocketClient(), net::l2::stream::tls::config::ConfigSocketClient::ConfigSocketClient(), net::rc::stream::tls::config::ConfigSocketClient::ConfigSocketClient(), and net::un::stream::tls::config::ConfigSocketClient::ConfigSocketClient().

Here is the caller graph for this function:

~ConfigSocketClient()

template<typename ConfigSocketClientBase >

net::config::stream::tls::ConfigSocketClient< ConfigSocketClientBase >::~ConfigSocketClient ( )

overrideprotected

Definition at line 58 of file ConfigSocketClient.hpp.

                                                                    {
        if (sslCtx != nullptr) {
            core::socket::stream::tls::ssl_ctx_free(sslCtx);
        }
    }

References core::socket::stream::tls::ssl_ctx_free(), and net::config::stream::tls::ConfigSocketClient< ConfigSocketClientBaseT >::sslCtx.

Here is the call graph for this function:

Member Function Documentation

getSslCtx()

template<typename ConfigSocketClientBase >

SSL_CTX * net::config::stream::tls::ConfigSocketClient< ConfigSocketClientBase >::getSslCtx

(

)

Definition at line 65 of file ConfigSocketClient.hpp.

                                                                   {
        if (sslCtx == nullptr) {
            core::socket::stream::tls::SslConfig sslConfig(false);
 
            sslConfig.instanceName = getInstanceName();
 
            sslConfig.cert = getCert();
            sslConfig.certKey = getCertKey();
            sslConfig.password = getCertKeyPassword();
            sslConfig.caCert = getCaCert();
            sslConfig.caCertDir = getCaCertDir();
            sslConfig.cipherList = getCipherList();
            sslConfig.sslOptions = getSslOptions();
            sslConfig.caCertUseDefaultDir = getCaCertUseDefaultDir();
            sslConfig.caCertAcceptUnknown = getCaCertAcceptUnknown();
 
            sslCtx = core::socket::stream::tls::ssl_ctx_new(sslConfig);
        }
 
        return sslCtx;
    }

References core::socket::stream::tls::SslConfig::caCert, core::socket::stream::tls::SslConfig::caCertAcceptUnknown, core::socket::stream::tls::SslConfig::caCertDir, core::socket::stream::tls::SslConfig::caCertUseDefaultDir, core::socket::stream::tls::SslConfig::cert, core::socket::stream::tls::SslConfig::certKey, core::socket::stream::tls::SslConfig::cipherList, net::config::ConfigTls::getCaCert(), net::config::ConfigTls::getCaCertAcceptUnknown(), net::config::ConfigTls::getCaCertDir(), net::config::ConfigTls::getCaCertUseDefaultDir(), net::config::ConfigTls::getCert(), net::config::ConfigTls::getCertKey(), net::config::ConfigTls::getCertKeyPassword(), net::config::ConfigTls::getCipherList(), net::config::ConfigInstance::getInstanceName(), net::config::ConfigTls::getSslOptions(), core::socket::stream::tls::SslConfig::instanceName, core::socket::stream::tls::SslConfig::password, core::socket::stream::tls::ssl_ctx_new(), core::socket::stream::tls::SslConfig::SslConfig(), net::config::stream::tls::ConfigSocketClient< ConfigSocketClientBaseT >::sslCtx, and core::socket::stream::tls::SslConfig::sslOptions.

Here is the call graph for this function:

Member Data Documentation

sslCtx

template<typename ConfigSocketClientBaseT >

SSL_CTX* net::config::stream::tls::ConfigSocketClient< ConfigSocketClientBaseT >::sslCtx = nullptr

private

Definition at line 68 of file ConfigSocketClient.h.

Referenced by net::config::stream::tls::ConfigSocketClient< ConfigSocketClientBaseT >::getSslCtx(), and net::config::stream::tls::ConfigSocketClient< ConfigSocketClientBaseT >::~ConfigSocketClient().

---

The documentation for this class was generated from the following files:

• net/config/stream/tls/ConfigSocketClient.h
• net/config/stream/tls/ConfigSocketClient.hpp