/
nathelper_admin.xml
879 lines (853 loc) · 25.8 KB
/
nathelper_admin.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
<?xml version="1.0" encoding='ISO-8859-1'?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
<!-- Include general documentation entities -->
<!ENTITY % docentities SYSTEM "../../../docbook/entities.xml">
%docentities;
]>
<!-- Module User's Guide -->
<chapter>
<title>&adminguide;</title>
<section>
<title>Overview</title>
<para>
This is a module to help with &nat; traversal and reuse
of <acronym>TCP</acronym> connections. In particular,
it helps symmetric &ua;s that don't advertise they are symmetric
and are not able to determine their public address.
</para>
<para>
The function <function>fix_nated_contact()</function> rewrites the <quote>Contact</quote>
header field with request's source address:port pair. The function
<function>fix_nated_sdp()</function> adds the active direction indication
to &sdp; (flag 0x01) and updates the source &ip; address too (flag 0x02). The function
<function>fix_nated_register()</function> exports exports the request's source
address:port into an AVP to be used during <function>save()</function> and should
be used for <quote>REGISTER</quote> requests.
</para>
<para>
Note: <function>fix_nated_contact</function> changes the <quote>Contact</quote>
header, thus it breaks the RFC. Although usually this is not an issue, it may
cause problems with strict SIP clients. An alternative is to use
<function>add_contact_alias()</function> that together with
the <function>handle_ruri_alias()</function> is standards conforming and also
supports reuse of TCP/TLS connections.
</para>
</section>
<section>
<title>NAT pinging types</title>
<para>
Currently, the nathelper module supports two types of NAT pings:
</para>
<itemizedlist>
<listitem>
<para>
<emphasis>UDP package</emphasis> - 4 bytes (zero filled) UDP
packages are sent to the contact address.
</para>
<itemizedlist>
<listitem>
<para><emphasis>Advantages:</emphasis> low bandwitdh traffic,
easy to generate by &kamailio;;
</para>
</listitem>
<listitem>
<para><emphasis>Disadvantages:</emphasis> unidirectional
traffic through NAT (inbound - from outside to inside); As
many NATs do update the bind timeout only on outbound traffic,
the bind may expire and closed.
</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>
<emphasis>SIP request</emphasis> - a stateless SIP request is
sent to the contact address.
</para>
<itemizedlist>
<listitem>
<para><emphasis>Advantages:</emphasis> bidirectional traffic
through NAT, since each PING request from &kamailio; (inbound
traffic) will force the SIP client to generate a SIP reply
(outbound traffic) - the NAT bind will be surely kept open.
</para>
</listitem>
<listitem>
<para><emphasis>Disadvantages:</emphasis> higher bandwitdh
traffic, more expensive (as time) to generate by &kamailio;;
</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
</section>
<section>
<title>Dependencies</title>
<section>
<title>&kamailio; Modules</title>
<para>
The following modules must be loaded before this module:
<itemizedlist>
<listitem>
<para>
<emphasis>usrloc</emphasis> module - only if the NATed
contacts are to be pinged.
</para>
</listitem>
</itemizedlist>
</para>
</section>
<section>
<title>External Libraries or Applications</title>
<para>
The following libraries or applications must be installed before
running &kamailio; with this module loaded:
<itemizedlist>
<listitem>
<para>
<emphasis>None</emphasis>.
</para>
</listitem>
</itemizedlist>
</para>
</section>
</section>
<section>
<title>Parameters</title>
<section id="nathelper.p.force_socket">
<title><varname>force_socket</varname> (string)</title>
<para>
Socket to be used when sending NAT pings for UDP communication.
If no one specified, the OS will choose a socket.
</para>
<para>
<emphasis>
Default value is <quote>NULL</quote>.
</emphasis>
</para>
<example>
<title>Set <varname>force_socket</varname> parameter</title>
<programlisting format="linespecific">
...
modparam("nathelper", "force_socket", "localhost:33333")
...
</programlisting>
</example>
</section>
<section id="nathelper.p.natping_interval">
<title><varname>natping_interval</varname> (integer)</title>
<para>
Period of time in seconds between sending the NAT pings to all
currently registered &ua;s to keep their &nat; bindings alive.
Value of 0 disables this functionality.
</para>
<note><para>
Enabling the NAT pinging functionality will force the module to
bind itself to USRLOC module.
</para></note>
<para>
<emphasis>
Default value is 0.
</emphasis>
</para>
<example>
<title>Set <varname>natping_interval</varname> parameter</title>
<programlisting format="linespecific">
...
modparam("nathelper", "natping_interval", 10)
...
</programlisting>
</example>
</section>
<section id="nathelper.p.ping_nated_only">
<title><varname>ping_nated_only</varname> (integer)</title>
<para>
If this variable is set then only contacts that have
<quote>behind_NAT</quote> flag in user location database set will
get ping.
</para>
<para>
<emphasis>
Default value is 0.
</emphasis>
</para>
<example>
<title>Set <varname>ping_nated_only</varname> parameter</title>
<programlisting format="linespecific">
...
modparam("nathelper", "ping_nated_only", 1)
...
</programlisting>
</example>
</section>
<section id="nathelper.p.natping_processes">
<title><varname>natping_processes</varname> (integer)</title>
<para>
How many timer processes should be created by the module for the
exclusive task of sending the NAT pings.
</para>
<para>
<emphasis>
Default value is 1.
</emphasis>
</para>
<example>
<title>Set <varname>natping_processes</varname> parameter</title>
<programlisting format="linespecific">
...
modparam("nathelper", "natping_processes", 3)
...
</programlisting>
</example>
</section>
<section id="nathelper.p.natping_socket">
<title><varname>natping_socket</varname> (string)</title>
<para>
Spoof the natping's source-ip to this address. Works only for IPv4.
</para>
<para>
<emphasis>
Default value is NULL.
</emphasis>
</para>
<example>
<title>Set <varname>natping_socket</varname> parameter</title>
<programlisting format="linespecific">
...
modparam("nathelper", "natping_socket", "192.168.1.1:5006")
...
</programlisting>
</example>
</section>
<section id="nathelper.p.received_avp">
<title><varname>received_avp</varname> (str)</title>
<para>
The name of the Attribute-Value-Pair (AVP) used to store the URI
containing the received IP, port, and protocol. The URI is created
by fix_nated_register function of nathelper module and the attribute
is then used by the registrar to store the received parameters. Do
not forget to change the value of corresponding parameter in
registrar module if you change the value of this parameter.
</para>
<note>
<para>
You must set this parameter if you use <function>fix_nated_register</function>. In such
case you must set the parameter with same name in the <quote>registrar</quote>
module to same value.
</para>
</note>
<para>
<emphasis>
Default value is "NULL" (disabled).
</emphasis>
</para>
<example>
<title>Set <varname>received_avp</varname> parameter</title>
<programlisting format="linespecific">
...
modparam("nathelper", "received_avp", "$avp(i:42)")
...
</programlisting>
</example>
</section>
<section id="nathelper.p.sipping_bflag">
<title><varname>sipping_bflag</varname> (integer)</title>
<para>
Which branch flag should be used by the module to identify NATed
contacts for which it should perform NAT ping via a SIP request
instead if dummy UDP package.
</para>
<para>
<emphasis>
Default value is -1 (disabled).
</emphasis>
</para>
<example>
<title>Set <varname>sipping_bflag</varname> parameter</title>
<programlisting format="linespecific">
...
modparam("nathelper", "sipping_bflag", 7)
...
</programlisting>
</example>
</section>
<section id="nathelper.p.sipping_from">
<title><varname>sipping_from</varname> (string)</title>
<para>
The parameter sets the SIP URI to be used in generating the SIP
requests for NAT ping purposes. To enable the SIP request pinging
feature, you have to set this parameter. The SIP request pinging
will be used only for requests marked so.
</para>
<para>
<emphasis>
Default value is <quote>NULL</quote>.
</emphasis>
</para>
<example>
<title>Set <varname>sipping_from</varname> parameter</title>
<programlisting format="linespecific">
...
modparam("nathelper", "sipping_from", "sip:pinger@siphub.net")
...
</programlisting>
</example>
</section>
<section id="nathelper.p.sipping_method">
<title><varname>sipping_method</varname> (string)</title>
<para>
The parameter sets the SIP method to be used in generating the SIP
requests for NAT ping purposes.
</para>
<para>
<emphasis>
Default value is <quote>OPTIONS</quote>.
</emphasis>
</para>
<example>
<title>Set <varname>sipping_method</varname> parameter</title>
<programlisting format="linespecific">
...
modparam("nathelper", "sipping_method", "INFO")
...
</programlisting>
</example>
</section>
<section id="nathelper.p.natping_disable_bflag">
<title><varname>natping_disable_bflag</varname> (integer)</title>
<para>
What branch flag should be used by the module to disable NAT pings
on a per-registration basis. If the given flag is set for a
particular registration, then no NAT pings will be sent at all,
regardless of any other conditions.
</para>
<para>
<emphasis>
Default value is -1 (disabled).
</emphasis>
</para>
<example>
<title>Set <varname>natping_disable_bflag</varname> parameter</title>
<programlisting format="linespecific">
...
modparam("nathelper", "natping_disable_bflag", 8)
...
</programlisting>
</example>
</section>
<section id="nathelper.p.nortpproxy_str">
<title><varname>nortpproxy_str</varname> (string)</title>
<para>
The parameter sets the SDP attribute used by nathelper to mark
the packet SDP that information have already been mangled.
</para>
<para>
If empty string, no marker will be added or checked.
</para>
<note><para>
The string must be a complete SDP line, including the EOH (\r\n).
</para></note>
<para>
<emphasis>
Default value is <quote>a=nortpproxy:yes\r\n</quote>.
</emphasis>
</para>
<example>
<title>Set <varname>nortpproxy_str</varname> parameter</title>
<programlisting format="linespecific">
...
modparam("nathelper", "nortpproxy_str", "a=sdpmangled:yes\r\n")
...
</programlisting>
</example>
</section>
<section id="nathelper.p.keepalive_timeout">
<title><varname>keepalive_timeout</varname> (int)</title>
<para>
The parameter sets the interval in secods after which a natted
contact is removed from location table if it does not reply to SIP
keepalives (usually OPTIONS ping requests).
</para>
<para>
The features is available only for UDP contacts that are stored in memory
(not working for db only mode for usrloc module).
</para>
<para>
Keepalives are sent stateless, not using TM module. The value of this
parameter has to be few times higher than natping_interval.
</para>
<para>
<emphasis>
Default value is <quote>0</quote> (feature disabled).
</emphasis>
</para>
<example>
<title>Set <varname>keepalive_timeout</varname> parameter</title>
<programlisting format="linespecific">
...
modparam("nathelper", "keepalive_timeout", 120)
...
</programlisting>
</example>
</section>
<section id="nathelper.p.udpping_from_path">
<title><varname>udpping_from_path</varname> (int)</title>
<para>
Enable sending UDP pings (keepalives) using raw socket from Path
address.
</para>
<para>
<emphasis>
Default value is <quote>0</quote> (feature disabled).
</emphasis>
</para>
<example>
<title>Set <varname>udpping_from_path</varname> parameter</title>
<programlisting format="linespecific">
...
modparam("nathelper", "udpping_from_path", 1)
...
</programlisting>
</example>
</section>
<section id="nathelper.p.append_sdp_oldmediaip">
<title><varname>append_sdp_oldmediaip</varname> (int)</title>
<para>
The parameter controls if oldmediaip field should be appended to the SDP.
</para>
<para>
<emphasis>
Default value is <quote>1</quote> (feature enabled).
</emphasis>
</para>
<example>
<title>Set <varname>append_sdp_oldmediaip</varname> parameter</title>
<programlisting format="linespecific">
...
modparam("nathelper", "append_sdp_oldmediaip", 1)
...
</programlisting>
</example>
</section>
</section>
<section>
<title>Functions</title>
<section id="nathelper.f.fix_nated_contact">
<title>
<function moreinfo="none">fix_nated_contact()</function>
</title>
<para>
Rewrites the <quote>Contact</quote> header to contain the request's source
address:port.
</para>
<para>
This function can be used from REQUEST_ROUTE, ONREPLY_ROUTE, BRANCH_ROUTE.
</para>
<example>
<title><function>fix_nated_contact</function> usage</title>
<programlisting format="linespecific">
...
if (search("User-Agent: Cisco ATA.*") {fix_nated_contact();};
...
</programlisting>
</example>
</section>
<section id="nathelper.f.fix_nated_sdp">
<title>
<function moreinfo="none">fix_nated_sdp(flags [, ip_address])</function>
</title>
<para>
Alters the SDP information in orer to facilitate NAT traversal. What
changes to be performed may be controled via the
<quote>flags</quote> parameter. Return value is -1 if error occurred,
1 if ip's were replaced, 2 if no ip's were replaced.
</para>
<para>Meaning of the parameters is as follows:</para>
<itemizedlist>
<listitem><para>
<emphasis>flags</emphasis> - the value may be a bitwise OR of
the following flags:
</para>
<itemizedlist>
<listitem>
<para><emphasis>0x01</emphasis> - adds
<quote>a=direction:active</quote> SDP line;
</para>
</listitem>
<listitem>
<para><emphasis>0x02</emphasis> - rewrite media
&ip; address (c=) with source address of the message
or the provided IP address (the provide IP address take
precedence over the source address).</para>
</listitem>
<listitem>
<para><emphasis>0x04</emphasis> - adds
<quote>a=nortpproxy:yes</quote> SDP line;</para>
</listitem>
<listitem>
<para><emphasis>0x08</emphasis> - rewrite IP from
origin description (o=) with source address of the message
or the provided IP address (the provide IP address take
precedence over the source address).</para>
</listitem>
</itemizedlist>
</listitem>
<listitem><para>
<emphasis>ip_address</emphasis> - IP to be used for rewritting SDP.
If not specified, the received signalling IP will be used. The
parameter allows pseudo-variables usage. NOTE: For the IP to be
used, you need to use 0x02 or 0x08 flags, otherwise it will have
no effect.
</para>
</listitem>
</itemizedlist>
<para>
This function can be used from REQUEST_ROUTE, ONREPLY_ROUTE,
FAILURE_ROUTE, BRANCH_ROUTE.
</para>
<example>
<title><function>fix_nated_sdp</function> usage</title>
<programlisting format="linespecific">
...
if (search("User-Agent: Cisco ATA.*") {fix_nated_sdp("3");};
...
</programlisting>
</example>
</section>
<section id="nathelper.f.add_rcv_param">
<title>
<function moreinfo="none">add_rcv_param([flag])</function>,
</title>
<para>
Add a received parameter to the <quote>Contact</quote> header fields
or the Contact URI. The parameter will contain the URI created from the
source IP, port, and protocol of the packet containing the SIP message.
The parameter can be then processed by another registrar. This is useful,
for example, when replicating register messages using <function>t_replicate</function>
function to another registrar.
</para>
<para>Meaning of the parameters is as follows:</para>
<itemizedlist>
<listitem><para>
<emphasis>flag</emphasis> - flags to indicate if the parameter
should be added to Contact URI or Contact header. If the flag is
non-zero, the parameter will be added to the Contact URI. If not
used or equal to zero, the parameter will go to the Contact
header.
</para></listitem>
</itemizedlist>
<para>
This function can be used from REQUEST_ROUTE.
</para>
<example>
<title><function>add_rcv_paramer</function> usage</title>
<programlisting format="linespecific">
...
add_rcv_param(); # add the parameter to the Contact header
....
add_rcv_param("1"); # add the parameter to the Contact URI
...
</programlisting>
</example>
</section>
<section id="nathelper.f.fix_nated_register">
<title>
<function moreinfo="none">fix_nated_register()</function>
</title>
<para>
The function creates a URI consisting of the source IP, port, and
protocol and stores the URI in an Attribute-Value-Pair. The URI will
be appended as "received" parameter to Contact in 200 OK and
registrar will store it in the received cloumn in the location table.
</para>
<para>
Note: You have to set the <quote>received_avp</quote> parameter of the
nathelper module and the registrar module (both module parameters must
have the same value) to use this function.
</para>
<para>
This function can be used from REQUEST_ROUTE.
</para>
<example>
<title><function>fix_nated_register</function> usage</title>
<programlisting format="linespecific">
...
fix_nated_register();
...
</programlisting>
</example>
</section>
<section id="nathelper.f.nat_uac_test">
<title>
<function>nat_uac_test(flags)</function>
</title>
<para>
Tries to guess if client's request originated behind a nat.
The parameter determines what heuristics is used.
</para>
<para>Meaning of the flags is as follows:</para>
<itemizedlist>
<listitem><para>
<emphasis>1</emphasis> - The <quote>Contact</quote> header field is searched
for occurrence of RFC1918 or RFC6598 addresses.
</para></listitem>
<listitem><para>
<emphasis>2</emphasis> - the "received" test is used: address
in the <quote>Via</quote> header is compared against source
IP address of signaling
</para></listitem>
<listitem><para>
<emphasis>4</emphasis> - The Top Most <quote>Via</quote> is searched
for occurrence of RFC1918 or RFC6598 addresses
</para></listitem>
<listitem><para>
<emphasis>8</emphasis> - The SDP is searched for occurrence of
RFC1918 or RFC6598 addresses
</para></listitem>
<listitem><para>
<emphasis>16</emphasis> - Test if the source port is different
from the port in the <quote>Via</quote> header
</para></listitem>
<listitem><para>
<emphasis>32</emphasis> - Test if the source IP address of
signaling is a RFC1918 or RFC6598 address
</para></listitem>
<listitem><para>
<emphasis>64</emphasis> - Test if the source connection of
signaling is a WebSocket
</para></listitem>
<listitem><para>
<emphasis>128</emphasis> - Test if the <quote>Contact</quote> header
URI port differs from the source port of the request (Warning: this is
might be legal or even intended combination in non NATted scenarios)
</para></listitem>
</itemizedlist>
<para>
All flags can be bitwise combined, the test returns true if any of
the tests identified a NAT.
</para>
<para>
This function can be used from REQUEST_ROUTE, ONREPLY_ROUTE, FAILURE_ROUTE, BRANCH_ROUTE.
</para>
<example>
<title><function>nat_uac_test</function> usage</title>
<programlisting format="linespecific">
...
if(nat_uac_test("19")) {
rtpproxy_manage("co");
}
...
</programlisting>
</example>
</section>
<section id="nathelper.f.is_rfc1918">
<title>
<function>is_rfc1918(ip_address)</function>
</title>
<para>
Determines if the address in the parameter is an rfc1918 or rfc6598 address.
The parameter allows pseudo-variables usage.
</para>
<para>
This function can be used from ANY_ROUTE.
</para>
<example>
<title><function>is_rfc1918</function> usage</title>
<programlisting format="linespecific">
...
if(is_rfc1918("$rd")) {
# domain in r-uri is private address
}
...
</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 <quote>;alias=ip~port~transport</quote> parameter to
the contact URI containing either received ip, port, and
transport protocol or those given as parameters. If called
without parameters, <quote>;alias</quote> parameter is
only added if received ip and port differ from those in
contact URI.
</para>
<para>
This function can be used from
REQUEST_ROUTE, ONREPLY_ROUTE, BRANCH_ROUTE, and LOCAL_ROUTE.
</para>
<example>
<title><function>add_contact_alias</function> usage</title>
<programlisting format="linespecific">
...
if (!is_present_hf("Record-Route")) {
if (!add_contact_alias("$var(src_ip)", "$Rp", "tcp")) {
xlog("L_ERR", "Error in aliasing contact $ct\n");
send_reply("400", "Bad request");
exit;
};
};
...
</programlisting>
</example>
</section>
<section id="nathelper.f.handle_ruri_alias">
<title>
<function moreinfo="none">handle_ruri_alias()</function>
</title>
<para>
Checks if the Request URI has an <quote>alias</quote>
parameter and if so, removes it and sets the <quote>$du</quote> based
on its value. Note that this means that routing of request is based on
<quote>;alias</quote> parameter value of the Request URI rather than
the Request URI itself. If you call <function>handle_ruri_alias()</function>
on a request, make sure that you screen the alias parameter value of
Request URI the same way as you would screen the
Request URI itself.
</para>
<para>
Returns <emphasis>1</emphasis> if <quote>;alias</quote> parameter was
found and <quote>$du</quote> was set and the <quote>$ru</quote> rewritten,
<emphasis>2</emphasis> if the alias parameter was not found and
nothing was done, or <emphasis>-1</emphasis> in case of error.
</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">
...
if ($du == "") {
handle_ruri_alias();
switch ($rc) {
case -1:
xlog("L_ERR", "Failed to handle alias of R-URI $ru\n");
send_reply("400", "Bad request");
exit;
case 1:
xlog("L_INFO", "Routing in-dialog $rm from $fu to $du\n");
break;
case 2:
xlog("L_INFO", "Routing in-dialog $rm from $fu to $ru\n");
break;
};
};
...
</programlisting>
</example>
</section>
<section id="nathelper.set_contact_alias">
<title>
<function moreinfo="none">set_contact_alias()</function>
</title>
<para>
Adds an <quote>;alias=ip~port~transport</quote> parameter to the
contact URI containing the received ip, port, and transport protocol.
The new contact URI is immediately visible to other modules in the
way the <function>fix_nated_contact()</function> does it.
</para>
<para>
This function can be used from
REQUEST_ROUTE, ONREPLY_ROUTE, BRANCH_ROUTE, and FAILURE_ROUTE.
</para>
<example>
<title><function>set_contact_alias</function> usage</title>
<programlisting format="linespecific">
...
if (!is_present_hf("Record-Route")) {
if (!set_contact_alias()) {
xlog("L_ERR", "Error in aliasing contact $ct\n");
send_reply("400", "Bad request");
exit;
};
};
...
</programlisting>
</example>
</section>
</section>
<section>
<title>Exported Pseudo Variables</title>
<section>
<title><function moreinfo="none">$rr_count</function></title>
<para>
Number of Record Routes in received SIP request
or reply.
</para>
<example>
<title>$rr_count usage</title>
<programlisting format="linespecific">
...
$avp(rr_count) = $rr_count;
...
</programlisting>
</example>
</section>
<section>
<title><function moreinfo="none">$rr_top_count</function></title>
<para>
If topmost Record Route in received SIP request
or reply is a double Record Route, value of
$rr_top_count is 2. If it a single Record
Route, value of $rr_top_count
is 1. If there is no Record Route(s), value of
$rr_top_count is 0.
</para>
<example>
<title>$rr_top_count usage</title>
<programlisting format="linespecific">
...
if ($rr_count == $avp(rr_count) + $rr_top_count) {
route(ADD_CONTACT_ALIAS);
};
...
</programlisting>
</example>
</section>
</section>
<section>
<title><acronym>MI</acronym> Commands</title>
<section id="nathelper.m.nh_enable_ping">
<title><function moreinfo="none">nh_enable_ping</function></title>
<para>
Enables natping if parameter value greater than 0.
Disables natping if parameter value is 0.
</para>
<para>
The function takes only one parameter - a number in decimal format.
</para>
<example>
<title><function moreinfo="none">nh_enable_ping</function> usage</title>
<programlisting format="linespecific">
...
$ &ctltool; fifo nh_enable_ping 1
...
</programlisting>
</example>
</section>
</section>
<section>
<title>Selects</title>
<section id="nathelper.s.rewrite_contact">
<title>@nathelper.rewrite_contact[n]</title>
<para>
Get n-th Contact value with IP:Port rewritten to source ip:port. N is counted from 1.
Only IP:port is rewritten, remaining part are left unchanged. Full nameaddr is supported.
</para>
<example>
<title>@nathelper.rewrite_contact usage</title>
<programlisting>
...
$c = @nathelper.rewrite_contact[1];
...
$c2 = @nathelper.rewrite_contact[1].nameaddr.uri;
</programlisting>
</example>
</section>
</section>
</chapter>