base.h

Go to the documentation of this file.

#pragma once
/*
 *   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 distributed in the hope that it will be useful,
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *   GNU General Public License for more details.
 *
 *   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
 */
 
/**
 * $Id: 2283664397ac3ddc82bbc562bbdd1a52064c1bf9 $
 * @file lib/redis/base.h
 * @brief Common functions for interacting with Redis via hiredis
 *
 * @author Arran Cudbard-Bell
 *
 * @copyright 2015 Arran Cudbard-Bell (a.cudbardb@freeradius.org)
 * @copyright 2000,2006,2015 The FreeRADIUS server project
 * @copyright 2011 TekSavvy Solutions (gabe@teksavvy.com)
 */
RCSIDH(redis_h, "$Id: 2283664397ac3ddc82bbc562bbdd1a52064c1bf9 $")
 
#include <freeradius-devel/server/base.h>
#include <freeradius-devel/server/map.h>
#include <freeradius-devel/server/module.h>
#include <freeradius-devel/server/trunk.h>
 
//DIAG_OFF(extra-semi-stmt)
#include <hiredis/hiredis.h>
//DIAG_ON(extra-semi-stmt)
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define MAX_REDIS_COMMAND_LEN           4096
#define MAX_REDIS_ARGS                  256
 
#define REDIS_ERROR_MOVED_STR           "MOVED"
#define REDIS_ERROR_ASK_STR             "ASK"
#define REDIS_ERROR_TRY_AGAIN_STR       "TRYAGAIN"
#define REDIS_ERROR_NO_SCRIPT_STR       "NOSCRIPT"
#define REDIS_DEFAULT_PORT              6379
 
#define REDIS_VERSION(_max, _min, _patch) (uint32_t) (_max << 24) | (_min << 16) | _patch
 
typedef struct fr_redis_cluster_node_s fr_redis_cluster_node_t;
typedef struct fr_redis_ct_s fr_redis_ct_t;
 
extern fr_table_num_sorted_t const redis_reply_types[];
extern size_t redis_reply_types_len;
extern fr_table_num_sorted_t const redis_rcodes[];
extern size_t redis_rcodes_len;
 
/** Codes are ordered inversely by priority
 *
 * To simplify handling the return codes from pipelined commands,
 * the lowest status code, and the reply which accompanies it should
 * be returned to the redis cluster code.
 */
typedef enum {
        REDIS_RCODE_SUCCESS = 0,                //!< Operation was successful.
        REDIS_RCODE_ERROR = -1,                 //!< Unrecoverable library/server error.
        REDIS_RCODE_TRY_AGAIN = -2,             //!< Try the operation again.
        REDIS_RCODE_RECONNECT = -3,             //!< Transitory error, caller should retry the operation
                                                //!< with a new connection.
        REDIS_RCODE_ASK = -4,                   //!< Attempt operation on an alternative node.
        REDIS_RCODE_MOVE = -5,                  //!< Attempt operation on an alternative node with remap.
        REDIS_RCODE_NO_SCRIPT = -6,             //!< Script doesn't exist.
} fr_redis_rcode_t;
 
typedef enum {
        REDIS_ASYNC_RCODE_SUCCESS = 0,          //!< Operation was successful.
        REDIS_ASYNC_RCODE_ERROR = -1,           //!< Unrecoverable error.
        REDIS_ASYNC_RCODE_BOOTSTRAP = -2,       //!< The caller should issue a request to bootstrap the cluster map.
        REDIS_ASYNC_RCODE_GETMAP = -3,          //!< The caller should issue a request to update the cluster map.
 
        REDIS_ASYNC_RCODE_TRY_AGAIN = -4,       //!< Try the operation again
        REDIS_ASYNC_RCODE_ASK = -5,             //!< Attempt operation on an alternative node.
        REDIS_ASYNC_RCODE_MOVE = -6,            //!< Attempt operation on an alternative node with remap.
        REDIS_ASYNC_RCODE_NO_SCRIPT = -7,       //!< Script doesn't exist.
        REDIS_ASYNC_RCODE_FAIL = -8,            //!< The command set trunk request has been failed.
} fr_redis_async_rcode_t;
 
/** Connection handle, holding a redis context
 */
typedef struct {
        redisContext            *handle;        //!< Hiredis context used when issuing commands.
        fr_redis_cluster_node_t *node;          //!< Node this connection is to.
} fr_redis_conn_t;
 
typedef enum {
        FR_REDIS_INVALID = 0,
        FR_REDIS_CLUSTER_MAP_BOOTSTRAP,
        FR_REDIS_CLUSTER_MAP_GET,
        FR_REDIS_CLUSTER_MAP_UPDATE,
        FR_REDIS_CLUSTER_MAP_FAIL,
        FR_REDIS_CODE_MAX,
        FR_REDIS_DO_NOT_RESPOND = 255
} fr_redis_packet_code_t;
 
/** Configuration parameters for a redis connection
 *
 * @note should be passed as instance data to #module_rlm_connection_pool_init.
 */
typedef struct {
        char const              **hostname;     //!< of Redis server.
        uint16_t                port;           //!< of Redis daemon.
        uint32_t                database;       //!< number on Redis server.
        bool                    use_tls;        //!< use TLS.
        bool                    use_cluster_map;//!< use cluster map.
 
        char const              *username;      //!< for acls.
        char const              *password;      //!< to authenticate to Redis.
 
        uint8_t                 max_nodes;      //!< Maximum number of cluster nodes to connect to.
        uint32_t                max_redirects;  //!< Maximum number of times we can be redirected.
        uint32_t                max_retries;    //!< Maximum number of times we attempt a command
                                                //!< when receiving successive -TRYAGAIN messages.
        uint32_t                max_alt;        //!< Maximum alternative nodes to try.
        fr_time_delta_t         retry_delay;    //!< How long to wait when we received a -TRYAGAIN
                                                //!< message.
        fr_time_delta_t         connection_timeout;
 
        fr_time_delta_t         reconnection_delay;
 
        char const              *log_prefix;
 
        char const              *module_name;   //!< Module name for triggers.
        char const              *inst_name;     //!< Instance name for triggers.
 
        trunk_conf_t            trunk_conf;     //!< Configuration for trunk connections.
} fr_redis_conf_t;
 
#define REDIS_COMMON_CONFIG \
        { FR_CONF_OFFSET_FLAGS("server", CONF_FLAG_REQUIRED | CONF_FLAG_MULTI, fr_redis_conf_t, hostname) }, \
        { FR_CONF_OFFSET("port", fr_redis_conf_t, port), .dflt = "6379" }, \
        { FR_CONF_OFFSET("database", fr_redis_conf_t, database), .dflt = "0" }, \
        { FR_CONF_OFFSET("use_tls", fr_redis_conf_t, use_tls), .dflt = "no" }, \
        { FR_CONF_OFFSET("use_cluster_map", fr_redis_conf_t, use_cluster_map), .dflt = "yes" }, \
        { FR_CONF_OFFSET("username", fr_redis_conf_t, username) }, \
        { FR_CONF_OFFSET_FLAGS("password", CONF_FLAG_SECRET, fr_redis_conf_t, password) }, \
        { FR_CONF_OFFSET("max_nodes", fr_redis_conf_t, max_nodes), .dflt = "20" }, \
        { FR_CONF_OFFSET("max_alt", fr_redis_conf_t, max_alt), .dflt = "3" }, \
        { FR_CONF_OFFSET("max_redirects", fr_redis_conf_t, max_redirects), .dflt = "2" }, \
        { FR_CONF_OFFSET_SUBSECTION("pool", 0, fr_redis_conf_t, trunk_conf, trunk_config) }
 
void            fr_redis_version_print(void);
 
int             redis_dict_init(void);
 
/*
 *      Command and resulting parsing
 */
fr_redis_rcode_t        fr_redis_command_status(fr_redis_conn_t *conn, redisReply *reply);
 
void                    fr_redis_reply_print(fr_log_lvl_t lvl, redisReply *reply, request_t *request, int idx,
                                             fr_redis_rcode_t status);
 
int                     fr_redis_reply_to_value_box(TALLOC_CTX *ctx, fr_value_box_t *out, redisReply *reply,
                                                    fr_type_t dst_type, fr_dict_attr_t const *dst_enumv,
                                                    bool box_error, bool shallow) CC_HINT(nonnull(2,3));
 
int                     fr_redis_reply_to_map(TALLOC_CTX *ctx, map_list_t *out,
                                              request_t *request, redisReply *key, redisReply *op, redisReply *value);
 
int                     fr_redis_tuple_from_map(TALLOC_CTX *pool, char const *out[], size_t out_len[], map_t *map);
 
fr_redis_rcode_t        fr_redis_parse_version(char *out, size_t out_len, redisReply *reply);
 
uint32_t                fr_redis_version_num(char const *version);
 
#ifdef __cplusplus
}
#endif