java.lang.Object
io.helidon.security.providers.httpauth.HttpBasicAuthProvider
All Implemented Interfaces:
AuthenticationProvider, OutboundSecurityProvider, SecurityProvider

public class HttpBasicAuthProvider extends Object implements AuthenticationProvider, OutboundSecurityProvider
Http authentication security provider. Provides support for username and password authentication, with support for roles list.
  • Method Details

    • builder

      public static HttpBasicAuthProvider.Builder builder()
      Get a builder instance to construct a new security provider. Alternative approach is create(io.helidon.common.config.Config) (or create(Config)).
      Returns:
      builder to fluently construct Basic security provider
    • create

      public static HttpBasicAuthProvider 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
    • isOutboundSupported

      public boolean isOutboundSupported(ProviderRequest providerRequest, SecurityEnvironment outbondEnv, EndpointConfig outboundEp)
      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
      outbondEnv - environment for outbound call
      outboundEp - 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 outboundEp)
      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
      outboundEp - outbound endpoint configuration
      Returns:
      response with generated headers and other possible configuration
      See Also:
    • 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: