{-# LANGUAGE DeriveGeneric #-}
{-# LANGUAGE DuplicateRecordFields #-}
{-# LANGUAGE NamedFieldPuns #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE RecordWildCards #-}
{-# LANGUAGE StrictData #-}
{-# LANGUAGE NoImplicitPrelude #-}
{-# OPTIONS_GHC -fno-warn-unused-imports #-}
{-# OPTIONS_GHC -fno-warn-unused-matches #-}

-- Derived from AWS service descriptions, licensed under Apache 2.0.

-- |
-- Module      : Amazonka.WAF.Types.RegexMatchTuple
-- Copyright   : (c) 2013-2021 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay <brendan.g.hay+amazonka@gmail.com>
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
module Amazonka.WAF.Types.RegexMatchTuple where

import qualified Amazonka.Core as Core
import qualified Amazonka.Lens as Lens
import qualified Amazonka.Prelude as Prelude
import Amazonka.WAF.Types.FieldToMatch
import Amazonka.WAF.Types.TextTransformation

-- | This is __AWS WAF Classic__ documentation. For more information, see
-- <https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html AWS WAF Classic>
-- in the developer guide.
--
-- __For the latest version of AWS WAF__, use the AWS WAFV2 API and see the
-- <https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html AWS WAF Developer Guide>.
-- With the latest version, AWS WAF has a single set of endpoints for
-- regional and global use.
--
-- The regular expression pattern that you want AWS WAF to search for in
-- web requests, the location in requests that you want AWS WAF to search,
-- and other settings. Each @RegexMatchTuple@ object contains:
--
-- -   The part of a web request that you want AWS WAF to inspect, such as
--     a query string or the value of the @User-Agent@ header.
--
-- -   The identifier of the pattern (a regular expression) that you want
--     AWS WAF to look for. For more information, see RegexPatternSet.
--
-- -   Whether to perform any conversions on the request, such as
--     converting it to lowercase, before inspecting it for the specified
--     string.
--
-- /See:/ 'newRegexMatchTuple' smart constructor.
data RegexMatchTuple = RegexMatchTuple'
  { -- | Specifies where in a web request to look for the @RegexPatternSet@.
    RegexMatchTuple -> FieldToMatch
fieldToMatch :: FieldToMatch,
    -- | 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
    -- @RegexPatternSet@ before inspecting a request 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
    -- 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.
    RegexMatchTuple -> TextTransformation
textTransformation :: TextTransformation,
    -- | The @RegexPatternSetId@ for a @RegexPatternSet@. You use
    -- @RegexPatternSetId@ to get information about a @RegexPatternSet@ (see
    -- GetRegexPatternSet), update a @RegexPatternSet@ (see
    -- UpdateRegexPatternSet), insert a @RegexPatternSet@ into a
    -- @RegexMatchSet@ or delete one from a @RegexMatchSet@ (see
    -- UpdateRegexMatchSet), and delete an @RegexPatternSet@ from AWS WAF (see
    -- DeleteRegexPatternSet).
    --
    -- @RegexPatternSetId@ is returned by CreateRegexPatternSet and by
    -- ListRegexPatternSets.
    RegexMatchTuple -> Text
regexPatternSetId :: Prelude.Text
  }
  deriving (RegexMatchTuple -> RegexMatchTuple -> Bool
(RegexMatchTuple -> RegexMatchTuple -> Bool)
-> (RegexMatchTuple -> RegexMatchTuple -> Bool)
-> Eq RegexMatchTuple
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: RegexMatchTuple -> RegexMatchTuple -> Bool
$c/= :: RegexMatchTuple -> RegexMatchTuple -> Bool
== :: RegexMatchTuple -> RegexMatchTuple -> Bool
$c== :: RegexMatchTuple -> RegexMatchTuple -> Bool
Prelude.Eq, ReadPrec [RegexMatchTuple]
ReadPrec RegexMatchTuple
Int -> ReadS RegexMatchTuple
ReadS [RegexMatchTuple]
(Int -> ReadS RegexMatchTuple)
-> ReadS [RegexMatchTuple]
-> ReadPrec RegexMatchTuple
-> ReadPrec [RegexMatchTuple]
-> Read RegexMatchTuple
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [RegexMatchTuple]
$creadListPrec :: ReadPrec [RegexMatchTuple]
readPrec :: ReadPrec RegexMatchTuple
$creadPrec :: ReadPrec RegexMatchTuple
readList :: ReadS [RegexMatchTuple]
$creadList :: ReadS [RegexMatchTuple]
readsPrec :: Int -> ReadS RegexMatchTuple
$creadsPrec :: Int -> ReadS RegexMatchTuple
Prelude.Read, Int -> RegexMatchTuple -> ShowS
[RegexMatchTuple] -> ShowS
RegexMatchTuple -> String
(Int -> RegexMatchTuple -> ShowS)
-> (RegexMatchTuple -> String)
-> ([RegexMatchTuple] -> ShowS)
-> Show RegexMatchTuple
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [RegexMatchTuple] -> ShowS
$cshowList :: [RegexMatchTuple] -> ShowS
show :: RegexMatchTuple -> String
$cshow :: RegexMatchTuple -> String
showsPrec :: Int -> RegexMatchTuple -> ShowS
$cshowsPrec :: Int -> RegexMatchTuple -> ShowS
Prelude.Show, (forall x. RegexMatchTuple -> Rep RegexMatchTuple x)
-> (forall x. Rep RegexMatchTuple x -> RegexMatchTuple)
-> Generic RegexMatchTuple
forall x. Rep RegexMatchTuple x -> RegexMatchTuple
forall x. RegexMatchTuple -> Rep RegexMatchTuple x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep RegexMatchTuple x -> RegexMatchTuple
$cfrom :: forall x. RegexMatchTuple -> Rep RegexMatchTuple x
Prelude.Generic)

-- |
-- Create a value of 'RegexMatchTuple' with all optional fields omitted.
--
-- Use <https://hackage.haskell.org/package/generic-lens generic-lens> or <https://hackage.haskell.org/package/optics optics> to modify other optional fields.
--
-- The following record fields are available, with the corresponding lenses provided
-- for backwards compatibility:
--
-- 'fieldToMatch', 'regexMatchTuple_fieldToMatch' - Specifies where in a web request to look for the @RegexPatternSet@.
--
-- 'textTransformation', 'regexMatchTuple_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
-- @RegexPatternSet@ before inspecting a request 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
-- 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.
--
-- 'regexPatternSetId', 'regexMatchTuple_regexPatternSetId' - The @RegexPatternSetId@ for a @RegexPatternSet@. You use
-- @RegexPatternSetId@ to get information about a @RegexPatternSet@ (see
-- GetRegexPatternSet), update a @RegexPatternSet@ (see
-- UpdateRegexPatternSet), insert a @RegexPatternSet@ into a
-- @RegexMatchSet@ or delete one from a @RegexMatchSet@ (see
-- UpdateRegexMatchSet), and delete an @RegexPatternSet@ from AWS WAF (see
-- DeleteRegexPatternSet).
--
-- @RegexPatternSetId@ is returned by CreateRegexPatternSet and by
-- ListRegexPatternSets.
newRegexMatchTuple ::
  -- | 'fieldToMatch'
  FieldToMatch ->
  -- | 'textTransformation'
  TextTransformation ->
  -- | 'regexPatternSetId'
  Prelude.Text ->
  RegexMatchTuple
newRegexMatchTuple :: FieldToMatch -> TextTransformation -> Text -> RegexMatchTuple
newRegexMatchTuple
  FieldToMatch
pFieldToMatch_
  TextTransformation
pTextTransformation_
  Text
pRegexPatternSetId_ =
    RegexMatchTuple' :: FieldToMatch -> TextTransformation -> Text -> RegexMatchTuple
RegexMatchTuple'
      { $sel:fieldToMatch:RegexMatchTuple' :: FieldToMatch
fieldToMatch = FieldToMatch
pFieldToMatch_,
        $sel:textTransformation:RegexMatchTuple' :: TextTransformation
textTransformation = TextTransformation
pTextTransformation_,
        $sel:regexPatternSetId:RegexMatchTuple' :: Text
regexPatternSetId = Text
pRegexPatternSetId_
      }

-- | Specifies where in a web request to look for the @RegexPatternSet@.
regexMatchTuple_fieldToMatch :: Lens.Lens' RegexMatchTuple FieldToMatch
regexMatchTuple_fieldToMatch :: (FieldToMatch -> f FieldToMatch)
-> RegexMatchTuple -> f RegexMatchTuple
regexMatchTuple_fieldToMatch = (RegexMatchTuple -> FieldToMatch)
-> (RegexMatchTuple -> FieldToMatch -> RegexMatchTuple)
-> Lens RegexMatchTuple RegexMatchTuple FieldToMatch FieldToMatch
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\RegexMatchTuple' {FieldToMatch
fieldToMatch :: FieldToMatch
$sel:fieldToMatch:RegexMatchTuple' :: RegexMatchTuple -> FieldToMatch
fieldToMatch} -> FieldToMatch
fieldToMatch) (\s :: RegexMatchTuple
s@RegexMatchTuple' {} FieldToMatch
a -> RegexMatchTuple
s {$sel:fieldToMatch:RegexMatchTuple' :: FieldToMatch
fieldToMatch = FieldToMatch
a} :: RegexMatchTuple)

-- | 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
-- @RegexPatternSet@ before inspecting a request 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
-- 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.
regexMatchTuple_textTransformation :: Lens.Lens' RegexMatchTuple TextTransformation
regexMatchTuple_textTransformation :: (TextTransformation -> f TextTransformation)
-> RegexMatchTuple -> f RegexMatchTuple
regexMatchTuple_textTransformation = (RegexMatchTuple -> TextTransformation)
-> (RegexMatchTuple -> TextTransformation -> RegexMatchTuple)
-> Lens
     RegexMatchTuple
     RegexMatchTuple
     TextTransformation
     TextTransformation
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\RegexMatchTuple' {TextTransformation
textTransformation :: TextTransformation
$sel:textTransformation:RegexMatchTuple' :: RegexMatchTuple -> TextTransformation
textTransformation} -> TextTransformation
textTransformation) (\s :: RegexMatchTuple
s@RegexMatchTuple' {} TextTransformation
a -> RegexMatchTuple
s {$sel:textTransformation:RegexMatchTuple' :: TextTransformation
textTransformation = TextTransformation
a} :: RegexMatchTuple)

-- | The @RegexPatternSetId@ for a @RegexPatternSet@. You use
-- @RegexPatternSetId@ to get information about a @RegexPatternSet@ (see
-- GetRegexPatternSet), update a @RegexPatternSet@ (see
-- UpdateRegexPatternSet), insert a @RegexPatternSet@ into a
-- @RegexMatchSet@ or delete one from a @RegexMatchSet@ (see
-- UpdateRegexMatchSet), and delete an @RegexPatternSet@ from AWS WAF (see
-- DeleteRegexPatternSet).
--
-- @RegexPatternSetId@ is returned by CreateRegexPatternSet and by
-- ListRegexPatternSets.
regexMatchTuple_regexPatternSetId :: Lens.Lens' RegexMatchTuple Prelude.Text
regexMatchTuple_regexPatternSetId :: (Text -> f Text) -> RegexMatchTuple -> f RegexMatchTuple
regexMatchTuple_regexPatternSetId = (RegexMatchTuple -> Text)
-> (RegexMatchTuple -> Text -> RegexMatchTuple)
-> Lens RegexMatchTuple RegexMatchTuple Text Text
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\RegexMatchTuple' {Text
regexPatternSetId :: Text
$sel:regexPatternSetId:RegexMatchTuple' :: RegexMatchTuple -> Text
regexPatternSetId} -> Text
regexPatternSetId) (\s :: RegexMatchTuple
s@RegexMatchTuple' {} Text
a -> RegexMatchTuple
s {$sel:regexPatternSetId:RegexMatchTuple' :: Text
regexPatternSetId = Text
a} :: RegexMatchTuple)

instance Core.FromJSON RegexMatchTuple where
  parseJSON :: Value -> Parser RegexMatchTuple
parseJSON =
    String
-> (Object -> Parser RegexMatchTuple)
-> Value
-> Parser RegexMatchTuple
forall a. String -> (Object -> Parser a) -> Value -> Parser a
Core.withObject
      String
"RegexMatchTuple"
      ( \Object
x ->
          FieldToMatch -> TextTransformation -> Text -> RegexMatchTuple
RegexMatchTuple'
            (FieldToMatch -> TextTransformation -> Text -> RegexMatchTuple)
-> Parser FieldToMatch
-> Parser (TextTransformation -> Text -> RegexMatchTuple)
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> (Object
x Object -> Text -> Parser FieldToMatch
forall a. FromJSON a => Object -> Text -> Parser a
Core..: Text
"FieldToMatch")
            Parser (TextTransformation -> Text -> RegexMatchTuple)
-> Parser TextTransformation -> Parser (Text -> RegexMatchTuple)
forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x Object -> Text -> Parser TextTransformation
forall a. FromJSON a => Object -> Text -> Parser a
Core..: Text
"TextTransformation")
            Parser (Text -> RegexMatchTuple)
-> Parser Text -> Parser RegexMatchTuple
forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x Object -> Text -> Parser Text
forall a. FromJSON a => Object -> Text -> Parser a
Core..: Text
"RegexPatternSetId")
      )

instance Prelude.Hashable RegexMatchTuple

instance Prelude.NFData RegexMatchTuple

instance Core.ToJSON RegexMatchTuple where
  toJSON :: RegexMatchTuple -> Value
toJSON RegexMatchTuple' {Text
FieldToMatch
TextTransformation
regexPatternSetId :: Text
textTransformation :: TextTransformation
fieldToMatch :: FieldToMatch
$sel:regexPatternSetId:RegexMatchTuple' :: RegexMatchTuple -> Text
$sel:textTransformation:RegexMatchTuple' :: RegexMatchTuple -> TextTransformation
$sel:fieldToMatch:RegexMatchTuple' :: RegexMatchTuple -> FieldToMatch
..} =
    [Pair] -> Value
Core.object
      ( [Maybe Pair] -> [Pair]
forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ Pair -> Maybe Pair
forall a. a -> Maybe a
Prelude.Just (Text
"FieldToMatch" Text -> FieldToMatch -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..= FieldToMatch
fieldToMatch),
            Pair -> Maybe Pair
forall a. a -> Maybe a
Prelude.Just
              (Text
"TextTransformation" Text -> TextTransformation -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..= TextTransformation
textTransformation),
            Pair -> Maybe Pair
forall a. a -> Maybe a
Prelude.Just
              (Text
"RegexPatternSetId" Text -> Text -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..= Text
regexPatternSetId)
          ]
      )