$Revision: 716 $
$Date: 2006-03-03 20:36:48 +0200 (Fri, 03 Mar 2006) $
User's Guide
Overview
UAC (User Agent Client) module provides some basic UAC
functionalities like FROM header manipulation (anonymization)
or client authentication.
Known limitations in this version:
authentication does not support qop;
CSeq not increased during authentication - the response
may be rejected.
Dependencies
&ser; Modules
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
.
External Libraries or Applications
The following libraries or applications must be installed
before running &ser; with this module loaded:
None
Exported Parameters
<varname>rr_store_param</varname> (string)
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
.
Set <varname>rr_store_param</varname> parameter
...
modparam("uac","rr_store_param","my_param")
...
<varname>from_restore_mode</varname> (string)
There are 3 mode of restoring the original FROM 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
.
Set <varname>from_restore_mode</varname> parameter
...
modparam("uac","from_restore_mode","auto")
...
<varname>from_passwd</varname> (string)
String password to be used to encrypt the RR storing paramter. If
empty, no encryption will be used.
Default value of this parameter is empty.
Set <varname>from_passwd</varname> parameter
...
modparam("uac","from_passwd","my_secret_passwd")
...
<varname>credential</varname> (string)
Contains a multiple definition of credentials used to perform
authentication.
This parameter is required if UAC authentication is used.
Set <varname>credential</varname> parameter
...
modparam("uac","credential","username:domain:password")
...
<varname>auth_realm_avp</varname> (string)
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
() and
auth_username_avp
().
Set <varname>auth_realm_avp</varname> parameter
...
modparam("uac","auth_realm_avp","$avp(i:10)")
...
<varname>auth_username_avp</varname> (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
() and
auth_username_avp
().
Set <varname>auth_username_avp</varname> parameter
...
modparam("uac","auth_username_avp","$avp(i:11)")
...
<varname>auth_password_avp</varname> (string)
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
() and
auth_username_avp
().
Set <varname>auth_password_avp</varname> parameter
...
modparam("uac","auth_password_avp","$avp(i:12)")
...
Exported Functions
<function moreinfo="none">uac_replace_from(display,uri)</function>
Replace in FROM header the display name and
the URI part.
display and URI parameters
can include pseudo-variables.
This function can be used from REQUEST_ROUTE.
<function>uac_replace_from</function> usage
...
# 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("","");
...
<function moreinfo="none">uac_replace_from(uri)</function>
Replace in FROM header the the URI part
without altering the display name.
URI parameter can include pseudo-variables.
This function can be used from REQUEST_ROUTE.
<function>uac_replace_from</function> usage
...
uac_replace_from("sip:batman@gotham.org");
...
<function moreinfo="none">uac_restore_from()</function>
This function will check if the FROM URI was modified and will
use the information stored in header parameter to restore
the original FROM URI value.
This function can be used from REQUEST_ROUTE.
<function>uac_restore_from</function> usage
...
uac_restore_from();
...
<function moreinfo="none">uac_auth()</function>
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.
<function>uac_auth</function> usage
...
uac_auth();
...