Table of Contents
List of Tables
List of Examples
This module is designed to be used at intermediate sip proxies like loadbalancers in front of registrars and proxies. It provides functions for inserting a Path header including a parameter for passing forward the received-URI of a registration to the next hop. It also provides a mechanism for evaluating this parameter in subsequent requests and to set the destination URI according to it.
For registrations in a scenario like “[UAC] -> [P1] -> [REG]”, the "path" module can be used at the intermediate proxy P1 to insert a Path header into the message before forwarding it to the registrar REG. Two functions can be used to achieve this:
add_path(...) adds a Path header in the form of “Path: <sip:1.2.3.4;lr>” to the message using the address of the outgoing interface. A port is only added if it's not the default port 5060.
If a username is passed to the function, it is also included in the Path URI, like “Path: <sip:username@1.2.3.4;lr>”.
add_path_received(...) also add a Path header in the same form as above, but also adds a parameter indicating the received-URI of the message, like “Path: <sip:1.2.3.4;received=sip:2.3.4.5:1234;lr>”. This is especially useful if the proxy does NAT detection and wants to pass the NAT'ed address to the registrar.
If the function is called with a username, it's included in the Path URI too.
If the NAT'ed address of an UAC is passed to the registrar, the registrar routes back subsequent requests using the Path header of the registration as Route header of the current request. If the intermediate proxy had inserted a Path header including the “received” parameter during the registration, this parameter will show up in the Route header of the new request as well, allowing the intermediate proxy to route to this address instead of the one propagated in the Route URI for tunneling through NAT. This behaviour can be activated by setting the module parameter “use_received”.
The following modules must be loaded before this module:
The "rr" module is needed for outbound routing according to the “received” parameter.
If set to 1, the “received” parameter of the first Route URI is evaluated and used as destination-URI if present.
Default value is 0.
There are some situations when the server needs to insert two Path header fields instead of one. For example when using two disconnected networks or doing cross-protocol forwarding from UDP->TCP. This parameter enables inserting of 2 Paths.
Default value is 1 (yes).
This function is used to insert a Path header in the form “Path: <sip:1.2.3.4;lr>”, where “1.2.3.4” is the address of the outgoing interface.
This function can be used from REQUEST_ROUTE.
Example 1.3. add_path usage
...
if (!add_path()) {
sl_send_reply("503", "Internal Path Error");
...
};
...
This function adds a Path header in the form “Path: <sip:user@1.2.3.4;lr>”.
Meaning of the parameters is as follows:
user - The username to be inserted as user part.
This function can be used from REQUEST_ROUTE.
Example 1.4. add_path(user) usage
...
if (!add_path("loadbalancer")) {
sl_send_reply("503", "Internal Path Error");
...
};
...
This function adds a Path header in the form “Path: <sip:1.2.3.4;received=sip:2.3.4.5:1234;lr>”, setting it's own outgoing address as domain-part, and the address the request has been received from as received-parameter.
This function can be used from REQUEST_ROUTE.
Example 1.5. add_path_received() usage
...
if (!add_path_received()) {
sl_send_reply("503", "Internal Path Error");
...
};
...
This function adds a Path header in the form “Path: <sip:user@1.2.3.4;received=sip:2.3.4.5:1234;lr>”, setting 'user' as username part of address, it's own outgoing address as domain-part, and the address the request has been received from as received-parameter.
This function can be used from REQUEST_ROUTE.
Example 1.6. add_path_received(user) usage
...
if (!add_path_received("inbound")) {
sl_send_reply("503", "Internal Path Error");
...
};
...
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) | 19 | 15 | 237 | 78 |
| 2. | Liviu Chircu (@liviuchircu) | 15 | 9 | 83 | 255 |
| 3. | Daniel-Constantin Mierla (@miconda) | 12 | 10 | 25 | 21 |
| 4. | Andreas Granig | 12 | 4 | 863 | 22 |
| 5. | Razvan Crainea (@razvancrainea) | 6 | 4 | 7 | 7 |
| 6. | Henning Westerholt (@henningw) | 4 | 2 | 5 | 32 |
| 7. | Ancuta Onofrei | 3 | 1 | 12 | 12 |
| 8. | Konstantin Bokarius | 3 | 1 | 2 | 5 |
| 9. | Edson Gellert Schubert | 3 | 1 | 0 | 103 |
| 10. | Elena-Ramona Modroiu | 2 | 1 | 26 | 0 |
(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. | Bogdan-Andrei Iancu (@bogdan-iancu) | Oct 2006 - Jun 2018 |
| 2. | Liviu Chircu (@liviuchircu) | Mar 2014 - Jun 2018 |
| 3. | Razvan Crainea (@razvancrainea) | Aug 2010 - Nov 2016 |
| 4. | Daniel-Constantin Mierla (@miconda) | Nov 2006 - Mar 2008 |
| 5. | Konstantin Bokarius | Mar 2008 - Mar 2008 |
| 6. | Edson Gellert Schubert | Feb 2008 - Feb 2008 |
| 7. | Henning Westerholt (@henningw) | Apr 2007 - Dec 2007 |
| 8. | Ancuta Onofrei | Sep 2007 - Sep 2007 |
| 9. | Andreas Granig | Mar 2006 - Aug 2007 |
| 10. | Elena-Ramona Modroiu | Jan 2007 - Jan 2007 |
(1) including any documentation-related commits, excluding merge commits
Last edited by: Bogdan-Andrei Iancu (@bogdan-iancu), Liviu Chircu (@liviuchircu), Daniel-Constantin Mierla (@miconda), Konstantin Bokarius, Edson Gellert Schubert, Elena-Ramona Modroiu, Andreas Granig.
doc copyrights:
Copyright © 2006 Inode GmbH