Browse Source

docs: details of VMess

master
Dnomd343 3 years ago
parent
commit
11d4233da2
  1. 370
      docs/ProxyObject.md

370
docs/ProxyObject.md

@ -10,23 +10,17 @@
**type** **type**
+ 类型:*str* + 类型:*str*
+ 说明:节点类型 + 说明:节点类型
+ 缺省:必选 + 缺省:必选
+ 可选值:`ss`,`ssr`,`vmess`
+ 可选值:`ss`,`ssr`
## Shadowsocks ## Shadowsocks
> **remark** > **remark**
> >
> + 类型:*str* > + 类型:*str*
>
> + 说明:节点备注名称 > + 说明:节点备注名称
>
> + 缺省:'' > + 缺省:''
>
> + 可选值:不限 > + 可选值:不限
``` ```
@ -43,53 +37,37 @@
**server** **server**
+ 类型:*str* + 类型:*str*
+ 说明:服务器地址 + 说明:服务器地址
+ 缺省:必选 + 缺省:必选
+ 可选值:合法的IP地址或域名 + 可选值:合法的IP地址或域名
**port** **port**
+ 类型:*int* + 类型:*int*
+ 说明:服务器端口 + 说明:服务器端口
+ 缺省:必选 + 缺省:必选
+ 可选值:1 ~ 65535 + 可选值:1 ~ 65535
**method** **method**
+ 类型:*str* + 类型:*str*
+ 说明:Shadowsocks加密方式 + 说明:Shadowsocks加密方式
+ 缺省:必选 + 缺省:必选
+ 可选值:`aes-128-gcm`,`aes-192-gcm`,`aes-256-gcm`,`aes-128-ctr`,`aes-192-ctr`,`aes-256-ctr`,`aes-128-ocb`,`aes-192-ocb`,`aes-256-ocb`,`aes-128-ofb`,`aes-192-ofb`,`aes-256-ofb`,`aes-128-cfb`,`aes-192-cfb`,`aes-256-cfb`,`aes-128-cfb1`,`aes-192-cfb1`,`aes-256-cfb1`,`aes-128-cfb8`,`aes-192-cfb8`,`aes-256-cfb8`,`aes-128-cfb128`,`aes-192-cfb128`,`aes-256-cfb128`,`camellia-128-cfb`,`camellia-192-cfb`,`camellia-256-cfb`,`camellia-128-cfb128`,`camellia-192-cfb128`,`camellia-256-cfb128`,`plain`,`none`,`table`,`rc4`,`rc4-md5`,`rc2-cfb`,`bf-cfb`,`cast5-cfb`,`des-cfb`,`idea-cfb`,`seed-cfb`,`salsa20`,`salsa20-ctr`,`xchacha20`,`chacha20`,`chacha20-ietf`,`chacha20-poly1305`,`chacha20-ietf-poly1305`,`xchacha20-ietf-poly1305` + 可选值:`aes-128-gcm`,`aes-192-gcm`,`aes-256-gcm`,`aes-128-ctr`,`aes-192-ctr`,`aes-256-ctr`,`aes-128-ocb`,`aes-192-ocb`,`aes-256-ocb`,`aes-128-ofb`,`aes-192-ofb`,`aes-256-ofb`,`aes-128-cfb`,`aes-192-cfb`,`aes-256-cfb`,`aes-128-cfb1`,`aes-192-cfb1`,`aes-256-cfb1`,`aes-128-cfb8`,`aes-192-cfb8`,`aes-256-cfb8`,`aes-128-cfb128`,`aes-192-cfb128`,`aes-256-cfb128`,`camellia-128-cfb`,`camellia-192-cfb`,`camellia-256-cfb`,`camellia-128-cfb128`,`camellia-192-cfb128`,`camellia-256-cfb128`,`plain`,`none`,`table`,`rc4`,`rc4-md5`,`rc2-cfb`,`bf-cfb`,`cast5-cfb`,`des-cfb`,`idea-cfb`,`seed-cfb`,`salsa20`,`salsa20-ctr`,`xchacha20`,`chacha20`,`chacha20-ietf`,`chacha20-poly1305`,`chacha20-ietf-poly1305`,`xchacha20-ietf-poly1305`
+ 建议值:`aes-256-gcm`,`aes-128-gcm`,`chacha20-ietf-poly1305` + 建议值:`aes-256-gcm`,`aes-128-gcm`,`chacha20-ietf-poly1305`
**passwd** **passwd**
+ 类型:*str* + 类型:*str*
+ 说明:Shadowsocks连接密码 + 说明:Shadowsocks连接密码
+ 缺省:必选 + 缺省:必选
+ 可选值:不限 + 可选值:不限
**plugin** **plugin**
+ 类型:*None* / *pluginObject* + 类型:*None* / *pluginObject*
+ 说明:SIP003插件 + 说明:SIP003插件
+ 缺省:None + 缺省:None
+ 可选值:不限 + 可选值:不限
### pluginObject ### pluginObject
@ -104,21 +82,15 @@
**type** **type**
+ 类型:*str* + 类型:*str*
+ 说明:SIP003插件名称 + 说明:SIP003插件名称
+ 缺省:必选 + 缺省:必选
+ 可选值:`obfs-local`,`simple-tls`,`v2ray-plugin`,`xray-plugin`,`kcptun-client`,`gost-plugin`,`ck-client`,`gq-client`,`mtt-client`,`rabbit-plugin`,`qtun-client`,`gun-plugin` + 可选值:`obfs-local`,`simple-tls`,`v2ray-plugin`,`xray-plugin`,`kcptun-client`,`gost-plugin`,`ck-client`,`gq-client`,`mtt-client`,`rabbit-plugin`,`qtun-client`,`gun-plugin`
**param** **param**
+ 类型:*str* + 类型:*str*
+ 说明:SIP003插件参数 + 说明:SIP003插件参数
+ 缺省:'' + 缺省:''
+ 可选值:不限 + 可选值:不限
## ShadowsocksR ## ShadowsocksR
@ -126,22 +98,15 @@
> **remark** > **remark**
> >
> + 类型:*str* > + 类型:*str*
>
> + 说明:节点备注名称 > + 说明:节点备注名称
>
> + 缺省:'' > + 缺省:''
>
> + 可选值:不限 > + 可选值:不限
>
> **group** > **group**
> >
> + 类型:*str* > + 类型:*str*
>
> + 说明:节点所属群组 > + 说明:节点所属群组
>
> + 缺省:'' > + 缺省:''
>
> + 可选值:不限 > + 可选值:不限
``` ```
@ -161,79 +126,370 @@
**server** **server**
+ 类型:*str* + 类型:*str*
+ 说明:服务器地址 + 说明:服务器地址
+ 缺省:必选 + 缺省:必选
+ 可选值:合法的IP地址或域名 + 可选值:合法的IP地址或域名
**port** **port**
+ 类型:*int* + 类型:*int*
+ 说明:服务器端口 + 说明:服务器端口
+ 缺省:必选 + 缺省:必选
+ 可选值:1 ~ 65535 + 可选值:1 ~ 65535
**method** **method**
+ 类型:*str* + 类型:*str*
+ 说明:ShadowsocksR加密方式 + 说明:ShadowsocksR加密方式
+ 缺省:必选 + 缺省:必选
+ 可选值:`aes-128-cfb`,`aes-192-cfb`,`aes-256-cfb`,`aes-128-cfb1`,`aes-192-cfb1`,`aes-256-cfb1`,`aes-128-cfb8`,`aes-192-cfb8`,`aes-256-cfb8`,`aes-128-ctr`,`aes-192-ctr`,`aes-256-ctr`,`aes-128-gcm`,`aes-192-gcm`,`aes-256-gcm`,`aes-128-ofb`,`aes-192-ofb`,`aes-256-ofb`,`camellia-128-cfb`,`camellia-192-cfb`,`camellia-256-cfb`,`none`,`table`,`rc4`,`rc4-md5`,`rc4-md5-6`,`bf-cfb`,`cast5-cfb`,`des-cfb`,`idea-cfb`,`seed-cfb`,`rc2-cfb`,`salsa20`,`xsalsa20`,`chacha20`,`xchacha20`,`chacha20-ietf` + 可选值:`aes-128-cfb`,`aes-192-cfb`,`aes-256-cfb`,`aes-128-cfb1`,`aes-192-cfb1`,`aes-256-cfb1`,`aes-128-cfb8`,`aes-192-cfb8`,`aes-256-cfb8`,`aes-128-ctr`,`aes-192-ctr`,`aes-256-ctr`,`aes-128-gcm`,`aes-192-gcm`,`aes-256-gcm`,`aes-128-ofb`,`aes-192-ofb`,`aes-256-ofb`,`camellia-128-cfb`,`camellia-192-cfb`,`camellia-256-cfb`,`none`,`table`,`rc4`,`rc4-md5`,`rc4-md5-6`,`bf-cfb`,`cast5-cfb`,`des-cfb`,`idea-cfb`,`seed-cfb`,`rc2-cfb`,`salsa20`,`xsalsa20`,`chacha20`,`xchacha20`,`chacha20-ietf`
**passwd** **passwd**
+ 类型:*str* + 类型:*str*
+ 说明:ShadowsocksR连接密码 + 说明:ShadowsocksR连接密码
+ 缺省:必选 + 缺省:必选
+ 可选值:不限 + 可选值:不限
**protocol** **protocol**
+ 类型:*str* + 类型:*str*
+ 说明:ShadowsocksR连接协议 + 说明:ShadowsocksR连接协议
+ 缺省:'origin' + 缺省:'origin'
+ 可选值:`origin`,`verify_sha1`,`verify_simple`,`verify_deflate`,`auth_simple`,`auth_sha1`,`auth_sha1_v2`,`auth_sha1_v4`,`auth_aes128`,`auth_aes128_md5`,`auth_aes128_sha1`,`auth_chain_a`,`auth_chain_b`,`auth_chain_c`,`auth_chain_d`,`auth_chain_e`,`auth_chain_f` + 可选值:`origin`,`verify_sha1`,`verify_simple`,`verify_deflate`,`auth_simple`,`auth_sha1`,`auth_sha1_v2`,`auth_sha1_v4`,`auth_aes128`,`auth_aes128_md5`,`auth_aes128_sha1`,`auth_chain_a`,`auth_chain_b`,`auth_chain_c`,`auth_chain_d`,`auth_chain_e`,`auth_chain_f`
**protocolParam** **protocolParam**
+ 类型:*str* + 类型:*str*
+ 说明:ShadowsocksR协议参数 + 说明:ShadowsocksR协议参数
+ 缺省:''
+ 可选值:不限
**obfs**
+ 类型:*str*
+ 说明:ShadowsocksR混淆方式
+ 缺省:'plain'
+ 可选值:`plain`,`http_post`,`http_simple`,`tls_simple`,`tls1.2_ticket_auth`,`tls1.2_ticket_fastauth`,`random_head`
**obfsParam**
+ 类型:*str*
+ 说明:ShadowsocksR混淆参数
+ 缺省:'' + 缺省:''
+ 可选值:不限
## VMess
```
{
'type': 'vmess',
'server': ...,
'port': ...,
'method': ...,
'id': ...,
'aid' ...,
'stream': ..
}
```
**server**
+ 类型:*str*
+ 说明:服务器地址
+ 缺省:必选
+ 可选值:合法的IP地址或域名
**port**
+ 类型:*int*
+ 说明:服务器端口
+ 缺省:必选
+ 可选值:1 ~ 65535
**method**
+ 类型:*str*
+ 说明:VMess加密方式
+ 缺省:'auto'
+ 可选值:`aes-128-gcm`,`chacha20-poly1305`,`auto`,`none`,`zero`
+ 建议值:'auto'
**id**
+ 类型:*str*
+ 说明:VMess认证ID
+ 缺省:必选
+ 可选值:合法的UUID
**aid**
+ 类型:*int*
+ 说明:VMess额外ID
+ 缺省:0
+ 可选值:0 ~ 65535
+ 建议值:0
**stream**
+ 类型:*tcpObject* / *kcpObject* / *wsObject* / *h2Object* / *quicObject* / *grpcObject*
+ 说明:VMess底层传输方式
+ 缺省:tcpObject
+ 可选值:不限
### tcpObject
```
{
'type': 'tcp',
'obfs': ...,
'secure': ...
}
```
**obfs**
+ 类型:*None* / *obfsObject*
+ 说明:http伪装
+ 缺省:None
+ 可选值:不限
**secure**
+ 类型:*None* / *secureObject*
+ 说明:TLS加密
+ 缺省:None
+ 可选值:不限
### kcpObject
```
{
'type': 'kcp',
'seed': ...,
'obfs': ...,
'secure': ...
}
```
**seed**
+ 类型:*None* / *str*
+ 说明:mKCP混淆密码
+ 缺省:None
+ 可选值:不限 + 可选值:不限
**obfs** **obfs**
+ 类型:*str* + 类型:*str*
+ 说明:数据包头部伪装类型
+ 缺省:'none'
+ 可选值:`none`,`srtp`,`utp`,`wechat-video`,`dtls`,`wireguard`
+ 说明:ShadowsocksR混淆方式 **secure**
+ 缺省:'plain' + 类型:*None* / *secureObject*
+ 说明:TLS加密
+ 缺省:None
+ 可选值:不限
+ 可选值:`plain`,`http_post`,`http_simple`,`tls_simple`,`tls1.2_ticket_auth`,`tls1.2_ticket_fastauth`,`random_head` ### wsObject
**obfsParam** ```
{
'type': 'ws',
'host': ...,
'path': ...,
'ed': ...,
'secure': ...
}
```
**host**
+ 类型:*str* + 类型:*str*
+ 说明:Websocket连接域名
+ 缺省:''
+ 可选值:不限
+ 建议值:合法域名
+ 说明:ShadowsocksR混淆参数 **path**
+ 类型:*str*
+ 说明:Websocket连接路径
+ 缺省:'/'
+ 可选值:不限
+ 建议值:以`/`开头的合法路径
**ed**
+ 类型:*int*
+ 说明:`Early Data`长度阈值
+ 缺省:2048
+ 可选值:>0
+ 建议值:2048
**secure**
+ 类型:*None* / *secureObject*
+ 说明:TLS加密
+ 缺省:None
+ 可选值:不限
### h2Object
```
{
'type': 'h2',
'host': ...,
'path': ...,
'secure': ...
}
```
**host**
+ 类型:*str*
+ 说明:HTTP/2通讯域名
+ 缺省:'' + 缺省:''
+ 可选值:不限
+ 建议值:合法域名列表(逗号隔开)
**path**
+ 类型:*str*
+ 说明:HTTP/2通讯路径
+ 缺省:'/'
+ 可选值:不限 + 可选值:不限
+ 建议值:以`/`开头的合法路径
**secure**
+ 类型:*None* / *secureObject*
+ 说明:TLS加密
+ 缺省:None
+ 可选值:不限
### quicObject
```
{
'type': 'quic',
'method': ...,
'passwd': ...,
'obfs': ...,
'secure': ...
}
```
**method**
+ 类型:*str*
+ 说明:QUIC加密方式
+ 缺省:'none'
+ 可选值:`none`,`aes-128-gcm`,`chacha20-poly1305`
**passwd**
+ 类型:*str*
+ 说明:QUIC连接密码
+ 缺省:''
+ 可选值:不限
**obfs**
+ 类型:*str*
+ 说明:数据包头部伪装类型
+ 缺省:'none'
+ 可选值:`none`,`srtp`,`utp`,`wechat-video`,`dtls`,`wireguard`
**secure**
+ 类型:*secureObject*
+ 说明:TLS加密
+ 缺省:secureObject
+ 可选值:不限
### grpcObject
```
{
'type': 'grpc',
'service': ...,
'secure': ...
}
```
**service**
+ 类型:*str*
+ 说明:gRPC服务名称
+ 缺省:必选
+ 可选值:不限
+ 建议值:英文大小写字母、数字、下划线及英文句号组成
**secure**
+ 类型:*None* / *secureObject*
+ 说明:TLS加密
+ 缺省:None
+ 可选值:不限
### obfsObject
```
{
'host': ...,
'path': ...
}
```
**host**
+ 类型:*str*
+ 说明:http伪装域名
+ 缺省:''
+ 可选值:不限
+ 建议值:合法域名列表(逗号隔开)
**path**
+ 类型:*str*
+ 说明:http伪装路径
+ 缺省:'/'
+ 可选值:不限
+ 建议值:以`/`开头的合法路径
### secureObject
```
{
'sni': ...,
'alpn': ...,
'verify': ...
}
```
**sni**
+ 类型:*str*
+ 说明:TLS握手SNI字段
+ 缺省:obfsObject.host[0] / wsObject.host / h2Object.host[0] / ''
+ 可选值:不限
+ 建议值:合法域名
**alpn**
+ 类型:*str*
+ 说明:TLS握手协商协议
+ 缺省:'h2,http/1.1'
+ 可选值:'h2', 'http/1.1', 'h2,http/1.1'
+ 建议值:'h2,http/1.1'
**verify**
+ 类型:*bool*
+ 说明:是否验证服务端证书
+ 缺省:True
+ 可选值:True / False
+ 建议值:True

Loading…
Cancel
Save