shadowsocks

Documentation

Index

• Constants
• Variables
• func BytesSizeForMetadata(firstTwoByte []byte) (int, error)
• func CalcPaddingLen(masterKey []byte, bodyWithoutAddr []byte, req bool) (length int)
• func DecryptUDP(key Key, shadowBytes []byte) (plainText []byte, err error)
• func EVPBytesToKey(password string, keyLen int) (key []byte)
• func EncryptUDPFromPool(key Key, b []byte) (shadowBytes []byte, err error)
• func EncryptedPayloadLen(plainTextLen int, tagLen int) int
• func MD5Sum(d []byte) []byte
• func NewGcm(key []byte) (cipher.AEAD, error)
• type CipherConf
  • func (conf *CipherConf) Verify(buf []byte, masterKey []byte, salt []byte, cipherText []byte, subKey *[]byte) ([]byte, bool)
• type Key
• type Metadata
  • func NewMetadata(bytesMetadata []byte) (*Metadata, error)
  • func (meta *Metadata) Bytes() (b []byte)
  • func (meta *Metadata) BytesFromPool() (b []byte)
• type MetadataType
• type TCPConn
  • func NewTCPConn(conn net.Conn, conf CipherConf, masterKey []byte, ...) (crw *TCPConn, err error)
  • func (c *TCPConn) Close() error
  • func (c *TCPConn) GetTurn(addr Metadata, reqBody []byte) (resp []byte, err error)
  • func (c *TCPConn) Read(b []byte) (n int, err error)
  • func (c *TCPConn) ReadMetadata() (metadata *Metadata, err error)
  • func (c *TCPConn) Write(b []byte) (n int, err error)
• type UDPConn
  • func NewUDPConn(conn *net.UDPConn) *UDPConn
• type UDPConnMapping
  • func NewUDPConnMapping() *UDPConnMapping
  • func (m *UDPConnMapping) Get(key string) (conn *UDPConn, ok bool)
  • func (m *UDPConnMapping) Insert(key string, val *net.UDPConn) *UDPConn
  • func (m *UDPConnMapping) Remove(key string)

Constants

const (
	MaxNonceSize = 12
	ATypeIPv4    = 1
	ATypeDomain  = 3
	ATypeIpv6    = 4
)

const (
	TCPChunkMaxLen = (1 << (16 - 2)) - 1
)

Variables

var (
	CiphersConf = map[string]CipherConf{
		"chacha20-ietf-poly1305": {KeyLen: 32, SaltLen: 32, NonceLen: 12, TagLen: 16, NewCipher: chacha20poly1305.New},
		"chacha20-poly1305":      {KeyLen: 32, SaltLen: 32, NonceLen: 12, TagLen: 16, NewCipher: chacha20poly1305.New},
		"aes-256-gcm":            {KeyLen: 32, SaltLen: 32, NonceLen: 12, TagLen: 16, NewCipher: NewGcm},
		"aes-128-gcm":            {KeyLen: 16, SaltLen: 16, NonceLen: 12, TagLen: 16, NewCipher: NewGcm},
	}
	ZeroNonce  [MaxNonceSize]byte
	ReusedInfo = []byte("ss-subkey")
)

var (
	ErrFailInitCihper = fmt.Errorf("fail to initiate cipher")
)

var (
	ErrInvalidMetadata = errors.Errorf("invalid metadata")
)

Functions

func BytesSizeForMetadata

func BytesSizeForMetadata(firstTwoByte []byte) (int, error)

func CalcPaddingLen

func CalcPaddingLen(masterKey []byte, bodyWithoutAddr []byte, req bool) (length int)

func DecryptUDP

func DecryptUDP(key Key, shadowBytes []byte) (plainText []byte, err error)

DecryptUDP will decrypt the data in place

func EVPBytesToKey

func EVPBytesToKey(password string, keyLen int) (key []byte)

func EncryptUDPFromPool

func EncryptUDPFromPool(key Key, b []byte) (shadowBytes []byte, err error)

EncryptUDPFromPool returns shadowBytes from pool. the shadowBytes MUST be put back.

func EncryptedPayloadLen

func EncryptedPayloadLen(plainTextLen int, tagLen int) int

func MD5Sum

func MD5Sum(d []byte) []byte

func NewGcm

func NewGcm(key []byte) (cipher.AEAD, error)

Types

type CipherConf

type CipherConf struct {
	KeyLen    int
	SaltLen   int
	NonceLen  int
	TagLen    int
	NewCipher func(key []byte) (cipher.AEAD, error)
}

func (*CipherConf) Verify

func (conf *CipherConf) Verify(buf []byte, masterKey []byte, salt []byte, cipherText []byte, subKey *[]byte) ([]byte, bool)

type Key

type Key struct {
	CipherConf CipherConf
	MasterKey  []byte
}

type Metadata

type Metadata struct {
	Type       MetadataType
	Hostname   string
	Port       uint16
	Cmd        protocol.MetadataCmd
	LenMsgBody uint32
}

func NewMetadata

func NewMetadata(bytesMetadata []byte) (*Metadata, error)

func (*Metadata) Bytes

func (meta *Metadata) Bytes() (b []byte)

func (*Metadata) BytesFromPool

func (meta *Metadata) BytesFromPool() (b []byte)

type MetadataType

type MetadataType int

const (
	MetadataTypeReserved0 MetadataType = iota
	MetadataTypeIPv4
	MetadataTypeReserved2
	MetadataTypeDomain
	MetadataTypeIPv6
	// MetadataTypeMsg indicates it's a message from SweetLisa.
	// [MetadataType(1)][MetadataCmd(1)]
	MetadataTypeMsg
)

type TCPConn

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

func NewTCPConn

func NewTCPConn(conn net.Conn, conf CipherConf, masterKey []byte, bloom *disk_bloom.FilterGroup) (crw *TCPConn, err error)

func (*TCPConn) Close

func (c *TCPConn) Close() error

func (*TCPConn) GetTurn

func (c *TCPConn) GetTurn(addr Metadata, reqBody []byte) (resp []byte, err error)

GetTurn executes one msg request and get one response like HTTP

func (*TCPConn) Read

func (c *TCPConn) Read(b []byte) (n int, err error)

func (*TCPConn) ReadMetadata

func (c *TCPConn) ReadMetadata() (metadata *Metadata, err error)

func (*TCPConn) Write

func (c *TCPConn) Write(b []byte) (n int, err error)

type UDPConn

type UDPConn struct {
	Establishing chan struct{}
	Timeout      time.Duration
	*net.UDPConn
}

func NewUDPConn

func NewUDPConn(conn *net.UDPConn) *UDPConn

type UDPConnMapping

type UDPConnMapping struct {
	sync.Mutex
	// contains filtered or unexported fields
}

func NewUDPConnMapping

func NewUDPConnMapping() *UDPConnMapping

func (*UDPConnMapping) Get

func (m *UDPConnMapping) Get(key string) (conn *UDPConn, ok bool)

func (*UDPConnMapping) Insert

func (m *UDPConnMapping) Insert(key string, val *net.UDPConn) *UDPConn

pass val=nil for stating it is establishing

func (*UDPConnMapping) Remove

func (m *UDPConnMapping) Remove(key string)