Skip to content

Configuring LTI Integration in Canvas

Overview

This guide will show you how to connect Canvas to the Cyber Range. Connecting to Canvas will allow your students to use the Cyber Range without leaving their Canvas window. When connected, all of your students in Canvas will be imported into the Cyber Range.

The Cyber Range uses LTI 1.3 to integrate into this service, so any Learning Management System such as Blackboard, that supports this standard should be compatible with the Cyber Range.

There are three sequential steps required to complete this integration and each will require a specific permission level:

  1. Setting up Canvas requires the Canvas administrator role.
  2. Setting up the Cyber Range requires the Cyber Range Organization Admin role.
  3. Linking Canvas to the Cyber Range requires the Canvas Teacher and Cyber Range Instructor roles.

1. Setting up Canvas

This section will require administrator permissions in Canvas to complete. For additional details on LTI 1.3 integration, we recommend checking out Instructure's documentation on configuring LTI 1.3.

Create a new LTI key

  1. Log into your administrator account in Canvas and navigate to Admin > Site Admin > Developer Keys
  2. On this page, click on "+ Developer Key" on the right side and select "+ LTI Key" To add an LTI key, you will need to be in the Account tab of the Developer Keys page.
  3. This will open a menu where you can configure the new LTI key. You can name it something memorable (i.e. Cyber Range) and enter the following information: You can choose any Title or Description for the LTI key. In this demo, we use "Cyber Range" for the title and "The Cyber Range Tool" as the description.
    • Redirect URIs: https://authentication.console.virginiacyberrange.net/v1/lti/redirect
    • Target Link URI: https://authentication.console.virginiacyberrange.net/v1/lti/target
    • OpenID Connect Initial URI: https://authentication.console.virginiacyberrange.net/v1/lti/initiation
    • JWK Method: Public JWK URL
    • Public JWK URL: https://authentication.console.virginiacyberrange.net/v1/jwks
    • LTI Advantage Services: In the list of options, enable "Can retrieve user data associated with the context the tool is installed in." This will allow users to be synced between Canvas and the Cyber Range. "Can retrieve user data associated with the context the tool is installed in." is the fifth option in the list of LTI advantage toggles.
    • Additional Settings: In the list of fields, we recommend that "Privacy Level" is set to "Public". This will allow Canvas users' names and emails to display properly in the Cyber Range. The "Privacy Level" setting is located below the "Custom Fields" textbox. The setting provides two options, PUBLIC or PRIVATE.

Retrieve Client ID

  1. Ensure that you see your new LTI key on the Admin > Site Admin > Developer Keys page. The State of the key should be set to ON if it is not already.
  2. In the Details column, you will see a long number that represents the Client ID of that developer key. Take note of this number, as it will be needed in the next step.

Add Cyber Range app to Canvas

  1. In the Canvas course that you want to add the Cyber Range app to, navigate to Settings > Apps
  2. Click on the "+ Apps" button
  3. Set the Configuration Type to "By Client ID" then paste your Development Key's Client ID into the second text box. Click Submit complete the app creation.

Retrieve Deployment ID

  1. Within the same Apps tab, click on the gear icon to the right of your new Cyber Range app.
  2. Select "Deployment Id" to view the Deployment ID.
  3. Take note of this deployment ID and save it for later. We will need this to connect the Cyber Range to Canvas.

2. Setting up the Cyber Range

This step will require organization admin permissions in the Virginia Cyber Range. Instructors should Contact Support with the following information to set up the LTI integration in the Cyber Range:

  • Name of your school or school district that administrates your Canvas instance.
  • Your school's Canvas domain (i.e. canvas.your-school.edu).
  • Client ID provided by your Canvas admin. Please see the section titled Retrieve Client ID for more information.
  • Deployment ID provided your by Canvas admin. Please see the section titled Retrieve Deployment ID for more information.

3. Linking Canvas to the Cyber Range

As long as the preparations defined above have been completed, this step can be done by anyone who is assigned as the instructor of a course in the Cyber Range.

Create a Course

If you don't already have a course in the Cyber Range, you should create one now. Please see the article titled Getting an Instructor Account and Creating Your First Course for more information. Make sure that you are designated as the instructor of the course before trying to complete the connection.

Log into your Cyber Range Account in Canvas

  1. In your Canvas course, you should see the app you created earlier along the left navigation pane. Click on the app you created. Our sample app was called "Cyber Range-DEV".
  2. If the connection was successful, you should now see a prompt to login using the authentication provider of your choice. Choose the login option that corresponds to your Cyber Range instructor account. Your options for authentication are Google, Facebook, and Azure AD

Choose a Cyber Range Course for Integration

  1. After logging in, you will be presented with a drop-down box that includes all of your Cyber Range courses. Select the course you want to link.
  2. Click "CONFIRM" and wait for the courses to be linked. The "Course" dropdown box contains any courses you are an instructor for.
  3. Once it has finished the linking process, you will see the Cyber Range UI integrated into your Canvas window. The entire Cyber Range UI will be embedded directly into the Canvas UI.

Have a Question? Contact Support

We're here to help you. If you still have questions after reviewing the information above, please feel free to submit a ticket with our support team and we'll get back to you as soon as possible.