CyberRangeCZ Platform

https://docs.platform.cyberrange.cz/
Admin
CyberRangeCZ Platform is an open-source cyber range platform for creating emulated virtual cloud...
Tokens:44,589
Snippets:404
Trust Score:5.5
Update:1 month ago
Show doc for...
Tokens:
Raw
### Start local MkDocs server with pipenv

Source: https://docs.platform.cyberrange.cz/extras/writing-documentation-mkdocs

Run these commands from the docs directory to start the local MkDocs server. Requires python3.8 and pipenv. After starting, access the site at http://localhost:8000.

```bash
pipenv sync
pipenv run mkdocs serve

```

--------------------------------

### Training Event Common Fields Example

Source: https://docs.platform.cyberrange.cz/extras/logging/logs

Example JSON object showing the common fields present in all training events. Note the missing comma after the timestamp field in the source.

```json
{
   "sandbox_id": 10,
   "pool_id": 3,
   "training_definition_id": 1,
   "training_instance_id": 1,
   "training_run_id": 1,
   "training_time": 0,
   "total_training_level_score": 0,
   "total_assessment_level_score": 0,
   "actual_score_in_level": 0,
   "level": 1,
   "level_order": 0,
   "user_ref_id": 1,
   "timestamp": 1636706806953
   "type": "crczp.events.trainings.TrainingRunStarted"
}
```

--------------------------------

### containers.yml example with two containers and mappings

Source: https://docs.platform.cyberrange.cz/user-guide-advanced/sandboxes/sandbox_dockers

Defines two Docker containers (home-docker from an image, home-docker2 from a Dockerfile) and maps them to host 'deb' on ports 2222 and 2223. Container names must be unique and either an image or dockerfile must be specified.

```yaml
containers:
  - name: home-docker
    image: debian
  - name: home-docker2
    dockerfile: home-docker2/

container_mappings:
  - container: home-docker
    host: deb
    port: 2222
  - container: home-docker2
    host: deb
    port: 2223

```

--------------------------------

### Command log JSON example for cloud and local sandbox

Source: https://docs.platform.cyberrange.cz/extras/logging/logs

Shows the JSON structure for command log entries in both cloud and local sandbox environments. The cloud sandbox includes sandbox_id and pool_id fields, while the local sandbox includes user_id and access_token fields. Use this as a reference for the expected format when logging commands.

```json
# CLOUD_SANDBOX
{
   "cmd": "msfconsole",
   "cmd_type": "bash-command",
   "wd": "/home/debian",
   "username": "debian",
   "timestamp_str": "2021-11-12T10:29:37.988Z",
   "hostname": "home",
   "ip": "10.10.30.5",
   "sandbox_id": "11",
   "pool_id": "3"
}

# LOCAL_SANDBOX
{
   "cmd": "msfconsole",
   "cmd_type": "bash-command",
   "wd": "/home/debian",
   "username": "debian",
   "timestamp_str": "2021-11-12T10:29:37.988Z",
   "hostname": "home",
   "ip": "10.10.30.5",
   "user_id": "21",
   "access_token": "secret-2541"
}
```

--------------------------------

### Example variables.yml

Source: https://docs.platform.cyberrange.cz/user-guide-advanced/sandboxes/apg-variables

Example variables.yml file that defines four variables: telnet_port (port type with min, max, and prohibited), secret (text type), username (username type), and encrypted_file (password type with length). Use variable names in the training level definition as Correct Answer - Variable Name instead of static answers.

```yaml
telnet_port:
    type: port
    min: 1500
    max: 65000
    prohibited: [2323]

secret:
    type: text

username:
    type: username

encrypted_file:
    type: password
    length: 5

```

--------------------------------

### Ansible inventory.yml example for small-sandbox

Source: https://docs.platform.cyberrange.cz/user-guide-advanced/sandboxes/sandbox-provisioning

Example of the inventory.yml file generated by sandbox-service for a small-sandbox. It includes networking data such as ansible_host, user_network_ip, and interface routes, plus group definitions and global variables. Use this as a reference when writing Sandbox Provisioning playbooks.

```yaml
all:
  hosts:
    home:
      ansible_host: 192.168.128.3
      ansible_user: windows
      user_network_ip: 10.10.30.5
    home-router:
      ansible_host: 192.168.128.7
      ansible_user: debian
      interfaces:
      - def_gw_ip: 100.100.100.1
        mac: 00:00:00:00:00:16
        routes: []
      ip_forward: true
      user_network_ip: 10.10.30.1
    proxy-jump:
      ansible_host: jump-host-ip
      ansible_user: debian
      user_access_mgmt_name: pool-prefix
      user_access_present: true
      user_access_user_name: stack-name
    man:
      ansible_host: 10.10.10.10
      ansible_user: man
      interfaces:
      - def_gw_ip: ''
        mac: 00:00:00:00:00:02
        routes:
        - gw: 100.100.100.2
          mask: 255.255.255.0
          net: 10.10.20.0
        - gw: 100.100.100.3
          mask: 255.255.255.0
          net: 10.10.30.0
      ip_forward: true
    server:
      ansible_host: 192.168.128.2
      ansible_user: debian
      user_network_ip: 10.10.20.5
    server-router:
      ansible_host: 192.168.128.6
      ansible_user: debian
      interfaces:
      - def_gw_ip: 100.100.100.1
        mac: 00:00:00:00:00:13
        routes: []
      ip_forward: true
      user_network_ip: 10.10.20.1
  children:
    custom-group:
      hosts:
        home: null
        server-router: null
    hidden_hosts:
      hosts:
        server: null
    hosts:
      hosts:
        home: null
        server: null
    management:
      hosts:
        man: null
    routers:
      hosts:
        home-router: null
        server-router: null
    ssh_nodes:
      hosts:
        home-router: null
        server: null
        server-router: null
    user_accessible_nodes:
      hosts:
        home: null
        home-router: null
    winrm_nodes:
      hosts:
        home: null
      vars:
        ansible_connection: psrp
        ansible_psrp_auth: certificate
        ansible_psrp_cert_validation: ignore
        ansible_psrp_certificate_key_pem: /root/.ssh/pool_mng_key
        ansible_psrp_certificate_pem: /root/.ssh/pool_mng_cert
        ansible_psrp_proxy: socks5://localhost:12345
  vars:
    global_head_ip: 0.0.0.0
    global_openstack_stack_id: heatstack-stack-id
    global_pool_id: 1
    global_sandbox_allocation_unit_id: 1
    global_sandbox_ip: 10.10.10.10
    global_sandbox_name: stack-name
    global_ssh_public_mgmt_key: /root/.ssh/pool_mng_key.pub
    global_ssh_public_user_key: /root/.ssh/user_key.pub

```

--------------------------------

### Training Event Additional Fields Example

Source: https://docs.platform.cyberrange.cz/extras/logging/logs

Example JSON object showing the additional fields for each event type, with comments indicating the event type. The source uses '###' for comments, which is not valid JSON.

```json
{
   ### AssessmentAnswers
   "answers": "[{ \"questionId\": 4, \"answers\": [\"Graphical user interface of CyberRangeCZ Platform\"] }, { \"questionId\": 5, \"answers\": [{ \"statementOrder\": 1, \"optionOrder\": 1 }, { \"statementOrder\": 2, \"optionOrder\": 1 }, { \"statementOrder\": 0, \"optionOrder\": 0 }] }, { \"questionId\": 6, \"answers\": [\"null\"] }]"

   ### CorrectAnswerSubmitted
   "answer_content": "Top_Secret_Flag"

   ### HintTaken
   "hint_id": 15,
   "hint_penalty_points": 5,
   "hint_title": "Tool for password attacks"

   ### LevelCompleted
   "level_type": "ASSESSMENT"

   ### LevelStarted
   "level_type": "TRAINING",
   "max_score": 50,
   "level_title": "Finding open ports"

   ### SolutionDisplayed
   "penalty_points": 10

   ### TrainingRunEnded
   "start_time": 1636706806877,
   "end_time": 1636706947806

   ### WrongAnswerSubmitted
   "answer_content": "Very_Bad_Flag",
   "count": 3
}
```

--------------------------------

### Create SOCKS5 Proxy for User Access

Source: https://docs.platform.cyberrange.cz/user-guide-advanced/sandboxes/sandbox-access

Set up a local SOCKS5 proxy on port 12345 for user access. Used to reach user-accessible VMs via a proxy.

```bash
$ ssh -F ~/.ssh/pool-id-ID-sandbox-id-ID-user-config -N -D 12345 man
```

--------------------------------

### Create SOCKS5 Proxy for Management Access

Source: https://docs.platform.cyberrange.cz/user-guide-advanced/sandboxes/sandbox-access

Set up a local SOCKS5 proxy on port 12345 via the management config. Useful for tools that support SOCKS5 proxy.

```bash
$ ssh -F ~/.ssh/pool-id-ID-sandbox-id-ID-management-config -N -D 12345 man
```

--------------------------------

### Adaptive training event additional fields example

Source: https://docs.platform.cyberrange.cz/extras/logging/logs

Example of additional fields for different event types. The block shows the extra fields for CorrectAnswerSubmitted, PhaseCompleted, PhaseStarted, and QuestionnaireAnswers events, with the QuestionnaireAnswers field containing a JSON string of question-answer objects.

```json
{
   ### CorrectAnswerSubmitted
   "answer_content": "Top_Secret_Flag"

   ### PhaseCompleted
   "phase_type": "QUESTIONNAIRE",
   "phase_title": "Finding open ports"

   ### PhaseStarted
   "phase_type": "TRAINING",
   "phase_title": "Finding open ports"

   ### QuestionnaireAnswers
   "answers":"[QuestionAnswer{questionAnswerId=1, answers='[None]'}, QuestionAnswer{questionAnswerId=2, answers='[None]'}, QuestionAnswer{questionAnswerId=3, answers='[None]'}, QuestionAnswer{questionAnswerId=4, answers='[None]'}, QuestionAnswer{questionAnswerId=5, answers='[None]'}, QuestionAnswer{questionAnswerId=6, answers='[None]'}, QuestionAnswer{questionAnswerId=7, answers='[Low]'}, QuestionAnswer{questionAnswerId=8, answers='[Medium]'}]"
}
```

--------------------------------

### Adaptive training event common fields example

Source: https://docs.platform.cyberrange.cz/extras/logging/logs

Example of common fields for an adaptive training event. The type field uses the full event class name, and fields like task_id and task_order are null when the event is not tied to a specific task.

```json
{
   "sandbox_id": 11,
   "pool_id": 3,
   "training_definition_id": 52,
   "training_instance_id": 152,
   "training_run_id": 5,
   "training_time": 2516,
   "phase_id": 6,
   "phase_order": 1,
   "task_id": null,
   "task_order": null,
   "user_ref_id": 1,
   "timestamp": 1636712942803,
   "type": "crczp.events.adaptive.trainings.PhaseStarted"
}
```

--------------------------------

### Add a page to mkdocs.yml nav

Source: https://docs.platform.cyberrange.cz/extras/writing-documentation-mkdocs

Base mkdocs.yml configuration showing the site_name and a nav section with a single Home page. Add new pages by adding lines to the nav object.

```yaml
site_name: MkLorum
nav:
    - Home: index.md

```

--------------------------------

### Footnote definitions

Source: https://docs.platform.cyberrange.cz/extras/writing-documentation-mkdocs

Defines footnotes using the Footnotes extension. Labels start with a caret and may contain any inline text; content must start with the label followed by a colon and at least one space. The content can include multiple lines, paragraphs, code blocks, and other markdown syntax, with additional lines indented one level.

```markdown
Footnotes[^1] have a label[^@#$%] and the footnote's content.

[^1]: This is footnote content.
[^@#$%]: A footnote on the label: "@#$%".

```

--------------------------------

### User import JSON file structure

Source: https://docs.platform.cyberrange.cz/user-guide-basic/administration-agenda/users

JSON structure for the file selected after clicking 'Choose file' on the Users page. The 'users' list is mandatory; each user requires 'sub' and 'iss' matching the login and OIDC provider URL. Optional fields 'full_name', 'given_name', 'family_name' are filled on first login. Optional 'group_name' creates a group (must not already exist) and assigns users to it; if omitted, users are created without group assignment.

```json
{
  "users": [
     {
       "sub": "test-user", (MANDATORY)
       "iss": "https://test.oidc.com/oidc/", (MANDATORY)
       "full_name": "Test User", (OPTIONAL)
       "given_name": "Test", (OPTIONAL)
       "family_name": "User" (OPTIONAL)
     },
     {
       ...
     }
  ],
  "group_name": "TEST GROUP" (OPTIONAL)
}

```

--------------------------------

### TrainingRunEnded event additional fields

Source: https://docs.platform.cyberrange.cz/extras/logging/logs

Additional fields for the TrainingRunEnded event, showing the start and end timestamps of the training run.

```json
"start_time": 1636706806877,
"end_time": 1636706947806
```

--------------------------------

### Sandbox Definition directory structure

Source: https://docs.platform.cyberrange.cz/user-guide-advanced/sandboxes/sandbox-definition

Shows the minimal directory layout for a Sandbox Definition, including topology.yml, variables.yml, provisioning/playbook.yml, and preconfig/.

```text
sandbox-definition/
├── topology.yml
├── variables.yml
└── provisioning/
    └── playbook.yml
└── preconfig/

```
Tokens:
Raw