TlsClientOptions Class Reference

TLS client credentials and connection parameters. More...

#include <cc/TlsClientOptions>

Inheritance diagram for TlsClientOptions:

Public Member Functions
	TlsClientOptions ()=default
	Create primordial security credentials.
void	setServerName (const String &serverName)
	Provide the server name the client is expecting to connect to.
void	setCredentials (const String &certPath, const String &keyPath)
	Set client authentification credentials
void	setTrustFilePath (const String &filePath)
	Set custom trust file path
void	setCiphers (const String &ciphers)
	Set allowed ciphers
void	setPsk (const Bytes &key, const Bytes &identifier={})
	Set key and key identifier for TLS PSK authentication.
String	serverName () const
	Server name the client is expecting to connect to.
String	certPath () const
	Certificate file path for client authentification.
String	keyPath () const
	Private key for client authentification.
String	trustFilePath () const
	Custome trust file path.
String	ciphers () const
	Allowed ciphers.
Bytes	pskKey () const
	PSK key.
Bytes	pskIdentifier () const
	PSK identifier.
Public Member Functions inherited from Object
	Object ()=default
	Create a null object.
	operator bool () const
	Check if this is a non-null object.
bool	isNull () const
	Check if this is a null object.
int	useCount () const
	Reference count.
template<class T >
bool	is () const
	Check if this object is of type T.
template<class T >
T	as () const
	Cast this object to type T.
bool	isWeak () const
	Check if the underlying object reference is weak.
bool	operator== (const Object &other) const
	Equality operator.
std::strong_ordering	operator<=> (const Object &other) const
	Ordering operator.

Additional Inherited Members
Public Types inherited from Object
using	NullAccess = cc::NullAccess
	Error thrown when trying to access a null object.
using	VirginityTestFailed = cc::VirginityTestFailed
	Error thrown when trying to initialize an object with a non-virgin state.
Protected Member Functions inherited from Object
template<class T >
T	weak () const
template<class T >
void	initOnce ()
	Create the object state when called the first time.
template<class T >
void	initOncePerThread ()
	Create a distinct object state for each thread when called the first time in that thread.
	Object (State *newState)
	Initialize object with newState.
	Object (State *state, Alias)
	Object (State *state, Weak)
Object &	operator= (std::nullptr_t)
Static Protected Member Functions inherited from Object
template<class T >
static T	alias (const State *state)
	Create an alias object for the given state.
template<class T >
static T	weak (const State *state)
Protected Attributes inherited from Object
Handle< State >	me
	Internal object state

Detailed Description

TLS client credentials and connection parameters.

Constructor & Destructor Documentation

TlsClientOptions()

TlsClientOptions ( )

default

Create primordial security credentials.

Member Function Documentation

setServerName()

void setServerName

(

const String &

serverName

)

Provide the server name the client is expecting to connect to.

setCredentials()

void setCredentials	(	const String &	certPath,
		const String &	keyPath
	)

Set client authentification credentials

Parameters

certPath	Certificate file path
keyPath	Private key file path

setTrustFilePath()

void setTrustFilePath

(

const String &

filePath

)

Set custom trust file path

setCiphers()

void setCiphers

(

const String &

ciphers

)

Set allowed ciphers

setPsk()

void setPsk	(	const Bytes &	key,
		const Bytes &	identifier = {}
	)

Set key and key identifier for TLS PSK authentication.

serverName()

String serverName

(

)

const

Server name the client is expecting to connect to.

certPath()

String certPath

(

)

const

Certificate file path for client authentification.

keyPath()

String keyPath

(

)

const

Private key for client authentification.

trustFilePath()

String trustFilePath

(

)

const

Custome trust file path.

ciphers()

String ciphers

(

)

const

Allowed ciphers.

pskKey()

Bytes pskKey

(

)

const

PSK key.

pskIdentifier()

Bytes pskIdentifier

(

)

const

PSK identifier.