From cd62f20022085821ddc136d54ae14b15bdc87ab3 Mon Sep 17 00:00:00 2001
From: brectanus <brectanus@9017d574-64ec-4062-9424-5e00b32a252b>
Date: Wed, 2 May 2007 17:00:13 +0000
Subject: [PATCH] Add docs for new transformations and operators.  See #54, #55
 and #117.

---
 doc/modsecurity2-apache-reference.xml | 91 +++++++++++++++++++++++++++
 1 file changed, 91 insertions(+)

diff --git a/doc/modsecurity2-apache-reference.xml b/doc/modsecurity2-apache-reference.xml
index 2e608548..d8ec6cf8 100644
--- a/doc/modsecurity2-apache-reference.xml
+++ b/doc/modsecurity2-apache-reference.xml
@@ -2777,6 +2777,13 @@ SecRule <emphasis role="bold">XML:/xq:employees/employee/name/text()</emphasis>
       </itemizedlist>
     </section>
 
+    <section>
+      <title><literal>length</literal></title>
+
+      <para>This function converts the input to its numeric length (count of
+      characters).</para>
+    </section>
+
     <section>
       <title><literal>lowercase</literal></title>
 
@@ -2876,6 +2883,27 @@ SecRule <emphasis role="bold">XML:/xq:employees/employee/name/text()</emphasis>
 
       <para>This function calculates a SHA1 hash from input.</para>
     </section>
+
+    <section>
+      <title><literal>trimLeft</literal></title>
+
+      <para>This function removes whitespace from the left side of
+      input.</para>
+    </section>
+
+    <section>
+      <title><literal>trimRight</literal></title>
+
+      <para>This function removes whitespace from the right side of
+      input.</para>
+    </section>
+
+    <section>
+      <title><literal>trim</literal></title>
+
+      <para>This function removes whitespace from both the left and right
+      sides of input.</para>
+    </section>
   </section>
 
   <section id="07-actions">
@@ -3910,6 +3938,53 @@ SecRule XML:/soap:Envelope/soap:Body/q1:getInput/id() "123" phase:2,deny</progra
     operator syntax used the "@" symbol followed by the specific operator
     name.</para>
 
+    <section>
+      <title><literal>beginsWith</literal></title>
+
+      <para><emphasis role="bold">Description: </emphasis>This operator is a
+      string comparison and returns true if the parameter value is found at
+      the beginning of the input. Macro expansion is performed so you may use
+      variable names such as %{TX.1}, etc.</para>
+
+      <para>Example:</para>
+
+      <programlisting format="linespecific">SecRule REQUEST_LINE "!<emphasis
+          role="bold">@beginsWith GET</emphasis>" t:none,deny,status:403
+SecRule REQUEST_ADDR "^(.*)\.\d+$" deny,status:403,capture,chain
+SecRule ARGS:gw "!<emphasis role="bold">@beginsWith %{TX.1}</emphasis>"</programlisting>
+    </section>
+
+    <section>
+      <title><literal>contains</literal></title>
+
+      <para><emphasis role="bold">Description: </emphasis>This operator is a
+      string comparison and returns true if the parameter value is found
+      anywhere in the input. Macro expansion is performed so you may use
+      variable names such as %{TX.1}, etc.</para>
+
+      <para>Example:</para>
+
+      <programlisting format="linespecific">SecRule REQUEST_LINE "!<emphasis
+          role="bold">@contains .php </emphasis>" t:none,deny,status:403
+SecRule REQUEST_ADDR "^(.*)$" deny,status:403,capture,chain
+SecRule ARGS:ip "!<emphasis role="bold">@contains %{TX.1}</emphasis>"</programlisting>
+    </section>
+
+    <section>
+      <title><literal>endsWith</literal></title>
+
+      <para><emphasis role="bold">Description: </emphasis>This operator is a
+      string comparison and returns true if the parameter value is found at
+      the end of the input. Macro expansion is performed so you may use
+      variable names such as %{TX.1}, etc.</para>
+
+      <para>Example:</para>
+
+      <programlisting format="linespecific">SecRule REQUEST_LINE "!<emphasis
+          role="bold">@endsWith HTTP/1.1</emphasis>" t:none,deny,status:403
+SecRule ARGS:route "!<emphasis role="bold">@endsWith %{REQUEST_ADDR}</emphasis>" t:none,deny,status:403</programlisting>
+    </section>
+
     <section>
       <title><literal>eq</literal></title>
 
@@ -3959,6 +4034,22 @@ SecRule XML:/soap:Envelope/soap:Body/q1:getInput/id() "123" phase:2,deny</progra
           role="bold">@inspectFile </emphasis>/opt/apache/bin/inspect_script.pl"</programlisting>
     </section>
 
+    <section>
+      <title><literal>is</literal></title>
+
+      <para><emphasis role="bold">Description: </emphasis>This operator is a
+      string comparison and returns true if the parameter value matches the
+      input exactly. Macro expansion is performed so you may use variable
+      names such as %{TX.1}, etc.</para>
+
+      <para>Example:</para>
+
+      <programlisting format="linespecific">SecRule ARGS:foo "!<emphasis
+          role="bold">@is bar</emphasis>" t:none,deny,status:403
+SecRule REQUEST_ADDR "^(.*)$" deny,status:403,capture,chain
+SecRule REQUEST_HEADERS:Ip-Address "!<emphasis role="bold">@is %{TX.1}</emphasis>"</programlisting>
+    </section>
+
     <section>
       <title><literal>le</literal></title>