libZSservicesZSamazonka-wafZSamazonka-waf
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.WAF.Types.XssMatchTuple

Description

 
Synopsis

Documentation

data XssMatchTuple Source #

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

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.

See: newXssMatchTuple smart constructor.

Constructors

XssMatchTuple' 

Fields

  • fieldToMatch :: FieldToMatch

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

  • textTransformation :: TextTransformation

    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 it for a match.

    You can only specify a single type of TextTransformation.

    CMD_LINE

    When you're concerned that attackers are injecting an operating system command line 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.

Instances

Instances details
Eq XssMatchTuple Source # 
Instance details

Defined in Amazonka.WAF.Types.XssMatchTuple

Methods

(==) :: XssMatchTuple -> XssMatchTuple -> Bool #

(/=) :: XssMatchTuple -> XssMatchTuple -> Bool #

Read XssMatchTuple Source # 
Instance details

Defined in Amazonka.WAF.Types.XssMatchTuple

Methods

readsPrec :: Int -> ReadS XssMatchTuple #

readList :: ReadS [XssMatchTuple] #

readPrec :: ReadPrec XssMatchTuple #

readListPrec :: ReadPrec [XssMatchTuple] #

Show XssMatchTuple Source # 
Instance details

Defined in Amazonka.WAF.Types.XssMatchTuple

Methods

showsPrec :: Int -> XssMatchTuple -> ShowS #

show :: XssMatchTuple -> String #

showList :: [XssMatchTuple] -> ShowS #

Generic XssMatchTuple Source # 
Instance details

Defined in Amazonka.WAF.Types.XssMatchTuple

Associated Types

type Rep XssMatchTuple :: Type -> Type #

Methods

from :: XssMatchTuple -> Rep XssMatchTuple x #

to :: Rep XssMatchTuple x -> XssMatchTuple #

NFData XssMatchTuple Source # 
Instance details

Defined in Amazonka.WAF.Types.XssMatchTuple

Methods

rnf :: XssMatchTuple -> () #

Hashable XssMatchTuple Source # 
Instance details

Defined in Amazonka.WAF.Types.XssMatchTuple

Methods

hashWithSalt :: Int -> XssMatchTuple -> Int #

hash :: XssMatchTuple -> Int #

ToJSON XssMatchTuple Source # 
Instance details

Defined in Amazonka.WAF.Types.XssMatchTuple

Methods

toJSON :: XssMatchTuple -> Value #

toEncoding :: XssMatchTuple -> Encoding #

toJSONList :: [XssMatchTuple] -> Value #

toEncodingList :: [XssMatchTuple] -> Encoding #

FromJSON XssMatchTuple Source # 
Instance details

Defined in Amazonka.WAF.Types.XssMatchTuple

Methods

parseJSON :: Value -> Parser XssMatchTuple #

parseJSONList :: Value -> Parser [XssMatchTuple] #

type Rep XssMatchTuple Source # 
Instance details

Defined in Amazonka.WAF.Types.XssMatchTuple

type Rep XssMatchTuple = D1 ('MetaData "XssMatchTuple" "Amazonka.WAF.Types.XssMatchTuple" "libZSservicesZSamazonka-wafZSamazonka-waf" 'False) (C1 ('MetaCons "XssMatchTuple'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fieldToMatch") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 FieldToMatch) :*: S1 ('MetaSel ('Just "textTransformation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 TextTransformation)))

newXssMatchTuple Source #

Arguments

:: FieldToMatch

$sel:fieldToMatch:XssMatchTuple'

-> TextTransformation

$sel:textTransformation:XssMatchTuple'

-> XssMatchTuple 

Create a value of XssMatchTuple with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:fieldToMatch:XssMatchTuple', xssMatchTuple_fieldToMatch - Specifies where in a web request to look for cross-site scripting attacks.

$sel:textTransformation:XssMatchTuple', xssMatchTuple_textTransformation - 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 it for a match.

You can only specify a single type of TextTransformation.

CMD_LINE

When you're concerned that attackers are injecting an operating system command line 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.

xssMatchTuple_fieldToMatch :: Lens' XssMatchTuple FieldToMatch Source #

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

xssMatchTuple_textTransformation :: Lens' XssMatchTuple TextTransformation Source #

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 it for a match.

You can only specify a single type of TextTransformation.

CMD_LINE

When you're concerned that attackers are injecting an operating system command line 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.