RADIUS CDR Support. More...

#include "asterisk.h"
#include <RADIUS_HEADER_STR>
#include "asterisk/channel.h"
#include "asterisk/cdr.h"
#include "asterisk/module.h"
#include "asterisk/utils.h"

Include dependency graph for cdr_radius.c:

Go to the source code of this file.

Macros
#define	DATE_FORMAT "%Y-%m-%d %T %z"

#define	VENDOR_CODE 22736

Enumerations
enum	{ PW_AST_ACCT_CODE = 101 , PW_AST_SRC = 102 , PW_AST_DST = 103 , PW_AST_DST_CTX = 104 , PW_AST_CLID = 105 , PW_AST_CHAN = 106 , PW_AST_DST_CHAN = 107 , PW_AST_LAST_APP = 108 , PW_AST_LAST_DATA = 109 , PW_AST_START_TIME = 110 , PW_AST_ANSWER_TIME = 111 , PW_AST_END_TIME = 112 , PW_AST_DURATION = 113 , PW_AST_BILL_SEC = 114 , PW_AST_DISPOSITION = 115 , PW_AST_AMA_FLAGS = 116 , PW_AST_UNIQUE_ID = 117 , PW_AST_USER_FIELD = 118 }

enum	{ RADIUS_FLAG_USEGMTIME = (1 << 0) , RADIUS_FLAG_LOGUNIQUEID = (1 << 1) , RADIUS_FLAG_LOGUSERFIELD = (1 << 2) }

Functions
static void	__reg_module (void)

static void	__unreg_module (void)

struct ast_module *	AST_MODULE_SELF_SYM (void)

static int	build_radius_record (VALUE_PAIR *tosend, struct ast_cdr cdr)

static int	load_module (void)

static int	radius_log (struct ast_cdr *cdr)

static int	unload_module (void)

Variables
static struct ast_module_info	__mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_LOAD_ORDER, .description = "RADIUS CDR Backend", .key = ASTERISK_GPL_KEY, .buildopt_sum = AST_BUILDOPT_SUM, .support_level = AST_MODULE_SUPPORT_EXTENDED, .load = load_module, .unload = unload_module, .load_pri = AST_MODPRI_CDR_DRIVER, .requires = "cdr", }

static const struct ast_module_info *	ast_module_info = &__mod_info

static const char	cdr_config [] = "cdr.conf"

static const char	desc [] = "RADIUS CDR Backend"

static struct ast_flags	global_flags = { RADIUS_FLAG_USEGMTIME \| RADIUS_FLAG_LOGUNIQUEID \| RADIUS_FLAG_LOGUSERFIELD }

static const char	name [] = "radius"

static char	radiuscfg [PATH_MAX] = "/etc/radiusclient-ng/radiusclient.conf"

static rc_handle *	rh = NULL

Detailed Description

RADIUS CDR Support.

Author: Philippe Sultan The Radius Client Library http://developer.berlios.de/projects/radiusclient-ng/

See also CDR - Call Data Records and billing

Definition in file cdr_radius.c.

Macro Definition Documentation

◆ DATE_FORMAT

#define DATE_FORMAT "%Y-%m-%d %T %z"

ISO 8601 standard format

Definition at line 50 of file cdr_radius.c.

◆ VENDOR_CODE

#define VENDOR_CODE 22736

Definition at line 52 of file cdr_radius.c.

Enumeration Type Documentation

◆ anonymous enum

anonymous enum

Enumerator
PW_AST_ACCT_CODE
PW_AST_SRC
PW_AST_DST
PW_AST_DST_CTX
PW_AST_CLID
PW_AST_CHAN
PW_AST_DST_CHAN
PW_AST_LAST_APP
PW_AST_LAST_DATA
PW_AST_START_TIME
PW_AST_ANSWER_TIME
PW_AST_END_TIME
PW_AST_DURATION
PW_AST_BILL_SEC
PW_AST_DISPOSITION
PW_AST_AMA_FLAGS
PW_AST_UNIQUE_ID
PW_AST_USER_FIELD

Definition at line 54 of file cdr_radius.c.

     {
    PW_AST_ACCT_CODE =    101,
    PW_AST_SRC =          102,
    PW_AST_DST =          103,
    PW_AST_DST_CTX =      104,
    PW_AST_CLID =         105,
    PW_AST_CHAN =         106,
    PW_AST_DST_CHAN =     107,
    PW_AST_LAST_APP =     108,
    PW_AST_LAST_DATA =    109,
    PW_AST_START_TIME =   110,
    PW_AST_ANSWER_TIME =  111,
    PW_AST_END_TIME =     112,
    PW_AST_DURATION =     113,
    PW_AST_BILL_SEC =     114,
    PW_AST_DISPOSITION =  115,
    PW_AST_AMA_FLAGS =    116,
    PW_AST_UNIQUE_ID =    117,
    PW_AST_USER_FIELD =   118
};

◆ anonymous enum

anonymous enum

Enumerator
RADIUS_FLAG_USEGMTIME	Log dates and times in UTC
RADIUS_FLAG_LOGUNIQUEID	Log Unique ID
RADIUS_FLAG_LOGUSERFIELD	Log User Field

Definition at line 75 of file cdr_radius.c.

     {
    /*! Log dates and times in UTC */
    RADIUS_FLAG_USEGMTIME = (1 << 0),
    /*! Log Unique ID */
    RADIUS_FLAG_LOGUNIQUEID = (1 << 1),
    /*! Log User Field */
    RADIUS_FLAG_LOGUSERFIELD = (1 << 2)
};

Function Documentation

◆ __reg_module()

static void __reg_module ( void )

static

Definition at line 291 of file cdr_radius.c.

◆ __unreg_module()

static void __unreg_module ( void )

static

Definition at line 291 of file cdr_radius.c.

◆ AST_MODULE_SELF_SYM()

struct ast_module * AST_MODULE_SELF_SYM ( void )

Definition at line 291 of file cdr_radius.c.

◆ build_radius_record()

static int build_radius_record	(	VALUE_PAIR **	tosend,
		struct ast_cdr *	cdr
	)

static

Definition at line 98 of file cdr_radius.c.

{
    int recordtype = PW_STATUS_STOP;
    struct ast_tm tm;
    char timestr[128];
    char *tmp;
 
    if (!rc_avpair_add(rh, tosend, PW_ACCT_STATUS_TYPE, &recordtype, 0, 0))
        return -1;
 
    /* Account code */
    if (!rc_avpair_add(rh, tosend, PW_AST_ACCT_CODE, &cdr->accountcode, strlen(cdr->accountcode), VENDOR_CODE))
        return -1;
 
    /* Source */
    if (!rc_avpair_add(rh, tosend, PW_AST_SRC, &cdr->src, strlen(cdr->src), VENDOR_CODE))
        return -1;
 
    /* Destination */
    if (!rc_avpair_add(rh, tosend, PW_AST_DST, &cdr->dst, strlen(cdr->dst), VENDOR_CODE))
        return -1;
 
    /* Destination context */
    if (!rc_avpair_add(rh, tosend, PW_AST_DST_CTX, &cdr->dcontext, strlen(cdr->dcontext), VENDOR_CODE))
        return -1;
 
    /* Caller ID */
    if (!rc_avpair_add(rh, tosend, PW_AST_CLID, &cdr->clid, strlen(cdr->clid), VENDOR_CODE))
        return -1;
 
    /* Channel */
    if (!rc_avpair_add(rh, tosend, PW_AST_CHAN, &cdr->channel, strlen(cdr->channel), VENDOR_CODE))
        return -1;
 
    /* Destination Channel */
    if (!rc_avpair_add(rh, tosend, PW_AST_DST_CHAN, &cdr->dstchannel, strlen(cdr->dstchannel), VENDOR_CODE))
        return -1;
 
    /* Last Application */
    if (!rc_avpair_add(rh, tosend, PW_AST_LAST_APP, &cdr->lastapp, strlen(cdr->lastapp), VENDOR_CODE))
        return -1;
 
    /* Last Data */
    if (!rc_avpair_add(rh, tosend, PW_AST_LAST_DATA, &cdr->lastdata, strlen(cdr->lastdata), VENDOR_CODE))
        return -1;
 
 
    /* Start Time */
    ast_strftime(timestr, sizeof(timestr), DATE_FORMAT,
        ast_localtime(&cdr->start, &tm,
            ast_test_flag(&global_flags, RADIUS_FLAG_USEGMTIME) ? "GMT" : NULL));
    if (!rc_avpair_add(rh, tosend, PW_AST_START_TIME, timestr, strlen(timestr), VENDOR_CODE))
        return -1;
 
    /* Answer Time */
    ast_strftime(timestr, sizeof(timestr), DATE_FORMAT,
        ast_localtime(&cdr->answer, &tm,
            ast_test_flag(&global_flags, RADIUS_FLAG_USEGMTIME) ? "GMT" : NULL));
    if (!rc_avpair_add(rh, tosend, PW_AST_ANSWER_TIME, timestr, strlen(timestr), VENDOR_CODE))
        return -1;
 
    /* End Time */
    ast_strftime(timestr, sizeof(timestr), DATE_FORMAT,
        ast_localtime(&cdr->end, &tm,
            ast_test_flag(&global_flags, RADIUS_FLAG_USEGMTIME) ? "GMT" : NULL));
    if (!rc_avpair_add(rh, tosend, PW_AST_END_TIME, timestr, strlen(timestr), VENDOR_CODE))
        return -1;
 
    /* Duration */
    if (!rc_avpair_add(rh, tosend, PW_AST_DURATION, &cdr->duration, 0, VENDOR_CODE))
        return -1;
 
    /* Billable seconds */
    if (!rc_avpair_add(rh, tosend, PW_AST_BILL_SEC, &cdr->billsec, 0, VENDOR_CODE))
        return -1;
 
    /* Disposition */
    tmp = ast_strdupa(ast_cdr_disp2str(cdr->disposition));
    if (!rc_avpair_add(rh, tosend, PW_AST_DISPOSITION, tmp, strlen(tmp), VENDOR_CODE))
        return -1;
 
    /* AMA Flags */
    tmp = ast_strdupa(ast_channel_amaflags2string(cdr->amaflags));
    if (!rc_avpair_add(rh, tosend, PW_AST_AMA_FLAGS, tmp, strlen(tmp), VENDOR_CODE))
        return -1;
 
    if (ast_test_flag(&global_flags, RADIUS_FLAG_LOGUNIQUEID)) {
        /* Unique ID */
        if (!rc_avpair_add(rh, tosend, PW_AST_UNIQUE_ID, &cdr->uniqueid, strlen(cdr->uniqueid), VENDOR_CODE))
            return -1;
    }
 
    if (ast_test_flag(&global_flags, RADIUS_FLAG_LOGUSERFIELD)) {
        /* append the user field */
        if (!rc_avpair_add(rh, tosend, PW_AST_USER_FIELD, &cdr->userfield, strlen(cdr->userfield), VENDOR_CODE))
            return -1;
    }
 
    /* Setting Acct-Session-Id & User-Name attributes for proper generation
     * of Acct-Unique-Session-Id on server side
     */
    /* Channel */
    if (!rc_avpair_add(rh, tosend, PW_USER_NAME, &cdr->channel, strlen(cdr->channel), 0))
        return -1;
 
    /* Unique ID */
    if (!rc_avpair_add(rh, tosend, PW_ACCT_SESSION_ID, &cdr->uniqueid, strlen(cdr->uniqueid), 0))
        return -1;
 
    return 0;
}

References ast_cdr::accountcode, ast_cdr::amaflags, ast_cdr::answer, ast_cdr_disp2str(), ast_channel_amaflags2string(), ast_localtime(), ast_strdupa, ast_strftime(), ast_test_flag, ast_cdr::billsec, ast_cdr::channel, ast_cdr::clid, DATE_FORMAT, ast_cdr::dcontext, ast_cdr::disposition, ast_cdr::dst, ast_cdr::dstchannel, ast_cdr::duration, ast_cdr::end, global_flags, ast_cdr::lastapp, ast_cdr::lastdata, NULL, PW_AST_ACCT_CODE, PW_AST_AMA_FLAGS, PW_AST_ANSWER_TIME, PW_AST_BILL_SEC, PW_AST_CHAN, PW_AST_CLID, PW_AST_DISPOSITION, PW_AST_DST, PW_AST_DST_CHAN, PW_AST_DST_CTX, PW_AST_DURATION, PW_AST_END_TIME, PW_AST_LAST_APP, PW_AST_LAST_DATA, PW_AST_SRC, PW_AST_START_TIME, PW_AST_UNIQUE_ID, PW_AST_USER_FIELD, RADIUS_FLAG_LOGUNIQUEID, RADIUS_FLAG_LOGUSERFIELD, RADIUS_FLAG_USEGMTIME, rh, ast_cdr::src, ast_cdr::start, ast_cdr::uniqueid, ast_cdr::userfield, and VENDOR_CODE.

Referenced by radius_log().

◆ load_module()

static int load_module ( void )

static

Definition at line 246 of file cdr_radius.c.

{
    struct ast_config *cfg;
    struct ast_flags config_flags = { 0 };
    const char *tmp;
 
    if ((cfg = ast_config_load(cdr_config, config_flags)) && cfg != CONFIG_STATUS_FILEINVALID) {
        ast_set2_flag(&global_flags, ast_true(ast_variable_retrieve(cfg, "radius", "usegmtime")), RADIUS_FLAG_USEGMTIME);
        ast_set2_flag(&global_flags, ast_true(ast_variable_retrieve(cfg, "radius", "loguniqueid")), RADIUS_FLAG_LOGUNIQUEID);
        ast_set2_flag(&global_flags, ast_true(ast_variable_retrieve(cfg, "radius", "loguserfield")), RADIUS_FLAG_LOGUSERFIELD);
        if ((tmp = ast_variable_retrieve(cfg, "radius", "radiuscfg")))
            ast_copy_string(radiuscfg, tmp, sizeof(radiuscfg));
        ast_config_destroy(cfg);
    } else
        return AST_MODULE_LOAD_DECLINE;
 
    /* read radiusclient-ng config file */
    if (!(rh = rc_read_config(radiuscfg))) {
        ast_log(LOG_NOTICE, "Cannot load radiusclient-ng configuration file %s.\n", radiuscfg);
        return AST_MODULE_LOAD_DECLINE;
    }
 
    /* read radiusclient-ng dictionaries */
    if (rc_read_dictionary(rh, rc_conf_str(rh, "dictionary"))) {
        ast_log(LOG_NOTICE, "Cannot load radiusclient-ng dictionary file.\n");
        rc_destroy(rh);
        rh = NULL;
        return AST_MODULE_LOAD_DECLINE;
    }
 
    if (ast_cdr_register(name, desc, radius_log)) {
        rc_destroy(rh);
        rh = NULL;
        return AST_MODULE_LOAD_DECLINE;
    } else {
        return AST_MODULE_LOAD_SUCCESS;
    }
}

References ast_cdr_register(), ast_config_destroy(), ast_config_load, ast_copy_string(), ast_log, AST_MODULE_LOAD_DECLINE, AST_MODULE_LOAD_SUCCESS, ast_set2_flag, ast_true(), ast_variable_retrieve(), cdr_config, CONFIG_STATUS_FILEINVALID, desc, global_flags, LOG_NOTICE, name, NULL, RADIUS_FLAG_LOGUNIQUEID, RADIUS_FLAG_LOGUSERFIELD, RADIUS_FLAG_USEGMTIME, radius_log(), radiuscfg, and rh.

◆ radius_log()

static int radius_log ( struct ast_cdr * cdr )

static

Definition at line 210 of file cdr_radius.c.

{
    int result = ERROR_RC;
    VALUE_PAIR *tosend = NULL;
 
    if (build_radius_record(&tosend, cdr)) {
        ast_debug(1, "Unable to create RADIUS record. CDR not recorded!\n");
        goto return_cleanup;
    }
 
    result = rc_acct(rh, 0, tosend);
    if (result != OK_RC) {
        ast_log(LOG_ERROR, "Failed to record Radius CDR record!\n");
    }
 
return_cleanup:
    if (tosend) {
        rc_avpair_free(tosend);
    }
 
    return result;
}

References ast_debug, ast_log, build_radius_record(), LOG_ERROR, NULL, result, and rh.

Referenced by load_module().

◆ unload_module()

static int unload_module ( void )

static

Definition at line 233 of file cdr_radius.c.

{
    if (ast_cdr_unregister(name)) {
        return -1;
    }
 
    if (rh) {
        rc_destroy(rh);
        rh = NULL;
    }
    return 0;
}

References ast_cdr_unregister(), name, NULL, and rh.

Variable Documentation

◆ __mod_info

struct ast_module_info __mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_LOAD_ORDER, .description = "RADIUS CDR Backend", .key = ASTERISK_GPL_KEY, .buildopt_sum = AST_BUILDOPT_SUM, .support_level = AST_MODULE_SUPPORT_EXTENDED, .load = load_module, .unload = unload_module, .load_pri = AST_MODPRI_CDR_DRIVER, .requires = "cdr", }

static

Definition at line 291 of file cdr_radius.c.

◆ ast_module_info

const struct ast_module_info* ast_module_info = &__mod_info

static

Definition at line 291 of file cdr_radius.c.

◆ cdr_config

const char cdr_config[] = "cdr.conf"

static

Definition at line 86 of file cdr_radius.c.

Referenced by load_module(), and module_config_alloc().

◆ desc

const char desc[] = "RADIUS CDR Backend"

static

Definition at line 84 of file cdr_radius.c.

Referenced by acf_retrieve_docs(), ast_cdr_modifier_register(), ast_cdr_register(), ast_netsock_set_qos(), ast_rtp_instance_set_qos(), ast_rtp_qos_set(), ast_set_qos(), ast_tcptls_client_create(), ast_tcptls_client_start_timeout(), ast_tcptls_server_root(), ast_tcptls_server_start(), ast_tcptls_server_stop(), au_rewrite(), au_seek(), au_tell(), cdr_generic_register(), check_header(), connect_to_host(), dump_cause(), handle_cli_ulimit(), iax_firmware_append(), idle_sched_init_pj_thread(), init_acf_query(), keepalive_transport_thread(), load_module(), ogg_vorbis_open(), ogg_vorbis_read(), ogg_vorbis_seek(), ogg_vorbis_tell(), print_file(), read_some(), setnonblocking(), sip_thread_start(), str2desc(), update_header(), write_amap(), write_buf(), write_header(), and xmpp_client_set_presence().

◆ global_flags

struct ast_flags global_flags = { RADIUS_FLAG_USEGMTIME | RADIUS_FLAG_LOGUNIQUEID | RADIUS_FLAG_LOGUSERFIELD }

static

Definition at line 94 of file cdr_radius.c.

94{ RADIUS_FLAG_USEGMTIME | RADIUS_FLAG_LOGUNIQUEID | RADIUS_FLAG_LOGUSERFIELD };

Referenced by build_radius_record(), and load_module().

◆ name

const char name[] = "radius"

static

Definition at line 85 of file cdr_radius.c.

Referenced by load_module(), and unload_module().

◆ radiuscfg

char radiuscfg[PATH_MAX] = "/etc/radiusclient-ng/radiusclient.conf"

static

Definition at line 91 of file cdr_radius.c.

Referenced by load_module().

◆ rh

rc_handle* rh = NULL

static

Definition at line 96 of file cdr_radius.c.

Referenced by build_radius_record(), handle_registrations(), load_module(), radius_log(), and unload_module().

Macros

Enumerations

Functions

Variables

Detailed Description

Macro Definition Documentation

◆ DATE_FORMAT

◆ VENDOR_CODE

Enumeration Type Documentation

◆ anonymous enum

◆ anonymous enum

Function Documentation

◆ __reg_module()

◆ __unreg_module()

◆ AST_MODULE_SELF_SYM()

◆ build_radius_record()

◆ load_module()

◆ radius_log()

◆ unload_module()

Variable Documentation

◆ __mod_info

◆ ast_module_info

◆ cdr_config

◆ desc

◆ global_flags

◆ name

◆ radiuscfg

◆ rh