From 34300dd8db7d52c639307f4121f8e61619a53f99 Mon Sep 17 00:00:00 2001 From: Kamailio Dev Date: Mon, 15 Nov 2021 10:46:22 +0100 Subject: [PATCH] modules: readme files regenerated - permissions ... [skip ci] --- src/modules/permissions/README | 63 +++++++++++++++++++++------------- 1 file changed, 40 insertions(+), 23 deletions(-) diff --git a/src/modules/permissions/README b/src/modules/permissions/README index 23dad5d6b53..431a6b513a6 100644 --- a/src/modules/permissions/README +++ b/src/modules/permissions/README @@ -61,6 +61,7 @@ Emmanuel Schmidbauer 3.23. max_subnets (int) 3.24. load_backends (int) 3.25. reload_delta (int) + 3.26. trusted_cleanup_interval (int) 4. Functions @@ -116,18 +117,19 @@ Emmanuel Schmidbauer 1.23. Set max_subnets parameter 1.24. Set load_backends parameter 1.25. Set reload_delta parameter - 1.26. allow_routing usage - 1.27. allow_routing(basename) usage - 1.28. allow_routing(allow_file, deny_file) usage - 1.29. allow_register(basename) usage - 1.30. allow_register(allow_file, deny_file) usage - 1.31. allow_uri(basename, pvar) usage - 1.32. allow_address() usage - 1.33. allow_source_address(group_id) usage - 1.34. allow_source_address_group() usage + 1.26. Set trusted_cleanup_interval parameter + 1.27. allow_routing usage + 1.28. allow_routing(basename) usage + 1.29. allow_routing(allow_file, deny_file) usage + 1.30. allow_register(basename) usage + 1.31. allow_register(allow_file, deny_file) usage + 1.32. allow_uri(basename, pvar) usage + 1.33. allow_address() usage + 1.34. allow_source_address(group_id) usage 1.35. allow_source_address_group() usage - 1.36. allow_trusted() usage - 1.37. Address File Sample + 1.36. allow_source_address_group() usage + 1.37. allow_trusted() usage + 1.38. Address File Sample Chapter 1. Admin Guide @@ -173,6 +175,7 @@ Chapter 1. Admin Guide 3.23. max_subnets (int) 3.24. load_backends (int) 3.25. reload_delta (int) + 3.26. trusted_cleanup_interval (int) 4. Functions @@ -405,6 +408,7 @@ Chapter 1. Admin Guide 3.23. max_subnets (int) 3.24. load_backends (int) 3.25. reload_delta (int) + 3.26. trusted_cleanup_interval (int) 3.1. default_allow_file (string) @@ -748,6 +752,19 @@ modparam("permissions", "load_backends", 1) modparam("permissions", "reload_delta", 1) ... +3.26. trusted_cleanup_interval (int) + + If module parameter db_mode is set to 1 a cleanup timer is set to the + trusted_cleanup_interval value in seconds. This process will cleanup + the previous values from memory after a RPC reload. + + Default value is “60”. + + Example 1.26. Set trusted_cleanup_interval parameter +... +modparam("permissions", "trusted_cleanup_interval", 120) +... + 4. Functions 4.1. allow_routing() @@ -771,7 +788,7 @@ modparam("permissions", "reload_delta", 1) This function can be used from REQUEST_ROUTE, FAILURE_ROUTE. - Example 1.26. allow_routing usage + Example 1.27. allow_routing usage ... if (allow_routing()) { t_relay(); @@ -794,7 +811,7 @@ if (allow_routing()) { This function can be used from REQUEST_ROUTE, FAILURE_ROUTE. - Example 1.27. allow_routing(basename) usage + Example 1.28. allow_routing(basename) usage ... if (allow_routing("basename")) { t_relay(); @@ -819,7 +836,7 @@ if (allow_routing("basename")) { This function can be used from REQUEST_ROUTE, FAILURE_ROUTE. - Example 1.28. allow_routing(allow_file, deny_file) usage + Example 1.29. allow_routing(allow_file, deny_file) usage ... if (allow_routing("rules.allow", "rules.deny")) { t_relay(); @@ -842,7 +859,7 @@ if (allow_routing("rules.allow", "rules.deny")) { This function can be used from REQUEST_ROUTE, FAILURE_ROUTE. - Example 1.29. allow_register(basename) usage + Example 1.30. allow_register(basename) usage ... if (method=="REGISTER") { if (allow_register("register")) { @@ -872,7 +889,7 @@ if (method=="REGISTER") { This function can be used from REQUEST_ROUTE, FAILURE_ROUTE. - Example 1.30. allow_register(allow_file, deny_file) usage + Example 1.31. allow_register(allow_file, deny_file) usage ... if (method=="REGISTER") { if (allow_register("register.allow", "register.deny")) { @@ -901,7 +918,7 @@ if (method=="REGISTER") { This function can be used from REQUEST_ROUTE, FAILURE_ROUTE. - Example 1.31. allow_uri(basename, pvar) usage + Example 1.32. allow_uri(basename, pvar) usage ... if (allow_uri("basename", "$rt")) { // Check Refer-To URI t_relay(); @@ -927,7 +944,7 @@ if (allow_uri("basename", "$avp(i:705)") { // Check URI stored in $avp(i:705) This function can be used from REQUEST_ROUTE, FAILURE_ROUTE. - Example 1.32. allow_address() usage + Example 1.33. allow_address() usage ... // Check if source address/port is in group 1 @@ -949,7 +966,7 @@ if (!allow_address("2", "$avp(dst_adr)", "$avp(dst_port)") { This function can be used from REQUEST_ROUTE, FAILURE_ROUTE. - Example 1.33. allow_source_address(group_id) usage + Example 1.34. allow_source_address(group_id) usage ... // Check source address/port of request @@ -966,7 +983,7 @@ if (!allow_source_address("1")) { This function can be used from REQUEST_ROUTE, FAILURE_ROUTE. - Example 1.34. allow_source_address_group() usage + Example 1.35. allow_source_address_group() usage ... $var(group) = allow_source_address_group(); @@ -984,7 +1001,7 @@ if ($var(group) != -1) { This function can be used from ANY_ROUTE. - Example 1.35. allow_source_address_group() usage + Example 1.36. allow_source_address_group() usage ... $var(group) = allow_address_group("1.2.3.4", "5060"); @@ -1014,7 +1031,7 @@ if ($var(group) != -1) { This function can be used from REQUEST_ROUTE, FAILURE_ROUTE. - Example 1.36. allow_trusted() usage + Example 1.37. allow_trusted() usage ... if (allow_trusted()) { t_relay(); @@ -1124,7 +1141,7 @@ if (allow_trusted("$si", "any", "$ai")) { provided, the tag value has to be a single token, without whitespaces (other punctuation signs can be in its value, like ',', '=', ';', ...). - Example 1.37. Address File Sample + Example 1.38. Address File Sample ... # address file - records to match with allow_address(...) and variants # * file format details