- Ruci : 如此:
- Rucimp: 如此实现~
- ruci-cmd: 如此简单！ 见 ruci-cmd
项目命名采用了谐音. 同时Ru指代rust, ruci 与 如此谐音. rucimp = ruci + imp, ruci pronounced lucy.
A flexible network proxy framework and toolbox written in Rust (Rust 2021 edition 1.81+) using Lua/toml as the configuration format.
用户 入门 ruci 可阅读 ruci 用户手册
（book源文件在SUMMARY.md)
Developer 入门 ruci 可阅读 Introduction_zh.md
See notes.md for more notes.
文档所限, 肯定有东西没有涉及到, 可提交issue提问或加入讨论. 欢迎加入我们. 注意低调.
一个好的解决问题的模式: 有暂时不懂的问题可以先进群问, 确定问题后再发 issue.
Developer chat: https://t.me/+6yL4ggeyKY0yNjIx
User channel: https://t.me/+r5hKQKYyeuowMTcx
The project is work in progress, 功能会陆续添加与调整.
The project is divided to three main parts:
ruci is the base framewark, defines some concepts like【映射】(Map), 动态Map迭代器 DMIter; implements chain structure, implements some basic Maps; provides some useful relay facilities.
rucimp provides more Maps, defines the config mode(and file format), provides some example binaries. rucimp is the core.
ruci-cmd is the ultimate full feature executable, including utils, api-client and api-server
具体名词解释请看下文.
For lua configuration, see local.lua, remote.lua 和 lua配置说明 以及 ruci 用户手册
full featured command-line executable.
See ruci-cmd
rucimp provides some example binaries for debugging and testing.
See exmaples
See doc/CONTRIBGUITING_zh.md for developper Contributing guidelines in 中文.
A proxy must have both an inbound and an outbound.
If the app only has an inbound, then it's just a regular web server. If the app only has an outbound, then it's just a regular web browser.
On client side, having both an inbound and an outbound is called a regular proxy; Its outbound is connected to the server's inbound.
On server side, having both an inbound and an outbound is called a "reverse proxy". Its outbound is connected to another server's inbound.
Ruci abstracts proxy, regards any protocols as consisting of one or more Map 【映射】
Pseudo code:
Stream generator 【单流发生器】(zero to one): function(args)->stream
Injection 【单射】(one to one function, which is the normal stream Map):
function(stream1, args...)-> (Option<stream2>, useful_data...)
Multi-stream generator【多流发生器】(one to many): function( Option<stream> ,args...)->[channel->stream]
流由流发生器产生.
流发生器是一种不接受流参数, 只接受其它参数的(编程意义下的)函数, 是整个链的起点, 是流的源。
单流发生器 可能是 BindDialer, 文件, 或者 Stdio.
多流发生器可能是 Listener (不接受流参数的无中生有 (一般实际上原理上是对接硬件上的流, 如网卡提供的流) ) 或 inner mux (接受一个流, 对其进行分支处理)。 其在数学意义下可以理解为泛函。
流映射是数学意义下的函数（映射）。 流映射可以改变流(如Tls), 也可以不改变而只是在内容上做修改(如MathAdder),
也可以完全不做修改而只提供副作用(如 Counter, 或Trojan/Socks5 先做握手然后不改变流) (Maps like this are normally called "middleware")
也可以消耗掉流(如 Echo (持有对流的所有权, 自己建立relay loop); Blackhole; 再如 relay 转发过程 将 in 和 out 调转对接, 同时消耗in 和 out 两个流),
消耗流的映射是整个链的终点 .
也可以替换掉流的源(如socks5中的 udp associate, 是持有tcp流的所有权后, 产生并返回一个新的udp流).
如此, 整个架构抽象把代理分成了一个一个小模块（映射）, 像一个个箭头一样，任由你拼接.
虽然看起来没有什么区别, 但是, 你可以很方便地构建一些独特的结构, 比如 TLS+TLS (用于分析 tls in tls,
你甚至可以累加N个, 变成N*TLS), 比如 TCP-Counter-TLS-Counter-TLS-Counter-Socks5-Counter
(Counter用于统计流量, 并将数据原样传递, 这样每一层的流量就都统计出来了)
其它可能的情况比如 Socks5+WS+TLS+WS+Socks5+TLS., 甚至你可以造出一些逻辑结构, 只要有最终出口就行, 如 Socks5 - repeat N [TLS1-TLS2] - Socks5
发挥你的想象力吧.
能够定义动态的链式结构 (如跳转, 以及通过跳转实现的 循环)的链式配置文件要采用脚本语言格式. 这里使用 Lua。
只会返回 有限个Map可能 的动态链 是一种 有限状态机. 静态链是一种特化的有限状态机, 其状态转换函数是 fn(i)->++i。
经典链
# classic chain
p1 p2
\ \
generator->[s1] -> [s2] -> [ output ]
\ \
o1 -> o2 ->
# where s1 is tls and s2 is trojan
# generator is tcp
# p1 is tls settings, o1 is the tls state (alpn, etc...)
# p2 is trojan settings, like the password
# o2 is the trojan state
# output is the encoded client stream
graph LR
p1((p1))-->s1_node[stream1]-.->o1node((o1))
p2((p2))-->s2_node[stream2]-.->o2node((o2))
o1node-..->s2_node
generator-->s1_node-->s2_node-->output
collector[data_collector]
o1node-.->collector
o2node-.->collector
- basic structure (based on "Map"s)
- tcp, udp, unix domain socket, ip (tun, with auto_route)(tun example)
- 流量记录 (两种实现, 分别用于记录原始流量(GlobalTrafficRecorder)与实际流量(Counter)) 与实时单连接流量监控 (trace feature)
- Direct, Blackhole, Listener, BindDialer, Stdio, Fileio
- fixed_target_addr
- TLS, Socks5(+ UDP ASSOCIATE,USERPASS), Http proxy, Socks5http, Trojan
- MathAdder (按字节加法器), Counter, Echo
- 路由 (tag_route)
- fallback (回落)
- DNS: client
- http1.1 识别
- MITM ( man in the middle)
- chain配置格式 (动态链须为lua格式)
- static chain (静态链, 可为 lua/toml 格式)
- dynamic chain (finite, infinite) (动态链)(有限动态链, 完全动态链)
- rucimp/examples
- rule_route 规则路由
- tproxy (with auto_route)
- native-tls
- http_filter, websocket(including early data)
- h2, grpc
- quic (quinn/s2n-quic)
- vpn_test1 （目前只有 单ip转发）
- tcp/ip stack (smoltcp/lwip)
-
ss, vmess - Steganography Protocol Example1
- User-defined Lua protocol
- Embedder (Steganography Protocol)
- basic feature
- api_server
- api_client
- static file server
- utils
- tui: using ratatui
- 了解协议的细节 以进行数据处理、转换到统一格式和“标注”.
- 提供一些新协议的想法
详见 目标
This project is licensed under the MIT OR Apache-2.0 License.
readme files and doc files are also distributed with CC0 1.0 Universal License if the related file has no conflict with the MIT OR Apache-2.0 License.
