rodbus.TlsServerConfig Class Reference

TLS server configuration More...

Public Member Functions
TlsServerConfig	WithPeerCertPath (string value)
	Path to the PEM-encoded trusted CA certificate(s) in CertificateMode.AuthorityBased mode, or to the peer's own certificate in CertificateMode.SelfSigned mode More...
TlsServerConfig	WithLocalCertPath (string value)
	Path to the PEM-encoded local certificate More...
TlsServerConfig	WithPrivateKeyPath (string value)
	Path to the PEM-encoded private key More...
TlsServerConfig	WithPassword (string value)
	Optional password if the private key file is encrypted More...
TlsServerConfig	WithMinTlsVersion (MinTlsVersion value)
	Minimum TLS version allowed More...
TlsServerConfig	WithCertificateMode (CertificateMode value)
	Certificate validation mode More...
	TlsServerConfig (string peerCertPath, string localCertPath, string privateKeyPath, string password)
	Initialize a TLS server configuration More...

Public Attributes
string	PeerCertPath
	Path to the PEM-encoded trusted CA certificate(s) in CertificateMode.AuthorityBased mode, or to the peer's own certificate in CertificateMode.SelfSigned mode More...
string	LocalCertPath
	Path to the PEM-encoded local certificate More...
string	PrivateKeyPath
	Path to the PEM-encoded private key More...
string	Password
	Optional password if the private key file is encrypted More...
MinTlsVersion	MinTlsVersion
	Minimum TLS version allowed More...
CertificateMode	CertificateMode
	Certificate validation mode More...

Detailed Description

TLS server configuration

Constructor & Destructor Documentation

TlsServerConfig()

rodbus.TlsServerConfig.TlsServerConfig ( string  peerCertPath, string  localCertPath, string  privateKeyPath, string  password  )

inline

Initialize a TLS server configuration

Default values:

• TlsServerConfig.MinTlsVersion: MinTlsVersion.V12
• TlsServerConfig.CertificateMode: CertificateMode.AuthorityBased

Parameters

peerCertPath	Path to the PEM-encoded trusted CA certificate(s) in CertificateMode.AuthorityBased mode, or to the peer's own certificate in CertificateMode.SelfSigned mode
localCertPath	Path to the PEM-encoded local certificate
privateKeyPath	Path to the PEM-encoded private key
password	Optional password if the private key file is encrypted

Member Function Documentation

WithCertificateMode()

TlsServerConfig rodbus.TlsServerConfig.WithCertificateMode ( CertificateMode  value )

inline

Certificate validation mode

WithLocalCertPath()

TlsServerConfig rodbus.TlsServerConfig.WithLocalCertPath ( string  value )

inline

Path to the PEM-encoded local certificate

WithMinTlsVersion()

TlsServerConfig rodbus.TlsServerConfig.WithMinTlsVersion ( MinTlsVersion  value )

inline

Minimum TLS version allowed

WithPassword()

TlsServerConfig rodbus.TlsServerConfig.WithPassword ( string  value )

inline

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.

WithPeerCertPath()

TlsServerConfig rodbus.TlsServerConfig.WithPeerCertPath ( string  value )

inline

Path to the PEM-encoded trusted CA certificate(s) in CertificateMode.AuthorityBased mode, or to the peer's own certificate in CertificateMode.SelfSigned mode

WithPrivateKeyPath()

TlsServerConfig rodbus.TlsServerConfig.WithPrivateKeyPath ( string  value )

inline

Path to the PEM-encoded private key

Member Data Documentation

CertificateMode

CertificateMode rodbus.TlsServerConfig.CertificateMode

Certificate validation mode

LocalCertPath

string rodbus.TlsServerConfig.LocalCertPath

Path to the PEM-encoded local certificate

MinTlsVersion

MinTlsVersion rodbus.TlsServerConfig.MinTlsVersion

Minimum TLS version allowed

Password

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.

PeerCertPath

string rodbus.TlsServerConfig.PeerCertPath

Path to the PEM-encoded trusted CA certificate(s) in CertificateMode.AuthorityBased mode, or to the peer's own certificate in CertificateMode.SelfSigned mode

PrivateKeyPath

string rodbus.TlsServerConfig.PrivateKeyPath

Path to the PEM-encoded private key

---

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

• TlsServerConfig.cs