Class MqttClientTlsConfigurationBuilder

Namespace

Silverback.Messaging.Configuration.Mqtt

Assembly

Silverback.Integration.MQTT.dll

Builds the MqttClientTlsConfiguration.

public class MqttClientTlsConfigurationBuilder

Inheritance

object

MqttClientTlsConfigurationBuilder

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

MqttClientTlsConfigurationBuilder()

public MqttClientTlsConfigurationBuilder()

Methods

AllowUntrustedCertificates()

Enables allowing untrusted certificates.

public MqttClientTlsConfigurationBuilder AllowUntrustedCertificates()

Returns

MqttClientTlsConfigurationBuilder

The MqttClientTlsConfigurationBuilder so that additional calls can be chained.

Build()

Builds the MqttClientTlsConfiguration instance.

public MqttClientTlsConfiguration Build()

Returns

MqttClientTlsConfiguration

The MqttClientTlsConfiguration.

DisableAllowUntrustedCertificates()

Disables allowing untrusted certificates.

public MqttClientTlsConfigurationBuilder DisableAllowUntrustedCertificates()

Returns

MqttClientTlsConfigurationBuilder

The MqttClientTlsConfigurationBuilder so that additional calls can be chained.

DisableIgnoreCertificateChainErrors()

Disables ignoring certificate chain errors.

public MqttClientTlsConfigurationBuilder DisableIgnoreCertificateChainErrors()

Returns

MqttClientTlsConfigurationBuilder

The MqttClientTlsConfigurationBuilder so that additional calls can be chained.

DisableIgnoreCertificateRevocationErrors()

Disables ignoring certificate revocation errors.

public MqttClientTlsConfigurationBuilder DisableIgnoreCertificateRevocationErrors()

Returns

MqttClientTlsConfigurationBuilder

The MqttClientTlsConfigurationBuilder so that additional calls can be chained.

DisableRenegotiation()

Disables renegotiation.

public MqttClientTlsConfigurationBuilder DisableRenegotiation()

Returns

MqttClientTlsConfigurationBuilder

The MqttClientTlsConfigurationBuilder so that additional calls can be chained.

DisableTls()

Disables TLS usage.

public MqttClientTlsConfigurationBuilder DisableTls()

Returns

MqttClientTlsConfigurationBuilder

The MqttClientTlsConfigurationBuilder so that additional calls can be chained.

EnableRenegotiation()

Enables renegotiation.

public MqttClientTlsConfigurationBuilder EnableRenegotiation()

Returns

MqttClientTlsConfigurationBuilder

The MqttClientTlsConfigurationBuilder so that additional calls can be chained.

EnableTls()

Enables TLS usage.

public MqttClientTlsConfigurationBuilder EnableTls()

Returns

MqttClientTlsConfigurationBuilder

The MqttClientTlsConfigurationBuilder so that additional calls can be chained.

IgnoreCertificateChainErrors()

Enables ignoring certificate chain errors.

public MqttClientTlsConfigurationBuilder IgnoreCertificateChainErrors()

Returns

MqttClientTlsConfigurationBuilder

The MqttClientTlsConfigurationBuilder so that additional calls can be chained.

IgnoreCertificateRevocationErrors()

Enables ignoring certificate revocation errors.

public MqttClientTlsConfigurationBuilder IgnoreCertificateRevocationErrors()

Returns

MqttClientTlsConfigurationBuilder

The MqttClientTlsConfigurationBuilder so that additional calls can be chained.

WithApplicationProtocols(params SslApplicationProtocol[])

Sets the application protocols (ALPN) to use.

public MqttClientTlsConfigurationBuilder WithApplicationProtocols(params SslApplicationProtocol[] protocols)

Parameters

protocols SslApplicationProtocol[]

The protocols.

Returns

MqttClientTlsConfigurationBuilder

The MqttClientTlsConfigurationBuilder so that additional calls can be chained.

WithCertificateSelectionHandler(Func<MqttClientCertificateSelectionEventArgs, X509Certificate>?)

Sets the certificate selection handler.

public MqttClientTlsConfigurationBuilder WithCertificateSelectionHandler(Func<MqttClientCertificateSelectionEventArgs, X509Certificate>? handler)

Parameters

handler Func<MqttClientCertificateSelectionEventArgs, X509Certificate>

The handler.

Returns

MqttClientTlsConfigurationBuilder

The MqttClientTlsConfigurationBuilder so that additional calls can be chained.

WithCertificateValidationHandler(Func<MqttClientCertificateValidationEventArgs, bool>?)

Sets the certificate validation handler.

public MqttClientTlsConfigurationBuilder WithCertificateValidationHandler(Func<MqttClientCertificateValidationEventArgs, bool>? handler)

Parameters

handler Func<MqttClientCertificateValidationEventArgs, bool>

The handler.

Returns

MqttClientTlsConfigurationBuilder

The MqttClientTlsConfigurationBuilder so that additional calls can be chained.

WithCipherSuitesPolicy(CipherSuitesPolicy?)

Sets the CipherSuitesPolicy to use.

public MqttClientTlsConfigurationBuilder WithCipherSuitesPolicy(CipherSuitesPolicy? cipherSuitesPolicy)

Parameters

cipherSuitesPolicy CipherSuitesPolicy

The cipher suites policy.

Returns

MqttClientTlsConfigurationBuilder

The MqttClientTlsConfigurationBuilder so that additional calls can be chained.

WithClientCertificatesProvider(IMqttClientCertificatesProvider?)

Sets the provider for the client certificates.

public MqttClientTlsConfigurationBuilder WithClientCertificatesProvider(IMqttClientCertificatesProvider? provider)

Parameters

provider IMqttClientCertificatesProvider

The MQTTnet.IMqttClientCertificatesProvider.

Returns

MqttClientTlsConfigurationBuilder

The MqttClientTlsConfigurationBuilder so that additional calls can be chained.

WithEncryptionPolicy(EncryptionPolicy)

Sets the encryption policy.

public MqttClientTlsConfigurationBuilder WithEncryptionPolicy(EncryptionPolicy policy)

Parameters

policy EncryptionPolicy

The EncryptionPolicy.

Returns

MqttClientTlsConfigurationBuilder

The MqttClientTlsConfigurationBuilder so that additional calls can be chained.

WithRevocationMode(X509RevocationMode)

Sets the revocation mode.

public MqttClientTlsConfigurationBuilder WithRevocationMode(X509RevocationMode revocationMode)

Parameters

revocationMode X509RevocationMode

The X509RevocationMode.

Returns

MqttClientTlsConfigurationBuilder

The MqttClientTlsConfigurationBuilder so that additional calls can be chained.

WithSslProtocol(SslProtocols)

Sets the SSL/TLS protocol to be used.

public MqttClientTlsConfigurationBuilder WithSslProtocol(SslProtocols sslProtocol)

Parameters

sslProtocol SslProtocols

The SslProtocols value.

Returns

MqttClientTlsConfigurationBuilder

The MqttClientTlsConfigurationBuilder so that additional calls can be chained.

WithTargetHost(string?)

Sets the target host for SNI/certificate validation.

public MqttClientTlsConfigurationBuilder WithTargetHost(string? targetHost)

Parameters

targetHost string

The target host.

Returns

MqttClientTlsConfigurationBuilder

The MqttClientTlsConfigurationBuilder so that additional calls can be chained.

WithTrustChain(X509Certificate2Collection?)

Sets the trust chain.

public MqttClientTlsConfigurationBuilder WithTrustChain(X509Certificate2Collection? trustChain)

Parameters

trustChain X509Certificate2Collection

The X509Certificate2Collection.

Returns

MqttClientTlsConfigurationBuilder

The MqttClientTlsConfigurationBuilder so that additional calls can be chained.

WithTrustChain(params X509Certificate2[])

Sets the trust chain from the specified certificates.

public MqttClientTlsConfigurationBuilder WithTrustChain(params X509Certificate2[] certificates)

Parameters

certificates X509Certificate2[]

The certificates.

Returns

MqttClientTlsConfigurationBuilder

The MqttClientTlsConfigurationBuilder so that additional calls can be chained.