openvpn::SslApiBuilder Class Reference

The SslApiBuilder struct is used to initialize and configure an SSL/TLS API in OpenVPN. More...

#include <acc_certcheck.hpp>

Collaboration diagram for openvpn::SslApiBuilder:

Public Member Functions
	SslApiBuilder (SSLLib::SSLAPI::Config::Ptr cfg)
	Construct a new SslApiBuilder object.
	SslApiBuilder (const SslApiBuilder &)=delete
	SslApiBuilder (SslApiBuilder &&) noexcept=delete
SslApiBuilder &	operator= (const SslApiBuilder &)=delete
SslApiBuilder &	operator= (SslApiBuilder &&)=delete
openvpn::SSLAPI &	get ()
	get a reference to the encapsulated ssl object

Private Attributes
SSLLib::SSLAPI::Config::Ptr	mConfig
	Configuration for this SSL server.
openvpn::SSLFactoryAPI::Ptr	mFactory
	Factory from the SSL configuration.
openvpn::SSLAPI::Ptr	mServer
	Server created from the factory - depends on mConfig and mFactory.

Detailed Description

The SslApiBuilder struct is used to initialize and configure an SSL/TLS API in OpenVPN.

It takes in a configuration pointer for the SSL library and uses that to initialize an SSL connection object. It does not directly produce any outputs, but allows accessing the initialized SSLAPI server object via the get() method.

Important transforms are using the SSLAPI config to initialize the SSLAPI object correctly. This handles the low-level details of configuring SSL securely via the sslctx abstraction layer.

Definition at line 36 of file acc_certcheck.hpp.

Constructor & Destructor Documentation

SslApiBuilder() [1/3]

openvpn::SslApiBuilder::SslApiBuilder ( SSLLib::SSLAPI::Config::Ptr  cfg )

inline

Construct a new SslApiBuilder object.

Parameters

cfg	configuration that should be installed

Definition at line 42 of file acc_certcheck.hpp.

SslApiBuilder() [2/3]

openvpn::SslApiBuilder::SslApiBuilder ( const SslApiBuilder &  )

delete

SslApiBuilder() [3/3]

openvpn::SslApiBuilder::SslApiBuilder ( SslApiBuilder &&  )

deletenoexcept

Member Function Documentation

get()

openvpn::SSLAPI & openvpn::SslApiBuilder::get ( )

inline

get a reference to the encapsulated ssl object

Returns

openvpn::SSLAPI& a reference to the ready-to-use ssl object

Definition at line 57 of file acc_certcheck.hpp.

Here is the caller graph for this function:

operator=() [1/2]

SslApiBuilder & openvpn::SslApiBuilder::operator= ( const SslApiBuilder &  )

delete

operator=() [2/2]

SslApiBuilder & openvpn::SslApiBuilder::operator= ( SslApiBuilder &&  )

delete

Member Data Documentation

mConfig

SSLLib::SSLAPI::Config::Ptr openvpn::SslApiBuilder::mConfig

private

Configuration for this SSL server.

Definition at line 63 of file acc_certcheck.hpp.

mFactory

openvpn::SSLFactoryAPI::Ptr openvpn::SslApiBuilder::mFactory

private

Factory from the SSL configuration.

Definition at line 64 of file acc_certcheck.hpp.

mServer

openvpn::SSLAPI::Ptr openvpn::SslApiBuilder::mServer

private

Server created from the factory - depends on mConfig and mFactory.

Definition at line 65 of file acc_certcheck.hpp.

---

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

• openvpn/client/acc_certcheck.hpp