GROUP module
Admin Guide
Section titled “Admin Guide”Overview
Section titled “Overview”This module provides functionalities for different methods of group membership checking.
Strict membership checking
Section titled “Strict 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.
Regular Expression based checking
Section titled “Regular Expression based checking”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.
Dependencies
Section titled “Dependencies”OpenSIPS Modules
Section titled “OpenSIPS Modules”The following modules must be loaded before this module:
- A database module, like mysql, postgres or dbtext.
- An AAA module, like radius or diameter.
External Libraries or Applications
Section titled “External Libraries or Applications”The following libraries or applications must be installed before running OpenSIPS with this module loaded:
- None.
Exported Parameters
Section titled “Exported Parameters”db_url (string)
Section titled “db_url (string)”URL of the database table to be used.
...modparam("group", "db_url", "mysql://username:password@dbhost/opensips")...table (string)
Section titled “table (string)”Name of the table holding strict definitions of groups and their members.
Default value is “grp”.
...modparam("group", "table", "grp_table")...user_column (string)
Section titled “user_column (string)”Name of the “table” column holding usernames.
Default value is “username”.
...modparam("group", "user_column", "user")...domain_column (string)
Section titled “domain_column (string)”Name of the “table” column holding domains.
Default value is “domain”.
...modparam("group", "domain_column", "realm")...group_column (string)
Section titled “group_column (string)”Name of the “table” column holding groups.
Default value is “grp”.
...modparam("group", "group_column", "grp")...use_domain (boolean)
Section titled “use_domain (boolean)”If enabled, the domain part of the URI will also be used in the lookup, for a stricter group matching. Otherwise, only the username part will be used.
Default value is true (enabled).
...modparam("group", "use_domain", 1)...re_table (string)
Section titled “re_table (string)”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”.
...modparam("group", "re_table", "re_grp")...re_exp_column (string)
Section titled “re_exp_column (string)”Name of the “re_table” column holding the regular expression used for user matching.
Default value is “reg_exp”.
...modparam("group", "re_exp_column", "re")...re_gid_column (string)
Section titled “re_gid_column (string)”Name of the “re_table” column holding the group IDs.
Default value is “group_id”.
...modparam("group", "re_gid_column", "grp_id")...multiple_gid (integer)
Section titled “multiple_gid (integer)”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”.
...modparam("group", "multiple_gid", 0)...aaa_url (string)
Section titled “aaa_url (string)”This is the url representing the AAA protocol used and the location of the configuration file of this protocol.
...modparam("group", "aaa_url", "radius:/etc/radiusclient-ng/radiusclient.conf")...Exported Functions
Section titled “Exported Functions”db_is_user_in(uri, group)
Section titled “db_is_user_in(uri, group)”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.
...if (db_is_user_in("Request-URI", "ld")) { ...}...$avp(grouptocheck)="offline";
if (db_is_user_in("Credentials", $avp(grouptocheck))) { ...}...db_get_user_group(uri, output_avp)
Section titled “db_get_user_group(uri, output_avp)”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.
...if (db_get_user_group("Request-URI", $avp(10))) { xdbg("User $ru belongs to the following groups: $(avp(10)[*])\n"); ....};...aaa_is_user_in(uri, group)
Section titled “aaa_is_user_in(uri, group)”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.
...if (aaa_is_user_in("Request-URI", "ld")) { ...};...Contributors
Section titled “Contributors”By Commit Statistics
Section titled “By Commit Statistics”Top contributors by DevScore(1), authored commits(2) and lines added/removed(3)
| # | Name | DevScore | Commits | Lines++ | Lines— |
|---|---|---|---|---|---|
| 1. | Bogdan-Andrei Iancu (@bogdan-iancu) | 50 | 31 | 989 | 545 |
| 2. | Jan Janak (@janakj) | 32 | 20 | 1070 | 147 |
| 3. | Daniel-Constantin Mierla (@miconda) | 23 | 18 | 137 | 137 |
| 4. | Liviu Chircu (@liviuchircu) | 19 | 13 | 147 | 214 |
| 5. | Irina-Maria Stanescu | 11 | 4 | 495 | 88 |
| 6. | Stefan Darius | 11 | 4 | 482 | 109 |
| 7. | Razvan Crainea (@razvancrainea) | 10 | 8 | 18 | 41 |
| 8. | Andrei Pelinescu-Onciul | 7 | 5 | 100 | 42 |
| 9. | Henning Westerholt (@henningw) | 7 | 5 | 28 | 47 |
| 10. | Vlad Patrascu (@rvlad-patrascu) | 5 | 2 | 91 | 119 |
All remaining contributors: Sergio Gutierrez, Jiri Kuthan (@jiriatipteldotorg), Maksym Sobolyev (@sobomax), Peter Lemenkov (@lemenkov), Walter Doekes (@wdoekes), Dan Pascu (@danpascu), Alexandra Titoc, UnixDev, Konstantin Bokarius, Norman Brandinger (@NormB), Anca Vamanu, Edson Gellert Schubert.
(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
(3) ignoring whitespace edits, renamed files and auto-generated files
By Commit Activity
Section titled “By Commit Activity”| # | Name | Commit Activity |
|---|---|---|
| 1. | Stefan Darius | Jun 2026 - Jul 2026 |
| 2. | Razvan Crainea (@razvancrainea) | Jun 2011 - Jun 2026 |
| 3. | Liviu Chircu (@liviuchircu) | Mar 2014 - Apr 2026 |
| 4. | Alexandra Titoc | Sep 2024 - Sep 2024 |
| 5. | Maksym Sobolyev (@sobomax) | Feb 2023 - Feb 2023 |
| 6. | Walter Doekes (@wdoekes) | Apr 2021 - Apr 2021 |
| 7. | Peter Lemenkov (@lemenkov) | Jun 2018 - May 2020 |
| 8. | Bogdan-Andrei Iancu (@bogdan-iancu) | Jul 2005 - Mar 2020 |
| 9. | Dan Pascu (@danpascu) | Oct 2007 - Apr 2019 |
| 10. | Vlad Patrascu (@rvlad-patrascu) | May 2017 - Apr 2019 |
All remaining contributors: Irina-Maria Stanescu, 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
Documentation
Section titled “Documentation”Contributors
Section titled “Contributors”Last edited by: Razvan Crainea (@razvancrainea), Liviu Chircu (@liviuchircu), Peter Lemenkov (@lemenkov), Bogdan-Andrei Iancu (@bogdan-iancu), Irina-Maria Stanescu, Sergio Gutierrez, Daniel-Constantin Mierla (@miconda), Konstantin Bokarius, Edson Gellert Schubert, Dan Pascu (@danpascu), Jan Janak (@janakj).
License
Section titled “License”All documentation files (i.e. .md extension) are licensed under the Creative Common License 4.0