You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::WAFRegional::Types::XssMatchTuple

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-wafregional/lib/aws-sdk-wafregional/types.rb

Overview

Note:

When making an API call, you may pass XssMatchTuple data as a hash:

{
  field_to_match: { # required
    type: "URI", # required, accepts URI, QUERY_STRING, HEADER, METHOD, BODY
    data: "MatchFieldData",
  },
  text_transformation: "NONE", # required, accepts NONE, COMPRESS_WHITE_SPACE, HTML_ENTITY_DECODE, LOWERCASE, CMD_LINE, URL_DECODE
}

Specifies the part of a web request that you want AWS WAF to inspect for cross-site scripting attacks and, if you want AWS WAF to inspect a header, the name of the header.

Instance Attribute Summary collapse

Instance Attribute Details

#field_to_matchTypes::FieldToMatch

Specifies where in a web request to look for cross-site scripting attacks.

Returns:



4143
4144
4145
4146
4147
# File 'gems/aws-sdk-wafregional/lib/aws-sdk-wafregional/types.rb', line 4143

class XssMatchTuple < Struct.new(
  :field_to_match,
  :text_transformation)
  include Aws::Structure
end

#text_transformationString

Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on FieldToMatch before inspecting a request for a match.

CMD_LINE

When you're concerned that attackers are injecting an operating system commandline command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:

  • Delete the following characters: \ " ' ^

  • Delete spaces before the following characters: / (

  • Replace the following characters with a space: , ;

  • Replace multiple spaces with one space

  • Convert uppercase letters (A-Z) to lowercase (a-z)

COMPRESS_WHITE_SPACE

Use this option to replace the following characters with a space character (decimal 32):

  • \f, formfeed, decimal 12

  • \t, tab, decimal 9

  • \n, newline, decimal 10

  • \r, carriage return, decimal 13

  • \v, vertical tab, decimal 11

  • non-breaking space, decimal 160

COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

HTML_ENTITY_DECODE

Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:

  • Replaces (ampersand)quot; with "

  • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160

  • Replaces (ampersand)lt; with a "less than" symbol

  • Replaces (ampersand)gt; with >

  • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters

  • Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters

LOWERCASE

Use this option to convert uppercase letters (A-Z) to lowercase (a-z).

URL_DECODE

Use this option to decode a URL-encoded value.

NONE

Specify NONE if you don't want to perform any text transformations.

Returns:

  • (String)


4143
4144
4145
4146
4147
# File 'gems/aws-sdk-wafregional/lib/aws-sdk-wafregional/types.rb', line 4143

class XssMatchTuple < Struct.new(
  :field_to_match,
  :text_transformation)
  include Aws::Structure
end