Table of Contents
rr_from_store_param (string)
rr_to_store_param (string)
restore_mode (string)
restore_passwd (string)
restore_from_avp (string)
restore_to_avp (string)
credential (string)
auth_realm_avp (string)
auth_username_avp (string)
auth_password_avp (string)
reg_db_url (string)
reg_timer_interval (string)
reg_contact_addr (string)
List of Examples
rr_from_store_param parameterrr_to_store_param parameterrestore_mode parameter
restore_passwd parameterrestore_from_avp parameterrestore_to_avp parametercredential parameterauth_realm_avp parameterauth_username_avp parameterauth_password_avp parameterreg_db_url parameterreg_timer_inteval parameterreg_contact_addr parameteruac_replace_from usageuac_replace_from usageuac_restore_from usageuac_replace_to usageuac_replace_to usageuac_restore_to usageuac_auth usageuac_req_send usageuac_reg_lookup usageuac_reg_request_to usagelookup remote registrations usageTable of Contents
rr_from_store_param (string)
rr_to_store_param (string)
restore_mode (string)
restore_passwd (string)
restore_from_avp (string)
restore_to_avp (string)
credential (string)
auth_realm_avp (string)
auth_username_avp (string)
auth_password_avp (string)
reg_db_url (string)
reg_timer_interval (string)
reg_contact_addr (string)
UAC (User Agent Client) module provides some basic UAC functionalities like FROM header manipulation (anonymization) or client authentication.
From version 1.5.0 it has function to send SIP message from configuration file. See variable $uac_req(name) and the function uac_req_send().
Version 3.1.0 adds user registration functionality. See uac_reg_lookup() function and dedicated section for remote registration configuration.
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”.
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.1. Set rr_from_store_param parameter
...
modparam("uac","rr_from_store_param","my_param")
...
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”.
There are 3 mode of restoring the original FROM URI and the original TO URI:
“none” - no information about original URI is stored; restoration 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 parameters. If empty, no encryption will be used.
Default value of this parameter is empty.
Example 1.4. Set restore_passwd parameter
...
modparam("uac","restore_passwd","my_secret_passwd")
...
If defined and restore_mode is manual or auto, the avp is used to save the original from uri in order to be able to restore it in replies. That makes sense, if the original-uri can not be extracted from the original request, e.g. if msg_apply_changes() was used after calling uac_replace_from()
Default value of this parameter is empty.
Example 1.5. Set restore_from_avp parameter
...
modparam("uac","restore_from_avp","$avp(s:original_uri_from)")
...
If defined and restore_mode is manual or auto, the avp is used to save the original to uri in order to be able to restore it in replies. That makes sense, if the original-uri can not be extracted from the original request, e.g. if msg_apply_changes() was used after calling uac_replace_to()
Default value of this parameter is empty.
Example 1.6. Set restore_to_avp parameter
...
modparam("uac","restore_to_avp","$avp(s:original_uri_to)")
...
Contains a multiple definition of credentials used to perform authentication.
This parameter is required if UAC authentication is used.
Example 1.7. Set credential parameter
...
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 3.9, “auth_username_avp (string)”) and
“auth_username_avp”
(Section 3.10, “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 3.8, “auth_realm_avp (string)”) and
“auth_username_avp”
(Section 3.10, “auth_password_avp (string)”).
Example 1.9. Set auth_username_avp parameter
...
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 3.10, “auth_password_avp (string)”) and
“auth_username_avp”
(Section 3.10, “auth_password_avp (string)”).
Example 1.10. Set auth_password_avp parameter
...
modparam("uac","auth_password_avp","$avp(i:12)")
...
Address to be used to build contact address. Must be at least host part, can have port and parameters. Must not include 'sip:'.
Example 1.13. Set reg_contact_addr parameter
...
modparam("uac", "reg_contact_addr", "192.168.1.2:5080")
...
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 and from BRANCH_ROUTE.
Example 1.14. uac_replace_from 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("","");
...
Replace in FROM header the URI part without altering the display name.
URI parameter can include pseudo-variables.
This function can be used from REQUEST_ROUTE and from BRANCH_ROUTE.
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.
Replace in TO header the display name and the URI part.
display and URI parameters can include pseudo-variables.
This function can be used from REQUEST_ROUTE and from BRANCH_ROUTE.
Example 1.17. uac_replace_to usage
...
# replace both display and uri
uac_replace_to("$avp(s:display)","$avp(s:uri)");
# replace only display and do not touch uri
uac_replace_to("batman","");
# remove display and replace uri
uac_replace_to("","sip:robin@gotham.org");
# remove display and do not touch uri
uac_replace_to("","");
...
Replace in TO header the URI part without altering the display name.
URI parameter can include pseudo-variables.
This function can be used from REQUEST_ROUTE and from BRANCH_ROUTE.
This function will check if the TO URI was modified and will use the information stored in header parameter to restore the original TO URI value.
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.
This function can be used from FAILURE_ROUTE.
This function sends a SIP message from the configuration file. The message is built out of $uac_req(...) pseudo-variable.
This function can be used from REQUEST_ROUTE, FAILURE_ROUTE, BRANCH_ROUTE, ONREPLY_ROUTE, LOCAL_ROUTE.
Example 1.21. uac_req_send usage
... $uac_req(method)="OPTIONS"; $uac_req(ruri)="sip:kamailio.org"; $uac_req(furi)="sip:kamailio.org"; $uac_req(turi)="sip:kamailio.org"; uac_req_send(); ...
This function sets the PV dst to SIP URI that correspond to uuid in uac registations table. uuid and dst must be pseudo-variables.
This function can be used from ANY_ROUTE.
This function can be used to send an authenticated request to a remote user in the uac registrations table. It sets the request-uri, dst-uri and auth_*_avp pv's to the values that correspond to the supplied user.
The mode indicates whether the user should match the local uuid (mode=0), or the username (mode=1).
The auth_*_avp module parameters must be set to valid pv's.
This function can be used from REQUEST_ROUTE, FAILURE_ROUTE, BRANCH_ROUTE.
Example 1.23. uac_reg_request_to usage
...
if(uac_reg_request_to("$fU", 0))
{
xlog("L_NOTICE", "Found remote user [$rU] on [$rd] via [$du]");
t_on_failure("REMOTE_AUTH");
t_relay()
}
...
failure_route[REMOTE_AUTH] {
if ($T_reply_code == 401 or $T_reply_code == 407) {
xlog("L_NOTICE", "Remote asked for authentication");
uac_auth()
}
}
...
$uac_req(key)
Exported pseudo-variables are documented at http://www.kamailio.org/dokuwiki/.
The module can register contact addresses to remote REGISTRAR servers. You have to add records to uacreg table. The table stores following attributes:
l_uuid - local unique user id, e.g.,: 12345678
l_username - local user name, e.g.,: test
l_domain - local domain, e.g.,: mysipserver.com
r_username - remote username, e.g.,: test123
r_domain - remote domain, e.g.,: sipprovider.com
realm - remote relam, e.g.,: sipprovider.com
auth_username - authentication username, e.g.,: test123
auth_password - authentication password, e.g.,: xxxxxx
auth_proxy - SIP address of authentication proxy, e.g.,: sip:sipprovider.com
expires - expiration time for registration, in seconds, e.g.,: 360
The module takes care of sending REGISTER and refresh registrations before they expire.
When calls come in, you have to run uac_reg_lookup() that will detect if the call is coming from a remote SIP provider and can change the R-URI to local username@domain. Afterwards you can run location lookup.
Example 1.24. lookup remote registrations usage
...
if(uac_reg_lookup("$rU", "$ru")) {
xlog("request from a remote SIP provider [$ou => $ru]\n");
}
lookup("location");
...