AUTH

语法

AUTH [username] password

可用版本: Redis 开源版 1.0.0
时间复杂度: O(N)，其中 N 是为用户定义的密码数量
ACL 类别: @fast, @connection,

AUTH 命令在以下两种情况下验证当前连接：

如果 Redis 服务器通过 requirepass 选项设置了密码保护。
Redis 6.0 或更高版本实例正在使用 Redis ACL 系统。

Redis 6 之前的版本只能理解该命令的单参数版本

>_ Redis CLI

AUTH "temp-pass"

Python

import redis

r = redis.Redis(decode_responses=True)

res1 = r.auth(password="temp_pass")
print(res1) # >>> True

res2 = r.auth(password="temp_pass", username="default")
print(res2) # >>> True


res = r.auth(username="test-user", password="strong_password")
print(res) # >>> True

Node.js


import { createClient } from 'redis';

const client = createClient();
await client.connect().catch(console.error);

const res1 = await client.auth({ password: 'temp_pass' });
console.log(res1); // OK

const res2 = await client.auth({ username: 'default', password: 'temp_pass' });
console.log(res2); // OK


const res3 = await client.auth({ username: 'test-user', password: 'strong_password' });
console.log(res3); // OK


await client.quit();

Java-Sync


import redis.clients.jedis.Jedis;

import static org.junit.jupiter.api.Assertions.assertEquals;

public class CmdsCnxmgmtExample {
    public void run() {
        Jedis jedis = new Jedis("redis://localhost:6379");

        // Note: you must use the `Jedis` class rather than `UnifiedJedis`
        // to access the `auth` commands.
        String authResult1 = jedis.auth("default",  "temp_pass");
        System.out.println(authResult1); // >>> OK
       
        // Note: you must use the `Jedis` class rather than `UnifiedJedis`
        // to access the `auth` commands.
        String authResult2 = jedis.auth("test-user", "strong_password");
        System.out.println(authResult2); // >>> OK
        
    }
}

此形式仅根据 requirepass 设置的密码进行身份验证。在此配置下，除非连接通过 AUTH 进行身份验证，否则 Redis 将拒绝新连接客户端执行的任何命令。

如果通过 AUTH 提供的密码与配置文件中的密码匹配，服务器会回复 OK 状态码并开始接受命令。否则，将返回错误，客户端需要尝试新密码。

当使用 Redis ACL 时，命令应以扩展方式给出

>_ Redis CLI

AUTH "test-user" "strong_password"

Python

import redis

r = redis.Redis(decode_responses=True)

res1 = r.auth(password="temp_pass")
print(res1) # >>> True

res2 = r.auth(password="temp_pass", username="default")
print(res2) # >>> True


res = r.auth(username="test-user", password="strong_password")
print(res) # >>> True

Node.js


import { createClient } from 'redis';

const client = createClient();
await client.connect().catch(console.error);

const res1 = await client.auth({ password: 'temp_pass' });
console.log(res1); // OK

const res2 = await client.auth({ username: 'default', password: 'temp_pass' });
console.log(res2); // OK


const res3 = await client.auth({ username: 'test-user', password: 'strong_password' });
console.log(res3); // OK


await client.quit();

Java-Sync


import redis.clients.jedis.Jedis;

import static org.junit.jupiter.api.Assertions.assertEquals;

public class CmdsCnxmgmtExample {
    public void run() {
        Jedis jedis = new Jedis("redis://localhost:6379");

        // Note: you must use the `Jedis` class rather than `UnifiedJedis`
        // to access the `auth` commands.
        String authResult1 = jedis.auth("default",  "temp_pass");
        System.out.println(authResult1); // >>> OK
       
        // Note: you must use the `Jedis` class rather than `UnifiedJedis`
        // to access the `auth` commands.
        String authResult2 = jedis.auth("test-user", "strong_password");
        System.out.println(authResult2); // >>> OK
        
    }
}

为了使用 ACL 列表中定义的连接之一验证当前连接（参见 ACL SETUSER），更多信息请参阅官方 ACL 指南。

使用 ACL 时，命令的单参数形式（仅指定密码）假定隐式用户名为 "default"。

安全注意事项

由于 Redis 的高性能特性，可以在很短时间内并行尝试大量密码，因此请务必生成一个强大且非常长的密码，以使此攻击不可行。生成强大密码的一个好方法是使用 ACL GENPASS 命令。

RESP2/RESP3 回复

简单字符串回复：OK，如果密码或用户名/密码对无效则返回错误。

历史

从 Redis 6.0.0 版本开始：添加了 ACL 风格（用户名和密码）。

产品

工具

获取 Redis

连接

学习

最新

了解工作原理

AUTH

安全注意事项

RESP2/RESP3 回复

历史