Package it.pagopa.swclient.mil.azureservices.keyvault.keys.service

Interface AzureKeyVaultKeysReactiveService

All Known Implementing Classes:

AzureKeyVaultKeysReactiveServiceDev, AzureKeyVaultKeysReactiveServiceImpl

public interface AzureKeyVaultKeysReactiveService

This is the interface of a wrapper of AzureKeyVaultKeysReactiveClient.

When the used profile is dev, AzureKeyVaultKeysReactiveServiceDev is used as implementation and the Azure Key Vault APIs are emulated.

When the used profile is not dev, AzureKeyVaultKeysReactiveServiceImpl is used as implementation, the real Azure Key Vault is used and some advanced features are offered.

Author:

Antonio Tarricone

Method Summary

Modifier and Type	Method	Description
io.smallrye.mutiny.Uni<KeyBundle>	createKey(String keyName, KeyCreateParameters keyCreateParameters)	Creates a new key, stores it, then returns key parameters and attributes to the client.
io.smallrye.mutiny.Uni<KeyOperationResult>	decrypt(String keyName, String keyVersion, KeyOperationParameters keyOperationParameters)	Decrypts a single block of encrypted data.
io.smallrye.mutiny.Uni<DeletedKeyBundle>	deleteKey(String keyName)	Deletes a key of any type from storage in Azure Key Vault.
io.smallrye.mutiny.Uni<KeyOperationResult>	encrypt(String keyName, String keyVersion, KeyOperationParameters keyOperationParameters)	Encrypts an arbitrary sequence of bytes using an encryption key that is stored in a key vault.
io.smallrye.mutiny.Uni<KeyBundle>	getKey(String keyName, String keyVersion)	Returns the public part of a stored key.
io.smallrye.mutiny.Uni<KeyListResult>	getKeys()	Lists keys in the specified vault.
io.smallrye.mutiny.Uni<KeyListResult>	getKeys(String skiptoken)	Lists keys in the specified vault.
io.smallrye.mutiny.Uni<KeyListResult>	getKeyVersions(String keyName)	Returns a list of individual key versions with the same key name.
io.smallrye.mutiny.Uni<KeyListResult>	getKeyVersions(String keyName, String skiptoken)	Returns a list of individual key versions with the same key name.
io.smallrye.mutiny.Uni<KeyOperationResult>	sign(String keyName, String keyVersion, KeySignParameters keySignParameters)	Creates a signature from a digest using the specified key.
io.smallrye.mutiny.Uni<KeyVerifyResult>	verify(String keyName, String keyVersion, KeyVerifyParameters keyVerifyParameters)	Verifies a signature using a specified key.

Method Details

createKey

io.smallrye.mutiny.Uni<KeyBundle> createKey(String keyName,
 KeyCreateParameters keyCreateParameters)

Creates a new key, stores it, then returns key parameters and attributes to the client.

Parameters:

keyName - The name for the new key. Regex pattern: ^[0-9a-zA-Z-]+$

keyCreateParameters - KeyCreateParameters

Returns:

KeyBundle

getKeys

io.smallrye.mutiny.Uni<KeyListResult> getKeys()

Lists keys in the specified vault.

Returns:

KeyListResult

getKeys

io.smallrye.mutiny.Uni<KeyListResult> getKeys(String skiptoken)

Lists keys in the specified vault.

Parameters:

skiptoken - Token to handle paging.

Returns:

KeyListResult

getKey

io.smallrye.mutiny.Uni<KeyBundle> getKey(String keyName,
 String keyVersion)

Returns the public part of a stored key.

Parameters:

keyName - The name of the key to get.

keyVersion - The version of the key.

Returns:

KeyBundle

getKeyVersions

io.smallrye.mutiny.Uni<KeyListResult> getKeyVersions(String keyName)

Returns a list of individual key versions with the same key name.

Parameters:

keyName - The name of the key.

Returns:

KeyListResult

getKeyVersions

io.smallrye.mutiny.Uni<KeyListResult> getKeyVersions(String keyName,
 String skiptoken)

Returns a list of individual key versions with the same key name.

Parameters:

keyName - The name of the key.

skiptoken - Token to handle paging.

Returns:

KeyListResult

sign

io.smallrye.mutiny.Uni<KeyOperationResult> sign(String keyName,
 String keyVersion,
 KeySignParameters keySignParameters)

Creates a signature from a digest using the specified key.

Parameters:

keyName - The name of the key.

keyVersion - The version of the key.

keySignParameters - KeySignParameters

Returns:

KeyOperationResult

verify

io.smallrye.mutiny.Uni<KeyVerifyResult> verify(String keyName,
 String keyVersion,
 KeyVerifyParameters keyVerifyParameters)

Verifies a signature using a specified key.

Parameters:

keyName - The name of the key.

keyVersion - The version of the key.

keyVerifyParameters - KeyVerifyParameters

Returns:

KeyVerifyResult

encrypt

io.smallrye.mutiny.Uni<KeyOperationResult> encrypt(String keyName,
 String keyVersion,
 KeyOperationParameters keyOperationParameters)

Encrypts an arbitrary sequence of bytes using an encryption key that is stored in a key vault.

Parameters:

keyName - The name of the key.

keyVersion - The version of the key.

keyOperationParameters - KeyOperationParameters

Returns:

KeyOperationResult

decrypt

io.smallrye.mutiny.Uni<KeyOperationResult> decrypt(String keyName,
 String keyVersion,
 KeyOperationParameters keyOperationParameters)

Decrypts a single block of encrypted data.

Parameters:

keyName - The name of the key.

keyVersion - The version of the key.

keyOperationParameters - KeyOperationParameters

Returns:

KeyOperationResult

deleteKey

io.smallrye.mutiny.Uni<DeletedKeyBundle> deleteKey(String keyName)

Deletes a key of any type from storage in Azure Key Vault.

Parameters:

keyName - The name of the key to delete.

Returns:

DeletedKeyBundle