Yesod.Session.Options

Documentation

data Options tx m

Settings that have defaults

See defaultOptions.

Constructors

Options

Fields

• cookieName :: Text

  The name of cookie where the session key will be saved

• timing :: TimingOptions NominalDiffTime

  Various time duration settings

• transportSecurity :: TransportSecurity

  Whether cookies require HTTPS

• embedding :: SessionEmbeddings

  How special session management indicators get smuggled through a SessionMap

• clock :: m UTCTime

  How to determine the current time; you can change this to a fake for testing

• randomization :: m (Randomization tx)

  Generator of random byte strings, used to contrive session keys

• keyRotationTrigger :: Comparison SessionMap -> Maybe KeyRotation

  At the end of request handling, compare old session data to new session data to determine whether a key rotation should be performed

defaultOptions :: Options IO IO

Default options

• cookieName = "session-key"
• timing = defaultTimingOptions
• transportSecurity = AllowPlaintextTranport (change this in production)
• embedding.keyRotation = showReadKeyEmbedding "session-key-rotation"
• embedding.freeze = showReadKeyEmbedding "session-freeze"
• clock = getCurrentTime
• randomization = defaultRandomization
• keyRotationTrigger = const Nothing

hoistOptions :: Functor m2 => (forall a. tx1 a -> tx2 a) -> (forall a. m1 a -> m2 a) -> Options tx1 m1 -> Options tx2 m2