rodbus (C++ API) 1.3.1
Loading...
Searching...
No Matches
rodbus::TlsServerConfig Struct Reference

TLS server configuration. More...

#include <rodbus.hpp>

Public Member Functions

 TlsServerConfig (const std::string &peer_cert_path, const std::string &local_cert_path, const std::string &private_key_path, const std::string &password)
 Initialize a TLS client configuration. More...
 

Public Attributes

std::string peer_cert_path
 Path to the PEM-encoded certificate of the peer. More...
 
std::string local_cert_path
 Path to the PEM-encoded local certificate. More...
 
std::string private_key_path
 Path to the the PEM-encoded private key. More...
 
std::string password
 Optional password if the private key file is encrypted. More...
 
MinTlsVersion min_tls_version
 Minimum TLS version allowed. More...
 
CertificateMode certificate_mode
 Certficate validation mode. More...
 

Friends

class CppTlsServerConfigFriend
 

Detailed Description

TLS server configuration.

Constructor & Destructor Documentation

◆ TlsServerConfig()

rodbus::TlsServerConfig::TlsServerConfig ( const std::string &  peer_cert_path,
const std::string &  local_cert_path,
const std::string &  private_key_path,
const std::string &  password 
)

Initialize a TLS client configuration.

Note
Values are initialized to:
Parameters
peer_cert_pathPath to the PEM-encoded certificate of the peer
local_cert_pathPath to the PEM-encoded local certificate
private_key_pathPath to the the PEM-encoded private key
passwordOptional password if the private key file is encrypted
Returns
New instance of TlsServerConfig

Member Data Documentation

◆ certificate_mode

CertificateMode rodbus::TlsServerConfig::certificate_mode

Certficate validation mode.

◆ local_cert_path

std::string rodbus::TlsServerConfig::local_cert_path

Path to the PEM-encoded local certificate.

◆ min_tls_version

MinTlsVersion rodbus::TlsServerConfig::min_tls_version

Minimum TLS version allowed.

◆ password

std::string rodbus::TlsServerConfig::password

Optional password if the private key file is encrypted.

Only PKCS#8 encrypted files are supported.

Pass empty string if the file is not encrypted.

◆ peer_cert_path

std::string rodbus::TlsServerConfig::peer_cert_path

Path to the PEM-encoded certificate of the peer.

◆ private_key_path

std::string rodbus::TlsServerConfig::private_key_path

Path to the the PEM-encoded private key.


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