@hackage hprox0.1.0.2

a lightweight HTTP proxy server, and more

hprox

CircleCI Depends Release Hackage License

hprox is a lightweight HTTP/HTTPS proxy server.

Features

  • Basic HTTP proxy functionality.
  • Simple password authentication.
  • TLS encryption (requires a valid certificate). Supports TLS 1.3 and HTTP 2, also known as SPDY Proxy.
  • TLS SNI validation (blocks all clients with invalid domain name).
  • Provide PAC file for easy client side configuration (supports Chrome and Firefox).
  • Websocket redirection (compatible with v2ray-plugin).
  • Reverse proxy support (redirect requests to a fallback server).
  • Implemented as a middleware, compatible with any Haskell Web Application built with wai interface. Defaults to fallback to a dumb application which simulate the default empty page from Apache.

Installation

hprox should build and work on all unix-like OS with ghc support, but it's only been tested on Linux and macOS.

stack is recommended to build hprox.

stack setup
stack install

Usage

Use hprox --help to list options with detailed explanation.

  • To run hprox on port 8080, with simple password authentication: 
echo "user:pass" > userpass.txt
hprox -p 8080 -a userpass.txt
  • To run hprox with TLS encryption on port 443, with certificate of example.com obtained with certbot: 
hprox -p 443 -s example.com:/etc/letsencrypt/live/example.com/fullchain.pem:/etc/letsencrypt/live/example.com/privkey.pem

Browsers can be configured with PAC file URL https://example.com/get/hprox.pac.

v2ray-plugin -server -localPort 8080 -mode websocket -host example.com -remotePort xxxx
hprox -p 443 -s example.com:fullchain.pem:privkey.pem --ws 127.0.0.1:8080 --rev archive.ubuntu.com:80

Clients will be able to connect with plugin option tls;host=example.com.

Known Issue

  • Only HTTP servers are supported as websocket and reverse proxy redirection destination.
  • Passwords are currently stored in plain text, please set permission accordingly and avoid using existing password.

License

hprox is licensed under the Apache license. See LICENSE file for details.