1.2.1. OpenSER Modules

The following modules must be loaded before this module:

• a OpenSER database module .

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. db_url (string)

URL of the database to be used.

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

Default value is "DEFAULT_RODB_URL".

...
modparam("uri_db", "db_url", "mysql://username:password@localhost/openser")
...

1.3.2. uri_table (string)

Table containing list of allowed URIs for each user.

Default value is "uri".

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

1.3.3. uri_user_column (string)

Column holding usernames in the URI table.

Default value is "username".

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

1.3.4. uri_domain_column (string)

Column holding domain in the URI table.

Default value is "domain".

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

1.3.5. uri_uriuser_column (string)

Column holding URI username in the URI table.

Default value is "uri_user".

...
modparam("uri_db", "uri_uriuser_column", "uri_user")
...

1.3.6. subscriber_table (string)

Name of the subscriber table.

Default value is "subscriber".

...
modparam("uri_db", "subscriber_table", "subscriber")
...

1.3.7. subscriber_user_column (string)

Column holding username in subscriber table.

Default value is "username".

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

1.3.8. subscriber_domain_column (string)

Column holding domains in the subscriber table.

Default value is "domain".

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

1.3.9. use_uri_table (integer)

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

1.3.10. use_domain (integer)

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

1.4.1. check_to()

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

1.4.2. check_from()

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

1.4.3. does_uri_exist()

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