Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/giper45/dockersecurityplayground

A Microservices-based framework for the study of Network Security and Penetration Test techniques
https://github.com/giper45/dockersecurityplayground

Last synced: 3 months ago
JSON representation

A Microservices-based framework for the study of Network Security and Penetration Test techniques

Host: GitHub
URL: https://github.com/giper45/dockersecurityplayground
Owner: DockerSecurityPlayground
License: mit
Created: 2017-09-19T07:15:19.000Z (about 7 years ago)
Default Branch: master
Last Pushed: 2023-09-27T23:06:27.000Z (about 1 year ago)
Last Synced: 2024-08-04T17:12:45.596Z (3 months ago)
Language: JavaScript
Homepage: https://secsi.io/docker-security-playground/
Size: 14 MB
Stars: 568
Watchers: 30
Forks: 107
Open Issues: 22
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

# DockerSecurityPlayground

[![All Contributors](https://img.shields.io/badge/all_contributors-8-orange.svg?style=flat-square)](#contributors-)

![](https://i.imgur.com/thNV8M7.png)

Docker Security Playground is an application that allows you to:
- Create **network and network security scenarios**, in order to understand network protocols,
rules, and security issues by installing DSP in your PC.
- Learn **penetration testing techniques** by simulating vulnerability labs scenarios
- **Manage a set of docker-compose project** . Main goal of DSP is to learn
in penetration testing and network security, but its flexibility allows you the
**creation**, **graphic editing** and **managment run / stop** of all your **docker-compose
labs**.

## How To Use
Follow [DSP channel](https://www.youtube.com/channel/UCkmz_sagT7_kxSdmttDWg9A) to learn how to use DSP.
You can also use [wiki](https://github.com/giper45/DockerSecurityPlayground/wiki) documentation to understand how you can use DSP.
Follow Installation and Start steps to run DSP.

The package:
* Install docker and docker-compose
* Install latest stable nodejs
* Install dsp
* Creates a dsp user on the target machine

When the installation is complete, you can run dsp by using the systemd command:
```
systemctl start dsp
```

DSP will run on "http://localhost:18181"

### Developer Installation
1. Install DSP Requirements:

* Nodejs (v 7 or later)
* git
* docker
* docker-compose
* compiler tools (g++, c, c++)

2. Install node dependencies and run:

```
git clone https://github.com/giper45/DockerSecurityPlayground.git
cd DockerSecurityPlayground
npm install
```

3. Run:

```
npm start
```
To start the application. This will launch a server listening on 18181 (or another if you set have set PORT environment variable) port of your localhost.

With your favourite browser go to http://localhost:18181. You'll be redirected on installation page, set parameters and click install.
I suggest you to run dsp on a Ubuntu virtual machine and expose on 0.0.0.0 interface.
If you want to expose on another interface, change DSP_IFACE environment variable:
```
export DSP_IFACE="0.0.0.0"
```
Now you can use dsp on Remote interface.

## Update the application:
When you update the application it is important to update the npm packages (The application uses mydockerjs, a npm docker API that I am developing during DSP development: https://www.npmjs.com/package/mydockerjs)
```
npm run update
```
## Clean DSP
If something goes wrong, you can reset DSP to factory by using the following command:
```
npm run uninstall
```
This will delete everything, and you can start DSP from the installation step.

## Official Repository
[DSP_Projects](https://github.com/giper45/DSP_Projects.git) contains official DSP labs. Contribute to DSP by creating new DSP Labs

## How can I **share my labs with the world** ?

During the installation you can create a local environment that has not link with git, or you can associate a personal repository the the application. This is very useful if you want to share your work with other people.
DSP Repository must have several requirements, so I have created a base DSP Repo Template that you can use to create your personal repository.
So, the easiest way to share labs is the following:

1. Fork the NS-Unina project: [https://github.com/NS-unina/DSP_Repo.git](https://github.com/NS-unina/DSP_Repo.git)
2. During the installation set github directory param to your forked repository.
3. Now create your labs and share it!

It is important that all images that you use should be available to other users, so:
- You can publish on docker hub so other users can pull your images in order to use your labs.
- You can prov[ide dockerfiles inside the .docker-images directory, so users can use build.sh to build your images and use your repo.

If you need a "private way" to share labs you should share the repository in other ways, at current time there is no support to share private repositories.

In DSP you can manage multiple user repositories (Repositories tab)
## DSP Features
- Graphic Editor of docker-compose
- Docker Image and Dockerfile Management
- GIT Integration
- DSP Repository with a set of network security scenarios

### Any question ?
If you have a problem you can use Issue section.

## Docker Wrapper Image
DSP implements a label convention called DockerWrapperImage that allows you to create images that expose action to execute when a lab is running.
Look at the [doc](https://github.com/giper45/DockerSecurityPlayground/wiki/Docker-Wrapper-Image)

## Tests
To run a test:
```
mocha test/
```
tests use helper.start() method to initialize the test environment:
* A test config is created
* homedir directory is mocked, in this way it is possible to use internal dsp directory for tests.

### Troubleshooting
#### During dependencies installation

If you have error regarding **node-pty** module, try to:
- Install build-essentials : (In Ubuntu: apt install -y build-essentials)
- Use nodejs LTS (note-pty has some isseus, as shown [here](https://github.com/microsoft/node-pty/issues/319)

If you have the following error:
```
ERR! typeerror Error: Missing required argument #1
```
You need to update nodejs:
```
sudo apt-get install -y python-software-properties
curl -sL https://deb.nodesource.com/setup_10.x | sudo -E bash
sudo apt-get install nodejs
```

#### During DSP installation
If you have the following error during the installation:
```
[2020-12-14T10:18:21.854Z] INFO: DockerSecurityPlayground/1536 on vagrant: [DOCKER ACTIONS - DOWNLOAD IMAGE]
events.js:174
throw er; // Unhandled 'error' event
^

Error: connect EACCES /var/run/docker.sock
at PipeConnectWrap.afterConnect [as oncomplete] (net.js:1107:14)
Emitted 'error' event at:
at Socket.socketErrorListener (_http_client.js:401:9)
at Socket.emit (events.js:198:13)
at emitErrorNT (internal/streams/destroy.js:91:8)
at emitErrorAndCloseNT (internal/streams/destroy.js:59:3)
at process._tickCallback (internal/process/next_tick.js:63:19)
```

Verify 2 things:
1. docker is installed
2. current user is in `docker` group

To test it:
```
docker ps
```
DO NOT USE SUDO if you are running DSP with normal user.
If you have the following error:
```
vagrant@vagrant:~/git/DockerSecurityPlayground$ docker ps
Got permission denied while trying to connect to the Docker daemon socket at unix:///var/run/docker.sock: Get http://%2Fvar%2Frun%2Fdocker.sock/v1.24/containers/json: dial unix /var/run/docker.sock: connect: permission denied
```
You need to add your user to group docker:
https://docs.docker.com/engine/install/linux-postinstall/
```
$ sudo groupadd docker
$ sudo usermod -aG docker $USER
```
Log-out and log-in
Now you need to clean DSP:
```
npm run uninstall
```
And now everything should work.

### MacOS error

MacOS ECONNRESET error:

```
events.js:183
throw er; // Unhandled 'error' event
^

Error: read ECONNRESET
at _errnoException (util.js:992:11)
at TCP.onread (net.js:618:25)
```
On Mac it seems that there is some problem with some node package, so in order to solve this run:
```
MacBook-Pro:DockerSecurityPlayground gaetanoperrone$ npm install [email protected] --save-dev --save-exact
```
Other info here: [http://gitlab.comics.unina.it/NS-Thesis/DockerSecurityPlayground_1/wikis/docker-operation-errors](http://gitlab.comics.unina.it/NS-Thesis/DockerSecurityPlayground_1/wikis/docker-operation-errors)

### node-pty issues
The application is based on [node-pty](https://github.com/microsoft/node-pty) pseudoterminal, that is subjected to several compilation errors.
In order to compile you need to install the compilation toolchain for Ubuntu:
```
apt-get install -y build-essential
```

And the `XCode` for macOS users.

Please, follow the library documentation guide to fix the compilation errors that could occurr when you run `npm install` command.
Here some potential issues:
* `error: no template named 'remove_cv_t' in namespace 'std'; did you mean 'remove_cv'?` : try to use the `C++ v17` : `env CXXFLAGS="-std=c++17" npm i `

## Contributing

1. Fork it!
2. Create your feature branch: `git checkout -b my-new-feature`
3. Commit your changes: `git commit -am 'Add some feature'`
4. Push to the branch: `git push origin my-new-feature`
5. Submit a pull request, we'll check

## Any Questions?
Use the **[Issues](http://gitlab.comics.unina.it/NS-Thesis/DockerSecurityPlayground_1/issues)** in order to ask everything you want!.

## Links
- [Landing Page](https://secsi.it/docker-security-playground/)
- [![Arsenal](https://github.com/toolswatch/badges/blob/master/arsenal/usa/2018.svg)](https://www.toolswatch.org/2018/05/black-hat-arsenal-usa-2018-the-w0w-lineup/)
- [DSP Vagrant Box used in Blackhat Session](https://app.vagrantup.com/giper45/boxes/dsp_blackhat)
- [Blackhat scenario in Gitlab](https://gitlab.com/dsp_blackhat/dsp_blackhat_vagrant.git)
## Relevant DSP Repositories
- https://github.com/giper45/DSP_Projects.git : Official DSP Repository
- https://github.com/giper45/DSP_Repo.git : DSP Template to create another repository: fork it to start creating your personal remote environment
- https://github.com/NS-unina/DSP_Repo.git : Repository created for Network Security Course of Simon Pietro Romano in University of the Study in Naples, Federico II
## Contributors

_gx1
🐛 💻 🖋 🎨 📖 🚧 📆

_{Simon Pietro Romano}
🎨 📖 📆

_catuhub
🐛 💻 🎨 📖 🚧 📆

_{Giuseppe Di Terlizzi}
💻

_Alessandro
📖 📹 🖋

_Roberto
💻 🖋 🚇

_the-licato
🚇

_{Gabriele Previtera}
💻 📢

Thanks to **Giuseppe Criscuolo** and **Alessandro Placido Luise** for the logo design
## Changelog
Got to [CHANGELOG.md](CHANGELOG.md) to see al the version changes.

## Cite this work
If you use Docker Security Playground for your research activity, cite the following paper published by the IEEE (Institute of Electrical and Electronics Engineers)
https://ieeexplore.ieee.org/document/8169747

## License
This project is under the **MIT license**