Package dev.getelements.elements.sdk.service.blockchain.crypto

Interface VaultCryptoUtilities

All Known Implementing Classes:

AesVaultCryptoUtilities

public interface VaultCryptoUtilities

Encrypts and decrypts Vaults.

Method Summary

Modifier and Type	Method	Description
Optional<VaultKey>	decryptKey(VaultKey key, String passphrase)	Returns the VaultKey unencrypted.
VaultKey	encryptKey(VaultKey vaultKey, String passphrase)	Encrypts the supplied VaultKey with the supplied passphrase.
VaultKey	generateKey(PrivateKeyCrytpoAlgorithm algorithm)	Generates a VaultKey, unencrypted.
default VaultKey	generateKey(PrivateKeyCrytpoAlgorithm algorithm, String passphrase)	Generates a VaultKey secured with the supplied passphrase.
default Optional<VaultKey>	reEncryptKey(VaultKey key, String passphrase, String newPassphrase)	Re-encrypts the VaultKey with the supplied passphrase.

Method Details

generateKey

VaultKey generateKey(PrivateKeyCrytpoAlgorithm algorithm)

Generates a VaultKey, unencrypted.

Returns:

the VaultKey

generateKey

default VaultKey generateKey(PrivateKeyCrytpoAlgorithm algorithm,
 String passphrase)

Generates a VaultKey secured with the supplied passphrase.

Parameters:

passphrase - the passphrase

Returns:

the VaultKey, encrypted

encryptKey

VaultKey encryptKey(VaultKey vaultKey,
 String passphrase)

Encrypts the supplied VaultKey with the supplied passphrase.

Parameters:

vaultKey - the VaultKey, must not be encrypted

passphrase - the passphrase.

Returns:

the encrypted key

reEncryptKey

default Optional<VaultKey> reEncryptKey(VaultKey key,
 String passphrase,
 String newPassphrase)

Re-encrypts the VaultKey with the supplied passphrase.

Parameters:

key - the key

passphrase - the existing passphrase

newPassphrase - the new passphrase

Returns:

an Optional<VaultKey>, if re-encryption was successful

decryptKey

Optional<VaultKey> decryptKey(VaultKey key,
 String passphrase)

Returns the VaultKey unencrypted.

Parameters:

key - the vault key

passphrase - the passphrase

Returns:

an Optional<VaultKey>, or null.