Class SslStreamSettings

Namespace

MongoDB.Driver.Core.Configuration

Assembly

MongoDB.Driver.Core.dll

Represents settings for an SSL stream.

public class SslStreamSettings

Inheritance

object

SslStreamSettings

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

SslStreamSettings(Optional<bool>, Optional<IEnumerable<X509Certificate>>, Optional<LocalCertificateSelectionCallback>, Optional<SslProtocols>, Optional<RemoteCertificateValidationCallback>)

Initializes a new instance of the SslStreamSettings class.

public SslStreamSettings(Optional<bool> checkCertificateRevocation = default, Optional<IEnumerable<X509Certificate>> clientCertificates = default, Optional<LocalCertificateSelectionCallback> clientCertificateSelectionCallback = default, Optional<SslProtocols> enabledProtocols = default, Optional<RemoteCertificateValidationCallback> serverCertificateValidationCallback = default)

Parameters

checkCertificateRevocation Optional<bool>

Whether to check for certificate revocation.

clientCertificates Optional<IEnumerable<X509Certificate>>

The client certificates.

clientCertificateSelectionCallback Optional<LocalCertificateSelectionCallback>

The client certificate selection callback.

enabledProtocols Optional<SslProtocols>

The enabled protocols.

serverCertificateValidationCallback Optional<RemoteCertificateValidationCallback>

The server certificate validation callback.

Properties

CheckCertificateRevocation

Gets a value indicating whether to check for certificate revocation.

public bool CheckCertificateRevocation { get; }

Property Value

bool

true if certificate should be checked for revocation; otherwise, false.

ClientCertificateSelectionCallback

Gets the client certificate selection callback.

public LocalCertificateSelectionCallback ClientCertificateSelectionCallback { get; }

Property Value

LocalCertificateSelectionCallback

The client certificate selection callback.

ClientCertificates

Gets the client certificates.

public IEnumerable<X509Certificate> ClientCertificates { get; }

Property Value

IEnumerable<X509Certificate>

The client certificates.

EnabledSslProtocols

Gets the enabled SSL protocols.

public SslProtocols EnabledSslProtocols { get; }

Property Value

SslProtocols

The enabled SSL protocols.

ServerCertificateValidationCallback

Gets the server certificate validation callback.

public RemoteCertificateValidationCallback ServerCertificateValidationCallback { get; }

Property Value

RemoteCertificateValidationCallback

The server certificate validation callback.

Methods

With(Optional<bool>, Optional<IEnumerable<X509Certificate>>, Optional<LocalCertificateSelectionCallback>, Optional<SslProtocols>, Optional<RemoteCertificateValidationCallback>)

Returns a new SsslStreamSettings instance with some settings changed.

public SslStreamSettings With(Optional<bool> checkCertificateRevocation = default, Optional<IEnumerable<X509Certificate>> clientCertificates = default, Optional<LocalCertificateSelectionCallback> clientCertificateSelectionCallback = default, Optional<SslProtocols> enabledProtocols = default, Optional<RemoteCertificateValidationCallback> serverCertificateValidationCallback = default)

Parameters

checkCertificateRevocation Optional<bool>

Whether to check certificate revocation.

clientCertificates Optional<IEnumerable<X509Certificate>>

The client certificates.

clientCertificateSelectionCallback Optional<LocalCertificateSelectionCallback>

The client certificate selection callback.

enabledProtocols Optional<SslProtocols>

The enabled protocols.

serverCertificateValidationCallback Optional<RemoteCertificateValidationCallback>

The server certificate validation callback.

Returns

SslStreamSettings

A new SsslStreamSettings instance.