Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/htrgouvea/spellbook
Framework for rapid development of offensive security tools
https://github.com/htrgouvea/spellbook
bugbounty ctf exploit framework offensive-security pentest perl security security-tools
Last synced: 13 days ago
JSON representation
Framework for rapid development of offensive security tools
- Host: GitHub
- URL: https://github.com/htrgouvea/spellbook
- Owner: htrgouvea
- License: other
- Created: 2016-07-11T14:36:28.000Z (over 8 years ago)
- Default Branch: main
- Last Pushed: 2024-07-01T23:38:48.000Z (6 months ago)
- Last Synced: 2024-07-29T20:08:07.359Z (6 months ago)
- Topics: bugbounty, ctf, exploit, framework, offensive-security, pentest, perl, security, security-tools
- Language: Perl
- Homepage: https://heitorgouvea.me/
- Size: 69.3 MB
- Stars: 97
- Watchers: 8
- Forks: 22
- Open Issues: 21
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
- awesome-security-collection - **36**星
README
Spellbook
A framework for rapid development of reusable security tools
---
### Summary
Spellbook uses FBP: "In computer programming, flow-based programming (FBP) is a programming paradigm that defines applications as networks of "black box" processes, which exchange data across predefined connections by message passing, where the connections are specified externally to the processes. These black box processes can be reconnected endlessly to form different applications without having to be changed internally. FBP is thus naturally component-oriented." [[1]](https://en.wikipedia.org/wiki/Flow-based_programming)
The main focus of this “micro-framework” is turn in reality the rapid development of security tools using reusable patterns of FBP.
"Third clark law: any sufficiently advanced technology is indistinguishable from magic" - that's why this project is called spellbook.
---
### Download and install
```bash
# Download
$ git clone https://github.com/htrgouvea/spellbook && cd spellbook
# Install libs and dependencies
$ cpanm --installdeps .
```
---
### How to use
```
Spellbook v0.3.6
Core Commands
==============
Command Description
------- -----------
-s, --search List modules, you can filter by category
-m, --module Set a module to use
-h, --help To see help menu of a module
```
### Example
```
# Searching for exploits
$ ./spellbook.pl --search advisory
Module: Advisory::CVE_2017_5487
Description: Read usernames leaked on WordPress API
=================================================
Module: Advisory::CVE_2006_3392
Description: Read arbitrary files for servers running Webmin before 1.290 and Usermin before 1.220
=================================================
Module: Advisory::CVE_2016_10045
Description: PHPMailer < 5.2.20 Remote Code Execution PoC 0day Exploit (CVE-2016-10045) (Bypass of the CVE-2016-1033 patch)
=================================================
Module: Advisory::CVE_2021_41773
Description: Exploit path Traversal or RCE in Apache HTTP Server 2.4
=================================================
Module: Advisory::CVE_2023_29489
Description: Exploit for cPanel Reflected XSS - CVE-2023-29489
=================================================
[...]
```
```
# Using an exploit
$ perl spellbook.pl -m Advisory::CVE_2006_3392 --help
Advisory::CVE_2006_3392
=======================
-h, --help See this menu
-t, --target Define a target
-f, --file Define a file to read
```
```
$ perl spellbook.pl -m Advisory::CVE_2006_3392 -t http://172.30.0.15:10000/ -f /etc/passwd
root:x:0:0:root:/root:/bin/bash
daemon:x:1:1:daemon:/usr/sbin:/bin/sh
bin:x:2:2:bin:/bin:/bin/sh
sys:x:3:3:sys:/dev:/bin/sh
sync:x:4:65534:sync:/bin:/bin/sync
games:x:5:60:games:/usr/games:/bin/sh
[...]
```
If you are interested in developing new modules, a good start point is to read the [development guide](/wiki/Developer-Guide).
---
### Docker container
```
$ docker build -t spellbook .
$ docker run -ti --rm spellbook --search exploits
```
---
### Contribution
Your contributions and suggestions are heartily ♥ welcome. [See here the contribution guidelines.](/.github/CONTRIBUTING.md) Please, report bugs via [issues page](https://github.com/htrgouvea/spellbook/issues) and for security issues, see here the [security policy.](/SECURITY.md) (✿ ◕‿◕)
---
### License
This work is licensed under [MIT License.](/LICENSE.md)