UAC AUTH module
Admin Guide
Section titled “Admin Guide”Overview
Section titled “Overview”UAC AUTH (User Agent Client Authentication) module provides a common API for building authentication headers.
It also provides a common set of authentication credetials to be used by other modules.
Note that authentication provided by this module supports both qop “auth” and qop “auth-int” but if both values are presented by the server, “auth” will be prefered.
RFC 8760 Support (Strenghtened Authentication)
Section titled “RFC 8760 Support (Strenghtened Authentication)”Starting with OpenSIPS 3.2, the auth, auth_db and uac_auth modules include support for two new digest authentication algorithms (“SHA-256” and “SHA-512-256”), according to the RFC 8760 specs.
Dependencies
Section titled “Dependencies”OpenSIPS Modules
Section titled “OpenSIPS Modules”- None.
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”credential (string)
Section titled “credential (string)”Contains a multiple definition of credentials used to perform authentication.
This parameter is required if UAC authentication is used.
...modparam("uac_auth","credential","username:domain:password")modparam("uac_auth","credential","username:domain:0xc17ba8157756f263d07e158504204629")...auth_realm_avp (string)
Section titled “auth_realm_avp (string)”The definition of an AVP that might contain the realm to be used to perform authentication.
If you define it, you also need to define “auth_username_avp” (auth username avp) and “auth_password_avp” (auth password avp).
...modparam("uac_auth","auth_realm_avp","$avp(10)")...auth_username_avp (string)
Section titled “auth_username_avp (string)”The definition of an AVP that might contain the username to be used to perform authentication.
If you define it, you also need to define “auth_realm_avp” (auth realm avp) and “auth_password_avp” (auth password avp).
...modparam("uac_auth","auth_username_avp","$avp(11)")...auth_password_avp (string)
Section titled “auth_password_avp (string)”The definition of an AVP that might contain the password to be used to perform authentication. The password can be provided as a plain text password or as a precalculated HA1 as a hexa (lower case) string (of 32 chars) prefixed with “0x” (so a total of 34 chars) (for example “0xc17ba8157756f263d07e158504204629”)
If you define it, you also need to define “auth_realm_avp” (auth realm avp) and “auth_username_avp” (auth username avp).
...modparam("uac_auth","auth_password_avp","$avp(12)")...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. | Ovidiu Sas (@ovidiusas) | 16 | 7 | 869 | 15 |
| 2. | Liviu Chircu (@liviuchircu) | 11 | 8 | 51 | 72 |
| 3. | Bogdan-Andrei Iancu (@bogdan-iancu) | 11 | 7 | 247 | 27 |
| 4. | Maksym Sobolyev (@sobomax) | 11 | 4 | 123 | 260 |
| 5. | Razvan Crainea (@razvancrainea) | 9 | 7 | 14 | 17 |
| 6. | Stefan Darius (@dariusstefan) | 7 | 4 | 194 | 39 |
| 7. | Vlad Patrascu (@rvlad-patrascu) | 6 | 4 | 45 | 31 |
| 8. | Bence Szigeti | 3 | 1 | 7 | 1 |
| 9. | Peter Lemenkov (@lemenkov) | 3 | 1 | 1 | 1 |
(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 (@dariusstefan) | Jun 2026 - Jul 2026 |
| 2. | Razvan Crainea (@razvancrainea) | Sep 2011 - Jun 2026 |
| 3. | Liviu Chircu (@liviuchircu) | Mar 2014 - Oct 2024 |
| 4. | Bence Szigeti | Apr 2023 - Apr 2023 |
| 5. | Maksym Sobolyev (@sobomax) | Sep 2020 - Feb 2023 |
| 6. | Vlad Patrascu (@rvlad-patrascu) | May 2017 - Jul 2019 |
| 7. | Bogdan-Andrei Iancu (@bogdan-iancu) | Mar 2012 - Apr 2019 |
| 8. | Peter Lemenkov (@lemenkov) | Jun 2018 - Jun 2018 |
| 9. | Ovidiu Sas (@ovidiusas) | Jun 2011 - Oct 2013 |
(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), Vlad Patrascu (@rvlad-patrascu), Peter Lemenkov (@lemenkov), Bogdan-Andrei Iancu (@bogdan-iancu), Ovidiu Sas (@ovidiusas).
License
Section titled “License”All documentation files (i.e. .md extension) are licensed under the Creative Common License 4.0