rlm_couchbase.c File Reference

Integrate FreeRADIUS with the Couchbase document database. More...

#include <freeradius-devel/server/base.h>
#include <freeradius-devel/server/map.h>
#include <freeradius-devel/server/module_rlm.h>
#include <freeradius-devel/radius/defs.h>
#include <freeradius-devel/json/base.h>
#include "mod.h"
#include "couchbase.h"

Include dependency graph for rlm_couchbase.c:

Go to the source code of this file.

Macros
#define	LOG_PREFIX   "couchbase - "

Functions
static unlang_action_t	mod_accounting (rlm_rcode_t *p_result, module_ctx_t const *mctx, request_t *request)
	Write accounting data to Couchbase documents. More...
static unlang_action_t	mod_authorize (rlm_rcode_t *p_result, module_ctx_t const *mctx, request_t *request)
	Handle authorization requests using Couchbase document data. More...
static int	mod_detach (module_detach_ctx_t const *mctx)
	Detach the module. More...
static int	mod_instantiate (module_inst_ctx_t const *mctx)
	Initialize the rlm_couchbase module. More...
static int	mod_load (void)

Variables
fr_dict_attr_t const *	attr_acct_session_time
fr_dict_attr_t const *	attr_acct_status_type
fr_dict_attr_t const *	attr_event_timestamp
static const conf_parser_t	client_config []
	Client Configuration. More...
static fr_dict_t const *	dict_radius
static const conf_parser_t	module_config []
	Module Configuration. More...
module_rlm_t	rlm_couchbase
fr_dict_autoload_t	rlm_couchbase_dict []
fr_dict_attr_autoload_t	rlm_couchbase_dict_attr []

Detailed Description

Integrate FreeRADIUS with the Couchbase document database.

Id

e2008e764a8d28c48a3944d7a4604149d02856e9

Author

Aaron Hurt (ahurt.nosp@m.@anb.nosp@m.cs.co.nosp@m.m)

Copyright

2013-2014 The FreeRADIUS Server Project.

Definition in file rlm_couchbase.c.

Macro Definition Documentation

LOG_PREFIX

#define LOG_PREFIX   "couchbase - "

Definition at line 29 of file rlm_couchbase.c.

Function Documentation

mod_accounting()

static unlang_action_t mod_accounting ( rlm_rcode_t *  p_result, module_ctx_t const *  mctx, request_t *  request  )

static

Write accounting data to Couchbase documents.

Handle accounting requests and store the associated data into JSON documents in couchbase mapping attribute names to JSON element names per the module configuration.

When an existing document already exists for the same accounting section the new attributes will be merged with the currently existing data. When conflicts arrise the new attribute value will replace or be added to the existing value.

Parameters

[out]	p_result	Result of calling the module.
	mctx	module calling context.
	request	The accounting request object.

Definition at line 233 of file rlm_couchbase.c.

Here is the call graph for this function:

mod_authorize()

static unlang_action_t mod_authorize ( rlm_rcode_t *  p_result, module_ctx_t const *  mctx, request_t *  request  )

static

Handle authorization requests using Couchbase document data.

Attempt to fetch the document associated with the requested user by using the deterministic key defined in the configuration. When a valid document is found it will be parsed and the containing value pairs will be injected into the request.

Parameters

[out]	p_result	Operation status (rlm_rcode_t).
[in]	mctx	module calling context.
[in]	request	The authorization request.

Definition at line 99 of file rlm_couchbase.c.

Here is the call graph for this function:

mod_detach()

static int mod_detach ( module_detach_ctx_t const *  mctx )

static

Detach the module.

Detach the module instance and free any allocated resources.

Parameters

mctx	The module instance.

Returns

Returns 0 (success) in all conditions.

Definition at line 424 of file rlm_couchbase.c.

Here is the call graph for this function:

mod_instantiate()

static int mod_instantiate ( module_inst_ctx_t const *  mctx )

static

Initialize the rlm_couchbase module.

Initialize the module and create the initial Couchbase connection pool.

Parameters

mctx	The module instance.

Returns

• 0 on success.
• -1 on failure.

Definition at line 444 of file rlm_couchbase.c.

Here is the call graph for this function:

mod_load()

static int mod_load ( void  )

static

Definition at line 537 of file rlm_couchbase.c.

Here is the call graph for this function:

Variable Documentation

attr_acct_session_time

fr_dict_attr_t const* attr_acct_session_time

Definition at line 77 of file rlm_couchbase.c.

attr_acct_status_type

fr_dict_attr_t const* attr_acct_status_type

Definition at line 76 of file rlm_couchbase.c.

attr_event_timestamp

fr_dict_attr_t const* attr_event_timestamp

Definition at line 78 of file rlm_couchbase.c.

client_config

const conf_parser_t client_config[]

static

Initial value:

= {
        { FR_CONF_OFFSET("view", rlm_couchbase_t, client_view), .dflt = "_design/client/_view/by_name" },
        CONF_PARSER_TERMINATOR
}

Client Configuration.

Definition at line 44 of file rlm_couchbase.c.

dict_radius

fr_dict_t const* dict_radius

static

Definition at line 68 of file rlm_couchbase.c.

module_config

const conf_parser_t module_config[]

static

Initial value:

= {
        { FR_CONF_OFFSET_FLAGS("server", CONF_FLAG_REQUIRED, rlm_couchbase_t, server_raw) },
        { FR_CONF_OFFSET_FLAGS("bucket", CONF_FLAG_REQUIRED, rlm_couchbase_t, bucket) },
        { FR_CONF_OFFSET("username", rlm_couchbase_t, username) },
        { FR_CONF_OFFSET("password", rlm_couchbase_t, password) },
 
        { FR_CONF_OFFSET("acct_key", rlm_couchbase_t, acct_key), .dflt = "radacct_%{%{Acct-Unique-Session-Id} || %{Acct-Session-Id}}", .quote = T_DOUBLE_QUOTED_STRING },
        { FR_CONF_OFFSET("doctype", rlm_couchbase_t, doctype), .dflt = "radacct" },
        { FR_CONF_OFFSET("expire", rlm_couchbase_t, expire), .dflt = 0 },
 
        { FR_CONF_OFFSET("user_key", rlm_couchbase_t, user_key), .dflt = "raduser_%md5(%tolower(%{Stripped-User-Name} || %{User-Name}))", .quote = T_DOUBLE_QUOTED_STRING },
        { FR_CONF_OFFSET("read_clients", rlm_couchbase_t, read_clients) }, 
        { FR_CONF_POINTER("client", 0, CONF_FLAG_SUBSECTION, NULL), .subcs = (void const *) client_config },
        CONF_PARSER_TERMINATOR
}

Module Configuration.

Definition at line 52 of file rlm_couchbase.c.

rlm_couchbase

module_rlm_t rlm_couchbase

Initial value:

= {
        .common = {
                .magic          = MODULE_MAGIC_INIT,
                .name           = "couchbase",
                .flags          = MODULE_TYPE_THREAD_SAFE,
                .inst_size      = sizeof(rlm_couchbase_t),
                .config         = module_config,
                .onload         = mod_load,
                .instantiate    = mod_instantiate,
                .detach         = mod_detach
        },
        .method_names = (module_method_name_t[]){
                { .name1 = "recv", .name2 = CF_IDENT_ANY,               .method = mod_authorize   },
                { .name1 = "accounting", .name2 = CF_IDENT_ANY,         .method = mod_accounting   },
                MODULE_NAME_TERMINATOR
        }
}

Definition at line 548 of file rlm_couchbase.c.

rlm_couchbase_dict

fr_dict_autoload_t rlm_couchbase_dict

Initial value:

= {
        { .out = &dict_radius, .proto = "radius" },
        { NULL }
}

Definition at line 71 of file rlm_couchbase.c.

rlm_couchbase_dict_attr

fr_dict_attr_autoload_t rlm_couchbase_dict_attr

Initial value:

= {
        { .out = &attr_acct_status_type, .name = "Acct-Status-Type", .type = FR_TYPE_UINT32, .dict = &dict_radius },
        { .out = &attr_acct_session_time, .name = "Acct-Session-Time", .type = FR_TYPE_UINT32, .dict = &dict_radius },
        { .out = &attr_event_timestamp, .name = "Event-Timestamp", .type = FR_TYPE_DATE, .dict = &dict_radius },
        { NULL }
}

Definition at line 81 of file rlm_couchbase.c.