mirror of
https://codeberg.org/redict/redict.git
synced 2025-01-24 09:08:26 -05:00
192 lines
7.2 KiB
C
192 lines
7.2 KiB
C
/* ACL API example - An example for performing custom synchronous and
|
|
* asynchronous password authentication.
|
|
*
|
|
* -----------------------------------------------------------------------------
|
|
*
|
|
* Copyright 2019 Amazon.com, Inc. or its affiliates.
|
|
* All rights reserved.
|
|
*
|
|
* Redistribution and use in source and binary forms, with or without
|
|
* modification, are permitted provided that the following conditions are met:
|
|
*
|
|
* * Redistributions of source code must retain the above copyright notice,
|
|
* this list of conditions and the following disclaimer.
|
|
* * Redistributions in binary form must reproduce the above copyright
|
|
* notice, this list of conditions and the following disclaimer in the
|
|
* documentation and/or other materials provided with the distribution.
|
|
* * Neither the name of Redis nor the names of its contributors may be used
|
|
* to endorse or promote products derived from this software without
|
|
* specific prior written permission.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
|
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
|
|
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
|
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
|
|
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
|
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
|
|
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
|
|
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
|
* POSSIBILITY OF SUCH DAMAGE.
|
|
*/
|
|
|
|
#define REDISMODULE_EXPERIMENTAL_API
|
|
#include "../redismodule.h"
|
|
#include <pthread.h>
|
|
#include <unistd.h>
|
|
|
|
// A simple global user
|
|
static RedisModuleUser *global;
|
|
static uint64_t global_auth_client_id = 0;
|
|
|
|
/* HELLOACL.REVOKE
|
|
* Synchronously revoke access from a user. */
|
|
int RevokeCommand_RedisCommand(RedisModuleCtx *ctx, RedisModuleString **argv, int argc) {
|
|
REDISMODULE_NOT_USED(argv);
|
|
REDISMODULE_NOT_USED(argc);
|
|
|
|
if (global_auth_client_id) {
|
|
RedisModule_DeauthenticateAndCloseClient(ctx, global_auth_client_id);
|
|
return RedisModule_ReplyWithSimpleString(ctx, "OK");
|
|
} else {
|
|
return RedisModule_ReplyWithError(ctx, "Global user currently not used");
|
|
}
|
|
}
|
|
|
|
/* HELLOACL.RESET
|
|
* Synchronously delete and re-create a module user. */
|
|
int ResetCommand_RedisCommand(RedisModuleCtx *ctx, RedisModuleString **argv, int argc) {
|
|
REDISMODULE_NOT_USED(argv);
|
|
REDISMODULE_NOT_USED(argc);
|
|
|
|
RedisModule_FreeModuleUser(global);
|
|
global = RedisModule_CreateModuleUser("global");
|
|
RedisModule_SetModuleUserACL(global, "allcommands");
|
|
RedisModule_SetModuleUserACL(global, "allkeys");
|
|
RedisModule_SetModuleUserACL(global, "on");
|
|
|
|
return RedisModule_ReplyWithSimpleString(ctx, "OK");
|
|
}
|
|
|
|
/* Callback handler for user changes, use this to notify a module of
|
|
* changes to users authenticated by the module */
|
|
void HelloACL_UserChanged(uint64_t client_id, void *privdata) {
|
|
REDISMODULE_NOT_USED(privdata);
|
|
REDISMODULE_NOT_USED(client_id);
|
|
global_auth_client_id = 0;
|
|
}
|
|
|
|
/* HELLOACL.AUTHGLOBAL
|
|
* Synchronously assigns a module user to the current context. */
|
|
int AuthGlobalCommand_RedisCommand(RedisModuleCtx *ctx, RedisModuleString **argv, int argc) {
|
|
REDISMODULE_NOT_USED(argv);
|
|
REDISMODULE_NOT_USED(argc);
|
|
|
|
if (global_auth_client_id) {
|
|
return RedisModule_ReplyWithError(ctx, "Global user currently used");
|
|
}
|
|
|
|
RedisModule_AuthenticateClientWithUser(ctx, global, HelloACL_UserChanged, NULL, &global_auth_client_id);
|
|
|
|
return RedisModule_ReplyWithSimpleString(ctx, "OK");
|
|
}
|
|
|
|
#define TIMEOUT_TIME 1000
|
|
|
|
/* Reply callback for auth command HELLOACL.AUTHASYNC */
|
|
int HelloACL_Reply(RedisModuleCtx *ctx, RedisModuleString **argv, int argc) {
|
|
REDISMODULE_NOT_USED(argv);
|
|
REDISMODULE_NOT_USED(argc);
|
|
size_t length;
|
|
|
|
RedisModuleString *user_string = RedisModule_GetBlockedClientPrivateData(ctx);
|
|
const char *name = RedisModule_StringPtrLen(user_string, &length);
|
|
|
|
if (RedisModule_AuthenticateClientWithACLUser(ctx, name, length, NULL, NULL, NULL) ==
|
|
REDISMODULE_ERR) {
|
|
return RedisModule_ReplyWithError(ctx, "Invalid Username or password");
|
|
}
|
|
return RedisModule_ReplyWithSimpleString(ctx, "OK");
|
|
}
|
|
|
|
/* Timeout callback for auth command HELLOACL.AUTHASYNC */
|
|
int HelloACL_Timeout(RedisModuleCtx *ctx, RedisModuleString **argv, int argc) {
|
|
REDISMODULE_NOT_USED(argv);
|
|
REDISMODULE_NOT_USED(argc);
|
|
return RedisModule_ReplyWithSimpleString(ctx, "Request timedout");
|
|
}
|
|
|
|
/* Private data frees data for HELLOACL.AUTHASYNC command. */
|
|
void HelloACL_FreeData(RedisModuleCtx *ctx, void *privdata) {
|
|
REDISMODULE_NOT_USED(ctx);
|
|
RedisModule_FreeString(NULL, privdata);
|
|
}
|
|
|
|
/* Background authentication can happen here. */
|
|
void *HelloACL_ThreadMain(void *args) {
|
|
void **targs = args;
|
|
RedisModuleBlockedClient *bc = targs[0];
|
|
RedisModuleString *user = targs[1];
|
|
RedisModule_Free(targs);
|
|
|
|
RedisModule_UnblockClient(bc,user);
|
|
return NULL;
|
|
}
|
|
|
|
/* HELLOACL.AUTHASYNC
|
|
* Asynchronously assigns an ACL user to the current context. */
|
|
int AuthAsyncCommand_RedisCommand(RedisModuleCtx *ctx, RedisModuleString **argv, int argc) {
|
|
if (argc != 2) return RedisModule_WrongArity(ctx);
|
|
|
|
pthread_t tid;
|
|
RedisModuleBlockedClient *bc = RedisModule_BlockClient(ctx, HelloACL_Reply, HelloACL_Timeout, HelloACL_FreeData, TIMEOUT_TIME);
|
|
|
|
|
|
void **targs = RedisModule_Alloc(sizeof(void*)*2);
|
|
targs[0] = bc;
|
|
targs[1] = RedisModule_CreateStringFromString(NULL, argv[1]);
|
|
|
|
if (pthread_create(&tid, NULL, HelloACL_ThreadMain, targs) != 0) {
|
|
RedisModule_AbortBlock(bc);
|
|
return RedisModule_ReplyWithError(ctx, "-ERR Can't start thread");
|
|
}
|
|
|
|
return REDISMODULE_OK;
|
|
}
|
|
|
|
/* This function must be present on each Redis module. It is used in order to
|
|
* register the commands into the Redis server. */
|
|
int RedisModule_OnLoad(RedisModuleCtx *ctx, RedisModuleString **argv, int argc) {
|
|
REDISMODULE_NOT_USED(argv);
|
|
REDISMODULE_NOT_USED(argc);
|
|
|
|
if (RedisModule_Init(ctx,"helloacl",1,REDISMODULE_APIVER_1)
|
|
== REDISMODULE_ERR) return REDISMODULE_ERR;
|
|
|
|
if (RedisModule_CreateCommand(ctx,"helloacl.reset",
|
|
ResetCommand_RedisCommand,"",0,0,0) == REDISMODULE_ERR)
|
|
return REDISMODULE_ERR;
|
|
|
|
if (RedisModule_CreateCommand(ctx,"helloacl.revoke",
|
|
RevokeCommand_RedisCommand,"",0,0,0) == REDISMODULE_ERR)
|
|
return REDISMODULE_ERR;
|
|
|
|
if (RedisModule_CreateCommand(ctx,"helloacl.authglobal",
|
|
AuthGlobalCommand_RedisCommand,"no-auth",0,0,0) == REDISMODULE_ERR)
|
|
return REDISMODULE_ERR;
|
|
|
|
if (RedisModule_CreateCommand(ctx,"helloacl.authasync",
|
|
AuthAsyncCommand_RedisCommand,"no-auth",0,0,0) == REDISMODULE_ERR)
|
|
return REDISMODULE_ERR;
|
|
|
|
global = RedisModule_CreateModuleUser("global");
|
|
RedisModule_SetModuleUserACL(global, "allcommands");
|
|
RedisModule_SetModuleUserACL(global, "allkeys");
|
|
RedisModule_SetModuleUserACL(global, "on");
|
|
|
|
global_auth_client_id = 0;
|
|
|
|
return REDISMODULE_OK;
|
|
}
|