# avp Module

Juha
Heinanen
jh@tutpro.com
2004
Juha Heinanen
$Revision: 1.1.2.1 $
$Date: 2005/06/22 23:16:51 $

## User's Guide

### Overview

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 "name:value" or of form "name#value". In the first case, value is interpreted as a string and in the second case as an int (second case has not been implemented yet).

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.

### Dependencies

None.

### Exported Parameters

#### `radius_config` (string)

This is the location of the configuration file of radius client libraries.

Default value is "/usr/local/etc/radiusclient/radiusclient.conf".

##### radius_config parameter usage

    modparam("avp_radius", "radius_config", "/etc/radiusclient.conf")

#### `caller_service_type` (integer)

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.

##### radius_config parameter usage

    modparam("avp_radius", "caller_service_type", 18)

### Exported Functions

#### `avp_load_radius(user)`

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", "callee", and "digest".

In "caller" case, attributes belong to the user of the From URI, in "callee" case, to the user of the Request URI, and, in "digest" case, to the authenticated user.

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

##### `avp_load_radius` usage

    ...
    avp_load_radius("callee")
    ...