|
|
This page describes how to install the required software before running Cyber Sandbox Creator (CSC). It contains two sections:
|
|
|
|
|
|
* Prerequisites for running intermediate definitions generated by CSC (for most users)
|
|
|
* Prerequisites for generating own intermediate definitions with CSC (for advanced users)
|
|
|
|
|
|
# I want to run CSC sandboxes (for most users)
|
|
|
|
|
|
## Linux/macOS
|
|
|
|
|
|
1. Enable [virtualization in BIOS](https://www.tactig.com/enable-intel-vt-x-amd-virtualization-pc-vmware-virtualbox/).
|
|
|
2. Install [VirtualBox](https://www.virtualbox.org/wiki/Downloads).
|
|
|
* VirtualBox on Linux is sensitive to kernel versions. First, update the system (including the kernel), and only then install the latest Virtualbox. **IMPORTANT**: Don’t install the distro-repository version of VirtualBox. Really do install the latest version from [https://www.virtualbox.org/wiki/Downloads](https://www.virtualbox.org/wiki/Downloads)
|
|
|
* VirtualBox requires x86 CPU architecture, so it will **not** work on ARM Mac.
|
|
|
3. Install [Vagrant](https://www.vagrantup.com/downloads.html). The official website should be preferred as a source. Repositories of Linux distributions could have outdated versions.
|
|
|
4. Install `pip` using the command `$ sudo apt-get install python3-pip`.
|
|
|
5. Install `setuptools` with `$ pip3 install setuptools`.
|
|
|
6. Install KYPO topology definition `$ pip3 install kypo-topology-definition~=0.5.0 --extra-index-url https://gitlab.ics.muni.cz/api/v4/projects/2358/packages/pypi/simple`.
|
|
|
7. Install CSC with `$ pip3 install sandboxcreator`.
|
|
|
|
|
|
Note: Instead of installing steps 4--7, you can (in most cases) use Vagrant commands directly to build virtual environments.
|
|
|
|
|
|
## Windows 10
|
|
|
|
|
|
1. Enable [virtualization in BIOS](https://www.tactig.com/enable-intel-vt-x-amd-virtualization-pc-vmware-virtualbox/).
|
|
|
2. Install [VirtualBox](https://www.virtualbox.org/wiki/Downloads).
|
|
|
3. Install [Vagrant](https://www.vagrantup.com/downloads.html).
|
|
|
4. Ensure Hyper-V is disabled (Programs and Features > Turn Windows features on or off > Hyper-V)
|
|
|
* Sometimes it is not enough to disable Hyper-V in Settings; you may need to use the command `bcdedit /set hypervisorlaunchtype off` and restart the computer.
|
|
|
* Windows Update can turn Hyper-V on again, be sure to check it again after installing updates.
|
|
|
5. Install [Python 3 with PIP](https://www.python.org/downloads/windows/).
|
|
|
6. Install KYPO topology definition `$ pip3 install kypo-topology-definition~=0.5.0 --extra-index-url https://gitlab.ics.muni.cz/api/v4/projects/2358/packages/pypi/simple`.
|
|
|
7. Install CSC with `$ pip3 install sandboxcreator`.
|
|
|
|
|
|
Note: Instead of installing steps 4--7, you can (in most cases) use Vagrant commands directly to build virtual environments.
|
|
|
|
|
|
# Required software versions for all operating systems
|
|
|
|
|
|
* Python >= 3.7
|
|
|
* VirtualBox >= 6.1
|
|
|
* Vagrant >= 2.2.5
|
|
|
* Ansible >= 2.5 (required only if using the option `--ansible-installed`)
|
|
|
|
|
|
It may happen that Vagrant does not support the brand new version of VirtualBox yet. In this case, install an earlier version of VirtualBox or wait for Vagrant to release a new version.
|
|
|
|
|
|
Note: Tested on Vagrant 2.2.18, VirtualBox 6.1.26, and Ansible 2.5.1.
|
|
|
|
|
|
# I want to generate sandboxes with CSC (for advanced users)
|
|
|
|
|
|
## Debian-based Linux
|
|
|
|
|
|
### Using PIP (recommended)
|
|
|
|
|
|
1. Install `pip` using `$ sudo apt-get install python3-pip`.
|
|
|
2. Install KYPO topology definition with `$ pip3 install kypo-topology-definition~=0.5.0 --extra-index-url https://gitlab.ics.muni.cz/api/v4/projects/2358/packages/pypi/simple`.
|
|
|
3. Install CSC with `$ pip3 install sandboxcreator`.
|
|
|
|
|
|
### From the repository
|
|
|
|
|
|
1. Clone the CSC project with `$ git clone https://gitlab.ics.muni.cz/muni-kypo-csc/cyber-sandbox-creator.git` or unzip the downloaded [release](https://gitlab.ics.muni.cz/muni-kypo-csc/cyber-sandbox-creator/-/releases) archive to an arbitrary directory.
|
|
|
2. Navigate to the project directory (`$ cd cyber-sandbox-creator`).
|
|
|
3. Install `pip` using `$ sudo apt-get install python3-pip`.
|
|
|
4. Install `setuptools` with `$ pip3 install setuptools`.
|
|
|
5. Install Python dependencies with `$ pip3 install -r requirements.txt`.
|
|
|
|
|
|
## Windows 10
|
|
|
|
|
|
### Using PIP (recommended)
|
|
|
|
|
|
1. Install [Python 3 with PIP](https://www.python.org/downloads/windows/).
|
|
|
2. Install KYPO topology definition with `pip install kypo-topology-definition~=0.5.0 --extra-index-url https://gitlab.ics.muni.cz/api/v4/projects/2358/packages/pypi/simple`.
|
|
|
3. Install CSC with `pip install sandboxcreator`.
|
|
|
|
|
|
### From the repository
|
|
|
|
|
|
1. Install [Python 3](https://www.python.org/downloads/windows/). At the beginning of the installation mark the "Add Python to PATH" option.
|
|
|
2. Clone the CSC project with `git clone https://gitlab.ics.muni.cz/muni-kypo-csc/cyber-sandbox-creator.git` or unzip the downloaded [release](https://gitlab.ics.muni.cz/muni-kypo-csc/cyber-sandbox-creator/-/releases) archive to an arbitrary folder.
|
|
|
3. Navigate to the project folder (`$ cd cyber-sandbox-creator`).
|
|
|
4. Install Python dependencies with `python -m pip install -r requirements.txt` |
|
|
\ No newline at end of file |