com.pega.pegarules.pub.util

Interface KMSCryptoUtils

public interface KMSCryptoUtils

Method Summary

Modifier and Type	Method and Description
void	clearCache(PublicAPI aTools, java.lang.String aCacheName) Use this API to clear KMS caches ("CDKCache","KeyStoreMetaDataCache","AWSKMSCache")
java.lang.String	getEncryptionType()
java.util.List<java.lang.String>	getPossibleCipherTexts(java.lang.String plainText) Get all possible cipher texts which are encrytped by using different customer data keys (CDKs) for a given input text.
ClipboardPage	populateDataEncryptionMetadata(PublicAPI aTools, ClipboardPage dataEncryptionPage) Get keystore active meta data
void	rotateDataKey(PublicAPI aTools) Force customer data key (CDK) rotation
void	saveDataEncryptionMetadata(PublicAPI aTools, ClipboardPage dataEncryptionPage) Save keystore active meta data which is provided in Keystore landing page
void	validateDataEncryptionMetadata(PublicAPI aTools) Agent uses this API to validate KMS encryption keys
void	validateDataEncryptionMetadata(PublicAPI aTools, ClipboardPage dataEncryptionPage) Validate keystore active meta data which is provided in Keystore landing page
boolean	validateKeystoreKMS(PublicAPI aTools, ClipboardPage myStepPage)

Method Detail

validateDataEncryptionMetadata

void validateDataEncryptionMetadata(PublicAPI aTools,
                                    ClipboardPage dataEncryptionPage)

Validate keystore active meta data which is provided in Keystore landing page

Parameters:

aTools -

dataEncryptionPage -

saveDataEncryptionMetadata

void saveDataEncryptionMetadata(PublicAPI aTools,
                                ClipboardPage dataEncryptionPage)

Save keystore active meta data which is provided in Keystore landing page

Parameters:

aTools -

dataEncryptionPage -

validateDataEncryptionMetadata

void validateDataEncryptionMetadata(PublicAPI aTools)

Agent uses this API to validate KMS encryption keys

Parameters:

aTools -

rotateDataKey

void rotateDataKey(PublicAPI aTools)

Force customer data key (CDK) rotation

Parameters:

aTools -

populateDataEncryptionMetadata

ClipboardPage populateDataEncryptionMetadata(PublicAPI aTools,
                                             ClipboardPage dataEncryptionPage)

Get keystore active meta data

Parameters:

aTools -

dataEncryptionPage -

Returns:

keystore active meta data

getEncryptionType

java.lang.String getEncryptionType()

Returns:

active encryption type (AWS, SITE_SPECIFIC or null).

validateKeystoreKMS

boolean validateKeystoreKMS(PublicAPI aTools,
                            ClipboardPage myStepPage)

Parameters:

aTools -

myStepPage -

Returns:

true if input keystore page is valid, otherwise return false

clearCache

void clearCache(PublicAPI aTools,
                java.lang.String aCacheName)

Use this API to clear KMS caches ("CDKCache","KeyStoreMetaDataCache","AWSKMSCache")

Parameters:

aTools -

aCacheName -

getPossibleCipherTexts

java.util.List<java.lang.String> getPossibleCipherTexts(java.lang.String plainText)

Get all possible cipher texts which are encrytped by using different customer data keys (CDKs) for a given input text.

Parameters:

plainText -

Returns:

possible