constant

Documentation

Index

• Constants
• Variables
• func SetConfig(file string)
• func SetHomeDir(root string)
• type AdapterType
  • func (at AdapterType) String() string
• type Chain
  • func (c Chain) String() string
• type Conn
• type Connection
• type DelayHistory
• type Metadata
  • func (m *Metadata) RemoteAddress() string
  • func (m *Metadata) Resolved() bool
  • func (m *Metadata) SourceAddress() string
  • func (m *Metadata) String() string
  • func (m *Metadata) UDPAddr() *net.UDPAddr
  • func (m *Metadata) Valid() bool
• type NetWork
  • func (n NetWork) MarshalJSON() ([]byte, error)
  • func (n *NetWork) String() string
• type PacketConn
• type Proxy
• type ProxyAdapter
• type Rule
• type RuleType
  • func (rt RuleType) String() string
• type ServerAdapter
• type Type
  • func (t Type) MarshalJSON() ([]byte, error)
  • func (t Type) String() string
• type UDPPacket

Constants

const (
	AtypIPv4       = 1
	AtypDomainName = 3
	AtypIPv6       = 4

	TCP NetWork = iota
	UDP

	HTTP Type = iota
	HTTPCONNECT
	SOCKS
	REDIR
)

Socks addr type

const Name = "clash"

Variables

var (
	Version   = "unknown version"
	BuildTime = "unknown time"
)

var Path *path

Path is used to get the configuration path

Functions

func SetConfig

func SetConfig(file string)

SetConfig is used to set the configuration file

func SetHomeDir

func SetHomeDir(root string)

SetHomeDir is used to set the configuration path

Types

type AdapterType

type AdapterType int

AdapterType is enum of adapter type

const (
	Direct AdapterType = iota
	Reject

	Shadowsocks
	Snell
	Socks5
	Http
	Vmess
	Trojan

	Relay
	Selector
	Fallback
	URLTest
	LoadBalance
)

Adapter Type

func (AdapterType) String

func (at AdapterType) String() string

type Chain

type Chain []string

func (Chain) String

func (c Chain) String() string

type Conn

type Conn interface {
	net.Conn
	Connection
}

type Connection

type Connection interface {
	Chains() Chain
	AppendToChains(adapter ProxyAdapter)
}

type DelayHistory

type DelayHistory struct {
	Time  time.Time `json:"time"`
	Delay uint16    `json:"delay"`
}

type Metadata

type Metadata struct {
	NetWork  NetWork `json:"network"`
	Type     Type    `json:"type"`
	SrcIP    net.IP  `json:"sourceIP"`
	DstIP    net.IP  `json:"destinationIP"`
	SrcPort  string  `json:"sourcePort"`
	DstPort  string  `json:"destinationPort"`
	AddrType int     `json:"-"`
	Host     string  `json:"host"`
}

Metadata is used to store connection address

func (*Metadata) RemoteAddress

func (m *Metadata) RemoteAddress() string

func (*Metadata) Resolved

func (m *Metadata) Resolved() bool

func (*Metadata) SourceAddress

func (m *Metadata) SourceAddress() string

func (*Metadata) String

func (m *Metadata) String() string

func (*Metadata) UDPAddr

func (m *Metadata) UDPAddr() *net.UDPAddr

func (*Metadata) Valid

func (m *Metadata) Valid() bool

type NetWork

type NetWork int

func (NetWork) MarshalJSON

func (n NetWork) MarshalJSON() ([]byte, error)

func (*NetWork) String

func (n *NetWork) String() string

type PacketConn

type PacketConn interface {
	net.PacketConn
	Connection
	WriteWithMetadata(p []byte, metadata *Metadata) (n int, err error)
}

type Proxy

type Proxy interface {
	ProxyAdapter
	Alive() bool
	DelayHistory() []DelayHistory
	Dial(metadata *Metadata) (Conn, error)
	LastDelay() uint16
	URLTest(ctx context.Context, url string) (uint16, error)
}

type ProxyAdapter

type ProxyAdapter interface {
	Name() string
	Type() AdapterType
	StreamConn(c net.Conn, metadata *Metadata) (net.Conn, error)
	DialContext(ctx context.Context, metadata *Metadata) (Conn, error)
	DialUDP(metadata *Metadata) (PacketConn, error)
	SupportUDP() bool
	MarshalJSON() ([]byte, error)
	Addr() string
}

type Rule

type Rule interface {
	RuleType() RuleType
	Match(metadata *Metadata) bool
	Adapter() string
	Payload() string
	NoResolveIP() bool
}

type RuleType

type RuleType int

const (
	Domain RuleType = iota
	DomainSuffix
	DomainKeyword
	GEOIP
	IPCIDR
	SrcIPCIDR
	SrcPort
	DstPort
	MATCH
)

Rule Type

func (RuleType) String

func (rt RuleType) String() string

type ServerAdapter

type ServerAdapter interface {
	net.Conn
	Metadata() *Metadata
}

type Type

type Type int

func (Type) MarshalJSON

func (t Type) MarshalJSON() ([]byte, error)

func (Type) String

func (t Type) String() string

type UDPPacket

type UDPPacket interface {
	// Data get the payload of UDP Packet
	Data() []byte

	// WriteBack writes the payload with source IP/Port equals addr
	// - variable source IP/Port is important to STUN
	// - if addr is not provided, WriteBack will wirte out UDP packet with SourceIP/Prot equals to origional Target,
	//   this is important when using Fake-IP.
	WriteBack(b []byte, addr net.Addr) (n int, err error)

	// Close closes the underlaying connection.
	Close() error

	// LocalAddr returns the source IP/Port of packet
	LocalAddr() net.Addr
}

UDPPacket contains the data of UDP packet, and offers control/info of UDP packet's source