- Oct 17, 2022
-
-
michaelroytman authored
This commit fixes a bug in the way we determine where to send the authentication response - the LTI 1.3 launch message - as part of an LTI 1.3 launch. According to the 1EdTech Security Framework 1.0, during an LTI 1.3 launch, "the authentication response is sent to the redirect_uri." The redirect_uri is a query or form parameter provided by the tool when it directs the browser to make a request to the Platform's authentication endpoint. However, we currently send the authentication response to the preregistered launch URL - lti_1p3_launch_url in the LtiConsumerXBlock or the LtiConfiguration model. The difference is subtle, but it is important, because the specification indicates the Platform should respect the redirect_uri provided by the Tool, assuming it is a valid redirect_uri. During the pregistration phase, "the Tool must provide one or multiple redirect URIs that are valid end points where the authorization response can be sent. The number of distinct redirect URIs to be supported by a platform is not specified." Currently, we do not support multiple redirect URIs, so the change is not immediately impactful. However, we should follow the specification and ensure that we return the authentication response to the correct URL.
-
michaelroytman authored
This commit fixes a bug caused by the X-Frame-Options response header. The X-Frame-Options response header indicates to the browser whether a site's content can be loaded within certain tags, including the <iframe> tag. This is a form of clickjacking protection. In Django, this response header is set by the django.middleware.clickjacking.XFrameOptionsMiddleware middleware. In the edx-platform, by default, X-Frame-Options is set to DENY (see the X_FRAME_OPTIONS Django setting), which means that the response content returned by Django views cannot be loaded within certain tags. However, this behavior can be disabled by decorating views with the django.views.decorators.clickjacking.xframe_options_exempt view decorator. This creates a problem for LTI 1.3 lauches in the edx-platform. When an LTI component is loaded, the LtiConsumerXBlock is loaded via the lms.djangoapps.courseware.views.views.render_xblock_view view. This view is called an <iframe> tag, but the view is decorated by the xfame_options_exempt decorator, which disables clickjacking protection and communicates to the browser that the content can be loaded in the <iframe> tag. Once the third-party login request of the LTI 1.3 launch is completed, the LTI tool directs the browser to make a request to the launch_gate_endpoint. This endpoint returns a response, which is an auto-submitting form that makes a POST request - the LTI launch request - to the tool. This view has clickjacking enabled, so the browser blocks the requests, which prevents the launch from occurring. This commit adds the xframe_options_exempt view decorator to the launch_gate_endpoint view. Note that LTI 1.1 does not have this bug, because the LTI launch request is handled via the lti_launch_handler. The XBlock runtime handles requests to the LTI handlers via the openedx.core.djangoapps.xblock.rest_api.views.xblock_handler view, which is also decorated by the xframe_options_exempt view decorator.
-
- Oct 13, 2022
-
-
michaelroytman authored
Purpose ------- The purpose of these changes is to decouple the LTI 1.3 launch from the LtiConsumerXBlock. It is in accordance with the ADR "0007 Decouple LTI 1.3 Launch from XBlock and edX Platform", which is currently under review. The pull request for the ADR is here: https://github.com/openedx/xblock-lti-consumer/pull/281. The general premise of these changes is to shift the responsibility of defining key launch claims to users of the library. Such claims include user ID, user role, resource link ID, etc. Prior to this change, this context was defined directly in the launch view by referencing XBlock fields and functions, thereby tying the LTI 1.3 launch to the XBlock. By shifting the responsibility out of the view, we will be able to genericize the launch and make it functional in more contexts than just the XBlock and the XBlock runtime. In short, the key launch claims are encoded in an instance of a data class Lti1p3LaunchData. Users of the library will instantiate this class with necessary launch data to it and pass the instance to various methods of the Python API to communicate the data to the library. Please see the aforementioned ADR for more details about this decoupling strategy. Note that the majority of these changes affect only the basic LTI 1.3 launch. There have largely been no changes to LTI 1.3 Advantage Services. The one exception is the Deep Linking content launch endpoint. This is because this launch is implemented in the basic LTI 1.3 launch, and it was necessary to make the same changes to the deep linking content launch to ensure that it works properly. Otherwise, LTI 1.3 Advantage Services are out of scope of these changes. Change Summary for Developers ----------------------------- Below is a summary of changes contained in this pull request. * added an Lti1p3LaunchData data class * added caching for Lti1p3LaunchData to limit data sent in request query or form parameters * BREAKING CHANGE: modified Python API methods to take Lti1p3LaunchData as a required argument ** get_lti_1p3_launch_info ** get_lti_1p3_launch_start_url ** get_lti_1p3_content_url * replaced references to LtiConsumerXBlock.location with Lti1p3LaunchData.config_id * removed definition of key LTI 1.3 claims from the launch_gate_endpoint and instantiated Lti1p3LaunchData from within the LtiConsumerXBlock instead * added a required launch_data_key request query parameter to the deep_linking_content_endpoint and refactored associated templates and template tags to pass this parameter in the request to the view Change Summary for Course Staff and Instructors ----------------------------------------------- The only changes relevant for course staff and instructors is that the access token and keyset URLs displayed in Studio have changed in format. The old format was: Access Token URL: https://courses.edx.org/api/lti_consumer/v1/token/block-v1:edX+999+2022Q3+type@lti_consumer+block@714c10a5e4df452da9d058788acb56be Keyset URL: https://courses.edx.org/api/lti_consumer/v1/public_keysets/block-v1:edX+999+2022Q3+type@lti_consumer+block@714c10a5e4df452da9d058788acb56be The new format is: Access Token URL: https://courses.edx.org/api/lti_consumer/v1/token/c3f6af60-dbf2-4f85-8974-4ff870068d43 Keyset URL: https://courses.edx.org/api/lti_consumer/v1/public_keysets/c3f6af60-dbf2-4f85-8974-4ff870068d43 The difference is in the slug at the end of the URL. In the old format, the slug was the UsageKey of the XBlock associated with the LTI integration. In the new format, the slug is the config_id of the LtiConfiguration associated with the LTI integration. This is an iterative step toward decoupling the access_token_endpoint and the public_keyset_endpoint views from the XBlock location field. The XBlock location field appears as the usage_key parameter to both views. We cannot simply remove the usage_key parameter from the views, because existing LTI 1.3 integrations may have been created using the old format, and we need to maintain backwards compatibility. This change, however, prevents new integrations from being created that are coupled to the XBlock. In the future, we may address integrations that use the old format to fully decouple the XBlock from the views. Testing ------- Unit tests were added for all changes. In addition, manual testing was performed using the instructions in the documents listed below. * https://github.com/openedx/xblock-lti-consumer#lti-13 * https://openedx.atlassian.net/wiki/spaces/COMM/pages/1858601008/How+to+run+the+LTI+Validation+test Resources --------- JIRA: MST-1603: https://2u-internal.atlassian.net/browse/MST-1603 BREAKING CHANGE
-
- Oct 03, 2022
-
-
edX requirements bot authored
* chore: Updating Python Requirements * fix: update is_valid arg Co-authored-by:
Alie Langston <alangsto@wellesley.edu>
-
- Aug 22, 2022
-
-
michaelroytman authored
In the LTI 1.1 launch handler, we set the user context, including the user_id. We do this by calling to the LMS's DjangoXBlockUserService to get information about the user. Sometimes, the user is unauthenticated. Sometimes, this is because the user is a web crawler. Other times, the user is a real user, but we do not know why the user is unauthenticated. We have some theories, but we have been unable to confirm them. Regardless, we should not surface a 500 error to the user. This commit adds handling for the LtiError that is raised when a user is unauthenticated during an LTI 1.1 launch. It catches the LtiError and renders an error page. The error page that was used for LTI 1.3 launches, formerly named "lti_1p3_launch_error.html", has been renamed to "lti_launch_error.html" to reflect the fact that it is used for both LTI 1.1 and 1.3 launches. It was modified to remove the reference to the version of LTI used by the XBlock; these details are unnecessary for a learner, and removing them allows us to reuse a single template for both LTI versions.
-
- Aug 17, 2022
-
-
Arunmozhi authored
Move XBlock endpoints to Django models and implement backwards compatible views. Relevant commits: * refactor: move LTI 1.3 access token endpoint to plugin view * refactor: remove the xblock handler and add tests to api view * refactor: move the lti_1p3_launch_callback logic to the django view * feat: adds access token view for backward compatibility * refactor: make launch urls use config_id when block is missing * refactor: remove launch_callback_handler from XBlock
-
- Mar 18, 2022
-
-
Giovanni Cimolin da Silva authored
Signed-off-by:
Giovanni Cimolin da Silva <giovannicimolin@gmail.com>
-
- Jan 18, 2022
-
-
Mohammad Ahtasham ul Hassan authored
-
- Oct 06, 2021
-
-
Jawayria authored
-
- Jul 01, 2021
-
-
Kshitij Sobti authored
refactor: Rename CourseEditLTIFieldsEnabledFlag to CourseAllowPIISharingInLTIFlag and use it for LTI1.3 This commit renames the CourseEditLTIFieldsEnabledFlag to CourseAllowPIISharingInLTIFlag since the aim is to expand its scope to all LTI-related PII sharing. It also removes the current LTI1.3 waffle flag for PII sharing.
-
- Jun 09, 2021
-
-
Giovanni Cimolin da Silva authored
This removes feature flags that were in place for development, but aren't needed in production. * feat: set LTI 1.3 support enabled by default * feat: Improve settings wording * chore: Update translation files * chore: Version bump * quality: Fix pylint errors and improve waffleflag documentation * doc: Add changes to changelog * feat: Remove LTI 1.3 flags and enable services by default * doc: Update NRPS ADR * doc: Fix typo * Update README.rst Co-authored-by:
Ned Batchelder <ned@nedbatchelder.com> * Update README.rst Co-authored-by:
Ned Batchelder <ned@nedbatchelder.com> * Update setup.py Co-authored-by:
Ned Batchelder <ned@nedbatchelder.com> Co-authored-by:
Ned Batchelder <ned@nedbatchelder.com>
-
- Jun 03, 2021
-
-
Shimul Chowdhury authored
This depends on a new API in edx-platform: get_course_members
-
- Apr 13, 2021
-
-
Giovanni Cimolin da Silva authored
This commit re-enables the programmatic grades support on LTI AGS. This allows complex tools to manage grades on their own. The default value keeps the old behavior (declarative mode).
-
- Mar 18, 2021
-
-
Giovanni Cimolin da Silva authored
* Improve content presentation and add multiple content display support This commit: * Improves LTI content presentation handling, and correctly displays LTI DL content in the LMS * Adds support for presenting multiple DL content items on the same block * Addressing review comments * Nits * Improve test and fix issue [BD-24][TNL-8072]
-
- Mar 03, 2021
-
-
Giovanni Cimolin da Silva authored
* Improve logging and error message presentation * Add full deep linking content data on studio * Internationalize LTI 1.3 templates * Add translation tooling Signed-off-by:
Giovanni Cimolin da Silva <giovannicimolin@gmail.com> * Update translations * Address review comments * Additional logging improvements * Address review comments, fix test Signed-off-by:
Giovanni Cimolin da Silva <giovannicimolin@gmail.com>
-
- Feb 16, 2021
-
-
Shimul Chowdhury authored
Fix broken tests Add serializer for `link` content type
-
Shimul Chowdhury authored
-
- Jan 29, 2021
-
-
Giovanni Cimolin da Silva authored
This implements the endpoint that LTI tools use to return the deep linking configuration to the LMS, along with the `ltiResourceLink` type to allow testing with demo tool. Signed-off-by:
Giovanni Cimolin da Silva <giovannicimolin@gmail.com>
-
- Jan 15, 2021
-
-
Kshitij Sobti authored
-
- Nov 12, 2020
-
-
Giovanni Cimolin da Silva authored
* Move LTI 1.3 Key management to model This: - Removes the need to load the modulestore on every public keyset endpoint call. - Simplifies the block structure and parent method overrides. - Removes private key, client id and related parameters from XBlock fields It also includes a migration from the data stored in the block to the model. * Cleanup unused test helpers * Version bump * Addressing review comments
-
- Oct 23, 2020
-
-
Patrick Cockwell authored
* BD-24 Implement LTI AGS Score Publish Service and Results Service * Address PR comments and add more validation * Address PR comments * Add tests; Fix error with scoreMaximum; Fix quality issues; Adjust user_id results url slightly * Add permissions tests and address other PR comments * Fix quality test * Address PR comments
-
- Oct 05, 2020
-
-
Giovanni Cimolin da Silva authored
* Add initial version of LineItem Implementation Signed-off-by:
Giovanni Cimolin da Silva <giovannicimolin@gmail.com> * Adding tests * Add LTI tests and fix quality isses * Quality nit * Add missing requirement, upgrade * Squash migrations * Fix merge conflicts * Addressing review comments
-
- Sep 29, 2020
-
-
Giovanni Cimolin da Silva authored
* Add django url testing support * Add tests to django views, implement compat layer * Addressing review comments * Improve tests and test descriptions * Nit
-
- Sep 04, 2020
-
-
Ned Batchelder authored
-
- Jun 25, 2020
-
-
Giovanni Cimolin da Silva authored
This commit adds support for the LTI 1.3 Access token endpoint, as detailed in the IMS Security Framework. The token is generated using the consumer's private key (stored in the XBlock) after validating the message sent by the LTI Tool using it's public key. Signed-off-by:
Giovanni Cimolin da Silva <giovannicimolin@gmail.com>
-
Giovanni Cimolin da Silva authored
Features: Implement LTI 1.3 launch support. Add LTI 1.3 passthrough views as LMS plugins.
-