# &adminguide;

## Overview

This module provides a Radius implementation for the AAA API from the core.

It also provides two functions to be used from the script for generating custom Radius acct and auth requests. Detection and handling of SIP-AVPs from Radius replies is automatically and transparently done by the module.

Since version 2.2, aaa_radius module supports asynchronous operations. But in order to use them, one must apply the patch contained by the modules/aaa_radius folder, called radius_async_support.patch.In order to do this, you must have freeradius-client sources. In order to do this you can follow the tutorial in the end of the documentation.

Any module that wishes to use it has to do the following:

- include aaa.h

- make a bind call with a proper radius specific url

## Dependencies

### &osips; Modules

None.

### External Libraries or Applications

One of the following libraries must be installed before running &osips; with this module loaded:

- radiusclient-ng 0.5.0 or higher See http://developer.berlios.de/projects/radiusclient-ng/.

- freeradius-client See http://freeradius.org/.

By default, radiusclient-ng is used. To change at compile time to freeradius, uncomment the USE_FREERADIUS=1 line in main Makefile.

## Exported Parameters

### `sets (string)`

Sets of Radius AVPs to be used when building custom RADIUS requests (set of input RADIUS AVPs) or when fetching data from the RADIUS reply (set of output RADIUS AVPs).

The format for a set definition is the following:

- " set_name = ( attribute_name1 = var1 [, attribute_name2 = var2 ]* ) "

The left-hand side of the assignment must be an attribute name known by the RADIUS dictionary.

The right-hand side of the assignment must be a script pseudo variable or a script AVP. For more information about them see CookBooks - Scripting Variables.

#### Set `sets` parameter

    ...
    modparam("aaa_radius","sets","set4  =  (  Sip-User-ID  =   $avp(10)
    			,   Sip-From-Tag=$si,Sip-To-Tag=$tt      )      ")
    ...

    ...
    modparam("aaa_radius","sets","set1 = (User-Name=$var(usr), Sip-Group = $var(grp),
    			Service-Type = $var(type)) ")
    ...

    ...
    modparam("aaa_radius","sets","set2 = (Sip-Group = $var(sipgrup)) ")
    ...

### `radius_config (string)`

Radiusclient configuration file.

This parameter is optional. It must be set only if the radius_send_acct and radius_send_auth functions are used.

#### Set `radius_config` parameter

    ...
    modparam("aaa_radius", "radius_config", "/etc/radiusclient-ng/radiusclient.conf")
    ...

### `syslog_name (string)`

Enable logging of the client library to syslog, using the given log name.

This parameter is optional. Radius client libraries will try to use syslog to report errors (such as problems with dictionaries) with the given ident string .If this parameter is set, then these errors are visible in syslog. Otherwise errors are hidden.

By default this parameter is not set (no logging).

#### Set `syslog_name` parameter

    ...
    modparam("aaa_radius", "syslog_name", "aaa-radius")
    ...

### `fetch_all_values (integer)`

For the output sets, this parameter controls if all the values (for the same RADIUS AVP) should be returned (otherwise only the first value will be returned). When enabling this options, be sure that the variable you use to get the RADIUS output can store multiple values (like the AVP variables).

By default this parameter is disabled (set to 0) for backward compatibility reasons.

#### Set `fetch_all_values` parameter

    ...
    modparam("aaa_radius", "fetch_all_values", 1)
    ...

## Exported Functions

### `radius_send_auth(input_set_name, output_set_name)`

This function can be used from the script to make custom radius authentication request. The function takes two parameters.

The first parameter represents the name of the set that contains the list of attributes and pvars that will form the authentication request (see the sets module parameter).

The second parameter represents the name of the set that contains the list of attributes and pvars that will be extracted form the authentication reply (see the sets module parameter).

The sets must be defined using the sets exported parameter.

The function return TRUE (retcode 1) if authentication was successful, FALSE (retcode -1) if an error (any kind of error) occured during authentication processes or FALSE (retcode -2) if authentication was rejected or denied by RADIUS server.

This function can be used from REQUEST_ROUTE, FAILURE_ROUTE, ONREPLY_ROUTE, BRANCH_ROUTE, ERROR_ROUTE and LOCAL_ROUTE.

#### `radius_send_auth` usage

    ...
    radius_send_auth("set1","set2");
    switch ($rc) {
    	case 1:
    		xlog("authentication ok \n");
    		break;
    	case -1:
    		xlog("error during authentication\n");
    		break;
    	case -2:
    		xlog("authentication denied \n");
    		break;
    }
    ...

### `radius_send_acct(input_set_name)`

This function can be used from the script to make custom radius authentication request. The function takes only one parameter that represents the name of the set that contains the list of attributes and pvars that will form the accounting request.

Only one set is needed as a parameter because no AVPs can be extracted from the accounting replies.

The set must be defined using the "sets" exported parameter.

This function can be used from REQUEST_ROUTE, FAILURE_ROUTE, ONREPLY_ROUTE, BRANCH_ROUTE, ERROR_ROUTE and LOCAL_ROUTE.

#### `radius_send_acct` usage

    ...
    radius_send_acct("set1");
    ...

## Exported Async Functions

### `radius_send_auth(input_set_name, output_set_name)`

This function can be used from the script to make custom radius authentication request. The function takes two parameters.

The first parameter represents the name of the set that contains the list of attributes and pvars that will form the authentication request (see the sets module parameter).

The second parameter represents the name of the set that contains the list of attributes and pvars that will be extracted form the authentication reply (see the sets module parameter).

The sets must be defined using the sets exported parameter.

The function return TRUE (retcode 1) if authentication was successful, FALSE (retcode -1) if an error (any kind of error) occured during authentication processes or FALSE (retcode -2) if authentication was rejected or denied by RADIUS server.

#### `radius_send_auth` usage

    ...
    {
    async( radius_send_auth("set1","set2"), resume);
    }

    route[resume] {
    switch ($rc) {
    	case 1:
    		xlog("authentication ok \n");
    		break;
    	case -1:
    		xlog("error during authentication\n");
    		break;
    	case -2:
    		xlog("authentication denied \n");
    		break;
    }
    ...

### `radius_send_acct(input_set_name)`

This function can be used from the script to make custom radius authentication request. The function takes only one parameter that represents the name of the set that contains the list of attributes and pvars that will form the accounting request.

Only one set is needed as a parameter because no AVPs can be extracted from the accounting replies.

The set must be defined using the "sets" exported parameter.

This function can be used from REQUEST_ROUTE, FAILURE_ROUTE, ONREPLY_ROUTE, BRANCH_ROUTE, ERROR_ROUTE and LOCAL_ROUTE.

#### `radius_send_acct` usage

    ...
    {
    async( radius_send_acct("set1","set2"), resume);
    }

    route[resume] {
    xlog(" accounting finished\n");
    }

    ...