Class SslSettings

Contains SSL connection parameters.

Inheritance

object

SslSettings

EngineSslSettings

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: OnixS.Fix

Assembly: OnixS.Fix.Engine.dll

Syntax

public class SslSettings

Properties

CaFile

Paths to file(s) in PKSC#12 format that contains SSL certificate chain excluding endpoint certificate or certificate store location(s) in form "Cert://CurrentUser(or LocalMachine)/Path/THUMBPRINT" or file(s) in PEM format containing one or several сertificates each. Multiple certificate location values should be separated by '|'.

Declaration

public string CaFile { get; set; }

Property Value

Type	Description
string	Paths to file(s) in PKSC#12 format that contains SSL certificate chain excluding endpoint certificate or certificate store location(s) in form "Cert://CurrentUser(or LocalMachine)/Path/THUMBPRINT" or file(s) in PEM format containing one or several сertificates each. Multiple certificate location values should be separated by '|'.

CertificateLocation

Paths to files in PKSC#12 format that contains a certificate with private key or certificate store location in form "Cert://CurrentUser(or LocalMachine)/Path/THUMBPRINT" or path to certificate file in PEM format containing the certificate itself and a private key or path to certificate file in PEM format and path to private key in PEM format separated by '|'.

Declaration

public string CertificateLocation { get; set; }

Property Value

Type	Description
string	Paths to files in PKSC#12 format that contains a certificate with private key or certificate store location in form "Cert://CurrentUser(or LocalMachine)/Path/THUMBPRINT" or path to certificate file in PEM format containing the certificate itself and a private key or path to certificate file in PEM format and path to private key file in PEM format separated by '|'.

PrivateKeyPassword

The password to access SSL certificate private key if it has ciphered. The default value is null. The property key is SslPrivateKeyPassword.

Declaration

public SecureString? PrivateKeyPassword { get; set; }

Property Value

Type	Description
SecureString	The password to access SSL certificate private key if it has ciphered

Protocol

Specifies security protocol used to authenticate this connection. Default value is SslProtocol.

Declaration

public SslProtocols Protocol { get; set; }

Property Value

Type	Description
SslProtocols	Security protocol used to authenticate this connection

RemoteCertificateNameMismatchOption

Option to control SSL handshake behaviour if certificate name does not match server name. Default value is SslRemoteCertificateNameMismatchOption.

Declaration

public RemoteCertificateNameMismatchOption RemoteCertificateNameMismatchOption { get; set; }

Property Value

Type	Description
RemoteCertificateNameMismatchOption	A RemoteCertificateNameMismatchOption enumeration.

RemoteCertificateValidationCallback

A callback method to validate the counterparty certificate.

Declaration

public RemoteCertificateValidationCallback? RemoteCertificateValidationCallback { get; set; }

Property Value

Type	Description
RemoteCertificateValidationCallback	An RemoteCertificateValidationCallback delegate.

Remarks

The RemoteCertificateValidationCallback can be used to obtain and additionally validate the counterparty certificate.

RevocationFlag

Gets or sets values for X509 revocation flags. Default value is SslRevocationFlag.

Declaration

public X509RevocationFlag RevocationFlag { get; set; }

Property Value

Type	Description
X509RevocationFlag	An X509RevocationFlag enumeration.

RevocationMode

Gets or sets values for X509 certificate revocation mode. Default value is SslRevocationMode.

Declaration

public X509RevocationMode RevocationMode { get; set; }

Property Value

Type	Description
X509RevocationMode	An X509RevocationMode enumeration.

VerificationFlags

Specifies conditions under which verification of certificates in the X509 chain should be conducted.. Default value is SslVerificationFlags.

Declaration

public X509VerificationFlags VerificationFlags { get; set; }

Property Value

Type	Description
X509VerificationFlags	An X509RevocationFlag enumeration.

VerifyPeer

Specifies if this endpoint should verify remote end certificate. Default value is SslVerifyPeer.

Declaration

public bool VerifyPeer { get; set; }

Property Value

Type	Description
bool

Methods

CopyTo(SslSettings)

Copies the properties of this instance into the specified destination SslSettings object.

Declaration

public void CopyTo(SslSettings other)

Parameters

Type	Name	Description
SslSettings	other	An SslSettings object to which the properties of this instance are copied.