org.apache.hadoop.crypto.key.kms.server

Class EagerKeyGeneratorKeyProviderCryptoExtension

java.lang.Object

org.apache.hadoop.crypto.key.KeyProvider

org.apache.hadoop.crypto.key.KeyProviderExtension<KeyProviderCryptoExtension.CryptoExtension>

org.apache.hadoop.crypto.key.KeyProviderCryptoExtension

org.apache.hadoop.crypto.key.kms.server.EagerKeyGeneratorKeyProviderCryptoExtension

@InterfaceAudience.Private
public class EagerKeyGeneratorKeyProviderCryptoExtension
extends KeyProviderCryptoExtension

A KeyProviderCryptoExtension that pre-generates and caches encrypted keys.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.hadoop.crypto.key.KeyProviderCryptoExtension

KeyProviderCryptoExtension.EncryptedKeyVersion

Nested classes/interfaces inherited from class org.apache.hadoop.crypto.key.KeyProviderExtension

KeyProviderExtension.Extension

Nested classes/interfaces inherited from class org.apache.hadoop.crypto.key.KeyProvider

KeyProvider.KeyVersion, KeyProvider.Metadata, KeyProvider.Options

Field Summary

Fields

Modifier and Type	Field and Description
static int	KMS_KEY_CACHE_EXPIRY_DEFAULT
static String	KMS_KEY_CACHE_EXPIRY_MS
static String	KMS_KEY_CACHE_LOW_WATERMARK
static float	KMS_KEY_CACHE_LOW_WATERMARK_DEFAULT
static String	KMS_KEY_CACHE_NUM_REFILL_THREADS
static int	KMS_KEY_CACHE_NUM_REFILL_THREADS_DEFAULT
static String	KMS_KEY_CACHE_SIZE
static int	KMS_KEY_CACHE_SIZE_DEFAULT

Fields inherited from class org.apache.hadoop.crypto.key.KeyProviderCryptoExtension

EEK, EK

Fields inherited from class org.apache.hadoop.crypto.key.KeyProvider

DEFAULT_BITLENGTH, DEFAULT_BITLENGTH_NAME, DEFAULT_CIPHER, DEFAULT_CIPHER_NAME

Constructor Summary

Constructors

Constructor and Description
EagerKeyGeneratorKeyProviderCryptoExtension(Configuration conf, KeyProviderCryptoExtension keyProviderCryptoExtension) This class is a proxy for a KeyProviderCryptoExtension that decorates the underlying CryptoExtension with one that eagerly caches pre-generated Encrypted Keys using a ValueQueue

Method Summary

Modifier and Type	Method and Description
KeyProvider.KeyVersion	rollNewVersion(String name)
KeyProvider.KeyVersion	rollNewVersion(String name, byte[] material)

Methods inherited from class org.apache.hadoop.crypto.key.KeyProviderCryptoExtension

close, createKeyProviderCryptoExtension, decryptEncryptedKey, generateEncryptedKey, warmUpEncryptedKeys

Methods inherited from class org.apache.hadoop.crypto.key.KeyProviderExtension

createKey, createKey, deleteKey, flush, getCurrentKey, getExtension, getKeyProvider, getKeys, getKeysMetadata, getKeyVersion, getKeyVersions, getMetadata, isTransient, toString

Methods inherited from class org.apache.hadoop.crypto.key.KeyProvider

buildVersionName, findProvider, generateKey, getBaseName, getConf, options

Methods inherited from class java.lang.Object

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

Field Detail

KMS_KEY_CACHE_SIZE

public static final String KMS_KEY_CACHE_SIZE

See Also:

Constant Field Values

KMS_KEY_CACHE_SIZE_DEFAULT

public static final int KMS_KEY_CACHE_SIZE_DEFAULT

See Also:

Constant Field Values

KMS_KEY_CACHE_LOW_WATERMARK

public static final String KMS_KEY_CACHE_LOW_WATERMARK

See Also:

Constant Field Values

KMS_KEY_CACHE_LOW_WATERMARK_DEFAULT

public static final float KMS_KEY_CACHE_LOW_WATERMARK_DEFAULT

See Also:

Constant Field Values

KMS_KEY_CACHE_EXPIRY_MS

public static final String KMS_KEY_CACHE_EXPIRY_MS

See Also:

Constant Field Values

KMS_KEY_CACHE_EXPIRY_DEFAULT

public static final int KMS_KEY_CACHE_EXPIRY_DEFAULT

See Also:

Constant Field Values

KMS_KEY_CACHE_NUM_REFILL_THREADS

public static final String KMS_KEY_CACHE_NUM_REFILL_THREADS

See Also:

Constant Field Values

KMS_KEY_CACHE_NUM_REFILL_THREADS_DEFAULT

public static final int KMS_KEY_CACHE_NUM_REFILL_THREADS_DEFAULT

See Also:

Constant Field Values

Constructor Detail

EagerKeyGeneratorKeyProviderCryptoExtension

public EagerKeyGeneratorKeyProviderCryptoExtension(Configuration conf,
                                                   KeyProviderCryptoExtension keyProviderCryptoExtension)

This class is a proxy for a KeyProviderCryptoExtension that decorates the underlying CryptoExtension with one that eagerly caches pre-generated Encrypted Keys using a ValueQueue

Parameters:

conf - Configuration object to load parameters from

keyProviderCryptoExtension - KeyProviderCryptoExtension to delegate calls to.

Method Detail

rollNewVersion

public KeyProvider.KeyVersion rollNewVersion(String name)
                                      throws NoSuchAlgorithmException,
                                             IOException

Overrides:

rollNewVersion in class KeyProviderExtension<KeyProviderCryptoExtension.CryptoExtension>

Throws:

NoSuchAlgorithmException

IOException

rollNewVersion

public KeyProvider.KeyVersion rollNewVersion(String name,
                                             byte[] material)
                                      throws IOException

Overrides:

rollNewVersion in class KeyProviderExtension<KeyProviderCryptoExtension.CryptoExtension>

Throws:

IOException