Identifiers.hs

{-# LANGUAGE TypeSynonymInstances #-}
{-# LANGUAGE FlexibleInstances #-}
{-# LANGUAGE MultiParamTypeClasses #-}
-- |
-- SAML-Defined Identifiers
--
-- <https://docs.oasis-open.org/security/saml/v2.0/saml-core-2.0-os.pdf saml-core-2.0-os> §8
module SAML2.Core.Identifiers where

import Data.Default (Default(..))

import SAML2.XML
import SAML2.Core.Namespaces
import SAML2.Core.Versioning

-- |§8.1
data ActionNamespace
  = ActionNamespaceRWEDC -- ^§8.1.1: Read Write Execute Delete Control
  | ActionNamespaceRWEDCNegation -- ^§8.1.2: RWEDC ~RWEDC
  | ActionNamespaceGHPP -- ^§8.1.3: GET HEAD PUT POST
  | ActionNamespaceUNIX -- ^§8.1.4: octal
  deriving (Eq, Enum, Bounded, Show)

instance Identifiable URI ActionNamespace where
  identifier = samlURNIdentifier "action" . f where
    f ActionNamespaceRWEDC          = (SAML10, "rwedc")
    f ActionNamespaceRWEDCNegation  = (SAML10, "rwedc-negation")
    f ActionNamespaceGHPP           = (SAML10, "ghpp")
    f ActionNamespaceUNIX           = (SAML10, "unix")

-- |§8.2
data AttributeNameFormat
  = AttributeNameFormatUnspecified -- ^§8.2.1: Text
  | AttributeNameFormatURI -- ^§8.2.2: URI
  | AttributeNameFormatBasic -- ^§8.2.3: Name
  deriving (Eq, Enum, Bounded, Show)

instance Identifiable URI AttributeNameFormat where
  identifier = samlURNIdentifier "attrname-format" . f where
    f AttributeNameFormatUnspecified = (SAML20, "unspecified")
    f AttributeNameFormatURI         = (SAML20, "uri")
    f AttributeNameFormatBasic       = (SAML20, "basic")

-- |§8.3
data NameIDFormat
  = NameIDFormatUnspecified -- ^§8.3.1: Text
  | NameIDFormatEmail -- ^§8.3.2: rfc2822
  | NameIDFormatX509 -- ^§8.3.3: XML signature
  | NameIDFormatWindows -- ^§8.3.4: Maybe Domain, User
  | NameIDFormatKerberos -- ^§8.3.5: rfc1510
  | NameIDFormatEntity -- ^§8.3.6: SAML endpoint (BaseId and SPProvidedID must be Nothing)
  | NameIDFormatPersistent -- ^§8.3.7: String <= 256 char (NameQualifier same as idp ident/Nothing, SPNameQualifier same as sp ident/Nothing, SPProvidedID alt ident from sp)
  | NameIDFormatTransient -- ^§8.3.8: String <= 256 char
  | NameIDFormatEncrypted -- ^§3.4.1.1: only for NameIDPolicy
  deriving (Eq, Enum, Bounded, Show)
  
instance Default NameIDFormat where
  def = NameIDFormatUnspecified

instance Identifiable URI NameIDFormat where
  identifier = samlURNIdentifier "nameid-format" . f where
    f NameIDFormatUnspecified = (SAML11, "unspecified")
    f NameIDFormatEmail       = (SAML11, "emailAddress")
    f NameIDFormatX509        = (SAML11, "X509SubjectName")
    f NameIDFormatWindows     = (SAML11, "WindowsDomainQualifiedName")
    f NameIDFormatKerberos    = (SAML20, "kerberos")
    f NameIDFormatEntity      = (SAML20, "entity")
    f NameIDFormatPersistent  = (SAML20, "persistent")
    f NameIDFormatTransient   = (SAML20, "transient")
    f NameIDFormatEncrypted   = (SAML20, "encrypted")

-- |§8.4
data Consent
  = ConsentUnspecified -- ^§8.4.1
  | ConsentObtained -- ^§8.4.2
  | ConsentPrior -- ^§8.4.3
  | ConsentImplicit -- ^§8.4.4
  | ConsentExplicit -- ^§8.4.5
  | ConsentUnavailable -- ^§8.4.6
  | ConsentInapplicable -- ^§8.4.7
  deriving (Eq, Enum, Bounded, Show)

instance Default Consent where
  def = ConsentUnspecified

instance Identifiable URI Consent where
  identifier = samlURNIdentifier "consent" . f where
    f ConsentUnspecified  = (SAML20, "unspecified")
    f ConsentObtained     = (SAML20, "obtained")
    f ConsentPrior        = (SAML20, "prior")
    f ConsentImplicit     = (SAML20, "current-implicit")
    f ConsentExplicit     = (SAML20, "current-explicit")
    f ConsentUnavailable  = (SAML20, "unavailable")
    f ConsentInapplicable = (SAML20, "inapplicable")