{-# 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.ByteMatchStatement -- 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.ByteMatchStatement 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.FieldToMatch import Amazonka.WAFV2.Types.PositionalConstraint import Amazonka.WAFV2.Types.TextTransformation -- | A rule statement that defines a string match search for WAF to apply to -- web requests. The byte match statement provides the bytes to search for, -- the location in requests that you want WAF to search, and other -- settings. The bytes to search for are typically a string that -- corresponds with ASCII characters. In the WAF console and the developer -- guide, this is called a string match statement. -- -- /See:/ 'newByteMatchStatement' smart constructor. data ByteMatchStatement = ByteMatchStatement' { -- | A string value that you want WAF to search for. WAF searches only in the -- part of web requests that you designate for inspection in FieldToMatch. -- The maximum length of the value is 50 bytes. -- -- Valid values depend on the component that you specify for inspection in -- @FieldToMatch@: -- -- - @Method@: The HTTP method that you want WAF to search for. This -- indicates the type of operation specified in the request. -- -- - @UriPath@: The value that you want WAF to search for in the URI -- path, for example, @\/images\/daily-ad.jpg@. -- -- If @SearchString@ includes alphabetic characters A-Z and a-z, note that -- the value is case sensitive. -- -- __If you\'re using the WAF API__ -- -- Specify a base64-encoded version of the value. The maximum length of the -- value before you base64-encode it is 50 bytes. -- -- For example, suppose the value of @Type@ is @HEADER@ and the value of -- @Data@ is @User-Agent@. If you want to search the @User-Agent@ header -- for the value @BadBot@, you base64-encode @BadBot@ using MIME -- base64-encoding and include the resulting value, @QmFkQm90@, in the -- value of @SearchString@. -- -- __If you\'re using the CLI or one of the Amazon Web Services SDKs__ -- -- The value that you want WAF to search for. The SDK automatically base64 -- encodes the value. ByteMatchStatement -> Base64 searchString :: Data.Base64, -- | The part of the web request that you want WAF to inspect. ByteMatchStatement -> FieldToMatch fieldToMatch :: FieldToMatch, -- | Text transformations eliminate some of the unusual formatting that -- attackers use in web requests in an effort to bypass detection. If you -- specify one or more transformations in a rule statement, WAF performs -- all transformations on the content of the request component identified -- by @FieldToMatch@, starting from the lowest priority setting, before -- inspecting the content for a match. ByteMatchStatement -> NonEmpty TextTransformation textTransformations :: Prelude.NonEmpty TextTransformation, -- | The area within the portion of the web request that you want WAF to -- search for @SearchString@. Valid values include the following: -- -- __CONTAINS__ -- -- The specified part of the web request must include the value of -- @SearchString@, but the location doesn\'t matter. -- -- __CONTAINS_WORD__ -- -- The specified part of the web request must include the value of -- @SearchString@, and @SearchString@ must contain only alphanumeric -- characters or underscore (A-Z, a-z, 0-9, or _). In addition, -- @SearchString@ must be a word, which means that both of the following -- are true: -- -- - @SearchString@ is at the beginning of the specified part of the web -- request or is preceded by a character other than an alphanumeric -- character or underscore (_). Examples include the value of a header -- and @;BadBot@. -- -- - @SearchString@ is at the end of the specified part of the web -- request or is followed by a character other than an alphanumeric -- character or underscore (_), for example, @BadBot;@ and @-BadBot;@. -- -- __EXACTLY__ -- -- The value of the specified part of the web request must exactly match -- the value of @SearchString@. -- -- __STARTS_WITH__ -- -- The value of @SearchString@ must appear at the beginning of the -- specified part of the web request. -- -- __ENDS_WITH__ -- -- The value of @SearchString@ must appear at the end of the specified part -- of the web request. ByteMatchStatement -> PositionalConstraint positionalConstraint :: PositionalConstraint } deriving (ByteMatchStatement -> ByteMatchStatement -> Bool forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a /= :: ByteMatchStatement -> ByteMatchStatement -> Bool $c/= :: ByteMatchStatement -> ByteMatchStatement -> Bool == :: ByteMatchStatement -> ByteMatchStatement -> Bool $c== :: ByteMatchStatement -> ByteMatchStatement -> Bool Prelude.Eq, ReadPrec [ByteMatchStatement] ReadPrec ByteMatchStatement Int -> ReadS ByteMatchStatement ReadS [ByteMatchStatement] forall a. (Int -> ReadS a) -> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a readListPrec :: ReadPrec [ByteMatchStatement] $creadListPrec :: ReadPrec [ByteMatchStatement] readPrec :: ReadPrec ByteMatchStatement $creadPrec :: ReadPrec ByteMatchStatement readList :: ReadS [ByteMatchStatement] $creadList :: ReadS [ByteMatchStatement] readsPrec :: Int -> ReadS ByteMatchStatement $creadsPrec :: Int -> ReadS ByteMatchStatement Prelude.Read, Int -> ByteMatchStatement -> ShowS [ByteMatchStatement] -> ShowS ByteMatchStatement -> String forall a. (Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a showList :: [ByteMatchStatement] -> ShowS $cshowList :: [ByteMatchStatement] -> ShowS show :: ByteMatchStatement -> String $cshow :: ByteMatchStatement -> String showsPrec :: Int -> ByteMatchStatement -> ShowS $cshowsPrec :: Int -> ByteMatchStatement -> ShowS Prelude.Show, forall x. Rep ByteMatchStatement x -> ByteMatchStatement forall x. ByteMatchStatement -> Rep ByteMatchStatement x forall a. (forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a $cto :: forall x. Rep ByteMatchStatement x -> ByteMatchStatement $cfrom :: forall x. ByteMatchStatement -> Rep ByteMatchStatement x Prelude.Generic) -- | -- Create a value of 'ByteMatchStatement' 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: -- -- 'searchString', 'byteMatchStatement_searchString' - A string value that you want WAF to search for. WAF searches only in the -- part of web requests that you designate for inspection in FieldToMatch. -- The maximum length of the value is 50 bytes. -- -- Valid values depend on the component that you specify for inspection in -- @FieldToMatch@: -- -- - @Method@: The HTTP method that you want WAF to search for. This -- indicates the type of operation specified in the request. -- -- - @UriPath@: The value that you want WAF to search for in the URI -- path, for example, @\/images\/daily-ad.jpg@. -- -- If @SearchString@ includes alphabetic characters A-Z and a-z, note that -- the value is case sensitive. -- -- __If you\'re using the WAF API__ -- -- Specify a base64-encoded version of the value. The maximum length of the -- value before you base64-encode it is 50 bytes. -- -- For example, suppose the value of @Type@ is @HEADER@ and the value of -- @Data@ is @User-Agent@. If you want to search the @User-Agent@ header -- for the value @BadBot@, you base64-encode @BadBot@ using MIME -- base64-encoding and include the resulting value, @QmFkQm90@, in the -- value of @SearchString@. -- -- __If you\'re using the CLI or one of the Amazon Web Services SDKs__ -- -- The value that you want WAF to search for. The SDK automatically base64 -- encodes the value.-- -- -- /Note:/ This 'Lens' automatically encodes and decodes Base64 data. -- -- The underlying isomorphism will encode to Base64 representation during -- -- serialisation, and decode from Base64 representation during deserialisation. -- -- This 'Lens' accepts and returns only raw unencoded data. -- -- 'fieldToMatch', 'byteMatchStatement_fieldToMatch' - The part of the web request that you want WAF to inspect. -- -- 'textTransformations', 'byteMatchStatement_textTransformations' - Text transformations eliminate some of the unusual formatting that -- attackers use in web requests in an effort to bypass detection. If you -- specify one or more transformations in a rule statement, WAF performs -- all transformations on the content of the request component identified -- by @FieldToMatch@, starting from the lowest priority setting, before -- inspecting the content for a match. -- -- 'positionalConstraint', 'byteMatchStatement_positionalConstraint' - The area within the portion of the web request that you want WAF to -- search for @SearchString@. Valid values include the following: -- -- __CONTAINS__ -- -- The specified part of the web request must include the value of -- @SearchString@, but the location doesn\'t matter. -- -- __CONTAINS_WORD__ -- -- The specified part of the web request must include the value of -- @SearchString@, and @SearchString@ must contain only alphanumeric -- characters or underscore (A-Z, a-z, 0-9, or _). In addition, -- @SearchString@ must be a word, which means that both of the following -- are true: -- -- - @SearchString@ is at the beginning of the specified part of the web -- request or is preceded by a character other than an alphanumeric -- character or underscore (_). Examples include the value of a header -- and @;BadBot@. -- -- - @SearchString@ is at the end of the specified part of the web -- request or is followed by a character other than an alphanumeric -- character or underscore (_), for example, @BadBot;@ and @-BadBot;@. -- -- __EXACTLY__ -- -- The value of the specified part of the web request must exactly match -- the value of @SearchString@. -- -- __STARTS_WITH__ -- -- The value of @SearchString@ must appear at the beginning of the -- specified part of the web request. -- -- __ENDS_WITH__ -- -- The value of @SearchString@ must appear at the end of the specified part -- of the web request. newByteMatchStatement :: -- | 'searchString' Prelude.ByteString -> -- | 'fieldToMatch' FieldToMatch -> -- | 'textTransformations' Prelude.NonEmpty TextTransformation -> -- | 'positionalConstraint' PositionalConstraint -> ByteMatchStatement newByteMatchStatement :: ByteString -> FieldToMatch -> NonEmpty TextTransformation -> PositionalConstraint -> ByteMatchStatement newByteMatchStatement ByteString pSearchString_ FieldToMatch pFieldToMatch_ NonEmpty TextTransformation pTextTransformations_ PositionalConstraint pPositionalConstraint_ = ByteMatchStatement' { $sel:searchString:ByteMatchStatement' :: Base64 searchString = Iso' Base64 ByteString Data._Base64 forall t b. AReview t b -> b -> t Lens.# ByteString pSearchString_, $sel:fieldToMatch:ByteMatchStatement' :: FieldToMatch fieldToMatch = FieldToMatch pFieldToMatch_, $sel:textTransformations:ByteMatchStatement' :: NonEmpty TextTransformation textTransformations = forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b Lens.coerced forall t b. AReview t b -> b -> t Lens.# NonEmpty TextTransformation pTextTransformations_, $sel:positionalConstraint:ByteMatchStatement' :: PositionalConstraint positionalConstraint = PositionalConstraint pPositionalConstraint_ } -- | A string value that you want WAF to search for. WAF searches only in the -- part of web requests that you designate for inspection in FieldToMatch. -- The maximum length of the value is 50 bytes. -- -- Valid values depend on the component that you specify for inspection in -- @FieldToMatch@: -- -- - @Method@: The HTTP method that you want WAF to search for. This -- indicates the type of operation specified in the request. -- -- - @UriPath@: The value that you want WAF to search for in the URI -- path, for example, @\/images\/daily-ad.jpg@. -- -- If @SearchString@ includes alphabetic characters A-Z and a-z, note that -- the value is case sensitive. -- -- __If you\'re using the WAF API__ -- -- Specify a base64-encoded version of the value. The maximum length of the -- value before you base64-encode it is 50 bytes. -- -- For example, suppose the value of @Type@ is @HEADER@ and the value of -- @Data@ is @User-Agent@. If you want to search the @User-Agent@ header -- for the value @BadBot@, you base64-encode @BadBot@ using MIME -- base64-encoding and include the resulting value, @QmFkQm90@, in the -- value of @SearchString@. -- -- __If you\'re using the CLI or one of the Amazon Web Services SDKs__ -- -- The value that you want WAF to search for. The SDK automatically base64 -- encodes the value.-- -- -- /Note:/ This 'Lens' automatically encodes and decodes Base64 data. -- -- The underlying isomorphism will encode to Base64 representation during -- -- serialisation, and decode from Base64 representation during deserialisation. -- -- This 'Lens' accepts and returns only raw unencoded data. byteMatchStatement_searchString :: Lens.Lens' ByteMatchStatement Prelude.ByteString byteMatchStatement_searchString :: Lens' ByteMatchStatement ByteString byteMatchStatement_searchString = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b Lens.lens (\ByteMatchStatement' {Base64 searchString :: Base64 $sel:searchString:ByteMatchStatement' :: ByteMatchStatement -> Base64 searchString} -> Base64 searchString) (\s :: ByteMatchStatement s@ByteMatchStatement' {} Base64 a -> ByteMatchStatement s {$sel:searchString:ByteMatchStatement' :: Base64 searchString = Base64 a} :: ByteMatchStatement) forall b c a. (b -> c) -> (a -> b) -> a -> c Prelude.. Iso' Base64 ByteString Data._Base64 -- | The part of the web request that you want WAF to inspect. byteMatchStatement_fieldToMatch :: Lens.Lens' ByteMatchStatement FieldToMatch byteMatchStatement_fieldToMatch :: Lens' ByteMatchStatement FieldToMatch byteMatchStatement_fieldToMatch = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b Lens.lens (\ByteMatchStatement' {FieldToMatch fieldToMatch :: FieldToMatch $sel:fieldToMatch:ByteMatchStatement' :: ByteMatchStatement -> FieldToMatch fieldToMatch} -> FieldToMatch fieldToMatch) (\s :: ByteMatchStatement s@ByteMatchStatement' {} FieldToMatch a -> ByteMatchStatement s {$sel:fieldToMatch:ByteMatchStatement' :: FieldToMatch fieldToMatch = FieldToMatch a} :: ByteMatchStatement) -- | Text transformations eliminate some of the unusual formatting that -- attackers use in web requests in an effort to bypass detection. If you -- specify one or more transformations in a rule statement, WAF performs -- all transformations on the content of the request component identified -- by @FieldToMatch@, starting from the lowest priority setting, before -- inspecting the content for a match. byteMatchStatement_textTransformations :: Lens.Lens' ByteMatchStatement (Prelude.NonEmpty TextTransformation) byteMatchStatement_textTransformations :: Lens' ByteMatchStatement (NonEmpty TextTransformation) byteMatchStatement_textTransformations = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b Lens.lens (\ByteMatchStatement' {NonEmpty TextTransformation textTransformations :: NonEmpty TextTransformation $sel:textTransformations:ByteMatchStatement' :: ByteMatchStatement -> NonEmpty TextTransformation textTransformations} -> NonEmpty TextTransformation textTransformations) (\s :: ByteMatchStatement s@ByteMatchStatement' {} NonEmpty TextTransformation a -> ByteMatchStatement s {$sel:textTransformations:ByteMatchStatement' :: NonEmpty TextTransformation textTransformations = NonEmpty TextTransformation a} :: ByteMatchStatement) forall b c a. (b -> c) -> (a -> b) -> a -> c Prelude.. forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b Lens.coerced -- | The area within the portion of the web request that you want WAF to -- search for @SearchString@. Valid values include the following: -- -- __CONTAINS__ -- -- The specified part of the web request must include the value of -- @SearchString@, but the location doesn\'t matter. -- -- __CONTAINS_WORD__ -- -- The specified part of the web request must include the value of -- @SearchString@, and @SearchString@ must contain only alphanumeric -- characters or underscore (A-Z, a-z, 0-9, or _). In addition, -- @SearchString@ must be a word, which means that both of the following -- are true: -- -- - @SearchString@ is at the beginning of the specified part of the web -- request or is preceded by a character other than an alphanumeric -- character or underscore (_). Examples include the value of a header -- and @;BadBot@. -- -- - @SearchString@ is at the end of the specified part of the web -- request or is followed by a character other than an alphanumeric -- character or underscore (_), for example, @BadBot;@ and @-BadBot;@. -- -- __EXACTLY__ -- -- The value of the specified part of the web request must exactly match -- the value of @SearchString@. -- -- __STARTS_WITH__ -- -- The value of @SearchString@ must appear at the beginning of the -- specified part of the web request. -- -- __ENDS_WITH__ -- -- The value of @SearchString@ must appear at the end of the specified part -- of the web request. byteMatchStatement_positionalConstraint :: Lens.Lens' ByteMatchStatement PositionalConstraint byteMatchStatement_positionalConstraint :: Lens' ByteMatchStatement PositionalConstraint byteMatchStatement_positionalConstraint = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b Lens.lens (\ByteMatchStatement' {PositionalConstraint positionalConstraint :: PositionalConstraint $sel:positionalConstraint:ByteMatchStatement' :: ByteMatchStatement -> PositionalConstraint positionalConstraint} -> PositionalConstraint positionalConstraint) (\s :: ByteMatchStatement s@ByteMatchStatement' {} PositionalConstraint a -> ByteMatchStatement s {$sel:positionalConstraint:ByteMatchStatement' :: PositionalConstraint positionalConstraint = PositionalConstraint a} :: ByteMatchStatement) instance Data.FromJSON ByteMatchStatement where parseJSON :: Value -> Parser ByteMatchStatement parseJSON = forall a. String -> (Object -> Parser a) -> Value -> Parser a Data.withObject String "ByteMatchStatement" ( \Object x -> Base64 -> FieldToMatch -> NonEmpty TextTransformation -> PositionalConstraint -> ByteMatchStatement ByteMatchStatement' forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b Prelude.<$> (Object x forall a. FromJSON a => Object -> Key -> Parser a Data..: Key "SearchString") 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 "FieldToMatch") 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 "TextTransformations") 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 "PositionalConstraint") ) instance Prelude.Hashable ByteMatchStatement where hashWithSalt :: Int -> ByteMatchStatement -> Int hashWithSalt Int _salt ByteMatchStatement' {NonEmpty TextTransformation Base64 PositionalConstraint FieldToMatch positionalConstraint :: PositionalConstraint textTransformations :: NonEmpty TextTransformation fieldToMatch :: FieldToMatch searchString :: Base64 $sel:positionalConstraint:ByteMatchStatement' :: ByteMatchStatement -> PositionalConstraint $sel:textTransformations:ByteMatchStatement' :: ByteMatchStatement -> NonEmpty TextTransformation $sel:fieldToMatch:ByteMatchStatement' :: ByteMatchStatement -> FieldToMatch $sel:searchString:ByteMatchStatement' :: ByteMatchStatement -> Base64 ..} = Int _salt forall a. Hashable a => Int -> a -> Int `Prelude.hashWithSalt` Base64 searchString forall a. Hashable a => Int -> a -> Int `Prelude.hashWithSalt` FieldToMatch fieldToMatch forall a. Hashable a => Int -> a -> Int `Prelude.hashWithSalt` NonEmpty TextTransformation textTransformations forall a. Hashable a => Int -> a -> Int `Prelude.hashWithSalt` PositionalConstraint positionalConstraint instance Prelude.NFData ByteMatchStatement where rnf :: ByteMatchStatement -> () rnf ByteMatchStatement' {NonEmpty TextTransformation Base64 PositionalConstraint FieldToMatch positionalConstraint :: PositionalConstraint textTransformations :: NonEmpty TextTransformation fieldToMatch :: FieldToMatch searchString :: Base64 $sel:positionalConstraint:ByteMatchStatement' :: ByteMatchStatement -> PositionalConstraint $sel:textTransformations:ByteMatchStatement' :: ByteMatchStatement -> NonEmpty TextTransformation $sel:fieldToMatch:ByteMatchStatement' :: ByteMatchStatement -> FieldToMatch $sel:searchString:ByteMatchStatement' :: ByteMatchStatement -> Base64 ..} = forall a. NFData a => a -> () Prelude.rnf Base64 searchString seq :: forall a b. a -> b -> b `Prelude.seq` forall a. NFData a => a -> () Prelude.rnf FieldToMatch fieldToMatch seq :: forall a b. a -> b -> b `Prelude.seq` forall a. NFData a => a -> () Prelude.rnf NonEmpty TextTransformation textTransformations seq :: forall a b. a -> b -> b `Prelude.seq` forall a. NFData a => a -> () Prelude.rnf PositionalConstraint positionalConstraint instance Data.ToJSON ByteMatchStatement where toJSON :: ByteMatchStatement -> Value toJSON ByteMatchStatement' {NonEmpty TextTransformation Base64 PositionalConstraint FieldToMatch positionalConstraint :: PositionalConstraint textTransformations :: NonEmpty TextTransformation fieldToMatch :: FieldToMatch searchString :: Base64 $sel:positionalConstraint:ByteMatchStatement' :: ByteMatchStatement -> PositionalConstraint $sel:textTransformations:ByteMatchStatement' :: ByteMatchStatement -> NonEmpty TextTransformation $sel:fieldToMatch:ByteMatchStatement' :: ByteMatchStatement -> FieldToMatch $sel:searchString:ByteMatchStatement' :: ByteMatchStatement -> Base64 ..} = [Pair] -> Value Data.object ( forall a. [Maybe a] -> [a] Prelude.catMaybes [ forall a. a -> Maybe a Prelude.Just (Key "SearchString" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv Data..= Base64 searchString), forall a. a -> Maybe a Prelude.Just (Key "FieldToMatch" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv Data..= FieldToMatch fieldToMatch), forall a. a -> Maybe a Prelude.Just (Key "TextTransformations" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv Data..= NonEmpty TextTransformation textTransformations), forall a. a -> Maybe a Prelude.Just ( Key "PositionalConstraint" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv Data..= PositionalConstraint positionalConstraint ) ] )