monkey/README.md

69 lines
2.9 KiB
Markdown
Raw Normal View History

2019-11-05 16:19:39 +08:00
# Infection Monkey
2019-10-28 00:44:38 +08:00
[![Build Status](https://travis-ci.com/guardicore/monkey.svg?branch=develop)](https://travis-ci.com/guardicore/monkey)
[![GitHub release (latest by date)](https://img.shields.io/github/v/release/guardicore/monkey)](https://github.com/guardicore/monkey/releases)
![GitHub stars](https://img.shields.io/github/stars/guardicore/monkey)
![GitHub commit activity](https://img.shields.io/github/commit-activity/m/guardicore/monkey)
2019-10-28 00:44:38 +08:00
## Data center Security Testing Tool
2016-07-29 02:24:03 +08:00
Welcome to the Infection Monkey!
The Infection Monkey is an open source security tool for testing a data center's resiliency to perimeter breaches and internal server infection. The Monkey uses various methods to self propagate across a data center and reports success to a centralized Monkey Island server.
2018-02-15 21:09:54 +08:00
<img src=".github/map-full.png" >
<img src=".github/Security-overview.png" width="800" height="500">
2019-11-05 16:19:39 +08:00
2017-10-17 22:14:28 +08:00
The Infection Monkey is comprised of two parts:
2018-01-21 03:49:36 +08:00
* Monkey - A tool which infects other machines and propagates to them
2018-02-22 16:59:04 +08:00
* Monkey Island - A dedicated server to control and visualize the Infection Monkey's progress inside the data center
2017-10-17 22:14:28 +08:00
To read more about the Monkey, visit http://infectionmonkey.com
2019-11-05 16:19:39 +08:00
## Main Features
2017-10-17 22:14:28 +08:00
The Infection Monkey uses the following techniques and exploits to propagate to other machines.
* Multiple propagation techniques:
* Predefined passwords
2017-10-17 22:14:28 +08:00
* Common logical exploits
* Password stealing using Mimikatz
* Multiple exploit methods:
2016-05-29 16:57:13 +08:00
* SSH
* SMB
* WMI
* Shellshock
2017-10-17 22:14:28 +08:00
* Conficker
* SambaCry
* Elastic Search (CVE-2015-1427)
2019-11-05 16:19:39 +08:00
## Setup
2018-03-13 17:08:23 +08:00
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/).
2019-01-23 19:59:00 +08:00
The Infection Monkey supports a variety of platforms, documented [in the wiki](https://github.com/guardicore/monkey/wiki/OS-compatibility).
2019-11-05 16:19:39 +08:00
## 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](infection_monkey) and [monkey_island](monkey_island).
2019-10-28 00:44:38 +08:00
### Build status
| Branch | Status |
| ------ | :----: |
| Develop | [![Build Status](https://travis-ci.com/guardicore/monkey.svg?branch=develop)](https://travis-ci.com/guardicore/monkey) |
| Master | [![Build Status](https://travis-ci.com/guardicore/monkey.svg?branch=master)](https://travis-ci.com/guardicore/monkey) |
2019-11-05 16:19:39 +08:00
## Tests
### Unit Tests
In order to run all of the Unit Tests, run the command `python -m pytest` in the `monkey` directory.
### Blackbox tests
In order to run the Blackbox tests, refer to `envs/monkey_zoo/blackbox/README.md`.
# License
2018-05-01 20:12:30 +08:00
Copyright (c) Guardicore Ltd
2017-10-17 22:14:28 +08:00
2018-01-21 03:49:36 +08:00
See the [LICENSE](LICENSE) file for license rights and limitations (GPLv3).