1.2.1. OpenSER 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".

1.2.2. External Libraries or Applications

The following libraries or applications must be installed before running OpenSER with this module loaded:

• None

1.3.1. rr_store_param (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".

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

1.3.2. from_restore_mode (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".

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

1.3.3. from_passwd (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.

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

1.3.4. credential (string)

Contains a multiple definition of credentials used to perform authentication.

This parameter is required if UAC authentication is used.

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

1.3.5. auth_realm_avp (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" (Section 1.3.6) and "auth_username_avp" (Section 1.3.7).

...
modparam("uac","auth_realm_avp","$avp(i:10)")
...
				

1.3.6. 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" (Section 1.3.5) and "auth_username_avp" (Section 1.3.7).

...
modparam("uac","auth_username_avp","$avp(i:11)")
...
				

1.3.7. 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_password_avp" (Section 1.3.7) and "auth_username_avp" (Section 1.3.7).

...
modparam("uac","auth_password_avp","$avp(i:12)")
...
				

1.4.1. 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.

...
# 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("","");
...
				

1.4.2. uac_replace_from(uri)

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.

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

1.4.3. 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();
...
				

1.4.4. uac_auth()

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.

...
uac_auth();
...