#include <sslapi.hpp>

Inheritance diagram for openvpn::SSLConfigAPI:

Collaboration diagram for openvpn::SSLConfigAPI:

Public Types
enum	LoadFlags { LF_PARSE_MODE = (1 << 0) , LF_ALLOW_CLIENT_CERT_NOT_REQUIRED = (1 << 1) , LF_RELAY_MODE = (1 << 2) }

typedef RCPtr< SSLConfigAPI >	Ptr

Public Types inherited from openvpn::RC< thread_unsafe_refcount >
typedef RCPtr< RC >	Ptr

Public Member Functions
std::string	private_key_type_string () const

virtual void	set_mode (const Mode &mode_arg)=0

virtual const Mode &	get_mode () const =0

virtual void	set_external_pki_callback (ExternalPKIBase *external_pki_arg, const std::string &alias)=0

virtual void	set_session_ticket_handler (TLSSessionTicketBase *session_ticket_handler)=0

virtual void	set_client_session_tickets (const bool v)=0

virtual void	enable_legacy_algorithms (const bool v)=0

virtual void	set_sni_handler (SNI::HandlerBase *sni_handler)=0

virtual void	set_sni_name (const std::string &sni_name_arg)=0

virtual void	set_private_key_password (const std::string &pwd)=0

virtual void	set_cn_reject_handler (CommonNameReject *cn_reject_handler_arg)=0

virtual void	load_ca (const std::string &ca_txt, bool strict)=0

virtual void	load_crl (const std::string &crl_txt)=0

virtual void	load_cert (const std::string &cert_txt)=0

virtual void	load_cert (const std::string &cert_txt, const std::string &extra_certs_txt)=0

virtual void	load_private_key (const std::string &key_txt)=0

virtual void	load_dh (const std::string &dh_txt)=0

virtual std::string	extract_ca () const =0

virtual std::string	extract_crl () const =0

virtual std::string	extract_cert () const =0

virtual std::vector< std::string >	extract_extra_certs () const =0

virtual std::string	extract_private_key () const =0

virtual std::string	extract_dh () const =0

virtual PKType::Type	private_key_type () const =0

virtual size_t	private_key_length () const =0

virtual void	set_frame (const Frame::Ptr &frame_arg)=0

virtual void	set_debug_level (const int debug_level)=0

virtual void	set_flags (const unsigned int flags_arg)=0

virtual void	set_ns_cert_type (const NSCert::Type ns_cert_type_arg)=0

virtual void	set_remote_cert_tls (const KUParse::TLSWebType wt)=0

virtual void	set_tls_remote (const std::string &tls_remote_arg)=0

virtual void	set_tls_version_min (const TLSVersion::Type tvm)=0

virtual void	set_tls_version_max (const TLSVersion::Type tvm)=0

virtual void	set_tls_version_min_override (const std::string &override)=0

virtual void	set_tls_cert_profile (const TLSCertProfile::Type type)=0

virtual void	set_tls_cert_profile_override (const std::string &override)=0

virtual void	set_local_cert_enabled (const bool v)=0

virtual void	set_x509_track (X509Track::ConfigSet x509_track_config_arg)=0

virtual void	set_rng (const StrongRandomAPI::Ptr &rng_arg)=0

virtual void	load (const OptionList &opt, const unsigned int lflags)=0

virtual std::string	validate_cert (const std::string &cert_txt) const =0

virtual std::string	validate_cert_list (const std::string &certs_txt) const =0

virtual std::string	validate_crl (const std::string &crl_txt) const =0

virtual std::string	validate_private_key (const std::string &key_txt) const =0

virtual std::string	validate_dh (const std::string &dh_txt) const =0

virtual SSLFactoryAPI::Ptr	new_factory ()=0

Public Member Functions inherited from openvpn::RC< thread_unsafe_refcount >
	RC () noexcept=default

	RC (const RC &)=delete

virtual	~RC ()=default

RC &	operator= (const RC &)=delete

olong	use_count () const noexcept
	Delegates call to RCImpl and returns the result.

Additional Inherited Members
Static Public Member Functions inherited from openvpn::RC< thread_unsafe_refcount >
static constexpr bool	is_thread_safe ()
	Delegates call to RCImpl and returns the result.

Detailed Description

Definition at line 107 of file sslapi.hpp.

Member Typedef Documentation

◆ Ptr

typedef RCPtr<SSLConfigAPI> openvpn::SSLConfigAPI::Ptr

Definition at line 110 of file sslapi.hpp.

Member Enumeration Documentation

◆ LoadFlags

enum openvpn::SSLConfigAPI::LoadFlags

Enumerator
LF_PARSE_MODE
LF_ALLOW_CLIENT_CERT_NOT_REQUIRED
LF_RELAY_MODE

Definition at line 112 of file sslapi.hpp.

Member Function Documentation

◆ enable_legacy_algorithms()

virtual void openvpn::SSLConfigAPI::enable_legacy_algorithms ( const bool v )

pure virtual

Implemented in openvpn::MbedTLSContext::Config, and openvpn::OpenSSLContext::Config.

◆ extract_ca()

virtual std::string openvpn::SSLConfigAPI::extract_ca ( ) const

pure virtual

Implemented in openvpn::MbedTLSContext::Config, and openvpn::OpenSSLContext::Config.

◆ extract_cert()

virtual std::string openvpn::SSLConfigAPI::extract_cert ( ) const

pure virtual

Implemented in openvpn::MbedTLSContext::Config, and openvpn::OpenSSLContext::Config.

◆ extract_crl()

virtual std::string openvpn::SSLConfigAPI::extract_crl ( ) const

pure virtual

Implemented in openvpn::MbedTLSContext::Config, and openvpn::OpenSSLContext::Config.

◆ extract_dh()

virtual std::string openvpn::SSLConfigAPI::extract_dh ( ) const

pure virtual

Implemented in openvpn::MbedTLSContext::Config, and openvpn::OpenSSLContext::Config.

◆ extract_extra_certs()

virtual std::vector< std::string > openvpn::SSLConfigAPI::extract_extra_certs ( ) const

pure virtual

Implemented in openvpn::MbedTLSContext::Config, and openvpn::OpenSSLContext::Config.

◆ extract_private_key()

virtual std::string openvpn::SSLConfigAPI::extract_private_key ( ) const

pure virtual

Implemented in openvpn::MbedTLSContext::Config, and openvpn::OpenSSLContext::Config.

◆ get_mode()

virtual const Mode & openvpn::SSLConfigAPI::get_mode ( ) const

pure virtual

Implemented in openvpn::AppleSSLContext::Config, openvpn::MbedTLSContext::Config, and openvpn::OpenSSLContext::Config.

◆ load()

virtual void openvpn::SSLConfigAPI::load	(	const OptionList &	opt,
		const unsigned int	lflags
	)

pure virtual

Implemented in openvpn::AppleSSLContext::Config, openvpn::MbedTLSContext::Config, and openvpn::OpenSSLContext::Config.

◆ load_ca()

virtual void openvpn::SSLConfigAPI::load_ca	(	const std::string &	ca_txt,
		bool	strict
	)

pure virtual

Implemented in openvpn::AppleSSLContext::Config, openvpn::MbedTLSContext::Config, and openvpn::OpenSSLContext::Config.

◆ load_cert() [1/2]

virtual void openvpn::SSLConfigAPI::load_cert ( const std::string & cert_txt )

pure virtual

Implemented in openvpn::AppleSSLContext::Config, openvpn::MbedTLSContext::Config, and openvpn::OpenSSLContext::Config.

◆ load_cert() [2/2]

virtual void openvpn::SSLConfigAPI::load_cert	(	const std::string &	cert_txt,
		const std::string &	extra_certs_txt
	)

pure virtual

Implemented in openvpn::AppleSSLContext::Config, openvpn::MbedTLSContext::Config, and openvpn::OpenSSLContext::Config.

◆ load_crl()

virtual void openvpn::SSLConfigAPI::load_crl ( const std::string & crl_txt )

pure virtual

Implemented in openvpn::AppleSSLContext::Config, openvpn::MbedTLSContext::Config, and openvpn::OpenSSLContext::Config.

◆ load_dh()

virtual void openvpn::SSLConfigAPI::load_dh ( const std::string & dh_txt )

pure virtual

Implemented in openvpn::AppleSSLContext::Config, openvpn::MbedTLSContext::Config, and openvpn::OpenSSLContext::Config.

◆ load_private_key()

virtual void openvpn::SSLConfigAPI::load_private_key ( const std::string & key_txt )

pure virtual

Implemented in openvpn::AppleSSLContext::Config, openvpn::MbedTLSContext::Config, and openvpn::OpenSSLContext::Config.

◆ new_factory()

virtual SSLFactoryAPI::Ptr openvpn::SSLConfigAPI::new_factory ( )

pure virtual

Implemented in openvpn::AppleSSLContext::Config, openvpn::MbedTLSContext::Config, and openvpn::OpenSSLContext::Config.

◆ private_key_length()

virtual size_t openvpn::SSLConfigAPI::private_key_length ( ) const

pure virtual

Implemented in openvpn::MbedTLSContext::Config, and openvpn::OpenSSLContext::Config.

◆ private_key_type()

virtual PKType::Type openvpn::SSLConfigAPI::private_key_type ( ) const

pure virtual

Implemented in openvpn::MbedTLSContext::Config, and openvpn::OpenSSLContext::Config.

Here is the caller graph for this function:

◆ private_key_type_string()

std::string openvpn::SSLConfigAPI::private_key_type_string ( ) const

inline

Definition at line 119 of file sslapi.hpp.

◆ set_client_session_tickets()

virtual void openvpn::SSLConfigAPI::set_client_session_tickets ( const bool v )

pure virtual

Implemented in openvpn::MbedTLSContext::Config, and openvpn::OpenSSLContext::Config.

◆ set_cn_reject_handler()

virtual void openvpn::SSLConfigAPI::set_cn_reject_handler ( CommonNameReject * cn_reject_handler_arg )

pure virtual

Implemented in openvpn::MbedTLSContext::Config, and openvpn::OpenSSLContext::Config.

◆ set_debug_level()

virtual void openvpn::SSLConfigAPI::set_debug_level ( const int debug_level )

pure virtual

Implemented in openvpn::AppleSSLContext::Config, openvpn::MbedTLSContext::Config, and openvpn::OpenSSLContext::Config.

◆ set_external_pki_callback()

virtual void openvpn::SSLConfigAPI::set_external_pki_callback	(	ExternalPKIBase *	external_pki_arg,
		const std::string &	alias
	)

pure virtual

Implemented in openvpn::AppleSSLContext::Config, openvpn::MbedTLSContext::Config, and openvpn::OpenSSLContext::Config.

◆ set_flags()

virtual void openvpn::SSLConfigAPI::set_flags ( const unsigned int flags_arg )

pure virtual

Implemented in openvpn::AppleSSLContext::Config, openvpn::MbedTLSContext::Config, and openvpn::OpenSSLContext::Config.

◆ set_frame()

virtual void openvpn::SSLConfigAPI::set_frame ( const Frame::Ptr & frame_arg )

pure virtual

Implemented in openvpn::AppleSSLContext::Config, openvpn::MbedTLSContext::Config, and openvpn::OpenSSLContext::Config.

◆ set_local_cert_enabled()

virtual void openvpn::SSLConfigAPI::set_local_cert_enabled ( const bool v )

pure virtual

Implemented in openvpn::AppleSSLContext::Config, openvpn::MbedTLSContext::Config, and openvpn::OpenSSLContext::Config.

◆ set_mode()

virtual void openvpn::SSLConfigAPI::set_mode ( const Mode & mode_arg )

pure virtual

Implemented in openvpn::AppleSSLContext::Config, openvpn::MbedTLSContext::Config, and openvpn::OpenSSLContext::Config.

◆ set_ns_cert_type()

virtual void openvpn::SSLConfigAPI::set_ns_cert_type ( const NSCert::Type ns_cert_type_arg )

pure virtual

Implemented in openvpn::AppleSSLContext::Config, openvpn::MbedTLSContext::Config, and openvpn::OpenSSLContext::Config.

◆ set_private_key_password()

virtual void openvpn::SSLConfigAPI::set_private_key_password ( const std::string & pwd )

pure virtual

Implemented in openvpn::AppleSSLContext::Config, openvpn::MbedTLSContext::Config, and openvpn::OpenSSLContext::Config.

◆ set_remote_cert_tls()

virtual void openvpn::SSLConfigAPI::set_remote_cert_tls ( const KUParse::TLSWebType wt )

pure virtual

Implemented in openvpn::AppleSSLContext::Config, openvpn::MbedTLSContext::Config, and openvpn::OpenSSLContext::Config.

◆ set_rng()

virtual void openvpn::SSLConfigAPI::set_rng ( const StrongRandomAPI::Ptr & rng_arg )

pure virtual

Implemented in openvpn::AppleSSLContext::Config, openvpn::MbedTLSContext::Config, and openvpn::OpenSSLContext::Config.

◆ set_session_ticket_handler()

virtual void openvpn::SSLConfigAPI::set_session_ticket_handler ( TLSSessionTicketBase * session_ticket_handler )

pure virtual

Implemented in openvpn::MbedTLSContext::Config, and openvpn::OpenSSLContext::Config.

◆ set_sni_handler()

virtual void openvpn::SSLConfigAPI::set_sni_handler ( SNI::HandlerBase * sni_handler )

pure virtual

Implemented in openvpn::MbedTLSContext::Config, and openvpn::OpenSSLContext::Config.

◆ set_sni_name()

virtual void openvpn::SSLConfigAPI::set_sni_name ( const std::string & sni_name_arg )

pure virtual

Implemented in openvpn::MbedTLSContext::Config, and openvpn::OpenSSLContext::Config.

◆ set_tls_cert_profile()

virtual void openvpn::SSLConfigAPI::set_tls_cert_profile ( const TLSCertProfile::Type type )

pure virtual

Implemented in openvpn::MbedTLSContext::Config, and openvpn::OpenSSLContext::Config.

◆ set_tls_cert_profile_override()

virtual void openvpn::SSLConfigAPI::set_tls_cert_profile_override ( const std::string & override )

pure virtual

Implemented in openvpn::MbedTLSContext::Config, and openvpn::OpenSSLContext::Config.

◆ set_tls_remote()

virtual void openvpn::SSLConfigAPI::set_tls_remote ( const std::string & tls_remote_arg )

pure virtual

Implemented in openvpn::AppleSSLContext::Config, openvpn::MbedTLSContext::Config, and openvpn::OpenSSLContext::Config.

◆ set_tls_version_max()

virtual void openvpn::SSLConfigAPI::set_tls_version_max ( const TLSVersion::Type tvm )

pure virtual

Implemented in openvpn::MbedTLSContext::Config, and openvpn::OpenSSLContext::Config.

◆ set_tls_version_min()

virtual void openvpn::SSLConfigAPI::set_tls_version_min ( const TLSVersion::Type tvm )

pure virtual

Implemented in openvpn::AppleSSLContext::Config, openvpn::MbedTLSContext::Config, and openvpn::OpenSSLContext::Config.

◆ set_tls_version_min_override()

virtual void openvpn::SSLConfigAPI::set_tls_version_min_override ( const std::string & override )

pure virtual

Implemented in openvpn::MbedTLSContext::Config, and openvpn::OpenSSLContext::Config.

◆ set_x509_track()

virtual void openvpn::SSLConfigAPI::set_x509_track ( X509Track::ConfigSet x509_track_config_arg )

pure virtual

Implemented in openvpn::MbedTLSContext::Config, and openvpn::OpenSSLContext::Config.

◆ validate_cert()

virtual std::string openvpn::SSLConfigAPI::validate_cert ( const std::string & cert_txt ) const

pure virtual

Implemented in openvpn::MbedTLSContext::Config, and openvpn::OpenSSLContext::Config.

◆ validate_cert_list()

virtual std::string openvpn::SSLConfigAPI::validate_cert_list ( const std::string & certs_txt ) const

pure virtual

Implemented in openvpn::MbedTLSContext::Config, and openvpn::OpenSSLContext::Config.

◆ validate_crl()

virtual std::string openvpn::SSLConfigAPI::validate_crl ( const std::string & crl_txt ) const

pure virtual

Implemented in openvpn::MbedTLSContext::Config, and openvpn::OpenSSLContext::Config.

◆ validate_dh()

virtual std::string openvpn::SSLConfigAPI::validate_dh ( const std::string & dh_txt ) const

pure virtual

Implemented in openvpn::MbedTLSContext::Config, and openvpn::OpenSSLContext::Config.

◆ validate_private_key()

virtual std::string openvpn::SSLConfigAPI::validate_private_key ( const std::string & key_txt ) const

pure virtual

Implemented in openvpn::MbedTLSContext::Config, and openvpn::OpenSSLContext::Config.

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

openvpn/ssl/sslapi.hpp

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Ptr

Member Enumeration Documentation

◆ LoadFlags

Member Function Documentation

◆ enable_legacy_algorithms()

◆ extract_ca()

◆ extract_cert()

◆ extract_crl()

◆ extract_dh()

◆ extract_extra_certs()

◆ extract_private_key()

◆ get_mode()

◆ load()

◆ load_ca()

◆ load_cert() [1/2]

◆ load_cert() [2/2]

◆ load_crl()

◆ load_dh()

◆ load_private_key()

◆ new_factory()

◆ private_key_length()

◆ private_key_type()

◆ private_key_type_string()

◆ set_client_session_tickets()

◆ set_cn_reject_handler()

◆ set_debug_level()

◆ set_external_pki_callback()

◆ set_flags()

◆ set_frame()

◆ set_local_cert_enabled()

◆ set_mode()

◆ set_ns_cert_type()

◆ set_private_key_password()

◆ set_remote_cert_tls()

◆ set_rng()

◆ set_session_ticket_handler()

◆ set_sni_handler()

◆ set_sni_name()

◆ set_tls_cert_profile()

◆ set_tls_cert_profile_override()

◆ set_tls_remote()

◆ set_tls_version_max()

◆ set_tls_version_min()

◆ set_tls_version_min_override()

◆ set_x509_track()

◆ validate_cert()

◆ validate_cert_list()

◆ validate_crl()

◆ validate_dh()

◆ validate_private_key()