monkey/monkey/monkey_island
VakarisZ 2e600fd5b2 Decoupled mongo setup from environment config 2021-05-27 15:57:12 +03:00
..
cc Decoupled mongo setup from environment config 2021-05-27 15:57:12 +03:00
deb-package No need to qualify python since we sourced `activate` 2020-04-12 19:26:26 +03:00
linux Removed code related to running mongodb and db folder creation 2021-05-27 11:05:43 +03:00
pyinstaller_hooks All E501 errors fixed, but formatting screwed up 2021-04-07 13:40:01 -04:00
setup Fixed typos and renamed windows permission setting function in windows_permissions.py to be more specific. 2021-05-27 14:09:21 +03:00
windows Removed code related to running mongodb and db folder creation 2021-05-27 11:05:43 +03:00
Pipfile travis: Fail build if vulture finds dead code 2021-05-05 19:19:59 +05:30
Pipfile.lock travis: Fail build if vulture finds dead code 2021-05-05 19:19:59 +05:30
__init__.py Reformat all python with black v20.8b1 2021-04-06 09:20:18 -04:00
monkey_island.ico Merge branch 'master' into develop 2019-04-14 16:39:15 +03:00
monkey_island.spec Trying to disable UPX to make it work on 2012 R2 2020-04-20 09:37:53 +03:00
readme.md Removed run.sh and updated mongodb related documentation: removed db folder creation and run.sh execution on linux 2021-05-27 11:05:43 +03:00

readme.md

Monkey island dev. env. setup guide

To easily setup development environment for Monkey Island and the Monkey look into deployment scripts folder. If you want to setup dev. env. for Island manually, refer to the instructions below.

How to set up the Monkey Island server

On Windows

  1. Exclude the folder you are planning to install the Monkey in from your AV software, as it might block or delete files from the installation.

  2. Create folder "bin" under monkey\monkey_island

  3. Place portable version of Python 3.7.4

  4. Install pipx

    • pip install --user -U pipx
    • pipx ensurepath
  5. Install pipenv

    • pipx install pipenv
  6. From the monkey\monkey_island directory, install python dependencies:

    • pipenv sync --dev
  7. Setup mongodb (Use one of the following two options):

    OR

    • Use already running instance of mongodb
      1. Run 'set MONKEY_MONGO_URL="mongodb://:27017/monkeyisland"'. Replace '' with address of mongo server
  8. Place portable version of OpenSSL

  9. Download and install Microsoft Visual C++ redistributable for Visual Studio 2017

  10. Generate SSL Certificate

    • run ./windows/create_certificate.bat when your current working directory is monkey_island
  11. Put Infection Monkey binaries inside monkey_island/cc/binaries (binaries can be found in releases on github or build from source) monkey-linux-64 - monkey binary for linux 64bit monkey-linux-32 - monkey binary for linux 32bit monkey-windows-32.exe - monkey binary for windows 32bit monkey-windows-64.exe - monkey binary for windows 64bit

  12. Install npm

  13. Build Monkey Island frontend

    • cd to 'monkey_island\cc\ui'
    • run 'npm update'
    • run 'npm run dist'

How to run

  1. When your current working directory is monkey_island, run monkey_island\windows\run_server_py.bat

On Linux

  1. Set your current working directory to monkey/.

  2. Get python 3.7 and pip if your linux distribution doesn't have it built in (following steps are for Ubuntu 16):

    • sudo add-apt-repository ppa:deadsnakes/ppa
    • sudo apt-get update
    • sudo apt install python3.7 python3-pip python3.7-dev python3.7-venv
    • python3.7 -m pip install pip
  3. Install pipx:

    • python3.7 -m pip install --user pipx
    • python3.7 -m pipx ensurepath
    • source ~/.profile
  4. Install pipenv:

    • pipx install pipenv
  5. Install required packages:

    • sudo apt-get install libffi-dev upx libssl-dev libc++1 openssl
  6. Install the Monkey Island python dependencies:

    • cd ./monkey_island
    • pipenv sync --dev
    • cd ..
  7. Create the following directories in monkey island folder (execute from ./monkey):

    • mkdir -p ./monkey_island/bin/mongodb
    • mkdir -p ./monkey_island/cc/binaries
  8. Put monkey binaries in /monkey_island/cc/binaries (binaries can be found in releases on github).

    monkey-linux-64 - monkey binary for linux 64bit

    monkey-linux-32 - monkey binary for linux 32bit

    monkey-windows-32.exe - monkey binary for windows 32bit

    monkey-windows-64.exe - monkey binary for windows 64bit

    Also, if you're going to run monkeys on local machine execute:

    • chmod 755 ./monkey_island/cc/binaries/monkey-linux-64
    • chmod 755 ./monkey_island/cc/binaries/monkey-linux-32
  9. Setup MongoDB (Use one of the two following options):

    • Download MongoDB and extract it to monkey/monkey_island/bin/mongodb:
      1. Run ./monkey_island/linux/install_mongo.sh ./monkey_island/bin/mongodb. This will download and extract the relevant mongoDB for your OS.

    OR

    • Use already running instance of mongodb
      1. Run set MONKEY_MONGO_URL="mongodb://<SERVER ADDR>:27017/monkeyisland". Replace '' with address of mongo server
  10. Generate SSL Certificate:

    • cd ./monkey_island
    • chmod 755 ./linux/create_certificate.sh
    • ./linux/create_certificate.sh
  11. Install npm and node by running:

    • sudo apt-get install curl
    • curl -sL https://deb.nodesource.com/setup_12.x | sudo -E bash -
    • sudo apt-get install -y nodejs
  12. Build Monkey Island frontend

    • cd to 'monkey_island/cc/ui'
    • npm install sass-loader node-sass webpack --save-dev
    • npm update
    • npm run dist

How to run

  1. From the monkey directory, run python3.7 ./monkey_island.py