Class EngineSslSettings

FIX Engine SSL settings. Used by default by SSL-enabled FIX sessions.

Inheritance

object

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 EngineSslSettings

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

[Obsolete("This property is obsolete. Use the EngineSettings.GlobalSessionSettings.Ssl.CaFile instead.")]
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 '|'.

Remarks

This property is obsolete and is kept for backward compatibility. Use CaFile in Ssl in GlobalSessionSettings instead.

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

[Obsolete("This property is obsolete. Use the EngineSettings.GlobalSessionSettings.Ssl.CertificateLocation instead.")]
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 '|'.

Remarks

This property is obsolete and is kept for backward compatibility. Use CertificateLocation in Ssl in GlobalSessionSettings instead.

ListenPorts

Listen port(s) for incoming SSL/TLS FIX connections. The property key is SslListenPorts.

Declaration

public List<int> ListenPorts { get; }

Property Value

Type	Description
List<int>	Listen port(s)

LocalNetworkInterface

The network interface. The default value is SslLocalNetworkInterface The property key is SslLocalNetworkInterface.

Declaration

[Obsolete("This property is obsolete. Use the EngineSettings.GlobalSessionSettings.Ssl.LocalNetworkInterface instead.")]
public IPAddress LocalNetworkInterface { get; set; }

Property Value

Type	Description
IPAddress	The network interface

Remarks

This property is obsolete and is kept for backward compatibility. Use LocalNetworkInterface in Ssl in GlobalSessionSettings instead.

PrivateKeyPassword

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

Declaration

[Obsolete("This property is obsolete. Use the EngineSettings.GlobalSessionSettings.Ssl.PrivateKeyPassword instead.")]
public SecureString? PrivateKeyPassword { get; set; }

Property Value

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

Remarks

This property is obsolete and is kept for backward compatibility. Use PrivateKeyPassword in Ssl in GlobalSessionSettings instead.

Protocol

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

Declaration

[Obsolete("This property is obsolete. Use the EngineSettings.GlobalSessionSettings.Ssl.Protocol instead.")]
public SslProtocols Protocol { get; set; }

Property Value

Type	Description
SslProtocols	Security protocol used to authenticate this connection

Remarks

This property is obsolete and is kept for backward compatibility. Use Protocol in Ssl in GlobalSessionSettings instead.

RemoteCertificateNameMismatchOption

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

Declaration

[Obsolete("This property is obsolete. Use the EngineSettings.GlobalSessionSettings.Ssl.RemoteCertificateNameMismatchOption instead.")]
public RemoteCertificateNameMismatchOption RemoteCertificateNameMismatchOption { get; set; }

Property Value

Type	Description
RemoteCertificateNameMismatchOption	A RemoteCertificateNameMismatchOption enumeration.

Remarks

This property is obsolete and is kept for backward compatibility. Use RemoteCertificateNameMismatchOption in Ssl in GlobalSessionSettings instead.

RemoteCertificateValidationCallback

A callback method to validate the counterparty certificate.

Declaration

[Obsolete("This property is obsolete. Use the EngineSettings.GlobalSessionSettings.Ssl.RemoteCertificateValidationCallback instead.")]
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

[Obsolete("This property is obsolete. Use the EngineSettings.GlobalSessionSettings.Ssl.RevocationFlag instead.")]
public X509RevocationFlag RevocationFlag { get; set; }

Property Value

Type	Description
X509RevocationFlag	An X509RevocationFlag enumeration.

Remarks

This property is obsolete and is kept for backward compatibility. Use RevocationFlag in Ssl in GlobalSessionSettings instead.

RevocationMode

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

Declaration

[Obsolete("This property is obsolete. Use the EngineSettings.GlobalSessionSettings.Ssl.RevocationMode instead.")]
public X509RevocationMode RevocationMode { get; set; }

Property Value

Type	Description
X509RevocationMode	An X509RevocationMode enumeration.

Remarks

This property is obsolete and is kept for backward compatibility. Use RevocationMode in Ssl in GlobalSessionSettings instead.

VerificationFlags

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

Declaration

[Obsolete("This property is obsolete. Use the EngineSettings.GlobalSessionSettings.Ssl.VerificationFlags instead.")]
public X509VerificationFlags VerificationFlags { get; set; }

Property Value

Type	Description
X509VerificationFlags	An X509RevocationFlag enumeration.

Remarks

This property is obsolete and is kept for backward compatibility. Use VerificationFlags in Ssl in GlobalSessionSettings instead.

VerifyPeer

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

Declaration

[Obsolete("This property is obsolete. Use the EngineSettings.GlobalSessionSettings.Ssl.VerifyPeer instead.")]
public bool VerifyPeer { get; set; }

Property Value

Type	Description
bool

Remarks

This property is obsolete and is kept for backward compatibility. Use VerifyPeer in Ssl in GlobalSessionSettings instead.

Methods

CopyTo(EngineSslSettings)

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

Declaration

public void CopyTo(EngineSslSettings other)

Parameters

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