Class AbstractLookupKeyProvider

java.lang.Object

com.kingsrook.qqq.backend.core.crypto.AbstractLookupKeyProvider

All Implemented Interfaces:

QKeyProviderInterface

Direct Known Subclasses:

AwsSecretsManagerKeyProvider, EnvKeyProvider

public abstract class AbstractLookupKeyProvider
extends Object
implements QKeyProviderInterface

Base for key providers that look up base64 text by name. Naming convention for a keyRef NAME: - NAME holds the CURRENT key (base64 of 32 bytes) - NAME_VERSION optionally names the current version (default "1") - NAME_V{version} holds the key for an older version, kept while data written under it still exists So rotating is: copy NAME to NAME_V{old}, put the new key in NAME, and set NAME_VERSION to the new version.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_VERSION

Constructor Summary

Constructors

Constructor	Description
AbstractLookupKeyProvider()

Method Summary

Modifier and Type	Method	Description
protected abstract String	describeSource()	Describe the source, for messages (e.g., "environment variable").
QKeyMaterial	getKey(String keyRef)	Get the current version of the key.
QKeyMaterial	getKey(String keyRef, String version)	Get a specific version of the key.
protected abstract Optional<String>	lookup(String name)	Look up the (base64) value stored under a name.

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_VERSION

public static final String DEFAULT_VERSION

See Also:

• Constant Field Values

Constructor Details

AbstractLookupKeyProvider

public AbstractLookupKeyProvider()

Method Details

lookup

protected abstract Optional<String> lookup(String name)

Look up the (base64) value stored under a name. Empty if not found.

describeSource

protected abstract String describeSource()

Describe the source, for messages (e.g., "environment variable").

getKey

public QKeyMaterial getKey(String keyRef)
                    throws QException

Description copied from interface: QKeyProviderInterface

Get the current version of the key.

Specified by:

getKey in interface QKeyProviderInterface

Throws:

QException - if the key cannot be found or is invalid

getKey

public QKeyMaterial getKey(String keyRef,
 String version)
                    throws QException

Description copied from interface: QKeyProviderInterface

Get a specific version of the key.

Specified by:

getKey in interface QKeyProviderInterface

Throws:

QException - if that version of the key cannot be found or is invalid