TlsOptions Class Reference

Class to access the global (and connection specific) TLS Settings To access the global TLS Settings just instantiate a TlsOption object using the default constructor. More...

#include <TlsOptions.h>

Public Types
enum	tls_option {   CACERTFILE =0, CACERTDIR, CERTFILE, KEYFILE,   REQUIRE_CERT, PROTOCOL_MIN, CIPHER_SUITE, RANDOM_FILE,   CRLCHECK, DHFILE }
	Available TLS Options. More...
enum	verifyMode {   NEVER =0, HARD, DEMAND, ALLOW,   TRY }
	Possible Values for the REQUIRE_CERT option. More...
enum	crlMode { CRL_NONE =0, CRL_PEER, CRL_ALL }
	Possible Values for the CRLCHECK option. More...

Public Member Functions
	TlsOptions ()
	Default constructor. More...
void	setOption (tls_option opt, const std::string &value) const
	Set string valued options. More...
void	setOption (tls_option opt, int value) const
	Set integer valued options. More...
void	setOption (tls_option opt, void *value) const
	Generic setOption variant. More...
int	getIntOption (tls_option opt) const
	Read integer valued options. More...
std::string	getStringOption (tls_option opt) const
	Read string valued options. More...
void	getOption (tls_option opt, void *value) const
	Read options value. More...

Friends
class	LDAPAsynConnection

Detailed Description

Class to access the global (and connection specific) TLS Settings To access the global TLS Settings just instantiate a TlsOption object using the default constructor.

To access connection specific settings instantiate a TlsOption object through the getTlsOptions() method from the corresponding LDAPConnection/LDAPAsynConnection object.

Member Enumeration Documentation

crlMode

enum TlsOptions::crlMode

Possible Values for the CRLCHECK option.

Enumerator
CRL_NONE
CRL_PEER
CRL_ALL

tls_option

enum TlsOptions::tls_option

Available TLS Options.

Enumerator
CACERTFILE
CACERTDIR
CERTFILE
KEYFILE
REQUIRE_CERT
PROTOCOL_MIN
CIPHER_SUITE
RANDOM_FILE
CRLCHECK
DHFILE

verifyMode

enum TlsOptions::verifyMode

Possible Values for the REQUIRE_CERT option.

Enumerator
NEVER
HARD
DEMAND
ALLOW
TRY

Constructor & Destructor Documentation

TlsOptions()

TlsOptions::TlsOptions

(

)

Default constructor.

Gives access to the global TlsSettings

Member Function Documentation

getIntOption()

int TlsOptions::getIntOption

(

tls_option

opt

)

const

Read integer valued options.

Returns

Option value

Exceptions

LDAPException

in case of error (invalid on non-integer valued option is requested)

getOption()

void TlsOptions::getOption	(	tls_option	opt,
		void *	value
	)		const

Read options value.

Usually you should prefer to use either getIntOption() or getStringOption()

Parameters

value

points to a buffer containing the option value

Exceptions

LDAPException

in case of error (invalid on non-string valued option is requested)

getStringOption()

std::string TlsOptions::getStringOption

(

tls_option

opt

)

const

Read string valued options.

Returns

Option value

Exceptions

LDAPException

in case of error (invalid on non-string valued option is requested)

setOption() [1/3]

void TlsOptions::setOption	(	tls_option	opt,
		const std::string &	value
	)		const

Set string valued options.

Parameters

opt

The following string valued options are available: TlsOptions::CACERTFILE TlsOptions::CACERTDIR TlsOptions::CERTFILE TlsOptions::KEYFILE TlsOptions::CIPHER_SUITE TlsOptions::RANDOM_FILE TlsOptions::DHFILE

value

The value to apply to that option, TlsOptions::CACERTFILE: The path to the file containing all recognized Certificate Authorities TlsOptions::CACERTDIR: The path to a directory containing individual files of all recognized Certificate Authority certificates TlsOptions::CERTFILE: The path to the client certificate TlsOptions::KEYFILE: The path to the file containing the private key matching the Certificate that as configured with TlsOptions::CERTFILE TlsOptions::CIPHER_SUITE Specifies the cipher suite and preference order TlsOptions::RANDOM_FILE Specifies the file to obtain random bits from when /dev/[u]random is not available. TlsOptions::DHFILE File containing DH parameters

setOption() [2/3]

void TlsOptions::setOption	(	tls_option	opt,
		int	value
	)		const

Set integer valued options.

Parameters

opt	The following string valued options are available: TlsOptions::REQUIRE_CERT TlsOptions::PROTOCOL_MIN TlsOptions::CRLCHECK
value	The value to apply to that option, TlsOptions::REQUIRE_CERT: Possible Values (For details see the ldap.conf(5) man-page): TlsOptions::NEVER TlsOptions::DEMAND TlsOptions::ALLOW TlsOptions::TRY TlsOptions::PROTOCOL_MIN TlsOptions::CRLCHECK Possible Values: TlsOptions::CRL_NONE TlsOptions::CRL_PEER TlsOptions::CRL_ALL

setOption() [3/3]

void TlsOptions::setOption	(	tls_option	opt,
		void *	value
	)		const

Generic setOption variant.

Generally you should prefer to use one of the other variants

Friends And Related Function Documentation

LDAPAsynConnection

friend class LDAPAsynConnection

friend

---

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

• TlsOptions.h
• TlsOptions.cpp