Package io.quarkus.vault

Interface VaultSystemBackendEngine

All Known Implementing Classes:

VaultSystemBackendManager

public interface VaultSystemBackendEngine

This service provides access to the system backend.

See Also:

VaultBootstrapConfig

Method Summary

Modifier and Type	Method	Description
void	createUpdatePolicy(String name, String rules)	Create or update a policy.
void	deletePolicy(String name)	Delete a policy by its name.
void	disable(String mount)	Disables the engine at a specific mount.
void	enable(VaultSecretEngine engine, String mount, String description, EnableEngineOptions options)	Enables a secret engine at a specific mount.
void	enable(String engineType, String mount, String description, EnableEngineOptions options)	Enables a secret engine at a specific mount.
List<String>	getPolicies()	List existing policies.
String	getPolicyRules(String name)	Get the rules for the named policy.
VaultTuneInfo	getTuneInfo(String mount)	Get the tune info for a secret engine at a specific mount.
VaultHealth	health()	Check the health status of Vault.
VaultHealthStatus	healthStatus()	Check and return the health status of Vault.
VaultInit	init(int secretShares, int secretThreshold)	Initializes a new Vault.
boolean	isEngineMounted(String mount)	Check if an engine is mounted at a specific mount.
VaultSealStatus	sealStatus()	Check the seal status of a Vault.
void	updateTuneInfo(String mount, VaultTuneInfo tuneInfo)	Update the tune info for a secret engine at a specific mount.

Method Detail

init

VaultInit init(int secretShares,
               int secretThreshold)

Initializes a new Vault.

Parameters:

secretShares - specifies the number of shares to split the master key into.

secretThreshold - specifies the number of shares required to reconstruct the master key.

Returns:

Vault Init.

health

VaultHealth health()

Check the health status of Vault. Returns Vault health status code only by using HTTP HEAD requests. It is faster than calling healthStatus() method which uses HTTP GET to return a complete VaultHealthStatus state.

Returns:

Vault Health Status.

healthStatus

VaultHealthStatus healthStatus()

Check and return the health status of Vault. Returns a complete VaultHealthStatus state. This method uses HTTP GET to return a complete state.

Returns:

Complete Vault Health Status.

sealStatus

VaultSealStatus sealStatus()

Check the seal status of a Vault.

Returns:

Vault Seal Status.

getPolicyRules

String getPolicyRules(String name)

Get the rules for the named policy.

Parameters:

name - of the policy

Returns:

rules of named policy

createUpdatePolicy

void createUpdatePolicy(String name,
                        String rules)

Create or update a policy.

Parameters:

name - policy name

rules - policy content

deletePolicy

void deletePolicy(String name)

Delete a policy by its name.

Parameters:

name - policy name

getPolicies

List<String> getPolicies()

List existing policies.

Returns:

a list of all policy names

getTuneInfo

VaultTuneInfo getTuneInfo(String mount)

Get the tune info for a secret engine at a specific mount.

Parameters:

mount - Name of the mount

Returns:

current tune info

updateTuneInfo

void updateTuneInfo(String mount,
                    VaultTuneInfo tuneInfo)

Update the tune info for a secret engine at a specific mount.

Parameters:

mount - Name of the mount

tuneInfo - Tune info with fields to update

isEngineMounted

boolean isEngineMounted(String mount)

Check if an engine is mounted at a specific mount.

Parameters:

mount - Name of the mount

Returns:

True if an engine is mounted, false otherwise

enable

void enable(VaultSecretEngine engine,
            String mount,
            String description,
            EnableEngineOptions options)

Enables a secret engine at a specific mount.

Parameters:

engine - Type of engine to mount.

mount - Engine mount path.

description - Human friendly description of mount point.

options - Engine options.

enable

void enable(String engineType,
            String mount,
            String description,
            EnableEngineOptions options)

Enables a secret engine at a specific mount.

Parameters:

engineType - Type of engine to mount.

mount - Engine mount path.

description - Human friendly description of mount point.

options - Engine options.

disable

void disable(String mount)

Disables the engine at a specific mount.

Parameters:

mount - Engine mount path.