Package io.quarkus.vertx.http.runtime.security

Class HttpSecurityImpl

java.lang.Object

io.quarkus.vertx.http.runtime.security.HttpSecurityImpl

All Implemented Interfaces:

HttpSecurity

final class HttpSecurityImpl
extends Object
implements HttpSecurity

Nested Class Summary

Nested classes/interfaces inherited from interface io.quarkus.vertx.http.security.HttpSecurity

HttpSecurity.Authorization, HttpSecurity.HttpPermission

Constructor Summary

Constructors

Constructor	Description
HttpSecurityImpl(io.vertx.core.http.ClientAuth clientAuth, VertxHttpConfig vertxHttpConfig, Optional<String> httpServerTlsConfigName)

Method Summary

Modifier and Type	Method	Description
(package private) void	addHttpPermissions(List<HttpSecurityConfiguration.HttpPermissionCarrier> httpPermissions)
HttpSecurity	basic()	Registers the Basic authentication mechanism in addition to all other global authentication mechanisms.
HttpSecurity	basic(String authenticationRealm)	Registers the Basic authentication mechanism in addition to all other global authentication mechanisms.
HttpSecurity.HttpPermission	delete(String... paths)	This method is a shortcut for path(path).methods("DELETE").
HttpSecurity.HttpPermission	get(String... paths)	This method is a shortcut for path(path).methods("GET").
(package private) io.vertx.core.http.ClientAuth	getClientAuth()
(package private) List<HttpSecurityConfiguration.HttpPermissionCarrier>	getHttpPermissions()
(package private) Optional<String>	getHttpServerTlsConfigName()
(package private) List<HttpAuthenticationMechanism>	getMechanisms()
(package private) RolesMapping	getRolesMapping()
HttpSecurity	mechanism(HttpAuthenticationMechanism mechanism)	Registers given HttpAuthenticationMechanism in addition to all other global authentication mechanisms.
HttpSecurity	mTLS()	Registers the mutual TLS client authentication mechanism in addition to all other global authentication mechanisms.
HttpSecurity	mTLS(MtlsAuthenticationMechanism mTLSAuthenticationMechanism)	Registers the mutual TLS client authentication mechanism in addition to all other global authentication mechanisms.
HttpSecurity	mTLS(io.vertx.core.http.ClientAuth tlsClientAuth)	Registers the mutual TLS client authentication mechanism in addition to all other global authentication mechanisms.
HttpSecurity	mTLS(String tlsConfigurationName, io.quarkus.tls.TlsConfiguration tlsConfiguration)	Registers the mutual TLS client authentication mechanism in addition to all other global authentication mechanisms.
HttpSecurity.HttpPermission	path(String... patterns)	Creates HttpSecurity.HttpPermission in addition to the permissions configured in the 'application.properties' file.
HttpSecurity.HttpPermission	post(String... paths)	This method is a shortcut for path(path).methods("POST").
HttpSecurity.HttpPermission	put(String... paths)	This method is a shortcut for path(path).methods("PUT").
HttpSecurity	rolesMapping(String sourceRole, String targetRole)
HttpSecurity	rolesMapping(String sourceRole, List<String> targetRoles)
HttpSecurity	rolesMapping(Map<String,List<String>> roleToRoles)	Map the `SecurityIdentity` roles to deployment specific roles and add the matching roles to `SecurityIdentity`.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

HttpSecurityImpl

HttpSecurityImpl(io.vertx.core.http.ClientAuth clientAuth,
 VertxHttpConfig vertxHttpConfig,
 Optional<String> httpServerTlsConfigName)

Method Details

mechanism

public HttpSecurity mechanism(HttpAuthenticationMechanism mechanism)

Description copied from interface: HttpSecurity

Registers given HttpAuthenticationMechanism in addition to all other global authentication mechanisms.

Specified by:

mechanism in interface HttpSecurity

Parameters:

mechanism - HttpAuthenticationMechanism

Returns:

HttpSecurity

basic

public HttpSecurity basic()

Description copied from interface: HttpSecurity

Registers the Basic authentication mechanism in addition to all other global authentication mechanisms. This method is a shortcut for mechanism(Basic.create()).

Specified by:

basic in interface HttpSecurity

Returns:

HttpSecurity

basic

public HttpSecurity basic(String authenticationRealm)

Description copied from interface: HttpSecurity

Registers the Basic authentication mechanism in addition to all other global authentication mechanisms. This method is a shortcut for mechanism(Basic.realm(authenticationRealm)).

Specified by:

basic in interface HttpSecurity

Parameters:

authenticationRealm - see the 'quarkus.http.auth.realm' configuration property

Returns:

HttpSecurity

mTLS

public HttpSecurity mTLS()

Description copied from interface: HttpSecurity

Registers the mutual TLS client authentication mechanism in addition to all other global authentication mechanisms. This method is a shortcut for mTLS(ClientAuth.REQUIRED), therefore the client authentication is required.

Specified by:

mTLS in interface HttpSecurity

Returns:

HttpSecurity

See Also:

• for more information

mTLS

public HttpSecurity mTLS(String tlsConfigurationName,
 io.quarkus.tls.TlsConfiguration tlsConfiguration)

Description copied from interface: HttpSecurity

Registers the mutual TLS client authentication mechanism in addition to all other global authentication mechanisms. The TLS configuration is registered against the registry and is used by the HTTP server for the TLS communication. This method is a shortcut for the httpSecurity.mTLS(MTLS.required(tlsConfigurationName, tlsConfiguration)), therefore the client authentication is required.

Specified by:

mTLS in interface HttpSecurity

Parameters:

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

tlsConfiguration - the configuration cannot be null

Returns:

HttpSecurity

See Also:

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

mTLS

public HttpSecurity mTLS(MtlsAuthenticationMechanism mTLSAuthenticationMechanism)

Description copied from interface: HttpSecurity

Registers the mutual TLS client authentication mechanism in addition to all other global authentication mechanisms.

Specified by:

mTLS in interface HttpSecurity

Parameters:

mTLSAuthenticationMechanism - MtlsAuthenticationMechanism build with the MTLS API

Returns:

HttpSecurity

mTLS

public HttpSecurity mTLS(io.vertx.core.http.ClientAuth tlsClientAuth)

Description copied from interface: HttpSecurity

Registers the mutual TLS client authentication mechanism in addition to all other global authentication mechanisms. If you need to define the client certificate attribute value to role mappings, please use the MTLS builder.

Specified by:

mTLS in interface HttpSecurity

Parameters:

tlsClientAuth - either ClientAuth.REQUEST or ClientAuth.REQUIRED; for more information, see the VertxHttpBuildTimeConfig.tlsClientAuth() configuration property

Returns:

HttpSecurity

path

public HttpSecurity.HttpPermission path(String... patterns)

Description copied from interface: HttpSecurity

Creates HttpSecurity.HttpPermission in addition to the permissions configured in the 'application.properties' file.

Specified by:

path in interface HttpSecurity

Parameters:

patterns - path patterns; this is programmatic analogy to the 'quarkus.http.auth.permission."permissions".paths' configuration property, same rules apply

Returns:

new HttpSecurity.HttpPermission

get

public HttpSecurity.HttpPermission get(String... paths)

Description copied from interface: HttpSecurity

This method is a shortcut for path(path).methods("GET").

Specified by:

get in interface HttpSecurity

See Also:

• HttpSecurity.path(String...)

put

public HttpSecurity.HttpPermission put(String... paths)

Description copied from interface: HttpSecurity

This method is a shortcut for path(path).methods("PUT").

Specified by:

put in interface HttpSecurity

See Also:

• HttpSecurity.path(String...)

post

public HttpSecurity.HttpPermission post(String... paths)

Description copied from interface: HttpSecurity

This method is a shortcut for path(path).methods("POST").

Specified by:

post in interface HttpSecurity

See Also:

• HttpSecurity.path(String...)

delete

public HttpSecurity.HttpPermission delete(String... paths)

Description copied from interface: HttpSecurity

This method is a shortcut for path(path).methods("DELETE").

Specified by:

delete in interface HttpSecurity

See Also:

• HttpSecurity.path(String...)

rolesMapping

public HttpSecurity rolesMapping(Map<String,List<String>> roleToRoles)

Description copied from interface: HttpSecurity

Map the `SecurityIdentity` roles to deployment specific roles and add the matching roles to `SecurityIdentity`. Programmatic analogy to the 'quarkus.http.auth.roles-mapping."role-name"' configuration property. If the configuration property is already set, invocation of this method fails as both methods are mutually exclusive.

Specified by:

rolesMapping in interface HttpSecurity

rolesMapping

public HttpSecurity rolesMapping(String sourceRole,
 List<String> targetRoles)

Specified by:

rolesMapping in interface HttpSecurity

See Also:

• HttpSecurity.rolesMapping(Map)

rolesMapping

public HttpSecurity rolesMapping(String sourceRole,
 String targetRole)

Specified by:

rolesMapping in interface HttpSecurity

See Also:

• HttpSecurity.rolesMapping(Map)

addHttpPermissions

void addHttpPermissions(List<HttpSecurityConfiguration.HttpPermissionCarrier> httpPermissions)

getHttpPermissions

List<HttpSecurityConfiguration.HttpPermissionCarrier> getHttpPermissions()

getRolesMapping

RolesMapping getRolesMapping()

getMechanisms

List<HttpAuthenticationMechanism> getMechanisms()

getClientAuth

io.vertx.core.http.ClientAuth getClientAuth()

getHttpServerTlsConfigName

Optional<String> getHttpServerTlsConfigName()