mirror of
https://github.com/dstotijn/hetty
synced 2024-11-10 06:04:19 +00:00
159 lines
5.5 KiB
Markdown
159 lines
5.5 KiB
Markdown
<img src="https://user-images.githubusercontent.com/983924/156430531-6193e187-7400-436b-81c6-f86862783ea5.svg#gh-light-mode-only" width="240"/>
|
|
<img src="https://user-images.githubusercontent.com/983924/156430660-9d5bd555-dcfd-47e2-ba70-54294c20c1b4.svg#gh-dark-mode-only" width="240"/>
|
|
|
|
[](https://github.com/dstotijn/hetty/releases/latest)
|
|
[](https://github.com/dstotijn/hetty/actions/workflows/build-test.yml)
|
|
|
|
[](https://github.com/dstotijn/hetty/blob/master/LICENSE)
|
|
[](https://hetty.xyz/)
|
|
|
|
**Hetty** is an HTTP toolkit for security research. It aims to become an open
|
|
source alternative to commercial software like Burp Suite Pro, with powerful
|
|
features tailored to the needs of the infosec and bug bounty community.
|
|
|
|
<img src="https://hetty.xyz/img/hero.png" width="907" alt="Hetty proxy logs (screenshot)" />
|
|
|
|
## Features
|
|
|
|
- Machine-in-the-middle (MITM) HTTP proxy, with logs and advanced search
|
|
- HTTP client for manually creating/editing requests, and replay proxied requests
|
|
- Intercept requests and responses for manual review (edit, send/receive, cancel)
|
|
- Scope support, to help keep work organized
|
|
- Easy-to-use web based admin interface
|
|
- Project based database storage, to help keep work organized
|
|
|
|
👷♂️ Hetty is under active development. Check the <a
|
|
href="https://github.com/dstotijn/hetty/projects/1">backlog</a> for the current
|
|
status.
|
|
|
|
📣 Are you pen testing professionaly in a team? I would love to hear your
|
|
thoughts on tooling via [this 5 minute
|
|
survey](https://forms.gle/36jtgNc3TJ2imi5A8). Thank you!
|
|
|
|
## Getting started
|
|
|
|
💡 The [Getting started](https://hetty.xyz/docs/getting-started) doc has more
|
|
detailed install and usage instructions.
|
|
|
|
### Installation
|
|
|
|
The quickest way to install and update Hetty is via a package manager:
|
|
|
|
#### macOS
|
|
|
|
```sh
|
|
brew install hettysoft/tap/hetty
|
|
```
|
|
|
|
#### Linux
|
|
|
|
```sh
|
|
sudo snap install hetty
|
|
```
|
|
|
|
#### Windows
|
|
|
|
```sh
|
|
scoop bucket add hettysoft https://github.com/hettysoft/scoop-bucket.git
|
|
scoop install hettysoft/hetty
|
|
```
|
|
|
|
#### Other
|
|
|
|
Alternatively, you can [download the latest release from
|
|
GitHub](https://github.com/dstotijn/hetty/releases/latest) for your OS and
|
|
architecture, and move the binary to a directory in your `$PATH`. If your OS is
|
|
not available for one of the package managers or not listed in the GitHub
|
|
releases, you can compile from source _(link coming soon)_.
|
|
|
|
#### Docker
|
|
|
|
Docker images are distributed via [GitHub's Container registry](https://github.com/dstotijn/hetty/pkgs/container/hetty)
|
|
and [Docker Hub](https://hub.docker.com/r/dstotijn/hetty). To run Hetty via with a volume for database and certificate
|
|
storage, and port 8080 forwarded:
|
|
|
|
```
|
|
docker run -v $HOME/.hetty:/root/.hetty -p 8080:8080 \
|
|
ghcr.io/dstotijn/hetty:latest
|
|
```
|
|
|
|
### Usage
|
|
|
|
Once installed, start Hetty via:
|
|
|
|
```sh
|
|
hetty
|
|
```
|
|
|
|
💡 Read the [Getting started](https://hetty.xyz/docs/getting-started) doc for
|
|
more details.
|
|
|
|
To list all available options, run: `hetty --help`:
|
|
|
|
```
|
|
$ hetty --help
|
|
|
|
Usage:
|
|
hetty [flags] [subcommand] [flags]
|
|
|
|
Runs an HTTP server with (MITM) proxy, GraphQL service, and a web based admin interface.
|
|
|
|
Options:
|
|
--cert Path to root CA certificate. Creates file if it doesn't exist. (Default: "~/.hetty/hetty_cert.pem")
|
|
--key Path to root CA private key. Creates file if it doesn't exist. (Default: "~/.hetty/hetty_key.pem")
|
|
--db Database directory path. (Default: "~/.hetty/db")
|
|
--addr TCP address for HTTP server to listen on, in the form \"host:port\". (Default: ":8080")
|
|
--chrome Launch Chrome with proxy settings applied and certificate errors ignored. (Default: false)
|
|
--verbose Enable verbose logging.
|
|
--json Encode logs as JSON, instead of pretty/human readable output.
|
|
--version, -v Output version.
|
|
--help, -h Output this usage text.
|
|
|
|
Subcommands:
|
|
- cert Certificate management
|
|
|
|
Run `hetty <subcommand> --help` for subcommand specific usage instructions.
|
|
|
|
Visit https://hetty.xyz to learn more about Hetty.
|
|
```
|
|
|
|
## Documentation
|
|
|
|
📖 [Read the docs](https://hetty.xyz/docs)
|
|
|
|
## Support
|
|
|
|
Use [issues](https://github.com/dstotijn/hetty/issues) for bug reports and
|
|
feature requests, and
|
|
[discussions](https://github.com/dstotijn/hetty/discussions) for questions and
|
|
troubleshooting.
|
|
|
|
## Community
|
|
|
|
💬 [Join the Hetty Discord server](https://discord.gg/3HVsj5pTFP)
|
|
|
|
## Contributing
|
|
|
|
Want to contribute? Great! Please check the [Contribution
|
|
Guidelines](CONTRIBUTING.md) for details.
|
|
|
|
## Acknowledgements
|
|
|
|
- Thanks to the [Hacker101 community on Discord](https://www.hacker101.com/discord)
|
|
for the encouragement and early feedback.
|
|
- The font used in the logo and admin interface is [JetBrains
|
|
Mono](https://www.jetbrains.com/lp/mono/).
|
|
|
|
## Sponsors
|
|
|
|
<p><a href="https://www.tines.com/?utm_source=oss&utm_medium=sponsorship&utm_campaign=hetty">
|
|
<img src="https://hetty.xyz/img/tines-sponsorship-badge.png" width="140" alt="Sponsored by Tines">
|
|
</a></p>
|
|
|
|
💖 Are you enjoying Hetty? You can [sponsor me](https://github.com/sponsors/dstotijn)!
|
|
|
|
## License
|
|
|
|
[MIT](LICENSE)
|
|
|
|
© 2022 Hetty Software
|