Add support for gRPC protocol

Reference URL: teddysun/xray-plugin#8 Signed-off-by: Teddysun <[email protected]>
teddysun · May 26, 2021 · dfaf0c8 · dfaf0c8
1 parent 05c14ae
commit dfaf0c8
Show file tree

Hide file tree

Showing 2 changed files with 53 additions and 19 deletions.
diff --git a/README.md b/README.md
@@ -2,7 +2,7 @@
 
 [![CircleCI](https://circleci.com/gh/shadowsocks/v2ray-plugin.svg?style=shield)](https://circleci.com/gh/shadowsocks/v2ray-plugin)
 [![Releases](https://img.shields.io/github/downloads/shadowsocks/v2ray-plugin/total.svg)](https://github.com/shadowsocks/v2ray-plugin/releases)
-[![Language: Go](https://img.shields.io/badge/go-1.13+-blue.svg)](https://github.com/shadowsocks/v2ray-plugin/search?l=go)
+[![Language: Go](https://img.shields.io/badge/go-1.16+-blue.svg)](https://github.com/shadowsocks/v2ray-plugin/search?l=go)
 [![Go Report Card](https://goreportcard.com/badge/github.com/shadowsocks/v2ray-plugin)](https://goreportcard.com/report/github.com/shadowsocks/v2ray-plugin)
 [![License](https://img.shields.io/github/license/shadowsocks/v2ray-plugin.svg)](LICENSE)
 
@@ -57,6 +57,34 @@ On your client
 ss-local -c config.json -p 443 --plugin v2ray-plugin --plugin-opts "mode=quic;host=mydomain.me"
 ```
 
+### Shadowsocks over gRPC (Remote Procedure Call)
+
+On your server
+
+```sh
+ss-server -c config.json -p 443 --plugin v2ray-plugin --plugin-opts "server;mode=grpc"
+```
+
+On your client
+
+```sh
+ss-local -c config.json -p 443 --plugin v2ray-plugin --plugin-opts "mode=grpc"
+```
+
+### Shadowsocks over gRPC with TLS
+
+On your server
+
+```sh
+ss-server -c config.json -p 443 --plugin v2ray-plugin --plugin-opts "server;mode=grpc;tls;host=mydomain.me"
+```
+
+On your client
+
+```sh
+ss-local -c config.json -p 443 --plugin v2ray-plugin --plugin-opts "tls;mode=grpc;host=mydomain.me"
+```
+
 ### Issue a cert for TLS and QUIC
 
 `v2ray-plugin` will look for TLS certificates signed by [acme.sh](https://github.com/acmesh-official/acme.sh) by default.

diff --git a/main.go b/main.go
@@ -29,6 +29,7 @@ import (
 	"github.com/v2fly/v2ray-core/v4/proxy/dokodemo"
 	"github.com/v2fly/v2ray-core/v4/proxy/freedom"
 	"github.com/v2fly/v2ray-core/v4/transport/internet"
+	"github.com/v2fly/v2ray-core/v4/transport/internet/grpc"
 	"github.com/v2fly/v2ray-core/v4/transport/internet/quic"
 	"github.com/v2fly/v2ray-core/v4/transport/internet/tls"
 	"github.com/v2fly/v2ray-core/v4/transport/internet/websocket"
@@ -39,24 +40,25 @@ var (
 )
 
 var (
-	vpn        = flag.Bool("V", false, "Run in VPN mode.")
-	fastOpen   = flag.Bool("fast-open", false, "Enable TCP fast open.")
-	localAddr  = flag.String("localAddr", "127.0.0.1", "local address to listen on.")
-	localPort  = flag.String("localPort", "1984", "local port to listen on.")
-	remoteAddr = flag.String("remoteAddr", "127.0.0.1", "remote address to forward.")
-	remotePort = flag.String("remotePort", "1080", "remote port to forward.")
-	path       = flag.String("path", "/", "URL path for websocket.")
-	host       = flag.String("host", "cloudfront.com", "Hostname for server.")
-	tlsEnabled = flag.Bool("tls", false, "Enable TLS.")
-	cert       = flag.String("cert", "", "Path to TLS certificate file. Overrides certRaw. Default: ~/.acme.sh/{host}/fullchain.cer")
-	certRaw    = flag.String("certRaw", "", "Raw TLS certificate content. Intended only for Android.")
-	key        = flag.String("key", "", "(server) Path to TLS key file. Default: ~/.acme.sh/{host}/{host}.key")
-	mode       = flag.String("mode", "websocket", "Transport mode: websocket, quic (enforced tls).")
-	mux        = flag.Int("mux", 1, "Concurrent multiplexed connections (websocket client mode only).")
-	server     = flag.Bool("server", false, "Run in server mode")
-	logLevel   = flag.String("loglevel", "", "loglevel for v2ray: debug, info, warning (default), error, none.")
-	version    = flag.Bool("version", false, "Show current version of v2ray-plugin")
-	fwmark     = flag.Int("fwmark", 0, "Set SO_MARK option for outbound sockets.")
+	vpn         = flag.Bool("V", false, "Run in VPN mode.")
+	fastOpen    = flag.Bool("fast-open", false, "Enable TCP fast open.")
+	localAddr   = flag.String("localAddr", "127.0.0.1", "local address to listen on.")
+	localPort   = flag.String("localPort", "1984", "local port to listen on.")
+	remoteAddr  = flag.String("remoteAddr", "127.0.0.1", "remote address to forward.")
+	remotePort  = flag.String("remotePort", "1080", "remote port to forward.")
+	path        = flag.String("path", "/", "URL path for websocket.")
+	serviceName = flag.String("serviceName", "GunService", "Service name for grpc.")
+	host        = flag.String("host", "cloudfront.com", "Hostname for server.")
+	tlsEnabled  = flag.Bool("tls", false, "Enable TLS.")
+	cert        = flag.String("cert", "", "Path to TLS certificate file. Overrides certRaw. Default: ~/.acme.sh/{host}/fullchain.cer")
+	certRaw     = flag.String("certRaw", "", "Raw TLS certificate content. Intended only for Android.")
+	key         = flag.String("key", "", "(server) Path to TLS key file. Default: ~/.acme.sh/{host}/{host}.key")
+	mode        = flag.String("mode", "websocket", "Transport mode: websocket, quic (enforced tls), grpc.")
+	mux         = flag.Int("mux", 1, "Concurrent multiplexed connections (websocket client mode only).")
+	server      = flag.Bool("server", false, "Run in server mode")
+	logLevel    = flag.String("loglevel", "", "loglevel for v2ray: debug, info, warning (default), error, none.")
+	version     = flag.Bool("version", false, "Show current version of v2ray-plugin")
+	fwmark      = flag.Int("fwmark", 0, "Set SO_MARK option for outbound sockets.")
 )
 
 func homeDir() string {
@@ -142,6 +144,10 @@ func generateConfig() (*core.Config, error) {
 			Security: &protocol.SecurityConfig{Type: protocol.SecurityType_NONE},
 		}
 		*tlsEnabled = true
+	case "grpc":
+		transportSettings = &grpc.Config{
+			ServiceName: *serviceName,
+		}
 	default:
 		return nil, newError("unsupported mode:", *mode)
 	}