MSRP RELAY module
Admin Guide
Section titled “Admin Guide”Overview
Section titled “Overview”This modules implements a Relay for the MSRP protocol, according to the specifications of RFC 4976. Once loaded, the module will automatically forward messages and manage MSRP sessions for the MSRP listeners defined in the script.
For authenticating MSRP clients, a dedicated script route is run in order to check the Digest credentials via pseudo-variables.
Dependencies
Section titled “Dependencies”OpenSIPS Modules
Section titled “OpenSIPS Modules”The following modules must be loaded before this module:
- proto_msrp
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:
- openssl or libssl
- openssl-dev or libssl-dev
Exported Parameters
Section titled “Exported Parameters”hash_size (int)
Section titled “hash_size (int)”The size of the hash table that stores the MSRP sessions. It is the 2 logarithmic value of the real size.
Default value is “10” (1024 records).
...modparam("msrp_relay", "hash_size", 10)...cleanup_interval (int)
Section titled “cleanup_interval (int)”The interval between full iterations of the sessions table in order to clean up expired MSRP sessions. Note that a session will be kept in memory as long as the Expires value provided in the 200 OK response to the AUTH request indicates.
Default value is “60”.
...modparam("msrp_relay", "cleanup_interval", 30)...auth_route (str)
Section titled “auth_route (str)”The name of the script route to be called when authorizing MSRP clients (receiving an AUTH request with an Authorization header). Here you should provide the appropriate password (or pre-calculated HA1 string) for the credentials via the password var pseudo-variable, in order for the relay to check the client response.
No default value; this parameter is mandatory.
...modparam("msrp_relay", "auth_route", "auth")...username_var (string)
Section titled “username_var (string)”This name of the pseudo-variable that holds the authentication username.
Default value is “$var(username)“.
modparam("msrp_relay", "username_var", "$var(msrp_auth_user)")realm_var (string)
Section titled “realm_var (string)”This name of the pseudo-variable that hols the authentication Realm.
Default value is “$var(realm)“.
modparam("msrp_relay", "realm_var", "$var(msrp_auth_realm)")password_var (string)
Section titled “password_var (string)”This name of the pseudo-variable that should be set in the auth route script route in order to check the client response when authenticating. The value to be set can be either the plaintext password or pre-calculated HA1 string, based on the parameter.
Default value is “$var(password)“.
modparam("msrp_relay", "password_var", "$var(msrp_auth_password)")calculate_ha1 (integer)
Section titled “calculate_ha1 (integer)”This parameter configures whether the value of the password var pseudo-variable should be treated as a plaintext password or a pre-calculated HA1 string.
Default value of this parameter is 0 (HA1 string).
modparam("msrp_relay", "calculate_ha1", 1)socket_route (str)
Section titled “socket_route (str)”The optional name of the script route to be called when start relaying a new MSRP session (upon the first SEND). The purpose of this route is to allow you to select the appropriate outbound socket to be be used for sending out the MSRP request.
Inside the route, the following information from the received request will be exposed:
- source network information via the
$si,$sp,$sPand$socket_invariables. - destination URL schema via the dst schema var variable
- destination URL host via the dst host var variable
In this route you should optionally set the desired MSRP(S)
outbound socket via the $socket_out variable.
If none is set, the inbound interface will also be used as
outbound if the schema (MSRP versus MSRPS) is the same. If the
schema changes, the first socket (matching the out schema) will
be used.
Default value is “NULL” (none).
...modparam("msrp_relay", "socket_route", "msrp_routing")
route[msrp_routing] { xlog("MSRP request comming from $si:$sp on $socket_in socket\n"); xlog("trying to go to $var(dst_schema)://$var(dst_host)\n");
$socket_out = "msrp:1.2.3.4:9999";}...dst_schema_var (string)
Section titled “dst_schema_var (string)”This name of the variable to provide the schema (“msrp” or “msrps”) of the destination URL in the socket route. See more on socket route parameter.
Default value is “$var(dst_schema)“.
dst_host_var (string)
Section titled “dst_host_var (string)”This name of the variable to provide the host of the destination URL in the socket route. See more on socket route parameter.
Default value is “$var(dst_host)“.
auth_realm (string)
Section titled “auth_realm (string)”The realm to be provided in the WWW-Authenticate header when the relay automatically challanges an MSRP client.
If this parameter is not set, the realm chose by the relay is the domain part of the top MSRP URI in the To-Path header of the AUTH request.
modparam("msrp_relay", "auth_realm", "opensips.org")auth_expires (int)
Section titled “auth_expires (int)”The Expires header value to be provided in the 200 OK response to an AUTH request, if the client does not explicitly request one. This represents how long the MSRP URI provided by the relay in the Use-Path header is valid.
Default value is “1800” (1024 records).
...modparam("msrp_relay", "auth_expires", 600)...auth_min_expires (int)
Section titled “auth_min_expires (int)”The minimum value accepted by the relay in the Expires header, if the client provides it in the AUTH request. If the requested value is lower that this parameter, the relay will include a Min-Expires header with the configured value, in the 423 Interval Out-of-Bounds response.
If not set, the relay will accept any value.
...modparam("msrp_relay", "auth_min_expires", 60)...auth_max_expires (int)
Section titled “auth_max_expires (int)”The maximum value accepted by the relay in the Expires header, if the client provides it in the AUTH request. If the requested value is higher that this parameter, the relay will include a Max-Expires header with the configured value, in the 423 Interval Out-of-Bounds response.
If not set, the relay will accept any value.
...modparam("msrp_relay", "auth_max_expires", 60)...nonce_expire (integer)
Section titled “nonce_expire (integer)”Nonces have limited lifetime. After a given period of time nonces
will be considered invalid. This is to protect replay attacks.
Credentials containing a stale nonce will be not authorized, but the
user agent will be challenged again. This time the challenge will
contain stale parameter which will indicate to the
client that it doesn’t have to disturb user by asking for username
and password, it can recalculate credentials using existing username
and password.
The value is in seconds and default value is 30 seconds.
modparam("msrp_relay", "nonce_expire", 15) # Set nonce_expire to 15smy_uri (string)
Section titled “my_uri (string)”MSRP URI of this relay, that will be matched against the first URI in the To-Path header of any request or response received. Messages that are not addressed to this relay will be dropped.
The MSRP URI provided by the relay in the Use-Path header, will be chosen based on the URI in the To-Path header of the AUTH request.
This parameter can be set multiple times
If the port is not set explicitly, the default value of 2855 wil be assumed. The session-id part of the URI should not be set
modparam("msrp_relay", "my_uri", "msrp://opensips.org:2855;tcp")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. | Vlad Patrascu (@rvlad-patrascu) | 22 | 7 | 1647 | 17 |
| 2. | Stefan Darius (@dariusstefan) | 10 | 4 | 453 | 82 |
| 3. | Bogdan-Andrei Iancu (@bogdan-iancu) | 7 | 4 | 201 | 21 |
| 4. | Razvan Crainea (@razvancrainea) | 3 | 1 | 2 | 2 |
| 5. | Maksym Sobolyev (@sobomax) | 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) | Jun 2026 - Jun 2026 |
| 3. | Vlad Patrascu (@rvlad-patrascu) | Mar 2022 - May 2023 |
| 4. | Bogdan-Andrei Iancu (@bogdan-iancu) | Apr 2022 - May 2023 |
| 5. | Maksym Sobolyev (@sobomax) | Feb 2023 - Feb 2023 |
(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).
License
Section titled “License”All documentation files (i.e. .md extension) are licensed under the Creative Common License 4.0