# &adminguide;

## Overview

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.

## Dependencies

### &kamailio; Modules

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

### External Libraries or Applications

The following libraries or applications must be installed before running &kamailio; with this module loaded:

- none

## Parameters

### `use_domain` (integer)

If set to non-zero value, the domain column in the userblacklist table is used.

Default value is 0.

#### Set `use_domain` parameter

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

### `match_mode` (integer)

The number of individual characters that are used for matching. Valid values are 10 or 128. When you specify 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.

#### Set `match_mode` parameter

    ...
    modparam("userblacklist", "match_mode", 128)
    ...

### `db_url` (String)

URL to the database containing the data.

Default value is &defaultrodb;.

#### Set `db_url` parameter

    ...
    modparam("userblacklist", "db_url", "dbdriver://username:password@dbhost/dbname")
    ...

### `userblacklist_table` (String)

Name of the userblacklist table for the userblacklist module.

Default value is userblacklist.

#### Set `userblacklist_table` parameter

    ...
    modparam("userblacklist", "userblacklist_table", "userblacklist")
    ...

### `userblacklist_id_col` (string)

unique ID

#### Set `userblacklist_id_col` parameter

    ...
    modparam("userblacklist", "userblacklist_id_col", "id")
    ...

### `userblacklist_username_col` (string)

The user that is used for the blacklist lookup.

#### Set `userblacklist_username_col` parameter

    ...
    modparam("userblacklist", "userblacklist_username_col", "username")
    ...

### `userblacklist_domain_col` (string)

The domain that is used for the blacklist lookup.

#### Set `userblacklist_domain_col` parameter

    ...
    modparam("userblacklist", "userblacklist_domain_col", "domain")
    ...

### `userblacklist_prefix_col` (string)

The prefix that is matched for the blacklist.

#### Set `userblacklist_prefix_col` parameter

    ...
    modparam("userblacklist", "userblacklist_prefix_col", "prefix")
    ...

### `userblacklist_whitelist_col` (string)

Specify if this a blacklist (0) or a whitelist (1) entry.

#### Set `userblacklist_whitelist_col` parameter

    ...
    modparam("userblacklist", "userblacklist_whitelist_col", "whitelist")
    ...

### `globalblacklist_table` (String)

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.

#### Set `globalblacklist_table` parameter

    ...
    modparam("userblacklist", "globalblacklist_table", "globalblacklist")
    ...

### `globalblacklist_id_col` (string)

unique ID

#### Set `globalblacklist_id_col` parameter

    ...
    modparam("userblacklist", "globalblacklist_id_col", "id")
    ...

### `globalblacklist_prefix_col` (string)

The prefix that is matched for the blacklist.

#### Set `globalblacklist_prefix_col` parameter

    ...
    modparam("userblacklist", "globalblacklist_prefix_col", "prefix")
    ...

### `globalblacklist_whitelist_col` (string)

Specify if this a blacklist (0) or a whitelist (1) entry.

#### Set `globalblacklist_whitelist_col` parameter

    ...
    modparam("userblacklist", "globalblacklist_whitelist_col", "whitelist")
    ...

### `globalblacklist_description_col` (string)

A comment for the entry.

#### Set `globalblacklist_description_col` parameter

    ...
    modparam("userblacklist", "globalblacklist_description_col", "description")
    ...

## Functions

### `check_user_blacklist (string user, string domain, string number, string table)`

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.

#### `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;
    }
    ...

### `check_user_whitelist (string user, string domain, string number, string table)`

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.

#### `check_user_whitelist` usage

    ...
    $avp(i:80) = $rU;
    # rewrite the R-URI
    if (!check_user_whitelist("$avp(i:80)", "$avp(i:82)")) {
    	# process request
    	exit;
    }
    ...

### `check_blacklist ([string table])`

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.

#### `check_blacklist` usage

    ...
    if (!check_blacklist("globalblacklist")) {
    	sl_send_reply("403", "Forbidden");
    	exit;
    }
    ...

### `check_whitelist (string table)`

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.

#### `check_whitelist` usage

    ...
    if (!check_whitelist("globalblacklist")) {
    	sl_send_reply("403", "Forbidden");
    	exit;
    }
    ...

## RPC Commands

### `userblacklist.reload_blacklist`

Reload the internal global blacklist cache. This is necessary after the database tables for the global blacklist have been changed.

#### `userblacklist.reload_blacklist` usage

    ...
    &kamcmd; userblacklist.reload_blacklist
    ...

## MI Commands

### `reload_blacklist`

Reload the internal global blacklist cache. This is necessary after the database tables for the global blacklist have been changed.

#### `reload_blacklist` usage

    					...
    					&ctltool; fifo reload_blacklist
    					...

### `dump_blacklist`

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.

#### `dump_blacklist` usage

    					...
    					&ctltool; fifo reload_blacklist
    					&ctltool; fifo dump_blacklist
    					...

### `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 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.

#### `check_blacklist` usage

    					...
    					&ctltool; fifo reload_blacklist
    					&ctltool; fifo check_blacklist prefix
    					...

### `check_whitelist 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.

#### `check_whitelist` usage

    					...
    					&ctltool; fifo reload_blacklist
    					&ctltool; fifo check_whitelist prefix
    					...

### `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 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.

#### `check_userblacklist` usage

    					...
    					&ctltool; fifo check_userblacklist user [domain] prefix
    					...

### `check_userwhitelist 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.

#### `check_userwhitelist` usage

    					...
    					&ctltool; fifo check_userwhitelist user [domain] prefix
    					...

## Installation and Running

### Database setup

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, &kamailiodbdocs;.

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