# &adminguide;

## Overview

The UAC (User Agent Client) module provides some basic UAC functionalities like sending SIP requests, registering with a remote service, From: header manipulation (anonymization) and client authentication.

The UAC module also supports sending a SIP request from the configuration file. See variable $uac_req(name) and the function uac_req_send().

In addition, the module supports database-driven SIP registration functionality. See the 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 is not increased automatically by uac_auth() during authentication - the follow up request may be rejected. CSeq can be increased when authenticating INVITE requests - dialog module has to be used, with CSeq tracking feature enabled (see the readme of dialog module).

- The uac_replace_* functions can only be run once on the same SIP request. Try to save needed changes in a pseudovariable and apply them once.

  There is also a limitation regarding the use of the msg_apply_changes() function together with the uac_replace_* functions for messages that are loose-routed (e.g. Re-INVITE requests). In this case you need to call the loose_route() function after the replace and msg_apply_changes. Otherwise Kamailio can create replies with wrong From/To headers (e.g. for the 100 - Trying reply in the Re-INVITE example).

## Dependencies

### &kamailio; 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.

- Dialog Module, but only if restore mode for From: URI is set to auto and you want uac_replace_from or uac_replace_to to store the values of the URIs as dialog variables.

### External Libraries or Applications

The following libraries or applications must be installed before running &kamailio; with this module loaded:

- None

## Parameters

### `rr_from_store_param` (string)

Name of Record-Route header parameter that will be used to store an encoded version of the original FROM URI.

The default value is vsf.

#### Set `rr_from_store_param` parameter

    ...
    modparam("uac","rr_from_store_param","my_param")
    ...

### `rr_to_store_param` (string)

Name of Record-Route header parameter that will be used to store (encoded) the original TO URI.

The default value is vst.

#### Set `rr_to_store_param` parameter

    ...
    modparam("uac","rr_to_store_param","my_param")
    ...

### `restore_mode` (string)

There are 3 modes 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. For this option you have to set modparam("rr", "append_fromtag", 1).

The default value is auto.

#### Set `restore_mode` parameter

    ...
    modparam("uac","restore_mode","auto")
    ...

### `restore_dlg` (int)

If set to 1, the module uses dialog variables to store initial and new values for From/To headers. The Dialog module has to be loaded and all calls that involve changes to From/To headers must be tracked.

Default value of this parameter is 0.

#### Set `restore_dlg` parameter

    ...
    modparam("uac", "restore_dlg", 1)
    ...

### `restore_passwd` (string)

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.

#### Set `restore_passwd` parameter

    ...
    modparam("uac","restore_passwd","my_secret_passwd")
    ...

### `restore_from_avp` (string)

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() or uac_replace_to().

If you create a dialog ( with dlg_manage() ) before calling uac_replace_from(), this avp will not be needed. The values of the uris will be stored as dialog variables.

Default value of this parameter is empty.

#### Set `restore_from_avp` parameter

    ...
    modparam("uac","restore_from_avp","$avp(original_uri_from)")
    ...

### `restore_to_avp` (string)

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()

If you create a dialog ( with dlg_manage() ) before calling or uac_replace_to(), this avp will not be needed. The values of the uris will be stored as dialog variables.

Default value of this parameter is empty.

#### Set `restore_to_avp` parameter

    ...
    modparam("uac","restore_to_avp","$avp(original_uri_to)")
    ...

### `credential` (string)

Contains a multiple definition of credentials used to perform authentication.

This parameter is required if UAC authentication is used.

#### Set `credential` parameter

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

### `auth_realm_avp` (string)

The definition of a PV that might contain the realm to be used to perform authentication.

When the PV value is an empty string or NULL when uac_auth() is called, the realm is taken from the reply and only username matching is done. This can be used if the realm upstream will be using is not known in advance.

If you define it, you also need to define auth_username_avp (uac.p.auth_username_avp) and auth_password_avp (uac.p.auth_password_avp).

#### Set `auth_realm_avp` parameter

    ...
    modparam("uac","auth_realm_avp","$avp(arealm)")
    ...

### `auth_username_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 (uac.p.auth_realm_avp) and auth_password_avp (uac.p.auth_password_avp).

#### Set `auth_username_avp` parameter

    ...
    modparam("uac","auth_username_avp","$avp(auser)")
    ...

### `auth_password_avp` (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_realm_avp (uac.p.auth_realm_avp) and auth_username_avp (uac.p.auth_username_avp).

#### Set `auth_password_avp` parameter

    ...
    modparam("uac","auth_password_avp","$avp(apasswd)")
    ...

### `reg_db_url` (string)

DB URL to fetch account profiles for registration. This parameter must be set in order to enable remote registrations feature.

The default value is "" (no value).

#### Set `reg_db_url` parameter

    ...
    modparam("uac", "reg_db_url",
        "&defaultdb;")
    ...

### `reg_timer_interval` (int)

Timer interval (in seconds) at which registrations are managed, e.g. renewed as needed.

The default value is 90 seconds.

#### Set `reg_timer_interval` parameter

    ...
    modparam("uac", "reg_timer_interval", 60)
    ...

### `reg_retry_interval` (int)

Failed registration attempts will be retried after this interval (in seconds). The interval is not exact, retries may be attempted as much as reg_timer_interval secs earlier. If set to 0, failed registrations will be disabled permanently.

The default value is 0 sec (disabled)

#### Set `reg_retry_interval` parameter

    ...
    modparam("uac", "reg_retry_interval", 300)
    ...

### `reg_random_delay` (int)

Set a random reg_delay for each registration that has reg_delay set to 0 in the database. If set to 0, randomization will be disabled.

The default value is 0 sec (disabled)

#### Set `reg_random_delay` parameter

    ...
    modparam("uac", "reg_random_delay", 300)
    ...

### `reg_hash_size` (int)

The number of entries of the hash table used by uac_reg to store the registration records is 2^hash_size. For hash_size=4, the number of slots of the hash table is 16.

Default value is 4 (16 slots).

#### Set `reg_hash_size` parameter

    ...
    modparam("uac", "reg_hash_size", 10)
    ...

### `reg_db_table` (string)

DB table name to fetch user profiles for registration.

The default value is uacreg.

#### Set `reg_db_table` parameter

    ...
    modparam("uac", "reg_db_table", "uacreg")
    ...

### `reg_contact_addr` (string)

Address to be used to build contact address. Must be at least host part, can have port and parameters. Must not include 'sip:'. The username part of the Contact: URI will be the L_UUID field in the database.

A contact_addr value in the uacreg table will override the parameter for this particular entry.

#### Set `reg_contact_addr` parameter

    ...
    modparam("uac", "reg_contact_addr", "192.168.1.2:5080")
    ...

### `reg_keep_callid` (int)

If set to 0 (default), a new Call-Id will be generated for each registration attempt. If set to non-zero, the same Call-Id will be used for re-registrations, as recommended by RFC3261 section 10.2.4. A new Call-Id will be generated when a previous registration had failed.

#### Set `reg_keep_callid` parameter

    ...
    modparam("uac", "reg_keep_callid", 1)
    ...

### `reg_active` (int)

If set to 0, no remote regisrations are done. In other words, it can control at once if the module should do remote registrations or not. It can be changed at runtime via rpc command 'uac.reg_active 0|1'.

The default value is 1 (active).

#### Set `reg_active` parameter

    ...
    modparam("uac", "reg_active", 0)
    ...

### `reg_gc_interval` (int)

Timer interval (in seconds) at which remote registrations are cleaned up in case of failure or removed. When setting it take in consideration the maximum value for retransmission timeout, this param should be greater than it.

The default value is 150 seconds.

#### Set `reg_gc_interval` parameter

    ...
    modparam("uac", "reg_gc_interval", 60)
    ...

### `reg_use_domain` (int)

If set to 1, domain part of URIs is used by functions doing lookup on user name.

Default value is 0.

#### Set `reg_use_domain` parameter

    ...
    modparam("uac", "reg_use_domain", 1)
    ...

### `default_socket` (str)

Default socket to be used for generating registration requests and sending requests with the function uac_req_send(). Useful e.g. when several public interfaces are available.

A send socket in the $uac_reg variable used together with the uac_req_send() function will override this parameter. A socket value in the uacreg table will also override the parameter for this particular entry.

By default no default socket is defined, the send socket is choosen from the tm module when the requests is sent out.

If you want to force a certain TCP port (e.g. 5060), you will need to set the tcp_reuse_port=yes core parameter as well.

#### Set the default_socket parameter

     ...
     modparam("uac", "default_socket", "udp:192.168.0.125:5060")
     ...

### `event_callback` (str)

The name of the function in the kemi configuration file (embedded scripting language such as Lua, Python, ...) to be executed instead of event_route[uac:reply] block.

The function receives a string parameter with the name of the event, the value can be: 'uac:reply'.

Default value is 'empty' (no function is executed for events).

#### Set `event_callback` parameter

     ...
    modparam("uac", "event_callback", "ksr_uac_event")

    function ksr_uac_event(evname)
    	KSR.info("===== uac module triggered event: " .. evname .. "\n");
    	return 1;
    end
     ...

### `reload_delta` (int)

The number of seconds that have to be waited before executing a new RPC reload (uac.reg_reload). By default, RPC reloads are rate limited to a maximum of one reload per the reload_delta interval.

If set to 0, no rate limit is configured. Note carefully: use this configuration only in tests environments because executing two RPC reloads of the same table at the same time can cause &kamailio; to crash.

The default value is 30 seconds.

#### Set `reload_delta` parameter

    ...
    modparam("uac", "reload_delta", 20)
    ...

## Functions

### `uac_replace_from(display, uri)`

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.

NOTE: Previous versions of this function added double quotes automatically to display variable. That is no longer the case, if you expect that behavior, you will have to add the quotes by yourself.

If you set restore_mode to AUTO, the URI will be modified automatically in all subsequent requests and replies in that dialog.

There are two ways in which the AUTO mode can be achieved.

One uses the rr module and appends to the Record-Route header a parameter containing some strings from which the original and new URI can be computed. The problem with this mode is that it relies on the fact the parties will send the Route exactly as it was received. In case there is a change, the resulting URIs will not be correct.

The other one uses the dialog module to store the original and new URI. If you already use dialog module in your configuration, this is the advisable mode. All you need to do to use this is to call dlg_manage() before calling uac_replace_from(). It works by storing the URIs as dialog variables and registering callbacks in dialog module for in dialog requests.

#### `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","");   # display is replaced with: batman
    uac_replace_from("\"batman\"","");  # display is replaced with: "batman"
    # remove display and replace uri
    uac_replace_from("","sip:robin@gotham.org");
    # remove display and do not touch uri
    uac_replace_from("","");
    ...

### `uac_replace_from(uri)`

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.

#### `uac_replace_from` usage

    ...
    uac_replace_from("sip:batman@gotham.org");
    ...

### `uac_restore_from()`

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.

#### `uac_restore_from` usage

    ...
    uac_restore_from();
    ...

### `uac_replace_to(display, uri)`

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.

NOTE: Previous versions of this function added double quotes automatically to display variable. That is no longer the case, if you expect that behavior, you will have to add the quotes by yourself.

#### `uac_replace_to` usage

    ...
    # replace both display and uri
    uac_replace_to("$avp(display)","$avp(uri)");
    # replace only display and do not touch uri
    uac_replace_to("batman","");   # display is replaced with: batman
    uac_replace_to("\"batman\"","");  # display is replaced with: "batman"
    # remove display and replace uri
    uac_replace_to("","sip:robin@gotham.org");
    # remove display and do not touch uri
    uac_replace_to("","");
    ...

### `uac_replace_to(uri)`

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.

If you set restore_mode to AUTO, the URI will be modified automatically in all subsequent requests and replies in that dialog.

There are two ways in which the AUTO mode can be achieved.

One uses the rr module and appends to the Record-Route header a parameter containing some strings from which the original and new URI can be computed. The problem with this mode is that it relies on the fact the parties will send the Route exactly as it was received. In case there is a change, the resulting URIs will not be correct.

The other one uses the dialog module to store the original and new URI. If you already use dialog module in your configuration, this is the advisable mode. All you need to do to use this is to call dlg_manage() before calling uac_replace_to(). It works by storing the URIs as dialog variables and registering callbacks in dialog module for in dialog requests.

#### `uac_replace_to` usage

    ...
    uac_replace_to("sip:batman@gotham.org");
    ...

### `uac_restore_to()`

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.

#### `uac_restore_to` usage

    ...
    uac_restore_to();
    ...

### `uac_auth([mode])`

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.

If mode is set to 1, then the password has to be provided in HA1 format. The parameter can be a static integer or a variable holding an integer value.

This function can be used from FAILURE_ROUTE and BRANCH_FAILURE_ROUTE event route.

#### `uac_auth` usage

    ...
    modparam("uac","auth_username_avp","$avp(auser)")
    modparam("uac","auth_password_avp","$avp(apass)")
    modparam("uac","auth_realm_avp","$avp(arealm)")

    request_route {
       ...
       if(is_method("INVITE")) {
          t_on_failure("TRUNKAUTH");
       }
       ...
    }

    failure_route[TRUNKAUTH] {

        if (t_is_canceled()) {
            exit;
        }
        if(t_check_status("401|407")) {
            $avp(auser) = "test";
            $avp(apass) = "test";
            # $avp(apass) = "36d0a02793542b4961e8348347236dbf";
            # if (uac_auth("1")) {
            if (uac_auth()) {
                t_relay();
            }
            exit;
        }
    }
    ...

### `uac_auth_mode(vmode)`

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.

If mode is set to 1, then the password has to be provided in HA1 format. The parameter can be a static integer or a variable holding an integer value.

This function can be used from FAILURE_ROUTE and BRANCH_FAILURE_ROUTE event route.

#### `uac_auth_mode` usage

    ...
    modparam("uac","auth_username_avp","$avp(auser)")
    modparam("uac","auth_password_avp","$avp(apass)")
    modparam("uac","auth_realm_avp","$avp(arealm)")

    request_route {
       ...
       if(is_method("INVITE")) {
          t_on_failure("TRUNKAUTH");
       }
       ...
    }

    failure_route[TRUNKAUTH] {

        if (t_is_canceled()) {
            exit;
        }
        if(t_check_status("401|407")) {
            $avp(auser) = "test";
            $avp(apass) = "test";
            # $avp(apass) = "36d0a02793542b4961e8348347236dbf";
            if (uac_auth_mode("1")) {
                t_relay();
            }
            exit;
        }
    }
    ...

### `uac_req_send()`

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.

#### `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(callid)=$(mb{s.md5});
    uac_req_send();
    ...

### `uac_reg_send_register(atttr,value)`

This function sends a REGISTER request for the registration based on a filter specified by attribute and value. The attribute can be: l_uuid, l_username, r_username or auth_username. The value is what should be matched against the value of the attribute in the remote registration record.

This function can be used from REQUEST_ROUTE, FAILURE_ROUTE, BRANCH_ROUTE, ONREPLY_ROUTE, LOCAL_ROUTE.

#### `uac_reg_send_register` usage

    ...
    uac_reg_send_register("l_uuid", "account123");
    ...

### `uac_reg_send_unregister(atttr,value)`

This function sends a REGISTER request with expires 0 for the registration based on a filter specified by attribute and value. The attribute can be: l_uuid, l_username, r_username or auth_username. The value is what should be matched against the value of the attribute in the remote registration record.

This function can be used from REQUEST_ROUTE, FAILURE_ROUTE, BRANCH_ROUTE, ONREPLY_ROUTE, LOCAL_ROUTE.

#### `uac_reg_send_unregister` usage

    ...
    uac_reg_send_unregister("l_uuid", "account123");
    ...

### `uac_reg_lookup(uuid, dst)`

This function sets the PV dst to SIP URI that correspond to uuid in uac registrations table. uuid and dst must be pseudo-variables.

This function can be used from ANY_ROUTE.

#### `uac_reg_lookup` usage

    ...

    if(uac_reg_lookup("$rU", "$ru"))
    {
        lookup("location");
    }
    ...

### `uac_reg_lookup_uri(uri, dst)`

This function sets the PV dst to SIP URI that correspond to the URI user in uac registrations table. The uri can contain pseudo-variables and dst must be the name of a pseudo-variable.

This function can be used from ANY_ROUTE.

#### `uac_reg_lookup_uri` usage

    ...

    if(uac_reg_lookup("$var(uri)", "$ru"))
    {
        lookup("location");
    }
    ...

### `uac_reg_status(uuid)`

This function returns the current registration status for the uuid.

Return values:

- 1 - a valid registration exists.

- -1 - uuid does not exist or an error occurred while executing the function.

- -2 - a registration attempt is ongoing (and currently there is no valid registration).

- -3 - registration is disabled.

- -99 - no valid registration, waiting for new registration attempt.

This function can be used from ANY_ROUTE.

#### `uac_reg_status` usage

    ...
    $var(status) = uac_reg_status("$rU");
    ...

### `uac_reg_request_to(user, mode)`

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 variables to the values that correspond to the supplied user.

The mode is a bitwise set of flags controlling how the matching of the record is done and what field is used to set auth_password_avp:

- indicates whether the user should match the local uuid (bit value=0), or the username (bit value=1, int value=1).

- indicates whether the auth_password value is used to set auth_password_avp (bit value=0), or the auth_ha1 value (bit value=1, int value=2).

The auth_*_avp module parameters must be set to valid pv's.

This function can be used from REQUEST_ROUTE, FAILURE_ROUTE, BRANCH_ROUTE.

#### `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_reg_enable(attr, val)`

Enable a remote registration record based on a filter specified by attribute and value. The attribute can be: l_uuid, l_username, r_username or auth_username. The value is what should be matched against the value of the attribute in the remote registration record.

The SIP processing is done on the next timer routine.

#### `uac_reg_enable` usage

    ...
       uac_reg_enable("l_uuid", "account123");
    ...

### `uac_reg_disable(attr, val)`

Disable a remote registration record based on a filter specified by attribute and value. The attribute can be: l_uuid, l_username, r_username or auth_username. The value is what should be matched against the value of the attribute in the remote registration record.

The SIP processing is done on the next timer routine.

#### `uac_reg_disable` usage

    ...
       uac_reg_disable("l_uuid", "account123");
    ...

### `uac_reg_refresh(luuid)`

Refresh the uac remote registration record based on local uuid. If the record was already loaded, new values are taken from database, otherwise a new record is created.

#### `uac_reg_refresh` usage

    ...
       uac_reg_refresh("account123");
    ...

## Pseudo Variables

- $uac_req(key)

Exported pseudo-variables are documented at &kamwikilink;.

## Event Routes

### `event_route[uac:reply]`

The associated $uac_req(evroute) can have either of the following values:

- 1 : event route executed for the final reply of the branch for the request sent with uac_req_send(). If the request is challenged for authentication with 401/407, then the event_route is executed twice, first for 401/407 and second for final reply of the transaction.

- 2 : event route executed for failure of the branch for the request sent with uac_req_send(). event route will execute also for timeout. In order for this to work, please also enable TM module "enable_uac_fr" modparam.

#### `event_route[uac:reply]` 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(callid)=$(mb{s.md5});
    $uac_req(evroute)=1;
    uac_req_send();
    ...
    event_route[uac:reply] {
        xlog("received reply code is: $uac_req(evcode)\n");
    }
    ...

## Counters

- regtotal: Total number of registrations

- regactive: Total number of active registrations (successfully registered with service)

- regdisabled: Total number of disabled registrations (no longer active)

## RPC Commands

### `uac.reg_dump`

Dump the content of remote registration table from memory.

#### `uac.reg_dump` usage

    ...
       kamctl rpc uac.reg_dump
    ...

### `uac.reg_info`

Return the details of a remote registration record based on a filter. The command has two parameters: attribute and value. The attribute can be: l_uuid, l_username, r_username or auth_username. The value is what should be matched against the value of the attribute in the remote registration record.

The state of the registration is reflected in the flags field:

- 1 (2^0) - registration profile is disabled

- 2 (2^1) - registration in progress

- 4 (2^2) - registration succeeded

- 8 (2^3) - registration in progress with authentication

- 16 (2^4) - registration initialized (after loading from database, the registration process was initialized)

#### `uac.reg_info` usage

    ...
       kamctl rpc uac.reg_info l_uuid account123
       kamctl rpc uac.reg_info l_uuid s:12345678
    ...

### `uac.reg_enable`

Enable a remote registration record based on a filter. The command has two parameters: attribute and value. The attribute can be: l_uuid, l_username, r_username or auth_username. The value is what should be matched against the value of the attribute in the remote registration record.

#### `uac.reg_enable` usage

    ...
       kamctl rpc uac.reg_enable l_uuid account123
       kamctl rpc uac.reg_enable l_uuid s:12345678
    ...

### `uac.reg_disable`

Disable a remote registration record based on a filter. The command has two parameters: attribute and value. The attribute can be: l_uuid, l_username, r_username or auth_username. The value is what should be matched against the value of the attribute in the remote registration record.

#### `uac.reg_disable` usage

    ...
       kamctl rpc uac.reg_disable l_uuid account123
       kamctl rpc uac.reg_disable l_uuid s:12345678
    ...

### `uac.reg_register`

Send a REGISTER for the matching record based on a filter. The command has two parameters: attribute and value. The attribute can be: l_uuid, l_username, r_username or auth_username. The value is what should be matched against the value of the attribute in the remote registration record.

#### `uac.reg_register` usage

    ...
       kamctl rpc uac.reg_register l_uuid account123
       kamctl rpc uac.reg_register l_uuid s:12345678
    ...

### `uac.reg_unregister`

Send REGISTER with expires 0 for matching record, disabling it. The command has two parameters: attribute and value. The attribute can be: l_uuid, l_username, r_username or auth_username. The value is what should be matched against the value of the attribute in the remote registration record.

#### `uac.reg_unregister` usage

    ...
       kamctl rpc uac.reg_unregister l_uuid account123
       kamctl rpc uac.reg_unregister l_uuid s:12345678
    ...

### `uac.reg_reload`

Reload the records from database for remote registrations. There is a limit of how often the reload command can be executed. By default, it is 30 seconds between reloads -- see the reload_delta parameter for more details.

#### `uac.reg_reload` usage

    ...
       kamctl rpc uac.reg_reload
    ...

### `uac.reg_refresh`

Load one record by l_uuid from database for remote registrations. If the record exists in memory, it will be replaced with the new values loaded from database.

#### `uac.reg_refresh` usage

    ...
       kamctl rpc uac.reg_refresh account123
       kamctl rpc uac.reg_refresh s:12345678
    ...

### `uac.reg_active`

Control if the module should do remote registrations or not. Setting to 1 enables remote registrations for all records and 0 disables doing them.

#### `uac.reg_active` usage

    ...
       kamctl rpc uac.reg_active 0
       kamctl rpc uac.reg_active 1
    ...

### `uac.reg_add`

Add a new UAC remote registration record. If one with the same unique id is found, it is deleted.

The parameters are:

- l_uuid

- l_username

- l_domain

- r_username

- r_domain

- realm

- auth_username

- auth_password

- auth_ha1

- auth_proxy

- expires

- flags

- reg_delay

- socket

- contact_addr

Use a dot (.) if no value should be set for realm, auth_password, auth_ha1, socket or contact_addr.

#### `uac.reg_add` usage

    ...
       kamctl rpc uac.reg_add ...
    ...

### `uac.reg_remove`

Remove a UAC remote registration record by l_uuid.

#### `uac.reg_remove` usage

    ...
       kamctl rpc uac.reg_remove my_l_uuid
    ...

## Remote Registration

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. Used to contstruct RURI, From: and To: domains.

- realm - remote realm, e.g.: sipprovider.com. Must match realm= parameter in incoming WWW-Authenticate headers.

- auth_username - authentication username, e.g.: test123

- auth_password - authentication password in clear text, e.g.: xxxxxx

- auth_ha1 - hashed (HA1) authentication password, it has priority over auth_password.

- auth_proxy - SIP address of authentication proxy, e.g.: sip:sipprovider.com or sips:sipprovider.com. It is used to find the IP address of the proxy and determine whether UDP or TLS shall be used. It has no impact on the content of generated messages.

- expires - expiration time for registration, in seconds, e.g.: 360

- flags - the state of the registration, see uac.r.uac.reg_info

- reg_delay - delay initial registration with at least reg_delay seconds, e.g.: 3

- contact_addr - contact address to be used for this record instead of reg_contact_addr module parameter, e.g.:, 192.168.0.125:5060. It can be set to '' (empty string) to skip setting it and then reg_contact_addr modparam is used.

- socket - Used socket for sending out registration requests, e.g.:, udp:192.168.0.125:5060

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.

### `lookup remote registrations` usage

    ...
        if(uac_reg_lookup("$rU", "$ru")) {
            xlog("request from a remote SIP provider [$ou => $ru]\n");
        }
        lookup("location");
    ...