Table of Contents
default_expires (integer)
default_expires_range (integer)
min_expires (integer)
max_expires (integer)
default_q (integer)
realm_prefix (string)
append_branches (integer)
aor_avp (str)
case_sensitive (integer)
received_avp (str)
received_param (string)
max_contacts (integer)
retry_after (integer)
sock_flag (integer)
sock_hdr_name (string)
method_filtering (integer)
use_path (integer)
path_mode (integer)
path_use_received (integer)
reg_callid_avp (string)
xavp_cfg (string)
xavp_rcd (string)
gruu_enabled (integer)
List of Examples
default_expires parameterdefault_expires_range parametermin_expires parametermax_expires parameterdefault_q parameterrealm_prefix parameterappend_branches parametercase_sensitive parameterreceived_avp parameterreceived_param parametermax_contacts parameterretry_after parametersock_flag parametersock_hdr_namer parametermethod_filtering parameteruse_path parameterpath_mode parameterpath_use_received parameterreg_callid_avp parameterxavp_cfg parameterxavp_rcd parametergruu_enabled parametersave usagelookup usagelookup_branches usageregistered usageadd_sock_hdr usageunregister usagereg_fetch_contacts usagereg_free_contacts usage$ulc(name) usageTable of Contents
default_expires (integer)
default_expires_range (integer)
min_expires (integer)
max_expires (integer)
default_q (integer)
realm_prefix (string)
append_branches (integer)
aor_avp (str)
case_sensitive (integer)
received_avp (str)
received_param (string)
max_contacts (integer)
retry_after (integer)
sock_flag (integer)
sock_hdr_name (string)
method_filtering (integer)
use_path (integer)
path_mode (integer)
path_use_received (integer)
reg_callid_avp (string)
xavp_cfg (string)
xavp_rcd (string)
gruu_enabled (integer)
The module contains REGISTER processing logic. The actual location database is managed by the USRLOC module.
The Register module includes Path support (according to RFC 3327) for usage in registrars and home-proxies.
If path support is enabled in the registrar module, a call to save(...) stores the values of the Path Header(s) along with the contact into usrloc. There are three modes regarding the reply to a REGISTER including one or more Path HFs:
off - stores the value of the Path headers into usrloc without passing it back to the UAC in the reply.
lazy - stores the Path header and passes it back to the UAC if Path-support is indicated by the “path” param in the Supported HF.
strict - rejects the registration with “420 Bad Extension” if there's a Path header but no support for it is indicated by the UAC. Otherwise it's stored and passed back to the UAC.
A call to lookup(...) always uses the path header if found, and inserts it as Route HF either in front of the first Route HF, or after the last Via HF if no Route is present. It also sets the destination uri to the first Path uri, thus overwriting the received-uri, because NAT has to be handled at the outbound-proxy of the UAC (the first hop after client's NAT).
The whole process is transparent to the user, so no config changes are required beside setting the registrar-parameters “use_path” and “path_mode”.
GRUU (RFC5627) is supported with both public and temporary addresses.
The public GRUU is build based on '+sip.instance' parameter as recommended by RFC.
The temporary GRUU is built based on internal SRUID (unique id generator) and it is kept the same for the duration of contact validity.
The following modules must be loaded before this module:
usrloc - User Location Module.
sl - Stateless Replies.
If the processed message contains neither Expires HFs nor expires contact parameters, this value will be used for newly created usrloc records. The parameter contains number of second to expire (for example use 3600 for one hour). If it is set to a lower value than the “min_expires” parameter then it will be ignored. This parameter can be modified via ser config framework. A random value in a specific interval can be selected by using the default_expires_range parameter
Default value is 3600.
This parameter specifies that the expiry used for newly created usrloc records are not fixed(when “default_expires” applies), but a random value in the interval “[default_expires-default_expires_range%, default_expires+default_expires_range%]”. The value is between 0 and 100 and represent the maximim percentage from default_expires that will be substracted or added when computing the value. Default in 0, meaning default_expires is left unmodified. This parameter can be modified via ser config framework.
Default value is 0.
Example 1.2. Set default_expires_range parameter
...
modparam("registrar", "default_expires_range", 30) # +- 30% from default_expires
...
The minimum expires value of a Contact, values lower than this minimum will be automatically set to the minimum. Value 0 disables the checking. This parameter can be modified via ser config framework.
Default value is 60.
The maximum expires value of a Contact, values higher than this maximum will be automatically set to the maximum. Value 0 disables the checking. This parameter can be modified via ser config framework.
Default value is 0.
The parameter represents default q value for new contacts. Because Kamailio doesn't support float parameter types, the value in the parameter is divided by 1000 and stored as float. For example, if you want default_q to be 0.38, use value 380 here. This parameter can be modified via ser config framework.
Default value is 0.
Prefix to be automatically stripped from realm. As an alternative to SRV records (not all SIP clients support SRV lookup), a subdomain of the master domain can be defined for SIP purposes (like sip.mydomain.net pointing to same IP address as the SRV record for mydomain.net). By ignoring the realm_prefix "sip.", at registration, sip.mydomain.net will be equivalent to mydomain.net.This parameter can be modified via the Kamailio config framework.
Default value is NULL (none).
The parameter controls how lookup function processes multiple contacts. If there are multiple contacts for the given username in usrloc and this parameter is set to 1, Request-URI will be overwritten with the highest-q rated contact and the rest will be appended to sip_msg structure and can be later used by tm for forking. If the parameter is set to 0, only Request-URI will be overwritten with the highest-q rated contact and the rest will be left unprocessed. This parameter can be modified via Kamailio config framework.
Default value is 1.
This module parameter has been removed. Use the 'uri' parameter from functions (e.g., save, lookup, registered).
If set to 1 then AOR comparison and also storing will be case sensitive, if set to 0 then AOR comparison and storing will be case insensitive--This is recommended. This parameter can be modified via Kamailio config framework.
Default value is 0.
Registrar will store the value of the AVP configured by this parameter in the received column in the user location database. It will leave the column empty if the AVP is empty. The AVP should contain a SIP URI consisting of the source IP, port, and protocol of the REGISTER message being processed.
The value of this parameter should be the same as the value of corresponding parameter of nathelper module.
Default value is "NULL" (disabled).
Example 1.9. Set received_avp parameter
...
modparam("registrar", "received_avp", "$avp(s:rcv)")
...
The name of the parameter that will be appended to Contacts of 200 OK when the received URI was set by nathelper module.
Default value is "received".
The parameter can be used to limit the number of contacts per AOR (Address of Record) in the user location database. Value 0 disables the check. This parameter can be modified via the Kamailio config framework.
Default value is 0.
Example 1.11. Set max_contacts parameter
...
# Allow no more than 10 contacts per AOR
modparam("registrar", "max_contacts", 10)
...
The registrar can generate 5xx reply to REGISTER in various
situations. It can, for example, happen when the
max_contacts parameter is set and the
processing of REGISTER request would exceed the limit. In this case
the registrar would generate "503 Service Unavailable" response.
This parameter can be modified via the Kamailio config framework.
If you want to add the Retry-After header field in 5xx replies, set this parameter to a value grater than zero (0 means do not add the header field). See section 20.33 of RFC3261 for more details.
Default value is 0 (disabled).
Message flag to signal to register module to look into REGISTER request for a header which contains a socket description (IP:port). This socket info will be stored by register instead of the received socket info.
This makes sense only in multiple replicated servers scenarios.
Default value is -1 (no flag).
Header which contains a socket description (proto:IP:port) to override the received socket info. The header will be read only if the flag sock_flag is set.
This makes sense only in multiple replicated servers scenarios.
Default value is NULL.
Example 1.14. Set sock_hdr_namer parameter
...
modparam("registrar", "sock_hdr_name", "Sock-Info")
...
Tells if the contact filtering based on supported methods should be performed during lookup. It's enabled only if it has a non zero value.
Default value is 0 (disabled).
If set to 1, the Path header is handled according to the parameter This parameter can be modified via ser config framework. “path_mode”.
Default value is 0 (disabled).
The registrar module implements three different modes regarding the response to a registration which includes one or more Path headers:
0 - The Path header is saved into usrloc, but is not included in the reply.
1 - The Path header is saved into usrloc, but is only included in the reply if path support is indicated in the registration request by the “path” option of the “Supported” header.
2 - The path header is only saved into usrloc, if path support is indicated in the registration request by the “path” option of the “Supported” header. If no path support is indicated, the request is rejected with “420 - Bad Extension” and the header “Unsupported: path” is included in the reply along with the received “Path” header. This mode is the one recommended by RFC-3327.
Default value is 2.
If set to 1, the “received” parameter of the first Path URI of a registration is set as received-uri and the NAT branch flag is set for this contact. This is useful if the registrar is placed behind a SIP loadbalancer, which passes the nat'ed UAC address as “received” parameter in it's Path uri.
Default value is 0 (disabled).
If reg_callid_avp is defined and populated when registered() is invoked, the result is TRUE only if an active registration with the specified callID is found.
Default value is NULL (disabled).
Example 1.19. Set reg_callid_avp parameter
...
modparam("registrar", "reg_callid_avp", "$avp(s:avp)")
...
Defines the name of XAVP class to store runtime module config values. The values are stored as inner XAVPs, like $xavp(class=>attribute). Valid inner XAVP names:
max_contacts - the number of maximum contacts to be stored for current registration AoR. It overwrites the 'max_contacts' module parameter value.
For example. if this parameter is set to 'reg', then the number of maximum contacts can be set in $xavp(reg=>max_contacts).
Default value is NULL (disabled).
Defines the name of XAVP class to store details from the location records. The values are stored as inner XAVPs, like $xavp(class=>attribute). Valid inner XAVP names:
ruid - the record's internal unique id.
For example. if this parameter is set to 'ulrcd', then the ruid for contact records are set in $xavp(ulrcd=>ruid).
Default value is NULL (disabled).
If set to 1 and GRUU “+sip.instance” parameter to Contact header of REGISTER is present, then the value of the parameter is saved to location and pub-gruu and temp-gruu addresses are generated.
Set it to 0 if you want to ignore GRUU extensions in REGISTER.
Default value is 1 (enabled).
The function processes a REGISTER message. It can add, remove or modify usrloc records depending on Contact and Expires HFs in the REGISTER message. On success and when called from the REQUEST_ROUTE, 200 OK will be returned listing all contacts that are currently in usrloc. On an error, error message will be send with a short description in reason phrase.
Meaning of the parameters is as follows:
domain - Logical domain within registrar. If database is used then this must be name of the table which stores the contacts.
flags (optional) - the value may be a bitwise OR of the following flags:
0x01 - save the contacts only in memory cache without no DB operation;
0x02 - do not generate a SIP reply to the current REGISTER request. When used in ONREPLY_ROUTE, this parameter is obsolete.
0x04 - store and maintain one contact per AoR. If there are other contact addresses for AoR not matching current registration, remove them. This mode ensures one contact per AoR (user).
The flags may be given in decimal or hexa format.
uri (optional - flags param has to be set and can be 0 for default behavior) - SIP URI to do be used instead of To header URI. It can be a dynamic string with pseudo-variables.
Return codes:
-1 - error.
1 - contacts inserted.
2 - contacts updated.
3 - contacts deleted.
4 - contacts returned.
This function can be used from REQUEST_ROUTE and REPLY_ROUTE.
Example 1.23. save usage
...
save("location");
save("location", "0x01");
save("location", "0x00", "sip:test@kamailio.org");
...
The function extracts username from Request-URI and tries to find all contacts for the username in usrloc. If there are no such contacts, -1 will be returned. If there are such contacts, Request-URI will be overwritten with the contact that has the highest q value and optionally the rest will be appended to the message (depending on append_branches parameter value).
If the method_filtering option is enabled, the lookup function will return only the contacts that support the method of the processed request.
Meaning of the parameters is as follows:
domain - Name of table that should be used for the lookup.
uri (optional) - SIP URI to do be used instead of R-URI. It can be a dynamic string with pseudo-variables.
Return codes:
1 - contacts found and returned.
-1 - no contact found.
-2 - contacts found, but method not supported.
-3 - internal error during processing.
This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
Example 1.24. lookup usage
...
lookup("location");
switch ($retcode) {
case -1:
case -3:
sl_send_reply("404", "Not Found");
exit;
case -2:
sl_send_reply("405", "Not Found");
exit;
};
...
The function performs lookup(domain) on r-uri and additional branches (only branches that have no other attributes set than uri).
Meaning of the parameters is as follows:
domain - Name of table that should be used for the lookup.
Return codes are propagated from lookup(domain).
This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
The function returns true if the AOR in the Request-URI is registered, false otherwise. The function does not modify the message being process, it neither rewrites the Request-URI if a contact is found not append branches.
Meaning of the parameters is as follows:
domain - Name of table that should be used for the lookup.
uri (optional) - SIP URI to do be used instead of R-URI. It can be a dynamic string with pseudo-variables.
This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
Example 1.26. registered usage
...
if (registered("location")) {
sl_send_reply("100", "Trying");
...
};
...
Adds to the current REGISTER request a new header with “hdr_name” which contains the description of the received socket (proto:ip:port)
This make sens only in multiple replicated servers scenarios.
Meaning of the parameters is as follows:
hdr_name - header name to be used.
This function can be used from REQUEST_ROUTE.
The function remove all the contact associated to 'uri'.
Meaning of the parameters is as follows:
domain - Name of table that should be used for the lookup or contact addresses.
uri - The SIP URI address of the user which to remove the contact addresses for. It can contain pseudo-variables that are evaluated at runtime.
This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
Example 1.28. unregister usage
...
unregister("location", "$ru");
unregister("location", "sip:user@kamailio.org");
...
The function fetches the contacts for 'uri' from table 'domain' to pseudo-variable $ulc(profile).
Meaning of the parameters is as follows:
domain - Name of table that should be used for the lookup of contact addresses.
uri - The SIP URI address of the user which to fetch the contact addresses for. It can contain pseudo-variables that are evaluated at runtime.
profile - Name of $ulc pseudo-variable profile that will store the fetched contacts. It is a static string.
This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
Example 1.29. reg_fetch_contacts usage
...
reg_fetch_contacts("location", "$ru", "callee");
reg_fetch_contacts("location", "sip:user@kamailio.org", "caller");
...
The function frees the contacts from pseudo-variable $ulc(profile). Should be called to release the content of a profile. Anyhow, fetching a new contact addresses set over a profile will release any existing data in that profile.
Meaning of the parameters is as follows:
profile - Name of $ulc pseudo-variable profile that stores fetched contacts. It is a static string.
This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
Access the attributes of contact addresses stored in 'profile'. It must be used after a call of “reg_fetch_contacts()”.
The “profile” has to be one of the values used with “reg_fetch_contacts()”.
The “attr” can be:
aor - address of record
domain - use location domain name
aorhash - hash id for the record
count - number of contacts
addr - contact address
path - path vector
received - received address
expires - expires value
callid - call-id header value
q - the q value
flags - flags value
cflags - cflags value
user_agent - user agent
socket - local socket
modified - last modified time
methods - methods value
The pseudo-variable accepts positive index value to access a specific contact record.
Example 1.31. $ulc(name) usage
...
if(reg_fetch_contacts("location", "$fu", "caller"))
{
xlog("caller=>aor: $(ulc(caller=>aor))\n");
xlog("caller=>domain: $(ulc(caller=>domain))\n");
xlog("caller=>aorhash $(ulc(caller=>aorhash))\n");
xlog("caller=>count $(ulc(caller=>count))\n");
$var(i) = 0;
while($var(i) < $(ulc(caller=>count)))
{
xlog("--- contact [$var(i)]\n");
xlog("caller=>addr: $(ulc(caller=>addr)[$var(i)])\n");
xlog("caller=>path: $(ulc(caller=>path)[$var(i)])\n");
xlog("caller=>received: $(ulc(caller=>received)[$var(i)])\n");
xlog("caller=>expires: $(ulc(caller=>expires)[$var(i)])\n");
xlog("caller=>callid: $(ulc(caller=>callid)[$var(i)])\n");
xlog("caller=>q: $(ulc(caller=>q)[$var(i)])\n");
xlog("caller=>cseq: $(ulc(caller=>cseq)[$var(i)])\n");
xlog("caller=>flags: $(ulc(caller=>flags)[$var(i)])\n");
xlog("caller=>cflags: $(ulc(caller=>cflags)[$var(i)])\n");
xlog("caller=>user_agent: $(ulc(caller=>user_agent)[$var(i)])\n");
xlog("caller=>socket: $(ulc(caller=>socket)[$var(i)])\n");
xlog("caller=>modified: $(ulc(caller=>modified)[$var(i)])\n");
xlog("caller=>methods: $(ulc(caller=>methods)[$var(i)])\n");
$var(i) = $var(i) + 1;
}
}
...
|
2.1. |
What happend with the old “nat_flag” module parameter? |
|
In was removed, as the module internally loads this value from the “USRLOC” module (see the “nat_bflag” USRLOC parameter). |
|
|
2.2. |
What happend with the old “use_domain” module parameter? |
|
In was removed, as the module internally loads this option from the “USRLOC” module. This was done in order to simplify the configuration. |
|
|
2.3. |
What happend with the old “save_noreply” and “save_memory” functions? |
|
There functions were merged into the new “save(domain,flags)” functions. If a reply should be sent or if the DB should be updated also is controlled via the flags. |
|
|
2.4. |
Where can I find more about Kamailio? |
|
Take a look at http://www.kamailio.org/. |
|
|
2.5. |
Where can I post a question about this module? |
|
First at all check if your question was already answered on one of our mailing lists:
E-mails regarding any stable Kamailio release should be sent to
If you want to keep the mail private, send it to
|
|
|
2.6. |
How can I report a bug? |
|
Please follow the guidelines provided at: http://sip-router.org/tracker. |
|
|
2.7. |
What happened to the desc_time_order parameter? |
|
It was removed, as its functionality was migrated into usrloc module, were there is a parameter with the same name. |