Skip to content
/ simprox Public

Simprox is a fast and simple local proxy server

License

Notifications You must be signed in to change notification settings

cars10/simprox

Repository files navigation

simprox

Build release Docker build

| Simple Proxy Server

Simprox is a fast and simple local proxy server.

You can use it to bypass browser restrictions like CORS or invalid SSL certificates when working with external services in your browser.
It forwards the complete original request to your proxy target and returns the response to your service.

Download

Binary

You can download the latest binary for linux, macos and windows from github.

Docker

Download the image:

docker pull cars10/simprox

Usage

> simprox --help
Simple proxy server

Usage: simprox [OPTIONS] --target-host <host:port>

Options:
  -l, --listen <host:port>
          Set the host for the proxy server itself [env: LISTEN=] [default: 127.0.0.1:7000]
  -t, --target-host <host:port>
          Sets the proxy target (required) [env: TARGET_HOST=]
      --skip-ssl-verify <skip-ssl-verify>
          Disable ssl certificate verification [env: SKIP_SSL_VERIFY=]
  -h, --help
          Print help information
  -V, --version
          Print version information

Examples

Listen on 127.0.0.1:7000 (default) and proxy requests to http://localhost:9200:

simprox -t http://localhost:9200 

Listen on 0.0.0.0:7000, proxy requests to https://localhost:9200 and ignore invalid SSL certificates:

simprox -l 0.0.0.0:7000 -t https://localhost:9200 --skip-ssl-verify

You can also use environment variables for configuration:

LISTEN=0.0.0.0:7000 TARGET_HOST=https://localhost:9200 SKIP_SSL_VERIFY=true simprox

Docker

When using the docker image you have to make sure that the docker container can access the service that you want to proxy. Some examples:

a) When your service is accessible via http://localhost:9200 you need to set --net host

docker run --rm \
           --name simprox \
           -p 7000:7000 \
           -e LISTEN=0.0.0.0:7000 \
           -e TARGET_HOST=http://localhost:9200 \
           --net host \
           cars10/simprox

b) Your service is accessible via http://example.com

docker run --rm \
           --name simprox \
           -p 7000:7000 \
           -e LISTEN=0.0.0.0:7000 \
           -e TARGET_HOST=http://example.com \
           cars10/simprox

c) Your service is running in another docker container named test on port 3000

docker run --rm \
           --name simprox \
           -p 7000:7000 \
           -e LISTEN=0.0.0.0:7000 \
           -e TARGET_HOST=http://test:3000 \
           --link test \
           cars10/simprox

Building

Dependencies

  • rust
  • SSL (depending on your platform). See rust-native-tls for more information
    • Windows: SChannel
    • macOS: Secure Transport
    • Linux: openssl

Build

git clone git@github.com:cars10/simprox.git
cd simprox
cargo build --release
./target/release/simprox --help

Why

Simprox was originally written for elasticvue, so users can access elasticsearch clusters that do not use trusted certificates.

Instead of connecting directly to your cluster https://my.cluster:9200 in elasticvue, you can use simprox to proxy the requests: Simply run simprox -t https://my.cluster:9200 --skip-ssl-verify and connect to http://localhost:7000 in elasticvue.

Yet simprox is completely generic and can be used for any combination of services where you need to proxy requests to bypass browser restrictions.

License

MIT