vmess

README

vmess-client

client for vmess protocol (ref :https://github.com/v2ray/v2ray-core).

Low memory size, can be used in embedded devices (eg : IOS)

Documentation

Index

• Constants
• func AEADReader(r io.Reader, aead cipher.AEAD, iv []byte) io.ReadCloser
• func AEADWriter(w io.Writer, aead cipher.AEAD, iv []byte) writer
• func ChunkedReader(r io.Reader) io.ReadCloser
• func ChunkedWriter(w io.Writer) writer
• func CreateAuthID(cmdKey []byte, time int64) [16]byte
• func DecodeResponseHeader(responseBodyKey, responseBodyIV []byte, reader net.Conn) ([]byte, error)
• func GetKey(uuid [16]byte) []byte
• func KDF(key []byte, path ...string) []byte
• func KDF16(key []byte, path ...string) []byte
• func NewCipherFromKey(cmdKey []byte) cipher.Block
• func OpenVMessAEADHeader(key [16]byte, authid [16]byte, data io.Reader) ([]byte, bool, int, error)
• func ParseAddr(s string) (Atyp, Addr, Port, error)
• func SealVMessAEADHeader(key [16]byte, data []byte) []byte
• func StrToUUID(s string) (uuid [16]byte, err error)
• func TimestampHash(t time.Time) []byte
• type Addr
• type Atyp
• type Client
  • func NewClient(uuidStr, security string, alterID int) (*Client, error)
  • func (c *Client) NewConn(rc net.Conn, target string) (net.Conn, error)
  • func (c *Client) NewPacketConn(rc net.Conn, target string) (net.PacketConn, error)
• type Conn
  • func (c *Conn) Close() error
  • func (c *Conn) DecodeRespHeader() error
  • func (c *Conn) EncodeAuthInfo() []byte
  • func (c *Conn) EncodeRequest() ([]byte, error)
  • func (c *Conn) Read(b []byte) (n int, err error)
  • func (c *Conn) Write(b []byte) (n int, err error)
• type Port
• type User
  • func NewUser(uuid [16]byte) *User
  • func (u *User) GenAlterIDUsers(alterID int) []*User

Constants

const (
	OptBasicFormat byte = 0
	OptChunkStream byte = 1
)

Request Options

const (
	SecurityAES128GCM        byte = 3
	SecurityChacha20Poly1305 byte = 4
	SecurityNone             byte = 5
)

Security types

const (
	CmdTCP byte = 1
	CmdUDP byte = 2
)

CMD types

const (
	KDFSaltConstAuthIDEncryptionKey             = "AES Auth ID Encryption"
	KDFSaltConstAEADRespHeaderLenKey            = "AEAD Resp Header Len Key"
	KDFSaltConstAEADRespHeaderLenIV             = "AEAD Resp Header Len IV"
	KDFSaltConstAEADRespHeaderPayloadKey        = "AEAD Resp Header Key"
	KDFSaltConstAEADRespHeaderPayloadIV         = "AEAD Resp Header IV"
	KDFSaltConstVMessAEADKDF                    = "VMess AEAD KDF"
	KDFSaltConstVMessHeaderPayloadAEADKey       = "VMess Header AEAD Key"
	KDFSaltConstVMessHeaderPayloadAEADIV        = "VMess Header AEAD Nonce"
	KDFSaltConstVMessHeaderPayloadLengthAEADKey = "VMess Header AEAD Key_Length"
	KDFSaltConstVMessHeaderPayloadLengthAEADIV  = "VMess Header AEAD Nonce_Length"
)

copy from https://github.com/v2fly/v2ray-core/tree/054e6679830885c94cc37d27ab2aa96b5b37e019/proxy/vmess/aead

Functions

func AEADReader

func AEADReader(r io.Reader, aead cipher.AEAD, iv []byte) io.ReadCloser

AEADReader returns a aead reader

func AEADWriter

func AEADWriter(w io.Writer, aead cipher.AEAD, iv []byte) writer

AEADWriter returns a aead writer

func ChunkedReader

func ChunkedReader(r io.Reader) io.ReadCloser

ChunkedReader returns a chunked reader

func ChunkedWriter

func ChunkedWriter(w io.Writer) writer

ChunkedWriter returns a chunked writer

func CreateAuthID

func CreateAuthID(cmdKey []byte, time int64) [16]byte

func DecodeResponseHeader

func DecodeResponseHeader(responseBodyKey, responseBodyIV []byte, reader net.Conn) ([]byte, error)

from https://github.com/v2ray/v2ray-core/blob/5dffca84234a74da9e8174f1e0b0af3dfb2a58ce/proxy/vmess/encoding/client.go#L191

func GetKey

func GetKey(uuid [16]byte) []byte

GetKey returns the key of AES-128-CFB encrypter Key：MD5(UUID + []byte('c48619fe-8f02-49e0-b9e9-edf763e17e21'))

func KDF

func KDF(key []byte, path ...string) []byte

func KDF16

func KDF16(key []byte, path ...string) []byte

func NewCipherFromKey

func NewCipherFromKey(cmdKey []byte) cipher.Block

func OpenVMessAEADHeader

func OpenVMessAEADHeader(key [16]byte, authid [16]byte, data io.Reader) ([]byte, bool, int, error)

func ParseAddr

func ParseAddr(s string) (Atyp, Addr, Port, error)

ParseAddr parses the address in string s

func SealVMessAEADHeader

func SealVMessAEADHeader(key [16]byte, data []byte) []byte

func StrToUUID

func StrToUUID(s string) (uuid [16]byte, err error)

StrToUUID converts string to uuid. s fomat: "6ba7b810-9dad-11d1-80b4-00c04fd430c8"

func TimestampHash

func TimestampHash(t time.Time) []byte

TimestampHash returns the iv of AES-128-CFB encrypter IV：MD5(X + X + X + X)，X = []byte(timestamp.now) (8 bytes, Big Endian)

Types

type Addr

type Addr []byte

Addr is vmess addr

type Atyp

type Atyp byte

Atyp is vmess addr type

const (
	AtypErr    Atyp = 0
	AtypIP4    Atyp = 1
	AtypDomain Atyp = 2
	AtypIP6    Atyp = 3
)

Atyp

type Client

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

Client vmess client

func NewClient

func NewClient(uuidStr, security string, alterID int) (*Client, error)

NewClient .

func (*Client) NewConn

func (c *Client) NewConn(rc net.Conn, target string) (net.Conn, error)

func (*Client) NewPacketConn

func (c *Client) NewPacketConn(rc net.Conn, target string) (net.PacketConn, error)

type Conn

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

Conn is a connection to vmess server

func (*Conn) Close

func (c *Conn) Close() error

func (*Conn) DecodeRespHeader

func (c *Conn) DecodeRespHeader() error

DecodeRespHeader .

func (*Conn) EncodeAuthInfo

func (c *Conn) EncodeAuthInfo() []byte

EncodeAuthInfo returns HMAC("md5", UUID, UTC) result

func (*Conn) EncodeRequest

func (c *Conn) EncodeRequest() ([]byte, error)

EncodeRequest encodes requests to network bytes

func (*Conn) Read

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

func (*Conn) Write

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

type Port

type Port uint16

Port is vmess addr port

type User

type User struct {
	UUID   [16]byte
	CmdKey [16]byte
}

User of vmess client

func NewUser

func NewUser(uuid [16]byte) *User

NewUser .

func (*User) GenAlterIDUsers

func (u *User) GenAlterIDUsers(alterID int) []*User

GenAlterIDUsers generates users according to primary user's id and alterID