Interface QKeyProviderInterface

All Known Implementing Classes:

AbstractLookupKeyProvider, AwsSecretsManagerKeyProvider, EnvKeyProvider

public interface QKeyProviderInterface

Source of symmetric key-encryption keys, addressed by a key reference. A keyRef names a logical key (e.g., an environment variable name, or a secret name). Each key can have several versions, so keys can be rotated: getKey(keyRef) returns the CURRENT version (use it for writes), while getKey(keyRef, version) returns a specific, possibly older, version (use it to read data that was written under that version). Implementations must never log key bytes, and must not put them in messages of exceptions they throw.

Method Summary

Modifier and Type	Method	Description
QKeyMaterial	getKey(String keyRef)	Get the current version of the key.
QKeyMaterial	getKey(String keyRef, String version)	Get a specific version of the key.

Method Details

getKey

QKeyMaterial getKey(String keyRef)
             throws QException

Get the current version of the key.

Throws:

QException - if the key cannot be found or is invalid

getKey

QKeyMaterial getKey(String keyRef,
 String version)
             throws QException

Get a specific version of the key.

Throws:

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