Safe Haskell	None
Language	GHC2021

SAML2.WebSSO.API.Example

Description

This is a sample application composed of the end-points in SAML.WebSSO.API plus a minimum of functionality to make a running web application. Some parts of this module could be handy to build other apps, but it is more likely to serve as a tutorial.

Documentation

newtype SimpleSP a Source #

Constructors

SimpleSP (ReaderT SimpleSPCtx (ExceptT SimpleError IO) a)

Instances

Instances details

MonadIO SimpleSP Source #

Instance details

Defined in SAML2.WebSSO.API.Example

Methods

liftIO :: IO a -> SimpleSP a #

Applicative SimpleSP Source #

Instance details

Defined in SAML2.WebSSO.API.Example

Methods

pure :: a -> SimpleSP a #

(<*>) :: SimpleSP (a -> b) -> SimpleSP a -> SimpleSP b #

liftA2 :: (a -> b -> c) -> SimpleSP a -> SimpleSP b -> SimpleSP c #

(*>) :: SimpleSP a -> SimpleSP b -> SimpleSP b #

(<*) :: SimpleSP a -> SimpleSP b -> SimpleSP a #

Functor SimpleSP Source #

Instance details

Defined in SAML2.WebSSO.API.Example

Methods

fmap :: (a -> b) -> SimpleSP a -> SimpleSP b #

(<$) :: a -> SimpleSP b -> SimpleSP a #

Monad SimpleSP Source #

Instance details

Defined in SAML2.WebSSO.API.Example

Methods

(>>=) :: SimpleSP a -> (a -> SimpleSP b) -> SimpleSP b #

(>>) :: SimpleSP a -> SimpleSP b -> SimpleSP b #

return :: a -> SimpleSP a #

HasConfig SimpleSP Source #

Instance details

Defined in SAML2.WebSSO.API.Example

Methods

getConfig :: SimpleSP Config Source #

HasCreateUUID SimpleSP Source #

Instance details

Defined in SAML2.WebSSO.API.Example

Methods

createUUID :: SimpleSP UUID Source #

HasLogger SimpleSP Source #

Instance details

Defined in SAML2.WebSSO.API.Example

Methods

logger :: Level -> String -> SimpleSP () Source #

HasNow SimpleSP Source #

Instance details

Defined in SAML2.WebSSO.API.Example

Methods

getNow :: SimpleSP Time Source #

MonadError SimpleError SimpleSP Source #

Instance details

Defined in SAML2.WebSSO.API.Example

Methods

throwError :: SimpleError -> SimpleSP a #

catchError :: SimpleSP a -> (SimpleError -> SimpleSP a) -> SimpleSP a #

MonadReader SimpleSPCtx SimpleSP Source #

Instance details

Defined in SAML2.WebSSO.API.Example

Methods

ask :: SimpleSP SimpleSPCtx #

local :: (SimpleSPCtx -> SimpleSPCtx) -> SimpleSP a -> SimpleSP a #

reader :: (SimpleSPCtx -> a) -> SimpleSP a #

GetAllIdPs SimpleError SimpleSP Source #

Instance details

Defined in SAML2.WebSSO.API.Example

Methods

getAllIdPs :: SimpleSP [IdPConfig (IdPConfigExtra SimpleSP)] Source #

SPHandler SimpleError SimpleSP Source #

If you read the Config initially in IO and then pass it into the monad via Reader, you safe disk load and redundant debug logs.

Instance details

Defined in SAML2.WebSSO.API.Example

Associated Types

type NTCTX SimpleSP
Instance details Defined in SAML2.WebSSO.API.Example type NTCTX SimpleSP = SimpleSPCtx

Methods

nt :: NTCTX SimpleSP -> SimpleSP x -> Handler x Source #

SPStoreIdP SimpleError SimpleSP Source #

Instance details

Defined in SAML2.WebSSO.API.Example

Associated Types

type IdPConfigExtra SimpleSP
Instance details Defined in SAML2.WebSSO.API.Example type IdPConfigExtra SimpleSP = ()
type IdPConfigSPId SimpleSP
Instance details Defined in SAML2.WebSSO.API.Example type IdPConfigSPId SimpleSP = Void

Methods

storeIdPConfig :: IdPConfig (IdPConfigExtra SimpleSP) -> SimpleSP () Source #

getIdPConfig :: IdPId -> SimpleSP (IdPConfig (IdPConfigExtra SimpleSP)) Source #

getIdPConfigByIssuer :: Issuer -> IdPConfigSPId SimpleSP -> SimpleSP (IdPConfig (IdPConfigExtra SimpleSP)) Source #

getIdPConfigByIssuerOptionalSPId :: Issuer -> Maybe (IdPConfigSPId SimpleSP) -> SimpleSP (IdPConfig (IdPConfigExtra SimpleSP)) Source #

SPStoreAssertion Assertion SimpleSP Source #

Instance details

Defined in SAML2.WebSSO.API.Example

Methods

storeAssertionInternal :: ID Assertion -> Time -> SimpleSP () Source #

unStoreAssertion :: ID Assertion -> SimpleSP () Source #

isAliveAssertion :: ID Assertion -> SimpleSP Bool Source #

SPStoreRequest AuthnRequest SimpleSP Source #

Instance details

Defined in SAML2.WebSSO.API.Example

Methods

storeRequest :: ID AuthnRequest -> Issuer -> Time -> SimpleSP () Source #

unStoreRequest :: ID AuthnRequest -> SimpleSP () Source #

getIdpIssuer :: ID AuthnRequest -> SimpleSP (Maybe Issuer) Source #

type IdPConfigExtra SimpleSP Source #

Instance details

Defined in SAML2.WebSSO.API.Example

type IdPConfigExtra SimpleSP = ()

type IdPConfigSPId SimpleSP Source #

Instance details

Defined in SAML2.WebSSO.API.Example

type IdPConfigSPId SimpleSP = Void

type NTCTX SimpleSP Source #

Instance details

Defined in SAML2.WebSSO.API.Example

type NTCTX SimpleSP = SimpleSPCtx

data SimpleSPCtx Source #

Constructors

SimpleSPCtx
Fields _spctxConfig :: Config _spctxIdP :: [IdPConfig_] _spctxReq :: MVar RequestStore _spctxAss :: MVar AssertionStore

Instances

Instances details

MonadReader SimpleSPCtx SimpleSP Source #
Instance details Defined in SAML2.WebSSO.API.Example Methods ask :: SimpleSP SimpleSPCtx # local :: (SimpleSPCtx -> SimpleSPCtx) -> SimpleSP a -> SimpleSP a # reader :: (SimpleSPCtx -> a) -> SimpleSP a #

type RequestStore = Map (ID AuthnRequest) (Issuer, Time) Source #

type AssertionStore = Map (ID Assertion) Time Source #

spctxAss :: Lens' SimpleSPCtx (MVar AssertionStore) Source #

spctxConfig :: Lens' SimpleSPCtx Config Source #

spctxIdP :: Lens' SimpleSPCtx [IdPConfig_] Source #

spctxReq :: Lens' SimpleSPCtx (MVar RequestStore) Source #

type MonadApp (m :: Type -> Type) = (GetAllIdPs SimpleError m, SPHandler SimpleError m) Source #

runSimpleSP :: SimpleSPCtx -> SimpleSP a -> IO (Either SimpleError a) Source #

mkSimpleSPCtx :: Config -> [IdPConfig_] -> IO SimpleSPCtx Source #

simpleStoreID :: forall {k} m ctx (a :: k). (MonadIO m, MonadReader ctx m) => Lens' ctx (MVar (Map (ID a) Time)) -> ID a -> Time -> m () Source #

simpleStoreID' :: forall {k} (a :: k). ID a -> Time -> Map (ID a) Time -> Map (ID a) Time Source #

simpleUnStoreID :: forall {k} m ctx (a :: k). (MonadIO m, MonadReader ctx m) => Lens' ctx (MVar (Map (ID a) Time)) -> ID a -> m () Source #

simpleUnStoreID' :: forall {k} (a :: k). ID a -> Map (ID a) Time -> Map (ID a) Time Source #

simpleIsAliveID :: forall {k} m ctx (a :: k). (MonadIO m, MonadReader ctx m, SP m) => Lens' ctx (MVar (Map (ID a) Time)) -> ID a -> m Bool Source #

simpleIsAliveID' :: forall {k} (a :: k). Time -> ID a -> Map (ID a) Time -> Bool Source #

simpleStoreRequest :: (MonadIO m, MonadReader ctx m) => Lens' ctx (MVar RequestStore) -> ID AuthnRequest -> Issuer -> Time -> m () Source #

simpleStoreRequest' :: ID AuthnRequest -> (Issuer, Time) -> RequestStore -> RequestStore Source #

simpleUnStoreRequest :: (MonadIO m, MonadReader ctx m) => Lens' ctx (MVar RequestStore) -> ID AuthnRequest -> m () Source #

simpleUnStoreRequest' :: ID AuthnRequest -> RequestStore -> RequestStore Source #

simpleGetIdpIssuer :: (MonadIO m, MonadReader ctx m, SP m) => Lens' ctx (MVar RequestStore) -> ID AuthnRequest -> m (Maybe Issuer) Source #

simpleGetIdpIssuer' :: ID AuthnRequest -> RequestStore -> Time -> Maybe Issuer Source #

simpleGetIdPConfigBy :: (MonadError (Error err) m, HasConfig m, Show a, Ord a) => m [IdPConfig_] -> (IdPConfig_ -> a) -> a -> m IdPConfig_ Source #

class SPStoreIdP err m => GetAllIdPs err (m :: Type -> Type) where Source #

Methods

getAllIdPs :: m [IdPConfig (IdPConfigExtra m)] Source #

Instances

Instances details

GetAllIdPs SimpleError SimpleSP Source #
Instance details Defined in SAML2.WebSSO.API.Example Methods getAllIdPs :: SimpleSP [IdPConfig (IdPConfigExtra SimpleSP)] Source #
GetAllIdPs SimpleError TestSP Source #
Instance details Defined in SAML2.WebSSO.Test.Util.TestSP Methods getAllIdPs :: TestSP [IdPConfig (IdPConfigExtra TestSP)] Source #

type SPAPI = (Header "Cookie" Cky :> Get '[HTML] LoginStatus) :<|> (("logout" :> ("local" :> GetRedir '[HTML] (WithCookieAndLocation ST))) :<|> ("logout" :> ("single" :> GetRedir '[HTML] (WithCookieAndLocation ST)))) Source #

type APPAPI = ("sp" :> SPAPI) :<|> ("sso" :> API) Source #

data LoginStatus Source #

Constructors

NotLoggedIn [(ST, ST)]
LoggedInAs ST ST

Instances

Instances details

Show LoginStatus Source #
Instance details Defined in SAML2.WebSSO.API.Example Methods showsPrec :: Int -> LoginStatus -> ShowS # show :: LoginStatus -> String # showList :: [LoginStatus] -> ShowS #
Eq LoginStatus Source #
Instance details Defined in SAML2.WebSSO.API.Example Methods (==) :: LoginStatus -> LoginStatus -> Bool # (/=) :: LoginStatus -> LoginStatus -> Bool #
MimeRender HTML LoginStatus Source #
Instance details Defined in SAML2.WebSSO.API.Example Methods mimeRender :: Proxy HTML -> LoginStatus -> ByteString Source #

data Path Source #

Constructors

SpPathHome
SpPathLocalLogout
SpPathSingleLogout
SsoPathMeta IdPId
SsoPathAuthnReq IdPId
SsoPathAuthnResp IdPId

Instances

Instances details

Show Path Source #
Instance details Defined in SAML2.WebSSO.API.Example Methods showsPrec :: Int -> Path -> ShowS # show :: Path -> String # showList :: [Path] -> ShowS #
Eq Path Source #
Instance details Defined in SAML2.WebSSO.API.Example Methods (==) :: Path -> Path -> Bool # (/=) :: Path -> Path -> Bool #