From 4dcbb5d3b813291320b30289d2cd786e11f97924 Mon Sep 17 00:00:00 2001 From: qxork Date: Thu, 3 Mar 2016 11:51:02 -0500 Subject: [PATCH] permissions: very minor spelling changes --- modules/permissions/README | 8 +- modules/permissions/doc/permissions_admin.xml | 178 +++++++++--------- 2 files changed, 93 insertions(+), 93 deletions(-) diff --git a/modules/permissions/README b/modules/permissions/README index 8c386d42d0d..9d0650ff9cd 100644 --- a/modules/permissions/README +++ b/modules/permissions/README @@ -18,9 +18,9 @@ Edited by Emmanuel Schmidbauer - Copyright © 2003 Miklos Tirpak + Copyright � 2003 Miklos Tirpak - Copyright © 2006-2008 Juha Heinanen + Copyright � 2006-2008 Juha Heinanen __________________________________________________________________ Table of Contents @@ -290,7 +290,7 @@ Chapter 1. Admin Guide 1.3. URI Permissions - The module can be used to determine if a request to a destionation is + The module can be used to determine if a request to a destination is allowed, based on an URI stored in a pvar. Permission rules are stored in plaintext configuration files similar to hosts.allow and hosts.deny used by tcpd. @@ -329,7 +329,7 @@ Chapter 1. Admin Guide One group can contain all of the three types of addresses: exact IP address, subnet IP address or DNS domain name. - When the argument is an IP addess, it is tried to be matched with the + When the argument is an IP address, it is tried to be matched with the records from that group that are of type exact IP or subnet. If the argument is not an IP it is tried to be matched with the records that are DNS domain names. No DNS lookup is performed, only strict matching. diff --git a/modules/permissions/doc/permissions_admin.xml b/modules/permissions/doc/permissions_admin.xml index 6b33e810dc2..c7517433477 100644 --- a/modules/permissions/doc/permissions_admin.xml +++ b/modules/permissions/doc/permissions_admin.xml @@ -10,9 +10,9 @@ - + &adminguide; - +
Overview @@ -41,21 +41,21 @@
Call Routing - The module can be used to determine if a call has appropriate - permission to be established. Permission rules are stored in + The module can be used to determine if a call has appropriate + permission to be established. Permission rules are stored in plaintext configuration files similar to hosts.allow and hosts.deny files used by tcpd. - When allow_routing function is - called it tries to find a rule that matches selected fields of the + When allow_routing function is + called it tries to find a rule that matches selected fields of the message. - &kamailio; is a forking proxy and therefore a single message can be sent - to different destinations simultaneously. When checking permissions - all the destinations must be checked and if one of them fails, the + &kamailio; is a forking proxy and therefore a single message can be sent + to different destinations simultaneously. When checking permissions + all the destinations must be checked and if one of them fails, the forwarding will fail. @@ -64,19 +64,19 @@ - Create a set of pairs of form (From, R-URI of branch 1), + Create a set of pairs of form (From, R-URI of branch 1), (From, R-URI of branch 2), etc. - Routing will be allowed when all pairs match an entry in the + Routing will be allowed when all pairs match an entry in the allow file. - Otherwise routing will be denied when one of pairs matches an + Otherwise routing will be denied when one of pairs matches an entry in the deny file. @@ -87,60 +87,60 @@ - A non-existing permission control file is treated as if it were an - empty file. Thus, permission control can be turned off by providing + A non-existing permission control file is treated as if it were an + empty file. Thus, permission control can be turned off by providing no permission control files. - From header field and Request-URIs are always compared with regular - expressions! For the syntax see the sample file: + From header field and Request-URIs are always compared with regular + expressions! For the syntax see the sample file: config/permissions.allow.
Registration Permissions - In addition to call routing it is also possible to check REGISTER - messages and decide--based on the configuration files--whether the + In addition to call routing it is also possible to check REGISTER + messages and decide--based on the configuration files--whether the message should be allowed and the registration accepted or not. - Main purpose of the function is to prevent registration of "prohibited" - IP addresses. One example, when a malicious user registers a contact - containing IP address of a PSTN gateway, he might be able to bypass - authorization checks performed by the SIP proxy. That is undesirable - and therefore attempts to register IP address of a PSTN gateway should + Main purpose of the function is to prevent registration of "prohibited" + IP addresses. One example, when a malicious user registers a contact + containing IP address of a PSTN gateway, he might be able to bypass + authorization checks performed by the SIP proxy. That is undesirable + and therefore attempts to register IP address of a PSTN gateway should be rejected. Files config/register.allow and config/register.deny contain an example + moreinfo="none">config/register.deny contain an example configuration. The function for registration checking is called allow_register and the algorithm is very - similar to the algorithm described in - . The only difference is in the way + moreinfo="none">allow_register and the algorithm is very + similar to the algorithm described in + . The only difference is in the way how pairs are created. - Instead of the From header field the function uses the To header field because - th To header field in REGISTER messages contains the URI of the person - being registered. Instead of the Request-URI of branches the function + Instead of the From header field the function uses the To header field because + th To header field in REGISTER messages contains the URI of the person + being registered. Instead of the Request-URI of branches the function uses the Contact header field. - Thus, the pairs used in matching will look like this: (To, Contact 1), + Thus, the pairs used in matching will look like this: (To, Contact 1), (To, Contact 2), (To, Contact 3), and so on.. - The algorithm of matching is the same as described in + The algorithm of matching is the same as described in .
URI Permissions - The module can be used to determine if a request to a destionation + The module can be used to determine if a request to a destination is allowed, based on an URI stored in a pvar. Permission rules are stored in plaintext configuration files similar to hosts.allow and @@ -177,13 +177,13 @@ - A non-existing permission control file is treated as if it were an - empty file. Thus, permission control can be turned off by providing + A non-existing permission control file is treated as if it were an + empty file. Thus, permission control can be turned off by providing no permission control files. - The From URI and the URI stored in pvar are always compared with regular - expressions! For the syntax see the sample file: + The From URI and the URI stored in pvar are always compared with regular + expressions! For the syntax see the sample file: config/permissions.allow.
@@ -205,18 +205,18 @@ identifier (positive integer value, i.e., equal or greater than 1). The group identifier is given as an argument to the allow_address() and allow_source_address() functions. - One group can contain all of the three types of addresses: exact + One group can contain all of the three types of addresses: exact IP address, subnet IP address or DNS domain name. - When the argument is an IP addess, it is tried to be matched with the - records from that group that are of type exact IP or subnet. If the + When the argument is an IP address, it is tried to be matched with the + records from that group that are of type exact IP or subnet. If the argument is not an IP it is tried to be matched with the records that are DNS domain names. No DNS lookup is performed, only strict matching. - As a side effect of matching the address, non-NULL tag + As a side effect of matching the address, non-NULL tag (see tag_col module parameter) is added as value to peer_tag AVP if peer_tag_avp module parameter has been defined. @@ -235,7 +235,7 @@ expression>. - A requests is accepted if there exists a rule, where + A requests is accepted if there exists a rule, where @@ -313,8 +313,8 @@
<varname>default_allow_file</varname> (string) - Default allow file used by the functions with no parameters. If you - don't specify a full pathname then the directory in which is the main + Default allow file used by the functions with no parameters. If you + don't specify a full pathname then the directory in which is the main config file is located will be used. @@ -335,7 +335,7 @@ modparam("permissions", "default_allow_file", "/etc/permissions.allow") <varname>default_deny_file</varname> (string) Default file containing deny rules. The file is used by functions - with no parameters. If you don't specify a full pathname then the + with no parameters. If you don't specify a full pathname then the directory in which the main config file is located will be used. @@ -355,13 +355,13 @@ modparam("permissions", "default_deny_file", "/etc/permissions.deny")
<varname>check_all_branches</varname> (integer) - If set then allow_routing functions will check Request-URI of all - branches (default). If disabled then only Request-URI of the first + If set then allow_routing functions will check Request-URI of all + branches (default). If disabled then only Request-URI of the first branch will be checked. - Do not disable this parameter unless you really know what you + Do not disable this parameter unless you really know what you are doing. @@ -382,8 +382,8 @@ modparam("permissions", "check_all_branches", 0)
<varname>allow_suffix</varname> (string) - Suffix to be appended to basename to create filename of the allow - file when version with one parameter of either + Suffix to be appended to basename to create filename of the allow + file when version with one parameter of either allow_routing or allow_register is used. @@ -409,8 +409,8 @@ modparam("permissions", "allow_suffix", ".allow")
<varname>deny_suffix</varname> (string) - Suffix to be appended to basename to create filename of the deny file - when version with one parameter of either + Suffix to be appended to basename to create filename of the deny file + when version with one parameter of either allow_routing or allow_register is used. @@ -436,7 +436,7 @@ modparam("permissions", "deny_suffix", ".deny")
<varname>db_url</varname> (string) - This is URL of the database to be used to store rules used by + This is URL of the database to be used to store rules used by allow_trusted function. @@ -625,7 +625,7 @@ modparam("permissions", "source_col", "source_ip_address") the received request. Possible values that can be stored in proto_col are any, udp, tcp, tls, - sctp, ws, wss, + sctp, ws, wss, and none. Value any matches always and value none never. @@ -687,7 +687,7 @@ modparam("permissions", "ruri_col", "regexp")
<varname>tag_col</varname> (string) - Name of the column in the address or + Name of the column in the address or trusted table containing a string that is added as value to peer_tag AVP if peer_tag AVP has been defined and if the address or peer matches. @@ -753,7 +753,7 @@ modparam("permissions", "peer_tag_avp", "$avp(i:707)") <varname>peer_tag_mode</varname> (integer) Tag mode for allow_trusted. - 0 sets only the tag of the first match. + 0 sets only the tag of the first match. 1 adds the tags of all matches to the avp. In addition the return value of allow_trusted is the number of matches. This parameter is not used for address table matching functions. @@ -802,8 +802,8 @@ modparam("permissions", "max_subnets", 1024) Returns true if all pairs constructed as described in have appropriate permissions according to - the configuration files. This function uses default configuration + linkend="sec-call-routing"/> have appropriate permissions according to + the configuration files. This function uses default configuration files specified in default_allow_file and default_deny_file. @@ -827,20 +827,20 @@ if (allow_routing()) { Returns true if all pairs constructed as described in have appropriate permissions according + linkend="sec-call-routing"/> have appropriate permissions according to the configuration files given as parameters. Meaning of the parameters is as follows: - basename - Basename from which allow + basename - Basename from which allow and deny filenames will be created by appending contents of allow_suffix and deny_suffix parameters. - If the parameter doesn't contain full pathname then the function - expects the file to be located in the same directory as the main + If the parameter doesn't contain full pathname then the function + expects the file to be located in the same directory as the main configuration file of the server. @@ -864,8 +864,8 @@ if (allow_routing("basename")) { allow_routing(allow_file,deny_file) - Returns true if all pairs constructed as described in - have appropriate permissions + Returns true if all pairs constructed as described in + have appropriate permissions according to the configuration files given as parameters. Meaning of the parameters is as follows: @@ -874,8 +874,8 @@ if (allow_routing("basename")) { allow_file - File containing allow rules. - If the parameter doesn't contain full pathname then the function - expects the file to be located in the same directory as the main + If the parameter doesn't contain full pathname then the function + expects the file to be located in the same directory as the main configuration file of the server. @@ -883,8 +883,8 @@ if (allow_routing("basename")) { deny_file - File containing deny rules. - If the parameter doesn't contain full pathname then the function - expects the file to be located in the same directory as the main + If the parameter doesn't contain full pathname then the function + expects the file to be located in the same directory as the main configuration file of the server. @@ -909,20 +909,20 @@ if (allow_routing("rules.allow", "rules.deny")) { The function returns true if all pairs constructed as described in have appropriate permissions + linkend="sec-registration-permissions"/> have appropriate permissions according to the configuration files given as parameters. Meaning of the parameters is as follows: - basename - Basename from which allow + basename - Basename from which allow and deny filenames will be created by appending contents of allow_suffix and deny_suffix parameters. - If the parameter doesn't contain full pathname then the function - expects the file to be located in the same directory as the main + If the parameter doesn't contain full pathname then the function + expects the file to be located in the same directory as the main configuration file of the server. @@ -951,8 +951,8 @@ if (method=="REGISTER") { allow_register(allow_file, deny_file) - The function returns true if all pairs constructed as described in - have appropriate + The function returns true if all pairs constructed as described in + have appropriate permissions according to the configuration files given as parameters. Meaning of the parameters is as follows: @@ -961,8 +961,8 @@ if (method=="REGISTER") { allow_file - File containing allow rules. - If the parameter doesn't contain full pathname then the function - expects the file to be located in the same directory as the main + If the parameter doesn't contain full pathname then the function + expects the file to be located in the same directory as the main configuration file of the server. @@ -970,8 +970,8 @@ if (method=="REGISTER") { deny_file - File containing deny rules. - If the parameter doesn't contain full pathname then the function - expects the file to be located in the same directory as the main + If the parameter doesn't contain full pathname then the function + expects the file to be located in the same directory as the main configuration file of the server. @@ -1001,20 +1001,20 @@ if (method=="REGISTER") { Returns true if the pair constructed as described in have appropriate permissions + linkend="sec-uri-permissions"/> have appropriate permissions according to the configuration files specified by the parameter. Meaning of the parameter is as follows: - basename - Basename from which allow + basename - Basename from which allow and deny filenames will be created by appending contents of allow_suffix and deny_suffix parameters. - If the parameter doesn't contain full pathname then the function - expects the file to be located in the same directory as the main + If the parameter doesn't contain full pathname then the function + expects the file to be located in the same directory as the main configuration file of the server. @@ -1052,14 +1052,14 @@ if (allow_uri("basename", "$avp(i:705)") { // Check URI stored in $avp(i:705) address table. - When matching is done if the argument is an IP address, it is + When matching is done if the argument is an IP address, it is matched with the records from that group that are of type exact IP or subnet. If the argument is not an IP it is tried to be matched with the records that are DNS domain names. No DNS lookup is performed, only strict matching. Cached address table entry containing port value 0 matches any port. The group_id argument can be an integer - string or a pseudo variable. + string or a pseudo variable. This function can be used from REQUEST_ROUTE, FAILURE_ROUTE. @@ -1200,7 +1200,7 @@ if (allow_trusted("$si", "$proto")) {
- +
MI Commands
@@ -1209,7 +1209,7 @@ if (allow_trusted("$si", "$proto")) { Causes the permissions module to re-read the contents of - address database table into cache memory. + address database table into cache memory. The in-cache memory entries are for performance reasons stored in two different tables: address table and @@ -1219,7 +1219,7 @@ if (allow_trusted("$si", "$proto")) { Parameters: none
- +
<function moreinfo="none">address_dump</function> @@ -1260,7 +1260,7 @@ if (allow_trusted("$si", "$proto")) { <function moreinfo="none">trusted_dump</function> - Causes the permissions module to dump the + Causes the permissions module to dump the contents of trusted table from cache memory. Parameters: none @@ -1313,7 +1313,7 @@ if (allow_trusted("$si", "$proto")) { Parameters: none
- +
<function moreinfo="none">addressDump</function>