Skip to content

Commit

Permalink
Rebuild documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@opensips-github
opensips-github committed Dec 23, 2023
1 parent a681c4f commit f1068b6
Show file tree
Hide file tree
Showing 10 changed files with 95 additions and 78 deletions.
6 changes: 3 additions & 3 deletions modules/dialog/README
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2548,7 +2548,7 @@ Chapter 4. Contributors
commits^(2) and lines added/removed^(3)
Name DevScore Commits Lines ++ Lines --
1. Bogdan-Andrei Iancu (@bogdan-iancu) 452 285 13276 3527
2. Razvan Crainea (@razvancrainea) 270 202 5072 1553
2. Razvan Crainea (@razvancrainea) 271 203 5078 1554
3. Vlad Paiu (@vladpaiu) 253 144 7205 3026
4. Vlad Patrascu (@rvlad-patrascu) 198 104 4330 3514
5. Liviu Chircu (@liviuchircu) 171 126 2943 1286
Expand Down Expand Up @@ -2592,8 +2592,8 @@ Chapter 4. Contributors

Table 4.2. Most recently active contributors^(1) to this module
Name Commit Activity
1. Liviu Chircu (@liviuchircu) Aug 2012 - Sep 2023
2. Razvan Crainea (@razvancrainea) Aug 2010 - Aug 2023
1. Razvan Crainea (@razvancrainea) Aug 2010 - Sep 2023
2. Liviu Chircu (@liviuchircu) Aug 2012 - Sep 2023
3. Vlad Patrascu (@rvlad-patrascu) Jul 2016 - Jun 2023
4. Bogdan-Andrei Iancu (@bogdan-iancu) Apr 2006 - Jun 2023
5. Ovidiu Sas (@ovidiusas) Feb 2008 - Jun 2023
Expand Down
16 changes: 8 additions & 8 deletions modules/dialog/doc/contributors.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,10 +29,10 @@
<row>
<entry>2. </entry>
<entry>Razvan Crainea (<ulink url="https://github.com/razvancrainea">@razvancrainea</ulink>)</entry>
<entry align="center">270</entry>
<entry align="center">202</entry>
<entry align="center">5072</entry>
<entry align="center">1553</entry>
<entry align="center">271</entry>
<entry align="center">203</entry>
<entry align="center">5078</entry>
<entry align="center">1554</entry>
</row>
<row>
<entry>3. </entry>
Expand Down Expand Up @@ -128,13 +128,13 @@
<tbody>
<row>
<entry>1. </entry>
<entry>Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>)</entry>
<entry align="center">Aug 2012 - Sep 2023</entry>
<entry>Razvan Crainea (<ulink url="https://github.com/razvancrainea">@razvancrainea</ulink>)</entry>
<entry align="center">Aug 2010 - Sep 2023</entry>
</row>
<row>
<entry>2. </entry>
<entry>Razvan Crainea (<ulink url="https://github.com/razvancrainea">@razvancrainea</ulink>)</entry>
<entry align="center">Aug 2010 - Aug 2023</entry>
<entry>Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>)</entry>
<entry align="center">Aug 2012 - Sep 2023</entry>
</row>
<row>
<entry>3. </entry>
Expand Down
12 changes: 6 additions & 6 deletions modules/ldap/README
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1346,7 +1346,7 @@ Chapter 3. Contributors
commits^(2) and lines added/removed^(3)
Name DevScore Commits Lines ++ Lines --
1. Christian Schlatter 57 6 5764 237
2. Bogdan-Andrei Iancu (@bogdan-iancu) 24 19 141 138
2. Bogdan-Andrei Iancu (@bogdan-iancu) 25 20 150 140
3. Ionut Ionita (@ionutrazvanionita) 22 5 1359 252
4. Razvan Crainea (@razvancrainea) 17 14 62 76
5. Daniel-Constantin Mierla (@miconda) 12 9 84 83
Expand Down Expand Up @@ -1381,11 +1381,11 @@ Chapter 3. Contributors

Table 3.2. Most recently active contributors^(1) to this module
Name Commit Activity
1. Maksym Sobolyev (@sobomax) Feb 2023 - Feb 2023
2. Petr Písař Mar 2022 - Mar 2022
3. Liviu Chircu (@liviuchircu) Mar 2014 - Jul 2021
4. Razvan Crainea (@razvancrainea) Jun 2011 - Jan 2021
5. Bogdan-Andrei Iancu (@bogdan-iancu) Jul 2007 - Mar 2020
1. Bogdan-Andrei Iancu (@bogdan-iancu) Jul 2007 - Sep 2023
2. Maksym Sobolyev (@sobomax) Feb 2023 - Feb 2023
3. Petr Písař Mar 2022 - Mar 2022
4. Liviu Chircu (@liviuchircu) Mar 2014 - Jul 2021
5. Razvan Crainea (@razvancrainea) Jun 2011 - Jan 2021
6. Zero King (@l2dy) Mar 2020 - Mar 2020
7. Vlad Patrascu (@rvlad-patrascu) May 2017 - Apr 2019
8. Peter Lemenkov (@lemenkov) Jun 2018 - Jun 2018
Expand Down
24 changes: 12 additions & 12 deletions modules/ldap/doc/contributors.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,10 +29,10 @@
<row>
<entry>2. </entry>
<entry>Bogdan-Andrei Iancu (<ulink url="https://github.com/bogdan-iancu">@bogdan-iancu</ulink>)</entry>
<entry align="center">24</entry>
<entry align="center">19</entry>
<entry align="center">141</entry>
<entry align="center">138</entry>
<entry align="center">25</entry>
<entry align="center">20</entry>
<entry align="center">150</entry>
<entry align="center">140</entry>
</row>
<row>
<entry>3. </entry>
Expand Down Expand Up @@ -128,29 +128,29 @@
<tbody>
<row>
<entry>1. </entry>
<entry>Bogdan-Andrei Iancu (<ulink url="https://github.com/bogdan-iancu">@bogdan-iancu</ulink>)</entry>
<entry align="center">Jul 2007 - Sep 2023</entry>
</row>
<row>
<entry>2. </entry>
<entry>Maksym Sobolyev (<ulink url="https://github.com/sobomax">@sobomax</ulink>)</entry>
<entry align="center">Feb 2023 - Feb 2023</entry>
</row>
<row>
<entry>2. </entry>
<entry>3. </entry>
<entry>Petr Písař</entry>
<entry align="center">Mar 2022 - Mar 2022</entry>
</row>
<row>
<entry>3. </entry>
<entry>4. </entry>
<entry>Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>)</entry>
<entry align="center">Mar 2014 - Jul 2021</entry>
</row>
<row>
<entry>4. </entry>
<entry>5. </entry>
<entry>Razvan Crainea (<ulink url="https://github.com/razvancrainea">@razvancrainea</ulink>)</entry>
<entry align="center">Jun 2011 - Jan 2021</entry>
</row>
<row>
<entry>5. </entry>
<entry>Bogdan-Andrei Iancu (<ulink url="https://github.com/bogdan-iancu">@bogdan-iancu</ulink>)</entry>
<entry align="center">Jul 2007 - Mar 2020</entry>
</row>
<row>
<entry>6. </entry>
<entry>Zero King (<ulink url="https://github.com/l2dy">@l2dy</ulink>)</entry>
Expand Down
6 changes: 3 additions & 3 deletions modules/sipmsgops/README
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1118,7 +1118,7 @@ Chapter 2. Contributors
1. Bogdan-Andrei Iancu (@bogdan-iancu) 68 38 2118 693
2. Liviu Chircu (@liviuchircu) 59 27 809 1510
3. Razvan Crainea (@razvancrainea) 48 21 2968 105
4. Vlad Paiu (@vladpaiu) 12 6 420 95
4. Vlad Paiu (@vladpaiu) 15 7 530 123
5. Mihai Tiganus (@tallicamike) 6 3 155 28
6. Maksym Sobolyev (@sobomax) 5 3 2 3
7. Vlad Patrascu (@rvlad-patrascu) 4 2 49 13
Expand Down Expand Up @@ -1152,8 +1152,8 @@ Chapter 2. Contributors

Table 2.2. Most recently active contributors^(1) to this module
Name Commit Activity
1. Razvan Crainea (@razvancrainea) Feb 2012 - Jun 2023
2. Vlad Paiu (@vladpaiu) Feb 2012 - May 2023
1. Vlad Paiu (@vladpaiu) Feb 2012 - Jun 2023
2. Razvan Crainea (@razvancrainea) Feb 2012 - Jun 2023
3. Maksym Sobolyev (@sobomax) Mar 2021 - Feb 2023
4. Bogdan-Andrei Iancu (@bogdan-iancu) Feb 2012 - Feb 2023
5. Liviu Chircu (@liviuchircu) Nov 2012 - Oct 2022
Expand Down
14 changes: 7 additions & 7 deletions modules/sipmsgops/doc/contributors.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,10 +45,10 @@
<row>
<entry>4. </entry>
<entry>Vlad Paiu (<ulink url="https://github.com/vladpaiu">@vladpaiu</ulink>)</entry>
<entry align="center">12</entry>
<entry align="center">6</entry>
<entry align="center">420</entry>
<entry align="center">95</entry>
<entry align="center">15</entry>
<entry align="center">7</entry>
<entry align="center">530</entry>
<entry align="center">123</entry>
</row>
<row>
<entry>5. </entry>
Expand Down Expand Up @@ -128,13 +128,13 @@
<tbody>
<row>
<entry>1. </entry>
<entry>Razvan Crainea (<ulink url="https://github.com/razvancrainea">@razvancrainea</ulink>)</entry>
<entry>Vlad Paiu (<ulink url="https://github.com/vladpaiu">@vladpaiu</ulink>)</entry>
<entry align="center">Feb 2012 - Jun 2023</entry>
</row>
<row>
<entry>2. </entry>
<entry>Vlad Paiu (<ulink url="https://github.com/vladpaiu">@vladpaiu</ulink>)</entry>
<entry align="center">Feb 2012 - May 2023</entry>
<entry>Razvan Crainea (<ulink url="https://github.com/razvancrainea">@razvancrainea</ulink>)</entry>
<entry align="center">Feb 2012 - Jun 2023</entry>
</row>
<row>
<entry>3. </entry>
Expand Down
6 changes: 3 additions & 3 deletions modules/siprec/README
View file
Original file line number Diff line number Diff line change
Expand Up @@ -330,7 +330,7 @@ Chapter 2. Contributors
Table 2.1. Top contributors by DevScore^(1), authored
commits^(2) and lines added/removed^(3)
Name DevScore Commits Lines ++ Lines --
1. Razvan Crainea (@razvancrainea) 138 71 4753 1708
1. Razvan Crainea (@razvancrainea) 139 72 4755 1710
2. Vlad Patrascu (@rvlad-patrascu) 16 11 166 149
3. Liviu Chircu (@liviuchircu) 9 7 35 53
4. Bogdan-Andrei Iancu (@bogdan-iancu) 4 2 3 2
Expand All @@ -357,8 +357,8 @@ Chapter 2. Contributors

Table 2.2. Most recently active contributors^(1) to this module
Name Commit Activity
1. Liviu Chircu (@liviuchircu) Apr 2018 - Aug 2023
2. Razvan Crainea (@razvancrainea) Jun 2017 - Jul 2023
1. Razvan Crainea (@razvancrainea) Jun 2017 - Sep 2023
2. Liviu Chircu (@liviuchircu) Apr 2018 - Aug 2023
3. Vlad Patrascu (@rvlad-patrascu) Feb 2018 - Mar 2023
4. Maksym Sobolyev (@sobomax) Feb 2023 - Feb 2023
5. Norman Brandinger (@NormB) Aug 2021 - Aug 2021
Expand Down
16 changes: 8 additions & 8 deletions modules/siprec/doc/contributors.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,10 @@
<row>
<entry>1. </entry>
<entry>Razvan Crainea (<ulink url="https://github.com/razvancrainea">@razvancrainea</ulink>)</entry>
<entry align="center">138</entry>
<entry align="center">71</entry>
<entry align="center">4753</entry>
<entry align="center">1708</entry>
<entry align="center">139</entry>
<entry align="center">72</entry>
<entry align="center">4755</entry>
<entry align="center">1710</entry>
</row>
<row>
<entry>2. </entry>
Expand Down Expand Up @@ -96,13 +96,13 @@
<tbody>
<row>
<entry>1. </entry>
<entry>Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>)</entry>
<entry align="center">Apr 2018 - Aug 2023</entry>
<entry>Razvan Crainea (<ulink url="https://github.com/razvancrainea">@razvancrainea</ulink>)</entry>
<entry align="center">Jun 2017 - Sep 2023</entry>
</row>
<row>
<entry>2. </entry>
<entry>Razvan Crainea (<ulink url="https://github.com/razvancrainea">@razvancrainea</ulink>)</entry>
<entry align="center">Jun 2017 - Jul 2023</entry>
<entry>Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>)</entry>
<entry align="center">Apr 2018 - Aug 2023</entry>
</row>
<row>
<entry>3. </entry>
Expand Down
57 changes: 37 additions & 20 deletions modules/stir_shaken/README
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,8 @@ STIR/SHAKEN Module
1.3.5. crl_list (string)
1.3.6. crl_dir (string)
1.3.7. e164_strict_mode (integer)
1.3.8. require_date_hdr (integer)
1.3.8. e164_max_length (integer)
1.3.9. require_date_hdr (integer)

1.4. Exported Functions

Expand Down Expand Up @@ -62,12 +63,13 @@ STIR/SHAKEN Module
1.5. Set crl_list parameter
1.6. Set crl_dir parameter
1.7. Set e164_strict_mode parameter
1.8. Set require_date_hdr parameter
1.9. stir_shaken_auth() usage
1.10. stir_shaken_verify() usage
1.11. stir_shaken_check() usage
1.12. stir_shaken_check_cert() usage
1.13. identity usage
1.8. Set e164_max_length parameter
1.9. Set require_date_hdr parameter
1.10. stir_shaken_auth() usage
1.11. stir_shaken_verify() usage
1.12. stir_shaken_check() usage
1.13. stir_shaken_check_cert() usage
1.14. identity usage

Chapter 1. Admin Guide

Expand Down Expand Up @@ -177,9 +179,10 @@ modparam("stir_shaken", "crl_dir", "/stir_certs/crls")

1.3.7. e164_strict_mode (integer)

Strictly check if the originating/destination identity derived
from the SIP message is an E.164 telephone number. Also require
the URI to either be a tel URI or a sip / sips URI with the
Require a leading "+" to be present in the
originating/destination SHAKEN identity, on top of mandating an
E.164 telephone number by default. Additionally, require the
URI to be either a tel URI or a sip / sips URI with the
user=phone parameter.

The default value is 0 (disabled).
Expand All @@ -189,7 +192,21 @@ modparam("stir_shaken", "crl_dir", "/stir_certs/crls")
modparam("stir_shaken", "e164_strict_mode", 1)
...

1.3.8. require_date_hdr (integer)
1.3.8. e164_max_length (integer)

This parameter allows the 15-digit number length restriction of
the E.164 format to be bypassed. Especially useful in scenarios
where various telephony number prefixes are in use, causing
some numbers to exceed the standard maximum length.

The default value is 15.

Example 1.8. Set e164_max_length parameter
...
modparam("stir_shaken", "e164_max_length", 16)
...

1.3.9. require_date_hdr (integer)

Specifies whether the Date header is mandatory when doing
verification with the stir_shaken_verify() function.
Expand All @@ -205,7 +222,7 @@ modparam("stir_shaken", "e164_strict_mode", 1)

The default value is 1 (required).

Example 1.8. Set require_date_hdr parameter
Example 1.9. Set require_date_hdr parameter
...
modparam("stir_shaken", "require_date_hdr", 0)
...
Expand Down Expand Up @@ -269,7 +286,7 @@ modparam("stir_shaken", "require_date_hdr", 0)

This function can be used from REQUEST_ROUTE.

Example 1.9. stir_shaken_auth() usage
Example 1.10. stir_shaken_auth() usage
...
stir_shaken_auth("A", "4437c7eb-8f7a-4f0e-a863-f53a0e60251a",
$var(cert), $var(privKey), "https://certs.example.org/cert.pem")
Expand Down Expand Up @@ -314,7 +331,7 @@ stir_shaken_auth("A", "4437c7eb-8f7a-4f0e-a863-f53a0e60251a",

This function can be used from REQUEST_ROUTE.

Example 1.10. stir_shaken_verify() usage
Example 1.11. stir_shaken_verify() usage
...
$var(rc) = stir_shaken_verify($var(cert), $var(err_code), $var(err_reaso
n));
Expand All @@ -340,7 +357,7 @@ if ($var(rc) < -1) {

This function can be used from REQUEST_ROUTE.

Example 1.11. stir_shaken_check() usage
Example 1.12. stir_shaken_check() usage
...
if (stir_shaken_check()) {
xlog("forwarding call to stir/shaken verification service\n");
Expand All @@ -360,7 +377,7 @@ if (stir_shaken_check()) {

This function can be used from REQUEST_ROUTE.

Example 1.12. stir_shaken_check_cert() usage
Example 1.13. stir_shaken_check_cert() usage
...
# update expired cached certificates
cache_fetch("local", $identity(x5u), $var(cert));
Expand Down Expand Up @@ -388,7 +405,7 @@ if (!stir_shaken_check_cert($var(cert))) {
claim;
* origid - the value of the 'origid' PASSporT claim;

Example 1.13. identity usage
Example 1.14. identity usage
...
# acquire the certificate to use for the verification process
$var(rc) = rest_get($identity(x5u), $var(cert));
Expand All @@ -409,7 +426,7 @@ Chapter 2. Contributors
commits^(2) and lines added/removed^(3)
Name DevScore Commits Lines ++ Lines --
1. Vlad Patrascu (@rvlad-patrascu) 58 26 3129 324
2. Liviu Chircu (@liviuchircu) 18 14 202 99
2. Liviu Chircu (@liviuchircu) 22 17 246 120
3. Maksym Sobolyev (@sobomax) 5 3 21 21
4. Razvan Crainea (@razvancrainea) 4 2 8 9
5. kworm83 4 2 7 2
Expand Down Expand Up @@ -437,8 +454,8 @@ Chapter 2. Contributors

Table 2.2. Most recently active contributors^(1) to this module
Name Commit Activity
1. Maksym Sobolyev (@sobomax) Jan 2021 - Feb 2023
2. Liviu Chircu (@liviuchircu) Nov 2019 - Aug 2022
1. Liviu Chircu (@liviuchircu) Nov 2019 - Sep 2023
2. Maksym Sobolyev (@sobomax) Jan 2021 - Feb 2023
3. Kevin Feb 2022 - Feb 2022
4. kworm83 Jan 2022 - Jan 2022
5. Vlad Patrascu (@rvlad-patrascu) Oct 2019 - Aug 2021
Expand Down

0 comments on commit f1068b6

Please sign in to comment.