core

Documentation

Overview

Package core implements essential parts of Shadowsocks

Index

• Variables
• func Dial(network, address string, ciph StreamConnCipher) (net.Conn, error)
• func Kdf(password string, keyLen int) []byte
• func ListCipher() []string
• func Listen(network, address string, ciph StreamConnCipher) (net.Listener, error)
• func ListenPacket(network, address string, ciph PacketConnCipher) (net.PacketConn, error)
• type AeadCipher
  • func (aead *AeadCipher) PacketConn(c net.PacketConn) net.PacketConn
  • func (aead *AeadCipher) StreamConn(c net.Conn) net.Conn
• type Cipher
  • func PickCipher(name string, key []byte, password string) (Cipher, error)
• type PacketConnCipher
• type StreamCipher
  • func (ciph *StreamCipher) PacketConn(c net.PacketConn) net.PacketConn
  • func (ciph *StreamCipher) StreamConn(c net.Conn) net.Conn
• type StreamConnCipher

Variables

var ErrCipherNotSupported = errors.New("cipher not supported")

ErrCipherNotSupported occurs when a cipher is not supported (likely because of security concerns).

Functions

func Dial

func Dial(network, address string, ciph StreamConnCipher) (net.Conn, error)

func Kdf

func Kdf(password string, keyLen int) []byte

key-derivation function from original Shadowsocks

func ListCipher

func ListCipher() []string

ListCipher returns a list of available cipher names sorted alphabetically.

func Listen

func Listen(network, address string, ciph StreamConnCipher) (net.Listener, error)

func ListenPacket

func ListenPacket(network, address string, ciph PacketConnCipher) (net.PacketConn, error)

Types

type AeadCipher

type AeadCipher struct {
	shadowaead.Cipher

	Key []byte
}

func (*AeadCipher) PacketConn

func (aead *AeadCipher) PacketConn(c net.PacketConn) net.PacketConn

func (*AeadCipher) StreamConn

func (aead *AeadCipher) StreamConn(c net.Conn) net.Conn

type Cipher

type Cipher interface {
	StreamConnCipher
	PacketConnCipher
}

func PickCipher

func PickCipher(name string, key []byte, password string) (Cipher, error)

PickCipher returns a Cipher of the given name. Derive key from password if given key is empty.

type PacketConnCipher

type PacketConnCipher interface {
	PacketConn(net.PacketConn) net.PacketConn
}

type StreamCipher

type StreamCipher struct {
	shadowstream.Cipher

	Key []byte
}

func (*StreamCipher) PacketConn

func (ciph *StreamCipher) PacketConn(c net.PacketConn) net.PacketConn

func (*StreamCipher) StreamConn

func (ciph *StreamCipher) StreamConn(c net.Conn) net.Conn

type StreamConnCipher

type StreamConnCipher interface {
	StreamConn(net.Conn) net.Conn
}