Table of Contents
use_domain (integer)
match_mode (integer)
db_url (String)
userblacklist_table (String)
userblacklist_id_col (string)
userblacklist_username_col (string)
userblacklist_domain_col (string)
userblacklist_prefix_col (string)
userblacklist_whitelist_col (string)
globalblacklist_table (String)
globalblacklist_id_col (string)
globalblacklist_prefix_col (string)
globalblacklist_whitelist_col (string)
globalblacklist_description_col (string)
List of Examples
use_domain parametermatch_mode parameterdb_url parameteruserblacklist_table parameteruserblacklist_id_col parameteruserblacklist_username_col parameteruserblacklist_domain_col parameteruserblacklist_prefix_col parameteruserblacklist_whitelist_col parameterglobalblacklist_table parameterglobalblacklist_id_col parameterglobalblacklist_prefix_col parameterglobalblacklist_whitelist_col parameterglobalblacklist_description_col parametercheck_user_blacklist usagecheck_user_blacklist usagecheck_blacklist usagecheck_whitelist usagereload_blacklist usagedump_blacklist usagecheck_blacklist usagecheck_whitelist usagecheck_userblacklist usagecheck_userwhitelist usageTable of Contents
use_domain (integer)
match_mode (integer)
db_url (String)
userblacklist_table (String)
userblacklist_id_col (string)
userblacklist_username_col (string)
userblacklist_domain_col (string)
userblacklist_prefix_col (string)
userblacklist_whitelist_col (string)
globalblacklist_table (String)
globalblacklist_id_col (string)
globalblacklist_prefix_col (string)
globalblacklist_whitelist_col (string)
globalblacklist_description_col (string)
The userblacklist module allows Kamailio to handle blacklists on a per user basis. This information is stored in a database table, which is queried to decide if the number (more exactly, the request URI user) is blacklisted or not.
An additional functionality that this module provides is the ability to handle global blacklists. This lists are loaded on startup into memory, thus providing a better performance than the userblacklist case. These global blacklists are useful to allow only calls to certain international destinations, i.e. block all not whitelisted numbers. They could also be used to prevent the blacklisting of important numbers, as whitelisting is supported too. This is useful for example to prevent the customer from blocking emergency call number or service hotlines.
The module exports four functions, check_blacklist,
check_whitelist,
check_user_blacklist and check_user_whitelist
for usage in the configuration file. Furthermore it provides a MI function to
reload the global blacklist cache.
Please note that only numerical strings for matching are supported at the moment (the used library supports this already, but its not yet implemented in the module). Non-digits on the beginning of the matched string are skipped, any later non-digits will stop the matching on this position.
The module depends on the following modules (in the other words the listed modules must be loaded before this module):
database -- Any db_* database module
If set to non-zero value, the domain column in the userblacklist table is used.
Default value is “0”.
The number of individual characters that are used for matching. Valid values are 10 or 128. When you specifiy 10, only digits will be used for matching, this operation mode is equivalent to the old behaviour. When configured with 128, all standard ASCII chars are available for matching. Please be aware that memory requirements for storing the routing tree in shared memory will also increase by a factor of 12.8.
Default value is “10”.
URL to the database containing the data.
Default value is “mysql://kamailioro:kamailioro@localhost/kamailio”.
Example 1.3. Set db_url parameter
...
modparam("userblacklist", "db_url", "dbdriver://username:password@dbhost/dbname")
...
Name of the userblacklist table for the userblacklist module.
Default value is “userblacklist”.
Example 1.4. Set userblacklist_table parameter
...
modparam("userblacklist", "userblacklist_table", "userblacklist")
...
unique ID
Example 1.5. Set userblacklist_id_col parameter
...
modparam("userblacklist", "userblacklist_id_col", "id")
...
The user that is used for the blacklist lookup.
Example 1.6. Set userblacklist_username_col parameter
...
modparam("userblacklist", "userblacklist_username_col", "username")
...
The domain that is used for the blacklist lookup.
Example 1.7. Set userblacklist_domain_col parameter
...
modparam("userblacklist", "userblacklist_domain_col", "domain")
...
The prefix that is matched for the blacklist.
Example 1.8. Set userblacklist_prefix_col parameter
...
modparam("userblacklist", "userblacklist_prefix_col", "prefix")
...
Specify if this a blacklist (0) or a whitelist (1) entry.
Example 1.9. Set userblacklist_whitelist_col parameter
...
modparam("userblacklist", "userblacklist_whitelist_col", "whitelist")
...
Name of the globalblacklist table for the userblacklist module. Please note that this table is used when the check_blacklist function is called with no parameters.
Default value is “globalblacklist”.
Example 1.10. Set globalblacklist_table parameter
...
modparam("userblacklist", "globalblacklist_table", "globalblacklist")
...
unique ID
Example 1.11. Set globalblacklist_id_col parameter
...
modparam("userblacklist", "globalblacklist_id_col", "id")
...
The prefix that is matched for the blacklist.
Example 1.12. Set globalblacklist_prefix_col parameter
...
modparam("userblacklist", "globalblacklist_prefix_col", "prefix")
...
Finds the longest prefix that matches the request URI user (or the number parameter) for the given user and domain name in the database. If a match is found and it is not set to whitelist, false is returned. Otherwise, true is returned. Pseudo-variables or AVPs can be used for the user, domain and number parameters. The number and table variables are optional, the defaults are used if they are omitted. The number parameter can be used to check for example against the from URI user.
Example 1.15. check_user_blacklist usage
...
$avp(i:80) = $rU;
# rewrite the R-URI
if (!check_user_blacklist("$avp(i:80)", "$avp(i:82)")) {
sl_send_reply("403", "Forbidden");
exit;
}
...
Finds the longest prefix that matches the request URI user (or the number parameter) for the given user and domain name in the database. If a match is found and it is set to whitelist, true is returned. Otherwise, false is returned. Pseudo-variables or AVPs can be used for the user, domain and number parameters. The number and table variables are optional, the defaults are used if they are omitted. The number parameter can be used to check for example against the from URI user.
Example 1.16. check_user_blacklist usage
...
$avp(i:80) = $rU;
# rewrite the R-URI
if (!check_user_whitelist("$avp(i:80)", "$avp(i:82)")) {
# process request
exit;
}
...
Finds the longest prefix that matches the request URI for the given table. If a match is found and it is not set to whitelist, false is returned. Otherwise, true is returned. If no table is given, then globalblacklist_table is used.
Example 1.17. check_blacklist usage
...
if (!check_blacklist("globalblacklist")) {
sl_send_reply("403", "Forbidden");
exit;
}
...
Finds the longest prefix that matches the request URI for the given table. If a match is found and it is set to whitelist, true is returned. Otherwise, false is returned.
Example 1.18. check_whitelist usage
...
if (!check_whitelist("globalblacklist")) {
sl_send_reply("403", "Forbidden");
exit;
}
...
Reload the internal global blacklist cache. This is necessary after the database tables for the global blacklist have been changed.
Dumps the default, in memory, global_blacklist content to stdout. Note that a reload_blacklist should be issued before, in order to see the latest content of the database.
Searches in the default, in memory, global list. Finds the longest prefix that matches the given prefix parameter. Returns true if the prefix is found and the whitelist is not set. Returns false otherwise - either prefix found and whitelist set or prefix not found. Note that a reload_blacklist should be issued before, in order to check through the latest content of the database.
Example 1.21. check_blacklist usage
... kamctl fifo reload_blacklist kamctl fifo check_blacklist prefix ...
Searches in the default, in memory, global list. Finds the longest prefix that matches the given prefix parameter. Returns true if the prefix is found and the whitelist is set. Returns false otherwise - either prefix found and whitelist not set or prefix not found. Note that a reload_blacklist should be issued before, in order to check through the latest content of the database.
Example 1.22. check_whitelist usage
... kamctl fifo reload_blacklist kamctl fifo check_whitelist prefix ...
Searches in the default user list table. Finds the longest prefix for the given user@domain that matches the given prefix parameter. Returns true if the prefix is found and the whitelist is not set. Returns false otherwise - either prefix found and whitelist set or prefix not found. Note that the domain parameter is optional. If not given, the second parameter is the considered to be the prefix.
Example 1.23. check_userblacklist usage
... kamctl fifo check_userblacklist user [domain] prefix ...
Searches in the default user list table. Finds the longest prefix for the given user@domain that matches the given prefix parameter. Returns true if the prefix is found and the whitelist is set. Returns false otherwise - either prefix found and whitelist not set or prefix not found. Note that the domain parameter is optional. If not given, the second parameter is the considered to be the prefix.
Example 1.24. check_userwhitelist usage
... kamctl fifo check_userwhitelist user [domain] prefix ...
Before running Kamailio with the userblacklist module, you have to setup the database table where the module will read the blacklist data. For that, if the table was not created by the installation script or you choose to install everything by yourself you can use the userblacklist-create.sql SQL script in the database directories in the kamailio/scripts folder as template. Database and table name can be set with module parameters so they can be changed, but the name of the columns must be as they are in the SQL script. You can also find the complete database documentation on the project webpage, http://www.kamailio.org/docs/db-tables/kamailio-db-devel.html.
Example 1.25. Example database content - globalblacklist table
... +----+-----------+-----------+ | id | prefix | whitelist | +----+-----------+-----------+ | 1 | | 0 | | 2 | 1 | 1 | | 3 | 123456 | 0 | | 4 | 123455787 | 0 | +----+-----------+-----------+ ...
This table will setup a global blacklist for all numbers, only allowing calls starting with “1”. Numbers that starts with “123456” and “123455787” are also blacklisted, because the longest prefix will be matched.
Example 1.26. Example database content - userblacklist table
... +----+----------------+-------------+-----------+-----------+ | id | username | domain | prefix | whitelist | +----+----------------+-------------+-----------+-----------+ | 23 | 49721123456788 | | 1234 | 0 | | 22 | 49721123456788 | | 123456788 | 1 | | 21 | 49721123456789 | | 12345 | 0 | | 20 | 494675231 | | 499034133 | 1 | | 19 | 494675231 | test | 499034132 | 0 | | 18 | 494675453 | test.domain | 49901 | 0 | | 17 | 494675454 | | 49900 | 0 | +----+----------------+-------------+-----------+-----------+ ...
This table will setup user specific blacklists for certain usernames. For example for user “49721123456788” the prefix “1234” will be not allowed, but the number “123456788” is allowed. Additionally a domain could be specified that is used for username matching if the “use_domain” parameter is set.