Provides implementation for the Vault Key Rotation APIs
Extends
- Vaulted
Methods
-
<inner> getKeyStatus()
-
Gets the status of the current key
Parameters:
Name Type Argument Description options.token
string <optional>
the authentication token
Returns:
- Type
- Promise
-
<inner> getRekeyStatus()
-
Gets the status of the rekey process.
Parameters:
Name Type Argument Description options.token
string <optional>
the authentication token
Returns:
- Type
- Promise
-
<inner> rotateKey()
-
Initiate the rotation of the encryption key for data stored in the vault
Parameters:
Name Type Argument Description options.token
string <optional>
the authentication token
Returns:
- Type
- Promise
-
<inner> startRekey()
-
Start the rekey process.
Parameters:
Name Type Argument Default Description options.secret_shares
number <optional>
config['secret_shares'] number of shares to split the master key into
options.secret_threshold
number <optional>
config['secret_threshold'] number of shares required to reconstruct the master key
options.token
string <optional>
the authentication token
Returns:
- Type
- Promise
-
<inner> stopRekey()
-
Stops/Cancels the current rekey process.
Parameters:
Name Type Argument Description options.token
string <optional>
the authentication token
Returns:
- Type
- Promise
-
<inner> updateRekey()
-
Sends the next key share to continue the rekey process.
Parameters:
Name Type Argument Description options.token
string <optional>
the authentication token
options.body.key
Object A single master share key
options.body.nonce
string The nonce from the current re-key operation
Returns:
- Type
- Promise