Network.Wai.SAML2.Config

Configuration types and smart constructors for the SAML2 middleware.

Documentation

data SAML2Config

Represents configurations for the SAML2 middleware.

Constructors

SAML2Config

Fields

• saml2AssertionPath :: !ByteString

  The path relative to the root of the web application at which the middleware should listen for SAML2 assertions (e.g. ssoassert).

• saml2PrivateKey :: !(Maybe PrivateKey)

  The service provider's private key, used to decrypt data from the identity provider. when set to Nothing, it rejects encrypted assertions.

• saml2PublicKey :: !PublicKey

  The identity provider's public key, used to validate signatures.

• saml2ExpectedIssuer :: !(Maybe Text)

  The name of the entity we expect assertions from. If this is set to Nothing, the issuer name is not validated.

• saml2ExpectedDestination :: !(Maybe Text)

  The URL we expect the SAML2 response to contain as destination.

• saml2Audiences :: ![Text]

  The audiences we are a member of. An assertions is only valid if we are a member of at least one of its audiences. Leaving this empty disables the check

  Since: 0.4

• saml2DisableTimeValidation :: !Bool

  A value indicating whether to disable time validity checks. This should not be set to True in a production environment, but may be useful for testing purposes.

• saml2RequireEncryptedAssertion :: !Bool

  Always decrypt assertions using saml2PrivateKey and reject plaintext assertions.

  Since: 0.4

saml2Config :: PrivateKey -> PublicKey -> SAML2Config

saml2Config privateKey publicKey constructs a SAML2Config value with the most basic set of options possible using privateKey as the SP's private key and publicKey as the IdP's public key. You should almost certainly change the resulting settings. This requires encrypted assertions by default.

saml2ConfigNoEncryption :: PublicKey -> SAML2Config

saml2ConfigNoEncryption publicKey constructs a SAML2Config value with the most basic set of options possible using publicKey as the IdP's public key. You should almost certainly change the resulting settings.

Since: 0.4.0.0