UAC Module

The following modules must be loaded before this module:

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

There are 3 mode of restoring the original headers (FROM/TO) URI:

This parameter is optional, it's default value being “auto”.

...
modparam("uac","restore_mode","auto")
...
				

String password to be used to encrypt the RR storing parameter (when replacing the TO/FROM headers). If empty, no encryption will be used.

Default value of this parameter is empty.

...
modparam("uac","restore_passwd","my_secret_passwd")
...
				

Name of Record-Route header parameter that will be used to store (encoded) the original FROM URI.

This parameter is optional, it's default value being “vsf”.

...
modparam("uac","rr_from_store_param","my_Fparam")
...
				

Name of Record-Route header parameter that will be used to store (encoded) the original TO URI.

This parameter is optional, it's default value being “vst”.

...
modparam("uac","rr_to_store_param","my_Tparam")
...
				

Force create dialog if it is not created from the configuration script.

Default value is no.

...
modparam("uac", "force_dialog", yes)
...
				

Replace in FROM/TO header the display name or/and the URI part.

Both parameters are string. The display is optional. If missing, only the URI will be changed in the message.

IMPORTANT: calling the function more than once per branch will lead to inconsistent changes over the request.Be sure you do the change only ONCE per branch. Note that calling the function from REQUEST ROUTE affects all the branches!, so no other change will be possible in the future. For per branch changes use BRANCH and FAILURE route.

This function can be used from REQUEST_ROUTE, BRANCH_ROUTE and FAILURE_ROUTE.

...
# replace both display and uri
uac_replace_from($avp(display),$avp(uri));
# replace only display and do not touch uri
uac_replace_from("batman","");
# remove display and replace uri
uac_replace_from("","sip:robin@gotham.org");
# remove display and do not touch uri
uac_replace_from("","");
# replace the URI without touching the display
uac_replace_from( , "sip:batman@gotham.org");
...
				

This function will check if the FROM/TO URI was modified and will use the information stored in header parameter to restore the original FROM/TO URI value.

NOTE - this function should be used only if you configured MANUAL restoring of the headers (see restore_mode param). For AUTO and NONE, there is no need to use this function.

This function can be used from REQUEST_ROUTE.

...
uac_restore_from();
...
				

This function can be called only from failure route and will build the authentication response header and insert it into the request without sending anything. Credentials for buiding the authentication response will be taken from the list of credentials provided by the uac_auth module (static or via AVPs).

As optional parameter, the function may receive a list of auth algorithms to be considered / supported during authentication:

Note that the CSeq is automatically increased during authentication.

This function can be used from FAILURE_ROUTE.

NOTE: when used without dialog support, the uac_auth() function cannot be used for authenticating in-dialog requests, as there is no mechanism to store the CSeq changes that are required for ensuring the correctness of the dialog. The only exception are BYE messages, which are the last messages within a call, hence no further adjustments are needed. The function can still be used for authenticating the initial INVITE though.

...
uac_auth();
...
failure_route[check_auth] {
    ...
    if ($T_reply_code==407) {
        if (uac_auth("MD5,MD5-sess")) {
            # auth is succesful, just relay
            t_relay();
            exit;
        }
        # auth failed (no credentials maybe)
        # so continue handling the 407 reply
    }
    ...
}
...
				

This function can be called to increase the CSeq of an ongoing request.

It receives as the cseq parameter the value that the CSeq should be incremented with.

This function can be used from REQUEST_ROUTE, BRANCH_ROUTE and FAILURE_ROUTE.

...
uac_inc_cseq(1);
...