Package io.micronaut.security.oauth2.endpoint.authorization.pkce

Interface PkceFactory

All Known Implementing Classes:
DefaultPkceFactory
@DefaultImplementation(DefaultPkceFactory.class) public interface PkceFactory
API to Build/Persist a PKCE (Proof Key for Code Exchange).
Since:
3.9.0
Author:
Sergio del Amo

  • Method Summary

    Modifier and Type
    Method
    Description
    @NonNull Optional<PkceChallenge>
    buildChallenge(@NonNull io.micronaut.http.HttpRequest<?> request, @NonNull io.micronaut.http.MutableHttpResponse<?> response, @Nullable List<String> supportedChallengeMethods)
     

  • Method Details

    • buildChallenge

      @NonNull @NonNull Optional<PkceChallenge> buildChallenge(@NonNull @NonNull io.micronaut.http.HttpRequest<?> request, @NonNull @NonNull io.micronaut.http.MutableHttpResponse<?> response, @Nullable @Nullable List<String> supportedChallengeMethods)
      Parameters:
      request - The original request prior redirect
      response - The authorization redirect response
      supportedChallengeMethods - Challenge methods supported by the authorization server
      Returns:
      A state parameter. An opaque value used to maintain state between the request and the callback.