# natcross2

**Repository Path**: p2p-nat/natcross2

## Basic Information

- **Project Name**: natcross2
- **Description**: No description available
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2023-10-26
- **Last Updated**: 2023-10-26

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# natcross2
内网穿透工具

*********************

**Q群：438793541**

## natcross是做什么的？
- 需要自己提供硬件支持、部署的内网穿透工具
- 提供TCP协议类型的内网穿透服务，包括但不限于http(s)、数据库连接、ssh等协议
- 支持https协议转http协议与应用交互方式
- 支持无加密、控制端口加密交互、数据加密交互方式
- 主要服务场景，需要将内网的应用开放到公网，如微信小程序开发调试、支付回调等
- 支持HTTP根据host进行反向代理；目标依然是内网应用，只是可以根据HTTP协议header中的host字段区分选择目标应用（注意：只是有人提出来了HTTP监听统一端口并用域名访问的问题，并且有做的价值才补充的该功能；没做负载功能，这个是内网穿透，不是nginx，更不建议直接用在生产上，需要负载的可以自己去实现）

## 打包使用

服务端-ServerApp打包：

```shell
# 修改ServerApp.java中serviceIp为公网服务器的IP

mvn clean compile package -PserverApp
```

客户端-ClientApp打包：

```shell
mvn clean compile package -PclientApp
```

## 安装
1. 需要一台可在公网访问的机器，并将控制端口（默认 servicePort 10010）、数据端口（如tomcat，开放公网 listenPort 8081端口，外网连接时要对应数据端口8081）开放出来
2. 将ServerApp.jar包放在公网可访问的机器并运行，打包前需要修改serviceIp为公网服务器的IP
3. 将clientApp为入口进行运行，destIp:destPort为要开放的内网应用，如本地的tomcat（127.0.0.1:8080）
4. 用浏览器访问serviceIp:listenPort便可以访问到内网的tomcat

## 参数解释
CommonConstants:

|字段|解释|
|:-:|:-|
|serviceIp|公网服务器的IP|
|servicePort|服务端的控制端口，主要用来与客户端进行指令交互|
|listenPort|服务端的监听端口，也就是部署完成后，在外网访问 serviceIp:listenPort 的方式对内网应用进行访问|
|destIp|要开放到公网的内网应用所在机器的IP|
|destPort|要开放到公网的内网应用的端口|
|aesKey|交互密钥key，保证数据的秘密性，可以查看 SecretInteractiveModel.java 中的fullMessage和checkAutograph中确认密钥的使用方式。<br>如果你使用了secretAll方式进行部署，这个key还是数据加密的key，可以在 SecretPassway.java 中确认密钥的使用方式<br>注意使用长度，windows版本的java只能用最大128长度的密钥|
|tokenKey|交互签名key，签名同aesKey|

ServerApp：

|字段|解释|
|:-:|:-|
|sslKeyStorePath|ssl证书的路径，默认方法只支持pkcs12的证书格式，使用这个证书可以做到https协议转http协议|
|sslKeyStorePassword|证书密码|
|createServerSocket|创建socket的方式，主要针对普通socket和sslSocket的方式进行封装，结合ssl证书使用|

ClientApp:

|字段|解释|
|:-:|:-|
|#secretHttpRoute:routes|http方式，根据不同host路由选择不同的目标应用|

## 内网穿透思路

因NAT网内CLIENT可以正常连接到SERVER端，并且能够保持一段时间的长连接，则由CLIENT发起连接，建立SOCKET对，在SERVER收到外部请求时，可以通过已经建立好的SOCKET将数据传输给CLIENT，CLIENT使用相同的方式将数据发送给指定的网络程序，网络程序回发数据后则按原路返回给请求方。
![时序图](./doc/sequence.svg)

## 相关技术

|技术|体现点|
|:-:|:-|
|Socket|核心技术概念|
|NIO|nio.NioHallows，使用Selector作为注册监听器（多路复用），有事件唤起后会创建子线程进行异步处理|
|TCP粘包、拆包的解决|channel.LengthChannel，此处用的是一个大端序列的长度加消息内容的方式|
|线程管控|clientside.ClientControlThread、serverside.client.ClientServiceThread、serverside.listen.ServerListenThread作为独立管控及子线程异步处理的主要体现，亦可通过executor包下相关类进行追踪|
|HTTP路由|api.socketpart.HttpRouteSocketPart#routeHost，一个简单的对host头部字段的处理应用|
|消息加密|对AES、MD5联合的使用示例，channel.SecretInteractiveChannel、model.SecretInteractiveModel，对实际消息进行加密，增加辅助字段保证消息的真实性、准确性和完整性|
|计数门闩|utils.CountWaitLatch，类CountDownLatch，增加了countUp，不只受初始化的值决定，可以增加、减少，主要用来解决nio.NioHallows唤醒后批量channel注册的问题（等下，怎么感觉可以用读写锁来解决呢？）|
|线程池|虽然用了线程池，但默认的是Executors.newCachedThreadPool()来生成的，具体的还是需要根据机器来自定义线程池，主要还是对子线程的管控体现吧|