TLS client configuration More...

Public Member Functions
TlsClientConfig	WithDnsName (string value)
	Name expected to be in the presented certificate (only in CertificateMode.AuthorityBased) More...

TlsClientConfig	WithPeerCertPath (string value)
	Path to the PEM-encoded certificate of the peer More...

TlsClientConfig	WithLocalCertPath (string value)
	Path to the PEM-encoded local certificate More...

TlsClientConfig	WithPrivateKeyPath (string value)
	Path to the the PEM-encoded private key More...

TlsClientConfig	WithPassword (string value)
	Optional password if the private key file is encrypted More...

TlsClientConfig	WithMinTlsVersion (MinTlsVersion value)
	Minimum TLS version allowed More...

TlsClientConfig	WithCertificateMode (CertificateMode value)
	Certificate validation mode More...

TlsClientConfig	WithAllowServerNameWildcard (bool value)
	If set to true, a '*' may be used for TlsClientConfig.DnsName to bypass server name validation More...

	TlsClientConfig (string dnsName, string peerCertPath, string localCertPath, string privateKeyPath, string password)
	Initialize a TLS client configuration More...

Public Attributes
string	DnsName
	Name expected to be in the presented certificate (only in CertificateMode.AuthorityBased) More...

string	PeerCertPath
	Path to the PEM-encoded certificate of the peer More...

string	LocalCertPath
	Path to the PEM-encoded local certificate More...

string	PrivateKeyPath
	Path to the 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...

bool	AllowServerNameWildcard
	If set to true, a '*' may be used for TlsClientConfig.DnsName to bypass server name validation More...

Detailed Description

TLS client configuration

Constructor & Destructor Documentation

◆ TlsClientConfig()

rodbus.TlsClientConfig.TlsClientConfig	(	string	dnsName,
		string	peerCertPath,
		string	localCertPath,
		string	privateKeyPath,
		string	password
	)

inline

Initialize a TLS client configuration

Default values:

TlsClientConfig.MinTlsVersion: MinTlsVersion.V12
TlsClientConfig.CertificateMode: CertificateMode.AuthorityBased
TlsClientConfig.AllowServerNameWildcard: false

Parameters

dnsName	Name expected to be in the presented certificate (only in CertificateMode.AuthorityBased)
peerCertPath	Path to the PEM-encoded certificate of the peer
localCertPath	Path to the PEM-encoded local certificate
privateKeyPath	Path to the the PEM-encoded private key
password	Optional password if the private key file is encrypted

Member Function Documentation

◆ WithAllowServerNameWildcard()

TlsClientConfig rodbus.TlsClientConfig.WithAllowServerNameWildcard ( bool value )

inline

If set to true, a '*' may be used for TlsClientConfig.DnsName to bypass server name validation

◆ WithCertificateMode()

TlsClientConfig rodbus.TlsClientConfig.WithCertificateMode ( CertificateMode value )

inline

Certificate validation mode

◆ WithDnsName()

TlsClientConfig rodbus.TlsClientConfig.WithDnsName ( string value )

inline

Name expected to be in the presented certificate (only in CertificateMode.AuthorityBased)

◆ WithLocalCertPath()

TlsClientConfig rodbus.TlsClientConfig.WithLocalCertPath ( string value )

inline

Path to the PEM-encoded local certificate

◆ WithMinTlsVersion()

TlsClientConfig rodbus.TlsClientConfig.WithMinTlsVersion ( MinTlsVersion value )

inline

Minimum TLS version allowed

◆ WithPassword()

TlsClientConfig rodbus.TlsClientConfig.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()

TlsClientConfig rodbus.TlsClientConfig.WithPeerCertPath ( string value )

inline

Path to the PEM-encoded certificate of the peer

◆ WithPrivateKeyPath()

TlsClientConfig rodbus.TlsClientConfig.WithPrivateKeyPath ( string value )

inline

Path to the the PEM-encoded private key

Member Data Documentation

◆ AllowServerNameWildcard

bool rodbus.TlsClientConfig.AllowServerNameWildcard

If set to true, a '*' may be used for TlsClientConfig.DnsName to bypass server name validation

◆ CertificateMode

CertificateMode rodbus.TlsClientConfig.CertificateMode

Certificate validation mode

◆ DnsName

string rodbus.TlsClientConfig.DnsName

Name expected to be in the presented certificate (only in CertificateMode.AuthorityBased)

◆ LocalCertPath

string rodbus.TlsClientConfig.LocalCertPath

Path to the PEM-encoded local certificate

◆ MinTlsVersion

MinTlsVersion rodbus.TlsClientConfig.MinTlsVersion

Minimum TLS version allowed

◆ Password

string rodbus.TlsClientConfig.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.TlsClientConfig.PeerCertPath

Path to the PEM-encoded certificate of the peer

◆ PrivateKeyPath

string rodbus.TlsClientConfig.PrivateKeyPath

Path to the the PEM-encoded private key

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

TlsClientConfig.cs

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ TlsClientConfig()

Member Function Documentation

◆ WithAllowServerNameWildcard()

◆ WithCertificateMode()

◆ WithDnsName()

◆ WithLocalCertPath()

◆ WithMinTlsVersion()

◆ WithPassword()

◆ WithPeerCertPath()

◆ WithPrivateKeyPath()

Member Data Documentation

◆ AllowServerNameWildcard

◆ CertificateMode

◆ DnsName

◆ LocalCertPath

◆ MinTlsVersion

◆ Password

◆ PeerCertPath

◆ PrivateKeyPath