/*
- * rlm_redis.c
- *
- * Version: $Id$
- *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
- * (at your option) any later version.
+ * This program is is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License, version 2 if the
+ * License as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
- *
- * Copyright 2000,2006 The FreeRADIUS server project
- * Copyright 2011 TekSavvy Solutions <gabe@teksavvy.com>
*/
-#include <freeradius-devel/ident.h>
+/**
+ * $Id$
+ * @file rlm_redis.c
+ * @brief Driver for the REDIS noSQL key value stores.
+ *
+ * @copyright 2000,2006 The FreeRADIUS server project
+ * @copyright 2011 TekSavvy Solutions <gabe@teksavvy.com>
+ */
RCSID("$Id$")
#include "rlm_redis.h"
static const CONF_PARSER module_config[] = {
- { "hostname", PW_TYPE_STRING_PTR,
- offsetof(REDIS_INST, hostname), NULL, "127.0.0.1"},
- { "port", PW_TYPE_INTEGER,
- offsetof(REDIS_INST, port), NULL, "6379"},
- { "database", PW_TYPE_INTEGER,
- offsetof(REDIS_INST, database), NULL, "0"},
- { "password", PW_TYPE_STRING_PTR,
- offsetof(REDIS_INST, password), NULL, NULL},
+ { "hostname", FR_CONF_OFFSET(PW_TYPE_STRING | PW_TYPE_DEPRECATED, REDIS_INST, hostname), NULL },
+ { "server", FR_CONF_OFFSET(PW_TYPE_STRING | PW_TYPE_REQUIRED, REDIS_INST, hostname), NULL },
+ { "port", FR_CONF_OFFSET(PW_TYPE_SHORT, REDIS_INST, port), "6379" },
+ { "database", FR_CONF_OFFSET(PW_TYPE_INTEGER, REDIS_INST, database), "0" },
+ { "password", FR_CONF_OFFSET(PW_TYPE_STRING | PW_TYPE_SECRET, REDIS_INST, password), NULL },
{ NULL, -1, 0, NULL, NULL} /* end the list */
};
-static int redis_delete_conn(UNUSED void *ctx, void *conn)
+static int _mod_conn_free(REDISSOCK *dissocket)
{
- REDISSOCK *dissocket = conn;
-
redisFree(dissocket->conn);
if (dissocket->reply) {
dissocket->reply = NULL;
}
- free(dissocket);
- return 1;
+ return 0;
}
-static void *redis_create_conn(void *ctx)
+static void *mod_conn_create(TALLOC_CTX *ctx, void *instance)
{
- REDIS_INST *inst = ctx;
+ REDIS_INST *inst = instance;
REDISSOCK *dissocket = NULL;
redisContext *conn;
+ redisReply *reply = NULL;
char buffer[1024];
conn = redisConnect(inst->hostname, inst->port);
- if (dissocket->conn->err) return NULL;
+ if (conn->err) return NULL;
if (inst->password) {
- redisReply *reply = NULL;
-
snprintf(buffer, sizeof(buffer), "AUTH %s", inst->password);
- reply = redisCommand(dissocket->conn, buffer);
+ reply = redisCommand(conn, buffer);
if (!reply) {
- radlog(L_ERR, "rlm_redis (%s): Failed to run AUTH",
- inst->xlat_name);
+ ERROR("rlm_redis (%s): Failed to run AUTH", inst->xlat_name);
+
do_close:
if (reply) freeReplyObject(reply);
redisFree(conn);
switch (reply->type) {
case REDIS_REPLY_STATUS:
if (strcmp(reply->str, "OK") != 0) {
- radlog(L_ERR, "rlm_redis (%s): Failed authentication: reply %s",
- inst->xlat_name, dissocket->reply->str);
+ ERROR("rlm_redis (%s): Failed authentication: reply %s",
+ inst->xlat_name, reply->str);
goto do_close;
}
break; /* else it's OK */
default:
- radlog(L_ERR, "rlm_redis (%s): Unexpected reply to AUTH",
+ ERROR("rlm_redis (%s): Unexpected reply to AUTH",
inst->xlat_name);
goto do_close;
}
}
if (inst->database) {
- redisReply *reply = NULL;
-
snprintf(buffer, sizeof(buffer), "SELECT %d", inst->database);
- reply = redisCommand(dissocket->conn, buffer);
+ reply = redisCommand(conn, buffer);
if (!reply) {
- radlog(L_ERR, "rlm_redis (%s): Failed to run SELECT",
+ ERROR("rlm_redis (%s): Failed to run SELECT",
inst->xlat_name);
goto do_close;
}
switch (reply->type) {
case REDIS_REPLY_STATUS:
if (strcmp(reply->str, "OK") != 0) {
- radlog(L_ERR, "rlm_redis (%s): Failed SELECT %d: reply %s",
+ ERROR("rlm_redis (%s): Failed SELECT %d: reply %s",
inst->xlat_name, inst->database,
- dissocket->reply->str);
+ reply->str);
goto do_close;
}
break; /* else it's OK */
default:
- radlog(L_ERR, "rlm_redis (%s): Unexpected reply to SELECT",
+ ERROR("rlm_redis (%s): Unexpected reply to SELECT",
inst->xlat_name);
goto do_close;
}
}
- dissocket = rad_malloc(sizeof(*dissocket));
- memset(dissocket, 0, sizeof(*dissocket));
+ dissocket = talloc_zero(ctx, REDISSOCK);
dissocket->conn = conn;
+ talloc_set_destructor(dissocket, _mod_conn_free);
return dissocket;
}
-static size_t redis_escape_func(char *out, size_t outlen, const char *in)
-{
-
- size_t len = 0;
-
- while (*in) {
- /*
- * Non-printable characters get replaced with their
- * mime-encoded equivalents.
- */
- if ((*in <= 32) || (*in == '\\')) {
- /*
- * Only 3 or less bytes available.
- */
- if (outlen <= 3) {
- break;
- }
-
- snprintf(out, outlen, "=%02X", (unsigned char) in[0]);
- in++;
- out += 3;
- outlen -= 3;
- len += 3;
- continue;
- }
-
- /*
- * Only one byte left.
- */
- if (outlen <= 1) {
- break;
- }
-
- /*
- * Allowed character.
- */
- *out = *in;
- out++;
- in++;
- outlen--;
- len++;
- }
- *out = '\0';
- return len;
-
-}
-
-static int redis_xlat(void *instance, REQUEST *request,
- char *fmt, char *out, size_t freespace,
- UNUSED RADIUS_ESCAPE_STRING func)
+static ssize_t redis_xlat(void *instance, REQUEST *request, char const *fmt, char *out, size_t freespace)
{
REDIS_INST *inst = instance;
REDISSOCK *dissocket;
size_t ret = 0;
char *buffer_ptr;
char buffer[21];
- char querystr[MAX_QUERY_LEN];
-
- if (!radius_xlat(querystr, sizeof(querystr), fmt, request,
- redis_escape_func)) {
- radlog(L_ERR, "rlm_redis (%s): xlat failed.",
- inst->xlat_name);
-
- return 0;
- }
dissocket = fr_connection_get(inst->pool);
- if (!dissocket) {
- radlog(L_ERR, "rlm_redis (%s): redis_get_socket() failed",
- inst->xlat_name);
-
- return 0;
- }
+ if (!dissocket) return -1;
/* Query failed for some reason, release socket and return */
- if (rlm_redis_query(&dissocket, inst, querystr) < 0) {
+ if (rlm_redis_query(&dissocket, inst, fmt, request) < 0) {
goto release;
}
- switch (dissocket->reply->type) {
+ switch (dissocket->reply->type) {
case REDIS_REPLY_INTEGER:
- buffer_ptr = buffer;
- snprintf(buffer_ptr, sizeof(buffer), "%lld",
+ buffer_ptr = buffer;
+ snprintf(buffer_ptr, sizeof(buffer), "%lld",
dissocket->reply->integer);
- ret = strlen(buffer_ptr);
- break;
+ ret = strlen(buffer_ptr);
+ break;
case REDIS_REPLY_STATUS:
case REDIS_REPLY_STRING:
- buffer_ptr = dissocket->reply->str;
- ret = dissocket->reply->len;
- break;
+ buffer_ptr = dissocket->reply->str;
+ ret = dissocket->reply->len;
+ break;
default:
- buffer_ptr = NULL;
- break;
- }
+ buffer_ptr = NULL;
+ break;
+ }
- if ((ret >= freespace) || (buffer_ptr == NULL)) {
+ if ((ret >= freespace) || (!buffer_ptr)) {
RDEBUG("rlm_redis (%s): Can't write result, insufficient space or unsupported result\n",
inst->xlat_name);
- ret = 0;
+ ret = -1;
goto release;
}
-
+
strlcpy(out, buffer_ptr, freespace);
release:
rlm_redis_finish_query(dissocket);
fr_connection_release(inst->pool, dissocket);
-
+
return ret;
}
* Only free memory we allocated. The strings allocated via
* cf_section_parse() do not need to be freed.
*/
-static int redis_detach(void *instance)
+static int mod_detach(void *instance)
{
REDIS_INST *inst = instance;
fr_connection_pool_delete(inst->pool);
- if (inst->xlat_name) {
- xlat_unregister(inst->xlat_name, (RAD_XLAT_FUNC)redis_xlat, instance);
- free(inst->xlat_name);
- }
- free(inst->xlat_name);
- free(inst);
-
return 0;
}
/*
* Query the redis database
*/
-int rlm_redis_query(REDISSOCK **dissocket_p, REDIS_INST *inst, char *query)
+int rlm_redis_query(REDISSOCK **dissocket_p, REDIS_INST *inst,
+ char const *query, REQUEST *request)
{
REDISSOCK *dissocket;
+ int argc;
+ char *argv[MAX_REDIS_ARGS];
+ char argv_buf[MAX_QUERY_LEN];
if (!query || !*query || !inst || !dissocket_p) {
return -1;
}
- dissocket = *dissocket_p;
+ argc = rad_expand_xlat(request, query, MAX_REDIS_ARGS, argv, false,
+ sizeof(argv_buf), argv_buf);
+ if (argc <= 0)
+ return -1;
- DEBUG2("executing query %s", query);
- dissocket->reply = redisCommand(dissocket->conn, query);
+ dissocket = *dissocket_p;
+ DEBUG2("executing %s ...", argv[0]);
+ dissocket->reply = redisCommandArgv(dissocket->conn, argc, (char const **)(void **)argv, NULL);
if (!dissocket->reply) {
- radlog(L_ERR, "rlm_redis: (%s) REDIS error: %s",
- inst->xlat_name, dissocket->conn->errstr);
+ RERROR("%s", dissocket->conn->errstr);
dissocket = fr_connection_reconnect(inst->pool, dissocket);
if (!dissocket) {
dissocket->reply = redisCommand(dissocket->conn, query);
if (!dissocket->reply) {
- radlog(L_ERR, "rlm_redis (%s): failed after re-connect",
- inst->xlat_name);
+ RERROR("Failed after re-connect");
fr_connection_del(inst->pool, dissocket);
goto error;
}
}
if (dissocket->reply->type == REDIS_REPLY_ERROR) {
- radlog(L_ERR, "rlm_redis (%s): query failed, %s",
- inst->xlat_name, query);
-
- /* Free the reply just in case */
- rlm_redis_finish_query(dissocket);
-
+ RERROR("Query failed, %s", query);
return -1;
}
return 0;
}
-static int redis_instantiate(CONF_SECTION *conf, void **instance)
+static int mod_instantiate(CONF_SECTION *conf, void *instance)
{
- REDIS_INST *inst;
- const char *xlat_name;
-
- /*
- * Set up a storage area for instance data
- */
- inst = rad_malloc(sizeof (REDIS_INST));
- if (!inst) {
- return -1;
- }
- memset(inst, 0, sizeof (*inst));
-
- /*
- * If the configuration parameters can't be parsed, then
- * fail.
- */
- if (cf_section_parse(conf, inst, module_config) < 0) {
- free(inst);
- return -1;
+ static bool version_done;
+
+ REDIS_INST *inst = instance;
+
+ if (!version_done) {
+ version_done = true;
+
+ INFO("rlm_redis: libhiredis version: %i.%i.%i", HIREDIS_MAJOR, HIREDIS_MINOR, HIREDIS_PATCH);
}
- xlat_name = cf_section_name2(conf);
+ inst->xlat_name = cf_section_name2(conf);
- if (!xlat_name)
- xlat_name = cf_section_name1(conf);
+ if (!inst->xlat_name) inst->xlat_name = cf_section_name1(conf);
- inst->xlat_name = strdup(xlat_name);
- xlat_register(inst->xlat_name, (RAD_XLAT_FUNC)redis_xlat, inst);
+ xlat_register(inst->xlat_name, redis_xlat, NULL, inst); /* FIXME! */
- inst->pool = fr_connection_pool_init(conf, inst,
- redis_create_conn, NULL,
- redis_delete_conn);
+ inst->pool = fr_connection_pool_init(conf, inst, mod_conn_create, NULL, NULL, NULL);
if (!inst->pool) {
- redis_detach(inst);
return -1;
}
inst->redis_query = rlm_redis_query;
inst->redis_finish_query = rlm_redis_finish_query;
- inst->redis_escape_func = redis_escape_func;
-
- *instance = inst;
return 0;
}
RLM_MODULE_INIT,
"redis",
RLM_TYPE_THREAD_SAFE, /* type */
- redis_instantiate, /* instantiation */
- redis_detach, /* detach */
+ sizeof(REDIS_INST), /* yuck */
+ module_config,
+ mod_instantiate, /* instantiation */
+ mod_detach, /* detach */
{
NULL, /* authentication */
NULL, /* authorization */
projects / freeradius.git / blobdiff