com.github.ambry.router

Class SingleKeyManagementService

java.lang.Object

com.github.ambry.router.SingleKeyManagementService

All Implemented Interfaces:

com.github.ambry.router.KeyManagementService<javax.crypto.spec.SecretKeySpec>, java.io.Closeable, java.lang.AutoCloseable

public class SingleKeyManagementService
extends java.lang.Object
implements com.github.ambry.router.KeyManagementService<javax.crypto.spec.SecretKeySpec>

Single KeyManagementService which returns a default key SecretKeySpec for any getKey(short, short) calls, but a different random key for any getRandomKey() calls.

Constructor Summary

Constructors

Constructor and Description
SingleKeyManagementService(com.github.ambry.config.KMSConfig config, java.lang.String defaultContainerKey) Instantiates SingleKeyManagementService with KMSConfig and a default container key which is hex string.

Method Summary

Modifier and Type	Method and Description
void	close()
javax.crypto.spec.SecretKeySpec	getKey(short accountId, short containerId) Fetches the key associated with the pair of AccountId and ContainerId.
javax.crypto.spec.SecretKeySpec	getKey(java.lang.String context)
javax.crypto.spec.SecretKeySpec	getRandomKey()
void	register(short accountId, short containerId) Registers with KMS to create key for a unique pair of AccountId and ContainerId
void	register(java.lang.String context)

Methods inherited from class java.lang.Object

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

Constructor Detail

SingleKeyManagementService

public SingleKeyManagementService(com.github.ambry.config.KMSConfig config,
                                  java.lang.String defaultContainerKey)
                           throws java.security.GeneralSecurityException

Instantiates SingleKeyManagementService with KMSConfig and a default container key which is hex string.

Parameters:

config - KMSConfig to fetch configs from

defaultContainerKey - the default container key that will be returned for all getKey(short, short) calls

Throws:

java.security.GeneralSecurityException

Method Detail

register

public void register(short accountId,
                     short containerId)

Registers with KMS to create key for a unique pair of AccountId and ContainerId

Specified by:

register in interface com.github.ambry.router.KeyManagementService<javax.crypto.spec.SecretKeySpec>

Parameters:

accountId - refers to the id of the Account to register

containerId - refers to the id of the Container to register

register

public void register(java.lang.String context)
              throws java.security.GeneralSecurityException

Specified by:

register in interface com.github.ambry.router.KeyManagementService<javax.crypto.spec.SecretKeySpec>

Throws:

java.security.GeneralSecurityException

getKey

public javax.crypto.spec.SecretKeySpec getKey(short accountId,
                                              short containerId)
                                       throws java.security.GeneralSecurityException

Fetches the key associated with the pair of AccountId and ContainerId. SingleKeyManagementService returns the default key for all getKey(short, short)}

Specified by:

getKey in interface com.github.ambry.router.KeyManagementService<javax.crypto.spec.SecretKeySpec>

Parameters:

accountId - refers to the id of the Account for which key is expected

containerId - refers to the id of the Container for which key is expected

Returns:

SecretKeySpec the key associated with the accountId and containerId

Throws:

java.security.GeneralSecurityException

getKey

public javax.crypto.spec.SecretKeySpec getKey(java.lang.String context)
                                       throws java.security.GeneralSecurityException

Specified by:

getKey in interface com.github.ambry.router.KeyManagementService<javax.crypto.spec.SecretKeySpec>

Throws:

java.security.GeneralSecurityException

getRandomKey

public javax.crypto.spec.SecretKeySpec getRandomKey()
                                             throws java.security.GeneralSecurityException

Specified by:

getRandomKey in interface com.github.ambry.router.KeyManagementService<javax.crypto.spec.SecretKeySpec>

Throws:

java.security.GeneralSecurityException

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException