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

Class S256PkceGenerator

java.lang.Object

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

All Implemented Interfaces:

io.micronaut.core.naming.Named, io.micronaut.core.order.Ordered, PkceGenerator

@Named(value="S256")
 @Singleton
 @Requires(condition=Sha256Condition.class)
public class S256PkceGenerator
extends java.lang.Object
implements PkceGenerator

SHA-256 based PKCE Generator.

Since:

3.9.0

Author:

Sergio del Amo

See Also:

xProof Key for Code Exchange by OAuth Public Clients (RFC 7636), Section 4.3

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CODE_CHALLENGE_METHOD_S256
static java.lang.Integer	ORDER

Fields inherited from interface io.micronaut.core.order.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
S256PkceGenerator(CodeVerifierGenerator codeVerifierGenerator)

Method Summary

Modifier and Type	Method and Description
Pkce	generate()
java.lang.String	getName()
int	getOrder()
static java.lang.String	hash(java.lang.String value)
boolean	supportsAny(java.util.List<java.lang.String> codeChallengeMethods)

Methods inherited from class java.lang.Object

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

Field Detail

ORDER

public static final java.lang.Integer ORDER

CODE_CHALLENGE_METHOD_S256

public static final java.lang.String CODE_CHALLENGE_METHOD_S256

See Also:

Constant Field Values

Constructor Detail

S256PkceGenerator

public S256PkceGenerator(CodeVerifierGenerator codeVerifierGenerator)

Parameters:

codeVerifierGenerator - Code Verifier generator

Method Detail

getName

@NonNull
public java.lang.String getName()

Specified by:

getName in interface io.micronaut.core.naming.Named

getOrder

public int getOrder()

Specified by:

getOrder in interface io.micronaut.core.order.Ordered

supportsAny

public boolean supportsAny(@NonNull
                           java.util.List<java.lang.String> codeChallengeMethods)

Specified by:

supportsAny in interface PkceGenerator

Parameters:

codeChallengeMethods - Code Challenge methods

Returns:

Whether the PKCE Generator supports any of the supplied code challenge methods.

generate

@NonNull
public Pkce generate()

Specified by:

generate in interface PkceGenerator

Returns:

Generates a Pkce.

hash

@NonNull
public static java.lang.String hash(@NonNull
                                             java.lang.String value)

Parameters:

value - Value to be hashed

Returns:

a hash build with algorithm SHA-256