Proton DotNet
Loading...
Searching...
No Matches
Public Member Functions | Static Public Attributes | Properties | List of all members
Apache.Qpid.Proton.Client.SslOptions Class Reference

Options that control the SSL level transport configuration. More...

Public Member Functions

 SslOptions ()
 Creates a default SSL options instance.
 
 SslOptions (SslOptions other)
 Create a target options instance that copies the configuration from the given instance.
 
object Clone ()
 Clone this options instance, changes to the cloned options are not reflected in this options instance.
 

Static Public Attributes

static readonly bool DEFAULT_ENABLED_CERT_REVOCATION_CHECKS = false
 
static readonly bool DEFAULT_VERIFY_HOST = true
 
static readonly int DEFAULT_SSL_PORT = 5671
 

Properties

bool SslEnabled [get, set]
 Controls if SSL is enabled for the connection these options are applied to.
 
int DefaultSslPort = DEFAULT_SSL_PORT [get, set]
 Returns the configured default SSL port which if not set otherwise is 5671.
 
bool VerifyHost = DEFAULT_VERIFY_HOST [get, set]
 Controls if the default verification mechanism will allow host name mismatch in the servers SN or Common Name field or if a mismatch fails the verification process. By default the client uses the host used in the connection address to validate the server name.
 
string ServerNameOverride = null [get, set]
 Configure the value used to validate the common name (server name) provided in the servers certificate instead of using the value provided in the connection address. This option is only used when the verify host option is enabled.
 
bool EnableCertificateRevocationChecks = DEFAULT_ENABLED_CERT_REVOCATION_CHECKS [get, set]
 Controls if the client will enable the system's certificate revocation checking feature (default is disabled).
 
SslProtocols TlsVersionOverride = SslProtocols.None [get, set]
 Allows the user to override the TLS version that the client will request from the O/S when performing the TLS handshake. By default the client will let the system choose the best TLS version, however the user may wish to enforce a specific value.
 
SslPolicyErrors AllowedSslPolicyErrorsOverride = SslPolicyErrors.None [get, set]
 Provides a means of overriding the default allowable SSL policy errors when validating the server certificate during the TLS handshake. By default no errors are allowed and any that do occur will fail the TLS handshake.
 
RemoteCertificateValidationCallback RemoteValidationCallbackOverride = null [get, set]
 Allows the user to provide an optional remote certificate validation callback which can be used by advanced users who want to customize the validation step of the TLS handshake process instead of relying on the built in mechanism.
 
LocalCertificateSelectionCallback LocalCertificateSelectionOverride = null [get, set]
 Allows the user to provide an optional local certificate selection callback which can be used by advanced users who want to customize the selection step when choosing the client certificate to provide to the remote during the TLS handshake.
 
X509CertificateCollection ClientCertificateCollection [get, set]
 Provides a collection of client certificates which will be used when the TLS handshake is performed wherein a single certificate will be selected. This collection takes precedence over any set certificate path however if no collection is provided a call to get this collection will attempt to load a certificate from the configure certificate path if set and return a collection containing the loaded value.
 
string ClientCertificatePath [get, set]
 Provides a system path where a client certificate can be read and supplied for use when performing the TLS handshake.
 
string ClientCertificatePassword [get, set]
 Configures the password used when attempting to load the certificate file specified.
 

Detailed Description

Options that control the SSL level transport configuration.

Constructor & Destructor Documentation

◆ SslOptions()

Apache.Qpid.Proton.Client.SslOptions.SslOptions ( SslOptions  other)
inline

Create a target options instance that copies the configuration from the given instance.

Parameters
otherThe target options instance to copy

Member Function Documentation

◆ Clone()

object Apache.Qpid.Proton.Client.SslOptions.Clone ( )
inline

Clone this options instance, changes to the cloned options are not reflected in this options instance.

Returns
A deep copy of this options instance.

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