Package io.quarkus.vault.runtime

Class VaultTOTPManager

java.lang.Object

io.quarkus.vault.runtime.VaultTOTPManager

All Implemented Interfaces:

VaultTOTPSecretReactiveEngine

@ApplicationScoped
public class VaultTOTPManager
extends Object
implements VaultTOTPSecretReactiveEngine

Constructor Summary

Constructors

Constructor	Description
VaultTOTPManager()

Method Summary

Modifier and Type	Method	Description
io.smallrye.mutiny.Uni<Optional<KeyDefinition>>	createKey(String name, CreateKeyParameters createKeyParameters)	Creates or updates a key definition.
io.smallrye.mutiny.Uni<Void>	deleteKey(String name)	Deletes the key definition.
io.smallrye.mutiny.Uni<String>	generateCode(String name)	Generates a new time-based one-time use password based on the named key.
io.smallrye.mutiny.Uni<List<String>>	listKeys()	Returns a list of available keys.
io.smallrye.mutiny.Uni<KeyConfiguration>	readKey(String name)	Queries the key definition.
io.smallrye.mutiny.Uni<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 io.smallrye.mutiny.Uni<Optional<KeyDefinition>> createKey(String name,
                                                                 CreateKeyParameters createKeyParameters)

Description copied from interface: VaultTOTPSecretReactiveEngine

Creates or updates a key definition.

Specified by:

createKey in interface VaultTOTPSecretReactiveEngine

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 io.smallrye.mutiny.Uni<KeyConfiguration> readKey(String name)

Description copied from interface: VaultTOTPSecretReactiveEngine

Queries the key definition.

Specified by:

readKey in interface VaultTOTPSecretReactiveEngine

Parameters:

name - of the key.

Returns:

The key configuration.

listKeys

public io.smallrye.mutiny.Uni<List<String>> listKeys()

Description copied from interface: VaultTOTPSecretReactiveEngine

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

Specified by:

listKeys in interface VaultTOTPSecretReactiveEngine

Returns:

List of available keys.

deleteKey

public io.smallrye.mutiny.Uni<Void> deleteKey(String name)

Description copied from interface: VaultTOTPSecretReactiveEngine

Deletes the key definition.

Specified by:

deleteKey in interface VaultTOTPSecretReactiveEngine

Parameters:

name - of the key.

generateCode

public io.smallrye.mutiny.Uni<String> generateCode(String name)

Description copied from interface: VaultTOTPSecretReactiveEngine

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

Specified by:

generateCode in interface VaultTOTPSecretReactiveEngine

Parameters:

name - of the key.

Returns:

The Code.

validateCode

public io.smallrye.mutiny.Uni<Boolean> validateCode(String name,
                                                    String code)

Description copied from interface: VaultTOTPSecretReactiveEngine

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

Specified by:

validateCode in interface VaultTOTPSecretReactiveEngine

Parameters:

name - of the key.

code - to validate.

Returns:

True if valid, false otherwise.