mirror of
https://github.com/owasp-modsecurity/ModSecurity.git
synced 2025-09-30 03:34:29 +03:00
Change 'sanitise' to 'sanitize' everywhere, preserving the 'sanitise' action variants for backward compatibility.
This commit is contained in:
@@ -5126,7 +5126,7 @@ SecRule REQUEST_HEADERS:User-Agent "Test" log,deny,status:403</programlisting>
|
||||
</section>
|
||||
|
||||
<section>
|
||||
<title><literal>sanitiseArg</literal></title>
|
||||
<title><literal>sanitizeArg</literal></title>
|
||||
|
||||
<para><emphasis>Description:</emphasis> Sanitises (replaces each byte
|
||||
with an asterisk) a named request argument prior to audit
|
||||
@@ -5136,7 +5136,7 @@ SecRule REQUEST_HEADERS:User-Agent "Test" log,deny,status:403</programlisting>
|
||||
|
||||
<para>Example:</para>
|
||||
|
||||
<programlisting format="linespecific">SecAction nolog,phase:2,<emphasis>sanitiseArg:password</emphasis></programlisting>
|
||||
<programlisting format="linespecific">SecAction nolog,phase:2,<emphasis>sanitizeArg:password</emphasis></programlisting>
|
||||
|
||||
<para><emphasis>Note</emphasis></para>
|
||||
|
||||
@@ -5148,7 +5148,7 @@ SecRule REQUEST_HEADERS:User-Agent "Test" log,deny,status:403</programlisting>
|
||||
</section>
|
||||
|
||||
<section>
|
||||
<title><literal>sanitiseMatched</literal></title>
|
||||
<title><literal>sanitizeMatched</literal></title>
|
||||
|
||||
<para><emphasis>Description:</emphasis> Sanitises the variable (request
|
||||
argument, request header, or response header) that caused a rule
|
||||
@@ -5156,52 +5156,52 @@ SecRule REQUEST_HEADERS:User-Agent "Test" log,deny,status:403</programlisting>
|
||||
|
||||
<para><emphasis>Action Group:</emphasis> Non-disruptive</para>
|
||||
|
||||
<para>Example: This action can be used to sanitise arbitrary transaction
|
||||
<para>Example: This action can be used to sanitize arbitrary transaction
|
||||
elements when they match a condition. For example, the example below
|
||||
will sanitise any argument that contains the word<emphasis>
|
||||
will sanitize any argument that contains the word<emphasis>
|
||||
password</emphasis> in the name.</para>
|
||||
|
||||
<programlisting format="linespecific">SecRule ARGS_NAMES password nolog,pass,<emphasis>sanitiseMatched</emphasis></programlisting>
|
||||
<programlisting format="linespecific">SecRule ARGS_NAMES password nolog,pass,<emphasis>sanitizeMatched</emphasis></programlisting>
|
||||
|
||||
<para><emphasis>Note</emphasis></para>
|
||||
|
||||
<para>Same note as sanitiseArg.</para>
|
||||
<para>Same note as sanitizeArg.</para>
|
||||
</section>
|
||||
|
||||
<section>
|
||||
<title><literal>sanitiseRequestHeader</literal></title>
|
||||
<title><literal>sanitizeRequestHeader</literal></title>
|
||||
|
||||
<para><emphasis>Description:</emphasis> Sanitises a named request
|
||||
header.</para>
|
||||
|
||||
<para><emphasis>Action Group:</emphasis> Non-disruptive</para>
|
||||
|
||||
<para>Example: This will sanitise the data in the Authorization
|
||||
<para>Example: This will sanitize the data in the Authorization
|
||||
header.</para>
|
||||
|
||||
<programlisting format="linespecific">SecAction log,phase:1,<emphasis>sanitiseRequestHeader:Authorization</emphasis></programlisting>
|
||||
<programlisting format="linespecific">SecAction log,phase:1,<emphasis>sanitizeRequestHeader:Authorization</emphasis></programlisting>
|
||||
|
||||
<para><emphasis>Note</emphasis></para>
|
||||
|
||||
<para>Same note as sanitiseArg.</para>
|
||||
<para>Same note as sanitizeArg.</para>
|
||||
</section>
|
||||
|
||||
<section>
|
||||
<title><literal>sanitiseResponseHeader</literal></title>
|
||||
<title><literal>sanitizeResponseHeader</literal></title>
|
||||
|
||||
<para><emphasis>Description:</emphasis> Sanitises a named response
|
||||
header.</para>
|
||||
|
||||
<para><emphasis>Action Group:</emphasis> Non-disruptive</para>
|
||||
|
||||
<para>Example: This will sanitise the Set-Cookie data sent to the
|
||||
<para>Example: This will sanitize the Set-Cookie data sent to the
|
||||
client.</para>
|
||||
|
||||
<programlisting format="linespecific">SecAction log,phase:3,<emphasis>sanitiseResponseHeader:Set-Cookie</emphasis></programlisting>
|
||||
<programlisting format="linespecific">SecAction log,phase:3,<emphasis>sanitizeResponseHeader:Set-Cookie</emphasis></programlisting>
|
||||
|
||||
<para><emphasis>Note</emphasis></para>
|
||||
|
||||
<para>Same note as sanitiseArg.</para>
|
||||
<para>Same note as sanitizeArg.</para>
|
||||
</section>
|
||||
|
||||
<section>
|
||||
@@ -5958,7 +5958,7 @@ SecRule XML "<emphasis>@validateSchema /path/to/apache2/conf/xml.xsd</emphasis>"
|
||||
<para>Example:</para>
|
||||
|
||||
<programlisting format="linespecific">SecRule ARGS "<emphasis>@verifyCC \d{13,16}</emphasis>" \
|
||||
"phase:2,sanitiseMatched,log,auditlog,pass,msg:'Potential credit card number'"</programlisting>
|
||||
"phase:2,sanitizeMatched,log,auditlog,pass,msg:'Potential credit card number'"</programlisting>
|
||||
</section>
|
||||
|
||||
<section>
|
||||
|
@@ -347,7 +347,7 @@
|
||||
|
||||
<para>ModSecurity alerts will always contain text fragments that were
|
||||
taken from configuration or the transaction. Such text fragments escaped
|
||||
before they are user in messages, in order to sanitise the potentially
|
||||
before they are user in messages, in order to sanitize the potentially
|
||||
dangerous characters. They are also sometimes surrounded using double
|
||||
quotes. The escaping algorithm is as follows:<orderedlist>
|
||||
<listitem>
|
||||
@@ -856,7 +856,7 @@ Server: Apache/2.x.x
|
||||
<title>Sanitised-Args</title>
|
||||
|
||||
<para>The <literal>Sanitised-Args</literal> header contains a list
|
||||
of arguments that were sanitised (each byte of their content
|
||||
of arguments that were sanitized (each byte of their content
|
||||
replaced with an asterisk) before logging. For example:</para>
|
||||
|
||||
<programlisting>Sanitised-Args: "old_password", "new_password", "new_password_repeat".</programlisting>
|
||||
@@ -866,7 +866,7 @@ Server: Apache/2.x.x
|
||||
<title>Sanitised-Request-Headers</title>
|
||||
|
||||
<para>The <literal>Sanitised-Request-Headers</literal> header
|
||||
contains a list of request headers that were sanitised before
|
||||
contains a list of request headers that were sanitized before
|
||||
logging. For example:</para>
|
||||
|
||||
<programlisting>Sanitised-Request-Headers: "Authentication".</programlisting>
|
||||
@@ -876,7 +876,7 @@ Server: Apache/2.x.x
|
||||
<title>Sanitised-Response-Headers</title>
|
||||
|
||||
<para>The <literal>Sanitised-Response-Headers</literal> header
|
||||
contains a list of response headers that were sanitised before
|
||||
contains a list of response headers that were sanitized before
|
||||
logging. For example:</para>
|
||||
|
||||
<programlisting>Sanitised-Response-Headers: "My-Custom-Header".</programlisting>
|
||||
|
Reference in New Issue
Block a user