Spring Boot LTI Advantage JKWS library

JKWS library for LTI Advantage Spring Boot projects. Adds a public keyset URI to your LTI Advantege application See https://github.com/UOC/java-lti-1.3-provider-example for an example.

Usage

1. Set your maven installation to work with Github packages, following https://help.github.com/en/packages/using-github-packages-with-your-projects-ecosystem/configuring-apache-maven-for-use-with-github-packages#authenticating-to-github-packages

Repository info:

  <repositories>
    <repository>
      <id>github-uoc-lti-core</id>
      <name>GitHub UOC Apache Maven Packages</name>
      <url>https://maven.pkg.github.com/uoc/java-lti-1.3-core</url>
    </repository>				
    <repository>
      <id>github-uoc-lti-jwt</id>
      <name>GitHub UOC Apache Maven Packages</name>
      <url>https://maven.pkg.github.com/uoc/java-lti-1.3-jwt</url>
    </repository>				
    <repository>
      <id>github-uoc-lti</id>
      <name>GitHub UOC Apache Maven Packages</name>
      <url>https://maven.pkg.github.com/uoc/java-lti-1.3</url>
    </repository>				
    <repository>
      <id>github-uoc-lti-springboot</id>
      <name>GitHub UOC Apache Maven Packages</name>
      <url>https://maven.pkg.github.com/uoc/spring-boot-lti-advantage</url>
    </repository>
  </repositories>

2. Add the dependency to your pom.xml file:

  <dependency>
	<groupId>edu.uoc.elc.lti</groupId>
	<artifactId>spring-boot-lti-advantage-jkws</artifactId>
	<version>1.0.0</version>
  </dependency>

Installation

This library depends on the following additional libraries:

• LTI 1.3 JWT
• Springboot LTI Advantage

Install it using maven:

./mvnw install

About

This library makes essentially two things: Define a controller for serving Keys to a LTI platform and provide service implementations.

Controller

The Controller is defined in edu.uoc.elc.spring.lti.jkws.WellKnowKeysController, and depens on edu.uoc.elc.spring.lti.tool.registration.RegistrationService (defined in Springboot LTI Advantage)for getting the keys

Configuration

edu.uoc.elc.spring.lti.jkws.WellKnowKeysController defines its path via the jkws.wellkownuri property. So, defining this property in your application.yaml or application.properties will work. If not present, the default path is /.well-known/jwks.json.

Take into account that you'll need to scan the package in your application for setting into spring mvc. This is done via adding to you Application:

@ComponentScan({"edu.uoc.elc.spring.lti.jkws"})

Service implementations

Springboot LTI Advantage define three services for managing signed requests: edu.uoc.elc.spring.lti.tool.builders.ClaimAccessorService (for accessing JWT claims in LTIResourceLaunch), edu.uoc.elc.spring.lti.tool.builders.DeepLinkingTokenBuilderService (for creating DeepLinking request to the platform) and edu.uoc.elc.spring.lti.tool.builders.ClientCredentialsTokenBuilderService (for creating access token request to the platform). This library provide implementations for all three services using JWKS.

• edu.uoc.elc.spring.lti.tool.builders.JWSClaimAccessorService
• edu.uoc.elc.spring.lti.tool.builders.JWSDeepLinkingTokenBuilderService
• edu.uoc.elc.spring.lti.tool.builders.JWSClientCredentialsTokenBuilderService

Configuration

Take into account that you'll need to scan the package in your application for setting into spring. This is done via adding to you Application:

@ComponentScan({"edu.uoc.elc.spring.lti.tool.builders"})

Contributing

Thanks for being interested in this project. The way of contributing is the common for almost all projects:

1. Fork the project to your account
2. Implement your changes
3. Make a pull request

If you need further information contact to xaracil at uoc dot edu