Package io.quarkus.vertx.http.security

Interface MTLS

@Experimental("This API is currently experimental and might get changed")
public interface MTLS

This class provides a way to create the mutual TLS client authentication mechanism. The HttpAuthenticationMechanism created with this class can be registered using the HttpSecurity.mechanism(HttpAuthenticationMechanism) method.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	MTLS.Builder	The mutual TLS client authentication mechanism builder.

Method Summary

Static Methods

Modifier and Type	Method	Description
static MTLS.Builder	builder()
static MtlsAuthenticationMechanism	request()	Creates the mutual TLS client authentication mechanism.
static MtlsAuthenticationMechanism	request(String tlsConfigurationName)	Creates the mutual TLS client authentication mechanism.
static MtlsAuthenticationMechanism	request(String tlsConfigurationName, io.quarkus.tls.TlsConfiguration tlsConfiguration)	Creates the mutual TLS client authentication mechanism.
static MtlsAuthenticationMechanism	required()	Creates the mutual TLS client authentication mechanism.
static MtlsAuthenticationMechanism	required(String tlsConfigurationName)	Creates the mutual TLS client authentication mechanism.
static MtlsAuthenticationMechanism	required(String tlsConfigurationName, io.quarkus.tls.TlsConfiguration tlsConfiguration)	Creates the mutual TLS client authentication mechanism.

Method Details

request

static MtlsAuthenticationMechanism request(String tlsConfigurationName)

Creates the mutual TLS client authentication mechanism. The client authentication is accepted if presented by a client. Use this method if the client authentication is only required for certain routes and secure these routes with HTTP permissions or standard security annotations.

Parameters:

tlsConfigurationName - the name of the configuration, cannot be null, cannot be <default>

Returns:

MtlsAuthenticationMechanism

See Also:

• for more information about ClientAuth#REQUEST
• about the TLS configuration name parameter

request

static MtlsAuthenticationMechanism request(String tlsConfigurationName,
 io.quarkus.tls.TlsConfiguration tlsConfiguration)

Creates the mutual TLS client authentication mechanism. The client authentication is accepted if presented by a client. Use this method if the client authentication is only required for certain routes and secure these routes with HTTP permissions or standard security annotations.

Parameters:

tlsConfigurationName - the name of the configuration, cannot be null, cannot be <default>

tlsConfiguration - the configuration cannot be null

Returns:

MtlsAuthenticationMechanism

See Also:

• for more information about ClientAuth#REQUEST
• for information about method parameters and TLS config registration

request

static MtlsAuthenticationMechanism request()

Creates the mutual TLS client authentication mechanism. The client authentication is accepted if presented by a client. Use this method if the client authentication is only required for certain routes and secure these routes with HTTP permissions or standard security annotations.

Returns:

MtlsAuthenticationMechanism

See Also:

• for more information

required

static MtlsAuthenticationMechanism required(String tlsConfigurationName,
 io.quarkus.tls.TlsConfiguration tlsConfiguration)

Creates the mutual TLS client authentication mechanism. This mechanism always require the client authentication.

Parameters:

tlsConfigurationName - the name of the configuration, cannot be null, cannot be <default>

tlsConfiguration - the configuration cannot be null

Returns:

MtlsAuthenticationMechanism

See Also:

• for more information about ClientAuth#REQUIRED
• for information about method parameters and TLS config registration

required

static MtlsAuthenticationMechanism required(String tlsConfigurationName)

Creates the mutual TLS client authentication mechanism. This mechanism always require the client authentication.

Parameters:

tlsConfigurationName - the name of the configuration, cannot be null, cannot be <default>

Returns:

MtlsAuthenticationMechanism

See Also:

• for more information about ClientAuth#REQUIRED
• about the TLS configuration name parameter

required

static MtlsAuthenticationMechanism required()

Creates the mutual TLS client authentication mechanism. This mechanism always require the client authentication.

Returns:

MtlsAuthenticationMechanism

See Also:

• for more information

builder

static MTLS.Builder builder()

Returns:

Builder for the mutual TLS client authentication mechanism. By default, this builder creates a mechanism which requires client authentication.