Add operator messages to documentation.

This commit is contained in:
ivanr 2008-02-14 15:41:49 +00:00
parent 258ef32adb
commit fb9585735a

View File

@ -5505,6 +5505,144 @@ against "REQUEST_PROTOCOL" required.</programlisting>
specify a human-readable message (using the <literal>msg</literal>
action) to provide further clarification.</para>
<para>The format of the second part of the engine message depends on
whether it was generated by the operator (which happens on a match) or
by the rule processor (which happens where there is not a match, but the
negation was used):</para>
<itemizedlist>
<listitem>
<para>@beginsWith s- String match %0 at %1.</para>
</listitem>
<listitem>
<para>@contains - String match %0 at %1.</para>
</listitem>
<listitem>
<para>@containsWord - String match %0 at %1.</para>
</listitem>
<listitem>
<para>@endsWith - String match %0 at %1.</para>
</listitem>
<listitem>
<para>@eq - Operator EQ matched %0 at %1.</para>
</listitem>
<listitem>
<para>@ge - Operator GE matched %0 at %1.</para>
</listitem>
<listitem>
<para>@geoLookup - Geo lookup for %0 succeeded at %1.</para>
</listitem>
<listitem>
<para>@inspectFile - File %0 rejected by the approver script %1:
%2</para>
</listitem>
<listitem>
<para>@le - Operator LE matched %0 at %1.</para>
</listitem>
<listitem>
<para>@lt - Operator LT matched %0 at %1.</para>
</listitem>
<listitem>
<para>@rbl - RBL lookup of %0 succeeded at %1.</para>
</listitem>
<listitem>
<para>@rx - Pattern match %0 at %1.</para>
</listitem>
<listitem>
<para>@streq - String match %0 at %1.</para>
</listitem>
<listitem>
<para>@validateByteRange - Found %0 byte(s) in %1 outside range:
%2.</para>
</listitem>
<listitem>
<para>@validateDTD - XML: DTD validation failed.</para>
</listitem>
<listitem>
<para>@validateSchema - XML: Schema validation failed.</para>
</listitem>
<listitem>
<para>@validateUrlEncoding</para>
<itemizedlist>
<listitem>
<para>Invalid URL Encoding: Non-hexadecimal digits used at
%0.</para>
</listitem>
<listitem>
<para>Invalid URL Encoding: Not enough characters at the end of
input at %0.</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>@validateUtf8Encoding</para>
<itemizedlist>
<listitem>
<para>Invalid UTF-8 encoding: not enough bytes in character at
%0 [offset %1].</para>
</listitem>
<listitem>
<para>Invalid UTF-8 encoding: invalid byte value in character at
%0 [offset %1].</para>
</listitem>
<listitem>
<para>Invalid UTF-8 encoding: overlong character detected at %0
[offset %1].</para>
</listitem>
<listitem>
<para>Invalid UTF-8 encoding: use of restricted character at %0
[offset %1].</para>
</listitem>
<listitem>
<para>Invalid UTF-8 encoding: decoding error at %0 [offset
%1].</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>@verifyCC - CC# match %0 at %1 [offset %2].</para>
</listitem>
</itemizedlist>
<para>Messages not related to operators:</para>
<itemizedlist>
<listitem>
<para>When <literal>SecAction</literal> directive is processed -
Unconditional match in SecAction.</para>
</listitem>
<listitem>
<para>When <literal>SecRule</literal> does not match but negation is
used - Match of %0 against %1 required.</para>
</listitem>
</itemizedlist>
<para>The metadata fields are always placed at the end of the alert
entry. Each metadata field is a text fragment that consists of an open
bracket followed by the metadata field name, followed by the value and
@ -5774,4 +5912,4 @@ Server: Apache/2.x.x
</section>
</section>
</section>
</article>
</article>