Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

27 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

gwk

Gwk is a tool that helps you expose your local servers or services to the internet, even in a private network. It supports both TCP and subdomain modes.

Download

Download

build

bash package.sh

usage

serverHost default is gank.75cos.com

# example 1 , detault dispatch to 127.0.0.1:8080
gwk

client more example

# example 2
gwk  --port 8080
# example 3
gwk  --subdomain testabc001 --port 8000
# example 4
gwk  -c client.json

develop

  1. generate root CA
bash ./scripts/gen_rootca.sh
  1. generate domain cert
bash ./scripts/gen_certbyca.sh
  1. move certs to etc directory

client

go run ./bin/gwk/main.go  -c etc/client.json

client.json

{
  "serverHost": "gank007.com",
  "serverPort": 4443,
  "tunnels": {
    "tcp001": {
      "protocol": "tcp",
      "localPort": 5000,
      "remotePort": 7200
    },
    "tcp002": {
      "protocol": "tcp",
      "localPort": 5000,
      "remotePort": 7500
    },
    "webapp02": {
      "protocol": "web",
      "localPort": 4900,
      "subdomain": "app02"
    },
    "webappmob": {
      "protocol": "web",
      "localPort": 9000,
      "subdomain": "mob"
    }
  }
}

setup a gwk server

go run ./bin/gwkd/main.go  -c etc/server.json

server.json

{
  "serverHost": "gank007.com",
  "serverPort": 4443,
  "httpAddr": 8080,
  "httpsAddr": 8043,
  "tlsCA":"./scripts/certs/rootCA.crt",
  "tlsCrt":"./scripts/certs/gank007.com/my.crt",
  "tlsKey":"./scripts/certs/gank007.com/my.key.pem"
}

websocket transport (WSS 伪装 / 内网穿透替代 frp)

控制与隧道通道除裸 TCP 外,还支持 websocket,便于经 Nginx 在 443 端口以 WSS 伪装跨境/穿透链路, 无需在受限服务器上新开公网入站端口。相关选项:

选项 位置 说明
transport client/server tcp(默认)、ws(明文 websocket)、wss(TLS websocket,仅客户端)
path client/server websocket 升级路径,默认 /websocket
token client/server 鉴权令牌;为空回退内置默认值
skipVerify client wss 跳过 TLS 证书校验

典型部署(国外 VPS 经国内 Nginx 反连,等价替代 frpc/frps STCP 反连):

  • 国内服务端 etc/server-ws.jsontransport=ws,监听 127.0.0.1:7000,由 Nginx 把 location /~!gwk(带 Upgrade 头)反代到该端口;TCP 隧道远端口(如 24005)同样绑定在 127.0.0.1,由 Nginx location /websocket 反代给客户端使用。
  • 国外客户端 etc/client-wss.jsontransport=wss,连 wss://chat.75cos.com:443/~!gwk, 注册 tcp 隧道把本地服务(如 127.0.0.1:24005)暴露到国内的 127.0.0.1:24005
# 国内(服务端)
go run ./bin/gwkd/main.go -c etc/server-ws.json
# 国外(客户端)
go run ./bin/gwk/main.go  -c etc/client-wss.json

对应的 Nginx 片段:

location /~!gwk {           # gwk 控制/隧道通道(WSS 伪装)
    proxy_pass http://127.0.0.1:7000;
    proxy_http_version 1.1;
    proxy_set_header Upgrade $http_upgrade;
    proxy_set_header Connection "upgrade";
    proxy_set_header Host $host;
}
location /websocket {        # 客户端业务流量(如 V2Ray VLESS over WS)
    proxy_pass http://127.0.0.1:24005;
    proxy_http_version 1.1;
    proxy_set_header Upgrade $http_upgrade;
    proxy_set_header Connection "upgrade";
    proxy_set_header Host $host;
}

About

A fast reverse proxy to help you expose a local server behind a NAT or firewall to the internet.

Topics

Resources

Stars

29 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages