Module io.helidon.security.providers.oidc.common

Package io.helidon.security.providers.oidc.common

Enum Class PkceChallengeMethod

java.lang.Object

java.lang.Enum<PkceChallengeMethod>

io.helidon.security.providers.oidc.common.PkceChallengeMethod

All Implemented Interfaces:

Serializable, Comparable<PkceChallengeMethod>, Constable

public enum PkceChallengeMethod
extends Enum<PkceChallengeMethod>

Proof Key Code Exchange (PKCE) challenge generation type. Based on RFC7636 - Section 4.2

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
PLAIN	No hashing will be applied.
S256	SHA-256 algorithm is used to hash the verifier value.

Method Summary

Modifier and Type	Method	Description
String	method()	Proof Key Code Exchange (PKCE) method name.
String	transform(String verifier)	Transform Proof Key Code Exchange (PKCE) verifier to the challenge.
static PkceChallengeMethod	valueOf(String name)	Returns the enum constant of this class with the specified name.
static PkceChallengeMethod[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

PLAIN

public static final PkceChallengeMethod PLAIN

No hashing will be applied. Challenge string will be the same as verifier.

S256

public static final PkceChallengeMethod S256

SHA-256 algorithm is used to hash the verifier value.

Method Details

values

public static PkceChallengeMethod[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static PkceChallengeMethod valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

transform

public String transform(String verifier)

Transform Proof Key Code Exchange (PKCE) verifier to the challenge.

Parameters:

verifier - PKCE verifier

Returns:

PKCE challenge

method

public String method()

Proof Key Code Exchange (PKCE) method name.

Returns:

method name