Skip to content

Document the ACL DIGEST command #469

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
melancholictheory wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Document the ACL DIGEST command #469

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions commands/acl-digest.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
Return a fingerprint of the ACL rules currently in effect, as a hexadecimal string.
The digest depends only on the rules in effect and not on the order the users were
created in, so two servers configured alike report the same digest.

The digest covers everything [`ACL LIST`](acl-list.md) reports: the user names, their
flags, their password hashes, and their command, key and channel rules.
Any change to any user changes the digest.
The reply is the same size however many users are configured.

This is meant for confirming which revision of an ACL a server is running.
A client that manages users through an ACL file can read the digest before and after an
[`ACL LOAD`](acl-load.md) to tell whether the file it wrote is the one now in effect.
Comparing the rules themselves is impractical, because the server reports them in its
own normalized form rather than the form they were written in, so a client would need its
own copy of the rule parser to compare them.

## Examples

```
127.0.0.1:6379> ACL DIGEST
"24ece0a4daea0bcb936b438ae6c9f36db76f57dfc70e00def7b2c26041c49822"
127.0.0.1:6379> ACL SETUSER alice on >alice ~key:* +get
OK
127.0.0.1:6379> ACL DIGEST
"d06ec40dd1a8e30a4babea1011d4b0daf02dbdf5de95ea18768e15f346a7d385"
127.0.0.1:6379> ACL DELUSER alice
(integer) 1
127.0.0.1:6379> ACL DIGEST
"24ece0a4daea0bcb936b438ae6c9f36db76f57dfc70e00def7b2c26041c49822"
```
3 changes: 3 additions & 0 deletions resp2_replies.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@
"ACL DELUSER": [
"[Integer reply](../topics/protocol.md#integers): the number of users that were deleted. This number will not always match the number of arguments since certain users may not exist."
],
"ACL DIGEST": [
"[Bulk string reply](../topics/protocol.md#bulk-strings): the digest of the ACL rules currently in effect, as a hexadecimal string."
],
"ACL DRYRUN": [
"Any of the following:",
"* [Simple string reply](../topics/protocol.md#simple-strings): `OK` on success.",
Expand Down
3 changes: 3 additions & 0 deletions resp3_replies.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@
"ACL DELUSER": [
"[Integer reply](../topics/protocol.md#integers): the number of users that were deleted. This number will not always match the number of arguments since certain users may not exist."
],
"ACL DIGEST": [
"[Bulk string reply](../topics/protocol.md#bulk-strings): the digest of the ACL rules currently in effect, as a hexadecimal string."
],
"ACL DRYRUN": [
"Any of the following:",
"* [Simple string reply](../topics/protocol.md#simple-strings): `OK` on success.",
Expand Down
Loading