opendnp3  3.1.0
Reference implementation of DNP3 (IEEE-1815)
opendnp3::TLSConfig Struct Reference

TLS configuration information. More...

#include <opendnp3/channel/TLSConfig.h>

Public Member Functions

 TLSConfig (const std::string &peerCertFilePath, const std::string &localCertFilePath, const std::string &privateKeyFilePath, bool allowTLSv10=false, bool allowTLSv11=false, bool allowTLSv12=true, bool allowTLSv13=true, const std::string &cipherList="")
 Construct a TLS configuration. More...
 

Public Attributes

bool allowTLSv10
 Allow TLS version 1.0 (default false) More...
 
bool allowTLSv11
 Allow TLS version 1.1 (default false) More...
 
bool allowTLSv12
 Allow TLS version 1.2 (default true) More...
 
bool allowTLSv13
 Allow TLS version 1.3 (default true) More...
 
std::string cipherList
 openssl format cipher list More...
 
std::string localCertFilePath
 File that contains the certificate (or certificate chain) that will be presented to the remote side of the connection. More...
 
std::string peerCertFilePath
 Certificate file used to verify the peer or server. More...
 
std::string privateKeyFilePath
 File that contains the private key corresponding to the local certificate. More...
 

Detailed Description

TLS configuration information.

Definition at line 32 of file TLSConfig.h.

Constructor & Destructor Documentation

◆ TLSConfig()

opendnp3::TLSConfig::TLSConfig ( const std::string &  peerCertFilePath,
const std::string &  localCertFilePath,
const std::string &  privateKeyFilePath,
bool  allowTLSv10 = false,
bool  allowTLSv11 = false,
bool  allowTLSv12 = true,
bool  allowTLSv13 = true,
const std::string &  cipherList = "" 
)
inline

Construct a TLS configuration.

Parameters
peerCertFilePathCertificate file used to verify the peer or server. Can be CA file or a self-signed cert provided by other party.
localCertFilePathFile that contains the certificate (or certificate chain) that will be presented to the remote side of the connection
privateKeyFilePathFile that contains the private key corresponding to the local certificate
allowTLSv10Allow TLS version 1.0 (default false)
allowTLSv11Allow TLS version 1.1 (default false)
allowTLSv12Allow TLS version 1.2 (default true)
allowTLSv13Allow TLS version 1.3 (default true)
cipherListThe openssl cipher-list, defaults to "" which does not modify the default cipher list

localCertFilePath and privateKeyFilePath can optionally be the same file, i.e. a PEM that contains both pieces of data.

Definition at line 52 of file TLSConfig.h.

Member Data Documentation

◆ allowTLSv10

bool opendnp3::TLSConfig::allowTLSv10

Allow TLS version 1.0 (default false)

Definition at line 83 of file TLSConfig.h.

◆ allowTLSv11

bool opendnp3::TLSConfig::allowTLSv11

Allow TLS version 1.1 (default false)

Definition at line 86 of file TLSConfig.h.

◆ allowTLSv12

bool opendnp3::TLSConfig::allowTLSv12

Allow TLS version 1.2 (default true)

Definition at line 89 of file TLSConfig.h.

◆ allowTLSv13

bool opendnp3::TLSConfig::allowTLSv13

Allow TLS version 1.3 (default true)

Definition at line 92 of file TLSConfig.h.

◆ cipherList

std::string opendnp3::TLSConfig::cipherList

openssl format cipher list

Definition at line 95 of file TLSConfig.h.

◆ localCertFilePath

std::string opendnp3::TLSConfig::localCertFilePath

File that contains the certificate (or certificate chain) that will be presented to the remote side of the connection.

Definition at line 77 of file TLSConfig.h.

◆ peerCertFilePath

std::string opendnp3::TLSConfig::peerCertFilePath

Certificate file used to verify the peer or server.

Can be CA file or a self-signed cert provided by other party.

Definition at line 73 of file TLSConfig.h.

◆ privateKeyFilePath

std::string opendnp3::TLSConfig::privateKeyFilePath

File that contains the private key corresponding to the local certificate.

Definition at line 80 of file TLSConfig.h.


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