Skip to content

Commit 0e019cc

Browse files
vladvildanovvladvildanov
authored
Extended core support by implementing ACL SETUSER, GETUSER, DRYRUN (#1193)
* Added support for ACL GETUSER, SETUSER, DRYRUN commands * Change test to support Redis > 6.0.0 * Removed selectors check
1 parent b898172 commit 0e019cc

File tree

8 files changed

+298
-0
lines changed

8 files changed

+298
-0
lines changed

‎examples/Commands/acl_dry_run.php

+36
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
<?php
2+
3+
/*
4+
* This file is part of the Predis package.
5+
*
6+
* (c) 2009-2020 Daniele Alessandri
7+
* (c) 2021-2023 Till Krüss
8+
*
9+
* For the full copyright and license information, please view the LICENSE
10+
* file that was distributed with this source code.
11+
*/
12+
13+
use Predis\Client;
14+
15+
require __DIR__ . '/../shared.php';
16+
17+
// Example of ACL DRYRUN command usage:
18+
19+
// 1. Set user with permissions to call only 'SET' command.
20+
$client = new Client($single_server);
21+
$response = $client->acl->setUser('Test_dry', '+SET', '~*');
22+
$created = ($response == 'OK') ? 'Yes' : 'No';
23+
24+
echo "User with username 'Test' was created: {$created}. Permissions only to use SET command\n";
25+
26+
// 2. Dry run 'SET' command under 'Test_dry' user
27+
$response = $client->acl->dryRun('Test_dry', 'SET', 'foo', 'bar');
28+
29+
echo 'Dry run "SET" command.' . "\n";
30+
echo 'Response: ' . $response . "\n";
31+
32+
// 3. Dry run 'GET' command under 'Test_dry' user
33+
$response = $client->acl->dryRun('Test_dry', 'GET', 'foo');
34+
35+
echo 'Dry run "GET" command.' . "\n";
36+
echo 'Response: ' . $response;

‎examples/Commands/acl_get_user.php

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
<?php
2+
3+
/*
4+
* This file is part of the Predis package.
5+
*
6+
* (c) 2009-2020 Daniele Alessandri
7+
* (c) 2021-2023 Till Krüss
8+
*
9+
* For the full copyright and license information, please view the LICENSE
10+
* file that was distributed with this source code.
11+
*/
12+
13+
use Predis\Client;
14+
15+
require __DIR__ . '/../shared.php';
16+
17+
// Example of ACL GETUSER command usage:
18+
19+
// 1. Set user
20+
$client = new Client($single_server);
21+
$response = $client->acl->setUser('Test');
22+
23+
// 2. Retrieve user rules:
24+
25+
echo 'Rules: ' . "\n";
26+
print_r(
27+
$client->acl->getUser('Test')
28+
);

‎examples/Commands/acl_set_user.php

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
<?php
2+
3+
/*
4+
* This file is part of the Predis package.
5+
*
6+
* (c) 2009-2020 Daniele Alessandri
7+
* (c) 2021-2023 Till Krüss
8+
*
9+
* For the full copyright and license information, please view the LICENSE
10+
* file that was distributed with this source code.
11+
*/
12+
13+
use Predis\Client;
14+
15+
require __DIR__ . '/../shared.php';
16+
17+
// Example of ACL SETUSER command usage:
18+
19+
// 1. Set user
20+
$client = new Client($single_server);
21+
$response = $client->acl->setUser('Test');
22+
$created = ($response == 'OK') ? 'Yes' : 'No';
23+
24+
echo "User with username 'Test' was created: {$created}";

‎src/ClientContextInterface.php

+2
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717
use Predis\Command\Argument\Server\LimitOffsetCount;
1818
use Predis\Command\Argument\Server\To;
1919
use Predis\Command\CommandInterface;
20+
use Predis\Command\Redis\Container\ACL;
2021
use Predis\Command\Redis\Container\FunctionContainer;
2122

2223
/**
@@ -206,6 +207,7 @@
206207
*
207208
* Container commands
208209
* @property FunctionContainer $function
210+
* @property ACL $acl
209211
*/
210212
interface ClientContextInterface
211213
{

‎src/ClientInterface.php

+2
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@
1818
use Predis\Command\Argument\Server\To;
1919
use Predis\Command\CommandInterface;
2020
use Predis\Command\FactoryInterface;
21+
use Predis\Command\Redis\Container\ACL;
2122
use Predis\Command\Redis\Container\FunctionContainer;
2223
use Predis\Configuration\OptionsInterface;
2324
use Predis\Connection\ConnectionInterface;
@@ -224,6 +225,7 @@
224225
*
225226
* Container commands
226227
* @property FunctionContainer $function
228+
* @property ACL $acl
227229
*/
228230
interface ClientInterface
229231
{

‎src/Command/Redis/ACL.php

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
<?php
2+
3+
/*
4+
* This file is part of the Predis package.
5+
*
6+
* (c) 2009-2020 Daniele Alessandri
7+
* (c) 2021-2023 Till Krüss
8+
*
9+
* For the full copyright and license information, please view the LICENSE
10+
* file that was distributed with this source code.
11+
*/
12+
13+
namespace Predis\Command\Redis;
14+
15+
use Predis\Command\Command as RedisCommand;
16+
17+
/**
18+
* @see https://redis.io/commands/?name=ACL
19+
*
20+
* Container command corresponds to any ACL *.
21+
* Represents any ACL command with subcommand as first argument.
22+
*/
23+
class ACL extends RedisCommand
24+
{
25+
public function getId()
26+
{
27+
return 'ACL';
28+
}
29+
}

‎src/Command/Redis/Container/ACL.php

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
<?php
2+
3+
/*
4+
* This file is part of the Predis package.
5+
*
6+
* (c) 2009-2020 Daniele Alessandri
7+
* (c) 2021-2023 Till Krüss
8+
*
9+
* For the full copyright and license information, please view the LICENSE
10+
* file that was distributed with this source code.
11+
*/
12+
13+
namespace Predis\Command\Redis\Container;
14+
15+
use Predis\Response\Status;
16+
17+
/**
18+
* @method Status dryRun(string $username, string $command, ...$arguments)
19+
* @method array getUser(string $username)
20+
* @method Status setUser(string $username, string ...$rules)
21+
*/
22+
class ACL extends AbstractContainer
23+
{
24+
public function getContainerCommandId(): string
25+
{
26+
return 'acl';
27+
}
28+
}

‎tests/Predis/Command/Redis/ACL_Test.php

+149
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,149 @@
1+
<?php
2+
3+
/*
4+
* This file is part of the Predis package.
5+
*
6+
* (c) 2009-2020 Daniele Alessandri
7+
* (c) 2021-2023 Till Krüss
8+
*
9+
* For the full copyright and license information, please view the LICENSE
10+
* file that was distributed with this source code.
11+
*/
12+
13+
namespace Predis\Command\Redis;
14+
15+
use Predis\Response\ServerException;
16+
17+
class ACL_Test extends PredisCommandTestCase
18+
{
19+
/**
20+
* {@inheritDoc}
21+
*/
22+
protected function getExpectedCommand(): string
23+
{
24+
return ACL::class;
25+
}
26+
27+
/**
28+
* {@inheritDoc}
29+
*/
30+
protected function getExpectedId(): string
31+
{
32+
return 'ACL';
33+
}
34+
35+
/**
36+
* @group disconnected
37+
*/
38+
public function testSetUserFilterArguments(): void
39+
{
40+
$arguments = ['SETUSER', 'username', 'rule1', 'rule2'];
41+
$expected = ['SETUSER', 'username', 'rule1', 'rule2'];
42+
43+
$command = $this->getCommand();
44+
$command->setArguments($arguments);
45+
46+
$this->assertSameValues($expected, $command->getArguments());
47+
}
48+
49+
/**
50+
* @group disconnected
51+
*/
52+
public function testDryRunFilterArguments(): void
53+
{
54+
$arguments = ['DRYRUN', 'username', 'command', 'arg1', 'arg2'];
55+
$expected = ['DRYRUN', 'username', 'command', 'arg1', 'arg2'];
56+
57+
$command = $this->getCommand();
58+
$command->setArguments($arguments);
59+
60+
$this->assertSameValues($expected, $command->getArguments());
61+
}
62+
63+
/**
64+
* @group disconnected
65+
*/
66+
public function testGetUserFilterArguments(): void
67+
{
68+
$arguments = ['GETUSER', 'username'];
69+
$expected = ['GETUSER', 'username'];
70+
71+
$command = $this->getCommand();
72+
$command->setArguments($arguments);
73+
74+
$this->assertSameValues($expected, $command->getArguments());
75+
}
76+
77+
/**
78+
* @group connected
79+
* @return void
80+
* @requiresRedisVersion >= 6.0.0
81+
*/
82+
public function testSetUserCreatesACLUser(): void
83+
{
84+
$redis = $this->getClient();
85+
86+
$this->assertEquals('OK', $redis->acl->setUser('Test'));
87+
}
88+
89+
/**
90+
* @group connected
91+
* @return void
92+
* @requiresRedisVersion >= 7.0.0
93+
*/
94+
public function testDryRunSimulateExecutionOfGivenCommandByUser(): void
95+
{
96+
$redis = $this->getClient();
97+
98+
$this->assertEquals('OK', $redis->acl->setUser('Test', '+SET', '~*'));
99+
$this->assertEquals(
100+
'OK',
101+
$redis->acl->dryRun('Test', 'SET', 'foo', 'bar')
102+
);
103+
$this->assertEquals(
104+
"This user has no permissions to run the 'get' command",
105+
$redis->acl->dryRun('Test', 'GET', 'foo')
106+
);
107+
}
108+
109+
/**
110+
* @group connected
111+
* @return void
112+
* @requiresRedisVersion >= 6.0.0
113+
*/
114+
public function testGetUserReturnsUserDefinedRules(): void
115+
{
116+
$redis = $this->getClient();
117+
118+
$this->assertEquals(
119+
'OK',
120+
$redis->acl->setUser(
121+
'alan',
122+
'allkeys',
123+
'+@string',
124+
'+@set',
125+
'-SADD',
126+
'>alanpassword'
127+
)
128+
);
129+
130+
foreach (['flags', 'passwords', 'commands', 'keys', 'channels'] as $key) {
131+
$this->assertContains($key, $redis->acl->getUser('alan'));
132+
}
133+
}
134+
135+
/**
136+
* @group connected
137+
* @return void
138+
* @requiresRedisVersion >= 6.0.0
139+
*/
140+
public function testSetUserThrowsExceptionOnIncorrectRuleProvided(): void
141+
{
142+
$redis = $this->getClient();
143+
144+
$this->expectException(ServerException::class);
145+
$this->expectExceptionMessage("ERR Error in ACL SETUSER modifier 'foobar'");
146+
147+
$redis->acl->setUser('Test', 'foobar');
148+
}
149+
}

0 commit comments

Comments
 (0)