Copyright © 2005-2009 Voice Sistem
| Revision History | |
|---|---|
| Revision $Revision: 8806 $ | $Date: 2012-03-21 12:05:34 +0100 (Wed, 21 Mar 2012) $ |
Table of Contents
List of Examples
restore_mode parameter
restore_passwd parameterrr_from_store_param parameterrr_to_store_param parameterauth_realm_avp parameterauth_username_avp parameterauth_password_avp parameterforce_dialog parameteruac_replace_from/uac_replace_to usageuac_replace_from/uac_replace_to usageuac_restore_from/uac_restore_to usageuac_auth usageUAC (User Agent Client) module provides some basic UAC functionalities like FROM / TO header manipulation (anonymization) or client authentication.
If the dialog module is loaded and a dialog can be created, then the auto mode can be done more efficiently.
Known limitations in this version:
authentication does not support qop auth-int, just qop auth;
CSeq not increased during authentication - the response may be rejected.
The following modules must be loaded before this module:
TM - Transaction Module.
RR - Record-Route Module, but only if restore mode for FROM URI is set to “auto”.
UAC_AUTH - UAC Authentication Module.
Dialog Module, if “force_dialog” module parameter is enabled, or a dialog is created from the configuration script.
There are 3 mode of restoring the original headers (FROM/TO) URI:
“none” - no information about original URI is stored; restoretion is not possible.
“manual” - all following replies will be restored, but not also the sequential requests - this must be manually updated based on original URI.
“auto” - all sequential requests and replies will be automatically updated based on stored original URI.
This parameter is optional, it's default value being “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.
Example 1.2. Set restore_passwd parameter
...
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”.
Example 1.3. Set rr_from_store_param parameter
...
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”.
Example 1.4. Set rr_to_store_param parameter
...
modparam("uac","rr_to_store_param","my_Tparam")
...
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.6, “auth_username_avp (string)”) and
“auth_username_avp”
(Section 1.3.7, “auth_password_avp (string)”).
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.5, “auth_realm_avp (string)”) and
“auth_username_avp”
(Section 1.3.7, “auth_password_avp (string)”).
The definition of an AVP that might contain the password to be used to perform authentication. The password can be provided as a plain text password or as a precalculated HA1 as a hexa (lower case) string (of 32 chars) prefixed with "0x" (so a total of 34 chars) (for example "0xc17ba8157756f263d07e158504204629")
If you define it, you also need to define
“auth_password_avp”
(Section 1.3.7, “auth_password_avp (string)”) and
“auth_username_avp”
(Section 1.3.7, “auth_password_avp (string)”).
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.
Example 1.9. uac_replace_from/uac_replace_to usage
...
# 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 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.
Example 1.10. uac_replace_from/uac_replace_to usage
...
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.
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 AVPs first (if AVPs are defined and populated) and then from the list of credentials provided by the uac_auth module.
This function can be used from FAILURE_ROUTE.