Merge pull request #3668 from fatedier/dev

bump version to v0.52.1
fatedier · Oct 11, 2023 · 31fa3f0 · 31fa3f0
2 parents 2d3af8a + 01a0d55
commit 31fa3f0
Show file tree

Hide file tree

Showing 26 changed files with 261 additions and 238 deletions.
diff --git a/README.md b/README.md
@@ -761,6 +761,8 @@ allowPorts = [
 
 `vhostHTTPPort` and `vhostHTTPSPort` in frps can use same port with `bindPort`. frps will detect the connection's protocol and handle it correspondingly.
 
+What you need to pay attention to is that if you want to configure `vhostHTTPSPort` and `bindPort` to the same port, you need to first set `transport.tls.disableCustomTLSFirstByte` to false.
+
 We would like to try to allow multiple proxies bind a same remote port with different protocols in the future.
 
 ### Bandwidth Limit

diff --git a/Release.md b/Release.md
@@ -1,9 +1,6 @@
-### Features
+### Fixes
 
-* Configuration: We now support TOML, YAML, and JSON for configuration. Please note that INI is deprecated and will be removed in future releases. New features will only be available in TOML, YAML, or JSON. Users wanting these new features should switch their configuration format accordingly. #2521
-
-### Breaking Changes
-
-* Change the way to start the visitor through the command line from `frpc stcp --role=visitor xxx` to `frpc stcp visitor xxx`.
-* Modified the semantics of the `server_addr` in the command line, no longer including the port. Added the `server_port` parameter to configure the port.
-* No longer support range ports mapping in TOML/YAML/JSON.
+* `transport.tls.disableCustomTLSFirstByte` doesn't have any effect.
+* The Server API did not return the data correctly.
+* The Dashboard is unable to display data.
+* `natHoleStunServer` is missing a default value.
diff --git a/assets/frps/static/index-ea3edf22.js → assets/frps/static/index-9465253b.js b/assets/frps/static/index-ea3edf22.js → assets/frps/static/index-9465253b.js
diff --git a/assets/frps/static/index.html b/assets/frps/static/index.html
@@ -4,7 +4,7 @@
 <head>
     <meta charset="utf-8">
     <title>frps dashboard</title>
-  <script type="module" crossorigin src="./index-ea3edf22.js"></script>
+  <script type="module" crossorigin src="./index-9465253b.js"></script>
   <link rel="stylesheet" href="./index-1e0c7400.css">
 </head>
 

diff --git a/client/service.go b/client/service.go
@@ -476,6 +476,9 @@ func (cm *ConnectionManager) realConnect() (net.Conn, error) {
 		// Make sure that if it is wss, the websocket hook is executed after the tls hook.
 		dialOptions = append(dialOptions, libdial.WithAfterHook(libdial.AfterHook{Hook: utilnet.DialHookWebsocket(protocol, tlsConfig.ServerName), Priority: 110}))
 	default:
+		dialOptions = append(dialOptions, libdial.WithAfterHook(libdial.AfterHook{
+			Hook: utilnet.DialHookCustomTLSHeadByte(tlsConfig != nil, lo.FromPtr(cm.cfg.Transport.TLS.DisableCustomTLSFirstByte)),
+		}))
 		dialOptions = append(dialOptions, libdial.WithTLSConfig(tlsConfig))
 	}
 

diff --git a/conf/frps.toml b/conf/frps.toml
@@ -83,7 +83,7 @@ enablePrometheus = true
 # console or real logFile path like ./frps.log
 log.to = "./frps.log"
 # trace, debug, info, warn, error
-log.level = info
+log.level = "info"
 log.maxDays = 3
 # disable log colors when log.to is console, default is false
 log.disablePrintColor = false

diff --git a/pkg/config/legacy/conversion.go b/pkg/config/legacy/conversion.go
@@ -306,6 +306,7 @@ func Convert_ProxyConf_To_v1(conf ProxyConf) v1.ProxyConfigurer {
 		c := &v1.XTCPProxyConfig{ProxyBaseConfig: *outBase}
 		c.Secretkey = v.Sk
 		c.AllowUsers = v.AllowUsers
+		out = c
 	}
 	return out
 }

diff --git a/pkg/config/legacy/server.go b/pkg/config/legacy/server.go
@@ -27,7 +27,7 @@ type HTTPPluginOptions struct {
 	Addr      string   `ini:"addr"`
 	Path      string   `ini:"path"`
 	Ops       []string `ini:"ops"`
-	TLSVerify bool     `ini:"tls_verify"`
+	TLSVerify bool     `ini:"tlsVerify"`
 }
 
 // ServerCommonConf contains information for a server service. It is

diff --git a/pkg/config/v1/client.go b/pkg/config/v1/client.go
@@ -76,6 +76,7 @@ func (c *ClientCommonConfig) Complete() {
 	c.ServerAddr = util.EmptyOr(c.ServerAddr, "0.0.0.0")
 	c.ServerPort = util.EmptyOr(c.ServerPort, 7000)
 	c.LoginFailExit = util.EmptyOr(c.LoginFailExit, lo.ToPtr(true))
+	c.NatHoleSTUNServer = util.EmptyOr(c.NatHoleSTUNServer, "stun.easyvoip.com:3478")
 
 	c.Auth.Complete()
 	c.Log.Complete()

diff --git a/pkg/config/v1/client_test.go b/pkg/config/v1/client_test.go
@@ -31,4 +31,5 @@ func TestClientConfigComplete(t *testing.T) {
 	require.Equal(true, lo.FromPtr(c.LoginFailExit))
 	require.Equal(true, lo.FromPtr(c.Transport.TLS.Enable))
 	require.Equal(true, lo.FromPtr(c.Transport.TLS.DisableCustomTLSFirstByte))
+	require.NotEmpty(c.NatHoleSTUNServer)
 }
diff --git a/pkg/config/v1/common.go b/pkg/config/v1/common.go
@@ -109,7 +109,7 @@ type HTTPPluginOptions struct {
 	Addr      string   `json:"addr"`
 	Path      string   `json:"path"`
 	Ops       []string `json:"ops"`
-	TLSVerify bool     `json:"tls_verify,omitempty"`
+	TLSVerify bool     `json:"tlsVerify,omitempty"`
 }
 
 type HeaderOperations struct {

diff --git a/pkg/config/v1/plugin.go b/pkg/config/v1/plugin.go
@@ -16,7 +16,6 @@ package v1
 
 import (
 	"encoding/json"
-	"errors"
 	"fmt"
 	"reflect"
 )
@@ -30,7 +29,7 @@ type TypedClientPluginOptions struct {
 
 func (c *TypedClientPluginOptions) UnmarshalJSON(b []byte) error {
 	if len(b) == 4 && string(b) == "null" {
-		return errors.New("type is required")
+		return nil
 	}
 
 	typeStruct := struct {
@@ -41,6 +40,9 @@ func (c *TypedClientPluginOptions) UnmarshalJSON(b []byte) error {
 	}
 
 	c.Type = typeStruct.Type
+	if c.Type == "" {
+		return nil
+	}
 
 	v, ok := clientPluginOptionsTypeMap[typeStruct.Type]
 	if !ok {

diff --git a/pkg/util/version/version.go b/pkg/util/version/version.go
@@ -19,7 +19,7 @@ import (
 	"strings"
 )
 
-var version = "0.52.0"
+var version = "0.52.1"
 
 func Full() string {
 	return version

diff --git a/server/dashboard_api.go b/server/dashboard_api.go
@@ -34,24 +34,24 @@ type GeneralResponse struct {
 
 type serverInfoResp struct {
 	Version               string `json:"version"`
-	BindPort              int    `json:"bind_port"`
-	VhostHTTPPort         int    `json:"vhost_http_port"`
-	VhostHTTPSPort        int    `json:"vhost_https_port"`
-	TCPMuxHTTPConnectPort int    `json:"tcpmux_httpconnect_port"`
-	KCPBindPort           int    `json:"kcp_bind_port"`
-	QUICBindPort          int    `json:"quic_bind_port"`
-	SubdomainHost         string `json:"subdomain_host"`
-	MaxPoolCount          int64  `json:"max_pool_count"`
-	MaxPortsPerClient     int64  `json:"max_ports_per_client"`
-	HeartBeatTimeout      int64  `json:"heart_beat_timeout"`
-	AllowPortsStr         string `json:"allow_ports_str,omitempty"`
-	TLSOnly               bool   `json:"tls_only,omitempty"`
-
-	TotalTrafficIn  int64            `json:"total_traffic_in"`
-	TotalTrafficOut int64            `json:"total_traffic_out"`
-	CurConns        int64            `json:"cur_conns"`
-	ClientCounts    int64            `json:"client_counts"`
-	ProxyTypeCounts map[string]int64 `json:"proxy_type_count"`
+	BindPort              int    `json:"bindPort"`
+	VhostHTTPPort         int    `json:"vhostHTTPPort"`
+	VhostHTTPSPort        int    `json:"vhostHTTPSPort"`
+	TCPMuxHTTPConnectPort int    `json:"tcpmuxHTTPConnectPort"`
+	KCPBindPort           int    `json:"kcpBindPort"`
+	QUICBindPort          int    `json:"quicBindPort"`
+	SubdomainHost         string `json:"subdomainHost"`
+	MaxPoolCount          int64  `json:"maxPoolCount"`
+	MaxPortsPerClient     int64  `json:"maxPortsPerClient"`
+	HeartBeatTimeout      int64  `json:"heartbeatTimeout"`
+	AllowPortsStr         string `json:"allowPortsStr,omitempty"`
+	TLSForce              bool   `json:"tlsForce,omitempty"`
+
+	TotalTrafficIn  int64            `json:"totalTrafficIn"`
+	TotalTrafficOut int64            `json:"totalTrafficOut"`
+	CurConns        int64            `json:"curConns"`
+	ClientCounts    int64            `json:"clientCounts"`
+	ProxyTypeCounts map[string]int64 `json:"proxyTypeCount"`
 }
 
 // /healthz
@@ -85,7 +85,7 @@ func (svr *Service) APIServerInfo(w http.ResponseWriter, r *http.Request) {
 		MaxPortsPerClient:     svr.cfg.MaxPortsPerClient,
 		HeartBeatTimeout:      svr.cfg.Transport.HeartbeatTimeout,
 		AllowPortsStr:         types.PortsRangeSlice(svr.cfg.AllowPorts).String(),
-		TLSOnly:               svr.cfg.Transport.TLS.Force,
+		TLSForce:              svr.cfg.Transport.TLS.Force,
 
 		TotalTrafficIn:  serverStats.TotalTrafficIn,
 		TotalTrafficOut: serverStats.TotalTrafficOut,
@@ -104,7 +104,7 @@ type BaseOutConf struct {
 
 type TCPOutConf struct {
 	BaseOutConf
-	RemotePort int `json:"remote_port"`
+	RemotePort int `json:"remotePort"`
 }
 
 type TCPMuxOutConf struct {
@@ -115,14 +115,14 @@ type TCPMuxOutConf struct {
 
 type UDPOutConf struct {
 	BaseOutConf
-	RemotePort int `json:"remote_port"`
+	RemotePort int `json:"remotePort"`
 }
 
 type HTTPOutConf struct {
 	BaseOutConf
 	v1.DomainConfig
 	Locations         []string `json:"locations"`
-	HostHeaderRewrite string   `json:"host_header_rewrite"`
+	HostHeaderRewrite string   `json:"hostHeaderRewrite"`
 }
 
 type HTTPSOutConf struct {
@@ -163,12 +163,12 @@ func getConfByType(proxyType string) any {
 type ProxyStatsInfo struct {
 	Name            string      `json:"name"`
 	Conf            interface{} `json:"conf"`
-	ClientVersion   string      `json:"client_version,omitempty"`
-	TodayTrafficIn  int64       `json:"today_traffic_in"`
-	TodayTrafficOut int64       `json:"today_traffic_out"`
-	CurConns        int64       `json:"cur_conns"`
-	LastStartTime   string      `json:"last_start_time"`
-	LastCloseTime   string      `json:"last_close_time"`
+	ClientVersion   string      `json:"clientVersion,omitempty"`
+	TodayTrafficIn  int64       `json:"todayTrafficIn"`
+	TodayTrafficOut int64       `json:"todayTrafficOut"`
+	CurConns        int64       `json:"curConns"`
+	LastStartTime   string      `json:"lastStartTime"`
+	LastCloseTime   string      `json:"lastCloseTime"`
 	Status          string      `json:"status"`
 }
 
@@ -236,11 +236,11 @@ func (svr *Service) getProxyStatsByType(proxyType string) (proxyInfos []*ProxySt
 type GetProxyStatsResp struct {
 	Name            string      `json:"name"`
 	Conf            interface{} `json:"conf"`
-	TodayTrafficIn  int64       `json:"today_traffic_in"`
-	TodayTrafficOut int64       `json:"today_traffic_out"`
-	CurConns        int64       `json:"cur_conns"`
-	LastStartTime   string      `json:"last_start_time"`
-	LastCloseTime   string      `json:"last_close_time"`
+	TodayTrafficIn  int64       `json:"todayTrafficIn"`
+	TodayTrafficOut int64       `json:"todayTrafficOut"`
+	CurConns        int64       `json:"curConns"`
+	LastStartTime   string      `json:"lastStartTime"`
+	LastCloseTime   string      `json:"lastCloseTime"`
 	Status          string      `json:"status"`
 }
 
@@ -310,8 +310,8 @@ func (svr *Service) getProxyStatsByTypeAndName(proxyType string, proxyName strin
 // /api/traffic/:name
 type GetProxyTrafficResp struct {
 	Name       string  `json:"name"`
-	TrafficIn  []int64 `json:"traffic_in"`
-	TrafficOut []int64 `json:"traffic_out"`
+	TrafficIn  []int64 `json:"trafficIn"`
+	TrafficOut []int64 `json:"trafficOut"`
 }
 
 func (svr *Service) APIProxyTraffic(w http.ResponseWriter, r *http.Request) {

diff --git a/test/e2e/framework/consts/consts.go b/test/e2e/framework/consts/consts.go
@@ -25,6 +25,7 @@ log.level = "trace"
 	DefaultClientConfig = `
 serverAddr = "127.0.0.1"
 serverPort = {{ .%s }}
+loginFailExit = false
 log.level = "trace"
 `
 
@@ -38,6 +39,7 @@ log.level = "trace"
 	[common]
 	server_addr = 127.0.0.1
 	server_port = {{ .%s }}
+	login_fail_exit = false
 	log_level = trace
 	`
 )

diff --git a/test/e2e/framework/process.go b/test/e2e/framework/process.go
@@ -40,6 +40,7 @@ func (f *Framework) RunProcesses(serverTemplates []string, clientTemplates []str
 		currentServerProcesses = append(currentServerProcesses, p)
 		err = p.Start()
 		ExpectNoError(err)
+		time.Sleep(500 * time.Millisecond)
 	}
 	time.Sleep(1 * time.Second)
 

diff --git a/test/e2e/v1/basic/client_server.go b/test/e2e/v1/basic/client_server.go
@@ -291,7 +291,7 @@ var _ = ginkgo.Describe("[Feature: Client-Server]", func() {
 		})
 	})
 
-	ginkgo.Describe("TLS with disable_custom_tls_first_byte set to false", func() {
+	ginkgo.Describe("TLS with disableCustomTLSFirstByte set to false", func() {
 		supportProtocols := []string{"tcp", "kcp", "quic", "websocket"}
 		for _, protocol := range supportProtocols {
 			tmp := protocol
@@ -322,4 +322,22 @@ var _ = ginkgo.Describe("[Feature: Client-Server]", func() {
 			})
 		}
 	})
+
+	ginkgo.Describe("Use same port for bindPort and vhostHTTPSPort", func() {
+		supportProtocols := []string{"tcp", "kcp", "quic", "websocket"}
+		for _, protocol := range supportProtocols {
+			tmp := protocol
+			defineClientServerTest("Use same port for bindPort and vhostHTTPSPort: "+strings.ToUpper(tmp), f, &generalTestConfigures{
+				server: fmt.Sprintf(`
+					vhostHTTPSPort = {{ .%s }}
+					%s
+					`, consts.PortServerName, renderBindPortConfig(protocol)),
+				// transport.tls.disableCustomTLSFirstByte should set to false when vhostHTTPSPort is same as bindPort
+				client: fmt.Sprintf(`
+					transport.protocol = "%s"
+					transport.tls.disableCustomTLSFirstByte = false
+					`, protocol),
+			})
+		}
+	})
 })
diff --git a/web/frps/auto-imports.d.ts b/web/frps/auto-imports.d.ts
@@ -1,3 +1,5 @@
 // Generated by 'unplugin-auto-import'
 export {}
-declare global {}
+declare global {
+
+}
diff --git a/web/frps/src/components/ProxiesHTTP.vue b/web/frps/src/components/ProxiesHTTP.vue
@@ -10,16 +10,16 @@ import ProxyView from './ProxyView.vue'
 let proxies = ref<HTTPProxy[]>([])
 
 const fetchData = () => {
-  let vhost_http_port: number
-  let subdomain_host: string
+  let vhostHTTPPort: number
+  let subdomainHost: string
   fetch('../api/serverinfo', { credentials: 'include' })
     .then((res) => {
       return res.json()
     })
     .then((json) => {
-      vhost_http_port = json.vhost_http_port
-      subdomain_host = json.subdomain_host
-      if (vhost_http_port == null || vhost_http_port == 0) {
+      vhostHTTPPort = json.vhostHTTPPort
+      subdomainHost = json.subdomainHost
+      if (vhostHTTPPort == null || vhostHTTPPort == 0) {
         return
       }
       fetch('../api/proxy/http', { credentials: 'include' })
@@ -29,7 +29,7 @@ const fetchData = () => {
         .then((json) => {
           for (let proxyStats of json.proxies) {
             proxies.value.push(
-              new HTTPProxy(proxyStats, vhost_http_port, subdomain_host)
+              new HTTPProxy(proxyStats, vhostHTTPPort, subdomainHost)
             )
           }
         })

diff --git a/web/frps/src/components/ProxiesHTTPS.vue b/web/frps/src/components/ProxiesHTTPS.vue
@@ -10,16 +10,16 @@ import ProxyView from './ProxyView.vue'
 let proxies = ref<HTTPSProxy[]>([])
 
 const fetchData = () => {
-  let vhost_https_port: number
-  let subdomain_host: string
+  let vhostHTTPSPort: number
+  let subdomainHost: string
   fetch('../api/serverinfo', { credentials: 'include' })
     .then((res) => {
       return res.json()
     })
     .then((json) => {
-      vhost_https_port = json.vhost_https_port
-      subdomain_host = json.subdomain_host
-      if (vhost_https_port == null || vhost_https_port == 0) {
+      vhostHTTPSPort = json.vhostHTTPSPort
+      subdomainHost = json.subdomainHost
+      if (vhostHTTPSPort == null || vhostHTTPSPort == 0) {
         return
       }
       fetch('../api/proxy/https', { credentials: 'include' })
@@ -29,7 +29,7 @@ const fetchData = () => {
         .then((json) => {
           for (let proxyStats of json.proxies) {
             proxies.value.push(
-              new HTTPSProxy(proxyStats, vhost_https_port, subdomain_host)
+              new HTTPSProxy(proxyStats, vhostHTTPSPort, subdomainHost)
             )
           }
         })