uri_radius Module

Juha Heinanen

   Song Networks

Edited by

Juha Heinanen

   Copyright © 2003 Juha Heinanen
     __________________________________________________________

   Table of Contents
   1. User's Guide

        1.1. Overview
        1.2. Dependencies

              1.2.1. OpenSER Modules
              1.2.2. External Libraries or Applications

        1.3. Exported Parameters

              1.3.1. radius_config (string)
              1.3.2. service_type (integer)

        1.4. Exported Functions

              1.4.1. radius_does_uri_exist()

   2. Developer's Guide
   3. Frequently Asked Questions

   List of Examples
   1-1. Set param_name parameter
   1-2. Set param_name parameter
   1-3. radius_does_uri_exist usage
     __________________________________________________________

Chapter 1. User's Guide

1.1. Overview

   URI check using Radius server.
     __________________________________________________________

1.2. Dependencies

1.2.1. OpenSER 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 OpenSER with this module loaded:

     * radiusclient-ng 0.5.0 or higher -- library and development
       files. See
       http://developer.berlios.de/projects/radiusclient-ng/.
     __________________________________________________________

1.3. Exported Parameters

1.3.1. radius_config (string)

   Radiusclient configuration file.

   Default value is
   "/opt/etc/radiusclient-ng/radiusclient.conf".

   Example 1-1. Set param_name parameter
...
modparam("uri_radius", "radius_config", "/etc/radiusclient.conf")
...
     __________________________________________________________

1.3.2. service_type (integer)

   Radius service type used in radius_does_uri_exist check.

   Default value is 10 (Call-Check).

   Example 1-2. Set param_name parameter
...
modparam("uri_radius", "service_type", 11)
...
     __________________________________________________________

1.4. Exported Functions

1.4.1. radius_does_uri_exist()

   Checks from Radius if user@host in Request-URI is a local user.
   Can be used to decide if 404 or 480 should be returned after
   lookup has failed. Adds SIP-AVP reply items, that must have a
   string value of form "name:value", as AVPs.

   This function can be used from REQUEST_ROUTE.

   Example 1-3. radius_does_uri_exist usage
...
if (radius_does_uri_exist()) {
        ...
};
...
     __________________________________________________________

Chapter 2. Developer's Guide

   The module does not provide any API to use in other OpenSER
   modules.
     __________________________________________________________

Chapter 3. Frequently Asked Questions

   3.1. Where can I find more about OpenSER?
   3.2. Where can I post a question about this module?
   3.3. How can I report a bug?

   3.1. Where can I find more about OpenSER?

   Take a look at http://www.openser.org/.

   3.2. Where can I post a question about this module?

   First at all check if your question was already answered on one
   of our mailing lists:

     * User Mailing List -
       http://lists.openser.org/cgi-bin/mailman/listinfo/users
     * Developer Mailing List -
       http://lists.openser.org/cgi-bin/mailman/listinfo/devel

   E-mails regarding any stable OpenSER release should be sent to
   <users@lists.openser.org> and e-mails regarding development
   versions should be sent to <devel@lists.openser.org>.

   If you want to keep the mail private, send it to
   <team@lists.openser.org>.

   3.3. How can I report a bug?

   Please follow the guidelines provided at:
   http://sourceforge.net/tracker/?group_id=139143.
