Package google.registry.request.auth

Interface AuthenticationMechanism

All Known Implementing Classes:
LegacyAuthenticationMechanism, OidcTokenAuthenticationMechanism
public interface AuthenticationMechanism
A particular way to authenticate an HTTP request, returning an AuthResult.

For instance, a request could be authenticated using OIDC, via special request headers, etc.

  • Method Summary

    Modifier and Type
    Method
    Description
    AuthResult
    authenticate(jakarta.servlet.http.HttpServletRequest request)
    Attempt to authenticate an incoming request.

  • Method Details

    • authenticate

      AuthResult authenticate(jakarta.servlet.http.HttpServletRequest request)
      Attempt to authenticate an incoming request.
      Parameters:
      request - the request to be authenticated
      Returns:
      the results of the authentication check; if the request could not be authenticated, the mechanism should return AuthResult.NOT_AUTHENTICATED