Package com.broadleafcommerce.auth.user.autoconfigure.support.keys

Class DynamicPropertyPublicKey

java.lang.Object

com.broadleafcommerce.auth.user.autoconfigure.support.keys.AbstractDynamicPropertyKey<RSAPublicKey>

com.broadleafcommerce.auth.user.autoconfigure.support.keys.DynamicPropertyPublicKey

All Implemented Interfaces:

Serializable, RSAKey, RSAPublicKey, Key, PublicKey

public class DynamicPropertyPublicKey
extends AbstractDynamicPropertyKey<RSAPublicKey>
implements RSAPublicKey

This is a special 'smart key' bean that will always present the latest public key for AuthenticationServices based on AuthorizationServerProperties.OAuth2.getEncodedPublicKey(). The only exception is when this key is used multiple times in a request lifecycle - in that case, the 'latest' value is computed in the first use of this key, and then that value is used for the remainder of that request's lifecycle.

See Also:

• AbstractDynamicPropertyKey
• DynamicPropertyKeysRequestContext
• Serialized Form

Field Summary

Fields inherited from interface java.security.interfaces.RSAPublicKey

serialVersionUID

Constructor Summary

Constructors

Constructor	Description
DynamicPropertyPublicKey(AuthorizationServerProperties authorizationServerProperties)

Method Summary

Modifier and Type	Method	Description
protected boolean	atomicSetKeyInRequestContextIfUnset(RSAPublicKey key, DynamicPropertyKeysRequestContext requestContext)	Implementations must be atomic and only set the given key instance value in the request context if unset.
protected RSAPublicKey	constructKeyInstance(String rawKeyValue)	Note - if this implementation changes, it's important to also ensure the interface declared at the top of this class is made as specific as possible to match.
String	getAlgorithm()
protected AuthorizationServerProperties	getAuthorizationServerProperties()
byte[]	getEncoded()
protected RSAPublicKey	getExistingKeyFromRequestContext(DynamicPropertyKeysRequestContext requestContext)
String	getFormat()
protected String	getLatestPropertyValueForKey()	AuthorizationServerProperties will always contain the latest refreshed property value.
protected org.slf4j.Logger	getLog()
BigInteger	getModulus()
AlgorithmParameterSpec	getParams()
BigInteger	getPublicExponent()

Methods inherited from class com.broadleafcommerce.auth.user.autoconfigure.support.keys.AbstractDynamicPropertyKey

getDelegate, getDynamicPropertyKeysRequestContext, getOrComputeKeyFromRequestContext, getOrComputeLatestKeyFromProperties, setDynamicPropertyKeysRequestContext

Methods inherited from class java.lang.Object

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

Constructor Details

DynamicPropertyPublicKey

public DynamicPropertyPublicKey(AuthorizationServerProperties authorizationServerProperties)

Method Details

getLog

protected org.slf4j.Logger getLog()

Specified by:

getLog in class AbstractDynamicPropertyKey<RSAPublicKey>

Returns:

the logger that should be used for log messages

getExistingKeyFromRequestContext

@Nullable
protected RSAPublicKey getExistingKeyFromRequestContext(DynamicPropertyKeysRequestContext requestContext)

Specified by:

getExistingKeyFromRequestContext in class AbstractDynamicPropertyKey<RSAPublicKey>

Parameters:

requestContext - the request context from which to get the existing key instance

Returns:

the existing key instance in the request context, or null if none is set

atomicSetKeyInRequestContextIfUnset

protected boolean atomicSetKeyInRequestContextIfUnset(RSAPublicKey key,
 DynamicPropertyKeysRequestContext requestContext)

Description copied from class: AbstractDynamicPropertyKey

Implementations must be atomic and only set the given key instance value in the request context if unset.

Recommended to use AtomicReference.compareAndSet(Object, Object) semantics.

Specified by:

atomicSetKeyInRequestContextIfUnset in class AbstractDynamicPropertyKey<RSAPublicKey>

Parameters:

key - the key value to set in the request context

requestContext - the request context in which to set the value

Returns:

true if the update succeeded (only set if unset), false otherwise

getLatestPropertyValueForKey

protected String getLatestPropertyValueForKey()

AuthorizationServerProperties will always contain the latest refreshed property value.

Specified by:

getLatestPropertyValueForKey in class AbstractDynamicPropertyKey<RSAPublicKey>

Returns:

the latest property value for AuthorizationServerProperties.OAuth2.getEncodedPublicKey()

constructKeyInstance

protected RSAPublicKey constructKeyInstance(String rawKeyValue)

Note - if this implementation changes, it's important to also ensure the interface declared at the top of this class is made as specific as possible to match. This ensures things like instanceof checks against this class (ex: such as those done in RSAKey) will go through the right code flows based on the specific interface type.

Specified by:

constructKeyInstance in class AbstractDynamicPropertyKey<RSAPublicKey>

Parameters:

rawKeyValue - the raw key value to construct the instance from

Returns:

the constructed key instance

getPublicExponent

public BigInteger getPublicExponent()

Specified by:

getPublicExponent in interface RSAPublicKey

getAlgorithm

public String getAlgorithm()

Specified by:

getAlgorithm in interface Key

getFormat

public String getFormat()

Specified by:

getFormat in interface Key

getEncoded

public byte[] getEncoded()

Specified by:

getEncoded in interface Key

getModulus

public BigInteger getModulus()

Specified by:

getModulus in interface RSAKey

getParams

public AlgorithmParameterSpec getParams()

Specified by:

getParams in interface RSAKey

getAuthorizationServerProperties

protected AuthorizationServerProperties getAuthorizationServerProperties()