yesod-auth-lti13: A yesod-auth plugin for LTI 1.3

[ lgpl, library, web, yesod ] [ Propose Tags ] [ Report a vulnerability ]

A plugin using https://hackage.haskell.org/package/lti13 to implement IMS Global LTI 1.3 authentication for yesod-auth.


[Skip to Readme]

Modules

[Index] [Quick Jump]

Flags

Automatic Flags
NameDescriptionDefault
example

Should I build the Yesod example?

Disabled

Use -f <flag> to enable a flag, or -f -<flag> to disable that flag. More info

Downloads

Maintainer's Corner

Package maintainers

For package maintainers and hackage trustees

Candidates

Versions [RSS] 0.1.1.0, 0.1.2.0, 0.1.2.1, 0.1.2.2, 0.2.0.0, 0.2.0.1, 0.2.0.2, 0.2.0.3, 0.3.0.0
Change log CHANGELOG.md
Dependencies aeson (>=2 && <2.2), aeson-pretty (>=0.8.8 && <0.9), base (>=4.12 && <5), base64-bytestring (>=1.0.0 && <1.3), bytestring (>=0.10.10 && <0.12), containers (>=0.6.2 && <0.7), cryptonite (>=0.26 && <0.31), http-client (>=0.6.4 && <0.8), http-conduit (>=2.3.7 && <2.4), http-types, jose-jwt (>=0.8.0 && <0.10.0), load-env (>=0.2.1 && <0.3), lti13 (==0.3.0.0), microlens (>=0.4.11 && <0.5), oidc-client (>=0.7 && <0.8), text (>=1.2.4 && <1.3 || >=2.0 && <2.1), time (>=1.0.0 && <1.13), unliftio, warp (>=3.3.13 && <3.4), yesod (>=1.6.1 && <1.7), yesod-auth (>=1.6.10 && <1.7), yesod-auth-lti13, yesod-core (>=1.6.18 && <1.7) [details]
Tested with ghc ==8.10.7 || ==9.2.5 || ==9.4.3
License LGPL-3.0-only
Author Jade Lovelace
Maintainer Jade Lovelace <software at lfcode dot ca>
Category Web, Yesod
Home page https://github.com/lf-/lti13#readme
Bug tracker https://github.com/lf-/lti13/issues
Source repo head: git clone https://github.com/lf-/lti13
Uploaded by jade at 2022-11-24T07:46:38Z
Distributions
Executables yesod-lti13-example
Downloads 1296 total (23 in the last 30 days)
Rating (no votes yet) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Docs available [build log]
Last success reported on 2022-11-24 [all 1 reports]

Readme for yesod-auth-lti13-0.3.0.0

[back to package description]

yesod-auth-lti13

A lti13 based authentication provider for Yesod.

Usage

Implement an instance YesodAuthLTI13 App for your Yesod site, using your persistence mechanisms. See the example for details.

To build the example, pass -f example with your cabal commands. You can also cabal configure -f example to make it apply to commands by default (and also enable it for haskell-language-server).

A sample configuration of the LTI 1.3 reference implementation for a site using this library is available here: https://lti-ri.imsglobal.org/platforms/1812/

If this link breaks in the future, see the documentation at ../referencetool in the repo on how to create a new one.

The following configuration is used on the provider (LMS) side, assuming your AuthR is /auth:

  • oidc_initiation_url: https://YOURAPPROOT/auth/page/lti13/initiate
  • target_link_uri: https://YOURAPPROOT
  • Public JWK URL: https://YOURAPPROOT/auth/page/lti13/jwks
  • Redirect URLs: https://YOURAPPROOT/auth/page/lti13/authenticate