Happstack.Server.Internal.Cookie

Documentation

data Cookie

a type for HTTP cookies. Usually created using mkCookie.

Constructors

Cookie

Fields

• cookieVersion :: String
• cookiePath :: String
• cookieDomain :: String
• cookieName :: String
• cookieValue :: String
• secure :: Bool
• httpOnly :: Bool
• sameSite :: SameSite
• partitioned :: Bool

Instances

Data Cookie

Defined in Happstack.Server.Internal.Cookie

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Cookie -> c Cookie

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Cookie

toConstr :: Cookie -> Constr

dataTypeOf :: Cookie -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Cookie)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Cookie)

gmapT :: (forall b. Data b => b -> b) -> Cookie -> Cookie

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Cookie -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Cookie -> r

gmapQ :: (forall d. Data d => d -> u) -> Cookie -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> Cookie -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Cookie -> m Cookie

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Cookie -> m Cookie

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Cookie -> m Cookie

Read Cookie

Defined in Happstack.Server.Internal.Cookie

Methods

readsPrec :: Int -> ReadS Cookie

readList :: ReadS [Cookie]

readPrec :: ReadPrec Cookie

readListPrec :: ReadPrec [Cookie]

Show Cookie

Defined in Happstack.Server.Internal.Cookie

Methods

showsPrec :: Int -> Cookie -> ShowS

show :: Cookie -> String

showList :: [Cookie] -> ShowS

Eq Cookie

Defined in Happstack.Server.Internal.Cookie

Methods

(==) :: Cookie -> Cookie -> Bool

(/=) :: Cookie -> Cookie -> Bool

MonadReader RqEnv RqData

Defined in Happstack.Server.RqData

Methods

ask :: RqData RqEnv

local :: (RqEnv -> RqEnv) -> RqData a -> RqData a

reader :: (RqEnv -> a) -> RqData a

data CookieLife

Specify the lifetime of a cookie.

Note that we always set the max-age and expires headers because internet explorer does not honor max-age. You can specific MaxAge or Expires and the other will be calculated for you. Choose which ever one makes your life easiest.

Constructors

Session

session cookie - expires when browser is closed

MaxAge Int

life time of cookie in seconds

Expires UTCTime

cookie expiration date

Expired

cookie already expired

Instances

Read CookieLife

Defined in Happstack.Server.Internal.Cookie

Methods

readsPrec :: Int -> ReadS CookieLife

readList :: ReadS [CookieLife]

readPrec :: ReadPrec CookieLife

readListPrec :: ReadPrec [CookieLife]

Show CookieLife

Defined in Happstack.Server.Internal.Cookie

Methods

showsPrec :: Int -> CookieLife -> ShowS

show :: CookieLife -> String

showList :: [CookieLife] -> ShowS

Eq CookieLife

Defined in Happstack.Server.Internal.Cookie

Methods

(==) :: CookieLife -> CookieLife -> Bool

(/=) :: CookieLife -> CookieLife -> Bool

Ord CookieLife

Defined in Happstack.Server.Internal.Cookie

Methods

compare :: CookieLife -> CookieLife -> Ordering

(<) :: CookieLife -> CookieLife -> Bool

(<=) :: CookieLife -> CookieLife -> Bool

(>) :: CookieLife -> CookieLife -> Bool

(>=) :: CookieLife -> CookieLife -> Bool

max :: CookieLife -> CookieLife -> CookieLife

min :: CookieLife -> CookieLife -> CookieLife

data SameSite

Options for specifying third party cookie behaviour.

Note that most or all web clients require the cookie to be secure if "none" is specified.

Constructors

SameSiteLax

The cookie is sent in first party contexts as well as linked requests initiated from other contexts.

SameSiteStrict

The cookie is sent in first party contexts only.

SameSiteNone

The cookie is sent in first as well as third party contexts if the cookie is secure.

SameSiteNoValue

The default; used if you do not wish a SameSite attribute present at all.

Instances

Data SameSite

Defined in Happstack.Server.Internal.Cookie

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SameSite -> c SameSite

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SameSite

toConstr :: SameSite -> Constr

dataTypeOf :: SameSite -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c SameSite)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SameSite)

gmapT :: (forall b. Data b => b -> b) -> SameSite -> SameSite

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SameSite -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SameSite -> r

gmapQ :: (forall d. Data d => d -> u) -> SameSite -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> SameSite -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> SameSite -> m SameSite

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SameSite -> m SameSite

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SameSite -> m SameSite

Read SameSite

Defined in Happstack.Server.Internal.Cookie

Methods

readsPrec :: Int -> ReadS SameSite

readList :: ReadS [SameSite]

readPrec :: ReadPrec SameSite

readListPrec :: ReadPrec [SameSite]

Show SameSite

Defined in Happstack.Server.Internal.Cookie

Methods

showsPrec :: Int -> SameSite -> ShowS

show :: SameSite -> String

showList :: [SameSite] -> ShowS

Eq SameSite

Defined in Happstack.Server.Internal.Cookie

Methods

(==) :: SameSite -> SameSite -> Bool

(/=) :: SameSite -> SameSite -> Bool

Ord SameSite

Defined in Happstack.Server.Internal.Cookie

Methods

compare :: SameSite -> SameSite -> Ordering

(<) :: SameSite -> SameSite -> Bool

(<=) :: SameSite -> SameSite -> Bool

(>) :: SameSite -> SameSite -> Bool

(>=) :: SameSite -> SameSite -> Bool

max :: SameSite -> SameSite -> SameSite

min :: SameSite -> SameSite -> SameSite

calcLife :: CookieLife -> IO (Maybe (Int, UTCTime))

mkCookie

Arguments

:: String

cookie name

-> String

cookie value

-> Cookie

Creates a cookie with a default version of 1, empty domain, a path of "/", secure == False, httpOnly == False and sameSite == SameSiteNoValue and partitioned = False

see also: addCookie

mkCookieHeader :: Maybe (Int, UTCTime) -> Cookie -> String

Set a Cookie in the Result. The values are escaped as per RFC 2109, but some browsers may have buggy support for cookies containing e.g. '"' or ' '.

Also, it seems that chrome, safari, and other webkit browsers do not like cookies which have double quotes around the domain and reject/ignore the cookie. So, we no longer quote the domain.

internet explorer does not honor the max-age directive so we set both max-age and expires.

See CookieLife and calcLife for a convenient way of calculating the first argument to this function.

getCookies :: MonadFail m => ByteString -> m [Cookie]

Get all cookies from the HTTP request. The cookies are ordered per RFC from the most specific to the least specific. Multiple cookies with the same name are allowed to exist.

getCookie :: MonadFail m => String -> ByteString -> m Cookie

Get the most specific cookie with the given name. Fails if there is no such cookie or if the browser did not escape cookies in a proper fashion. Browser support for escaping cookies properly is very diverse.

getCookies' :: Monad m => ByteString -> m (Either String [Cookie])

getCookie' :: Monad m => String -> ByteString -> m (Either String Cookie)

parseCookies :: String -> Either String [Cookie]

Not an supported api. Takes a cookie header and returns either a String error message or an array of parsed cookies

cookiesParser :: GenParser Char st [Cookie]

not a supported api. A parser for RFC 2109 cookies