HackBox Console

Note

Comes with support for:

• Microsoft WhatTheHack - Integration Guide
• Microsoft MicroHack - Integration Guide

A portal for Hackathon participants to access challenges and credentials.

A portal for Hackathon coaches to access challenges, solutions, credentials and unlock challenges for participants.

The HackBox Console also supports multitenancy (multiple teams with a single coach each) and can be integrated with other tools, that take care of the sandbox environment provisioning.

Solutions and challenges are stored in markdown files.

• challanges should follow the format: challenge-*.md, f.e. challenge-1.md, challenge-2.md, ...
• solutions should follow the format: solution-*.md, f.e. solution-1.md, solution-2.md, ...

Thanks to zero-md the markdown files are rendered as HTML with a broad support for markdown syntax:

• Math rendering via KaTeX
• Mermaid diagrams
• Syntax highlighting via highlight.js
• Language detection for un-hinted code blocks
• Hash-link scroll handling
• FOUC prevention
• Auto re-render on input changes
• Light and dark themes
• Spec-compliant extensibility

How to build & Deploy

Have a directory containing the challenges. It will walk through the directory (including subdirectories) and look for files named *challenge*.md. Have a directory containing the solutions. It will walk through the directory (including subdirectories) and look for files named *solution*.md.

Deploy the console with the markdown files from the ContosoHotelOpenHack repository Either run for a single tenant (one team, one coach)

# for single tenant run:
.\iac\deployHackerConsole.ps1 `
    -SourceChallengesDir ..\ContosoHotelOpenHack\challenges\ `
    -SourceSolutionsDir ..\ContosoHotelOpenHack\solutions\ `
    -hackerUsername "hacker" `
    -hackerPassword ("hacker" | ConvertTo-SecureString -AsPlainText -Force) `
    -coachUsername "coach" `
    -coachPassword ("coach" | ConvertTo-SecureString -AsPlainText -Force)

Or run for multiple tenants (multiple teams with one coach each)

# for multi tenant create the users.json first
.\iac\createUsers.ps1 -numberOfTenants 3 -baseHackerUsername "hacker" -baseCoachUsername "coach"
# for multi tenant run:
.\iac\deployHackerConsole.ps1 `
    -SourceChallengesDir ..\ContosoHotelOpenHack\challenges\ `
    -SourceSolutionsDir ..\ContosoHotelOpenHack\solutions\

Publish additional credentials to the storage account in this example the name of the credential is Example Password with the (secret) value DontTellAnyone

.\iac\addCredential.ps1 `
    -storageAccountName "storage...." `
    -name "Example Password" `
    -value "DontTellAnyone"
# for multi tenant please also add: -tenant "team1"

In addtion, you can also add multiple credentials from a json or csv file:

# for csv with required columns: name, value   (optional columns: group, tenant)
Get-Content .\creds.csv | ConvertFrom-Csv | .\iac\addMultipleCredentails.ps1 -storageAccountName "storage...."
# for json array of objects with required attributes: name, value   (optional attributes: group, tenant)
Get-Content .\creds.json | ConvertFrom-Json | .\iac\addMultipleCredentails.ps1 -storageAccountName "storage...." 

users.json - Multi Tenant User Definition

The easiest way to create the users.json file is to use the createUsers.ps1 script.

Alternatively, you can copy the sample-users.json file to users.json and then modify it to fit your needs.

The file has the following structure:

[
    {
        "username": "admin",
        "password": "admin",
        "role": "coach",
        "tenant": "Default"
    }
]

Attribute	Required?	Description
username	required	The username of the user
password	required	The password of the user
role	required	The role of the user: coach: Can see unlocked challenges, solutions and credentials within his tenant. Can unlock challenges for hackers. hacker: Can see only unlocked challenges and credentials within his tenant. techlead: Can start/stop/reset timers and unlock challenges across all tenants. (Just create a techlead, if you have a more than 3 tenants.)
tenant	optional	The tenant the user belongs to (each tenant must have at least one coach and one hacker)