Copyright © 2004 Juha Heinanen
|Revision $Revision: 3898 $||$Date: 2008-03-08 00:03:56 +0100 (Sat, 08 Mar 2008) $|
Table of Contents
List of Examples
avp_radius module allows loading of user's attributes into AVPs from Radius. User's name and domain can be based on From URI, Request URI, or authenticated credentials.
The module assumes that Radius returns the AVPs as values of reply attribute SIP-AVP. Its value must be a string of form:
value = SIP_AVP_NAME SIP_AVP_VALUE
SIP_AVP_NAME = STRING_NAME | '#'ID_NUMBER
SIP_AVP_VALUE = ':'STRING_VALUE | '#'NUMBER_VALUE
Example 1.1. “SIP-AVP” RADIUS AVP exmaples
.... "email:email@example.com" -> STRING NAME AVP (email) with STRING VALUE (firstname.lastname@example.org) "#14:email@example.com" -> ID AVP (14) with STRING VALUE (firstname.lastname@example.org) "age#28" -> STRING NAME AVP (age) with INTEGER VALUE (28) "#14#28" -> ID AVP (14) with INTEGER VALUE (28) ....
For AVP with STRING NAME, the module prefixes each attribute name as returned from Radius by string “caller_” or “callee_” depending if caller's or callee's attributes are loaded.
The module depends on the following modules (in the other words the listed modules must be loaded before this module):
The following libraries or applications must be installed before compilling OpenSIPS with this module loaded:
radiusclient-ng 0.5.0 or higher -- library and development files. See http://developer.berlios.de/projects/radiusclient-ng/.
This is the location of the configuration file of radius client libraries.
Default value is “/usr/local/etc/radiusclient-ng/radiusclient.conf”.
radius_config parameter usage
modparam("avp_radius", "radius_config", "/etc/radiusclient.conf")
This is the value of the Service-Type radius attribute to be used, when caller's attributes are loaded.
Default value is dictionary value of “SIP-Caller-AVPs” Service-Type.
This is the value of the Service-Type radius attribute to be used, when callee's attributes are loaded.
Default value is dictionary value of “SIP-Callee-AVPs” Service-Type.
The functions loads user's attributes from radius and stores them into AVPs. Parameter “user” is used to indicate, whose attributes are loaded. Possible values are:
caller - attributes belong to the user of the From URI are loaded
callee - attributes belong to the user of the Request URI are loaded
digest - attributes belong to the authenticated user are loaded
AVP name returned from Radius is prefixed by string “caller_”, if avp_load_radius parameter is “caller” or “digest”, and by “callee_”, if parameter is “callee”.
This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.