torproxy

README

Torproxy

An easy way to proxy your http requests through the onion network

NOTE: This is a beta release, we do not consider it completely production ready yet. Use at your own risk.

Route your http requests through the onion network without Tor browser

Using Torproxy

Note: The master branch is using Caddy v2, if you want to use Torproxy with previous caddy versions, check the caddy-v1 branch.

If you want Torproxy to start a fresh instance of Tor, you need to install Tor on your machine. Take a look at the Tor download instructions

You can get torproxy as a plugin on Caddy's v1 build server.

Or install torproxy's v2 version using go get:

go get go.okkur.org/torproxy/cmd/torproxy

Create a config file like the example below. For more information about the available config options, check the Configuration page.

example.test {
  torproxy example.test somewhereonthe.onion 
}

You can run torproxy with Caddyfile config adapter using this command:

torproxy start -config torproxy.config -adapter caddyfile

Take a look at our full documentation.

Support

For detailed information on support options see our support guide.

Helping out

Best place to start is our contribution guide.

---

Code is licensed under the Apache License, Version 2.0.
Documentation/examples are licensed under Creative Commons BY-SA 4.0.
Illustrations, trademarks and third-party resources are owned by their respective party and are subject to different licensing.

---

Copyright 2019 - The Torproxy authors

Documentation

Index

• Constants
• func TorConstructor() (caddy.Destructor, error)
• type Config
  • func (c Config) Proxy(w http.ResponseWriter, r *http.Request) error
• type Tor
  • func (t *Tor) Destruct() error
  • func (t *Tor) IsInstalled() error
  • func (t *Tor) ParseTor(d *caddyfile.Dispenser) error
  • func (t *Tor) SetDefaults()
  • func (t *Tor) Start()
  • func (t *Tor) Stop() error
• type TorProxy
  • func (TorProxy) CaddyModule() caddy.ModuleInfo
  • func (t TorProxy) ServeHTTP(w http.ResponseWriter, r *http.Request, next caddyhttp.Handler) error
  • func (t *TorProxy) UnmarshalCaddyfile(d *caddyfile.Dispenser) error
• type TorResponse
  • func (t *TorResponse) Body() []byte
  • func (t *TorResponse) Header() http.Header
  • func (t *TorResponse) Redirect() error
  • func (t *TorResponse) ReplaceBody(scheme, to, host string) error
  • func (t *TorResponse) Write(body []byte) (int, error)
  • func (t *TorResponse) WriteBody() error
  • func (t *TorResponse) WriteHeader(status int)

Constants

const DefaultOnionServicePort = 4242

DefaultOnionServicePort is the port used to serve the onion service on

Functions

func TorConstructor

func TorConstructor() (caddy.Destructor, error)

TorConstructor return a new instance of Tor client struct. Used to manage the Tor client's life cycle

Types

type Config

type Config struct {
	To     map[string]string
	Client *Tor
}

TorProxy config

func (Config) Proxy

func (c Config) Proxy(w http.ResponseWriter, r *http.Request) error

Proxy redirects the request to the local onion service and the actual proxying happens inside onion service's http handler

type Tor

type Tor struct {
	// Socks5 proxy port
	Host      string
	Port      int
	DataDir   string
	Torrc     string
	DebugMode bool
	LogFile   string
	// contains filtered or unexported fields
}

Tor instance config struct

func (*Tor) Destruct

func (t *Tor) Destruct() error

Destruct stops the Tor client

func (*Tor) IsInstalled

func (t *Tor) IsInstalled() error

IsInstalled checks the Tor client using the `tor --version` command

func (*Tor) ParseTor

func (t *Tor) ParseTor(d *caddyfile.Dispenser) error

ParseTor parses advanced config for Tor client

func (*Tor) SetDefaults

func (t *Tor) SetDefaults()

SetDefaults sets the default values for prometheus config if the fields are empty

func (*Tor) Start

func (t *Tor) Start()

func (*Tor) Stop

func (t *Tor) Stop() error

Stop stops the tor instance, context listener and the onion service

type TorProxy

type TorProxy struct {
	Config Config
	// contains filtered or unexported fields
}

func (TorProxy) CaddyModule

func (TorProxy) CaddyModule() caddy.ModuleInfo

CaddyModule returns the Caddy module information.

func (TorProxy) ServeHTTP

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

func (*TorProxy) UnmarshalCaddyfile

func (t *TorProxy) UnmarshalCaddyfile(d *caddyfile.Dispenser) error

UnmarshalCaddyfile implements caddyfile.Unmarshaler.

type TorResponse

type TorResponse struct {
	// contains filtered or unexported fields
}

func (*TorResponse) Body

func (t *TorResponse) Body() []byte

Body returns response's body. This method should only get called after WriteBody()

func (*TorResponse) Header

func (t *TorResponse) Header() http.Header

Header returns response headers

func (*TorResponse) Redirect

func (t *TorResponse) Redirect() error

Redirect redirects the request to the previous response's Location header.

func (*TorResponse) ReplaceBody

func (t *TorResponse) ReplaceBody(scheme, to, host string) error

func (*TorResponse) Write

func (t *TorResponse) Write(body []byte) (int, error)

func (*TorResponse) WriteBody

func (t *TorResponse) WriteBody() error

func (*TorResponse) WriteHeader

func (t *TorResponse) WriteHeader(status int)

WriteHeader Writes the given status code to response