etc-hosts-proxy

etc-hosts-proxy

Stop changing /etc/hosts file! Use etc-hosts-proxy instead!

When testing a website there are usually 3 ways to access the test environment while keeping the Host HTTP header:

1. Override the hostname in the /etc/hosts file. Admin privileges are required for this.

2. Use local DNS server with ability to override the hostname (dnsmasq e.g.). You should configure the local DNS server properly. Then you should change your network settings to use it.

3. Use a proxy server which can override the hostname in a request.

This proxy implements the 3rd way. Nor admin privileges neither any system-wide changes are required for this. Just start the proxy server and direct your browser to use it.

A proxy-switching extension for your browser (FoxyProxy or SwitchyOmega e.g.) is highly recommended.

WARNING & DISCLAIMER

⚠️ DO NOT RUN this server on a publicly available network interface! This may compromise your network, privacy, wallet, etc. Never run this proxy on 0.0.0.0 if you do not understand what you're doing!

Contributors are not responsible for any damage incurred by using this proxy server.

What this proxy does and what's not

• ✅ HTTP proxy protocol is supported
• ✅ HTTPS CONNECT method is supported
• ✅ SOCKS5 protocol is supported
• ✅ HTTP proxy-chaining is supported (use HTTP_PROXY environment variable)
• ❌ Config file support is possible but not planned
• ❌ Daemon mode support is possible but not planned
• ❌ HTTPS MitM support is not planned (use mitmproxy)
• ❌ Request/response rewrite support is not planned (use mitmproxy)
• ❌ ACL support is not planned

Usage

Run the HTTP proxy on 127.0.0.1:8080 and redirect some hostnames to a local web server:

etc-hosts-proxy run -H example.com=127.0.0.1 -H www.example.com=127.0.0.1

Test the above with curl:

curl -v -x 127.0.0.1:8080 http://example.com
curl -v -x 127.0.0.1:8080 http://www.example.com

NOTE: Proxy listens on 127.0.0.1:8080 by default. Use -L (or --listen-address) CLI option to change this.

Run the SOCKS5 proxy on 127.0.0.1:1080 and redirect some hostnames to a local web server:

etc-hosts-proxy run -M socks5 -L 127.0.0.1:1080 -H example.com=127.0.0.1,www.example.com=127.0.0.1

curl -v -x socks5h://127.0.0.1:1080 http://example.com
curl -v -x socks5h://127.0.0.1:1080 http://www.example.com

See etc-hosts-proxy --help for general CLI usage information.

Docker usage

You may also use a Docker image if you'd prefer:

docker run -d --name=etc-hosts-proxy -p 127.0.0.1:8080:8080 --rm \
  -e ETC_HOSTS_PROXY_HOSTS_LIST="akamai.com=2.21.250.7,www.akamai.com=2.21.250.7" \
  -e ETC_HOSTS_PROXY_DEBUG=true \
  ghcr.io/jay7x/etc-hosts-proxy:latest

curl -v -x 127.0.0.1:8080 http://akamai.com

docker logs etc-hosts-proxy
docker stop etc-hosts-proxy

NOTE: You should not use 127.0.0.1 (or ::1) as your redirection destination in the hosts list while running in a container. This will redirect the request to the container's localhost, which is not what you might expect. You can use host Docker network if you really need it.

A bit more complex example to redirect some domains to a nginx container:

# Create a docker network
docker network create somenet

# Run a web server exposed in somenet and on 127.0.0.1:8080 on the host
docker run -d --name=nginx --net=somenet -p 127.0.0.1:8080:80 --rm nginx:latest

# Run the proxy connected to somenet and exposed on 127.0.0.1:3128 on the host
docker run -d --name=etc-hosts-proxy --net=somenet -p 127.0.0.1:3128:8080 --rm \
  -e ETC_HOSTS_PROXY_HOSTS_LIST="example.com=nginx,www.example.com=nginx" \
  -e ETC_HOSTS_PROXY_DEBUG=true \
  ghcr.io/jay7x/etc-hosts-proxy:latest

# Check nginx
curl -v http://127.0.0.1:8080

# Check proxy is proxying (note the port is 3128 here)
curl -v -x 127.0.0.1:3128 http://example.com
curl -v -x 127.0.0.1:3128 http://www.example.com
# This should not be redirected
curl -v -x 127.0.0.1:3128 http://example.net

# Check logs
docker logs etc-hosts-proxy
docker logs nginx

# Cleanup
docker stop etc-hosts-proxy
docker stop nginx
docker network rm somenet

Docker images are built by goreleaser from the Dockerfile

See etc-hosts-proxy Github Container registry for more details

Environment variables