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 Kamailio with this module loaded:

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

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)

Semi-colon separated list of extra RADIUS attribute name=pseudo variable pairs. When radius_www_authorize() or radius_proxy_authorize() function is called, listed extra attributes are included in RADIUS request with current values of corresponding pseudo variables.

There is no default value, i.e., by default no extra attributes are included.

modparam("auth_radius", "auth_extra", "Acct-Session-Id=$ci")

When this parameter is set to the value other than "-1" and the request being authenticated has flag with matching number set via setflag() function, use Request URI instead of uri parameter value from the Authorization / Proxy-Authorization header field to perform RADIUS authentication. This is intended to provide workaround for misbehaving NAT / routers / ALGs that alter request in the transit, breaking authentication. At the time of this writing, certain versions of Linksys WRT54GL are known to do that.

Default value is “-1”.

modparam("auth_radius", "use_ruri_flag", 22)

If set to 1, all RADIUS AVPs returned by RADIUS server are stored in Kamailio AVPs list. If set to 0, only the SIP_AVP type of RADIUS AVPs are stored in Kamailio AVPs list.

Default value is 0.

modparam("auth_radius", "radius_avps_mode", 1)

If set to 1, the username passed to the RADIUS server will have the digest realm appended to it, if no domain is provided in the digest username.

Default value is 1.

modparam("auth_radius", "append_realm_to_username", 0)

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, it fails and assigns a WWW-Authorize header containing a new challenge to digest_challenge AVP (see modules/auth). The script should then respond with 401 that includes this header, which will challenge the user again.

Negative result codes may be interpreted as follows:

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

Meaning of the parameter is as follows:

This function can be used from REQUEST_ROUTE.

...
    if (!radius_www_authorize("$td")) {
        switch ($rc) {
        case -7:
	    send_reply("500", "Server Internal Error");
	    exit;
        case -1:
	    send_reply("400", "Bad Request");
	    exit;
        default:
        };
        if (defined($avp(digest_challenge)) &&
                ($avp(digest_challenge) != "")) {
            append_to_reply("$avp(digest_challenge)");
        };
        send_reply("401", "Unauthorized");
        exit;
    };
...

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, it fails and assigns a Proxy-Authorize header containing a new challenge to digest_challenge AVP. The script should then respond with 407 that includes this header, which will challenge the user again. For negative result codes, see the above function.

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

Meaning of the parameters is as follows:

This function can be used from REQUEST_ROUTE.

...
    if (!radius_proxy_authorize("$pd", "$pU")) { # Realm and URI user are taken
        switch ($rc) {                           # from P-Preferred-Identity
        case -7:                                 # header field
	    send_reply("500", "Server Internal Error");
	    exit;
        case -1:
	    send_reply("400", "Bad Request");
	    exit;
        default:
        };
        if (defined($avp(digest_challenge)) &&
                ($avp(digest_challenge) != "")) {
            append_to_reply("$avp(digest_challenge)");
        };
        send_reply("407", "Proxy Authentication Required");
        exit;
    };
...