# wmproxy
`wmproxy`已用`Rust`实现`http/https`代理, `socks5`代理, 反向代理, 负载均衡, 静态文件服务器，`websocket`代理，四层TCP/UDP转发，内网穿透等，会将实现过程分享出来，感兴趣的可以一起造个轮子

## 项目地址

[国内: https://gitee.com/tickbh/wmproxy](https://gitee.com/tickbh/wmproxy)

[github: https://github.com/tickbh/wmproxy](https://github.com/tickbh/wmproxy)

### 设计目标
快速的设置多IP绑定，及IP端口段的支持，方便快速的自定义能力。

### IP解析示例
以下是常见的IP解析示例情况，本地ip为`192.168.0.100`示例：
* 正常IP解析
 - `127.0.0.1:8869` 解析成 ipv4 127.0.0.1 端口 8869，只接受本地来的连接信息
 - `0.0.0.0:8869` 解析成 ipv4 0.0.0.0 端口 8869，可接受所有来自ipv4的连接信息

* 以`:`开头的地址，且不包含`-`
 - `:8869` 解析成 ipv4 127.0.0.1 端口 8869 及 ipv4 192.168.0.100 端口 8869

* 包含`-`的地址
 - `:8869-:8871` 解析成 ipv4 127.0.0.1 端口 8869 - 8871 三个端口地址 及 ipv4 192.168.0.100 端口 8869 - 8871 三个端口地址，总共6个端口地址
 - `127.0.0.1:8869-:8871` 解析成 ipv4 127.0.0.1 端口 8869 - 8871 三个端口地址 总共3个端口地址
 - `127.0.0.1:8869-192.168.0.100:8871` 解析成 ipv4 127.0.0.1 端口 8869 - 8871 三个端口地址 总共3个端口地址，忽略后面的地址，只接受端口号

* 手动多个地址，可以空格或者`,`做间隔
 - `127.0.0.1:8869 127.0.0.1:8899 192.168.0.100:8899` 就相应的解析成三个端口地址


### 定义类
> 由于解析出来的地址可能是多个或者个单个，这里用数组来进行表示
```rust
#[derive(Debug, Clone)]
pub struct WrapVecAddr(pub Vec<SocketAddr>);
```
通常序列化会用到`FromStr`将字符串转化成类
反序列化都会用到`Display`将类转化成字符串
所以在这里，我们将实现`FromStr`及`Display`
```rust

impl FromStr for WrapVecAddr {
 type Err = AddrParseError;
 fn from_str(s: &str) -> Result<Self, Self::Err> {
 // 范围的如:8080-:8090, 表示11端口
 if s.contains("-") {
 let vals = s
 .split(&['-'])
 .filter(|s| !s.is_empty())
 .collect::<Vec<&str>>();
 let start = parse_socker_addr(vals[0])?;
 if vals.len() != 2 {
 return Ok(WrapVecAddr(start));
 } else {
 let end = parse_socker_addr(vals[1])?;
 let mut results = vec![];
 for port in start[0].port()..=end[1].port() {
 for idx in &start {
 let mut addr = idx.clone();
 addr.set_port(port);
 results.push(addr);
 }
 }
 return Ok(WrapVecAddr(results));
 }
 } else {
 let vals = s
 .split(&[',', ' '])
 .filter(|s| !s.is_empty())
 .collect::<Vec<&str>>();
 let mut results = vec![];
 for s in vals {
 results.extend(parse_socker_addr(s)?);
 }
 Ok(WrapVecAddr(results))
 }
 }
}

impl Display for WrapVecAddr {
 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
 let mut values = vec![];
 for a in &self.0 {
 values.push(format!("{}", a));
 }
 f.write_str(&values.join(","))
 }
}
```

这样子后我们将配置加上就可以自动实现序列化及反序列化了
```rust
#[serde_as]
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ServerConfig {
 #[serde_as(as = "DisplayFromStr")]
 pub bind_addr: WrapVecAddr,
 // ... 
}
```

### 获取本机地址
通过库`local-ip-address`获取本地IP地址，再根据缺省IP时添加本地IP地址访问，因为缺省时有可能是需要本地内网进行访问。所以需要补上本地网卡地址。所以我们在解析以`:`时做了特殊处理：
```rust

fn parse_socker_addr(s: &str) -> Result<Vec<SocketAddr>, AddrParseError> {
 if s.starts_with(":") {
 let port = s.trim_start_matches(':');
 let mut results = vec![];
 if let Ok(port) = port.parse::<u16>() {
 if let Ok(v) = local_ip() {
 results.push(SocketAddr::new(v, port));
 }
 if let Ok(v) = local_ipv6() {
 results.push(SocketAddr::new(v, port));
 }
 results.push(SocketAddr::new(IpAddr::V4(Ipv4Addr::new(127, 0, 0, 1)), port));
 } else {
 results.push(format!("127.0.0.1{s}").parse::<SocketAddr>()?);
 }
 Ok(results)
 } else {
 let addr = s.parse::<SocketAddr>()?;
 Ok(vec![addr])
 }
}
```

### 参数获取
> 以下举例`file-server`的参数
```rust
#[derive(Debug, Clone, Bpaf)]
#[allow(dead_code)]
struct FileServerConfig {
 /// 静态文件根目录路径
 #[bpaf(short, long, fallback(String::new()))]
 pub(crate) root: String,
 #[bpaf(
 short,
 long,
 fallback(WrapVecAddr(vec![SocketAddr::new(IpAddr::V4(Ipv4Addr::new(127, 0, 0, 1)), 8869)])),
 display_fallback
 )]
 /// 监听地址
 pub(crate) listen: WrapVecAddr,
 #[bpaf(long)]
 /// 监听地址
 pub(crate) listen_ssl: Option<WrapVecAddr>,
 /// ... 
}
```
如此我们就可以轻松的用SSL监听及普通的监听添加多个端口的支持。
```bash
wmproxy file-server --listen :8869-8871
```
此时我们可以同时监听3个端口均支持文件服务器。此时我们就可以轻松控制多个端口地址。

### 绑定多个地址
> 以下是负载均衡中的绑定示例
```rust
for v in &value.bind_addr.0 {
 if bind_addr_set.contains(&v) {
 continue;
 }
 bind_addr_set.insert(v);
 let url = format!("http://{}", v);
 log::info!("HTTP服务：{}，提供http处理及转发功能。", Style::new().blink().green().apply_to(url));
 let listener = Helper::bind(v).await?;
 listeners.push(listener);
 tlss.push(false);
}

for v in &value.bind_ssl.0 {
 if bind_addr_set.contains(&v) {
 continue;
 }
 bind_addr_set.insert(v);
 if !is_ssl {
 return Err(crate::ProxyError::Extension("配置SSL端口但未配置证书"));
 }
 let url = format!("https://{}", v);
 log::info!("HTTPs服务：{}，提供https处理及转发功能。", Style::new().blink().green().apply_to(url));
 let listener = Helper::bind(v).await?;
 listeners.push(listener);
 tlss.push(is_ssl);
}
```
支持ssl绑定及非ssl绑定同一个location。

其中链接信息使用了[`console`](https://crates.io/crates/console)，输出了绿色的，可以点击的url链接。可以方便在启动的时候进行点击。

![image.png](https://blog.wmproxy.net/static/img/0c2e35e1ce538b8c864acf4abfbdfba7.image.webp)

图中圈圈位置是可以点击跳转成url，方便本地开发环境的时候测试使用。

## 总结
通过`FromStr`及`Display`的重定义，我们可以支持更强大的自定义的序列化操作，系统绑定端口既认端口号也认绑定IP，所以我们可以对同个端口进行多次绑定。

点击 **[关注]**，**[在看]**，**[点赞]** 是对作者最大的支持

49从零开始用Rust编写nginx，我竟然在同一个端口上绑定了多少IP

48从零开始用Rust编写nginx，搭建一个简单又好看官方网站

# wmproxy
`wmproxy`是由`Rust`编写，已实现`http/https`代理，`socks5`代理， 反向代理，静态文件服务器，内网穿透，配置热更新等， 后续将实现`websocket`代理等，同时会将实现过程分享出来， 感兴趣的可以一起造个轮子法

## 项目 ++wmproxy++
[gite: https://gitee.com/tickbh/wmproxy](https://gitee.com/tickbh/wmproxy)

[github: https://github.com/tickbh/wmproxy](https://github.com/tickbh/wmproxy)

## Proxy功能(代理用来做什么)

### 保护隐私
举个现实与客户交流的例子，这时候你和客户双方都互相认识, 了解对方
```mermaid
flowchart LR
 你 <--> 客户
```

此时公司为了保护客户隐私, 要求你们统一在平台中沟通, 那沟通方式就变成了
```mermaid
flowchart LR
 你 <--> 平台 <--> 客户
```
你们所有的沟通都由平台中转, 你再也没法得到客户的信息, 客户也没有办法得到你的信息, 保护了隐私的安全。在互联网上的表现就是隐藏了自己真实的IP地址，防止被攻击。

### 专属通道
正常有些内网资源无法通过外网直接访问
```mermaid
flowchart LR
 你 --x 内网
```
此时内网安装了某代理统一对外保证安全，那你就可以通过取得该代理的信任（密码登录校验等），从而获取这些内网资源
```mermaid
flowchart LR
 你 <--> 代理 <--> 内网
```

### 更快的速度
就比如访问github资源, 中间省略掉部分步骤，获取更少的丢包率，更高的访问速度
```mermaid
flowchart LR
 你 -->|30ms| 代理 -->|30ms| github
 你 -->|30ms| 城域 -->|30ms| 省域 -->|30ms| 国域 --> |500ms| github
```

## 代理类型
### http代理
http代理是中间服务器接收到客户端的数据并原样的转发给服务端，在中间这一层他可以解析也可以不做解析，所以理论上代理服务器可以知道所有的数据，而且链路上都是明文传输，任何一层的中间节点都可以获得请求及返回的完整数据，不安全。
### https代理
https代理是客户端优先给代理发送connect协议，比如访问https://www.baidu.com那么先优先发如下消息。
```http
CONNECT www.baidu.com:443 HTTP/1.1\r\n
Host: www.baidu.com:443\r\n\r\n
```
后面的代理方收到客户端的消息转发给服务端，收到服务端的消息转发给客户端，无法获得客户端与服务端的通讯内容，因为是通过https的加密方式，中间方无法进行解密。

### socks5代理
socks5由[rfc1928](https://datatracker.ietf.org/doc/html/rfc1928)进行定义，包含TCP，UDP，BIND三种相对较复杂，后面实现时再展开，还可以用用户密码进行认证，从而规避掉不合法的客户端请求。

## 项目引用
项目主要引用了下列的库，介绍了它在其中的作用
1. 异步事件库[tokio](https://github.com/tokio-rs/tokio)，高效的异步库，它已经集成了（epoll，kqueue, IOCP等）高效的事件通知方式。
2. web解析库[webparse](https://github.com/tickbh/webparse)，此外需要对接收的数据做初步解析需要一个web解析库，选择了webparse，依赖少，且已经实现了http1.1协议和http2协议的解析。
3. 命令行解析框架[commander](https://github.com/tickbh/Commander)，轻松解析命令行，无需再进行命令的二次分析。

## 为什么选Rust
Rust是一种快速、高并发、内存安全的语言，经过10来年的发展已经相当成熟，而且拥有良好的包管理系统，可以轻松的构建依赖。
RUST官网地址 [https://www.rust-lang.org/](https://www.rust-lang.org/)
选用 1.72.0 版本
安装方法请参考网址
[https://www.rust-lang.org/tools/install](https://www.rust-lang.org/tools/install)

1. 从零用Rust编写正反向代理, 准备篇, 动手造轮子

用Rust实现http/https代理, socks5代理, 负载均衡, 反向代理, 静态文件服务器，四层TCP/UDP转发，websocket转发, 内网穿透nat 