service

Dec 16, 2024

Changes in this version

+ func MakeTargetUDPListener(fwmark uint) transport.PacketListener

+ func MakeValidatingTCPStreamDialer(targetIPValidator onet.TargetIPValidator, fwmark uint) transport.StreamDialer

+ func SetFwmark(rc syscall.RawConn, fwmark uint) error — linux/amd64

type Option

+ func WithPacketListener(listener transport.PacketListener) Option

+ func WithStreamDialer(dialer transport.StreamDialer) Option

type PacketHandler

+ SetTargetPacketListener func(targetListener transport.PacketListener)

type ReplayCache

+ func (c *ReplayCache) Resize(capacity int) error

Oct 2, 2024

Changes in this version

type Option

+ func WithLogger(l *slog.Logger) Option

type PacketHandler

+ SetLogger func(l *slog.Logger)

type StreamHandler

+ SetLogger func(l *slog.Logger)

Sep 18, 2024

Changes in this version

+ type NoOpShadowsocksConnMetrics struct

+ func (m *NoOpShadowsocksConnMetrics) AddCipherSearch(accessKeyFound bool, timeToCipher time.Duration)

+ type Option func(s *ssService)

+ func WithCiphers(ciphers CipherList) Option

+ func WithMetrics(metrics ServiceMetrics) Option

+ func WithNatTimeout(natTimeout time.Duration) Option

+ func WithReplayCache(replayCache *ReplayCache) Option

+ type Service interface

+ HandlePacket func(conn net.PacketConn)

+ HandleStream func(ctx context.Context, conn transport.StreamConn)

+ func NewShadowsocksService(opts ...Option) (Service, error)

+ type ServiceMetrics interface

+ AddCipherSearch func(proto string, accessKeyFound bool, timeToCipher time.Duration)

+ AddOpenTCPConnection func(conn net.Conn) TCPConnMetrics

Aug 29, 2024

Changes in this version

+ type Listener = io.Closer

+ type ListenerManager interface

+ ListenPacket func(addr string) (net.PacketConn, error)

+ ListenStream func(addr string) (StreamListener, error)

+ func NewListenerManager() ListenerManager

+ type MultiListener interface

+ Acquire func() (T, error)

+ func NewMultiPacketListener(addr string, onCloseFunc OnCloseFunc) MultiListener[net.PacketConn]

+ func NewMultiStreamListener(addr string, onCloseFunc OnCloseFunc) MultiListener[StreamListener]

+ type NoOpTCPConnMetrics struct

+ func (m *NoOpTCPConnMetrics) AddAuthenticated(accessKey string)

+ func (m *NoOpTCPConnMetrics) AddClosed(status string, data metrics.ProxyMetrics, duration time.Duration)

+ func (m *NoOpTCPConnMetrics) AddProbe(status, drainResult string, clientProxyBytes int64)

+ type NoOpUDPConnMetrics struct

+ func (m *NoOpUDPConnMetrics) AddPacketFromClient(status string, clientProxyBytes, proxyTargetBytes int64)

+ func (m *NoOpUDPConnMetrics) AddPacketFromTarget(status string, targetProxyBytes, proxyClientBytes int64)

+ func (m *NoOpUDPConnMetrics) RemoveNatEntry()

+ type OnCloseFunc func() error

+ type ShadowsocksConnMetrics interface

+ AddCipherSearch func(accessKeyFound bool, timeToCipher time.Duration)

+ type StreamAcceptFunc func() (transport.StreamConn, error)

+ func WrapStreamAcceptFunc[T transport.StreamConn](f func() (T, error)) StreamAcceptFunc

+ type StreamHandleFunc func(ctx context.Context, conn transport.StreamConn)

type StreamHandler

+ func NewStreamHandler(authenticate StreamAuthenticateFunc, timeout time.Duration) StreamHandler

+ Handle func(ctx context.Context, conn transport.StreamConn, connMetrics TCPConnMetrics)

+ SetTargetDialer func(dialer transport.StreamDialer)

type StreamListener

+ AcceptStream func() (transport.StreamConn, error)

+ Addr func() net.Addr

+ Close func() error

+ type TCPConnMetrics interface

+ AddAuthenticated func(accessKey string)

+ AddClosed func(status string, data metrics.ProxyMetrics, duration time.Duration)

+ AddProbe func(status, drainResult string, clientProxyBytes int64)

+ type TCPListener struct

+ func (t *TCPListener) AcceptStream() (transport.StreamConn, error)

+ func (t *TCPListener) Addr() net.Addr

+ func (t *TCPListener) Close() error

+ type UDPConnMetrics interface

+ AddPacketFromClient func(status string, clientProxyBytes, proxyTargetBytes int64)

+ AddPacketFromTarget func(status string, targetProxyBytes, proxyClientBytes int64)

+ RemoveNatEntry func()

Mar 28, 2024

Changes in this version

+ func StreamServe(accept StreamListener, handle StreamHandler)

type CipherEntry

+ CryptoKey *shadowsocks.EncryptionKey

+ type NoOpTCPMetrics struct

+ func (m *NoOpTCPMetrics) AddAuthenticatedTCPConnection(clientAddr net.Addr, accessKey string)

+ func (m *NoOpTCPMetrics) AddClosedTCPConnection(clientInfo ipinfo.IPInfo, clientAddr net.Addr, accessKey string, status string, ...)

+ func (m *NoOpTCPMetrics) AddOpenTCPConnection(clientInfo ipinfo.IPInfo)

+ func (m *NoOpTCPMetrics) AddTCPCipherSearch(accessKeyFound bool, timeToCipher time.Duration)

+ func (m *NoOpTCPMetrics) AddTCPProbe(status, drainResult string, port int, clientProxyBytes int64)

+ func (m *NoOpTCPMetrics) GetIPInfo(net.IP) (ipinfo.IPInfo, error)

+ type NoOpUDPMetrics struct

+ func (m *NoOpUDPMetrics) AddUDPCipherSearch(accessKeyFound bool, timeToCipher time.Duration)

+ func (m *NoOpUDPMetrics) AddUDPNatEntry(clientAddr net.Addr, accessKey string)

+ func (m *NoOpUDPMetrics) AddUDPPacketFromClient(clientInfo ipinfo.IPInfo, accessKey, status string, ...)

+ func (m *NoOpUDPMetrics) AddUDPPacketFromTarget(clientInfo ipinfo.IPInfo, accessKey, status string, ...)

+ func (m *NoOpUDPMetrics) GetIPInfo(net.IP) (ipinfo.IPInfo, error)

+ func (m *NoOpUDPMetrics) RemoveUDPNatEntry(clientAddr net.Addr, accessKey string)

+ type PacketHandler interface

+ Handle func(clientConn net.PacketConn)

+ SetTargetIPValidator func(targetIPValidator onet.TargetIPValidator)

+ func NewPacketHandler(natTimeout time.Duration, cipherList CipherList, m UDPMetrics) PacketHandler

+ type ShadowsocksTCPMetrics interface

+ AddTCPCipherSearch func(accessKeyFound bool, timeToCipher time.Duration)

+ type StreamAuthenticateFunc func(clientConn transport.StreamConn) (string, transport.StreamConn, *onet.ConnectionError)

+ func NewShadowsocksStreamAuthenticator(ciphers CipherList, replayCache *ReplayCache, metrics ShadowsocksTCPMetrics) StreamAuthenticateFunc

+ type StreamHandler func(ctx context.Context, conn transport.StreamConn)

+ type StreamListener func() (transport.StreamConn, error)

+ func WrapStreamListener[T transport.StreamConn](f func() (T, error)) StreamListener

+ type TCPHandler interface

+ Handle func(ctx context.Context, conn transport.StreamConn)

+ SetTargetDialer func(dialer transport.StreamDialer)

+ func NewTCPHandler(port int, authenticate StreamAuthenticateFunc, m TCPMetrics, ...) TCPHandler

+ type TCPMetrics interface

+ AddAuthenticatedTCPConnection func(clientAddr net.Addr, accessKey string)

+ AddClosedTCPConnection func(clientInfo ipinfo.IPInfo, clientAddr net.Addr, accessKey string, status string, ...)

+ AddOpenTCPConnection func(clientInfo ipinfo.IPInfo)

+ AddTCPProbe func(status, drainResult string, port int, clientProxyBytes int64)

+ type UDPMetrics interface

+ AddUDPCipherSearch func(accessKeyFound bool, timeToCipher time.Duration)

+ AddUDPNatEntry func(clientAddr net.Addr, accessKey string)

+ AddUDPPacketFromClient func(clientInfo ipinfo.IPInfo, accessKey, status string, ...)

+ AddUDPPacketFromTarget func(clientInfo ipinfo.IPInfo, accessKey, status string, ...)

+ RemoveUDPNatEntry func(clientAddr net.Addr, accessKey string)

Oct 5, 2020

Changes in this version

+ const MaxCapacity

+ const ServerSaltMarkLen

+ type CipherEntry struct

+ Cipher shadowaead.Cipher

+ ID string

+ SaltGenerator ServerSaltGenerator

+ func MakeCipherEntry(id string, cipher shadowaead.Cipher, secret string) CipherEntry

+ type CipherList interface

+ MarkUsedByClientIP func(e *list.Element, clientIP net.IP)

+ SnapshotForClientIP func(clientIP net.IP) (int, []*list.Element)

+ Update func(contents *list.List) error

+ func MakeTestCiphers(secrets []string) (CipherList, error)

+ func NewCipherList() CipherList

+ type ReplayCache struct

+ func NewReplayCache(capacity int) ReplayCache

+ func (c *ReplayCache) Add(id string, salt []byte) bool

+ type ServerSaltGenerator interface

+ IsServerSalt func(salt []byte) bool

+ var RandomServerSaltGenerator ServerSaltGenerator = randomServerSaltGenerator{}

+ func NewServerSaltGenerator(secret string) ServerSaltGenerator

+ type TCPService interface

+ GracefulStop func() error

+ Serve func(listener *net.TCPListener) error

+ SetTargetIPValidator func(targetIPValidator onet.TargetIPValidator)

+ Stop func() error

+ func NewTCPService(ciphers CipherList, replayCache *ReplayCache, m metrics.ShadowsocksMetrics, ...) TCPService

+ type UDPService interface

+ GracefulStop func() error

+ Serve func(clientConn net.PacketConn) error

+ SetTargetIPValidator func(targetIPValidator onet.TargetIPValidator)

+ Stop func() error

+ func NewUDPService(natTimeout time.Duration, cipherList CipherList, m metrics.ShadowsocksMetrics) UDPService