-
Notifications
You must be signed in to change notification settings - Fork 301
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Development: Adapt LTI advantage deep linking service for exercise se…
…lection from Moodle (#7425)
- Loading branch information
1 parent
a85d19d
commit e43999e
Showing
31 changed files
with
1,796 additions
and
99 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
229 changes: 229 additions & 0 deletions
229
src/main/java/de/tum/in/www1/artemis/domain/lti/Lti13DeepLinkingResponse.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,229 @@ | ||
| package de.tum.in.www1.artemis.domain.lti; | ||
|
|
||
| import java.util.HashMap; | ||
| import java.util.Map; | ||
|
|
||
| import org.springframework.security.oauth2.core.oidc.OidcIdToken; | ||
|
|
||
| import com.fasterxml.jackson.annotation.JsonProperty; | ||
| import com.google.gson.JsonObject; | ||
| import com.google.gson.JsonParser; | ||
|
|
||
| /** | ||
| * Represents the LTI 1.3 Deep Linking Response. | ||
| * It encapsulates the necessary information to construct a valid deep linking response | ||
| * according to the LTI 1.3 specification. | ||
| */ | ||
| public class Lti13DeepLinkingResponse { | ||
|
|
||
| @JsonProperty("aud") | ||
| private String aud; | ||
|
|
||
| @JsonProperty("iss") | ||
| private String iss; | ||
|
|
||
| @JsonProperty("exp") | ||
| private String exp; | ||
|
|
||
| @JsonProperty("iat") | ||
| private String iat; | ||
|
|
||
| @JsonProperty("nonce") | ||
| private String nonce; | ||
|
|
||
| @JsonProperty(Claims.MSG) | ||
| private String message; | ||
|
|
||
| @JsonProperty(Claims.LTI_DEPLOYMENT_ID) | ||
| private String deploymentId; | ||
|
|
||
| @JsonProperty(Claims.MESSAGE_TYPE) | ||
| private String messageType; | ||
|
|
||
| @JsonProperty(Claims.LTI_VERSION) | ||
| private String ltiVersion; | ||
|
|
||
| @JsonProperty(Claims.CONTENT_ITEMS) | ||
| private String contentItems; | ||
|
|
||
| private JsonObject deepLinkingSettings; | ||
|
|
||
| private String clientRegistrationId; | ||
|
|
||
| private String returnUrl; | ||
|
|
||
| /** | ||
| * Constructs an Lti13DeepLinkingResponse from an OIDC ID token and client registration ID. | ||
| * | ||
| * @param ltiIdToken the OIDC ID token | ||
| * @param clientRegistrationId the client registration ID | ||
| */ | ||
| public Lti13DeepLinkingResponse(OidcIdToken ltiIdToken, String clientRegistrationId) { | ||
| validateClaims(ltiIdToken); | ||
|
|
||
| this.deepLinkingSettings = JsonParser.parseString(ltiIdToken.getClaim(Claims.DEEP_LINKING_SETTINGS).toString()).getAsJsonObject(); | ||
| this.setReturnUrl(this.deepLinkingSettings.get("deep_link_return_url").getAsString()); | ||
| this.clientRegistrationId = clientRegistrationId; | ||
|
|
||
| this.setAud(ltiIdToken.getClaim("iss").toString()); | ||
| this.setIss(ltiIdToken.getClaim("aud").toString().replace("[", "").replace("]", "")); | ||
| this.setExp(ltiIdToken.getClaim("exp").toString()); | ||
| this.setIat(ltiIdToken.getClaim("iat").toString()); | ||
| this.setNonce(ltiIdToken.getClaim("nonce").toString()); | ||
| this.setMessage("Content successfully linked"); | ||
| this.setDeploymentId(ltiIdToken.getClaim(Claims.LTI_DEPLOYMENT_ID).toString()); | ||
| this.setMessageType("LtiDeepLinkingResponse"); | ||
| this.setLtiVersion("1.3.0"); | ||
| } | ||
|
|
||
| /** | ||
| * Retrieves a map of claims to be included in the ID token. | ||
| * | ||
| * @return a map of claims | ||
| */ | ||
| public Map<String, Object> getClaims() { | ||
| Map<String, Object> claims = new HashMap<>(); | ||
|
|
||
| claims.put("aud", aud); | ||
| claims.put("iss", iss); | ||
| claims.put("exp", exp); | ||
| claims.put("iat", iat); | ||
| claims.put("nonce", nonce); | ||
| claims.put(Claims.MSG, message); | ||
| claims.put(Claims.LTI_DEPLOYMENT_ID, deploymentId); | ||
| claims.put(Claims.MESSAGE_TYPE, messageType); | ||
| claims.put(Claims.LTI_VERSION, ltiVersion); | ||
| claims.put(Claims.CONTENT_ITEMS, contentItems); | ||
|
|
||
| return claims; | ||
| } | ||
|
|
||
| private void validateClaims(OidcIdToken ltiIdToken) { | ||
| if (ltiIdToken == null) { | ||
| throw new IllegalArgumentException("The OIDC ID token must not be null."); | ||
| } | ||
|
|
||
| Object deepLinkingSettingsElement = ltiIdToken.getClaim(Claims.DEEP_LINKING_SETTINGS); | ||
| if (deepLinkingSettingsElement == null) { | ||
| throw new IllegalArgumentException("Missing or invalid deep linking settings in ID token."); | ||
| } | ||
|
|
||
| ensureClaimPresent(ltiIdToken, "iss"); | ||
| ensureClaimPresent(ltiIdToken, "aud"); | ||
| ensureClaimPresent(ltiIdToken, "exp"); | ||
| ensureClaimPresent(ltiIdToken, "iat"); | ||
| ensureClaimPresent(ltiIdToken, "nonce"); | ||
| ensureClaimPresent(ltiIdToken, Claims.LTI_DEPLOYMENT_ID); | ||
| } | ||
|
|
||
| private void ensureClaimPresent(OidcIdToken ltiIdToken, String claimName) { | ||
| Object claimValue = ltiIdToken.getClaim(claimName); | ||
| if (claimValue == null) { | ||
| throw new IllegalArgumentException("Missing claim: " + claimName); | ||
| } | ||
| } | ||
|
|
||
| public void setAud(String aud) { | ||
| this.aud = aud; | ||
| } | ||
|
|
||
| public String getIss() { | ||
| return iss; | ||
| } | ||
|
|
||
| public void setIss(String iss) { | ||
| this.iss = iss; | ||
| } | ||
|
|
||
| public String getExp() { | ||
| return exp; | ||
| } | ||
|
|
||
| public void setExp(String exp) { | ||
| this.exp = exp; | ||
| } | ||
|
|
||
| public String getIat() { | ||
| return iat; | ||
| } | ||
|
|
||
| public void setIat(String iat) { | ||
| this.iat = iat; | ||
| } | ||
|
|
||
| public String getNonce() { | ||
| return nonce; | ||
| } | ||
|
|
||
| public void setNonce(String nonce) { | ||
| this.nonce = nonce; | ||
| } | ||
|
|
||
| public String getMessage() { | ||
| return message; | ||
| } | ||
|
|
||
| public void setMessage(String message) { | ||
| this.message = message; | ||
| } | ||
|
|
||
| public String getDeploymentId() { | ||
| return deploymentId; | ||
| } | ||
|
|
||
| public void setDeploymentId(String deploymentId) { | ||
| this.deploymentId = deploymentId; | ||
| } | ||
|
|
||
| public String getMessageType() { | ||
| return messageType; | ||
| } | ||
|
|
||
| public void setMessageType(String messageType) { | ||
| this.messageType = messageType; | ||
| } | ||
|
|
||
| public String getLtiVersion() { | ||
| return ltiVersion; | ||
| } | ||
|
|
||
| public void setLtiVersion(String ltiVersion) { | ||
| this.ltiVersion = ltiVersion; | ||
| } | ||
|
|
||
| public String getContentItems() { | ||
| return contentItems; | ||
| } | ||
|
|
||
| public void setContentItems(String contentItems) { | ||
| this.contentItems = contentItems; | ||
| } | ||
|
|
||
| public JsonObject getDeepLinkingSettings() { | ||
| return deepLinkingSettings; | ||
| } | ||
|
|
||
| public void setDeepLinkingSettings(JsonObject deepLinkingSettings) { | ||
| this.deepLinkingSettings = deepLinkingSettings; | ||
| } | ||
|
|
||
| public String getClientRegistrationId() { | ||
| return clientRegistrationId; | ||
| } | ||
|
|
||
| public void setClientRegistrationId(String clientRegistrationId) { | ||
| this.clientRegistrationId = clientRegistrationId; | ||
| } | ||
|
|
||
| public String getAud() { | ||
| return aud; | ||
| } | ||
|
|
||
| public String getReturnUrl() { | ||
| return returnUrl; | ||
| } | ||
|
|
||
| public void setReturnUrl(String returnUrl) { | ||
| this.returnUrl = returnUrl; | ||
| } | ||
| } |
11 changes: 11 additions & 0 deletions
11
src/main/java/de/tum/in/www1/artemis/domain/lti/LtiAuthenticationResponseDTO.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| package de.tum.in.www1.artemis.domain.lti; | ||
|
|
||
| /** | ||
| * Holds LTI authentication response details. | ||
| * | ||
| * @param targetLinkUri URI targeted in the LTI process. | ||
| * @param ltiIdToken LTI service provided ID token. | ||
| * @param clientRegistrationId Client's registration ID with LTI service. | ||
| */ | ||
| public record LtiAuthenticationResponseDTO(String targetLinkUri, String ltiIdToken, String clientRegistrationId) { | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.