* add Russian lang support --------- Co-authored-by: 风扇滑翔翼 <Fangliding.fshxy@outlook.com>pull/532/head
@ -1,2 +1,3 @@
|
||||
export * from './en.js' |
||||
export * from './zh.js' |
||||
export * from './ru.js' |
@ -0,0 +1,9 @@
|
||||
import { NavbarConfig } from '@vuepress/theme-default' |
||||
|
||||
export const navbarRu: NavbarConfig = [ |
||||
{ text: 'Главная', link: '/ru' }, |
||||
{ text: 'История сайта', link: '/ru/about/news.md' }, |
||||
{ text: 'Справочник по конфигурации', link: '/ru/config/' }, |
||||
{ text: 'Руководство разработчика', link: '/ru/development/' }, |
||||
{ text: 'Быстрый старт', link: '/ru/document/' }, |
||||
] |
@ -1,2 +1,3 @@
|
||||
export * from './en.js' |
||||
export * from './zh.js' |
||||
export * from './ru.js' |
||||
|
@ -0,0 +1,149 @@
|
||||
import type { SidebarConfig } from '@vuepress/theme-default' |
||||
|
||||
export const sidebarRu: SidebarConfig = { |
||||
'/ru/config/': [ |
||||
{ |
||||
text: 'Описание функций', |
||||
children: [ |
||||
'/ru/config/features/xtls.md', |
||||
'/ru/config/features/fallback.md', |
||||
'/ru/config/features/browser_dialer.md', |
||||
'/ru/config/features/env.md', |
||||
'/ru/config/features/multiple.md', |
||||
], |
||||
}, |
||||
{ |
||||
text: 'Базовая конфигурация', |
||||
children: [ |
||||
'/ru/config/README.md', |
||||
'/ru/config/log.md', |
||||
'/ru/config/api.md', |
||||
'/ru/config/dns.md', |
||||
'/ru/config/fakedns.md', |
||||
'/ru/config/inbound.md', |
||||
'/ru/config/outbound.md', |
||||
'/ru/config/policy.md', |
||||
'/ru/config/reverse.md', |
||||
'/ru/config/routing.md', |
||||
'/ru/config/stats.md', |
||||
'/ru/config/transport.md', |
||||
'/ru/config/metrics.md', |
||||
'/ru/config/observatory.md', |
||||
], |
||||
}, |
||||
{ |
||||
text: 'Входящий прокси', |
||||
children: [ |
||||
'/ru/config/inbounds/dokodemo.md', |
||||
'/ru/config/inbounds/http.md', |
||||
'/ru/config/inbounds/shadowsocks.md', |
||||
'/ru/config/inbounds/socks.md', |
||||
'/ru/config/inbounds/trojan.md', |
||||
'/ru/config/inbounds/vless.md', |
||||
'/ru/config/inbounds/vmess.md', |
||||
], |
||||
}, |
||||
{ |
||||
text: 'Исходящий прокси', |
||||
children: [ |
||||
'/ru/config/outbounds/blackhole.md', |
||||
'/ru/config/outbounds/dns.md', |
||||
'/ru/config/outbounds/freedom.md', |
||||
'/ru/config/outbounds/http.md', |
||||
'/ru/config/outbounds/loopback.md', |
||||
'/ru/config/outbounds/shadowsocks.md', |
||||
'/ru/config/outbounds/socks.md', |
||||
'/ru/config/outbounds/trojan.md', |
||||
'/ru/config/outbounds/vless.md', |
||||
'/ru/config/outbounds/vmess.md', |
||||
'/ru/config/outbounds/wireguard.md', |
||||
], |
||||
}, |
||||
{ |
||||
text: 'Транспортный уровень', |
||||
children: [ |
||||
'/ru/config/transports/domainsocket.md', |
||||
'/ru/config/transports/grpc.md', |
||||
'/ru/config/transports/h2.md', |
||||
'/ru/config/transports/mkcp.md', |
||||
'/ru/config/transports/quic.md', |
||||
'/ru/config/transports/tcp.md', |
||||
'/ru/config/transports/websocket.md', |
||||
'/ru/config/transports/httpupgrade.md', |
||||
'/ru/config/transports/splithttp.md' |
||||
], |
||||
}, |
||||
], |
||||
'/ru/document/': [ |
||||
{ |
||||
text: 'Быстрый старт', |
||||
children: [ |
||||
'/ru/document/README.md', |
||||
'/ru/document/install.md', |
||||
'/ru/document/config.md', |
||||
'/ru/document/command.md', |
||||
'/ru/document/document.md', |
||||
], |
||||
}, |
||||
{ |
||||
text: 'Простыми словами', |
||||
children: [ |
||||
'/ru/document/level-0/README.md', |
||||
'/ru/document/level-0/ch01-preface.md', |
||||
'/ru/document/level-0/ch02-preparation.md', |
||||
'/ru/document/level-0/ch03-ssh.md', |
||||
'/ru/document/level-0/ch04-security.md', |
||||
'/ru/document/level-0/ch05-webpage.md', |
||||
'/ru/document/level-0/ch06-certificates.md', |
||||
'/ru/document/level-0/ch07-xray-server.md', |
||||
'/ru/document/level-0/ch08-xray-clients.md', |
||||
'/ru/document/level-0/ch09-appendix.md', |
||||
], |
||||
}, |
||||
{ |
||||
text: 'Базовые навыки', |
||||
children: [ |
||||
'/ru/document/level-1/README.md', |
||||
'/ru/document/level-1/fallbacks-lv1.md', |
||||
'/ru/document/level-1/routing-lv1-part1.md', |
||||
'/ru/document/level-1/routing-lv1-part2.md', |
||||
'/ru/document/level-1/work.md', |
||||
'/ru/document/level-1/fallbacks-with-sni.md', |
||||
], |
||||
}, |
||||
{ |
||||
text: 'Продвинутые навыки', |
||||
children: [ |
||||
'/ru/document/level-2/README.md', |
||||
'/ru/document/level-2/transparent_proxy/transparent_proxy.md', |
||||
'/ru/document/level-2/tproxy.md', |
||||
'/ru/document/level-2/tproxy_ipv4_and_ipv6.md', |
||||
'/ru/document/level-2/nginx_or_haproxy_tls_tunnel.md', |
||||
'/ru/document/level-2/iptables_gid.md', |
||||
'/ru/document/level-2/redirect.md', |
||||
'/ru/document/level-2/warp.md', |
||||
'/ru/document/level-2/traffic_stats.md', |
||||
], |
||||
} |
||||
], |
||||
'/ru/development/': [ |
||||
{ |
||||
text: 'Руководство разработчика', |
||||
children: [ |
||||
'/ru/development/README.md', |
||||
'/ru/development/intro/compile.md', |
||||
'/ru/development/intro/design.md', |
||||
'/ru/development/intro/guide.md', |
||||
], |
||||
}, |
||||
{ |
||||
text: 'Описание протоколов', |
||||
children: [ |
||||
'/ru/development/protocols/vless.md', |
||||
'/ru/development/protocols/vmess.md', |
||||
'/ru/development/protocols/muxcool.md', |
||||
'/ru/development/protocols/mkcp.md', |
||||
], |
||||
}, |
||||
], |
||||
} |
@ -0,0 +1,240 @@
|
||||
--- |
||||
sidebar: auto |
||||
--- |
||||
|
||||
# 大史记 |
||||
|
||||
## 2021.4.6 |
||||
|
||||
- VuePress Next. |
||||
- With Dark Mode. |
||||
|
||||
## 2021.4.4 |
||||
|
||||
- 本文档迎来的新的首页。 |
||||
- 本文档迎来了暗黑模式。 |
||||
- ~~当然,暗黑模式还有各种各样的问题。具体的内容还需要慢慢调整。~~ |
||||
- 另:Telegram 群聊突破了 5000 人!还加入了 Anti-Spam 机器人! |
||||
- 🎉🎉🎉 |
||||
|
||||
## 2021.4.1 <Badge>[v1.4.2](https://github.com/XTLS/Xray-core/releases/tag/v1.4.2)</Badge> |
||||
|
||||
- 不是愚人节玩笑,今天更新。 |
||||
- 加入 Browser Dialer,用与改变 TLS 指纹与行为。 |
||||
- 加入 uTLS,用与改变 TLS Client Hello 的指纹。 |
||||
- 顺便修复了一大堆奇妙的问题,具体的内容见更新日志。 |
||||
|
||||
## 2021.3.25 |
||||
|
||||
<!-- prettier-ignore --> |
||||
没错还在变。 -_- |
||||
|
||||
## 2021.3.15 |
||||
|
||||
文档网站正在悄悄的进行着某些神秘的变化。。。,🙊🙊🙊 |
||||
|
||||
## 2021.3.14 <Badge>[v1.4.0](https://github.com/XTLS/Xray-core/releases/tag/v1.4.0)</Badge> |
||||
|
||||
- Happy Pi-Day! |
||||
- 这次是个大更新: |
||||
- 为链式代理引入了传输层支持。 |
||||
- 为 Dialer 引入了 Domain Strategy,解决奇妙的 DNS 问题。 |
||||
- 添加了 gRPC 传输方式,与更快一点的 Multi Mode。 |
||||
- 添加了 WebSocket Early-Data 功能,减少了 WebSocket 的延迟。 |
||||
- 添加了 FakeDNS。 |
||||
- 还修复了系列的问题,添加了各类功能,详情请见更新日志。 |
||||
- 还是 VuePress 比较爽啊( |
||||
|
||||
## 2021.3.3 <Badge>[1.3.1](https://github.com/XTLS/Xray-core/releases/tag/v1.3.1)</Badge> |
||||
|
||||
- 这个版本使用了 Golang 1.16,正式原生支持 Apple Silicon。 |
||||
- 同时修复了一个会导致 Panic 的 bug。~~Holmium\_认为这是在骗、在偷袭。~~ |
||||
- 修复了几个遗留问题。 |
||||
|
||||
## 2021.2.14 <Badge>[1.3.0](https://github.com/XTLS/Xray-core/releases/tag/v1.3.0)</Badge> |
||||
|
||||
- Happy 🐮 Year 🎉! |
||||
- v1.3.0 通过非常巧妙的机制实现了 V 系协议全部 FullCone,同时保证了一定的兼容性。 |
||||
- OHHHHHHHHHHHH! |
||||
|
||||
## 2021.01.31 <Badge>[1.2.4](https://github.com/XTLS/Xray-core/releases/tag/v1.2.4)</Badge> |
||||
|
||||
- 解决两个“连接至标准 Socks 服务端时可能出错”的历史遗留问题。 |
||||
- 似乎这个版本没有什么改变,但这只是暴风雨前的宁静。 |
||||
- (没错我就是先知) |
||||
> 你个傻子,你拿的是 UNO 牌。 |
||||
|
||||
## 2021.01.25 |
||||
|
||||
- 全互联网最好最详细的秘籍入门篇同学们练熟了吗? 🍉 老师开始连载[秘籍第一层](../document/level-1/)咯... |
||||
- [英文版文档网站](../en)逐渐增加内容 ing, 感谢各位大佬的辛苦付出~! |
||||
|
||||
## 2021.01.22 <Badge>[1.2.3](https://github.com/XTLS/Xray-core/releases/tag/v1.2.3)</Badge> |
||||
|
||||
- 对 SS 协议的支持**又**变强了, 支持单端口多用户! |
||||
- 对 trojan 协议的支持也**又**变强了, trojan 的回落也解锁 SNI 分流的新姿势啦~! |
||||
- _(VLESS: 嘤嘤嘤)_ |
||||
- UDP 奇奇怪怪的 BUG 被干掉了, 一个字, "稳定". |
||||
- 嗅探可以排除你不想嗅探的域名, 可以开启一些新玩法. |
||||
- 向发现问题->开 issue->自行测试->自行分析->自行找到问题->自行解决->然后给上下游提交 PR 的大佬 <img src="https://avatars2.githubusercontent.com/u/8384161?s=32" width="32px" height="32px" alt="a"/> [@Bohan Yang](https://github.com/bohanyang) 致敬! |
||||
- 其他美味小樱桃, 惯例更新品尝就对啦. |
||||
|
||||
## 2021.01.19 |
||||
|
||||
- 一些数字 |
||||
- 版本发布了 10 个 tag |
||||
- 解决掉了 100 个 issue |
||||
- 复刻了 300 个 fork |
||||
- 点了 2000 个 star |
||||
- 群 3000 个 人 |
||||
|
||||
## 2021.01.17 |
||||
|
||||
- 辛苦的翻译工作开始了, 感谢<img src="https://avatars2.githubusercontent.com/u/60207794?s=32" width="32px" height="32px" alt="a"/> [@玖柒 Max](https://github.com/jiuqi9997)和其他所有的翻译大佬们. |
||||
- [English version](https://xtls.github.io/en/) |
||||
|
||||
## 2021.01.15 <Badge>[1.2.2](https://github.com/XTLS/Xray-core/releases/tag/v1.2.2)</Badge> |
||||
|
||||
- 回落分流又解锁了奇怪的新姿势! 回落中可以根据 SNI 分流啦~! |
||||
- 之前预告的 UUID 修改正式上线.([往下看往下看](#2021.01.12)) |
||||
- 日志现在看起来比上一次顺眼又更顺眼了一丢丢. |
||||
- 远程 DOH 和其他的 DNS 模式一样学会了走路由分流. |
||||
- 当然还有其他各种小糖果.(更新品尝就对了) |
||||
- 啊, 还有, 世界上第一個 M1 上跑起 Xray 的男人是 Anthony TSE |
||||
|
||||
## 2021.01.12 |
||||
|
||||
- 将要到来的 UUID 修改, 支持自定义字符串和 UUID 之间的映射. 这意味着你将可以这样在配置文件中写 id 来对应用户. |
||||
- 客户端写 "id": "我爱 🍉 老师 1314", |
||||
- 服务端写 "id": "5783a3e7-e373-51cd-8642-c83782b807c5" (此 UUID 是 `我爱🍉老师1314` 的 UUID 映射) |
||||
- 🍉 老师的[小小白白话文](../document/level-0/)大结局, 撒花. |
||||
|
||||
## 2021.01.10 <Badge>[1.2.1](https://github.com/XTLS/Xray-core/releases/tag/v1.2.1)</Badge> |
||||
|
||||
- [小小白白话文](../document/level-0/)连载上线啦,🍉 老师呕心沥血之作, 手把手教你从什么都不会到熟练配置 Xray! |
||||
- (可能是整个互联网上, 最详细最有耐心的教你从 0 开始配置的教程) |
||||
- [透明代理](../document/level-2/)也增加了更多文章. |
||||
- 还有很多细节修改, 文档将会越来越规范! |
||||
- 感谢 [@ricuhkaen](https://github.com/ricuhkaen) , [@BioniCosmos](https://github.com/BioniCosmos), [@kirin](https://github.com/kirin10000) |
||||
|
||||
* 大量的 UDP 相关修复, 甚至可以在育碧的土豆服务器上玩彩虹六号! |
||||
* Google Voice 应该也可以正常使用 v2rayNG 拨打了. |
||||
* 日志现在看起来更顺眼. |
||||
|
||||
## 2021.01.07 |
||||
|
||||
- 礼貌和尊重本应是社区不需要明说的准则之一。 |
||||
|
||||
## 2021.01.05 |
||||
|
||||
- 文档网站正在悄悄的进行着某些神秘的变化。。。,🙊🙊🙊 |
||||
|
||||
## 2021.01.03 |
||||
|
||||
- 文档仓库第一个 PR。🎉 |
||||
[透明代理(TProxy)配置教程 ](../document/level-2/tproxy.md) ,感谢<img src="https://avatars2.githubusercontent.com/u/41363844?s=32" width="32px" height="32px" alt="a"/> [@BioniCosmos](https://github.com/BioniCosmos) |
||||
- tg 群突破 2500。 |
||||
|
||||
## 2021.01.01 |
||||
|
||||
【祝大家新年快乐,嗨皮牛耶!】🎆🎇🎆 <Badge>[1.2.0](https://github.com/XTLS/Xray-core/releases/tag/v1.2.0)</Badge> |
||||
|
||||
🎁 在元旦的最后几分钟,v1.2.0 它来了,带着周五必更的惯例,带着各位贡献大佬的心血以及 @rprxx 的黑眼圈,不负众望的来了! |
||||
|
||||
- 圣诞礼物[v1.1.5](#20201225)后的元旦礼物 🎁,游戏玩家大福利,全面 FullCone。 |
||||
- (UDP 还会继续增强!) |
||||
- 如果你已经拆过圣诞礼物,这次还有比圣诞礼物更精美的包装和小糖果哦。(同样不用问,更新品尝就对了) |
||||
- (不,下面不是广告,是里程碑。) |
||||
- Xray 是有史以来第一个不受限制的多协议平台:只需 Xray 即可解决问题,无需借力其它实现。 |
||||
- 一人扛起了所有!支持各大主流协议! |
||||
- 一骑绝尘的性能! |
||||
- 日趋完善的功能! |
||||
- 可怕的生命力与社区亲和力! |
||||
- Xray 将继续保持前行! 因此 [Xray 需要更多的英雄!!](https://github.com/XTLS/Xray-core/discussions/56)! |
||||
- PS:请品,请细品[release notes](https://github.com/XTLS/Xray-core/releases/tag/v1.2.0)每一句。似乎有一个小秘密小彩蛋 ~~(啊,有人敲门...我一会和你们说)~~ |
||||
|
||||
## 2020.12.29 |
||||
|
||||
透明代理的游戏玩家利好! Xray-core tproxy 入站, socks 出站 UDP FullCone 测试版, [TG 群](https://t.me/projectXray)火热测试中 |
||||
|
||||
## 2020.12.25 <Badge>[1.1.5](https://github.com/XTLS/Xray-core/releases/tag/v1.1.5)</Badge> |
||||
|
||||
圣诞节快乐! |
||||
|
||||
- 游戏玩家的圣诞礼物!你可以用 xray 爽快的打游戏啦!因为有了 SS/trojan UDP fullcone |
||||
- 你可以用你喜欢的格式写配置文件了,比如 yaml,比如 toml... |
||||
- (VLESS 的 UDP fullcone 和更多增强很快就到!) |
||||
- 无须再担心证书验证被墙,OCSP stapling 已经上线! |
||||
- kirin 带来了一大波 脚本更新.[脚本在此](https://github.com/XTLS/Xray-install) |
||||
- 还有更多美味小樱桃!(不用问,更新品尝就对了) |
||||
|
||||
## 2020.12.24 |
||||
|
||||
因为某些不可描述的原因,Xray 的文档网站已在发布日前偷跑上线。 |
||||
网址为:[没错你正在看的就是](https://xtls.github.io) |
||||
|
||||
大家可以查阅各种内容也欢迎纠错/提出建议(可发往文档 github 仓库的 issue 区) |
||||
|
||||
文档网站需要不断完善和增加内容,以及完善设计。 |
||||
因此更欢迎大家一起为文档建设添砖加瓦。 |
||||
[文档的仓库](https://github.com/XTLS/XTLS.github.io) |
||||
|
||||
仓库的 readme 中有简略教程说明如何帮助 xray 改进文档网站. |
||||
欢迎大家查看,纠错,修改,增加心得。 |
||||
|
||||
## 2020.12.23 |
||||
|
||||
Xray-core Shadowsocks UDP FullCone 测试版, [TG 群](https://t.me/projectXray)火热测试中 |
||||
|
||||
## 2020.12.21 |
||||
|
||||
- Project X 群人数 2000+ |
||||
- 群消息(含游戏群) 日均破万 |
||||
|
||||
## 2020.12.18 <Badge>[1.1.4](https://github.com/XTLS/Xray-core/releases/tag/v1.1.4)</Badge> |
||||
|
||||
- 更低的启动内占用和内存使用优化 |
||||
- 随意定制的 TLS 提高你的 SSL 评级 |
||||
- 支持 XTLS 入站的 Splice 以及支持 trojan 的 XTLS |
||||
- 还有在您路由器上使用的 Splice 最佳使用模式建议 |
||||
|
||||
## 2020.12.17 |
||||
|
||||
鉴于日益增长群人数和游戏需求, 开启了[TG 游戏群](https://t.me/joinchat/UO4NixbB_XDQJOUjS6mHEQ) |
||||
|
||||
## 2020.12.15 |
||||
|
||||
[安装脚本 dev 分支](https://github.com/XTLS/Xray-install/tree/dev)开启, 持续更新功能中. |
||||
|
||||
## 2020.12.11 <Badge>[1.1.3](https://github.com/XTLS/Xray-core/releases/tag/v1.1.3)</Badge> |
||||
|
||||
- 完整版本的 REDIRECT 透明代理模式. |
||||
- 软路由 splice 流控模式的优化建议. |
||||
|
||||
## 2020.12.06 <Badge>[1.1.2](https://github.com/XTLS/Xray-core/releases/tag/v1.1.2)</Badge> |
||||
|
||||
- 流控增加 splice 模式, Linux 限定, 性能一骑绝尘. |
||||
- 增强了 API 兼容 |
||||
|
||||
## 2020.12.04 |
||||
|
||||
增加 splice 模式 |
||||
|
||||
## 2020.11.27 |
||||
|
||||
- Project X 的 GitHub 主仓库 Xray-core 已获 500+ stars |
||||
- 登上了 GitHub Trending |
||||
- Project X 群人数破千,频道订阅数 500+ |
||||
|
||||
## 2020.11.25 <Badge>[1.0.0](https://github.com/XTLS/Xray-core/releases/tag/v1.0.0)</Badge> |
||||
|
||||
Xray 的第一个版本. |
||||
|
||||
- 基于 v2ray-core 修改而来,改动较大 |
||||
- 全面增强, 性能卓越, 完全兼容 |
||||
|
||||
## 2020.11.23 |
||||
|
||||
project X start |
||||
|
||||
> ~~梦开始的时候~~ |
@ -0,0 +1,94 @@
|
||||
--- |
||||
title: Конфигурационный файл |
||||
lang: ru-RU |
||||
--- |
||||
|
||||
> **В этом разделе вы узнаете все детали настройки Xray. Овладев этими знаниями, вы сможете раскрыть весь потенциал Xray.** |
||||
|
||||
## Обзор |
||||
|
||||
Конфигурационный файл Xray имеет формат JSON. Формат конфигурации одинаков для клиента и сервера, но фактическое содержимое отличается. |
||||
Он выглядит следующим образом: |
||||
|
||||
```json |
||||
{ |
||||
"log": {}, |
||||
"api": {}, |
||||
"dns": {}, |
||||
"routing": {}, |
||||
"policy": {}, |
||||
"inbounds": [], |
||||
"outbounds": [], |
||||
"transport": {}, |
||||
"stats": {}, |
||||
"reverse": {}, |
||||
"fakedns": {}, |
||||
"metrics": {}, |
||||
"observatory": {}, |
||||
"burstObservatory": {} |
||||
} |
||||
``` |
||||
|
||||
::: warning |
||||
Если вы новичок в Xray, вы можете сначала прочитать раздел [Настройка и запуск в кратком руководстве](../document/install.md), чтобы узнать об основных способах настройки, а затем прочитать этот раздел, чтобы узнать обо всех способах настройки Xray. |
||||
::: |
||||
|
||||
## Основные модули конфигурации |
||||
|
||||
> log: [LogObject](./log.md) |
||||
|
||||
Настройка журнала, управляющая способом вывода журналов Xray. |
||||
|
||||
> api: [ApiObject](./api.md) |
||||
|
||||
Предоставляет API-интерфейсы для удаленного вызова. |
||||
|
||||
> dns: [DnsObject](./dns.md) |
||||
|
||||
Встроенный DNS-сервер. Если этот параметр не настроен, используются системные настройки DNS. |
||||
|
||||
> routing: [RoutingObject](./routing.md) |
||||
|
||||
Функция маршрутизации. Позволяет настроить правила для разделения трафика и отправки его через разные исходящие подключения. |
||||
|
||||
> policy: [PolicyObject](./policy.md) |
||||
|
||||
Локальная политика, позволяющая настроить разные уровни пользователей и соответствующие им политики. |
||||
|
||||
> inbounds: \[ [InboundObject](./inbound.md) \] |
||||
|
||||
Массив, каждый элемент которого представляет собой конфигурацию входящего подключения. |
||||
|
||||
> outbounds: \[ [OutboundObject](./outbound.md) \] |
||||
|
||||
Массив, каждый элемент которого представляет собой конфигурацию исходящего подключения. |
||||
|
||||
> transport: [TransportObject](./transport.md) |
||||
|
||||
Используется для настройки способа, которым Xray устанавливает и использует сетевые подключения к другим серверам. |
||||
|
||||
> stats: [StatsObject](./stats.md) |
||||
|
||||
Используется для настройки сбора статистики трафика. |
||||
|
||||
> reverse: [ReverseObject](./reverse.md) |
||||
|
||||
Обратный прокси. Позволяет перенаправлять трафик с сервера на клиент, т.е. перенаправлять трафик в обратном направлении. |
||||
|
||||
> fakedns: [FakeDnsObject](./fakedns.md) |
||||
|
||||
Настройка FakeDNS. Может использоваться совместно с прозрачным проксированием для получения фактических доменных имен. |
||||
|
||||
> metrics: [metricsObject](./metrics.md) |
||||
|
||||
Настройка метрик. Более прямой (и, надеемся, лучший) способ экспорта статистики. |
||||
|
||||
> observatory: [ObservatoryObject](./observatory.md#observatoryobject) |
||||
|
||||
Мониторинг фоновых подключений. Обнаружение состояния подключения исходящего прокси. |
||||
|
||||
> burstObservatory: [BurstObservatoryObject](./observatory.md#burstobservatoryobject) |
||||
|
||||
Мониторинг параллельных подключений. Обнаружение состояния подключения исходящего прокси. |
||||
|
||||
|
@ -0,0 +1,144 @@
|
||||
# API |
||||
|
||||
Настройка API предоставляет API-интерфейсы на основе [gRPC](https://grpc.io/) для удаленного вызова. |
||||
|
||||
Интерфейсы можно включить с помощью модуля конфигурации api. Когда API включен, Xray создает исходящее подключение с тем же тегом, что и тег API. |
||||
Необходимо вручную направить все входящие API-подключения на это исходящее подключение с помощью [правил маршрутизации](./routing.md). |
||||
См. раздел [Связанные настройки](#связанные-настройки) в этом документе. |
||||
|
||||
Начиная с версии [v1.8.12](https://github.com/XTLS/Xray-core/releases/tag/v1.8.12) поддерживается упрощенный режим настройки, в котором достаточно указать только ApiObject, без необходимости настройки inbounds и routing. |
||||
Однако при использовании упрощенной настройки статистика трафика не учитывает трафик входящих API-подключений. |
||||
|
||||
::: warning |
||||
Большинству пользователей не нужен этот API, новички могут просто пропустить этот раздел. |
||||
::: |
||||
|
||||
## ApiObject |
||||
|
||||
`ApiObject` соответствует полю `api` в конфигурационном файле. |
||||
|
||||
```json |
||||
{ |
||||
"api": { |
||||
"tag": "api", |
||||
"listen": "127.0.0.1:8080", |
||||
"services": ["HandlerService", "LoggerService", "StatsService", "RoutingService"] |
||||
} |
||||
} |
||||
``` |
||||
|
||||
> `tag`: string |
||||
|
||||
Тег исходящего подключения. |
||||
|
||||
> `listen`: string |
||||
|
||||
IP-адрес и порт, на котором прослушивает API-сервер. Это необязательный параметр. |
||||
|
||||
Если этот параметр опущен, необходимо добавить настройки inbounds и routing, как показано в примере в разделе [Связанные настройки](#связанные-настройки). |
||||
|
||||
> `services`: \[string\] |
||||
|
||||
Список включенных API. |
||||
Доступные значения см. в разделе [Список API](#список-поддерживаемых-api). |
||||
|
||||
## Связанные настройки |
||||
|
||||
Можно добавить входящее подключение api в раздел inbounds: |
||||
|
||||
```json |
||||
"inbounds": [ |
||||
{ |
||||
"listen": "127.0.0.1", |
||||
"port": 10085, |
||||
"protocol": "dokodemo-door", |
||||
"settings": { |
||||
"address": "127.0.0.1" |
||||
}, |
||||
"tag": "api" |
||||
} |
||||
] |
||||
``` |
||||
|
||||
Добавить правило маршрутизации для входящего подключения api в раздел routing: |
||||
|
||||
```json |
||||
"routing": { |
||||
"rules": [ |
||||
{ |
||||
"inboundTag": [ |
||||
"api" |
||||
], |
||||
"outboundTag": "api", |
||||
"type": "field" |
||||
} |
||||
] |
||||
} |
||||
``` |
||||
|
||||
Добавить api в основные настройки: |
||||
|
||||
```json |
||||
"api": { |
||||
"tag": "api", |
||||
"services": [ |
||||
"StatsService" |
||||
] |
||||
} |
||||
``` |
||||
|
||||
## Список поддерживаемых API |
||||
|
||||
### HandlerService |
||||
|
||||
API для изменения входящих и исходящих подключений. |
||||
Доступны следующие функции: |
||||
|
||||
- Добавление нового входящего подключения; |
||||
- Добавление нового исходящего подключения; |
||||
- Удаление существующего входящего подключения; |
||||
- Удаление существующего исходящего подключения; |
||||
- Добавление пользователя к входящему подключению (поддерживается только для VMess, VLESS, Trojan, Shadowsocks (v1.3.0+)); |
||||
- Удаление пользователя из входящего подключения (поддерживается только для VMess, VLESS, Trojan, Shadowsocks (v1.3.0+)); |
||||
|
||||
### RoutingService |
||||
|
||||
API для добавления, удаления, замены правил маршрутизации и запроса статистики балансировщика. |
||||
Доступны следующие функции: |
||||
|
||||
- adrules - добавление или замена правил маршрутизации; |
||||
- rmrules - удаление правил маршрутизации; |
||||
- sib - разрыв соединений с указанного IP-адреса; |
||||
- bi - запрос статистики балансировщика; |
||||
- bo - принудительное переключение балансировщика на указанный outboundTag. |
||||
|
||||
Конкретное использование можно узнать с помощью команды `./xray help api bi`. |
||||
|
||||
### LoggerService |
||||
|
||||
Поддержка перезапуска встроенного логгера. |
||||
Можно использовать совместно с logrotate для управления файлами журналов. |
||||
|
||||
### StatsService |
||||
|
||||
Встроенная служба статистики данных. |
||||
См. [Статистика](./stats.md). |
||||
|
||||
### ReflectionService |
||||
|
||||
Позволяет gRPC-клиентам получать список API сервера. |
||||
|
||||
```bash |
||||
$ grpcurl -plaintext localhost:10085 list |
||||
grpc.reflection.v1alpha.ServerReflection |
||||
v2ray.core.app.proxyman.command.HandlerService |
||||
v2ray.core.app.stats.command.StatsService |
||||
xray.app.proxyman.command.HandlerService |
||||
xray.app.stats.command.StatsService |
||||
``` |
||||
|
||||
## Примеры вызова API |
||||
|
||||
[Xray-API-documents](https://github.com/XTLS/Xray-API-documents) @crossfw |
||||
|
||||
|
@ -0,0 +1,344 @@
|
||||
# Встроенный DNS-сервер |
||||
|
||||
## DNS-сервер |
||||
|
||||
Встроенный DNS-модуль Xray имеет два основных назначения: |
||||
|
||||
- Разрешение доменных имен в IP-адреса на этапе маршрутизации и сопоставление правил с полученными IP-адресами для разделения трафика. |
||||
Разрешение доменных имен и разделение трафика зависят от значения параметра `domainStrategy` в модуле конфигурации маршрутизации. |
||||
Встроенный DNS-сервер будет использоваться для DNS-запросов только при следующих значениях: |
||||
|
||||
- "IPIfNonMatch": при запросе доменного имени Xray сопоставляет его с доменами, указанными в правилах маршрутизации. |
||||
Если совпадение не найдено, встроенный DNS-сервер используется для разрешения доменного имени, а затем полученный IP-адрес снова сопоставляется с правилами маршрутизации на основе IP-адресов. |
||||
- "IPOnDemand": при сопоставлении правил, основанных на IP-адресах, доменное имя немедленно разрешается в IP-адрес для сопоставления. |
||||
|
||||
- Разрешение целевого адреса для подключения. |
||||
- Например, в исходящем подключении `freedom`, если параметр `domainStrategy` установлен в `UseIP`, исходящие запросы будут сначала разрешать доменное имя в IP-адрес с помощью встроенного DNS-сервера, а затем устанавливать соединение. |
||||
- Например, в `sockopt`, если параметр `domainStrategy` установлен в `UseIP`, системные соединения, инициированные этим исходящим подключением, будут сначала разрешать доменное имя в IP-адрес с помощью встроенного DNS-сервера, а затем устанавливать соединение. |
||||
|
||||
::: tip Совет 1 |
||||
DNS-запросы, отправляемые встроенным DNS-сервером, автоматически перенаправляются в соответствии с конфигурацией маршрутизации. |
||||
::: |
||||
|
||||
::: tip Совет 2 |
||||
Поддерживаются только базовые запросы IP-адресов (записи A и AAAA). Записи CNAME будут запрашиваться повторно до тех пор, пока не будет возвращена запись A/AAAA. Другие запросы не обрабатываются встроенным DNS-сервером. |
||||
::: |
||||
|
||||
## Процесс обработки DNS-запросов |
||||
|
||||
Если запрашиваемое доменное имя: |
||||
|
||||
- Соответствует сопоставлению "домен - IP" или "домен - массив IP" в `hosts`, то этот IP-адрес или массив IP-адресов возвращается в качестве результата DNS-разрешения. |
||||
- Соответствует сопоставлению "домен - домен" в `hosts`, то значение этого сопоставления (другой домен) используется в качестве текущего запрашиваемого доменного имени, и процесс обработки DNS-запросов продолжается до тех пор, пока не будет разрешен IP-адрес или не будет возвращен пустой результат. |
||||
- Не соответствует `hosts`, но соответствует списку доменов `domains` одного (или нескольких) DNS-серверов, то запросы отправляются на соответствующие DNS-серверы в порядке приоритета. |
||||
Если запрос к DNS-серверу завершается неудачей или `expectIPs` не совпадает, используется следующий подходящий DNS-сервер. |
||||
В противном случае возвращается полученный IP-адрес. |
||||
Если запросы ко всем подходящим DNS-серверам завершаются неудачей или `expectIPs` не совпадает, компонент DNS: |
||||
- По умолчанию выполняет "резервный (fallback) запрос DNS": запросы отправляются на "DNS-серверы, которые не использовались в предыдущем раунде неудачных запросов и для которых `skipFallback` имеет значение по умолчанию `false`". |
||||
Если запрос завершается неудачей или `expectIPs` не совпадает, возвращается пустой результат. |
||||
В противном случае возвращается полученный IP-адрес. |
||||
- Если `disableFallback` установлен в `true`, "резервный (fallback) запрос DNS" не выполняется. |
||||
- Не соответствует `hosts` и не соответствует списку доменов `domains` ни одного DNS-сервера, то: |
||||
- По умолчанию запросы отправляются на "DNS-серверы, для которых `skipFallback` имеет значение по умолчанию `false`". |
||||
Если запрос к первому выбранному DNS-серверу завершается неудачей или `expectIPs` не совпадает, используется следующий выбранный DNS-сервер. |
||||
В противном случае возвращается полученный IP-адрес. |
||||
Если запросы ко всем выбранным DNS-серверам завершаются неудачей или `expectIPs` не совпадает, возвращается пустой результат. |
||||
- Если количество "DNS-серверов, для которых `skipFallback` имеет значение по умолчанию `false`", равно 0 или `disableFallback` установлен в `true`, используется первый DNS-сервер в конфигурации DNS. |
||||
Если запрос завершается неудачей или `expectIPs` не совпадает, возвращается пустой результат. |
||||
В противном случае возвращается полученный IP-адрес. |
||||
|
||||
## DnsObject |
||||
|
||||
`DnsObject` соответствует полю `dns` в конфигурационном файле. |
||||
|
||||
```json |
||||
{ |
||||
"dns": { |
||||
"hosts": { |
||||
"baidu.com": "127.0.0.1", |
||||
"dns.google": ["8.8.8.8", "8.8.4.4"] |
||||
}, |
||||
"servers": [ |
||||
"8.8.8.8", |
||||
"8.8.4.4", |
||||
{ |
||||
"address": "1.2.3.4", |
||||
"port": 5353, |
||||
"domains": ["domain:xray.com"], |
||||
"expectIPs": ["geoip:cn"], |
||||
"skipFallback": false, |
||||
"clientIP": "1.2.3.4" |
||||
}, |
||||
{ |
||||
"address": "https://8.8.8.8/dns-query", |
||||
"domains": [ |
||||
"geosite:netflix" |
||||
], |
||||
"skipFallback": true, |
||||
"queryStrategy": "UseIPv4" |
||||
}, |
||||
{ |
||||
"address": "https://1.1.1.1/dns-query", |
||||
"domains": [ |
||||
"geosite:openai" |
||||
], |
||||
"skipFallback": true, |
||||
"queryStrategy": "UseIPv6" |
||||
}, |
||||
"localhost" |
||||
], |
||||
"clientIp": "1.2.3.4", |
||||
"queryStrategy": "UseIP", |
||||
"disableCache": false, |
||||
"disableFallback": false, |
||||
"disableFallbackIfMatch": false, |
||||
"tag": "dns_inbound" |
||||
} |
||||
} |
||||
``` |
||||
|
||||
> `hosts`: map{string: address} | map{string: [address]} |
||||
|
||||
Статический список IP-адресов, значение которого представляет собой набор сопоставлений "домен": "адрес" или "домен": ["адрес 1", "адрес 2"]. |
||||
Адрес может быть IP-адресом или доменным именем. |
||||
При разрешении доменного имени, если домен соответствует одному из элементов этого списка: |
||||
|
||||
- Если адрес элемента - это IP-адрес, то результатом разрешения будет IP-адрес элемента. |
||||
- Если адрес элемента - это доменное имя, то для разрешения IP-адреса будет использоваться это доменное имя, а не исходное доменное имя. |
||||
- Если в адресе указано несколько IP-адресов и доменных имен, то возвращается только первое доменное имя, остальные IP-адреса и доменные имена игнорируются. |
||||
|
||||
Доменные имена могут быть представлены в следующих форматах: |
||||
|
||||
- Простая строка: правило применяется, если эта строка полностью совпадает с целевым доменным именем. |
||||
Например, "xray.com" соответствует "xray.com", но не соответствует "www.xray.com". |
||||
- Регулярное выражение: начинается с `"regexp:"`, а остальная часть - это регулярное выражение. |
||||
Правило применяется, если это регулярное выражение соответствует целевому доменному имени. |
||||
Например, "regexp:\\\\.goo.\*\\\\.com\$" соответствует "www.google.com", "fonts.googleapis.com", но не соответствует "google.com". |
||||
- Поддомен (рекомендуется): начинается с `"domain:"`, а остальная часть - это доменное имя. |
||||
Правило применяется, если это доменное имя является целевым доменным именем или его поддоменом. |
||||
Например, "domain:xray.com" соответствует "www.xray.com" и "xray.com", но не соответствует "wxray.com". |
||||
- Подстрока: начинается с `"keyword:"`, а остальная часть - это строка. |
||||
Правило применяется, если эта строка соответствует любой части целевого доменного имени. |
||||
Например, "keyword:sina.com" соответствует "sina.com", "sina.com.cn" и "www.sina.com", но не соответствует "sina.cn". |
||||
- Предопределенный список доменов: начинается с `"geosite:"`, а остальная часть - это имя, например `geosite:google` или `geosite:cn`. |
||||
Список имен и доменов см. в разделе [Предопределенные списки доменов](./routing.md#предопределенные-списки-доменов). |
||||
|
||||
> `servers`: \[string | [ServerObject](#serverobject) \] |
||||
|
||||
Список DNS-серверов, поддерживаются два типа: адрес DNS (в виде строки) и [ServerObject](#serverobject). |
||||
|
||||
Значение `"localhost"` означает использование локальных настроек DNS. |
||||
|
||||
Если значение - это адрес DNS `"IP:Port"`, например `"8.8.8.8:53"`, Xray будет использовать указанный UDP-порт этого адреса для DNS-запросов. |
||||
Запрос будет следовать правилам маршрутизации. |
||||
Если порт не указан, по умолчанию используется порт 53. |
||||
|
||||
Если значение имеет вид `"tcp://host:port"`, например `"tcp://8.8.8.8:53"`, Xray будет использовать `DNS over TCP` для запросов. |
||||
Запрос будет следовать правилам маршрутизации. |
||||
Если порт не указан, по умолчанию используется порт 53. |
||||
|
||||
Если значение имеет вид `"tcp+local://host:port"`, например `"tcp+local://8.8.8.8:53"`, Xray будет использовать `локальный режим TCP (TCPL)` для запросов. |
||||
Это означает, что DNS-запросы не будут проходить через компонент маршрутизации, а будут отправляться непосредственно через исходящее подключение Freedom для сокращения времени ожидания. |
||||
Если порт не указан, по умолчанию используется порт 53. |
||||
|
||||
Если значение имеет вид `"https://host:port/dns-query"`, например `"https://dns.google/dns-query"`, Xray будет использовать `DNS over HTTPS` (RFC8484, сокращенно DOH) для запросов. |
||||
Некоторые провайдеры имеют сертификаты с IP-псевдонимами, поэтому можно использовать IP-адрес напрямую, например `https://1.1.1.1/dns-query`. |
||||
Также можно использовать нестандартные порты и пути, например `"https://a.b.c.d:8443/my-dns-query"`. |
||||
|
||||
Если значение имеет вид `"https+local://host:port/dns-query"`, например `"https+local://dns.google/dns-query"`, Xray будет использовать `локальный режим DOH (DOHL)` для запросов. |
||||
Это означает, что DOH-запросы не будут проходить через компонент маршрутизации, а будут отправляться непосредственно через исходящее подключение Freedom для сокращения времени ожидания. |
||||
Обычно этот режим подходит для использования на сервере. |
||||
Также можно использовать нестандартные порты и пути. |
||||
|
||||
Если значение имеет вид `"quic+local://host"`, например `"quic+local://dns.adguard.com"`, Xray будет использовать `локальный режим DNS over QUIC (DOQL)` для запросов. |
||||
Это означает, что DNS-запросы не будут проходить через компонент маршрутизации, а будут отправляться непосредственно через исходящее подключение Freedom. |
||||
Этот режим требует, чтобы DNS-сервер поддерживал DNS over QUIC. |
||||
По умолчанию для запросов используется порт 784, можно использовать нестандартный порт. |
||||
|
||||
Если значение равно `fakedns`, для запросов будет использоваться FakeDNS. |
||||
|
||||
::: tip Совет 1 |
||||
При использовании `localhost` локальные DNS-запросы не контролируются Xray. |
||||
Для того, чтобы DNS-запросы перенаправлялись через Xray, требуется дополнительная настройка. |
||||
::: |
||||
|
||||
::: tip Совет 2 |
||||
Разные DNS-клиенты, инициализированные разными правилами, будут отображаться в журнале запуска Xray с уровнем `info`, например, `local DOH`, `remote DOH`, `udp` и т.д. |
||||
::: |
||||
|
||||
::: tip Совет 3 |
||||
(v1.4.0+) Можно включить ведение журнала DNS-запросов в [настройках журнала](./log.md). |
||||
::: |
||||
|
||||
> `clientIp`: string |
||||
|
||||
IP-адрес, который будет сообщаться серверу при выполнении DNS-запросов. |
||||
Не может быть частным IP-адресом. |
||||
|
||||
::: tip Совет 1 |
||||
Требуется, чтобы DNS-сервер поддерживал EDNS Client Subnet. |
||||
::: |
||||
|
||||
::: tip Совет 2 |
||||
Можно указать `clientIp` для всех DNS-серверов в [DnsObject](#dnsobject) или для каждого DNS-сервера в [ServerObject](#serverobject) (настройка в ServerObject имеет приоритет над настройкой в DnsObject). |
||||
::: |
||||
|
||||
> `queryStrategy`: "UseIP" | "UseIPv4" | "UseIPv6" |
||||
|
||||
Значение по умолчанию - `UseIP`, запрашиваются как записи A, так и записи AAAA. |
||||
`UseIPv4` - запрашиваются только записи A; `UseIPv6` - запрашиваются только записи AAAA. |
||||
|
||||
Новая функция в Xray-core v1.8.6: `queryStrategy` можно настроить для каждого `DNS`-сервера. |
||||
|
||||
```json |
||||
"dns": { |
||||
"servers": [ |
||||
"https://1.1.1.1/dns-query", |
||||
{ |
||||
"address": "https://8.8.8.8/dns-query", |
||||
"domains": [ |
||||
"geosite:netflix" |
||||
], |
||||
"skipFallback": true, |
||||
"queryStrategy": "UseIPv4" // Запрос записей A для доменов netflix |
||||
}, |
||||
{ |
||||
"address": "https://1.1.1.1/dns-query", |
||||
"domains": [ |
||||
"geosite:openai" |
||||
], |
||||
"skipFallback": true, |
||||
"queryStrategy": "UseIPv6" // Запрос записей AAAA для доменов openai |
||||
} |
||||
], |
||||
"queryStrategy": "UseIP" // Запрос записей A и AAAA для всех доменов |
||||
} |
||||
``` |
||||
|
||||
::: tip Совет 1 |
||||
Глобальное значение `"queryStrategy"` имеет приоритет. |
||||
Если значение `"queryStrategy"` в дочернем элементе конфликтует с глобальным значением `"queryStrategy"`, дочерний запрос вернет пустой ответ. |
||||
::: |
||||
|
||||
::: tip Совет 2 |
||||
Если параметр `"queryStrategy"` не указан в дочернем элементе, используется глобальное значение `"queryStrategy"`. |
||||
Поведение такое же, как и в версиях Xray-core до v1.8.6. |
||||
::: |
||||
|
||||
Например:<br> |
||||
Глобальное значение `"queryStrategy": "UseIPv6"` конфликтует с дочерним значением `"queryStrategy": "UseIPv4"`.<br> |
||||
Глобальное значение `"queryStrategy": "UseIPv4"` конфликтует с дочерним значением `"queryStrategy": "UseIPv6"`.<br> |
||||
Глобальное значение `"queryStrategy": "UseIP"` не конфликтует с дочерним значением `"queryStrategy": "UseIPv6"`.<br> |
||||
Глобальное значение `"queryStrategy": "UseIP"` не конфликтует с дочерним значением `"queryStrategy": "UseIPv4"`. |
||||
|
||||
```json |
||||
"dns": { |
||||
"servers": [ |
||||
"https://1.1.1.1/dns-query", |
||||
{ |
||||
"address": "https://8.8.8.8/dns-query", |
||||
"domains": [ |
||||
"geosite:netflix" |
||||
], |
||||
"skipFallback": true, |
||||
"queryStrategy": "UseIPv6" // Конфликт между глобальным значением "UseIPv4" и дочерним значением "UseIPv6" |
||||
} |
||||
], |
||||
"queryStrategy": "UseIPv4" |
||||
} |
||||
``` |
||||
|
||||
Дочерний запрос для доменов netflix вернет пустой ответ из-за конфликта значений `"queryStrategy"`. |
||||
Домены netflix будут разрешены с помощью `https://1.1.1.1/dns-query`, и будут получены записи A. |
||||
|
||||
> `disableCache`: true | false |
||||
|
||||
`true` - отключить кэширование DNS, по умолчанию `false` (кэширование включено). |
||||
|
||||
> `disableFallback`: true | false |
||||
|
||||
`true` - отключить резервные (fallback) DNS-запросы, по умолчанию `false` (резервные запросы включены). |
||||
|
||||
> `disableFallbackIfMatch`: true | false |
||||
|
||||
`true` - отключить резервные (fallback) DNS-запросы, если совпадает приоритетный список доменов DNS-сервера, по умолчанию `false` (резервные запросы включены). |
||||
|
||||
> `tag`: string |
||||
|
||||
Трафик запросов, отправляемых встроенным DNS-сервером (кроме режимов `localhost`, `fakedns`, `TCPL`, `DOHL` и `DOQL`), можно сопоставить с помощью этого тега, используя `inboundTag` в правилах маршрутизации. |
||||
|
||||
### ServerObject |
||||
|
||||
```json |
||||
{ |
||||
"address": "1.2.3.4", |
||||
"port": 5353, |
||||
"domains": ["domain:xray.com"], |
||||
"expectIPs": ["geoip:cn"], |
||||
"skipFallback": false, |
||||
"clientIP": "1.2.3.4" |
||||
} |
||||
``` |
||||
|
||||
> `address`: address |
||||
|
||||
Адрес DNS-сервера. |
||||
Поддерживаются два типа: адрес DNS (в виде строки) и ServerObject. |
||||
|
||||
Значение `"localhost"` означает использование локальных настроек DNS. |
||||
|
||||
Если значение - это адрес DNS `"IP"`, например `"8.8.8.8"`, Xray будет использовать указанный UDP-порт этого адреса для DNS-запросов. |
||||
Запрос будет следовать правилам маршрутизации. |
||||
По умолчанию используется порт 53. |
||||
|
||||
Если значение имеет вид `"tcp://host"`, например `"tcp://8.8.8.8"`, Xray будет использовать `DNS over TCP` для запросов. |
||||
Запрос будет следовать правилам маршрутизации. |
||||
По умолчанию используется порт 53. |
||||
|
||||
Если значение имеет вид `"tcp+local://host"`, например `"tcp+local://8.8.8.8"`, Xray будет использовать `локальный режим TCP (TCPL)` для запросов. |
||||
Это означает, что DNS-запросы не будут проходить через компонент маршрутизации, а будут отправляться непосредственно через исходящее подключение Freedom для сокращения времени ожидания. |
||||
Если порт не указан, по умолчанию используется порт 53. |
||||
|
||||
Если значение имеет вид `"https://host:port/dns-query"`, например `"https://dns.google/dns-query"`, Xray будет использовать `DNS over HTTPS` (RFC8484, сокращенно DOH) для запросов. |
||||
Некоторые провайдеры имеют сертификаты с IP-псевдонимами, поэтому можно использовать IP-адрес напрямую, например `https://1.1.1.1/dns-query`. |
||||
Также можно использовать нестандартные порты и пути, например `"https://a.b.c.d:8443/my-dns-query"`. |
||||
|
||||
Если значение имеет вид `"https+local://host:port/dns-query"`, например `"https+local://dns.google/dns-query"`, Xray будет использовать `локальный режим DOH (DOHL)` для запросов. |
||||
Это означает, что DOH-запросы не будут проходить через компонент маршрутизации, а будут отправляться непосредственно через исходящее подключение Freedom для сокращения времени ожидания. |
||||
Обычно этот режим подходит для использования на сервере. |
||||
Также можно использовать нестандартные порты и пути. |
||||
|
||||
Если значение имеет вид `"quic+local://host:port"`, например `"quic+local://dns.adguard.com"`, Xray будет использовать `локальный режим DOQ (DOQL)` для запросов. |
||||
Это означает, что DNS-запросы не будут проходить через компонент маршрутизации, а будут отправляться непосредственно через исходящее подключение Freedom. |
||||
Этот режим требует, чтобы DNS-сервер поддерживал DNS over QUIC. |
||||
По умолчанию для запросов используется порт 784, можно использовать нестандартный порт. |
||||
|
||||
Если значение равно `fakedns`, для запросов будет использоваться FakeDNS. |
||||
|
||||
> `port`: number |
||||
|
||||
Порт DNS-сервера, например `53`. |
||||
По умолчанию используется порт `53`. |
||||
Этот параметр не используется в режимах DOH, DOHL, DOQL. |
||||
Нестандартный порт должен быть указан в URL. |
||||
|
||||
> `domains`: \[string\] |
||||
|
||||
Список доменов, для которых в первую очередь будет использоваться этот сервер. |
||||
Формат доменных имен такой же, как и в [конфигурации маршрутизации](./routing.md#ruleobject). |
||||
|
||||
> `expectIPs`: \[string\] |
||||
|
||||
Список диапазонов IP-адресов, формат такой же, как и в [конфигурации маршрутизации](./routing.md#ruleobject). |
||||
|
||||
Если этот параметр настроен, DNS Xray будет проверять возвращаемые IP-адреса и возвращать только те, которые входят в список `expectIPs`. |
||||
|
||||
Если этот параметр не настроен, IP-адреса возвращаются без изменений. |
||||
|
||||
> `skipFallback`: true | false |
||||
|
||||
`true` - пропустить этот сервер при выполнении резервных (fallback) DNS-запросов, по умолчанию `false` (не пропускать). |
||||
|
||||
|
||||
|
||||
|
After Width: | Height: | Size: 659 KiB |
@ -0,0 +1,202 @@
|
||||
# FakeDNS |
||||
|
||||
FakeDNS подменяет DNS-записи, чтобы получить целевое доменное имя, что позволяет сократить время DNS-запросов и получить целевое доменное имя при использовании прозрачного проксирования. |
||||
|
||||
::: warning |
||||
FakeDNS может загрязнить локальный DNS-кэш, что может привести к "недоступности сети" после отключения Xray. |
||||
::: |
||||
|
||||
## FakeDNSObject |
||||
|
||||
`FakeDNSObject` соответствует полю `fakedns` в конфигурационном файле. |
||||
|
||||
```json |
||||
{ |
||||
"ipPool": "198.18.0.0/16", |
||||
"poolSize": 65535 |
||||
} |
||||
``` |
||||
|
||||
`FakeDnsObject` также может быть настроен как массив, содержащий несколько пулов FakeIP. |
||||
При получении DNS-запроса FakeDNS вернет набор FakeIP, полученных из нескольких пулов FakeIP. |
||||
|
||||
```json |
||||
[ |
||||
{ |
||||
"ipPool": "198.18.0.0/15", |
||||
"poolSize": 65535 |
||||
}, |
||||
{ |
||||
"ipPool": "fc00::/18", |
||||
"poolSize": 65535 |
||||
} |
||||
] |
||||
``` |
||||
|
||||
> `ipPool`: CIDR |
||||
|
||||
FakeDNS будет использовать этот блок IP-адресов для выделения адресов. |
||||
|
||||
> `poolSize`: int |
||||
|
||||
Максимальное количество сопоставлений "домен - IP", которые FakeDNS может хранить в памяти. |
||||
Когда количество сопоставлений превышает это значение, старые сопоставления удаляются по алгоритму LRU. |
||||
Значение по умолчанию - 65535. |
||||
|
||||
::: warning |
||||
`poolSize` должен быть меньше или равен общему количеству адресов в `ipPool`. |
||||
::: |
||||
|
||||
::: tip |
||||
Если в поле `dns` конфигурационного файла указано `fakedns`, но `FakeDnsObject` не настроен, Xray инициализирует `FakeDnsObject` в соответствии с параметром `queryStrategy` компонента DNS. |
||||
|
||||
Если `queryStrategy` равен `UseIP`, инициализированный пул FakeIP будет эквивалентен: |
||||
|
||||
```json |
||||
[ |
||||
{ |
||||
"ipPool": "198.18.0.0/15", |
||||
"poolSize": 32768 |
||||
}, |
||||
{ |
||||
"ipPool": "fc00::/18", |
||||
"poolSize": 32768 |
||||
} |
||||
] |
||||
``` |
||||
|
||||
Если `queryStrategy` равен `UseIPv4`, инициализированный пул FakeIP будет эквивалентен: |
||||
|
||||
```json |
||||
{ |
||||
"ipPool": "198.18.0.0/15", |
||||
"poolSize": 65535 |
||||
} |
||||
``` |
||||
|
||||
Если `queryStrategy` равен `UseIPv6`, инициализированный пул FakeIP будет эквивалентен: |
||||
|
||||
```json |
||||
{ |
||||
"ipPool": "fc00::/18", |
||||
"poolSize": 65535 |
||||
} |
||||
``` |
||||
|
||||
::: |
||||
|
||||
### Как использовать FakeDNS? |
||||
|
||||
По сути, FakeDNS - это [DNS-сервер](./dns.md#serverobject), который можно использовать с любыми правилами DNS. |
||||
|
||||
Чтобы FakeDNS работал, необходимо направить DNS-запросы на него. |
||||
|
||||
```json |
||||
{ |
||||
"dns": { |
||||
"servers": [ |
||||
"fakedns", // fakedns на первом месте |
||||
"8.8.8.8" |
||||
] |
||||
}, |
||||
"outbounds": [ |
||||
{ |
||||
"protocol": "dns", |
||||
"tag": "dns-out" |
||||
} |
||||
], |
||||
"routing": { |
||||
"rules": [ |
||||
{ |
||||
"type": "field", |
||||
"inboundTag": ["dns-in"], // Перехват DNS-трафика, поступающего от DNS-входа или от входящего подключения прозрачного прокси. |
||||
"port": 53, |
||||
"outboundTag": "dns-out" |
||||
} |
||||
] |
||||
} |
||||
} |
||||
``` |
||||
|
||||
Когда внешний DNS-запрос поступает в компонент FakeDNS, он возвращает IP-адрес из своего пула `ipPool` в качестве фиктивного результата разрешения доменного имени и сохраняет сопоставление между доменным именем и фиктивным IP-адресом. |
||||
|
||||
Кроме того, вам нужно включить `Sniffing` во входящем подключении, которое принимает трафик, который нужно проксировать, и использовать `fakedns` для замены целевого адреса **на стороне клиента**. |
||||
|
||||
```json |
||||
"sniffing": { |
||||
"enabled": true, |
||||
"destOverride": ["fakedns"], // Используйте "fakedns" или в сочетании с другими снифферами, или используйте "fakedns+others". |
||||
"metadataOnly": false // Если этот параметр равен true, то в destOverride можно использовать только fakedns. |
||||
}, |
||||
``` |
||||
|
||||
::: warning |
||||
Если FakeIP не будет правильно заменен на доменное имя, подключение к серверу не будет установлено. |
||||
::: |
||||
|
||||
### Использование FakeDNS с другими типами DNS |
||||
|
||||
#### Совместное использование с разделением DNS |
||||
|
||||
При использовании разделения DNS, чтобы `fakedns` имел высокий приоритет, нужно добавить для него тот же параметр `domains`, что и для других типов DNS. |
||||
|
||||
```json |
||||
{ |
||||
"servers": [ |
||||
{ |
||||
"address": "fakedns", |
||||
"domains": [ |
||||
// То же самое, что и в разделе разделения DNS ниже. |
||||
"geosite:cn", |
||||
"domain:example.com" |
||||
] |
||||
}, |
||||
{ |
||||
"address": "1.2.3.4", |
||||
"domains": ["geosite:cn"], |
||||
"expectIPs": ["geoip:cn"] |
||||
}, |
||||
{ |
||||
"address": "1.1.1.1", |
||||
"domains": ["domain:example.com"] |
||||
}, |
||||
"8.8.8.8" |
||||
] |
||||
} |
||||
``` |
||||
|
||||
#### Черный список FakeDNS |
||||
|
||||
Если вы не хотите, чтобы FakeDNS использовался для определенных доменов, вы можете добавить параметр `domains` к другим типам конфигурации DNS, чтобы указать, что эти домены должны иметь более высокий приоритет при сопоставлении с другими DNS-серверами, чем с FakeDNS, тем самым реализовав механизм черного списка FakeDNS. |
||||
|
||||
```json |
||||
{ |
||||
"servers": [ |
||||
"fakedns", |
||||
{ |
||||
"address": "1.2.3.4", |
||||
"domains": ["domain:do-not-use-fakedns.com"] |
||||
} |
||||
] |
||||
} |
||||
``` |
||||
|
||||
#### Белый список FakeDNS |
||||
|
||||
Если вы хотите, чтобы FakeDNS использовался только для определенных доменов, вы можете добавить параметр `domains` к `fakedns`, чтобы указать, что эти домены должны иметь более высокий приоритет при сопоставлении с `fakedns`, чем с другими DNS-серверами, тем самым реализовав механизм белого списка FakeDNS. |
||||
|
||||
```json |
||||
{ |
||||
"servers": [ |
||||
"1.2.3.4", |
||||
{ |
||||
"address": "fakedns", |
||||
"domains": ["domain:only-this-use-fakedns.com"] |
||||
} |
||||
] |
||||
} |
||||
``` |
||||
|
||||
|
||||
|
||||
|
@ -0,0 +1,47 @@
|
||||
# Браузерный Dialer |
||||
|
||||
<Badge text="BETA" type="warning"/> <Badge text="v1.4.1+" type="warning"/> |
||||
|
||||
## Предыстория |
||||
|
||||
Основываясь на [идее, возникшей год назад](https://github.com/v2ray/discussion/issues/754#issuecomment-647934994), с помощью нативного JavaScript был реализован простой WSS-браузерный Dialer, который эмулирует TLS-отпечаток и поведенческие характеристики реального браузера. |
||||
|
||||
Однако WSS все еще имеет очевидные проблемы с ALPN, поэтому следующим шагом будет пересылка `HTTP/2` и `QUIC` через браузер. |
||||
|
||||
## Xray и JS |
||||
|
||||
Был создан очень простой и элегантный механизм связи: |
||||
|
||||
- Xray прослушивает адрес и порт A в качестве HTTP-сервера. |
||||
Браузер обращается к A и загружает JavaScript-код с веб-страницы. |
||||
- JavaScript-код устанавливает WebSocket-соединение с A. |
||||
После успешного установления соединения Xray передает соединение в канал. |
||||
- При необходимости установить соединение Xray получает доступное соединение из канала и отправляет целевой URL-адрес и необязательные ранние данные (early data). |
||||
- JavaScript-код сообщает Xray об успешном подключении к цели и продолжает использовать это соединение для двунаправленной передачи данных. |
||||
Соединение закрывается синхронно. |
||||
- Соединение закрывается после использования, но JavaScript-код гарантирует, что всегда есть доступные новые соединения. |
||||
|
||||
## Ранние данные (Early data) |
||||
|
||||
Механизм ранних данных был скорректирован в соответствии с потребностями браузера: |
||||
|
||||
- Заголовок ответа сервера содержит заголовок `Sec-WebSocket-Protocol` запроса, что также частично скрывает характеристики длины ответа рукопожатия WSS. |
||||
- Для кодирования ранних данных, отправляемых браузеру, используется `base64.RawURLEncoding`, а не `StdEncoding`. |
||||
Сервер обеспечивает совместимость. |
||||
- Кроме того, из-за [Xray-core#375](https://github.com/XTLS/Xray-core/pull/375) рекомендуется использовать `?ed=2048`. |
||||
В этом PR также увеличен `MaxHeaderBytes` на сервере до 4096. |
||||
~~(Хотя, кажется, это не обязательно)~~ |
||||
|
||||
## Конфигурация <Badge text="v1.4.1" type="warning"/> |
||||
|
||||
Это экспериментальный процесс. |
||||
В настоящее время конфигурация выглядит следующим образом (Xray-core v1.4.1): |
||||
|
||||
- Подготовьте рабочую конфигурацию WSS. |
||||
Обратите внимание, что в поле `address` нужно указать доменное имя. |
||||
Если нужно указать IP-адрес, настройте DNS или добавьте запись в файл hosts. |
||||
- Если трафик браузера также проходит через Xray-core, обязательно настройте прямое подключение для этого домена, чтобы избежать зацикливания трафика. |
||||
- Установите переменную окружения, указывающую адрес и порт, который нужно прослушивать, например, `XRAY_BROWSER_DIALER = 127.0.0.1:8080`. |
||||
- Сначала запустите Xray-core, а затем откройте указанный адрес и порт в любом браузере. |
||||
Вы также можете открыть инструменты разработчика (F12) и посмотреть консоль и вкладку "Сеть". |
||||
- Браузеры ограничивают количество WebSocket-соединений, поэтому рекомендуется включить `Mux.Cool`. |
@ -0,0 +1,31 @@
|
||||
# Переменные среды |
||||
|
||||
Xray предоставляет следующие переменные среды для изменения некоторых базовых настроек Xray. |
||||
|
||||
## Путь к файлам ресурсов |
||||
|
||||
- Название: `xray.location.asset` или `XRAY_LOCATION_ASSET`. |
||||
- Значение по умолчанию: Определенный каталог [FHS](https://en.wikipedia.org/wiki/Filesystem_Hierarchy_Standard) или тот же каталог, что и файл Xray. |
||||
|
||||
Эта переменная среды указывает расположение папки, которая должна содержать файлы `geoip.dat` и `geosite.dat`. |
||||
Если значение переменной не указано, программа будет искать файлы ресурсов в следующем порядке: |
||||
|
||||
``` |
||||
./ |
||||
/usr/local/share/xray |
||||
/usr/share/xray |
||||
``` |
||||
|
||||
## Расположение файла конфигурации |
||||
|
||||
- Название: `xray.location.config` или `XRAY_LOCATION_CONFIG`. |
||||
- Значение по умолчанию: Тот же каталог, что и файл Xray. |
||||
|
||||
Эта переменная среды указывает расположение папки, которая должна содержать файл `config.json`. |
||||
|
||||
## Каталог с несколькими конфигурациями |
||||
|
||||
- Название: `xray.location.confdir` или `XRAY_LOCATION_CONFDIR`. |
||||
- Значение по умолчанию: `""`. |
||||
|
||||
Файлы `.json` в этом каталоге будут читаться в порядке имен файлов как параметры конфигурации. |
@ -0,0 +1,102 @@
|
||||
# Fallback |
||||
|
||||
> **Fallback - одна из самых мощных функций Xray, эффективно предотвращающая активное зондирование и позволяющая свободно настраивать совместное использование нескольких служб на часто используемых портах.** |
||||
|
||||
Fallback обеспечивает Xray высокой степенью защиты от активного зондирования и имеет уникальный механизм резервирования первого пакета. |
||||
|
||||
Fallback также может разделять трафик различных типов по пути, что позволяет совместно использовать один порт для нескольких служб. |
||||
|
||||
В настоящее время вы можете использовать функцию fallback при использовании протоколов VLESS или Trojan, настроив `fallbacks`, и создавать очень разнообразные комбинации. |
||||
|
||||
## Настройка `fallbacks` |
||||
|
||||
```json |
||||
"fallbacks": [ |
||||
{ |
||||
"dest": 80 |
||||
} |
||||
] |
||||
``` |
||||
|
||||
> `fallbacks`: \[ [FallbackObject](#fallbackobject) \] |
||||
|
||||
Массив, содержащий серию мощных конфигураций резервирования и разделения трафика. |
||||
|
||||
### FallbackObject |
||||
|
||||
```json |
||||
{ |
||||
"name": "", |
||||
"alpn": "", |
||||
"path": "", |
||||
"dest": 80, |
||||
"xver": 0 |
||||
} |
||||
``` |
||||
|
||||
**`fallbacks` - это массив, здесь приведено описание конфигурации одного из его элементов.** |
||||
|
||||
Элемент `fallbacks` является необязательным и может использоваться только для комбинации транспорта TCP+TLS. |
||||
|
||||
- Если этот элемент имеет дочерние элементы, в [Inbound TLS](../transport.md#tlsobject) необходимо установить `"alpn":["http/1.1"]`. |
||||
|
||||
Обычно сначала нужно настроить набор резервных путей по умолчанию с опущенными или пустыми `alpn` и `path`, а затем настроить другие разделения по мере необходимости. |
||||
|
||||
VLESS будет перенаправлять трафик с длиной первого пакета после дешифрования TLS менее 18 байт, неверной версией протокола или неудачной аутентификацией на адрес, указанный в `dest`. |
||||
|
||||
Для других комбинаций транспорта необходимо удалить элемент `fallbacks` или все его дочерние элементы. В этом случае Fallback не будет включен, VLESS будет ждать считывания необходимой длины, а в случае неверной версии протокола или сбоя аутентификации соединение будет немедленно разорвано. |
||||
|
||||
> `name`: string |
||||
|
||||
Попытка сопоставить TLS SNI (указание имени сервера), любое значение или пустая строка, по умолчанию "". |
||||
|
||||
> `alpn`: string |
||||
|
||||
Попытка сопоставить результат согласования TLS ALPN, любое значение или пустая строка, по умолчанию "". |
||||
|
||||
При необходимости VLESS попытается прочитать результат согласования TLS ALPN, и в случае успеха выведет в лог `realAlpn =`. |
||||
Назначение: решает проблему несовместимости службы h2c Nginx с http/1.1, для которой в Nginx требуется написать две строки listen, по одной для 1.1 и h2c. |
||||
Примечание: если в `fallbacks alpn` присутствует `"h2"`, в [Inbound TLS](../transport.md#tlsobject) необходимо установить `"alpn":["h2","http/1.1"]` для поддержки доступа h2. |
||||
|
||||
::: tip |
||||
`alpn`, установленный в Fallback, соответствует фактически согласованному ALPN, а `alpn`, установленный в Inbound TLS, - это список дополнительных ALPN во время рукопожатия. Это разные вещи. |
||||
::: |
||||
|
||||
> `path`: string |
||||
|
||||
Попытка сопоставить HTTP-путь первого пакета, любое значение или пустая строка, по умолчанию пустая строка, если не пустая, то должна начинаться с `/`, h2c не поддерживается. |
||||
|
||||
Интеллектуальность: при необходимости VLESS попытается просмотреть PATH (не более 55 байт; самый быстрый алгоритм, не выполняет полный разбор HTTP) и в случае успеха выведет в INFO-лог `realPath =`. |
||||
Назначение: разделение трафика WebSocket или HTTP-маскировки для других входящих соединений, без лишней обработки, чистая переадресация трафика, теоретически более высокая производительность, чем у Nginx. |
||||
|
||||
Примечание: **входящее соединение, в котором находится fallbacks, должно быть TCP+TLS**, это необходимо для разделения трафика на другие входящие соединения WS, входящие соединения, на которые разделяется трафик, не нуждаются в настройке TLS. |
||||
|
||||
> `dest`: string | number |
||||
|
||||
Определяет, куда перенаправляется TCP-трафик после дешифрования TLS, в настоящее время поддерживаются два типа адресов (это поле является обязательным, иначе запуск невозможен): |
||||
|
||||
1. TCP, формат `"addr:port"`, где addr поддерживает IPv4, доменное имя, IPv6, если указано доменное имя, TCP-соединение будет установлено напрямую (без использования встроенного DNS). |
||||
2. Unix domain socket, формат - абсолютный путь, например, `"/dev/shm/domain.socket"`, в начале можно добавить `@` для обозначения [abstract](https://www.man7.org/linux/man-pages/man7/unix.7.html), `@@` - для обозначения abstract с заполнением. |
||||
|
||||
Если указан только порт, можно использовать число или строку, например, `80`, `"80"`, обычно указывает на службу http в открытом виде (addr будет дополнен до `"127.0.0.1"`). |
||||
|
||||
> `xver`: number |
||||
|
||||
Отправка [PROXY protocol](https://www.haproxy.org/download/2.2/doc/proxy-protocol.txt), специально для передачи реального исходного IP-адреса и порта запроса, заполняется версией 1 или 2, по умолчанию 0, то есть не отправляется. При необходимости рекомендуется указать 1. |
||||
|
||||
В настоящее время при указании 1 или 2 функциональность полностью идентична, отличается только структура, причем первая может быть распечатана, а вторая - двоичная. Входящие TCP- и WS-соединения Xray уже поддерживают прием PROXY protocol. |
||||
|
||||
::: warning |
||||
Если вы [настраиваете Nginx на прием PROXY protocol](https://docs.nginx.com/nginx/admin-guide/load-balancer/using-proxy-protocol/#configuring-nginx-to-accept-the-proxy-protocol), помимо установки `proxy_protocol`, необходимо также установить `set_real_ip_from`, иначе могут возникнуть проблемы. |
||||
::: |
||||
|
||||
### Дополнительные замечания |
||||
|
||||
- Будет выполнено сопоставление с наиболее точным дочерним элементом, порядок дочерних элементов не имеет значения. Если настроено несколько дочерних элементов с одинаковыми `alpn` и `path`, будет использоваться последний. |
||||
- Резервирование и разделение трафика - это переадресация на уровне TCP после дешифрования, а не на уровне HTTP, проверка PATH первого пакета выполняется только при необходимости. |
||||
- Вы можете просмотреть больше советов и рекомендаций по использованию Fallbacks: |
||||
- [Краткое описание функции Fallbacks](../../document/level-1/fallbacks-lv1) |
||||
|
||||
## Теория Fallbacks <Badge text="В разработке" type="warning"/> |
||||
|
||||
|
@ -0,0 +1,138 @@
|
||||
# Настройка с помощью нескольких файлов |
||||
|
||||
Программа Xray поддерживает использование нескольких файлов конфигурации. |
||||
|
||||
Основная цель использования нескольких файлов конфигурации — разделение настроек модулей с разными функциями для удобства управления и обслуживания. |
||||
|
||||
Эта функция в основном предназначена для обогащения экосистемы Xray. Например, для клиентских GUI обычно реализуются только фиксированные функции, такие как выбор узла, и слишком сложные конфигурации трудно реализовать графически. Можно оставить только один пользовательский каталог конфигурации `confdir` для настройки сложных функций. Для сценариев развертывания сервера достаточно добавить файлы в `confdir` для настройки различных протоколов. |
||||
|
||||
## Запуск с несколькими файлами |
||||
|
||||
::: tip |
||||
В информации о запуске будет указан каждый считываемый файл конфигурации. Убедитесь, что порядок считывания соответствует ожидаемому. Вы можете контролировать порядок, добавляя префиксы с номерами к именам файлов. Например, `01_имя_файла`, `02_имя_файла`, чем больше число, тем позже файл будет обработан. |
||||
::: |
||||
|
||||
```shell |
||||
$ xray run -confdir /etc/xray/confs |
||||
``` |
||||
|
||||
Также можно использовать `Xray.location.confdir` или `Xray_LOCATION_CONFDIR` для указания `confdir`. |
||||
|
||||
Параметр `-confdir` имеет приоритет над переменной среды. Если параметр указывает на допустимый каталог, значение переменной среды игнорируется. |
||||
|
||||
## Правила |
||||
|
||||
### Обычные объекты (`{}`) |
||||
|
||||
Последующие объекты верхнего уровня перезаписывают или дополняют предыдущие. |
||||
|
||||
### Массивы (`[]`) |
||||
|
||||
В конфигурации JSON `inbounds` и `outbounds` имеют структуру массива, для них действуют особые правила: |
||||
|
||||
- Поиск существующего элемента с тем же `tag` для перезаписи. Если элемент не найден: |
||||
- Для `inbounds`: добавляется в конец (порядок элементов в `inbounds` не имеет значения). |
||||
- Для `outbounds`: добавляется в начало (по умолчанию используется первый выход в `outbounds`); но если имя файла содержит `tail` (регистр не имеет значения), элемент добавляется в конец. |
||||
|
||||
## Пример конфигурации |
||||
|
||||
Предположим, что в папке `confs` есть следующие три файла конфигурации: |
||||
|
||||
- 01.json |
||||
|
||||
```json |
||||
{ |
||||
"log": { |
||||
"loglevel": "warning" |
||||
}, |
||||
"inbounds": [ |
||||
{ |
||||
"tag": "socks", |
||||
"protocol": "socks", |
||||
"listen": "0.0.0.0", |
||||
"port": 8888 |
||||
} |
||||
], |
||||
"outbounds": [ |
||||
{ |
||||
"tag": "direct", |
||||
"protocol": "freedom" |
||||
} |
||||
] |
||||
} |
||||
``` |
||||
|
||||
- 02.json |
||||
|
||||
```json |
||||
{ |
||||
"log": { |
||||
"loglevel": "debug" |
||||
}, |
||||
"inbounds": [ |
||||
{ |
||||
"tag": "socks", |
||||
"protocol": "socks", |
||||
"listen": "127.0.0.1", |
||||
"port": 1080 |
||||
} |
||||
], |
||||
"outbounds": [ |
||||
{ |
||||
"tag": "block", |
||||
"protocol": "blackhole" |
||||
} |
||||
] |
||||
} |
||||
``` |
||||
|
||||
- 03_tail.json |
||||
|
||||
```json |
||||
{ |
||||
"outbounds": [ |
||||
{ |
||||
"tag": "direct2", |
||||
"protocol": "freedom" |
||||
} |
||||
] |
||||
} |
||||
``` |
||||
|
||||
Три конфигурации будут объединены следующим образом: |
||||
|
||||
```json |
||||
{ |
||||
"log": { |
||||
"loglevel": "debug" // объект верхнего уровня перезаписывает предыдущий |
||||
}, |
||||
"inbounds": [ |
||||
{ |
||||
"tag": "socks", // перезапись элемента с тем же tag |
||||
"protocol": "socks", |
||||
"listen": "127.0.0.1", |
||||
"port": 1080 |
||||
} |
||||
], |
||||
"outbounds": [ |
||||
{ |
||||
"tag": "block", // добавлено в начало outbounds |
||||
"protocol": "blackhole" |
||||
}, |
||||
{ |
||||
"tag": "direct", |
||||
"protocol": "freedom" |
||||
}, |
||||
{ |
||||
"tag": "direct2", // добавлено в конец, так как имя файла 03_tail.json содержит tail |
||||
"protocol": "freedom" |
||||
} |
||||
] |
||||
} |
||||
``` |
||||
|
||||
::: tip |
||||
Вы можете использовать команду `xray run -confdir=./confs -dump` для просмотра объединенной конфигурации. Однако, поскольку ядро использует формат данных protobuf, формат вывода конфигурации для параметра `-dump` будет отличаться. |
||||
::: |
||||
|
||||
|
@ -0,0 +1,7 @@
|
||||
# Глубокое погружение в XTLS |
||||
|
||||
> **XTLS - это оригинальная технология Xray, которая является ключевым фактором высокой производительности Xray.** |
||||
|
||||
<Badge text="WIP" type="warning"/> |
||||
|
||||
|
@ -0,0 +1,216 @@
|
||||
# Входящие подключения |
||||
|
||||
Входящие подключения используются для приема данных. Доступные протоколы см. в разделе [Входящие протоколы](./inbounds/). |
||||
|
||||
## InboundObject |
||||
|
||||
`InboundObject` соответствует дочернему элементу поля `inbounds` в конфигурационном файле. |
||||
|
||||
```json |
||||
{ |
||||
"inbounds": [ |
||||
{ |
||||
"listen": "127.0.0.1", |
||||
"port": 1080, |
||||
"protocol": "название протокола", |
||||
"settings": {}, |
||||
"streamSettings": {}, |
||||
"tag": "тег", |
||||
"sniffing": { |
||||
"enabled": true, |
||||
"destOverride": ["http", "tls"] |
||||
}, |
||||
"allocate": { |
||||
"strategy": "always", |
||||
"refresh": 5, |
||||
"concurrency": 3 |
||||
} |
||||
} |
||||
] |
||||
} |
||||
``` |
||||
|
||||
> `listen`: address |
||||
|
||||
Адрес прослушивания, IP-адрес или Unix domain socket. |
||||
Значение по умолчанию - `"0.0.0.0"`, что означает прием подключений на всех сетевых интерфейсах. |
||||
|
||||
Можно указать любой доступный в системе IP-адрес. |
||||
|
||||
Поддерживается указание Unix domain socket в формате абсолютного пути, например `"/dev/shm/domain.socket"`. |
||||
Можно добавить `@` в начало пути, чтобы использовать [абстрактный сокет](https://www.man7.org/linux/man-pages/man7/unix.7.html), или `@@`, чтобы использовать абстрактный сокет с заполнением. |
||||
|
||||
При указании Unix domain socket параметры `port` и `allocate` игнорируются. |
||||
В настоящее время поддерживаются протоколы VLESS, VMess, Trojan и типы транспорта TCP, WebSocket, HTTP/2, gRPC. |
||||
|
||||
При указании Unix domain socket можно указать права доступа к сокету, добавив запятую и индикатор прав доступа, например `"/dev/shm/domain.socket,0666"`. |
||||
Это может помочь решить проблемы с правами доступа к сокету, которые возникают по умолчанию. |
||||
|
||||
> `port`: number | "env:variable" | string |
||||
|
||||
Порт. |
||||
Допустимые форматы: |
||||
|
||||
- Целое число: фактический номер порта. |
||||
- Переменная окружения: начинается с `"env:"`, за которым следует имя переменной окружения, например `"env:PORT"`. |
||||
Xray будет анализировать эту переменную окружения как строку. |
||||
- Строка: может быть числом в виде строки, например `"1234"`, или диапазоном портов, например `"5-10"`, что означает порты с 5 по 10 (6 портов). |
||||
Можно использовать запятые для разделения диапазонов, например `11,13,15-17`, что означает порты 11, 13, 15, 16 и 17 (5 портов). |
||||
|
||||
Если указан только один порт, Xray будет прослушивать входящие подключения на этом порту. |
||||
Если указан диапазон портов, то фактическое поведение зависит от настройки `allocate`. |
||||
|
||||
> `protocol`: string |
||||
|
||||
Название протокола подключения. |
||||
Список доступных протоколов см. в разделе "Входящие подключения" в левой части документации. |
||||
|
||||
> `settings`: InboundConfigurationObject |
||||
|
||||
Конкретные настройки зависят от протокола. |
||||
См. описание `InboundConfigurationObject` для каждого протокола. |
||||
|
||||
> `streamSettings`: [StreamSettingsObject](./transport.md#streamsettingsobject) |
||||
|
||||
Тип транспорта (transport) - это способ взаимодействия текущего узла Xray с другими узлами. |
||||
|
||||
> `tag`: string |
||||
|
||||
Тег этого входящего подключения, используемый для идентификации этого подключения в других настройках. |
||||
|
||||
::: danger |
||||
Если это поле не пустое, его значение должно быть **уникальным** среди всех тегов. |
||||
::: |
||||
|
||||
> `sniffing`: [SniffingObject](#sniffingobject) |
||||
|
||||
Обнаружение трафика в основном используется для прозрачного проксирования и других целей. |
||||
Например, типичный сценарий выглядит следующим образом: |
||||
|
||||
1. Устройство пытается получить доступ к abc.com. |
||||
Сначала устройство выполняет DNS-запрос и получает IP-адрес 1.2.3.4 для abc.com. |
||||
Затем устройство пытается установить соединение с 1.2.3.4. |
||||
2. Если обнаружение трафика не настроено, Xray получает запрос на подключение к 1.2.3.4 и не может использовать доменные правила для маршрутизации и разделения трафика. |
||||
3. Если в sniffing включен параметр `enabled`, Xray при обработке трафика этого соединения попытается извлечь доменное имя из данных трафика, т.е. abc.com. |
||||
4. Xray заменит 1.2.3.4 на abc.com. |
||||
Маршрутизация сможет использовать доменные правила для разделения трафика. |
||||
|
||||
Так как запрос теперь направляется на abc.com, можно выполнять больше действий, например, повторное разрешение DNS, помимо разделения трафика по доменным правилам. |
||||
|
||||
Если в sniffing включен параметр `enabled`, Xray также сможет обнаруживать трафик типа bittorrent, а затем можно настроить правила маршрутизации по протоколу, чтобы обрабатывать трафик BT, например, блокировать его на сервере или перенаправлять его на определенный VPS на клиенте. |
||||
|
||||
> `allocate`: [AllocateObject](#allocateobject) |
||||
|
||||
Настройки выделения портов при указании нескольких портов. |
||||
|
||||
### SniffingObject |
||||
|
||||
```json |
||||
{ |
||||
"enabled": true, |
||||
"destOverride": ["http", "tls", "fakedns"], |
||||
"metadataOnly": false, |
||||
"domainsExcluded": [], |
||||
"routeOnly": false |
||||
} |
||||
``` |
||||
|
||||
> `enabled`: true | false |
||||
|
||||
Включить обнаружение трафика. |
||||
|
||||
> `destOverride`: \["http" | "tls" | "quic" | "fakedns" | "fakedns+others" \] |
||||
|
||||
Заменить целевой адрес текущего подключения на указанные типы, если трафик соответствует им. |
||||
|
||||
`["fakedns+others"]` эквивалентно `["http", "tls", "quic", "fakedns"]`. |
||||
Если IP-адрес находится в диапазоне FakeIP, но не найдено соответствие доменному имени, будут использованы `http`, `tls` и `quic`. |
||||
Этот параметр действителен только при `metadataOnly` = `false`. |
||||
|
||||
::: tip |
||||
Xray будет использовать доменные имена, обнаруженные с помощью sniffing, только для маршрутизации. |
||||
Если вы хотите только обнаруживать доменные имена для маршрутизации, но не хотите изменять целевой адрес (например, при использовании Tor Browser изменение целевого адреса может привести к невозможности подключения), добавьте соответствующие протоколы в этот список и включите `routeOnly`. |
||||
::: |
||||
|
||||
> `metadataOnly`: true | false |
||||
|
||||
Если этот параметр включен, для обнаружения целевого адреса будут использоваться только метаданные подключения. |
||||
В этом случае все снифферы, кроме `fakedns`, будут отключены (включая `fakedns+others`). |
||||
|
||||
Если этот параметр отключен, для определения целевого адреса будут использоваться не только метаданные, но и данные. |
||||
В этом случае клиенту необходимо сначала отправить данные, чтобы прокси-сервер установил соединение. |
||||
Это поведение несовместимо с протоколами, которые требуют, чтобы сервер первым отправил сообщение, например, SMTP. |
||||
|
||||
> `domainsExcluded`: [string] <Badge text="WIP" type="warning"/> |
||||
|
||||
Список доменных имен, для которых **не будет** выполняться замена целевого адреса, если они обнаружены с помощью sniffing. |
||||
|
||||
Поддерживаются прямые доменные имена (точное совпадение) или регулярные выражения, начинающиеся с `regexp:`. |
||||
|
||||
::: tip |
||||
Добавление некоторых доменных имен может решить проблемы с push-уведомлениями iOS, умными устройствами Mijia и голосовым чатом в некоторых играх (Rainbow Six Siege).<br> |
||||
Если вам нужно выяснить причину каких-либо проблем, попробуйте отключить `"sniffing"` или включить `"routeOnly"`. |
||||
::: |
||||
|
||||
```json |
||||
"domainsExcluded": [ |
||||
"courier.push.apple.com", // Push-уведомления iOS |
||||
"Mijia Cloud", // Умные устройства Mijia |
||||
"dlg.io.mi.com" |
||||
] |
||||
|
||||
``` |
||||
|
||||
::: warning |
||||
В настоящее время `domainsExcluded` не поддерживает способы сопоставления доменов, аналогичные тем, что используются в маршрутизации. |
||||
Этот параметр может быть изменен в будущем, совместимость между версиями не гарантируется. |
||||
::: |
||||
|
||||
> `routeOnly`: true | false |
||||
|
||||
Использовать обнаруженные доменные имена только для маршрутизации. |
||||
Целевой адрес прокси-сервера остается IP-адресом. |
||||
Значение по умолчанию - `false`. |
||||
|
||||
Этот параметр требует, чтобы `destOverride` был включен. |
||||
|
||||
::: tip |
||||
Если вы уверены, что **проксируемое соединение будет правильно разрешено DNS**, то при использовании `routeOnly` и включенном `destOverride` можно установить стратегию сопоставления маршрутов `domainStrategy` в `AsIs`, чтобы реализовать разделение трафика по доменам и IP-адресам без DNS-разрешения. |
||||
В этом случае при сопоставлении правил на основе IP-адресов будет использоваться исходный IP-адрес домена. |
||||
::: |
||||
|
||||
### AllocateObject |
||||
|
||||
```json |
||||
{ |
||||
"strategy": "always", |
||||
"refresh": 5, |
||||
"concurrency": 3 |
||||
} |
||||
``` |
||||
|
||||
> `strategy`: "always" | "random" |
||||
|
||||
Стратегия выделения портов. |
||||
|
||||
- `"always"` - всегда выделять все указанные порты. |
||||
Xray будет прослушивать все порты, указанные в `port`. |
||||
- `"random"` - случайным образом открывать порты. |
||||
Каждые `refresh` минут Xray будет случайным образом выбирать `concurrency` портов из диапазона, указанного в `port`, и прослушивать их. |
||||
|
||||
> `refresh`: number |
||||
|
||||
Интервал обновления случайных портов в минутах. |
||||
Минимальное значение - `2`, рекомендуемое значение - `5`. |
||||
Этот параметр действителен только при `strategy` = `"random"`. |
||||
|
||||
> `concurrency`: number |
||||
|
||||
Количество случайных портов. |
||||
Минимальное значение - `1`, максимальное значение - треть от диапазона портов, указанного в `port`. |
||||
Рекомендуемое значение - `3`. |
||||
|
||||
|
||||
|
||||
|
||||
|
@ -0,0 +1,77 @@
|
||||
# Dokodemo-Door |
||||
|
||||
Dokodemo door может прослушивать локальный порт и отправлять все данные, поступающие на этот порт, на порт указанного сервера, тем самым реализуя перенаправление портов. |
||||
|
||||
## InboundConfigurationObject |
||||
|
||||
```json |
||||
{ |
||||
"address": "8.8.8.8", |
||||
"port": 53, |
||||
"network": "tcp", |
||||
"timeout": 0, |
||||
"followRedirect": false, |
||||
"userLevel": 0 |
||||
} |
||||
``` |
||||
|
||||
> `address`: address |
||||
|
||||
Перенаправлять трафик на этот адрес. Может быть IP-адресом, например, `"1.2.3.4"`, или доменным именем, например, `"xray.com"`. Тип данных: строка. |
||||
|
||||
Если `followRedirect` (см. ниже) равно `true`, то `address` может быть пустым. |
||||
|
||||
> `port`: number |
||||
|
||||
Перенаправлять трафик на указанный порт целевого адреса, диапазон \[1, 65535\], тип данных: число. Обязательный параметр. |
||||
|
||||
> `network`: "tcp" | "udp" | "tcp,udp" |
||||
|
||||
Поддерживаемые типы сетевых протоколов. Например, если указано `"tcp"`, то будет приниматься только трафик TCP. Значение по умолчанию: `"tcp"`. |
||||
|
||||
> `timeout`: number |
||||
|
||||
Ограничение времени простоя соединения. Измеряется в секундах. Значение по умолчанию: `300`. Если во время обработки соединения в течение `timeout` секунд не передается никаких данных, соединение разрывается. |
||||
|
||||
> `followRedirect`: true | false |
||||
|
||||
Если значение равно `true`, dokodemo-door будет распознавать данные, перенаправленные iptables, и пересылать их на соответствующий целевой адрес. |
||||
|
||||
См. настройку `tproxy` в разделе [Конфигурация транспорта](../transport.md#sockoptobject). |
||||
|
||||
> `userLevel`: number |
||||
|
||||
Уровень пользователя, для соединения будет использоваться [локальная политика](../policy.md#levelpolicyobject), соответствующая этому уровню пользователя. |
||||
|
||||
Значение userLevel соответствует значению `level` в разделе [policy](../policy.md#policyobject). Если не указано, используется значение по умолчанию - 0. |
||||
|
||||
## Использование |
||||
|
||||
У Dokodemo door есть два основных варианта использования: прозрачное проксирование (см. ниже) и перенаправление портов. |
||||
|
||||
Иногда некоторые сервисы не поддерживают прямое проксирование, такое как Socks5, а использование Tun или Tproxy является излишним, и эти сервисы взаимодействуют только с одним IP-адресом и одним портом (например: iperf, сервер Minecraft, конечная точка Wireguard), тогда можно использовать произвольную дверь. |
||||
|
||||
Например, следующая конфигурация (предполагается, что исходящее соединение по умолчанию является допустимым прокси): |
||||
|
||||
```json |
||||
{ |
||||
"listen": "127.0.0.1", |
||||
"port": 25565, |
||||
"protocol": "dokodemo-door", |
||||
"settings": { |
||||
"address": "mc.hypixel.net", |
||||
"port": 25565, |
||||
"network": "tcp", |
||||
"timeout": 0, |
||||
"followRedirect": false, |
||||
"userLevel": 0 |
||||
}, |
||||
"tag": "mc" |
||||
} |
||||
``` |
||||
|
||||
В этом случае ядро будет прослушивать 127.0.0.1:25565 и перенаправлять трафик через исходящее соединение по умолчанию на mc.hypixel.net:25565 (сервер MC). При подключении клиента Minecraft к 127.0.0.1:25565 будет осуществлено подключение к серверу Hypixel через прокси. |
||||
|
||||
## Пример настройки прозрачного прокси |
||||
|
||||
Эту часть см. в разделе [Руководство по настройке прозрачного прокси (TProxy)](../../document/level-2/tproxy). |
@ -0,0 +1,81 @@
|
||||
# HTTP |
||||
|
||||
Протокол HTTP. |
||||
|
||||
::: danger |
||||
**Протокол HTTP не обеспечивает шифрования передачи данных, поэтому он не подходит для передачи данных через общедоступные сети и более уязвим для использования в качестве ботнета.** |
||||
::: |
||||
|
||||
Использование входящих соединений `http` более целесообразно в локальной сети или локальной среде, где он может быть использован для прослушивания входящих подключений и предоставления локальных сервисов другим программам. |
||||
|
||||
::: tip СОВЕТ 1 |
||||
`http proxy` может проксировать только протокол tcp, протоколы семейства udp не поддерживаются. |
||||
::: |
||||
|
||||
::: tip СОВЕТ 2 |
||||
Используйте следующие переменные среды в Linux, чтобы использовать глобальный HTTP-прокси в текущем сеансе (эта настройка поддерживается многими программами, но не всеми). |
||||
|
||||
- `export http_proxy=http://127.0.0.1:8080/` (замените адрес на адрес вашего настроенного входящего HTTP-прокси) |
||||
- `export https_proxy=$http_proxy` |
||||
::: |
||||
|
||||
## InboundConfigurationObject |
||||
|
||||
```json |
||||
{ |
||||
"timeout": 0, |
||||
"accounts": [ |
||||
{ |
||||
"user": "my-username", |
||||
"pass": "my-password" |
||||
} |
||||
], |
||||
"allowTransparent": false, |
||||
"userLevel": 0 |
||||
} |
||||
``` |
||||
|
||||
> `timeout`: number |
||||
|
||||
Ограничение времени простоя соединения. Измеряется в секундах. Значение по умолчанию: `300`, значение 0 означает отсутствие ограничения времени. |
||||
|
||||
Если в течение `timeout` секунд во время обработки соединения не было передано никаких данных, соединение разрывается. |
||||
|
||||
> `accounts`: \[[AccountObject](#accountobject)\] |
||||
|
||||
Массив, каждый элемент которого представляет собой учетную запись пользователя. Значение по умолчанию: пустой массив. |
||||
|
||||
Если `accounts` не пуст, HTTP-прокси будет выполнять проверку подлинности Basic Authentication для входящих соединений. |
||||
|
||||
> `allowTransparent`: true | false |
||||
|
||||
Если установлено значение `true`, будут перенаправляться все HTTP-запросы, а не только прокси-запросы. |
||||
|
||||
::: tip |
||||
Неправильная настройка этой опции может привести к бесконечному циклу. |
||||
::: |
||||
|
||||
> `userLevel`: number |
||||
|
||||
Уровень пользователя, для подключения будет использоваться [локальная политика](../policy.md#levelpolicyobject), соответствующая этому уровню пользователя. |
||||
|
||||
Значение userLevel соответствует значению `level` в разделе [policy](../policy.md#policyobject). Если не указано, используется значение по умолчанию - 0. |
||||
|
||||
### AccountObject |
||||
|
||||
```json |
||||
{ |
||||
"user": "my-username", |
||||
"pass": "my-password" |
||||
} |
||||
``` |
||||
|
||||
> `user`: string |
||||
|
||||
Имя пользователя, тип данных: строка. Обязательный параметр. |
||||
|
||||
> `pass`: string |
||||
|
||||
Пароль, тип данных: строка. Обязательный параметр. |
||||
|
||||
|
@ -0,0 +1,110 @@
|
||||
# Shadowsocks |
||||
|
||||
Протокол [Shadowsocks](https://ru.wikipedia.org/wiki/Shadowsocks), совместимый с большинством других реализаций. |
||||
|
||||
Текущая совместимость: |
||||
|
||||
- Поддерживает пересылку пакетов TCP и UDP, при этом UDP можно выборочно отключить; |
||||
- Рекомендуемые методы шифрования: |
||||
- 2022-blake3-aes-128-gcm |
||||
- 2022-blake3-aes-256-gcm |
||||
- 2022-blake3-chacha20-poly1305 |
||||
- Другие методы шифрования: |
||||
- aes-256-gcm |
||||
- aes-128-gcm |
||||
- chacha20-poly1305 или chacha20-ietf-poly1305 |
||||
- xchacha20-poly1305 или xchacha20-ietf-poly1305 |
||||
- none или plain |
||||
|
||||
Новый формат протокола Shadowsocks 2022 повышает производительность и обеспечивает полную защиту от повторов, решая следующие проблемы безопасности старого протокола: |
||||
|
||||
- [Серьезные уязвимости в шифровании Shadowsocks AEAD, которые не могут гарантировать целостность содержимого](https://github.com/shadowsocks/shadowsocks-org/issues/183) |
||||
- Возрастающий коэффициент ложных срабатываний исходного фильтра повторов TCP с течением времени |
||||
- Отсутствие защиты от повторов UDP |
||||
- Поведение TCP, которое можно использовать для активного зондирования |
||||
|
||||
::: danger |
||||
При использовании метода шифрования "none" трафик передается в открытом виде. В целях безопасности не используйте этот метод в общедоступных сетях. |
||||
::: |
||||
|
||||
## InboundConfigurationObject |
||||
|
||||
```json |
||||
{ |
||||
"settings": { |
||||
"network": "tcp,udp", |
||||
"method": "aes-256-gcm", |
||||
"password": "114514", |
||||
"level": 0, |
||||
"email": "love@xray.com", |
||||
"clients": [ |
||||
{ |
||||
"password": "1919810", |
||||
"method": "aes-128-gcm" |
||||
} |
||||
] |
||||
} |
||||
} |
||||
``` |
||||
|
||||
> `network`: "tcp" | "udp" | "tcp,udp" |
||||
|
||||
Поддерживаемые типы сетевых протоколов. Например, если указано `"tcp"`, будет приниматься только трафик TCP. Значение по умолчанию: `"tcp"`. |
||||
|
||||
> `method`: string |
||||
|
||||
Метод шифрования, доступные варианты см. выше. |
||||
|
||||
> `password`: string |
||||
|
||||
Обязательный параметр. |
||||
|
||||
- Shadowsocks 2022 |
||||
|
||||
Используется предварительный общий ключ, аналогичный WireGuard, в качестве пароля. |
||||
|
||||
Используйте команду `openssl rand -base64 <длина>` для генерации ключа, совместимого с shadowsocks-rust, длина зависит от используемого метода шифрования. |
||||
|
||||
| Метод шифрования | Длина ключа | |
||||
| ------------------------------------ | ----------: | |
||||
| 2022-blake3-aes-128-gcm | 16 | |
||||
| 2022-blake3-aes-256-gcm | 32 | |
||||
| 2022-blake3-chacha20-poly1305 | 32 | |
||||
|
||||
В реализации Go всегда работают 32-битные ключи. |
||||
|
||||
- Другие методы шифрования |
||||
|
||||
Любая строка. Длина пароля не ограничена, но короткие пароли более уязвимы для взлома, рекомендуется использовать пароли длиной 16 символов или более. |
||||
|
||||
> `level`: number |
||||
|
||||
Уровень пользователя, для соединения будет использоваться [локальная политика](../policy.md#levelpolicyobject), соответствующая этому уровню пользователя. |
||||
Значение `level` соответствует значению `level` в разделе [policy](../policy.md#levelpolicyobject). Если не указано, используется значение по умолчанию - 0. |
||||
|
||||
> `email`: string |
||||
|
||||
Адрес электронной почты пользователя, используется для разделения трафика разных пользователей (журналы, статистика). |
||||
|
||||
## ClientObject |
||||
|
||||
```json |
||||
{ |
||||
"password": "1919810", |
||||
"method": "aes-256-gcm", |
||||
"level": 0, |
||||
"email": "love@xray.com" |
||||
} |
||||
``` |
||||
|
||||
Наличие этой опции означает включение многопользовательского режима. |
||||
|
||||
Если `method` в InboundConfigurationObject не является опцией SS2022, можно указать `"method"` для каждого пользователя. (`"method"` также поддерживает только опции, не относящиеся к SS2022) и `"password"` (при этом `"password"`, установленный в InboundConfigurationObject, будет игнорироваться). |
||||
|
||||
Если `method` в InboundConfigurationObject является опцией SS2022, то из соображений безопасности больше не поддерживается установка `"method"` для отдельных пользователей, используется единый `"method"`, указанный в InboundConfigurationObject. |
||||
|
||||
Обратите внимание, что SS2022, в отличие от старого SS, не игнорирует `"password"` верхнего уровня, правильный способ записи пароля клиента: `ServerPassword:UserPassword`. Например: `"password": "114514:1919810"` |
||||
|
||||
Остальные опции имеют то же значение, что и в InboundConfigurationObject. |
||||
|
||||
|
@ -0,0 +1,77 @@
|
||||
# Socks |
||||
|
||||
Стандартная реализация протокола Socks, совместимая с [Socks 4](http://ftp.icm.edu.pl/packages/socks/socks4/SOCKS4.protocol), [Socks 4a](https://ftp.icm.edu.pl/packages/socks/socks4/SOCKS4A.protocol) и Socks 5. |
||||
|
||||
::: danger |
||||
**Протокол Socks не обеспечивает шифрование передачи данных, поэтому он не подходит для передачи данных через общедоступные сети.** |
||||
::: |
||||
|
||||
Использование входящих соединений `SOCKS` более целесообразно в локальной сети или локальной среде, где он может быть использован для прослушивания входящих подключений и предоставления локальных сервисов другим программам. |
||||
|
||||
## InboundConfigurationObject |
||||
|
||||
```json |
||||
{ |
||||
"auth": "noauth", |
||||
"accounts": [ |
||||
{ |
||||
"user": "my-username", |
||||
"pass": "my-password" |
||||
} |
||||
], |
||||
"udp": false, |
||||
"ip": "127.0.0.1", |
||||
"userLevel": 0 |
||||
} |
||||
``` |
||||
|
||||
> `auth`: "noauth" | "password" |
||||
|
||||
Метод аутентификации протокола Socks, поддерживаются режимы `"noauth"` (анонимный) и `"password"` (с использованием пароля пользователя). |
||||
|
||||
Значение по умолчанию: `"noauth"`. |
||||
|
||||
> `accounts`: \[ [AccountObject](#accountobject) \] |
||||
|
||||
Массив, каждый элемент которого представляет собой учетную запись пользователя. |
||||
|
||||
Этот параметр действителен только если `auth` установлен в значение `password`. |
||||
|
||||
Значение по умолчанию: пустой массив. |
||||
|
||||
> `udp`: true | false |
||||
|
||||
Включает или отключает поддержку протокола UDP. |
||||
|
||||
Значение по умолчанию: `false`. |
||||
|
||||
> `ip`: address |
||||
|
||||
Если UDP включен, Xray должен знать IP-адрес локального хоста. |
||||
|
||||
Значение по умолчанию: `"127.0.0.1"`. |
||||
|
||||
> `userLevel`: number |
||||
|
||||
Уровень пользователя, для соединения будет использоваться [локальная политика](../policy.md#levelpolicyobject), соответствующая этому уровню пользователя. |
||||
|
||||
Значение userLevel соответствует значению `level` в разделе [policy](../policy.md#policyobject). Если не указано, используется значение по умолчанию - 0. |
||||
|
||||
### AccountObject |
||||
|
||||
```json |
||||
{ |
||||
"user": "my-username", |
||||
"pass": "my-password" |
||||
} |
||||
``` |
||||
|
||||
> `user`: string |
||||
|
||||
Имя пользователя, тип данных: строка. Обязательный параметр. |
||||
|
||||
> `pass`: string |
||||
|
||||
Пароль, тип данных: строка. Обязательный параметр. |
||||
|
||||
|
@ -0,0 +1,74 @@
|
||||
# Trojan |
||||
|
||||
Протокол [Trojan](https://trojan-gfw.github.io/trojan/protocol). |
||||
|
||||
::: danger |
||||
Trojan предназначен для работы в правильно настроенном зашифрованном TLS-туннеле. |
||||
::: |
||||
|
||||
## InboundConfigurationObject |
||||
|
||||
```json |
||||
{ |
||||
"clients": [ |
||||
{ |
||||
"password": "password", |
||||
"email": "love@xray.com", |
||||
"level": 0 |
||||
} |
||||
], |
||||
"fallbacks": [ |
||||
{ |
||||
"dest": 80 |
||||
} |
||||
] |
||||
} |
||||
``` |
||||
|
||||
> `clients`: \[ [ClientObject](#clientobject) \] |
||||
|
||||
Массив, представляющий группу пользователей, одобренных сервером. |
||||
|
||||
Каждый элемент в массиве - это пользователь [ClientObject](#clientobject). |
||||
|
||||
> `fallbacks`: \[ [FallbackObject](../features/fallback.md) \] |
||||
|
||||
Массив, содержащий ряд конфигураций fallback-маршрутизации (необязательно). |
||||
Подробную информацию о настройке fallbacks см. в разделе [FallbackObject](../features/fallback.md#fallbacks-конфигурация). |
||||
|
||||
::: tip |
||||
Trojan в Xray имеет полную поддержку fallbacks, конфигурация идентична. |
||||
Условия запуска fallback также аналогичны VLESS: длина первого пакета < 58 или 57-й байт не равен `\r` (поскольку Trojan не имеет версии протокола) или ошибка аутентификации. |
||||
::: |
||||
|
||||
### ClientObject |
||||
|
||||
```json |
||||
{ |
||||
"password": "password", |
||||
"email": "love@xray.com", |
||||
"level": 0 |
||||
} |
||||
``` |
||||
|
||||
> `password`: string |
||||
|
||||
Обязательный параметр, любая строка. |
||||
|
||||
> `email`: string |
||||
|
||||
Адрес электронной почты, необязательный параметр, используется для идентификации пользователя. |
||||
|
||||
::: danger |
||||
Если существует несколько объектов ClientObject, убедитесь, что адреса электронной почты не дублируются. |
||||
::: |
||||
|
||||
> `level`: number |
||||
|
||||
Уровень пользователя, для соединения будет использоваться [локальная политика](../policy.md#levelpolicyobject), соответствующая этому уровню пользователя. |
||||
|
||||
Значение userLevel соответствует значению `level` в разделе [policy](../policy.md#policyobject). Если не указано, используется значение по умолчанию - 0. |
||||
|
||||
|
||||
|
||||
|
@ -0,0 +1,97 @@
|
||||
# VLESS |
||||
|
||||
::: danger |
||||
VLESS не предусматривает встроенного шифрования, поэтому обязательным условием для его использования является наличие надежного канала, такого как TLS или REALITY. |
||||
::: |
||||
|
||||
VLESS - это легкий транспортный протокол без сохранения состояния, который разделен на входящую и исходящую части и может служить мостом между клиентом и сервером Xray. |
||||
|
||||
В отличие от [VMess](./vmess.md), VLESS не зависит от системного времени, аутентификация также осуществляется с помощью UUID. |
||||
|
||||
## InboundConfigurationObject |
||||
|
||||
```json |
||||
{ |
||||
"clients": [ |
||||
{ |
||||
"id": "5783a3e7-e373-51cd-8642-c83782b807c5", |
||||
"level": 0, |
||||
"email": "love@xray.com", |
||||
"flow": "xtls-rprx-vision" |
||||
} |
||||
], |
||||
"decryption": "none", |
||||
"fallbacks": [ |
||||
{ |
||||
"dest": 80 |
||||
} |
||||
] |
||||
} |
||||
``` |
||||
|
||||
> `clients`: \[ [ClientObject](#clientobject) \] |
||||
|
||||
Массив, представляющий группу пользователей, одобренных сервером. |
||||
|
||||
Каждый элемент является пользователем [ClientObject](#clientobject). |
||||
|
||||
> `decryption`: "none" |
||||
|
||||
На данный момент необходимо указать `"none"`, значение не может быть пустым. |
||||
Если значение decryption установлено неверно, при использовании Xray или -test будет выдано сообщение об ошибке. |
||||
|
||||
Обратите внимание, что здесь используется decryption, на том же уровне, что и clients. |
||||
Расположение decryption и encryption в протоколе vmess отличается, потому что, если используется дополнительный уровень шифрования, сервер должен сначала расшифровать данные, чтобы узнать, какой это пользователь. |
||||
|
||||
> `fallbacks`: \[ [FallbackObject](../features/fallback.md) \] |
||||
|
||||
Массив, содержащий ряд конфигураций fallback-маршрутизации (необязательно). |
||||
Подробную информацию о настройке fallbacks см. в разделе [FallbackObject](../features/fallback.md#fallbacks-конфигурация). |
||||
|
||||
### ClientObject |
||||
|
||||
```json |
||||
{ |
||||
"id": "5783a3e7-e373-51cd-8642-c83782b807c5", |
||||
"level": 0, |
||||
"email": "love@xray.com", |
||||
"flow": "xtls-rprx-vision" |
||||
} |
||||
``` |
||||
|
||||
> `id`: string |
||||
|
||||
Идентификатор пользователя VLESS, может быть любой строкой длиной менее 30 байт или допустимым UUID. |
||||
Пользовательская строка и ее UUID-отображение эквивалентны, это означает, что вы можете использовать следующие способы записи id в файле конфигурации для идентификации одного и того же пользователя: |
||||
|
||||
- Напишите `"id": "Я люблю арбуз учителя 1314"`, |
||||
- Или напишите `"id": "5783a3e7-e373-51cd-8642-c83782b807c5"` (этот UUID является UUID-отображением строки "Я люблю арбуз учителя 1314") |
||||
|
||||
Стандарт сопоставления описан в [VLESS UUID Mapping Standard: Mapping Custom Strings to a UUIDv5](https://github.com/XTLS/Xray-core/issues/158). |
||||
|
||||
Вы можете использовать команду `xray uuid -i "Пользовательская строка"` для генерации UUID, соответствующего пользовательской строке. |
||||
|
||||
> Вы также можете использовать команду `xray uuid` для генерации случайного UUID. |
||||
|
||||
> `level`: number |
||||
|
||||
Уровень пользователя, для подключения будет использоваться [локальная политика](../policy.md#levelpolicyobject), соответствующая этому уровню пользователя. |
||||
|
||||
Значение level соответствует значению `level` в разделе [policy](../policy.md#policyobject). Если не указано, используется значение по умолчанию - 0. |
||||
|
||||
> `email`: string |
||||
|
||||
Адрес электронной почты пользователя, используется для разделения трафика разных пользователей (отображается в журналах, статистике). |
||||
|
||||
> `flow`: string |
||||
|
||||
Режим управления потоком, используется для выбора алгоритма XTLS. |
||||
|
||||
В настоящее время для входящего протокола доступны следующие режимы управления потоком: |
||||
|
||||
- Отсутствует `flow` или пустая строка: используется обычный TLS-прокси |
||||
- `xtls-rprx-vision`: используется новый режим XTLS, включает случайное заполнение внутреннего рукопожатия |
||||
|
||||
Кроме того, в настоящее время XTLS поддерживает только три транспортных протокола: TCP, mKCP и DomainSocket. |
||||
|
||||
|
@ -0,0 +1,107 @@
|
||||
# VMess |
||||
|
||||
[VMess](../../development/protocols/vmess.md) - это зашифрованный транспортный протокол, который обычно используется в качестве моста между клиентами и серверами Xray. |
||||
|
||||
::: danger |
||||
VMess полагается на системное время. Убедитесь, что системное время UTC, используемое Xray, находится в пределах 120 секунд от фактического времени, независимо от часового пояса. В системах Linux вы можете установить службу `ntp` для автоматической синхронизации системного времени. |
||||
::: |
||||
|
||||
## InboundConfigurationObject |
||||
|
||||
```json |
||||
{ |
||||
"clients": [ |
||||
{ |
||||
"id": "5783a3e7-e373-51cd-8642-c83782b807c5", |
||||
"level": 0, |
||||
"email": "love@xray.com" |
||||
} |
||||
], |
||||
"default": { |
||||
"level": 0 |
||||
}, |
||||
"detour": { |
||||
"to": "tag_to_detour" |
||||
} |
||||
} |
||||
``` |
||||
|
||||
> `clients`: \[ [ClientObject](#clientobject) \] |
||||
|
||||
Массив, представляющий группу пользователей, одобренных сервером. |
||||
|
||||
Каждый элемент в массиве - это пользователь [ClientObject](#clientobject). |
||||
|
||||
Когда эта конфигурация используется для динамических портов, Xray будет автоматически создавать пользователей. |
||||
|
||||
> `detour`: [DetourObject](#detourobject) |
||||
|
||||
Указывает, что для соответствующего исходящего протокола следует использовать другой сервер. |
||||
|
||||
> `default`: [DefaultObject](#defaultobject) |
||||
|
||||
Необязательно. Конфигурация по умолчанию для клиентов. Действует только при использовании с `detour`. |
||||
|
||||
### ClientObject |
||||
|
||||
```json |
||||
{ |
||||
"id": "5783a3e7-e373-51cd-8642-c83782b807c5", |
||||
"level": 0, |
||||
"email": "love@xray.com" |
||||
} |
||||
``` |
||||
|
||||
> `id`: string |
||||
|
||||
Идентификатор пользователя VMess. Это может быть любая строка длиной менее 30 байт или допустимый UUID. |
||||
|
||||
::: tip |
||||
Пользовательские строки и соответствующие им UUID эквивалентны, что означает, что вы можете использовать любой из следующих вариантов в файле конфигурации для идентификации одного и того же пользователя: |
||||
|
||||
- `"id": "Я люблю арбуз учителя 1314"` |
||||
- `"id": "5783a3e7-e373-51cd-8642-c83782b807c5"` (этот UUID является сопоставлением строки "Я люблю арбуз учителя 1314") |
||||
|
||||
Стандарт сопоставления описан в [VLESS UUID Mapping Standard: Mapping a Custom String to a UUIDv5](https://github.com/XTLS/Xray-core/issues/158). |
||||
|
||||
Вы можете использовать команду `xray uuid -i "пользовательская строка"` для создания UUID, соответствующего пользовательской строке. |
||||
|
||||
Вы также можете использовать команду `xray uuid` для создания случайного UUID. ::: |
||||
|
||||
> `level`: number |
||||
|
||||
Уровень пользователя, который будет использоваться соединением для определения соответствующей [локальной политики](../policy.md#levelpolicyobject). |
||||
|
||||
Значение `level` соответствует значению `level` в [policy](../policy.md#policyobject). Если не указано, используется значение по умолчанию - 0. |
||||
|
||||
> `email`: string |
||||
|
||||
Адрес электронной почты пользователя, используемый для разделения трафика от разных пользователей. |
||||
|
||||
### DetourObject |
||||
|
||||
```json |
||||
{ |
||||
"to": "tag_to_detour" |
||||
} |
||||
``` |
||||
|
||||
> `to`: string |
||||
|
||||
`Тег` входящего соединения, определяющий входящее соединение, использующее протокол VMess. |
||||
|
||||
### DefaultObject |
||||
|
||||
```json |
||||
{ |
||||
"level": 0 |
||||
} |
||||
``` |
||||
|
||||
> `level`: number |
||||
|
||||
Уровень пользователя, который будет использоваться соединением для определения соответствующей [локальной политики](../policy.md#levelpolicyobject). |
||||
|
||||
Значение `level` соответствует значению `level` в [policy](../policy.md#policyobject). Если не указано, используется значение по умолчанию - 0. |
||||
|
||||
|
@ -0,0 +1,55 @@
|
||||
# Настройка журнала |
||||
|
||||
Настройка журнала управляет тем, как Xray выводит журналы. |
||||
|
||||
Xray имеет два типа журналов: журнал доступа и журнал ошибок. |
||||
Вы можете настроить способ вывода каждого типа журнала отдельно. |
||||
|
||||
## LogObject |
||||
|
||||
LogObject соответствует полю `log` в конфигурационном файле. |
||||
|
||||
```json |
||||
{ |
||||
"log": { |
||||
"access": "путь к файлу", |
||||
"error": "путь к файлу", |
||||
"loglevel": "warning", |
||||
"dnsLog": false |
||||
} |
||||
} |
||||
``` |
||||
|
||||
> `access`: string |
||||
|
||||
Путь к файлу журнала доступа. |
||||
Значение должно быть допустимым путем к файлу, например `"/var/log/Xray/access.log"` (Linux) или `"C:\\Temp\\Xray\\_access.log"` (Windows). |
||||
Если этот параметр не указан или имеет пустое значение, журнал выводится в stdout. |
||||
|
||||
- Специальное значение `none` отключает журнал доступа. |
||||
|
||||
> `error`: string |
||||
|
||||
Путь к файлу журнала ошибок. |
||||
Значение должно быть допустимым путем к файлу, например `"/var/log/Xray/error.log"` (Linux) или `"C:\\Temp\\Xray\\_error.log"` (Windows). |
||||
Если этот параметр не указан или имеет пустое значение, журнал выводится в stdout. |
||||
|
||||
- Специальное значение `none` отключает журнал ошибок. |
||||
|
||||
> `loglevel`: "debug" | "info" | "warning" | "error" | "none" |
||||
|
||||
Уровень журнала ошибок, указывающий, какую информацию следует записывать в журнал ошибок. |
||||
Значение по умолчанию - `"warning"`. |
||||
|
||||
- `"debug"`: информация, используемая при отладке программы. |
||||
Включает всю информацию уровня `"info"`. |
||||
- `"info"`: информация о состоянии во время выполнения и т.д., не влияющая на нормальную работу. |
||||
Включает всю информацию уровня `"warning"`. |
||||
- `"warning"`: информация, выводимая при возникновении проблем, не влияющих на нормальную работу, но которые могут повлиять на работу пользователя. |
||||
Включает всю информацию уровня `"error"`. |
||||
- `"error"`: Xray столкнулся с проблемой, которая не позволяет ему работать нормально, и ее необходимо немедленно решить. |
||||
- `"none"`: не записывать ничего. |
||||
|
||||
> `dnsLog`: bool |
||||
|
||||
Включить ведение журнала DNS-запросов, например: `DOH//doh.server got answer: domain.com -> [ip1, ip2] 2.333ms`. |
@ -0,0 +1,280 @@
|
||||
# Метрики |
||||
|
||||
Более простой (и, надеюсь, лучший) способ экспорта статистики. |
||||
|
||||
## Связанные настройки |
||||
|
||||
Можно добавить входящее подключение `metrics` в раздел `inbounds`: |
||||
|
||||
```json |
||||
"inbounds": [ |
||||
{ |
||||
"listen": "127.0.0.1", |
||||
"port": 11111, |
||||
"protocol": "dokodemo-door", |
||||
"settings": { |
||||
"address": "127.0.0.1" |
||||
}, |
||||
"tag": "metrics_in" |
||||
} |
||||
] |
||||
``` |
||||
|
||||
Добавьте правило маршрутизации для входящего подключения `metrics` в раздел `routing`: |
||||
|
||||
```json |
||||
"routing": { |
||||
"rules": [ |
||||
{ |
||||
"type": "field", |
||||
"inboundTag": [ |
||||
"metrics_in" |
||||
], |
||||
"outboundTag": "metrics_out" |
||||
} |
||||
] |
||||
} |
||||
``` |
||||
|
||||
Добавьте `metrics` в основные настройки: |
||||
|
||||
```json |
||||
"metrics": { |
||||
"tag": "metrics_out" |
||||
} |
||||
``` |
||||
|
||||
## Использование |
||||
|
||||
### pprof |
||||
|
||||
Откройте `http://127.0.0.1:11111/debug/pprof/` или используйте утилиту `go tool pprof`, чтобы начать профилирование или просмотреть запущенные горутины. |
||||
|
||||
### expvars |
||||
|
||||
Откройте `http://127.0.0.1:11111/debug/vars`. |
||||
|
||||
Экспортируемые переменные включают: |
||||
* `stats` - статистика по входящим, исходящим подключениям и пользователям. |
||||
* `observatory` - результаты мониторинга. |
||||
|
||||
Например, с помощью [luci-app-xray](https://github.com/yichya/luci-app-xray) вы, скорее всего, получите результат, подобный этому (стандартные переменные expvar, такие как `cmdline` и `memstats`, опущены): |
||||
|
||||
<details><summary>Показать</summary><br> |
||||
|
||||
```json |
||||
{ |
||||
"observatory": { |
||||
"tcp_outbound": { |
||||
"alive": true, |
||||
"delay": 782, |
||||
"outbound_tag": "tcp_outbound", |
||||
"last_seen_time": 1648477189, |
||||
"last_try_time": 1648477189 |
||||
}, |
||||
"udp_outbound": { |
||||
"alive": true, |
||||
"delay": 779, |
||||
"outbound_tag": "udp_outbound", |
||||
"last_seen_time": 1648477191, |
||||
"last_try_time": 1648477191 |
||||
} |
||||
}, |
||||
"stats": { |
||||
"inbound": { |
||||
"api": { |
||||
"downlink": 0, |
||||
"uplink": 0 |
||||
}, |
||||
"dns_server_inbound_5300": { |
||||
"downlink": 14286, |
||||
"uplink": 5857 |
||||
}, |
||||
"http_inbound": { |
||||
"downlink": 74460, |
||||
"uplink": 10231 |
||||
}, |
||||
"https_inbound": { |
||||
"downlink": 0, |
||||
"uplink": 0 |
||||
}, |
||||
"metrics": { |
||||
"downlink": 6327, |
||||
"uplink": 1347 |
||||
}, |
||||
"socks_inbound": { |
||||
"downlink": 19925615, |
||||
"uplink": 5512 |
||||
}, |
||||
"tproxy_tcp_inbound": { |
||||
"downlink": 4739161, |
||||
"uplink": 1568869 |
||||
}, |
||||
"tproxy_udp_inbound": { |
||||
"downlink": 0, |
||||
"uplink": 2608142 |
||||
} |
||||
}, |
||||
"outbound": { |
||||
"blackhole_outbound": { |
||||
"downlink": 0, |
||||
"uplink": 0 |
||||
}, |
||||
"direct": { |
||||
"downlink": 97714548, |
||||
"uplink": 3234617 |
||||
}, |
||||
"dns_server_outbound": { |
||||
"downlink": 7116, |
||||
"uplink": 2229 |
||||
}, |
||||
"manual_tproxy_outbound_tcp_1": { |
||||
"downlink": 0, |
||||
"uplink": 0 |
||||
}, |
||||
"manual_tproxy_outbound_udp_1": { |
||||
"downlink": 0, |
||||
"uplink": 0 |
||||
}, |
||||
"tcp_outbound": { |
||||
"downlink": 23873238, |
||||
"uplink": 1049595 |
||||
}, |
||||
"udp_outbound": { |
||||
"downlink": 639282, |
||||
"uplink": 74634 |
||||
} |
||||
}, |
||||
"user": {} |
||||
} |
||||
} |
||||
``` |
||||
</details> |
||||
|
||||
Чтобы лучше визуализировать эти данные, можно использовать [Netdata](https://github.com/netdata/netdata) (с плагином python.d): |
||||
|
||||
1. Отредактируйте соответствующий файл конфигурации (`sudo /etc/netdata/edit-config python.d/go_expvar.conf`). |
||||
2. Используйте следующий файл конфигурации в качестве примера: |
||||
|
||||
<details><summary>Показать</summary><br> |
||||
|
||||
``` |
||||
xray: |
||||
name: 'xray' |
||||
update_every: 2 |
||||
url: 'http://127.0.0.1:11111/debug/vars' |
||||
collect_memstats: false |
||||
extra_charts: |
||||
- id: 'inbounds' |
||||
options: |
||||
name: 'inbounds' |
||||
title: 'Xray System Inbounds' |
||||
units: bytes |
||||
family: xray |
||||
context: xray.inbounds |
||||
chart_type: line |
||||
lines: |
||||
- expvar_key: stats.inbound.tproxy_tcp_inbound.downlink |
||||
id: 'tcp.downlink' |
||||
algorithm: incremental |
||||
expvar_type: int |
||||
- expvar_key: stats.inbound.tproxy_udp_inbound.downlink |
||||
id: 'udp.downlink' |
||||
algorithm: incremental |
||||
expvar_type: int |
||||
- expvar_key: stats.inbound.http_inbound.downlink |
||||
id: 'http.downlink' |
||||
algorithm: incremental |
||||
expvar_type: int |
||||
- expvar_key: stats.inbound.https_inbound.downlink |
||||
id: 'https.downlink' |
||||
algorithm: incremental |
||||
expvar_type: int |
||||
- expvar_key: stats.inbound.socks_inbound.downlink |
||||
id: 'socks.downlink' |
||||
algorithm: incremental |
||||
expvar_type: int |
||||
- expvar_key: stats.inbound.tproxy_tcp_inbound.uplink |
||||
id: 'tcp.uplink' |
||||
algorithm: incremental |
||||
expvar_type: int |
||||
- expvar_key: stats.inbound.tproxy_udp_inbound.uplink |
||||
id: 'udp.uplink' |
||||
algorithm: incremental |
||||
expvar_type: int |
||||
- expvar_key: stats.inbound.http_inbound.uplink |
||||
id: 'http.uplink' |
||||
algorithm: incremental |
||||
expvar_type: int |
||||
- expvar_key: stats.inbound.https_inbound.uplink |
||||
id: 'https.uplink' |
||||
algorithm: incremental |
||||
expvar_type: int |
||||
- expvar_key: stats.inbound.socks_inbound.uplink |
||||
id: 'socks.uplink' |
||||
algorithm: incremental |
||||
expvar_type: int |
||||
- id: 'outbounds' |
||||
options: |
||||
name: 'outbounds' |
||||
title: 'Xray System Outbounds' |
||||
units: bytes |
||||
family: xray |
||||
context: xray.outbounds |
||||
chart_type: line |
||||
lines: |
||||
- expvar_key: stats.outbound.tcp_outbound.downlink |
||||
id: 'tcp.downlink' |
||||
algorithm: incremental |
||||
expvar_type: int |
||||
- expvar_key: stats.outbound.udp_outbound.downlink |
||||
id: 'udp.downlink' |
||||
algorithm: incremental |
||||
expvar_type: int |
||||
- expvar_key: stats.outbound.direct.downlink |
||||
id: 'direct.downlink' |
||||
algorithm: incremental |
||||
expvar_type: int |
||||
- expvar_key: stats.outbound.tcp_outbound.uplink |
||||
id: 'tcp.uplink' |
||||
algorithm: incremental |
||||
expvar_type: int |
||||
- expvar_key: stats.outbound.udp_outbound.uplink |
||||
id: 'udp.uplink' |
||||
algorithm: incremental |
||||
expvar_type: int |
||||
- expvar_key: stats.outbound.direct.uplink |
||||
id: 'direct.uplink' |
||||
algorithm: incremental |
||||
expvar_type: int |
||||
- id: 'observatory' |
||||
options: |
||||
name: 'observatory' |
||||
title: 'Xray Observatory Metrics' |
||||
units: milliseconds |
||||
family: xray |
||||
context: xray.observatory |
||||
chart_type: line |
||||
lines: |
||||
- expvar_key: observatory.tcp_outbound.delay |
||||
id: tcp |
||||
expvar_type: int |
||||
- expvar_key: observatory.udp_outbound.delay |
||||
id: udp |
||||
expvar_type: int |
||||
``` |
||||
</details> |
||||
|
||||
И вы получите красивый график, подобный этому: |
||||
|
||||
![160428235-2988bf69-5d6c-41ec-8267-1bd512508aa8](https://github.com/chika0801/Xray-docs-next/assets/88967758/455e88ce-ced2-4593-a9fa-425bb293215b) |
||||
|
||||
### Дополнительно |
||||
|
||||
Возможно, лучше использовать пустой объект `stats` в конфигурационном файле, чем добавлять `metrics`? |
||||
|
||||
**Изменение:** удалены настройки, связанные с Prometheus, и добавлено использование expvars. |
||||
|
||||
|
||||
|
||||
|
@ -0,0 +1,100 @@
|
||||
# Мониторинг подключений |
||||
|
||||
Компонент мониторинга подключений использует HTTP-пинги для проверки состояния подключения исходящих прокси. Результаты мониторинга могут использоваться другими компонентами, например, балансировщиком нагрузки. |
||||
В настоящее время доступны два режима: [observatory](#observatoryobject) (фоновый мониторинг подключений) и [burstObservatory](#burstobservatoryobject) (мониторинг параллельных подключений). |
||||
Выберите один из них в соответствии с вашими потребностями. |
||||
|
||||
## ObservatoryObject |
||||
|
||||
```json |
||||
{ |
||||
"subjectSelector":[ |
||||
"outbound" |
||||
], |
||||
"probeUrl": "https://www.google.com/generate_204", |
||||
"probeInterval": "10s", |
||||
"enableConcurrency": false |
||||
} |
||||
``` |
||||
|
||||
> `subjectSelector`: \[ string \] |
||||
|
||||
Массив строк, каждый элемент которого будет использоваться для сопоставления с префиксом тега исходящего подключения. |
||||
Например, для следующих тегов исходящих подключений: `[ "a", "ab", "c", "ba" ]`, `"subjectSelector": ["a"]` будет соответствовать `[ "a", "ab" ]`. |
||||
|
||||
> `probeUrl`: string |
||||
|
||||
URL-адрес, используемый для проверки состояния подключения исходящего прокси. |
||||
|
||||
> `probeInterval`: string |
||||
|
||||
Интервал между проверками. |
||||
Формат времени: число + единица измерения, например `"10s"`, `"2h45m"`. |
||||
Поддерживаемые единицы измерения: `ns`, `us`, `ms`, `s`, `m`, `h` (наносекунды, микросекунды, миллисекунды, секунды, минуты, часы). |
||||
|
||||
> `enableConcurrency`: true | false |
||||
|
||||
- `true` - проверять все соответствующие исходящие прокси одновременно, после чего сделать паузу на время, указанное в `probeInterval`. |
||||
- `false` - проверять соответствующие исходящие прокси по очереди, делая паузу на время, указанное в `probeInterval`, после проверки каждого прокси. |
||||
|
||||
## BurstObservatoryObject |
||||
|
||||
```json |
||||
{ |
||||
"subjectSelector":[ |
||||
"outbound" |
||||
], |
||||
"pingConfig": {} |
||||
} |
||||
``` |
||||
|
||||
> `subjectSelector`: \[ string \] |
||||
|
||||
Массив строк, каждый элемент которого будет использоваться для сопоставления с префиксом тега исходящего подключения. |
||||
Например, для следующих тегов исходящих подключений: `[ "a", "ab", "c", "ba" ]`, `"subjectSelector": ["a"]` будет соответствовать `[ "a", "ab" ]`. |
||||
|
||||
> `pingConfig`: [PingConfigObject](#PingConfigObject) |
||||
|
||||
|
||||
### PingConfigObject |
||||
|
||||
```json |
||||
{ |
||||
"destination": "https://connectivitycheck.gstatic.com/generate_204", |
||||
"connectivity": "", |
||||
"interval": "1h", |
||||
"sampling": 3, |
||||
"timeout": "30s" |
||||
} |
||||
``` |
||||
|
||||
> `destination`: string |
||||
|
||||
URL-адрес, используемый для проверки состояния подключения исходящего прокси. |
||||
Этот URL-адрес должен возвращать код состояния HTTP 204. |
||||
|
||||
> `connectivity`: string |
||||
|
||||
URL-адрес, используемый для проверки подключения к локальной сети. |
||||
Пустая строка означает, что проверка подключения к локальной сети не выполняется. |
||||
|
||||
> `interval`: string |
||||
|
||||
Проверить все соответствующие исходящие прокси в течение указанного времени, отправляя `sampling` + 1 запросов на каждый прокси. |
||||
Формат времени: число + единица измерения, например `"10s"`, `"2h45m"`. |
||||
Поддерживаемые единицы измерения: `ns`, `us`, `ms`, `s`, `m`, `h` (наносекунды, микросекунды, миллисекунды, секунды, минуты, часы). |
||||
|
||||
> `sampling`: number |
||||
|
||||
Количество последних результатов проверок, которые нужно сохранить. |
||||
|
||||
> `timeout`: string |
||||
|
||||
Время ожидания ответа при проверке. |
||||
Формат такой же, как и у `interval`. |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
@ -0,0 +1,163 @@
|
||||
# Исходящие подключения |
||||
|
||||
Исходящие подключения используются для отправки данных. Доступные протоколы см. в разделе [Исходящие протоколы](./outbounds/). |
||||
|
||||
## OutboundObject |
||||
|
||||
`OutboundObject` соответствует дочернему элементу поля `outbounds` в конфигурационном файле. |
||||
|
||||
::: tip |
||||
Первый элемент в списке используется как основной исходящий узел. |
||||
Если совпадений с правилами маршрутизации нет или ни одно правило не сработало, трафик отправляется через основной исходящий узел. |
||||
::: |
||||
|
||||
```json |
||||
{ |
||||
"outbounds": [ |
||||
{ |
||||
"sendThrough": "0.0.0.0", |
||||
"protocol": "название протокола", |
||||
"settings": {}, |
||||
"tag": "тег", |
||||
"streamSettings": {}, |
||||
"proxySettings": { |
||||
"tag": "another-outbound-tag" |
||||
}, |
||||
"mux": {} |
||||
} |
||||
] |
||||
} |
||||
``` |
||||
|
||||
> `sendThrough`: address |
||||
|
||||
IP-адрес, используемый для отправки данных. |
||||
Этот параметр используется, если на хосте настроено несколько IP-адресов. |
||||
Значение по умолчанию - `"0.0.0.0"`. |
||||
|
||||
Разрешается указывать блок IPv6 CIDR (например, `114:514:1919:810::/64`). |
||||
Xray будет использовать случайный IP-адрес из этого блока для установления исходящих соединений. |
||||
Необходимо правильно настроить сетевое подключение, таблицу маршрутизации и параметры ядра, чтобы разрешить Xray привязываться к любому IP-адресу из этого блока. |
||||
|
||||
> `protocol`: string |
||||
|
||||
Название протокола подключения. |
||||
Список доступных протоколов см. в разделе "Исходящие подключения" в левой части документации. |
||||
|
||||
> `settings`: OutboundConfigurationObject |
||||
|
||||
Конкретные настройки зависят от протокола. |
||||
См. описание `OutboundConfigurationObject` для каждого протокола. |
||||
|
||||
> `tag`: string |
||||
|
||||
Тег этого исходящего подключения, используемый для идентификации этого подключения в других настройках. |
||||
|
||||
::: danger |
||||
Если это поле не пустое, его значение должно быть **уникальным** среди всех тегов. |
||||
::: |
||||
|
||||
> `streamSettings`: [StreamSettingsObject](./transport.md#streamsettingsobject) |
||||
|
||||
Тип транспорта (transport) - это способ взаимодействия текущего узла Xray с другими узлами. |
||||
|
||||
> `proxySettings`: [ProxySettingsObject](#proxysettingsobject) |
||||
|
||||
Настройки исходящего прокси. |
||||
Если исходящий прокси включен, параметр `streamSettings` этого исходящего подключения игнорируется. |
||||
|
||||
> `mux`: [MuxObject](#muxobject) |
||||
|
||||
Настройки Mux. |
||||
|
||||
### ProxySettingsObject |
||||
|
||||
```json |
||||
{ |
||||
"tag": "another-outbound-tag" |
||||
} |
||||
``` |
||||
|
||||
> `tag`: string |
||||
|
||||
При указании тега другого исходящего подключения данные, отправляемые этим исходящим подключением, будут перенаправлены через указанное исходящее подключение. |
||||
|
||||
::: danger |
||||
Этот способ пересылки **не использует** транспортный уровень. |
||||
Если вам нужна пересылка с использованием транспортного уровня, используйте [SockOpt.dialerProxy](./transport.md#sockoptobject). |
||||
::: |
||||
|
||||
::: danger |
||||
Этот параметр несовместим с SockOpt.dialerProxy. |
||||
::: |
||||
|
||||
::: tip |
||||
Совместим с настройкой `transportLayer` в v2fly/v2ray-core [transportLayer](https://www.v2fly.org/config/outbounds.html#proxysettingsobject). |
||||
::: |
||||
|
||||
### MuxObject |
||||
|
||||
Функция Mux позволяет мультиплексировать несколько TCP-соединений по одному TCP-соединению. |
||||
Подробнее см. [Mux.Cool](../../development/protocols/muxcool). |
||||
Mux предназначен для сокращения задержек при установлении TCP-соединений, а не для увеличения пропускной способности. |
||||
Использование Mux при просмотре видео, загрузке файлов или тестировании скорости обычно приводит к обратным результатам. |
||||
Mux нужно включать только на клиенте, сервер автоматически адаптируется. |
||||
|
||||
`MuxObject` соответствует полю `mux` в `OutboundObject`. |
||||
|
||||
```json |
||||
{ |
||||
"enabled": true, |
||||
"concurrency": 8, |
||||
"xudpConcurrency": 16, |
||||
"xudpProxyUDP443": "reject" |
||||
} |
||||
``` |
||||
|
||||
> `enabled`: true | false |
||||
|
||||
Включить пересылку запросов через Mux. |
||||
Значение по умолчанию - `false`. |
||||
|
||||
> `concurrency`: number |
||||
|
||||
Максимальное количество одновременных подключений. |
||||
Минимальное значение - `1`, максимальное значение - `1024`. |
||||
Если этот параметр опущен или равен `0`, используется значение `8`. |
||||
|
||||
Это значение определяет максимальное количество дочерних соединений, которые могут быть мультиплексированы по одному TCP-соединению. |
||||
Например, если `concurrency` равен `8`, то при отправке 8 TCP-запросов клиентом Xray создаст только одно фактическое TCP-соединение, и все 8 запросов клиента будут передаваться по этому соединению. |
||||
|
||||
::: tip |
||||
Если указать отрицательное значение, например `-1`, трафик TCP не будет проходить через Mux. |
||||
::: |
||||
|
||||
> `xudpConcurrency`: number |
||||
|
||||
Использовать новый агрегированный туннель XUDP (т.е. другое Mux-соединение) для проксирования UDP-трафика. |
||||
Укажите максимальное количество одновременных дочерних UoT-подключений. |
||||
Минимальное значение - `1`, максимальное значение - `1024`. |
||||
Если этот параметр опущен или равен `0`, UDP-трафик будет использовать тот же путь, что и TCP-трафик (традиционное поведение). |
||||
|
||||
::: tip |
||||
Если указать отрицательное значение, например `-1`, трафик UDP не будет проходить через Mux. |
||||
Будет использоваться исходный способ передачи UDP-трафика для данного протокола прокси. |
||||
Например, `Shadowsocks` будет использовать нативный UDP, а `VLESS` будет использовать UoT. |
||||
::: |
||||
|
||||
> `xudpProxyUDP443`: string |
||||
|
||||
Управление обработкой проксируемого трафика UDP/443 (QUIC) в Mux: |
||||
|
||||
- По умолчанию `reject` - отклонять трафик (обычно браузеры автоматически переключаются на TCP HTTP/2). |
||||
- `allow` - разрешить трафик через Mux. |
||||
- `skip` - не использовать Mux для трафика UDP/443. |
||||
Будет использоваться исходный способ передачи UDP-трафика для данного протокола прокси. |
||||
Например, `Shadowsocks` будет использовать нативный UDP, а `VLESS` будет использовать UoT. |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
@ -0,0 +1,38 @@
|
||||
# Blackhole |
||||
|
||||
Blackhole - это протокол исходящих данных, который блокирует все исходящие данные. В сочетании с [конфигурацией маршрутизации](../routing.md) он может быть использован для запрета доступа к определенным сайтам. |
||||
|
||||
## OutboundConfigurationObject |
||||
|
||||
```json |
||||
{ |
||||
"response": { |
||||
"type": "none" |
||||
} |
||||
} |
||||
``` |
||||
|
||||
> `response`: [ResponseObject](#responseobject) |
||||
|
||||
Настройка ответа Blackhole. |
||||
|
||||
Blackhole отправит указанный ответ после получения данных , а затем закроет соединение. Данные для будут отброшены. |
||||
Если этот параметр не указан, Blackhole просто закроет соединение. |
||||
|
||||
### ResponseObject |
||||
|
||||
```json |
||||
{ |
||||
"type": "none" |
||||
} |
||||
``` |
||||
|
||||
> `type`: "http" | "none" |
||||
|
||||
Если `type` равен `"none"` (значение по умолчанию), Blackhole просто закроет соединение. |
||||
|
||||
Если `type` равен `"http"`, Blackhole вернет простой пакет HTTP 403, а затем закроет соединение. |
||||
|
||||
|
||||
|
||||
|
@ -0,0 +1,36 @@
|
||||
# DNS |
||||
|
||||
DNS — это исходящий протокол, который в основном используется для перехвата и пересылки DNS-запросов. |
||||
|
||||
Этот исходящий протокол может принимать только DNS-трафик (включая запросы по протоколам UDP и TCP), другие типы трафика будут вызывать ошибки. |
||||
|
||||
При обработке DNS-запросов этот исходящий протокол перенаправляет IP-запросы (то есть A и AAAA) на встроенный [DNS-сервер](../dns.md). Другие типы запросов будут перенаправлены на их исходные адреса назначения. |
||||
|
||||
## OutboundConfigurationObject |
||||
|
||||
```json |
||||
{ |
||||
"network": "tcp", |
||||
"address": "1.1.1.1", |
||||
"port": 53, |
||||
"nonIPQuery": "drop" |
||||
} |
||||
``` |
||||
|
||||
> `network`: "tcp" | "udp" |
||||
|
||||
Изменяет транспортный протокол DNS-трафика, возможные значения: `"tcp"` и `"udp"`. Если не указан, сохраняется исходный транспортный протокол. |
||||
|
||||
> `address`: address |
||||
|
||||
Изменяет адрес DNS-сервера. Если не указан, сохраняется адрес, указанный в источнике. |
||||
|
||||
> `port`: number |
||||
|
||||
Изменяет порт DNS-сервера. Если не указан, сохраняется порт, указанный в источнике. |
||||
|
||||
> `nonIPQuery`: string |
||||
|
||||
Управляет не IP-запросами (не A и AAAA), `"drop"` - отбрасывать или `"skip"` - не обрабатывать встроенным DNS-сервером, а пересылать на целевой сервер. Значение по умолчанию: `"drop"`. |
||||
|
||||
## Пример настройки DNS <Badge text="WIP" type="warning"/> |
@ -0,0 +1,73 @@
|
||||
# Freedom |
||||
|
||||
Freedom - это исходящий протокол, который можно использовать для отправки (обычных) данных TCP или UDP в любую сеть. |
||||
|
||||
## OutboundConfigurationObject |
||||
|
||||
```json |
||||
{ |
||||
"domainStrategy": "AsIs", |
||||
"redirect": "127.0.0.1:3366", |
||||
"userLevel": 0, |
||||
"fragment": { |
||||
"packets": "tlshello", |
||||
"length": "100-200", |
||||
"interval": "10-20" // в миллисекундах |
||||
}, |
||||
"proxyProtocol": 0 |
||||
} |
||||
``` |
||||
|
||||
> `domainStrategy`: "AsIs"<br> |
||||
> "UseIP" | "UseIPv6v4" | "UseIPv6" | "UseIPv4v6" | "UseIPv4"<br> |
||||
> "ForceIP" | "ForceIPv6v4" | "ForceIPv6" | "ForceIPv4v6" | "ForceIPv4" |
||||
|
||||
Значение по умолчанию: `"AsIs"`. |
||||
|
||||
Если целевой адрес является доменным именем, настройте соответствующее значение для режима работы Freedom: |
||||
|
||||
- При использовании `"AsIs"` Xray будет напрямую использовать системный стек для установления соединения, приоритет и выбор IP будут зависеть от системных настроек. По некоторым причинам UDP-соединения, использующие доменные имена, будут игнорировать системные настройки и отдавать приоритет IPv4. |
||||
- При указании других значений для разрешения будет использоваться [встроенный DNS-сервер](../dns.md) Xray-core. Если DNSObject отсутствует, будет использоваться системный DNS. Если существует несколько подходящих IP-адресов, ядро случайным образом выберет один IP-адрес в качестве целевого. |
||||
- `"IPv4"` означает попытку подключения только с использованием IPv4, `"IPv4v6"` - попытку подключения с использованием IPv4 или IPv6, но с предпочтением IPv4 для доменных имен с поддержкой обоих протоколов. (То же самое относится и к v4v6, но в обратном порядке, поэтому здесь не приводится). |
||||
- Если в настройках встроенного DNS указан параметр `"queryStrategy"`, фактическое поведение будет объединено с этой опцией, и будут разрешаться только те типы IP, которые включены в обе опции. Например, `"queryStrategy": "UseIPv4"` и `"domainStrategy": "UseIP"` фактически эквивалентны `"domainStrategy": "UseIPv4"`. |
||||
- При использовании опций, начинающихся с `"Use"`, если результаты разрешения не соответствуют требованиям (например, доменное имя имеет только результат разрешения IPv4, но используется UseIPv6), будет выполнен откат к AsIs. |
||||
- При использовании опций, начинающихся с `"Force"`, если результаты разрешения не соответствуют требованиям, соединение не будет установлено. |
||||
|
||||
::: tip СОВЕТ 1 |
||||
При использовании режимов `"UseIP"` или `"ForceIP"` и указании `sendThrough` в [конфигурации исходящего соединения](../outbound.md#outboundobject) Freedom будет автоматически определять необходимый тип IP (IPv4 или IPv6) на основе значения `sendThrough`. Если вручную указать один тип IP (например, UseIPv4), но он не совпадает с локальным адресом, указанным в `sendThrough`, соединение не будет установлено. |
||||
::: |
||||
|
||||
> `redirect`: адрес_порт |
||||
|
||||
Freedom будет принудительно отправлять все данные на указанный адрес (а не на адрес, указанный во входящем соединении). |
||||
|
||||
Его значение представляет собой строку, например: `"127.0.0.1:80"`, `":1234"`. |
||||
|
||||
Если адрес не указан, например, `":443"`, Freedom не будет изменять исходный целевой адрес. |
||||
Если порт равен `0`, например, `"xray.com: 0"`, Freedom не будет изменять исходный порт. |
||||
|
||||
> `userLevel`: number |
||||
|
||||
Уровень пользователя, для соединения будет использоваться [локальная политика](../policy.md#levelpolicyobject), соответствующая этому уровню пользователя. |
||||
|
||||
Значение userLevel соответствует значению `level` в разделе [policy](../policy.md#policyobject). Если не указано, используется значение по умолчанию - 0. |
||||
|
||||
> `fragment`: map |
||||
|
||||
Некоторые пары "ключ-значение" для управления исходящей TCP-фрагментацией, которые в некоторых случаях могут обмануть систему цензуры, например, обойти черный список SNI. |
||||
|
||||
`"packets"`: поддерживаются два режима фрагментации: "1-3" - это фрагментация потока TCP, применяемая к первым трем операциям записи данных на стороне клиента. "tlshello" - это фрагментация пакета TLS-рукопожатия. |
||||
|
||||
`"length"`: длина фрагмента пакета (в байтах). |
||||
|
||||
`"interval"`: интервал фрагментации (в миллисекундах). |
||||
|
||||
> `proxyProtocol`: number |
||||
|
||||
Протокол PROXY обычно используется в сочетании с `redirect` для перенаправления на Nginx или другой сервер, на котором включен протокол PROXY. Если сервер не поддерживает протокол PROXY, соединение будет разорвано. |
||||
|
||||
Значение proxyProtocol - это номер версии протокола PROXY, возможные значения: `1` или `2`. Если не указано, используется значение по умолчанию - `0` (протокол не используется). |
||||
|
||||
|
||||
|
||||
|
@ -0,0 +1,93 @@
|
||||
# HTTP |
||||
|
||||
Протокол HTTP. |
||||
|
||||
::: danger |
||||
**Протокол HTTP не обеспечивает шифрования передачи, что делает его непригодным для передачи по общедоступным сетям и более уязвимым для использования в качестве скомпрометированного хоста для атак.** |
||||
::: |
||||
|
||||
::: tip |
||||
`HTTP` может проксировать только протоколы TCP и не может обрабатывать протоколы на основе UDP. |
||||
::: |
||||
|
||||
## OutboundConfigurationObject |
||||
|
||||
```json |
||||
{ |
||||
"servers": [ |
||||
{ |
||||
"address": "192.168.108.1", |
||||
"port": 3128, |
||||
"users": [ |
||||
{ |
||||
"user": "my-username", |
||||
"pass": "my-password" |
||||
} |
||||
] |
||||
} |
||||
], |
||||
"headers": { |
||||
"User-Agent": "Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/53.0.2785.143 Safari/537.36", |
||||
"Accept-Language": "zh-CN,zh;q=0.8,zh-TW;q=0.7,zh-HK;q=0.5,en-US;q=0.3,en;q=0.2" |
||||
} |
||||
} |
||||
``` |
||||
|
||||
::: tip |
||||
В настоящее время в исходящем HTTP-протоколе действительна конфигурация `streamSettings` с параметрами `security` и `tlsSettings`. |
||||
::: |
||||
|
||||
> `servers`: \[ [ServerObject](#serverobject) \] |
||||
|
||||
Список HTTP-серверов, каждый элемент которого является конфигурацией сервера. Если настроено несколько серверов, они используются по кругу (RoundRobin). |
||||
|
||||
> `headers`: map{ string, string } |
||||
|
||||
HTTP-заголовки, пара "ключ-значение". Каждый ключ представляет собой имя HTTP-заголовка, все пары "ключ-значение" будут прикрепляться к каждому запросу. |
||||
|
||||
### ServerObject |
||||
|
||||
```json |
||||
{ |
||||
"address": "192.168.108.1", |
||||
"port": 3128, |
||||
"users": [ |
||||
{ |
||||
"user": "my-username", |
||||
"pass": "my-password" |
||||
} |
||||
] |
||||
} |
||||
``` |
||||
|
||||
> `address`: string |
||||
|
||||
Адрес HTTP-прокси-сервера, обязательный параметр. |
||||
|
||||
> `port`: int |
||||
|
||||
Порт HTTP-прокси-сервера, обязательный параметр. |
||||
|
||||
> `user`: \[[AccountObject](#accountobject)\] |
||||
|
||||
Массив, каждый элемент которого представляет собой учетную запись пользователя. Значение по умолчанию: пустой массив. |
||||
|
||||
#### AccountObject |
||||
|
||||
```json |
||||
{ |
||||
"user": "my-username", |
||||
"pass": "my-password" |
||||
} |
||||
``` |
||||
|
||||
> `user`: string |
||||
|
||||
Имя пользователя, тип данных: строка. Обязательный параметр. |
||||
|
||||
> `pass`: string |
||||
|
||||
Пароль, тип данных: строка. Обязательный параметр. |
||||
|
||||
|
||||
|
@ -0,0 +1,59 @@
|
||||
# Loopback |
||||
|
||||
Loopback - это исходящий протокол данных, который перенаправляет данные, прошедшие через это исходящее соединение, обратно на вход маршрутизатора, что позволяет повторно обработать данные по правилам маршрутизации, не покидая Xray-core. |
||||
|
||||
## OutboundConfigurationObject |
||||
|
||||
```json |
||||
{ |
||||
"inboundTag": "TagUseAsInbound" |
||||
} |
||||
``` |
||||
|
||||
> `inboundTag`: string |
||||
|
||||
Идентификатор входящего протокола, используемый для повторной маршрутизации. |
||||
|
||||
Этот идентификатор может использоваться в маршрутизации для `inboundTag`, указывая, что данные из этого исходящего соединения могут быть повторно обработаны соответствующими правилами маршрутизации. |
||||
|
||||
### Как использовать? |
||||
|
||||
Если необходимо, чтобы трафик, уже разделенный по правилам маршрутизации, был перенаправлен другими правилами маршрутизации (например, трафик TCP и UDP, разделенный одними и теми же правилами маршрутизации, должен идти через разные исходящие соединения), можно использовать исходящее соединение `loopback`. |
||||
|
||||
``` json |
||||
{ |
||||
"outbounds": [ |
||||
{ |
||||
"protocol": "loopback", |
||||
"tag": "need-to-split", |
||||
"settings": { |
||||
"inboundTag": "traffic-input" // Этот тег используется ниже для inboundTag в RuleObject |
||||
} |
||||
}, |
||||
{ |
||||
"tag": "tcp-output", |
||||
// Настройки protocol, settings, streamSettings и т. д. |
||||
}, |
||||
{ |
||||
"tag": "udp-output", |
||||
// Настройки protocol, settings, streamSettings и т. д. |
||||
} |
||||
], |
||||
"routing": { |
||||
"rules": [ |
||||
{ |
||||
"inboundTag": ["traffic-input"], // Тег, установленный в loopback |
||||
"network": "tcp", |
||||
"outboundTag": "tcp-output" |
||||
}, |
||||
{ |
||||
"inboundTag": ["traffic-input"], // Тег, установленный в loopback |
||||
"network": "udp", |
||||
"outboundTag": "udp-output" |
||||
} |
||||
] |
||||
} |
||||
} |
||||
``` |
||||
|
||||
|
@ -0,0 +1,123 @@
|
||||
# Shadowsocks |
||||
|
||||
Протокол [Shadowsocks](https://ru.wikipedia.org/wiki/Shadowsocks), совместимый с большинством других реализаций. |
||||
|
||||
Текущая совместимость: |
||||
|
||||
- Поддерживает пересылку пакетов TCP и UDP, при этом UDP можно выборочно отключить; |
||||
- Рекомендуемые методы шифрования: |
||||
- 2022-blake3-aes-128-gcm |
||||
- 2022-blake3-aes-256-gcm |
||||
- 2022-blake3-chacha20-poly1305 |
||||
- Другие методы шифрования: |
||||
- aes-256-gcm |
||||
- aes-128-gcm |
||||
- chacha20-poly1305 или chacha20-ietf-poly1305 |
||||
- xchacha20-poly1305 или xchacha20-ietf-poly1305 |
||||
- none или plain |
||||
|
||||
Новый формат протокола Shadowsocks 2022 повышает производительность и обеспечивает полную защиту от повторов, решая следующие проблемы безопасности старого протокола: |
||||
|
||||
- [Серьезные уязвимости в шифровании Shadowsocks AEAD, которые не могут гарантировать целостность содержимого](https://github.com/shadowsocks/shadowsocks-org/issues/183) |
||||
- Возрастающий коэффициент ложных срабатываний исходного фильтра повторов TCP с течением времени |
||||
- Отсутствие защиты от повторов UDP |
||||
- Поведение TCP, которое можно использовать для активного зондирования |
||||
|
||||
::: danger |
||||
При использовании метода шифрования "none" трафик передается в открытом виде. В целях безопасности не используйте этот метод в общедоступных сетях. |
||||
::: |
||||
|
||||
## OutboundConfigurationObject |
||||
|
||||
```json |
||||
{ |
||||
"servers": [ |
||||
{ |
||||
"email": "love@xray.com", |
||||
"address": "127.0.0.1", |
||||
"port": 1234, |
||||
"method": "метод_шифрования", |
||||
"password": "пароль", |
||||
"uot": true, |
||||
"UoTVersion": 2, |
||||
"level": 0 |
||||
} |
||||
] |
||||
} |
||||
``` |
||||
|
||||
> `servers`: \[[ServerObject](#serverobject)\] |
||||
|
||||
Массив, представляющий собой набор настроек сервера Shadowsocks, каждый элемент которого является [ServerObject](#serverobject). |
||||
|
||||
### ServerObject |
||||
|
||||
```json |
||||
{ |
||||
"email": "love@xray.com", |
||||
"address": "127.0.0.1", |
||||
"port": 1234, |
||||
"method": "метод_шифрования", |
||||
"password": "пароль", |
||||
"uot": true, |
||||
"UoTVersion": 2, |
||||
"level": 0 |
||||
} |
||||
``` |
||||
|
||||
> `email`: string |
||||
|
||||
Адрес электронной почты, необязательный параметр, используется для идентификации пользователя. |
||||
|
||||
> `address`: address |
||||
|
||||
Адрес сервера Shadowsocks, поддерживаются IPv4, IPv6 и доменные имена. Обязательный параметр. |
||||
|
||||
> `port`: number |
||||
|
||||
Порт сервера Shadowsocks. Обязательный параметр. |
||||
|
||||
> `method`: string |
||||
|
||||
Обязательный параметр. |
||||
|
||||
> `password`: string |
||||
|
||||
Обязательный параметр. |
||||
|
||||
> `uot`: bool |
||||
|
||||
Включить `udp over tcp`. |
||||
|
||||
> `UoTVersion`: number |
||||
|
||||
Версия реализации `UDP over TCP`. |
||||
|
||||
Допустимые значения: `1`, `2`. |
||||
|
||||
- Shadowsocks 2022 |
||||
|
||||
В качестве пароля используется предварительный общий ключ, аналогичный ключам WireGuard. |
||||
|
||||
Используйте `openssl rand -base64 <длина>`, чтобы сгенерировать ключ, совместимый с shadowsocks-rust, длина зависит от используемого метода шифрования. |
||||
|
||||
| Метод шифрования | Длина ключа | |
||||
| ------------------------------------ | ----------: | |
||||
| 2022-blake3-aes-128-gcm | 16 | |
||||
| 2022-blake3-aes-256-gcm | 32 | |
||||
| 2022-blake3-chacha20-poly1305 | 32 | |
||||
|
||||
В реализации Go всегда работают 32-битные ключи. |
||||
|
||||
- Другие методы шифрования |
||||
|
||||
Любая строка. Длина пароля не ограничена, но короткие пароли более уязвимы для взлома, рекомендуется использовать пароли длиной 16 символов или более. |
||||
|
||||
> `level`: number |
||||
|
||||
Уровень пользователя, для соединения будет использоваться [локальная политика](../policy.md#levelpolicyobject), соответствующая этому уровню пользователя. |
||||
|
||||
Значение `level` соответствует значению `level` в разделе [policy](../policy.md#policyobject). Если не указано, используется значение по умолчанию - 0. |
||||
|
||||
|
||||
|
@ -0,0 +1,94 @@
|
||||
# Socks |
||||
|
||||
Стандартная реализация протокола Socks, совместимая с [Socks 4](http://ftp.icm.edu.pl/packages/socks/socks4/SOCKS4.protocol), [Socks 4a](https://ftp.icm.edu.pl/packages/socks/socks4/SOCKS4A.protocol) и Socks 5. |
||||
|
||||
::: danger |
||||
**Протокол Socks не обеспечивает шифрования передачи, поэтому он не подходит для передачи данных через общедоступные сети.** |
||||
::: |
||||
|
||||
## OutboundConfigurationObject |
||||
|
||||
```json |
||||
{ |
||||
"servers": [ |
||||
{ |
||||
"address": "127.0.0.1", |
||||
"port": 1234, |
||||
"users": [ |
||||
{ |
||||
"user": "test user", |
||||
"pass": "test pass", |
||||
"level": 0 |
||||
} |
||||
] |
||||
} |
||||
] |
||||
} |
||||
``` |
||||
|
||||
> `servers`: \[ [ServerObject](#serverobject) \] |
||||
|
||||
Список Socks-серверов, где каждый элемент представляет собой конфигурацию сервера. |
||||
|
||||
### ServerObject |
||||
|
||||
```json |
||||
{ |
||||
"address": "127.0.0.1", |
||||
"port": 1234, |
||||
"users": [ |
||||
{ |
||||
"user": "test user", |
||||
"pass": "test pass", |
||||
"level": 0 |
||||
} |
||||
] |
||||
} |
||||
``` |
||||
|
||||
> `address`: address |
||||
|
||||
Адрес сервера, обязательный параметр. |
||||
|
||||
::: tip |
||||
Поддерживается подключение только к Socks 5 серверам. |
||||
::: |
||||
|
||||
> `port`: number |
||||
|
||||
Порт сервера, обязательный параметр. |
||||
|
||||
> `users`: \[ [UserObject](#userobject) \] |
||||
|
||||
Массив, представляющий список пользователей, где каждый элемент представляет собой конфигурацию пользователя. |
||||
|
||||
Если список не пуст, Socks-клиент будет использовать информацию о пользователе для аутентификации; если не указан, аутентификация не выполняется. |
||||
|
||||
Значение по умолчанию: пустой массив. |
||||
|
||||
#### UserObject |
||||
|
||||
```json |
||||
{ |
||||
"user": "test user", |
||||
"pass": "test pass", |
||||
"level": 0 |
||||
} |
||||
``` |
||||
|
||||
> `user`: string |
||||
|
||||
Имя пользователя, тип данных: строка. Обязательный параметр. |
||||
|
||||
> `pass`: string |
||||
|
||||
Пароль, тип данных: строка. Обязательный параметр. |
||||
|
||||
> `level`: number |
||||
|
||||
Уровень пользователя, для соединения будет использоваться [локальная политика](../policy.md#levelpolicyobject), соответствующая этому уровню пользователя. |
||||
|
||||
Значение userLevel соответствует значению `level` в разделе [policy](../policy.md#policyobject). Если не указано, используется значение по умолчанию - 0. |
||||
|
||||
|
||||
|
@ -0,0 +1,67 @@
|
||||
# Trojan |
||||
|
||||
Протокол [Trojan](https://trojan-gfw.github.io/trojan/protocol). |
||||
|
||||
::: danger |
||||
Trojan предназначен для работы в правильно настроенном зашифрованном TLS-туннеле. |
||||
::: |
||||
|
||||
|
||||
## OutboundConfigurationObject |
||||
|
||||
```json |
||||
{ |
||||
"servers": [ |
||||
{ |
||||
"address": "127.0.0.1", |
||||
"port": 1234, |
||||
"password": "password", |
||||
"email": "love@xray.com", |
||||
"level": 0 |
||||
} |
||||
] |
||||
} |
||||
``` |
||||
|
||||
> `servers`: \[ [ServerObject](#serverobject) \] |
||||
|
||||
Массив, каждый элемент которого является [ServerObject](#serverobject). |
||||
|
||||
### ServerObject |
||||
|
||||
```json |
||||
{ |
||||
"address": "127.0.0.1", |
||||
"port": 1234, |
||||
"password": "password", |
||||
"email": "love@xray.com", |
||||
"level": 0 |
||||
} |
||||
``` |
||||
|
||||
> `address`: address |
||||
|
||||
Адрес сервера, поддерживаются IPv4, IPv6 и доменные имена. Обязательный параметр. |
||||
|
||||
> `port`: number |
||||
|
||||
Порт сервера, обычно тот же, что и порт, прослушиваемый сервером. |
||||
|
||||
> `password`: string |
||||
|
||||
Пароль. Обязательный параметр, любая строка. |
||||
|
||||
> `email`: string |
||||
|
||||
Адрес электронной почты, необязательный параметр, используется для идентификации пользователя. |
||||
|
||||
> `level`: number |
||||
|
||||
Уровень пользователя, для соединения будет использоваться [локальная политика](../policy.md#levelpolicyobject), соответствующая этому уровню пользователя. |
||||
|
||||
Значение level соответствует значению `level` в разделе [policy](../policy.md#policyobject). Если не указано, используется значение по умолчанию - 0. |
||||
|
||||
|
||||
|
||||
|
||||
|
@ -0,0 +1,139 @@
|
||||
# VLESS |
||||
|
||||
::: danger |
||||
VLESS не предусматривает встроенного шифрования, поэтому обязательным условием для его использования является наличие надежного канала, такого как TLS или REALITY. |
||||
::: |
||||
|
||||
VLESS - это легкий транспортный протокол без сохранения состояния, который разделен на входящую и исходящую части и может служить мостом между клиентом и сервером Xray. |
||||
|
||||
В отличие от [VMess](./vmess.md), VLESS не зависит от системного времени, аутентификация также осуществляется с помощью UUID. |
||||
|
||||
|
||||
## OutboundConfigurationObject |
||||
|
||||
```json |
||||
{ |
||||
"vnext": [ |
||||
{ |
||||
"address": "example.com", |
||||
"port": 443, |
||||
"users": [ |
||||
{ |
||||
"id": "5783a3e7-e373-51cd-8642-c83782b807c5", |
||||
"encryption": "none", |
||||
"flow": "xtls-rprx-vision", |
||||
"level": 0 |
||||
} |
||||
] |
||||
} |
||||
] |
||||
} |
||||
``` |
||||
|
||||
> `vnext`: \[ [ServerObject](#serverobject) \] |
||||
|
||||
Массив, представляющий список серверов VLESS, содержащий набор конфигураций, указывающих на сервер, где каждый элемент является конфигурацией сервера. |
||||
|
||||
### ServerObject |
||||
|
||||
```json |
||||
{ |
||||
"address": "example.com", |
||||
"port": 443, |
||||
"users": [ |
||||
{ |
||||
"id": "5783a3e7-e373-51cd-8642-c83782b807c5", |
||||
"encryption": "none", |
||||
"flow": "xtls-rprx-vision", |
||||
"level": 0 |
||||
} |
||||
] |
||||
} |
||||
``` |
||||
|
||||
> `address`: address |
||||
|
||||
Адрес сервера, указывающий на сервер, поддерживаются доменные имена, IPv4 и IPv6. |
||||
|
||||
> `port`: number |
||||
|
||||
Порт сервера, обычно тот же, что и порт, прослушиваемый сервером. |
||||
|
||||
> `users`: \[ [UserObject](#userobject) \] |
||||
|
||||
Массив, представляющий список пользователей, распознаваемых сервером, где каждый элемент является конфигурацией пользователя. |
||||
|
||||
### UserObject |
||||
|
||||
```json |
||||
{ |
||||
"id": "5783a3e7-e373-51cd-8642-c83782b807c5", |
||||
"encryption": "none", |
||||
"flow": "xtls-rprx-vision", |
||||
"level": 0 |
||||
} |
||||
``` |
||||
|
||||
> `id`: string |
||||
|
||||
Идентификатор пользователя VLESS, может быть любой строкой длиной менее 30 байт или допустимым UUID. |
||||
Пользовательская строка и ее UUID-отображение эквивалентны, это означает, что вы можете использовать следующие способы записи id в файле конфигурации для идентификации одного и того же пользователя: |
||||
|
||||
- Напишите `"id": "Я люблю арбуз учителя 1314"`, |
||||
- Или напишите `"id": "5783a3e7-e373-51cd-8642-c83782b807c5"` (этот UUID является UUID-отображением строки "Я люблю арбуз учителя 1314") |
||||
|
||||
Стандарт сопоставления описан в [VLESS UUID Mapping Standard: Mapping Custom Strings to a UUIDv5](https://github.com/XTLS/Xray-core/issues/158). |
||||
|
||||
Вы можете использовать команду `xray uuid -i "Пользовательская строка"` для генерации UUID, соответствующего пользовательской строке. Вы также можете использовать команду `xray uuid` для генерации случайного UUID. |
||||
|
||||
> `encryption`: "none" |
||||
|
||||
Необходимо указать `"none"`, значение не может быть пустым. |
||||
|
||||
Это требование призвано напомнить пользователю об отсутствии шифрования, а также предотвратить ошибки пользователей при вводе имени атрибута или его расположения в будущем, когда будут доступны методы шифрования. |
||||
|
||||
Если значение encryption установлено неверно, при использовании Xray или -test будет выдано сообщение об ошибке. |
||||
|
||||
> `flow`: string |
||||
|
||||
Режим управления потоком, используется для выбора алгоритма XTLS. |
||||
|
||||
В настоящее время для исходящего протокола доступны следующие режимы управления потоком: |
||||
|
||||
- Отсутствует `flow` или пустая строка: используется обычный TLS-прокси. |
||||
- `xtls-rprx-vision`: используется новый режим XTLS, включает случайное заполнение внутреннего рукопожатия, поддерживает uTLS для имитации отпечатка клиента. |
||||
- `xtls-rprx-vision-udp443`: аналогично `xtls-rprx-vision`, но разрешает UDP-трафик, направленный на порт 443. |
||||
|
||||
Кроме того, в настоящее время XTLS поддерживает только три транспортных протокола: TCP, mKCP и DomainSocket. |
||||
|
||||
<!-- prettier-ignore --> |
||||
::: tip О режимах управления потоком xtls-rprx-*-udp443 |
||||
|
||||
Когда XTLS в Xray-core включен, трафик, направленный на UDP-порт 443 (обычно QUIC), по умолчанию блокируется, чтобы приложение не использовало QUIC, а использовало TLS, чтобы XTLS действительно вступил в силу. Фактически, QUIC сам по себе не подходит для проксирования, поскольку QUIC имеет встроенные функции TCP, и когда он передается по протоколу VLESS как UDP-трафик, базовый протокол - TCP, что эквивалентно двум уровням TCP. |
||||
|
||||
Если блокировка не требуется, укажите `xtls-rprx-*-udp443` на стороне клиента, на стороне сервера оставляйте без изменений. |
||||
::: |
||||
|
||||
::: tip О режиме Splice |
||||
|
||||
Splice - это функция, предоставляемая ядром Linux, где ядро системы напрямую пересылает TCP, минуя память Xray, что значительно сокращает количество операций копирования данных и переключения контекста процессора. |
||||
|
||||
Ограничения использования режима Splice: |
||||
|
||||
- Среда Linux. |
||||
- Входящий протокол: `Dokodemo door`, `Socks`, `HTTP` и другие чистые TCP-соединения или другие входящие протоколы, использующие XTLS. |
||||
- Исходящий протокол: VLESS + XTLS. |
||||
- Обратите внимание, что при использовании протокола mKCP Splice не будет использоваться (да, хотя ошибки и нет, на самом деле он не используется). |
||||
|
||||
Кроме того, при использовании Splice отображение скорости сети будет запаздывать, это особенность, а не ошибка. |
||||
|
||||
При использовании режима Vision Splice будет включен автоматически, если выполнены вышеуказанные условия. |
||||
::: |
||||
|
||||
> `level`: number |
||||
|
||||
Уровень пользователя, для соединения будет использоваться [локальная политика](../policy.md#levelpolicyobject), соответствующая этому уровню пользователя. |
||||
|
||||
Значение level соответствует значению `level` в разделе [policy](../policy.md#policyobject). Если не указано, используется значение по умолчанию - 0. |
||||
|
||||
|
@ -0,0 +1,124 @@
|
||||
# VMess |
||||
|
||||
[VMess](../../development/protocols/vmess.md) - это зашифрованный транспортный протокол, который обычно используется в качестве моста между клиентами и серверами Xray. |
||||
|
||||
::: danger |
||||
VMess полагается на системное время. Убедитесь, что системное время UTC, используемое Xray, находится в пределах 120 секунд от фактического времени, независимо от часового пояса. В системах Linux вы можете установить службу `ntp` для автоматической синхронизации системного времени. |
||||
::: |
||||
|
||||
## OutboundConfigurationObject |
||||
|
||||
```json |
||||
{ |
||||
"vnext": [ |
||||
{ |
||||
"address": "127.0.0.1", |
||||
"port": 37192, |
||||
"users": [ |
||||
{ |
||||
"id": "5783a3e7-e373-51cd-8642-c83782b807c5", |
||||
"security": "auto", |
||||
"level": 0, |
||||
"experiments": "" |
||||
} |
||||
] |
||||
} |
||||
] |
||||
} |
||||
``` |
||||
|
||||
> `vnext`: \[ [ServerObject](#serverobject) \] |
||||
|
||||
Массив, содержащий набор конфигураций сервера. |
||||
|
||||
Каждый элемент - это конфигурация сервера [ServerObject](#serverobject). |
||||
|
||||
### ServerObject |
||||
|
||||
```json |
||||
{ |
||||
"address": "127.0.0.1", |
||||
"port": 37192, |
||||
"users": [] |
||||
} |
||||
``` |
||||
|
||||
> `address`: address |
||||
|
||||
Адрес сервера, поддерживается IP-адрес или доменное имя. |
||||
|
||||
> `port`: number |
||||
|
||||
Номер порта, который прослушивает сервер, обязательный параметр. |
||||
|
||||
> `users`: \[ [UserObject](#userobject) \] |
||||
|
||||
Массив, представляющий группу пользователей, распознаваемых сервером. |
||||
|
||||
Каждый элемент - это пользователь [UserObject](#userobject). |
||||
|
||||
#### UserObject |
||||
|
||||
```json |
||||
{ |
||||
"id": "5783a3e7-e373-51cd-8642-c83782b807c5", |
||||
"security": "auto", |
||||
"level": 0, |
||||
"experiments": "" |
||||
} |
||||
``` |
||||
|
||||
> `id`: string |
||||
|
||||
Идентификатор пользователя VMess, может быть любой строкой длиной менее 30 байт или допустимым UUID. |
||||
|
||||
Пользовательская строка и соответствующий ей UUID эквивалентны, что означает, что вы можете использовать любой из следующих вариантов в файле конфигурации для идентификации одного и того же пользователя: |
||||
|
||||
- Напишите `"id": "Я люблю арбуз учителя 1314"`, |
||||
- Или напишите `"id": "5783a3e7-e373-51cd-8642-c83782b807c5"` (этот UUID является сопоставлением строки "Я люблю арбуз учителя 1314") |
||||
|
||||
Стандарт сопоставления описан в [VLESS UUID Mapping Standard: Mapping Custom Strings to a UUIDv5](https://github.com/XTLS/Xray-core/issues/158). |
||||
|
||||
Вы можете использовать команду `xray uuid -i "пользовательская строка"` для создания UUID, соответствующего пользовательской строке. Вы также можете использовать команду `xray uuid` для создания случайного UUID. |
||||
|
||||
> `level`: number |
||||
|
||||
Уровень пользователя, для соединения будет использоваться [локальная политика](../policy.md#levelpolicyobject), соответствующая этому уровню пользователя. |
||||
|
||||
Значение level соответствует значению `level` в разделе [policy](../policy.md#policyobject). Если не указано, используется значение по умолчанию - 0. |
||||
|
||||
> `security`: "aes-128-gcm" | "chacha20-poly1305" | "auto" | "none" | "zero" |
||||
|
||||
Метод шифрования. Клиент будет отправлять данные с использованием настроенного метода шифрования, сервер автоматически распознает его, настройка на сервере не требуется. |
||||
|
||||
- `"aes-128-gcm"`: рекомендуется для использования на ПК. |
||||
- `"chacha20-poly1305"`: рекомендуется для использования на мобильных устройствах. |
||||
- `"auto"`: значение по умолчанию, автоматический выбор (метод шифрования aes-128-gcm, если платформа выполнения - AMD64, ARM64 или s390x, в противном случае - Chacha20-Poly1305). |
||||
- `"none"`: без шифрования. |
||||
|
||||
* `"zero"`: без шифрования и проверки подлинности сообщений (v1.4.0+). |
||||
|
||||
::: tip |
||||
Рекомендуется использовать метод шифрования `"auto"`, чтобы обеспечить безопасность и совместимость в долгосрочной перспективе. |
||||
|
||||
Метод псевдошифрования `"none"` будет вычислять и проверять контрольные суммы пакетов данных, но поскольку алгоритм аутентификации не имеет аппаратной поддержки, на некоторых платформах он может быть медленнее, чем `"aes-128-gcm"` с аппаратным ускорением. |
||||
|
||||
Метод псевдошифрования `"zero"` не шифрует сообщения и не вычисляет контрольные суммы данных, поэтому теоретически он должен быть быстрее любого другого метода шифрования. Фактическая скорость может зависеть от других факторов. |
||||
|
||||
Не рекомендуется использовать методы псевдошифрования `"none"` и `"zero"` без включенного TLS-шифрования и обязательной проверки сертификатов. |
||||
Если для установления соединения используется CDN или другая промежуточная платформа, расшифровывающая TLS, или сетевая среда, не рекомендуется использовать методы псевдошифрования `"none"` и `"zero"`. |
||||
|
||||
Независимо от используемого метода шифрования, заголовок пакета VMess защищен шифрованием и аутентификацией. |
||||
::: |
||||
|
||||
> `experiments`: string |
||||
|
||||
Включенные экспериментальные функции протокола VMess. (Функции здесь нестабильны и могут быть удалены в любое время). Несколько включенных экспериментов можно разделить символом |, например, "AuthenticatedLength|NoTerminationSignal". |
||||
|
||||
"AuthenticatedLength" включает эксперимент с аутентифицированной длиной пакета. Этот эксперимент необходимо включить одновременно на клиенте и сервере, а также запустить одну и ту же версию программы. |
||||
|
||||
"NoTerminationSignal" включает эксперимент с отключением сигнала завершения соединения. Этот эксперимент может повлиять на стабильность проксируемого соединения. |
||||
|
||||
|
||||
|
||||
|
@ -0,0 +1,169 @@
|
||||
# WireGuard |
||||
|
||||
Стандартная реализация протокола WireGuard. |
||||
|
||||
::: danger |
||||
**Протокол WireGuard не предназначен для обхода блокировок, и его использование может привести к блокировке сервера из-за наличия характерных признаков.** |
||||
::: |
||||
|
||||
## OutboundConfigurationObject |
||||
|
||||
```json |
||||
{ |
||||
"secretKey": "PRIVATE_KEY", |
||||
"address": [ |
||||
// необязательно, по умолчанию ["10.0.0.1", "fd59:7153:2388:b5fd:0000:0000:0000:0001"] |
||||
"IPv4_CIDR", |
||||
"IPv6_CIDR", |
||||
"и так далее..." |
||||
], |
||||
"peers": [ |
||||
{ |
||||
"endpoint": "ENDPOINT_ADDR", |
||||
"publicKey": "PUBLIC_KEY" |
||||
} |
||||
], |
||||
"kernelMode": true, // необязательно, по умолчанию true, если поддерживается и есть достаточные права |
||||
"mtu": 1420, // необязательно, по умолчанию 1420 |
||||
"reserved": [1, 2, 3], |
||||
"workers": 2, // необязательно, по умолчанию runtime.NumCPU() |
||||
"domainStrategy": "ForceIP" |
||||
} |
||||
``` |
||||
|
||||
::: tip |
||||
В настоящее время в исходящем протоколе WireGuard не поддерживается настройка `streamSettings`. |
||||
::: |
||||
|
||||
> `secretKey`: string |
||||
|
||||
Приватный ключ пользователя. Обязательный параметр. |
||||
|
||||
> `address`: string array |
||||
|
||||
WireGuard создаст виртуальный сетевой интерфейс TUN на локальном компьютере. Используйте один или несколько IP-адресов, IPv6 поддерживается. |
||||
|
||||
> `kernelMode`: true | false |
||||
|
||||
Использовать ли TUN виртуального сетевого интерфейса ядра Linux.<br> |
||||
Для использования TUN виртуального сетевого интерфейса ядра Linux требуется поддержка системы и права root, после использования будет занята 1023-я таблица маршрутизации IPv6.<br> |
||||
|
||||
::: tip |
||||
Если в 1023-й таблице маршрутизации IPv6 уже есть записи маршрутов и значение `kernelMode` равно `true`, нормальная работа будет невозможна. |
||||
::: |
||||
|
||||
> `mtu`: int |
||||
|
||||
Размер фрагментации TUN нижнего уровня WireGuard. |
||||
|
||||
<details> |
||||
<summary>Как рассчитать MTU</summary> |
||||
|
||||
Структура пакета WireGuard выглядит следующим образом: |
||||
|
||||
``` |
||||
- 20-байтовый заголовок IPv4 или 40-байтовый заголовок IPv6 |
||||
- 8-байтовый заголовок UDP |
||||
- 4 байта типа |
||||
- 4 байта индекса ключа |
||||
- 8 байтов nonce |
||||
- N байтов зашифрованных данных |
||||
- 16-байтовый тег аутентификации |
||||
``` |
||||
|
||||
`N байтов зашифрованных данных` - это значение MTU, которое нам нужно. В зависимости от того, использует ли конечная точка IPv4 или IPv6, конкретное значение может быть 1440 (IPv4) или 1420 (IPv6), и его можно дополнительно уменьшить, если это необходимо в особых условиях (например, PPPoE для домашнего интернета требует дополнительного вычитания 8). |
||||
</details> |
||||
|
||||
> `reserved` \[ number \] |
||||
|
||||
Зарезервированные байты WireGuard. |
||||
|
||||
Новый параметр в Xray-core v1.8.0.<br> |
||||
При подключении к Warp через WireGuard из-за ограничений Cloudflare для некоторых IP-адресов в Гонконге и Лос-Анджелесе требуется значение `reserved` для успешного подключения.<br> |
||||
Значение `reserved` можно получить с помощью сторонних инструментов, таких как: [warp-reg](https://github.com/badafans/warp-reg), [warp-reg.sh](https://github.com/chise0713/warp-reg.sh). |
||||
|
||||
> `workers`: int |
||||
|
||||
Количество потоков, используемых WireGuard. |
||||
|
||||
> `peers`: \[ [Peers](#peers) \] |
||||
|
||||
Список серверов WireGuard, где каждый элемент является конфигурацией сервера. |
||||
|
||||
> `domainStrategy`: "ForceIPv6v4" | "ForceIPv6" | "ForceIPv4v6" | "ForceIPv4" | "ForceIP" |
||||
|
||||
Новый параметр в Xray-core v1.8.6.<br> |
||||
Если этот параметр не указан или оставлен пустым, используется значение по умолчанию `"ForceIP"`.<br> |
||||
Если целевой адрес является доменным именем, для получения IP-адреса используется [встроенный DNS-сервер](../dns.md) Xray-core (если конфигурация `"dns"` не указана, используется системный DNS), и этот IP-адрес отправляется через WireGuard для установления соединения.<br> |
||||
|
||||
::: tip |
||||
Если значение `domainStrategy` конфликтует со значением `"queryStrategy"` в конфигурации `"dns"`, это может привести к ошибкам при открытии веб-сайтов. |
||||
::: |
||||
|
||||
```json |
||||
"dns": { |
||||
"servers": [ |
||||
"https://1.1.1.1/dns-query", |
||||
{ |
||||
"address": "https://1.1.1.1/dns-query", |
||||
"domains": [ |
||||
"geosite:openai" |
||||
], |
||||
"skipFallback": true, |
||||
"queryStrategy": "UseIPv6" // Запрашивать только записи AAAA |
||||
} |
||||
], |
||||
"queryStrategy": "UseIP" // Запрашивать записи A и AAAA одновременно, если этот параметр не указан, значение по умолчанию - UseIP |
||||
}, |
||||
``` |
||||
|
||||
Если `domainStrategy: "ForceIPv4"`, а в поле DNS, управляющем запросами домена geosite:openai, используется `"queryStrategy": "UseIPv6"`, это приведет к ошибкам при открытии веб-сайтов geosite:openai. |
||||
|
||||
::: tip |
||||
В Xray-core v1.8.0 - v1.8.4 нет `"domainStrategy"`.<br> |
||||
Если целевой адрес является доменным именем, для получения IP-адреса используется встроенный DNS-сервер Xray-core. Значение `"queryStrategy"` в конфигурации `"dns"` используется для управления приоритетом IPv4 или IPv6.<br> |
||||
Если конфигурация `"dns"` не указана, для получения IP-адреса используется системный DNS, а приоритет IPv4 или IPv6 определяется системой. |
||||
::: |
||||
|
||||
### Peers |
||||
|
||||
```json |
||||
{ |
||||
"endpoint": "ENDPOINT_ADDR", |
||||
"publicKey": "PUBLIC_KEY", |
||||
"preSharedKey": "PRE_SHARED_KEY", // необязательно, по умолчанию "0000000000000000000000000000000000000000000000000000000000000000" |
||||
"keepAlive": 0, // необязательно, по умолчанию 0 |
||||
"allowedIPs": ["0.0.0.0/0"] // необязательно, по умолчанию ["0.0.0.0/0", "::/0"] |
||||
} |
||||
``` |
||||
|
||||
> `endpoint`: address |
||||
|
||||
Адрес сервера, обязательный параметр. |
||||
|
||||
Формат URL:порт, например, `engage.cloudflareclient.com:2408`<br> |
||||
Формат IP:порт, например, `162.159.192.1:2408` или `[2606:4700:d0::a29f:c001]:2408`. |
||||
|
||||
::: tip |
||||
Если целевой адрес имеет тип URL, для получения IP-адреса будет использоваться встроенный DNS-сервер Xray-core, приоритет IPv4 или IPv6 определяется значением `domainStrategy`.<br> |
||||
Если конфигурация `"dns"` не указана, для получения IP-адреса будет использоваться системный DNS, а приоритет IPv4 или IPv6 будет определяться системой. |
||||
::: |
||||
|
||||
> `publicKey`: string |
||||
|
||||
Публичный ключ сервера, используемый для аутентификации, обязательный параметр. |
||||
|
||||
> `preSharedKey`: string |
||||
|
||||
Дополнительный ключ симметричного шифрования. |
||||
|
||||
> `keepAlive`: int |
||||
|
||||
Интервал отправки keep-alive пакетов в секундах, значение по умолчанию - 0, что означает отсутствие keep-alive. |
||||
|
||||
> `allowedIPs`: string array |
||||
|
||||
WireGuard разрешает трафик только от определенных исходных IP-адресов. |
||||
|
||||
|
||||
|
@ -0,0 +1,144 @@
|
||||
# Локальные политики |
||||
|
||||
Локальные политики позволяют настраивать различные уровни пользователей и соответствующие им политики, например, настройки тайм-аута подключения. |
||||
Каждое соединение, обрабатываемое Xray, соответствует определенному пользователю, и к нему применяются политики в соответствии с уровнем пользователя (level). |
||||
|
||||
## PolicyObject |
||||
|
||||
`PolicyObject` соответствует полю `policy` в конфигурационном файле. |
||||
|
||||
```json |
||||
{ |
||||
"policy": { |
||||
"levels": { |
||||
"0": { |
||||
"handshake": 4, |
||||
"connIdle": 300, |
||||
"uplinkOnly": 2, |
||||
"downlinkOnly": 5, |
||||
"statsUserUplink": false, |
||||
"statsUserDownlink": false, |
||||
"bufferSize": 4 |
||||
} |
||||
}, |
||||
"system": { |
||||
"statsInboundUplink": false, |
||||
"statsInboundDownlink": false, |
||||
"statsOutboundUplink": false, |
||||
"statsOutboundDownlink": false |
||||
} |
||||
} |
||||
} |
||||
``` |
||||
|
||||
> `level`: map{string: [LevelPolicyObject](#levelpolicyobject)} |
||||
|
||||
Набор пар ключ-значение, где каждый ключ - это число в виде строки (требование JSON), например `"0"`, `"1"` и т.д. (кавычки обязательны). |
||||
Это число соответствует уровню пользователя. |
||||
Каждое значение - это [LevelPolicyObject](#levelpolicyobject). |
||||
|
||||
::: tip |
||||
Теперь можно настроить уровень пользователя для каждого входящего и исходящего подключения. |
||||
Xray будет применять различные локальные политики в соответствии с фактическим уровнем пользователя. |
||||
::: |
||||
|
||||
> `system`: [SystemPolicyObject](#systempolicyobject) |
||||
|
||||
Политики уровня системы Xray. |
||||
|
||||
### LevelPolicyObject |
||||
|
||||
```json |
||||
{ |
||||
"handshake": 4, |
||||
"connIdle": 300, |
||||
"uplinkOnly": 2, |
||||
"downlinkOnly": 5, |
||||
"statsUserUplink": false, |
||||
"statsUserDownlink": false, |
||||
"bufferSize": 10240 |
||||
} |
||||
``` |
||||
|
||||
> `handshake`: number |
||||
|
||||
Ограничение времени на установление соединения (рукопожатие). |
||||
Измеряется в секундах. |
||||
Значение по умолчанию - `4`. |
||||
При обработке нового соединения входящим прокси, если время, затраченное на рукопожатие, превышает это значение, соединение разрывается. |
||||
|
||||
> `connIdle`: number |
||||
|
||||
Ограничение времени простоя соединения. |
||||
Измеряется в секундах. |
||||
Значение по умолчанию - `300`. |
||||
При обработке соединения входящим или исходящим прокси, если в течение времени `connIdle` не было передано никаких данных (включая исходящие и входящие данные), соединение разрывается. |
||||
|
||||
> `uplinkOnly`: number |
||||
|
||||
Ограничение времени ожидания после закрытия исходящего канала соединения. |
||||
Измеряется в секундах. |
||||
Значение по умолчанию - `2`. |
||||
Когда сервер (например, удаленный веб-сайт) закрывает исходящее соединение, исходящий прокси разрывает соединение через `uplinkOnly` секунд. |
||||
|
||||
> `downlinkOnly`: number |
||||
|
||||
Ограничение времени ожидания после закрытия входящего канала соединения. |
||||
Измеряется в секундах. |
||||
Значение по умолчанию - `5`. |
||||
Когда клиент (например, браузер) закрывает входящее соединение, входящий прокси разрывает соединение через `downlinkOnly` секунд. |
||||
|
||||
::: tip |
||||
При просмотре веб-страниц можно установить `uplinkOnly` и `downlinkOnly` в `0`, чтобы ускорить закрытие соединений. |
||||
::: |
||||
|
||||
> `statsUserUplink`: true | false |
||||
|
||||
Если значение равно `true`, включить учет исходящего трафика для всех пользователей текущего уровня. |
||||
|
||||
> `statsUserDownlink`: true | false |
||||
|
||||
Если значение равно `true`, включить учет входящего трафика для всех пользователей текущего уровня. |
||||
|
||||
> `bufferSize`: number |
||||
|
||||
Размер внутреннего буфера для каждого соединения. |
||||
Измеряется в килобайтах. |
||||
Если значение равно `0`, внутренний буфер отключается. |
||||
|
||||
Значение по умолчанию: |
||||
|
||||
- На платформах ARM, MIPS, MIPSLE значение по умолчанию - `0`. |
||||
- На платформах ARM64, MIPS64, MIPS64LE значение по умолчанию - `4`. |
||||
- На других платформах значение по умолчанию - `512`. |
||||
|
||||
### SystemPolicyObject |
||||
|
||||
```json |
||||
{ |
||||
"statsInboundUplink": false, |
||||
"statsInboundDownlink": false, |
||||
"statsOutboundUplink": false, |
||||
"statsOutboundDownlink": false |
||||
} |
||||
``` |
||||
|
||||
> `statsInboundUplink`: true | false |
||||
|
||||
Если значение равно `true`, включить учет исходящего трафика для всех входящих подключений. |
||||
|
||||
> `statsInboundDownlink`: true | false |
||||
|
||||
Если значение равно `true`, включить учет входящего трафика для всех входящих подключений. |
||||
|
||||
> `statsOutboundUplink`: true | false |
||||
|
||||
Если значение равно `true`, включить учет исходящего трафика для всех исходящих подключений. |
||||
|
||||
> `statsOutboundDownlink`: true | false |
||||
|
||||
Если значение равно `true`, включить учет входящего трафика для всех исходящих подключений. |
||||
|
||||
|
||||
|
||||
|
@ -0,0 +1,247 @@
|
||||
# Обратный прокси |
||||
|
||||
Обратный прокси позволяет перенаправлять трафик с сервера на клиент, то есть перенаправлять трафик в обратном направлении. |
||||
|
||||
Принцип работы обратного прокси: |
||||
|
||||
- Предположим, что на хосте A запущен веб-сервер, но у этого хоста нет публичного IP-адреса, и к нему нельзя получить доступ из Интернета. |
||||
У нас есть другой хост B с публичным IP-адресом. |
||||
Мы хотим использовать хост B в качестве шлюза и перенаправлять трафик с B на A. |
||||
- На хосте A настроен Xray, называемый `bridge`, и на хосте B также настроен Xray, называемый `portal`. |
||||
- `bridge` устанавливает соединение с `portal`. |
||||
Целевой адрес этого соединения можно настроить произвольно. |
||||
`portal` получает два типа соединений: соединения от `bridge` и соединения от пользователей из Интернета. |
||||
`portal` автоматически объединяет эти два типа соединений. |
||||
Таким образом, `bridge` может получать трафик из Интернета. |
||||
- После получения трафика из Интернета `bridge` перенаправляет его на веб-сервер на хосте A без изменений. |
||||
Конечно, для этого требуется настроить маршрутизацию. |
||||
- `bridge` выполняет динамическую балансировку нагрузки в зависимости от объема трафика. |
||||
|
||||
::: tip |
||||
Обратный прокси по умолчанию использует [Mux](../../development/protocols/muxcool/). |
||||
Не включайте Mux для исходящих подключений, используемых обратным прокси. |
||||
::: |
||||
|
||||
::: warning |
||||
Функция обратного прокси находится в стадии тестирования и может работать некорректно. |
||||
::: |
||||
|
||||
## ReverseObject |
||||
|
||||
`ReverseObject` соответствует полю `reverse` в конфигурационном файле. |
||||
|
||||
```json |
||||
{ |
||||
"reverse": { |
||||
"bridges": [ |
||||
{ |
||||
"tag": "bridge", |
||||
"domain": "test.xray.com" |
||||
} |
||||
], |
||||
"portals": [ |
||||
{ |
||||
"tag": "portal", |
||||
"domain": "test.xray.com" |
||||
} |
||||
] |
||||
} |
||||
} |
||||
``` |
||||
|
||||
> `bridges`: \[[BridgeObject](#bridgeobject)\] |
||||
|
||||
Массив, каждый элемент которого представляет собой `bridge`. |
||||
Настройки каждого `bridge` определяются в [BridgeObject](#bridgeobject). |
||||
|
||||
> `portals`: \[[PortalObject](#portalobject)\] |
||||
|
||||
Массив, каждый элемент которого представляет собой `portal`. |
||||
Настройки каждого `portal` определяются в [PortalObject](#bridgeobject). |
||||
|
||||
### BridgeObject |
||||
|
||||
```json |
||||
{ |
||||
"tag": "bridge", |
||||
"domain": "test.xray.com" |
||||
} |
||||
``` |
||||
|
||||
> `tag`: string |
||||
|
||||
Все соединения, исходящие от `bridge`, будут иметь этот тег. |
||||
Его можно использовать для идентификации соединений в [настройках маршрутизации](./routing.md) с помощью `inboundTag`. |
||||
|
||||
> `domain`: string |
||||
|
||||
Доменное имя, которое `bridge` будет использовать для установления соединения с `portal`. |
||||
Это доменное имя используется только для связи между `bridge` и `portal` и не должно существовать на самом деле. |
||||
|
||||
### PortalObject |
||||
|
||||
```json |
||||
{ |
||||
"tag": "portal", |
||||
"domain": "test.xray.com" |
||||
} |
||||
``` |
||||
|
||||
> `tag`: string |
||||
|
||||
Тег `portal`. |
||||
Используйте `outboundTag` в [настройках маршрутизации](./routing.md), чтобы перенаправить трафик на этот `portal`. |
||||
|
||||
> `domain`: string |
||||
|
||||
Доменное имя. |
||||
Когда `portal` получает трафик, если целевое доменное имя трафика совпадает с этим доменным именем, `portal` считает, что это соединение для связи с `bridge`. |
||||
Весь остальной трафик считается трафиком, который нужно перенаправить. |
||||
`portal` идентифицирует и объединяет эти два типа соединений. |
||||
|
||||
::: tip |
||||
Один и тот же экземпляр Xray может выступать в роли `bridge`, `portal` или и того, и другого, в зависимости от сценария использования. |
||||
::: |
||||
|
||||
## Примеры полных конфигураций |
||||
|
||||
::: tip |
||||
Рекомендуется сначала запустить `bridge`, а затем `portal`. |
||||
::: |
||||
|
||||
### Настройка bridge |
||||
|
||||
`bridge` обычно требуется два исходящих подключения: одно для подключения к `portal`, а другое - для отправки фактического трафика. |
||||
Другими словами, вам нужно использовать маршрутизацию, чтобы разделять эти два типа трафика. |
||||
|
||||
Настройки обратного прокси: |
||||
|
||||
```json |
||||
{ |
||||
"bridges": [ |
||||
{ |
||||
"tag": "bridge", |
||||
"domain": "test.xray.com" |
||||
} |
||||
] |
||||
} |
||||
``` |
||||
|
||||
Исходящие подключения: |
||||
|
||||
```json |
||||
{ |
||||
"tag": "out", |
||||
"protocol": "freedom", |
||||
"settings": { |
||||
"redirect": "127.0.0.1:80" // Перенаправить весь трафик на веб-сервер |
||||
} |
||||
} |
||||
``` |
||||
|
||||
```json |
||||
{ |
||||
"protocol": "vmess", |
||||
"settings": { |
||||
"vnext": [ |
||||
{ |
||||
"address": "IP-адрес portal", |
||||
"port": 1024, |
||||
"users": [ |
||||
{ |
||||
"id": "5783a3e7-e373-51cd-8642-c83782b807c5" |
||||
} |
||||
] |
||||
} |
||||
] |
||||
}, |
||||
"tag": "interconn" |
||||
} |
||||
``` |
||||
|
||||
Настройки маршрутизации: |
||||
|
||||
```json |
||||
{ |
||||
"rules": [ |
||||
{ |
||||
"type": "field", |
||||
"inboundTag": ["bridge"], |
||||
"domain": ["full:test.xray.com"], |
||||
"outboundTag": "interconn" |
||||
}, |
||||
{ |
||||
"type": "field", |
||||
"inboundTag": ["bridge"], |
||||
"outboundTag": "out" |
||||
} |
||||
] |
||||
} |
||||
``` |
||||
|
||||
### Настройка portal |
||||
|
||||
`portal` обычно требуется два входящих подключения: одно для приема соединений от `bridge`, а другое - для приема фактического трафика. |
||||
Вам также нужно использовать маршрутизацию, чтобы разделять эти два типа трафика. |
||||
|
||||
Настройки обратного прокси: |
||||
|
||||
```json |
||||
{ |
||||
"portals": [ |
||||
{ |
||||
"tag": "portal", |
||||
"domain": "test.xray.com" // Должно совпадать с настройками bridge |
||||
} |
||||
] |
||||
} |
||||
``` |
||||
|
||||
Входящие подключения: |
||||
|
||||
```json |
||||
{ |
||||
"tag": "external", |
||||
"port": 80, |
||||
"protocol": "dokodemo-door", |
||||
"settings": { |
||||
"address": "127.0.0.1", |
||||
"port": 80, |
||||
"network": "tcp" |
||||
} |
||||
} |
||||
``` |
||||
|
||||
```json |
||||
{ |
||||
"port": 1024, |
||||
"tag": "interconn", |
||||
"protocol": "vmess", |
||||
"settings": { |
||||
"clients": [ |
||||
{ |
||||
"id": "5783a3e7-e373-51cd-8642-c83782b807c5" |
||||
} |
||||
] |
||||
} |
||||
} |
||||
``` |
||||
|
||||
Настройки маршрутизации: |
||||
|
||||
```json |
||||
{ |
||||
"rules": [ |
||||
{ |
||||
"type": "field", |
||||
"inboundTag": ["external"], |
||||
"outboundTag": "portal" |
||||
}, |
||||
{ |
||||
"type": "field", |
||||
"inboundTag": ["interconn"], |
||||
"outboundTag": "portal" |
||||
} |
||||
] |
||||
} |
||||
``` |
@ -0,0 +1,357 @@
|
||||
# Маршрутизация |
||||
|
||||
Модуль маршрутизации позволяет направлять входящие данные через разные исходящие подключения в соответствии с различными правилами, что позволяет реализовать проксирование по требованию. |
||||
|
||||
Например, распространенным сценарием использования является разделение трафика на внутренний и внешний. |
||||
Xray может определять трафик из разных регионов с помощью внутренних механизмов и отправлять его через разные исходящие подключения. |
||||
|
||||
Более подробное описание функции маршрутизации: [Введение в маршрутизацию (routing)](https://xtls.github.io/ru/document/level-1/routing-lv1-part1.html). |
||||
|
||||
## RoutingObject |
||||
|
||||
`RoutingObject` соответствует полю `routing` в конфигурационном файле. |
||||
|
||||
```json |
||||
{ |
||||
"routing": { |
||||
"domainStrategy": "AsIs", |
||||
"domainMatcher": "hybrid", |
||||
"rules": [], |
||||
"balancers": [] |
||||
} |
||||
} |
||||
``` |
||||
|
||||
> `domainStrategy`: "AsIs" | "IPIfNonMatch" | "IPOnDemand" |
||||
|
||||
Стратегия разрешения доменных имен. |
||||
|
||||
- `"AsIs"`: использовать только доменные имена для выбора маршрута. |
||||
Значение по умолчанию. |
||||
- `"IPIfNonMatch"`: если доменное имя не соответствует ни одному правилу, разрешить доменное имя в IP-адрес (запись A или AAAA) и снова выполнить сопоставление. |
||||
- Если у домена есть несколько записей A, Xray попытается сопоставить все записи A, пока одна из них не совпадет с каким-либо правилом. |
||||
- Разрешенный IP-адрес используется только для выбора маршрута, в пересылаемых пакетах данных по-прежнему используется исходное доменное имя. |
||||
- `"IPOnDemand"`: при сопоставлении с любым правилом, основанным на IP-адресе, доменное имя немедленно разрешается в IP-адрес для сопоставления. |
||||
|
||||
> `domainMatcher`: "hybrid" | "linear" |
||||
|
||||
Алгоритм сопоставления доменных имен. |
||||
Этот параметр влияет на все `RuleObject`, для которых не указан алгоритм сопоставления. |
||||
|
||||
- `"hybrid"`: использовать новый алгоритм сопоставления доменных имен, который работает быстрее и занимает меньше памяти. |
||||
Значение по умолчанию. |
||||
- `"linear"`: использовать старый алгоритм сопоставления доменных имен. |
||||
|
||||
> `rules`: \[[RuleObject](#ruleobject)\] |
||||
|
||||
Массив, каждый элемент которого представляет собой правило. |
||||
|
||||
Для каждого соединения маршрутизатор проверяет правила сверху вниз. |
||||
Когда встречается первое подходящее правило, соединение перенаправляется на исходящее подключение, указанное в его `outboundTag` или `balancerTag`. |
||||
|
||||
::: tip |
||||
Если ни одно правило не подходит, трафик отправляется через первое исходящее подключение по умолчанию. |
||||
::: |
||||
|
||||
> `balancers`: \[ [BalancerObject](#balancerobject) \] |
||||
|
||||
Массив, каждый элемент которого представляет собой конфигурацию балансировщика нагрузки. |
||||
|
||||
Если правило указывает на балансировщик нагрузки, Xray выбирает исходящее подключение через этот балансировщик нагрузки и перенаправляет трафик через него. |
||||
|
||||
### RuleObject |
||||
|
||||
```json |
||||
{ |
||||
"domainMatcher": "hybrid", |
||||
"type": "field", |
||||
"domain": ["baidu.com", "qq.com", "geosite:cn"], |
||||
"ip": ["0.0.0.0/8", "10.0.0.0/8", "fc00::/7", "fe80::/10", "geoip:cn"], |
||||
"port": "53,443,1000-2000", |
||||
"sourcePort": "53,443,1000-2000", |
||||
"network": "tcp", |
||||
"source": ["10.0.0.1"], |
||||
"user": ["love@xray.com"], |
||||
"inboundTag": ["tag-vmess"], |
||||
"protocol": ["http", "tls", "bittorrent"], |
||||
"attrs": { ":method": "GET" }, |
||||
"outboundTag": "direct", |
||||
"balancerTag": "balancer" |
||||
} |
||||
``` |
||||
|
||||
::: danger |
||||
Если указано несколько атрибутов, правило применяется только в том случае, если **все** атрибуты совпадают. |
||||
::: |
||||
|
||||
> `domainMatcher`: "hybrid" | "linear" |
||||
|
||||
Алгоритм сопоставления доменных имен. |
||||
Этот параметр имеет приоритет над параметром `domainMatcher` в `RoutingObject`. |
||||
|
||||
- `"hybrid"`: использовать новый алгоритм сопоставления доменных имен, который работает быстрее и занимает меньше памяти. |
||||
Значение по умолчанию. |
||||
- `"linear"`: использовать старый алгоритм сопоставления доменных имен. |
||||
|
||||
> `type`: "field" |
||||
|
||||
В настоящее время поддерживается только значение `"field"`. |
||||
|
||||
::: tip |
||||
В Xray-core v1.8.7 и более поздних версиях эту строку можно опустить. |
||||
::: |
||||
|
||||
> `domain`: \[string\] |
||||
|
||||
Массив, каждый элемент которого представляет собой шаблон доменного имени. |
||||
Доступны следующие форматы: |
||||
|
||||
- Простая строка: правило применяется, если эта строка соответствует любой части целевого доменного имени. |
||||
Например, "sina.com" соответствует "sina.com", "sina.com.cn" и "www.sina.com", но не соответствует "sina.cn". |
||||
- Регулярное выражение: начинается с `"regexp:"`, а остальная часть - это регулярное выражение. |
||||
Правило применяется, если это регулярное выражение соответствует целевому доменному имени. |
||||
Например, "regexp:\\\\.goo.\*\\\\.com\$" соответствует "www.google.com" или "fonts.googleapis.com", но не соответствует "google.com". |
||||
- Поддомен (рекомендуется): начинается с `"domain:"`, а остальная часть - это доменное имя. |
||||
Правило применяется, если это доменное имя является целевым доменным именем или его поддоменом. |
||||
Например, "domain:xray.com" соответствует "www.xray.com" и "xray.com", но не соответствует "wxray.com". |
||||
- Полное совпадение: начинается с `"full:"`, а остальная часть - это доменное имя. |
||||
Правило применяется, если это доменное имя полностью совпадает с целевым доменным именем. |
||||
Например, "full:xray.com" соответствует "xray.com", но не соответствует "www.xray.com". |
||||
- Предопределенный список доменов: начинается с `"geosite:"`, а остальная часть - это имя, например `geosite:google` или `geosite:cn`. |
||||
Список имен и доменов см. в разделе [Предопределенные списки доменов](#предопределенные-списки-доменов). |
||||
- Загрузка доменов из файла: имеет вид `"ext:file:tag"`, где `ext:` (в нижнем регистре) - префикс, за которым следует имя файла и тег. |
||||
Файл должен находиться в [каталоге ресурсов](./features/env.md#пути-к-файлам-ресурсов). |
||||
Формат файла такой же, как у `geosite.dat`. |
||||
Тег должен присутствовать в файле. |
||||
|
||||
::: tip |
||||
`"ext:geoip.dat:cn"` эквивалентно `"geoip:cn"`. |
||||
::: |
||||
|
||||
> `ip`: \[string\] |
||||
|
||||
Массив, каждый элемент которого представляет собой диапазон IP-адресов. |
||||
Правило применяется, если один из элементов соответствует целевому IP-адресу. |
||||
Доступны следующие форматы: |
||||
|
||||
- IP-адрес: например, `"127.0.0.1"`. |
||||
- [CIDR](https://ru.wikipedia.org/wiki/Бесклассовая_междоменная_маршрутизация): например, `"10.0.0.0/8"`. |
||||
- Предопределенный список IP-адресов: этот список включен в каждый установочный пакет Xray и называется `geoip.dat`. |
||||
Используйте формат `"geoip:cn"`, где `geoip:` (в нижнем регистре) - префикс, за которым следует двухбуквенный код страны. |
||||
Поддерживаются практически все страны с доступом в Интернет. |
||||
- Специальное значение: `"geoip:private"`, включает все частные IP-адреса, например `127.0.0.1`. |
||||
- Инверсия (!): `"geoip:!cn"` означает все IP-адреса, кроме тех, что указаны в `geoip:cn`. |
||||
- Загрузка IP-адресов из файла: имеет вид `"ext:file:tag"`, где `ext:` (в нижнем регистре) - префикс, за которым следует имя файла и тег. |
||||
Файл должен находиться в [каталоге ресурсов](./features/env.md#пути-к-файлам-ресурсов). |
||||
Формат файла такой же, как у `geoip.dat`. |
||||
Тег должен присутствовать в файле. |
||||
|
||||
> `port`: number | string |
||||
|
||||
Диапазон портов назначения. |
||||
Доступны следующие форматы: |
||||
|
||||
- `"a-b"`: `a` и `b` - положительные целые числа, меньшие 65536. |
||||
Диапазон является замкнутым, правило применяется, если целевой порт находится в этом диапазоне. |
||||
- `a`: `a` - положительное целое число, меньшее 65536. |
||||
Правило применяется, если целевой порт равен `a`. |
||||
- Комбинация двух вышеуказанных форматов, разделенных запятыми ",". |
||||
Например: `"53,443,1000-2000"`. |
||||
|
||||
> `sourcePort`: number | string |
||||
|
||||
Порт источника. |
||||
Доступны следующие форматы: |
||||
|
||||
- `"a-b"`: `a` и `b` - положительные целые числа, меньшие 65536. |
||||
Диапазон является замкнутым, правило применяется, если порт источника находится в этом диапазоне. |
||||
- `a`: `a` - положительное целое число, меньшее 65536. |
||||
Правило применяется, если порт источника равен `a`. |
||||
- Комбинация двух вышеуказанных форматов, разделенных запятыми ",". |
||||
Например: `"53,443,1000-2000"`. |
||||
|
||||
> `network`: "tcp" | "udp" | "tcp,udp" |
||||
|
||||
Допустимые значения: "tcp", "udp" или "tcp,udp". |
||||
Правило применяется, если тип сети соединения соответствует указанному значению. |
||||
|
||||
> `source`: \[string\] |
||||
|
||||
Массив, каждый элемент которого представляет собой диапазон IP-адресов. |
||||
Доступны следующие форматы: IP-адрес, CIDR, GeoIP и загрузка IP-адресов из файла. |
||||
Правило применяется, если один из элементов соответствует IP-адресу источника. |
||||
|
||||
> `user`: \[string\] |
||||
|
||||
Массив, каждый элемент которого представляет собой адрес электронной почты. |
||||
Правило применяется, если один из элементов соответствует пользователю источника. |
||||
|
||||
> `inboundTag`: \[string\] |
||||
|
||||
Массив, каждый элемент которого представляет собой тег. |
||||
Правило применяется, если один из элементов соответствует тегу входящего протокола. |
||||
|
||||
> `protocol`: \[ "http" | "tls" | "bittorrent" \] |
||||
|
||||
Массив, каждый элемент которого представляет собой протокол. |
||||
Правило применяется, если один из элементов соответствует типу протокола текущего соединения. |
||||
|
||||
::: tip |
||||
Для определения типа протокола соединения необходимо включить параметр `sniffing` во входящем подключении. |
||||
::: |
||||
|
||||
> `attrs`: object |
||||
|
||||
Объект JSON, где ключи и значения являются строками, используемый для проверки атрибутов трафика. |
||||
Правило применяется, если заголовки HTTP содержат все указанные ключи, а значения содержат указанные подстроки. |
||||
Ключи нечувствительны к регистру. |
||||
Значения могут быть регулярными выражениями. |
||||
|
||||
В настоящее время этот атрибут устанавливается только входящим прокси HTTP. |
||||
|
||||
Примеры: |
||||
|
||||
- Проверка HTTP GET: `{":method": "GET"}` |
||||
- Проверка пути HTTP: `{":path": "/test"}"` |
||||
- Проверка типа содержимого: `{"accept": "text/html"}"` |
||||
|
||||
> `outboundTag`: string |
||||
|
||||
Тег исходящего подключения. |
||||
|
||||
> `balancerTag`: string |
||||
|
||||
Тег балансировщика нагрузки. |
||||
|
||||
::: tip |
||||
Необходимо указать либо `balancerTag`, либо `outboundTag`. |
||||
Если указаны оба параметра, используется `outboundTag`. |
||||
::: |
||||
|
||||
### BalancerObject |
||||
|
||||
Настройки балансировщика нагрузки. |
||||
Когда балансировщик нагрузки активируется, он выбирает наиболее подходящее исходящее подключение из указанных и перенаправляет трафик через него. |
||||
|
||||
```json |
||||
{ |
||||
"tag": "balancer", |
||||
"selector": [], |
||||
"fallbackTag": "outbound", |
||||
"strategy": {} |
||||
} |
||||
``` |
||||
|
||||
> `tag`: string |
||||
|
||||
Тег этого балансировщика нагрузки, используемый для сопоставления с `balancerTag` в `RuleObject`. |
||||
|
||||
> `selector`: \[ string \] |
||||
|
||||
Массив строк, каждый элемент которого будет использоваться для сопоставления с префиксом тега исходящего подключения. |
||||
Например, для следующих тегов исходящих подключений: `[ "a", "ab", "c", "ba" ]`, `"selector": ["a"]` будет соответствовать `[ "a", "ab" ]`. |
||||
|
||||
Если найдено несколько совпадений, балансировщик нагрузки в настоящее время выбирает одно из них случайным образом. |
||||
|
||||
> `fallbackTag`: string |
||||
|
||||
Исходящее подключение, которое будет использоваться, если балансировщик нагрузки не сможет выбрать подходящее исходящее подключение. |
||||
|
||||
> `strategy`: [StrategyObject](#strategyobject) |
||||
|
||||
#### StrategyObject |
||||
```json |
||||
{ |
||||
"type": "roundRobin", |
||||
"settings": {} |
||||
} |
||||
``` |
||||
> `type` : "random" | "roundRobin" | "leastPing" | "leastLoad" |
||||
|
||||
- `random` (значение по умолчанию): случайный выбор из подходящих исходящих подключений. |
||||
- `roundRobin`: последовательный выбор из подходящих исходящих подключений. |
||||
- `leastPing`: выбор исходящего подключения с наименьшей задержкой на основе результатов мониторинга подключений. |
||||
Требуется настроить [observatory](./observatory.md#observatoryobject). |
||||
- `leastLoad`: выбор наиболее стабильного исходящего подключения на основе результатов мониторинга подключений. |
||||
Требуется настроить [burstObservatory](./observatory.md#burstobservatoryobject). |
||||
|
||||
> `settings`: [StrategySettingsObject](#strategysettingsobject) |
||||
|
||||
##### StrategySettingsObject |
||||
|
||||
Это необязательный параметр. Формат настройки зависит от стратегии балансировки нагрузки. |
||||
В настоящее время этот параметр можно использовать только со стратегией `leastLoad`. |
||||
|
||||
### Пример конфигурации балансировщика нагрузки |
||||
|
||||
```json |
||||
"routing": { |
||||
"rules": [ |
||||
{ |
||||
"inboundTag": [ |
||||
"in" |
||||
], |
||||
"balancerTag": "round" |
||||
} |
||||
], |
||||
"balancers" : [ |
||||
{ |
||||
"selector": [ |
||||
"out" |
||||
], |
||||
"strategy": { |
||||
"type":"roundRobin" |
||||
}, |
||||
"tag": "round" |
||||
} |
||||
] |
||||
} |
||||
|
||||
"inbounds": [ |
||||
{ |
||||
// Настройки входящего подключения |
||||
"tag": "in" |
||||
} |
||||
] |
||||
|
||||
"outbounds": [ |
||||
{ |
||||
// Настройки исходящего подключения |
||||
"tag": "out1" |
||||
}, |
||||
{ |
||||
// Настройки исходящего подключения |
||||
"tag": "out2" |
||||
} |
||||
] |
||||
``` |
||||
|
||||
### Предопределенные списки доменов |
||||
|
||||
Этот список включен в каждый установочный пакет Xray и называется `geosite.dat`. |
||||
Этот файл содержит некоторые распространенные доменные имена. |
||||
Формат использования: `geosite:filename`, например `geosite:google` означает сопоставление с доменными именами, указанными в файле в разделе `google`, для маршрутизации или фильтрации DNS. |
||||
|
||||
Распространенные доменные имена: |
||||
|
||||
- `category-ads`: содержит доменные имена распространенных рекламных сервисов. |
||||
- `category-ads-all`: содержит доменные имена распространенных рекламных сервисов, а также доменные имена поставщиков рекламы. |
||||
- `cn`: эквивалентно объединению `geolocation-cn` и `tld-cn`. |
||||
- `apple`: содержит большинство доменных имен Apple. |
||||
- `google`: содержит большинство доменных имен Google. |
||||
- `microsoft`: содержит большинство доменных имен Microsoft. |
||||
- `facebook`: содержит большинство доменных имен Facebook. |
||||
- `twitter`: содержит большинство доменных имен Twitter. |
||||
- `telegram`: содержит большинство доменных имен Telegram. |
||||
- `geolocation-cn`: содержит доменные имена распространенных сайтов, расположенных в Китае. |
||||
- `geolocation-!cn`: содержит доменные имена распространенных сайтов, расположенных за пределами Китая, а также `tld-!cn`. |
||||
- `tld-cn`: содержит доменные имена верхнего уровня, управляемые CNNIC и используемые в Китае, например, домены, оканчивающиеся на `.cn`, `.中国`. |
||||
- `tld-!cn`: содержит доменные имена верхнего уровня, не используемые в Китае, например, домены, оканчивающиеся на `.hk` (Гонконг), `.tw` (Тайвань), `.jp` (Япония), `.sg` (Сингапур), `.us` (США), `.ca` (Канада) и т.д. |
||||
|
||||
Вы также можете просмотреть полный список доменов здесь: [Domain list community](https://github.com/v2fly/domain-list-community). |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
@ -0,0 +1,56 @@
|
||||
# Статистика |
||||
|
||||
Используется для настройки сбора статистики трафика Xray. |
||||
|
||||
## StatsObject |
||||
|
||||
`StatsObject` соответствует полю `stats` в конфигурационном файле. |
||||
|
||||
```json |
||||
{ |
||||
"stats": {} |
||||
} |
||||
``` |
||||
|
||||
В настоящее время для статистики не требуется никаких параметров. |
||||
Если поле `StatsObject` присутствует, внутренняя статистика включается. |
||||
|
||||
После включения статистики вам нужно только включить соответствующие параметры в разделе [Политики](./policy.md), чтобы начать сбор статистики. |
||||
|
||||
## Получение статистики |
||||
|
||||
Вы можете получить статистику с помощью соответствующих команд `xray api`. |
||||
|
||||
В настоящее время доступна следующая статистика: |
||||
|
||||
- Данные пользователя |
||||
|
||||
- `user>>>[email]>>>traffic>>>uplink` |
||||
|
||||
Исходящий трафик для определенного пользователя в байтах. |
||||
|
||||
- `user>>>[email]>>>traffic>>>downlink` |
||||
|
||||
Входящий трафик для определенного пользователя в байтах. |
||||
|
||||
::: tip |
||||
Если для пользователя не указан email, статистика для него не будет собираться. |
||||
::: |
||||
|
||||
- Глобальные данные |
||||
|
||||
- `inbound>>>[tag]>>>traffic>>>uplink` |
||||
|
||||
Исходящий трафик для определенного входящего подключения в байтах. |
||||
|
||||
- `inbound>>>[tag]>>>traffic>>>downlink` |
||||
|
||||
Входящий трафик для определенного входящего подключения в байтах. |
||||
|
||||
- `outbound>>>[tag]>>>traffic>>>uplink` |
||||
|
||||
Исходящий трафик для определенного исходящего подключения в байтах. |
||||
|
||||
- `outbound>>>[tag]>>>traffic>>>downlink` |
||||
|
||||
Входящий трафик для определенного исходящего подключения в байтах. |
@ -0,0 +1,889 @@
|
||||
# Транспорт |
||||
|
||||
Транспорт (transport) - это способ, которым текущий узел Xray взаимодействует с другими узлами. |
||||
|
||||
Транспорт определяет способ передачи данных. Обычно оба конца сетевого подключения должны использовать одинаковый транспорт. |
||||
Например, если один конец использует WebSocket, то другой конец также должен использовать WebSocket, иначе соединение не будет установлено. |
||||
|
||||
Настройка транспорта (transport) состоит из двух частей: |
||||
|
||||
1. ~~Глобальные настройки ([TransportObject](#transportobject)) (устарело)~~ |
||||
2. Локальные настройки ([StreamSettingsObject](#streamsettingsobject)). |
||||
|
||||
- Локальные настройки позволяют указать способ передачи данных для каждого отдельного входящего или исходящего подключения. |
||||
- Обычно клиент и сервер должны использовать одинаковый транспорт для соответствующих входящих и исходящих подключений. |
||||
Если в настройках указан тип транспорта, но не указаны конкретные параметры, будут использованы настройки из глобальной конфигурации. |
||||
|
||||
<details> |
||||
<summary>Глобальные настройки</summary> |
||||
|
||||
|
||||
## TransportObject (устарело) |
||||
|
||||
`TransportObject` соответствует полю `transport` в конфигурационном файле. |
||||
|
||||
```json |
||||
{ |
||||
"transport": { |
||||
"tcpSettings": {}, |
||||
"kcpSettings": {}, |
||||
"wsSettings": {}, |
||||
"httpSettings": {}, |
||||
"quicSettings": {}, |
||||
"dsSettings": {}, |
||||
"grpcSettings": {}, |
||||
"httpupgradeSettings": {} |
||||
} |
||||
} |
||||
``` |
||||
|
||||
> `tcpSettings`: [TcpObject](./transports/tcp.md) |
||||
|
||||
Настройки TCP-подключений. |
||||
|
||||
> `kcpSettings`: [KcpObject](./transports/mkcp.md) |
||||
|
||||
Настройки mKCP-подключений. |
||||
|
||||
> `wsSettings`: [WebSocketObject](./transports/websocket.md) |
||||
|
||||
Настройки WebSocket-подключений. |
||||
|
||||
> `httpSettings`: [HttpObject](./transports/h2.md) |
||||
|
||||
Настройки HTTP/2-подключений. |
||||
|
||||
> `quicSettings`: [QuicObject](./transports/quic.md) |
||||
|
||||
Настройки QUIC-подключений. |
||||
|
||||
> `grpcSettings`: [GRPCObject](./transports/grpc.md) |
||||
|
||||
Настройки gRPC-подключений. |
||||
|
||||
> `httpupgradeSettings`: [HttpUpgradeObject](./transports/httpupgrade.md) |
||||
|
||||
Настройки HTTPUpgrade-подключений. |
||||
|
||||
> `splithttpSettings`: [SplitHttpObject](./transports/splithttp.md) |
||||
|
||||
Настройки SplitHTTP-подключений. |
||||
|
||||
> `dsSettings`: [DomainSocketObject](./transports/domainsocket.md) |
||||
|
||||
Настройки Domain Socket-подключений. |
||||
|
||||
</details> |
||||
|
||||
## StreamSettingsObject |
||||
|
||||
`StreamSettingsObject` соответствует полю `streamSettings` во входящем или исходящем подключении. |
||||
Каждое входящее или исходящее подключение может иметь свои собственные настройки транспорта. |
||||
|
||||
```json |
||||
{ |
||||
"network": "tcp", |
||||
"security": "none", |
||||
"tlsSettings": {}, |
||||
"tcpSettings": {}, |
||||
"kcpSettings": {}, |
||||
"wsSettings": {}, |
||||
"httpSettings": {}, |
||||
"quicSettings": {}, |
||||
"dsSettings": {}, |
||||
"grpcSettings": {}, |
||||
"httpupgradeSettings": {}, |
||||
"splithttpSettings": {}, |
||||
"sockopt": { |
||||
"mark": 0, |
||||
"tcpMaxSeg": 1440, |
||||
"tcpFastOpen": false, |
||||
"tproxy": "off", |
||||
"domainStrategy": "AsIs", |
||||
"dialerProxy": "", |
||||
"acceptProxyProtocol": false, |
||||
"tcpKeepAliveInterval": 0, |
||||
"tcpKeepAliveIdle": 300, |
||||
"tcpUserTimeout": 10000, |
||||
"tcpCongestion": "bbr", |
||||
"interface": "wg0", |
||||
"v6only": false, |
||||
"tcpWindowClamp": 600, |
||||
"tcpMptcp": false, |
||||
"tcpNoDelay": false, |
||||
"customSockopt": [] |
||||
} |
||||
} |
||||
``` |
||||
|
||||
> `network`: "tcp" | "ws" | "h2" | "grpc" | "quic" | "kcp" | "httpupgrade" | "splithttp" |
||||
|
||||
Тип транспорта, используемый для передачи данных. |
||||
Значение по умолчанию - `"tcp"`. |
||||
|
||||
::: tip |
||||
"h2" можно записать как "http", "grpc" - как "gun", "kcp" - как "mkcp". |
||||
::: |
||||
|
||||
> `security`: "none" | "tls" | "reality" |
||||
|
||||
Включить шифрование транспортного уровня. |
||||
Доступные значения: |
||||
|
||||
- `"none"` - без шифрования (значение по умолчанию). |
||||
- `"tls"` - использовать [TLS](https://ru.wikipedia.org/wiki/Transport_Layer_Security). |
||||
- `"reality"` - использовать REALITY. |
||||
|
||||
> `tlsSettings`: [TLSObject](#tlsobject) |
||||
|
||||
Настройки TLS. |
||||
TLS предоставляется Golang. |
||||
Обычно в результате согласования TLS используется TLS 1.3, DTLS не поддерживается. |
||||
|
||||
> `realitySettings`: [RealityObject](#realityobject) |
||||
|
||||
Настройки Reality. |
||||
Reality - это оригинальная технология Xray. |
||||
Reality обеспечивает более высокий уровень безопасности, чем TLS, и настраивается аналогично TLS. |
||||
|
||||
::: tip |
||||
Reality - это самый безопасный на данный момент способ шифрования транспорта, и внешний трафик выглядит как обычный интернет-трафик. |
||||
Включение Reality и настройка правильного режима управления потоком XTLS Vision может привести к увеличению производительности в несколько раз. |
||||
::: |
||||
|
||||
> `tcpSettings`: [TcpObject](./transports/tcp.md) |
||||
|
||||
Настройки TCP для текущего подключения, действуют только при использовании TCP. |
||||
Настройки аналогичны глобальным настройкам, описанным выше. |
||||
|
||||
> `kcpSettings`: [KcpObject](./transports/mkcp.md) |
||||
|
||||
Настройки mKCP для текущего подключения, действуют только при использовании mKCP. |
||||
Настройки аналогичны глобальным настройкам, описанным выше. |
||||
|
||||
> `wsSettings`: [WebSocketObject](./transports/websocket.md) |
||||
|
||||
Настройки WebSocket для текущего подключения, действуют только при использовании WebSocket. |
||||
Настройки аналогичны глобальным настройкам, описанным выше. |
||||
|
||||
> `httpSettings`: [HttpObject](./transports/h2.md) |
||||
|
||||
Настройки HTTP/2 для текущего подключения, действуют только при использовании HTTP/2. |
||||
Настройки аналогичны глобальным настройкам, описанным выше. |
||||
|
||||
> `quicSettings`: [QUICObject](./transports/quic.md) |
||||
|
||||
Настройки QUIC для текущего подключения, действуют только при использовании QUIC. |
||||
Настройки аналогичны глобальным настройкам, описанным выше. |
||||
|
||||
> `grpcSettings`: [GRPCObject](./transports/grpc.md) |
||||
|
||||
Настройки gRPC для текущего подключения, действуют только при использовании gRPC. |
||||
Настройки аналогичны глобальным настройкам, описанным выше. |
||||
|
||||
> `dsSettings`: [DomainSocketObject](./transports/domainsocket.md) |
||||
|
||||
Настройки Domain socket для текущего подключения, действуют только при использовании Domain socket. |
||||
Настройки аналогичны глобальным настройкам, описанным выше. |
||||
|
||||
> `httpupgradeSettings`: [HttpUpgradeObject](./transports/httpupgrade.md) |
||||
|
||||
Настройки HTTPUpgrade для текущего подключения, действуют только при использовании HTTPUpgrade. |
||||
Настройки аналогичны глобальным настройкам, описанным выше. |
||||
|
||||
> `splithttpSettings`: [SplitHttpObject](./transports/splithttp.md) |
||||
|
||||
Настройки SplitHTTP для текущего подключения, действуют только при использовании SplitHTTP. |
||||
Настройки аналогичны глобальным настройкам, описанным выше. |
||||
|
||||
> `sockopt`: [SockoptObject](#sockoptobject) |
||||
|
||||
Настройки прозрачного прокси. |
||||
|
||||
### TLSObject |
||||
|
||||
```json |
||||
{ |
||||
"serverName": "xray.com", |
||||
"rejectUnknownSni": false, |
||||
"allowInsecure": false, |
||||
"alpn": ["h2", "http/1.1"], |
||||
"minVersion": "1.2", |
||||
"maxVersion": "1.3", |
||||
"cipherSuites": "список наборов шифров, разделенных двоеточиями", |
||||
"certificates": [], |
||||
"disableSystemRoot": false, |
||||
"enableSessionResumption": false, |
||||
"fingerprint": "", |
||||
"pinnedPeerCertificateChainSha256": [""], |
||||
"masterKeyLog": "" |
||||
} |
||||
``` |
||||
|
||||
> `serverName`: string |
||||
|
||||
Доменное имя сертификата сервера. |
||||
Используется, если соединение установлено по IP-адресу. |
||||
|
||||
Если этот параметр не указан, автоматически используется значение из `address` (если это доменное имя). |
||||
Это значение также используется для проверки действительности сертификата сервера. |
||||
|
||||
::: tip |
||||
Как упомянуто выше, поскольку это значение также используется для проверки действительности сертификата сервера, если по какой-либо причине вам нужно указать значение, отличное от доменного имени в сертификате сервера, необходимо включить параметр `allowInsecure`, иначе проверка сертификата завершится неудачей. |
||||
Из соображений безопасности мы не рекомендуем использовать этот метод постоянно. |
||||
Если вам нужно безопасно подменить SNI, рассмотрите возможность использования REALITY. |
||||
|
||||
В частности, если на клиенте указан IP-адрес, Xray не будет отправлять SNI. |
||||
Чтобы использовать эту функцию, также необходимо включить `allowInsecure`. |
||||
::: |
||||
|
||||
> `rejectUnknownSni`: bool |
||||
|
||||
Если значение равно `true`, сервер отклонит рукопожатие TLS, если полученный SNI не совпадает с доменным именем в сертификате. |
||||
Значение по умолчанию - `false`. |
||||
|
||||
> `alpn`: \[ string \] |
||||
|
||||
Массив строк, указывающий значения ALPN, используемые при рукопожатии TLS. |
||||
Значение по умолчанию - `["h2", "http/1.1"]`. |
||||
|
||||
> `minVersion`: string |
||||
|
||||
Минимальная допустимая версия TLS. |
||||
|
||||
> `maxVersion`: string |
||||
|
||||
Максимальная допустимая версия TLS. |
||||
|
||||
> `cipherSuites`: string |
||||
|
||||
Список поддерживаемых наборов шифров, разделенных двоеточиями. |
||||
|
||||
Список наборов шифров Golang и их описания можно найти [здесь](https://golang.org/src/crypto/tls/cipher_suites.go#L500) или [здесь](https://golang.org/src/crypto/tls/cipher_suites.go#L44). |
||||
|
||||
::: danger |
||||
Эти два параметра не являются обязательными и обычно не влияют на безопасность. |
||||
Если они не настроены, Golang автоматически выбирает их в зависимости от устройства. |
||||
Если вы не знакомы с этими параметрами, не настраивайте их. |
||||
Вы несете ответственность за любые проблемы, вызванные неправильной настройкой. |
||||
::: |
||||
|
||||
> `allowInsecure`: true | false |
||||
|
||||
Разрешить небезопасные соединения (только для клиентов). |
||||
Значение по умолчанию - `false`. |
||||
|
||||
Если значение равно `true`, Xray не будет проверять действительность сертификата TLS, предоставленного удаленным хостом. |
||||
|
||||
::: danger |
||||
Из соображений безопасности не рекомендуется устанавливать этот параметр в `true` в реальных сценариях, так как это может сделать вас уязвимыми для атак типа "человек посередине". |
||||
::: |
||||
|
||||
> `disableSystemRoot`: true | false |
||||
|
||||
Отключить использование корневых сертификатов, предоставляемых операционной системой. |
||||
Значение по умолчанию - `false`. |
||||
|
||||
Если значение равно `true`, Xray будет использовать только сертификаты, указанные в `certificates`, для рукопожатия TLS. |
||||
Если значение равно `false`, Xray будет использовать только корневые сертификаты, предоставляемые операционной системой, для рукопожатия TLS. |
||||
|
||||
> `enableSessionResumption`: true | false |
||||
|
||||
Если этот параметр установлен в `false`, расширение `session_ticket` не будет включено в ClientHello. |
||||
Обычно программы на Golang не используют это расширение в ClientHello, поэтому рекомендуется оставить значение по умолчанию. |
||||
Значение по умолчанию - `false`. |
||||
|
||||
> `fingerprint`: string |
||||
|
||||
Этот параметр используется для настройки отпечатка `TLS Client Hello`. |
||||
Если значение пустое, эта функция отключена. |
||||
Если эта функция включена, Xray будет **эмулировать** отпечаток `TLS` с помощью библиотеки uTLS или генерировать его случайным образом. |
||||
Поддерживаются три способа настройки: |
||||
|
||||
1. Отпечатки TLS последних версий популярных браузеров, включая: |
||||
|
||||
- `"chrome"` |
||||
- `"firefox"` |
||||
- `"safari"` |
||||
- `"ios"` |
||||
- `"android"` |
||||
- `"edge"` |
||||
- `"360"` |
||||
- `"qq"` |
||||
|
||||
2. Автоматическая генерация отпечатка при запуске Xray: |
||||
|
||||
- `"random"`: случайный выбор из отпечатков последних версий браузеров. |
||||
- `"randomized"`: генерация полностью случайного уникального отпечатка (100% поддержка TLS 1.3 с использованием X25519). |
||||
|
||||
3. Использование имен переменных отпечатков uTLS, например, `"HelloRandomizedNoALPN"`, `"HelloChrome_106_Shuffle"`. |
||||
Полный список см. в [библиотеке uTLS](https://github.com/refraction-networking/utls/blob/master/u_common.go#L434). |
||||
|
||||
::: tip |
||||
Эта функция только **эмулирует** отпечаток `TLS Client Hello`, поведение и другие отпечатки такие же, как у Golang. |
||||
Если вам нужно более полно эмулировать отпечаток `TLS` и поведение браузера, используйте [Browser Dialer](./transports/websocket.md#browser-dialer). |
||||
::: |
||||
|
||||
> `pinnedPeerCertificateChainSha256`: \[string\] |
||||
|
||||
SHA256-хэш цепочки сертификатов удаленного сервера в стандартном формате кодировки. |
||||
Соединение TLS будет успешно установлено, только если хэш цепочки сертификатов сервера совпадает с одним из значений в этом списке. |
||||
|
||||
Если соединение не удалось установить из-за этой настройки, будет показан хэш цепочки сертификатов удаленного сервера. |
||||
|
||||
::: danger |
||||
Не рекомендуется использовать этот способ для получения хэша цепочки сертификатов, так как в этом случае у вас не будет возможности проверить, является ли сертификат, предоставленный сервером, подлинным, и поэтому вы не можете гарантировать, что полученный хэш сертификата будет ожидаемым. |
||||
::: |
||||
|
||||
::: tip |
||||
Если вам нужно получить хэш сертификата, запустите команду `xray tls certChainHash --cert <cert.pem>` в командной строке, где `<cert.pem>` - это путь к файлу сертификата. |
||||
::: |
||||
|
||||
> `certificates`: \[ [CertificateObject](#certificateobject) \] |
||||
|
||||
Список сертификатов, каждый элемент которого представляет собой сертификат (рекомендуется использовать fullchain). |
||||
|
||||
::: tip |
||||
Если вам нужно получить оценку A/A+ в ssllibs или myssl, см. [здесь](https://github.com/XTLS/Xray-core/discussions/56#discussioncomment-215600). |
||||
::: |
||||
|
||||
> `masterKeyLog` : string |
||||
|
||||
Путь к файлу журнала (pre)-master-secret, который можно использовать для расшифровки TLS-соединений, отправляемых Xray, в таких программах, как Wireshark. |
||||
Пока не поддерживается совместное использование с utls. |
||||
Требуется Xray-Core v1.8.7. |
||||
|
||||
### RealityObject |
||||
|
||||
```json |
||||
{ |
||||
"show": false, |
||||
"dest": "example.com:443", |
||||
"xver": 0, |
||||
"serverNames": ["example.com", "www.example.com"], |
||||
"privateKey": "", |
||||
"minClientVer": "", |
||||
"maxClientVer": "", |
||||
"maxTimeDiff": 0, |
||||
"shortIds": ["", "0123456789abcdef"], |
||||
"fingerprint": "chrome", |
||||
"serverName": "", |
||||
"publicKey": "", |
||||
"shortId": "", |
||||
"spiderX": "" |
||||
} |
||||
``` |
||||
|
||||
::: tip |
||||
Дополнительную информацию см. в проекте [REALITY](https://github.com/XTLS/REALITY). |
||||
::: |
||||
|
||||
> `show`: true | false |
||||
|
||||
Если значение равно `true`, выводить отладочную информацию. |
||||
|
||||
::: tip |
||||
Настройки для **входящего** подключения (**сервер**). |
||||
::: |
||||
|
||||
> `dest`: string |
||||
|
||||
Обязательный параметр, формат такой же, как у `dest` в `fallbacks` для VLESS [dest](https://xtls.github.io/config/features/fallback.html#fallbackobject). |
||||
|
||||
::: warning |
||||
Для лучшей маскировки Xray **напрямую перенаправляет** трафик, не прошедший аутентификацию Reality (незаконные запросы Reality), на `dest`. |
||||
Если IP-адрес сайта `dest` является особенным (например, сайт использует CDN CloudFlare), то ваш сервер будет действовать как переадресатор портов для CloudFlare, что может привести к утечке трафика после сканирования. |
||||
Чтобы избежать этого, можно использовать Nginx или другие средства для фильтрации нежелательных SNI. |
||||
::: |
||||
|
||||
> `xver`: number |
||||
|
||||
Необязательный параметр, формат такой же, как у `xver` в `fallbacks` для VLESS [xver](https://xtls.github.io/config/features/fallback.html#fallbackobject). |
||||
|
||||
> `serverNames`: \[string\] |
||||
|
||||
Обязательный параметр, список допустимых `serverName` для клиентов. |
||||
Пока не поддерживаются подстановочные знаки \*. |
||||
|
||||
Обычно это значение совпадает с `dest`. |
||||
Фактически допустимыми значениями являются любые SNI, принимаемые сервером (в зависимости от конфигурации `dest`). |
||||
В качестве ориентира можно использовать [SAN](https://ru.wikipedia.org/wiki/Subject_Alternative_Name) возвращаемого сертификата. |
||||
|
||||
Может содержать пустое значение `""`, что означает прием подключений без SNI. |
||||
|
||||
> `privateKey`: string |
||||
|
||||
Обязательный параметр, сгенерируйте его, выполнив команду `./xray x25519`. |
||||
|
||||
> `minClientVer`: string |
||||
|
||||
Необязательный параметр, минимальная версия Xray на клиенте, формат: `x.y.z`. |
||||
|
||||
> `maxClientVer`: string |
||||
|
||||
Необязательный параметр, максимальная версия Xray на клиенте, формат: `x.y.z`. |
||||
|
||||
> `maxTimeDiff`: number |
||||
|
||||
Необязательный параметр, максимально допустимая разница во времени в миллисекундах. |
||||
|
||||
> `shortIds`: \[string\] |
||||
|
||||
Обязательный параметр, список допустимых `shortId` для клиентов, которые можно использовать для различения разных клиентов. |
||||
|
||||
Состоит из символов от 0 до f, длина должна быть кратна 2, максимальная длина - 16. |
||||
|
||||
Если список содержит пустое значение, `shortId` на клиенте может быть пустым. |
||||
|
||||
::: tip |
||||
Настройки для **исходящего** подключения (**клиент**). |
||||
::: |
||||
|
||||
> `serverName`: string |
||||
|
||||
Одно из значений `serverNames` на сервере. |
||||
|
||||
Если `serverNames` на сервере содержит пустое значение, на клиенте можно использовать `"serverName": "0.0.0.0"`, как и в TLS, для установления соединения без SNI. |
||||
В отличие от TLS, в REALITY для использования этой функции не нужно включать параметр `allowInsecure`. |
||||
При использовании этой функции убедитесь, что `dest` возвращает сертификат по умолчанию при приеме соединений без SNI. |
||||
|
||||
> `fingerprint`: string |
||||
|
||||
Обязательный параметр, такой же, как в [TLSObject](https://xtls.github.io/config/transport.html#tlsobject). |
||||
|
||||
> `shortId`: string |
||||
|
||||
Одно из значений `shortIds` на сервере. |
||||
|
||||
Состоит из символов от 0 до f, длина должна быть кратна 2, максимальная длина - 16. |
||||
|
||||
Если `shordIDs` на сервере содержит пустое значение, этот параметр на клиенте может быть пустым. |
||||
|
||||
> `publicKey`: string |
||||
|
||||
Обязательный параметр, открытый ключ, соответствующий закрытому ключу сервера. |
||||
Сгенерируйте его с помощью команды `./xray x25519 -i "закрытый ключ сервера"`. |
||||
|
||||
> `spiderX`: string |
||||
|
||||
Начальный путь и параметры для краулера, рекомендуется использовать разные значения для каждого клиента. |
||||
|
||||
#### CertificateObject |
||||
|
||||
```json |
||||
{ |
||||
"ocspStapling": 3600, |
||||
"oneTimeLoading": false, |
||||
"usage": "encipherment", |
||||
"certificateFile": "/path/to/certificate.crt", |
||||
"keyFile": "/path/to/key.key", |
||||
"certificate": [ |
||||
"--BEGIN CERTIFICATE--", |
||||
"MIICwDCCAaigAwIBAgIRAO16JMdESAuHidFYJAR/7kAwDQYJKoZIhvcNAQELBQAw", |
||||
"ADAeFw0xODA0MTAxMzU1MTdaFw0xODA0MTAxNTU1MTdaMAAwggEiMA0GCSqGSIb3", |
||||
"DQEBAQUAA4IBDwAwggEKAoIBAQCs2PX0fFSCjOemmdm9UbOvcLctF94Ox4BpSfJ+", |
||||
"3lJHwZbvnOFuo56WhQJWrclKoImp/c9veL1J4Bbtam3sW3APkZVEK9UxRQ57HQuw", |
||||
"OzhV0FD20/0YELou85TwnkTw5l9GVCXT02NG+pGlYsFrxesUHpojdl8tIcn113M5", |
||||
"pypgDPVmPeeORRf7nseMC6GhvXYM4txJPyenohwegl8DZ6OE5FkSVR5wFQtAhbON", |
||||
"OAkIVVmw002K2J6pitPuJGOka9PxcCVWhko/W+JCGapcC7O74palwBUuXE1iH+Jp", |
||||
"noPjGp4qE2ognW3WH/sgQ+rvo20eXb9Um1steaYY8xlxgBsXAgMBAAGjNTAzMA4G", |
||||
"A1UdDwEB/wQEAwIFoDATBgNVHSUEDDAKBggrBgEFBQcDATAMBgNVHRMBAf8EAjAA", |
||||
"MA0GCSqGSIb3DQEBCwUAA4IBAQBUd9sGKYemzwPnxtw/vzkV8Q32NILEMlPVqeJU", |
||||
"7UxVgIODBV6A1b3tOUoktuhmgSSaQxjhYbFAVTD+LUglMUCxNbj56luBRlLLQWo+", |
||||
"9BUhC/ow393tLmqKcB59qNcwbZER6XT5POYwcaKM75QVqhCJVHJNb1zSEE7Co7iO", |
||||
"6wIan3lFyjBfYlBEz5vyRWQNIwKfdh5cK1yAu13xGENwmtlSTHiwbjBLXfk+0A/8", |
||||
"r/2s+sCYUkGZHhj8xY7bJ1zg0FRalP5LrqY+r6BckT1QPDIQKYy615j1LpOtwZe/", |
||||
"d4q7MD/dkzRDsch7t2cIjM/PYeMuzh87admSyL6hdtK0Nm/Q", |
||||
"--END CERTIFICATE--" |
||||
], |
||||
"key": [ |
||||
"--BEGIN RSA PRIVATE KEY--", |
||||
"MIIEowIBAAKCAQEArNj19HxUgoznppnZvVGzr3C3LRfeDseAaUnyft5SR8GW75zh", |
||||
"bqOeloUCVq3JSqCJqf3Pb3i9SeAW7Wpt7FtwD5GVRCvVMUUOex0LsDs4VdBQ9tP9", |
||||
"GBC6LvOU8J5E8OZfRlQl09NjRvqRpWLBa8XrFB6aI3ZfLSHJ9ddzOacqYAz1Zj3n", |
||||
"jkUX+57HjAuhob12DOLcST8np6IcHoJfA2ejhORZElUecBULQIWzjTgJCFVZsNNN", |
||||
"itieqYrT7iRjpGvT8XAlVoZKP1viQhmqXAuzu+KWpcAVLlxNYh/iaZ6D4xqeKhNq", |
||||
"IJ1t1h/7IEPq76NtHl2/VJtbLXmmGPMZcYAbFwIDAQABAoIBAFCgG4phfGIxK9Uw", |
||||
"qrp+o9xQLYGhQnmOYb27OpwnRCYojSlT+mvLcqwvevnHsr9WxyA+PkZ3AYS2PLue", |
||||
"C4xW0pzQgdn8wENtPOX8lHkuBocw1rNsCwDwvIguIuliSjI8o3CAy+xVDFgNhWap", |
||||
"/CMzfQYziB7GlnrM6hH838iiy0dlv4I/HKk+3/YlSYQEvnFokTf7HxbDDmznkJTM", |
||||
"aPKZ5qbnV+4AcQfcLYJ8QE0ViJ8dVZ7RLwIf7+SG0b0bqloti4+oQXqGtiESUwEW", |
||||
"/Wzi7oyCbFJoPsFWp1P5+wD7jAGpAd9lPIwPahdr1wl6VwIx9W0XYjoZn71AEaw4", |
||||
"bK4xUXECgYEA3g2o9WqyrhYSax3pGEdvV2qN0VQhw7Xe+jyy98CELOO2DNbB9QNJ", |
||||
"8cSSU/PjkxQlgbOJc8DEprdMldN5xI/srlsbQWCj72wXxXnVnh991bI2clwt7oYi", |
||||
"pcGZwzCrJyFL+QaZmYzLxkxYl1tCiiuqLm+EkjxCWKTX/kKEFb6rtnMCgYEAx0WR", |
||||
"L8Uue3lXxhXRdBS5QRTBNklkSxtU+2yyXRpvFa7Qam+GghJs5RKfJ9lTvjfM/PxG", |
||||
"3vhuBliWQOKQbm1ZGLbgGBM505EOP7DikUmH/kzKxIeRo4l64mioKdDwK/4CZtS7", |
||||
"az0Lq3eS6bq11qL4mEdE6Gn/Y+sqB83GHZYju80CgYABFm4KbbBcW+1RKv9WSBtK", |
||||
"gVIagV/89moWLa/uuLmtApyEqZSfn5mAHqdc0+f8c2/Pl9KHh50u99zfKv8AsHfH", |
||||
"TtjuVAvZg10GcZdTQ/I41ruficYL0gpfZ3haVWWxNl+J47di4iapXPxeGWtVA+u8", |
||||
"eH1cvgDRMFWCgE7nUFzE8wKBgGndUomfZtdgGrp4ouLZk6W4ogD2MpsYNSixkXyW", |
||||
"64cIbV7uSvZVVZbJMtaXxb6bpIKOgBQ6xTEH5SMpenPAEgJoPVts816rhHdfwK5Q", |
||||
"8zetklegckYAZtFbqmM0xjOI6bu5rqwFLWr1xo33jF0wDYPQ8RHMJkruB1FIB8V2", |
||||
"GxvNAoGBAM4g2z8NTPMqX+8IBGkGgqmcYuRQxd3cs7LOSEjF9hPy1it2ZFe/yUKq", |
||||
"ePa2E8osffK5LBkFzhyQb0WrGC9ijM9E6rv10gyuNjlwXdFJcdqVamxwPUBtxRJR", |
||||
"cYTY2HRkJXDdtT0Bkc3josE6UUDvwMpO0CfAETQPto1tjNEDhQhT", |
||||
"--END RSA PRIVATE KEY--" |
||||
] |
||||
} |
||||
``` |
||||
|
||||
> `ocspStapling`: number |
||||
|
||||
Интервал обновления OCSP-стейплинга. |
||||
Совпадает с интервалом перезагрузки сертификата. |
||||
Единица измерения: секунды. |
||||
Значение по умолчанию - `3600` (1 час). |
||||
|
||||
> `oneTimeLoading`: true | false |
||||
|
||||
Загрузить только один раз. |
||||
Если значение равно `true`, функция перезагрузки сертификата и OCSP-стейплинга отключаются. |
||||
|
||||
::: warning |
||||
Если значение равно `true`, OCSP-стейплинг будет отключен. |
||||
::: |
||||
|
||||
> `usage`: "encipherment" | "verify" | "issue" |
||||
|
||||
Назначение сертификата. |
||||
Значение по умолчанию - `"encipherment"`. |
||||
|
||||
- `"encipherment"`: сертификат используется для аутентификации и шифрования TLS. |
||||
- `"verify"`: сертификат используется для проверки сертификата удаленного TLS-сервера. |
||||
При использовании этого значения текущий сертификат должен быть сертификатом ЦС. |
||||
- `"issue"`: сертификат используется для выпуска других сертификатов. |
||||
При использовании этого значения текущий сертификат должен быть сертификатом ЦС. |
||||
|
||||
::: tip Совет 1 |
||||
В Windows можно установить самозаверяющий сертификат ЦС в систему, чтобы проверять сертификаты удаленных TLS-серверов. |
||||
::: |
||||
|
||||
::: tip Совет 2 |
||||
При получении нового запроса от клиента, если указанный `serverName` равен `"xray.com"`, Xray сначала ищет в списке сертификатов сертификат, который можно использовать для `"xray.com"`. |
||||
Если подходящий сертификат не найден, Xray использует любой сертификат с `usage` = `"issue"` для выпуска нового сертификата для `"xray.com"` со сроком действия один час. |
||||
Новый сертификат добавляется в список сертификатов для последующего использования. |
||||
::: |
||||
|
||||
::: tip Совет 3 |
||||
Если указаны и `certificateFile`, и `certificate`, Xray использует `certificateFile`. |
||||
То же самое относится к `keyFile` и `key`. |
||||
::: |
||||
|
||||
::: tip Совет 4 |
||||
Если `usage` равен `"verify"`, `keyFile` и `key` могут быть пустыми. |
||||
::: |
||||
|
||||
::: tip Совет 5 |
||||
Можно сгенерировать самозаверяющий сертификат ЦС с помощью команды `xray tls cert`. |
||||
::: |
||||
|
||||
::: tip Совет 6 |
||||
Если у вас есть доменное имя, вы можете легко получить бесплатный сторонний сертификат с помощью таких инструментов, как [acme.sh](https://github.com/acmesh-official/acme.sh). |
||||
::: |
||||
|
||||
> `certificateFile`: string |
||||
|
||||
Путь к файлу сертификата, например, сертификат, сгенерированный OpenSSL, с расширением .crt. |
||||
|
||||
> `certificate`: \[ string \] |
||||
|
||||
Массив строк, представляющий содержимое сертификата, как показано в примере. |
||||
`certificate` и `certificateFile` - взаимоисключающие параметры. |
||||
|
||||
> `keyFile`: string |
||||
|
||||
Путь к файлу ключа, например, ключ, сгенерированный OpenSSL, с расширением .key. |
||||
В настоящее время не поддерживаются файлы ключей, защищенные паролем. |
||||
|
||||
> `key`: \[ string \] |
||||
|
||||
Массив строк, представляющий содержимое ключа, как показано в примере. |
||||
`key` и `keyFile` - взаимоисключающие параметры. |
||||
|
||||
### SockoptObject |
||||
|
||||
```json |
||||
{ |
||||
"mark": 0, |
||||
"tcpMaxSeg": 1440, |
||||
"tcpFastOpen": false, |
||||
"tproxy": "off", |
||||
"domainStrategy": "AsIs", |
||||
"dialerProxy": "", |
||||
"acceptProxyProtocol": false, |
||||
"tcpKeepAliveInterval": 0, |
||||
"tcpKeepAliveIdle": 300, |
||||
"tcpUserTimeout": 10000, |
||||
"tcpcongestion": "bbr", |
||||
"interface": "wg0", |
||||
"V6Only": false, |
||||
"tcpWindowClamp": 600, |
||||
"tcpMptcp": false, |
||||
"tcpNoDelay": false, |
||||
"customSockopt": [] |
||||
} |
||||
``` |
||||
|
||||
> `mark`: number |
||||
|
||||
Целое число. |
||||
Если значение не равно нулю, исходящее соединение будет помечено этим значением SO_MARK. |
||||
|
||||
- Работает только в Linux. |
||||
- Требуются права CAP_NET_ADMIN. |
||||
|
||||
> `tcpMaxSeg`: number |
||||
|
||||
Устанавливает максимальный размер сегмента TCP (MSS). |
||||
|
||||
> `tcpFastOpen`: true | false | number |
||||
|
||||
Включить [TCP Fast Open](https://ru.wikipedia.org/wiki/TCP_Fast_Open) (TFO). |
||||
|
||||
Если значение равно `true` или **положительному целому числу**, TFO включен. |
||||
Если значение равно `false` или **отрицательному числу**, TFO принудительно отключен. |
||||
Если этот параметр не указан или равен `0`, используются настройки системы по умолчанию. |
||||
Может использоваться как для входящих, так и для исходящих подключений. |
||||
|
||||
- Доступно только в следующих (или более поздних) версиях операционных систем: |
||||
|
||||
- Linux 3.16: требуется настроить параметр ядра `net.ipv4.tcp_fastopen`. |
||||
Этот параметр представляет собой битовую маску, где `0x1` означает, что TFO разрешен для клиентов, а `0x2` - для серверов. |
||||
Значение по умолчанию - `0x1`. |
||||
Если вы хотите включить TFO на сервере, установите значение этого параметра ядра в `0x3`. |
||||
- ~~Windows 10 (1607)~~ (неправильная реализация). |
||||
- Mac OS 10.11 / iOS 9 (требуется тестирование). |
||||
- FreeBSD 10.3 (сервер) / 12.0 (клиент): необходимо установить параметры ядра `net.inet.tcp.fastopen.server_enabled` и `net.inet.tcp.fastopen.client_enabled` в `1`. |
||||
(Требуется тестирование.) |
||||
|
||||
- Для входящих подключений указанное здесь **положительное целое число** представляет собой [максимальное количество ожидающих запросов на подключение TFO](https://tools.ietf.org/html/rfc7413#section-5.1). |
||||
**Обратите внимание, что не все операционные системы поддерживают эту настройку:** |
||||
|
||||
- Linux / FreeBSD: указанное здесь **положительное целое число** представляет собой максимальное значение, максимальное допустимое значение - 2147483647. |
||||
Если значение равно `true`, используется значение `256`. |
||||
Обратите внимание, что в Linux параметр `net.core.somaxconn` ограничивает максимальное значение этого параметра. |
||||
Если значение превышает `somaxconn`, увеличьте `somaxconn`. |
||||
- Mac OS: если значение равно `true` или **положительному целому числу**, это означает только, что TFO включен. |
||||
Максимальное значение нужно настроить отдельно с помощью параметра ядра `net.inet.tcp.fastopen_backlog`. |
||||
- Windows: если значение равно `true` или **положительному целому числу**, это означает только, что TFO включен. |
||||
|
||||
- Для исходящих подключений значение `true` или **положительное целое число** означает только, что TFO включен, во всех операционных системах. |
||||
|
||||
> `tproxy`: "redirect" | "tproxy" | "off" |
||||
|
||||
Включить прозрачное проксирование (только для Linux). |
||||
|
||||
- `"redirect"`: использовать прозрачное проксирование в режиме Redirect. |
||||
Поддерживаются все TCP- и UDP-соединения на основе IPv4/6. |
||||
- `"tproxy"`: использовать прозрачное проксирование в режиме TProxy. |
||||
Поддерживаются все TCP- и UDP-соединения на основе IPv4/6. |
||||
- `"off"`: отключить прозрачное проксирование. |
||||
|
||||
Для прозрачного проксирования требуются права root или `CAP\_NET\_ADMIN`. |
||||
|
||||
::: danger |
||||
Если в [Dokodemo-door](./inbounds/dokodemo.md) параметр `followRedirect` установлен в `true`, а параметр `tproxy` в Sockopt не указан, значение `tproxy` в Sockopt будет установлено в `"redirect"`. |
||||
::: |
||||
|
||||
> `domainStrategy`: "AsIs"<br> |
||||
> "UseIP" | "UseIPv6v4" | "UseIPv6" | "UseIPv4v6" | "UseIPv4"<br> |
||||
> "ForceIP" | "ForceIPv6v4" | "ForceIPv6" | "ForceIPv4v6" | "ForceIPv4" |
||||
|
||||
|
||||
В предыдущих версиях, когда Xray пытался установить системное соединение с использованием доменного имени, разрешение доменного имени выполнялось системой и не контролировалось Xray. |
||||
Это приводило к таким проблемам, как [невозможность разрешения доменных имен в нестандартных средах Linux](https://github.com/v2ray/v2ray-core/issues/1909). |
||||
Чтобы решить эту проблему, в Xray 1.3.1 был добавлен параметр `domainStrategy` в Sockopt, аналогичный параметру в Freedom. |
||||
|
||||
Значение по умолчанию - `"AsIs"`. |
||||
|
||||
При использовании доменного имени в качестве целевого адреса поведение Freedom зависит от значения этого параметра: |
||||
|
||||
- `"AsIs"`: Xray будет использовать системный стек для установления соединения, приоритет и выбор IP-адреса зависят от настроек системы. |
||||
- При указании других значений будет использоваться [встроенный DNS-сервер](../dns.md) Xray-core для разрешения доменного имени. |
||||
Если `DnsObject` не настроен, будет использоваться системный DNS. |
||||
Если для домена найдено несколько подходящих IP-адресов, ядро случайным образом выберет один из них в качестве целевого IP-адреса. |
||||
- `"IPv4"` - попытаться использовать только IPv4 для подключения, `"IPv4v6"` - попытаться использовать IPv4 или IPv6, но для доменов с двумя стеками отдать предпочтение IPv4. |
||||
(То же самое относится к `IPv6v4`, не будем повторяться.) |
||||
- Если в настройках встроенного DNS указан параметр `"queryStrategy"`, фактическое поведение будет определяться пересечением этих двух параметров, будут разрешены только IP-адреса тех типов, которые указаны в обоих параметрах. |
||||
Например, если `"queryStrategy": "UseIPv4"` и `"domainStrategy": "UseIP"`, это фактически эквивалентно `"domainStrategy": "UseIPv4"`. |
||||
- Если используется значение, начинающееся с `"Use"`, и результат разрешения не соответствует требованиям (например, у домена есть только IPv4-адрес, но используется `UseIPv6`), Xray переключится на `AsIs`. |
||||
- Если используется значение, начинающееся с `"Force"`, и результат разрешения не соответствует требованиям, соединение не будет установлено. |
||||
|
||||
::: tip Совет |
||||
При использовании режимов `"UseIP"` и `"ForceIP"` и указании `sendThrough` в [настройках исходящего подключения](../outbound.md#outboundobject) Freedom автоматически определит необходимый тип IP-адреса (IPv4 или IPv6) на основе значения `sendThrough`. |
||||
Если вручную указан один тип IP-адреса (например, `UseIPv4`), но он не совпадает с локальным адресом, указанным в `sendThrough`, соединение не будет установлено. |
||||
::: |
||||
|
||||
::: danger |
||||
|
||||
Неправильная настройка этой функции может привести к бесконечному циклу. |
||||
|
||||
Коротко говоря: для подключения к серверу нужно дождаться результата DNS-запроса, а для завершения DNS-запроса нужно подключиться к серверу. |
||||
|
||||
> Тони: Что было раньше, курица или яйцо? |
||||
|
||||
Подробное объяснение: |
||||
|
||||
1. Условия возникновения: прокси-сервер (proxy.com), встроенный DNS-сервер, не локальный режим. |
||||
2. **Перед** установлением TCP-соединения с proxy.com Xray пытается разрешить proxy.com с помощью встроенного DNS-сервера. |
||||
3. Встроенный DNS-сервер устанавливает соединение с dns.com и отправляет запрос для получения IP-адреса proxy.com. |
||||
4. **Неправильные** правила маршрутизации приводят к тому, что proxy.com проксирует запрос, отправленный на шаге 3. |
||||
5. Xray пытается установить еще одно TCP-соединение с proxy.com. |
||||
6. Перед установлением соединения Xray пытается разрешить proxy.com с помощью встроенного DNS-сервера. |
||||
7. Встроенный DNS-сервер повторно использует соединение, установленное на шаге 3, и отправляет запрос. |
||||
8. Возникает проблема: установление соединения на шаге 3 ожидает результата запроса на шаге 7, а завершение запроса на шаге 7 ожидает полного установления соединения на шаге 3. |
||||
9. Игра окончена! |
||||
|
||||
Решения: |
||||
|
||||
- Изменить правила разделения трафика для встроенного DNS-сервера. |
||||
- Использовать Hosts. |
||||
- ~~Если вы все еще не знаете, как решить эту проблему, не используйте эту функцию.~~ |
||||
|
||||
Поэтому **не рекомендуется** неопытным пользователям использовать эту функцию без необходимости. |
||||
::: |
||||
|
||||
> `dialerProxy`: "" |
||||
|
||||
Тег исходящего прокси. |
||||
Если значение не пустое, исходящие соединения будут устанавливаться через указанное исходящее подключение. |
||||
Этот параметр можно использовать для цепочечной пересылки с поддержкой транспорта. |
||||
|
||||
::: danger |
||||
Этот параметр несовместим с `ProxySettingsObject.Tag`. |
||||
::: |
||||
|
||||
> `acceptProxyProtocol`: true | false |
||||
|
||||
Только для входящих подключений. |
||||
Указывает, следует ли принимать PROXY protocol. |
||||
|
||||
[PROXY protocol](https://www.haproxy.org/download/2.2/doc/proxy-protocol.txt) используется для передачи реального IP-адреса и порта источника запроса. |
||||
**Если вы не знакомы с ним, пропустите этот параметр.** |
||||
|
||||
Распространенные обратные прокси (например, HAProxy, Nginx) можно настроить на отправку PROXY protocol, VLESS fallbacks xver также может отправлять его. |
||||
|
||||
Если значение равно `true`, то после установления TCP-соединения на самом нижнем уровне отправитель запроса должен сначала отправить PROXY protocol v1 или v2, иначе соединение будет разорвано. |
||||
|
||||
> `tcpKeepAliveInterval`: number |
||||
|
||||
Интервал между отправкой пакетов TCP keep-alive в секундах. ~~Работает только в Linux.~~ |
||||
|
||||
Это keep-alive-пакеты, отправляемые при ненормальном состоянии соединения (не получен ACK). |
||||
|
||||
Если этот параметр не указан или равен 0, используется значение по умолчанию Golang. |
||||
|
||||
::: tip |
||||
Если указать отрицательное значение, например `-1`, TCP keep-alive будет отключен. |
||||
::: |
||||
|
||||
> `tcpKeepAliveIdle`: number |
||||
|
||||
Порог простоя TCP-соединения в секундах. |
||||
Keep-alive-пакеты будут отправляться, когда время простоя TCP-соединения достигнет этого порога. |
||||
|
||||
Это keep-alive-пакеты, отправляемые при нормальном состоянии соединения. |
||||
|
||||
Если этот параметр не указан или равен 0, используется значение по умолчанию Golang. |
||||
|
||||
::: tip |
||||
Если указать отрицательное значение, например `-1`, TCP keep-alive будет отключен. |
||||
::: |
||||
|
||||
> `tcpUserTimeout`: number |
||||
|
||||
Измеряется в миллисекундах. |
||||
Подробнее: https://github.com/grpc/proposal/blob/master/A18-tcp-user-timeout.md |
||||
|
||||
> `tcpcongestion`: "" |
||||
|
||||
Алгоритм управления перегрузкой TCP. |
||||
Поддерживается только в Linux. |
||||
Если этот параметр не указан, используется значение по умолчанию системы. |
||||
|
||||
::: tip Распространенные алгоритмы |
||||
|
||||
- bbr (рекомендуется) |
||||
- cubic |
||||
- reno |
||||
|
||||
::: |
||||
|
||||
::: tip |
||||
Выполните команду `sysctl net.ipv4.tcp_congestion_control`, чтобы узнать значение по умолчанию системы. |
||||
::: |
||||
|
||||
> `interface`: "" |
||||
|
||||
Имя сетевого интерфейса, к которому нужно привязаться. |
||||
Поддерживается в Linux / iOS / Mac OS / Windows.<br> |
||||
Для iOS / Mac OS требуется Xray-core v1.8.6 или более поздней версии.<br> |
||||
Для Windows требуется Xray-core v1.8.7 или более поздней версии. |
||||
|
||||
> `V6Only`: true | false |
||||
|
||||
Если значение равно `true`, адрес `::` будет принимать только IPv6-соединения. |
||||
Поддерживается только в Linux. |
||||
|
||||
> `tcpWindowClamp`: number |
||||
|
||||
Привязать размер рекламируемого окна к этому значению. |
||||
Ядро выберет максимальное значение между этим значением и SOCK_MIN_RCVBUF/2. |
||||
|
||||
> `tcpMptcp`: true | false |
||||
|
||||
Новый параметр в Xray-core v1.8.6.<br> |
||||
Значение по умолчанию - `false`. |
||||
Если значение равно `true`, включить [Multipath TCP](https://ru.wikipedia.org/wiki/Multipath_TCP). |
||||
Этот параметр нужно включить как на сервере, так и на клиенте. |
||||
В настоящее время поддерживается только в Linux, требуется ядро Linux версии 5.6 или выше. |
||||
|
||||
> `tcpNoDelay`: true | false |
||||
|
||||
Значение по умолчанию - `false`. |
||||
Рекомендуется включать вместе с `"tcpMptcp": true`. |
||||
|
||||
> `customSockopt`: [] |
||||
|
||||
Массив, позволяющий опытным пользователям указать любые необходимые параметры sockopt. |
||||
Теоретически все настройки, связанные с подключением, описанные выше, можно настроить с помощью этого параметра. |
||||
Вы также можете настроить другие параметры, доступные в Linux, но не добавленные в ядро, например, следующий пример эквивалентен `"tcpcongestion": "bbr"` в ядре. |
||||
|
||||
Перед использованием убедитесь, что вы понимаете принципы программирования сокетов в Linux. |
||||
|
||||
```json |
||||
"customSockopt": [ |
||||
{ |
||||
"type": "str", |
||||
"level":"6", |
||||
"opt": "13", |
||||
"value": "bbr" |
||||
} |
||||
] |
||||
``` |
||||
|
||||
> `type`: "" |
||||
|
||||
Обязательный параметр, тип настройки, в настоящее время доступны `int` и `str`. |
||||
|
||||
> `level`: "" |
||||
|
||||
Необязательный параметр, уровень протокола, используемый для указания области действия. |
||||
Значение по умолчанию - `6` (TCP). |
||||
|
||||
> `opt`: "" |
||||
|
||||
Название настраиваемого параметра в десятичном формате (в этом примере используется значение TCP_CONGESTION, которое равно 0xd в шестнадцатеричном формате и 13 в десятичном формате). |
||||
|
||||
> `value`: "" |
||||
|
||||
Значение, которое нужно установить. |
||||
В этом примере используется значение `bbr`. |
||||
|
||||
Если `type` равен `int`, значение должно быть десятичным числом. |
||||
|
||||
|
||||
|
||||
|
||||
|
@ -0,0 +1,43 @@
|
||||
# DomainSocket |
||||
|
||||
::: danger |
||||
Рекомендуется прописать в разделе `listen` файла [inbounds](../inbound.md). В качестве способа передачи можно выбрать TCP, WebSocket, HTTP/2. |
||||
В будущем использование DomainSocket может быть прекращено. |
||||
::: |
||||
|
||||
DomainSocket использует стандартные доменные сокеты Unix для передачи данных. |
||||
|
||||
Его преимущество заключается в использовании встроенного в операционную систему канала передачи, не занимающего сетевой буфер. |
||||
Теоретически, по сравнению с локальной петлей (local loopback), доменный сокет работает немного быстрее. |
||||
|
||||
В настоящее время он доступен только на платформах, поддерживающих доменные сокеты Unix, таких как Linux и macOS. Недоступно в Windows 10 до сборки 17036. |
||||
|
||||
Если в качестве способа передачи указан DomainSocket, то порт и IP-адрес, настроенные во входящем и исходящем прокси, будут недействительны, и вся передача будет осуществляться через DomainSocket. |
||||
|
||||
## DomainSocketObject |
||||
|
||||
`DomainSocketObject` соответствует элементу `dsSettings` конфигурации передачи. |
||||
|
||||
```json |
||||
{ |
||||
"path": "/path/to/ds/file", |
||||
"abstract": false, |
||||
"padding": false |
||||
} |
||||
``` |
||||
|
||||
> `path`: string |
||||
|
||||
Допустимый путь к файлу. |
||||
|
||||
::: danger |
||||
Этот файл не должен существовать до запуска Xray. |
||||
::: |
||||
|
||||
> `abstract`: true | false |
||||
|
||||
Является ли сокет абстрактным доменным сокетом, значение по умолчанию `false`. |
||||
|
||||
> `padding`: true | false |
||||
|
||||
Использовать ли padding для абстрактного доменного сокета, значение по умолчанию `false`. |
@ -0,0 +1,126 @@
|
||||
# gRPC |
||||
|
||||
Режим передачи данных, основанный на HTTP/2, полностью соответствует стандарту HTTP/2 и может быть ретранслирован другими HTTP-серверами (такими как Nginx). |
||||
|
||||
gRPC (HTTP/2) имеет встроенное мультиплексирование, не рекомендуется включать mux.cool при использовании gRPC и HTTP/2. |
||||
|
||||
::: warning ⚠⚠⚠ |
||||
|
||||
- gRPC не поддерживает указание Host. Пожалуйста, укажите **правильное доменное имя** в адресе исходящего прокси или укажите `ServerName` в `(x)tlsSettings`, иначе подключение не будет установлено. |
||||
- gRPC не поддерживает fallback на другие сервисы. |
||||
- Существует риск активного сканирования сервисов gRPC. Рекомендуется использовать обратный прокси-сервер, такой как Caddy или Nginx, для предварительного разделения трафика по пути. |
||||
::: |
||||
|
||||
::: tip |
||||
Если вы используете обратный прокси-сервер, такой как Caddy или Nginx, обратите внимание на следующие моменты: |
||||
|
||||
- Убедитесь, что на обратном прокси-сервере включен HTTP/2. |
||||
- Используйте HTTP/2 или h2c (Caddy), grpc_pass (Nginx) для подключения к Xray. |
||||
- Путь в обычном режиме: `/${serviceName}/Tun`, в режиме Multi: `/${serviceName}/TunMulti`. |
||||
- Если необходимо получать IP-адрес клиента, его можно передать через заголовок `X-Real-IP`, отправленный Caddy / Nginx. |
||||
::: |
||||
|
||||
::: tip |
||||
Если вы используете fallback, обратите внимание на следующие моменты: |
||||
|
||||
- Не рекомендуется использовать fallback на gRPC, так как существует риск активного сканирования. |
||||
- Убедитесь, что `h2` находится на первом месте в (x)tlsSettings.alpn, иначе gRPC (HTTP/2) может не завершить TLS-рукопожатие. |
||||
- gRPC не поддерживает маршрутизацию на основе path с помощью Xray. |
||||
::: |
||||
|
||||
## GRPCObject |
||||
|
||||
`GRPCObject` соответствует элементу `grpcSettings` конфигурации передачи. |
||||
|
||||
```json |
||||
{ |
||||
"authority": "grpc.example.com", |
||||
"serviceName": "name", |
||||
"multiMode": false, |
||||
"user_agent": "custom user agent", |
||||
"idle_timeout": 60, |
||||
"health_check_timeout": 20, |
||||
"permit_without_stream": false, |
||||
"initial_windows_size": 0 |
||||
} |
||||
``` |
||||
|
||||
> `authority`: string |
||||
|
||||
Строка, которая может использоваться как Host для реализации некоторых других целей. |
||||
|
||||
> `serviceName`: string |
||||
|
||||
Строка, указывающая имя сервиса, **аналогично** пути в HTTP/2. |
||||
Клиент будет использовать это имя для связи, а сервер будет проверять, совпадает ли имя сервиса. |
||||
|
||||
::: tip |
||||
Когда `serviceName` начинается с косой черты, можно настроить собственный путь, используя как минимум две косые черты.<br> |
||||
Например, если на сервере указано `"serviceName": "/my/sample/path1|path2"`, то на клиенте можно указать `"serviceName": "/my/sample/path1"` или `"/my/sample/path2"`. |
||||
::: |
||||
|
||||
> `user_agent`: string |
||||
|
||||
::: tip |
||||
**Необходимо настроить только** в `outbound` **(клиент)**. |
||||
::: |
||||
|
||||
Установка пользовательского агента gRPC, может предотвратить блокировку трафика gRPC некоторыми CDN. |
||||
|
||||
> `multiMode`: true | false <Badge text="BETA" type="warning"/> |
||||
|
||||
`true` включает `multiMode`, значение по умолчанию: `false`. |
||||
|
||||
Это **экспериментальная** опция, которая может быть удалена в будущем, и ее совместимость между версиями не гарантируется. Этот режим может обеспечить прирост производительности примерно на 20% **в тестовой среде**, фактическая производительность зависит от скорости передачи. |
||||
|
||||
::: tip |
||||
**Необходимо настроить только** в `outbound` **(клиент)**. |
||||
::: |
||||
|
||||
> `idle_timeout`: number |
||||
|
||||
Проверка работоспособности выполняется, если в течение определенного периода времени, измеряемого в секундах, не происходит передача данных. Если это значение меньше `10`, то в качестве минимального значения будет использоваться `10`. |
||||
|
||||
::: tip |
||||
Если не используется обратный прокси-сервер, такой как Caddy или Nginx (**обычно не используется**), и это значение установлено меньше `60`, сервер может отправить непредвиденный кадр h2 GOAWAY, чтобы закрыть существующее соединение. |
||||
::: |
||||
|
||||
По умолчанию проверка работоспособности **отключена**. |
||||
|
||||
::: tip |
||||
**Необходимо настроить только** в `outbound` **(клиент)**. |
||||
::: |
||||
|
||||
::: tip |
||||
Может решить некоторые проблемы с "обрывом" соединения. |
||||
::: |
||||
|
||||
> `health_check_timeout`: number |
||||
|
||||
Время ожидания ответа проверки работоспособности в секундах. Если в течение этого времени проверка работоспособности не будет завершена и по-прежнему не будет передачи данных, проверка работоспособности будет считаться неудачной. Значение по умолчанию: `20`. |
||||
|
||||
::: tip |
||||
Настройка требуется **только** на стороне **исходящего соединения** (**клиента**). |
||||
::: |
||||
|
||||
> `permit_without_stream`: true | false |
||||
|
||||
`true` разрешает проверку работоспособности, если нет дочерних подключений. Значение по умолчанию: `false`. |
||||
|
||||
::: tip |
||||
**Необходимо настроить только** в `outbound` **(клиент)**. |
||||
::: |
||||
|
||||
> `initial_windows_size`: number |
||||
|
||||
Начальный размер окна h2 Stream. Если значение меньше или равно `0`, эта функция не действует. Если значение больше `65535`, механизм динамического окна будет отключен. Значение по умолчанию: `0`, то есть не действует. |
||||
|
||||
::: tip |
||||
**Необходимо настроить только** в `outbound` **(клиент)**. |
||||
::: |
||||
|
||||
::: tip |
||||
При использовании CDN Cloudflare можно установить значение `65536` или выше, чтобы отключить механизм динамического окна, что предотвратит отправку непредвиденных кадров h2 GOAWAY CDN Cloudflare для закрытия существующего соединения. |
||||
::: |
||||
|
||||
|
@ -0,0 +1,53 @@
|
||||
# HTTPUpgrade |
||||
|
||||
Это протокол, реализующий запросы и ответы на обновление HTTP 1.1, подобно WebSocket. Это позволяет ему, как и WebSocket, быть проксируемым CDN или Nginx, но без необходимости реализации других частей протокола WebSocket, что делает его более эффективным. |
||||
|
||||
Его дизайн не рекомендуется для самостоятельного использования, а лучше всего работает в сочетании с TLS. |
||||
|
||||
## HttpUpgradeObject |
||||
|
||||
`HttpUpgradeObject` соответствует пункту `httpupgradeSettings` в настройках передачи. |
||||
|
||||
```json |
||||
{ |
||||
"acceptProxyProtocol": false, |
||||
"path": "/", |
||||
"host": "xray.com", |
||||
"headers": { |
||||
"key": "value" |
||||
} |
||||
} |
||||
``` |
||||
|
||||
> `acceptProxyProtocol`: true | false |
||||
|
||||
Используется только для входящих соединений и указывает, принимать ли протокол PROXY. |
||||
|
||||
[PROXY protocol](https://www.haproxy.org/download/2.2/doc/proxy-protocol.txt) предназначен для передачи реального IP-адреса и порта запроса. **Если вы не знакомы с ним, проигнорируйте этот пункт.** |
||||
|
||||
Распространенные программы для reverse прокси (например, HAProxy, Nginx) и VLESS fallbacks xver могут быть настроены для его включения. |
||||
|
||||
При установке значения `true`, после установления TCP-соединения на самом нижнем уровне, запрашивающая сторона должна сначала отправить PROXY protocol v1 или v2, в противном случае соединение будет закрыто. |
||||
|
||||
> `path`: string |
||||
|
||||
HTTP-путь, используемый HTTPUpgrade, по умолчанию `"/"`. |
||||
|
||||
Если в пути клиента содержится параметр `ed` (например, ```/mypath?ed=2560```), будет активирована функция `Early Data` для уменьшения задержки, ее значение - порог длины первого пакета. Если длина первого пакета превышает это значение, `Early Data` не будет активирована. Рекомендуемое значение - 2560. |
||||
|
||||
> `host`: string |
||||
|
||||
Хост, отправляемый в HTTP-запросе HTTPUpgrade, по умолчанию пустой. Если значение на стороне сервера пустое, значение хоста, отправляемое клиентом, не проверяется. |
||||
|
||||
Когда на стороне сервера указано это значение или в `headers` указан хост, будет проверено соответствие хоста запроса клиента. |
||||
|
||||
Приоритет выбора хоста, отправляемого клиентом: `host` > `headers` > `address` |
||||
|
||||
> `headers`: map \{string: string\} |
||||
|
||||
Пользовательские HTTP-заголовки, пара ключ-значение, где каждый ключ представляет имя HTTP-заголовка, а соответствующее значение - строка. |
||||
|
||||
По умолчанию пустое. |
||||
|
||||
|
||||
|
@ -0,0 +1,162 @@
|
||||
# mKCP |
||||
|
||||
mKCP использует UDP для имитации TCP-соединения. |
||||
|
||||
mKCP жертвует пропускной способностью ради уменьшения задержки. При передаче одного и того же контента mKCP, как правило, потребляет больше трафика, чем TCP. |
||||
|
||||
::: tip |
||||
Убедитесь, что на хосте правильно настроена конфигурация брандмауэра. |
||||
::: |
||||
|
||||
## KcpObject |
||||
|
||||
`KcpObject` соответствует параметрам передачи `kcpSettings`. |
||||
|
||||
```json |
||||
{ |
||||
"mtu": 1350, |
||||
"tti": 20, |
||||
"uplinkCapacity": 5, |
||||
"downlinkCapacity": 20, |
||||
"congestion": false, |
||||
"readBufferSize": 1, |
||||
"writeBufferSize": 1, |
||||
"header": { |
||||
"type": "none", |
||||
"domain": "example.com" |
||||
}, |
||||
"seed": "Password" |
||||
} |
||||
``` |
||||
|
||||
> `mtu`: number |
||||
|
||||
Максимальный размер передаваемого блока (maximum transmission unit). |
||||
|
||||
Выберите значение от 576 до 1460. |
||||
|
||||
По умолчанию `1350`. |
||||
|
||||
> `tti`: number |
||||
|
||||
Интервал передачи (transmission time interval), в миллисекундах (ms), mKCP будет отправлять данные с этой частотой. |
||||
|
||||
Выберите значение от 10 до 100. |
||||
|
||||
По умолчанию `50`. |
||||
|
||||
> `uplinkCapacity`: number |
||||
|
||||
Пропускная способность канала отправки, то есть максимальная полоса пропускания, используемая хостом для отправки данных, в Мбит/с, обратите внимание, что это байты, а не биты. |
||||
|
||||
Может быть установлено в 0, что означает очень маленькую пропускную способность. |
||||
|
||||
По умолчанию `5`. |
||||
|
||||
> `downlinkCapacity`: number |
||||
|
||||
Пропускная способность канала приема, то есть максимальная полоса пропускания, используемая хостом для приема данных, в Мбит/с, обратите внимание, что это байты, а не биты. |
||||
|
||||
Может быть установлено в 0, что означает очень маленькую пропускную способность. |
||||
|
||||
По умолчанию `20`. |
||||
|
||||
::: tip |
||||
`uplinkCapacity` и `downlinkCapacity` определяют скорость передачи mKCP. |
||||
|
||||
В качестве примера, если клиент отправляет данные, то `uplinkCapacity` клиента определяет скорость отправки данных, а `downlinkCapacity` сервера определяет скорость приема данных. Значение, меньшее из двух, будет использоваться в качестве определяющего. |
||||
|
||||
Рекомендуется установить `downlinkCapacity` в большое значение, например, 100, а `uplinkCapacity` - в фактическое значение скорости сети. Когда скорость недостаточна, можно постепенно увеличивать значение `uplinkCapacity` до примерно двух раз больше, чем фактическая скорость сети. |
||||
::: |
||||
|
||||
> `congestion`: true | false |
||||
|
||||
Включить или отключить контроль перегрузки. |
||||
|
||||
При включении контроля перегрузки Xray будет автоматически отслеживать качество сети. При серьезных потерях пакетов он автоматически снизит пропускную способность; при хорошем качестве сети он также будет соответствующим образом увеличивать пропускную способность. |
||||
|
||||
По умолчанию `false`. |
||||
|
||||
> `readBufferSize`: number |
||||
|
||||
Размер буфера чтения для отдельного соединения, в МБ. |
||||
|
||||
По умолчанию `2`. |
||||
|
||||
> `writeBufferSize`: number |
||||
|
||||
Размер буфера записи для отдельного соединения, в МБ. |
||||
|
||||
По умолчанию `2`. |
||||
|
||||
::: tip |
||||
`readBufferSize` и `writeBufferSize` определяют размер памяти, используемой для каждого соединения. |
||||
|
||||
При необходимости высокой скорости передачи, установка больших значений `readBufferSize` и `writeBufferSize` может в некоторой степени повысить скорость, но также будет использовать больше памяти. |
||||
|
||||
При скорости сети не превышающей 20 Мбит/с, значение по умолчанию 1 МБ может удовлетворить требованиям; при превышении этой скорости можно соответствующим образом увеличить значения `readBufferSize` и `writeBufferSize`, а затем вручную сбалансировать скорость и использование памяти. |
||||
::: |
||||
|
||||
> `header`: [HeaderObject](#headerobject) |
||||
|
||||
Настройка маскировки заголовка данных |
||||
|
||||
> `seed`: string |
||||
|
||||
Опциональное шифрование пароля, используемое для шифрования потока данных с помощью алгоритма AES-128-GCM. Клиент и сервер должны использовать одинаковый пароль. |
||||
|
||||
Эта шифровальная схема не предназначена для обеспечения безопасности контента, но может помочь противостоять некоторым блокировкам. |
||||
|
||||
> В настоящее время в тестовой среде, после включения этой настройки, не наблюдалось явления блокировки исходного, не зашифрованного варианта. |
||||
|
||||
### HeaderObject |
||||
|
||||
```json |
||||
{ |
||||
"type": "none", |
||||
"domain": "example.com" |
||||
} |
||||
``` |
||||
|
||||
> `type`: string |
||||
|
||||
Тип маскировки, доступные значения: |
||||
|
||||
- `"none"`: значение по умолчанию, не применяется маскировка, отправляемые данные не имеют никаких отличительных признаков. |
||||
- `"srtp"`: маскировка под SRTP-пакеты, будет идентифицироваться как данные видеозвонка (например, FaceTime). |
||||
- `"utp"`: маскировка под uTP-пакеты, будет идентифицироваться как данные загрузки BT. |
||||
- `"wechat-video"`: маскировка под пакеты видеозвонка WeChat. |
||||
- `"dtls"`: маскировка под DTLS 1.2-пакеты. |
||||
- `"wireguard"`: маскировка под WireGuard-пакеты. (Это не настоящий протокол WireGuard). |
||||
- `"dns"`: некоторые корпоративные сети разрешают DNS-запросы без авторизации, добавление DNS-заголовка к KCP-пакетам позволяет обойти некоторые корпоративные сети. |
||||
|
||||
> `domain`: string |
||||
|
||||
Используется совместно с типом маскировки `"dns"`, можно указать произвольный домен. |
||||
|
||||
## Благодарности |
||||
|
||||
- [@skywind3000](https://github.com/skywind3000) изобрел и реализовал протокол KCP. |
||||
- [@xtaci](https://github.com/xtaci) перевел реализацию KCP с C на Go. |
||||
- [@xiaokangwang](https://github.com/xiaokangwang) протестировал интеграцию KCP с Xray и внес первый PR. |
||||
|
||||
## Улучшения протокола KCP |
||||
|
||||
### Более компактный заголовок протокола |
||||
|
||||
Протокол KCP использует заголовок размером 24 байта, а mKCP уменьшил его до 18 байт для пакета данных и 16 байт для пакета подтверждения. Более компактный заголовок помогает избежать обнаружения по признакам и ускоряет передачу данных. |
||||
|
||||
Кроме того, в оригинальном KCP каждый пакет подтверждения может подтвердить только один пакет данных, то есть, если KCP нужно подтвердить получение 100 пакетов данных, он отправит 24 * 100 = 2400 байт данных. В этом случае многократно повторяются заголовки, что приводит к ненужному расходу полосы пропускания. mKCP сжимает несколько пакетов подтверждения, 100 пакетов подтверждения занимают всего 16 + 2 + 100 * 4 = 418 байт, что в шесть раз меньше, чем в оригинальном KCP. |
||||
|
||||
### Передача пакетов подтверждения |
||||
|
||||
В оригинальном KCP пакет подтверждения отправляется только один раз, если пакет подтверждения потерян, то обязательно произойдет повторная передача данных, что приводит к ненужному расходу полосы пропускания. mKCP будет повторно отправлять пакеты подтверждения с определенной частотой, пока отправитель не получит подтверждение. Размер одного пакета подтверждения составляет 22 байта, что значительно меньше, чем размер пакета данных, который составляет более 1000 байт, поэтому повторная передача пакета подтверждения имеет гораздо меньшую цену. |
||||
|
||||
### Управление состоянием соединения |
||||
|
||||
mKCP может эффективно управлять состоянием соединения. Когда удаленный хост инициализирует закрытие соединения, соединение будет закрыто в течение двух секунд; когда удаленный хост теряет соединение, соединение будет закрыто в течение максимум 30 секунд. |
||||
|
||||
Оригинальный KCP не поддерживает этот сценарий. |
||||
|
||||
|
||||
|
@ -0,0 +1,75 @@
|
||||
# QUIC |
||||
|
||||
QUIC (Quick UDP Internet Connection) — это протокол, предложенный Google для многоканальной передачи данных по UDP. Его основные преимущества: |
||||
|
||||
1. Сокращение времени установки соединения (1-RTT или 0-RTT). |
||||
2. Многоканальность и отсутствие проблем с блокировкой, как у TCP. |
||||
3. Миграция соединений (в основном на стороне клиента): при переходе с Wi-Fi на 4G соединение не разрывается. |
||||
|
||||
QUIC в настоящее время находится в экспериментальной стадии и использует реализацию IETF, которая находится в процессе стандартизации, поэтому совместимость с финальной версией не гарантируется. |
||||
|
||||
- По умолчанию: |
||||
- 12-байтовый Connection ID. |
||||
- Автоматическое отключение соединения через 30 секунд бездействия (может повлиять на работу некоторых долгоживущих соединений). |
||||
|
||||
## QuicObject |
||||
|
||||
`QuicObject` соответствует элементу `quicSettings` в конфигурации транспорта. |
||||
|
||||
::: danger |
||||
Конфигурация на обоих концах соединения должна быть полностью идентичной, иначе соединение установить не удастся. |
||||
QUIC требует включения TLS. Если TLS не включён в настройках транспорта, Xray сгенерирует самоподписанный сертификат для использования TLS. |
||||
::: |
||||
|
||||
```json |
||||
{ |
||||
"security": "none", |
||||
"key": "", |
||||
"header": { |
||||
"type": "none" |
||||
} |
||||
} |
||||
``` |
||||
|
||||
> `security`: "none" | "aes-128-gcm" | "chacha20-poly1305" |
||||
|
||||
Метод шифрования. |
||||
|
||||
Это шифрование применяется к пакетам данных QUIC. Зашифрованные пакеты не могут быть распознаны. |
||||
|
||||
Значение по умолчанию: без шифрования. |
||||
|
||||
> `key`: string |
||||
|
||||
Ключ шифрования. |
||||
|
||||
Может быть любой строкой. Используется только если `security` не равен `"none"`. |
||||
|
||||
> `header`: [HeaderObject](#headerobject) |
||||
|
||||
Настройки маскировки заголовков пакетов. |
||||
|
||||
### HeaderObject |
||||
|
||||
```json |
||||
{ |
||||
"type": "none" |
||||
} |
||||
``` |
||||
|
||||
> `type`: string |
||||
|
||||
Тип маскировки. Допустимые значения: |
||||
|
||||
- `"none"`: значение по умолчанию, маскировка не используется, отправляемые данные не имеют характерных признаков. |
||||
- `"srtp"`: маскировка под SRTP-трафик (например, FaceTime). |
||||
- `"utp"`: маскировка под uTP-трафик (например, BitTorrent). |
||||
- `"wechat-video"`: маскировка под видеозвонки WeChat. |
||||
- `"dtls"`: маскировка под DTLS 1.2. |
||||
- `"wireguard"`: маскировка под WireGuard (не является настоящим WireGuard). |
||||
|
||||
::: tip |
||||
Если ни шифрование, ни маскировка не включены, то пакеты QUIC отправляются в исходном виде и могут быть распознаны другими инструментами QUIC. |
||||
|
||||
Для предотвращения обнаружения рекомендуется включить хотя бы шифрование или маскировку. |
||||
::: |
@ -0,0 +1,81 @@
|
||||
# SplitHTTP |
||||
|
||||
<Badge text="v1.8.16+" type="warning"/> |
||||
|
||||
Используется для загрузки с помощью HTTP-фрагментированной передачи, загрузка осуществляется с помощью нескольких HTTP POST-запросов. |
||||
|
||||
Может использоваться через CDN, не поддерживающие WebSocket, но есть несколько требований: |
||||
|
||||
- CDN должен поддерживать HTTP-фрагментированную передачу и потоковые ответы без буферизации. Ядро будет отправлять `X-Accel-Buffering: no` и `Content-Type: text/event-stream`, чтобы сообщить CDN об этом, но CDN должен соблюдать этот заголовок. Если промежуточный сервер не поддерживает потоковые ответы и зависает, передача, скорее всего, не будет работать. |
||||
|
||||
Цель та же, что и у V2fly Meek, но благодаря использованию фрагментированной загрузки скорость загрузки выше, а скорость отдачи оптимизирована, но все еще очень ограничена, поэтому к HTTP-прокси предъявляются более высокие требования (см. выше). |
||||
|
||||
`SplitHTTP` также принимает заголовок `X-Forwarded-For`. |
||||
|
||||
## SplitHttpObject |
||||
|
||||
`SplitHttpObject` соответствует элементу `splithttpSettings` в конфигурации транспорта. |
||||
|
||||
```json |
||||
{ |
||||
"path": "/", |
||||
"host": "xray.com", |
||||
"headers": { |
||||
"key": "value" |
||||
}, |
||||
"maxUploadSize": 1000000, |
||||
"maxConcurrentUploads": 10 |
||||
} |
||||
``` |
||||
|
||||
> `path`: string |
||||
|
||||
Путь HTTP-протокола, используемый SplitHTTP, значение по умолчанию — `"/"`. |
||||
|
||||
> `host`: string |
||||
|
||||
Хост, отправляемый в HTTP-запросе SplitHTTP, по умолчанию пуст. Если значение на стороне сервера пустое, значение хоста, отправленное клиентом, не проверяется. |
||||
|
||||
Если это значение указано на стороне сервера или `host` указан в `headers`, то проверяется соответствие хоста запроса клиента. |
||||
|
||||
Приоритет выбора хоста для отправки клиентом: `host` > `headers` > `address`. |
||||
|
||||
> `headers`: map \{string: string\} |
||||
|
||||
Пользовательские HTTP-заголовки, пары ключ-значение, где каждый ключ представляет имя HTTP-заголовка, а соответствующее значение является строкой. |
||||
|
||||
> `maxUploadSize`: int |
||||
|
||||
Максимальный размер фрагмента загрузки в байтах, по умолчанию 1 МБ. |
||||
|
||||
Это значение должно быть меньше максимального размера тела запроса, разрешенного CDN или другим обратным HTTP-прокси, иначе будет выдаваться ошибка HTTP 413. |
||||
|
||||
Увеличение этого значения может увеличить скорость загрузки. |
||||
|
||||
> `maxConcurrentUploads`: int |
||||
|
||||
Максимальное количество одновременных загрузок, по умолчанию 10, соединения будут использоваться повторно, насколько это возможно. |
||||
|
||||
Если соединение нестабильно или потребление памяти на сервере слишком велико, попробуйте уменьшить это значение. |
||||
|
||||
Значение, установленное клиентом, должно быть меньше, чем на сервере, иначе это может привести к проблемам с подключением. |
||||
|
||||
## Детали протокола |
||||
|
||||
Подробное обсуждение см. [#3412](https://github.com/XTLS/Xray-core/pull/3412) и [#3462](https://github.com/XTLS/Xray-core/pull/3462). Ниже приведено краткое описание и требования к совместимой реализации: |
||||
|
||||
1. Загрузка начинается с `GET /<UUID>`. Сервер немедленно отвечает `200 OK` и `Transfer Encoding:chunked` и немедленно отправляет двухбайтовую полезную нагрузку, чтобы принудительно обновить заголовки HTTP-прокси. |
||||
|
||||
2. Отправка данных начинается с `POST /<UUID>/<seq>`. `seq` действует как порядковый номер TCP, начиная с 0, пакеты данных могут отправляться одновременно, сервер должен пересобрать данные по порядковому номеру. Порядковый номер не следует сбрасывать. |
||||
|
||||
Клиент может свободно выбирать порядок открытия исходящих и нисходящих запросов, любой из них может инициировать сеанс, но соединение `GET` должно быть открыто в течение 30 секунд, иначе сеанс будет разорван. |
||||
|
||||
4. Запрос `GET` будет оставаться открытым до тех пор, пока соединение не будет разорвано, и сервер, и клиент могут закрыть соединение. Конкретное поведение зависит от версии HTTP. |
||||
|
||||
Рекомендации: |
||||
|
||||
* Не ожидайте, что CDN будет правильно передавать все заголовки, цель этого протокола — обойти CDN, не поддерживающие WS, а поведение этих CDN обычно не очень дружелюбное. |
||||
|
||||
* Следует предполагать, что все HTTP-соединения не поддерживают потоковые запросы, поэтому размер каждого пакета, отправляемого исходящим соединением, должен определяться с учетом задержки, пропускной способности и ограничений самого промежуточного сервера (аналогично MTU TCP и алгоритму Нейгла). |
||||
|
||||
* Что касается версии HTTP, ядро в настоящее время не поддерживает h2c, поэтому Xray будет отправлять только запросы http/1.1 при использовании без HTTPS. Чтобы избежать дополнительных сложностей, связанных с согласованием ALPN, клиент Xray использует h2 при использовании HTTPS (если только alpn не указан вручную как http/1.1 в tlsSettings), а сервер Xray совместим с различными типами входящих подключений (h3 пока нет), поскольку входящие соединения могут быть различных типов из-за промежуточных серверов. |
@ -0,0 +1,148 @@
|
||||
# TCP |
||||
|
||||
Режим транспорта TCP — один из рекомендуемых в настоящее время режимов транспорта. |
||||
|
||||
Может использоваться в различных комбинациях с различными протоколами. |
||||
|
||||
## TcpObject |
||||
|
||||
`TcpObject` соответствует элементу `tcpSettings` в конфигурации транспорта. |
||||
|
||||
```json |
||||
{ |
||||
"acceptProxyProtocol": false, |
||||
"header": { |
||||
"type": "none" |
||||
} |
||||
} |
||||
``` |
||||
|
||||
> `acceptProxyProtocol`: true | false |
||||
|
||||
Только для входящих подключений, указывает, следует ли принимать PROXY protocol. |
||||
|
||||
[PROXY protocol](https://www.haproxy.org/download/2.2/doc/proxy-protocol.txt) используется для передачи реального исходного IP-адреса и порта запроса, **если вы не знаете, что это такое, проигнорируйте этот параметр**. |
||||
|
||||
Распространенные программы для обработки обратного прокси (например, HAProxy, Nginx) можно настроить на его отправку, VLESS fallbacks xver также может его отправлять. |
||||
|
||||
Если установлено значение `true`, то после установления TCP-соединения на самом нижнем уровне запрашивающая сторона должна сначала отправить PROXY protocol v1 или v2, иначе соединение будет закрыто. |
||||
|
||||
Значение по умолчанию: `false`. |
||||
|
||||
> `header`: [NoneHeaderObject](#noneheaderobject) | [HttpHeaderobject](#httpheaderobject) |
||||
|
||||
Настройки маскировки заголовка пакета данных, значение по умолчанию: `NoneHeaderObject`. |
||||
|
||||
::: tip |
||||
HTTP-маскировка не может быть разделена другими HTTP-серверами (например, Nginx), но может быть разделена с помощью VLESS fallbacks path. |
||||
::: |
||||
|
||||
### NoneHeaderObject |
||||
|
||||
Маскировка не выполняется. |
||||
|
||||
```json |
||||
{ |
||||
"type": "none" |
||||
} |
||||
``` |
||||
|
||||
> `type`: "none" |
||||
|
||||
Указывает, что маскировка не выполняется. |
||||
|
||||
### HttpHeaderObject |
||||
|
||||
Конфигурация HTTP-маскировки должна быть одинаковой как на входящем, так и на исходящем соединении, и ее содержимое должно совпадать. |
||||
|
||||
```json |
||||
{ |
||||
"type": "http", |
||||
"request": {}, |
||||
"response": {} |
||||
} |
||||
``` |
||||
|
||||
> `type`: "http" |
||||
|
||||
Указывает на выполнение HTTP-маскировки. |
||||
|
||||
> `request`: [HTTPRequestObject](#httprequestobject) |
||||
|
||||
HTTP-запрос. |
||||
|
||||
> `response`: [HTTPResponseObject](#httpresponseobject) |
||||
|
||||
HTTP-ответ. |
||||
|
||||
#### HTTPRequestObject |
||||
|
||||
```json |
||||
{ |
||||
"version": "1.1", |
||||
"method": "GET", |
||||
"path": ["/"], |
||||
"headers": { |
||||
"Host": ["www.baidu.com", "www.bing.com"], |
||||
"User-Agent": [ |
||||
"Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/53.0.2785.143 Safari/537.36", |
||||
"Mozilla/5.0 (iPhone; CPU iPhone OS 10_0_2 like Mac OS X) AppleWebKit/601.1 (KHTML, like Gecko) CriOS/53.0.2785.109 Mobile/14A456 Safari/601.1.46" |
||||
], |
||||
"Accept-Encoding": ["gzip, deflate"], |
||||
"Connection": ["keep-alive"], |
||||
"Pragma": "no-cache" |
||||
} |
||||
} |
||||
``` |
||||
|
||||
> `version`: string |
||||
|
||||
Версия HTTP, значение по умолчанию — `"1.1"`. |
||||
|
||||
> `method`: string |
||||
|
||||
Метод HTTP, значение по умолчанию — `"GET"`. |
||||
|
||||
> `path`: \[ string \] |
||||
|
||||
Путь, массив строк. Значение по умолчанию — `["/"]`. Если имеется несколько значений, то при каждом запросе случайным образом выбирается одно из них. |
||||
|
||||
> `headers`: map{ string, \[ string \]} |
||||
|
||||
HTTP-заголовки, пары ключ-значение, где каждый ключ представляет имя HTTP-заголовка, а соответствующее значение является массивом. |
||||
|
||||
Каждый запрос будет содержать все ключи и случайно выбранное соответствующее значение. Значение по умолчанию см. в примере выше. |
||||
|
||||
#### HTTPResponseObject |
||||
|
||||
```json |
||||
{ |
||||
"version": "1.1", |
||||
"status": "200", |
||||
"reason": "OK", |
||||
"headers": { |
||||
"Content-Type": ["application/octet-stream", "video/mpeg"], |
||||
"Transfer-Encoding": ["chunked"], |
||||
"Connection": ["keep-alive"], |
||||
"Pragma": "no-cache" |
||||
} |
||||
} |
||||
``` |
||||
|
||||
> `version`: string |
||||
|
||||
Версия HTTP, значение по умолчанию — `"1.1"`. |
||||
|
||||
> `status`: string |
||||
|
||||
Состояние HTTP, значение по умолчанию — `"200"`. |
||||
|
||||
> `reason`: string |
||||
|
||||
Описание состояния HTTP, значение по умолчанию — `"OK"`. |
||||
|
||||
> `headers`: map {string, \[ string \]} |
||||
|
||||
HTTP-заголовки, пары ключ-значение, где каждый ключ представляет имя HTTP-заголовка, а соответствующее значение является массивом. |
||||
|
||||
Каждый запрос будет содержать все ключи и случайно выбранное соответствующее значение. Значение по умолчанию см. в примере выше. |
@ -0,0 +1,58 @@
|
||||
# WebSocket |
||||
|
||||
Использует стандартный WebSocket для передачи данных. |
||||
|
||||
Подключение WebSocket может быть проксировано другими HTTP-серверами (например, Nginx) и VLESS fallbacks path. |
||||
|
||||
::: tip |
||||
WebSocket распознает заголовок X-Forwarded-For в HTTP-запросе для перезаписи исходного адреса трафика, приоритет выше, чем у PROXY protocol. |
||||
::: |
||||
|
||||
## WebSocketObject |
||||
|
||||
`WebSocketObject` соответствует элементу `wsSettings` в конфигурации транспорта. |
||||
|
||||
```json |
||||
{ |
||||
"acceptProxyProtocol": false, |
||||
"path": "/", |
||||
"host": "xray.com", |
||||
"headers": { |
||||
"key": "value" |
||||
} |
||||
} |
||||
``` |
||||
|
||||
> `acceptProxyProtocol`: true | false |
||||
|
||||
Только для входящих подключений, указывает, следует ли принимать PROXY protocol. |
||||
|
||||
[PROXY protocol](https://www.haproxy.org/download/2.2/doc/proxy-protocol.txt) используется для передачи реального исходного IP-адреса и порта запроса, **если вы не знаете, что это такое, проигнорируйте этот параметр**. |
||||
|
||||
Распространенные программы-обработчики обратного прокси (например, HAProxy, Nginx) можно настроить на его отправку, VLESS fallbacks xver также может его отправлять. |
||||
|
||||
Если установлено значение `true`, то после установления TCP-соединения на самом нижнем уровне запрашивающая сторона должна сначала отправить PROXY protocol v1 или v2, иначе соединение будет закрыто. |
||||
|
||||
> `path`: string |
||||
|
||||
Путь, используемый WebSocket в HTTP-протоколе, значение по умолчанию — `"/"`. |
||||
|
||||
Если в пути клиента есть параметр `ed` (например, ```/mypath?ed=2560```), будет активирован `Early Data` для уменьшения задержки. |
||||
|
||||
> `host`: string |
||||
|
||||
Хост, отправляемый в HTTP-запросе WebSocket, значение по умолчанию — пустое. Если значение на стороне сервера пустое, значение хоста, отправленное клиентом, не проверяется. |
||||
|
||||
Если это значение указано на стороне сервера или `host` указан в `headers`, то проверяется соответствие хоста запроса клиента. |
||||
|
||||
Приоритет выбора хоста для отправки клиентом: `host` > `headers` > `address`. |
||||
|
||||
> `headers`: map \{string: string\} |
||||
|
||||
Пользовательские HTTP-заголовки, пары ключ-значение, где каждый ключ представляет имя HTTP-заголовка, а соответствующее значение является строкой. |
||||
|
||||
Значение по умолчанию: пустое. |
||||
|
||||
## Browser Dialer |
||||
|
||||
Использует браузер для обработки TLS, подробнее см. в [Browser Dialer](../features/browser_dialer.md). |
@ -0,0 +1,41 @@
|
||||
# 开发指南 |
||||
|
||||
## 编译文档 |
||||
|
||||
Xray 支持各种平台, 您可以在多种平台上自行进行交叉编译。 |
||||
|
||||
请点击[编译文档](./intro/compile.md)以查看具体编译相关内容。 |
||||
|
||||
## 设计思路 |
||||
|
||||
Xray 内核提供了一个平台,在其之上可以进二次开发。 |
||||
|
||||
这个章节阐述了 Xray 的设计目标和架构。 |
||||
|
||||
请点击[设计思路](./intro/design.md)以了解 Xray 的设计目标和架构。 |
||||
|
||||
## 开发规范 |
||||
|
||||
这个章节阐述了获取代码,进行开发,提交 PR 的流程中需要遵循的准则, 以及相关的编码规范。 |
||||
|
||||
请点击[开发规范](./intro/guide.md)查看 Xray 开发中应遵循的准则。 |
||||
|
||||
## 协议详解 |
||||
|
||||
Xray 用到了很多种协议, 您可以通过各种途径获得协议的详细描述。 |
||||
|
||||
### [VLESS 协议](./protocols/vless.md) |
||||
|
||||
VLESS 是一个无状态的轻量传输协议,可以作为 Xray 客户端和服务器之间的桥梁。 |
||||
|
||||
### [VMess 协议](./protocols/vmess.md) |
||||
|
||||
VMess 是一个加密传输协议,可以作为 Xray 客户端和服务器之间的桥梁。 |
||||
|
||||
### [Mux.Cool 协议](./protocols/muxcool.md) |
||||
|
||||
Mux.Cool 协议是一个多路复用传输协议,用于在一条已建立的数据流中传输多个各自独立的数据流。 |
||||
|
||||
### [mKCP 协议](./protocols/mkcp.md) |
||||
|
||||
mKCP 是流式传输协议,由 [KCP 协议](https://github.com/skywind3000/kcp)修改而来,可以按顺序传输任意的数据流。 |
@ -0,0 +1,81 @@
|
||||
# 编译文档 |
||||
|
||||
## 前序工作 |
||||
|
||||
Xray 使用 [Golang](https://golang.org/) 作为编程语言,你需要先安装最新版本 Golang 才能够编译。 |
||||
|
||||
::: tip TIP |
||||
安装 Golang: [golang.org/doc/install](https://golang.org/doc/install) |
||||
::: |
||||
|
||||
> 如果你不幸使用 Windows, 请 **务必** 使用 Powershell |
||||
|
||||
## 拉取 Xray 源代码 |
||||
|
||||
```bash |
||||
git clone https://github.com/XTLS/Xray-core.git |
||||
cd Xray-core && go mod download |
||||
``` |
||||
|
||||
> 如果你闲的没事干,可以试试 GitHub 官方工具: `gh repo clone XTLS/Xray-core` |
||||
|
||||
注意:在无法正常访问 Google 的网络环境,依赖无法被正常拉取,需要先设置 `GOPROXY`: |
||||
|
||||
```bash |
||||
go env -w GOPROXY=https://goproxy.io,direct |
||||
``` |
||||
|
||||
## 构建二进制 |
||||
|
||||
:::warning |
||||
本小节的命令需要在 Xray 根目录内运行。 |
||||
::: |
||||
|
||||
### Windows(Powershell): |
||||
|
||||
```powershell |
||||
$env:CGO_ENABLED=0 |
||||
go build -o xray.exe -trimpath -ldflags "-s -w -buildid=" ./main |
||||
``` |
||||
|
||||
### macOS, Linux: |
||||
|
||||
```bash |
||||
CGO_ENABLED=0 go build -o xray -trimpath -ldflags "-s -w -buildid=" ./main |
||||
``` |
||||
|
||||
运行以上命令会在目录下生成 xray 可执行文件。 |
||||
|
||||
::: tip |
||||
如果需要编译可以进行 debug 的程序,即可以用 dlv 附加到运行的程序进行调试, 请去掉 ldflags 中的 '-w -s' 选项. |
||||
|
||||
-w 禁止生成 debug 信息。使用该选项后,将无法使用 gdb 进行调试。 |
||||
-s 禁用符号表 |
||||
PS:其实用 vscode 或其他 IDE 调试似乎更方便。 |
||||
::: |
||||
|
||||
## 交叉编译: |
||||
|
||||
这里以在 Windows(Powershell) 环境中,编译到 Linux 服务器为例: |
||||
|
||||
```powershell |
||||
$env:CGO_ENABLED=0 |
||||
$env:GOOS="linux" |
||||
$env:GOARCH="amd64" |
||||
|
||||
go build -o xray -trimpath -ldflags "-s -w -buildid=" ./main |
||||
``` |
||||
|
||||
上传到服务器后,记得在服务器终端内执行 `chmod +x xray` |
||||
|
||||
::: tip |
||||
执行 `go tool dist list` 查看所有支持的系统与架构。 |
||||
::: |
||||
|
||||
## 可复现构建: |
||||
|
||||
按照上述步骤,能够编译与 Release 中完全相同的二进制文件。 |
||||
|
||||
::: warning |
||||
请先确认您使用的 Golang 版本与编译 Release 的一致。 |
||||
::: |
@ -0,0 +1,43 @@
|
||||
# 设计目标 |
||||
|
||||
- Xray 内核提供了一个平台,支持必要的网络代理功能,在其之上可以进二次开发,以提供更好的用户体验; |
||||
- 以跨平台为首要原则,以减少二次开发的成本; |
||||
|
||||
## 架构 |
||||
|
||||
![Architecture](./framework.png) |
||||
|
||||
内核分为三层:应用层、代理层和传输层。 |
||||
|
||||
每一层内包含数个模块,模块间互相独立,同类型的模块可无缝替换。 |
||||
|
||||
### 应用层 |
||||
|
||||
应用层包含一些代理层中常用的功能,这些功能被抽象出来,以便在不同的代理模块中复用。 |
||||
|
||||
应用层的模块应为纯软件实现,与硬件或平台相关的技术无关。 |
||||
|
||||
重要模块列表: |
||||
|
||||
- Dispatcher: 用于把入站代理所接收到的数据,传送给出站代理; |
||||
- Router: 路由模块,详见 [路由配置](../../config/routing.md); |
||||
- DNS: 内置的 DNS 服务器模块; |
||||
- Proxy Manager: 代理管理器; |
||||
|
||||
### 代理层 |
||||
|
||||
代理层分为两部分:入站代理(Inbound Proxy)和出站代理(Outbound Proxy)。 |
||||
|
||||
两部分相互独立,入站代理不依赖于某个特定的出站代理,反之亦然。 |
||||
|
||||
#### 入站代理 |
||||
|
||||
- 实现 [proxy.Inbound](https://github.com/xtls/Xray-core/blob/main/proxy/proxy.go) 接口; |
||||
|
||||
#### 出站代理 |
||||
|
||||
- 实现 [proxy.Outbound](https://github.com/xtls/Xray-core/blob/main/proxy/proxy.go) 接口; |
||||
|
||||
### 传输层 |
||||
|
||||
传输层提供一些网络数据传输相关的工具模块。 |
After Width: | Height: | Size: 66 KiB |
@ -0,0 +1,131 @@
|
||||
# 开发规范 |
||||
|
||||
## 基本 |
||||
|
||||
### 版本控制 |
||||
|
||||
Project X 的代码被托管在 github 上: |
||||
|
||||
- Xray 核心 [Xray-core](https://github.com/XTLS/Xray-core) |
||||
- 安装脚本 [Xray-install](https://github.com/XTLS/Xray-install) |
||||
- 配置模板 [Xray-examples](https://github.com/XTLS/Xray-examples) |
||||
- Xray 文档 [Xray-docs-next](https://github.com/XTLS/Xray-docs-next) |
||||
|
||||
您可以使用 [Git](https://git-scm.com/) 来获取代码。 |
||||
|
||||
### 分支(Branch) |
||||
|
||||
- 本项目的主干分支为 main, |
||||
- 本项目的发布主分支同为 main, |
||||
- 需要确保 main 在任一时刻都是可编译,且可正常使用的。 |
||||
- 如果需要开发新的功能,请新建分支进行开发,在开发完成并且经过充分测试后,合并回主干分支。 |
||||
- 已经合并入主干且没有必要存在的分支,请删除。 |
||||
|
||||
### 发布(Release) |
||||
|
||||
<Badge text="WIP" type="warning"/> |
||||
|
||||
- 建立尝鲜版本和稳定版本两个发布通道 |
||||
- 尝鲜版本,可以为 daily build,主要用于特定情况的测试,尝鲜和获得即时反馈和再改进。 |
||||
- 稳定版本,为定时更新(比如月更),合并稳定的修改并发布。 |
||||
|
||||
### 引用其它项目 |
||||
|
||||
- Golang |
||||
- 产品代码建议使用 Golang 标准库和 [golang.org/x/](https://pkg.go.dev/search?limit=25&m=package&q=golang.org%2Fx) 下的库; |
||||
- 如需引用其它项目,请事先创建 issue 讨论; |
||||
- 其它 |
||||
- 不违反双方的协议,且对项目有帮助的工具,都可以使用。 |
||||
|
||||
## 开发流程 |
||||
|
||||
### 写代码之前 |
||||
|
||||
发现任何问题,或对项目有任何想法,请创建 [issue](https://github.com/XTLS/Xray-core/issues) 讨论以减少重复劳动和消耗在代码上的时间。 |
||||
|
||||
### 修改代码 |
||||
|
||||
- Golang |
||||
- 请参考 [Effective Go](https://golang.org/doc/effective_go.html); |
||||
- 每一次 push 之前,请运行:`go generate core/format.go`; |
||||
- 如果需要修改 protobuf,例如增加新配置项,请运行:`go generate core/proto.go`; |
||||
- 提交 pull request 之前,建议测试通过:`go test ./...`; |
||||
- 提交 pull request 之前,建议新增代码有超过 70% 的代码覆盖率(code coverage); |
||||
- 其它 |
||||
- 请注意代码的可读性。 |
||||
|
||||
### Pull Request |
||||
|
||||
- 提交 PR 之前,请先运行 `git pull https://github.com/XTLS/Xray-core.git` 以确保 merge 可顺利进行; |
||||
- 一个 PR 只做一件事,如有对多个 bug 的修复,请对每一个 bug 提交一个 PR; |
||||
- 由于 Golang 的特殊需求(Package path),Go 项目的 PR 流程和其它项目有所不同,建议流程如下: |
||||
1. 先 Fork 本项目,创建你自己的 `github.com/<your_name>/Xray-core.git` 仓库; |
||||
2. 克隆你自己的 Xray 仓库到本地:`git clone https://github.com/<your_name>/Xray-core.git`; |
||||
3. 基于 `main` 分支创建新的分支,例如 `git branch issue24 main`; |
||||
4. 在新创建的分支上作修改并提交修改(commit); |
||||
5. 在推送(push)修改完成的分支到自己的仓库前,先切换到 `main` 分支,运行 `git pull https://github.com/XTLS/Xray-core.git` 拉取最新的远端代码; |
||||
6. 如果上一步拉取得到了新的远端代码,则切换到之前自己创建的分支,运行 `git rebase main` 执行分支合并操作。如遇到文件冲突,则需要解决冲突; |
||||
7. 上一步处理完毕后,就可以把自己创建的分支推送到自己的仓库:`git push -u origin your-branch` |
||||
8. 最后,把自己仓库的新推送的分支往 `XTLS/Xray-core` 的 `main` 分支发 PR 即可; |
||||
9. 请在 PR 的标题和正文中,完整表述此次 PR 解决的问题 / 新增的功能 / 代码所做的修改的用意等; |
||||
10. 耐心等待开发者的回应。 |
||||
|
||||
### 对代码的修改 |
||||
|
||||
#### 功能性问题 |
||||
|
||||
请提交至少一个测试用例(Test Case)来验证对现有功能的改动。 |
||||
|
||||
#### 性能相关 |
||||
|
||||
请提交必要的测试数据来证明现有代码的性能缺陷,或是新增代码的性能提升。 |
||||
|
||||
#### 新功能 |
||||
|
||||
- 如果新增功能对已有功能不影响,请提供可以开启/关闭的开关(如 flag),并使新功能保持默认关闭的状态; |
||||
- 大型新功能(比如增加一个新的协议)开发之前,请先提交一个 issue,讨论完毕之后再进行开发。 |
||||
|
||||
#### 其它 |
||||
|
||||
视具体情况而定。 |
||||
|
||||
## Xray 编码规范 |
||||
|
||||
以下内容适用于 Xray 中的 Golang 代码。 |
||||
|
||||
### 代码结构 |
||||
|
||||
``` |
||||
Xray-core |
||||
├── app // 应用模块 |
||||
│ ├── router // 路由 |
||||
├── common // 公用代码 |
||||
├── proxy // 通讯协议 |
||||
│ ├── blackhole |
||||
│ ├── dokodemo-door |
||||
│ ├── freedom |
||||
│ ├── socks |
||||
│ ├── vmess |
||||
├── transport // 传输模块 |
||||
``` |
||||
|
||||
### 编码规范 |
||||
|
||||
基本与 Golang 官方所推荐做法一致,有一些例外。写在这里以方便大家熟悉 Golang。 |
||||
|
||||
#### 命名 |
||||
|
||||
- 文件和目录名尽量使用单个英文单词,比如 hello.go; |
||||
- 如果实在没办法,则目录使用连接线/文件名使用下划线连接两个(或多个单词),比如 hello-world/hello_again.go; |
||||
- 测试代码使用 \_test.go 结尾; |
||||
- 类型使用 Pascal 命名法,比如 ConnectionHandler; |
||||
- 对缩写不强制小写,即 HTML 不必写成 Html; |
||||
- 公开成员变量也使用 Pascal 命名法; |
||||
- 私有成员变量使用 [小驼峰式命名法](https://zh.wikipedia.org/wiki/%E9%A7%9D%E5%B3%B0%E5%BC%8F%E5%A4%A7%E5%B0%8F%E5%AF%AB) ,如 `privateAttribute` ; |
||||
- 为了方便重构,方法建议全部使用 Pascal 命名法; |
||||
- 完全私有的类型放入 `internal` 。 |
||||
|
||||
#### 内容组织 |
||||
|
||||
- 一个文件包含一个主要类型,及其相关的私有函数等; |
||||
- 测试相关的文件,如 Mock 等工具类,放入 testing 子目录。 |
@ -0,0 +1,92 @@
|
||||
# mKCP 协议 |
||||
|
||||
mKCP 是流式传输协议,由 [KCP 协议](https://github.com/skywind3000/kcp) 修改而来,可以按顺序传输任意的数据流。 |
||||
|
||||
## 版本 |
||||
|
||||
mKCP 没有版本号,不保证版本之间兼容性。 |
||||
|
||||
## 依赖 |
||||
|
||||
### 底层协议 |
||||
|
||||
mKCP 是一个基于 UDP 的协议,所有通讯使用 UDP 传输。 |
||||
|
||||
### 函数 |
||||
|
||||
- fnv: [FNV-1a](https://en.wikipedia.org/wiki/Fowler%E2%80%93Noll%E2%80%93Vo_hash_function) 哈希函数 |
||||
- 输入参数为任意长度的字符串; |
||||
- 输入出一个 32 位无符号整数; |
||||
|
||||
## 通讯过程 |
||||
|
||||
1. mKCP 将数据流拆成若干个数据包进行发送。一个数据流有一个唯一标识,用以区分不同的数据流。数据流中的每一个数据包都携带了同样的标识。 |
||||
1. mKCP 没有握手过程,当收到一个数据包时,根据其携带的数据流的标识来判断是否为新的通话,或是正在进行中的通话。 |
||||
1. 每一个数据包中包含若干个片段(Segment),片段分为三类:数据(Data)、确认(ACK)、心跳(Ping)。每个片段需要单独处理。 |
||||
|
||||
## 数据格式 |
||||
|
||||
### 数据包 |
||||
|
||||
| 4 字节 | 2 字节 | L 字节 | |
||||
| ---------- | ---------- | -------- | |
||||
| 认证信息 A | 数据长度 L | 片段部分 | |
||||
|
||||
其中: |
||||
|
||||
- 认证信息 A = fnv(片段部分),big endian; |
||||
- 片段部分可能包含多个片段; |
||||
|
||||
### 数据片段 |
||||
|
||||
| 2 字节 | 1 字节 | 1 字节 | 4 字节 | 4 字节 | 4 字节 | 2 字节 | Len 字节 | |
||||
| --------- | -------- | -------- | --------- | --------- | ---------------- | -------- | -------- | |
||||
| 标识 Conv | 指令 Cmd | 选项 Opt | 时间戳 Ts | 序列号 Sn | 未确认序列号 Una | 长度 Len | 数据 | |
||||
|
||||
其中: |
||||
|
||||
- 标识 Conv: mKCP 数据流的标识 |
||||
- 指令 Cmd: 常量 0x01 |
||||
- 选项 Opt: 可选的值有: |
||||
- 0x00: 空选项 |
||||
- 0x01: 对方已发出所有数据 |
||||
- 时间戳 Ts: 当前片段从远端发送出来时的时间,big endian |
||||
- 序列号 Sn: 该数据片段时数据流中的位置,起始片段的序列号为 0,之后每个新片段按顺序加 1 |
||||
- 未确认序列号 Una: 远端主机正在发送的,且尚未收到确认的最小的 Sn |
||||
|
||||
### 确认片段 |
||||
|
||||
| 2 字节 | 1 字节 | 1 字节 | 4 字节 | 4 字节 | 4 字节 | 2 字节 | Len \* 4 字节 | |
||||
| --------- | -------- | -------- | -------- | ----------------- | --------- | -------- | -------------- | |
||||
| 标识 Conv | 指令 Cmd | 选项 Opt | 窗口 Wnd | 下一接收序列号 Sn | 时间戳 Ts | 长度 Len | 已收到的序列号 | |
||||
|
||||
其中: |
||||
|
||||
- 标识 Conv: mKCP 数据流的标识 |
||||
- 指令 Cmd: 常量 0x00 |
||||
- 选项 Opt: 同上 |
||||
- 窗口 Wnd: 远端主机可以接收的最大序列号 |
||||
- 下一接收序列号 Sn: 远端主机未收到的数据片段中的最小序列号 |
||||
- 时间戳 Ts: 远端主机最新收到的数据片段的时间戳,可用于计算延迟 |
||||
- 已收到的序列号: 每个 4 字节,表示此序列号的数据已经确认收到 |
||||
|
||||
注释: |
||||
|
||||
- 远程主机期待收到序列号 [Sn, Wnd) 范围内的数据 |
||||
|
||||
### 心跳片段 |
||||
|
||||
| 2 字节 | 1 字节 | 1 字节 | 4 字节 | 4 字节 | 4 字节 | |
||||
| --------- | -------- | -------- | ---------------- | ----------------- | -------- | |
||||
| 标识 Conv | 指令 Cmd | 选项 Opt | 未确认序列号 Una | 下一接收序列号 Sn | 延迟 Rto | |
||||
|
||||
其中: |
||||
|
||||
- 标识 Conv: mKCP 数据流的标识 |
||||
- 指令 Cmd: 可选的值有 |
||||
- 0x02: 远端主机强行终止会话 |
||||
- 0x03: 正常心跳 |
||||
- 选项 Opt: 同上 |
||||
- 未确认序列号 Una: 同数据片段的 Una |
||||
- 下一接收序列号 Sn: 同确认片段的 Sn |
||||
- 延迟 Rto: 远端主机自己计算出的延迟 |
@ -0,0 +1,129 @@
|
||||
# Mux.Cool 协议 |
||||
|
||||
Mux.Cool 协议是一个多路复用传输协议,用于在一条已建立的数据流中传输多个各自独立的数据流。 |
||||
|
||||
## 版本 |
||||
|
||||
当前版本是 1 Beta。 |
||||
|
||||
## 依赖 |
||||
|
||||
### 底层协议 |
||||
|
||||
Mux.Cool 必须运行在一个已建立的可靠数据流之上。 |
||||
|
||||
## 通讯过程 |
||||
|
||||
一个 Mux.Cool 连接中可传输若干个子连接,每个子连接有一个独立的 ID 和状态。传输过程由帧(Frame)组成,每一帧用于传输一个特定的子连接的数据。 |
||||
|
||||
### 客户端行为 |
||||
|
||||
当有连接需求时并且没有现有可用的连接时,客户端向服务器发起一个新连接,以下称为“主连接”。 |
||||
|
||||
1. 一个主连接可用于发送若干个子连接。客户端可自主决定主连接可承载的子连接数量。 |
||||
1. 对于一个新的子连接,客户端必须发送状态`New`以通知服务器建立子连接,然后使用状态`Keep`来传送数据。 |
||||
1. 当子连接结束时,客户端发送`End`状态来通知服务器关闭子连接。 |
||||
1. 客户端可自行决定何时关闭主连接,但必须确定服务器也同时保持连接。 |
||||
1. 客户端可使用 KeepAlive 状态来避免服务器关闭主连接。 |
||||
|
||||
### 服务器端行为 |
||||
|
||||
当服务器端接收到新的子连接时,服务器应当按正常的连接来处理。 |
||||
|
||||
1. 当收到状态`End`时,服务器端可以关闭对目标地址的上行连接。 |
||||
1. 在服务器的响应中,必须使用与请求相同的 ID 来传输子连接的数据。 |
||||
1. 服务器不能使用`New`状态。 |
||||
1. 服务器可使用 KeepAlive 状态来避免客户端关闭主连接。 |
||||
|
||||
## 传输格式 |
||||
|
||||
Mux.Cool 使用对称传输格式,即客户端和服务器发送和接收相同格式的数据。 |
||||
|
||||
### 帧格式 |
||||
|
||||
| 2 字节 | L 字节 | X 字节 | |
||||
| ------------ | ------ | -------- | |
||||
| 元数据长度 L | 元数据 | 额外数据 | |
||||
|
||||
### 元数据 |
||||
|
||||
元数据有若干种类型。所有类型的元数据都包含 ID 和 Opt 两项,其含义为: |
||||
|
||||
- ID: 子连接的唯一标识 |
||||
- 对于一般 Mux 子连接,ID 由 1 开始累加 |
||||
- 对于 Xray 实现的 [Single XUDP](https://github.com/XTLS/Xray-core/blob/main/common/xudp/xudp.go),ID 始终为 0 |
||||
- Opt: |
||||
- D(0x01): 有额外数据 |
||||
|
||||
当选项 Opt(D) 开启时,额外数据格式如下: |
||||
|
||||
| 2 字节 | X-2 字节 | |
||||
| -------- | -------- | |
||||
| 长度 X-2 | 数据 | |
||||
|
||||
### 新建子连接 (New) |
||||
|
||||
| 2 字节 | 1 字节 | 1 字节 | 1 字节 | 2 字节 | 1 字节 | A 字节 | 8 字节 | |
||||
| ------ | ------ | -------- | ---------- | ------ | ---------- | ------ | ---------------- | |
||||
| ID | 0x01 | 选项 Opt | 网络类型 N | 端口 | 地址类型 T | 地址 A | Global ID (XUDP) | |
||||
|
||||
其中: |
||||
|
||||
- 网络类型 N: |
||||
- 0x01:TCP,表示当前子连接的流量应当以 TCP 的方式发送至目标。 |
||||
- 0x02:UDP,表示当前子连接的流量应当以 UDP 的方式发送至目标。 |
||||
- 地址类型 T: |
||||
- 0x01:IPv4 |
||||
- 0x02:域名 |
||||
- 0x03:IPv6 |
||||
- 地址 A: |
||||
- 当 T = 0x01 时,A 为 4 字节 IPv4 地址; |
||||
- 当 T = 0x02 时,A 为 1 字节长度(L) + L 字节域名; |
||||
- 当 T = 0x03 时,A 为 16 字节 IPv6 地址; |
||||
- Global ID (XUDP): |
||||
- 客户端计算出 UDP 来源二元组的全局独特 ID,服务端用以确保当 XUDP 断线重连时,仍使用同一个端口与目标通信。 |
||||
|
||||
在新建子连接时,若 Opt(D) 开启,则这一帧所带的数据需要被发往目标主机。 |
||||
|
||||
### 保持子连接 (Keep) |
||||
|
||||
TCP |
||||
|
||||
| 2 字节 | 1 字节 | 1 字节 | |
||||
| ------ | ------ | -------- | |
||||
| ID | 0x02 | 选项 Opt | |
||||
|
||||
UDP |
||||
|
||||
| 2 字节 | 1 字节 | 1 字节 | 1 字节 | 2 字节 | 1 字节 | A 字节 | |
||||
| ------ | ------ | -------- | ---------- | ------ | ---------- | ------ | |
||||
| ID | 0x02 | 选项 Opt | 网络类型 N | 端口 | 地址类型 T | 地址 A | |
||||
|
||||
在保持子连接时,若 Opt(D) 开启,则这一帧所带的数据需要被发往目标主机。 |
||||
XUDP 在 Opt(D) 之后加 UDP 地址,格式同新建子连接,但没有 Global ID。 |
||||
|
||||
### 关闭子连接 (End) |
||||
|
||||
| 2 字节 | 1 字节 | 1 字节 | |
||||
| ------ | ------ | -------- | |
||||
| ID | 0x03 | 选项 Opt | |
||||
|
||||
在保持子连接时,若 Opt(D) 开启,则这一帧所带的数据需要被发往目标主机。 |
||||
|
||||
### 保持连接 (KeepAlive) |
||||
|
||||
| 2 字节 | 1 字节 | 1 字节 | |
||||
| ------ | ------ | -------- | |
||||
| ID | 0x04 | 选项 Opt | |
||||
|
||||
在保持连接时: |
||||
|
||||
- 若 Opt(D) 开启,则这一帧所带的数据必须被丢弃。 |
||||
- ID 可为随机值。 |
||||
|
||||
## 应用 |
||||
|
||||
Mux.Cool 协议与底层协议无关,理论上可以使用任何可靠的流式连接来传输 Mux.Cool 的协议数据。 |
||||
|
||||
在目标导向的协议如 Shadowsocks 和 VMess 协议中,连接建立时必须包含一个指定的地址。 |
||||
为了保持兼容性,Mux.Cool 协议指定地址为“v1.mux.cool”。即当主连接的目标地址与之匹配时,则进行 Mux.Cool 方式的转发,否则按传统方式进行转发。(注:这是一个程序内的标记,VMess 和 VLESS 并不会在数据包中发送“v1.mux.cool”地址) |
@ -0,0 +1,91 @@
|
||||
# VLESS 协议 |
||||
|
||||
VLESS 是一个无状态的轻量传输协议,可以作为 Xray 客户端和服务器之间的桥梁。 |
||||
|
||||
## Request & Response |
||||
|
||||
| 1 字节 | 16 字节 | 1 字节 | M 字节 | 1 字节 | 2 字节 | 1 字节 | S 字节 | X 字节 | |
||||
| -------- | --------- | -------------- | ----------------- | ------ | ------ | -------- | ------ | -------- | |
||||
| 协议版本 | 等价 UUID | 附加信息长度 M | 附加信息 ProtoBuf | 指令 | 端口 | 地址类型 | 地址 | 请求数据 | |
||||
|
||||
| 1 字节 | 1 字节 | N 字节 | Y 字节 | |
||||
| ---------------------- | -------------- | ----------------- | -------- | |
||||
| 协议版本,与请求的一致 | 附加信息长度 N | 附加信息 ProtoBuf | 响应数据 | |
||||
|
||||
VLESS 早在第二个测试版 ALPHA 2 时就已经是上述结构了(BETA 是第五个测试版): |
||||
|
||||
> “响应认证”被替换为“协议版本”并移至最前,使 VLESS 可以升级换代,同时消除了生成伪随机数的开销。混淆相关结构被替换为附加信息(ProtoBuf)并前移,赋予协议本身可扩展性,相关开销也极小([gogo/protobuf](https://github.com/gogo/protobuf)),若无附加信息则无相关开销。 |
||||
|
||||
我一直觉得“响应认证”不是必要的,ALPHA 时为了提升生成随机数的性能,还用 math/rand 替换 crypto/rand,而现在都不需要了。 |
||||
|
||||
“协议版本”不仅能起到“响应认证”的作用,还赋予了 VLESS 无痛升级协议结构的能力,带来无限的可能性。 |
||||
“协议版本”在测试版本中均为 0,正式版本中为 1,以后若有不兼容的协议结构变更则应升级版本。 |
||||
|
||||
VLESS 服务端的设计是 switch version,即同时支持所有 VLESS 版本。若需要升级协议版本(可能到不了这一步),推荐的做法是服务端提前一个月支持,一个月后再改客户端。VMess 请求也有协议版本,但它的认证信息在外面,指令部分则高度耦合且有固定加密,导致里面的协议版本毫无意义,服务端也没有进行判断,响应则没有协议版本。Trojan 的协议结构中没有协议版本。 |
||||
|
||||
接下来是 UUID,我本来觉得 16 字节有点长,曾经考虑过缩短它,但后来看到 Trojan 用了 56 个可打印字符(56 字节),就彻底打消了这个念头。服务端每次都要验证 UUID,所以性能也很重要:VLESS 的 Validator 经历了多次重构/升级,相较于 VMess,它十分简洁且耗资源很少,可以同时支持非常多的用户,性能也十分强悍,验证速度极快(sync.Map)。API 动态增删用户则更高效顺滑。 |
||||
https://github.com/XTLS/Xray-core/issues/158 |
||||
|
||||
引入 ProtoBuf 是一个创举,等下会详细讲解。“指令”到“地址”的结构目前与 VMess 完全相同,同样支持 Mux。 |
||||
|
||||
总体上,ALPHA 2 到 BETA 主要是:结构进化、清理整合、性能提升、更加完善。这些都是一点一滴的,详见 [VLESS Changes](https://github.com/rprx/v2ray-vless/releases)。 |
||||
|
||||
## ProtoBuf |
||||
|
||||
似乎只有 VLESS 可选内嵌 ProtoBuf,它是一种数据交换格式,信息被紧密编码成二进制,TLV 结构(Tag Length Value)。 |
||||
|
||||
起因是我看到一篇文章称 SS 有一些缺点,如没有设计错误回报机制,客户端没办法根据不同的错误采取进一步的动作。 |
||||
(但我并不认同所有错误都要回报,不然防不了主动探测。下一个测试版中,服务器可以返回一串自定义信息。) |
||||
于是想到一个可扩展的结构是很重要的,未来它也可以承载如动态端口指令。不止响应,请求也需要类似的结构。 |
||||
本来打算自己设计 TLV,接着发觉 ProtoBuf 就是此结构、现成的轮子,完全适合用来做这件事,各语言支持等也不错。 |
||||
|
||||
目前“附加信息”只有 Scheduler 和 SchedulerV,它们是 MessName 和 MessSeed 的替代者,**当你不需要它们时,“附加信息长度”为 0,也就不会有 ProtoBuf 序列化/反序列化的开销**。其实我更愿意称这个过程为“拼接”,因为 pb 实际原理上也只是这么做而已,相关开销极小。拼接后的 bytes 十分紧凑,和 ALPHA 的方案相差无几,有兴趣的可以分别输出并对比。 |
||||
|
||||
为了指示对附加信息(Addons,也可以理解成插件,以后可以有很多个插件)的不同支持程度,下个测试版会在“附加信息长度”前新增“附加信息版本”。256 - 1 = 255 字节是够用且合理的(65535 就太多了,还可能有人恶意填充),现有的只用了十分之一,以后也不会同时有那么多附加信息,且大多数情况下是完全没有附加信息的。真不够用的话,可以升级 VLESS 版本。 |
||||
|
||||
为了减少逻辑判断等开销,暂定 Addons 不使用多级结构。一个月前出现过“可变协议格式”的想法,pb 是可以做到打乱顺序,但没必要,因为现代加密的设计不会让旁观者看出两次传输的头部相同。 |
||||
|
||||
下面介绍 Schedulers 和 Encryption 的构想,**它们都是可选的**,一个应对流量时序特征问题,一个应对密码学上的问题。 |
||||
|
||||
## ~~Schedulers~~ Flow |
||||
|
||||
~~中文名暂称:流量调度器~~(2020-09-03 更新:中文名确定为“流控”),指令由 ProtoBuf 承载,控制的是数据部分。 |
||||
|
||||
我之前发现,VMess 原有的 shake “元数据混淆”在 TLS 上完全不会带来有意义的改变,只会降低性能,所以 VLESS 弃用了它。并且,“混淆”这个表述容易被误解成伪装,也弃用了。顺便一提,我一直是不看好伪装的:做不到完全一样,那不就是强特征吗?做得到完全一样,那为什么不直接用伪装目标?我一开始用的是 SSR,后来发现它只是表面伪装骗运营商,就再也没用过了。 |
||||
|
||||
那么,“流量调度器”要解决什么问题?它影响的是宏观流量时序特征,而不是微观特征,后者是加密要解决的事情。流量时序特征可以是协议带来的,比如 Socks5 over TLS 时的 Socks5 握手 ,TLS 上不同的这种特征对于监测者来说就是不同的协议,此时无限 Schedulers 就相当于无限协议(重新分配每次发送的数据量大小等)。流量时序特征也可以是行为带来的,比如访问 Google 首页时加载了多少文件、顺序、每个文件的大小,多套一层加密并不能有效掩盖这些信息。 |
||||
|
||||
Schedulers 没必要像下面的 Encryption 一样整个套在外面,因为头部的一丁点数据相对于后面的数据量来说太微不足道了。 |
||||
|
||||
BETA 2 预计推出两个初级的 Scheduler:Zstd 压缩、数据量动态扩充。进阶操作才是从宏观层面来控制、分配,暂时咕咕。 |
||||
|
||||
## Encryption |
||||
|
||||
与 VMess 的高度耦合不同,VLESS 的服务端、客户端不久后可以提前约定好加密方式,仅在外面套一层加密。这有点类似于使用 TLS,不影响承载的任何数据,也可以理解成底层就是从 TLS 换成预设约定加密。相对于高度耦合,这种方式更合理且灵活:一种加密方式出了安全性问题,直接扔掉并换用其它的就行了,十分方便。VLESS 服务端还会允许不同的加密方式共存。 |
||||
|
||||
对比 VMess,VLESS 相当于把 security 换成 encryption,把 disableInsecureEncryption 换成 decryption,就解决了所有问题。目前 encryption 和 decryption 只接受 \"none\" 且不能留空(即使以后有连接安全性检查),详见 [VLESS 配置文档](https://github.com/rprx/v2fly-github-io/blob/master/docs/config/protocols/vless.md)。encryption 并不需要往外移一级,一是因为无法复用很多代码,二是因为会影响控制粒度,看未来的应用就明白了。 |
||||
|
||||
加密支持两类形式,一类是加密完全独立,需要额外密码,适合私用,另一类是结合已有的 UUID 来加密,适合公用。 |
||||
(若用第一类加密形式,且密码是以某种形式公开的,比如多人共用,那么中间人攻击就不远了) |
||||
重新设计的动态端口可能会随加密同时推出,指令由 ProtoBuf 承载,具体实现和 VMess 的动态端口也会有很多不同。 |
||||
|
||||
套现成加密是件很简单的事情,也就多一层 writer & reader。BETA 3 预计支持 SS 的 aes-128-gcm 和 chacha20-ietf-poly1305: |
||||
客户端的 encryption 可以填 “auto: ss_aes-128-gcm_0_123456, ss_chacha20-ietf-poly1305_0_987654”,auto 会选择最适合当前机器的,0 代表测试版,最后的是密码。服务端的 decryption 也是类似填法,收到请求时会逐一尝试解密。 |
||||
|
||||
并不是所有组合都需逐一尝试:VMess 的加密分为三段,第一段是认证信息,结合了 UUID、alterId、时间因素,第二段是指令部分,以固定算法加密,指令中含有数据部分使用的加密算法,第三段才是重要的数据部分。可以看出,VMess 的加解密方式实际上是多对一(服务端适配),而不仅是结合 UUID。但仅是结合 UUID 来加密也是件相对麻烦的事情,短时间内不会出,鉴于我们现在有 VMessAEAD 可用,也并不着急。若 VLESS 推出了结合 UUID 的加密方式,相当于重构了整个 VMess。 |
||||
|
||||
## UDP issues |
||||
|
||||
[XUDP:VLESS & VMess & Mux UDP FullCone NAT](https://github.com/XTLS/Xray-core/discussions/252) |
||||
|
||||
## 客户端开发指引 |
||||
|
||||
1. VLESS 协议本身还会有不兼容升级,但客户端配置文件参数基本上是只增不减的。iOS 客户端的协议实现则需紧跟升级。 |
||||
2. **视觉标准:UI 标识请统一用 VLESS**,而不是 VLess / Vless / vless,配置文件不受影响,代码内则顺其自然。 |
||||
3. `encryption` 应做成输入框而不是选择框,新配置的默认值应为 `none`,若用户置空则应代填 `none`。 |
||||
|
||||
## VLESS 分享链接标准 |
||||
|
||||
感谢 <img src="https://avatars2.githubusercontent.com/u/7822648?s=32" width="32px" height="32px" alt="a"/> [@DuckSoft](https://github.com/DuckSoft) 的提案! |
||||
|
||||
详情请见 [VMessAEAD / VLESS 分享链接标准提案](https://github.com/XTLS/Xray-core/issues/91) |
@ -0,0 +1,175 @@
|
||||
# VMess 协议 |
||||
|
||||
VMess 是一个加密传输协议,可以作为 Xray 客户端和服务器之间的桥梁。 |
||||
|
||||
## 版本 |
||||
|
||||
当前版本号为 1。 |
||||
|
||||
## 依赖 |
||||
|
||||
### 底层协议 |
||||
|
||||
VMess 是一个基于 TCP 的协议,所有数据使用 TCP 传输。 |
||||
|
||||
### 用户 ID |
||||
|
||||
ID 等价于 [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier),是一个 16 字节长的随机数,它的作用相当于一个令牌(Token)。 |
||||
一个 ID 形如:de305d54-75b4-431b-adb2-eb6b9e546014,几乎完全随机,可以使用任何的 UUID 生成器来生成,比如[这个](https://www.uuidgenerator.net/)。 |
||||
|
||||
用户 ID 可在[配置文件](../../config)中指定。 |
||||
|
||||
### 函数 |
||||
|
||||
- MD5: [MD5 函数](https://en.wikipedia.org/wiki/MD5) |
||||
- 输入参数为任意长度的 byte 数组 |
||||
- 输出为一个 16 byte 的数组 |
||||
- HMAC: [HMAC 函数](https://en.wikipedia.org/wiki/Hash-based_message_authentication_code) |
||||
- 输入参数为: |
||||
- H:散列函数 |
||||
- K:密钥,任意长度的 byte 数组 |
||||
- M:消息,任意长度的 byte 数组 |
||||
- Shake: [SHA3-Shake128 函数](https://en.wikipedia.org/wiki/SHA-3) |
||||
- 输入参数为任意长度的字符串 |
||||
- 输出为任意长度的字符串 |
||||
|
||||
## 通讯过程 |
||||
|
||||
VMess 是一个无状态协议,即客户端和服务器之间不需要握手即可直接传输数据,每一次数据传输对之前和之后的其它数据传输没有影响。 |
||||
|
||||
VMess 的客户端发起一次请求,服务器判断该请求是否来自一个合法的客户端。如验证通过,则转发该请求,并把获得的响应发回给客户端。 |
||||
|
||||
VMess 使用非对称格式,即客户端发出的请求和服务器端的响应使用了不同的格式。 |
||||
|
||||
## 客户端请求 |
||||
|
||||
| 16 字节 | X 字节 | 余下部分 | |
||||
| -------- | -------- | -------- | |
||||
| 认证信息 | 指令部分 | 数据部分 | |
||||
|
||||
### 认证信息 |
||||
|
||||
认证信息是一个 16 字节的哈希(hash)值,它的计算方式如下: |
||||
|
||||
- H = MD5 |
||||
- K = 用户 ID (16 字节) |
||||
- M = UTC 时间,精确到秒,取值为当前时间的前后 30 秒随机值(8 字节, Big Endian) |
||||
- Hash = HMAC(H, K, M) |
||||
|
||||
### 指令部分 |
||||
|
||||
指令部分经过 AES-128-CFB 加密: |
||||
|
||||
- Key:MD5(用户 ID + []byte('c48619fe-8f02-49e0-b9e9-edf763e17e21')) |
||||
- IV:MD5(X + X + X + X),X = []byte(认证信息生成的时间) (8 字节, Big Endian) |
||||
|
||||
| 1 字节 | 16 字节 | 16 字节 | 1 字节 | 1 字节 | 4 位 | 4 位 | 1 字节 | 1 字节 | 2 字节 | 1 字节 | N 字节 | P 字节 | 4 字节 | |
||||
| :--------: | :---------: | :----------: | :--------: | :------: | :----: | :----------: | :----: | :------: | :-------: | :--------: | :----: | :----: | :----: | |
||||
| 版本号 Ver | 数据加密 IV | 数据加密 Key | 响应认证 V | 选项 Opt | 余量 P | 加密方式 Sec | 保留 | 指令 Cmd | 端口 Port | 地址类型 T | 地址 A | 随机值 | 校验 F | |
||||
|
||||
选项 Opt 细节:(当某一位为 1 时,表示该选项启用) |
||||
|
||||
| 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | |
||||
| :-: | :-: | :-: | :-: | :-: | :-: | :-: | :-: | |
||||
| X | X | X | X | X | M | R | S | |
||||
|
||||
其中: |
||||
|
||||
- 版本号 Ver:始终为 1; |
||||
- 数据加密 IV:随机值; |
||||
- 数据加密 Key:随机值; |
||||
- 响应认证 V:随机值; |
||||
- 选项 Opt: |
||||
- S (0x01):标准格式的数据流(建议开启); |
||||
- R (0x02):客户端期待重用 TCP 连接(Xray 2.23+ 弃用); |
||||
- 只有当 S 开启时,这一项才有效; |
||||
- M (0x04):开启元数据混淆(建议开启); |
||||
- 只有当 S 开启时,这一项才有效; |
||||
- 当其项开启时,客户端和服务器端需要分别构造两个 Shake 实例,分别为 RequestMask = Shake(请求数据 IV), ResponseMask = Shake(响应数据 IV)。 |
||||
- X:保留 |
||||
- 余量 P:在校验值之前加入 P 字节的随机值; |
||||
- 加密方式:指定数据部分的加密方式,可选的值有: |
||||
- 0x00:AES-128-CFB; |
||||
- 0x01:不加密; |
||||
- 0x02:AES-128-GCM; |
||||
- 0x03:ChaCha20-Poly1305; |
||||
- 指令 Cmd: |
||||
- 0x01:TCP 数据; |
||||
- 0x02:UDP 数据; |
||||
- 端口 Port:Big Endian 格式的整型端口号; |
||||
- 地址类型 T: |
||||
- 0x01:IPv4 |
||||
- 0x02:域名 |
||||
- 0x03:IPv6 |
||||
- 地址 A: |
||||
- 当 T = 0x01 时,A 为 4 字节 IPv4 地址; |
||||
- 当 T = 0x02 时,A 为 1 字节长度(L) + L 字节域名; |
||||
- 当 T = 0x03 时,A 为 16 字节 IPv6 地址; |
||||
- 校验 F:指令部分除 F 外所有内容的 FNV1a hash; |
||||
|
||||
### 数据部分 |
||||
|
||||
当 Opt(S) 开启时,数据部分使用此格式。实际的请求数据被分割为若干个小块,每个小块的格式如下。服务器校验完所有的小块之后,再按基本格式的方式进行转发。 |
||||
|
||||
| 2 字节 | L 字节 | |
||||
| :----: | :----: | |
||||
| 长度 L | 数据包 | |
||||
|
||||
其中: |
||||
|
||||
- 长度 L:Big Endian 格式的整型,最大值为 2^14; |
||||
- 当 Opt(M) 开启时,L 的值 = 真实值 xor Mask。Mask = (RequestMask.NextByte() << 8) + RequestMask.NextByte(); |
||||
- 数据包:由指定的加密方式加密过的数据包; |
||||
|
||||
在传输结束之前,数据包中必须有实际数据,即除了长度和认证数据之外的数据。当传输结束时,客户端必须发送一个空的数据包,即 L = 0(不加密) 或认证数据长度(有加密),来表示传输结束。 |
||||
|
||||
按加密方式不同,数据包的格式如下: |
||||
|
||||
- 不加密: |
||||
- L 字节:实际数据; |
||||
- AES-128-CFB:整个数据部分使用 AES-128-CFB 加密 |
||||
- 4 字节:实际数据的 FNV1a hash; |
||||
- L - 4 字节:实际数据; |
||||
- AES-128-GCM:Key 为指令部分的 Key,IV = count (2 字节) + IV (10 字节)。count 从 0 开始递增,每个数据包加 1;IV 为 指令部分 IV 的第 3 至第 12 字节。 |
||||
- L - 16 字节:实际数据; |
||||
- 16 字节:GCM 认证信息 |
||||
- ChaCha20-Poly1305:Key = MD5(指令部分 Key) + MD5(MD5(指令部分 Key)),IV = count (2 字节) + IV (10 字节)。count 从 0 开始递增,每个数据包加 1;IV 为 指令部分 IV 的第 3 至第 12 字节。 |
||||
- L - 16 字节:实际数据; |
||||
- 16 字节:Poly1305 认证信息 |
||||
|
||||
## 服务器应答 |
||||
|
||||
应答头部数据使用 AES-128-CFB 加密,IV 为 MD5(数据加密 IV),Key 为 MD5(数据加密 Key)。实际应答数据视加密设置不同而不同。 |
||||
|
||||
| 1 字节 | 1 字节 | 1 字节 | 1 字节 | M 字节 | 余下部分 | |
||||
| ---------- | -------- | -------- | ---------- | -------- | ------------ | |
||||
| 响应认证 V | 选项 Opt | 指令 Cmd | 指令长度 M | 指令内容 | 实际应答数据 | |
||||
|
||||
其中: |
||||
|
||||
- 响应认证 V:必须和客户端请求中的响应认证 V 一致; |
||||
- 选项 Opt: |
||||
- 0x01:服务器端准备重用 TCP 连接(Xray 2.23+ 弃用); |
||||
- 指令 Cmd: |
||||
- 0x01:动态端口指令 |
||||
- 实际应答数据: |
||||
- 如果请求中的 Opt(S) 开启,则使用标准格式,否则使用基本格式。 |
||||
- 格式均和请求数据相同。 |
||||
- 当 Opt(M) 开启时,长度 L 的值 = 真实值 xor Mask。Mask = (ResponseMask.NextByte() << 8) + ResponseMask.NextByte(); |
||||
|
||||
### 动态端口指令 |
||||
|
||||
| 1 字节 | 2 字节 | 16 字节 | 2 字节 | 1 字节 | 1 字节 | |
||||
| ------ | --------- | ------- | ------- | -------- | ---------- | |
||||
| 保留 | 端口 Port | 用户 ID | AlterID | 用户等级 | 有效时间 T | |
||||
|
||||
其中: |
||||
|
||||
- 端口 Port:Big Endian 格式的整型端口号; |
||||
- 有效时间 T:分钟数; |
||||
|
||||
客户端在收到动态端口指令时,服务器已开放新的端口用于通信,这时客户端可以将数据发往新的端口。在 T 分钟之后,这个端口将失效,客户端必须重新使用主端口进行通信。 |
||||
|
||||
## 注释 |
||||
|
||||
- 为确保向前兼容性,所有保留字段的值必须为 0。 |
@ -0,0 +1,159 @@
|
||||
# Командные аргументы |
||||
|
||||
::: tip |
||||
Xray использует команды и аргументы в стиле Go. |
||||
::: |
||||
|
||||
## Базовые команды |
||||
|
||||
Вы можете запустить `xray help`, чтобы получить список всех базовых команд Xray, а также их описание и примеры использования. |
||||
|
||||
``` |
||||
Xray is a platform for building proxies. |
||||
|
||||
Usage: |
||||
|
||||
xray <command> [arguments] |
||||
|
||||
The commands are: |
||||
|
||||
run Run Xray with config, the default command |
||||
version Show current version of Xray |
||||
api Call an API in an Xray process |
||||
tls TLS tools |
||||
uuid Generate UUIDv4 or UUIDv5 |
||||
x25519 Generate key pair for x25519 key exchange |
||||
wg Generate key pair for wireguard key exchange |
||||
|
||||
Use "xray help <command>" for more information about a command. |
||||
|
||||
``` |
||||
|
||||
### xray run |
||||
|
||||
Запуск Xray с указанием одного или нескольких файлов конфигурации. |
||||
|
||||
Использование: |
||||
|
||||
``` |
||||
xray run [-c config.json] [-confdir dir] |
||||
``` |
||||
|
||||
``` |
||||
Run Xray with config, the default command. |
||||
|
||||
The -config=file, -c=file flags set the config files for |
||||
Xray. Multiple assign is accepted. |
||||
|
||||
The -confdir=dir flag sets a dir with multiple json config |
||||
|
||||
The -format=json flag sets the format of config files. |
||||
Default "auto". |
||||
|
||||
The -test flag tells Xray to test config files only, |
||||
without launching the server. |
||||
|
||||
The -dump flag tells Xray to print the merged config. |
||||
``` |
||||
|
||||
`-config=` / `-c=`: Указывает путь к файлу конфигурации, поддерживается использование нескольких файлов. |
||||
`-confdir=`: Указывает путь к папке, содержащей несколько файлов конфигурации. |
||||
`-format=`: Задает формат файлов конфигурации. |
||||
`-test`: Проверяет корректность файлов конфигурации. |
||||
`-dump`: Выводит объединенный результат слияния нескольких файлов конфигурации. |
||||
|
||||
::: tip |
||||
Помимо формата JSON по умолчанию, файлы конфигурации также могут быть в формате TOML или YAML. Если формат не указан явно, он определяется по расширению файла. |
||||
::: |
||||
|
||||
``` |
||||
xray run -dump |
||||
``` |
||||
|
||||
Выводит результат слияния нескольких файлов конфигурации. |
||||
|
||||
### xray version |
||||
|
||||
Выводит информацию о версии Xray, версии Golang и т. д. |
||||
|
||||
Использование: |
||||
|
||||
``` |
||||
xray version |
||||
``` |
||||
|
||||
### xray api |
||||
|
||||
Вызов gRPC API Xray, который должен быть включен в файле конфигурации. |
||||
|
||||
Использование: |
||||
|
||||
``` |
||||
xray api <command> [arguments] |
||||
``` |
||||
|
||||
``` |
||||
restartlogger Restart the logger |
||||
stats Get statistics |
||||
statsquery Query statistics |
||||
statssys Get system statistics |
||||
adi Add inbounds |
||||
ado Add outbounds |
||||
rmi Remove inbounds |
||||
rmo Remove outbounds |
||||
``` |
||||
|
||||
### xray tls |
||||
|
||||
Инструменты для работы с TLS. |
||||
|
||||
Использование: |
||||
|
||||
``` |
||||
xray tls <command> [arguments] |
||||
``` |
||||
|
||||
``` |
||||
cert Generate TLS certificates |
||||
ping Ping the domain with TLS handshake |
||||
certChainHash Calculate TLS certificates hash. |
||||
``` |
||||
|
||||
### xray uuid |
||||
|
||||
Генерация UUID. |
||||
|
||||
Использование: |
||||
|
||||
``` |
||||
xray uuid [-i "example"] |
||||
``` |
||||
|
||||
### xray x25519 |
||||
|
||||
Генерация пары ключей x25519. |
||||
|
||||
Использование: |
||||
|
||||
``` |
||||
xray x25519 [-i "(base64.RawURLEncoding)" --std-encoding ] |
||||
``` |
||||
|
||||
### xray wg |
||||
|
||||
Генерация пары ключей curve25519 для WireGuard. |
||||
|
||||
Использование: |
||||
|
||||
``` |
||||
xray wg [-i "(base64.StdEncoding)"] |
||||
``` |
||||
|
||||
::: tip |
||||
Если `-config` не указан, Xray попытается загрузить `config.json` из следующих мест: |
||||
|
||||
- Рабочий каталог (Working Directory); |
||||
- Путь, указанный в переменной окружения `Xray.location.asset` (см. [Переменные окружения](../config/features/env.md#ресурсные-файлы)). |
||||
::: |
||||
|
||||
|
@ -0,0 +1,108 @@
|
||||
# Настройка и запуск |
||||
|
||||
После того, как вы [скачали и установили](./install) Xray, вам потребуется его настроить. |
||||
|
||||
В данном руководстве мы рассмотрим только простой способ настройки. Дополнительные шаблоны: [Xray-examples](https://github.com/XTLS/Xray-examples) |
||||
|
||||
Для настройки более сложных функций обратитесь к подробным инструкциям в разделе [Файл конфигурации](../config/). |
||||
|
||||
::: danger |
||||
Во избежание расшифровки вашего трафика <br> |
||||
следует сгенерировать уникальный UUID с помощью команды `xray uuid` или `uuidgen`, <br> |
||||
который затем нужно вставить на стороне сервера в поле `inbounds[0].settings.clients[0].id`, <br> |
||||
а на стороне клиента - в поле `outbounds[0].settings.vnext[0].users[0].id`. <br> |
||||
::: |
||||
|
||||
## Настройка сервера |
||||
|
||||
Вам понадобится сервер с публичным IP-адресом (не за NAT), на котором будет запущен Xray. Конфигурация сервера: |
||||
|
||||
```json |
||||
{ |
||||
"inbounds": [ |
||||
{ |
||||
"port": 10086, // Порт, который слушает сервер |
||||
"protocol": "vmess", |
||||
"settings": { |
||||
"clients": [ |
||||
{ |
||||
"id": "b831381d-6324-4d53-ad4f-8cda48b30811" // Не забудьте заменить это поле, сгенерировав UUID с помощью `xray uuid` или `uuidgen` |
||||
} |
||||
] |
||||
} |
||||
} |
||||
], |
||||
"outbounds": [ |
||||
{ |
||||
"protocol": "freedom" |
||||
} |
||||
] |
||||
} |
||||
``` |
||||
|
||||
Убедитесь, что `id` и порт в конфигурации сервера совпадают с настройками клиента, чтобы подключение работало correctamente. |
||||
|
||||
## Настройка клиента |
||||
|
||||
На вашем компьютере (или телефоне) необходимо запустить Xray со следующей конфигурацией: |
||||
|
||||
```json |
||||
{ |
||||
"inbounds": [ |
||||
{ |
||||
"port": 1080, // Порт SOCKS-прокси, на него нужно будет направлять трафик в браузере |
||||
"listen": "127.0.0.1", |
||||
"protocol": "socks", |
||||
"settings": { |
||||
"udp": true |
||||
} |
||||
} |
||||
], |
||||
"outbounds": [ |
||||
{ |
||||
"protocol": "vmess", |
||||
"settings": { |
||||
"vnext": [ |
||||
{ |
||||
"address": "server", // Адрес сервера, замените его на IP-адрес или доменное имя вашего сервера |
||||
"port": 10086, // Порт сервера |
||||
"users": [ |
||||
{ |
||||
"id": "b831381d-6324-4d53-ad4f-8cda48b30811" // Не забудьте заменить это поле, сгенерировав UUID с помощью `xray uuid` или `uuidgen` |
||||
} |
||||
] |
||||
} |
||||
] |
||||
} |
||||
}, |
||||
{ |
||||
"protocol": "freedom", |
||||
"tag": "direct" |
||||
} |
||||
], |
||||
"routing": { |
||||
"domainStrategy": "IPOnDemand", |
||||
"rules": [ |
||||
{ |
||||
"type": "field", |
||||
"ip": ["geoip:private","geoip:cn"], // Исключить локальную сеть и диапазоны IP-адресов Китая |
||||
"outboundTag": "direct" |
||||
} |
||||
] |
||||
} |
||||
} |
||||
``` |
||||
Единственное, что вам нужно изменить в приведенной выше конфигурации, - это IP-адрес вашего сервера и UUID пользователя, как указано в комментариях. Эта конфигурация будет перенаправлять весь трафик на ваш сервер, за исключением локальной сети (например, доступ к маршрутизатору) и диапазонов IP-адресов Китая (например, доступ к bilibili, acfun). |
||||
|
||||
## Запуск |
||||
|
||||
- В Windows и macOS файл конфигурации обычно находится в том же каталоге, что и Xray, и называется `config.json`. |
||||
- Просто запустите `Xray` или `Xray.exe`. |
||||
- В Linux файл конфигурации обычно находится в каталоге `/etc/xray/` или `/usr/local/etc/xray/`. |
||||
- Запустите команду `xray run -c /etc/xray/config.json`. |
||||
- Или используйте systemd или другой инструмент для запуска Xray как службы в фоновом режиме. |
||||
|
||||
Более подробную информацию можно найти в [документации по конфигурации](../config/) и в разделе [Простыми словами](./level-0/). |
||||
|
||||
|
||||
|
@ -0,0 +1,49 @@
|
||||
# Вклад в документацию Project X |
||||
|
||||
Мы приветствуем ваш вклад в документацию Project X и благодарим каждого контрибьютора за помощь! Вы делаете Xray лучше! |
||||
|
||||
## Улучшение документации |
||||
|
||||
Документация Project X размещена на [GitHub](https://github.com/XTLS/Xray-docs-next). |
||||
|
||||
Вы можете внести изменения в документацию, выполнив следующие действия: |
||||
|
||||
1. Откройте [репозиторий документации Project X](https://github.com/XTLS/Xray-docs-next), нажмите кнопку "Fork" в правом верхнем углу, чтобы создать копию репозитория документации в вашей учетной записи GitHub. |
||||
|
||||
2. Используйте любой удобный инструмент для клонирования документации из вашего репозитория, например: |
||||
|
||||
``` |
||||
git clone https://github.com/XTLS/Xray-docs-next.git |
||||
``` |
||||
|
||||
3. Создайте новую ветку на основе ветки `main`, например: |
||||
|
||||
``` |
||||
git checkout -b your-branch |
||||
``` |
||||
|
||||
4. Внесите изменения в новую ветку. |
||||
|
||||
Примечание: рекомендуем придерживаться [Руководства по оформлению текстов на китайском языке](https://github.com/sparanoid/chinese-copywriting-guidelines) (на китайском). |
||||
|
||||
5. После внесения изменений отформатируйте их с помощью [Prettier](https://prettier.io/docs/en/install.html). |
||||
|
||||
Примечание: запросы на включение (PR) с ошибками форматирования могут быть отклонены. |
||||
|
||||
6. Зафиксируйте изменения и отправьте их в ваш репозиторий: |
||||
|
||||
``` |
||||
git push -u origin your-branch |
||||
``` |
||||
|
||||
7. Откройте GitHub, перейдите в раздел "Pull requests" и создайте новый запрос на включение (PR) в [репозиторий документации Project X](https://github.com/XTLS/Xray-docs-next). |
||||
|
||||
8. В заголовке и описании PR кратко опишите внесенные изменения. |
||||
|
||||
9. Дождитесь ответа. Если ваш PR будет принят, изменения появятся на [сайте документации Project X](https://xtls.github.io). |
||||
|
||||
## Нашли ошибку? |
||||
|
||||
Если вы обнаружили ошибку в документации, вы можете внести исправления или создать задачу (Issue). |
||||
|
||||
|
@ -0,0 +1,119 @@
|
||||
# Загрузка и установка |
||||
|
||||
## Поддерживаемые платформы |
||||
|
||||
Xray доступен на следующих платформах: |
||||
|
||||
- Windows 7 и выше (x86 / amd64 / arm32 / arm64); |
||||
- macOS 10.10 Yosemite и выше (amd64 / arm64); |
||||
- Linux 2.6.23 и выше (x86 / amd64 / arm / arm64 / mips64 / mips / ppc64 / s390x / riscv64); |
||||
- Включая, но не ограничиваясь: Debian 7 / 8, Ubuntu 12.04 / 14.04 и выше, CentOS 7 / 8, Arch Linux и др.; |
||||
- FreeBSD (x86 / amd64); |
||||
- OpenBSD (x86 / amd64); |
||||
- Dragonfly BSD (amd64); |
||||
|
||||
## Загрузка Xray |
||||
|
||||
Предварительно скомпилированные ZIP-архивы с двоичными файлами можно найти в [Github Releases](https://github.com/xtls/Xray-core/releases). |
||||
|
||||
Скачайте архив для своей платформы, распакуйте его и можете использовать. |
||||
|
||||
## Проверка установочного пакета |
||||
|
||||
Xray предлагает два способа проверки: |
||||
|
||||
- SHA1 / SHA256 хэш-сумма ZIP-архива; |
||||
- Воспроизводимая сборка: см. [Сборка Xray](../development/intro/compile.md). |
||||
|
||||
## Установка на Windows |
||||
|
||||
- Скачайте ZIP-архив для Windows на [Github Releases](https://github.com/xtls/Xray-core/releases), распакуйте его, чтобы получить исполняемый файл `xray.exe`, а затем [запустите его из командной строки с параметрами](./command). |
||||
- Установите с помощью менеджера пакетов [Scoop](https://scoop.sh): Xray был добавлен в [Mochi](https://github.com/Qv2ray/mochi). |
||||
|
||||
## Установка на macOS |
||||
|
||||
- Скачайте ZIP-архив для macOS на [Github Releases](https://github.com/xtls/Xray-core/releases), распакуйте его, чтобы получить исполняемый файл `xray`, а затем [запустите его из командной строки с параметрами](./command.md). |
||||
- Установите с помощью менеджера пакетов [Homebrew](https://brew.sh): `brew install xray`. |
||||
- [homebrew-xray](https://github.com/N4FA/homebrew-xray) Спасибо, [@N4FA](https://github.com/N4FA)! |
||||
|
||||
## Установка на Linux |
||||
|
||||
### Установочные скрипты |
||||
|
||||
- Linux Script |
||||
|
||||
- [Xray-install](https://github.com/XTLS/Xray-install) |
||||
|
||||
* One Click |
||||
|
||||
- [Xray-script](https://github.com/kirin10000/Xray-script) |
||||
- [ProxySU](https://github.com/proxysu/ProxySU) |
||||
- [v2ray-agent](https://github.com/reeceyng/v2ray-agent) Спасибо, [@mack-a](https://github.com/mack-a) [@Reece](https://github.com/reeceyng)! |
||||
- [Xray-yes](https://github.com/jiuqi9997/Xray-yes) |
||||
- [Xray-onekey](https://github.com/wulabing/Xray_onekey) |
||||
|
||||
* Magisk |
||||
- [Xray4Magisk](https://github.com/CerteKim/Xray4Magisk) |
||||
- [Xray_For_Magisk](https://github.com/E7KMbb/Xray_For_Magisk) |
||||
|
||||
### Arch Linux |
||||
|
||||
#### Arch User Repository |
||||
|
||||
Требуется [помощник AUR](https://wiki.archlinux.org/index.php/AUR_helpers), например, [yay](https://github.com/Jguer/yay), установка с помощью команды `yay -S xray`. |
||||
|
||||
#### Arch Linux CN |
||||
|
||||
Сначала добавьте [репозиторий Arch Linux CN](https://www.archlinuxcn.org/archlinux-cn-repo-and-mirror/), затем установите от имени пользователя root с помощью команды `pacman -S xray`. |
||||
|
||||
### Linuxbrew |
||||
|
||||
Использование менеджера пакетов Linuxbrew аналогично Homebrew: `brew install xray`. |
||||
|
||||
### Debian <Badge text="WIP" type="warning"/> |
||||
|
||||
### Gentoo |
||||
|
||||
В настоящее время существует три оверлея сторонних разработчиков, которые предоставляют сценарии установки Portage: |
||||
|
||||
- [CHN-beta/touchfish-os](https://github.com/gentoo-mirror/touchfish-os/tree/master/net-proxy/Xray): Поддерживается отдельным пользователем, подходит для систем с systemD. |
||||
- [Gentoo-zh](https://github.com/microcai/gentoo-zh): Поддерживается сообществом, подходит для систем с systemD. |
||||
- [JuanCldCmt/Xray-Overlay](https://github.com/JuanCldCmt/Xray-Overlay): Поддерживается отдельным пользователем, подходит для систем с openRC, использует группу пользователей xray для повышения безопасности. |
||||
|
||||
Добавьте оверлей в локальную систему с помощью layman или eselect-repository, а затем выполните установку. |
||||
|
||||
## Установка с помощью Docker |
||||
|
||||
- [teddysun/xray](https://hub.docker.com/r/teddysun/xray) |
||||
|
||||
### Файловая структура образа Docker |
||||
|
||||
- `/etc/xray/config.json`: файл конфигурации; |
||||
- `/usr/bin/xray`: основная программа Xray; |
||||
- `/usr/share/xray/geoip.dat`: файл данных IP; |
||||
- `/usr/share/xray/geosite.dat`: файл данных доменных имен. |
||||
|
||||
# Графические клиенты |
||||
|
||||
- OpenWrt |
||||
- [PassWall](https://github.com/xiaorouji/openwrt-passwall) |
||||
- [Hello World](https://github.com/jerrykuku/luci-app-vssr) |
||||
- [ShadowSocksR Plus+](https://github.com/fw876/helloworld) |
||||
- [luci-app-xray](https://github.com/yichya/luci-app-xray) ([openwrt-xray](https://github.com/yichya/openwrt-xray)) |
||||
- Windows |
||||
- [v2rayN](https://github.com/2dust/v2rayN) |
||||
- [Qv2ray](https://github.com/Qv2ray/Qv2ray) (проект заморожен и архивирован) |
||||
- [Netch (NetFilter & TUN/TAP)](https://github.com/NetchX/Netch) (проект заморожен и архивирован) |
||||
- Android |
||||
- [v2rayNG](https://github.com/2dust/v2rayNG) |
||||
- [Kitsunebi](https://github.com/rurirei/Kitsunebi/tree/release_xtls) |
||||
- iOS / macOS (с чипом ARM) |
||||
- [Shadowrocket](https://apps.apple.com/app/shadowrocket/id932747118) |
||||
- [Stash](https://apps.apple.com/app/stash/id1596063349) |
||||
- macOS (чип X86 / ARM) |
||||
- [Qv2ray](https://github.com/Qv2ray/Qv2ray) (проект заморожен и архивирован) |
||||
- [V2RayXS](https://github.com/tzmax/V2RayXS) |
||||
|
||||
# Генератор UUID |
||||
|
||||
Генератор UUID от сторонних разработчиков: [uuidgenerator.net](https://www.uuidgenerator.net) |
After Width: | Height: | Size: 161 KiB |
@ -0,0 +1,99 @@
|
||||
# 【Глава 1】 Простыми словами |
||||
|
||||
## 1.1 Для кого эта документация? |
||||
|
||||
В двух словах: для **① новичков без опыта** **② желающих научиться настраивать свой собственный VPS**. |
||||
|
||||
## 1.2 Для кого эта документация не предназначена? |
||||
|
||||
В том числе, но не ограничиваясь: для всевозможных гуру и экспертов, для тех, кто слишком ленив, чтобы во всём разбираться самостоятельно, для тех, кто уже умеет настраивать VPS, для тех, кто точно решил пользоваться платными VPN-сервисами, для тех, кто предпочитает использовать готовые скрипты... Короче говоря, если у вас есть технические знания или вы не хотите настраивать всё сами, можете смело закрывать эту статью. Скорее всего, она покажется вам бесполезной и даже может вызвать раздражение, а оно вам надо? |
||||
|
||||
## 1.3 Важное замечание и другие примечания |
||||
|
||||
**Важное замечание:** |
||||
|
||||
Я не являюсь техническим экспертом, поэтому в этой статье неизбежны пробелы и неточности. Если вы обнаружите какие-либо ошибки, пожалуйста, дайте мне знать об этом деликатно, без лишних эмоций. |
||||
|
||||
**Отказ от ответственности:** |
||||
|
||||
Пожалуйста, относитесь к информации, представленной в этой статье, критически и проверяйте её самостоятельно. Я не несу никакой ответственности за любые проблемы или негативные последствия, возникшие в результате использования информации из этой статьи. |
||||
|
||||
**Предупреждение о многословности:** |
||||
|
||||
Поскольку эта статья предназначена для **новичков без опыта**, многие вещи будут объяснены максимально подробно. Поэтому будьте готовы к тому, что текст будет довольно многословным. |
||||
|
||||
## 1.4 Почему самостоятельная настройка — это сложно? |
||||
|
||||
Чтобы ответить на этот вопрос, нужно немного углубиться в историю вопроса. |
||||
|
||||
Во-первых, обход блокировок существует уже почти двадцать лет (Шок! Ужас!). Сначала для этого достаточно было пары манипуляций (поправить файл hosts, подключиться по SSH), потом понадобились веб-прокси, затем — собственные протоколы (например, Shadowsocks) и так далее. |
||||
|
||||
По мере того, как технологии блокировок совершенствовались на протяжении последних десятилетий, для самостоятельного обхода блокировок теперь нужно уметь: |
||||
|
||||
- Разбираться в основных командах Linux. |
||||
- Понимать принципы работы сетевых протоколов. |
||||
- Иметь технические навыки и средства для покупки и управления VPS. |
||||
- Иметь технические навыки и средства для покупки и управления доменными именами. |
||||
- Уметь получать TLS-сертификаты. |
||||
- И многое другое. |
||||
|
||||
Всё это превратило некогда простую задачу в пугающее испытание для новичков. |
||||
|
||||
Во-вторых, о проблемах новичков. |
||||
|
||||
Начинающим пользователям без технического бэкграунда, чтобы разобраться во всех этих премудростях, приходится изучать огромные массивы информации, разбросанной по всему интернету: блогам, форумам, группам в мессенджерах, репозиториям на GitHub, видео на YouTube и так далее. |
||||
|
||||
Вся эта информация часто оказывается противоречивой, неполной или попросту неверной. Новичкам остаётся только гадать, кому верить и как всё это работает на самом деле. |
||||
|
||||
В итоге вместо нехватки информации новички сталкиваются с её избытком. После нескольких (скорее всего, неудачных) попыток разобраться во всём этом, их энтузиазм угасает. А если по пути им ещё и «посчастливится» обратиться за помощью не в то место, их могут ещё и высмеять: «Ну ты и нуб, проще уж платным VPN пользоваться, зачем изобретать велосипед?» или «Сначала Linux изучи, потом приходи». |
||||
|
||||
В такие моменты остаётся только горько усмехнуться. |
||||
|
||||
## 1.5 «Почему бы просто не пользоваться платным VPN?» |
||||
|
||||
Во-первых, я хотел бы спросить у любителей подобных советов: разве платные VPN — это панацея? |
||||
|
||||
Во-вторых, я считаю, что «не знать» и «не хотеть знать» — это две большие разницы. Конечно, инфантилы, которые хотят всё и сразу, не прилагая никаких усилий, вызывают только раздражение. Но люди, которые искренне хотят разобраться во всём сами, не заслуживают презрения и издёвок. Именно эта нетерпимость к новичкам и побудила меня написать эту статью. |
||||
|
||||
Давайте разберёмся, в чём плюсы и минусы платных VPN-сервисов. |
||||
|
||||
**Плюсы:** |
||||
|
||||
1. **Простота использования:** сканирование QR-кода, добавление правил в один клик и т.д. |
||||
2. **Большой выбор серверов:** доступ к ресурсам разных стран и регионов; например, выделенные серверы с низкой задержкой (iplc), серверы для онлайн-игр и т.д. |
||||
3. **Множество точек подключения:** выше устойчивость к блокировкам, если один сервер заблокируют, можно подключиться к другому. |
||||
|
||||
**Риски:** |
||||
|
||||
За удобство приходится платить, и в случае с платными VPN-сервисами риски следующие: |
||||
|
||||
1. **VPN-провайдер имеет полный доступ к вашим данным:** всё, что вы делаете в интернете, **обязательно** проходит и **с большой вероятностью** хранится на серверах провайдера. Эти данные никак не защищены пользовательским соглашением или законом о защите персональных данных **(вас могут отслеживать и записывать всё, что вы делаете)**. |
||||
2. **Отсутствие регулирования рынка:** высока вероятность нарваться на мошенников **(провайдер может в любой момент исчезнуть с вашими деньгами)**. |
||||
3. **Давление со стороны регулирующих органов:** крупные VPN-провайдеры, с одной стороны, кажутся более надёжными, но, с другой стороны, чаще привлекают к себе внимание властей. В 2020 году было несколько случаев закрытия и прекращения работы крупных VPN-провайдеров, что привело к серьёзным неудобствам для пользователей **(провайдер может быть вынужден прекратить работу)**. |
||||
4. **Непрозрачность технических решений:** качество предоставляемых услуг может сильно варьироваться, не редки случаи обмана **(низкая скорость, частые обрывы связи, невозможность подключения)**. |
||||
|
||||
## 1.6 Так стоит ли настраивать VPN самостоятельно? |
||||
|
||||
Теперь, когда вы знаете о плюсах и минусах платных VPN, решать вам. В конце концов, лучший вариант — тот, который подходит именно вам. |
||||
|
||||
![Выбор за вами!](./ch01-img01-choice.png) |
||||
|
||||
1. Если вы решили воспользоваться платным VPN, можете закрыть эту статью. |
||||
|
||||
2. Если же вы решили настроить всё самостоятельно, продолжайте чтение! |
||||
|
||||
Цель этой статьи — стать отправной точкой для новичков, предоставить подробное пошаговое руководство по настройке VPN-сервера на VPS, начиная **с ввода первой команды** и заканчивая **успешным подключением к заблокированным ресурсам**. |
||||
|
||||
В процессе настройки вы познакомитесь с основными командами Linux, что станет хорошей базой для дальнейшего изучения этой операционной системы. |
||||
|
||||
## 1.7 Немного лирики |
||||
|
||||
1. В интернете много дезинформации, поэтому важно научиться критически мыслить, не поддаваться на провокации и не верить всему, что пишут. |
||||
2. Искренне надеюсь, что, получив доступ к свободному интернету, вы сможете узнавать больше нового, наслаждаться разнообразным контентом, знакомиться с интересными людьми и находить единомышленников. |
||||
3. Ваша личность в интернете — это всё ещё вы. Добиться полной анонимности крайне сложно, поэтому не забывайте о законах вашей страны и стран, IP-адреса которых вы используете. Всегда помните о собственной безопасности. |
||||
|
||||
## 1.8 Ваш прогресс |
||||
|
||||
> ⬛⬜⬜⬜⬜⬜⬜⬜ 12.5% |
||||
|
||||
|
After Width: | Height: | Size: 55 KiB |
@ -0,0 +1,57 @@
|
||||
# 【Глава 2】 Подготовка |
||||
|
||||
Эта глава особенная, поскольку затрагивает финансовые операции. В соответствии с нейтральной позицией проекта, здесь не будет конкретных рекомендаций. Всё, что я могу сделать, — это рассказать, что вам понадобится. |
||||
|
||||
## 2.1 Приобретение VPS |
||||
|
||||
Вам нужно получить работающий VPS с не заблокированным IP-адресом и выполнить следующие базовые действия в панели управления: |
||||
|
||||
1. Установить на VPS операционную систему Debian 10 64-bit. |
||||
2. Записать IP-адрес VPS (в этой статье он будет обозначаться как `"100.200.300.400"`). |
||||
::: tip |
||||
Это **неверный** IP-адрес, используемый только в качестве примера. Не забудьте заменить его на свой реальный IP-адрес. |
||||
::: |
||||
3. Записать порт (Port) SSH для удалённого подключения к VPS. |
||||
4. Записать имя пользователя и пароль для удалённого подключения по SSH. |
||||
|
||||
Выбор и покупка VPS — дело непростое. Рекомендуем сначала изучить этот вопрос и выбрать тариф, который соответствует вашим финансовым возможностям и требованиям к скорости и качеству связи. Также можно воспользоваться бесплатными (постоянными или временными) предложениями от крупных облачных провайдеров, таких как Oracle Cloud и Google Cloud. Главное — не влезайте в долги. |
||||
|
||||
::: tip Пояснение |
||||
Несколько слов о выборе Debian 10 в качестве операционной системы. Что бы вы ни слышали в интернете, какой бы дистрибутив Linux ни советовали вам гуру, все эти споры о том, какой Linux лучше, **не имеют к вам никакого отношения**! Debian 10 — это надёжная и стабильная операционная система, которая отлично подходит для работы VPN-сервера и достаточно оптимизирована (например, имеет специальное ядро для облачных сред и своевременную поддержку BBR). Когда вы освоитесь с Linux, можете попробовать и другие дистрибутивы. |
||||
::: |
||||
|
||||
## 2.2 Выбор доменного имени |
||||
|
||||
Вам нужно получить доменное имя и добавить A-запись, указывающую на IP-адрес вашего VPS, в настройках DNS. |
||||
|
||||
1. Выберите надёжного международного регистратора доменных имён. Доменная зона (расширение домена) может быть любой, главное — не используйте `.cn`. |
||||
2. В настройках DNS добавьте A-запись, указывающую на IP-адрес вашего VPS (имя A-записи может быть любым, в этой статье оно будет обозначаться как `"a-name"`. Полное доменное имя будет выглядеть как `"a-name.yourdomain.com"`). Должно получиться примерно так: |
||||
|
||||
![Добавление A-записи](./ch02-img01-a-name.png) |
||||
|
||||
::: tip |
||||
Это **не** настоящий URL-адрес. Не забудьте заменить его на свой реальный адрес. |
||||
::: |
||||
|
||||
## 2.3 Необходимое программное обеспечение |
||||
|
||||
1. SSH-клиент для удалённого подключения: |
||||
|
||||
- Windows: [PuTTY](https://www.chiark.greenend.org.uk/~sgtatham/putty/latest.html) |
||||
- macOS/Linux: Terminal |
||||
|
||||
2. Программа для передачи файлов: |
||||
|
||||
- Windows: [WinSCP](https://winscp.net/eng/index.php) |
||||
- macOS/Linux: Terminal |
||||
|
||||
3. Хороший текстовый редактор: |
||||
- Windows/macOS/Linux: [VSCode](https://code.visualstudio.com) |
||||
|
||||
## 2.4 Ваш прогресс |
||||
|
||||
Если вы выполнили все пункты из этого раздела, у вас уже есть всё необходимое, чтобы открыть для себя новый мир. Так чего же мы ждём? Давайте перейдём к следующей главе и сделаем это! |
||||
|
||||
> ⬛⬛⬜⬜⬜⬜⬜⬜ 25% |
||||
|
||||
|
After Width: | Height: | Size: 91 KiB |
After Width: | Height: | Size: 50 KiB |
After Width: | Height: | Size: 58 KiB |
After Width: | Height: | Size: 19 KiB |
After Width: | Height: | Size: 25 KiB |
After Width: | Height: | Size: 3.1 MiB |
@ -0,0 +1,87 @@
|
||||
# 【Глава 3】 Удалённое подключение |
||||
|
||||
## 3.1 Удалённое подключение к VPS (PuTTY) |
||||
|
||||
Во-первых, поскольку Windows является самой распространённой операционной системой среди новичков, в этой статье мы будем использовать её в качестве примера. |
||||
|
||||
Во-вторых, хотя PowerShell и WSL в Windows 10 и выше также предоставляют удобные инструменты для работы по SSH, не все версии Windows имеют эти компоненты. Поэтому в этой статье мы рассмотрим подключение по SSH с помощью старого доброго PuTTY. (После подключения по SSH действия во всех программах будут одинаковыми.) |
||||
|
||||
Итак, давайте начнём. |
||||
|
||||
1. Перейдите на [официальный сайт](https://www.chiark.greenend.org.uk/~sgtatham/putty/latest.html) PuTTY и скачайте версию, подходящую для вашей операционной системы (в этой статье мы будем использовать 64-битную версию). |
||||
|
||||
![Скачать PuTTY](./ch03-img01-putty-download.png) |
||||
|
||||
2. Запустите PuTTY. Откроется главное окно программы. Теперь возьмите [блокнот](./ch02-preparation.md#21-получение-vps), в который вы записывали информацию в предыдущей главе, и введите **IP-адрес** и **порт** вашего VPS в соответствующие поля (на скриншоте ниже). Чтобы не вводить эти данные каждый раз, можно сохранить сеанс (Saved Sessions). В дальнейшем вы сможете загрузить сохранённые настройки одним кликом. |
||||
|
||||
![Настройка PuTTY](./ch03-img02-putty-settings.png) |
||||
|
||||
3. Рекомендуем установить значение `keepalive` в разделе `Connection` равным `60` секундам, чтобы предотвратить разрыв SSH-соединения, если вы долгое время не будете выполнять никаких действий. Не забудьте снова сохранить настройки. |
||||
|
||||
![Предотвращение разрывов соединения](./ch03-img03-putty-keepalive.png) |
||||
|
||||
::: warning Внимание |
||||
После любых изменений настроек PuTTY необходимо сохранить сеанс, иначе они будут потеряны при закрытии программы. |
||||
::: |
||||
|
||||
4. Нажмите кнопку "Open", чтобы открыть окно SSH-подключения. Введите имя пользователя и пароль для подключения к вашему VPS (в этой статье предполагается, что имя пользователя по умолчанию — `root`. Обратите внимание, что при вводе пароля в Linux не отображаются символы `******`. Это сделано для того, чтобы скрыть длину пароля. Не пугайтесь, ваша клавиатура в порядке!). |
||||
|
||||
![Подключение по SSH](./ch03-img04-ssh-login.png) |
||||
|
||||
## 3.2 Успешное подключение по SSH! Знакомство с командной строкой! |
||||
|
||||
1. Если вы всё сделали правильно, вы увидите примерно такой экран, как на рисунке ниже. Это означает, что вы успешно подключились к серверу: |
||||
|
||||
![Первое подключение к VPS](./ch03-img05-ssh-login-success.png) |
||||
|
||||
Этот экран — аналог «рабочего стола» на удалённом сервере, но здесь нет привычных значков, курсора мыши и ярких цветов. Только текст. Это и есть **командная строка** — *Command Line Interface* или сокращённо *CLI*. |
||||
|
||||
Все дальнейшие действия вам придётся выполнять в командной строке, как хакер в кино. Возможно, поначалу это покажется вам непривычным, но поверьте, в использовании командной строки нет ничего страшного или сложного. По сути, это всего лишь способ взаимодействия с компьютером с помощью текстовых команд вместо графического интерфейса. **Вы пишете команду, а компьютер её выполняет.** |
||||
|
||||
2. Теперь можете немного осмотреться и познакомиться с командной строкой. На этом экране уже есть полезная информация, например, версия ядра системы (в данном случае `4.19.37-5`), время последнего входа в систему, IP-адрес и т.д. Конечно, в зависимости от VPS, ваш экран может выглядеть немного иначе. |
||||
|
||||
3. Обратите внимание на последнюю строку командной строки. Слева от мигающего курсора находится набор символов. В данном случае это `root@vps-server:~#`. Что это значит? Всё просто: |
||||
|
||||
- Текущий пользователь: `root`. |
||||
- Имя сервера, на котором работает пользователь `root`: `vps-server`. |
||||
- Текущий каталог, в котором находится пользователь `root`: `~`. |
||||
- Символ `#` указывает на то, что после него можно вводить команды. |
||||
|
||||
Первые два пункта интуитивно понятны и не требуют пояснений. Третий пункт относится к файловой системе Linux. Сейчас вам не нужно вдаваться в подробности, достаточно знать, что `~` — это «домашний каталог» текущего пользователя. Четвёртый пункт, символ `#`, также не требует особого внимания. Просто знайте, что в дальнейшем все команды, которые вам нужно будет вводить, будут начинаться с `#` или `$`. Это будет означать, что **после** этого символа нужно ввести команду (поэтому при копировании команд **копируйте только текст после**, без символа `#` или `$`). |
||||
|
||||
## 3.3 Первое обновление программного обеспечения Linux! |
||||
|
||||
1. Так же, как и ваш телефон, будь то Android или iPhone, Linux нуждается в регулярном обновлении программного обеспечения для получения исправлений безопасности и новых функций. В Linux каждое приложение называется «пакетом» (package). А программа, которая управляет пакетами, называется «менеджером пакетов» (Package Manager). С помощью менеджера пакетов можно устанавливать, обновлять и удалять программы, а также обновлять саму систему Linux. Менеджеры пакетов Linux очень мощные, но сейчас вам достаточно знать, что в Debian используется менеджер пакетов `apt`. Давайте обновим систему с помощью `apt`, чтобы вы познакомились с его основными функциями. |
||||
|
||||
2. Базовые команды Linux: |
||||
|
||||
| Номер | Команда | Описание | |
||||
| :----: | :----------: | :----------------- | |
||||
| `cmd-01` | `apt update` | Проверить обновления | |
||||
| `cmd-02` | `apt upgrade` | Установить обновления| |
||||
|
||||
3. Введите первую команду, чтобы получить информацию об обновлениях: |
||||
|
||||
```shell |
||||
apt update |
||||
``` |
||||
|
||||
4. Затем введите вторую команду. При появлении запроса на подтверждение установки `(Y/n)` введите `y` и нажмите Enter, чтобы начать установку. |
||||
|
||||
```shell |
||||
apt upgrade |
||||
``` |
||||
|
||||
5. Весь процесс показан на гифке ниже: |
||||
|
||||
![Демонстрация процесса обновления](./ch03-img06-apt-upgrade-full.gif) |
||||
|
||||
## 3.4 Ваш прогресс |
||||
|
||||
**Поздравляем, вы сделали ещё один важный шаг!** Теперь вы умеете подключаться к своему серверу по SSH! Но что делать после подключения, кроме обновления системы? Узнаем в следующей главе! |
||||
|
||||
> ⬛⬛⬛⬜⬜⬜⬜⬜ 37.5% |
||||
|
||||
|
||||
|
||||
|
After Width: | Height: | Size: 44 KiB |
After Width: | Height: | Size: 95 KiB |
After Width: | Height: | Size: 36 KiB |
After Width: | Height: | Size: 46 KiB |
After Width: | Height: | Size: 120 KiB |
After Width: | Height: | Size: 77 KiB |
After Width: | Height: | Size: 52 KiB |
After Width: | Height: | Size: 61 KiB |
After Width: | Height: | Size: 104 KiB |
After Width: | Height: | Size: 50 KiB |
After Width: | Height: | Size: 104 KiB |
After Width: | Height: | Size: 114 KiB |
After Width: | Height: | Size: 143 KiB |
After Width: | Height: | Size: 134 KiB |
After Width: | Height: | Size: 141 KiB |
After Width: | Height: | Size: 961 KiB |
After Width: | Height: | Size: 112 KiB |
After Width: | Height: | Size: 62 KiB |
After Width: | Height: | Size: 30 KiB |