Skip to content

nathelper: port add_contact_alias() and handle_ruri_alias() #3769

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
sobomax wants to merge 1 commit into
base: master
Choose a base branch
from
+559 −2
Open

nathelper: port add_contact_alias() and handle_ruri_alias() #3769

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 46 additions & 2 deletions modules/nathelper/README
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,8 @@ nathelper Module
1.5.3. add_rcv_param([flag]),
1.5.4. fix_nated_register()
1.5.5. nat_uac_test(flags)
1.5.6. add_contact_alias([ip_addr, port, proto])
1.5.7. handle_ruri_alias()

1.6. Exported MI Functions

Expand Down Expand Up @@ -91,7 +93,9 @@ nathelper Module
1.22. add_rcv_paramer usage
1.23. fix_nated_register usage
1.24. nat_uac_test usage
1.25. nh_enable_ping usage
1.25. add_contact_alias usage
1.26. handle_ruri_alias usage
1.27. nh_enable_ping usage

Chapter 1. Admin Guide

Expand Down Expand Up @@ -595,6 +599,46 @@ if (nat_uac_test("private-contact,private-sdp"))
xlog("SIP message is NAT'ed (Call-ID: $ci)\n");
...

1.5.6. add_contact_alias([ip_addr, port, proto])

Adds a standards-compliant “;alias=” parameter to the Contact URI
containing the signalling source IP, port and transport protocol
when they differ from the advertised Contact address.

Meaning of the parameters is as follows:
* ip_addr (string, optional) - IP to encode inside the alias. If
omitted, the message source IP is used.
* port (string, optional) - port to encode inside the alias. If
omitted, the message source port is used.
* proto (string, optional) - transport protocol to encode inside
the alias (for example “udp”, “tcp”, “tls”, “sctp”, “ws” or
“wss”). If omitted, the transport used to receive the message is
used.

This function can be used from REQUEST_ROUTE, ONREPLY_ROUTE,
BRANCH_ROUTE and FAILURE_ROUTE.

Example 1.25. add_contact_alias usage
...
if (!add_contact_alias("$si", "$sp", "tcp")) {
xlog("[NAT] cannot create alias\n");
}
...

1.5.7. handle_ruri_alias()

If the Request URI contains an “alias” parameter, the destination
URI is set based on its encoded IP, port and transport, and the
parameter is removed from the URI.

This function can be used from REQUEST_ROUTE, BRANCH_ROUTE and
LOCAL_ROUTE.

Example 1.26. handle_ruri_alias usage
...
handle_ruri_alias();
...

1.6. Exported MI Functions

1.6.1. nh_enable_ping
Expand All @@ -607,7 +651,7 @@ if (nat_uac_test("private-contact,private-sdp"))
parameter value greater than 0 or disables natping if
parameter value is 0.

Example 1.25. nh_enable_ping usage
Example 1.27. nh_enable_ping usage
...
$ opensips-cli -x mi nh_enable_ping
Status:: 1
Expand Down
49 changes: 49 additions & 0 deletions modules/nathelper/doc/nathelper_admin.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -833,6 +833,55 @@ fix_nated_register();
if (nat_uac_test("private-contact,private-sdp"))
xlog("SIP message is NAT'ed (Call-ID: $ci)\n");
...
</programlisting>
</example>
</section>
<section id="nathelper.f.add_contact_alias">
<title>
<function moreinfo="none">add_contact_alias([ip_addr, port, proto])</function>
</title>
<para>
Adds an “alias” URI parameter to the Contact address that encodes the
signalling source IP, port and transport protocol when they differ from
the advertised Contact address.
</para>
<itemizedlist>
<listitem><para><emphasis>ip_addr</emphasis> (string, optional) - IP to encode
inside the alias. If omitted, the source IP of the SIP message is used.</para></listitem>
<listitem><para><emphasis>port</emphasis> (string, optional) - port to encode inside
the alias. If omitted, the source port of the SIP message is used.</para></listitem>
<listitem><para><emphasis>proto</emphasis> (string, optional) - transport protocol to
encode inside the alias (e.g. “udp”, “tcp”, “tls”, “sctp”, “ws” or “wss”). If omitted,
the transport used to receive the message is used.</para></listitem>
</itemizedlist>
<para>This function can be used from REQUEST_ROUTE, ONREPLY_ROUTE, BRANCH_ROUTE and
FAILURE_ROUTE.</para>
<example>
<title><function>add_contact_alias</function> usage</title>
<programlisting format="linespecific">
...
if (!add_contact_alias("$si", "$sp", "tcp")) {
xlog("[NAT] cannot create alias\n");
}
...
</programlisting>
</example>
</section>
<section id="nathelper.f.handle_ruri_alias">
<title>
<function moreinfo="none">handle_ruri_alias()</function>
</title>
<para>
Parses an “alias” parameter from the Request URI, sets the destination URI based on its
contents and removes the parameter from the Request URI.
</para>
<para>This function can be used from REQUEST_ROUTE, BRANCH_ROUTE and LOCAL_ROUTE.</para>
<example>
<title><function>handle_ruri_alias</function> usage</title>
<programlisting format="linespecific">
...
handle_ruri_alias();
...
</programlisting>
</example>
</section>
Expand Down
Loading