Class MqttClientTlsConfigurationBuilder

Builds the MqttClientTlsConfiguration.

Inheritance

object

MqttClientTlsConfigurationBuilder

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Silverback.Messaging.Configuration.Mqtt

Assembly: Silverback.Integration.MQTT.dll

Syntax

public class MqttClientTlsConfigurationBuilder

Constructors

MqttClientTlsConfigurationBuilder()

Builds the MqttClientTlsConfiguration.

Declaration

public MqttClientTlsConfigurationBuilder()

Methods

AllowUntrustedCertificates()

Enables allowing untrusted certificates.

Declaration

public MqttClientTlsConfigurationBuilder AllowUntrustedCertificates()

Returns

Type	Description
MqttClientTlsConfigurationBuilder	The MqttClientTlsConfigurationBuilder so that additional calls can be chained.

Build()

Builds the MqttClientTlsConfiguration instance.

Declaration

public MqttClientTlsConfiguration Build()

Returns

Type	Description
MqttClientTlsConfiguration	The MqttClientTlsConfiguration.

DisableAllowUntrustedCertificates()

Disables allowing untrusted certificates.

Declaration

public MqttClientTlsConfigurationBuilder DisableAllowUntrustedCertificates()

Returns

Type	Description
MqttClientTlsConfigurationBuilder	The MqttClientTlsConfigurationBuilder so that additional calls can be chained.

DisableIgnoreCertificateChainErrors()

Disables ignoring certificate chain errors.

Declaration

public MqttClientTlsConfigurationBuilder DisableIgnoreCertificateChainErrors()

Returns

Type	Description
MqttClientTlsConfigurationBuilder	The MqttClientTlsConfigurationBuilder so that additional calls can be chained.

DisableIgnoreCertificateRevocationErrors()

Disables ignoring certificate revocation errors.

Declaration

public MqttClientTlsConfigurationBuilder DisableIgnoreCertificateRevocationErrors()

Returns

Type	Description
MqttClientTlsConfigurationBuilder	The MqttClientTlsConfigurationBuilder so that additional calls can be chained.

DisableRenegotiation()

Disables renegotiation.

Declaration

public MqttClientTlsConfigurationBuilder DisableRenegotiation()

Returns

Type	Description
MqttClientTlsConfigurationBuilder	The MqttClientTlsConfigurationBuilder so that additional calls can be chained.

DisableTls()

Disables TLS usage.

Declaration

public MqttClientTlsConfigurationBuilder DisableTls()

Returns

Type	Description
MqttClientTlsConfigurationBuilder	The MqttClientTlsConfigurationBuilder so that additional calls can be chained.

EnableRenegotiation()

Enables renegotiation.

Declaration

public MqttClientTlsConfigurationBuilder EnableRenegotiation()

Returns

Type	Description
MqttClientTlsConfigurationBuilder	The MqttClientTlsConfigurationBuilder so that additional calls can be chained.

EnableTls()

Enables TLS usage.

Declaration

public MqttClientTlsConfigurationBuilder EnableTls()

Returns

Type	Description
MqttClientTlsConfigurationBuilder	The MqttClientTlsConfigurationBuilder so that additional calls can be chained.

IgnoreCertificateChainErrors()

Enables ignoring certificate chain errors.

Declaration

public MqttClientTlsConfigurationBuilder IgnoreCertificateChainErrors()

Returns

Type	Description
MqttClientTlsConfigurationBuilder	The MqttClientTlsConfigurationBuilder so that additional calls can be chained.

IgnoreCertificateRevocationErrors()

Enables ignoring certificate revocation errors.

Declaration

public MqttClientTlsConfigurationBuilder IgnoreCertificateRevocationErrors()

Returns

Type	Description
MqttClientTlsConfigurationBuilder	The MqttClientTlsConfigurationBuilder so that additional calls can be chained.

WithApplicationProtocols(params SslApplicationProtocol[])

Sets the application protocols (ALPN) to use.

Declaration

public MqttClientTlsConfigurationBuilder WithApplicationProtocols(params SslApplicationProtocol[] protocols)

Parameters

Type	Name	Description
SslApplicationProtocol[]	protocols	The protocols.

Returns

Type	Description
MqttClientTlsConfigurationBuilder	The MqttClientTlsConfigurationBuilder so that additional calls can be chained.

WithCertificateSelectionHandler(Func<MqttClientCertificateSelectionEventArgs, X509Certificate>?)

Sets the certificate selection handler.

Declaration

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

Parameters

Type	Name	Description
Func<MqttClientCertificateSelectionEventArgs, X509Certificate>	handler	The handler.

Returns

Type	Description
MqttClientTlsConfigurationBuilder	The MqttClientTlsConfigurationBuilder so that additional calls can be chained.

WithCertificateValidationHandler(Func<MqttClientCertificateValidationEventArgs, bool>?)

Sets the certificate validation handler.

Declaration

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

Parameters

Type	Name	Description
Func<MqttClientCertificateValidationEventArgs, bool>	handler	The handler.

Returns

Type	Description
MqttClientTlsConfigurationBuilder	The MqttClientTlsConfigurationBuilder so that additional calls can be chained.

WithCipherSuitesPolicy(CipherSuitesPolicy?)

Sets the CipherSuitesPolicy to use.

Declaration

public MqttClientTlsConfigurationBuilder WithCipherSuitesPolicy(CipherSuitesPolicy? cipherSuitesPolicy)

Parameters

Type	Name	Description
CipherSuitesPolicy	cipherSuitesPolicy	The cipher suites policy.

Returns

Type	Description
MqttClientTlsConfigurationBuilder	The MqttClientTlsConfigurationBuilder so that additional calls can be chained.

WithClientCertificatesProvider(IMqttClientCertificatesProvider?)

Sets the provider for the client certificates.

Declaration

public MqttClientTlsConfigurationBuilder WithClientCertificatesProvider(IMqttClientCertificatesProvider? provider)

Parameters

Type	Name	Description
IMqttClientCertificatesProvider	provider	The MQTTnet.IMqttClientCertificatesProvider.

Returns

Type	Description
MqttClientTlsConfigurationBuilder	The MqttClientTlsConfigurationBuilder so that additional calls can be chained.

WithEncryptionPolicy(EncryptionPolicy)

Sets the encryption policy.

Declaration

public MqttClientTlsConfigurationBuilder WithEncryptionPolicy(EncryptionPolicy policy)

Parameters

Type	Name	Description
EncryptionPolicy	policy	The EncryptionPolicy.

Returns

Type	Description
MqttClientTlsConfigurationBuilder	The MqttClientTlsConfigurationBuilder so that additional calls can be chained.

WithRevocationMode(X509RevocationMode)

Sets the revocation mode.

Declaration

public MqttClientTlsConfigurationBuilder WithRevocationMode(X509RevocationMode revocationMode)

Parameters

Type	Name	Description
X509RevocationMode	revocationMode	The X509RevocationMode.

Returns

Type	Description
MqttClientTlsConfigurationBuilder	The MqttClientTlsConfigurationBuilder so that additional calls can be chained.

WithSslProtocol(SslProtocols)

Sets the SSL/TLS protocol to be used.

Declaration

public MqttClientTlsConfigurationBuilder WithSslProtocol(SslProtocols sslProtocol)

Parameters

Type	Name	Description
SslProtocols	sslProtocol	The SslProtocols value.

Returns

Type	Description
MqttClientTlsConfigurationBuilder	The MqttClientTlsConfigurationBuilder so that additional calls can be chained.

WithTargetHost(string?)

Sets the target host for SNI/certificate validation.

Declaration

public MqttClientTlsConfigurationBuilder WithTargetHost(string? targetHost)

Parameters

Type	Name	Description
string	targetHost	The target host.

Returns

Type	Description
MqttClientTlsConfigurationBuilder	The MqttClientTlsConfigurationBuilder so that additional calls can be chained.

WithTrustChain(X509Certificate2Collection?)

Sets the trust chain.

Declaration

public MqttClientTlsConfigurationBuilder WithTrustChain(X509Certificate2Collection? trustChain)

Parameters

Type	Name	Description
X509Certificate2Collection	trustChain	The X509Certificate2Collection.

Returns

Type	Description
MqttClientTlsConfigurationBuilder	The MqttClientTlsConfigurationBuilder so that additional calls can be chained.

WithTrustChain(params X509Certificate2[])

Sets the trust chain from the specified certificates.

Declaration

public MqttClientTlsConfigurationBuilder WithTrustChain(params X509Certificate2[] certificates)

Parameters

Type	Name	Description
X509Certificate2[]	certificates	The certificates.

Returns

Type	Description
MqttClientTlsConfigurationBuilder	The MqttClientTlsConfigurationBuilder so that additional calls can be chained.