Skip to content

Commit ff861e3

Browse files
Readme update
1 parent 46e91ca commit ff861e3

File tree

1 file changed

+26
-3
lines changed

1 file changed

+26
-3
lines changed

README.md

Lines changed: 26 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,35 @@
22
EasyEASM repository for Black Hat Arsenal 2023
33

44
# Description
5-
Easy EASM is just that... the easiest to set-up tool to give your organization visibility into its external facing assets.
5+
Easy EASM is just that... the easiest to set-up tool to give your organization visibility into its external facing assets.
66

77
The industry is dominated by $30k vendors selling "Attack Surface Management," but OG bug bounty hunters and red teamers know the truth. External ASM was born out of the bug bounty scene. Most of these $30k vendors use this open-source tooling on the backend.
88

99
With ten lines of setup or less, using open source tools, and one button deployment, Easy EASM will give your organization a complete view of your online assets. Easy EASM scans you daily and alerts you via Slack or Discord on newly found assets! Easy EASM also spits out an Excel skeleton for a Risk Register or Asset Database! This isn't rocket science.. but it's USEFUL. Don't get scammed. Grab Easy EASM and feel confident you know what's facing attackers on the internet.
1010

11-
Easy EASM uses a collection of tools tied together to perform recon on a target or set of targets. Utilizing Amass, Subfinder, Chaos, Notify, r7 Sonar, eyewitness, and Cloud Certs. It will run daily and track all assets discovered for your targets. With a Discord or Slack key, you'll get this output to chat every morning if any new assets have appeared. You can choose the "fast" or "comprehensive" deployment, which adds additional methods to the discovery (brute force, permutation discovery, screenshots, and tech profiling).
11+
# Installation
12+
```sh
13+
go install github.com/g0ldencybersec/EasyEASM/easyeasm@latest
14+
```
1215

13-
BUT... literally, all the user does is one-click deploy and add a Slack or Discord token. Then they start receiving bacon... I mean recon... I mean EASM data.
16+
# Example Config file
17+
The tool will expect a configuration file named "config.yml" to be in the directory you are running from. An example of this yml file is below:
18+
```yaml
19+
# EasyEASM configurations
20+
runConfig:
21+
domains: # List root domains here.
22+
- example.com
23+
- mydomain.com
24+
slack: https://hooks.slack.com/services/DUMMYDATA/DUMMYDATA/RANDOM # Slack webhook url for slack notificaitions.
25+
discord: https://discord.com/api/webhooks/DUMMYURL/Dasdfsdf # Discord webhook for discord notifications.
26+
runType: fast # Set to either fast (Passive enum) or complete (Active enumeration).
27+
activeWordList: subdomainWordlist.txt
28+
activeThreads: 100
29+
```
30+
31+
# Running the tool
32+
To run the tool, fill out the config file then simply run the easyeasm module:
33+
```sh
34+
$ ./easyeasm
35+
```
36+
After the run is complete you should see the output CSV (EasyEASM.csv) in the run directory. This can be added to your asset database and risk register!

0 commit comments

Comments
 (0)