#include <ConfigTls.h>

Inheritance diagram for net::config::ConfigTls:

Collaboration diagram for net::config::ConfigTls:

Public Member Functions
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
	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
CLI::Option *	certOpt = nullptr

CLI::Option *	certKeyOpt = nullptr

CLI::Option *	certKeyPasswordOpt = nullptr

CLI::Option *	caCertOpt = nullptr

CLI::Option *	caCertDirOpt = nullptr

CLI::Option *	caCertUseDefaultDirOpt = nullptr

CLI::Option *	caCertAcceptUnknownOpt = nullptr

CLI::Option *	cipherListOpt = nullptr

CLI::Option *	sslOptionsOpt = nullptr

CLI::Option *	initTimeoutOpt = nullptr

CLI::Option *	shutdownTimeoutOpt = nullptr

CLI::Option *	noCloseNotifyIsEOFOpt = nullptr

Additional Inherited Members
Protected Attributes inherited from net::config::ConfigSection
CLI::App *	section = nullptr

Detailed Description

Definition at line 65 of file ConfigTls.h.

Constructor & Destructor Documentation

◆ ConfigTls()

net::config::ConfigTls::ConfigTls ( ConfigInstance * instance )

explicitprotected

Definition at line 52 of file ConfigTls.cpp.

        : ConfigSection(instance, "tls", "Configuration of SSL/TLS behavior") {
        certOpt = addOption( //
            "--cert",
            "Certificate chain file",
            "filename:PEM-FILE",
            "");
 
        certKeyOpt = addOption( //
            "--cert-key",
            "Certificate key file",
            "filename:PEM-FILE",
            "");
 
        certKeyPasswordOpt = addOption( //
            "--cert-key-password",
            "Password for the certificate key file",
            "password",
            "",
            CLI::TypeValidator<std::string>());
 
        caCertOpt = addOption( //
            "--ca-cert",
            "CA-certificate file",
            "filename:PEM-FILE",
            "");
 
        caCertDirOpt = addOption( //
            "--ca-cert-dir",
            "CA-certificate directory",
            "directory:PEM-CONTAINER-DIR",
            "");
 
        caCertUseDefaultDirOpt = addFlag( //
            "--ca-cert-use-default-dir{true}",
            "Use default CA-certificate directory",
            "bool",
            "false",
            CLI::IsMember({"true", "false"}));
 
        caCertAcceptUnknownOpt = addFlag( //
            "--ca-cert-accept-unknown{true}",
            "Accept unknown certificates (unsecure)",
            "bool",
            "false",
            CLI::IsMember({"true", "false"}));
 
        cipherListOpt = addOption( //
            "--cipher-list",
            "Cipher list (OpenSSL syntax)",
            "cipher_list",
            "",
            CLI::TypeValidator<std::string>("CIPHER"));
 
        sslOptionsOpt = addOption( //
            "--ssl-options",
            "OR combined SSL/TLS options (OpenSSL values)",
            "options",
            0,
            CLI::TypeValidator<ssl_option_t>());
 
        initTimeoutOpt = addOption( //
            "--init-timeout",
            "SSL/TLS initialization timeout in seconds",
            "timeout",
            TLS_INIT_TIMEOUT,
            CLI::PositiveNumber);
 
        shutdownTimeoutOpt = addOption( //
            "--shutdown-timeout",
            "SSL/TLS shutdown timeout in seconds",
            "timeout",
            TLS_SHUTDOWN_TIMEOUT,
            CLI::PositiveNumber);
 
        noCloseNotifyIsEOFOpt = addFlag( //
            "--no-close-notify-is-eof{true}",
            "Do not interpret a SSL/TLS close_notify alert as EOF",
            "bool",
            "false",
            CLI::IsMember({"true", "false"}));
    }

References net::config::ConfigSection::addFlag(), net::config::ConfigSection::addOption(), net::config::ConfigSection::addOption(), caCertAcceptUnknownOpt, caCertDirOpt, caCertOpt, caCertUseDefaultDirOpt, certKeyOpt, certKeyPasswordOpt, certOpt, cipherListOpt, net::config::ConfigSection::ConfigSection(), noCloseNotifyIsEOFOpt, and sslOptionsOpt.

Referenced by net::config::ConfigTlsClient::ConfigTlsClient(), and net::config::ConfigTlsServer::ConfigTlsServer().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Function Documentation

◆ getCaCert()

std::string net::config::ConfigTls::getCaCert ( ) const

Definition at line 179 of file ConfigTls.cpp.

                                         {
        return caCertOpt->as<std::string>();
    }

References caCertOpt.

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

Here is the caller graph for this function:

◆ getCaCertAcceptUnknown()

bool net::config::ConfigTls::getCaCertAcceptUnknown ( ) const

Definition at line 215 of file ConfigTls.cpp.

                                                 {
        return caCertAcceptUnknownOpt->as<bool>();
    }

References caCertAcceptUnknownOpt.

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

Here is the caller graph for this function:

◆ getCaCertDir()

std::string net::config::ConfigTls::getCaCertDir ( ) const

Definition at line 191 of file ConfigTls.cpp.

                                            {
        return caCertDirOpt->as<std::string>();
    }

References caCertDirOpt.

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

Here is the caller graph for this function:

◆ getCaCertUseDefaultDir()

bool net::config::ConfigTls::getCaCertUseDefaultDir ( ) const

Definition at line 203 of file ConfigTls.cpp.

                                                 {
        return caCertUseDefaultDirOpt->as<bool>();
    }

References caCertUseDefaultDirOpt.

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

Here is the caller graph for this function:

◆ getCert()

std::string net::config::ConfigTls::getCert ( ) const

Definition at line 143 of file ConfigTls.cpp.

                                       {
        return certOpt->as<std::string>();
    }

References certOpt.

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

Here is the caller graph for this function:

◆ getCertKey()

std::string net::config::ConfigTls::getCertKey ( ) const

Definition at line 155 of file ConfigTls.cpp.

                                          {
        return certKeyOpt->as<std::string>();
    }

References certKeyOpt.

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

Here is the caller graph for this function:

◆ getCertKeyPassword()

std::string net::config::ConfigTls::getCertKeyPassword ( ) const

Definition at line 167 of file ConfigTls.cpp.

                                                  {
        return certKeyPasswordOpt->as<std::string>();
    }

References certKeyPasswordOpt.

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

Here is the caller graph for this function:

◆ getCipherList()

std::string net::config::ConfigTls::getCipherList ( ) const

Definition at line 227 of file ConfigTls.cpp.

                                             {
        return cipherListOpt->as<std::string>();
    }

References cipherListOpt.

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

Here is the caller graph for this function:

◆ getInitTimeout()

utils::Timeval net::config::ConfigTls::getInitTimeout ( ) const

Definition at line 262 of file ConfigTls.cpp.

                                                 {
        return initTimeoutOpt->as<utils::Timeval>();
    }

References initTimeoutOpt.

◆ getNoCloseNotifyIsEOF()

bool net::config::ConfigTls::getNoCloseNotifyIsEOF ( ) const

Definition at line 250 of file ConfigTls.cpp.

                                                {
        return noCloseNotifyIsEOFOpt->as<bool>();
    }

References noCloseNotifyIsEOFOpt.

◆ getShutdownTimeout()

utils::Timeval net::config::ConfigTls::getShutdownTimeout ( ) const

Definition at line 274 of file ConfigTls.cpp.

                                                     {
        return shutdownTimeoutOpt //
            ->as<utils::Timeval>();
    }

References shutdownTimeoutOpt.

◆ getSslOptions()

ssl_option_t net::config::ConfigTls::getSslOptions ( ) const

Definition at line 239 of file ConfigTls.cpp.

                                                {
        return sslOptionsOpt->as<ssl_option_t>();
    }

References sslOptionsOpt.

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

Here is the caller graph for this function:

◆ setCaCert()

ConfigTls & net::config::ConfigTls::setCaCert ( const std::string & caCert )

Definition at line 171 of file ConfigTls.cpp.

                                                           {
        caCertOpt //
            ->default_val(caCert)
            ->clear();
 
        return *this;
    }

References caCertOpt.

◆ setCaCertAcceptUnknown()

ConfigTls & net::config::ConfigTls::setCaCertAcceptUnknown ( bool set = true )

Definition at line 207 of file ConfigTls.cpp.

                                                         {
        caCertAcceptUnknownOpt //
            ->default_val(set ? "true" : "false")
            ->clear();
 
        return *this;
    }

References caCertAcceptUnknownOpt.

◆ setCaCertDir()

ConfigTls & net::config::ConfigTls::setCaCertDir ( const std::string & caCertDir )

Definition at line 183 of file ConfigTls.cpp.

                                                                 {
        caCertDirOpt //
            ->default_val(caCertDir)
            ->clear();
 
        return *this;
    }

References caCertDirOpt.

◆ setCaCertUseDefaultDir()

ConfigTls & net::config::ConfigTls::setCaCertUseDefaultDir ( bool set = true )

Definition at line 195 of file ConfigTls.cpp.

                                                         {
        caCertUseDefaultDirOpt //
            ->default_val(set ? "true" : "false")
            ->clear();
 
        return *this;
    }

References caCertUseDefaultDirOpt.

◆ setCert()

ConfigTls & net::config::ConfigTls::setCert ( const std::string & cert )

Definition at line 135 of file ConfigTls.cpp.

                                                       {
        certOpt //
            ->default_val(cert)
            ->clear();
 
        return *this;
    }

References certOpt.

Referenced by main().

Here is the caller graph for this function:

◆ setCertKey()

ConfigTls & net::config::ConfigTls::setCertKey ( const std::string & certKey )

Definition at line 147 of file ConfigTls.cpp.

                                                             {
        certKeyOpt //
            ->default_val(certKey)
            ->clear();
 
        return *this;
    }

References certKeyOpt.

Referenced by main().

Here is the caller graph for this function:

◆ setCertKeyPassword()

ConfigTls & net::config::ConfigTls::setCertKeyPassword ( const std::string & certKeyPassword )

Definition at line 159 of file ConfigTls.cpp.

                                                                             {
        certKeyPasswordOpt //
            ->default_val(certKeyPassword)
            ->clear();
 
        return *this;
    }

References certKeyPasswordOpt.

Referenced by main().

Here is the caller graph for this function:

◆ setCipherList()

ConfigTls & net::config::ConfigTls::setCipherList ( const std::string & cipherList )

Definition at line 219 of file ConfigTls.cpp.

                                                                   {
        cipherListOpt //
            ->default_val(cipherList)
            ->clear();
 
        return *this;
    }

References cipherListOpt.

◆ setInitTimeout()

ConfigTls & net::config::ConfigTls::setInitTimeout ( const utils::Timeval & newInitTimeout )

Definition at line 254 of file ConfigTls.cpp.

                                                                           {
        initTimeoutOpt //
            ->default_val(newInitTimeout)
            ->clear();
 
        return *this;
    }

References initTimeoutOpt.

◆ setNoCloseNotifyIsEOF()

ConfigTls & net::config::ConfigTls::setNoCloseNotifyIsEOF ( bool noCloseNotifyIsEOF = true )

Definition at line 243 of file ConfigTls.cpp.

                                                                     {
        noCloseNotifyIsEOFOpt //
            ->default_val(closeNotifyIsEOF ? "true" : "false")
            ->clear();
        return *this;
    }

References noCloseNotifyIsEOFOpt.

◆ setShutdownTimeout()

ConfigTls & net::config::ConfigTls::setShutdownTimeout ( const utils::Timeval & newShutdownTimeout )

Definition at line 266 of file ConfigTls.cpp.

                                                                                   {
        shutdownTimeoutOpt //
            ->default_val(newShutdownTimeout)
            ->clear();
 
        return *this;
    }

References shutdownTimeoutOpt.

◆ setSslOptions()

ConfigTls & net::config::ConfigTls::setSslOptions ( ssl_option_t sslOptions )

Definition at line 231 of file ConfigTls.cpp.

                                                               {
        sslOptionsOpt //
            ->default_val(sslOptions)
            ->clear();
 
        return *this;
    }

References sslOptionsOpt.

Member Data Documentation

◆ caCertAcceptUnknownOpt

CLI::Option* net::config::ConfigTls::caCertAcceptUnknownOpt = nullptr

private

Definition at line 113 of file ConfigTls.h.

Referenced by ConfigTls(), getCaCertAcceptUnknown(), and setCaCertAcceptUnknown().

◆ caCertDirOpt

CLI::Option* net::config::ConfigTls::caCertDirOpt = nullptr

private

Definition at line 111 of file ConfigTls.h.

Referenced by ConfigTls(), getCaCertDir(), and setCaCertDir().

◆ caCertOpt

CLI::Option* net::config::ConfigTls::caCertOpt = nullptr

private

Definition at line 110 of file ConfigTls.h.

Referenced by ConfigTls(), getCaCert(), and setCaCert().

◆ caCertUseDefaultDirOpt

CLI::Option* net::config::ConfigTls::caCertUseDefaultDirOpt = nullptr

private

Definition at line 112 of file ConfigTls.h.

Referenced by ConfigTls(), getCaCertUseDefaultDir(), and setCaCertUseDefaultDir().

◆ certKeyOpt

CLI::Option* net::config::ConfigTls::certKeyOpt = nullptr

private

Definition at line 108 of file ConfigTls.h.

Referenced by ConfigTls(), getCertKey(), and setCertKey().

◆ certKeyPasswordOpt

CLI::Option* net::config::ConfigTls::certKeyPasswordOpt = nullptr

private

Definition at line 109 of file ConfigTls.h.

Referenced by ConfigTls(), getCertKeyPassword(), and setCertKeyPassword().

◆ certOpt

CLI::Option* net::config::ConfigTls::certOpt = nullptr

private

Definition at line 107 of file ConfigTls.h.

Referenced by ConfigTls(), getCert(), and setCert().

◆ cipherListOpt

CLI::Option* net::config::ConfigTls::cipherListOpt = nullptr

private

Definition at line 114 of file ConfigTls.h.

Referenced by ConfigTls(), getCipherList(), and setCipherList().

◆ initTimeoutOpt

CLI::Option* net::config::ConfigTls::initTimeoutOpt = nullptr

private

Definition at line 116 of file ConfigTls.h.

Referenced by getInitTimeout(), and setInitTimeout().

◆ noCloseNotifyIsEOFOpt

CLI::Option* net::config::ConfigTls::noCloseNotifyIsEOFOpt = nullptr

private

Definition at line 118 of file ConfigTls.h.

Referenced by ConfigTls(), getNoCloseNotifyIsEOF(), and setNoCloseNotifyIsEOF().

◆ shutdownTimeoutOpt

CLI::Option* net::config::ConfigTls::shutdownTimeoutOpt = nullptr

private

Definition at line 117 of file ConfigTls.h.

Referenced by getShutdownTimeout(), and setShutdownTimeout().

◆ sslOptionsOpt

CLI::Option* net::config::ConfigTls::sslOptionsOpt = nullptr

private

Definition at line 115 of file ConfigTls.h.

Referenced by ConfigTls(), getSslOptions(), and setSslOptions().

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

net/config/ConfigTls.h
net/config/ConfigTls.cpp

Public Member Functions

Protected Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ConfigTls()

Member Function Documentation

◆ getCaCert()

◆ getCaCertAcceptUnknown()

◆ getCaCertDir()

◆ getCaCertUseDefaultDir()

◆ getCert()

◆ getCertKey()

◆ getCertKeyPassword()

◆ getCipherList()

◆ getInitTimeout()

◆ getNoCloseNotifyIsEOF()

◆ getShutdownTimeout()

◆ getSslOptions()

◆ setCaCert()

◆ setCaCertAcceptUnknown()

◆ setCaCertDir()

◆ setCaCertUseDefaultDir()

◆ setCert()

◆ setCertKey()

◆ setCertKeyPassword()

◆ setCipherList()

◆ setInitTimeout()

◆ setNoCloseNotifyIsEOF()

◆ setShutdownTimeout()

◆ setSslOptions()

Member Data Documentation

◆ caCertAcceptUnknownOpt

◆ caCertDirOpt

◆ caCertOpt

◆ caCertUseDefaultDirOpt

◆ certKeyOpt

◆ certKeyPasswordOpt

◆ certOpt

◆ cipherListOpt

◆ initTimeoutOpt

◆ noCloseNotifyIsEOFOpt

◆ shutdownTimeoutOpt

◆ sslOptionsOpt