- more clear documentation for the new ds_is_from_list flags
<!-- Kamailio Pull Request Template -->
<!--
IMPORTANT:
- for detailed contributing guidelines, read:
https://github.com/kamailio/kamailio/blob/master/.github/CONTRIBUTING.md
- pull requests must be done to master branch, unless they are backports
of fixes from master branch to a stable branch
- backports to stable branches must be done with 'git cherry-pick -x ...'
- code is contributed under BSD for core and main components (tm, sl, auth, tls)
- code is contributed GPLv2 or a compatible license for the other components
- GPL code is contributed with OpenSSL licensing exception
-->
#### Pre-Submission Checklist
<!-- Go over all points below, and after creating the PR, tick all the checkboxes that apply -->
<!-- All points should be verified, otherwise, read the CONTRIBUTING guidelines from above-->
<!-- If you're unsure about any of these, don't hesitate to ask on sr-dev mailing list -->
- [x] Commit message has the format required by CONTRIBUTING guide
- [x] Commits are split per component (core, individual modules, libs, utils, ...)
- [x] Each component has a single commit (if not, squash them into one commit)
- [x] No commits to README files for modules (changes must be done to docbook files
in `doc/` subfolder, the README file is autogenerated)
#### Type Of Change
- [x] Small bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds new functionality)
- [ ] Breaking change (fix or feature that would change existing functionality)
#### Checklist:
<!-- Go over all points below, and after creating the PR, tick the checkboxes that apply -->
- [ ] PR should be backported to stable branches
- [ ] Tested changes locally
- [ ] Related to issue #XXXX (replace XXXX with an open issue number)
#### Description
<!-- Describe your changes in detail -->
You can view, comment on, or merge this pull request online at:
https://github.com/kamailio/kamailio/pull/3783
-- Commit Summary --
* dispatcher: refine documentation
-- File Changes --
M src/modules/dispatcher/doc/dispatcher_admin.xml (9)
-- Patch Links --
https://github.com/kamailio/kamailio/pull/3783.patchhttps://github.com/kamailio/kamailio/pull/3783.diff
--
Reply to this email directly or view it on GitHub:
https://github.com/kamailio/kamailio/pull/3783
You are receiving this because you are subscribed to this thread.
Message ID: <kamailio/kamailio/pull/3783(a)github.com>
Module: kamailio
Branch: master
Commit: 761e963c0f7d9bf1b66c1ef18a409756b919ae2c
URL: https://github.com/kamailio/kamailio/commit/761e963c0f7d9bf1b66c1ef18a40975…
Author: Dennis Yurasov <dennis-y(a)yandex-team.ru>
Committer: Daniel-Constantin Mierla <miconda(a)gmail.com>
Date: 2024-03-13T10:08:05+01:00
dispatcher: refine documentation
- more clear documentation for the new ds_is_from_list flags
---
Modified: src/modules/dispatcher/doc/dispatcher_admin.xml
---
Diff: https://github.com/kamailio/kamailio/commit/761e963c0f7d9bf1b66c1ef18a40975…
Patch: https://github.com/kamailio/kamailio/commit/761e963c0f7d9bf1b66c1ef18a40975…
---
diff --git a/src/modules/dispatcher/doc/dispatcher_admin.xml b/src/modules/dispatcher/doc/dispatcher_admin.xml
index 4708ca06c92..83ef06285a0 100644
--- a/src/modules/dispatcher/doc/dispatcher_admin.xml
+++ b/src/modules/dispatcher/doc/dispatcher_admin.xml
@@ -1805,9 +1805,12 @@ if(ds_list_exists("10")) {
If bit two is set, then protocol is ignored.
If bit three is set, then state must be active.
If bit four is set, then socket/sockname be matched.
- If bit five is set, then try to find the most complete
- "address/protocol/port/local socket" combination for all dispatcher targets. The parameter
- can be an integer or a variable holding an integer value.
+ If bit five is set, then try to find the most closest target from all
+ dispatcher targets with the mandatory ip and combination of local socket, protocol, port,
+ the weighted search result is combined from bit flags of matched components:
+ ip - 1, port - 2, protocol - 4, local socket - 8,
+ the target with the maximum value of flags combination will be selected.
+ The parameter can be an integer or a variable holding an integer value.
It must be provided if the uri parameter is provided.
</para>
</listitem>
<!-- Kamailio Pull Request Template -->
<!--
IMPORTANT:
- for detailed contributing guidelines, read:
https://github.com/kamailio/kamailio/blob/master/.github/CONTRIBUTING.md
- pull requests must be done to master branch, unless they are backports
of fixes from master branch to a stable branch
- backports to stable branches must be done with 'git cherry-pick -x ...'
- code is contributed under BSD for core and main components (tm, sl, auth, tls)
- code is contributed GPLv2 or a compatible license for the other components
- GPL code is contributed with OpenSSL licensing exception
-->
#### Pre-Submission Checklist
<!-- Go over all points below, and after creating the PR, tick all the checkboxes that apply -->
<!-- All points should be verified, otherwise, read the CONTRIBUTING guidelines from above-->
<!-- If you're unsure about any of these, don't hesitate to ask on sr-dev mailing list -->
- [ ] Commit message has the format required by CONTRIBUTING guide
- [ ] Commits are split per component (core, individual modules, libs, utils, ...)
- [ ] Each component has a single commit (if not, squash them into one commit)
- [ ] No commits to README files for modules (changes must be done to docbook files
in `doc/` subfolder, the README file is autogenerated)
#### Type Of Change
- [ ] Small bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds new functionality)
- [ ] Breaking change (fix or feature that would change existing functionality)
#### Checklist:
<!-- Go over all points below, and after creating the PR, tick the checkboxes that apply -->
- [ ] PR should be backported to stable branches
- [ ] Tested changes locally
- [ ] Related to issue #XXXX (replace XXXX with an open issue number)
#### Description
This PR adds 2 new flags to the mode parameter of the ds_is_from_list function.
Some times the dispatcher configuration can look like this (route attribute is just for exampe, sockname is important here):
70 sip:192.168.1.1:5060;transport=udp 0 1 route=route1;sockname=udp_5060
71 sip:192.168.1.1:5060;transport=udp 0 1 route=route2;sockname=udp_5061
72 sip:192.168.1.1:5060;transport=udp 0 1 route=route3;sockname=udp_5062
73 sip:192.168.1.1:5060;transport=udp 0 1 route=route4;sockname=udp_5063
Here we have one host/port/protocol on the remote side and different ports that we are listening on,
In stock dispatcher version ds_is_from_list(-1,0) will always match first available - 70, but this is not right
for dst ports 5061-5063 (sockets in realality, because we can have different local ip on same port also).
The new mode flag DS_MATCH_SOCKET (8) allow match for dispatcher socket also.
Second flag is DS_MATCH_STRICTEST (16), it allow to match more strictness target in "address/protocol/port/socket" key,
for example:
70 sip:192.168.1.1;transport=udp 0 1 route=route1
71 sip:192.168.1.1:5061;transport=udp 0 1 route=route2
72 sip:192.168.1.1:5062;transport=udp 0 1 route=route3
73 sip:192.168.1.1;transport=udp 0 1 route=route4;socket=udp:192.168.10.10:5063
if packet come from from any port of sip:192.168.1.1;transport=udp except 5061-5062 ds_is_from list will return 70,
if received port also is 5063 the result will be 73, packets from ports 5061-5062 will be matched at 71-72 respectively.
In stock version of ds_is_from_list the result will always be 70.
Note, the DS_MATCH_STRICTEST method can be more compute intensive, because we can potentially traverse all the dispatcher tree.
The behavior of existing flags are not changed.
You can view, comment on, or merge this pull request online at:
https://github.com/kamailio/kamailio/pull/3699
-- Commit Summary --
* dispatcher: added two new flags to mode parameter of ds_is_from_list function for more strictly matching
-- File Changes --
M src/modules/dispatcher/dispatch.c (112)
M src/modules/dispatcher/dispatch.h (2)
-- Patch Links --
https://github.com/kamailio/kamailio/pull/3699.patchhttps://github.com/kamailio/kamailio/pull/3699.diff
--
Reply to this email directly or view it on GitHub:
https://github.com/kamailio/kamailio/pull/3699
You are receiving this because you are subscribed to this thread.
Message ID: <kamailio/kamailio/pull/3699(a)github.com>
Module: kamailio
Branch: master
Commit: ef29e84929b8ef779341ef63a77e68ca6909705a
URL: https://github.com/kamailio/kamailio/commit/ef29e84929b8ef779341ef63a77e68c…
Author: Elena-Ramona Modroiu <ramona(a)asipto.com>
Committer: Elena-Ramona Modroiu <ramona(a)asipto.com>
Date: 2024-03-11T07:18:17+01:00
http_client: docs for http_client_request() function
---
Modified: src/modules/http_client/doc/http_client_admin.xml
---
Diff: https://github.com/kamailio/kamailio/commit/ef29e84929b8ef779341ef63a77e68c…
Patch: https://github.com/kamailio/kamailio/commit/ef29e84929b8ef779341ef63a77e68c…
---
diff --git a/src/modules/http_client/doc/http_client_admin.xml b/src/modules/http_client/doc/http_client_admin.xml
index 0e182cc95e3..df9d8c288e5 100644
--- a/src/modules/http_client/doc/http_client_admin.xml
+++ b/src/modules/http_client/doc/http_client_admin.xml
@@ -960,6 +960,30 @@ http_client_get("http://api.com/index.php?r_uri=$(ru{s.escape.param})&f_uri=
switch ($rc) {
...
}
+...
+ </programlisting>
+ </example>
+ </section>
+ <section id="http_client.f.http_client_request">
+ <title>
+ <function moreinfo="none">http_client_request(url, met, body, hdrs, respv)</function>
+ </title>
+ <para>
+ Perform a HTTP request to "url", storing the response body
+ in the "respv" variable. The method of the request is set by "met".
+ The "body" and "hdrs" can be empty strings to skip setting them.
+ The first four parameters can contain variables that are evaluated
+ at runtime. The "respv" has to be the name of a writable variable.
+ </para>
+ <example>
+ <title><function>http_client_request()</function> usage</title>
+ <programlisting format="linespecific">
+...
+http_client_request("GET", "http://api.com/index.php?r_uri=$(ru{s.escape.param})&f_uri=$(fu{s.escap…",
+ "", "X-Token: abc", "$var(result)");
+switch ($rc) {
+ ...
+}
...
</programlisting>
</example>
Kamailio v5.8.0 is out – it comes with 4 new modules and a large set of
improvements touching again more than 50 existing modules.
You can read a bit more detailed release notes at:
  * https://www.kamailio.org/w/kamailio-v5-8-0-release-notes/
Many thanks to all developers and community members that made possible
this release.
v5.8.0 brings more flexibility and optimizations across many existing
components and modules, new parameters, functions, variables and
transformations.
Enjoy Kamailio v5.8.0!
Thank you for flying Kamailio!
Daniel
--
Daniel-Constantin Mierla (@ asipto.com)
twitter.com/miconda -- linkedin.com/in/miconda
Kamailio Consultancy, Training and Development Services -- asipto.com
Kamailio World Conference, April 18-19, 2024, Berlin -- kamailioworld.com
Module: kamailio
Branch: 5.7
Commit: 3eb545779876265f4587ff8ff627530b70c761dc
URL: https://github.com/kamailio/kamailio/commit/3eb545779876265f4587ff8ff627530…
Author: Kamailio Dev <kamailio.dev(a)kamailio.org>
Committer: Kamailio Dev <kamailio.dev(a)kamailio.org>
Date: 2024-03-07T10:17:45+01:00
modules: readme files regenerated - modules ... [skip ci]
---
Modified: src/modules/db_mysql/README
---
Diff: https://github.com/kamailio/kamailio/commit/3eb545779876265f4587ff8ff627530…
Patch: https://github.com/kamailio/kamailio/commit/3eb545779876265f4587ff8ff627530…
---
diff --git a/src/modules/db_mysql/README b/src/modules/db_mysql/README
index 8d9f526cbe1..b1ae13eca1b 100644
--- a/src/modules/db_mysql/README
+++ b/src/modules/db_mysql/README
@@ -32,6 +32,7 @@ Daniel-Constantin Mierla
3.5. insert_delayed (integer)
3.6. update_affected_found (integer)
3.7. opt_ssl_mode (integer)
+ 3.8. opt_ssl_ca (string)
4. Functions
5. Installation
@@ -46,9 +47,10 @@ Daniel-Constantin Mierla
1.5. Set insert_delayed parameter
1.6. Set update_affected_found parameter
1.7. Set opt_ssl_mode parameter
- 1.8. Set a my.cnf group in db_url parameter
- 1.9. Adding a kamailio group to my.cnf
- 1.10. Using [client] and specific group
+ 1.8. Set opt_ssl_ca parameter
+ 1.9. Set a my.cnf group in db_url parameter
+ 1.10. Adding a kamailio group to my.cnf
+ 1.11. Using [client] and specific group
Chapter 1. Admin Guide
@@ -69,6 +71,7 @@ Chapter 1. Admin Guide
3.5. insert_delayed (integer)
3.6. update_affected_found (integer)
3.7. opt_ssl_mode (integer)
+ 3.8. opt_ssl_ca (string)
4. Functions
5. Installation
@@ -105,6 +108,7 @@ Chapter 1. Admin Guide
3.5. insert_delayed (integer)
3.6. update_affected_found (integer)
3.7. opt_ssl_mode (integer)
+ 3.8. opt_ssl_ca (string)
3.1. ping_interval (integer)
@@ -209,6 +213,21 @@ modparam("db_mysql", "update_affected_found", 1)
modparam("db_mysql", "opt_ssl_mode", 1)
...
+3.8. opt_ssl_ca (string)
+
+ Configures the CA certs used to verify the MySQL server cert when SSL
+ is enabled.
+
+ Required when opt_ssl_mode = 4 or 5 and db_mysql is built with
+ libmysqlclient.
+
+ Default value is NULL (NULL - not configured).
+
+ Example 1.8. Set opt_ssl_ca parameter
+...
+modparam("db_mysql", "opt_ssl_ca", "/etc/ssl/certs/mysql-ca.pem")
+...
+
4. Functions
No function exported to be used from configuration file.
@@ -235,12 +254,12 @@ modparam("db_mysql", "opt_ssl_mode", 1)
* mysql://user:pass@[group]/db
* mysql://[group]/db
- Example 1.8. Set a my.cnf group in db_url parameter
+ Example 1.9. Set a my.cnf group in db_url parameter
...
modparam("usrloc", "db_url", "mysql://[kamailio]/kamailio)
...
- Example 1.9. Adding a kamailio group to my.cnf
+ Example 1.10. Adding a kamailio group to my.cnf
...
[kamailio]
socket = /path/to/mysql.sock
@@ -254,7 +273,7 @@ default-character-set = utf8
both your specific group and the client group, then the value is taken
from the last one.
- Example 1.10. Using [client] and specific group
+ Example 1.11. Using [client] and specific group
...
[client]
socket = /run/mysql/mysqld.sock
Module: kamailio
Branch: 5.8
Commit: ed99a5e2648c39e29fbbc7842c86425147c607c6
URL: https://github.com/kamailio/kamailio/commit/ed99a5e2648c39e29fbbc7842c86425…
Author: Kamailio Dev <kamailio.dev(a)kamailio.org>
Committer: Kamailio Dev <kamailio.dev(a)kamailio.org>
Date: 2024-03-07T10:17:15+01:00
modules: readme files regenerated - modules ... [skip ci]
---
Modified: src/modules/tls/README
---
Diff: https://github.com/kamailio/kamailio/commit/ed99a5e2648c39e29fbbc7842c86425…
Patch: https://github.com/kamailio/kamailio/commit/ed99a5e2648c39e29fbbc7842c86425…
---
diff --git a/src/modules/tls/README b/src/modules/tls/README
index 78af3bdcc77..d98f94eb8ed 100644
--- a/src/modules/tls/README
+++ b/src/modules/tls/README
@@ -263,8 +263,9 @@ Chapter 1. Admin Guide
profiles of tls.cfg file.
When installing tls module of kamailio, a sample 'tls.cfg' file is
- deployed in the same folder with 'kamailio.cfg', along with freshly
- generated self signed certificates.
+ deployed in the same folder with 'kamailio.cfg'. For freshly generated
+ self signed certificates make must be called from tls folder
+make install-tls-cert
HINT: be sure you have enable_tls=yes to your kamailio.cfg.
@@ -402,9 +403,6 @@ make -C modules/tls extra_defs="-DTLS_WR_DEBUG -DTLS_RD_DEBUG"
standard conforming (the verification should happen during TLS
connection establishment and not after).
- TLS specific config reloading is not safe, so for now better don't use
- it, especially under heavy traffic.
-
This documentation is incomplete. The provided selects are not
documented in this file. A list with all the ones implemented by the
TLS module can be found in the Cookbook
@@ -1683,6 +1681,10 @@ verify_client = optional_no_ca
are not terminated and they continue to use the old certificates. The
new configuration will be used for new connections.
+ Reload is generally safe and usable in production environments. If
+ possible should be done in a time where the service has lower
+ usage/connections.
+
This RPC command is exported with "RPC_EXEC_DELTA" flag, therefore its
execution rate can be restricted to specific time intervals by setting
the "rpc_exec_delta" core parameter.
Module: kamailio
Branch: 5.8
Commit: 22f274513a98cc081d44a6694e35c3e96844dae3
URL: https://github.com/kamailio/kamailio/commit/22f274513a98cc081d44a6694e35c3e…
Author: Xenofon Karamanos <22965395+xkaraman(a)users.noreply.github.com>
Committer: Daniel-Constantin Mierla <miconda(a)gmail.com>
Date: 2024-03-07T10:07:03+01:00
tls/docs: Update certificate generation docs
(cherry picked from commit 67785fea8f906236e4a30bc09bb11b3292c46572)
---
Modified: src/modules/tls/doc/tls.xml
---
Diff: https://github.com/kamailio/kamailio/commit/22f274513a98cc081d44a6694e35c3e…
Patch: https://github.com/kamailio/kamailio/commit/22f274513a98cc081d44a6694e35c3e…
---
diff --git a/src/modules/tls/doc/tls.xml b/src/modules/tls/doc/tls.xml
index 9b3f4eaacb3..5697792655a 100644
--- a/src/modules/tls/doc/tls.xml
+++ b/src/modules/tls/doc/tls.xml
@@ -93,7 +93,10 @@
</para>
<para>
When installing tls module of kamailio, a sample 'tls.cfg' file is deployed in the same
- folder with 'kamailio.cfg', along with freshly generated self signed certificates.
+ folder with 'kamailio.cfg'. For freshly generated self signed certificates make must be called from tls folder
+ <programlisting>
+make install-tls-cert
+ </programlisting>
</para>
<para>
HINT: be sure you have <emphasis>enable_tls=yes</emphasis> to your kamailio.cfg.