proxy

Documentation

Overview

Package proxy contains all proxies used by V2Ray.

To implement an inbound or outbound proxy, one needs to do the following: 1. Implement the interface(s) below. 2. Register a config creator through common.RegisterConfig.

Index

• func ContextWithInboundEntryPoint(ctx context.Context, dest net.Destination) context.Context
• func ContextWithInboundTag(ctx context.Context, tag string) context.Context
• func ContextWithOriginalTarget(ctx context.Context, dest net.Destination) context.Context
• func ContextWithResolveIPs(ctx context.Context, f IPResolver) context.Context
• func ContextWithSource(ctx context.Context, src net.Destination) context.Context
• func ContextWithTarget(ctx context.Context, dest net.Destination) context.Context
• func InboundEntryPointFromContext(ctx context.Context) (net.Destination, bool)
• func InboundTagFromContext(ctx context.Context) (string, bool)
• func OriginalTargetFromContext(ctx context.Context) (net.Destination, bool)
• func SourceFromContext(ctx context.Context) (net.Destination, bool)
• func TargetFromContext(ctx context.Context) (net.Destination, bool)
• type Dialer
• type GetInbound
• type GetOutbound
• type IPResolver
  • func ResolvedIPsFromContext(ctx context.Context) (IPResolver, bool)
• type Inbound
• type Outbound
• type UserManager

Functions

func ContextWithInboundEntryPoint

func ContextWithInboundEntryPoint(ctx context.Context, dest net.Destination) context.Context

func ContextWithInboundTag

func ContextWithInboundTag(ctx context.Context, tag string) context.Context

func ContextWithOriginalTarget

func ContextWithOriginalTarget(ctx context.Context, dest net.Destination) context.Context

func ContextWithResolveIPs

func ContextWithResolveIPs(ctx context.Context, f IPResolver) context.Context

func ContextWithSource

func ContextWithSource(ctx context.Context, src net.Destination) context.Context

ContextWithSource creates a new context with given source.

func ContextWithTarget

func ContextWithTarget(ctx context.Context, dest net.Destination) context.Context

func InboundEntryPointFromContext

func InboundEntryPointFromContext(ctx context.Context) (net.Destination, bool)

func InboundTagFromContext

func InboundTagFromContext(ctx context.Context) (string, bool)

func OriginalTargetFromContext

func OriginalTargetFromContext(ctx context.Context) (net.Destination, bool)

func SourceFromContext

func SourceFromContext(ctx context.Context) (net.Destination, bool)

SourceFromContext retrieves source from the given context.

func TargetFromContext

func TargetFromContext(ctx context.Context) (net.Destination, bool)

Types

type Dialer

type Dialer interface {
	// Dial dials a system connection to the given destination.
	Dial(ctx context.Context, destination net.Destination) (internet.Connection, error)
}

Dialer is used by OutboundHandler for creating outbound connections.

type GetInbound

type GetInbound interface {
	GetInbound() Inbound
}

type GetOutbound

type GetOutbound interface {
	GetOutbound() Outbound
}

type IPResolver

type IPResolver interface {
	Resolve() []net.Address
}

func ResolvedIPsFromContext

func ResolvedIPsFromContext(ctx context.Context) (IPResolver, bool)

type Inbound

type Inbound interface {
	// Network returns a list of network that this inbound supports. Connections with not-supported networks will not be passed into Process().
	Network() net.NetworkList

	// Process processes a connection of given network. If necessary, the Inbound can dispatch the connection to an Outbound.
	Process(context.Context, net.Network, internet.Connection, core.Dispatcher) error
}

An Inbound processes inbound connections.

type Outbound

type Outbound interface {
	// Process processes the given connection. The given dialer may be used to dial a system outbound connection.
	Process(context.Context, ray.OutboundRay, Dialer) error
}

An Outbound process outbound connections.

type UserManager

type UserManager interface {
	// AddUser adds a new user.
	AddUser(context.Context, *protocol.User) error

	// RemoveUser removes a user by email.
	RemoveUser(context.Context, string) error
}

UserManager is the interface for Inbounds and Outbounds that can manage their users.