dnp3.TlsClientConfig Class Reference

TLS client configuration More...

Public Member Functions
TlsClientConfig	WithDnsName (string value)
	Expected name to validate in the presented certificate (only in CertificateMode.AuthorityBased mode) 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 (string dnsName, string peerCertPath, string localCertPath, string privateKeyPath, string password)
	construct the configuration with defaults More...

Public Attributes
string	DnsName
	Expected name to validate in the presented certificate (only in CertificateMode.AuthorityBased mode) 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...

Detailed Description

TLS client configuration

Constructor & Destructor Documentation

TlsClientConfig()

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

inline

construct the configuration with defaults

Default values:

• TlsClientConfig.MinTlsVersion: MinTlsVersion.V12
• TlsClientConfig.CertificateMode: CertificateMode.AuthorityBased

Parameters

dnsName	Expected name to validate in the presented certificate (only in CertificateMode.AuthorityBased mode)
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

WithCertificateMode()

TlsClientConfig dnp3.TlsClientConfig.WithCertificateMode ( CertificateMode  value )

inline

Certificate validation mode

WithDnsName()

TlsClientConfig dnp3.TlsClientConfig.WithDnsName ( string  value )

inline

Expected name to validate in the presented certificate (only in CertificateMode.AuthorityBased mode)

WithLocalCertPath()

TlsClientConfig dnp3.TlsClientConfig.WithLocalCertPath ( string  value )

inline

Path to the PEM-encoded local certificate

WithMinTlsVersion()

TlsClientConfig dnp3.TlsClientConfig.WithMinTlsVersion ( MinTlsVersion  value )

inline

Minimum TLS version allowed

WithPassword()

TlsClientConfig dnp3.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 dnp3.TlsClientConfig.WithPeerCertPath ( string  value )

inline

Path to the PEM-encoded certificate of the peer

WithPrivateKeyPath()

TlsClientConfig dnp3.TlsClientConfig.WithPrivateKeyPath ( string  value )

inline

Path to the the PEM-encoded private key

Member Data Documentation

CertificateMode

CertificateMode dnp3.TlsClientConfig.CertificateMode

Certificate validation mode

DnsName

string dnp3.TlsClientConfig.DnsName

Expected name to validate in the presented certificate (only in CertificateMode.AuthorityBased mode)

LocalCertPath

string dnp3.TlsClientConfig.LocalCertPath

Path to the PEM-encoded local certificate

MinTlsVersion

MinTlsVersion dnp3.TlsClientConfig.MinTlsVersion

Minimum TLS version allowed

Password

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

Path to the PEM-encoded certificate of the peer

PrivateKeyPath

string dnp3.TlsClientConfig.PrivateKeyPath

Path to the the PEM-encoded private key

---

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

• TlsClientConfig.cs