Proposal: VMess Share Link Standard

[AkinoKaede]

Thanks to the original designer @DuckSoft

You can comment in this discussion if you have any suggestion. If you have any problem with this propsal, please contant me by email [email protected].

Overview

vmess://
	$(uuid)
	@
	remote-host
	:
	remote-port
?
	<protocol-specific fields>
	<transport-specific fields>
	<security-specific fields>
#$(descriptive-text)

$() means encodeURIComponent()

omit means null or empty.

Details

Basic Fields

uuid: $(string)

VMess user's UUID.

Not null, not empty.

remote-host: string

Remote server's host. Compatible with Punycode.

Not null, not empty.

remote-port: range(1, 65536)

Remote server's port. The min value is 1, and the max value is 65535. Not null.

descriptive-text: $(string)

Description for remote server.

Protocol-specific Fields

encryption: auto | aes-128-gcm | chacha20-poly1305 | none | zero

VMess's security type. Default value is auto.

Transport-specific Fields

type: tcp | ws | kcp | http | quic | grpc | meek

Transport type.

HTTP/2

type must be http.

path: $(string)

The path for HTTP/2. Default value is /. It is not recommended to omit.

host : $(string)

The Host filed in HTTP requests. Default value is same as remote-host.

WebSocket

type must be ws.

path: $(string)

The path for WebSocket. Default value is /. It is not recommended to omit.

host : $(string)

The Host filed in requests. It is not recommended to omit.

mKCP (KCP)

type must be kcp.

headerType: none | srtp | wechat-video | dtls | wireguard

mKCP's imitated header. Default value is none. Not empty.

seed: $(string)

mKCP encryption seed. Not empty.

QUIC

type must be quic.

headerType: none | srtp | wechat-video | dtls | wireguard

QUIC's imitated header. Default value is none. Not empty.

quicSecurity: none | aes-128-gcm | chacha20-poly1305

QUIC's encryption mothod. Default value is none.

key: $(string)

Key for QUIC's encryption.

When quicSecurity is none, it must be null.

When quicSecurity is not none, it must be not empty.

gRPC

type must be grpc.

serviceName: string.

ServiceName for gRPC. Null is not recommended，not empty.

Meek

type must be meek.

url: $(string)

Request url for Meek, It must be a legal URL. For exmaple, https%3A%2F%2Fmeek.v2fly.org%2Fmeek is legal. Not null, not empty.

mekya

type must be mekya.

url: $(string)

Request url for mekya, It must be a legal URL. For exmaple, https%3A%2F%2Fmeek.v2fly.org%2Fmekya is legal. Not null, not empty.

mekya use mKCP to reassemble data, so parameters for mKCP can also be set.

Security-specific Fields

security: none | tls

Security tranport type. Default value is none

TLS

security must be tls

sni: string

TLS's SNI, Ponycode is supported. Default value is same as remote-host. Not empty.

alpn: $(strings.Join([]string, ","))

TLS ALPN. For example, h2%2Chttp%2F1.1 is legal. Not empty.

Backward Compatibility

As the software develops, the range of possible values for the enumerated fields such as encryption, type and security, will be added and the fields will be added.

[nursery01]

那麽你是準備把link功能寫入core裡面，然後可以直接讀取呢？還是新建個程式名字叫做v2ray-link之類的，然後功能是可以在link和json之間做轉換

[AkinoKaede]

The current rationale is that I'm pushing features developed by V2Fly in other software, but none of the downstream developers have ever responded to these features, so I think there should be a standard.