Skip to content

Latest commit

 

History

History
253 lines (199 loc) · 12.9 KB

README.md

File metadata and controls

253 lines (199 loc) · 12.9 KB
Raw

DockerSecurityPlayground

All Contributors

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 to learn how to use DSP. You can also use wiki documentation to understand how you can use DSP.
Follow Installation and Start steps to run DSP.

Installation And Start

  1. Install DSP Requirements:
  • Nodejs (v 7 or later)
  • git
  • docker
  • docker-compose
  • compiler tools (g++, c, c++)
  1. Install node dependencies and run:
git clone https://github.com/giper45/DockerSecurityPlayground.git
cd DockerSecurityPlayground
npm install
  1. 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 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 DSP_Repo project: https://github.com/giper45/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 provide 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

Tests

To run a test:

mocha test/<test-nodejs-file.js>

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

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

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 in order to ask everything you want!.

Links

Relevant DSP Repositories

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 to see al the version changes.

License

This project is under the MIT license