group_radius Module

Juha Heinanen

Song Networks

Jan Janak


Edited by

Jan Janak

Revision History
Revision $Revision: 4473 $$Date: 2008-07-11 23:16:22 +0200 (Fri, 11 Jul 2008) $

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. radius_config (string)
1.3.2. use_domain (integer)
1.4. Exported Functions
1.4.1. radius_is_user_in(URI, group)

List of Examples

1.1. Set radius_config parameter
1.2. Set use_domain parameter
1.3. radius_is_user_in usage

Chapter 1. Admin Guide

1.1. Overview

This module export functions necessary for group membership checking over radius. There is a database table that contains list of users and groups they belong to. The table is used by functions of this module.

1.2. Dependencies

1.2.1. OpenSIPS Modules

The module depends on the following modules (in the other words the listed modules must be loaded before this module):

  • none

1.2.2. External Libraries or Applications

The following libraries or applications must be installed before compilling OpenSIPS with this module loaded:

1.3. Exported Parameters

1.3.1. radius_config (string)

Location of the configuration file of the radius client library.

Default value is “/usr/local/etc/radiusclient-ng/radiusclient.conf”.

Example 1.1. Set radius_config parameter

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

1.3.2. use_domain (integer)

If set to 1 then username@domain will be used for lookup, if set to 0 then only username will be used.

Default value is 0 (no).

Example 1.2. Set use_domain parameter

modparam("group_radius", "use_domain", 1)

1.4. Exported Functions

1.4.1.  radius_is_user_in(URI, group)

The function returns true if username in the given URI is member of the given group and false if not.

Meaning of the parameters is as follows:

  • URI - URI whose username and optionally domain to be used, this can be one of:

    • Request-URI - Use Request-URI username and (optionally) domain.

    • To - Use To username and (optionally) domain.

    • From - Use From username and (optionally) domain.

    • Credentials - Use digest credentials username.

  • group - Name of the group to check.

This function can be used from REQUEST_ROUTE.

Example 1.3. radius_is_user_in usage

if (radius_is_user_in("Request-URI", "ld")) {