Module io.helidon.integrations.vault.secrets.transit

Package io.helidon.integrations.vault.secrets.transit

Interface TransitSecretsRx

All Superinterfaces:

SecretsRx

public interface TransitSecretsRx
extends SecretsRx

API operations for Vault's Transit Secrets Engine.

Field Summary

Fields

Modifier and Type	Field	Description
static final Engine<TransitSecretsRx>	ENGINE	Transit Secrets engine.

Method Summary

Modifier and Type	Method	Description
Single<CreateKey.Response>	createKey(CreateKey.Request request)	Creates a new named encryption key of the specified type.
Single<Decrypt.Response>	decrypt(Decrypt.Request request)	Decrypts the provided ciphertext using the named key.
Single<DecryptBatch.Response>	decrypt(DecryptBatch.Request request)	Decrypts the provided batch of ciphertext strings using the named key.
Single<DeleteKey.Response>	deleteKey(DeleteKey.Request request)	Delete a named ecryption key.
Single<Encrypt.Response>	encrypt(Encrypt.Request request)	Encrypts the provided plaintext using the named key.
Single<EncryptBatch.Response>	encrypt(EncryptBatch.Request request)	Encrypts the provided batch of plaintext strings using the named key.
Single<Hmac.Response>	hmac(Hmac.Request request)	Hmac of a message.
Single<VaultOptionalResponse<ListSecrets.Response>>	list(ListSecrets.Request request)	List available keys.
Single<Sign.Response>	sign(Sign.Request request)	Sign a message.
Single<UpdateKeyConfig.Response>	updateKeyConfig(UpdateKeyConfig.Request request)	Tune configuration of a key.
Single<Verify.Response>	verify(Verify.Request request)	Verify a message signature.

Methods inherited from interface io.helidon.integrations.vault.SecretsRx

list, list

Field Details

ENGINE

static final Engine<TransitSecretsRx> ENGINE

Transit Secrets engine.

Documentation: https://www.vaultproject.io/docs/secrets/transit

Method Details

list

Single<VaultOptionalResponse<ListSecrets.Response>> list(ListSecrets.Request request)

List available keys.

Specified by:

list in interface SecretsRx

Parameters:

request - list request, path is ignored

Returns:

transit secret keys

createKey

Single<CreateKey.Response> createKey(CreateKey.Request request)

Creates a new named encryption key of the specified type.

Parameters:

request - create key request

Returns:

future with response

deleteKey

Single<DeleteKey.Response> deleteKey(DeleteKey.Request request)

Delete a named ecryption key. Deletion is not allowed by default, updateKeyConfig(io.helidon.integrations.vault.secrets.transit.UpdateKeyConfig.Request) must be called before deleting.

Parameters:

request - delete key request

Returns:

future with response

updateKeyConfig

Single<UpdateKeyConfig.Response> updateKeyConfig(UpdateKeyConfig.Request request)

Tune configuration of a key.

Parameters:

request - update configuration request

Returns:

future with response

See Also:

• UpdateKeyConfig.Request.allowDeletion(boolean)

encrypt

Single<Encrypt.Response> encrypt(Encrypt.Request request)

Encrypts the provided plaintext using the named key. This path supports the create and update policy capabilities as follows: if the user has the create capability for this endpoint in their policies, and the key does not exist, it will be upserted with default values (whether the key requires derivation depends on whether the context parameter is empty or not). If the user only has update capability and the key does not exist, an error will be returned.

Parameters:

request - encrypt request

Returns:

future with response

encrypt

Single<EncryptBatch.Response> encrypt(EncryptBatch.Request request)

Encrypts the provided batch of plaintext strings using the named key. This path supports the create and update policy capabilities as follows: if the user has the create capability for this endpoint in their policies, and the key does not exist, it will be upserted with default values (whether the key requires derivation depends on whether the context parameter is empty or not). If the user only has update capability and the key does not exist, an error will be returned.

Parameters:

request - encrypt request

Returns:

future with response

decrypt

Single<Decrypt.Response> decrypt(Decrypt.Request request)

Decrypts the provided ciphertext using the named key.

Parameters:

request - decrypt request

Returns:

future with response

decrypt

Single<DecryptBatch.Response> decrypt(DecryptBatch.Request request)

Decrypts the provided batch of ciphertext strings using the named key.

Parameters:

request - decrypt request

Returns:

future with response

hmac

Single<Hmac.Response> hmac(Hmac.Request request)

Hmac of a message. Equivalent of a signature when using symmetric keys.

Parameters:

request - hmac request

Returns:

hmac response

sign

Single<Sign.Response> sign(Sign.Request request)

Sign a message.

Parameters:

request - signature request

Returns:

signature response

verify

Single<Verify.Response> verify(Verify.Request request)

Verify a message signature.

Parameters:

request - verification request

Returns:

verification response