{-# 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.WAFV2.Types.JsonBody
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
module Amazonka.WAFV2.Types.JsonBody where

import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import qualified Amazonka.Prelude as Prelude
import Amazonka.WAFV2.Types.BodyParsingFallbackBehavior
import Amazonka.WAFV2.Types.JsonMatchPattern
import Amazonka.WAFV2.Types.JsonMatchScope
import Amazonka.WAFV2.Types.OversizeHandling

-- | Inspect the body of the web request as JSON. The body immediately
-- follows the request headers.
--
-- This is used to indicate the web request component to inspect, in the
-- FieldToMatch specification.
--
-- Use the specifications in this object to indicate which parts of the
-- JSON body to inspect using the rule\'s inspection criteria. WAF inspects
-- only the parts of the JSON that result from the matches that you
-- indicate.
--
-- Example JSON:
-- @\"JsonBody\": { \"MatchPattern\": { \"All\": {} }, \"MatchScope\": \"ALL\" }@
--
-- /See:/ 'newJsonBody' smart constructor.
data JsonBody = JsonBody'
  { -- | What WAF should do if it fails to completely parse the JSON body. The
    -- options are the following:
    --
    -- -   @EVALUATE_AS_STRING@ - Inspect the body as plain text. WAF applies
    --     the text transformations and inspection criteria that you defined
    --     for the JSON inspection to the body text string.
    --
    -- -   @MATCH@ - Treat the web request as matching the rule statement. WAF
    --     applies the rule action to the request.
    --
    -- -   @NO_MATCH@ - Treat the web request as not matching the rule
    --     statement.
    --
    -- If you don\'t provide this setting, WAF parses and evaluates the content
    -- only up to the first parsing failure that it encounters.
    --
    -- WAF does its best to parse the entire JSON body, but might be forced to
    -- stop for reasons such as invalid characters, duplicate keys, truncation,
    -- and any content whose root node isn\'t an object or an array.
    --
    -- WAF parses the JSON in the following examples as two valid key, value
    -- pairs:
    --
    -- -   Missing comma: @{\"key1\":\"value1\"\"key2\":\"value2\"}@
    --
    -- -   Missing colon: @{\"key1\":\"value1\",\"key2\"\"value2\"}@
    --
    -- -   Extra colons: @{\"key1\"::\"value1\",\"key2\"\"value2\"}@
    JsonBody -> Maybe BodyParsingFallbackBehavior
invalidFallbackBehavior :: Prelude.Maybe BodyParsingFallbackBehavior,
    -- | What WAF should do if the body is larger than WAF can inspect. WAF does
    -- not support inspecting the entire contents of the body of a web request
    -- when the body exceeds 8 KB (8192 bytes). Only the first 8 KB of the
    -- request body are forwarded to WAF by the underlying host service.
    --
    -- The options for oversize handling are the following:
    --
    -- -   @CONTINUE@ - Inspect the body normally, according to the rule
    --     inspection criteria.
    --
    -- -   @MATCH@ - Treat the web request as matching the rule statement. WAF
    --     applies the rule action to the request.
    --
    -- -   @NO_MATCH@ - Treat the web request as not matching the rule
    --     statement.
    --
    -- You can combine the @MATCH@ or @NO_MATCH@ settings for oversize handling
    -- with your rule and web ACL action settings, so that you block any
    -- request whose body is over 8 KB.
    --
    -- Default: @CONTINUE@
    JsonBody -> Maybe OversizeHandling
oversizeHandling :: Prelude.Maybe OversizeHandling,
    -- | The patterns to look for in the JSON body. WAF inspects the results of
    -- these pattern matches against the rule inspection criteria.
    JsonBody -> JsonMatchPattern
matchPattern :: JsonMatchPattern,
    -- | The parts of the JSON to match against using the @MatchPattern@. If you
    -- specify @All@, WAF matches against keys and values.
    JsonBody -> JsonMatchScope
matchScope :: JsonMatchScope
  }
  deriving (JsonBody -> JsonBody -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: JsonBody -> JsonBody -> Bool
$c/= :: JsonBody -> JsonBody -> Bool
== :: JsonBody -> JsonBody -> Bool
$c== :: JsonBody -> JsonBody -> Bool
Prelude.Eq, ReadPrec [JsonBody]
ReadPrec JsonBody
Int -> ReadS JsonBody
ReadS [JsonBody]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [JsonBody]
$creadListPrec :: ReadPrec [JsonBody]
readPrec :: ReadPrec JsonBody
$creadPrec :: ReadPrec JsonBody
readList :: ReadS [JsonBody]
$creadList :: ReadS [JsonBody]
readsPrec :: Int -> ReadS JsonBody
$creadsPrec :: Int -> ReadS JsonBody
Prelude.Read, Int -> JsonBody -> ShowS
[JsonBody] -> ShowS
JsonBody -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [JsonBody] -> ShowS
$cshowList :: [JsonBody] -> ShowS
show :: JsonBody -> String
$cshow :: JsonBody -> String
showsPrec :: Int -> JsonBody -> ShowS
$cshowsPrec :: Int -> JsonBody -> ShowS
Prelude.Show, forall x. Rep JsonBody x -> JsonBody
forall x. JsonBody -> Rep JsonBody x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep JsonBody x -> JsonBody
$cfrom :: forall x. JsonBody -> Rep JsonBody x
Prelude.Generic)

-- |
-- Create a value of 'JsonBody' 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:
--
-- 'invalidFallbackBehavior', 'jsonBody_invalidFallbackBehavior' - What WAF should do if it fails to completely parse the JSON body. The
-- options are the following:
--
-- -   @EVALUATE_AS_STRING@ - Inspect the body as plain text. WAF applies
--     the text transformations and inspection criteria that you defined
--     for the JSON inspection to the body text string.
--
-- -   @MATCH@ - Treat the web request as matching the rule statement. WAF
--     applies the rule action to the request.
--
-- -   @NO_MATCH@ - Treat the web request as not matching the rule
--     statement.
--
-- If you don\'t provide this setting, WAF parses and evaluates the content
-- only up to the first parsing failure that it encounters.
--
-- WAF does its best to parse the entire JSON body, but might be forced to
-- stop for reasons such as invalid characters, duplicate keys, truncation,
-- and any content whose root node isn\'t an object or an array.
--
-- WAF parses the JSON in the following examples as two valid key, value
-- pairs:
--
-- -   Missing comma: @{\"key1\":\"value1\"\"key2\":\"value2\"}@
--
-- -   Missing colon: @{\"key1\":\"value1\",\"key2\"\"value2\"}@
--
-- -   Extra colons: @{\"key1\"::\"value1\",\"key2\"\"value2\"}@
--
-- 'oversizeHandling', 'jsonBody_oversizeHandling' - What WAF should do if the body is larger than WAF can inspect. WAF does
-- not support inspecting the entire contents of the body of a web request
-- when the body exceeds 8 KB (8192 bytes). Only the first 8 KB of the
-- request body are forwarded to WAF by the underlying host service.
--
-- The options for oversize handling are the following:
--
-- -   @CONTINUE@ - Inspect the body normally, according to the rule
--     inspection criteria.
--
-- -   @MATCH@ - Treat the web request as matching the rule statement. WAF
--     applies the rule action to the request.
--
-- -   @NO_MATCH@ - Treat the web request as not matching the rule
--     statement.
--
-- You can combine the @MATCH@ or @NO_MATCH@ settings for oversize handling
-- with your rule and web ACL action settings, so that you block any
-- request whose body is over 8 KB.
--
-- Default: @CONTINUE@
--
-- 'matchPattern', 'jsonBody_matchPattern' - The patterns to look for in the JSON body. WAF inspects the results of
-- these pattern matches against the rule inspection criteria.
--
-- 'matchScope', 'jsonBody_matchScope' - The parts of the JSON to match against using the @MatchPattern@. If you
-- specify @All@, WAF matches against keys and values.
newJsonBody ::
  -- | 'matchPattern'
  JsonMatchPattern ->
  -- | 'matchScope'
  JsonMatchScope ->
  JsonBody
newJsonBody :: JsonMatchPattern -> JsonMatchScope -> JsonBody
newJsonBody JsonMatchPattern
pMatchPattern_ JsonMatchScope
pMatchScope_ =
  JsonBody'
    { $sel:invalidFallbackBehavior:JsonBody' :: Maybe BodyParsingFallbackBehavior
invalidFallbackBehavior =
        forall a. Maybe a
Prelude.Nothing,
      $sel:oversizeHandling:JsonBody' :: Maybe OversizeHandling
oversizeHandling = forall a. Maybe a
Prelude.Nothing,
      $sel:matchPattern:JsonBody' :: JsonMatchPattern
matchPattern = JsonMatchPattern
pMatchPattern_,
      $sel:matchScope:JsonBody' :: JsonMatchScope
matchScope = JsonMatchScope
pMatchScope_
    }

-- | What WAF should do if it fails to completely parse the JSON body. The
-- options are the following:
--
-- -   @EVALUATE_AS_STRING@ - Inspect the body as plain text. WAF applies
--     the text transformations and inspection criteria that you defined
--     for the JSON inspection to the body text string.
--
-- -   @MATCH@ - Treat the web request as matching the rule statement. WAF
--     applies the rule action to the request.
--
-- -   @NO_MATCH@ - Treat the web request as not matching the rule
--     statement.
--
-- If you don\'t provide this setting, WAF parses and evaluates the content
-- only up to the first parsing failure that it encounters.
--
-- WAF does its best to parse the entire JSON body, but might be forced to
-- stop for reasons such as invalid characters, duplicate keys, truncation,
-- and any content whose root node isn\'t an object or an array.
--
-- WAF parses the JSON in the following examples as two valid key, value
-- pairs:
--
-- -   Missing comma: @{\"key1\":\"value1\"\"key2\":\"value2\"}@
--
-- -   Missing colon: @{\"key1\":\"value1\",\"key2\"\"value2\"}@
--
-- -   Extra colons: @{\"key1\"::\"value1\",\"key2\"\"value2\"}@
jsonBody_invalidFallbackBehavior :: Lens.Lens' JsonBody (Prelude.Maybe BodyParsingFallbackBehavior)
jsonBody_invalidFallbackBehavior :: Lens' JsonBody (Maybe BodyParsingFallbackBehavior)
jsonBody_invalidFallbackBehavior = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\JsonBody' {Maybe BodyParsingFallbackBehavior
invalidFallbackBehavior :: Maybe BodyParsingFallbackBehavior
$sel:invalidFallbackBehavior:JsonBody' :: JsonBody -> Maybe BodyParsingFallbackBehavior
invalidFallbackBehavior} -> Maybe BodyParsingFallbackBehavior
invalidFallbackBehavior) (\s :: JsonBody
s@JsonBody' {} Maybe BodyParsingFallbackBehavior
a -> JsonBody
s {$sel:invalidFallbackBehavior:JsonBody' :: Maybe BodyParsingFallbackBehavior
invalidFallbackBehavior = Maybe BodyParsingFallbackBehavior
a} :: JsonBody)

-- | What WAF should do if the body is larger than WAF can inspect. WAF does
-- not support inspecting the entire contents of the body of a web request
-- when the body exceeds 8 KB (8192 bytes). Only the first 8 KB of the
-- request body are forwarded to WAF by the underlying host service.
--
-- The options for oversize handling are the following:
--
-- -   @CONTINUE@ - Inspect the body normally, according to the rule
--     inspection criteria.
--
-- -   @MATCH@ - Treat the web request as matching the rule statement. WAF
--     applies the rule action to the request.
--
-- -   @NO_MATCH@ - Treat the web request as not matching the rule
--     statement.
--
-- You can combine the @MATCH@ or @NO_MATCH@ settings for oversize handling
-- with your rule and web ACL action settings, so that you block any
-- request whose body is over 8 KB.
--
-- Default: @CONTINUE@
jsonBody_oversizeHandling :: Lens.Lens' JsonBody (Prelude.Maybe OversizeHandling)
jsonBody_oversizeHandling :: Lens' JsonBody (Maybe OversizeHandling)
jsonBody_oversizeHandling = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\JsonBody' {Maybe OversizeHandling
oversizeHandling :: Maybe OversizeHandling
$sel:oversizeHandling:JsonBody' :: JsonBody -> Maybe OversizeHandling
oversizeHandling} -> Maybe OversizeHandling
oversizeHandling) (\s :: JsonBody
s@JsonBody' {} Maybe OversizeHandling
a -> JsonBody
s {$sel:oversizeHandling:JsonBody' :: Maybe OversizeHandling
oversizeHandling = Maybe OversizeHandling
a} :: JsonBody)

-- | The patterns to look for in the JSON body. WAF inspects the results of
-- these pattern matches against the rule inspection criteria.
jsonBody_matchPattern :: Lens.Lens' JsonBody JsonMatchPattern
jsonBody_matchPattern :: Lens' JsonBody JsonMatchPattern
jsonBody_matchPattern = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\JsonBody' {JsonMatchPattern
matchPattern :: JsonMatchPattern
$sel:matchPattern:JsonBody' :: JsonBody -> JsonMatchPattern
matchPattern} -> JsonMatchPattern
matchPattern) (\s :: JsonBody
s@JsonBody' {} JsonMatchPattern
a -> JsonBody
s {$sel:matchPattern:JsonBody' :: JsonMatchPattern
matchPattern = JsonMatchPattern
a} :: JsonBody)

-- | The parts of the JSON to match against using the @MatchPattern@. If you
-- specify @All@, WAF matches against keys and values.
jsonBody_matchScope :: Lens.Lens' JsonBody JsonMatchScope
jsonBody_matchScope :: Lens' JsonBody JsonMatchScope
jsonBody_matchScope = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\JsonBody' {JsonMatchScope
matchScope :: JsonMatchScope
$sel:matchScope:JsonBody' :: JsonBody -> JsonMatchScope
matchScope} -> JsonMatchScope
matchScope) (\s :: JsonBody
s@JsonBody' {} JsonMatchScope
a -> JsonBody
s {$sel:matchScope:JsonBody' :: JsonMatchScope
matchScope = JsonMatchScope
a} :: JsonBody)

instance Data.FromJSON JsonBody where
  parseJSON :: Value -> Parser JsonBody
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"JsonBody"
      ( \Object
x ->
          Maybe BodyParsingFallbackBehavior
-> Maybe OversizeHandling
-> JsonMatchPattern
-> JsonMatchScope
-> JsonBody
JsonBody'
            forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"InvalidFallbackBehavior")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"OversizeHandling")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser a
Data..: Key
"MatchPattern")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser a
Data..: Key
"MatchScope")
      )

instance Prelude.Hashable JsonBody where
  hashWithSalt :: Int -> JsonBody -> Int
hashWithSalt Int
_salt JsonBody' {Maybe BodyParsingFallbackBehavior
Maybe OversizeHandling
JsonMatchPattern
JsonMatchScope
matchScope :: JsonMatchScope
matchPattern :: JsonMatchPattern
oversizeHandling :: Maybe OversizeHandling
invalidFallbackBehavior :: Maybe BodyParsingFallbackBehavior
$sel:matchScope:JsonBody' :: JsonBody -> JsonMatchScope
$sel:matchPattern:JsonBody' :: JsonBody -> JsonMatchPattern
$sel:oversizeHandling:JsonBody' :: JsonBody -> Maybe OversizeHandling
$sel:invalidFallbackBehavior:JsonBody' :: JsonBody -> Maybe BodyParsingFallbackBehavior
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe BodyParsingFallbackBehavior
invalidFallbackBehavior
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe OversizeHandling
oversizeHandling
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` JsonMatchPattern
matchPattern
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` JsonMatchScope
matchScope

instance Prelude.NFData JsonBody where
  rnf :: JsonBody -> ()
rnf JsonBody' {Maybe BodyParsingFallbackBehavior
Maybe OversizeHandling
JsonMatchPattern
JsonMatchScope
matchScope :: JsonMatchScope
matchPattern :: JsonMatchPattern
oversizeHandling :: Maybe OversizeHandling
invalidFallbackBehavior :: Maybe BodyParsingFallbackBehavior
$sel:matchScope:JsonBody' :: JsonBody -> JsonMatchScope
$sel:matchPattern:JsonBody' :: JsonBody -> JsonMatchPattern
$sel:oversizeHandling:JsonBody' :: JsonBody -> Maybe OversizeHandling
$sel:invalidFallbackBehavior:JsonBody' :: JsonBody -> Maybe BodyParsingFallbackBehavior
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe BodyParsingFallbackBehavior
invalidFallbackBehavior
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe OversizeHandling
oversizeHandling
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf JsonMatchPattern
matchPattern
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf JsonMatchScope
matchScope

instance Data.ToJSON JsonBody where
  toJSON :: JsonBody -> Value
toJSON JsonBody' {Maybe BodyParsingFallbackBehavior
Maybe OversizeHandling
JsonMatchPattern
JsonMatchScope
matchScope :: JsonMatchScope
matchPattern :: JsonMatchPattern
oversizeHandling :: Maybe OversizeHandling
invalidFallbackBehavior :: Maybe BodyParsingFallbackBehavior
$sel:matchScope:JsonBody' :: JsonBody -> JsonMatchScope
$sel:matchPattern:JsonBody' :: JsonBody -> JsonMatchPattern
$sel:oversizeHandling:JsonBody' :: JsonBody -> Maybe OversizeHandling
$sel:invalidFallbackBehavior:JsonBody' :: JsonBody -> Maybe BodyParsingFallbackBehavior
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"InvalidFallbackBehavior" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=)
              forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe BodyParsingFallbackBehavior
invalidFallbackBehavior,
            (Key
"OversizeHandling" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=)
              forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe OversizeHandling
oversizeHandling,
            forall a. a -> Maybe a
Prelude.Just (Key
"MatchPattern" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= JsonMatchPattern
matchPattern),
            forall a. a -> Maybe a
Prelude.Just (Key
"MatchScope" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= JsonMatchScope
matchScope)
          ]
      )