#include <ConfigTlsServer.h>

Inheritance diagram for net::config::ConfigTlsServer:

Collaboration diagram for net::config::ConfigTlsServer:

Public Types
using	Tls = ConfigTlsServer

Public Member Functions
ConfigTlsServer &	setForceSni (bool forceSni=true)
bool	getForceSni () const
ConfigTlsServer &	addSniCerts (const std::map< std::string, std::map< std::string, std::variant< std::string, bool, ssl_option_t > > > &sniCerts)
ConfigTlsServer &	addSniCert (const std::string &domain, const std::map< std::string, std::variant< std::string, bool, ssl_option_t > > &sniCert)
const std::map< std::string, std::map< std::string, std::variant< std::string, bool, ssl_option_t > > > &	getSniCerts ()
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
	ConfigTlsServer (ConfigInstance *instance)
	~ConfigTlsServer () override
Protected Member Functions inherited from net::config::ConfigTls
	ConfigTls (net::config::ConfigSection *section)

Private Types
using	Super = ConfigTls

Private Attributes
std::map< std::string, std::map< std::string, std::variant< std::string, bool, ssl_option_t > > >	defaultSniCerts
std::map< std::string, std::map< std::string, std::variant< std::string, bool, ssl_option_t > > >	configuredSniCerts
CLI::Option *	sniCertsOpt = nullptr
CLI::Option *	forceSniOpt = nullptr
Private Attributes inherited from net::config::ConfigSection
CLI::App *	sectionSc = nullptr

Additional Inherited Members
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"}
Private Member Functions inherited from net::config::ConfigSection
template<typename T>
	ConfigSection (ConfigInstance instance, T sectionPtr, const std::string &group="Sections")
virtual	~ConfigSection ()
	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)
template<typename ValueTypeT>
CLI::Option *	addOptionFunction (const std::string &name, const std::function< void(const std::string &)> &optionFunction, const std::string &description)
CLI::Option *	addFlag (const std::string &name, const std::string &description)
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)
CLI::Option *	getOption (const std::string &name) const
void	required (CLI::Option *opt, bool req=true)
void	required (bool required=true)
bool	getRequired () 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)
void	setConfigurable (CLI::Option *option, bool configurable)

Detailed Description

Definition at line 61 of file ConfigTlsServer.h.

Member Typedef Documentation

◆ Super

using net::config::ConfigTlsServer::Super = ConfigTls

private

Definition at line 65 of file ConfigTlsServer.h.

◆ Tls

using net::config::ConfigTlsServer::Tls = ConfigTlsServer

Definition at line 68 of file ConfigTlsServer.h.

Constructor & Destructor Documentation

◆ ConfigTlsServer()

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

explicitprotected

Definition at line 59 of file ConfigTlsServer.cpp.

        : ConfigSection(instance, this)
        , ConfigTls(this) {
        sniCertsOpt = sectionSc //
                          ->add_option("--sni-cert",
                                       configuredSniCerts,
                                       "Server Name Indication (SNI) Certificates:\n"
                                       "sni = SNI of the virtual server\n"
                                       "<key> = {\n"
                                       "  Cert -> value:PEM-FILE                  [\"\"]\n"
                                       "  CertKey -> value:PEM-FILE               [\"\"]\n"
                                       "  CertKeyPassword -> value:TEXT           [\"\"]\n"
                                       "  CaCert -> value:PEM-FILE                [\"\"]\n"
                                       "  CaCertDir -> value:PEM-CONTAINER-DIR    [\"\"]\n"
                                       "  CaCertUseDefaultDir -> value:BOOLEAN    [false]\n"
                                       "  CipherList -> value:CIPHER              [\"\"]\n"
                                       "  SslOptions -> value:UINT                [0]\n"
                                       "}") //
                          ->type_name("sni <key> value [<key> value] ... [%% sni <key> value [<key> value] ...]")
                          ->default_str("[\"\" \"\" \"\" \"\"]");
        if (sniCertsOpt->get_configurable()) {
            sniCertsOpt->group(sectionSc->get_formatter()->get_label("Persistent Options"));
        }
 
        sniCertsOpt->default_function([this]() -> std::string {
            std::string defaultValue;
 
            for (const auto& [domain, sniCertConf] : defaultSniCerts) {
                defaultValue += (!defaultValue.empty() ? "\"%%\" \"" : "\"") + domain + "\" ";
 
                for (const auto& [key, value] : sniCertConf) {
                    defaultValue += "\"" + key + "\" ";
 
                    if (key == "Cert") {
                        defaultValue += "\"" + std::get<std::string>(value) + "\" ";
                    } else if (key == "CertKey") {
                        defaultValue += "\"" + std::get<std::string>(value) + "\" ";
                    } else if (key == "CertKeyPassword") {
                        defaultValue += "\"" + std::get<std::string>(value) + "\" ";
                    } else if (key == "CaCert") {
                        defaultValue += "\"" + std::get<std::string>(value) + "\" ";
                    } else if (key == "CaCertDir") {
                        defaultValue += "\"" + std::get<std::string>(value) + "\" ";
                    } else if (key == "CaCertUseDefaultDir") {
                        defaultValue += std::get<bool>(value) ? "\"true\" " : "\"false\" ";
                    } else if (key == "CipherList") {
                        defaultValue += "\"" + std::get<std::string>(value) + "\" ";
                    } else if (key == "SslOptions") {
                        defaultValue += "\"" + std::to_string(std::get<ssl_option_t>(value)) + "\" ";
                    }
                }
            }
 
            defaultValue.pop_back();
 
            return "[" + defaultValue + " \"\"]";
        });
 
        forceSniOpt = addFlag( //
            "--force-sni{true}",
            "Force using of the Server Name Indication",
            "bool",
            "false",
            CLI::IsMember({"true", "false"}));
 
        sectionSc->final_callback([this]() {
            for (auto& [domain, sniMap] : configuredSniCerts) {
                if (domain.empty()) {
                    sniCertsOpt //
                        ->clear();
                    sniMap.clear();
                    break;
                }
                for (auto& [key, value] : sniMap) {
                    if (key != "Cert" &&                //
                        key != "CertKey" &&             //
                        key != "CertKeyPassword" &&     //
                        key != "CaCert" &&              //
                        key != "CaCertDir" &&           //
                        key != "CaCertUseDefaultDir" && //
                        key != "CipherList" &&          //
                        key != "SslOptions") {
                        throw CLI::ConversionError("'" + key + "' of option '--" + sectionSc->get_parent()->get_name() + "." +
                                                       sectionSc->get_name() + ".sni-cert'",
                                                   "<key>");
                    }
                }
            }
        });
    }

References net::config::ConfigSection::addFlag(), net::config::ConfigSection::ConfigSection(), net::config::ConfigTls::ConfigTls(), configuredSniCerts, defaultSniCerts, forceSniOpt, net::config::ConfigSection::sectionSc, and sniCertsOpt.

Here is the call graph for this function:

◆ ~ConfigTlsServer()

net::config::ConfigTlsServer::~ConfigTlsServer ( )

overrideprotected

Definition at line 150 of file ConfigTlsServer.cpp.

150 {

151 }

Member Function Documentation

◆ addSniCert()

ConfigTlsServer & net::config::ConfigTlsServer::addSniCert	(	const std::string &	domain,
		const std::map< std::string, std::variant< std::string, bool, ssl_option_t > > &	sniCert )

Definition at line 173 of file ConfigTlsServer.cpp.

                                                                                                                              {
        defaultSniCerts[domain] = sniCert;
        sniCertsOpt->capture_default_str();
 
        return *this;
    }

References defaultSniCerts, and sniCertsOpt.

◆ addSniCerts()

ConfigTlsServer & net::config::ConfigTlsServer::addSniCerts ( const std::map< std::string, std::map< std::string, std::variant< std::string, bool, ssl_option_t > > > & sniCerts )

Definition at line 165 of file ConfigTlsServer.cpp.

                                                                                                         {
        defaultSniCerts.insert(sniCerts.begin(), sniCerts.end());
        sniCertsOpt->capture_default_str();
 
        return *this;
    }

References defaultSniCerts, and sniCertsOpt.

◆ getForceSni()

bool net::config::ConfigTlsServer::getForceSni ( ) const

Definition at line 161 of file ConfigTlsServer.cpp.

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

References forceSniOpt.

◆ getSniCerts()

const std::map< std::string, std::map< std::string, std::variant< std::string, bool, ssl_option_t > > > & net::config::ConfigTlsServer::getSniCerts ( )

Definition at line 181 of file ConfigTlsServer.cpp.

                                                                                                                        {
        return configuredSniCerts.empty() ? defaultSniCerts : configuredSniCerts;
    }

References configuredSniCerts, and defaultSniCerts.

Referenced by net::config::stream::tls::ConfigSocketServer< ConfigSocketServerBaseT >::getSslCtx().

Here is the caller graph for this function:

◆ setForceSni()

ConfigTlsServer & net::config::ConfigTlsServer::setForceSni ( bool forceSni = true )

Definition at line 153 of file ConfigTlsServer.cpp.

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

References forceSniOpt.

Member Data Documentation

◆ configuredSniCerts

std::map<std::string, std::map<std::string, std::variant<std::string, bool, ssl_option_t> > > net::config::ConfigTlsServer::configuredSniCerts

private

Definition at line 87 of file ConfigTlsServer.h.

Referenced by ConfigTlsServer(), and getSniCerts().

◆ defaultSniCerts

std::map<std::string, std::map<std::string, std::variant<std::string, bool, ssl_option_t> > > net::config::ConfigTlsServer::defaultSniCerts

private

Definition at line 86 of file ConfigTlsServer.h.

Referenced by addSniCert(), addSniCerts(), ConfigTlsServer(), and getSniCerts().

◆ forceSniOpt

CLI::Option* net::config::ConfigTlsServer::forceSniOpt = nullptr

private

Definition at line 90 of file ConfigTlsServer.h.

Referenced by ConfigTlsServer(), getForceSni(), and setForceSni().

◆ sniCertsOpt

CLI::Option* net::config::ConfigTlsServer::sniCertsOpt = nullptr

private

Definition at line 89 of file ConfigTlsServer.h.

Referenced by addSniCert(), addSniCerts(), and ConfigTlsServer().

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

net/config/ConfigTlsServer.h
net/config/ConfigTlsServer.cpp

SNode.C

Public Types

Public Member Functions

Protected Member Functions

Private Types

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Super

◆ Tls

Constructor & Destructor Documentation

◆ ConfigTlsServer()

◆ ~ConfigTlsServer()

Member Function Documentation

◆ addSniCert()

◆ addSniCerts()

◆ getForceSni()

◆ getSniCerts()

◆ setForceSni()

Member Data Documentation

◆ configuredSniCerts

◆ defaultSniCerts

◆ forceSniOpt

◆ sniCertsOpt