shadowsocks

Documentation

Index

• Constants
• type Client
  • func NewClient(ctx context.Context, underlay tunnel.Client) (*Client, error)
  • func (c *Client) Close() error
  • func (c *Client) DialConn(address *tunnel.Address, tunnel tunnel.Tunnel) (tunnel.Conn, error)
  • func (c *Client) DialPacket(tunnel tunnel.Tunnel) (tunnel.PacketConn, error)
• type Config
• type Conn
  • func (c *Conn) Close() error
  • func (c *Conn) Metadata() *tunnel.Metadata
  • func (c *Conn) Read(p []byte) (n int, err error)
  • func (c *Conn) Write(p []byte) (n int, err error)
• type Server
  • func NewServer(ctx context.Context, underlay tunnel.Server) (*Server, error)
  • func (s *Server) AcceptConn(overlay tunnel.Tunnel) (tunnel.Conn, error)
  • func (s *Server) AcceptPacket(t tunnel.Tunnel) (tunnel.PacketConn, error)
  • func (s *Server) Close() error
• type ShadowsocksConfig
• type Tunnel
  • func (t *Tunnel) Name() string
  • func (t *Tunnel) NewClient(ctx context.Context, client tunnel.Client) (tunnel.Client, error)
  • func (t *Tunnel) NewServer(ctx context.Context, server tunnel.Server) (tunnel.Server, error)

Constants

const Name = "SHADOWSOCKS"

Types

type Client

type Client struct {
	core.Cipher
	// contains filtered or unexported fields
}

func NewClient

func NewClient(ctx context.Context, underlay tunnel.Client) (*Client, error)

func (*Client) Close

func (c *Client) Close() error

func (*Client) DialConn

func (c *Client) DialConn(address *tunnel.Address, tunnel tunnel.Tunnel) (tunnel.Conn, error)

func (*Client) DialPacket

func (c *Client) DialPacket(tunnel tunnel.Tunnel) (tunnel.PacketConn, error)

type Config

type Config struct {
	RemoteHost  string            `json:"remote_addr" yaml:"remote-addr"`
	RemotePort  int               `json:"remote_port" yaml:"remote-port"`
	Shadowsocks ShadowsocksConfig `json:"shadowsocks" yaml:"shadowsocks"`
}

type Conn

type Conn struct {
	tunnel.Conn
	// contains filtered or unexported fields
}

func (*Conn) Close

func (c *Conn) Close() error

func (*Conn) Metadata

func (c *Conn) Metadata() *tunnel.Metadata

func (*Conn) Read

func (c *Conn) Read(p []byte) (n int, err error)

func (*Conn) Write

func (c *Conn) Write(p []byte) (n int, err error)

type Server

type Server struct {
	core.Cipher
	*redirector.Redirector
	// contains filtered or unexported fields
}

func NewServer

func NewServer(ctx context.Context, underlay tunnel.Server) (*Server, error)

func (*Server) AcceptConn

func (s *Server) AcceptConn(overlay tunnel.Tunnel) (tunnel.Conn, error)

func (*Server) AcceptPacket

func (s *Server) AcceptPacket(t tunnel.Tunnel) (tunnel.PacketConn, error)

func (*Server) Close

func (s *Server) Close() error

type ShadowsocksConfig

type ShadowsocksConfig struct {
	Enabled  bool   `json:"enabled" yaml:"enabled"`
	Method   string `json:"method" yaml:"method"`
	Password string `json:"password" yaml:"password"`
}

type Tunnel

type Tunnel struct{}

func (*Tunnel) Name

func (t *Tunnel) Name() string

func (*Tunnel) NewClient

func (t *Tunnel) NewClient(ctx context.Context, client tunnel.Client) (tunnel.Client, error)

func (*Tunnel) NewServer

func (t *Tunnel) NewServer(ctx context.Context, server tunnel.Server) (tunnel.Server, error)