clientproxy

README

caddy-clientproxy

This Caddy module provides a handler that proxies traffic from your Caddy server to your origin. Using the sibling clientproxy package, your origin initiates and maintains a connection to your Caddy server. Caddy uses this connection to proxy requests to your origin. This way your origin does not need to accept any connections, and need only support outbound connections.

Usage

1. Make sure you're using https as appropriate.
2. Use a sufficiently large shared secret.
3. Order the handlers correctly. This is a terminal handler, in that it does not continue the chain if the reverse proxy is available.
4. Use clientproxy to make your origin(s) available via your caddy.

Limitations

1. A single TCP connection is used to connect to the origin.
2. Only one active origin is supported.
3. Connection upgrades like WebSockets are not supported.

Configuration

You'll need to order this handler, or use route:

{
	order client_proxy before respond
}

example.com {
	client_proxy 46f20973162c43d09bf7ca2311a9c3ca
}

clientproxy

On the machine which hosts your origin, you'll need to run clientproxy. This process will maintain a connection to your Caddy instance, and accept and proxy requests to your origin. You'll need a configuration file:

[[proxy]]
register = "https://example.com/46f20973162c43d09bf7ca2311a9c3ca"
forward = "http://localhost:8080"

Run the clientproxy daemon:

clientproxy config.toml

Now a request to https://example.com should get proxied to your origin.

Implementation

In Caddy, when the module recieves a valid client request that intends to become the origin, it Hijacks the connection, and uses yamux to make the client the server. This serves as the reverse proxy target.

Testing

In terminal 1, start the caddy server with the sample Caddyfile:

xcaddy run -c Caddyfile

In terminal 2, start the example server. This is actually the process that handles the HTTP requests, but it does not listen on any ports.

cd clientproxy
go run ./cmd/example-server

In terminal 3, make a request using curl to your caddy server:

curl -k https://localhost:4430/

Documentation

Index

• type Middleware
  • func (*Middleware) CaddyModule() caddy.ModuleInfo
  • func (m *Middleware) Provision(ctx caddy.Context) error
  • func (m *Middleware) ServeHTTP(w http.ResponseWriter, r *http.Request, next caddyhttp.Handler) error
  • func (m *Middleware) UnmarshalCaddyfile(d *caddyfile.Dispenser) error
  • func (m *Middleware) Validate() error

Types

type Middleware

type Middleware struct {
	// The secret to allow for registering a client.
	Secret string `json:"secret,omitempty"`
	// contains filtered or unexported fields
}

Middleware implements an HTTP handler that allows for a client to become the reverse proxy.

func (*Middleware) CaddyModule

func (*Middleware) CaddyModule() caddy.ModuleInfo

CaddyModule returns the Caddy module information.

func (*Middleware) Provision

func (m *Middleware) Provision(ctx caddy.Context) error

Provision implements caddy.Provisioner.

func (*Middleware) ServeHTTP

func (m *Middleware) ServeHTTP(w http.ResponseWriter, r *http.Request, next caddyhttp.Handler) error

ServeHTTP implements caddyhttp.MiddlewareHandler.

func (*Middleware) UnmarshalCaddyfile

func (m *Middleware) UnmarshalCaddyfile(d *caddyfile.Dispenser) error

UnmarshalCaddyfile implements caddyfile.Unmarshaler.

func (*Middleware) Validate

func (m *Middleware) Validate() error

Validate implements caddy.Validator.