🛠 Admin Setup Instructions
Contact HTB to get the Dynamic Registration URL.
Click the + Developer Key button on the top right and choose LTi Registration in the button’s dropdown.
A modal opens that requires an input for the Dynamic Registration URL. In that field, paste the
Dynamic Registration URLshared by your HTB appointed Solutions Engineer.
Adding the provided
Dynamic Registration URLand clicking Continue, you’ll see a modal with all the available settings for the LTi integration with HTB Enterprise Platform, as seen below.
Keep all options checked and select to share All user data with the tool on the respective dropdown. 2nd and 3rd checkboxes enable gradebook for the LTi integration.
Click Enable & Close in the Register App modal to activate the LTi integration with HTB Enterprise Platform.
With this step you have connected your Canvas LMS to the LTi integration with HTB Enterprise Platform. The following steps are needed to make the LTi integration available to your Canvas courses.
In the Developer Keys interface, locate the list entry for the LTi integration with HTB Enterprise Platform. Copy the Numeric value visible in the Details column. This Numeric value is the Client ID of the LTi integration.
After copying the Numeric value, navigate to Settings in Canvas and click on the Apps tab.
Click the +App button to see the Add App modal and choose By Client ID in the Configuration type dropdown. In the displayed Client ID field, paste the numeric value you copied in step 1, and click Submit.
Finally, click Install button in the Add App confirmation modal, to make the LTi integration with HTB Enterprise Platform available to your Teachers for generating courses.
You can disable/enable the LTi integration in your Developer Keys page by switching the State of the App entry.
Seat Assignment
HTB Enterprise Platform works with seat allocation as part of the subscription. So, to setup the LTi integration, you need an HTB Enterprise subscription for your organization that comes with specific seat quota and HTB Content access limitations.
Your subscription and limitations are available in the HTB Enterprise Platform under Manage > Company > Settings, in the Subscriptions tab. At any point, you can Contact the HTB team to upgrade your subscription to increase your seat quota.
Using LTi integration, seats are automatically assigned to the students who engage with HTB Content through a course. Students occupy a seat as long as they have engaged with HTB Content. As long as a student is engaged with HTB Content that is not completed yet and there are seats available, this student will keep the assigned seat.
In the case where all seats available in your HTB Enterprise subscription are occupied by students, you have a few ways to unblock access to students:
Automatically, when a student completes an HTB Content and all seats are occupied, the student is removed from that seat to make it available for another student. Now, if that student chooses to engage with another HTB Content of a course, she is automatically assigned that seat.
Manual, by visiting the HTB Enterprise Platform interface as an administrator and removing a seat for a user in the User Management interface.
Upgrading your subscription by contacting the HTB team to purchase more seats.
👨🏫 Teacher Workflow
Create a new Course in Canvas.
Under Assignments > +Assignment:
Set Submission Type: External Tool
Click Find and choose Hack The Box
A modal will open to let you choose HTB content:
Use filters for difficulty and tier
Select Modules, Machines, Sherlocks, or Challenges
Click Add then Save
Be sure to:
Enable Load in a new tab
Click Select > Save & Publish
Publishing a course
Head over to the Course Home page
Click on the Course Status dropdown and choose Publish
In the Choose Course Home Page modal, select the Assignments list to display all the assigned HTB Enterprise Platform content items added to the course, and click Choose and Publish.
Now your course is available to students as seen below (the course has a single assignment).
📊 Grades Setup
Grading is available for the HTB Enterprise Plaform LTi integration, offering a 100% complete grade for all completed assignments of a course.
In order for grading to be available in your assignment, you need to ensure with your Canvas admin that they have properly setup the Developer Keys settings when adding HTB Enterprise Platform as a Canvas App.
To add grades in an assignment, simply setup the proper fields when editing an Assignment in a Course. Points field is automatically set to 100 by the LTi integration. Make sure that the following options are set for Assignment Group: Assignment, and Display Grade as: Points.
To preview progress in a course you’re assigned as a teacher, visit the course and click Grades in the side menu to see the Gradebook
When in Gradebook, you can see the full points for all completed content for each student. The HTB Enterprise Platform LTi integration supports updates only when courses are fully complete.
Grades are synced only when the student completes the content.
Assigning students to the course
To assign students to your Canvas course, follow the default steps as described in Canvas. In a nutshell:
Visit the course of choice and click the People option from the menu
Click the +People button to see the Add People modal.
Add users using any of the supported methods: Email Address, Login ID, SIS ID.
Please inform students that they have to accept cross-domain cookies.
Setting up accept cross-domain cookies for Chrome.
Setting up in Safari:
Open Safari.
Click on "Safari" in the top left corner of your screen.
Select "Settings" (or "Preferences").
Click on the "Privacy" tab.
Uncheck the box next to "Prevent cross-site tracking".
Uncheck the box next to "Block all cookies”.
Cross-site cookies are enabled by default on Firefox. If you’ve got a problem loading HTB Enterprise Platform content then:
While in Canvas, click the shield icon on the left of the address bar.
At the top of the panel, toggle off the Enhanced Tracking Protection switch. This will disable Enhanced Tracking Protection for the site, causing the page to automatically reload and enable trackers.
Once this is set, the selected HTB Enterprise Platform course will open in a new browser tab.
👩🎓 Student Experience
When a new assignment is published, all students added to that assignment will see a popup informing on new assignment with a button to Acccept the new assignment.
Students entering Canvas can check their assignments through the Home page.
Selecting an assignment that links to an HTB Enterprise course, the student sees an option to open the course in a new window.
In order to take the course, students need to allow cross-domain cookies!
See the following instructions on enabling the option for your browser:
Setting up accept cross-domain cookies for Chrome.
Setting up in Safari:
Open Safari.
Click on "Safari" in the top left corner of your screen.
Select "Settings" (or "Preferences").
Click on the "Privacy" tab.
Uncheck the box next to "Prevent cross-site tracking".
Uncheck the box next to "Block all cookies”.
Cross-site cookies are enabled by default on Firefox. If you’ve got a problem loading HTB Enterprise Platform content then:
While in Canvas, click the shield icon on the left of the address bar.
At the top of the panel, toggle off the Enhanced Tracking Protection switch. This will disable Enhanced Tracking Protection for the site, causing the page to automatically reload and enable trackers.
Once this is set, the selected HTB Enterprise Platform course will open in a new browser tab.
When the student clicks on the button to open the course in a new window, they land on the specific course in the HTB Enterprise Platform.
This page keeps the students focused on the specific course. Some key interface elements to notice:
Option to Connect to HTB on the top left corner of the interface: Some of the courses require connection to a VPN service in order to interact with the course material. Through this option, students can connect to HTB and continue engaging with the content.
Student’s username on the top left, next to Connect to HTB option, displays a random username or the actual username depending on what Canvas was allowed to sync with the HTB Enterprise Platform through the LTi integration.
To check the specifics for each HTB Content type available, follow these links: