nps/README.md

497 lines
13 KiB
Markdown
Raw Normal View History

2018-11-04 15:19:58 +00:00
# easyProxy
2018-12-03 16:15:14 +00:00
2018-12-07 07:29:18 +00:00
easyProxy是一款轻量级、高性能、功能最为强大的**内网穿透**代理服务器。目前支持**tcp、udp流量转发**可支持任何tcp、udp上层协议访问内网网站、本地支付接口调试、ssh访问、远程桌面内网dns解析等等……此外还**支持内网http代理、内网socks5代理**可实现在非内网环境下如同使用vpn一样访问内网资源和设备的效果同时支持socks5验证gzip、snnapy压缩节省带宽和流量
2018-11-29 15:05:43 +00:00
2018-12-07 07:29:18 +00:00
目前市面上提供类似服务的有花生壳、TeamView、GoToMyCloud等等但要使用第三方的公网服务器就必须为第三方付费并且这些服务都有各种各样的限制此外由于数据包会流经第三方因此对数据安全也是一大隐患。
2018-11-29 15:05:43 +00:00
2018-12-07 07:29:18 +00:00
支持客户端与服务端连接中断自动重连多路传输大大的提高请求处理速度go语言编写无第三方依赖经过测试内存占用小普通场景下内存占用极小。
水平有限,不足指出请大家指出。
2018-11-29 15:51:16 +00:00
## 背景
2018-12-03 16:15:14 +00:00
1. 我有一个小程序的需求但是小程序的数据源必须从内网才能抓取到但是内网服务器没有公网ip所以只能内网穿透了。----> [http反向代理请求](#http代理请求)
2. 想在外网通过ssh连接内网的机器做云服务器到内网服务器端口的映射或者做微信公众号开发---->[tcp隧道模式](#tcp隧道模式)
2018-11-29 15:51:16 +00:00
2018-12-03 16:15:14 +00:00
3. 在非内网环境下使用内网dns或者需要通过udp访问内网机器等---->[udp隧道模式](#udp隧道模式)
2018-11-29 15:51:16 +00:00
2018-12-03 16:15:14 +00:00
4. 在外网使用HTTP代理访问内网站点---->[http代理模式](#http代理模式)
5. 搭建一个内网穿透ss在外网如同使用内网vpn一样访问内网资源或者设备----> [socks5代理模式](#socks5代理模式)
2018-12-01 05:52:48 +00:00
2018-11-29 15:51:16 +00:00
## 特点
2018-12-03 16:15:14 +00:00
- [x] 支持gzip、snnapy压缩,减小传输过程流量消耗
- [x] 支持多站点配置,兼容多个内网网站,可处理相互之间的跳转包含关系
2018-11-29 15:51:16 +00:00
- [x] 断线自动重连
- [x] 支持多路传输,提高并发
- [x] 跨站自动匹配替换
- [x] 支持tcp隧道,提升访问效率
2018-12-03 16:15:14 +00:00
- [x] 支持udp隧道
2018-12-01 05:52:48 +00:00
- [x] 支持http代理
2018-12-03 16:15:14 +00:00
- [x] 支持内网穿透sock5代理配合proxifer可达到vpn的效果在外网访问内网资源或者设备同时可以设置用户名和密码验证
2018-11-29 15:51:16 +00:00
2018-11-29 15:05:43 +00:00
## 目录
2018-11-29 15:51:16 +00:00
1. [安装](#安装)
2018-12-01 05:52:48 +00:00
2. [http反向代理请求](#http代理请求)
2018-11-29 15:38:42 +00:00
3. [tcp隧道模式](#tcp隧道模式)
2018-12-03 16:15:14 +00:00
4. [udp隧道模式](#udp隧道模式)
5. [sock5代理模式](#sock5代理模式)
6. [http代理模式](#http代理模式)
7. [数据压缩支持](#数据压缩支持)
8. [操作系统支持](#操作系统支持)
2018-11-04 14:54:27 +00:00
2018-11-04 15:19:58 +00:00
## 安装
2018-11-29 15:36:22 +00:00
2018-11-04 15:19:58 +00:00
1. release安装
> https://github.com/cnlh/easyProxy/releases
下载对应的系统版本即可目前linux和windows只编译了64位的服务端和客户端共用一个程序go语言开发无需任何第三方依赖
2. 源码安装
- 安装源码
> go get github.com/cnlh/easyProxy
- 编译(无第三方模块)
> go build
2018-11-29 15:51:16 +00:00
## http代理请求
2018-11-29 15:36:22 +00:00
### 场景及原理
2018-12-03 16:15:14 +00:00
较为适用于http也就是web站点的穿透服务端与客户端之间建立连接服务端收到http请求后将请求发送到客户端客户端再执行这个请求并将结果返回给服务端服务端收到后再返回。
<html>
<span style="color:red">特点:支持同时代理多个站点,不同站点之间有联系还可以实现匹配替换</span>
</html>
2018-12-01 05:52:48 +00:00
![image](https://github.com/cnlh/easyProxy/blob/master/image/http.png?raw=true)
2018-11-29 15:36:22 +00:00
2018-12-03 16:15:14 +00:00
**最终效果**
- 访问a.server.com和访问10.1.50.203的80端口相同
- 访问b.server.com和访问10.1.50.202的80端口相同
- 访问c.server.com和访问10.1.50.201的80端口相同
2018-11-29 15:36:22 +00:00
### 使用
2018-11-04 15:19:58 +00:00
- 服务端
```
2018-11-29 15:36:22 +00:00
./easyProxy -mode httpServer -vkey DKibZF5TXvic1g3kY -tcpport=8284 -httpport=8024
2018-11-04 15:19:58 +00:00
```
名称 | 含义
---|---
mode | 运行模式(client、server不写默认client)
vkey | 验证密钥
tcpport | 服务端与客户端通信端口
httpport | 代理的http端口与nginx配合使用
- 客户端
```
建立配置文件 config.json
```
```
2018-11-04 17:40:56 +00:00
./easyProxy -config config.json
2018-11-04 15:19:58 +00:00
```
名称 | 含义
---|---
config | 配置文件路径
2018-11-29 15:36:22 +00:00
### 配置文件config.json
2018-11-04 15:19:58 +00:00
```
{
"Server": {
"ip": "123.206.77.88",
2018-11-04 15:39:42 +00:00
"tcp": 8284,
2018-11-04 15:19:58 +00:00
"vkey": "DKibZF5TXvic1g3kY",
"num": 10
},
"SiteList": [
{
2018-12-03 16:15:14 +00:00
"host": "a.ourcauc.com",
2018-11-04 15:19:58 +00:00
"url": "10.1.50.203",
"port": 80
},
{
2018-12-03 16:15:14 +00:00
"host": "b.ourcauc.com",
"url": "10.1.50.202",
"port": 80
},
{
"host": "c.ourcauc.com",
"url": "10.1.50.203",
"port": 80
2018-11-04 15:19:58 +00:00
}
2018-11-08 15:08:47 +00:00
],
"Replace": 0
2018-11-04 15:19:58 +00:00
}
```
名称 | 含义
---|---
ip | 服务端ip地址
tcp | 服务端与客户端通信端口
vkey | 验证密钥
num | 服务端与客户端通信连接数
SiteList | 本地解析的域名列表
host | 域名地址
url | 内网代理的地址
port | 内网代理的地址对应的端口
2018-11-29 15:36:22 +00:00
Replace | 是否自动匹配替换[(查看场景)](https://github.com/cnlh/easyProxy/issues/1)
2018-11-04 15:19:58 +00:00
2018-11-29 15:36:22 +00:00
### nginx代理配置示例
2018-11-04 15:19:58 +00:00
```
upstream nodejs {
server 127.0.0.1:8024;
keepalive 64;
}
server {
listen 80;
2018-12-03 16:15:14 +00:00
server_name a.ourcauc.com b.ourcauc.com c.ourcauc.com ;
2018-11-04 15:19:58 +00:00
location / {
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
2018-11-06 06:28:10 +00:00
proxy_set_header Host $http_host:8024;
2018-11-04 15:19:58 +00:00
proxy_set_header X-Nginx-Proxy true;
proxy_set_header Connection "";
proxy_pass http://nodejs;
}
}
```
## 域名配置示例
2018-12-03 16:15:14 +00:00
> -a A 123.206.77.88
> -b A 123.206.77.88
2018-11-08 15:08:47 +00:00
2018-12-03 16:15:14 +00:00
> -c A 123.206.77.88
2018-11-04 14:54:27 +00:00
2018-11-29 15:36:22 +00:00
### 跨站自动匹配替换说明
2018-11-08 12:02:58 +00:00
2018-12-03 16:15:14 +00:00
例如访问a.ourcauc.com该页面里面有一个超链接为10.1.50.202:80,将根据配置文件自动该将url替换为b.ourcauc.com以达到跨站也可访问的效果但需要提前在配置文件中配置这些站点。
2018-11-08 12:02:58 +00:00
2018-11-08 15:08:47 +00:00
如需开启请加配置文件Replace值设置为1
>注意:开启可能导致不应该被替换的内容被替换,请谨慎开启
2018-11-29 15:36:22 +00:00
### 二级域名示范
[二级域名](https://github.com/cnlh/easyProxy/wiki/%E4%BD%BF%E7%94%A8%E6%95%99%E7%A8%8B)
2018-12-03 16:15:14 +00:00
2018-11-29 15:36:22 +00:00
## tcp隧道模式
### 场景及原理
2018-12-03 16:15:14 +00:00
较为适用于处理tcp连接例如ssh同时也适用于http等访问服务端的8024端口相当于访问内网10.1.50.202机器的4000端口构成如下所示的隧道。
2018-11-29 15:36:22 +00:00
2018-12-01 05:52:48 +00:00
![image](https://github.com/cnlh/easyProxy/blob/master/image/tcp.png?raw=true)
2018-11-29 15:36:22 +00:00
2018-12-03 16:15:14 +00:00
例如:
**背景:**
- 内网机器10.1.50.203提供了web服务80端口
- 有VPS一个,公网IP:123.206.77.88
**需求:**
在家里能够通过访问VPS的8024端口访问到内网机器A的80端口
2018-11-29 15:36:22 +00:00
### 使用
- 服务端
```
./easyProxy -mode tunnelServer -vkey DKibZF5TXvic1g3kY -tcpport=8284 -httpport=8024 -target=10.1.50.203:80
```
名称 | 含义
---|---
mode | 运行模式(client、server不写默认client)
vkey | 验证密钥
tcpport | 服务端与客户端通信端口
httpport | 代理的http端口与nginx配合使用
target | 目标地址,格式如上
- 客户端
```
建立配置文件 config.json
```
```
./easyProxy -config config.json
```
名称 | 含义
---|---
config | 配置文件路径
### 配置文件config.json
```
{
"Server": {
"ip": "123.206.77.88",
"tcp": 8284,
"vkey": "DKibZF5TXvic1g3kY",
"num": 10
}
}
```
名称 | 含义
---|---
ip | 服务端ip地址
tcp | 服务端与客户端通信端口
vkey | 验证密钥
num | 服务端与客户端通信连接数
2018-12-03 16:15:14 +00:00
## udp隧道模式
2018-11-29 15:36:22 +00:00
### 场景及原理
2018-12-03 16:15:14 +00:00
**背景**
- 内网机器A提供了DNS解析服务,10.1.50.210:53端口
- 有VPS一个,公网IP:123.206.77.88
**需求:**
在家里能够通过设置本地dns为123.206.77.88,使用内网机器A进行域名解析服务.
访问vps的53端口相当于访问10.1.50.210的53端口构成如下所示的隧道。
![image](https://github.com/cnlh/easyProxy/blob/master/image/udp.png?raw=true)
2018-11-29 15:36:22 +00:00
### 使用
- 服务端
```
2018-12-03 16:15:14 +00:00
./easyProxy -mode udpServer -vkey DKibZF5TXvic1g3kY -tcpport=8284 -httpport=53 -target=10.1.50.210:53
2018-11-29 15:36:22 +00:00
```
名称 | 含义
---|---
mode | 运行模式(client、server不写默认client)
vkey | 验证密钥
tcpport | 服务端与客户端通信端口
2018-12-03 16:15:14 +00:00
httpport | 公网vpn的端口
target | 目标地址,格式如上
2018-11-29 15:36:22 +00:00
- 客户端
```
建立配置文件 config.json
```
```
./easyProxy -config config.json
```
2018-12-03 16:15:14 +00:00
名称 | 含义
---|---
config | 配置文件路径
- 本机
2018-11-29 15:36:22 +00:00
```
2018-12-03 16:15:14 +00:00
设置本机dns解析服务器地址为123.206.77.88
```
### 配置文件config.json
```
{
"Server": {
"ip": "123.206.77.88",
"tcp": 8284,
"vkey": "DKibZF5TXvic1g3kY",
"num": 10
}
}
```
名称 | 含义
---|---
ip | 服务端ip地址
tcp | 服务端与客户端通信端口
vkey | 验证密钥
num | 服务端与客户端通信连接数
## socks5代理模式
### 场景及原理
**原理**
主要用于socks5代理也就是和ss类似不过是代理内网。使用此模式时可在非内网环境下配置本机的socks5代理服务器ip、sock5代理端口即可实现socks5代理达到访问内网的网站的效果配合proxifer等全局代理软件即可如同使用内网vpn一样访问内网网站通过ssh连接内网机器等等……。
![image](https://github.com/cnlh/easyProxy/blob/master/image/sock5.png?raw=true)
### 使用
- 服务端
```
./easyProxy -mode sock5Server -vkey DKibZF5TXvic1g3kY -tcpport=8284 -httpport=8024
```
名称 | 含义
---|---
mode | 运行模式(client、server不写默认client)
vkey | 验证密钥
tcpport | 服务端与客户端通信端口
httpport | 代理的http端口与nginx配合使用
u | 验证的用户名
p | 验证的密码
**说明**用户名和密码验证模式仅部分socks5客户端支持例如proxifer。
如需验证,在服务端命令后加上
```
-u=user -p=password
2018-11-29 15:36:22 +00:00
```
2018-12-03 16:15:14 +00:00
即可
2018-11-29 15:36:22 +00:00
2018-12-03 16:15:14 +00:00
- 客户端
2018-11-29 15:36:22 +00:00
2018-12-03 16:15:14 +00:00
```
建立配置文件 config.json
```
```
./easyProxy -config config.json
```
2018-11-29 15:36:22 +00:00
名称 | 含义
---|---
config | 配置文件路径
2018-12-03 16:15:14 +00:00
- 需要使用内网代理的机器
```
配置sock5代理即可ip为外网服务器ip端口为httpport即可在外网环境使用内网啦也可使用proxifer等全局代理软件。
```
如果设置了用户名和密码,记得填上用户名和密码
2018-11-29 15:36:22 +00:00
### 配置文件config.json
```
{
"Server": {
"ip": "123.206.77.88",
"tcp": 8284,
"vkey": "DKibZF5TXvic1g3kY",
"num": 10
}
}
```
名称 | 含义
---|---
ip | 服务端ip地址
tcp | 服务端与客户端通信端口
vkey | 验证密钥
num | 服务端与客户端通信连接数
2018-12-01 05:52:48 +00:00
## http代理模式
### 场景及原理
主要用于HTTP代理区别也就是HTTP代理和sock5代理的区别。使用此模式时可在非内网环境下配置本机的HTTP代理服务器ip、HTTP代理端口即可实现HTTP代理达到访问内网的网站的效果。
![image](https://github.com/cnlh/easyProxy/blob/master/image/httpProxy.png?raw=true)
### 使用
- 服务端
```
./easyProxy -mode httpProxyServer -vkey DKibZF5TXvic1g3kY -tcpport=8284 -httpport=8024
```
名称 | 含义
---|---
mode | 运行模式(client、server不写默认client)
vkey | 验证密钥
tcpport | 服务端与客户端通信端口
httpport | 代理的http端口与nginx配合使用
- 客户端
```
建立配置文件 config.json
```
```
./easyProxy -config config.json
```
- 需要使用内网代理的机器
```
配置HTTP代理即可ip为外网服务器ip端口为httpport即可在外网环境访问内网啦
```
名称 | 含义
---|---
config | 配置文件路径
### 配置文件config.json
```
{
"Server": {
"ip": "123.206.77.88",
"tcp": 8284,
"vkey": "DKibZF5TXvic1g3kY",
"num": 10
}
}
```
名称 | 含义
---|---
ip | 服务端ip地址
tcp | 服务端与客户端通信端口
vkey | 验证密钥
num | 服务端与客户端通信连接数
2018-12-03 16:15:14 +00:00
## 数据压缩支持
### 场景及原理
由于是内网穿透内网客户端与服务端之间的隧道存在大量的数据交换为节省流量加快传输速度由此本程序支持GZIP、SNNAPY两种形式的压缩两者差异请自行选择。
### 注意点
- 所有模式均支持数据压缩
- 如使用数据压缩,客户端与服务端的压缩方式必须相同,否则将无法正常工作。
### 如何使用
**GZIP压缩**
- 在server端加上参数 -compress=gzip例如在TCP隧道模式
```
./easyProxy -mode tunnelServer -vkey DKibZF5TXvic1g3kY -tcpport=8284 -httpport=8024 -target=10.1.50.203:80 -compress=gzip
```
- 在client端同时加上参数 -compress=gzip例如
```
./easyProxy -config=config.json -compress=gzip
```
**SNNAPY压缩**
将参数修改为snnapy即可
2018-11-29 15:36:22 +00:00
## 操作系统支持
支持Windows、Linux、MacOSX等无第三方依赖库。