Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sigoden/proxyfor
A powerful and flexible proxy CLI for capturing and inspecting HTTP(S) and WS(S) traffic, with TUI and WebUI.
https://github.com/sigoden/proxyfor
cli forward-proxy http http2 https man-in-the-middle proxy proxy-server reverse-proxy rust websocket
Last synced: about 6 hours ago
JSON representation
A powerful and flexible proxy CLI for capturing and inspecting HTTP(S) and WS(S) traffic, with TUI and WebUI.
- Host: GitHub
- URL: https://github.com/sigoden/proxyfor
- Owner: sigoden
- License: apache-2.0
- Created: 2024-03-05T01:56:58.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-12-24T11:23:49.000Z (18 days ago)
- Last Synced: 2025-01-04T07:47:36.452Z (7 days ago)
- Topics: cli, forward-proxy, http, http2, https, man-in-the-middle, proxy, proxy-server, reverse-proxy, rust, websocket
- Language: Rust
- Homepage:
- Size: 252 KB
- Stars: 359
- Watchers: 4
- Forks: 27
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE-APACHE
Awesome Lists containing this project
- jimsghstars - sigoden/proxyfor - A proxy CLI for capturing HTTP(S) & WS(S) Traffic. (Rust)
README
# Proxyfor
[](https://github.com/sigoden/proxyfor/actions/workflows/ci.yaml)
[](https://crates.io/crates/proxyfor)
[](https://hub.docker.com/r/sigoden/proxyfor)
A powerful and flexible proxy CLI for capturing and inspecting HTTP(S) and WS(S) traffic.
## Key Features
* **Forward & Reverse Proxy:** Supports both forward proxy (client explicitly uses the proxy) and reverse proxy (proxy sits in front of the server).
* **Multi-Protocol Support:** Handles HTTP, HTTPS, WebSocket (WS), and secure WebSocket (WSS) protocols.
* **Flexible Filtering:** Filter traffic based on method, URI, and content-type for targeted analysis.
* **Multiple User Interfaces:** Includes a user-friendly Terminal User Interface (TUI) and a web-based interface (WebUI) for inspecting captured data.
* **CA Certificate Management:** Simplifies the process of installing the necessary CA certificates to decrypt HTTPS traffic.
* **Export Options:** Export captured traffic in various formats, including Markdown, cURL commands, and HAR files.
* **Non-Blocking Streaming:** Captures request/response data in a non-blocking, streaming fashion for efficient handling of large volumes of traffic.
* **Cross-Platform & Standalone:** Delivered as a single, self-contained executable for Windows, macOS, and Linux, simplifying setup and distribution.
## Screenshots
**Terminal User Interface (TUI)**
**Web User Interface (WebUI)**
## Installation
### With cargo
```
cargo install proxyfor
```
### With docker
```
docker run -v ~/.proxyfor:/.proxyfor -p 8080:8080 --rm sigoden/proxyfor --web
```
### Binaries on macOS, Linux, Windows
Download from [Github Releases](https://github.com/sigoden/proxyfor/releases), unzip and add proxyfor to your $PATH.
## Proxy Modes Explained
### Forward Proxy
In this mode, your client applications (e.g., web browsers, curl) are configured to send their requests to `proxyfor`, which then forwards them to the target servers. You would configure your client to use a proxy at `http://127.0.0.1:8080`.
```bash
proxyfor
curl -x http://127.0.0.1:8080 httpbin.org/ip
```
### Reverse Proxy
In reverse proxy mode, `proxyfor` sits in front of a target server. Clients access `proxyfor` and it forwards the requests to the defined URL. This mode is ideal when clients cannot be configured to use a proxy.
```bash
proxyfor https://httpbin.org
curl http://127.0.0.1:8080/ip
```
## Command Line Interface (CLI)
```
Usage: proxyfor [OPTIONS] [URL]
Arguments:
[URL] Reverse proxy url
Options:
-l, --listen Listening ip and port address [default: 0.0.0.0:8080]
-f, --filters Only inspect http(s) traffic whose `{method} {uri}` matches the regex
-m, --mime-filters Only inspect http(s) traffic whose content-type matches the value
-W, --web Enable user-friendly web interface
-T, --tui Eenter TUI
-D, --dump Dump all traffics
-h, --help Print help
-V, --version Print version
```
### Choosing User Interface
`proxyfor` provides several ways to interact with captured traffic:
```sh
proxyfor # Enter TUI, equal to `proxyfor --tui`
proxyfor --web # Serve WebUI
proxyfor --web --tui # Serve WebUI + Enter TUI
proxyfor --dump # Dump all traffics to console
proxyfor > proxyfor.md # Dump all traffics to markdown file
```
### Specifying Address and Port
Customize the listening address and port:
```sh
proxyfor -l 8081
proxyfor -l 127.0.0.1
proxyfor -l 127.0.0.1:8081
```
### Filtering Traffic
Apply regex filters to limit captured traffic based on method and URI:
```sh
proxyfor -f httpbin.org/ip -f httpbin.org/anything
proxyfor -f '/^(get|post) https:\/\/httpbin.org/'
```
Filter based on MIME types:
```sh
proxyfor -m application/json -m application/ld+json
proxyfor -m text/
```
## CA Certificate Installation
To decrypt HTTPS traffic, you must install `proxyfor`'s CA certificate on your device. The easiest way to do this is to use the built-in certificate installation app.
1. Start `proxyfor` with desired proxy settings.
2. On your target device, configure the device to use `proxyfor` as the proxy.
3. Open a web browser on the target device and navigate to [proxyfor.local](http://proxyfor.local).
4. Follow the on-screen instructions to download and install the CA certificate.
## License
Copyright (c) 2024-∞ proxyfor-developers.
Proxyfor is made available under the terms of either the MIT License or the Apache License 2.0, at your option.
See the LICENSE-APACHE and LICENSE-MIT files for license details.