monax-auth-api-0.4.0.0: Servant API types
LicenseAGPL-3.0-or-later
Maintainermonawasensei@gmail.com
Safe HaskellNone
LanguageGHC2024

Monax.Auth.Servant

Description

 
Synopsis

Documentation

class KnownSessionRequired (r :: SessionRequired) where Source #

Singleton class for SessionRequired for static dispatch of types like `ServerT (SessionRequired i r a :> api) m`

Associated Types

type FromSessionRequirement (r :: SessionRequired) a Source #

Methods

decideRequirement :: (r ~ 'NotRequired => a) -> (r ~ 'Required => a) -> a Source #

Branch on a known value.

Instances

Instances details
KnownSessionRequired 'NotRequired Source # 
Instance details

Defined in Monax.Auth.Servant

Associated Types

type FromSessionRequirement 'NotRequired a 
Instance details

Defined in Monax.Auth.Servant

type FromSessionRequirement 'NotRequired a = Maybe a

Methods

decideRequirement :: ('NotRequired ~ 'NotRequired => a) -> ('NotRequired ~ 'Required => a) -> a Source #

KnownSessionRequired 'Required Source # 
Instance details

Defined in Monax.Auth.Servant

Associated Types

type FromSessionRequirement 'Required a 
Instance details

Defined in Monax.Auth.Servant

type FromSessionRequirement 'Required a = a

Methods

decideRequirement :: ('Required ~ 'NotRequired => a) -> ('Required ~ 'Required => a) -> a Source #

fromSessionRequirement :: forall (r :: SessionRequired) a b. KnownSessionRequired r => Proxy a -> (r ~ 'NotRequired => FromSessionRequirement r a -> b) -> (r ~ 'Required => FromSessionRequirement r a -> b) -> FromSessionRequirement r a -> b Source #

Case analysis using a static type of kind SessionRequired.

data SessionRequired Source #

Marks an endpoint as requiring a valid session to proceed.

Constructors

NotRequired 
Required 

Instances

Instances details
Bounded SessionRequired Source # 
Instance details

Defined in Monax.Auth.Servant

Methods

minBound :: SessionRequired #

maxBound :: SessionRequired #

Enum SessionRequired Source # 
Instance details

Defined in Monax.Auth.Servant

Methods

succ :: SessionRequired -> SessionRequired #

pred :: SessionRequired -> SessionRequired #

toEnum :: Int -> SessionRequired #

fromEnum :: SessionRequired -> Int #

enumFrom :: SessionRequired -> [SessionRequired] #

enumFromThen :: SessionRequired -> SessionRequired -> [SessionRequired] #

enumFromTo :: SessionRequired -> SessionRequired -> [SessionRequired] #

enumFromThenTo :: SessionRequired -> SessionRequired -> SessionRequired -> [SessionRequired] #

Generic SessionRequired Source # 
Instance details

Defined in Monax.Auth.Servant

Associated Types

type Rep SessionRequired 
Instance details

Defined in Monax.Auth.Servant

type Rep SessionRequired = D1 ('MetaData "SessionRequired" "Monax.Auth.Servant" "monax-auth-api-0.4.0.0-inplace" 'False) (C1 ('MetaCons "NotRequired" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Required" 'PrefixI 'False) (U1 :: Type -> Type))

Methods

from :: SessionRequired -> Rep SessionRequired x #

to :: Rep SessionRequired x -> SessionRequired #

Show SessionRequired Source # 
Instance details

Defined in Monax.Auth.Servant

Methods

showsPrec :: Int -> SessionRequired -> ShowS #

show :: SessionRequired -> String #

showList :: [SessionRequired] -> ShowS #

Eq SessionRequired Source # 
Instance details

Defined in Monax.Auth.Servant

Methods

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

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

Ord SessionRequired Source # 
Instance details

Defined in Monax.Auth.Servant

Methods

compare :: SessionRequired -> SessionRequired -> Ordering #

(<) :: SessionRequired -> SessionRequired -> Bool #

(<=) :: SessionRequired -> SessionRequired -> Bool #

(>) :: SessionRequired -> SessionRequired -> Bool #

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

max :: SessionRequired -> SessionRequired -> SessionRequired #

min :: SessionRequired -> SessionRequired -> SessionRequired #

type Rep SessionRequired Source # 
Instance details

Defined in Monax.Auth.Servant

type Rep SessionRequired = D1 ('MetaData "SessionRequired" "Monax.Auth.Servant" "monax-auth-api-0.4.0.0-inplace" 'False) (C1 ('MetaCons "NotRequired" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Required" 'PrefixI 'False) (U1 :: Type -> Type))

data family SessionCookie :: k -> SessionRequired -> Type -> Type Source #

Reads a session token from the request cookies, and depending on the SessionRequired value, will proceed with an optional or required value for the user's session state.

Instances

Instances details
HasLink api => HasLink (SessionCookie i r b :> api :: Type) Source # 
Instance details

Defined in Monax.Auth.Servant

Methods

toLink :: (Link -> a) -> Proxy (SessionCookie i r b :> api) -> Link -> MkLink (SessionCookie i r b :> api) a #

(KnownSessionRequired r, HasContextEntry context (Tagged i (Sessions SessionID a)), HasContextEntry context (Tagged i Cipher), HasContextEntry context (Tagged i AuthenticationRedirectURL), HasServer api context) => HasServer (SessionCookie i r a :> api :: Type) context Source # 
Instance details

Defined in Monax.Auth.Servant

Methods

route :: Proxy (SessionCookie i r a :> api) -> Context context -> Delayed env (Server (SessionCookie i r a :> api)) -> Router env #

hoistServerWithContext :: Proxy (SessionCookie i r a :> api) -> Proxy context -> (forall x. m x -> n x) -> ServerT (SessionCookie i r a :> api) m -> ServerT (SessionCookie i r a :> api) n #

type IsElem' e (SessionCookie i r b :> api) Source # 
Instance details

Defined in Monax.Auth.Servant

type IsElem' e (SessionCookie i r b :> api) = IsElem e api
type MkLink (SessionCookie i r b :> api :: Type) a Source # 
Instance details

Defined in Monax.Auth.Servant

type MkLink (SessionCookie i r b :> api :: Type) a = MkLink api a
type ServerT (SessionCookie i r a :> api :: Type) m Source # 
Instance details

Defined in Monax.Auth.Servant

type ServerT (SessionCookie i r a :> api :: Type) m = FromSessionRequirement r (SessionID, a) -> ServerT api m

newtype SessionID Source #

Unique identifier suitable for sessions.

Constructors

SessionID UUID 

Instances

Instances details
Generic SessionID Source # 
Instance details

Defined in Monax.Auth.Servant

Associated Types

type Rep SessionID 
Instance details

Defined in Monax.Auth.Servant

type Rep SessionID = D1 ('MetaData "SessionID" "Monax.Auth.Servant" "monax-auth-api-0.4.0.0-inplace" 'True) (C1 ('MetaCons "SessionID" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UUID)))

Methods

from :: SessionID -> Rep SessionID x #

to :: Rep SessionID x -> SessionID #

Show SessionID Source # 
Instance details

Defined in Monax.Auth.Servant

Methods

showsPrec :: Int -> SessionID -> ShowS #

show :: SessionID -> String #

showList :: [SessionID] -> ShowS #

Eq SessionID Source # 
Instance details

Defined in Monax.Auth.Servant

Methods

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

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

Hashable SessionID Source # 
Instance details

Defined in Monax.Auth.Servant

Methods

hashWithSalt :: Int -> SessionID -> Int #

hash :: SessionID -> Int #

type Rep SessionID Source # 
Instance details

Defined in Monax.Auth.Servant

type Rep SessionID = D1 ('MetaData "SessionID" "Monax.Auth.Servant" "monax-auth-api-0.4.0.0-inplace" 'True) (C1 ('MetaCons "SessionID" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UUID)))

newSessionID :: IO SessionID Source #

Create a new unique SessionID

newtype AuthenticationRedirectURL Source #

A link to somewhere a user can authenticate and be issued a session token.

Constructors

AuthenticationRedirectURL Text 

Instances

Instances details
Monoid AuthenticationRedirectURL Source # 
Instance details

Defined in Monax.Auth.Servant

Methods

mempty :: AuthenticationRedirectURL #

mappend :: AuthenticationRedirectURL -> AuthenticationRedirectURL -> AuthenticationRedirectURL #

mconcat :: [AuthenticationRedirectURL] -> AuthenticationRedirectURL #

Semigroup AuthenticationRedirectURL Source # 
Instance details

Defined in Monax.Auth.Servant

Methods

(<>) :: AuthenticationRedirectURL -> AuthenticationRedirectURL -> AuthenticationRedirectURL #

sconcat :: NonEmpty AuthenticationRedirectURL -> AuthenticationRedirectURL #

stimes :: Integral b => b -> AuthenticationRedirectURL -> AuthenticationRedirectURL #

IsString AuthenticationRedirectURL Source # 
Instance details

Defined in Monax.Auth.Servant

Methods

fromString :: String -> AuthenticationRedirectURL #

Generic AuthenticationRedirectURL Source # 
Instance details

Defined in Monax.Auth.Servant

Associated Types

type Rep AuthenticationRedirectURL 
Instance details

Defined in Monax.Auth.Servant

type Rep AuthenticationRedirectURL = D1 ('MetaData "AuthenticationRedirectURL" "Monax.Auth.Servant" "monax-auth-api-0.4.0.0-inplace" 'True) (C1 ('MetaCons "AuthenticationRedirectURL" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

Methods

from :: AuthenticationRedirectURL -> Rep AuthenticationRedirectURL x #

to :: Rep AuthenticationRedirectURL x -> AuthenticationRedirectURL #

Show AuthenticationRedirectURL Source # 
Instance details

Defined in Monax.Auth.Servant

Methods

showsPrec :: Int -> AuthenticationRedirectURL -> ShowS #

show :: AuthenticationRedirectURL -> String #

showList :: [AuthenticationRedirectURL] -> ShowS #

Eq AuthenticationRedirectURL Source # 
Instance details

Defined in Monax.Auth.Servant

Methods

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

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

type Rep AuthenticationRedirectURL Source # 
Instance details

Defined in Monax.Auth.Servant

type Rep AuthenticationRedirectURL = D1 ('MetaData "AuthenticationRedirectURL" "Monax.Auth.Servant" "monax-auth-api-0.4.0.0-inplace" 'True) (C1 ('MetaCons "AuthenticationRedirectURL" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

data BasicAuthReqBody Source #

A form with "username" and "password" for a user to authenticate with.

Place in front of a POST endpoint.

type AuthenticateAndIssueToken =
    ReqBody '[FormUrlEncoded] BasicAuthReqBody
      :> Post '[JSON] (Headers '[Header "Set-Cookie" Text] Text)

Constructors

BasicAuthReqBody 

Fields

Instances

Instances details
Generic BasicAuthReqBody Source # 
Instance details

Defined in Monax.Auth.Servant

Associated Types

type Rep BasicAuthReqBody 
Instance details

Defined in Monax.Auth.Servant

type Rep BasicAuthReqBody = D1 ('MetaData "BasicAuthReqBody" "Monax.Auth.Servant" "monax-auth-api-0.4.0.0-inplace" 'False) (C1 ('MetaCons "BasicAuthReqBody" 'PrefixI 'True) (S1 ('MetaSel ('Just "barbUsername") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "barbPassword") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

Methods

from :: BasicAuthReqBody -> Rep BasicAuthReqBody x #

to :: Rep BasicAuthReqBody x -> BasicAuthReqBody #

FromForm BasicAuthReqBody Source # 
Instance details

Defined in Monax.Auth.Servant

Methods

fromForm :: Form -> Either Text BasicAuthReqBody #

type Rep BasicAuthReqBody Source # 
Instance details

Defined in Monax.Auth.Servant

type Rep BasicAuthReqBody = D1 ('MetaData "BasicAuthReqBody" "Monax.Auth.Servant" "monax-auth-api-0.4.0.0-inplace" 'False) (C1 ('MetaCons "BasicAuthReqBody" 'PrefixI 'True) (S1 ('MetaSel ('Just "barbUsername") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "barbPassword") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

makeSetSessionCookie :: AddHeader '[Optional, Strict] "Set-Cookie" Text orig new => Cipher -> SessionID -> Integer -> Text -> IO (orig -> new) Source #

Encrypt a session id and return a function that sets that session id as a cookie in a response.