From 8c16055853a697d1a13ef760da06a30544dc4fd8 Mon Sep 17 00:00:00 2001 From: Kamailio Dev Date: Thu, 12 Nov 2020 14:46:14 +0100 Subject: [PATCH] modules: readme files regenerated - secsipid ... [skip ci] --- src/modules/secsipid/README | 44 ++++++++++++++++++++++++++++++++----- 1 file changed, 38 insertions(+), 6 deletions(-) diff --git a/src/modules/secsipid/README b/src/modules/secsipid/README index a58d5110787..a65afcf78e5 100644 --- a/src/modules/secsipid/README +++ b/src/modules/secsipid/README @@ -28,6 +28,8 @@ Daniel-Constantin Mierla 3.1. expire (int) 3.2. timeout (int) + 3.3. cache_dir (str) + 3.4. cache_expire (int) 4. Functions @@ -41,9 +43,11 @@ Daniel-Constantin Mierla 1.1. Set expire parameter 1.2. Set timeout parameter - 1.3. secsipid_check_identity usage - 1.4. secsipid_add_identity usage - 1.5. Libsecsipid usage + 1.3. Set cache_dir parameter + 1.4. Set cache_expire parameter + 1.5. secsipid_check_identity usage + 1.6. secsipid_add_identity usage + 1.7. Libsecsipid usage Chapter 1. Admin Guide @@ -59,6 +63,8 @@ Chapter 1. Admin Guide 3.1. expire (int) 3.2. timeout (int) + 3.3. cache_dir (str) + 3.4. cache_expire (int) 4. Functions @@ -95,6 +101,8 @@ Chapter 1. Admin Guide 3.1. expire (int) 3.2. timeout (int) + 3.3. cache_dir (str) + 3.4. cache_expire (int) 3.1. expire (int) @@ -120,6 +128,30 @@ modparam("secsipid", "expire", 600) modparam("secsipid", "timeout", 2) ... +3.3. cache_dir (str) + + The path to the directory where to save cached pyblic keys. If set, it + activates the public key file caching in the libsecsipid library. + + Default value is "". + + Example 1.3. Set cache_dir parameter +... +modparam("secsipid", "cache_dir", "/tmp/kamailio/secsipid") +... + +3.4. cache_expire (int) + + The interval in seconds after which a cached public key is considered + expired. This value is passed to the libsecsipid library. + + Default value is 3600. + + Example 1.4. Set cache_expire parameter +... +modparam("secsipid", "cache_expire", 7200) +... + 4. Functions 4.1. secsipid_check_identity(keyPath) @@ -139,7 +171,7 @@ modparam("secsipid", "timeout", 2) This function can be used from ANY_ROUTE. - Example 1.3. secsipid_check_identity usage + Example 1.5. secsipid_check_identity usage ... request_route { ... @@ -168,7 +200,7 @@ request_route { This function can be used from ANY_ROUTE. - Example 1.4. secsipid_add_identity usage + Example 1.6. secsipid_add_identity usage ... request_route { ... @@ -192,7 +224,7 @@ request_route { installed and its environment configured, then run the following commands: - Example 1.5. Libsecsipid usage + Example 1.7. Libsecsipid usage ... go get https://github.com/asipto/secsipidx cd $GOPATH/src/github.com/asipto/secsipidx/csecsipid/