Package io.quarkus.vault.runtime

Class VaultTOTPManager

java.lang.Object

io.quarkus.vault.runtime.VaultTOTPManager

All Implemented Interfaces:

VaultTOTPSecretEngine

@ApplicationScoped
public class VaultTOTPManager
extends Object
implements VaultTOTPSecretEngine

Constructor Summary

Constructors

Constructor	Description
VaultTOTPManager()

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

VaultTOTPManager

public VaultTOTPManager()

Method Detail

createKey

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

Description copied from interface: VaultTOTPSecretEngine

Creates or updates a key definition.

Specified by:

createKey in interface VaultTOTPSecretEngine

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)

Description copied from interface: VaultTOTPSecretEngine

Queries the key definition.

Specified by:

readKey in interface VaultTOTPSecretEngine

Parameters:

name - of the key.

Returns:

The key configuration.

listKeys

public List<String> listKeys()

Description copied from interface: VaultTOTPSecretEngine

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

Specified by:

listKeys in interface VaultTOTPSecretEngine

Returns:

List of available keys.

deleteKey

public void deleteKey(String name)

Description copied from interface: VaultTOTPSecretEngine

Deletes the key definition.

Specified by:

deleteKey in interface VaultTOTPSecretEngine

Parameters:

name - of the key.

generateCode

public String generateCode(String name)

Description copied from interface: VaultTOTPSecretEngine

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

Specified by:

generateCode in interface VaultTOTPSecretEngine

Parameters:

name - of the key.

Returns:

The Code.

validateCode

public boolean validateCode(String name,
                            String code)

Description copied from interface: VaultTOTPSecretEngine

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

Specified by:

validateCode in interface VaultTOTPSecretEngine

Parameters:

name - of the key.

code - to validate.

Returns:

True if valid, false otherwise.