Class MqttClientTlsConfiguration

The TLS configuration.

Inheritance

object

MqttClientTlsConfiguration

Implements

IValidatableSettings

IEquatable<MqttClientTlsConfiguration>

Inherited Members

object.GetType()

object.MemberwiseClone()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Namespace: Silverback.Messaging.Configuration.Mqtt

Assembly: Silverback.Integration.MQTT.dll

Syntax

public record MqttClientTlsConfiguration : IValidatableSettings, IEquatable<MqttClientTlsConfiguration>

Constructors

MqttClientTlsConfiguration()

The TLS configuration.

Declaration

public MqttClientTlsConfiguration()

MqttClientTlsConfiguration(MqttClientTlsConfiguration)

The TLS configuration.

Declaration

protected MqttClientTlsConfiguration(MqttClientTlsConfiguration original)

Parameters

Type	Name	Description
MqttClientTlsConfiguration	original

Properties

AllowRenegotiation

Gets a value indicating whether renegotiation is allowed.

Declaration

public bool AllowRenegotiation { get; init; }

Property Value

Type	Description
bool

AllowUntrustedCertificates

Gets a value indicating whether the client should accept untrusted certificates.

Declaration

public bool AllowUntrustedCertificates { get; init; }

Property Value

Type	Description
bool

ApplicationProtocols

Gets the TLS protocols to use.

Declaration

public IValueReadOnlyCollection<SslApplicationProtocol>? ApplicationProtocols { get; init; }

Property Value

Type	Description
IValueReadOnlyCollection<SslApplicationProtocol>

CertificateSelectionHandler

Gets the function to be used to select the client certificate.

Declaration

public Func<MqttClientCertificateSelectionEventArgs, X509Certificate>? CertificateSelectionHandler { get; init; }

Property Value

Type	Description
Func<MqttClientCertificateSelectionEventArgs, X509Certificate>

CertificateValidationHandler

Gets the function to be used to validate the remote certificate.

Declaration

public Func<MqttClientCertificateValidationEventArgs, bool>? CertificateValidationHandler { get; init; }

Property Value

Type	Description
Func<MqttClientCertificateValidationEventArgs, bool>

CipherSuitesPolicy

Gets the CipherSuitesPolicy.

Declaration

public CipherSuitesPolicy? CipherSuitesPolicy { get; init; }

Property Value

Type	Description
CipherSuitesPolicy

ClientCertificatesProvider

Gets the provider to be used to get the client certificates.

Declaration

public IMqttClientCertificatesProvider? ClientCertificatesProvider { get; init; }

Property Value

Type	Description
IMqttClientCertificatesProvider

EncryptionPolicy

Gets the EncryptionPolicy.

Declaration

public EncryptionPolicy EncryptionPolicy { get; init; }

Property Value

Type	Description
EncryptionPolicy

EqualityContract

The TLS configuration.

Declaration

protected virtual Type EqualityContract { get; }

Property Value

Type	Description
Type

IgnoreCertificateChainErrors

Gets a value indicating whether the client should ignore the certificate chain errors.

Declaration

public bool IgnoreCertificateChainErrors { get; init; }

Property Value

Type	Description
bool

IgnoreCertificateRevocationErrors

Gets a value indicating whether the client should ignore the certificate revocation errors.

Declaration

public bool IgnoreCertificateRevocationErrors { get; init; }

Property Value

Type	Description
bool

RevocationMode

Gets the X509RevocationMode.

Declaration

public X509RevocationMode RevocationMode { get; init; }

Property Value

Type	Description
X509RevocationMode

SslProtocol

Gets the protocol to be used. The default is TLS 1.3 or TLS 1.2.

Declaration

public SslProtocols SslProtocol { get; init; }

Property Value

Type	Description
SslProtocols

TargetHost

Gets the target host. If the value is null or empty the same host as the TCP socket host will be used.

Declaration

public string? TargetHost { get; init; }

Property Value

Type	Description
string

TrustChain

Gets the X509Certificate2Collection containing the trust chain.

Declaration

public X509Certificate2Collection? TrustChain { get; init; }

Property Value

Type	Description
X509Certificate2Collection

UseTls

Gets a value indicating whether the client should use TLS.

Declaration

public bool UseTls { get; init; }

Property Value

Type	Description
bool

Methods

Equals(MqttClientTlsConfiguration?)

The TLS configuration.

Declaration

public virtual bool Equals(MqttClientTlsConfiguration? other)

Parameters

Type	Name	Description
MqttClientTlsConfiguration	other

Returns

Type	Description
bool

Equals(object?)

The TLS configuration.

Declaration

public override bool Equals(object? obj)

Parameters

Type	Name	Description
object	obj

Returns

Type	Description
bool

Overrides

object.Equals(object)

GetHashCode()

The TLS configuration.

Declaration

public override int GetHashCode()

Returns

Type	Description
int

Overrides

object.GetHashCode()

PrintMembers(StringBuilder)

The TLS configuration.

Declaration

protected virtual bool PrintMembers(StringBuilder builder)

Parameters

Type	Name	Description
StringBuilder	builder

Returns

Type	Description
bool

ToString()

The TLS configuration.

Declaration

public override string ToString()

Returns

Type	Description
string

Overrides

object.ToString()

Validate()

Throws a SilverbackConfigurationException if the configuration is not valid.

Declaration

public void Validate()

Operators

operator ==(MqttClientTlsConfiguration?, MqttClientTlsConfiguration?)

The TLS configuration.

Declaration

public static bool operator ==(MqttClientTlsConfiguration? left, MqttClientTlsConfiguration? right)

Parameters

Type	Name	Description
MqttClientTlsConfiguration	left
MqttClientTlsConfiguration	right

Returns

Type	Description
bool

operator !=(MqttClientTlsConfiguration?, MqttClientTlsConfiguration?)

The TLS configuration.

Declaration

public static bool operator !=(MqttClientTlsConfiguration? left, MqttClientTlsConfiguration? right)

Parameters

Type	Name	Description
MqttClientTlsConfiguration	left
MqttClientTlsConfiguration	right

Returns

Type	Description
bool

Implements

IValidatableSettings

IEquatable<T>