//go:build with_quic package tuic import ( "context" "io" "net" "runtime" "sync" "time" "github.com/sagernet/quic-go" "github.com/sagernet/sing-box/common/qtls" "github.com/sagernet/sing-box/common/tls" "github.com/sagernet/sing/common" "github.com/sagernet/sing/common/baderror" "github.com/sagernet/sing/common/buf" "github.com/sagernet/sing/common/bufio" E "github.com/sagernet/sing/common/exceptions" M "github.com/sagernet/sing/common/metadata" N "github.com/sagernet/sing/common/network" "github.com/gofrs/uuid/v5" ) type ClientOptions struct { Context context.Context Dialer N.Dialer ServerAddress M.Socksaddr TLSConfig tls.Config UUID uuid.UUID Password string CongestionControl string UDPStream bool ZeroRTTHandshake bool Heartbeat time.Duration } type Client struct { ctx context.Context dialer N.Dialer serverAddr M.Socksaddr tlsConfig tls.Config quicConfig *quic.Config uuid uuid.UUID password string congestionControl string udpStream bool zeroRTTHandshake bool heartbeat time.Duration connAccess sync.RWMutex conn *clientQUICConnection } func NewClient(options ClientOptions) (*Client, error) { if options.Heartbeat == 0 { options.Heartbeat = 10 * time.Second } quicConfig := &quic.Config{ DisablePathMTUDiscovery: !(runtime.GOOS == "windows" || runtime.GOOS == "linux" || runtime.GOOS == "android" || runtime.GOOS == "darwin"), MaxDatagramFrameSize: 1400, EnableDatagrams: true, MaxIncomingUniStreams: 1 << 60, } switch options.CongestionControl { case "": options.CongestionControl = "cubic" case "cubic", "new_reno", "bbr": default: return nil, E.New("unknown congestion control algorithm: ", options.CongestionControl) } return &Client{ ctx: options.Context, dialer: options.Dialer, serverAddr: options.ServerAddress, tlsConfig: options.TLSConfig, quicConfig: quicConfig, uuid: options.UUID, password: options.Password, congestionControl: options.CongestionControl, udpStream: options.UDPStream, zeroRTTHandshake: options.ZeroRTTHandshake, heartbeat: options.Heartbeat, }, nil } func (c *Client) offer(ctx context.Context) (*clientQUICConnection, error) { conn := c.conn if conn != nil && conn.active() { return conn, nil } c.connAccess.Lock() defer c.connAccess.Unlock() conn = c.conn if conn != nil && conn.active() { return conn, nil } conn, err := c.offerNew(ctx) if err != nil { return nil, err } return conn, nil } func (c *Client) offerNew(ctx context.Context) (*clientQUICConnection, error) { udpConn, err := c.dialer.DialContext(c.ctx, "udp", c.serverAddr) if err != nil { return nil, err } var quicConn quic.Connection if c.zeroRTTHandshake { quicConn, err = qtls.DialEarly(ctx, bufio.NewUnbindPacketConn(udpConn), udpConn.RemoteAddr(), c.tlsConfig, c.quicConfig) } else { quicConn, err = qtls.Dial(ctx, bufio.NewUnbindPacketConn(udpConn), udpConn.RemoteAddr(), c.tlsConfig, c.quicConfig) } if err != nil { udpConn.Close() return nil, E.Cause(err, "open connection") } setCongestion(c.ctx, quicConn, c.congestionControl) conn := &clientQUICConnection{ quicConn: quicConn, rawConn: udpConn, connDone: make(chan struct{}), udpConnMap: make(map[uint16]*udpPacketConn), } go func() { hErr := c.clientHandshake(quicConn) if hErr != nil { conn.closeWithError(hErr) } }() if c.udpStream { go c.loopUniStreams(conn) } go c.loopMessages(conn) go c.loopHeartbeats(conn) c.conn = conn return conn, nil } func (c *Client) clientHandshake(conn quic.Connection) error { authStream, err := conn.OpenUniStream() if err != nil { return E.Cause(err, "open handshake stream") } defer authStream.Close() handshakeState := conn.ConnectionState() tuicAuthToken, err := handshakeState.ExportKeyingMaterial(string(c.uuid[:]), []byte(c.password), 32) if err != nil { return E.Cause(err, "export keying material") } authRequest := buf.NewSize(AuthenticateLen) authRequest.WriteByte(Version) authRequest.WriteByte(CommandAuthenticate) authRequest.Write(c.uuid[:]) authRequest.Write(tuicAuthToken) return common.Error(authStream.Write(authRequest.Bytes())) } func (c *Client) loopHeartbeats(conn *clientQUICConnection) { ticker := time.NewTicker(c.heartbeat) defer ticker.Stop() for { select { case <-conn.connDone: return case <-ticker.C: err := conn.quicConn.SendMessage([]byte{Version, CommandHeartbeat}) if err != nil { conn.closeWithError(E.Cause(err, "send heartbeat")) } } } } func (c *Client) DialConn(ctx context.Context, destination M.Socksaddr) (net.Conn, error) { conn, err := c.offer(ctx) if err != nil { return nil, err } stream, err := conn.quicConn.OpenStream() if err != nil { return nil, err } return &clientConn{ Stream: stream, parent: conn, destination: destination, }, nil } func (c *Client) ListenPacket(ctx context.Context) (net.PacketConn, error) { conn, err := c.offer(ctx) if err != nil { return nil, err } var sessionID uint16 clientPacketConn := newUDPPacketConn(ctx, conn.quicConn, c.udpStream, false, func() { conn.udpAccess.Lock() delete(conn.udpConnMap, sessionID) conn.udpAccess.Unlock() }) conn.udpAccess.Lock() sessionID = conn.udpSessionID conn.udpSessionID++ conn.udpConnMap[sessionID] = clientPacketConn conn.udpAccess.Unlock() clientPacketConn.sessionID = sessionID return clientPacketConn, nil } func (c *Client) CloseWithError(err error) error { conn := c.conn if conn != nil { conn.closeWithError(err) } return nil } type clientQUICConnection struct { quicConn quic.Connection rawConn io.Closer closeOnce sync.Once connDone chan struct{} connErr error udpAccess sync.RWMutex udpConnMap map[uint16]*udpPacketConn udpSessionID uint16 } func (c *clientQUICConnection) active() bool { select { case <-c.quicConn.Context().Done(): return false default: } select { case <-c.connDone: return false default: } return true } func (c *clientQUICConnection) closeWithError(err error) { c.closeOnce.Do(func() { c.connErr = err close(c.connDone) _ = c.quicConn.CloseWithError(0, "") _ = c.rawConn.Close() }) } type clientConn struct { quic.Stream parent *clientQUICConnection destination M.Socksaddr requestWritten bool } func (c *clientConn) NeedHandshake() bool { return !c.requestWritten } func (c *clientConn) Read(b []byte) (n int, err error) { n, err = c.Stream.Read(b) return n, baderror.WrapQUIC(err) } func (c *clientConn) Write(b []byte) (n int, err error) { if !c.requestWritten { request := buf.NewSize(2 + addressSerializer.AddrPortLen(c.destination) + len(b)) defer request.Release() request.WriteByte(Version) request.WriteByte(CommandConnect) err = addressSerializer.WriteAddrPort(request, c.destination) if err != nil { return } request.Write(b) _, err = c.Stream.Write(request.Bytes()) if err != nil { c.parent.closeWithError(E.Cause(err, "create new connection")) return 0, baderror.WrapQUIC(err) } c.requestWritten = true return len(b), nil } n, err = c.Stream.Write(b) return n, baderror.WrapQUIC(err) } func (c *clientConn) Close() error { c.Stream.CancelRead(0) return c.Stream.Close() } func (c *clientConn) LocalAddr() net.Addr { return M.Socksaddr{} } func (c *clientConn) RemoteAddr() net.Addr { return c.destination }