clash/constant/adapters.go

251 lines
5.2 KiB
Go
Raw Normal View History

2018-06-10 14:50:03 +00:00
package constant
import (
2019-07-02 11:18:03 +00:00
"context"
"fmt"
2018-06-13 17:00:58 +00:00
"net"
2022-12-19 13:34:07 +00:00
"net/netip"
"sync"
"time"
"github.com/Dreamacro/clash/component/dialer"
2018-06-10 14:50:03 +00:00
)
// Adapter Type
const (
Direct AdapterType = iota
Reject
Compatible
Pass
Relay
Selector
Fallback
URLTest
LoadBalance
Shadowsocks
ShadowsocksR
2019-10-09 10:46:23 +00:00
Snell
2018-08-12 05:50:54 +00:00
Socks5
Http
2018-09-06 02:53:29 +00:00
Vmess
2021-11-17 08:03:47 +00:00
Vless
2020-03-19 12:26:53 +00:00
Trojan
2022-06-07 05:38:45 +00:00
Hysteria
2022-11-09 10:44:06 +00:00
WireGuard
2022-11-25 00:08:14 +00:00
Tuic
)
2021-06-10 06:05:56 +00:00
const (
DefaultTCPTimeout = 5 * time.Second
DefaultUDPTimeout = DefaultTCPTimeout
DefaultTLSTimeout = DefaultTCPTimeout
2021-06-10 06:05:56 +00:00
)
type Connection interface {
Chains() Chain
AppendToChains(adapter ProxyAdapter)
2022-05-26 15:41:09 +00:00
RemoteDestination() string
}
type Chain []string
func (c Chain) String() string {
switch len(c) {
case 0:
return ""
case 1:
return c[0]
default:
return fmt.Sprintf("%s[%s]", c[len(c)-1], c[0])
}
}
func (c Chain) Last() string {
switch len(c) {
case 0:
return ""
default:
return c[0]
}
}
type Conn interface {
net.Conn
Connection
}
type PacketConn interface {
net.PacketConn
Connection
// Deprecate WriteWithMetadata because of remote resolve DNS cause TURN failed
// WriteWithMetadata(p []byte, metadata *Metadata) (n int, err error)
}
2022-12-19 13:34:07 +00:00
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 ProxyAdapter interface {
2018-06-16 13:34:13 +00:00
Name() string
Type() AdapterType
Addr() string
SupportUDP() bool
SupportXUDP() bool
SupportTFO() bool
MarshalJSON() ([]byte, error)
2022-12-19 13:34:07 +00:00
// 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.StreamConn(conn, metadata)
//
// It returns a C.Conn with protocol which start with
// a new session (if any)
StreamConn(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
2022-12-19 13:34:07 +00:00
SupportWithDialer() bool
DialContextWithDialer(ctx context.Context, dialer Dialer, metadata *Metadata) (Conn, error)
ListenPacketWithDialer(ctx context.Context, dialer Dialer, metadata *Metadata) (PacketConn, error)
// Unwrap extracts the proxy from a proxy-group. It returns nil when nothing to extract.
2022-10-30 15:08:18 +00:00
Unwrap(metadata *Metadata, touch bool) Proxy
2018-06-10 14:50:03 +00:00
}
2022-05-30 13:55:09 +00:00
type Group interface {
URLTest(ctx context.Context, url string) (mp map[string]uint16, err error)
GetProxies(touch bool) []Proxy
Touch()
2022-05-30 13:55:09 +00:00
}
type DelayHistory struct {
Time time.Time `json:"time"`
Delay uint16 `json:"delay"`
}
type Proxy interface {
ProxyAdapter
Alive() bool
DelayHistory() []DelayHistory
LastDelay() uint16
2019-07-02 11:18:03 +00:00
URLTest(ctx context.Context, url string) (uint16, error)
// Deprecated: use DialContext instead.
Dial(metadata *Metadata) (Conn, error)
// Deprecated: use DialPacketConn instead.
DialUDP(metadata *Metadata) (PacketConn, error)
}
// AdapterType is enum of adapter type
type AdapterType int
func (at AdapterType) String() string {
switch at {
case Direct:
return "Direct"
case Reject:
return "Reject"
case Compatible:
return "Compatible"
case Pass:
return "Pass"
case Shadowsocks:
return "Shadowsocks"
case ShadowsocksR:
return "ShadowsocksR"
2019-10-09 10:46:23 +00:00
case Snell:
return "Snell"
2018-08-12 05:50:54 +00:00
case Socks5:
return "Socks5"
case Http:
return "Http"
2018-09-06 02:53:29 +00:00
case Vmess:
return "Vmess"
2021-11-17 08:03:47 +00:00
case Vless:
return "Vless"
2020-03-19 12:26:53 +00:00
case Trojan:
return "Trojan"
2022-06-07 05:38:45 +00:00
case Hysteria:
return "Hysteria"
2022-11-09 10:44:06 +00:00
case WireGuard:
return "WireGuard"
2022-11-25 00:08:14 +00:00
case Tuic:
return "Tuic"
2020-03-19 12:26:53 +00:00
case Relay:
return "Relay"
2020-03-19 12:26:53 +00:00
case Selector:
return "Selector"
case Fallback:
return "Fallback"
case URLTest:
return "URLTest"
2019-02-15 06:25:20 +00:00
case LoadBalance:
return "LoadBalance"
2020-03-19 12:26:53 +00:00
default:
2019-08-26 04:26:14 +00:00
return "Unknown"
}
}
// UDPPacket contains the data of UDP packet, and offers control/info of UDP packet's source
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
2020-10-14 11:56:02 +00:00
// - 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(b []byte, addr net.Addr) (n int, err error)
// Drop call after packet is used, could recycle buffer in this function.
Drop()
// LocalAddr returns the source IP/Port of packet
LocalAddr() net.Addr
}
2022-11-11 15:36:06 +00:00
type UDPPacketInAddr interface {
InAddr() net.Addr
}
// PacketAdapter is a UDP Packet adapter for socks/redir/tun
type PacketAdapter interface {
UDPPacket
Metadata() *Metadata
}
type NatTable interface {
Set(key string, e PacketConn)
Get(key string) PacketConn
GetOrCreateLock(key string) (*sync.Cond, bool)
Delete(key string)
GetLocalConn(lAddr, rAddr string) *net.UDPConn
AddLocalConn(lAddr, rAddr string, conn *net.UDPConn) bool
RangeLocalConn(lAddr string, f func(key, value any) bool)
GetOrCreateLockForLocalConn(lAddr, key string) (*sync.Cond, bool)
DeleteLocalConnMap(lAddr, key string)
}