1. Uri_db Module

Jan Janak

FhG FOKUS

1.1. Overview
1.2. Dependencies
1.3. Parameters
1.3.1. db_url (string)
1.3.2. uri_table (string)
1.3.3. uri_user_column (string)
1.3.4. uri_domain_column (string)
1.3.5. uri_uriuser_column (string)
1.3.6. subscriber_table (string)
1.3.7. subscriber_user_column (string)
1.3.8. subscriber_domain_column (string)
1.4. Functions
1.4.1. check_to()
1.4.2. check_from()
1.4.3. does_uri_exist()

1.1. Overview

Various checks related to SIP URI.

1.2. Dependencies

The following modules must be loaded before this module:

  • A SER database module.

1.3. Parameters

1.3.1. db_url (string)

URL of the database to be used.

Default value is "mysql://serro:47serro11@localhost/ser".

Example 1. Set db_url parameter

...
modparam("module", "db_url", "mysql://username:password@localhost/ser")
...

1.3.2. uri_table (string)

Table containing list of allowed URIs for each user.

Default value is "uri".

Example 2. Set uri_table parameter

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

1.3.3. uri_user_column (string)

Column holding usernames in the URI table.

Default value is "username".

Example 3. Set uri_user_column parameter

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

1.3.4. uri_domain_column (string)

Column holding domain in the URI table.

Default value is "domain".

Example 4. Set uri_domain_column parameter

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

1.3.5. uri_uriuser_column (string)

Column holding URI username in the URI table.

Default value is "uri_user".

Example 5. Set uri_uriuser_column parameter

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

1.3.6. subscriber_table (string)

Name of the subscriber table.

Default value is "subscriber".

Example 6. Set subscriber_table parameter

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

1.3.7. subscriber_user_column (string)

Column holding username in subscriber table.

Default value is "username".

Example 7. Set subscriber_user_column parameter

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

1.3.8. subscriber_domain_column (string)

Column holding domains in the subscriber table.

Default value is "domain".

Example 8. Set subscriber_domain_column parameter

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

1.4. Functions

1.4.1.  check_to()

Check To username against URI table or digest credentials.

Example 9. check_to usage

...
if (check_to()) {
    ...
};
...

1.4.2.  check_from()

Check From username against URI table or digest credentials.

Example 10. check_from usage

...
if (check_from()) {
    ...
};
...

1.4.3.  does_uri_exist()

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

Example 11. does_uri_exist usage

...
if (does_uri_exist()) {
    ...
};
...