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

Class DynamicPropertyPrivateKey

java.lang.Object

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

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

All Implemented Interfaces:

Serializable, RSAKey, RSAPrivateKey, Key, PrivateKey, Destroyable

public class DynamicPropertyPrivateKey
extends AbstractDynamicPropertyKey<RSAPrivateKey>
implements RSAPrivateKey

This is a special 'smart key' bean that will always present the latest private key for AuthenticationServices based on AuthorizationServerProperties.OAuth2.getEncodedPrivateKey(). 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.RSAPrivateKey

serialVersionUID

Constructor Summary

Constructors

Constructor	Description
DynamicPropertyPrivateKey(AuthorizationServerProperties authorizationServerProperties)

Method Summary

Modifier and Type	Method	Description
protected boolean	atomicSetKeyInRequestContextIfUnset(RSAPrivateKey key, DynamicPropertyKeysRequestContext requestContext)	Implementations must be atomic and only set the given key instance value in the request context if unset.
protected RSAPrivateKey	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.
void	destroy()
String	getAlgorithm()
protected AuthorizationServerProperties	getAuthorizationServerProperties()
byte[]	getEncoded()
protected RSAPrivateKey	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	getPrivateExponent()
boolean	isDestroyed()

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

DynamicPropertyPrivateKey

public DynamicPropertyPrivateKey(AuthorizationServerProperties authorizationServerProperties)

Method Details

getLog

protected org.slf4j.Logger getLog()

Specified by:

getLog in class AbstractDynamicPropertyKey<RSAPrivateKey>

Returns:

the logger that should be used for log messages

getExistingKeyFromRequestContext

@Nullable
protected RSAPrivateKey getExistingKeyFromRequestContext(DynamicPropertyKeysRequestContext requestContext)

Specified by:

getExistingKeyFromRequestContext in class AbstractDynamicPropertyKey<RSAPrivateKey>

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(RSAPrivateKey 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<RSAPrivateKey>

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<RSAPrivateKey>

Returns:

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

constructKeyInstance

protected RSAPrivateKey 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<RSAPrivateKey>

Parameters:

rawKeyValue - the raw key value to construct the instance from

Returns:

the constructed key instance

getPrivateExponent

public BigInteger getPrivateExponent()

Specified by:

getPrivateExponent in interface RSAPrivateKey

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

destroy

public void destroy()
             throws DestroyFailedException

Specified by:

destroy in interface Destroyable

Throws:

DestroyFailedException

isDestroyed

public boolean isDestroyed()

Specified by:

isDestroyed in interface Destroyable

getAuthorizationServerProperties

protected AuthorizationServerProperties getAuthorizationServerProperties()