1.3.1. OpenSER Modules

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

• auth -- Generic authentication functions

1.3.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.4.1. radius_config (string)

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

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

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

1.4.2. service_type (integer)

This is the value of the Service-Type radius attribute to be used. The default should be fine for most people. See your radius client include files for numbers to be put in this parameter if you need to change it.

Default value is "15".

modparam("auth_radius", "service_type", 15)
		

1.5.1. radius_www_authorize(realm)

The function verifies credentials according to RFC2617. If the credentials are verified successfully then the function will succeed and mark the credentials as authorized (marked credentials can be later used by some other functions). If the function was unable to verify the credentials for some reason then it will fail and the script should call www_challenge which will challenge the user again.

Negative codes may be interpreted as follows:

• -5 (generic error) - some generic error occurred and no reply was sent out;

• -4 (no credentials) - credentials were not found in request;

• -3 (stale nonce) - stale nonce;

This function will, in fact, perform sanity checks over the received credentials and then pass them along to the radius server which will verify the credentials and return whether they are valid or not.

Meaning of the parameter is as follows:

• realm - Realm is a opaque string that the user agent should present to the user so he can decide what username and password to use. Usually this is domain of the host the server is running on.

  If an empty string "" is used then the server will generate it from the request. In case of REGISTER requests To header field domain will be used (because this header field represents a user being registered), for all other messages From header field domain will be used.

  The string may contain pseudo variables.

This function can be used from REQUEST_ROUTE.

...
if (!radius_www_authorize("siphub.net")) {
	www_challenge("siphub.net", "1");
};
...

1.5.2. radius_proxy_authorize(realm [, uri_user])

The function verifies credentials according to RFC2617. If the credentials are verified successfully then the function will succeed and mark the credentials as authorized (marked credentials can be later used by some other functions). If the function was unable to verify the credentials for some reason then it will fail and the script should call proxy_challenge which will challenge the user again. For more about the negative return codes, see the above function.

This function will, in fact, perform sanity checks over the received credentials and then pass them along to the radius server which will verify the credentials and return whether they are valid or not.

Meaning of the parameters is as follows:

• realm - Realm is a opaque string that the user agent should present to the user so he can decide what username and password to use. This is usually one of the domains the proxy is responsible for. If an empty string "" is used then the server will generate realm from host part of From header field URI.

  The string may contain pseudo variables.

• uri_user - Uri_user is an optional pseudo variable parameter whose value, if present, will be given to Radius server as value of SIP-URI-User check item. If uri_user pseudo variable parameter is not present, the server will generate SIP-URI-User check item value from user part of To/From URI.

This function can be used from REQUEST_ROUTE.

...
if (!radius_proxy_authorize("")) {   # Realm and URI user will be autogenerated
	proxy_challenge("", "1");
};
...
if (!radius_proxy_authorize("$pd", "$pU")) { # Realm and URI user are taken
	proxy_challenge("$pd", "1");         # from P-Preferred-Identity
};                                           # header field
...