Manage KMS using the CLI
Explore commands for managing Key Management System (KMS) integration with the WEKA system using the CLI.
Last updated
Explore commands for managing Key Management System (KMS) integration with the WEKA system using the CLI.
Last updated
Using the CLI, you can:
Command: weka security kms set
To integrate the Key Management Service (KMS) with the WEKA system, use the provided command line for adding or updating the KMS configuration. Ensure that the KMS is preconfigured, and both the key and a valid token are readily available.
Run the following command to establish a connection between the WEKA system and the configured Vault KMS.
weka security kms set <type> <address> <key-identifier> [--token token] [--namespace namespace] [--client-cert client-cert] [--client-key client-key] [--ca-cert ca-cert]
Parameters
Name | Value | Limitations |
---|---|---|
Example:
Setting the WEKA system with a Vault KMS:
weka security kms set vault https://vault-dns:8200 weka-key --token s.nRucA9Gtb3yNVmLUK221234
Setting the WEKA system with a KMIP complaint KMS (SmartKey example):
weka security kms set kmip amer.smartkey.io:5696 b2f81234-c0f6-4d63-b5b3-84a82e231234 --client-cert smartkey_cert.pem --client-key smartkey_key.pem
Command: weka security kms
Use this command to show the details of the configured KMS.
Command: weka security kms unset
Use this command to remove the KMS from the Weka system. It is only possible to remove a KMS configuration if no encrypted filesystems exist.
To force remove a KMS even if encrypted filesystems exist, use the --allow-downgrade
attribute. In such cases, the encrypted filesystem keys are re-encrypted with local encryption and may be compromised.
Command: weka security kms rewrap
If the KMS key is compromised or requires rotation, the KMS admin can rotate the key in the KMS. In such cases, this command is used to re-encrypt the encrypted filesystem keys with the new KMS master key.
weka security kms rewrap [--new-key-uid new-key-uid]
Parameters
WEKA does not automatically re-encrypt existing filesystem keys with the new KMS key for the existing snapshots already uploaded with the old encrypted keys.
In contrast to Vault KMS, the process of re-wrapping a KMIP-based KMS involves generating a new key within the KMS, rather than rotating the existing key. Therefore, it is essential to retain the old key within the KMS to ensure the ability to decrypt older Snap-to-Object snapshots.
The WEKA system uses encryption-as-a-service capabilities of the KMS to encrypt/decrypt the filesystem keys. This requires the configuration of Vault with the transit
secret engine.
Once the transit
secret engine is set up, a master key for use with the WEKA system must be created.
It is possible to either create a different key for each WEKA cluster or to share the key between different WEKA clusters.
Related information:
Vault transit secret-engine documentation
Create a weka_policy.hcl
file with the following content:
This limits the capabilities so there is no permission to destroy the key, using this policy. This protection is important when creating an API token.
Create the policy using the following command:
Authentication from the WEKA system to Vault relies on an API token. Since the WEKA system must always be able to communicate with the KMS, a periodic service token must be used.
Verify that thetoken
authentication method in Vault is enabled. This can be performed using the following command:
To enable the token authentication method use the following command:
Log into the KMS system using any of the identity methods Vault supports. The identity should have permission to use the previously set master key.
Create a token role for the identity using the following command:
The period
is the designated timeframe for a renewal request. If a renewal is not requested within this period, the token is revoked, necessitating the retrieval of a new token from the Vault and its configuration in the WEKA system.
Generate a token for the logged-in identity using the following command:
For more information on obtaining an API token, refer to Vault Tokens documentation.
The WEKA system does not automatically renew the API token lease. It can be renewed using the Vault CLI/API. It is also possible to define a higher maximum token value (max_lease_ttl)
by changing the Vault Configuration file.
Each KMS employs a unique process for obtaining a client certificate and key and configuring it through the KMS. The certificate is generated using OpenSSL and utilizes a UID obtained from the KMS.
Example:
Refer to the specific KMS documentation to create a certificate and associate it with the WEKA cluster within the KMS, ensuring it has the necessary privileges for encryption and decryption.
Name | Value |
---|---|
type
*
Type of the KMS.
Possible values: vault
or kmip
address
*
KMS server address.
URL
for vault
hostname:port
for kmip
key-identifier
*
Key to secure the filesystem keys.
Key name for vault
Key UID for kmip
token
API token to access Vault KMS.
Mandatory for vault
.
Prohibited for kmip
.
Must have:
read permissions to transit/keys/<master-key-name>
write permissions to transit/encrypt/<master-key-name>
and transit/decrypt/<masterkeyname>
permissions to /transit/rewrap
and auth/token/lookup
namespace
The vault's namespace name.
Namespace names must not end with "/", avoid spaces, and refrain from using reserved names like root
, sys
, audit
, auth
, cubbyhole
, and identity
.
(Available from v4.2.7.)
client-cert
Path to the client certificate PEM file.
Must permit encrypt
and decrypt
permissions.
Mandatory for kmip
.
Prohibited for vault
.
client-key
Path to the client key PEM file.
Mandatory for kmip
.
Prohibited for vault
.
ca-cert
Path to the CA certificate PEM file.
Optional for kmip
.
Prohibited for vault
.
new-key-uid
*
Unique identifier for the new key to be used to wrap filesystem keys.
Mandatory for kmip
only.
Do not specify any value for vault
.