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 paramter (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")
...
				

Contains a multiple definition of credentials used to perform authentication.

This parameter is required if UAC authentication is used.

...
modparam("uac","credential","username:domain:password")
...
				

The definition of an AVP that might contain the realm to be used to perform authentication.

If you define it, you also need to define “auth_username_avp” (Section 1.3.7, “auth_username_avp (string)”) and “auth_username_avp” (Section 1.3.8, “auth_password_avp (string)”).

...
modparam("uac","auth_realm_avp","$avp(i:10)")
...
				

The definition of an AVP that might contain the username to be used to perform authentication.

If you define it, you also need to define “auth_realm_avp” (Section 1.3.6, “auth_realm_avp (string)”) and “auth_username_avp” (Section 1.3.8, “auth_password_avp (string)”).

...
modparam("uac","auth_username_avp","$avp(i:11)")
...
				

The definition of an AVP that might contain the password to be used to perform authentication.

If you define it, you also need to define “auth_password_avp” (Section 1.3.8, “auth_password_avp (string)”) and “auth_username_avp” (Section 1.3.8, “auth_password_avp (string)”).

...
modparam("uac","auth_password_avp","$avp(i:12)")
...
				

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

display and URI parameters can include pseudo-variables.

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(s:display)","$avp(s: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 in FROM/TO header the URI part without altering the display name.

URI parameter can include pseudo-variables.

This function can be used from REQUEST_ROUTE.

...
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.

This function can be used from FAILURE_ROUTE.

...
uac_auth();
...