uri Module

At least one of the following modules must be loaded before this module:

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

This is the url representing the AAA protocol used and the location of the configuration file of this protocol.

...
modparam("uri", "aaa_url", "radius:/etc/radiusclient-ng/radiusclient.conf")
...

AAA service type used in aaa_does_uri_exist and aaa_does_uri_user_exist checks.

Default value is 10 (Call-Check).

...
modparam("uri", "service_type", 11)
...

If zero, aaa_does_uri_exist sends to AAA server Request URI user@host in UserName attribute. If non-zero, aaa_does_uri_exist sends to AAA server Request URI user in UserName attribute and host in SIP-URI-Host attribute.

Default value is 0.

...
modparam("uri", "use_sip_uri_host", 1)
...

URL of the database to be used.

If the db_url string is not set, you will not be able to use the DB related functions.

Default value is “>NULL”.

...
modparam("uri", "db_url", "mysql://username:password@localhost/opensips")
...

The DB table that should be used. Its possible to use the “subscriber” and “uri” table. If the “uri” table should be used, an additional parameter (use_uri_table) must be set.

Default value is “subscriber”.

...
modparam("uri", "db_table", "uri")
...

Column holding usernames in the table.

Default value is “username”.

...
modparam("uri", "user_column", "username")
...

Column holding domain in the table.

Default value is “domain”.

...
modparam("uri", "domain_column", "domain")
...

Column holding URI username in the table.

Default value is “uri_user”.

...
modparam("uri", "uriuser_column", "uri_user")
...

Specify if the “uri” table should be used for checkings instead of “subscriber” table. A non-zero value means true.

Default value is “0 (false)”.

...
modparam("uri", "use_uri_table", 1)
...

Specify if the domain part of the URI should be used to identify the users (along with username). This is useful in multi domain setups, a non-zero value means true.

This parameter is only evaluated for calls to “does_uri_exist”, all other functions checks the digest username and realm against the given username, if the “uri” table is used.

Default value is “0 (false)”.

...
modparam("uri", "use_domain", 1)
...

Check To username against URI table (if use_uri_table is set) or digest credentials (no DB backend required).

This function can be used from REQUEST_ROUTE.

...
if (db_check_to()) {
	...
};
...

Check From username against URI table (if use_uri_table is set) or digest credentials (no DB backend required).

This function can be used from REQUEST_ROUTE.

...
if (db_check_from()) {
	...
};
...

Check if username in the request URI belongs to an existing user.

Matching is done against the URI table (if use_uri_table is set) or the subscriber table.

This function can be used from REQUEST_ROUTE.

...
if (db_does_uri_exist()) {
	...
};
...

Checks given uri-string username against URI table (if use_uri_table is set) or subscriber table (database backend required). Returns true if the user exists in the database, and sets the given variables to the authentication id and realm corresponding to the given uri.

This function can be used from REQUEST_ROUTE.

...
if (db_get_auth_id("$ru", "$avp(auth_id)", "$avp(auth_realm)")) {
	...
};
...

Checks from Radius if user@host in Request-URI or in URI stored in pseudo variable argument belongs to a local user. Can be used to decide if 404 or 480 should be returned after lookup has failed. If yes, loads AVP based on SIP-AVP reply items returned from Radius. Each SIP-AVP reply item must have a string value of form:

Returns 1 if Radius returns Access-Accept, -1 if Radius returns Access-Reject, and -2 in case of internal error.

This function can be used from REQUEST_ROUTE.

...
if (aaa_does_uri_exist()) {
	...
};
...

Similar to aaa_does_uri_exist, but check is done based only on Request-URI user part or user stored in pseudo variable argument. User should thus be unique among all users, such as an E.164 number.

This function can be used from REQUEST_ROUTE.

...
if (aaa_does_uri_user_exist()) {
	...
};
...

Check if the username in credentials matches the given username.

Meaning of the parameters is as follows:

This function can be used from REQUEST_ROUTE.

...
if (is_user("john")) {
	...
};
...

Check if To header field uri contains tag parameter.

This function can be used from REQUEST_ROUTE.

...
if (has_totag()) {
	...
};
...

Find if Request URI has a given parameter with no value

Meaning of the parameters is as follows:

This function can be used from REQUEST_ROUTE.

...
if (uri_param("param1")) {
	...
};
...

Find if Request URI has a given parameter with matching value

Meaning of the parameters is as follows:

This function can be used from REQUEST_ROUTE.

...
if (uri_param("param1","value1")) {
	...
};
...

Add to RURI a parameter (name=value);

Meaning of the parameters is as follows:

This function can be used from REQUEST_ROUTE.

...
add_uri_param("nat=yes");
...

Delete a parameter from the RURI being given the key(key=value);

Meaning of the parameters is as follows:

This function can be used from REQUEST_ROUTE.

...
del_uri_param("name");
...

Converts RURI, if it is tel URI, to SIP URI. Returns true, only if conversion succeeded or if no conversion was needed (like RURI was not tel URI.

This function can be used from REQUEST_ROUTE.

...
tel2sip();
...

Checks if userpart of URI stored in pseudo variable is E164 number.

This function can be used from REQUEST_ROUTE and FAILURE_ROUTE.

...
if (is_uri_user_e164("$fu")) {  # Check From header URI user part
   ...
}
if (is_uri_user_e164("$avp(uri)") {
   # Check user part of URI stored in avp uri
   ...
};
...