SNode.C
Loading...
Searching...
No Matches
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 Types

using Instance = net::config::ConfigInstance
using Tls = net::config::ConfigTlsClient
Public Types inherited from net::config::ConfigInstance
enum class  Role { SERVER , CLIENT }
using Instance = ConfigInstance

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
const std::string & getInstanceName () const
ConfigInstance & setInstanceName (const std::string &instanceName)
bool getDisabled () const
ConfigInstance & setDisabled (bool disabled=true)
ConfigInstance & configurable (bool configurable)
Public Member Functions inherited from utils::SubCommand
 SubCommand (const SubCommand &)=delete
 SubCommand (SubCommand &&)=delete
SubCommand & operator= (const SubCommand &)=delete
SubCommand & operator= (SubCommand &&)=delete
virtual ~SubCommand ()
std::string getName () const
std::string version () const
CLI::Option * setConfig (const std::string &defaultConfigFile) const
CLI::Option * setLogFile (const std::string &defaultLogFile) const
CLI::Option * setVersionFlag (const std::string &version) const
bool hasParent () const
SubCommand * getParent () const
SubCommand * allowExtras (bool allow=true)
SubCommand * required (bool required=true, bool force=true)
SubCommand * required (SubCommand *subCommand, bool required=true)
SubCommand * required (CLI::Option *option, bool required=true)
bool getRequired () const
SubCommand * needs (SubCommand *subCommand, bool needs=true)
SubCommand * disabled (SubCommand *subCommand, bool disabled=true)
SubCommand * setRequireCallback (const std::function< void(void)> &callback)
SubCommand * finalCallback (const std::function< void()> &finalCallback)
std::string configToStr () const
std::string help (const CLI::App *helpApp, const CLI::AppFormatMode &mode) const
template<typename NewSubCommand, typename... Args>
NewSubCommand * newSubCommand (Args &&... args)
template<typename RequestedSubCommand>
RequestedSubCommand * getSubCommand ()
template<typename RequestedSubCommand>
RequestedSubCommand * getSubCommand () const
CLI::Option * getOption (const std::string &name) const
CLI::Option * addOption (const std::string &name, const std::string &description, const std::string &typeName, const CLI::Validator &validator) const
template<typename ValueTypeT>
CLI::Option * addOption (const std::string &name, const std::string &description, const std::string &typeName, ValueTypeT defaultValue, const CLI::Validator &validator) const
template<typename ValueTypeT>
CLI::Option * addOptionVariable (const std::string &name, ValueTypeT &variable, const std::string &description, const std::string &typeName, const CLI::Validator &additionalValidator) const
template<typename ValueTypeT>
CLI::Option * addOptionVariable (const std::string &name, ValueTypeT &variable, const std::string &description, const std::string &typeName, ValueTypeT defaultValue, const CLI::Validator &additionalValidator) const
CLI::Option * addOptionFunction (const std::string &name, const std::function< void(const std::string &)> &callback, const std::string &description, const std::string &typeName, const CLI::Validator &validator) const
template<typename ValueTypeT>
CLI::Option * addOptionFunction (const std::string &name, const std::function< void(const std::string &)> &callback, const std::string &description, const std::string &typeName, ValueTypeT defaultValue, const CLI::Validator &validator) const
CLI::Option * addFlag (const std::string &name, const std::string &description, const std::string &typeName, const CLI::Validator &validator) const
template<typename ValueTypeT>
CLI::Option * addFlag (const std::string &name, const std::string &description, const std::string &typeName, ValueTypeT defaultValue, const CLI::Validator &validator) const
CLI::Option * addFlagFunction (const std::string &name, const std::function< void()> &callback, const std::string &description, const std::string &typeName, const CLI::Validator &validator) const
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) const
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
Public Member Functions inherited from net::config::ConfigSection
template<typename T>
 ConfigSection (ConfigInstance *instance, T *sectionPtr, const std::string &group="Sections")
 ~ConfigSection () override
 ConfigSection (const ConfigSection &)=delete
 ConfigSection (ConfigSection &&)=delete
ConfigSection & operator= (const ConfigSection &)=delete

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)
 ~ConfigInstance () override
Protected Member Functions inherited from utils::SubCommand
 SubCommand (SubCommand *parent, std::shared_ptr< utils::AppWithPtr > appWithPtr, const std::string &group, bool final)
template<typename ConcretSubCommand>
 SubCommand (SubCommand *parent, ConcretSubCommand *concretSubCommand, const std::string &group, bool final=true)
void parse (int argc, char *argv[]) const
SubCommand * description (const std::string &description)
SubCommand * footer (const std::string &footer)
void removeSubCommand ()
template<typename ValueTypeT>
CLI::Option * setDefaultValue (CLI::Option *option, const ValueTypeT &value, bool clear=true) const
CLI::Option * setConfigurable (CLI::Option *option, bool configurable) const
Protected Member Functions inherited from net::config::ConfigTlsClient
 ConfigTlsClient (ConfigInstance *instance)
 ~ConfigTlsClient () override
Protected Member Functions inherited from net::config::ConfigTls
template<typename ConcretConfigTls>
 ConfigTls (ConfigInstance *instance, ConcretConfigTls section)
 ~ConfigTls () override

Private Attributes

SSL_CTX * sslCtx = nullptr

Additional Inherited Members

Static Public Member Functions inherited from net::config::ConfigInstance
static CLI::App * getHelpTriggerApp ()
static CLI::App * getShowConfigTriggerApp ()
static CLI::App * getCommandlineTriggerApp ()
Static Public Attributes inherited from net::config::ConfigTls
static constexpr std::string_view NAME {"tls"}
static constexpr std::string_view DESCRIPTION {"Configuration of SSL/TLS behavior"}
Static Protected Member Functions inherited from utils::SubCommand
static CLI::App * getHelpTriggerApp ()
static CLI::App * getShowConfigTriggerApp ()
static CLI::App * getCommandlineTriggerApp ()
Static Protected Attributes inherited from utils::SubCommand
static std::shared_ptr< CLI::Formatter > sectionFormatter = makeSectionFormatter()
static std::map< std::string, std::string > aliases
static CLI::App * helpTriggerApp = nullptr
static CLI::App * showConfigTriggerApp = nullptr
static CLI::App * commandlineTriggerApp = nullptr

Detailed Description

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

Definition at line 55 of file ConfigSocketClient.h.

Member Typedef Documentation

◆ Instance

template<typename ConfigSocketClientBaseT>
using net::config::stream::tls::ConfigSocketClient< ConfigSocketClientBaseT >::Instance = net::config::ConfigInstance

Definition at line 65 of file ConfigSocketClient.h.

◆ Tls

template<typename ConfigSocketClientBaseT>
using net::config::stream::tls::ConfigSocketClient< ConfigSocketClientBaseT >::Tls = net::config::ConfigTlsClient

Definition at line 66 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.

52 : net::config::ConfigInstance(name, net::config::ConfigInstance::Role::CLIENT)
53 , ConfigSocketClientBase(this)
54 , net::config::ConfigTlsClient(this) {
55 }
utils::SubCommand::name
std::string name
Definition SubCommand.h:250

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

Referenced by net::in6::stream::tls::config::ConfigSocketClient::ConfigSocketClient(), net::in::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.

58 {
59 if (sslCtx != nullptr) {
60 core::socket::stream::tls::ssl_ctx_free(sslCtx);
61 }
62 }
core::socket::stream::tls::ssl_ctx_free
void ssl_ctx_free(SSL_CTX *ctx)
Definition ssl_utils.cpp:266

References sslCtx.

Member Function Documentation

◆ getSslCtx()

template<typename ConfigSocketClientBase>
SSL_CTX * net::config::stream::tls::ConfigSocketClient< ConfigSocketClientBase >::getSslCtx ( )

Definition at line 65 of file ConfigSocketClient.hpp.

65 {
66 if (sslCtx == nullptr) {
67 core::socket::stream::tls::SslConfig sslConfig(false);
68
69 sslConfig.instanceName = getInstanceName();
70
71 sslConfig.cert = getCert();
72 sslConfig.certKey = getCertKey();
73 sslConfig.password = getCertKeyPassword();
74 sslConfig.caCert = getCaCert();
75 sslConfig.caCertDir = getCaCertDir();
76 sslConfig.cipherList = getCipherList();
77 sslConfig.sslOptions = getSslOptions();
78 sslConfig.caCertUseDefaultDir = getCaCertUseDefaultDir();
79 sslConfig.caCertAcceptUnknown = getCaCertAcceptUnknown();
80
81 sslCtx = core::socket::stream::tls::ssl_ctx_new(sslConfig);
82 }
83
84 return sslCtx;
85 }
net::config::ConfigInstance::getInstanceName
const std::string & getInstanceName() const
Definition ConfigInstance.cpp:89
net::config::ConfigTls::getCaCertDir
std::string getCaCertDir() const
Definition ConfigTls.cpp:99
net::config::ConfigTls::getCaCert
std::string getCaCert() const
Definition ConfigTls.cpp:89
net::config::ConfigTls::getCipherList
std::string getCipherList() const
Definition ConfigTls.cpp:129
net::config::ConfigTls::getSslOptions
ssl_option_t getSslOptions() const
Definition ConfigTls.cpp:139
net::config::ConfigTls::getCaCertAcceptUnknown
bool getCaCertAcceptUnknown() const
Definition ConfigTls.cpp:119
net::config::ConfigTls::getCaCertUseDefaultDir
bool getCaCertUseDefaultDir() const
Definition ConfigTls.cpp:109
net::config::ConfigTls::getCertKey
std::string getCertKey() const
Definition ConfigTls.cpp:69
net::config::ConfigTls::getCert
std::string getCert() const
Definition ConfigTls.cpp:59
net::config::ConfigTls::getCertKeyPassword
std::string getCertKeyPassword() const
Definition ConfigTls.cpp:79
core::socket::stream::tls::ssl_ctx_new
SSL_CTX * ssl_ctx_new(const SslConfig &sslConfig)
Definition ssl_utils.cpp:114

References core::socket::stream::tls::SslConfig::SslConfig(), and sslCtx.

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 71 of file ConfigSocketClient.h.

Referenced by getSslCtx(), and ~ConfigSocketClient().

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