{-# 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.CertificateManagerPCA.Types.Extensions
-- 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.CertificateManagerPCA.Types.Extensions where

import Amazonka.CertificateManagerPCA.Types.CustomExtension
import Amazonka.CertificateManagerPCA.Types.ExtendedKeyUsage
import Amazonka.CertificateManagerPCA.Types.GeneralName
import Amazonka.CertificateManagerPCA.Types.KeyUsage
import Amazonka.CertificateManagerPCA.Types.PolicyInformation
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

-- | Contains X.509 extension information for a certificate.
--
-- /See:/ 'newExtensions' smart constructor.
data Extensions = Extensions'
  { -- | Contains a sequence of one or more policy information terms, each of
    -- which consists of an object identifier (OID) and optional qualifiers.
    -- For more information, see NIST\'s definition of
    -- <https://csrc.nist.gov/glossary/term/Object_Identifier Object Identifier (OID)>.
    --
    -- In an end-entity certificate, these terms indicate the policy under
    -- which the certificate was issued and the purposes for which it may be
    -- used. In a CA certificate, these terms limit the set of policies for
    -- certification paths that include this certificate.
    Extensions -> Maybe (NonEmpty PolicyInformation)
certificatePolicies :: Prelude.Maybe (Prelude.NonEmpty PolicyInformation),
    -- | Contains a sequence of one or more X.509 extensions, each of which
    -- consists of an object identifier (OID), a base64-encoded value, and the
    -- critical flag. For more information, see the
    -- <https://oidref.com/2.5.29 Global OID reference database.>
    Extensions -> Maybe (NonEmpty CustomExtension)
customExtensions :: Prelude.Maybe (Prelude.NonEmpty CustomExtension),
    -- | Specifies additional purposes for which the certified public key may be
    -- used other than basic purposes indicated in the @KeyUsage@ extension.
    Extensions -> Maybe (NonEmpty ExtendedKeyUsage)
extendedKeyUsage :: Prelude.Maybe (Prelude.NonEmpty ExtendedKeyUsage),
    Extensions -> Maybe KeyUsage
keyUsage :: Prelude.Maybe KeyUsage,
    -- | The subject alternative name extension allows identities to be bound to
    -- the subject of the certificate. These identities may be included in
    -- addition to or in place of the identity in the subject field of the
    -- certificate.
    Extensions -> Maybe (NonEmpty GeneralName)
subjectAlternativeNames :: Prelude.Maybe (Prelude.NonEmpty GeneralName)
  }
  deriving (Extensions -> Extensions -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: Extensions -> Extensions -> Bool
$c/= :: Extensions -> Extensions -> Bool
== :: Extensions -> Extensions -> Bool
$c== :: Extensions -> Extensions -> Bool
Prelude.Eq, ReadPrec [Extensions]
ReadPrec Extensions
Int -> ReadS Extensions
ReadS [Extensions]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [Extensions]
$creadListPrec :: ReadPrec [Extensions]
readPrec :: ReadPrec Extensions
$creadPrec :: ReadPrec Extensions
readList :: ReadS [Extensions]
$creadList :: ReadS [Extensions]
readsPrec :: Int -> ReadS Extensions
$creadsPrec :: Int -> ReadS Extensions
Prelude.Read, Int -> Extensions -> ShowS
[Extensions] -> ShowS
Extensions -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [Extensions] -> ShowS
$cshowList :: [Extensions] -> ShowS
show :: Extensions -> String
$cshow :: Extensions -> String
showsPrec :: Int -> Extensions -> ShowS
$cshowsPrec :: Int -> Extensions -> ShowS
Prelude.Show, forall x. Rep Extensions x -> Extensions
forall x. Extensions -> Rep Extensions x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep Extensions x -> Extensions
$cfrom :: forall x. Extensions -> Rep Extensions x
Prelude.Generic)

-- |
-- Create a value of 'Extensions' 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:
--
-- 'certificatePolicies', 'extensions_certificatePolicies' - Contains a sequence of one or more policy information terms, each of
-- which consists of an object identifier (OID) and optional qualifiers.
-- For more information, see NIST\'s definition of
-- <https://csrc.nist.gov/glossary/term/Object_Identifier Object Identifier (OID)>.
--
-- In an end-entity certificate, these terms indicate the policy under
-- which the certificate was issued and the purposes for which it may be
-- used. In a CA certificate, these terms limit the set of policies for
-- certification paths that include this certificate.
--
-- 'customExtensions', 'extensions_customExtensions' - Contains a sequence of one or more X.509 extensions, each of which
-- consists of an object identifier (OID), a base64-encoded value, and the
-- critical flag. For more information, see the
-- <https://oidref.com/2.5.29 Global OID reference database.>
--
-- 'extendedKeyUsage', 'extensions_extendedKeyUsage' - Specifies additional purposes for which the certified public key may be
-- used other than basic purposes indicated in the @KeyUsage@ extension.
--
-- 'keyUsage', 'extensions_keyUsage' - Undocumented member.
--
-- 'subjectAlternativeNames', 'extensions_subjectAlternativeNames' - The subject alternative name extension allows identities to be bound to
-- the subject of the certificate. These identities may be included in
-- addition to or in place of the identity in the subject field of the
-- certificate.
newExtensions ::
  Extensions
newExtensions :: Extensions
newExtensions =
  Extensions'
    { $sel:certificatePolicies:Extensions' :: Maybe (NonEmpty PolicyInformation)
certificatePolicies = forall a. Maybe a
Prelude.Nothing,
      $sel:customExtensions:Extensions' :: Maybe (NonEmpty CustomExtension)
customExtensions = forall a. Maybe a
Prelude.Nothing,
      $sel:extendedKeyUsage:Extensions' :: Maybe (NonEmpty ExtendedKeyUsage)
extendedKeyUsage = forall a. Maybe a
Prelude.Nothing,
      $sel:keyUsage:Extensions' :: Maybe KeyUsage
keyUsage = forall a. Maybe a
Prelude.Nothing,
      $sel:subjectAlternativeNames:Extensions' :: Maybe (NonEmpty GeneralName)
subjectAlternativeNames = forall a. Maybe a
Prelude.Nothing
    }

-- | Contains a sequence of one or more policy information terms, each of
-- which consists of an object identifier (OID) and optional qualifiers.
-- For more information, see NIST\'s definition of
-- <https://csrc.nist.gov/glossary/term/Object_Identifier Object Identifier (OID)>.
--
-- In an end-entity certificate, these terms indicate the policy under
-- which the certificate was issued and the purposes for which it may be
-- used. In a CA certificate, these terms limit the set of policies for
-- certification paths that include this certificate.
extensions_certificatePolicies :: Lens.Lens' Extensions (Prelude.Maybe (Prelude.NonEmpty PolicyInformation))
extensions_certificatePolicies :: Lens' Extensions (Maybe (NonEmpty PolicyInformation))
extensions_certificatePolicies = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Extensions' {Maybe (NonEmpty PolicyInformation)
certificatePolicies :: Maybe (NonEmpty PolicyInformation)
$sel:certificatePolicies:Extensions' :: Extensions -> Maybe (NonEmpty PolicyInformation)
certificatePolicies} -> Maybe (NonEmpty PolicyInformation)
certificatePolicies) (\s :: Extensions
s@Extensions' {} Maybe (NonEmpty PolicyInformation)
a -> Extensions
s {$sel:certificatePolicies:Extensions' :: Maybe (NonEmpty PolicyInformation)
certificatePolicies = Maybe (NonEmpty PolicyInformation)
a} :: Extensions) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall (f :: * -> *) (g :: * -> *) s t a b.
(Functor f, Functor g) =>
AnIso s t a b -> Iso (f s) (g t) (f a) (g b)
Lens.mapping forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

-- | Contains a sequence of one or more X.509 extensions, each of which
-- consists of an object identifier (OID), a base64-encoded value, and the
-- critical flag. For more information, see the
-- <https://oidref.com/2.5.29 Global OID reference database.>
extensions_customExtensions :: Lens.Lens' Extensions (Prelude.Maybe (Prelude.NonEmpty CustomExtension))
extensions_customExtensions :: Lens' Extensions (Maybe (NonEmpty CustomExtension))
extensions_customExtensions = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Extensions' {Maybe (NonEmpty CustomExtension)
customExtensions :: Maybe (NonEmpty CustomExtension)
$sel:customExtensions:Extensions' :: Extensions -> Maybe (NonEmpty CustomExtension)
customExtensions} -> Maybe (NonEmpty CustomExtension)
customExtensions) (\s :: Extensions
s@Extensions' {} Maybe (NonEmpty CustomExtension)
a -> Extensions
s {$sel:customExtensions:Extensions' :: Maybe (NonEmpty CustomExtension)
customExtensions = Maybe (NonEmpty CustomExtension)
a} :: Extensions) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall (f :: * -> *) (g :: * -> *) s t a b.
(Functor f, Functor g) =>
AnIso s t a b -> Iso (f s) (g t) (f a) (g b)
Lens.mapping forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

-- | Specifies additional purposes for which the certified public key may be
-- used other than basic purposes indicated in the @KeyUsage@ extension.
extensions_extendedKeyUsage :: Lens.Lens' Extensions (Prelude.Maybe (Prelude.NonEmpty ExtendedKeyUsage))
extensions_extendedKeyUsage :: Lens' Extensions (Maybe (NonEmpty ExtendedKeyUsage))
extensions_extendedKeyUsage = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Extensions' {Maybe (NonEmpty ExtendedKeyUsage)
extendedKeyUsage :: Maybe (NonEmpty ExtendedKeyUsage)
$sel:extendedKeyUsage:Extensions' :: Extensions -> Maybe (NonEmpty ExtendedKeyUsage)
extendedKeyUsage} -> Maybe (NonEmpty ExtendedKeyUsage)
extendedKeyUsage) (\s :: Extensions
s@Extensions' {} Maybe (NonEmpty ExtendedKeyUsage)
a -> Extensions
s {$sel:extendedKeyUsage:Extensions' :: Maybe (NonEmpty ExtendedKeyUsage)
extendedKeyUsage = Maybe (NonEmpty ExtendedKeyUsage)
a} :: Extensions) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall (f :: * -> *) (g :: * -> *) s t a b.
(Functor f, Functor g) =>
AnIso s t a b -> Iso (f s) (g t) (f a) (g b)
Lens.mapping forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

-- | Undocumented member.
extensions_keyUsage :: Lens.Lens' Extensions (Prelude.Maybe KeyUsage)
extensions_keyUsage :: Lens' Extensions (Maybe KeyUsage)
extensions_keyUsage = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Extensions' {Maybe KeyUsage
keyUsage :: Maybe KeyUsage
$sel:keyUsage:Extensions' :: Extensions -> Maybe KeyUsage
keyUsage} -> Maybe KeyUsage
keyUsage) (\s :: Extensions
s@Extensions' {} Maybe KeyUsage
a -> Extensions
s {$sel:keyUsage:Extensions' :: Maybe KeyUsage
keyUsage = Maybe KeyUsage
a} :: Extensions)

-- | The subject alternative name extension allows identities to be bound to
-- the subject of the certificate. These identities may be included in
-- addition to or in place of the identity in the subject field of the
-- certificate.
extensions_subjectAlternativeNames :: Lens.Lens' Extensions (Prelude.Maybe (Prelude.NonEmpty GeneralName))
extensions_subjectAlternativeNames :: Lens' Extensions (Maybe (NonEmpty GeneralName))
extensions_subjectAlternativeNames = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Extensions' {Maybe (NonEmpty GeneralName)
subjectAlternativeNames :: Maybe (NonEmpty GeneralName)
$sel:subjectAlternativeNames:Extensions' :: Extensions -> Maybe (NonEmpty GeneralName)
subjectAlternativeNames} -> Maybe (NonEmpty GeneralName)
subjectAlternativeNames) (\s :: Extensions
s@Extensions' {} Maybe (NonEmpty GeneralName)
a -> Extensions
s {$sel:subjectAlternativeNames:Extensions' :: Maybe (NonEmpty GeneralName)
subjectAlternativeNames = Maybe (NonEmpty GeneralName)
a} :: Extensions) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall (f :: * -> *) (g :: * -> *) s t a b.
(Functor f, Functor g) =>
AnIso s t a b -> Iso (f s) (g t) (f a) (g b)
Lens.mapping forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

instance Prelude.Hashable Extensions where
  hashWithSalt :: Int -> Extensions -> Int
hashWithSalt Int
_salt Extensions' {Maybe (NonEmpty CustomExtension)
Maybe (NonEmpty ExtendedKeyUsage)
Maybe (NonEmpty GeneralName)
Maybe (NonEmpty PolicyInformation)
Maybe KeyUsage
subjectAlternativeNames :: Maybe (NonEmpty GeneralName)
keyUsage :: Maybe KeyUsage
extendedKeyUsage :: Maybe (NonEmpty ExtendedKeyUsage)
customExtensions :: Maybe (NonEmpty CustomExtension)
certificatePolicies :: Maybe (NonEmpty PolicyInformation)
$sel:subjectAlternativeNames:Extensions' :: Extensions -> Maybe (NonEmpty GeneralName)
$sel:keyUsage:Extensions' :: Extensions -> Maybe KeyUsage
$sel:extendedKeyUsage:Extensions' :: Extensions -> Maybe (NonEmpty ExtendedKeyUsage)
$sel:customExtensions:Extensions' :: Extensions -> Maybe (NonEmpty CustomExtension)
$sel:certificatePolicies:Extensions' :: Extensions -> Maybe (NonEmpty PolicyInformation)
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe (NonEmpty PolicyInformation)
certificatePolicies
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe (NonEmpty CustomExtension)
customExtensions
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe (NonEmpty ExtendedKeyUsage)
extendedKeyUsage
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe KeyUsage
keyUsage
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe (NonEmpty GeneralName)
subjectAlternativeNames

instance Prelude.NFData Extensions where
  rnf :: Extensions -> ()
rnf Extensions' {Maybe (NonEmpty CustomExtension)
Maybe (NonEmpty ExtendedKeyUsage)
Maybe (NonEmpty GeneralName)
Maybe (NonEmpty PolicyInformation)
Maybe KeyUsage
subjectAlternativeNames :: Maybe (NonEmpty GeneralName)
keyUsage :: Maybe KeyUsage
extendedKeyUsage :: Maybe (NonEmpty ExtendedKeyUsage)
customExtensions :: Maybe (NonEmpty CustomExtension)
certificatePolicies :: Maybe (NonEmpty PolicyInformation)
$sel:subjectAlternativeNames:Extensions' :: Extensions -> Maybe (NonEmpty GeneralName)
$sel:keyUsage:Extensions' :: Extensions -> Maybe KeyUsage
$sel:extendedKeyUsage:Extensions' :: Extensions -> Maybe (NonEmpty ExtendedKeyUsage)
$sel:customExtensions:Extensions' :: Extensions -> Maybe (NonEmpty CustomExtension)
$sel:certificatePolicies:Extensions' :: Extensions -> Maybe (NonEmpty PolicyInformation)
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe (NonEmpty PolicyInformation)
certificatePolicies
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe (NonEmpty CustomExtension)
customExtensions
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe (NonEmpty ExtendedKeyUsage)
extendedKeyUsage
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe KeyUsage
keyUsage
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe (NonEmpty GeneralName)
subjectAlternativeNames

instance Data.ToJSON Extensions where
  toJSON :: Extensions -> Value
toJSON Extensions' {Maybe (NonEmpty CustomExtension)
Maybe (NonEmpty ExtendedKeyUsage)
Maybe (NonEmpty GeneralName)
Maybe (NonEmpty PolicyInformation)
Maybe KeyUsage
subjectAlternativeNames :: Maybe (NonEmpty GeneralName)
keyUsage :: Maybe KeyUsage
extendedKeyUsage :: Maybe (NonEmpty ExtendedKeyUsage)
customExtensions :: Maybe (NonEmpty CustomExtension)
certificatePolicies :: Maybe (NonEmpty PolicyInformation)
$sel:subjectAlternativeNames:Extensions' :: Extensions -> Maybe (NonEmpty GeneralName)
$sel:keyUsage:Extensions' :: Extensions -> Maybe KeyUsage
$sel:extendedKeyUsage:Extensions' :: Extensions -> Maybe (NonEmpty ExtendedKeyUsage)
$sel:customExtensions:Extensions' :: Extensions -> Maybe (NonEmpty CustomExtension)
$sel:certificatePolicies:Extensions' :: Extensions -> Maybe (NonEmpty PolicyInformation)
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"CertificatePolicies" 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 (NonEmpty PolicyInformation)
certificatePolicies,
            (Key
"CustomExtensions" 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 (NonEmpty CustomExtension)
customExtensions,
            (Key
"ExtendedKeyUsage" 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 (NonEmpty ExtendedKeyUsage)
extendedKeyUsage,
            (Key
"KeyUsage" 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 KeyUsage
keyUsage,
            (Key
"SubjectAlternativeNames" 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 (NonEmpty GeneralName)
subjectAlternativeNames
          ]
      )