Skip to content
HotKVDocs

Ask the HotKV docs

Answers come only from these docs and can be wrong; check the linked pages before you rely on them.

ENCRYPTION.INFO

Last updated 
ENCRYPTION.INFO
Group
Encryption
Complexity
O(1)
Arity
1 (exactly, counting the command name)
Flags
admin, fast
HotKV Cloud
Scale
On-Premise
requires the encryption-at-rest license feature

ENCRYPTION.INFO tells you whether HotKV encrypts its snapshots on this node. With encryption at rest on, snapshots are encrypted with AES-256-GCM as they are written and decrypted as they are read, using the key from the file set by key_path under [encryption] (encryption.key-file in hotkv.conf). See Security: Encryption at rest for the setup.

Return value

Section titled “Return value”

A flat array of field and value pairs, in RESP2 and RESP3:

Field Type Meaning
enabled Integer 1 when encryption at rest is on, 0 when it is off
algorithm Bulk string Always AES-256-GCM
provider Bulk string local (a key file on this host), or none when no key is loaded

Without a license that includes encryption-at-rest, the reply is NOLICENSE encryption-at-rest requires a HotKV license. Contact sales@hotkv.com.

Examples

Section titled “Examples”
127.0.0.1:6379> ENCRYPTION.INFO
1) "enabled"
2) (integer) 1
3) "algorithm"
4) "AES-256-GCM"
5) "provider"
6) "local"

Compatibility

Section titled “Compatibility”

HotKV-only command.

See also

Section titled “See also”

ENCRYPTION.ROTATE, ENCRYPTION.VERIFY, Security