Safe Haskell	Safe-Inferred
Language	Haskell2010

Web.Spock.Internal.Cookies

Synopsis

data CookieSettings = CookieSettings {
- cs_EOL :: CookieEOL
- cs_path :: Maybe ByteString
- cs_domain :: Maybe ByteString
- cs_HTTPOnly :: Bool
- cs_secure :: Bool
- cs_sameSite :: Maybe SameSite
}
data SameSite
- = SameSiteLax
- | SameSiteStrict
- | SameSiteNone
data CookieEOL
defaultCookieSettings :: CookieSettings
parseCookies :: ByteString -> [(Text, Text)]
generateCookieHeaderString :: Text -> Text -> CookieSettings -> UTCTime -> ByteString
renderCookie :: SetCookie -> ByteString

Documentation

data CookieSettings Source #

Cookie settings

Constructors

CookieSettings

Fields

cs_EOL :: CookieEOL
cookie expiration setting, see CookieEOL
cs_path :: Maybe ByteString
a path for the cookie
cs_domain :: Maybe ByteString
a domain for the cookie. Nothing means no domain is set
cs_HTTPOnly :: Bool
whether the cookie should be set as HttpOnly
cs_secure :: Bool
whether the cookie should be marked secure (sent over HTTPS only)
cs_sameSite :: Maybe SameSite
Cross-site cookie policy. Nothing omits the attribute. When using SameSiteNone, also enable cs_secure for browser compatibility.

data SameSite Source #

Constructors

SameSiteLax
SameSiteStrict
SameSiteNone

Instances

Instances details

Eq SameSite Source #
Instance details Defined in Web.Spock.Internal.Cookies Methods (==) :: SameSite -> SameSite -> Bool (/=) :: SameSite -> SameSite -> Bool
Show SameSite Source #
Instance details Defined in Web.Spock.Internal.Cookies Methods showsPrec :: Int -> SameSite -> ShowS show :: SameSite -> String showList :: [SameSite] -> ShowS

data CookieEOL Source #

Setting cookie expiration

Constructors

CookieValidUntil UTCTime	a point in time in UTC until the cookie is valid
CookieValidFor NominalDiffTime	a period (in seconds) for which the cookie is valid
CookieValidForSession	the cookie expires with the browser session
CookieValidForever	the cookie will have an expiration date in the far future

defaultCookieSettings :: CookieSettings Source #

Default cookie settings, equals

CookieSettings
  { cs_EOL      = CookieValidForSession
  , cs_HTTPOnly = False
  , cs_secure   = False
  , cs_sameSite = Nothing
  , cs_domain   = Nothing
  , cs_path     = Just "/"
  }

parseCookies :: ByteString -> [(Text, Text)] Source #

generateCookieHeaderString :: Text -> Text -> CookieSettings -> UTCTime -> ByteString Source #

renderCookie :: SetCookie -> ByteString Source #