Module io.helidon.security.providers.header

Package io.helidon.security.providers.header

Class HeaderAtnProvider

java.lang.Object

io.helidon.security.providers.header.HeaderAtnProvider

All Implemented Interfaces:

AuthenticationProvider, OutboundSecurityProvider, SecurityProvider

public class HeaderAtnProvider
extends Object
implements AuthenticationProvider, OutboundSecurityProvider

Security provider that extracts a username (or service name) from a header. This provider also supports propagation of identity through a header.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	HeaderAtnProvider.Builder	A fluent api Builder for HeaderAtnProvider.

Method Summary

Modifier and Type	Method	Description
AuthenticationResponse	authenticate(ProviderRequest providerRequest)	Authenticate a request.
static HeaderAtnProvider.Builder	builder()	A builder for this provider.
static HeaderAtnProvider	create(Config config)	Create provider instance from configuration.
boolean	isOutboundSupported(ProviderRequest providerRequest, SecurityEnvironment outboundEnv, EndpointConfig outboundConfig)	Check if the path to be executed is supported by this security provider.
OutboundSecurityResponse	outboundSecurity(ProviderRequest providerRequest, SecurityEnvironment outboundEnv, EndpointConfig outboundEndpointConfig)	Creates necessary updates to headers and entity needed for outbound security (e.g.

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

create

public static HeaderAtnProvider create(Config config)

Create provider instance from configuration.

Parameters:

config - configuration of this provider

Returns:

provider instance

builder

public static HeaderAtnProvider.Builder builder()

A builder for this provider.

Returns:

builder to create a new instance

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)

isOutboundSupported

public boolean isOutboundSupported(ProviderRequest providerRequest,
 SecurityEnvironment outboundEnv,
 EndpointConfig outboundConfig)

Description copied from interface: OutboundSecurityProvider

Check if the path to be executed is supported by this security provider. Defaults to true.

Specified by:

isOutboundSupported in interface OutboundSecurityProvider

Parameters:

providerRequest - context with environment, subject(s) etc. that was received

outboundEnv - environment for outbound call

outboundConfig - outbound endpoint configuration

Returns:

true if this identity propagator can generate required headers for the path defined

outboundSecurity

public OutboundSecurityResponse outboundSecurity(ProviderRequest providerRequest,
 SecurityEnvironment outboundEnv,
 EndpointConfig outboundEndpointConfig)

Description copied from interface: OutboundSecurityProvider

Creates necessary updates to headers and entity needed for outbound security (e.g. identity propagation, s2s security etc.). This method will be invoked for outbound requests ONLY.

Specified by:

outboundSecurity in interface OutboundSecurityProvider

Parameters:

providerRequest - context with environment, subject(s) etc. that was received

outboundEnv - environment for outbound call

outboundEndpointConfig - outbound endpoint configuration

Returns:

response with generated headers and other possible configuration

See Also:

• OutboundSecurityResponse.builder()