Safe Haskell	None
Language	Haskell2010

Servant.Auth.Server.Internal.ConfigTypes

Synopsis

data IsMatch
- = Matches
- | DoesNotMatch
data JWTSettings = JWTSettings {
- signingKey :: JWK
- jwtAlg :: Maybe Alg
- validationKeys :: IO JWKSet
- audienceMatches :: StringOrURI -> IsMatch
}
defaultJWTSettings :: JWK -> JWTSettings
data CookieSettings = CookieSettings {
- cookieIsSecure :: !IsSecure
- cookieMaxAge :: !(Maybe DiffTime)
- cookieExpires :: !(Maybe UTCTime)
- cookiePath :: !(Maybe ByteString)
- cookieDomain :: !(Maybe ByteString)
- cookieSameSite :: !SameSite
- sessionCookieName :: !ByteString
- cookieXsrfSetting :: !(Maybe XsrfCookieSettings)
}
data XsrfCookieSettings = XsrfCookieSettings {
- xsrfCookieName :: !ByteString
- xsrfCookiePath :: !(Maybe ByteString)
- xsrfHeaderName :: !ByteString
- xsrfExcludeGet :: !Bool
}
defaultCookieSettings :: CookieSettings
defaultXsrfCookieSettings :: XsrfCookieSettings
data SameSite
- = AnySite
- | SameSiteStrict
- | SameSiteLax
data IsPasswordCorrect
- = PasswordCorrect
- | PasswordIncorrect
jwtSettingsToJwtValidationSettings :: JWTSettings -> JWTValidationSettings
data IsSecure
- = Secure
- | NotSecure

Documentation

data IsMatch Source #

Constructors

Matches
DoesNotMatch

Instances

Instances details

Generic IsMatch Source #

Instance details

Defined in Servant.Auth.Server.Internal.ConfigTypes

Associated Types

type Rep IsMatch
Instance details Defined in Servant.Auth.Server.Internal.ConfigTypes type Rep IsMatch = D1 ('MetaData "IsMatch" "Servant.Auth.Server.Internal.ConfigTypes" "servant-auth-server-0.4.9.1-4gCm79nClZlK0DXZWI8UFm" 'False) (C1 ('MetaCons "Matches" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "DoesNotMatch" 'PrefixI 'False) (U1 :: Type -> Type))

Methods

from :: IsMatch -> Rep IsMatch x #

to :: Rep IsMatch x -> IsMatch #

Read IsMatch Source #

Instance details

Defined in Servant.Auth.Server.Internal.ConfigTypes

Methods

readsPrec :: Int -> ReadS IsMatch #

readList :: ReadS [IsMatch] #

readPrec :: ReadPrec IsMatch #

readListPrec :: ReadPrec [IsMatch] #

Show IsMatch Source #

Instance details

Defined in Servant.Auth.Server.Internal.ConfigTypes

Methods

showsPrec :: Int -> IsMatch -> ShowS #

show :: IsMatch -> String #

showList :: [IsMatch] -> ShowS #

Eq IsMatch Source #

Instance details

Defined in Servant.Auth.Server.Internal.ConfigTypes

Methods

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

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

Ord IsMatch Source #

Instance details

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 Source #

Instance details

Defined in Servant.Auth.Server.Internal.ConfigTypes

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

data JWTSettings Source #

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

Instances details

Generic JWTSettings Source #

Instance details

Defined in Servant.Auth.Server.Internal.ConfigTypes

Associated Types

type Rep JWTSettings

Instance details

Defined in Servant.Auth.Server.Internal.ConfigTypes

type Rep JWTSettings = D1 ('MetaData "JWTSettings" "Servant.Auth.Server.Internal.ConfigTypes" "servant-auth-server-0.4.9.1-4gCm79nClZlK0DXZWI8UFm" '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)))))

Methods

from :: JWTSettings -> Rep JWTSettings x #

to :: Rep JWTSettings x -> JWTSettings #

type Rep JWTSettings Source #

Instance details

Defined in Servant.Auth.Server.Internal.ConfigTypes

type Rep JWTSettings = D1 ('MetaData "JWTSettings" "Servant.Auth.Server.Internal.ConfigTypes" "servant-auth-server-0.4.9.1-4gCm79nClZlK0DXZWI8UFm" '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)))))

defaultJWTSettings :: JWK -> JWTSettings Source #

A JWTSettings where the audience always matches.

data CookieSettings Source #

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

Instances details

Generic CookieSettings Source #

Instance details

Defined in Servant.Auth.Server.Internal.ConfigTypes

Associated Types

type Rep CookieSettings

Instance details

Defined in Servant.Auth.Server.Internal.ConfigTypes

Methods

from :: CookieSettings -> Rep CookieSettings x #

to :: Rep CookieSettings x -> CookieSettings #

Show CookieSettings Source #

Instance details

Defined in Servant.Auth.Server.Internal.ConfigTypes

Methods

showsPrec :: Int -> CookieSettings -> ShowS #

show :: CookieSettings -> String #

showList :: [CookieSettings] -> ShowS #

Default CookieSettings Source #

Instance details

Defined in Servant.Auth.Server.Internal.ConfigTypes

Methods

def :: CookieSettings #

Eq CookieSettings Source #

Instance details

Defined in Servant.Auth.Server.Internal.ConfigTypes

Methods

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

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

type Rep CookieSettings Source #

Instance details

Defined in Servant.Auth.Server.Internal.ConfigTypes

data XsrfCookieSettings Source #

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

Instances details

Generic XsrfCookieSettings Source #

Instance details

Defined in Servant.Auth.Server.Internal.ConfigTypes

Associated Types

type Rep XsrfCookieSettings

Instance details

Defined in Servant.Auth.Server.Internal.ConfigTypes

type Rep XsrfCookieSettings = D1 ('MetaData "XsrfCookieSettings" "Servant.Auth.Server.Internal.ConfigTypes" "servant-auth-server-0.4.9.1-4gCm79nClZlK0DXZWI8UFm" '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))))

Methods

from :: XsrfCookieSettings -> Rep XsrfCookieSettings x #

to :: Rep XsrfCookieSettings x -> XsrfCookieSettings #

Show XsrfCookieSettings Source #

Instance details

Defined in Servant.Auth.Server.Internal.ConfigTypes

Methods

showsPrec :: Int -> XsrfCookieSettings -> ShowS #

show :: XsrfCookieSettings -> String #

showList :: [XsrfCookieSettings] -> ShowS #

Default XsrfCookieSettings Source #

Instance details

Defined in Servant.Auth.Server.Internal.ConfigTypes

Methods

def :: XsrfCookieSettings #

Eq XsrfCookieSettings Source #

Instance details

Defined in Servant.Auth.Server.Internal.ConfigTypes

Methods

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

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

type Rep XsrfCookieSettings Source #

Instance details

Defined in Servant.Auth.Server.Internal.ConfigTypes

type Rep XsrfCookieSettings = D1 ('MetaData "XsrfCookieSettings" "Servant.Auth.Server.Internal.ConfigTypes" "servant-auth-server-0.4.9.1-4gCm79nClZlK0DXZWI8UFm" '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))))

defaultCookieSettings :: CookieSettings Source #

defaultXsrfCookieSettings :: XsrfCookieSettings Source #

data SameSite Source #

Constructors

AnySite
SameSiteStrict
SameSiteLax

Instances

Instances details

Generic SameSite Source #

Instance details

Defined in Servant.Auth.Server.Internal.ConfigTypes

Associated Types

type Rep SameSite

Instance details

Defined in Servant.Auth.Server.Internal.ConfigTypes

type Rep SameSite = D1 ('MetaData "SameSite" "Servant.Auth.Server.Internal.ConfigTypes" "servant-auth-server-0.4.9.1-4gCm79nClZlK0DXZWI8UFm" '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)))

Methods

from :: SameSite -> Rep SameSite x #

to :: Rep SameSite x -> SameSite #

Read SameSite Source #

Instance details

Defined in Servant.Auth.Server.Internal.ConfigTypes

Methods

readsPrec :: Int -> ReadS SameSite #

readList :: ReadS [SameSite] #

readPrec :: ReadPrec SameSite #

readListPrec :: ReadPrec [SameSite] #

Show SameSite Source #

Instance details

Defined in Servant.Auth.Server.Internal.ConfigTypes

Methods

showsPrec :: Int -> SameSite -> ShowS #

show :: SameSite -> String #

showList :: [SameSite] -> ShowS #

Eq SameSite Source #

Instance details

Defined in Servant.Auth.Server.Internal.ConfigTypes

Methods

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

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

Ord SameSite Source #

Instance details

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 Source #

Instance details

Defined in Servant.Auth.Server.Internal.ConfigTypes

type Rep SameSite = D1 ('MetaData "SameSite" "Servant.Auth.Server.Internal.ConfigTypes" "servant-auth-server-0.4.9.1-4gCm79nClZlK0DXZWI8UFm" '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 Source #

Constructors

PasswordCorrect
PasswordIncorrect

Instances

Instances details

Generic IsPasswordCorrect Source #

Instance details

Defined in Servant.Auth.Server.Internal.ConfigTypes

Associated Types

type Rep IsPasswordCorrect
Instance details Defined in Servant.Auth.Server.Internal.ConfigTypes type Rep IsPasswordCorrect = D1 ('MetaData "IsPasswordCorrect" "Servant.Auth.Server.Internal.ConfigTypes" "servant-auth-server-0.4.9.1-4gCm79nClZlK0DXZWI8UFm" 'False) (C1 ('MetaCons "PasswordCorrect" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "PasswordIncorrect" 'PrefixI 'False) (U1 :: Type -> Type))

Methods

from :: IsPasswordCorrect -> Rep IsPasswordCorrect x #

to :: Rep IsPasswordCorrect x -> IsPasswordCorrect #

Read IsPasswordCorrect Source #

Instance details

Defined in Servant.Auth.Server.Internal.ConfigTypes

Methods

readsPrec :: Int -> ReadS IsPasswordCorrect #

readList :: ReadS [IsPasswordCorrect] #

readPrec :: ReadPrec IsPasswordCorrect #

readListPrec :: ReadPrec [IsPasswordCorrect] #

Show IsPasswordCorrect Source #

Instance details

Defined in Servant.Auth.Server.Internal.ConfigTypes

Methods

showsPrec :: Int -> IsPasswordCorrect -> ShowS #

show :: IsPasswordCorrect -> String #

showList :: [IsPasswordCorrect] -> ShowS #

Eq IsPasswordCorrect Source #

Instance details

Defined in Servant.Auth.Server.Internal.ConfigTypes

Methods

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

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

Ord IsPasswordCorrect Source #

Instance details

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 Source #

Instance details

Defined in Servant.Auth.Server.Internal.ConfigTypes

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

jwtSettingsToJwtValidationSettings :: JWTSettings -> JWTValidationSettings Source #

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

Instances details

Generic IsSecure

Instance details

Defined in Servant.API.IsSecure

Associated Types

type Rep IsSecure
Instance details Defined in Servant.API.IsSecure type Rep IsSecure = D1 ('MetaData "IsSecure" "Servant.API.IsSecure" "servant-0.20.3.0-8Vrl4WcIxFuIuakScJskmc" 'False) (C1 ('MetaCons "Secure" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "NotSecure" 'PrefixI 'False) (U1 :: Type -> Type))

Methods

from :: IsSecure -> Rep IsSecure x #

to :: Rep IsSecure x -> IsSecure #

Read IsSecure

Instance details

Defined in Servant.API.IsSecure

Methods

readsPrec :: Int -> ReadS IsSecure #

readList :: ReadS [IsSecure] #

readPrec :: ReadPrec IsSecure #

readListPrec :: ReadPrec [IsSecure] #

Show IsSecure

Instance details

Defined in Servant.API.IsSecure

Methods

showsPrec :: Int -> IsSecure -> ShowS #

show :: IsSecure -> String #

showList :: [IsSecure] -> ShowS #

Eq IsSecure

Instance details

Defined in Servant.API.IsSecure

Methods

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

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

Ord IsSecure

Instance details

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)

Instance details

Defined in Servant.Links

Methods

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

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

Instance details

Defined in Servant.Server.Internal

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

Instance details

Defined in Servant.API.IsSecure

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

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

Instance details

Defined in Servant.Links

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

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

Instance details

Defined in Servant.Server.Internal

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