Merge pull request #769 from guardicore/release/1.9.0

Release/1.9.0

.github/ISSUE_TEMPLATE/Bug_report.md

@@ -1,29 +1,32 @@
----
-name: 🐛 Bug report
-about: Create a report to help us fix things!
-
----
-
-<!--
-Thank you for reporting a bug to make Infection Monkey better.
-
-Please fill in as much of the template below as you're able.
--->
-
-## Describe the bug
-A clear and concise description of what the bug is.
-
-## To Reproduce
-Steps to reproduce the behavior:
-1. Configure the Monkey with X settings
-2. Run the monkey on specific machine
-3. See error
-
-## Expected behavior
-A description of what you expected to happen.
-
-## Screenshots
-If applicable, add screenshots to help explain your problem.
-
-## Machine version (please complete the following information):
- - OS: Windows or Linux
+---
+name: "\U0001F41B Bug report"
+about: Create a report to help us fix things!
+title: ''
+labels: Bug
+assignees: ''
+
+---
+
+<!--
+Thank you for reporting a bug to make Infection Monkey better.
+
+Please fill in as much of the template below as you're able.
+-->
+
+## Describe the bug
+A clear and concise description of what the bug is.
+
+## To Reproduce
+Steps to reproduce the behavior:
+1. Configure the Monkey with X settings
+2. Run the monkey on specific machine
+3. See error
+
+## Expected behavior
+A description of what you expected to happen.
+
+## Screenshots
+If applicable, add screenshots to help explain your problem.
+
+## Machine version (please complete the following information):
+ - OS: Windows or Linux

.github/ISSUE_TEMPLATE/Documentation_request.md

@@ -0,0 +1,28 @@
+---
+name: "\U0001F4C3 Documentation request"
+about: Suggest additions or fixes to our documentation hub!
+title: ''
+labels: Documentation
+assignees: ''
+
+---
+
+## Documentation request
+
+<!-- Choose: adding a new page, or edit existing content. -->
+
+### Add a new page 🆕
+
+**What documentation you'd like us to add?**
+Put suggestion here.
+
+**Where in the documentation tree?**
+Put section here.
+
+### Edit existing content 📝
+
+**Which page(s) do you want us to edit?**
+Put link here.
+
+**What do you think should be changed?**
+Put requested changes here.

.github/ISSUE_TEMPLATE/Feature_request.md

@@ -1,6 +1,9 @@
 ---
 name: "\U0001F680 Feature request"
 about: Suggest an idea for this project
+title: ''
+labels: Feature
+assignees: ''
 
 ---
 
@@ -17,4 +20,4 @@ Please describe the problem you are trying to solve.
 Please describe the desired behavior.
 
 **Describe alternatives you've considered**
-Please describe alternative solutions or features you have considered.
+Please describe alternative solutions or features you have considered.

.gitignore

@@ -90,3 +90,9 @@ profiler_logs/
 
 # vim swap files
 *.swp
+
+# Server config might contain credentials. Don't commit by default.
+/monkey/monkey_island/cc/server_config.json
+
+# Virtualenv
+venv/

.gitmodules

@@ -2,3 +2,6 @@
 [submodule "monkey/monkey_island/cc/services/attack/attack_data"]
 	path = monkey/monkey_island/cc/services/attack/attack_data
 	url = https://github.com/guardicore/cti
+[submodule "docs/themes/learn"]
+	path = docs/themes/learn
+	url = https://github.com/ShayNehmad/hugo-theme-learn.git

.travis.yml

@@ -18,10 +18,14 @@ os: linux
 
 install:
 # Python
+- pip freeze
 - pip install -r monkey/monkey_island/requirements.txt  # for unit tests
-- pip install flake8 pytest dlint  # for next stages
+- pip install flake8 pytest dlint isort # for next stages
 - pip install coverage  # for code coverage
 - pip install -r monkey/infection_monkey/requirements.txt  # for unit tests
+- pip install pipdeptree
+# Fail builds on possible conflicting dependencies.
+- pipdeptree --warn fail
 
 # node + npm + eslint
 - node --version
@@ -33,6 +37,17 @@ install:
 - node --version
 - npm --version
 
+# linuxbrew (for hugo)
+- git clone https://github.com/Homebrew/brew ~/.linuxbrew/Homebrew
+- mkdir ~/.linuxbrew/bin
+- ln -s ~/.linuxbrew/Homebrew/bin/brew ~/.linuxbrew/bin
+- eval $(~/.linuxbrew/bin/brew shellenv)
+
+# hugo (for documentation)
+- brew install hugo
+# print hugo version (useful for debugging documentation build errors)
+- hugo version
+
 before_script:
 # Set the server config to `testing`. This is required for for the UTs to pass.
 - python monkey/monkey_island/cc/set_server_config.py testing
@@ -54,6 +69,9 @@ script:
 - PYTHON_WARNINGS_AMOUNT_UPPER_LIMIT=120
 - if [ $(tail -n 1 flake8_warnings.txt) -gt $PYTHON_WARNINGS_AMOUNT_UPPER_LIMIT ]; then echo "Too many python linter warnings! Failing this build. Lower the amount of linter errors in this and try again. " && exit 1; fi
 
+## Check import order
+- python -m isort . -c -p common -p infection_monkey -p monkey_island
+
 ## Run unit tests
 - cd monkey  # This is our source dir
 - python -m pytest  # Have to use `python -m pytest` instead of `pytest` to add "{$builddir}/monkey/monkey" to sys.path.
@@ -65,9 +83,13 @@ script:
 - cd monkey_island/cc/ui
 - npm ci  # See https://docs.npmjs.com/cli/ci.html
 - eslint ./src --quiet  # Test for errors
-- JS_WARNINGS_AMOUNT_UPPER_LIMIT=490
+- JS_WARNINGS_AMOUNT_UPPER_LIMIT=28
 - eslint ./src --max-warnings $JS_WARNINGS_AMOUNT_UPPER_LIMIT  # Test for max warnings
 
+# Build documentation
+- cd $TRAVIS_BUILD_DIR/docs
+- hugo --verbose --environment staging
+
 after_success:
   # Upload code coverage results to codecov.io, see https://github.com/codecov/codecov-bash for more information
   - bash <(curl -s https://codecov.io/bash)

README.md

@@ -51,17 +51,16 @@ The Infection Monkey uses the following techniques and exploits to propagate to
   * SambaCry
   * Elastic Search (CVE-2015-1427)
   * Weblogic server
-  * and more
+  * and more, see our [Documentation hub](https://www.guardicore.com/infectionmonkey/docs/reference/exploiters/) for more information about our RCE exploiters.
 
 ## Setup
-Check out the [Setup](https://github.com/guardicore/monkey/wiki/setup) page in the Wiki or a quick getting [started guide](https://www.guardicore.com/infectionmonkey/wt/).
+Check out the [Setup](https://www.guardicore.com/infectionmonkey/docs/setup/) page in the Wiki or a quick getting [started guide](https://www.guardicore.com/infectionmonkey/docs/usage/getting-started/).
 
-The Infection Monkey supports a variety of platforms, documented [in the wiki](https://github.com/guardicore/monkey/wiki/OS-compatibility).
+The Infection Monkey supports a variety of platforms, documented [in our documentation hub](https://www.guardicore.com/infectionmonkey/docs/reference/operating_systems_support/).
 
 ## Building the Monkey from source
-To deploy development version of monkey you should refer to readme in the [deployment scripts](deployment_scripts) folder.
-If you only want to build the monkey from source, see [Setup](https://github.com/guardicore/monkey/wiki/Setup#compile-it-yourself)
-and follow the instructions at the readme files under [infection_monkey](monkey/infection_monkey) and [monkey_island](monkey/monkey_island). 
+To deploy development version of monkey you should refer to readme in the [deployment scripts](deployment_scripts) 
+folder or follow documentation in [documentation hub](https://www.guardicore.com/infectionmonkey/docs/development/setup-development-environment/).
 
 ### Build status
 | Branch | Status |

deployment_scripts/config

@@ -1,21 +1,44 @@
 #!/usr/bin/env bash
 # Absolute monkey's path
-MONKEY_FOLDER_NAME="infection_monkey"
+export MONKEY_FOLDER_NAME="infection_monkey"
 # Url of public git repository that contains monkey's source code
-MONKEY_GIT_URL="https://github.com/guardicore/monkey"
+export MONKEY_GIT_URL="https://github.com/guardicore/monkey"
+
+get_latest_release() {
+  curl --silent "https://api.github.com/repos/$1/releases/latest" | # Get latest release from GitHub API
+    grep '"tag_name":' |                                            # Get tag line
+    sed -E 's/.*"([^"]+)".*/\1/'                                    # Pluck JSON value
+}
+
+MONKEY_LATEST_RELEASE=$(get_latest_release "monkey/guardicore")
 
 # Monkey binaries
-LINUX_32_BINARY_URL="https://github.com/guardicore/monkey/releases/download/v1.7.0/monkey-linux-32"
 LINUX_32_BINARY_NAME="monkey-linux-32"
-LINUX_64_BINARY_URL="https://github.com/guardicore/monkey/releases/download/v1.7.0/monkey-linux-64"
+LINUX_32_BINARY_URL="https://github.com/guardicore/monkey/releases/download/$($MONKEY_LATEST_RELEASE)/monkey-linux-32"
+export LINUX_32_BINARY_URL
+export LINUX_32_BINARY_NAME
+
 LINUX_64_BINARY_NAME="monkey-linux-64"
-WINDOWS_32_BINARY_URL="https://github.com/guardicore/monkey/releases/download/v1.7.0/monkey-windows-32.exe"
+LINUX_64_BINARY_URL="https://github.com/guardicore/monkey/releases/download/$($MONKEY_LATEST_RELEASE)/monkey-linux-64"
+export LINUX_64_BINARY_URL
+export LINUX_64_BINARY_NAME
+
 WINDOWS_32_BINARY_NAME="monkey-windows-32.exe"
-WINDOWS_64_BINARY_URL="https://github.com/guardicore/monkey/releases/download/v1.7.0/monkey-windows-64.exe"
+WINDOWS_32_BINARY_URL="https://github.com/guardicore/monkey/releases/download/$($MONKEY_LATEST_RELEASE)/monkey-windows-32.exe"
+export WINDOWS_32_BINARY_URL
+export WINDOWS_32_BINARY_NAME
+
 WINDOWS_64_BINARY_NAME="monkey-windows-64.exe"
+WINDOWS_64_BINARY_URL="https://github.com/guardicore/monkey/releases/download/$($MONKEY_LATEST_RELEASE)/monkey-windows-64.exe"
+export WINDOWS_64_BINARY_URL
+export WINDOWS_64_BINARY_NAME
 
 # Other binaries for monkey
-TRACEROUTE_64_BINARY_URL="https://github.com/guardicore/monkey/releases/download/v1.7.0/traceroute64"
-TRACEROUTE_32_BINARY_URL="https://github.com/guardicore/monkey/releases/download/v1.7.0/traceroute32"
-SAMBACRY_64_BINARY_URL="https://github.com/guardicore/monkey/releases/download/v1.7.0/sc_monkey_runner64.so"
-SAMBACRY_32_BINARY_URL="https://github.com/guardicore/monkey/releases/download/v1.7.0/sc_monkey_runner32.so"
+TRACEROUTE_64_BINARY_URL="https://github.com/guardicore/monkey/releases/download/$($MONKEY_LATEST_RELEASE)/traceroute64"
+export TRACEROUTE_64_BINARY_URL
+TRACEROUTE_32_BINARY_URL="https://github.com/guardicore/monkey/releases/download/$($MONKEY_LATEST_RELEASE)/traceroute32"
+export TRACEROUTE_32_BINARY_URL
+SAMBACRY_64_BINARY_URL="https://github.com/guardicore/monkey/releases/download/$($MONKEY_LATEST_RELEASE)/sc_monkey_runner64.so"
+export SAMBACRY_64_BINARY_URL
+SAMBACRY_32_BINARY_URL="https://github.com/guardicore/monkey/releases/download/$($MONKEY_LATEST_RELEASE)/sc_monkey_runner32.so"
+export SAMBACRY_32_BINARY_URL

deployment_scripts/config.ps1

@@ -1,12 +1,14 @@
 # Absolute monkey's path
 $MONKEY_FOLDER_NAME = "infection_monkey"
 # Url of public git repository that contains monkey's source code
+$MONKEY_REPO = "guardicore/monkey"
 $MONKEY_GIT_URL = "https://github.com/guardicore/monkey"
 $MONKEY_RELEASES_URL = $MONKEY_GIT_URL + "/releases"
-$MONKEY_LATEST_VERSION = "v1.7.0"
+$MONKEY_API_RELEASES_URL = "https://api.github.com/repos/$MONKEY_REPO/releases"
+$MONKEY_LATEST_VERSION = (Invoke-WebRequest $MONKEY_API_RELEASES_URL | ConvertFrom-Json)[0].tag_name
 $MONKEY_DOWNLOAD_URL = $MONKEY_RELEASES_URL + "/download/" + $MONKEY_LATEST_VERSION + "/"
 # Link to the latest python download or install it manually
-$PYTHON_URL = "https://www.python.org/ftp/python/3.7.6/python-3.7.6-amd64.exe"
+$PYTHON_URL = "https://www.python.org/ftp/python/3.7.7/python-3.7.7-amd64.exe"
 
 
 # Monkey binaries
@@ -29,8 +31,6 @@ $TRACEROUTE_32_BINARY_URL = $MONKEY_DOWNLOAD_URL + "traceroute32"
 $MONKEY_ISLAND_DIR = Join-Path "\monkey" -ChildPath "monkey_island"
 $MONKEY_DIR = Join-Path "\monkey" -ChildPath "infection_monkey"
 $SAMBA_BINARIES_DIR = Join-Path -Path $MONKEY_DIR -ChildPath "\bin"
-$MK32_DLL = "mk32.zip"
-$MK64_DLL = "mk64.zip"
 $TEMP_PYTHON_INSTALLER = ".\python.exe"
 $TEMP_MONGODB_ZIP = ".\mongodb.zip"
 $TEMP_OPEN_SSL_ZIP = ".\openssl.zip"
@@ -44,6 +44,4 @@ $MONGODB_URL = "https://downloads.mongodb.org/win32/mongodb-win32-x86_64-2012plu
 $OPEN_SSL_URL = "https://indy.fulgan.com/SSL/openssl-1.0.2u-x64_86-win64.zip"
 $CPP_URL = "https://go.microsoft.com/fwlink/?LinkId=746572"
 $NPM_URL = "https://nodejs.org/dist/v12.14.1/node-v12.14.1-x64.msi"
-$MK32_DLL_URL = "https://github.com/guardicore/mimikatz/releases/download/1.1.0/mk32.zip"
-$MK64_DLL_URL = "https://github.com/guardicore/mimikatz/releases/download/1.1.0/mk64.zip"
 $UPX_URL = "https://github.com/upx/upx/releases/download/v3.96/upx-3.96-win64.zip"

deployment_scripts/deploy_windows.ps1

@@ -226,20 +226,6 @@ function Deploy-Windows([String] $monkey_home = (Get-Item -Path ".\").FullName,
         Remove-Item $TEMP_UPX_ZIP
     }
 
-    # Download mimikatz binaries
-    $mk32_path = Join-Path -Path $binDir -ChildPath $MK32_DLL
-    if (!(Test-Path -Path $mk32_path))
-    {
-        "Downloading mimikatz 32 binary"
-        $webClient.DownloadFile($MK32_DLL_URL, $mk32_path)
-    }
-    $mk64_path = Join-Path -Path $binDir -ChildPath $MK64_DLL
-    if (!(Test-Path -Path $mk64_path))
-    {
-        "Downloading mimikatz 64 binary"
-        $webClient.DownloadFile($MK64_DLL_URL, $mk64_path)
-    }
-
     # Download sambacry binaries
     $samba_path = Join-Path -Path $monkey_home -ChildPath $SAMBA_BINARIES_DIR
     $samba32_path = Join-Path -Path $samba_path -ChildPath $SAMBA_32_BINARY_NAME

docs/.gitignore

@@ -0,0 +1,2 @@
+/public/
+/resources/_gen/

docs/README.md

@@ -0,0 +1,5 @@
+# Monkey documentation
+
+This folder contains the Monkey Documentation site.
+
+For more information see `content/development/contribute-documentation.md`.

docs/archetypes/default.md

@@ -0,0 +1,6 @@
+---
+title: "{{ replace .Name "-" " " | title }}"
+date: {{ .Date }}
+draft: true
+---
+