Module io.helidon.security.providers.httpauth

Package io.helidon.security.providers.httpauth

Class HttpDigestAuthProvider

java.lang.Object

io.helidon.security.providers.httpauth.HttpDigestAuthProvider

All Implemented Interfaces:

AuthenticationProvider, SecurityProvider

public final class HttpDigestAuthProvider
extends Object
implements AuthenticationProvider

Http authentication security provider. Provides support for username and password authentication, with support for roles list.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	HttpDigestAuthProvider.Builder	HttpDigestAuthProvider fluent API builder.

Method Summary

Modifier and Type	Method	Description
AuthenticationResponse	authenticate(ProviderRequest providerRequest)	Authenticate a request.
static HttpDigestAuthProvider.Builder	builder()	Get a builder instance to construct a new security provider.
static HttpDigestAuthProvider	create(Config config)	Deprecated, for removal: This API element is subject to removal in a future version. use create(io.helidon.config.Config) instead
static HttpDigestAuthProvider	create(Config config)	Load this provider from configuration.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.helidon.security.spi.SecurityProvider

supportedAnnotations, supportedAttributes, supportedConfigKeys, supportedCustomObjects

Method Details

builder

public static HttpDigestAuthProvider.Builder builder()

Get a builder instance to construct a new security provider. Alternative approach is create(Config) (or create(Config)).

Returns:

builder to fluently construct Basic security provider

create

@Deprecated(since="4.4.0",
            forRemoval=true)
public static HttpDigestAuthProvider create(Config config)

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

use create(io.helidon.config.Config) instead

Load this provider from configuration.

Parameters:

config - configuration

Returns:

instance of provider configured from provided config

create

public static HttpDigestAuthProvider create(Config config)

Load this provider from configuration.

Parameters:

config - Configuration located at this provider's configuration (e.g. child is either http-basic-auth or http-digest-auth)

Returns:

instance of provider configured from provided config

authenticate

public AuthenticationResponse authenticate(ProviderRequest providerRequest)

Description copied from interface: AuthenticationProvider

Authenticate a request. This may be just resolving headers (tokens) or full authentication (basic auth). Do not throw exception for normal processing (e.g. invalid credentials; you may throw an exception in case of misconfiguration). This method will be invoked for inbound requests ONLY.

This method must provide either a Principal or a whole Subject either for a user or for service (or both).

Specified by:

authenticate in interface AuthenticationProvider

Parameters:

providerRequest - context of this security enforcement/validation

Returns:

response that either authenticates the request, fails authentication or abstains from authentication

See Also:

• AuthenticationResponse.success(Subject)