Getting Started
Getting started with Sooty begins by downloading or cloning the repo. Assuming Python3 is installed, simply navigate to the directory, install from the requirements.txt file, and Sooty will be up and running. Sooty can be launched with the command python3 Sooty. More specific details can be found below:
- Requires Python 3.x
- Install all dependencies from the requirements.txt file.
pip install -r requirements.txt - Update any API Keys you wish to use in the
example_config.yamlfile and rename toconfig.yaml - Supported API keys are as follows:
- For PhishTank support, an unique app name is also required as an additional field. Simply update the
config.yamlfile with your unique name.
Sooty has been developed with several menu options, each containing further options contained within. The diagram below can be used as a quick reference for locating tools if you are unsure of where to find them.
└── Main Menu
├── Sanitize URL's for use in emails
| └── URL Sanitizing Tool
├── Decoders
| ├── ProofPoint Decoder
| ├── URL Decoder
| ├── Office Safelinks Decoder
| ├── URL Unshortener
| ├── Base 64 Decoder
| └── Cisco Password 7 Decoder
├── Reputation Checker
| └── Reputation Checker for IP's, URL's or email addresses
├── DNS Tools
| ├── Reverse DNS Lookup
| ├── DNS Lookup
| └── WhoIs Lookup
├── Hashing Functions
| ├── Hash a File
| ├── Hash a Text Input
| ├── Check a hash for known malicious activity
| └── Hash a file and check for known malicious activity
├── Phishing Analysis
| ├── Analyze an Email
| ├── Analyze an email address for known malicious activity
| ├── Generate an email template based on analysis
| ├── Analyze a URL with Phishtank
| ├── HaveIBeenPwned Lookup
├── URL Scan
| └── URLScan.io lookup
├── Extra's
| ├── About
| ├── Contributors
| ├── Version
| ├── Wiki
| └── Github Repo
└── Exit