DOMAIN module
Admin Guide
Section titled “Admin Guide”Overview
Section titled “Overview”Domain module implements checks that based on domain table determine if a host part of an URI is “local” or not. A “local” domain is one that the proxy is responsible for.
Domain module operates in caching or non-caching mode depending on
value of module parameter db_mode.
In caching mode domain module reads the contents of domain table into
cache memory when the module is loaded. After that domain table is
re-read only when module is given domain:reload MI command. Any
changes in domain table must thus be followed by
“domain:reload” command in order to reflect them in
module behavior. In non-caching mode domain module always queries domain
table in the database.
Caching is implemented using a hash table. The size of the hash table is given by HASH_SIZE constant defined in domain_mod.h. Its “factory default” value is 128.
Dependencies
Section titled “Dependencies”The module depends on the following modules (in the other words the listed modules must be loaded before this module):
- database — Any database module
Exported Parameters
Section titled “Exported Parameters”db_url (string)
Section titled “db_url (string)”This is URL of the database to be used.
Default value is “mysql://opensipsro:opensipsro@localhost/opensips”
modparam("domain", "db_url", "mysql://ser:pass@db_host/ser")db_mode (integer)
Section titled “db_mode (integer)”Database mode: 0 means non-caching, 1 means caching.
Default value is 0 (non-caching).
modparam("domain", "db_mode", 1) # Use cachingdomain_table (string)
Section titled “domain_table (string)”Name of table containing names of local domains that the proxy is responsible for. Local users must have in their sip uri a host part that is equal to one of these domains.
Default value is “domain”.
modparam("domain", "domain_table", "new_name")domain_col (string)
Section titled “domain_col (string)”Name of column containing domains in domain table.
Default value is “domain”.
modparam("domain", "domain_col", "domain_name")attrs_col (string)
Section titled “attrs_col (string)”Name of column containing attributes in domain table.
Default value is “attrs”.
modparam("domain", "attrs_col", "attributes")subdomain_col (int)
Section titled “subdomain_col (int)”Name of the “accept_subdomain” column in the domain table. A positive value for the column means the domain accepts subdomains. A 0 value means it does not.
Default value is “accept_subdomain”.
modparam("domain", "subdomain_col", "has_subdomain")Exported Functions
Section titled “Exported Functions”is_from_local([attrs_var])
Section titled “is_from_local([attrs_var])”Checks based on domain table if host part of From header uri is one of the local domains that the proxy is responsible for. The argument is optional and if present it should contain a writable variable that will be populated with the attributes from the database.
This function can be used from REQUEST_ROUTE.
...if (is_from_local()) { ...};...if (is_from_local($var(attrs))) { xlog("Domain attributes are $var(attrs)\n"); ...};...is_uri_host_local([attrs_var])
Section titled “is_uri_host_local([attrs_var])”If called from route or failure route block, checks based on domain table if host part of Request-URI is one of the local domains that the proxy is responsible for. If called from branch route, the test is made on host part of URI of first branch, which thus must have been appended to the transaction before is_uri_host_local() is called. The argument is optional and if present it should contain a writable variable that will be populated with the attributes from the database.
This function can be used from REQUEST_ROUTE, FAILURE_ROUTE, BRANCH_ROUTE.
...if (is_uri_host_local()) { ...};...if (is_uri_host_local($var(attrs))) { xlog("Domain attributes are $var(attrs)\n"); ...};is_domain_local(domain, [attrs_var])
Section titled “is_domain_local(domain, [attrs_var])”This function checks if the domain contained in the first parameter is local.
This function is a generalized form of the is_from_local() and is_uri_host_local() functions, being able to completely replace them and also extends them by allowing the domain to be taken from any of the above mentioned sources. The following equivalences exist:
- is_domain_local($rd) is same as is_uri_host_local()
- is_domain_local($fd) is same as is_from_local()
Parameters:
- domain (string)
- attrs_var (var, optional) - a writable variable that will be populated with the attributes from the database.
This function can be used from REQUEST_ROUTE, FAILURE_ROUTE, BRANCH_ROUTE.
...if (is_domain_local($rd)) { ...};if (is_domain_local($fd)) { ...};if (is_domain_local($avp(some_avp_alias))) { ...};if (is_domain_local($avp(850))) { ...};if (is_domain_local($avp(some_avp))) { ...};if (is_domain_local($avp(some_avp), $avp(attrs))) { xlog("Domain attributes are $avp(attrs)\n"); ...};...Exported MI Functions
Section titled “Exported MI Functions”domain:reload
Section titled “domain:reload”Replaces obsolete MI command: domain_reload.
Causes domain module to re-read the contents of domain table into cache memory.
Name: domain:reload
Parameters: none
MI FIFO Command Format:
opensips-cli -x mi domain:reloaddomain:dump
Section titled “domain:dump”Replaces obsolete MI command: domain_dump.
Causes domain module to dump hash indexes and domain names in its cache memory.
Name: domain:dump
Parameters: none
MI FIFO Command Format:
opensips-cli -x mi domain:dumpKnown Limitations
Section titled “Known Limitations”There is an unlikely race condition on domain list update. If a process uses a table, which is reloaded at the same time twice through FIFO, the second reload will delete the original table still in use by the process.
Developer Guide
Section titled “Developer Guide”The module provides is_domain_local API function for use by other OpenSIPS modules.
Available Functions
Section titled “Available Functions”is_domain_local(domain)
Section titled “is_domain_local(domain)”Checks if domain given in str* parameter is local.
The function returns 1 if domain is local and -1 if domain is not local or if an error occurred.
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) | 56 | 42 | 451 | 569 |
| 2. | Jan Janak (@janakj) | 33 | 21 | 1036 | 150 |
| 3. | Juha Heinanen (@juha-h) | 32 | 20 | 726 | 259 |
| 4. | Razvan Crainea (@razvancrainea) | 24 | 19 | 270 | 94 |
| 5. | Daniel-Constantin Mierla (@miconda) | 18 | 16 | 73 | 58 |
| 6. | Liviu Chircu (@liviuchircu) | 12 | 9 | 55 | 85 |
| 7. | Stefan Darius | 11 | 5 | 401 | 63 |
| 8. | Vlad Patrascu (@rvlad-patrascu) | 9 | 5 | 96 | 124 |
| 9. | Andrei Pelinescu-Onciul | 9 | 4 | 186 | 121 |
| 10. | Dan Pascu (@danpascu) | 8 | 4 | 237 | 106 |
All remaining contributors: Henning Westerholt (@henningw), David Trihy, Elena-Ramona Modroiu, Peter Lemenkov (@lemenkov), Maksym Sobolyev (@sobomax), Jiri Kuthan (@jiriatipteldotorg), @coxx, Anca Vamanu, Konstantin Bokarius, Klaus Darilion, Stefan Darius, Norman Brandinger (@NormB), UnixDev, Andreas Granig, Edson Gellert Schubert, Ovidiu Sas (@ovidiusas), John Burke (@john08burke).
(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. | Peter Lemenkov (@lemenkov) | Jun 2018 - Jul 2025 |
| 4. | Bogdan-Andrei Iancu (@bogdan-iancu) | Oct 2005 - Jun 2025 |
| 5. | Ovidiu Sas (@ovidiusas) | May 2025 - May 2025 |
| 6. | Liviu Chircu (@liviuchircu) | Mar 2014 - May 2025 |
| 7. | David Trihy | May 2025 - May 2025 |
| 8. | Stefan Darius | Jul 2024 - Jul 2024 |
| 9. | Maksym Sobolyev (@sobomax) | Feb 2023 - Feb 2023 |
| 10. | John Burke (@john08burke) | Jan 2022 - Jan 2022 |
All remaining contributors: Vlad Patrascu (@rvlad-patrascu), @coxx, Anca Vamanu, UnixDev, Juha Heinanen (@juha-h), Henning Westerholt (@henningw), Daniel-Constantin Mierla (@miconda), Konstantin Bokarius, Edson Gellert Schubert, Elena-Ramona Modroiu, Dan Pascu (@danpascu), Norman Brandinger (@NormB), Andreas Granig, Klaus Darilion, 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), Bogdan-Andrei Iancu (@bogdan-iancu), Vlad Patrascu (@rvlad-patrascu), Peter Lemenkov (@lemenkov), Liviu Chircu (@liviuchircu), Daniel-Constantin Mierla (@miconda), Konstantin Bokarius, Edson Gellert Schubert, Juha Heinanen (@juha-h), Elena-Ramona Modroiu, Dan Pascu (@danpascu), Klaus Darilion, Jan Janak (@janakj).
License
Section titled “License”All documentation files (i.e. .md extension) are licensed under the Creative Common License 4.0