constant

package
v0.0.0-...-17b02d1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 5, 2024 License: GPL-3.0 Imports: 19 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	DefaultTCPTimeout = dialer.DefaultTCPTimeout
	DefaultUDPTimeout = dialer.DefaultUDPTimeout
	DefaultDropTime   = 12 * DefaultTCPTimeout
	DefaultTLSTimeout = DefaultTCPTimeout
	DefaultTestURL    = "https://www.gstatic.com/generate_204"
)
View Source 
const Name = "clash"

Variables

View Source 
var (
	GeositeName = "GeoSite.dat"
	GeoipName   = "GeoIP.dat"
	ASNName     = "ASN.mmdb"
)
View Source 
var (
	Meta      = true
	Version   = "1.10.0"
	BuildTime = "unknown time"
	ClashName = "clash"
)
View Source 
var DNSModeMapping = map[string]DNSMode{
	DNSNormal.String():  DNSNormal,
	DNSFakeIP.String():  DNSFakeIP,
	DNSMapping.String(): DNSMapping,
}

DNSModeMapping is a mapping for EnhancedMode enum

View Source 
var ErrNotSupport = errors.New("no support")
View Source 
var FilterModeMapping = map[string]FilterMode{
	FilterBlackList.String(): FilterBlackList,
	FilterWhiteList.String(): FilterWhiteList,
}

FilterModeMapping is a mapping for FilterMode enum

View Source 
var Path = func() *path {
	homeDir, err := os.UserHomeDir()
	if err != nil {
		homeDir, _ = os.Getwd()
	}
	allowUnsafePath, _ := strconv.ParseBool(os.Getenv("SKIP_SAFE_PATH_CHECK"))
	homeDir = P.Join(homeDir, ".config", Name)

	if _, err = os.Stat(homeDir); err != nil {
		if configHome, ok := os.LookupEnv("XDG_CONFIG_HOME"); ok {
			homeDir = P.Join(configHome, Name)
		}
	}

	return &path{homeDir: homeDir, configFile: "config.yaml", allowUnsafePath: allowUnsafePath}
}()

Path is used to get the configuration path

on Unix systems, `$HOME/.config/clash`. on Windows, `%USERPROFILE%/.config/clash`.

View Source 
var StackTypeMapping = map[string]TUNStack{
	strings.ToLower(TunGvisor.String()): TunGvisor,
	strings.ToLower(TunSystem.String()): TunSystem,
	strings.ToLower(TunMixed.String()):  TunMixed,
}

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
	RejectDrop
	Compatible
	Pass
	Dns

	Relay
	Selector
	Fallback
	URLTest
	LoadBalance

	Shadowsocks
	ShadowsocksR
	Snell
	Socks5
	Http
	Vmess
	Vless
	Trojan
	Hysteria
	Hysteria2
	WireGuard
	Tuic
	Ssh
)

Adapter Type

func (AdapterType) String 

func (at AdapterType) String() string

type Chain 

type Chain []string

func (Chain) Last 

func (c Chain) Last() string

func (Chain) String 

func (c Chain) String() string

type Conn 

type Conn interface {
	N.ExtendedConn
	Connection
}

type ConnContext 

type ConnContext interface {
	PlainContext
	Metadata() *Metadata
	Conn() *N.BufferedConn
}

type Connection 

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

type DNSMode 

type DNSMode int
const (
	DNSNormal DNSMode = iota
	DNSFakeIP
	DNSMapping
	DNSHosts
)

func (DNSMode) MarshalJSON 

func (e DNSMode) MarshalJSON() ([]byte, error)

MarshalJSON serialize EnhancedMode with json

func (DNSMode) MarshalText 

func (e DNSMode) MarshalText() ([]byte, error)

MarshalText serialize EnhancedMode

func (DNSMode) MarshalYAML 

func (e DNSMode) MarshalYAML() (any, error)

MarshalYAML serialize EnhancedMode with yaml

func (DNSMode) String 

func (e DNSMode) String() string

func (*DNSMode) UnmarshalJSON 

func (e *DNSMode) UnmarshalJSON(data []byte) error

UnmarshalJSON unserialize EnhancedMode with json

func (*DNSMode) UnmarshalText 

func (e *DNSMode) UnmarshalText(data []byte) error

UnmarshalText unserialize EnhancedMode

func (*DNSMode) UnmarshalYAML 

func (e *DNSMode) UnmarshalYAML(unmarshal func(any) error) error

UnmarshalYAML unserialize EnhancedMode with yaml

type DNSPrefer 

type DNSPrefer int
const (
	DualStack DNSPrefer = iota
	IPv4Only
	IPv6Only
	IPv4Prefer
	IPv6Prefer
)

func NewDNSPrefer 

func NewDNSPrefer(prefer string) DNSPrefer

func (DNSPrefer) String 

func (d DNSPrefer) String() string

type DelayHistory 

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

type DelayHistoryStoreType 

type DelayHistoryStoreType int

type Dialer 

type Dialer interface {
	DialContext(ctx context.Context, network, address string) (net.Conn, error)
	ListenPacket(ctx context.Context, network, address string, rAddrPort netip.AddrPort) (net.PacketConn, error)
}

type DomainMatcher 

type DomainMatcher interface {
	MatchDomain(domain string) bool
}

type FilterMode 

type FilterMode int
const (
	FilterBlackList FilterMode = iota
	FilterWhiteList
)

func (FilterMode) MarshalJSON 

func (e FilterMode) MarshalJSON() ([]byte, error)

func (FilterMode) MarshalText 

func (e FilterMode) MarshalText() ([]byte, error)

func (FilterMode) MarshalYAML 

func (e FilterMode) MarshalYAML() (interface{}, error)

func (FilterMode) String 

func (e FilterMode) String() string

func (*FilterMode) UnmarshalJSON 

func (e *FilterMode) UnmarshalJSON(data []byte) error

func (*FilterMode) UnmarshalText 

func (e *FilterMode) UnmarshalText(data []byte) error

func (*FilterMode) UnmarshalYAML 

func (e *FilterMode) UnmarshalYAML(unmarshal func(interface{}) error) error

type Group 

type Group interface {
	URLTest(ctx context.Context, url string, expectedStatus utils.IntRanges[uint16]) (mp map[string]uint16, err error)
	GetProxies(touch bool) []Proxy
	Touch()
}

type HTTPVersion 

type HTTPVersion string
const (
	// HTTPVersion11 is HTTP/1.1.
	HTTPVersion11 HTTPVersion = "http/1.1"
	// HTTPVersion2 is HTTP/2.
	HTTPVersion2 HTTPVersion = "h2"
	// HTTPVersion3 is HTTP/3.
	HTTPVersion3 HTTPVersion = "h3"
)

type InboundConfig 

type InboundConfig interface {
	Name() string
	Equal(config InboundConfig) bool
}

type InboundListener 

type InboundListener interface {
	Name() string
	Listen(tunnel Tunnel) error
	Close() error
	Address() string
	RawAddress() string
	Config() InboundConfig
}

type IpMatcher 

type IpMatcher interface {
	MatchIp(ip netip.Addr) bool
}

type Listener 

type Listener interface {
	RawAddress() string
	Address() string
	Close() error
}

type Metadata 

type Metadata struct {
	NetWork      NetWork    `json:"network"`
	Type         Type       `json:"type"`
	SrcIP        netip.Addr `json:"sourceIP"`
	DstIP        netip.Addr `json:"destinationIP"`
	SrcGeoIP     []string   `json:"sourceGeoIP"`      // can be nil if never queried, empty slice if got no result
	DstGeoIP     []string   `json:"destinationGeoIP"` // can be nil if never queried, empty slice if got no result
	SrcIPASN     string     `json:"sourceIPASN"`
	DstIPASN     string     `json:"destinationIPASN"`
	SrcPort      uint16     `json:"sourcePort,string"`      // `,string` is used to compatible with old version json output
	DstPort      uint16     `json:"destinationPort,string"` // `,string` is used to compatible with old version json output
	InIP         netip.Addr `json:"inboundIP"`
	InPort       uint16     `json:"inboundPort,string"` // `,string` is used to compatible with old version json output
	InName       string     `json:"inboundName"`
	InUser       string     `json:"inboundUser"`
	Host         string     `json:"host"`
	DNSMode      DNSMode    `json:"dnsMode"`
	Uid          uint32     `json:"uid"`
	Process      string     `json:"process"`
	ProcessPath  string     `json:"processPath"`
	SpecialProxy string     `json:"specialProxy"`
	SpecialRules string     `json:"specialRules"`
	RemoteDst    string     `json:"remoteDestination"`
	DSCP         uint8      `json:"dscp"`

	RawSrcAddr net.Addr `json:"-"`
	RawDstAddr net.Addr `json:"-"`
	// Only domain rule
	SniffHost string `json:"sniffHost"`
}

Metadata is used to store connection address

func (*Metadata) AddrPort 

func (m *Metadata) AddrPort() netip.AddrPort

func (*Metadata) AddrType 

func (m *Metadata) AddrType() int

func (*Metadata) Pure 

func (m *Metadata) Pure() *Metadata

Pure is used to solve unexpected behavior when dialing proxy connection in DNSMapping mode.

func (*Metadata) RemoteAddress 

func (m *Metadata) RemoteAddress() string

func (*Metadata) Resolved 

func (m *Metadata) Resolved() bool

func (*Metadata) RuleHost 

func (m *Metadata) RuleHost() string

func (*Metadata) SetRemoteAddr 

func (m *Metadata) SetRemoteAddr(addr net.Addr) error

func (*Metadata) SetRemoteAddress 

func (m *Metadata) SetRemoteAddress(rawAddress string) error

func (*Metadata) SourceAddrPort 

func (m *Metadata) SourceAddrPort() netip.AddrPort

func (*Metadata) SourceAddress 

func (m *Metadata) SourceAddress() string

func (*Metadata) SourceDetail 

func (m *Metadata) SourceDetail() string

func (*Metadata) SourceValid 

func (m *Metadata) SourceValid() bool

func (*Metadata) String 

func (m *Metadata) String() string

func (*Metadata) SwapSrcDst 

func (m *Metadata) SwapSrcDst()

func (*Metadata) UDPAddr 

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

func (*Metadata) Valid 

func (m *Metadata) Valid() bool

type MultiAddrListener 

type MultiAddrListener interface {
	Close() error
	Config() string
	AddrList() (addrList []net.Addr)
}

type NatTable 

type NatTable interface {
	GetOrCreate(key string, maker func() PacketSender) (PacketSender, bool)

	Delete(key string)

	GetForLocalConn(lAddr, rAddr string) *net.UDPConn

	AddForLocalConn(lAddr, rAddr string, conn *net.UDPConn) bool

	RangeForLocalConn(lAddr string, f func(key string, value *net.UDPConn) bool)

	GetOrCreateLockForLocalConn(lAddr string, key string) (*sync.Cond, bool)

	DeleteForLocalConn(lAddr, key string)

	DeleteLockForLocalConn(lAddr, key string)
}

type NetWork 

type NetWork int
const (
	TCP NetWork = iota
	UDP
	ALLNet
	InvalidNet = 0xff
)

Socks addr type

func (NetWork) MarshalJSON 

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

func (NetWork) String 

func (n NetWork) String() string

type PacketAdapter 

type PacketAdapter interface {
	UDPPacket
	// Metadata returns destination metadata
	Metadata() *Metadata
	// Key is a SNAT key
	Key() string
}

PacketAdapter is a UDP Packet adapter for socks/redir/tun

func NewPacketAdapter 

func NewPacketAdapter(packet UDPPacket, metadata *Metadata) PacketAdapter

type PacketConn 

type PacketConn interface {
	N.EnhancePacketConn
	Connection
}

type PacketConnContext 

type PacketConnContext interface {
	PlainContext
	Metadata() *Metadata
	PacketConn() net.PacketConn
}

type PacketSender 

type PacketSender interface {
	// Send will send PacketAdapter nonblocking
	// the implement must call UDPPacket.Drop() inside Send
	Send(PacketAdapter)
	// Process is a blocking loop to send PacketAdapter to PacketConn and update the WriteBackProxy
	Process(PacketConn, WriteBackProxy)
	// ResolveUDP do a local resolve UDP dns blocking if metadata is not resolved
	ResolveUDP(*Metadata) error
	// Close stop the Process loop
	Close()
}

type PlainContext 

type PlainContext interface {
	ID() uuid.UUID
}

type Proxy 

type Proxy interface {
	ProxyAdapter
	Adapter() ProxyAdapter
	AliveForTestUrl(url string) bool
	DelayHistory() []DelayHistory
	ExtraDelayHistories() map[string]ProxyState
	LastDelayForTestUrl(url string) uint16
	URLTest(ctx context.Context, url string, expectedStatus utils.IntRanges[uint16]) (uint16, error)

	// Deprecated: use DialContext instead.
	Dial(metadata *Metadata) (Conn, error)

	// Deprecated: use DialPacketConn instead.
	DialUDP(metadata *Metadata) (PacketConn, error)
}

type ProxyAdapter 

type ProxyAdapter interface {
	Name() string
	Type() AdapterType
	Addr() string
	SupportUDP() bool
	SupportXUDP() bool
	SupportTFO() bool
	MarshalJSON() ([]byte, error)

	// Deprecated: use DialContextWithDialer and ListenPacketWithDialer instead.
	// StreamConn wraps a protocol around net.Conn with Metadata.
	//
	// Examples:
	//	conn, _ := net.DialContext(context.Background(), "tcp", "host:port")
	//	conn, _ = adapter.StreamConnContext(context.Background(), conn, metadata)
	//
	// It returns a C.Conn with protocol which start with
	// a new session (if any)
	StreamConnContext(ctx context.Context, c net.Conn, metadata *Metadata) (net.Conn, error)

	// DialContext return a C.Conn with protocol which
	// contains multiplexing-related reuse logic (if any)
	DialContext(ctx context.Context, metadata *Metadata, opts ...dialer.Option) (Conn, error)
	ListenPacketContext(ctx context.Context, metadata *Metadata, opts ...dialer.Option) (PacketConn, error)

	// SupportUOT return UDP over TCP support
	SupportUOT() bool

	SupportWithDialer() NetWork
	DialContextWithDialer(ctx context.Context, dialer Dialer, metadata *Metadata) (Conn, error)
	ListenPacketWithDialer(ctx context.Context, dialer Dialer, metadata *Metadata) (PacketConn, error)

	// IsL3Protocol return ProxyAdapter working in L3 (tell dns module not pass the domain to avoid loopback)
	IsL3Protocol(metadata *Metadata) bool

	// Unwrap extracts the proxy from a proxy-group. It returns nil when nothing to extract.
	Unwrap(metadata *Metadata, touch bool) Proxy
}

type ProxyState 

type ProxyState struct {
	Alive   bool           `json:"alive"`
	History []DelayHistory `json:"history"`
}

type Rule 

type Rule interface {
	RuleType() RuleType
	Match(metadata *Metadata) (bool, string)
	Adapter() string
	Payload() string
	ShouldResolveIP() bool
	ShouldFindProcess() bool
	ProviderNames() []string
}

type RuleGroup 

type RuleGroup interface {
	Rule
	GetRecodeSize() int
}

type RuleType 

type RuleType int
const (
	Domain RuleType = iota
	DomainSuffix
	DomainKeyword
	DomainRegex
	GEOSITE
	GEOIP
	SrcGEOIP
	IPASN
	SrcIPASN
	IPCIDR
	SrcIPCIDR
	IPSuffix
	SrcIPSuffix
	SrcPort
	DstPort
	InPort
	DSCP
	InUser
	InName
	InType
	ProcessName
	ProcessPath
	ProcessNameRegex
	ProcessPathRegex
	RuleSet
	Network
	Uid
	SubRules
	MATCH
	AND
	OR
	NOT
)

Rule Type

func (RuleType) String 

func (rt RuleType) String() string

type TUNStack 

type TUNStack int
const (
	TunGvisor TUNStack = iota
	TunSystem
	TunMixed
)

func (TUNStack) MarshalJSON 

func (e TUNStack) MarshalJSON() ([]byte, error)

MarshalJSON serialize TUNStack with json

func (TUNStack) MarshalText 

func (e TUNStack) MarshalText() ([]byte, error)

MarshalText serialize TUNStack with json

func (TUNStack) MarshalYAML 

func (e TUNStack) MarshalYAML() (any, error)

MarshalYAML serialize TUNStack with yaml

func (TUNStack) String 

func (e TUNStack) String() string

func (*TUNStack) UnmarshalJSON 

func (e *TUNStack) UnmarshalJSON(data []byte) error

UnmarshalJSON unserialize TUNStack with json

func (*TUNStack) UnmarshalText 

func (e *TUNStack) UnmarshalText(data []byte) error

UnmarshalText unserialize TUNStack

func (*TUNStack) UnmarshalYAML 

func (e *TUNStack) UnmarshalYAML(unmarshal func(any) error) error

UnmarshalYAML unserialize TUNStack with yaml

type Tunnel 

type Tunnel interface {
	// HandleTCPConn will handle a tcp connection blocking
	HandleTCPConn(conn net.Conn, metadata *Metadata)
	// HandleUDPPacket will handle a udp packet nonblocking
	HandleUDPPacket(packet UDPPacket, metadata *Metadata)
	// NatTable return nat table
	NatTable() NatTable
}

type Type 

type Type int
const (
	HTTP Type = iota
	HTTPS
	SOCKS4
	SOCKS5
	SHADOWSOCKS
	VMESS
	REDIR
	TPROXY
	TUNNEL
	TUN
	TUIC
	HYSTERIA2
	INNER
)

func ParseType 

func ParseType(t string) (*Type, error)

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 write out UDP packet with SourceIP/Port equals to original Target,
	//   this is important when using Fake-IP.
	WriteBack

	// Drop call after packet is used, could recycle buffer in this function.
	Drop()

	// 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

type UDPPacketInAddr 

type UDPPacketInAddr interface {
	InAddr() net.Addr
}

type WriteBack 

type WriteBack interface {
	WriteBack(b []byte, addr net.Addr) (n int, err error)
}

type WriteBackProxy 

type WriteBackProxy interface {
	WriteBack
	UpdateWriteBack(wb WriteBack)
}

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.