mirror of
https://codeberg.org/redict/redict.git
synced 2025-01-22 16:18:28 -05:00
3193f086ca
Motivation: for applications that use RM ACL verification functions, they would
want to return errors back to the user, in ways that are consistent with Redis.
While investigating how we should return ACL errors to the user, we realized that
Redis isn't consistent, and currently returns ACL error strings in 3 primary ways.
[For the actual implications of this change, see the "Impact" section at the bottom]
1. how it returns an error when calling a command normally
ACL_DENIED_CMD -> "this user has no permissions to run the '%s' command"
ACL_DENIED_KEY -> "this user has no permissions to access one of the keys used as arguments"
ACL_DENIED_CHANNEL -> "this user has no permissions to access one of the channels used as arguments"
2. how it returns an error when calling via 'acl dryrun' command
ACL_DENIED_CMD -> "This user has no permissions to run the '%s' command"
ACL_DENIED_KEY -> "This user has no permissions to access the '%s' key"
ACL_DENIED_CHANNEL -> "This user has no permissions to access the '%s' channel"
3. how it returns an error via RM_Call (and scripting is similar).
ACL_DENIED_CMD -> "can't run this command or subcommand";
ACL_DENIED_KEY -> "can't access at least one of the keys mentioned in the command arguments";
ACL_DENIED_CHANNEL -> "can't publish to the channel mentioned in the command";
In addition, if one wants to use RM_Call's "dry run" capability instead of the RM ACL
functions directly, one also sees a different problem than it returns ACL errors with a -ERR,
not a -PERM, so it can't be returned directly to the caller.
This PR modifies the code to generate a base message in a common manner with the ability
to set verbose flag for acl dry run errors, and keep it unset for normal/rm_call/script cases
```c
sds getAclErrorMessage(int acl_res, user *user, struct redisCommand *cmd, sds errored_val, int verbose) {
switch (acl_res) {
case ACL_DENIED_CMD:
return sdscatfmt(sdsempty(), "User %S has no permissions to run "
"the '%S' command", user->name, cmd->fullname);
case ACL_DENIED_KEY:
if (verbose) {
return sdscatfmt(sdsempty(), "User %S has no permissions to access "
"the '%S' key", user->name, errored_val);
} else {
return sdsnew("No permissions to access a key");
}
case ACL_DENIED_CHANNEL:
if (verbose) {
return sdscatfmt(sdsempty(), "User %S has no permissions to access "
"the '%S' channel", user->name, errored_val);
} else {
return sdsnew("No permissions to access a channel");
}
}
```
The caller can append/prepend the message (adding NOPERM for normal/RM_Call or indicating it's within a script).
Impact:
- Plain commands, as well as scripts and RM_Call now include the user name.
- ACL DRYRUN remains the only one that's verbose (mentions the offending channel or key name)
- Changes RM_Call ACL errors from being a `-ERR` to being `-NOPERM` (besides for textual changes)
**This somewhat a breaking change, but it only affects the RM_Call with both `C` and `E`, or `D`**
- Changes ACL errors in scripts textually from being
`The user executing the script <old non unified text>`
to
`ACL failure in script: <new unified text>`
81 lines
3.3 KiB
Tcl
81 lines
3.3 KiB
Tcl
set testmodule [file normalize tests/modules/getkeys.so]
|
|
|
|
start_server {tags {"modules"}} {
|
|
r module load $testmodule
|
|
|
|
test {COMMAND INFO correctly reports a movable keys module command} {
|
|
set info [lindex [r command info getkeys.command] 0]
|
|
|
|
assert_equal {module movablekeys} [lindex $info 2]
|
|
assert_equal {0} [lindex $info 3]
|
|
assert_equal {0} [lindex $info 4]
|
|
assert_equal {0} [lindex $info 5]
|
|
}
|
|
|
|
test {COMMAND GETKEYS correctly reports a movable keys module command} {
|
|
r command getkeys getkeys.command arg1 arg2 key key1 arg3 key key2 key key3
|
|
} {key1 key2 key3}
|
|
|
|
test {COMMAND GETKEYS correctly reports a movable keys module command using flags} {
|
|
r command getkeys getkeys.command_with_flags arg1 arg2 key key1 arg3 key key2 key key3
|
|
} {key1 key2 key3}
|
|
|
|
test {COMMAND GETKEYSANDFLAGS correctly reports a movable keys module command not using flags} {
|
|
r command getkeysandflags getkeys.command arg1 arg2 key key1 arg3 key key2
|
|
} {{key1 {RW access update}} {key2 {RW access update}}}
|
|
|
|
test {COMMAND GETKEYSANDFLAGS correctly reports a movable keys module command using flags} {
|
|
r command getkeysandflags getkeys.command_with_flags arg1 arg2 key key1 arg3 key key2 key key3
|
|
} {{key1 {RO access}} {key2 {RO access}} {key3 {RO access}}}
|
|
|
|
test {RM_GetCommandKeys on non-existing command} {
|
|
catch {r getkeys.introspect 0 non-command key1 key2} e
|
|
set _ $e
|
|
} {*ENOENT*}
|
|
|
|
test {RM_GetCommandKeys on built-in fixed keys command} {
|
|
r getkeys.introspect 0 set key1 value1
|
|
} {key1}
|
|
|
|
test {RM_GetCommandKeys on built-in fixed keys command with flags} {
|
|
r getkeys.introspect 1 set key1 value1
|
|
} {{key1 OW}}
|
|
|
|
test {RM_GetCommandKeys on EVAL} {
|
|
r getkeys.introspect 0 eval "" 4 key1 key2 key3 key4 arg1 arg2
|
|
} {key1 key2 key3 key4}
|
|
|
|
test {RM_GetCommandKeys on a movable keys module command} {
|
|
r getkeys.introspect 0 getkeys.command arg1 arg2 key key1 arg3 key key2 key key3
|
|
} {key1 key2 key3}
|
|
|
|
test {RM_GetCommandKeys on a non-movable module command} {
|
|
r getkeys.introspect 0 getkeys.fixed arg1 key1 key2 key3 arg2
|
|
} {key1 key2 key3}
|
|
|
|
test {RM_GetCommandKeys with bad arity} {
|
|
catch {r getkeys.introspect 0 set key} e
|
|
set _ $e
|
|
} {*EINVAL*}
|
|
|
|
# user that can only read from "read" keys, write to "write" keys, and read+write to "RW" keys
|
|
r ACL setuser testuser +@all %R~read* %W~write* %RW~rw*
|
|
|
|
test "module getkeys-api - ACL" {
|
|
# legacy triple didn't provide flags, so they require both read and write
|
|
assert_equal "OK" [r ACL DRYRUN testuser getkeys.command key rw]
|
|
assert_match {*has no permissions to access the 'read' key*} [r ACL DRYRUN testuser getkeys.command key read]
|
|
assert_match {*has no permissions to access the 'write' key*} [r ACL DRYRUN testuser getkeys.command key write]
|
|
}
|
|
|
|
test "module getkeys-api with flags - ACL" {
|
|
assert_equal "OK" [r ACL DRYRUN testuser getkeys.command_with_flags key rw]
|
|
assert_equal "OK" [r ACL DRYRUN testuser getkeys.command_with_flags key read]
|
|
assert_match {*has no permissions to access the 'write' key*} [r ACL DRYRUN testuser getkeys.command_with_flags key write]
|
|
}
|
|
|
|
test "Unload the module - getkeys" {
|
|
assert_equal {OK} [r module unload getkeys]
|
|
}
|
|
}
|