Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sigoden/proxyfor
A proxy CLI for capturing HTTP(S) & WS(S) Traffic.
https://github.com/sigoden/proxyfor
cli forward-proxy http http2 https man-in-the-middle proxy proxy-server reverse-proxy rust websocket
Last synced: 14 days ago
JSON representation
A proxy CLI for capturing HTTP(S) & WS(S) Traffic.
- Host: GitHub
- URL: https://github.com/sigoden/proxyfor
- Owner: sigoden
- License: apache-2.0
- Created: 2024-03-05T01:56:58.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-10-17T03:07:55.000Z (27 days ago)
- Last Synced: 2024-10-19T05:32:14.514Z (25 days ago)
- Topics: cli, forward-proxy, http, http2, https, man-in-the-middle, proxy, proxy-server, reverse-proxy, rust, websocket
- Language: Rust
- Homepage:
- Size: 310 KB
- Stars: 291
- Watchers: 4
- Forks: 19
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE-APACHE
Awesome Lists containing this project
README
# Proxyfor
[](https://github.com/sigoden/proxyfor/actions/workflows/ci.yaml)
[](https://crates.io/crates/proxyfor)
[](https://hub.docker.com/r/sigoden/proxyfor)
A proxy CLI for capturing HTTP(S) & WS(S) Traffic.
## Features
- Supports forward/reverse proxy
- Supports HTTP/HTTPS/WS/WSS protocols
- Supports filtering & searching
- Provides terminal user interface (TUI)
- Provides web user interface (WebUI)
- Provides CA certificates installation tool
- Enables export in Markdown, cURL, or HAR formats
- Captures request/response in a non-blocking, streaming way
> Proxyfor, written in Rust, is distributed as a single executable file for Windows, macOS, and Linux, requiring no further installation steps or dependencies.
## Screenshots
**Terminal User Inferace**
**Web User Inferace**
## 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 Type
### Forward Proxy
The client sets the proxy to `http://127.0.0.1:8080`.
```sh
$ proxyfor
$ curl -x http://127.0.0.1:8080 httpbin.org/ip
```
### Reverse Proxy
The client accesses to `http://127.0.0.1:8080/*`.
**This mode is suitable for scenarios where client cannot set a proxy.**
```sh
$ proxyfor https://httpbin.org
$ curl http://127.0.0.1:8080/ip
```
## Command Line
```
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
You can select different interfaces with the following commands:
```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
```
### Changing IP and Port
You can specify different listening addresses:
```sh
proxyfor -l 8081
proxyfor -l 127.0.0.1
proxyfor -l 127.0.0.1:8081
```
### Applying Filter
Filter traffic by setting method and URI:
```sh
proxyfor -f httpbin.org/ip -f httpbin.org/anything
proxyfor -f '/^(get|post) https:\/\/httpbin.org/'
```
Filter traffic based on content type:
```sh
proxyfor -m application/json -m application/ld+json
proxyfor -m text/
```
## CA Certificates
Proxyfor can decrypt encrypted traffic on the fly, as long as the client trusts proxyfor’s built-in certificate authority. Usually this means that the proxyfor CA certificate has to be installed on the client device.
By far the easiest way to [install the proxyfor CA certificate](./assets/install-certificate.md) is to use the built-in certificate installation app.
To do this, start proxyfor and configure your target device with the correct proxy settings.
Now start a browser on the device, and visit the magic domain [proxyfor.local](http://proxyfor.local).
## 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.