Web.Apiary.ClientSession

Documentation

data Session

config

data SessionConfig

Constructors

SessionConfig

Fields

sessionKey :: KeySource

sessionMaxAge :: DiffTime

sessionPath :: Maybe ByteString

sessionDomain :: Maybe ByteString

sessionHttpOnly :: Bool

sessionSecure :: Bool

sessionTimeoutAction :: forall e m. MonadIO m => ActionT e m ()

angularXsrfCookieName :: Maybe ByteString

csrfTokenCookieName :: ByteString

csrfTokenCheckingName :: Either HeaderName ByteString

csrfTokenLength :: Int

Instances

Default SessionConfig

data KeySource

Constructors

KeyFile FilePath

KeyByteString ByteString

Instances

IsString KeySource

embedKeyConfig :: FilePath -> ExpQ

generate and embed key at compile time. since 0.13.2.

This function embed as SessionsessionConfig with default sessionConfig. so you can sessionConfigure it. but DON'T sessionConfigure sessionKey.

this function is convenient when create heroku project.

embedsessionConfig = $embedDefaultKeysessionConfig { csrfTokenCookieName = "foo" }

embedDefaultKeyConfig :: ExpQ

initializer

initSession :: MonadIO m => SessionConfig -> Initializer' m Session

getter

getSessionConfig :: (Has Session exts, Monad m) => ActionT exts m SessionConfig

setter

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

csrfToken :: (Has Session exts, MonadIO m) => ActionT exts m ByteString

create crypto random (generate random by AES CTR(cprng-aes package) and encode by base64),

set it client session cookie, set XSRF-TOKEN header(when Just angularXsrfCookieName),

and return value. since 0.9.0.0.

with sessionConfig

setSessionWith :: (Has Session exts, MonadIO m) => SessionConfig -> ByteString -> ByteString -> ActionT exts m ()

filter

session :: (Has Session exts, Query a, Strategy w, MonadIO actM) => ByteString -> w a -> ApiaryT exts (SNext w prms a) actM m () -> ApiaryT exts prms actM m ()

checkToken :: (Has Session exts, MonadIO actM) => ApiaryT exts prms actM m () -> ApiaryT exts prms actM m ()

check csrf token. since 0.9.0.0.

Reexport

deleteCookie

module Web.Apiary.Cookie