httpproxy

README

http proxy

HTTP proxy handler and dialer

This project is to add protocol support for the Bridge, or it can be used alone

The following is the implementation of other proxy protocols

• Socks4
• Socks5
• Shadow Socks
• SSH Proxy

Usage

API Documentation

Example

License

Licensed under the MIT License. See LICENSE for the full license text.

Documentation

Index

• Constants
• type Authentication
  • func BasicAuth(username, password string) Authentication
  • func BasicAuthFunc(f func(username, password string) bool) Authentication
• type AuthenticationFunc
  • func (f AuthenticationFunc) Auth(w http.ResponseWriter, r *http.Request) bool
• type BytesPool
• type Dialer
  • func NewDialer(addr string) (*Dialer, error)
  • func (d *Dialer) Dial(network string, address string) (net.Conn, error)
  • func (d *Dialer) DialContext(ctx context.Context, network, address string) (net.Conn, error)
• type Logger
• type ProxyHandler
  • func (p *ProxyHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)
• type SimpleServer
  • func NewSimpleServer(addr string) (*SimpleServer, error)
  • func (s *SimpleServer) Close() error
  • func (s *SimpleServer) ProxyURL() string
  • func (s *SimpleServer) Run(ctx context.Context) error
  • func (s *SimpleServer) Start(ctx context.Context) error

Constants

const (
	BasicAuthName         = "Basic"
	ProxyAuthorizationKey = "Proxy-Authorization"
	ProxyAuthenticateKey  = "Proxy-Authenticate"
)

Types

type Authentication

type Authentication interface {
	Auth(http.ResponseWriter, *http.Request) bool
}

Authentication proxy authentication

func BasicAuth

func BasicAuth(username, password string) Authentication

BasicAuth HTTP Basic authentication for Header Proxy-Authorization

func BasicAuthFunc

func BasicAuthFunc(f func(username, password string) bool) Authentication

BasicAuthFunc HTTP Basic authentication for Header Proxy-Authorization

type AuthenticationFunc

type AuthenticationFunc func(http.ResponseWriter, *http.Request) bool

AuthenticationFunc Authentication interface is implemented

func (AuthenticationFunc) Auth

func (f AuthenticationFunc) Auth(w http.ResponseWriter, r *http.Request) bool

Auth authentication processing

type BytesPool

type BytesPool interface {
	Get() []byte
	Put([]byte)
}

BytesPool is an interface for getting and returning temporary bytes for use by io.CopyBuffer.

type Dialer

type Dialer struct {
	// ProxyDial specifies the optional dial function for
	// establishing the transport connection.
	ProxyDial func(context.Context, string, string) (net.Conn, error)

	// TLSClientConfig specifies the TLS configuration to use with
	// tls.Client.
	// If nil, the TLS is not used.
	// If non-nil, HTTP/2 support may not be enabled by default.
	TLSClientConfig *tls.Config

	// ProxyHeader optionally specifies headers to send to
	// proxies during CONNECT requests.
	ProxyHeader http.Header

	// Proxy proxy server address
	Proxy string

	// Userinfo use userinfo authentication if not empty
	Userinfo *url.Userinfo

	// Timeout is the maximum amount of time a dial will wait for
	// a connect to complete. The default is no timeout
	Timeout time.Duration
}

Dialer holds HTTP CONNECT options.

func NewDialer

func NewDialer(addr string) (*Dialer, error)

NewDialer is create a new HTTP CONNECT connection

func (*Dialer) Dial

func (d *Dialer) Dial(network string, address string) (net.Conn, error)

Dial connects to the provided address on the provided network.

func (*Dialer) DialContext

func (d *Dialer) DialContext(ctx context.Context, network, address string) (net.Conn, error)

DialContext connects to the provided address on the provided network.

type Logger

type Logger interface {
	Println(v ...interface{})
}

type ProxyHandler

type ProxyHandler struct {
	// Client  is used without the connect method
	Client *http.Client
	// ProxyDial specifies the optional proxyDial function for
	// establishing the transport connection.
	ProxyDial func(context.Context, string, string) (net.Conn, error)
	// Authentication is proxy authentication
	Authentication Authentication
	// NotFound Not proxy requests
	NotFound http.Handler
	// Logger error log
	Logger Logger
	// BytesPool getting and returning temporary bytes for use by io.CopyBuffer
	BytesPool BytesPool
}

ProxyHandler proxy handler

func (*ProxyHandler) ServeHTTP

func (p *ProxyHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)

type SimpleServer

type SimpleServer struct {
	ProxyHandler
	Server   http.Server
	Listener net.Listener
	Network  string
	Address  string
	Username string
	Password string
}

SimpleServer is a simplified server, which can be configured as easily as client.

func NewSimpleServer

func NewSimpleServer(addr string) (*SimpleServer, error)

NewServer creates a new NewSimpleServer

func (*SimpleServer) Close

func (s *SimpleServer) Close() error

Close closes the listener

func (*SimpleServer) ProxyURL

func (s *SimpleServer) ProxyURL() string

ProxyURL returns the URL of the proxy

func (*SimpleServer) Run

func (s *SimpleServer) Run(ctx context.Context) error

Run the server

func (*SimpleServer) Start

func (s *SimpleServer) Start(ctx context.Context) error

Start the server