diff --git a/README.md b/README.md index fabae8a..e36e691 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,69 @@ -# breach-parse -A tool for parsing breached passwords +# ๐Ÿ” BreachParse: A Powerful Tool for Parsing Breached Passwords +Effortlessly parse through massive databases of breached passwords to discover compromised accounts. BreachParse is your go-to tool for security audits, helping you identify potential vulnerabilities based on breached data. +## ๐Ÿš€ Quick Start Guide +### Step 1: Installation +Get BreachParse up and running in just a few simple steps. Here's how: +1. Clone the repository to user/opt folder (if applicable): +``` +git clone https://github.com/username/breach-parse.git +cd breach-parse +``` +2. Run the installation script with root privileges: +``` +sudo ./install.sh +``` +This script ensures that all dependencies are installed, and BreachParse is set up correctly on your system. +## ๐Ÿ“ฆ Download Breached Password List +To fully utilize BreachParse, youโ€™ll need a comprehensive list of breached passwords. +The most popular compilation of breached passwords can be downloaded via this magnet link: +``` +magnet:?xt=urn:btih:7ffbcd8cee06aba2ce6561688cf68ce2addca0a3&dn=BreachCompilation&tr=udp%3A%2F%2Ftracker.openbittorrent.com%3A80&tr=udp%3A%2F%2Ftracker.leechers-paradise.org%3A6969&tr=udp%3A%2F%2Ftracker.coppersurfer.tk%3A6969&tr=udp%3A%2F%2Fglotorrents.pw%3A6969&tr=udp%3A%2F%2Ftracker.opentrackr.org%3A1337 -### Installation +``` +This magnet link points to a torrent of the "Breach Compilation" โ€” a massive database of breached passwords available for research purposes which size is about 40+GB. +## ๐Ÿ›  Usage Instructions +Once you've downloaded the breached password list, youโ€™re ready to begin parsing. +### Basic Usage Example: +If you store the BreachCompilation data in the default location (/opt/breach-parse), you can simply run the tool without specifying any paths: +``` +breach-parse @gmail.com gmail.txt +``` +### Custom Path: +If you've stored the BreachCompilation in a custom location, specify the path like so: +``` +breach-parse @gmail.com gmail.txt "~/Downloads/BreachCompilation/data" +``` +This command checks for any breached passwords related to Gmail accounts and saves the results in gmail.txt. -Install: `sudo ./install.sh` +### Get Help: +For detailed instructions and available options, simply run: +``` +breach-parse +``` +This will display the available commands and how to use the tool effectively. +### ๐ŸŒŸ Key Features +- Fast Parsing: BreachParse can handle massive breached password lists efficiently. +- Customizable: Easily specify custom paths for your breached data or search for specific domains. +- Security Auditing: Use this tool to audit your organizationโ€™s email accounts for potential password compromises. +- User-Friendly: Designed to be straightforward with simple command-line usage. +## ๐Ÿ“š Additional Information +### Legal Disclaimer: +This tool is intended for research purposes and security audits only. Unauthorized use of breached data is illegal and unethical. +Always ensure that you have the necessary permissions when using this tool. +### Dependencies: +- Operating System: Linux (recommended), macOS +- Go: Install Go if you don't already have it on your system. +- Breach Compilation: The breached password list used by the tool. +## ๐Ÿค Contributing +Contributions are welcome! Feel free to fork the project, submit pull requests, or report issues. -Download breached password list from magnet located here: `magnet:?xt=urn:btih:7ffbcd8cee06aba2ce6561688cf68ce2addca0a3&dn=BreachCompilation&tr=udp%3A%2F%2Ftracker.openbittorrent.com%3A80&tr=udp%3A%2F%2Ftracker.leechers-paradise.org%3A6969&tr=udp%3A%2F%2Ftracker.coppersurfer.tk%3A6969&tr=udp%3A%2F%2Fglotorrents.pw%3A6969&tr=udp%3A%2F%2Ftracker.opentrackr.org%3A1337` +1. Fork the repository. +2. Create a new branch (git checkout -b feature/awesome-feature). +3. Commit your changes (git commit -m 'Add awesome feature'). +4. Push the branch (git push origin feature/awesome-feature). +5. Open a pull request. +## ๐Ÿ“ License +This project is licensed under the MIT License. See the LICENSE file for details. +## ๐Ÿ™Œ Acknowledgements +A big thank you to the open-source community and everyone who has contributed to creating a safer internet by responsibly handling breached data. -If you don't store the password list (BreachCompilation) in `/opt/breach-parse`, specify the location like: - -`breach-parse @gmail.com gmail.txt "~/Downloads/BreachCompilation/data"` - -Run `breach-parse` for instructions \ No newline at end of file