Skip to content

Commit 195a186

Browse files
opensips-githubopensips-github
committed
Rebuild documentation
1 parent 3377918 commit 195a186

File tree

6 files changed

+74
-66
lines changed

6 files changed

+74
-66
lines changed

‎modules/nathelper/README‎

Lines changed: 23 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,8 @@ nathelper Module
9090
1.21. fix_nated_sdp usage
9191
1.22. add_rcv_paramer usage
9292
1.23. fix_nated_register usage
93-
1.24. nh_enable_ping usage
93+
1.24. nat_uac_test usage
94+
1.25. nh_enable_ping usage
9495

9596
Chapter 1. Admin Guide
9697

@@ -557,12 +558,13 @@ fix_nated_register();
557558

558559
1.5.5. nat_uac_test(flags)
559560

560-
Tries to guess if client's request originated behind a nat. The
561-
parameter determines what heuristics is used.
561+
Determines whether the received SIP message originated behind a
562+
NAT, using one or more pre-defined checks.
562563

563-
Meaning of the flags (string) parameter is as follows:
564+
The flags (string) parameter denotes a comma-separated list of
565+
checks to be performed, as follows:
564566
* private-contact - (old 1 flag) Contact header field is
565-
searched for occurrence of RFC1918 / RFC6598 addresses.
567+
searched for occurrence of RFC1918 / RFC6598 addresses
566568
* diff-ip-src-via - (old 2 flag) the "received" test is used:
567569
address in Via is compared against source IP address of
568570
signaling
@@ -577,14 +579,20 @@ fix_nated_register();
577579
* diff-port-src-contact - (old 64 flag) Port in Contact is
578580
compared against source port of signaling
579581
* carrier-grade-nat - (old 128 flag) also include RFC 6333
580-
addresses in the checks for ct, via and sdp flags.
582+
addresses in the checks for Contact, Via and SDP
581583

582-
A CSV of the above flags can be provided, the test returns true
583-
if any of the tests identified a NAT.
584+
Returns true if any of the tests passed.
584585

585586
This function can be used from REQUEST_ROUTE, ONREPLY_ROUTE,
586587
FAILURE_ROUTE, BRANCH_ROUTE.
587588

589+
Example 1.24. nat_uac_test usage
590+
...
591+
# check for private Contact or SDP media IP addresses
592+
if (nat_uac_test("private-contact,private-sdp"))
593+
xlog("SIP message is NAT'ed (Call-ID: $ci)\n");
594+
...
595+
588596
1.6. Exported MI Functions
589597

590598
1.6.1. nh_enable_ping
@@ -597,7 +605,7 @@ fix_nated_register();
597605
parameter value greater than 0 or disables natping if
598606
parameter value is 0.
599607

600-
Example 1.24. nh_enable_ping usage
608+
Example 1.25. nh_enable_ping usage
601609
...
602610
$ opensips-cli -x mi nh_enable_ping
603611
Status:: 1
@@ -651,7 +659,7 @@ Chapter 3. Contributors
651659
Name DevScore Commits Lines ++ Lines --
652660
1. Bogdan-Andrei Iancu (@bogdan-iancu) 153 121 2044 866
653661
2. Maksym Sobolyev (@sobomax) 153 45 3556 4790
654-
3. Liviu Chircu (@liviuchircu) 46 37 420 298
662+
3. Liviu Chircu (@liviuchircu) 48 38 438 307
655663
4. Ionut Ionita (@ionutrazvanionita) 40 15 1598 627
656664
5. Razvan Crainea (@razvancrainea) 33 27 158 240
657665
6. Daniel-Constantin Mierla (@miconda) 22 17 142 124
@@ -691,8 +699,8 @@ Chapter 3. Contributors
691699

692700
Table 3.2. Most recently active contributors^(1) to this module
693701
Name Commit Activity
694-
1. Maksym Sobolyev (@sobomax) May 2003 - Nov 2023
695-
2. Liviu Chircu (@liviuchircu) Jan 2013 - Oct 2023
702+
1. Liviu Chircu (@liviuchircu) Jan 2013 - Jan 2024
703+
2. Maksym Sobolyev (@sobomax) May 2003 - Nov 2023
696704
3. Vlad Paiu (@vladpaiu) Aug 2010 - Jul 2023
697705
4. Vlad Patrascu (@rvlad-patrascu) May 2017 - Apr 2023
698706
5. Nick Altmann (@nikbyte) May 2022 - May 2022
@@ -720,9 +728,9 @@ Chapter 4. Documentation
720728

721729
4.1. Contributors
722730

723-
Last edited by: Vlad Patrascu (@rvlad-patrascu), Nick Altmann
724-
(@nikbyte), Jasper Hafkenscheid (@hafkensite), Liviu Chircu
725-
(@liviuchircu), Razvan Crainea (@razvancrainea), Bogdan-Andrei
731+
Last edited by: Liviu Chircu (@liviuchircu), Vlad Patrascu
732+
(@rvlad-patrascu), Nick Altmann (@nikbyte), Jasper Hafkenscheid
733+
(@hafkensite), Razvan Crainea (@razvancrainea), Bogdan-Andrei
726734
Iancu (@bogdan-iancu), Peter Lemenkov (@lemenkov), Ovidiu Sas
727735
(@ovidiusas), Ionut Ionita (@ionutrazvanionita), Walter Doekes
728736
(@wdoekes), Christophe Sollet (@csollet), Vlad Paiu

‎modules/nathelper/doc/contributors.xml‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -37,10 +37,10 @@
3737
<row>
3838
<entry>3. </entry>
3939
<entry>Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>)</entry>
40-
<entry align="center">46</entry>
41-
<entry align="center">37</entry>
42-
<entry align="center">420</entry>
43-
<entry align="center">298</entry>
40+
<entry align="center">48</entry>
41+
<entry align="center">38</entry>
42+
<entry align="center">438</entry>
43+
<entry align="center">307</entry>
4444
</row>
4545
<row>
4646
<entry>4. </entry>
@@ -128,13 +128,13 @@
128128
<tbody>
129129
<row>
130130
<entry>1. </entry>
131-
<entry>Maksym Sobolyev (<ulink url="https://github.com/sobomax">@sobomax</ulink>)</entry>
132-
<entry align="center">May 2003 - Nov 2023</entry>
131+
<entry>Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>)</entry>
132+
<entry align="center">Jan 2013 - Jan 2024</entry>
133133
</row>
134134
<row>
135135
<entry>2. </entry>
136-
<entry>Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>)</entry>
137-
<entry align="center">Jan 2013 - Oct 2023</entry>
136+
<entry>Maksym Sobolyev (<ulink url="https://github.com/sobomax">@sobomax</ulink>)</entry>
137+
<entry align="center">May 2003 - Nov 2023</entry>
138138
</row>
139139
<row>
140140
<entry>3. </entry>
@@ -190,7 +190,7 @@
190190
<title>Documentation</title>
191191
<section id="documentation_contributors" xreflabel="documentation_contributors">
192192
<title>Contributors</title>
193-
<para><emphasis role='bold'>Last edited by:</emphasis> Vlad Patrascu (<ulink url="https://github.com/rvlad-patrascu">@rvlad-patrascu</ulink>), Nick Altmann (<ulink url="https://github.com/nikbyte">@nikbyte</ulink>), Jasper Hafkenscheid (<ulink url="https://github.com/hafkensite">@hafkensite</ulink>), Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>), Razvan Crainea (<ulink url="https://github.com/razvancrainea">@razvancrainea</ulink>), Bogdan-Andrei Iancu (<ulink url="https://github.com/bogdan-iancu">@bogdan-iancu</ulink>), Peter Lemenkov (<ulink url="https://github.com/lemenkov">@lemenkov</ulink>), Ovidiu Sas (<ulink url="https://github.com/ovidiusas">@ovidiusas</ulink>), Ionut Ionita (<ulink url="https://github.com/ionutrazvanionita">@ionutrazvanionita</ulink>), Walter Doekes (<ulink url="https://github.com/wdoekes">@wdoekes</ulink>), Christophe Sollet (<ulink url="https://github.com/csollet">@csollet</ulink>), Vlad Paiu (<ulink url="https://github.com/vladpaiu">@vladpaiu</ulink>), Maksym Sobolyev (<ulink url="https://github.com/sobomax">@sobomax</ulink>), Anca Vamanu, Andrei Dragus, Sergio Gutierrez, Klaus Darilion, Daniel-Constantin Mierla (<ulink url="https://github.com/miconda">@miconda</ulink>), Konstantin Bokarius, Edson Gellert Schubert, Carsten Bock, Ancuta Onofrei, Marcus Hunger, Jeremie Le Hen, Bayan Towfiq, Elena-Ramona Modroiu, Jan Janak (<ulink url="https://github.com/janakj">@janakj</ulink>), Jiri Kuthan (<ulink url="https://github.com/jiriatipteldotorg">@jiriatipteldotorg</ulink>).</para>
193+
<para><emphasis role='bold'>Last edited by:</emphasis> Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>), Vlad Patrascu (<ulink url="https://github.com/rvlad-patrascu">@rvlad-patrascu</ulink>), Nick Altmann (<ulink url="https://github.com/nikbyte">@nikbyte</ulink>), Jasper Hafkenscheid (<ulink url="https://github.com/hafkensite">@hafkensite</ulink>), Razvan Crainea (<ulink url="https://github.com/razvancrainea">@razvancrainea</ulink>), Bogdan-Andrei Iancu (<ulink url="https://github.com/bogdan-iancu">@bogdan-iancu</ulink>), Peter Lemenkov (<ulink url="https://github.com/lemenkov">@lemenkov</ulink>), Ovidiu Sas (<ulink url="https://github.com/ovidiusas">@ovidiusas</ulink>), Ionut Ionita (<ulink url="https://github.com/ionutrazvanionita">@ionutrazvanionita</ulink>), Walter Doekes (<ulink url="https://github.com/wdoekes">@wdoekes</ulink>), Christophe Sollet (<ulink url="https://github.com/csollet">@csollet</ulink>), Vlad Paiu (<ulink url="https://github.com/vladpaiu">@vladpaiu</ulink>), Maksym Sobolyev (<ulink url="https://github.com/sobomax">@sobomax</ulink>), Anca Vamanu, Andrei Dragus, Sergio Gutierrez, Klaus Darilion, Daniel-Constantin Mierla (<ulink url="https://github.com/miconda">@miconda</ulink>), Konstantin Bokarius, Edson Gellert Schubert, Carsten Bock, Ancuta Onofrei, Marcus Hunger, Jeremie Le Hen, Bayan Towfiq, Elena-Ramona Modroiu, Jan Janak (<ulink url="https://github.com/janakj">@janakj</ulink>), Jiri Kuthan (<ulink url="https://github.com/jiriatipteldotorg">@jiriatipteldotorg</ulink>).</para>
194194
</section>
195195

196196
</chapter>

‎modules/presence_dfks/README‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -217,7 +217,7 @@ Chapter 2. Contributors
217217
Name DevScore Commits Lines ++ Lines --
218218
1. Vlad Patrascu (@rvlad-patrascu) 23 7 1641 92
219219
2. Maksym Sobolyev (@sobomax) 8 6 16 21
220-
3. Bogdan-Andrei Iancu (@bogdan-iancu) 4 2 29 24
220+
3. Bogdan-Andrei Iancu (@bogdan-iancu) 5 3 30 25
221221
4. Liviu Chircu (@liviuchircu) 4 2 2 2
222222
5. Razvan Crainea (@razvancrainea) 3 1 67 21
223223

@@ -241,8 +241,8 @@ Chapter 2. Contributors
241241

242242
Table 2.2. Most recently active contributors^(1) to this module
243243
Name Commit Activity
244-
1. Maksym Sobolyev (@sobomax) Jan 2021 - Nov 2023
245-
2. Bogdan-Andrei Iancu (@bogdan-iancu) Dec 2020 - May 2023
244+
1. Bogdan-Andrei Iancu (@bogdan-iancu) Dec 2020 - Jan 2024
245+
2. Maksym Sobolyev (@sobomax) Jan 2021 - Nov 2023
246246
3. Liviu Chircu (@liviuchircu) Nov 2020 - Jan 2021
247247
4. Vlad Patrascu (@rvlad-patrascu) Dec 2019 - Sep 2020
248248
5. Razvan Crainea (@razvancrainea) Feb 2020 - Feb 2020
@@ -254,8 +254,8 @@ Chapter 3. Documentation
254254

255255
3.1. Contributors
256256

257-
Last edited by: Vlad Patrascu (@rvlad-patrascu), Razvan Crainea
258-
(@razvancrainea).
257+
Last edited by: Bogdan-Andrei Iancu (@bogdan-iancu), Vlad
258+
Patrascu (@rvlad-patrascu), Razvan Crainea (@razvancrainea).
259259

260260
Documentation Copyrights:
261261

‎modules/presence_dfks/doc/contributors.xml‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -37,10 +37,10 @@
3737
<row>
3838
<entry>3. </entry>
3939
<entry>Bogdan-Andrei Iancu (<ulink url="https://github.com/bogdan-iancu">@bogdan-iancu</ulink>)</entry>
40-
<entry align="center">4</entry>
41-
<entry align="center">2</entry>
42-
<entry align="center">29</entry>
43-
<entry align="center">24</entry>
40+
<entry align="center">5</entry>
41+
<entry align="center">3</entry>
42+
<entry align="center">30</entry>
43+
<entry align="center">25</entry>
4444
</row>
4545
<row>
4646
<entry>4. </entry>
@@ -88,13 +88,13 @@
8888
<tbody>
8989
<row>
9090
<entry>1. </entry>
91-
<entry>Maksym Sobolyev (<ulink url="https://github.com/sobomax">@sobomax</ulink>)</entry>
92-
<entry align="center">Jan 2021 - Nov 2023</entry>
91+
<entry>Bogdan-Andrei Iancu (<ulink url="https://github.com/bogdan-iancu">@bogdan-iancu</ulink>)</entry>
92+
<entry align="center">Dec 2020 - Jan 2024</entry>
9393
</row>
9494
<row>
9595
<entry>2. </entry>
96-
<entry>Bogdan-Andrei Iancu (<ulink url="https://github.com/bogdan-iancu">@bogdan-iancu</ulink>)</entry>
97-
<entry align="center">Dec 2020 - May 2023</entry>
96+
<entry>Maksym Sobolyev (<ulink url="https://github.com/sobomax">@sobomax</ulink>)</entry>
97+
<entry align="center">Jan 2021 - Nov 2023</entry>
9898
</row>
9999
<row>
100100
<entry>3. </entry>
@@ -125,7 +125,7 @@
125125
<title>Documentation</title>
126126
<section id="documentation_contributors" xreflabel="documentation_contributors">
127127
<title>Contributors</title>
128-
<para><emphasis role='bold'>Last edited by:</emphasis> Vlad Patrascu (<ulink url="https://github.com/rvlad-patrascu">@rvlad-patrascu</ulink>), Razvan Crainea (<ulink url="https://github.com/razvancrainea">@razvancrainea</ulink>).</para>
128+
<para><emphasis role='bold'>Last edited by:</emphasis> Bogdan-Andrei Iancu (<ulink url="https://github.com/bogdan-iancu">@bogdan-iancu</ulink>), Vlad Patrascu (<ulink url="https://github.com/rvlad-patrascu">@rvlad-patrascu</ulink>), Razvan Crainea (<ulink url="https://github.com/razvancrainea">@razvancrainea</ulink>).</para>
129129
</section>
130130

131131
</chapter>

‎modules/tracer/README‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -500,7 +500,7 @@ Chapter 2. Contributors
500500
2. Ionut Ionita (@ionutrazvanionita) 105 52 2676 1887
501501
3. Razvan Crainea (@razvancrainea) 70 49 1642 421
502502
4. Daniel-Constantin Mierla (@miconda) 49 26 2215 191
503-
5. Liviu Chircu (@liviuchircu) 24 21 85 76
503+
5. Liviu Chircu (@liviuchircu) 25 22 87 78
504504
6. Vlad Paiu (@vladpaiu) 24 10 402 568
505505
7. Vlad Patrascu (@rvlad-patrascu) 17 8 286 335
506506
8. Henning Westerholt (@henningw) 11 6 146 155
@@ -535,16 +535,16 @@ Chapter 2. Contributors
535535

536536
Table 2.2. Most recently active contributors^(1) to this module
537537
Name Commit Activity
538-
1. Vlad Paiu (@vladpaiu) Jun 2011 - Dec 2023
539-
2. Maksym Sobolyev (@sobomax) Feb 2023 - Nov 2023
540-
3. Bogdan-Andrei Iancu (@bogdan-iancu) Jul 2006 - Jul 2023
541-
4. Razvan Crainea (@razvancrainea) Jun 2011 - Jun 2023
542-
5. Vlad Patrascu (@rvlad-patrascu) May 2017 - May 2023
543-
6. okhowang Mar 2023 - Mar 2023
544-
7. Peter Lemenkov (@lemenkov) Jun 2018 - Sep 2022
545-
8. Nick Altmann (@nikbyte) Feb 2022 - Feb 2022
546-
9. Walter Doekes (@wdoekes) Apr 2019 - Apr 2021
547-
10. Liviu Chircu (@liviuchircu) Jan 2013 - Mar 2021
538+
1. Liviu Chircu (@liviuchircu) Jan 2013 - Jan 2024
539+
2. Vlad Paiu (@vladpaiu) Jun 2011 - Dec 2023
540+
3. Maksym Sobolyev (@sobomax) Feb 2023 - Nov 2023
541+
4. Bogdan-Andrei Iancu (@bogdan-iancu) Jul 2006 - Jul 2023
542+
5. Razvan Crainea (@razvancrainea) Jun 2011 - Jun 2023
543+
6. Vlad Patrascu (@rvlad-patrascu) May 2017 - May 2023
544+
7. okhowang Mar 2023 - Mar 2023
545+
8. Peter Lemenkov (@lemenkov) Jun 2018 - Sep 2022
546+
9. Nick Altmann (@nikbyte) Feb 2022 - Feb 2022
547+
10. Walter Doekes (@wdoekes) Apr 2019 - Apr 2021
548548

549549
All remaining contributors: Ovidiu Sas (@ovidiusas), Zero King
550550
(@l2dy), Dan Pascu (@danpascu), Eric Tamme (@etamme), Ionut

‎modules/tracer/doc/contributors.xml‎

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -53,10 +53,10 @@
5353
<row>
5454
<entry>5. </entry>
5555
<entry>Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>)</entry>
56-
<entry align="center">24</entry>
57-
<entry align="center">21</entry>
58-
<entry align="center">85</entry>
59-
<entry align="center">76</entry>
56+
<entry align="center">25</entry>
57+
<entry align="center">22</entry>
58+
<entry align="center">87</entry>
59+
<entry align="center">78</entry>
6060
</row>
6161
<row>
6262
<entry>6. </entry>
@@ -128,54 +128,54 @@
128128
<tbody>
129129
<row>
130130
<entry>1. </entry>
131+
<entry>Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>)</entry>
132+
<entry align="center">Jan 2013 - Jan 2024</entry>
133+
</row>
134+
<row>
135+
<entry>2. </entry>
131136
<entry>Vlad Paiu (<ulink url="https://github.com/vladpaiu">@vladpaiu</ulink>)</entry>
132137
<entry align="center">Jun 2011 - Dec 2023</entry>
133138
</row>
134139
<row>
135-
<entry>2. </entry>
140+
<entry>3. </entry>
136141
<entry>Maksym Sobolyev (<ulink url="https://github.com/sobomax">@sobomax</ulink>)</entry>
137142
<entry align="center">Feb 2023 - Nov 2023</entry>
138143
</row>
139144
<row>
140-
<entry>3. </entry>
145+
<entry>4. </entry>
141146
<entry>Bogdan-Andrei Iancu (<ulink url="https://github.com/bogdan-iancu">@bogdan-iancu</ulink>)</entry>
142147
<entry align="center">Jul 2006 - Jul 2023</entry>
143148
</row>
144149
<row>
145-
<entry>4. </entry>
150+
<entry>5. </entry>
146151
<entry>Razvan Crainea (<ulink url="https://github.com/razvancrainea">@razvancrainea</ulink>)</entry>
147152
<entry align="center">Jun 2011 - Jun 2023</entry>
148153
</row>
149154
<row>
150-
<entry>5. </entry>
155+
<entry>6. </entry>
151156
<entry>Vlad Patrascu (<ulink url="https://github.com/rvlad-patrascu">@rvlad-patrascu</ulink>)</entry>
152157
<entry align="center">May 2017 - May 2023</entry>
153158
</row>
154159
<row>
155-
<entry>6. </entry>
160+
<entry>7. </entry>
156161
<entry>okhowang</entry>
157162
<entry align="center">Mar 2023 - Mar 2023</entry>
158163
</row>
159164
<row>
160-
<entry>7. </entry>
165+
<entry>8. </entry>
161166
<entry>Peter Lemenkov (<ulink url="https://github.com/lemenkov">@lemenkov</ulink>)</entry>
162167
<entry align="center">Jun 2018 - Sep 2022</entry>
163168
</row>
164169
<row>
165-
<entry>8. </entry>
170+
<entry>9. </entry>
166171
<entry>Nick Altmann (<ulink url="https://github.com/nikbyte">@nikbyte</ulink>)</entry>
167172
<entry align="center">Feb 2022 - Feb 2022</entry>
168173
</row>
169174
<row>
170-
<entry>9. </entry>
175+
<entry>10. </entry>
171176
<entry>Walter Doekes (<ulink url="https://github.com/wdoekes">@wdoekes</ulink>)</entry>
172177
<entry align="center">Apr 2019 - Apr 2021</entry>
173178
</row>
174-
<row>
175-
<entry>10. </entry>
176-
<entry>Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>)</entry>
177-
<entry align="center">Jan 2013 - Mar 2021</entry>
178-
</row>
179179
</tbody>
180180
</tgroup>
181181
</table>

0 commit comments

Comments
 (0)