Package io.quarkus.vault

Class VaultTOTPSecretEngine

java.lang.Object

io.quarkus.vault.VaultTOTPSecretEngine

@ApplicationScoped
public class VaultTOTPSecretEngine
extends Object

This service provides access to the TOTP secret engine.

See Also:

TOTP Secrets Engine

Constructor Summary

Constructors

Constructor	Description
VaultTOTPSecretEngine(VaultTOTPSecretReactiveEngine engine)

Method Summary

Modifier and Type	Method	Description
Optional<KeyDefinition>	createKey(String name, CreateKeyParameters createKeyParameters)	Creates or updates a key definition.
void	deleteKey(String name)	Deletes the key definition.
String	generateCode(String name)	Generates a new time-based one-time use password based on the named key.
List<String>	listKeys()	Returns a list of available keys.
KeyConfiguration	readKey(String name)	Queries the key definition.
boolean	validateCode(String name, String code)	Validates a time-based one-time use password generated from the named key.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

VaultTOTPSecretEngine

@Inject
public VaultTOTPSecretEngine(VaultTOTPSecretReactiveEngine engine)

Method Detail

createKey

public Optional<KeyDefinition> createKey(String name,
                                         CreateKeyParameters createKeyParameters)

Creates or updates a key definition.

Parameters:

name - of the key.

createKeyParameters - required to create or update a key.

Returns:

Barcode and/or URL of the created OTP key.

readKey

public KeyConfiguration readKey(String name)

Queries the key definition.

Parameters:

name - of the key.

Returns:

The key configuration.

listKeys

public List<String> listKeys()

Returns a list of available keys. Only the key names are returned, not any values.

Returns:

List of available keys.

deleteKey

public void deleteKey(String name)

Deletes the key definition.

Parameters:

name - of the key.

generateCode

public String generateCode(String name)

Generates a new time-based one-time use password based on the named key.

Parameters:

name - of the key.

Returns:

The Code.

validateCode

public boolean validateCode(String name,
                            String code)

Validates a time-based one-time use password generated from the named key.

Parameters:

name - of the key.

code - to validate.

Returns:

True if valid, false otherwise.