TODO: Transport Security Layer (TLS) settings. More...

#include <ConfigurationObjects.h>

Inherits AppConfigurationObjects::ConfigurationObjectBase.

Public Member Functions
void	clear ()

Public Member Functions inherited from AppConfigurationObjects::ConfigurationObjectBase
virtual void	initForDocumenting ()

virtual std::string	toString ()

virtual bool	isDocumenting () const

Public Attributes
bool	verifyPeers
	[Optional, Default: true] When true, checks the far-end certificate validity and Engage-specific TLS setup procedure.

bool	allowSelfSignedCertificates
	[Optional, Default: false] When true, accepts far-end certificates that are self-signed.

std::vector< std::string >	caCertificates
	[Optional] Array of CA certificates (PEM or "@" file/certstore references) to be used to validate far-end certificates.

StringRestrictionList	subjectRestrictions
	[NOT USED AT THIS TIME]

StringRestrictionList	issuerRestrictions
	[NOT USED AT THIS TIME]

std::vector< std::string >	crlSerials
	[Optional] Array of serial numbers certificates that have been revoked

Public Attributes inherited from AppConfigurationObjects::ConfigurationObjectBase
nlohmann::json	_attached

Additional Inherited Members
Protected Attributes inherited from AppConfigurationObjects::ConfigurationObjectBase
bool	_documenting

Detailed Description

TODO: Transport Security Layer (TLS) settings.

Helper C++ class to serialize and de-serialize Tls JSON

Example:

{
   "allowSelfSignedCertificates": true,
   "blacklistedIssuers": [],
   "blacklistedSubjects": [],
   "caCertificates": [],
   "verifyPeers": false,
   "whitelistedIssuers": [],
   "whitelistedSubjects": []
}

See also: RallypointServer

Definition at line 4463 of file ConfigurationObjects.h.

Constructor & Destructor Documentation

◆ Tls()

AppConfigurationObjects::Tls::Tls ( )

inline

Definition at line 4488 of file ConfigurationObjects.h.

Member Function Documentation

◆ clear()

void AppConfigurationObjects::Tls::clear ( )

inline

Definition at line 4493 of file ConfigurationObjects.h.

Member Data Documentation

◆ allowSelfSignedCertificates

bool AppConfigurationObjects::Tls::allowSelfSignedCertificates

[Optional, Default: false] When true, accepts far-end certificates that are self-signed.

Definition at line 4474 of file ConfigurationObjects.h.

◆ caCertificates

std::vector<std::string> AppConfigurationObjects::Tls::caCertificates

[Optional] Array of CA certificates (PEM or "@" file/certstore references) to be used to validate far-end certificates.

Definition at line 4477 of file ConfigurationObjects.h.

◆ crlSerials

std::vector<std::string> AppConfigurationObjects::Tls::crlSerials

[Optional] Array of serial numbers certificates that have been revoked

Definition at line 4486 of file ConfigurationObjects.h.

◆ issuerRestrictions

StringRestrictionList AppConfigurationObjects::Tls::issuerRestrictions

[NOT USED AT THIS TIME]

Definition at line 4483 of file ConfigurationObjects.h.

◆ subjectRestrictions

StringRestrictionList AppConfigurationObjects::Tls::subjectRestrictions

[NOT USED AT THIS TIME]

Definition at line 4480 of file ConfigurationObjects.h.

◆ verifyPeers

bool AppConfigurationObjects::Tls::verifyPeers

[Optional, Default: true] When true, checks the far-end certificate validity and Engage-specific TLS setup procedure.

Definition at line 4471 of file ConfigurationObjects.h.

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

c/include/ConfigurationObjects.h

Public Member Functions

Public Attributes

Additional Inherited Members