io.quarkus.vertx.http.runtime.security

Class BasicAuthenticationMechanism

java.lang.Object

io.quarkus.vertx.http.runtime.security.BasicAuthenticationMechanism

All Implemented Interfaces:

HttpAuthenticationMechanism

@ApplicationScoped
public class BasicAuthenticationMechanism
extends Object
implements HttpAuthenticationMechanism

The authentication handler responsible for BASIC authentication as described by RFC2617

Author:

Darran Lofthouse

Field Summary

Fields

Modifier and Type	Field and Description
static String	CHARSET
static String	SILENT
static String	USER_AGENT_CHARSETS A comma separated list of patterns and charsets.

Constructor Summary

Constructors

Constructor and Description
BasicAuthenticationMechanism(String realmName)
BasicAuthenticationMechanism(String realmName, String mechanismName)
BasicAuthenticationMechanism(String realmName, String mechanismName, boolean silent)
BasicAuthenticationMechanism(String realmName, String mechanismName, boolean silent, Charset charset, Map<Pattern,Charset> userAgentCharsets)

Method Summary

Modifier and Type	Method and Description
CompletionStage<io.quarkus.security.identity.SecurityIdentity>	authenticate(io.vertx.ext.web.RoutingContext context, io.quarkus.security.identity.IdentityProviderManager identityProviderManager)
CompletionStage<Boolean>	sendChallenge(io.vertx.ext.web.RoutingContext context)

Methods inherited from class java.lang.Object

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

Field Detail

SILENT

public static final String SILENT

See Also:

Constant Field Values

CHARSET

public static final String CHARSET

See Also:

Constant Field Values

USER_AGENT_CHARSETS

public static final String USER_AGENT_CHARSETS

A comma separated list of patterns and charsets. The pattern is a regular expression. Because different browsers user different encodings this allows for the correct encoding to be selected based on the current browser. In general though it is recommended that BASIC auth not be used when passwords contain characters outside ASCII, as some browsers use the current locate to determine encoding. This list must have an even number of elements, as it is interpreted as pattern,charset,pattern,charset,...

See Also:

Constant Field Values

Constructor Detail

BasicAuthenticationMechanism

public BasicAuthenticationMechanism(String realmName)

BasicAuthenticationMechanism

public BasicAuthenticationMechanism(String realmName,
                                    String mechanismName)

BasicAuthenticationMechanism

public BasicAuthenticationMechanism(String realmName,
                                    String mechanismName,
                                    boolean silent)

BasicAuthenticationMechanism

public BasicAuthenticationMechanism(String realmName,
                                    String mechanismName,
                                    boolean silent,
                                    Charset charset,
                                    Map<Pattern,Charset> userAgentCharsets)

Method Detail

authenticate

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

Specified by:

authenticate in interface HttpAuthenticationMechanism

sendChallenge

public CompletionStage<Boolean> sendChallenge(io.vertx.ext.web.RoutingContext context)

Specified by:

sendChallenge in interface HttpAuthenticationMechanism