Servant.Auth.Server.Internal.ConfigTypes

Documentation

data IsMatch

Constructors

Matches

DoesNotMatch

Instances

Generic IsMatch

Defined in Servant.Auth.Server.Internal.ConfigTypes

Associated Types

type Rep IsMatch :: Type -> Type

Methods

from :: IsMatch -> Rep IsMatch x

to :: Rep IsMatch x -> IsMatch

Read IsMatch

Defined in Servant.Auth.Server.Internal.ConfigTypes

Methods

readsPrec :: Int -> ReadS IsMatch

readList :: ReadS [IsMatch]

readPrec :: ReadPrec IsMatch

readListPrec :: ReadPrec [IsMatch]

Show IsMatch

Defined in Servant.Auth.Server.Internal.ConfigTypes

Methods

showsPrec :: Int -> IsMatch -> ShowS

show :: IsMatch -> String

showList :: [IsMatch] -> ShowS

Eq IsMatch

Defined in Servant.Auth.Server.Internal.ConfigTypes

Methods

(==) :: IsMatch -> IsMatch -> Bool

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

Ord IsMatch

Defined in Servant.Auth.Server.Internal.ConfigTypes

Methods

compare :: IsMatch -> IsMatch -> Ordering

(<) :: IsMatch -> IsMatch -> Bool

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

(>) :: IsMatch -> IsMatch -> Bool

(>=) :: IsMatch -> IsMatch -> Bool

max :: IsMatch -> IsMatch -> IsMatch

min :: IsMatch -> IsMatch -> IsMatch

type Rep IsMatch

Defined in Servant.Auth.Server.Internal.ConfigTypes

type Rep IsMatch = D1 ('MetaData "IsMatch" "Servant.Auth.Server.Internal.ConfigTypes" "servant-auth-server-0.4.9.0-JicIkdxdNDE9KNv4CWRn7m" 'False) (C1 ('MetaCons "Matches" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "DoesNotMatch" 'PrefixI 'False) (U1 :: Type -> Type))

data JWTSettings

JWTSettings are used to generate cookies, and to verify JWTs.

Constructors

JWTSettings

Fields

• signingKey :: JWK

  Key used to sign JWT.

• jwtAlg :: Maybe Alg

  Algorithm used to sign JWT.

• validationKeys :: IO JWKSet

  Keys used to validate JWT.

• audienceMatches :: StringOrURI -> IsMatch

  An aud predicate. The aud is a string or URI that identifies the intended recipient of the JWT.

Instances

Generic JWTSettings

Defined in Servant.Auth.Server.Internal.ConfigTypes

Associated Types

type Rep JWTSettings :: Type -> Type

Methods

from :: JWTSettings -> Rep JWTSettings x

to :: Rep JWTSettings x -> JWTSettings

type Rep JWTSettings

Defined in Servant.Auth.Server.Internal.ConfigTypes

type Rep JWTSettings = D1 ('MetaData "JWTSettings" "Servant.Auth.Server.Internal.ConfigTypes" "servant-auth-server-0.4.9.0-JicIkdxdNDE9KNv4CWRn7m" 'False) (C1 ('MetaCons "JWTSettings" 'PrefixI 'True) ((S1 ('MetaSel ('Just "signingKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 JWK) :*: S1 ('MetaSel ('Just "jwtAlg") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Alg))) :*: (S1 ('MetaSel ('Just "validationKeys") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (IO JWKSet)) :*: S1 ('MetaSel ('Just "audienceMatches") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (StringOrURI -> IsMatch)))))

data CookieSettings

The policies to use when generating cookies.

If *both* cookieMaxAge and cookieExpires are Nothing, browsers will treat the cookie as a *session cookie*. These will be deleted when the browser is closed.

Note that having the setting Secure may cause testing failures if you are not testing over HTTPS.

Constructors

CookieSettings

Fields

• cookieIsSecure :: !IsSecure

  Secure means browsers will only send cookies over HTTPS. Default: Secure.

• cookieMaxAge :: !(Maybe DiffTime)

  How long from now until the cookie expires. Default: Nothing.

• cookieExpires :: !(Maybe UTCTime)

  At what time the cookie expires. Default: Nothing.

• cookiePath :: !(Maybe ByteString)

  The URL path and sub-paths for which this cookie is used. Default: Just "/".

• cookieDomain :: !(Maybe ByteString)

  Domain name, if set cookie also allows subdomains. Default: Nothing.

• cookieSameSite :: !SameSite

  SameSite settings. Default: SameSiteLax.

• sessionCookieName :: !ByteString

  What name to use for the cookie used for the session.

• cookieXsrfSetting :: !(Maybe XsrfCookieSettings)

  The optional settings to use for XSRF protection. Default: Just def.

Instances

Generic CookieSettings

Defined in Servant.Auth.Server.Internal.ConfigTypes

Associated Types

type Rep CookieSettings :: Type -> Type

Methods

from :: CookieSettings -> Rep CookieSettings x

to :: Rep CookieSettings x -> CookieSettings

Show CookieSettings

Defined in Servant.Auth.Server.Internal.ConfigTypes

Methods

showsPrec :: Int -> CookieSettings -> ShowS

show :: CookieSettings -> String

showList :: [CookieSettings] -> ShowS

Default CookieSettings

Defined in Servant.Auth.Server.Internal.ConfigTypes

Methods

def :: CookieSettings

Eq CookieSettings

Defined in Servant.Auth.Server.Internal.ConfigTypes

Methods

(==) :: CookieSettings -> CookieSettings -> Bool

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

type Rep CookieSettings

Defined in Servant.Auth.Server.Internal.ConfigTypes

type Rep CookieSettings = D1 ('MetaData "CookieSettings" "Servant.Auth.Server.Internal.ConfigTypes" "servant-auth-server-0.4.9.0-JicIkdxdNDE9KNv4CWRn7m" 'False) (C1 ('MetaCons "CookieSettings" 'PrefixI 'True) (((S1 ('MetaSel ('Just "cookieIsSecure") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 IsSecure) :*: S1 ('MetaSel ('Just "cookieMaxAge") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe DiffTime))) :*: (S1 ('MetaSel ('Just "cookieExpires") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe UTCTime)) :*: S1 ('MetaSel ('Just "cookiePath") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe ByteString)))) :*: ((S1 ('MetaSel ('Just "cookieDomain") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe ByteString)) :*: S1 ('MetaSel ('Just "cookieSameSite") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 SameSite)) :*: (S1 ('MetaSel ('Just "sessionCookieName") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ByteString) :*: S1 ('MetaSel ('Just "cookieXsrfSetting") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe XsrfCookieSettings))))))

data XsrfCookieSettings

The policies to use when generating and verifying XSRF cookies

Constructors

XsrfCookieSettings

Fields

• xsrfCookieName :: !ByteString

  What name to use for the cookie used for XSRF protection.

• xsrfCookiePath :: !(Maybe ByteString)

  What path to use for the cookie used for XSRF protection. Default Just "/".

• xsrfHeaderName :: !ByteString

  What name to use for the header used for XSRF protection.

• xsrfExcludeGet :: !Bool

  Exclude GET request method from XSRF protection.

Instances

Generic XsrfCookieSettings

Defined in Servant.Auth.Server.Internal.ConfigTypes

Associated Types

type Rep XsrfCookieSettings :: Type -> Type

Methods

from :: XsrfCookieSettings -> Rep XsrfCookieSettings x

to :: Rep XsrfCookieSettings x -> XsrfCookieSettings

Show XsrfCookieSettings

Defined in Servant.Auth.Server.Internal.ConfigTypes

Methods

showsPrec :: Int -> XsrfCookieSettings -> ShowS

show :: XsrfCookieSettings -> String

showList :: [XsrfCookieSettings] -> ShowS

Default XsrfCookieSettings

Defined in Servant.Auth.Server.Internal.ConfigTypes

Methods

def :: XsrfCookieSettings

Eq XsrfCookieSettings

Defined in Servant.Auth.Server.Internal.ConfigTypes

Methods

(==) :: XsrfCookieSettings -> XsrfCookieSettings -> Bool

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

type Rep XsrfCookieSettings

Defined in Servant.Auth.Server.Internal.ConfigTypes

type Rep XsrfCookieSettings = D1 ('MetaData "XsrfCookieSettings" "Servant.Auth.Server.Internal.ConfigTypes" "servant-auth-server-0.4.9.0-JicIkdxdNDE9KNv4CWRn7m" 'False) (C1 ('MetaCons "XsrfCookieSettings" 'PrefixI 'True) ((S1 ('MetaSel ('Just "xsrfCookieName") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ByteString) :*: S1 ('MetaSel ('Just "xsrfCookiePath") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe ByteString))) :*: (S1 ('MetaSel ('Just "xsrfHeaderName") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ByteString) :*: S1 ('MetaSel ('Just "xsrfExcludeGet") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Bool))))

data SameSite

Constructors

AnySite

SameSiteStrict

SameSiteLax

Instances

Generic SameSite

Defined in Servant.Auth.Server.Internal.ConfigTypes

Associated Types

type Rep SameSite :: Type -> Type

Methods

from :: SameSite -> Rep SameSite x

to :: Rep SameSite x -> SameSite

Read SameSite

Defined in Servant.Auth.Server.Internal.ConfigTypes

Methods

readsPrec :: Int -> ReadS SameSite

readList :: ReadS [SameSite]

readPrec :: ReadPrec SameSite

readListPrec :: ReadPrec [SameSite]

Show SameSite

Defined in Servant.Auth.Server.Internal.ConfigTypes

Methods

showsPrec :: Int -> SameSite -> ShowS

show :: SameSite -> String

showList :: [SameSite] -> ShowS

Eq SameSite

Defined in Servant.Auth.Server.Internal.ConfigTypes

Methods

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

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

Ord SameSite

Defined in Servant.Auth.Server.Internal.ConfigTypes

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

type Rep SameSite

Defined in Servant.Auth.Server.Internal.ConfigTypes

type Rep SameSite = D1 ('MetaData "SameSite" "Servant.Auth.Server.Internal.ConfigTypes" "servant-auth-server-0.4.9.0-JicIkdxdNDE9KNv4CWRn7m" 'False) (C1 ('MetaCons "AnySite" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "SameSiteStrict" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "SameSiteLax" 'PrefixI 'False) (U1 :: Type -> Type)))

data IsPasswordCorrect

Constructors

PasswordCorrect

PasswordIncorrect

Instances

Generic IsPasswordCorrect

Defined in Servant.Auth.Server.Internal.ConfigTypes

Associated Types

type Rep IsPasswordCorrect :: Type -> Type

Methods

from :: IsPasswordCorrect -> Rep IsPasswordCorrect x

to :: Rep IsPasswordCorrect x -> IsPasswordCorrect

Read IsPasswordCorrect

Defined in Servant.Auth.Server.Internal.ConfigTypes

Methods

readsPrec :: Int -> ReadS IsPasswordCorrect

readList :: ReadS [IsPasswordCorrect]

readPrec :: ReadPrec IsPasswordCorrect

readListPrec :: ReadPrec [IsPasswordCorrect]

Show IsPasswordCorrect

Defined in Servant.Auth.Server.Internal.ConfigTypes

Methods

showsPrec :: Int -> IsPasswordCorrect -> ShowS

show :: IsPasswordCorrect -> String

showList :: [IsPasswordCorrect] -> ShowS

Eq IsPasswordCorrect

Defined in Servant.Auth.Server.Internal.ConfigTypes

Methods

(==) :: IsPasswordCorrect -> IsPasswordCorrect -> Bool

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

Ord IsPasswordCorrect

Defined in Servant.Auth.Server.Internal.ConfigTypes

Methods

compare :: IsPasswordCorrect -> IsPasswordCorrect -> Ordering

(<) :: IsPasswordCorrect -> IsPasswordCorrect -> Bool

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

(>) :: IsPasswordCorrect -> IsPasswordCorrect -> Bool

(>=) :: IsPasswordCorrect -> IsPasswordCorrect -> Bool

max :: IsPasswordCorrect -> IsPasswordCorrect -> IsPasswordCorrect

min :: IsPasswordCorrect -> IsPasswordCorrect -> IsPasswordCorrect

type Rep IsPasswordCorrect

Defined in Servant.Auth.Server.Internal.ConfigTypes

type Rep IsPasswordCorrect = D1 ('MetaData "IsPasswordCorrect" "Servant.Auth.Server.Internal.ConfigTypes" "servant-auth-server-0.4.9.0-JicIkdxdNDE9KNv4CWRn7m" 'False) (C1 ('MetaCons "PasswordCorrect" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "PasswordIncorrect" 'PrefixI 'False) (U1 :: Type -> Type))

defaultJWTSettings :: JWK -> JWTSettings

A JWTSettings where the audience always matches.

defaultCookieSettings :: CookieSettings

defaultXsrfCookieSettings :: XsrfCookieSettings

jwtSettingsToJwtValidationSettings :: JWTSettings -> JWTValidationSettings

data IsSecure

Was this request made over an SSL connection?

Note that this value will not tell you if the client originally made this request over SSL, but rather whether the current connection is SSL. The distinction lies with reverse proxies. In many cases, the client will connect to a load balancer over SSL, but connect to the WAI handler without SSL. In such a case, the handlers would get NotSecure, but from a user perspective, there is a secure connection.

Constructors

Secure

the connection to the server is secure (HTTPS)

NotSecure

the connection to the server is not secure (HTTP)

Instances

Generic IsSecure

Defined in Servant.API.IsSecure

Associated Types

type Rep IsSecure :: Type -> Type

Methods

from :: IsSecure -> Rep IsSecure x

to :: Rep IsSecure x -> IsSecure

Read IsSecure

Defined in Servant.API.IsSecure

Methods

readsPrec :: Int -> ReadS IsSecure

readList :: ReadS [IsSecure]

readPrec :: ReadPrec IsSecure

readListPrec :: ReadPrec [IsSecure]

Show IsSecure

Defined in Servant.API.IsSecure

Methods

showsPrec :: Int -> IsSecure -> ShowS

show :: IsSecure -> String

showList :: [IsSecure] -> ShowS

Eq IsSecure

Defined in Servant.API.IsSecure

Methods

(==) :: IsSecure -> IsSecure -> Bool

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

Ord IsSecure

Defined in Servant.API.IsSecure

Methods

compare :: IsSecure -> IsSecure -> Ordering

(<) :: IsSecure -> IsSecure -> Bool

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

(>) :: IsSecure -> IsSecure -> Bool

(>=) :: IsSecure -> IsSecure -> Bool

max :: IsSecure -> IsSecure -> IsSecure

min :: IsSecure -> IsSecure -> IsSecure

HasLink sub => HasLink (IsSecure :> sub :: Type)

Defined in Servant.Links

Associated Types

type MkLink (IsSecure :> sub) a

Methods

toLink :: (Link -> a) -> Proxy (IsSecure :> sub) -> Link -> MkLink (IsSecure :> sub) a

HasServer api context => HasServer (IsSecure :> api :: Type) context

Defined in Servant.Server.Internal

Associated Types

type ServerT (IsSecure :> api) m

Methods

route :: Proxy (IsSecure :> api) -> Context context -> Delayed env (Server (IsSecure :> api)) -> Router env

hoistServerWithContext :: Proxy (IsSecure :> api) -> Proxy context -> (forall x. m x -> n x) -> ServerT (IsSecure :> api) m -> ServerT (IsSecure :> api) n

type Rep IsSecure

Defined in Servant.API.IsSecure

type Rep IsSecure = D1 ('MetaData "IsSecure" "Servant.API.IsSecure" "servant-0.20.2-Gi9sNeCszk4lB7Qo1IEZK" 'False) (C1 ('MetaCons "Secure" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "NotSecure" 'PrefixI 'False) (U1 :: Type -> Type))

type MkLink (IsSecure :> sub :: Type) a

Defined in Servant.Links

type MkLink (IsSecure :> sub :: Type) a = MkLink sub a

type ServerT (IsSecure :> api :: Type) m

Defined in Servant.Server.Internal

type ServerT (IsSecure :> api :: Type) m = IsSecure -> ServerT api m