Merge pull request #642 from getlantern/reflog/vmess-doc

added vmess documentation

http_proxy.go

@@ -1005,7 +1005,7 @@ func (p *Proxy) listenVMess(baseListen func(string) (net.Listener, error)) liste
 		log.Debugf("Listening for vmess at %v", base.Addr())
 		wrapper, err := vmess.NewVMessListener(base, p.VMessUUIDs)
 		if err != nil {
-			base.Close()
+			_ = base.Close()
 			return nil, fmt.Errorf("vmess wrapping error: %w", err)
 		}
 

v2ray/vmess/listener.go

@@ -14,6 +14,12 @@ type listener struct {
 	service *vmess.Service[int]
 }
 
+// NewVMessListener wraps a net.Listener with a VMess service
+// VMess is used only for obfuscation, not for transport, thus the destination is not read from VMess header
+// VMess will accept connections only from users that are identified by UUIDs passed here
+// The UUIDs are generated on route setup and stored in the database, there could be several UUIDs per proxy
+// The UUIDs will be distributed between the users. There is no 1-1 mapping between UUIDs and users and this is just
+// intended as a source of extra entropy
 func NewVMessListener(baseListener net.Listener, uuids []string) (net.Listener, error) {
 	var userNum []int
 	var userAlt []int