
permissions Module

Miklos Tirpak

Edited by

Miklos Tirpak

Bogdan-Andrei Iancu

Juha Heinanen

   Copyright © 2003 Miklos Tirpak

   Copyright © 2006 Juha Heinanen
     _________________________________________________________

   Table of Contents
   1. User's Guide

        1.1. Overview

              1.1.1. Call Routing
              1.1.2. Registration Permissions
              1.1.3. URI Permissions
              1.1.4. Address Permissions
              1.1.5. Trusted Requests

        1.2. Dependencies

              1.2.1. OpenSER Modules
              1.2.2. External Libraries or Applications

        1.3. Exported Parameters

              1.3.1. default_allow_file (string)
              1.3.2. default_deny_file (string)
              1.3.3. check_all_branches (integer)
              1.3.4. allow_suffix (string)
              1.3.5. deny_suffix (string)
              1.3.6. db_url (string)
              1.3.7. address_table (string)
              1.3.8. grp_col (string)
              1.3.9. ip_addr_col (string)
              1.3.10. mask_col (string)
              1.3.11. port_col (string)
              1.3.12. db_mode (integer)
              1.3.13. trusted_table (string)
              1.3.14. source_col (string)
              1.3.15. proto_col (string)
              1.3.16. from_col (string)
              1.3.17. tag_col (string)
              1.3.18. peer_tag_avp (string)

        1.4. Exported Functions

              1.4.1. allow_routing()
              1.4.2. allow_routing(basename)
              1.4.3. allow_routing(allow_file,deny_file)
              1.4.4. allow_register(basename)
              1.4.5. allow_register(allow_file, deny_file)
              1.4.6. allow_uri(basename, pseudo-variable)
              1.4.7. set_address_group(group_id)
              1.4.8. allow_address(ip_addr_pv, port_pv)
              1.4.9. allow_source_address(group_id)
              1.4.10. allow_trusted()

        1.5. Exported MI Functions

              1.5.1. address_reload
              1.5.2. address_dump
              1.5.3. subnet_dump
              1.5.4. trusted_reload
              1.5.5. trusted_dump

   2. Developer's Guide
   3. Frequently Asked Questions

   List of Examples
   1-1. Set default_allow_file parameter
   1-2. Set default_deny_file parameter
   1-3. Set check_all_branches parameter
   1-4. Set allow_suffix parameter
   1-5. Set deny_suffix parameter
   1-6. Set db_url parameter
   1-7. Set address_table parameter
   1-8. Set grp_col parameter
   1-9. Set ip_addr_col parameter
   1-10. Set mask_col parameter
   1-11. Set port_col parameter
   1-12. Set db_mode parameter
   1-13. Set trusted_table parameter
   1-14. Set source_col parameter
   1-15. Set proto_col parameter
   1-16. Set from_col parameter
   1-17. Set tag_col parameter
   1-18. Set peer_tag_avp parameter
   1-19. allow_routing usage
   1-20. allow_routing(basename) usage
   1-21. allow_routing(allow_file, deny_file) usage
   1-22. allow_register(basename) usage
   1-23. allow_register(allow_file, deny_file) usage
   1-24. allow_uri(basename, pseudo-variable) usage
   1-25. set_address_group(group_id) usage
   1-26. allow_address(ip_addr_pv, port_pv) usage
   1-27. allow_source_address(group_id) usage
   1-28. allow_trusted() usage
     _________________________________________________________

Chapter 1. User's Guide

1.1. Overview

1.1.1. Call Routing

   The module can be used to determine if a call has appropriate
   permission to be established. Permission rules are stored in
   plaintext configuration files similar to hosts.allow and
   hosts.deny files used by tcpd.

   When allow_routing function is called it tries to find a rule
   that matches selected fields of the message.

   OpenSER is a forking proxy and therefore a single message can
   be sent to different destinations simultaneously. When
   checking permissions all the destinations must be checked and
   if one of them fails, the forwarding will fail.

   The matching algorithm is as follows, first match wins:

     * Create a set of pairs of form (From, R-URI of branch 1),
       (From, R-URI of branch 2), etc.
     * Routing will be allowed when all pairs match an entry in
       the allow file.
     * Otherwise routing will be denied when one of pairs matches
       an entry in the deny file.
     * Otherwise, routing will be allowed.

   A non-existing permission control file is treated as if it
   were an empty file. Thus, permission control can be turned off
   by providing no permission control files.

   From header field and Request-URIs are always compared with
   regular expressions! For the syntax see the sample file:
   config/permissions.allow.
     _________________________________________________________

1.1.2. Registration Permissions

   In addition to call routing it is also possible to check
   REGISTER messages and decide--based on the configuration
   files--whether the message should be allowed and the
   registration accepted or not.

   Main purpose of the function is to prevent registration of
   "prohibited" IP addresses. One example, when a malicious user
   registers a contact containing IP address of a PSTN gateway,
   he might be able to bypass authorization checks performed by
   the SIP proxy. That is undesirable and therefore attempts to
   register IP address of a PSTN gateway should be rejected.
   Files config/register.allow and config/register.deny contain
   an example configuration.

   Function for registration checking is called allow_register
   and the algorithm is very similar to the algorithm described
   in Section 1.1.1. The only difference is in the way how pairs
   are created.

   Instead of From header field the function uses To header field
   because To header field in REGISTER messages contains the URI
   of the person being registered. Instead of the Request-URI of
   branches the function uses Contact header field.

   Thus, pairs used in matching will look like this: (To, Contact
   1), (To, Contact 2), (To, Contact 3), and so on..

   The algorithm of matching is same as described in Section
   1.1.1.
     _________________________________________________________

1.1.3. URI Permissions

   The module can be used to determine if request is allowed to
   the destination specified by an URI stored in a
   pseudo-variable. Permission rules are stored in plaintext
   configuration files similar to hosts.allow and hosts.deny used
   by tcpd.

   When allow_uri function is called, it tries to find a rule
   that matches selected fields of the message. The matching
   algorithm is as follows, first match wins:

     * Create a pair <From URI, URI stored in pseudo-variable>.
     * Request will be allowed when the pair matches an entry in
       the allow file.
     * Otherwise request will be denied when the pair matches an
       entry in the deny file.
     * Otherwise, request will be allowed.

   A non-existing permission control file is treated as if it
   were an empty file. Thus, permission control can be turned off
   by providing no permission control files.

   From URI and URI stored in pseudo-variable are always compared
   with regular expressions! For the syntax see the sample file:
   config/permissions.allow.
     _________________________________________________________

1.1.4. Address Permissions

   The module can be used to determine if an address (IP address
   and port) matches any of the IP subnets stored in cached
   openser database table. Port 0 in cached database table
   matches any port. IP address and port to be matched can be
   either taken from the request (allow_source_address) or given
   as pseudo value arguments (allow_address).

   Addresses stored in cached database table can be grouped
   together into one or more groups specified by a group
   identifier (unsigned integer). Group identifier is given as
   argument to allow_source_address function or assigned
   separately for subsequent allow_address function calls using
   set_address_group function.
     _________________________________________________________

1.1.5. Trusted Requests

   The module can be used to determine if an incoming request can
   be trusted without authentication.

   When allow_trusted function is called, it tries to find a rule
   that matches the request. Rules contain the following fields:
   <source address, transport protocol, regular expression>.

   A requests is accepted if there exists a rule, where

     * source address is equal to source address of request,
     * transport protocol is either "any" or equal to transport
       protocol of request, and
     * regular expression is either empty (NULL in database) or
       matches From URI of request.

   Otherwise the request is rejected.

   Rules are stored in a database table specified by module
   parameters. There also exists a module parameter that
   determines if rules are cached into memory for faster matching
   or if database is consulted for each invocation of
   allow_trusted function call.
     _________________________________________________________

1.2. Dependencies

1.2.1. OpenSER Modules

   The following modules must be loaded before this module:

     * No dependencies on other OpenSER modules.
     _________________________________________________________

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. Exported Parameters

1.3.1. default_allow_file (string)

   Default allow file used by functions without parameters. If
   you don't specify full pathname then the directory in which is
   the main config file is located will be used.

   Default value is "permissions.allow". 

   Example 1-1. Set default_allow_file parameter
...
modparam("permissions", "default_allow_file", "/etc/permissions.allow")
...
     _________________________________________________________

1.3.2. default_deny_file (string)

   Default file containing deny rules. The file is used by
   functions without parameters. If you don't specify full
   pathname then the directory in which the main config file is
   located will be used.

   Default value is "permissions.deny". 

   Example 1-2. Set default_deny_file parameter
...
modparam("permissions", "default_deny_file", "/etc/permissions.deny")
...
     _________________________________________________________

1.3.3. check_all_branches (integer)

   If set then allow_routing functions will check Request-URI of
   all branches (default). If disabled then only Request-URI of
   the first branch will be checked.

   Warning

   Do not disable this parameter unless you really know what you
   are doing.

   Default value is 1. 

   Example 1-3. Set check_all_branches parameter
...
modparam("permissions", "check_all_branches", 0)
...
     _________________________________________________________

1.3.4. allow_suffix (string)

   Suffix to be appended to basename to create filename of the
   allow file when version with one parameter of either
   allow_routing or allow_register is used.

   Note

   Including leading dot.

   Default value is ".allow". 

   Example 1-4. Set allow_suffix parameter
...
modparam("permissions", "allow_suffix", ".allow")
...
     _________________________________________________________

1.3.5. deny_suffix (string)

   Suffix to be appended to basename to create filename of the
   deny file when version with one parameter of either
   allow_routing or allow_register is used.

   Note

   Including leading dot.

   Default value is ".deny". 

   Example 1-5. Set deny_suffix parameter
...
modparam("permissions", "deny_suffix", ".deny")
...
     _________________________________________________________

1.3.6. db_url (string)

   This is URL of the database to be used to store rules used by
   allow_trusted function.

   Default value is "NULL". 

   Example 1-6. Set db_url parameter
...
modparam("permissions", "db_url", "mysql://openser:pass@db_host/openser
")
...
     _________________________________________________________

1.3.7. address_table (string)

   Name of database table containing IP subnet information used
   by allow_address and allow_source_address functions.

   Default value is "address". 

   Example 1-7. Set address_table parameter
...
modparam("permissions", "address_table", "addr")
...
     _________________________________________________________

1.3.8. grp_col (string)

   Name of address table column containing group identifier of
   the address.

   Default value is "grp". 

   Example 1-8. Set grp_col parameter
...
modparam("permissions", "grp_col", "group_id")
...
     _________________________________________________________

1.3.9. ip_addr_col (string)

   Name of address table column containing IP address part of the
   address.

   Default value is "ip_addr". 

   Example 1-9. Set ip_addr_col parameter
...
modparam("permissions", "ip_addr_col", "ip_address")
...
     _________________________________________________________

1.3.10. mask_col (string)

   Name of address table column containing network mask of the
   address. Possible values are 0-32.

   Default value is "mask". 

   Example 1-10. Set mask_col parameter
...
modparam("permissions", "mask_col", "subnet_length")
...
     _________________________________________________________

1.3.11. port_col (string)

   Name of address table column containing port part of the
   address.

   Default value is "port". 

   Example 1-11. Set port_col parameter
...
modparam("permissions", "port_col", "prt")
...
     _________________________________________________________

1.3.12. db_mode (integer)

   Database mode. 0 means non-caching, 1 means caching. Valid
   only for allow_trusted function.

   Default value is 0 (non-caching). 

   Example 1-12. Set db_mode parameter
...
modparam("permissions", "db_mode", 1)
...
     _________________________________________________________

1.3.13. trusted_table (string)

   Name of database table containing matching rules used by
   allow_register function.

   Default value is "trusted". 

   Example 1-13. Set trusted_table parameter
...
modparam("permissions", "trusted_table", "pbx")
...
     _________________________________________________________

1.3.14. source_col (string)

   Name of trusted table column containing source IP address that
   is matched against source IP address of received request.

   Default value is "src_ip". 

   Example 1-14. Set source_col parameter
...
modparam("permissions", "source_col", "source_ip_address")
...
     _________________________________________________________

1.3.15. proto_col (string)

   Name of trusted table column containing transport protocol
   that is matched against transport protocol of received
   request. Possible values that can be stored in proto_col are
   "any", "udp", "tcp", "tls", "sctp", and "none". Value "any"
   matches always and value "none" never.

   Default value is "proto". 

   Example 1-15. Set proto_col parameter
...
modparam("permissions", "proto_col", "transport")
...
     _________________________________________________________

1.3.16. from_col (string)

   Name of trusted table column containing regular expression
   that is matched against From URI.

   Default value is "from_pattern". 

   Example 1-16. Set from_col parameter
...
modparam("permissions", "from_col", "regexp")
...
     _________________________________________________________

1.3.17. tag_col (string)

   Name of trusted table column containing a string that is added
   as value to peer_tag AVP if peer_tag AVP has been defined and
   if the peer matches.

   Default value is "tag". 

   Example 1-17. Set tag_col parameter
...
modparam("permissions", "tag_col", "peer_tag")
...
     _________________________________________________________

1.3.18. peer_tag_avp (string)

   AVP spec of peer tag AVP. If defined, the AVP will be set as
   side effect of allow_trusted() call to not NULL tag column
   value of the matching peer.

   Default value is "undefined". 

   Example 1-18. Set peer_tag_avp parameter
...
modparam("permissions", "peer_tag_avp", "i:707")
...
     _________________________________________________________

1.4. Exported Functions

1.4.1. allow_routing()

   Returns true if all pairs constructed as described in Section
   1.1.1 have appropriate permissions according to the
   configuration files. This function uses default configuration
   files specified in default_allow_file and default_deny_file.

   This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.

   Example 1-19. allow_routing usage
...
if (allow_routing()) {
        t_relay();
};
...
     _________________________________________________________

1.4.2. allow_routing(basename)

   Returns true if all pairs constructed as described in Section
   1.1.1 have appropriate permissions according to the
   configuration files given as parameters.

   Meaning of the parameters is as follows:

     * basename - Basename from which allow and deny filenames
       will be created by appending contents of allow_suffix and
       deny_suffix parameters.
       If the parameter doesn't contain full pathname then the
       function expects the file to be located in the same
       directory as the main configuration file of the server.

   This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.

   Example 1-20. allow_routing(basename) usage
...
if (allow_routing("basename")) {
        t_relay();
};
...
     _________________________________________________________

1.4.3. allow_routing(allow_file,deny_file)

   Returns true if all pairs constructed as described in Section
   1.1.1 have appropriate permissions according to the
   configuration files given as parameters.

   Meaning of the parameters is as follows:

     * allow_file - File containing allow rules.
       If the parameter doesn't contain full pathname then the
       function expects the file to be located in the same
       directory as the main configuration file of the server.
     * deny_file - File containing deny rules.
       If the parameter doesn't contain full pathname then the
       function expects the file to be located in the same
       directory as the main configuration file of the server.

   This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.

   Example 1-21. allow_routing(allow_file, deny_file) usage
...
if (allow_routing("rules.allow", "rules.deny")) {
        t_relay();
};
...
     _________________________________________________________

1.4.4. allow_register(basename)

   The function returns true if all pairs constructed as
   described in Section 1.1.2 have appropriate permissions
   according to the configuration files given as parameters.

   Meaning of the parameters is as follows:

     * basename - Basename from which allow and deny filenames
       will be created by appending contents of allow_suffix and
       deny_suffix parameters.
       If the parameter doesn't contain full pathname then the
       function expects the file to be located in the same
       directory as the main configuration file of the server.

   This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.

   Example 1-22. allow_register(basename) usage
...
if (method=="REGISTER") {
        if (allow_register("register")) {
                save("location");
                break;
        } else {
                sl_send_reply("403", "Forbidden");
        };
};
...
     _________________________________________________________

1.4.5. allow_register(allow_file, deny_file)

   The function returns true if all pairs constructed as
   described in Section 1.1.2 have appropriate permissions
   according to the configuration files given as parameters.

   Meaning of the parameters is as follows:

     * allow_file - File containing allow rules.
       If the parameter doesn't contain full pathname then the
       function expects the file to be located in the same
       directory as the main configuration file of the server.
     * deny_file - File containing deny rules.
       If the parameter doesn't contain full pathname then the
       function expects the file to be located in the same
       directory as the main configuration file of the server.

   This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.

   Example 1-23. allow_register(allow_file, deny_file) usage
...
if (method=="REGISTER") {
        if (allow_register("register.allow", "register.deny")) {
                save("location");
                break;
        } else {
                sl_send_reply("403", "Forbidden");
        };
};
...
     _________________________________________________________

1.4.6. allow_uri(basename, pseudo-variable)

   Returns true if the pair constructed as described in Section
   1.1.3 have appropriate permissions according to the
   configuration files specified by the parameter.

   Meaning of the parameter is as follows:

     * basename - Basename from which allow and deny filenames
       will be created by appending contents of allow_suffix and
       deny_suffix parameters.
       If the parameter doesn't contain full pathname then the
       function expects the file to be located in the same
       directory as the main configuration file of the server.
     * pseudo-variable - Any pseudo-variable defined in OpenSER.

   This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.

   Example 1-24. allow_uri(basename, pseudo-variable) usage
...
if (allow_uri("basename", "$rt")) {  // Check Refer-To URI
        t_relay();
};
if (allow_uri("basename", "$avp(i:705)") {  // Check URI stored in $avp
(i:705)
        t_relay();
};
...
     _________________________________________________________

1.4.7. set_address_group(group_id)

   Sets address group to be used in subsequent allow_address
   function calls to an unsigned integer value given as argument.
   Argument can be an integer string or a pseudo variable.

   This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.

   Example 1-25. set_address_group(group_id) usage
...

// Set address group identifier to 1.
set_address_group("1");
// Set address group identifier to value of pseudo variable i:100.
set_address_group("$avp(i:100)");
...
     _________________________________________________________

1.4.8. allow_address(ip_addr_pv, port_pv)

   Returns true if IP address and port given as values of pseudo
   variable arguments and belonging to an earlier assigned
   address group matches an IP subnet found in cached address
   table. Cached address table entry containing port value 0
   matches any port.

   This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.

   Example 1-26. allow_address(ip_addr_pv, port_pv) usage
...

// Check source address/port of request
if (!allow_address("$si", "$sp")) {
        sl_send_reply("403", "Forbidden");
};
// Check IP address/port stored in AVPs i:704/i:705
if (!allow_address("$avp(i:704)", "$avp(i:705)") {
        sl_send_reply("403", "Forbidden");
};
...
     _________________________________________________________

1.4.9. allow_source_address(group_id)

   Equal to set_address_group(group_id); allow_address("$si",
   "$sp"), but faster.

   This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.

   Example 1-27. allow_source_address(group_id) usage
...

// Check source address/port of request
if (!allow_source_address("0")) {
        sl_send_reply("403", "Forbidden");
};
...
     _________________________________________________________

1.4.10. allow_trusted()

   Checks based on request's source address, transport protocol,
   and From URI if request can be trusted without authentication.
   Returns 1 if a match is found as described in Section 1.1.5
   and -1 otherwise. If a match is found and peer_tag_avp has
   been defined, adds a non-NULL tag column value of the matching
   peer to AVP peer_tag_avp.

   This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.

   Example 1-28. allow_trusted() usage
...
if (allow_trusted()) {
        t_relay();
};
...
     _________________________________________________________

1.5. Exported MI Functions

1.5.1. address_reload

   Causes permissions module to re-read the contents of address
   database table into cache memory. In cache memory the entries
   are for performance reasons stored in two different tables:
   address table and subnet table depending on the value of the
   mask field (32 or smaller).

   Name: address_reload

   Parameters: none

   MI FIFO Command Format:
                :address_reload:_reply_fifo_file_
                _empty_line_
     _________________________________________________________

1.5.2. address_dump

   Causes permissions module to dump contents of cache memory
   address table.

   Name: address_dump

   Parameters: none

   MI FIFO Command Format:
                :address_dump:_reply_fifo_file_
                _empty_line_
     _________________________________________________________

1.5.3. subnet_dump

   Causes permissions module to dump contents of cache memory
   subnet table.

   Name: subnet_dump

   Parameters: none

   MI FIFO Command Format:
                :subnet_dump:_reply_fifo_file_
                _empty_line_
     _________________________________________________________

1.5.4. trusted_reload

   Causes permissions module to re-read the contents of trusted
   table into cache memory.

   Name: trusted_reload

   Parameters: none

   MI FIFO Command Format:
                :trusted_reload:_reply_fifo_file_
                _empty_line_
     _________________________________________________________

1.5.5. trusted_dump

   Causes permissions module to dump contents of trusted table
   from cache memory.

   Name: trusted_dump

   Parameters: none

   MI FIFO Command Format:
                :trusted_dump:_reply_fifo_file_
                _empty_line_
     _________________________________________________________

Chapter 2. Developer's Guide

   The module does not provide any API to use in other OpenSER
   modules.
     _________________________________________________________

Chapter 3. Frequently Asked Questions

   3.1. Where can I find more about OpenSER?
   3.2. Where can I post a question about this module?
   3.3. How can I report a bug?

   3.1. Where can I find more about OpenSER?

   Take a look at http://openser.org/.

   3.2. Where can I post a question about this module?

   First at all check if your question was already answered on
   one of our mailing lists:

     * User Mailing List -
       http://openser.org/cgi-bin/mailman/listinfo/users
     * Developer Mailing List -
       http://openser.org/cgi-bin/mailman/listinfo/devel

   E-mails regarding any stable OpenSER release should be sent to
   <users@openser.org> and e-mails regarding development versions
   should be sent to <devel@openser.org>.

   If you want to keep the mail private, send it to
   <team@openser.org>.

   3.3. How can I report a bug?

   Please follow the guidelines provided at:
   http://sourceforge.net/tracker/?group_id=139143.
