Package com.oracle.bmc.encryption

Class KmsMasterKey

java.lang.Object

com.oracle.bmc.encryption.KmsMasterKey

All Implemented Interfaces:

MasterKey

public class KmsMasterKey
extends Object
implements MasterKey

Represents a MasterKey contained in the OCI Key Management Service.

Constructor Summary

Constructors

Constructor	Description
KmsMasterKey(BasicAuthenticationDetailsProvider authenticationDetailsProvider, String region, String vaultId, String kmsMasterKeyId)	Initialize KmsMasterKey for encryption.

Method Summary

Modifier and Type	Method	Description
void	close()	Close the OCI clients.
String	decryptDataKey(String encryptedDataKey, String kmsMasterKeyId)	Decrypt Data key.
DataKey	generateDataEncryptionKey(CryptoAlgorithm cryptoAlgorithm)	Generate Data encryption key.
String	getKmsMasterKeyId()
BasicAuthenticationDetailsProvider	getProvider()
String	getRegion()
String	getVaultId()

Methods inherited from class java.lang.Object

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

Constructor Detail

KmsMasterKey

public KmsMasterKey(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                    String region,
                    String vaultId,
                    String kmsMasterKeyId)

Initialize KmsMasterKey for encryption.

It creates the clients needed to get Keys from OCI KMS service.

Parameters:

authenticationDetailsProvider - Authentication Provider for OCI.

region - OCI Region

vaultId - The OCID of the vault.

kmsMasterKeyId - The OCID of the KMS master key.

Method Detail

generateDataEncryptionKey

public DataKey generateDataEncryptionKey(CryptoAlgorithm cryptoAlgorithm)

Generate Data encryption key.

Specified by:

generateDataEncryptionKey in interface MasterKey

Parameters:

cryptoAlgorithm - Crypto Algorithm.

Returns:

Data Key

decryptDataKey

public String decryptDataKey(String encryptedDataKey,
                             String kmsMasterKeyId)

Decrypt Data key.

Specified by:

decryptDataKey in interface MasterKey

Parameters:

encryptedDataKey - encryptedDataKey.

kmsMasterKeyId - masterKeyId.

Returns:

Decrypted Data Key

close

public void close()

Close the OCI clients.

getProvider

public BasicAuthenticationDetailsProvider getProvider()

getVaultId

public String getVaultId()

getKmsMasterKeyId

public String getKmsMasterKeyId()

getRegion

public String getRegion()