shadowquic

README

ShadowQUIC client in sing flavor based on https://github.com/metacubex/jls-quic-go and https://github.com/metacubex/jls-tls.

License

Copyright (C) 2026  dyhkwong

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.

References

• https://github.com/MetaCubeX/mihomo

• https://github.com/SagerNet/sing-quic

• https://github.com/spongebob888/shadowquic

Documentation

Index

• type Client
  • func NewClient(options ClientOptions) (*Client, error)
  • func NewShadowQUICClient(options ShadowQUICClientOptions) (*Client, error)
  • func NewSunnyQUICClient(options SunnyQUICClientOptions) (*Client, error)
  • func (c *Client) Close() error
  • func (c *Client) DialConn(ctx context.Context, destination metadata.Socksaddr) (net.Conn, error)
  • func (c *Client) DialCustomCommandConn(ctx context.Context) (net.Conn, error)
  • func (c *Client) ListenPacket(ctx context.Context) (net.PacketConn, error)
• type ClientOptions
• type ShadowQUICClientOptions
• type SunnyQUICClientOptions

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

func NewClient

func NewClient(options ClientOptions) (*Client, error)

func NewShadowQUICClient

func NewShadowQUICClient(options ShadowQUICClientOptions) (*Client, error)

func NewSunnyQUICClient

func NewSunnyQUICClient(options SunnyQUICClientOptions) (*Client, error)

func (*Client) Close

func (c *Client) Close() error

func (*Client) DialConn

func (c *Client) DialConn(ctx context.Context, destination metadata.Socksaddr) (net.Conn, error)

func (*Client) DialCustomCommandConn

func (c *Client) DialCustomCommandConn(ctx context.Context) (net.Conn, error)

func (*Client) ListenPacket

func (c *Client) ListenPacket(ctx context.Context) (net.PacketConn, error)

type ClientOptions

type ClientOptions struct {
	Context           context.Context
	Dialer            network.Dialer
	ServerAddress     metadata.Socksaddr
	Username          string
	Password          string
	ServerName        string
	NextProtos        []string
	CongestionControl string
	UDPOverStream     bool
	ZeroRTTHandshake  bool
	SunnyQUIC         bool
}

type ShadowQUICClientOptions

type ShadowQUICClientOptions struct {
	Context           context.Context
	Dialer            network.Dialer
	ServerAddress     metadata.Socksaddr
	TLSConfig         *tls.Config
	QUICConfig        *quic.Config
	CongestionControl string
	UDPOverStream     bool
	ZeroRTTHandshake  bool
}

type SunnyQUICClientOptions

type SunnyQUICClientOptions struct {
	Context           context.Context
	Dialer            network.Dialer
	ServerAddress     metadata.Socksaddr
	Username          string
	Password          string
	TLSConfig         *tls.Config
	QUICConfig        *quic.Config
	CongestionControl string
	UDPOverStream     bool
	ZeroRTTHandshake  bool
}