diff --git a/.gitignore b/.gitignore index bee8a64..20bd586 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1 @@ -__pycache__ +redbaron/data/plugins/ diff --git a/README.md b/README.md index 7538e65..d9a81f2 100644 --- a/README.md +++ b/README.md @@ -3,284 +3,31 @@

-- [Overlord – Red Teaming Automation](#overlord-%e2%80%93-red-teaming-automation) -- [Installation](#installation) -- [Documentation](#documentation) - - [Projects](#projects) - - [Supported Providers](#supported-providers) - - [Variables](#variables) - - [Modules](#modules) - - [c2](#c2) - - [dns_records](#dnsrecords) - - [Type](#type) - - [Record](#record) - - [Name](#name) - - [gophish](#gophish) - - [letsencrypt](#letsencrypt) - - [mail](#mail) - - [redirector](#redirector) - - [webserver](#webserver) - - [godaddy](#godaddy) -- [Arguments](#arguments) - - [Help](#help) - - [Advanced Configuration](#advanced-configuration) - - [Installation Templates](#installation-templates) - - [Default Configuration File](#default-configuration-file) -- [RedBaron](#redbaron) - - [Notes](#notes) - - [Firewall rules](#firewall-rules) +Overlord provides a python-based console CLI which is used to build Red Teaming infrastructure in an automated way. The user has to provide inputs by using the tool’s modules (e.g. C2, Email Server, HTTP web delivery server, Phishing server etc.) and the full infra / modules and scripts will be generated automatically on a cloud provider of choice. Currently supports AWS and Digital Ocean. The tool is still under development and it was inspired and uses the [Red-Baron](https://github.com/byt3bl33d3r/Red-Baron) Terraform implementation found on Github. +A demo infrastructure was set up in our blog post https://blog.qsecure.com.cy/posts/overlord/. -This tool provides a python-based console CLI which is used to build Red Teaming infrastructure in an automated way. The user has to provide inputs by using the tool’s modules (e.g. C2, Email Server, HTTP web delivery server, Phishing server etc.) and the full infra / modules and scripts will be generated automatically on a cloud provider of choice. Currently supports AWS and Digital Ocean. The tool is still under development and it was inspired and uses the [Red-Baron](https://github.com/byt3bl33d3r/Red-Baron) Terraform implementation found on Github. +For the full documentation of the tool visit the Wiki tab at https://github.com/qsecure-labs/overlord/wiki. -A demo infrastructure was set up in our blog post https://blog.qsecure.com.cy/posts/overlord/ . - -It was only tested on Kali Linux but it probably work on all Linux x64 systems. # Installation ```bash -git clone overlord /opt/overlord -cd /opt/overlord/config -./install.sh -``` -# Documentation -## Projects -Overlord has build in functionality for project management. From the cli you can manage each project by loading the configuration file with the `load` command. When you deploy the project again, the modifications will be pushed to the providers. For more information visit the [Help](#help). -## Supported Providers - - Digital Ocean - - AWS - - Godaddy -## Variables -The `set` command can be used to initialize the API keys to communicate with the providers. The domains variable can be used to add domain names into the overlord project. -``` -aws_access_key aws_secret_key domains dotoken godaddy_access_key godaddy_secret_key -``` -The `./projects/variables.json` can be used to auto load the keys used to authenticate with each of the supported providers and the domain names. When you first set the arguments into your campaign you can save them using the `set variables` command which will create the `variables.json` file. -## Modules -### c2 -Creates a C2 server of the provider of choice on the cloud. The types available are HTTP/DNS. SSH keys for each instance will be generated in the ```redbaron/data/ssh_keys``` folder. - -|Variable |Required |Description | -|--- |--- |--- | -|`id` |N/A |Module ID Autogenerated | -|`type` |Yes |Type of c2 Accepted values are: HTTP/DNS. | -|`provider` |Yes |Provider to be used | -|`region` |Yes |Regions to create server instance | -|`size` |Yes |Instance size to launch | -|`redirectors`|Yes |Number of redirectors to launch for each c2. It can be 0. | -|`tools` |No |Tools to be installed on instance creation. | - -The tools which are currently available for automatic installation on the C2 servers are the following: -- metasploit -- empire -- dnscat2 -- cobaltstrike (The `CSTRIKE_KEY` variable has to be set in the `./redbaron/data/scripts/tools/cobaltstrike.sh` script) -- The PenTesters Framework `(PTF)` (A library of penetration testing tools. You can modify what you want to install by changing the `./redbaron/data/scripts/tools/ptf.sh` script. For more information about the project visit: https://github.com/trustedsec/ptf) - -### dns_records -Adds records to a domain. - -|Variable |Required |Description | -|--- |--- |--- | -|`id` |N/A |Module ID Autogenerated | -|`provider` |Yes |Provider to be used | -|`type` |Yes |The record type to add. | -|`record` |Yes |The record to add. See record section. | -|`name` |Yes |Name of the subdomain | -|`priority` |No |Used for mail server. Default 1. | -|`ttl` |No |Time to live | - -#### Type -Valid values are A, MX and TXT. -#### Record -The record to add. -``` -A: set record -m -d -TXT: set record -d -t