proxy

README

proxy

Some proxy implementations

Documentation

Overview

Package proxy provides wrappers around various proxy server implementations.

Index

• type Protocol
  • func ParseProto(s string) (Protocol, error)
• type Proxy
  • func NewHTTP() (Proxy, error)
  • func NewSOCKS5() (Proxy, error)

Types

type Protocol

type Protocol uint8

Protocol is a wrapper around uint8.

const (
	HTTP Protocol = iota
	HTTPS
	SOCKS5
	Unknown
)

Proxy protocol available.

func ParseProto

func ParseProto(s string) (Protocol, error)

ParseProto takes a string as input and returns its Protocol value, is one is recognised. Otherwise it returns an error.

type Proxy

type Proxy interface {
	// Protocol is the string representation of the protocol
	// beign used.
	Protocol() string
	// ListenAndServe reveleas the proxy to the network.
	ListenAndServe(ctx context.Context, port int) error
	// DialWith makes the proxy dial new connections with the
	// assigned dialer.
	DialWith(d dialer.Dialer)
}

Proxy explains how a proxy should behave.

func NewHTTP

func NewHTTP() (Proxy, error)

NewHTTP returns a new HTTP proxy instance that speaks the protocol assigned. d can also be nil, in that case the proxy will use a default dialer, usually a bare net.Dialer.

func NewSOCKS5

func NewSOCKS5() (Proxy, error)

NewSOCKS5 returns a new SOCKS5 proxy instance that speaks the protocol assigned. d can also be nil, in that case the proxy will use a default dialer, usually a bare net.Dialer.