Web.Apiary.ClientSession.Explicit

Documentation

data Session

data SessionConfig

Constructors

SessionConfig

Fields

sessionKey :: KeySource

sessionMaxAge :: DiffTime

sessionPath :: Maybe ByteString

sessionDomain :: Maybe ByteString

sessionHttpOnly :: Bool

sessionSecure :: Bool

angularXsrfCookieName :: Maybe ByteString

csrfTokenCookieName :: ByteString

csrfTokenCheckingName :: Either HeaderName ByteString

csrfTokenLength :: Int

Instances

Default SessionConfig

data KeySource

Constructors

KeyFile FilePath

KeyByteString ByteString

Instances

IsString KeySource

withSession :: MonadIO m => SessionConfig -> (Session -> m b) -> m b

embedKeyConfig :: FilePath -> ExpQ

generate and embed key at compile time. since 0.13.2.

This function embed as SessionConfig with default config. so you can configure it. but don't configure sessionKey.

 withSession $embedDefaultKeyConfig { csrfTokenCookieName = "foo" } $ run 3000 . runApiary def $ do
     route define ...

embedDefaultKeyConfig :: ExpQ

actions

setSession :: MonadIO m => Session -> ByteString -> ByteString -> ActionT m ()

csrfToken :: MonadIO m => Session -> ActionT m ByteString

filters

session :: (Functor n, MonadIO n, Strategy w, Query a) => Session -> ByteString -> proxy (w a) -> ApiaryT (SNext w as a) n m b -> ApiaryT as n m b

checkToken :: (Functor n, MonadIO n) => Session -> ApiaryT c n m a -> ApiaryT c n m a

lowlevels

mkSessionCookie :: SessionConfig -> Key -> ByteString -> ByteString -> IO SetCookie

getSessionValue

Arguments

:: Session

-> UTCTime

current time

-> ByteString

-> Maybe ByteString

reexports

module Data.Default.Class

deleteCookie

module Web.Apiary.Cookie