Table of Contents
List of Tables
List of Examples
db_url parametertable parameteruser_column parameterdomain_column parametergroup_column parameteruse_domain parameterre_table parameterre_exp_column parameterre_gid_column parametermultiple_gid parameteraaa_url parameterdb_is_user_in usagedb_get_user_group usageaaa_is_user_in usageThis module provides functionalities for different methods of group membership checking.
There is a database table that contains list of users and groups they belong to. The module provides the possibility to check if a specific user belongs to a specific group.
There is no DB caching support, each check involving a DB query.
Another database table contains list of regular expressions and group IDs. A matching occurs if the user URI match the regular expression. This type of matching may be used to fetch the group ID(s) the user belongs to (via RE matching) .
Due performance reasons (regular expression evaluation), DB cache support is available: the table content is loaded into memory at startup and all regular expressions are compiled.
The following modules must be loaded before this module:
A database module, like mysql, postgres or dbtext.
An AAA module, like radius or diameter.
URL of the database table to be used.
Example 1.1. Set db_url parameter
...
modparam("group", "db_url", "mysql://username:password@dbhost/opensips")
...
Name of the table holding strict definitions of groups and their members.
Default value is “grp”.
Name of the “table” column holding usernames.
Default value is “username”.
Name of the “table” column holding domains.
Default value is “domain”.
Name of the “table” column holding groups.
Default value is “grp”.
If enabled (set to non zero value) then domain will be used also used for strict group matching; otherwise only the username part will be used.
Default value is 0 (no).
Name of the table holding definitions for regular-expression based groups. If no table is defined, the regular-expression support is disabled.
Default value is “NULL”.
Name of the “re_table” column holding the regular expression used for user matching.
Default value is “reg_exp”.
Name of the “re_table” column holding the group IDs.
Default value is “group_id”.
If enabled (non zero value) the regular-expression matching will return all group IDs that match the user; otherwise only the first will be returned.
Default value is “1”.
This function is to be used for script group membership. The function returns true if username in the given URI is member of the given group and false if not.
Meaning of the parameters is as follows:
uri (string) - a SIP URI whose username and optionally domain to be used. Possible values:
"Request-URI" - Use Request-URI username and (optionally) domain.
"To" - Use To username and (optionally) domain.
"From" - Use From username and (optionally) domain.
"Credentials" - Use digest credentials username.
(default) - parse the given input as a SIP URI
group (string) - the group to check
This function can be used from REQUEST_ROUTE and FAILURE_ROUTE.
Example 1.12. db_is_user_in usage
...
if (db_is_user_in("Request-URI", "ld")) {
...
}
...
$avp(grouptocheck)="offline";
if (db_is_user_in("Credentials", $avp(grouptocheck))) {
...
}
...
This function is to be used for regular expression based group membership, using DB support. The function returns true if the username in the given "uri" belongs to at least one group.
All matching group IDs shall be returned in "output_avp" if multiple_gid is enabled, otherwise only the first one to match (the records are attempted in reversed order of the results returned by the RDBMS).
Meaning of the parameters is as follows:
uri (string) - a SIP URI to be matched against the regular expressions:
"Request-URI" - Use Request-URI
"To" - Use To URI.
"From" - Use From URI
"Credentials" - Use digest credentials username and realm.
(default) - parse the given input as a SIP URI
output_avp (var) - a list of matched group IDs
This function can be used from REQUEST_ROUTE and FAILURE_ROUTE.
Example 1.13. db_get_user_group usage
...
if (db_get_user_group("Request-URI", $avp(10))) {
xdbg("User $ru belongs to the following groups: $(avp(10)[*])\n");
....
};
...
This function checks group membership, using AAA support. The function returns true if username in the given "uri" is member of the given group and false if not.
Meaning of the parameters is as follows:
uri (string) - a SIP URI whose username and optionally domain to be used, this can be one of:
"Request-URI" - Use Request-URI username and (optionally) domain.
"To" - Use To username and (optionally) domain.
"From" - Use From username and (optionally) domain.
"Credentials" - Use digest credentials username.
group (string) - Name of the group to check.
This function can be used from REQUEST_ROUTE.
Table 2.1. Top contributors by DevScore(1), authored commits(2) and lines added/removed(3)
| Name | DevScore | Commits | Lines ++ | Lines -- | |
|---|---|---|---|---|---|
| 1. | Bogdan-Andrei Iancu (@bogdan-iancu) | 46 | 31 | 848 | 397 |
| 2. | Jan Janak (@janakj) | 35 | 20 | 1370 | 148 |
| 3. | Daniel-Constantin Mierla (@miconda) | 24 | 18 | 176 | 226 |
| 4. | Liviu Chircu (@liviuchircu) | 16 | 12 | 87 | 154 |
| 5. | Razvan Crainea (@razvancrainea) | 9 | 7 | 16 | 39 |
| 6. | Irina-Maria Stanescu | 9 | 4 | 466 | 59 |
| 7. | Andrei Pelinescu-Onciul | 7 | 5 | 101 | 40 |
| 8. | Henning Westerholt (@henningw) | 7 | 5 | 27 | 46 |
| 9. | Vlad Patrascu (@rvlad-patrascu) | 5 | 2 | 78 | 106 |
| 10. | Sergio Gutierrez | 5 | 1 | 122 | 72 |
All remaining contributors: Edson Gellert Schubert, Jiri Kuthan (@jiriatipteldotorg), Maksym Sobolyev (@sobomax), Peter Lemenkov (@lemenkov), Walter Doekes (@wdoekes), Dan Pascu (@danpascu), Konstantin Bokarius, Alexandra Titoc, Norman Brandinger (@NormB), UnixDev, Anca Vamanu.
(1) DevScore = author_commits + author_lines_added / (project_lines_added / project_commits) + author_lines_deleted / (project_lines_deleted / project_commits)
(2) including any documentation-related commits, excluding merge commits. Regarding imported patches/code, we do our best to count the work on behalf of the proper owner, as per the "fix_authors" and "mod_renames" arrays in opensips/doc/build-contrib.sh. If you identify any patches/commits which do not get properly attributed to you, please submit a pull request which extends "fix_authors" and/or "mod_renames".
(3) ignoring whitespace edits, renamed files and auto-generated files
Table 2.2. Most recently active contributors(1) to this module
| Name | Commit Activity | |
|---|---|---|
| 1. | Alexandra Titoc | Sep 2024 - Sep 2024 |
| 2. | Liviu Chircu (@liviuchircu) | Mar 2014 - May 2024 |
| 3. | Maksym Sobolyev (@sobomax) | Feb 2023 - Feb 2023 |
| 4. | Razvan Crainea (@razvancrainea) | Jun 2011 - Jun 2021 |
| 5. | Walter Doekes (@wdoekes) | Apr 2021 - Apr 2021 |
| 6. | Peter Lemenkov (@lemenkov) | Jun 2018 - May 2020 |
| 7. | Bogdan-Andrei Iancu (@bogdan-iancu) | Jul 2005 - Mar 2020 |
| 8. | Dan Pascu (@danpascu) | Oct 2007 - Apr 2019 |
| 9. | Vlad Patrascu (@rvlad-patrascu) | May 2017 - Apr 2019 |
| 10. | Irina-Maria Stanescu | Aug 2009 - Dec 2009 |
All remaining contributors: Anca Vamanu, UnixDev, Sergio Gutierrez, Henning Westerholt (@henningw), Daniel-Constantin Mierla (@miconda), Konstantin Bokarius, Edson Gellert Schubert, Norman Brandinger (@NormB), Jan Janak (@janakj), Andrei Pelinescu-Onciul, Jiri Kuthan (@jiriatipteldotorg).
(1) including any documentation-related commits, excluding merge commits
Last edited by: Peter Lemenkov (@lemenkov), Liviu Chircu (@liviuchircu), Bogdan-Andrei Iancu (@bogdan-iancu), Razvan Crainea (@razvancrainea), Irina-Maria Stanescu, Sergio Gutierrez, Daniel-Constantin Mierla (@miconda), Konstantin Bokarius, Edson Gellert Schubert, Dan Pascu (@danpascu), Jan Janak (@janakj).
Documentation Copyrights:
Copyright © 2009 Voice Sistem SRL
Copyright © 2003 FhG FOKUS