AUTH

Syntax

AUTH [username] password

Available since:: Redis Open Source 1.0.0
Time complexity:: O(N) where N is the number of passwords defined for the user
ACL categories:: @fast, @connection,

The AUTH command authenticates the current connection in two cases:

If the Redis server is password protected via the requirepass option.
A Redis 6.0 instance, or greater, is using the Redis ACL system.

Redis versions prior of Redis 6 were only able to understand the one argument version of the command:

>_ 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
        
    }
}

This form just authenticates against the password set with requirepass. In this configuration Redis will deny any command executed by the just connected clients, unless the connection gets authenticated via AUTH.

If the password provided via AUTH matches the password in the configuration file, the server replies with the OK status code and starts accepting commands. Otherwise, an error is returned and the clients needs to try a new password.

When Redis ACLs are used, the command should be given in an extended way:

>_ 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
        
    }
}

In order to authenticate the current connection with one of the connections defined in the ACL list (see ACL SETUSER) and the official ACL guide for more information.

When ACLs are used, the single argument form of the command, where only the password is specified, assumes that the implicit username is "default".

Security notice

Because of the high performance nature of Redis, it is possible to try a lot of passwords in parallel in very short time, so make sure to generate a strong and very long password so that this attack is infeasible. A good way to generate strong passwords is via the ACL GENPASS command.

Return information

RESP2 RESP3

Simple string reply: OK, or an error if the password, or username/password pair, is invalid.

History

Starting with Redis version 6.0.0: Added ACL style (username and password).

Products

Tools

Get Redis

Connect

Learn

Latest

See how it works

AUTH

Security notice

Return information

History