Safe Haskell	Safe-Inferred
Language	Haskell2010

Network.Wai.SAML2.Assertion

Description

Types to represent SAML2 assertions and functions to parse them from XML.

Synopsis

data SubjectConfirmationMethod
- = HolderOfKey
- | SenderVouches
- | Bearer
data SubjectConfirmation = SubjectConfirmation {
}
data Subject = Subject {
- subjectConfirmations :: ![SubjectConfirmation]
- subjectNameID :: !NameID
}
data NameID = NameID {
- nameIDQualifier :: !(Maybe Text)
- nameIDSPNameQualifier :: !(Maybe Text)
- nameIDSPProvidedID :: !(Maybe Text)
- nameIDFormat :: !(Maybe NameIDFormat)
- nameIDValue :: !Text
}
data Conditions = Conditions {
- conditionsNotBefore :: !UTCTime
- conditionsNotOnOrAfter :: !UTCTime
- conditionsAudienceRestrictions :: ![AudienceRestriction]
}
data AudienceRestriction = AudienceRestriction {
- audienceRestrictionAudience :: ![Text]
}
data AuthnStatement = AuthnStatement {
- authnStatementInstant :: !UTCTime
- authnStatementSessionIndex :: !Text
- authnStatementLocality :: !Text
}
data AssertionAttribute = AssertionAttribute {
- attributeName :: !Text
- attributeFriendlyName :: !(Maybe Text)
- attributeNameFormat :: !Text
- attributeValue :: !Text
}
type AttributeStatement = [AssertionAttribute]
parseAttributeStatement :: Cursor -> AttributeStatement
data Assertion = Assertion {
- assertionId :: !Text
- assertionIssued :: !UTCTime
- assertionIssuer :: !Text
- assertionSubject :: !Subject
- assertionConditions :: !Conditions
- assertionAuthnStatement :: !AuthnStatement
- assertionAttributeStatement :: !AttributeStatement
}

Documentation

data SubjectConfirmationMethod Source #

Enumerates different subject confirmation methods. See http://docs.oasis-open.org/security/saml/Post2.0/sstc-saml-tech-overview-2.0-cd-02.html#4.2.1.Subject%20Confirmation%20|outline

Constructors

HolderOfKey	urn:oasis:names:tc:SAML:2.0:cm:holder-of-key
SenderVouches	urn:oasis:names:tc:SAML:2.0:cm:sender-vouches
Bearer	urn:oasis:names:tc:SAML:2.0:cm:bearer

Instances

Instances details

Show SubjectConfirmationMethod Source #
Instance details Defined in Network.Wai.SAML2.Assertion Methods showsPrec :: Int -> SubjectConfirmationMethod -> ShowS # show :: SubjectConfirmationMethod -> String # showList :: [SubjectConfirmationMethod] -> ShowS #
Eq SubjectConfirmationMethod Source #
Instance details Defined in Network.Wai.SAML2.Assertion Methods (==) :: SubjectConfirmationMethod -> SubjectConfirmationMethod -> Bool # (/=) :: SubjectConfirmationMethod -> SubjectConfirmationMethod -> Bool #
FromXML SubjectConfirmationMethod Source #
Instance details Defined in Network.Wai.SAML2.Assertion Methods parseXML :: MonadFail m => Cursor -> m SubjectConfirmationMethod Source #

data SubjectConfirmation Source #

Represents a subject confirmation record.

Constructors

SubjectConfirmation
Fields subjectConfirmationMethod :: !SubjectConfirmationMethod The subject confirmation method used. subjectConfirmationAddress :: !Text The address of the subject. subjectConfirmationNotOnOrAfter :: !UTCTime A timestamp. subjectConfirmationRecipient :: !Text The recipient.

Instances

Instances details

Show SubjectConfirmation Source #
Instance details Defined in Network.Wai.SAML2.Assertion Methods showsPrec :: Int -> SubjectConfirmation -> ShowS # show :: SubjectConfirmation -> String # showList :: [SubjectConfirmation] -> ShowS #
Eq SubjectConfirmation Source #
Instance details Defined in Network.Wai.SAML2.Assertion Methods (==) :: SubjectConfirmation -> SubjectConfirmation -> Bool # (/=) :: SubjectConfirmation -> SubjectConfirmation -> Bool #
FromXML SubjectConfirmation Source #
Instance details Defined in Network.Wai.SAML2.Assertion Methods parseXML :: MonadFail m => Cursor -> m SubjectConfirmation Source #

data Subject Source #

The subject of the assertion.

Constructors

Subject
Fields subjectConfirmations :: ![SubjectConfirmation] The list of subject confirmation elements, if any. subjectNameID :: !NameID An identifier for the subject of the assertion.

Instances

Instances details

Show Subject Source #
Instance details Defined in Network.Wai.SAML2.Assertion Methods showsPrec :: Int -> Subject -> ShowS # show :: Subject -> String # showList :: [Subject] -> ShowS #
Eq Subject Source #
Instance details Defined in Network.Wai.SAML2.Assertion Methods (==) :: Subject -> Subject -> Bool # (/=) :: Subject -> Subject -> Bool #
FromXML Subject Source #
Instance details Defined in Network.Wai.SAML2.Assertion Methods parseXML :: MonadFail m => Cursor -> m Subject Source #

data NameID Source #

The NameID of a subject. See http://docs.oasis-open.org/security/saml/Post2.0/sstc-saml-tech-overview-2.0-cd-02.html#4.4.2.Assertion,%20Subject,%20and%20Statement%20Structure|outline and https://docs.oasis-open.org/security/saml/v2.0/saml-core-2.0-os.pdf#page=13

Since: 0.4

Constructors

NameID

Fields

nameIDQualifier :: !(Maybe Text)
The domain that qualifies the name. Allows names from different sources to used together without colliding
nameIDSPNameQualifier :: !(Maybe Text)
Additionally qualifies the name with the name of the service provider
nameIDSPProvidedID :: !(Maybe Text)
Name provided by a service provider
nameIDFormat :: !(Maybe NameIDFormat)
A URI reference describing the format of the value. If not specified it defaults to urn:oasis:names:tc:SAML:1.0:nameid-format:unspecified
nameIDValue :: !Text
Some textual identifier for the subject, such as an email address.

Instances

Instances details

Show NameID Source #
Instance details Defined in Network.Wai.SAML2.Assertion Methods showsPrec :: Int -> NameID -> ShowS # show :: NameID -> String # showList :: [NameID] -> ShowS #
Eq NameID Source #
Instance details Defined in Network.Wai.SAML2.Assertion Methods (==) :: NameID -> NameID -> Bool # (/=) :: NameID -> NameID -> Bool #
FromXML NameID Source #
Instance details Defined in Network.Wai.SAML2.Assertion Methods parseXML :: MonadFail m => Cursor -> m NameID Source #

data Conditions Source #

Conditions under which a SAML assertion is issued.

Constructors

Conditions
Fields conditionsNotBefore :: !UTCTime The time when the assertion is valid from (inclusive). conditionsNotOnOrAfter :: !UTCTime The time the assertion is valid to (not inclusive). conditionsAudienceRestrictions :: ![AudienceRestriction] The intended audience of the assertion. Since: 0.4

Instances

Instances details

Show Conditions Source #
Instance details Defined in Network.Wai.SAML2.Assertion Methods showsPrec :: Int -> Conditions -> ShowS # show :: Conditions -> String # showList :: [Conditions] -> ShowS #
Eq Conditions Source #
Instance details Defined in Network.Wai.SAML2.Assertion Methods (==) :: Conditions -> Conditions -> Bool # (/=) :: Conditions -> Conditions -> Bool #
FromXML Conditions Source #
Instance details Defined in Network.Wai.SAML2.Assertion Methods parseXML :: MonadFail m => Cursor -> m Conditions Source #

data AudienceRestriction Source #

An audience restriction.

Since: 0.4

Constructors

AudienceRestriction
Fields audienceRestrictionAudience :: ![Text] A URI reference that identifies an intended audience. For the corresponding assertion to be valid, the client has to be a member of one or more of these audiences

Instances

Instances details

Show AudienceRestriction Source #
Instance details Defined in Network.Wai.SAML2.Assertion Methods showsPrec :: Int -> AudienceRestriction -> ShowS # show :: AudienceRestriction -> String # showList :: [AudienceRestriction] -> ShowS #
Eq AudienceRestriction Source #
Instance details Defined in Network.Wai.SAML2.Assertion Methods (==) :: AudienceRestriction -> AudienceRestriction -> Bool # (/=) :: AudienceRestriction -> AudienceRestriction -> Bool #
FromXML AudienceRestriction Source #
Instance details Defined in Network.Wai.SAML2.Assertion Methods parseXML :: MonadFail m => Cursor -> m AudienceRestriction Source #

data AuthnStatement Source #

SAML2 authentication statements.

Constructors

AuthnStatement
Fields authnStatementInstant :: !UTCTime The timestamp when the assertion was issued. authnStatementSessionIndex :: !Text The session index. authnStatementLocality :: !Text The statement locality.

Instances

Instances details

Show AuthnStatement Source #
Instance details Defined in Network.Wai.SAML2.Assertion Methods showsPrec :: Int -> AuthnStatement -> ShowS # show :: AuthnStatement -> String # showList :: [AuthnStatement] -> ShowS #
Eq AuthnStatement Source #
Instance details Defined in Network.Wai.SAML2.Assertion Methods (==) :: AuthnStatement -> AuthnStatement -> Bool # (/=) :: AuthnStatement -> AuthnStatement -> Bool #
FromXML AuthnStatement Source #
Instance details Defined in Network.Wai.SAML2.Assertion Methods parseXML :: MonadFail m => Cursor -> m AuthnStatement Source #

data AssertionAttribute Source #

SAML2 assertion attributes.

Constructors

AssertionAttribute
Fields attributeName :: !Text The name of the attribute. attributeFriendlyName :: !(Maybe Text) A friendly attribute name, if it exists. attributeNameFormat :: !Text The name format. attributeValue :: !Text The value of the attribute.

Instances

Instances details

Show AssertionAttribute Source #
Instance details Defined in Network.Wai.SAML2.Assertion Methods showsPrec :: Int -> AssertionAttribute -> ShowS # show :: AssertionAttribute -> String # showList :: [AssertionAttribute] -> ShowS #
Eq AssertionAttribute Source #
Instance details Defined in Network.Wai.SAML2.Assertion Methods (==) :: AssertionAttribute -> AssertionAttribute -> Bool # (/=) :: AssertionAttribute -> AssertionAttribute -> Bool #
FromXML AssertionAttribute Source #
Instance details Defined in Network.Wai.SAML2.Assertion Methods parseXML :: MonadFail m => Cursor -> m AssertionAttribute Source #

type AttributeStatement = [AssertionAttribute] Source #

SAML2 assertion statements (collections of assertion attributes).

parseAttributeStatement :: Cursor -> AttributeStatement Source #

parseAttributeStatement cursor parses an AttributeStatement.

data Assertion Source #

Represents a SAML2 assertion.

Constructors

Assertion

Fields

assertionId :: !Text
The unique ID of this assertion. It is important to keep track of these in order to avoid replay attacks.
assertionIssued :: !UTCTime
The date and time when the assertion was issued.
assertionIssuer :: !Text
The name of the entity that issued this assertion.
assertionSubject :: !Subject
The subject of the assertion.
assertionConditions :: !Conditions
The conditions under which the assertion is issued.
assertionAuthnStatement :: !AuthnStatement
The authentication statement included in the assertion.
assertionAttributeStatement :: !AttributeStatement
The assertion's attribute statement.

Instances

Instances details

Show Assertion Source #
Instance details Defined in Network.Wai.SAML2.Assertion Methods showsPrec :: Int -> Assertion -> ShowS # show :: Assertion -> String # showList :: [Assertion] -> ShowS #
Eq Assertion Source #
Instance details Defined in Network.Wai.SAML2.Assertion Methods (==) :: Assertion -> Assertion -> Bool # (/=) :: Assertion -> Assertion -> Bool #
FromXML Assertion Source #
Instance details Defined in Network.Wai.SAML2.Assertion Methods parseXML :: MonadFail m => Cursor -> m Assertion Source #