wsp 全称WebSocket Proxy 是一种基于 WebSocket 的全方位代理, 仅需要web端口即可提供以下功能：
- 正向代理：支持 socks5 http代理，实现突破防火墙的访问
- 反向代理：支持将NAT或防火墙后面的本地服务暴露在Internet
- 网络穿透：将处在NAT设备之后的机器建立连接通讯隧道，进行数据的相互访问
wsp为C/S架构，其中 wsps 位于公网提供 WebSocket 服务，wspc 连接 wsps 进行数据转发，以下为简单的结构示意图
flowchart TD
wspc1 --> wsps
wspc2 --> wsps
wspc3 --> wsps
wsps --> wspc1
wsps --> wspc2
wsps --> wspc3
服务端安装，根据操作系统从Release下载相应的程序包，解压后将wsps放置在公网机器上，配置用于提供服务的web端口，最小化配置如下：
{
"port": 8010
}启动服务端， ./wsps -c wsps.json，其他配置可参考 configs/wsps_template.json
wspc功能设计参考了ssh，配置项存在三种转发模式：
- DynamicForward，动态转发，提供正向代理如：socks5，http代理
- RemoteForward，远程转发，将本地端口服务暴露在wsps上，支持 TCP HTTP HTTPS 协议
- LocalForward，本地转发，用于本地访问已注册的
远程转发服务
支持连接多个 wsps 服务端，配置格式类似如下：
{
"client": [
{
"server": "ws://wsp1.com:8010",
"local": []
},
{
"server": "ws://wsp1.com:8010",
"remote": []
}
]
}wspc的其他配置可参考 configs/wspc_template.json
此模式下需要在本机中安装wspc配合wsps使用正向代理，wspc动态转发代理请求，连接的打开和流量传输通过wsps，示意图如下
sequenceDiagram
actor client
participant wspc
participant wsps
actor server
par connect
wspc --> wsps : keep websocket connect
and proxy
client ->> wspc: socks5 or http proxy reqeust
wspc ->> wsps: request open connect
wsps ->> server: open connect
server ->> wsps: connect response
wsps ->> wspc: connect response
wspc ->> client: proxy response
and tranfer data
client -->> server: tranfer data, via wspc
server -->> client: tranfer data, via wsps
end
配置格式：protocols://[bind_address]:port
protocols支持 socks5 代理协议，HTTP 代理bind_address可选，空地址表示监听所有网卡IPport本地监听端口
示例如下：
{
"client": [
{
"server": "ws://mywsps.com:8010",
"dynamic": [
"http://:80",
"socks5://:1080"
]
}
]
}启动wspc， ./wsps -c wsps.json, 此时本地1080提供socks5代理，80提供http代理, 流量则通过wsps进行访问
将本地服务暴露在wsps上，供浏览器直接访问
示意图如下：
sequenceDiagram
actor browser
participant wsps
participant wspc
actor http as web server
par register
wspc --> wsps: websocket connect
and connect
browser ->> wsps : http request
wsps ->> wspc : select wspc to serve
wspc ->> http: open connect
http ->> wspc: connect response
wspc ->> wsps: connect response
and reqeust
wsps ->> wspc: http reqeust data
wspc ->> http: http reqeust data
http ->> wspc: http response data
wspc ->> wsps: http response data
wsps ->> browser: http response data
end
配置格式：protocols://bind_address:port/[path]?mode=[mode]&value=[value]
protocols支持 http, https（支持websocket）bind_addresshttp服务地址porthttp服务端口path可选http服务路径mode访问模式，为以下两种path路径模式domain域名模式
例：
{
"client": [
{
"server": "ws://mywsps.com:8010",
"remote": [
"http://127.0.0.1:8080?mode=path&value=api",
"http://127.0.0.1:8080/api/?mode=path&value=api",
"http://127.0.0.1:8080?mode=domain&value=customwsp.com",
"http://127.0.0.1:8080/api/?mode=domain&value=customapi.com"
]
}
]
}启动wspc， ./wsps -c wsps.json，此时在wsps注册的访问映射关系由上至下为
- 访问 http://mywsps.com:8010/api/greet -> http://127.0.0.1:8080/greet
- 访问 http://mywsps.com:8010/api/greet -> http://127.0.0.1:8080/api/greet
- 访问 http://customwsp.com:8010/api/greet -> http://127.0.0.1:8080/api/greet
- 访问 http://customwsp.com:8010/greet -> http://127.0.0.1:8080/api/greet
某些场景下希望将TCP流量通过websocket进行转发，配置格式：protocols://bind_address:port?mode=[mode]&value=[value]
protocols支持 tcpbind_address服务IP地址port服务端口mode访问模式，为以下两种path路径模式domain域名模式
例暴露vnc服务在websocket，我们配置如下：
{
"client": [
{
"server": "ws://mywsps.com:8010",
"remote": [
"tcp://127.0.0.1:5900?mode=path&value=vnc"
]
}
]
}这时我们可以打开novnc, 修改配置，修改为暴露的vnc服务参数，即可实现vnc的远程访问
此模式下需要两台wspc配合wsps使用，三者功能角色如下：
- wspc client 接入侧
- wsps 中转侧，负责将wspc clinet的代理请求和数据中转给目标的wspc server
- wspc server 服务侧，注册在wsps，负责打开来至wspc client的连接或转发数据
示意图如下
sequenceDiagram
actor client
participant wspc1
participant wsps
participant wspc2
actor target
par target register
wspc2 ->> wsps: websocket connect
and local register
wspc1 ->> wsps: websocket connect
end
par request connect
client ->>+ wspc1: request
wspc1 ->>+ wsps : request
wsps ->>+ wspc2 : request
wspc2 ->>+ target : request
target ->>- wspc2 : reponse
wspc2 ->>- wsps : reponse
wsps ->>- wspc1 : reponse
wspc1 ->>- client: reponse
and tranfer data
client -->> target: virtual connection, via wspc1 websocket
target -->> client: virtual connection, via wspc2 websocket
end
wspc server将本地服务注册至wsps等待wspc client连接，配置格式：protocols://channel[:password]@[bind_address]:port
protocols支持 tcpchannel信道标识，注册在wsps上等待其他wspc接入的标识信息password连接密码，接入的wspc连接密码需要一致才能通讯bind_address监听地址port服务端口
如注册本地网络中ssh服务配置如下
{
"client": [
{
"server": "ws://mywsps.com:8010",
"remote": [
"tcp://ssh:ssh@192.168.1.200:22"
]
}
]
}wspc client本地转发，开启本地端口来访问远程已注册的wspc server，配置格式：protocols://remote_channel[:password]@[bind_address]:port
protocols支持 tcpchannel信道标识，wsps上已注册的的channel才能访问password连接密码，与RemoteForward端密码一致才能通讯bind_address监听地址port本地端口
如访问已注册的wspc serverssh服务，本地wspc client进行如下配置
{
"client": [
{
"server": "ws://mywsps.com:8010",
"local": [
"tcp://ssh:ssh@127.0.0.1:2200"
]
}
]
}此时访问本地的127.0.0.1:2200即为访问wspc server端中192.168.1.200:22的ssh服务
此模式下需要两台wspc配合wsps使用，三者功能角色如下：
- wspc client 代理侧
- wsps 中转侧，负责将wspc clinet的代理请求和数据中转给目标的wspc server
- wspc server 服务侧，注册在wsps，负责打开来至wspc client的代理连接转发代理数据
wspc server端配置tunnel://channel[:password]@
channel信道标识，注册在wsps上等待其他wspc接入的标识信息password连接密码，接入的wspc连接密码需要一致才能通讯
例：
{
"client": [
{
"server": "ws://mywsps.com:8010",
"remote": [
"tunnel://work_tunnel:password@"
]
}
]
}wspc client端配置protocols://remote_channel[:password]@[bind_address]:port
protocols代理协议，支持 socks5 代理，HTTP 代理remote_channel信道标识，RemoteForward端注册的channelpassword密码，对应RemoteForward端密码bind_address可选，空地址表示监听所有网卡IPport本地监听端口
{
"client": [
{
"server": "ws://mywsps.com:8010",
"dynamic": [
"socks5://work_tunnel:password@127.0.0.1:1080"
]
}
]
}在wspc client端用socket5代理的连接和流量都会转发到wspc server端，如socket5代理下，访问192.168.1.200:22即访问wspc server端的192.168.1.200:22
wsp 支持日志分级记录，可在 wsps 或 wspc 中加入如下配置：
{
"log": {
"level": "info",
"output": "/var/log/wsp.log"
}
}其中 level 支持以下级别：
- error：只记录错误
- info：记录信息，包含错误
- debug：记录收发的信令，包含以上信息
- trace：记录全过程信息
wsp在开发时考虑了与现有web服务的协作，支持作为一个功能模块引入
go get -u github.com/gowsp/wsp
与官方http集成
import "github.com/gowsp/wsp/pkg/server"
config := &server.Config{Auth: "auth"}
server.NewWithHandler(config, http.NewServeMux())
server.NewWithHandler(config, http.DefaultServeMux)与gin集成
import "github.com/gowsp/wsp/pkg/server"
config := &server.Config{Auth: "auth"}
r := gin.Default()
server.NewWithHandler(config, r)- 支持命令行模式使用
目前此项目为个人独立开发，难免会有BUG和功能设计上的缺陷，如有问题请提issues反馈，也欢迎参与代码或文档的贡献，祝使用愉快