From 156ad4a4e71a8b1959d3fb910e48d78cdccbd031 Mon Sep 17 00:00:00 2001 From: Itay Mizeretz Date: Wed, 18 Oct 2017 18:15:07 +0300 Subject: [PATCH] Revert "Remove configuration and license detail" This reverts commit dc698345930f27b20a0fdf258fad9fd2faa5ee5c. --- README.md | 82 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 82 insertions(+) diff --git a/README.md b/README.md index 6eb25429b..bb331007e 100644 --- a/README.md +++ b/README.md @@ -95,6 +95,50 @@ Wait for monkeys using the tunnel to unregister for it Cleanup Remove firewall rules if added +Configuration Options +--------------------- + +Key | Type | Description | Possible Values +--- | ---- | ----------- | --------------- +alive | bool | sets whether or not the monkey is alive. if false will stop scanning and exploiting +command_servers | array | addresses of c&c servers to try to connect | example: ["russian-mail-brides.com:5000"] +singleton_mutex_name | string | string of the mutex name for single instance | example: {2384ec59-0df8-4ab9-918c-843740924a28} +self_delete_in_cleanup | bool | sets whether or not to self delete the monkey executable when stopped +use_file_logging | bool | sets whether or not to use a log file +monkey_log_path_[windows/linux] | string | file path for monkey logger. +kill_file_path_[windows/linux] | string | file path that the Monkey checks to prevent running +timeout_between_iterations | int | how long to wait between scan iterations +max_iterations | int | how many scan iterations to perform on each run +internet_services | array | addresses of internet servers to ping and check if the monkey has internet acccess +victims_max_find | int | how many victims to look for in a single scan iteration +victims_max_exploit | int | how many victims to exploit before stopping +retry_failed_explotation | bool | sets whether or not to retry failed hosts on next scan +local_network_scan | bool | sets whether to auto detect and scan local subnets +range_class | class name | sets which ip ranges class is used to construct the list of ips to scan | `FixedRange` - scan list is a static ips list, `RelativeRange` - scan list will be constructed according to ip address of the machine and size of the scan, `ClassCRange` - will scan the entire class c the machine is in. +range_fixed | tuple of strings | list of ips to scan +RelativeRange range_size | int | number of hosts to scan in relative range +scanner_class | class name | sets which scan class to use when scanning for hosts to exploit | `TCPScanner` - searches for hosts according to open tcp ports, `PingScanner` - searches for hosts according to ping scan +finger_classes | tuple of class names | sets which fingerprinting classes to use | in the list: `SMBFinger` - get host os info by checking smb info, `SSHFinger` - get host os info by checking ssh banner, `PingScanner` - get host os type by checking ping ttl. For example: `(SMBFinger, SSHFinger, PingScanner)` +exploiter_classes | tuple of class names | | `SmbExploiter` - exploit using smb connection, `WmiExploiter` - exploit using wmi connection, `RdpExploiter` - exploit using rdp connection, `Ms08_067_Exploiter` - exploit using ms08_067 smb exploit, `SSHExploiter` - exploit using ssh connection +tcp_target_ports | list of int | which ports to scan using TCPScanner +tcp_scan_timeout | int | timeout for tcp connection in tcp scan (in milliseconds) +tcp_scan_interval | int | time to wait between ports in the tcp scan (in milliseconds) +tcp_scan_get_banner | bool | sets whether or not to read a banner from the tcp ports when scanning +ping_scan_timeout | int | timeout for the ping command (in milliseconds) utilised by PingScanner +skip_exploit_if_file_exist | bool | sets whether or not to abort exploit if the monkey already exists in target, used by SmbExploiter +psexec_user | string | user to use for connection, utilised by SmbExploiter/WmiExploiter/RdpExploiter +psexec_passwords | list of strings | list of passwords to use when trying to exploit +rdp_use_vbs_download | bool | sets whether to use vbs payload for rdp exploitation in RdpExploiter. If false, bits payload is used (will fail if bitsadmin.exe doesn’t exist) +ms08_067_exploit_attempt | int | number of times to try and exploit using ms08_067 exploit +ms08_067_remote_user_add | string | user to add to target when using ms08_067 exploit +ms08_067_remote_user_pass | string | password of the user the exploit will add +ssh_user | string | user to use for ssh connection, used by SSHExploiter +ssh_passwords | list of strings | list of passwords to use when trying to exploit using SSHExploiter +dropper_set_date | bool | whether or not to change the monkey file date to match other files +dropper_target_path_[windows/linux] | string | path for the dropper +serialize_config | bool | sets whether or not to locally save the running configuration after finishing + + Building the Monkey from source ------------------------------- If you want to build the monkey from source instead of using our provided packages, follow the instructions at the readme files under [chaos_monkey](chaos_monkey) and [monkey_island](monkey_island). @@ -106,3 +150,41 @@ Copyright (c) 2016 Guardicore Ltd See the [LICENSE](LICENSE) file for license rights and limitations (GPLv3). +Dependent packages +--------------------- + +Dependency | License | +----------------------------|---------------------------- + libffi-dev | https://github.com/atgreen/libffi/blob/master/LICENSE + PyCrypto | Public domain + upx | Custom license, http://upx.sourceforge.net/upx-license.html + bson | BSD + enum34 | BSD + pyasn1 | BSD + psutil | BSD + flask | BSD + flask-Pymongo | BSD + Flask-Restful | BSD + python-dateutil | Simplified BSD + zope | ZPL 2.1 + Bootstrap | MIT + Bootstrap Switch | Apache 2.0 + Bootstrap Dialog | MIT + JSON Editor | MIT + Datatables | MIT + jQuery | MIT + cffi | MIT + twisted | MIT + typeahead.js | MIT + Font Awesome | MIT + vis.js | MIT/Apache 2.0 + impacket | Apache Modified + Start Bootstrap (UI Theme) | Apache 2.0 + requests | Apache 2.0 + grequests | BSD + odict | Python Software Foundation License + paramiko | LGPL + rdpy | GPL-3 + winbind | GPL-3 + pyinstaller | GPL + Celery | BSD