juicity

README

Copyright (C) 2025  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/>.

Documentation

Index

• Constants
• Variables
• type Client
  • func NewClient(options ClientOptions) (*Client, error)
  • func (c *Client) CloseWithError(err error) error
  • func (c *Client) DialConn(ctx context.Context, destination metadata.Socksaddr) (net.Conn, error)
  • func (c *Client) ListenPacket(ctx context.Context, destination metadata.Socksaddr) (net.PacketConn, error)
• type ClientOptions
• type Service
  • func NewService[U comparable](options ServiceOptions) (*Service[U], error)
  • func (s *Service[U]) Close() error
  • func (s *Service[U]) Start(conn net.PacketConn) error
  • func (s *Service[U]) UpdateUsers(userList []U, uuidList [][16]byte, passwordList []string)
• type ServiceHandler
• type ServiceOptions

Constants

const (
	NetworkTCP = 1
	NetworkUDP = 3
)

const AuthenticateLen = 2 + 16 + 32

const (
	CommandAuthenticate = 0
)

const (
	Version = 0
)

Variables

var AddressSerializer = metadata.NewSerializer(
	metadata.AddressFamilyByte(0x01, metadata.AddressFamilyIPv4),
	metadata.AddressFamilyByte(0x04, metadata.AddressFamilyIPv6),
	metadata.AddressFamilyByte(0x03, metadata.AddressFamilyFqdn),
)

Juicity Specification tells us it is 0x01 for IPv4, 0x02 for IPv6, and 0x03 for domain, which is incorrect.

Types

type Client

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

func NewClient

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

func (*Client) CloseWithError

func (c *Client) CloseWithError(err error) error

func (*Client) DialConn

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

func (*Client) ListenPacket

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

type ClientOptions

type ClientOptions struct {
	Context           context.Context
	Dialer            network.Dialer
	ServerAddress     metadata.Socksaddr
	TLSConfig         tls.Config
	QUICConfig        *quic.Config
	UUID              [16]byte
	Password          string
	CongestionControl string
}

type Service

type Service[U comparable] struct {
	// contains filtered or unexported fields
}

func NewService

func NewService[U comparable](options ServiceOptions) (*Service[U], error)

func (*Service[U]) Close

func (s *Service[U]) Close() error

func (*Service[U]) Start

func (s *Service[U]) Start(conn net.PacketConn) error

func (*Service[U]) UpdateUsers

func (s *Service[U]) UpdateUsers(userList []U, uuidList [][16]byte, passwordList []string)

type ServiceHandler

type ServiceHandler interface {
	network.TCPConnectionHandlerEx
	network.UDPConnectionHandlerEx
}

type ServiceOptions

type ServiceOptions struct {
	Context           context.Context
	Logger            logger.Logger
	TLSConfig         tls.ServerConfig
	QUICConfig        *quic.Config
	CongestionControl string
	AuthTimeout       time.Duration
	// UDPTimeout  time.Duration todo?
	Handler ServiceHandler
}