|
Proton DotNet
|
Options that control the SSL level transport configuration. More...
Public Member Functions | |
| SslOptions () | |
| Creates a default SSL options instance. More... | |
| SslOptions (SslOptions other) | |
| Create a target options instance that copies the configuration from the given instance. More... | |
| object | Clone () |
| Clone this options instance, changes to the cloned options are not reflected in this options instance. More... | |
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. More... | |
| int | DefaultSslPort = DEFAULT_SSL_PORT [get, set] |
| Returns the configured default SSL port which if not set otherwise is 5671 More... | |
| 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. More... | |
| 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. More... | |
| 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). More... | |
| 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 specifc value. More... | |
| SslPolicyErrors | AllowedSslPolicyErrorsOverride = SslPolicyErrors.None [get, set] |
| Provides a means of overrideing 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. More... | |
| 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. More... | |
| 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. More... | |
| 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. More... | |
| string | ClientCertificatePath [get, set] |
| Provides a system path where a client certificate can be read and supplied for use when performing the TLS handshake. More... | |
| string | ClientCertificatePassword [get, set] |
| Configures the password used when attempting to load the certificate file specified. More... | |
Options that control the SSL level transport configuration.
|
inline |
Creates a default SSL options instance.
|
inline |
Create a target options instance that copies the configuration from the given instance.
| other | The target options instance to copy |
|
inline |
Clone this options instance, changes to the cloned options are not reflected in this options instance.
|
getset |
Provides a means of overrideing 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.
|
getset |
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.
|
getset |
Configures the password used when attempting to load the certificate file specified.
|
getset |
Provides a system path where a client certificate can be read and supplied for use when performing the TLS handshake.
|
getset |
Returns the configured default SSL port which if not set otherwise is 5671
|
getset |
Controls if the client will enable the system's certificate revocation checking feature (default is disabled).
|
getset |
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.
|
getset |
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.
|
getset |
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.
|
getset |
Controls if SSL is enabled for the connection these options are applied to.
|
getset |
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 specifc value.
|
getset |
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.
1.9.1