Skip to content

gRPC

gRPC是GOST中的一种数据通道类型。

TLS证书配置

TLS配置请参考TLS配置说明。

使用TLS

gRPC通道默认采用TLS加密。

gost -L http+grpc://:8443

services:
- name: service-0
  addr: ":8443"
  handler:
    type: http
  listener:
    type: grpc

不使用TLS

通过grpc.insecure选项开启明文gRPC传输。

gost -L http+grpc://:8443?grpc.insecure=true

services:
- name: service-0
  addr: ":8443"
  handler:
    type: http
  listener:
    type: grpc
    metadata:
      grpc.insecure: true

选项

自定义请求主机名

客户端默认使用节点地址(-F参数或nodes.addr中指定的地址)作为请求主机名(:authority头部信息)，可以通过host选项自定义请求主机名。

gost -L http://:8080 -F grpc://:8443?host=example.com

services:
- name: service-0
  addr: :8080
  handler:
    type: http
    chain: chain-0
  listener:
    type: tcp
chains:
- name: chain-0
  hops:
  - name: hop-0
    nodes:
    - name: node-0
      addr: :8443
      connector:
        type: http
      dialer:
        type: grpc
        metadata:
          host: example.com

自定义请求路径

可以通过path选项自定义请求路径，默认值为/GostTunel/Tunnel。

路径匹配验证

仅当客户端和服务端设定的path参数相同时，连接才能成功建立。

服务端

gost -L grpc://:8443?path=/GostTunel/Tunnel

services:
- name: service-0
  addr: :8443
  handler:
    type: auto
  listener:
    type: grpc
    metadata:
      path: /GostTunel/Tunnel

客户端

gost -L http://:8080 -F grpc://:8443?path=/GostTunel/Tunnel

services:
- name: service-0
  addr: :8080
  handler:
    type: http
    chain: chain-0
  listener:
    type: tcp
chains:
- name: chain-0
  hops:
  - name: hop-0
    nodes:
    - name: node-0
      addr: :8443
      connector:
        type: http
      dialer:
        type: grpc
        metadata:
          path: /GostTunel/Tunnel

心跳

客户端和服务端可以分别通过若干选项来控制心跳的发送。

客户端

gost -L http://:8080 -F "grpc://:8443?keepalive=true&keepalive.time=30s&keepalive.timeout=30s&keepalive.permitWithoutStream=true"

services:
- name: service-0
  addr: :8080
  handler:
    type: http
    chain: chain-0
  listener:
    type: tcp
chains:
- name: chain-0
  hops:
  - name: hop-0
    nodes:
    - name: node-0
      addr: :8443
      connector:
        type: http
      dialer:
        type: grpc
        metadata:
          keepalive: true
          keepalive.time: 30s
          keepalive.timeout: 30s
          keepalive.permitWithoutStream: true

服务端

gost -L "grpc://:8443?keepalive=true&keepalive.minTime=30s&keepalive.time=60s&keepalive.timeout=30s&keepalive.permitWithoutStream=true&keepalive.maxConnectionIdle=5m"

services:
- name: service-0
  addr: :8443
  handler:
    type: auto
  listener:
    type: grpc
    metadata:
      keepalive: true
      keepalive.time: 60s
      keepalive.timeout: 30s
      keepalive.permitWithoutStream: true
      keepalive.minTime: 30s
      keepalive.maxConnectionIdle: 5m
keepalive (bool, default=false)
是否开启心跳，只有当此选项开启后，其他相关参数才有效。
keepalive.time (duration, default=30s)
当空闲时长超过此设定值后，发送心跳包。
keepalive.timeout (duration, default=30s)
等待心跳响应时长。
keepalive.permitWithoutStream (bool, default=false)
是否允许在空闲状态下也发送心跳包。注意：当客户端开启此选项后，服务端也应同时开启，否则服务端会强行关闭当前连接。
keepalive.minTime (duration, default=30s)
客户端在发送心跳包之前最小等待时长。仅服务端有效。
keepalive.maxConnectionIdle (duration, default=5m)
当连接空闲超过此设定时长后，连接将被关闭。仅服务端有效。

谨慎使用

gRPC的心跳机制需要客户端和服务端相互配合，如果参数设置有误可能会导致连接异常，建议在使用心跳之前先阅读官方文档。

代理协议

gRPC数据通道可以与各种代理协议组合使用。

HTTP Over gRPC

gost -L http+grpc://:8443

services:
- name: service-0
  addr: :8443
  handler:
    type: http
  listener:
    type: grpc

SOCKS5 Over gRPC

gost -L socks5+grpc://:8443

services:
- name: service-0
  addr: :8443
  handler:
    type: socks5
  listener:
    type: grpc

Relay Over gRPC

gost -L relay+grpc://:8443

services:
- name: service-0
  addr: :8443
  handler:
    type: relay
  listener:
    type: grpc

端口转发

gRPC通道也可以用作端口转发。

服务端

gost -L grpc://:8443/:1080 -L socks5://:1080
等同于

gost -L forward+grpc://:8443/:1080 -L socks5://:1080

services:
- name: service-0
  addr: :8443
  handler:
    type: forward
  listener:
    type: grpc
  forwarder:
    nodes:
    - name: target-0
      addr: :1080
- name: service-1
  addr: :1080
  handler:
    type: socks5
  listener:
    type: tcp

通过使用gRPC数据通道的端口转发，给1080端口的SOCKS5代理服务增加了gRPC数据通道。

此时8443端口等同于：

gost -L socks5+grpc://:8443

Comments