Caterpillar Proxy - The simple and parasitic web proxy with SPAM filter (formerly, php-httpproxy)
Go to file
2024-08-20 19:51:50 +09:00
.github feat: github action configure for ruff action 2024-07-13 18:35:03 +09:00
assets Update the cover image 2024-08-20 14:36:26 +09:00
plugins Change author 2024-08-12 15:12:50 +09:00
.gitignore Add roadmap image 2024-07-11 20:53:06 +09:00
base.py ruff checked 2024-07-31 15:39:48 +09:00
caterpillar.service Create caterpillar.service 2024-02-21 02:24:06 +09:00
console.html Update console.html 2024-06-26 16:21:05 +09:00
Dockerfile Create Dockerfile 2024-03-06 15:11:13 +09:00
download_certs.bat Revert "Fix SSL negotiation + ruff formatted" 2024-07-11 19:00:58 +09:00
download_certs.sh Revert "Fix SSL negotiation + ruff formatted" 2024-07-11 19:00:58 +09:00
LICENSE Initial commit 2022-10-06 02:16:30 +09:00
README.md Update README.md 2024-08-20 19:51:50 +09:00
requirements-dev.txt Add elasticsearch webpage cache 2024-07-31 13:39:09 +09:00
requirements.txt SMTP fix #35 2024-07-12 10:14:39 +09:00
ruff.toml feat: ruff exclude append assets data 2024-07-11 15:19:50 +09:00
server.py ruff checked 2024-07-31 15:39:48 +09:00
smtp.py ruff checked 2024-07-31 15:39:48 +09:00
web.py ruff formatted 2024-07-11 19:02:08 +09:00

gnh1201/caterpillar

FOSSA Status DOI

Caterpillar Proxy - The simple web debugging proxy (formerly, php-httpproxy)

Cover image - Caterpillar on a tree looking at a rocket flying over the clouds

You can connect all physical and logical channels with communication capabilities to the web! Imagine a wide range of mediums, from web archives to satellites and quantum communication! Caterpillar Proxy supports your imagination by enabling the implementation of extensions for Connectors, Filters, and RPC methods.

Use cases

How it works

Basic structure

You <-> Proxy client (Python) <-> Parasitized proxy server (Optional, PHP/LAMP) <-> On the Web

For example, build a simple web debugging proxy on the shared servers.

Stateful mode

This project supports two modes of connection. The default is stateless. You can use the stateful mode to avoid being constrained by transfer capacity limits. See the Stateful mode (github.com/gnh1201/caterpillar wiki).

(Optional) Before to use

If you have a server that will be parasitized and you want to proxy it, you should upload the index.php file to a shared server. The index.php file is located in the assets/php directory within this repository.

How to use

  1. Write a file .env(Linux) or settings.ini(Windows). Like this:
[settings]
PORT=5555
SERVER_URL=localhost
SERVER_CONNECTION_TYPE=
CA_KEY=ca.key
CA_CERT=ca.crt
CERT_KEY=cert.key
CERT_DIR=certs/
OPENSSL_BINPATH=openssl
CLIENT_ENCODING=utf-8
USE_EXTENSIONS=wayback.Wayback,bio.PyBio

Note: If using Caterpillar Proxy (Python) alone, set SERVER_URL=localhost. Otherwise, use the endpoint URL of the Worker script (PHP or Java), e.g., SERVER_URL=http://example.org.

  • (Optional) Create a certificate for SSL decryption
chmod +x configure_certs.sh
./configure_certs.sh
sudo apt-get install -y ca-certificates
sudo cp ca.crt /usr/local/share/ca-certificates/caterpillar-ca.crt
sudo update-ca-certificates
  1. Run python3 server.py and set HTTP(S) proxy in your web browser (e.g. Firefox, Chromium)

  2. Test 100MB/SSL, 1GB/SSL, 10GB/SSL download and check the speed.

  3. Enjoy it

  4. (Optional) With Cloudflare, we can expect to accelerate the 4x speed and reduce the network stuck.

Extensions

Thanks to

Contributors

Contributors

Our roadmap

Roadmap image

Report abuse

License

FOSSA Status