vmess

Documentation

Overview

Package vmess contains the implementation of VMess protocol and transportation.

VMess contains both inbound and outbound connections. VMess inbound is usually used on servers together with 'freedom' to talk to final destination, while VMess outbound is usually used on clients with 'socks' for proxying.

Index

• Constants
• Variables
• type Account
  • func (a *Account) AsAccount() (protocol.Account, error)
  • func (*Account) Descriptor() ([]byte, []int)
  • func (x *Account) GetAlterId() uint32
  • func (x *Account) GetId() string
  • func (x *Account) GetSecuritySettings() *protocol.SecurityConfig
  • func (x *Account) GetTestsEnabled() string
  • func (*Account) ProtoMessage()
  • func (x *Account) ProtoReflect() protoreflect.Message
  • func (x *Account) Reset()
  • func (x *Account) String() string
• type MemoryAccount
  • func (a *MemoryAccount) AnyValidID() *protocol.ID
  • func (a *MemoryAccount) Equals(account protocol.Account) bool
• type TimedUserValidator
  • func NewTimedUserValidator(hasher protocol.IDHash) *TimedUserValidator
  • func (v *TimedUserValidator) Add(u *protocol.MemoryUser) error
  • func (v *TimedUserValidator) BurnTaintFuse(userHash []byte) error
  • func (v *TimedUserValidator) Close() error
  • func (v *TimedUserValidator) Get(userHash []byte) (*protocol.MemoryUser, protocol.Timestamp, bool, error)
  • func (v *TimedUserValidator) GetAEAD(userHash []byte) (*protocol.MemoryUser, bool, error)
  • func (v *TimedUserValidator) GetBehaviorSeed() uint64
  • func (v *TimedUserValidator) Remove(email string) bool
  • func (v *TimedUserValidator) ShouldShowLegacyWarn() bool

Constants

const AlterID = "VMessCtxInterface_AlterID"

example

Variables

var ErrNotFound = newError("Not Found")

var ErrTainted = newError("ErrTainted")

var File_proxy_vmess_account_proto protoreflect.FileDescriptor

Types

type Account

type Account struct {

	// ID of the account, in the form of a UUID, e.g.,
	// "66ad4540-b58c-4ad2-9926-ea63445a9b57".
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// Number of alternative IDs. Client and server must share the same number.
	AlterId uint32 `protobuf:"varint,2,opt,name=alter_id,json=alterId,proto3" json:"alter_id,omitempty"`
	// Security settings. Only applies to client side.
	SecuritySettings *protocol.SecurityConfig `protobuf:"bytes,3,opt,name=security_settings,json=securitySettings,proto3" json:"security_settings,omitempty"`
	// Define tests enabled for this account
	TestsEnabled string `protobuf:"bytes,4,opt,name=tests_enabled,json=testsEnabled,proto3" json:"tests_enabled,omitempty"`
	// contains filtered or unexported fields
}

func (*Account) AsAccount

func (a *Account) AsAccount() (protocol.Account, error)

AsAccount implements protocol.Account.

func (*Account) Descriptor

func (*Account) Descriptor() ([]byte, []int)

Deprecated: Use Account.ProtoReflect.Descriptor instead.

func (*Account) GetAlterId

func (x *Account) GetAlterId() uint32

func (*Account) GetId

func (x *Account) GetId() string

func (*Account) GetSecuritySettings

func (x *Account) GetSecuritySettings() *protocol.SecurityConfig

func (*Account) GetTestsEnabled

func (x *Account) GetTestsEnabled() string

func (*Account) ProtoMessage

func (*Account) ProtoMessage()

func (*Account) ProtoReflect

func (x *Account) ProtoReflect() protoreflect.Message

func (*Account) Reset

func (x *Account) Reset()

func (*Account) String

func (x *Account) String() string

type MemoryAccount

type MemoryAccount struct {
	// ID is the main ID of the account.
	ID *protocol.ID
	// AlterIDs are the alternative IDs of the account.
	AlterIDs []*protocol.ID
	// Security type of the account. Used for client connections.
	Security protocol.SecurityType
}

MemoryAccount is an in-memory form of VMess account.

func (*MemoryAccount) AnyValidID

func (a *MemoryAccount) AnyValidID() *protocol.ID

AnyValidID returns an ID that is either the main ID or one of the alternative IDs if any.

func (*MemoryAccount) Equals

func (a *MemoryAccount) Equals(account protocol.Account) bool

Equals implements protocol.Account.

type TimedUserValidator

type TimedUserValidator struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

TimedUserValidator is a user Validator based on time.

func NewTimedUserValidator

func NewTimedUserValidator(hasher protocol.IDHash) *TimedUserValidator

NewTimedUserValidator creates a new TimedUserValidator.

func (*TimedUserValidator) Add

func (v *TimedUserValidator) Add(u *protocol.MemoryUser) error

func (*TimedUserValidator) BurnTaintFuse

func (v *TimedUserValidator) BurnTaintFuse(userHash []byte) error

func (*TimedUserValidator) Close

func (v *TimedUserValidator) Close() error

Close implements common.Closable.

func (*TimedUserValidator) Get

func (v *TimedUserValidator) Get(userHash []byte) (*protocol.MemoryUser, protocol.Timestamp, bool, error)

func (*TimedUserValidator) GetAEAD

func (v *TimedUserValidator) GetAEAD(userHash []byte) (*protocol.MemoryUser, bool, error)

func (*TimedUserValidator) GetBehaviorSeed

func (v *TimedUserValidator) GetBehaviorSeed() uint64

func (*TimedUserValidator) Remove

func (v *TimedUserValidator) Remove(email string) bool

func (*TimedUserValidator) ShouldShowLegacyWarn

func (v *TimedUserValidator) ShouldShowLegacyWarn() bool

ShouldShowLegacyWarn will return whether a Legacy Warning should be shown

Not guaranteed to only return true once for every inbound, but it is okay.