From 340e476ff1d9a0c93410530600035e505d7da3c1 Mon Sep 17 00:00:00 2001 From: Fabian Keil Date: Thu, 20 May 2021 11:16:20 +0200 Subject: [PATCH] Add documentation for the client-body-tagger action Sponsored by: Robert Klemme --- doc/source/user-manual.sgml | 84 ++++++++++++++++++++++++++++++++++++- 1 file changed, 82 insertions(+), 2 deletions(-) diff --git a/doc/source/user-manual.sgml b/doc/source/user-manual.sgml index 0c5ee300..90702c41 100644 --- a/doc/source/user-manual.sgml +++ b/doc/source/user-manual.sgml @@ -3135,6 +3135,85 @@ adserver.example.net/.*\.js$ + + +client-body-tagger + + + + Typical use: + + + Block requests based on the content of the body data. + + + + + + Effect: + + + Client request bodies to which this action applies are filtered on-the-fly through + the specified regular expression based substitutions, the result is used as tag. + + + + + + Type: + + + Multi-value. + + + + + Parameter: + + + The name of a client-body tagger, as defined in one of the + filter files. + + + + + + Notes: + + + Please refer to the filter file chapter + to learn how to create your own client-body tagger. + + + Client-body taggers are applied to each request body on its own, + and as the body isn't modified, each tagger "sees" the original. + + + Chunk-encoded request bodies currently can't be tagged. + Request bodies larger than the buffer-limit can't be tagged either. + + + + + + Example usage (section): + + +# Apply blafasel tagger. +{+client-body-tagger{blafasel}} +/ + +# Block request based on the tag created by the blafasel tagger. +{+block{Request body contains blafasel}} +TAG:^content contains blafasel$ + + + + + + + + client-header-tagger @@ -7107,8 +7186,9 @@ webmail.example.com - &my-app; also supports two tagger actions: - client-header-tagger + &my-app; also supports three tagger actions: + client-header-tagger, + client-body-tagger and server-header-tagger. Taggers and filters use the same syntax in the filter files, the difference -- 2.39.2