uri_db Module

The following modules must be loaded before this module:

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

URL of the database to be used.

If the db_url string is empty, the default database URL will be used.

Default value is “mysql://opensipsro:opensipsro@localhost/opensips”.

...
modparam("uri_db", "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 (Section 1.3.6, “use_uri_table (integer)”) must be set.

Default value is “subscriber”.

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

Column holding usernames in the table.

Default value is “username”.

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

Column holding domain in the table.

Default value is “domain”.

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

Column holding URI username in the table.

Default value is “uri_user”.

...
modparam("uri_db", "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_db", "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_db", "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 (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 (check_from()) {
	...
};
...

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

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

This function can be used from REQUEST_ROUTE.

...
if (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 (get_auth_id("$ru", "$avp(s:auth_id)", "$avp(s:auth_realm)")) {
	...
};
...

Number of tests executed for which a positive match is returned.

Number of tests executed for which a negative match is returned. This includes no credentials found, or not match found in database.