README.md 7 KB
Newer Older
Jan Vykopal's avatar
Jan Vykopal committed
1
2
# sandbox-creator

Attila Farkas's avatar
Attila Farkas committed
3
4
A next generation of https://gitlab.ics.muni.cz/KYPO-content/KYPO-Creator

Attila Farkas's avatar
Attila Farkas committed
5
create.py is a python program that generates a vagrant source file from a definition in yaml. This yaml file contains definitions of devices (hosts and routers) and networks. Its structure is described below.
Attila Farkas's avatar
Attila Farkas committed
6

Attila Farkas's avatar
Attila Farkas committed
7
8
9
10
### Requirements:
- Python 3
- VirtualBox 6
- Ansible 2.3.3.0
11
- Vagrant 2.2.5
12
13
14
15
16
17
18
19
20
21
22
23
24
25

### Installation steps

##### Linux Mint

1. Enable [virtualization in BIOS](https://www.tactig.com/enable-intel-vt-x-amd-virtualization-pc-vmware-virtualbox/).
2. Install [VirtualBox 6.0](https://www.virtualbox.org/wiki/Download_Old_Builds_6_0).
3. Install Ansible with the command `$ sudo apt-get install ansible`.
4. Install [Vagrant](https://www.vagrantup.com/downloads.html).
5. Install git using the command `$ sudo apt-get install git`.
6. Clone the project with `$ git clone https://gitlab.ics.muni.cz/cs4eu/sandbox-creator.git` to an arbitrary directory.
7. Navigate to the project directory (`$ cd sandbox-creator`).
8. Install pip using `$ sudo apt-get install python3-pip`.
9. Install setuptools with `$ pip3 install setuptools`.
26
10. Install dependencies with the command `$ pip3 install -r requirements.txt`.
27
28
29
30
31
32
33
34
35
36
37

##### Windows 10
 
1. Enable [virtualization in BIOS](https://www.tactig.com/enable-intel-vt-x-amd-virtualization-pc-vmware-virtualbox/).
2. Install [VirtualBox 6.0](https://www.virtualbox.org/wiki/Download_Old_Builds_6_0).
3. Install [Vagrant](https://www.vagrantup.com/downloads.html).
4. Install Ansible using the [guide](https://www.how2shout.com/how-to/how-to-install-ansible-on-windows-10.html).
5. Install [Python 3](https://www.python.org/downloads/windows/). At the beginning of the installation mark the "Add Python to PATH" option.
6. Install [git](https://git-scm.com/downloads).
7. Clone the project with `git clone https://gitlab.ics.muni.cz/cs4eu/sandbox-creator.git` to an arbitrary folder.
8. Navigate to the project folder (`$ cd sandbox-creator`).
38
9. Install Python dependencies using the command `python -m pip install -r .\requirements.txt`
Attila Farkas's avatar
Attila Farkas committed
39

Attila Farkas's avatar
Attila Farkas committed
40
### Usage:
41
42
1. Type `$ python3 create.py sandbox.yml`. On Windows or in case of an error due to ansible/python use `python create.py -l sandbox.yml`. (note: This will rewrite the previously generated Vagrantfile and ansible files.)
2. Run `$ vagrant up` to build the virtual environment.
43
3. The created virtual machines can be accessed with the command `$ vagrant ssh nameOfTheMachine`.
44
4. The environment can be destroyed using the command `vagrant destroy -f`.
Attila Farkas's avatar
Attila Farkas committed
45

Attila Farkas's avatar
Attila Farkas committed
46
### Input yaml file structure
Attila Farkas's avatar
Attila Farkas committed
47

Attila Farkas's avatar
Attila Farkas committed
48
49
50
51
52
- `hosts`: a list of host devices. All attributes of these virtual machines are defined here. Every host must have a unique `name` and a `base_box`.
	- `name`: unique name of the device (required)
	- `base_box`: an OS image that will be installed on the machine (required)
	- `cpus`: number of CPU units
	- `memory`: required memory size in MB
Attila Farkas's avatar
Attila Farkas committed
53
	- `flavor`: a quick definition of memory and cpus (details below)
Attila Farkas's avatar
Attila Farkas committed
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
	- other simple [vagrant attributes](https://www.vagrantup.com/docs/vagrantfile/machine_settings.html)

- `routers`: a list of routers. Routers need only a unique name. All other attributes are preset (Debian 10 with 256MB memory and 2 CPUs).
	- `name`: a unique router name (required)

- `networks`: list of networks
	- `name`: unique name of the network (required)
	- `cidr`: ip address of the network in cidr notation

- `net_mappings`: mappings of host machines to a network. This list defines the ip addresses of host in certain networks
	- `host`: name of an existing host
	- `network`: name of an existing network
	- `ip`: ip address of the host in the network

- `router_mappings`: similar to net_mappings. It defines the addresses of routers inside networks.
	- `router`: name of an existing router
	- `network`: name of an existing network
	- `ip`: ip address of the router in the network
Attila Farkas's avatar
Attila Farkas committed
72

Attila Farkas's avatar
Attila Farkas committed
73
74
75
76
77
78
79
80
### Testing the network

After a successful `vagrant up` it is sometimes needed to test the network routing:

1. Log in to a host with `$ vagrant ssh <host>`.
2. Ping a host from a different network with `$ ping <other-host>`.
3. If the networks are connected with a router and the routing works, ping gives an output (cca every second) about the transmitted packets. If ping cannot access the other host, no such output is produced.

Attila Farkas's avatar
Attila Farkas committed
81
#### Flavors
Attila Farkas's avatar
Attila Farkas committed
82

Attila Farkas's avatar
Attila Farkas committed
83
84
85
Flavors provide a quick way to choose hardware specs (like number of cpus and memory) for a virtual machine. These attributes can also be specified separately by `memory` and `cpus`. The values of `memory` and/or `cpus` always override the values specified in the `flavor`.

##### Supported flavors:
Attila Farkas's avatar
Attila Farkas committed
86
87
88
89
90
91
92
93
94
95
96
97
98
| flavor | cpus | memory |
| ------------------ |:--:|:-----:|
| csirtmu.tiny1x2    | 1  | 2048  |
| csirtmu.tiny1x4    | 1  | 4096  |
| csirtmu.small2x4   | 2  | 4096  |
| csirtmu.small2x8   | 2  | 8192  |
| csirtmu.medium4x8  | 4  | 8192  |
| csirtmu.medium4x16 | 4  | 16384 |
| csirtmu.large8x16  | 8  | 16384 |
| csirtmu.large8x32  | 8  | 32768 |
| csirtmu.jumbo16x32 | 16 | 32768 |
| csirtmu.jumbo16x64 | 16 | 65536 |

Attila Farkas's avatar
Attila Farkas committed
99
100
101
102
### Interface names and supported boxes

The name of the correct network interface can be different for every box. The supported boxes are listed in the file name_mappings/interface.yml. If your box is not on the list, the most common "eth1" will be used. If you get an error during `$ vagrant up` about non-existing network interface, you can add the name of your box and the correct network interface to the list manually.

Attila Farkas's avatar
Attila Farkas committed
103
104
105
106
107
108
109
110
111
112
### Implemented attribute types:
- all simple vagrant attributes
- flavors, memory, cpus
- a simple network (assigning ip and netmask to a device)
- simple routing (one router between networks)

### Not implemented yet:
- other VirtualBox attributes
- more complex routing

Jan Vykopal's avatar
Jan Vykopal committed
113
### Known [issues](https://gitlab.ics.muni.cz/cs4eu/sandbox-creator/issues?scope=all&utf8=✓&state=all&label_name[]=known_issue):
114
- After running on Windows the output may contain invalid multibyte chars.
115
- Check if DHCP server for vboxnet0 is turned off in VirtualBox. It can be done manually in VirtualBox or with the command `$ VBoxManage dhcpserver remove --ifname vboxnet0`
Jan Vykopal's avatar
Jan Vykopal committed
116
- Vagrant up can somtimes get stuck on "SSH auth method: private key" in case of "generic/debian10" box or on "SSH auth method: password" in case of "kalilinux/rolling-light" box. This is probably an issue of VirtualBox. In this case try to create the machine again. In case of "kalilinux/rolling-light" remove the line `device.ssh.password = "vagrant"` from the generated Vagrantfile and try to bring it up again.
117
- On some machines ansible local (flag -l) can get stuck while connecting to the created virtual machine.
Attila Farkas's avatar
Attila Farkas committed
118
119

### Notes
120
- tested on Vagrant 2.2.5, VirtualBox 6.0.4 and 6.0.10, Ansible 2.3.3.0
121
- Vagrantfile and the provision directory contains everything needed by vagrant. Feel free to move them to a different directory after creation. 
Attila Farkas's avatar
Attila Farkas committed
122

Jan Vykopal's avatar
Jan Vykopal committed
123
124
125
126
127
128
129
130
### Credits

Cybersecurity laboratory\
Faculty of Informatics\
Masaryk University

Lead developer: Attila Farkas

Jan Vykopal's avatar
Jan Vykopal committed
131
Technology lead: Daniel Tovarňák (KYPO cyber range platform)
Jan Vykopal's avatar
Jan Vykopal committed
132
133
134
135
136
137
138

Supervisor: Jan Vykopal

Contributors:
*  Valdemar Švábenský
*  Michal Staník
*  Zdeněk Vydra
139
*  Adam Skrášek