Moodle configuration

• Tool URL: http://app.host.lti:5000/launch
• LTI version: 1.3
• Public key type: Keyset URL
• Public key URL: http://app.host.lti:5000/jwks
• Initiate login URL: http://app.host.lti:5000/login
• Redirect URI(s):
  • http://app.host.lti:5000/launch
  • http://app.host.lti:5000/submissions

Run app:

flask run --debugger --debug --reload --host=0.0.0.0

4.3 -> En curso, en la administración -> más -> Herramientas externas LTI

extensiones / autentificación / Gestionar la autentificación -> habilitar LTI

extensiones / Módulos de Actividad / Gestionar actividades? extensiones / Módulos de Actividad / Herramienta externa?

Developer notes

python -m venv .venv pip install flask psycopg2-binary pip install debugpy python-dotenv

You can decode the token from the request with https://developer.pingidentity.com/en/tools/jwt-decoder.html

Alembic

alembic init migrations alembic revision --autogenerate -m "Create submissions table" alembic upgrade head

Build and run the container in production

You can build the container with the following command:

./build.sh

To run the container, you need to set the following environment variables:

• FLASK_ENV: production or development, defaults to production
• FLASK_SECRET_KEY: secret key for the Flask app. It will initialize to a random value if not set.
• DB_USER, DB_PASSWORD: database credentials
• DB_HOST: database host, from the viewpoint of the app container. You can add the database host using the --add-host option when running the container.
• DB_PORT: database port, defaults to 5432
• DB_NAME: database name
• CORRECTOMATIC_API_SERVER: URL of the correctomatic API server from the viewpoint of the app container
• CALLBACK_HOST: host and port of this app from the correctomatic viewpoint. You will probably need to set this to http://host.docker.internal:5000 when running the app in a container.
• UPLOAD_FOLDER: folder where uploaded files are stored. Correctomatic doesn't need access to this folder (it makes a copy of the file), so you can set it to any value.

TODO: obsolete, it's in the DB now You will also need to mount the LTI configuration directory, with the correctomatic.json LTI configuration files and the private and public keys. Take in mind that the paths in the configuration file should be from the viewpoint of the app container. TODO: obsolete, it's in the DB now

Example of running the container:

docker run --rm --name correctomatic-app \
    -e DB_USER=correctomatic \
    -e DB_PASSWORD=correctomatic \
    -e DB_HOST=host.docker.internal \
    -e DB_PORT=5432 \
    -e DB_NAME=correctomatic \
    -e CORRECTOMATIC_API_SERVER=http://host.docker.internal:8080 \
    -e CALLBACK_HOST=http://host.docker.internal:5000 \
    -e UPLOAD_FOLDER=/uploads \
    -e LTI_CONFIG_DIR=/lti_config \
    -v /path/to/uploads:/uploads \
    -v /path/to/lti_config_dir:/lti_config \
    -p 5000:5000 \
    --add-host=host.docker.internal:host-gateway \
    correctomatic/app

Run the app in development mode

Very important: listen on all hosts, so correctomatic notifier can access this app:

flask run --debugger --reload --host=0.0.0.0

• .env contents are loaded automatically by Flask when the app is run in development mode.
• You can open a shell with the app context by running flask shell.

Interesant things to check:

• Custom commands

flask shell

from app import create_app
app = create_app()
app.url_map

Super Interesting: https://pypi.org/project/PyLTI1p3/

The fields in an LTI 1.3 launch request contain various pieces of information required for the successful launching of an LTI-compliant tool from a Learning Management System (LMS). Here's an explanation of each field in the given JSON object:

1. nonce: A unique value to ensure that the request is not a replay attack. It should be used only once.

2. iat (Issued At): The timestamp indicating when the token was issued, in seconds since the Unix epoch.

3. exp (Expiration): The timestamp indicating when the token will expire, in seconds since the Unix epoch.

4. iss (Issuer): The issuer of the token, which in this case is the LMS (http://moodle.lti).

5. aud (Audience): The intended recipient of the token, typically the client ID of the tool provider (ZHD2HCuDCNrSEkG).

6. https://purl.imsglobal.org/spec/lti/claim/deployment_id: The unique identifier for the deployment within the LMS (2).

7. https://purl.imsglobal.org/spec/lti/claim/target_link_uri: The URL where the tool should be launched (http://app.host.lti:5000/launch).

8. sub: The subject of the token, typically the unique identifier for the user within the LMS (2).

9. https://purl.imsglobal.org/spec/lti/claim/lis: Information related to the Learning Information Services (LIS):

   • person_sourcedid: The sourced identifier for the person (empty in this case).
   • course_section_sourcedid: The sourced identifier for the course section (empty in this case).

10. https://purl.imsglobal.org/spec/lti/claim/roles: The roles of the user within the context of the LMS:

    • http://purl.imsglobal.org/vocab/lis/v2/institution/person#Administrator: Institution-level administrator.
    • http://purl.imsglobal.org/vocab/lis/v2/membership#Instructor: Instructor in the course.
    • http://purl.imsglobal.org/vocab/lis/v2/system/person#Administrator: System-level administrator.

11. https://purl.imsglobal.org/spec/lti/claim/context: Contextual information about the course:

    • id: The unique identifier for the course (2).
    • label: A short label for the course (cursopruebas).
    • title: The full title of the course (Curso de pruebas).
    • type: The type of context (not fully listed here).

12. https://purl.imsglobal.org/spec/lti/claim/resource_link: Information about the resource link being launched:

    • title: The title of the resource link (Prueba LTI).
    • description: A description of the resource link (empty).
    • id: The unique identifier for the resource link (2).

13. https://purl.imsglobal.org/spec/lti-bo/claim/basicoutcome: Information for basic outcomes:

    • lis_result_sourcedid: A unique identifier for the result, including instance ID, user ID, type ID, and launch ID, along with a hash for verification.
    • lis_outcome_service_url: The URL to the service endpoint where outcomes can be reported (http://moodle.lti/mod/lti/service.php).

14. given_name: The given name of the user (Admin).

15. family_name: The family name of the user (Adminsurname).

16. name: The full name of the user (Admin Adminsurname).

17. https://purl.imsglobal.org/spec/lti/claim/ext: Additional information:

    • user_username: The username of the user (admin).
    • lms: The LMS name and version (moodle-2).

18. email: The email address of the user (spam1@gammu.com).

19. https://purl.imsglobal.org/spec/lti/claim/launch_presentation: Presentation information for the launch:

    • locale: The locale of the user (en).
    • document_target: How the content should be displayed (iframe).
    • return_url: The URL to return to after the launch (http://moodle.lti/mod/lti/return.php?course=2&launch_container=3&instanceid=2&sesskey=jXyERUUMWo).

20. https://purl.imsglobal.org/spec/lti/claim/tool_platform: Information about the tool platform:

    • product_family_code: The product family code of the LMS (moodle).
    • version: The version of the LMS (2021051718).
    • guid: A unique identifier for the platform instance (moodle.lti).
    • name: The name of the platform (cursodepruebas).
    • description: A description of the platform (Curso de pruebas).

21. https://purl.imsglobal.org/spec/lti/claim/version: The version of the LTI specification being used (1.3.0).

22. https://purl.imsglobal.org/spec/lti/claim/message_type: The type of LTI message (LtiResourceLinkRequest).

These fields collectively provide the necessary context, user information, and security details required for an LTI tool to process the launch request and present the appropriate content to the user.

JS Tool

https://github.com/Godmartinz/Node-LTI-1.3-library https://cvmcosta.me/ltijs/#/ https://github.com/SanDiegoCodeSchool/lti-node-example

LTI configuration

.venv/lib/python3.10/site-packages/pylti1p3/tool_config/init.py .venv/lib/python3.10/site-packages/pylti1p3/tool_config/dict.py

It can be configured with a dictionary:

# .venv/lib/python3.10/site-packages/pylti1p3/tool_config/dict.py
"""
json_data is a dict where each key is issuer and value is issuer's configuration.
Configuration could be set in two formats:

1. { ... "iss": { ... "client_id: "client" ... }, ... }
In this case the library will work in the concept: one issuer ~ one client-id

2. { ... "iss": [ { ... "client_id: "client1" ... }, { ... "client_id: "client2" ... } ], ... }
In this case the library will work in concept: one issuer ~ many client-ids

Example:
    {
        "iss1": [{
                "default": True,
                "client_id": "client_id1",
                "auth_login_url": "auth_login_url1",
                "auth_token_url": "auth_token_url1",
                "auth_audience": None,
                "key_set_url": "key_set_url1",
                "key_set": None,
                "deployment_ids": ["deployment_id1", "deployment_id2"]
            }, {
                "default": False,
                "client_id": "client_id2",
                "auth_login_url": "auth_login_url2",
                "auth_token_url": "auth_token_url2",
                "auth_audience": None,
                "key_set_url": "key_set_url2",
                "key_set": None,
                "deployment_ids": ["deployment_id3", "deployment_id4"]
            }],
        "iss2": [ .... ]
    }

default (bool) - this iss config will be used in case if client-id was not passed on the login step
client_id - this is the id received in the 'aud' during a launch
auth_login_url - the platform's OIDC login endpoint
auth_token_url - the platform's service authorization endpoint
auth_audience - the platform's OAuth2 Audience (aud). Is used to get platform's access token,
                Usually the same as "auth_token_url" but in the common case could be a different url
key_set_url - the platform's JWKS endpoint
key_set - in case if platform's JWKS endpoint somehow unavailable you may paste JWKS here
deployment_ids (list) - The deployment_id passed by the platform during launch
"""

Passing parameters

192.168.3.5 - - [20/Sep/2024 06:50:34] "POST /login HTTP/1.1" 200 -

192.168.3.5 - - [20/Sep/2024 06:50:45] "GET /login?lti1p3_new_window=1&iss=http://moodle.lti&login_hint=2&target_link_uri=http://app.host.lti:5000/launch&lti_message_hint={"cmid":2,"launchid":"ltilaunch1_1110149175"}&lti_deployment_id=1&client_id=VeDBJjVL0qiEB6z HTTP/1.1" 302 -

192.168.3.5 - - [20/Sep/2024 06:50:45] "POST /launch HTTP/1.1" 302 -

192.168.3.5 - - [20/Sep/2024 06:50:45] "GET /submissions HTTP/1.1" 200 -

192.168.3.5 - - [20/Sep/2024 06:50:45] "GET /login?lti1p3_new_window=1&iss=http://moodle.lti&login_hint=2&target_link_uri=http://app.host.lti:5000/launch&lti_message_hint={"cmid":2,"launchid":"ltilaunch1_1110149175"}&lti_deployment_id=1&client_id=VeDBJjVL0qiEB6z HTTP/1.1" 302 -

---

[2024-09-20 06:53:41,744] INFO in init: Request ID: 56ff0f54-caec-4b9a-a80d-c7b252af9407 finished 192.168.3.5 - - [20/Sep/2024 06:53:41] "POST /launch HTTP/1.1" 302 - [2024-09-20 06:53:41,754] INFO in init: Request ID: 3f816d6f-bd7b-4763-b973-d8cc087e39f1 - GET /submissions [2024-09-20 06:53:41,756] DEBUG in submissions: launch_id in submissions: lti1p3-launch-36c0a55b-03e4-4ca4-a0b8-ad1b2daaaf49 [2024-09-20 06:53:41,757] DEBUG in submissions: {'aud': 'VeDBJjVL0qiEB6z', 'exp': 1726808081, 'https://purl.imsglobal.org/spec/lti/claim/context': {'id': '2', 'label': 'pruebas1', 'title': 'Pruebas 1', 'type': ['CourseSection']}, 'https://purl.imsglobal.org/spec/lti/claim/custom': {'patata': '********************************'}, 'https://purl.imsglobal.org/spec/lti/claim/deployment_id': '1', 'https://purl.imsglobal.org/spec/lti/claim/ext': {'lms': 'moodle-2'}, 'https://purl.imsglobal.org/spec/lti/claim/launch_presentation': {'document_target': 'iframe', 'locale': 'es', 'return_url': 'http://moodle.lti/mod/lti/return.php?course=2&launch_container=3&instanceid=1&sesskey=06TF8Rsa8c'}, 'https://purl.imsglobal.org/spec/lti/claim/lis': {'course_section_sourcedid': '', 'person_sourcedid': ''}, 'https://purl.imsglobal.org/spec/lti/claim/message_type': 'LtiResourceLinkRequest', 'https://purl.imsglobal.org/spec/lti/claim/resource_link': {'description': '', 'id': '1', 'title': 'local - 1'}, 'https://purl.imsglobal.org/spec/lti/claim/roles': ['http://purl.imsglobal.org/vocab/lis/v2/institution/person#Administrator', 'http://purl.imsglobal.org/vocab/lis/v2/membership#Instructor', 'http://purl.imsglobal.org/vocab/lis/v2/system/person#Administrator'], 'https://purl.imsglobal.org/spec/lti/claim/target_link_uri': 'http://app.host.lti:5000/launch', 'https://purl.imsglobal.org/spec/lti/claim/tool_platform': {'description': 'Moodle de pruebas LTI', 'guid': 'moodle.lti', 'name': 'moodle-lti', 'product_family_code': 'moodle', 'version': '2023100904'}, 'https://purl.imsglobal.org/spec/lti/claim/version': '1.3.0', 'iat': 1726808021, 'iss': 'http://moodle.lti', 'nonce': '2084cf776e2f44ffaa878d7b855e8f8c4ec4d9b2770c11ef9b2757c1532c3e24', 'sub': '2'} [2024-09-20 06:53:41,761] INFO in init: Request ID: 3f816d6f-bd7b-4763-b973-d8cc087e39f1 finished

Aquí están los parámetros personalizados, dentro de launch data: https://purl.imsglobal.org/spec/lti/claim/custom