File Coverage

blib/lib/Paws/WAF/XssMatchTuple.pm
Criterion Covered Total %
statement 3 3 100.0
branch n/a
condition n/a
subroutine 1 1 100.0
pod n/a
total 4 4 100.0


line stmt bran cond sub pod time code
1             package Paws::WAF::XssMatchTuple;
2 1     1   311 use Moose;
  1         4  
  1         6  
3             has FieldToMatch => (is => 'ro', isa => 'Paws::WAF::FieldToMatch', required => 1);
4             has TextTransformation => (is => 'ro', isa => 'Str', required => 1);
5             1;
6              
7             ### main pod documentation begin ###
8              
9             =head1 NAME
10              
11             Paws::WAF::XssMatchTuple
12              
13             =head1 USAGE
14              
15             This class represents one of two things:
16              
17             =head3 Arguments in a call to a service
18              
19             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
20             Each attribute should be used as a named argument in the calls that expect this type of object.
21              
22             As an example, if Att1 is expected to be a Paws::WAF::XssMatchTuple object:
23              
24             $service_obj->Method(Att1 => { FieldToMatch => $value, ..., TextTransformation => $value });
25              
26             =head3 Results returned from an API call
27              
28             Use accessors for each attribute. If Att1 is expected to be an Paws::WAF::XssMatchTuple object:
29              
30             $result = $service_obj->Method(...);
31             $result->Att1->FieldToMatch
32              
33             =head1 DESCRIPTION
34              
35             Specifies the part of a web request that you want AWS WAF to inspect
36             for cross-site scripting attacks and, if you want AWS WAF to inspect a
37             header, the name of the header.
38              
39             =head1 ATTRIBUTES
40              
41              
42             =head2 B<REQUIRED> FieldToMatch => L<Paws::WAF::FieldToMatch>
43              
44             Specifies where in a web request to look for cross-site scripting
45             attacks.
46              
47              
48             =head2 B<REQUIRED> TextTransformation => Str
49              
50             Text transformations eliminate some of the unusual formatting that
51             attackers use in web requests in an effort to bypass AWS WAF. If you
52             specify a transformation, AWS WAF performs the transformation on
53             C<FieldToMatch> before inspecting a request for a match.
54              
55             B<CMD_LINE>
56              
57             When you're concerned that attackers are injecting an operating system
58             commandline command and using unusual formatting to disguise some or
59             all of the command, use this option to perform the following
60             transformations:
61              
62             =over
63              
64             =item *
65              
66             Delete the following characters: \ " ' ^
67              
68             =item *
69              
70             Delete spaces before the following characters: / (
71              
72             =item *
73              
74             Replace the following characters with a space: , ;
75              
76             =item *
77              
78             Replace multiple spaces with one space
79              
80             =item *
81              
82             Convert uppercase letters (A-Z) to lowercase (a-z)
83              
84             =back
85              
86             B<COMPRESS_WHITE_SPACE>
87              
88             Use this option to replace the following characters with a space
89             character (decimal 32):
90              
91             =over
92              
93             =item *
94              
95             \f, formfeed, decimal 12
96              
97             =item *
98              
99             \t, tab, decimal 9
100              
101             =item *
102              
103             \n, newline, decimal 10
104              
105             =item *
106              
107             \r, carriage return, decimal 13
108              
109             =item *
110              
111             \v, vertical tab, decimal 11
112              
113             =item *
114              
115             non-breaking space, decimal 160
116              
117             =back
118              
119             C<COMPRESS_WHITE_SPACE> also replaces multiple spaces with one space.
120              
121             B<HTML_ENTITY_DECODE>
122              
123             Use this option to replace HTML-encoded characters with unencoded
124             characters. C<HTML_ENTITY_DECODE> performs the following operations:
125              
126             =over
127              
128             =item *
129              
130             Replaces C<(ampersand)quot;> with C<">
131              
132             =item *
133              
134             Replaces C<(ampersand)nbsp;> with a non-breaking space, decimal 160
135              
136             =item *
137              
138             Replaces C<(ampersand)lt;> with a "less than" symbol
139              
140             =item *
141              
142             Replaces C<(ampersand)gt;> with C<E<gt>>
143              
144             =item *
145              
146             Replaces characters that are represented in hexadecimal format,
147             C<(ampersand)(hash)xhhhh;>, with the corresponding characters
148              
149             =item *
150              
151             Replaces characters that are represented in decimal format,
152             C<(ampersand)(hash)nnnn;>, with the corresponding characters
153              
154             =back
155              
156             B<LOWERCASE>
157              
158             Use this option to convert uppercase letters (A-Z) to lowercase (a-z).
159              
160             B<URL_DECODE>
161              
162             Use this option to decode a URL-encoded value.
163              
164             B<NONE>
165              
166             Specify C<NONE> if you don't want to perform any text transformations.
167              
168              
169              
170             =head1 SEE ALSO
171              
172             This class forms part of L<Paws>, describing an object used in L<Paws::WAF>
173              
174             =head1 BUGS and CONTRIBUTIONS
175              
176             The source code is located here: https://github.com/pplu/aws-sdk-perl
177              
178             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
179              
180             =cut
181