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

Class PkceConfigurationProperties

java.lang.Object

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

All Implemented Interfaces:

io.micronaut.core.util.Toggleable, PkceConfiguration, PersistableConfiguration

@ConfigurationProperties("micronaut.security.oauth2.pkce")
public class PkceConfigurationProperties
extends Object
implements PkceConfiguration

Configuration properties implementation of PKCE.

Since:

3.9.0

Author:

Nemanja Mikic

Field Summary

Fields

Modifier and Type	Field	Description
static final boolean	DEFAULT_ENABLED	The default enable value.
static final String	PERSISTENCE_COOKIE
static final String	PERSISTENCE_SESSION
static final String	PREFIX

Constructor Summary

Constructors

Constructor	Description
PkceConfigurationProperties()

Method Summary

Modifier and Type	Method	Description
int	getEntropy()
Optional<@Pattern(regexp="cookie|session") String>	getPersistence()
boolean	isEnabled()
void	setEnabled(boolean enabled)	Sets whether a state parameter will be sent.
void	setEntropy(int entropy)	entropy (in bytes) used for the code verifier generation.
void	setPersistence(String persistence)	Sets the mechanism to persist the state for later retrieval for validation.

Methods inherited from class java.lang.Object

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

Field Details

PREFIX

public static final String PREFIX

See Also:

• Constant Field Values

DEFAULT_ENABLED

public static final boolean DEFAULT_ENABLED

The default enable value.

See Also:

• Constant Field Values

PERSISTENCE_COOKIE

public static final String PERSISTENCE_COOKIE

See Also:

• Constant Field Values

PERSISTENCE_SESSION

public static final String PERSISTENCE_SESSION

See Also:

• Constant Field Values

Constructor Details

PkceConfigurationProperties

public PkceConfigurationProperties()

Method Details

getEntropy

public int getEntropy()

Specified by:

getEntropy in interface PkceConfiguration

Returns:

entropy (in bytes) used for the code verifier generation.

setEntropy

public void setEntropy(int entropy)

entropy (in bytes) used for the code verifier generation. Default value 64.

Parameters:

entropy - entropy (in bytes) used for the code verifier.

getPersistence

@NonNull
public Optional<@Pattern(regexp="cookie|session") String> getPersistence()

Specified by:

getPersistence in interface PersistableConfiguration

Returns:

The nonce persistence mechanism

setPersistence

public void setPersistence(String persistence)

Sets the mechanism to persist the state for later retrieval for validation. Supported values ("session", "cookie"). Default value ("cookie").

Parameters:

persistence - The persistence mechanism

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface io.micronaut.core.util.Toggleable

setEnabled

public void setEnabled(boolean enabled)

Sets whether a state parameter will be sent. Default (true).

Parameters:

enabled - The enabled flag