doxyproxy

package module

v1.0.0 Latest Latest Go to latest Published: Aug 12, 2020 License: Apache-2.0 Imports: 6 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/syrinsecurity/doxyproxy

Links

Open Source Insights

README ¶

DoxyProxy Client Lib

This is a client lib for DoxyProxy.

DoxyProxy is a fast layer 4 reverse proxy supporting both; UDP and TCP. The key features of DoxyProxy is the built in API which allows the remote origin to access the clients true IP address, instead of the proxy's IP.

Enhance security
Hide your origin
Protect your self origin for DDOS attacks

DoxyProxy is built for flexibility and speed, not just in raw performance but also in setup. Use a simple json file to configure a ProxiedHost. Features include:

Limit connections per IP
DualStack lookup
Domain support
IPv4, IPv6
Configurable IP version switching handled by the proxy
Force IPv6 or IPv4 (or allow all)
Fail over IP
Blacklist IP addresses
Blacklist CIDRs (ip ranges)
Whitelist IP addresses
Whitelist CIDRs (ip ranges)

Install

go get github.com/syrinsecurity/doxyproxy

Documentation ¶

Index ¶

Variables
type IPEntry
- func (entry IPEntry) Fetch() (string, error)
- func (entry IPEntry) Kill() error
type Proxy
- func New(api string, app string, key string) *Proxy
- func (p *Proxy) Kill(addr net.Addr) error
- func (p *Proxy) Resolve(addr net.Addr) (string, error)
type Response

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	//ErrAPIResponseSuccessFalse is returned when the response was false
	ErrAPIResponseSuccessFalse = errors.New("api response success false")
	//ErrClientNotFound is returned when the client was not found on the proxy server
	ErrClientNotFound = errors.New("client not found")
)

Functions ¶

This section is empty.

Types ¶

type IPEntry ¶

type IPEntry struct {
	ID string

	IP     string
	Expire int64
	// contains filtered or unexported fields
}

IPEntry holds the true IP address of a client

func (IPEntry) Fetch ¶

func (entry IPEntry) Fetch() (string, error)

Fetch will query the proxy API for the real IP

func (IPEntry) Kill ¶

func (entry IPEntry) Kill() error

Kill will disconnect the user from the proxy

type Proxy ¶

type Proxy struct {
	API string
	App string
	Key string

	CacheTTL time.Duration

	Client *http.Client
	// contains filtered or unexported fields
}

Proxy is a doxyproxy config

func New ¶

func New(api string, app string, key string) *Proxy

New creates a new DoxyProxy

func (*Proxy) Kill ¶

func (p *Proxy) Kill(addr net.Addr) error

Kill will disconnect the user from the proxy

func (*Proxy) Resolve ¶

func (p *Proxy) Resolve(addr net.Addr) (string, error)

Resolve will return the true IP address of the client

type Response ¶

type Response struct {
	Success bool   `json:"success"`
	Message string `json:"message"`
}

Response holds a response from the API server

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL