Metadata-Version: 2.1
Name: shellcrafter
Version: 1.0.2
Summary: A package containing scripts for developing and generating shellcode
Author: totekuh
Author-email: totekuh@protonmail.com
Requires-Dist: numpy
Requires-Dist: keystone-engine
Requires-Dist: termcolor
Requires-Dist: rich
Requires-Dist: ropper
Requires-Dist: capstone

# Shellcrafter

Shellcrafter is a package containing scripts for developing and generating shellcode. 

It provides a collection of utilities for working with shellcode in various ways, such as generating shellcode from assembly instructions, computing hashes from function names, converting ASCII text to hex stack push instructions, and finding ROP gadgets.

## Installation

To install Shellcrafter, use pip:

```bash
pip3 install shellcrafter
```

Or clone this repository and run:

```bash
pip3 install .
```


## Usage

Shellcrafter provides the following command-line utilities:

- `keyst-api`: A shellcode generator using the Keystone Engine to assemble assembly instructions into shellcode.
- `compute-hashes-from-function-name`: Computes the hash for a given function name using the ROR operation.
- `ascii-to-push`: Converts an ASCII string to a series of x86 PUSH instructions that represent the given string as hexadecimal values.
- `find-gadgets`: Searches for clean, categorized gadgets from a given list of files.

To get help on how to use each utility, run the corresponding command with the `-h` or `--help` flag:

```bash
keyst-api --help
compute-hashes-from-function-name --help
ascii-to-push --help
find-gadgets --help
```
