AAA RADIUS MODULE

Irina-Maria Stanescu

OpenSIPS Solutions>

Edited by

Irina-Maria Stanescu

Revision History
Revision $Revision: 5908 $$Date$

Table of Contents

1. Admin Guide
1.1. Overview
1.2. Dependencies
1.2.1. OpenSIPS Modules
1.2.2. External Libraries or Applications
1.3. Exported Parameters
1.3.1. sets
1.3.2. radius_config
1.3.3. syslog_name
1.4. Exported Functions
1.4.1. radius_send_auth(input_set_name,output_set_name)
1.4.2. radius_send_acct(input_set_name)

List of Examples

1.1. Set sets parameter
1.2. Set radius_config parameter
1.3. Set syslog_name parameter
1.4. radius_send_auth usage
1.5. radius_send_acct usage

Chapter 1. Admin Guide

1.1. 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.

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

1.2. Dependencies

1.2.1. OpenSIPS Modules

None.

1.2.2. External Libraries or Applications

One of the following libraries must be installed before running OpenSIPS with this module loaded:

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

1.3. Exported Parameters

1.3.1. sets

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.

Example 1.1. 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)) ")
...


1.3.2. radius_config

Radiusclient configuration file.

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

Example 1.2. Set radius_config parameter


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


1.3.3. syslog_name

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).

Example 1.3. Set syslog_name parameter

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

1.4. Exported Functions

1.4.1.  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.

Example 1.4. 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;
}
...

		

1.4.2.  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.

Example 1.5. radius_send_acct usage

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