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

Class FormAuthenticationMechanism

java.lang.Object

io.quarkus.vertx.http.runtime.security.FormAuthenticationMechanism

All Implemented Interfaces:

HttpAuthenticationMechanism

public class FormAuthenticationMechanism
extends Object
implements HttpAuthenticationMechanism

Nested Class Summary

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

HttpAuthenticationMechanism.ChallengeSender

Field Summary

Fields

Modifier and Type	Field	Description
(package private) static String	encryptionKey

Fields inherited from interface io.quarkus.vertx.http.runtime.security.HttpAuthenticationMechanism

DEFAULT_PRIORITY

Constructor Summary

Constructors

Constructor	Description
FormAuthenticationMechanism(FormAuthConfig runtimeForm, Optional<String> encKey)
FormAuthenticationMechanism(String loginPage, String postLocation, String usernameParameter, String passwordParameter, String errorPage, String landingPage, boolean redirectAfterLogin, String locationCookie, String cookieSameSite, String cookiePath, String cookieDomain, PersistentLoginManager loginManager)	Deprecated, for removal: This API element is subject to removal in a future version. use FormAuthenticationMechanism(FormAuthConfig, Optional)

Method Summary

Modifier and Type	Method	Description
io.smallrye.mutiny.Uni<io.quarkus.security.identity.SecurityIdentity>	authenticate(io.vertx.ext.web.RoutingContext context, io.quarkus.security.identity.IdentityProviderManager identityProviderManager)
io.smallrye.mutiny.Uni<ChallengeData>	getChallenge(io.vertx.ext.web.RoutingContext context)
io.smallrye.mutiny.Uni<HttpCredentialTransport>	getCredentialTransport(io.vertx.ext.web.RoutingContext context)	The credential transport, used for finding the best candidate for authenticating and challenging when more than one mechanism is installed.
Set<Class<? extends io.quarkus.security.identity.request.AuthenticationRequest>>	getCredentialTypes()	If this mechanism delegates authentication to the IdentityProviderManager using the IdentityProviderManager.authenticate(AuthenticationRequest) call, then the mechanism must provide supported AuthenticationRequest request types.
(package private) String	getPostLocation()
(package private) static io.smallrye.mutiny.Uni<ChallengeData>	getRedirect(io.vertx.ext.web.RoutingContext exchange, String location, Set<String> redirectQueryParams)
protected void	handleRedirectBack(io.vertx.ext.web.RoutingContext exchange)
static void	logout(io.quarkus.security.identity.SecurityIdentity securityIdentity)
static void	logout(io.vertx.ext.web.RoutingContext routingContext)
io.smallrye.mutiny.Uni<io.quarkus.security.identity.SecurityIdentity>	runFormAuth(io.vertx.ext.web.RoutingContext exchange, io.quarkus.security.identity.IdentityProviderManager securityContext)
(package private) static void	sendRedirect(io.vertx.ext.web.RoutingContext exchange, String location)
protected void	servePage(io.vertx.ext.web.RoutingContext exchange, String location)	Deprecated, for removal: This API element is subject to removal in a future version. this method hasn't been used by this class for some time now; if you implement this mechanism and have a use case with this method, please let us no so that we can document and test it
protected void	storeInitialLocation(io.vertx.ext.web.RoutingContext exchange)
protected void	verifyRedirectBackLocation(String requestURIString, String redirectUriString)

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.quarkus.vertx.http.runtime.security.HttpAuthenticationMechanism

getPriority, sendChallenge

Field Details

encryptionKey

static volatile String encryptionKey

Constructor Details

FormAuthenticationMechanism

public FormAuthenticationMechanism(FormAuthConfig runtimeForm,
 Optional<String> encKey)

FormAuthenticationMechanism

@Deprecated(forRemoval=true,
            since="3.25")
public FormAuthenticationMechanism(String loginPage,
 String postLocation,
 String usernameParameter,
 String passwordParameter,
 String errorPage,
 String landingPage,
 boolean redirectAfterLogin,
 String locationCookie,
 String cookieSameSite,
 String cookiePath,
 String cookieDomain,
 PersistentLoginManager loginManager)

Deprecated, for removal: This API element is subject to removal in a future version.

use FormAuthenticationMechanism(FormAuthConfig, Optional)

Method Details

runFormAuth

public io.smallrye.mutiny.Uni<io.quarkus.security.identity.SecurityIdentity> runFormAuth(io.vertx.ext.web.RoutingContext exchange,
 io.quarkus.security.identity.IdentityProviderManager securityContext)

handleRedirectBack

protected void handleRedirectBack(io.vertx.ext.web.RoutingContext exchange)

verifyRedirectBackLocation

protected void verifyRedirectBackLocation(String requestURIString,
 String redirectUriString)

storeInitialLocation

protected void storeInitialLocation(io.vertx.ext.web.RoutingContext exchange)

servePage

@Deprecated(since="3.31",
            forRemoval=true)
protected void servePage(io.vertx.ext.web.RoutingContext exchange,
 String location)

Deprecated, for removal: This API element is subject to removal in a future version.

this method hasn't been used by this class for some time now; if you implement this mechanism and have a use case with this method, please let us no so that we can document and test it

sendRedirect

static void sendRedirect(io.vertx.ext.web.RoutingContext exchange,
 String location)

getRedirect

static io.smallrye.mutiny.Uni<ChallengeData> getRedirect(io.vertx.ext.web.RoutingContext exchange,
 String location,
 Set<String> redirectQueryParams)

authenticate

public io.smallrye.mutiny.Uni<io.quarkus.security.identity.SecurityIdentity> authenticate(io.vertx.ext.web.RoutingContext context,
 io.quarkus.security.identity.IdentityProviderManager identityProviderManager)

Specified by:

authenticate in interface HttpAuthenticationMechanism

getChallenge

public io.smallrye.mutiny.Uni<ChallengeData> getChallenge(io.vertx.ext.web.RoutingContext context)

Specified by:

getChallenge in interface HttpAuthenticationMechanism

getCredentialTypes

public Set<Class<? extends io.quarkus.security.identity.request.AuthenticationRequest>> getCredentialTypes()

Description copied from interface: HttpAuthenticationMechanism

If this mechanism delegates authentication to the IdentityProviderManager using the IdentityProviderManager.authenticate(AuthenticationRequest) call, then the mechanism must provide supported AuthenticationRequest request types. It allows Quarkus to validate that one or more IdentityProvider providers with matching supported IdentityProvider.getRequestType() request types exist and fail otherwise.

Specified by:

getCredentialTypes in interface HttpAuthenticationMechanism

Returns:

required credential types

getCredentialTransport

public io.smallrye.mutiny.Uni<HttpCredentialTransport> getCredentialTransport(io.vertx.ext.web.RoutingContext context)

Description copied from interface: HttpAuthenticationMechanism

The credential transport, used for finding the best candidate for authenticating and challenging when more than one mechanism is installed.

This method must be implemented if either HttpAuthenticationMechanism.value() or an HTTP security policy's `auth-mechanism` property has to be set to find a matching HttpAuthenticationMechanism that must secure a specific REST resource method or request path.

May be Uni with null item if this mechanism cannot interfere with other mechanisms.

Specified by:

getCredentialTransport in interface HttpAuthenticationMechanism

getPostLocation

String getPostLocation()

logout

public static void logout(io.quarkus.security.identity.SecurityIdentity securityIdentity)

logout

public static void logout(io.vertx.ext.web.RoutingContext routingContext)