| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
Yesod.Auth.LTI13
Description
A Yesod authentication module for LTI 1.3
See example/Main.hs for a sample implementation.
Configuration:
- Login initiation URL: http://localhost:3000/auth/page/lti13/initiate
- JWKs URL: http://localhost:3000/auth/page/lti13/jwks
- Tool link URL: http://localhost:3000
Synopsis
- data PlatformInfo = PlatformInfo {}
- type Issuer = Text
- type ClientId = Text
- type Nonce = ByteString
- authLTI13 :: YesodAuthLTI13 m => AuthPlugin m
- authLTI13WithWidget :: YesodAuthLTI13 m => ((Route Auth -> Route m) -> WidgetFor m ()) -> AuthPlugin m
- class YesodAuth site => YesodAuthLTI13 site where
- checkSeenNonce :: Nonce -> AuthHandler site Bool
- retrievePlatformInfo :: (Issuer, Maybe ClientId) -> AuthHandler site PlatformInfo
- retrieveOrInsertJwks :: IO ByteString -> AuthHandler site ByteString
- getLtiIss :: CredsExtra -> Maybe Issuer
- getLtiSub :: CredsExtra -> Maybe Issuer
- getLtiToken :: CredsExtra -> Maybe LtiTokenClaims
- newtype LtiTokenClaims = LtiTokenClaims UncheckedLtiTokenClaims
- data UncheckedLtiTokenClaims = UncheckedLtiTokenClaims {
- messageType :: Text
- ltiVersion :: Text
- deploymentId :: Text
- targetLinkUri :: Text
- roles :: [Role]
- email :: Maybe Text
- displayName :: Maybe Text
- firstName :: Maybe Text
- lastName :: Maybe Text
- context :: Maybe ContextClaim
- lis :: Maybe LisClaim
- data ContextClaim = ContextClaim {
- contextId :: Text
- contextLabel :: Maybe Text
- contextTitle :: Maybe Text
- data LisClaim = LisClaim {}
- data Role
Documentation
data PlatformInfo #
Preregistered information about a learning platform
Constructors
| PlatformInfo | |
Fields
| |
client_id, one or more per platform; LTI spec § 3.1.3
type Nonce = ByteString #
authLTI13 :: YesodAuthLTI13 m => AuthPlugin m Source #
Auth plugin. Add this to appAuthPlugins to enable this plugin.
authLTI13WithWidget :: YesodAuthLTI13 m => ((Route Auth -> Route m) -> WidgetFor m ()) -> AuthPlugin m Source #
Auth plugin. The same as authLTI13 but you can provide your own template
for the login hint page.
class YesodAuth site => YesodAuthLTI13 site where Source #
Callbacks into your site for LTI 1.3
Methods
checkSeenNonce :: Nonce -> AuthHandler site Bool Source #
Check if a nonce has been seen in the last validity period. It is expected that nonces given to this function are stored somewhere, returning False, then when seen again, True should be returned. See the <http://www.imsglobal.org/spec/security/v1p0/#authentication-response-validation relevant section of the IMS security specification> for details.
retrievePlatformInfo :: (Issuer, Maybe ClientId) -> AuthHandler site PlatformInfo Source #
Get the configuration for the given platform.
It is possible that the relation between Issuer and ClientId is 1
to n rather than 1 to 1, for instance in the case of cloud hosted
Canvas. You *must* therefore key your PlatformInfo retrieval
with the pair of both and throw an error if there are multiple
ClientId for the given Issuer and the ClientId is Nothing.
Arguments
| :: IO ByteString | |
| -> AuthHandler site ByteString |
Retrieve JWKs list from the database or other store. If not
present, please create a new one by evaluating the given IO, store
it, and return it.
getLtiToken :: CredsExtra -> Maybe LtiTokenClaims Source #
Gets and decodes the extra token claims with the full LTI launch
information from a credsExtra
newtype LtiTokenClaims #
An object representing in the type system a token whose claims have been validated.
Constructors
| LtiTokenClaims UncheckedLtiTokenClaims |
Instances
| Eq LtiTokenClaims | |
Defined in Web.LTI13 Methods (==) :: LtiTokenClaims -> LtiTokenClaims -> Bool # (/=) :: LtiTokenClaims -> LtiTokenClaims -> Bool # | |
| Show LtiTokenClaims | |
Defined in Web.LTI13 Methods showsPrec :: Int -> LtiTokenClaims -> ShowS # show :: LtiTokenClaims -> String # showList :: [LtiTokenClaims] -> ShowS # | |
data UncheckedLtiTokenClaims #
LTI specific claims on a token. You should not accept this type, and
instead prefer the newtype LtiTokenClaims which has had checking
performed on it.
Constructors
| UncheckedLtiTokenClaims | |
Fields
| |
Instances
| Eq UncheckedLtiTokenClaims | |
Defined in Web.LTI13 Methods (==) :: UncheckedLtiTokenClaims -> UncheckedLtiTokenClaims -> Bool # (/=) :: UncheckedLtiTokenClaims -> UncheckedLtiTokenClaims -> Bool # | |
| Show UncheckedLtiTokenClaims | |
Defined in Web.LTI13 Methods showsPrec :: Int -> UncheckedLtiTokenClaims -> ShowS # show :: UncheckedLtiTokenClaims -> String # showList :: [UncheckedLtiTokenClaims] -> ShowS # | |
| ToJSON UncheckedLtiTokenClaims | |
Defined in Web.LTI13 Methods toJSON :: UncheckedLtiTokenClaims -> Value # toEncoding :: UncheckedLtiTokenClaims -> Encoding # toJSONList :: [UncheckedLtiTokenClaims] -> Value # | |
| FromJSON UncheckedLtiTokenClaims | |
Defined in Web.LTI13 Methods parseJSON :: Value -> Parser UncheckedLtiTokenClaims # parseJSONList :: Value -> Parser [UncheckedLtiTokenClaims] # | |
data ContextClaim #
LTI spec § 5.4.1 context claim
Constructors
| ContextClaim | |
Fields
| |
Instances
| Eq ContextClaim | |
Defined in Web.LTI13 | |
| Show ContextClaim | |
Defined in Web.LTI13 Methods showsPrec :: Int -> ContextClaim -> ShowS # show :: ContextClaim -> String # showList :: [ContextClaim] -> ShowS # | |
| ToJSON ContextClaim | |
Defined in Web.LTI13 Methods toJSON :: ContextClaim -> Value # toEncoding :: ContextClaim -> Encoding # toJSONList :: [ContextClaim] -> Value # toEncodingList :: [ContextClaim] -> Encoding # | |
| FromJSON ContextClaim | |
Defined in Web.LTI13 | |
LTI spec § D LIS claim
Constructors
| LisClaim | |
Fields
| |
Roles in the target context (≈ course/section); see LTI spec § A.2.2 and LTI spec § 5.3.7 for details
Constructors
| Administrator | |
| ContentDeveloper | |
| Instructor | |
| Learner | |
| Mentor | |
| Other Text |