mirror of
https://github.com/fatedier/frp.git
synced 2024-12-12 17:50:51 +01:00
0db4fc07fb
* feat: support set local ip in client when connect server * fix: typo Co-authored-by: blizard863 <760076784@qq.com>
351 lines
8.7 KiB
Go
351 lines
8.7 KiB
Go
// Copyright 2017 fatedier, fatedier@gmail.com
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
package client
|
|
|
|
import (
|
|
"context"
|
|
"crypto/tls"
|
|
"errors"
|
|
"fmt"
|
|
"io"
|
|
"net"
|
|
"runtime"
|
|
"strconv"
|
|
"sync"
|
|
"sync/atomic"
|
|
"time"
|
|
|
|
"github.com/fatedier/frp/assets"
|
|
"github.com/fatedier/frp/pkg/auth"
|
|
"github.com/fatedier/frp/pkg/config"
|
|
"github.com/fatedier/frp/pkg/msg"
|
|
"github.com/fatedier/frp/pkg/transport"
|
|
"github.com/fatedier/frp/pkg/util/log"
|
|
frpNet "github.com/fatedier/frp/pkg/util/net"
|
|
"github.com/fatedier/frp/pkg/util/version"
|
|
"github.com/fatedier/frp/pkg/util/xlog"
|
|
libdial "github.com/fatedier/golib/net/dial"
|
|
|
|
fmux "github.com/hashicorp/yamux"
|
|
)
|
|
|
|
// Service is a client service.
|
|
type Service struct {
|
|
// uniq id got from frps, attach it in loginMsg
|
|
runID string
|
|
|
|
// manager control connection with server
|
|
ctl *Control
|
|
ctlMu sync.RWMutex
|
|
|
|
// Sets authentication based on selected method
|
|
authSetter auth.Setter
|
|
|
|
cfg config.ClientCommonConf
|
|
pxyCfgs map[string]config.ProxyConf
|
|
visitorCfgs map[string]config.VisitorConf
|
|
cfgMu sync.RWMutex
|
|
|
|
// The configuration file used to initialize this client, or an empty
|
|
// string if no configuration file was used.
|
|
cfgFile string
|
|
|
|
// This is configured by the login response from frps
|
|
serverUDPPort int
|
|
|
|
exit uint32 // 0 means not exit
|
|
|
|
// service context
|
|
ctx context.Context
|
|
// call cancel to stop service
|
|
cancel context.CancelFunc
|
|
}
|
|
|
|
func NewService(cfg config.ClientCommonConf, pxyCfgs map[string]config.ProxyConf, visitorCfgs map[string]config.VisitorConf, cfgFile string) (svr *Service, err error) {
|
|
|
|
ctx, cancel := context.WithCancel(context.Background())
|
|
svr = &Service{
|
|
authSetter: auth.NewAuthSetter(cfg.ClientConfig),
|
|
cfg: cfg,
|
|
cfgFile: cfgFile,
|
|
pxyCfgs: pxyCfgs,
|
|
visitorCfgs: visitorCfgs,
|
|
exit: 0,
|
|
ctx: xlog.NewContext(ctx, xlog.New()),
|
|
cancel: cancel,
|
|
}
|
|
return
|
|
}
|
|
|
|
func (svr *Service) GetController() *Control {
|
|
svr.ctlMu.RLock()
|
|
defer svr.ctlMu.RUnlock()
|
|
return svr.ctl
|
|
}
|
|
|
|
func (svr *Service) Run() error {
|
|
xl := xlog.FromContextSafe(svr.ctx)
|
|
|
|
// login to frps
|
|
for {
|
|
conn, session, err := svr.login()
|
|
if err != nil {
|
|
xl.Warn("login to server failed: %v", err)
|
|
|
|
// if login_fail_exit is true, just exit this program
|
|
// otherwise sleep a while and try again to connect to server
|
|
if svr.cfg.LoginFailExit {
|
|
return err
|
|
}
|
|
time.Sleep(10 * time.Second)
|
|
} else {
|
|
// login success
|
|
ctl := NewControl(svr.ctx, svr.runID, conn, session, svr.cfg, svr.pxyCfgs, svr.visitorCfgs, svr.serverUDPPort, svr.authSetter)
|
|
ctl.Run()
|
|
svr.ctlMu.Lock()
|
|
svr.ctl = ctl
|
|
svr.ctlMu.Unlock()
|
|
break
|
|
}
|
|
}
|
|
|
|
go svr.keepControllerWorking()
|
|
|
|
if svr.cfg.AdminPort != 0 {
|
|
// Init admin server assets
|
|
assets.Load(svr.cfg.AssetsDir)
|
|
|
|
address := net.JoinHostPort(svr.cfg.AdminAddr, strconv.Itoa(svr.cfg.AdminPort))
|
|
err := svr.RunAdminServer(address)
|
|
if err != nil {
|
|
log.Warn("run admin server error: %v", err)
|
|
}
|
|
log.Info("admin server listen on %s:%d", svr.cfg.AdminAddr, svr.cfg.AdminPort)
|
|
}
|
|
<-svr.ctx.Done()
|
|
return nil
|
|
}
|
|
|
|
func (svr *Service) keepControllerWorking() {
|
|
xl := xlog.FromContextSafe(svr.ctx)
|
|
maxDelayTime := 20 * time.Second
|
|
delayTime := time.Second
|
|
|
|
// if frpc reconnect frps, we need to limit retry times in 1min
|
|
// current retry logic is sleep 0s, 0s, 0s, 1s, 2s, 4s, 8s, ...
|
|
// when exceed 1min, we will reset delay and counts
|
|
cutoffTime := time.Now().Add(time.Minute)
|
|
reconnectDelay := time.Second
|
|
reconnectCounts := 1
|
|
|
|
for {
|
|
<-svr.ctl.ClosedDoneCh()
|
|
if atomic.LoadUint32(&svr.exit) != 0 {
|
|
return
|
|
}
|
|
|
|
// the first three retry with no delay
|
|
if reconnectCounts > 3 {
|
|
time.Sleep(reconnectDelay)
|
|
reconnectDelay *= 2
|
|
}
|
|
reconnectCounts++
|
|
|
|
now := time.Now()
|
|
if now.After(cutoffTime) {
|
|
// reset
|
|
cutoffTime = now.Add(time.Minute)
|
|
reconnectDelay = time.Second
|
|
reconnectCounts = 1
|
|
}
|
|
|
|
for {
|
|
xl.Info("try to reconnect to server...")
|
|
conn, session, err := svr.login()
|
|
if err != nil {
|
|
xl.Warn("reconnect to server error: %v", err)
|
|
time.Sleep(delayTime)
|
|
|
|
opErr := &net.OpError{}
|
|
// quick retry for dial error
|
|
if errors.As(err, &opErr) && opErr.Op == "dial" {
|
|
delayTime = 2 * time.Second
|
|
} else {
|
|
delayTime = delayTime * 2
|
|
if delayTime > maxDelayTime {
|
|
delayTime = maxDelayTime
|
|
}
|
|
}
|
|
continue
|
|
}
|
|
// reconnect success, init delayTime
|
|
delayTime = time.Second
|
|
|
|
ctl := NewControl(svr.ctx, svr.runID, conn, session, svr.cfg, svr.pxyCfgs, svr.visitorCfgs, svr.serverUDPPort, svr.authSetter)
|
|
ctl.Run()
|
|
svr.ctlMu.Lock()
|
|
if svr.ctl != nil {
|
|
svr.ctl.Close()
|
|
}
|
|
svr.ctl = ctl
|
|
svr.ctlMu.Unlock()
|
|
break
|
|
}
|
|
}
|
|
}
|
|
|
|
// login creates a connection to frps and registers it self as a client
|
|
// conn: control connection
|
|
// session: if it's not nil, using tcp mux
|
|
func (svr *Service) login() (conn net.Conn, session *fmux.Session, err error) {
|
|
xl := xlog.FromContextSafe(svr.ctx)
|
|
var tlsConfig *tls.Config
|
|
if svr.cfg.TLSEnable {
|
|
sn := svr.cfg.TLSServerName
|
|
if sn == "" {
|
|
sn = svr.cfg.ServerAddr
|
|
}
|
|
|
|
tlsConfig, err = transport.NewClientTLSConfig(
|
|
svr.cfg.TLSCertFile,
|
|
svr.cfg.TLSKeyFile,
|
|
svr.cfg.TLSTrustedCaFile,
|
|
sn)
|
|
if err != nil {
|
|
xl.Warn("fail to build tls configuration when service login, err: %v", err)
|
|
return
|
|
}
|
|
}
|
|
|
|
proxyType, addr, auth, err := libdial.ParseProxyURL(svr.cfg.HTTPProxy)
|
|
if err != nil {
|
|
xl.Error("fail to parse proxy url")
|
|
return
|
|
}
|
|
dialOptions := []libdial.DialOption{}
|
|
protocol := svr.cfg.Protocol
|
|
if protocol == "websocket" {
|
|
protocol = "tcp"
|
|
dialOptions = append(dialOptions, libdial.WithAfterHook(libdial.AfterHook{Hook: frpNet.DialHookWebsocket()}))
|
|
}
|
|
if svr.cfg.ConnectServerLocalIP != "" {
|
|
dialOptions = append(dialOptions, libdial.WithLocalAddr(svr.cfg.ConnectServerLocalIP))
|
|
}
|
|
dialOptions = append(dialOptions,
|
|
libdial.WithProtocol(protocol),
|
|
libdial.WithProxy(proxyType, addr),
|
|
libdial.WithProxyAuth(auth),
|
|
libdial.WithTLSConfig(tlsConfig),
|
|
libdial.WithAfterHook(libdial.AfterHook{
|
|
Hook: frpNet.DialHookCustomTLSHeadByte(tlsConfig != nil, svr.cfg.DisableCustomTLSFirstByte),
|
|
}),
|
|
)
|
|
conn, err = libdial.Dial(
|
|
net.JoinHostPort(svr.cfg.ServerAddr, strconv.Itoa(svr.cfg.ServerPort)),
|
|
dialOptions...,
|
|
)
|
|
if err != nil {
|
|
return
|
|
}
|
|
|
|
defer func() {
|
|
if err != nil {
|
|
conn.Close()
|
|
if session != nil {
|
|
session.Close()
|
|
}
|
|
}
|
|
}()
|
|
|
|
if svr.cfg.TCPMux {
|
|
fmuxCfg := fmux.DefaultConfig()
|
|
fmuxCfg.KeepAliveInterval = time.Duration(svr.cfg.TCPMuxKeepaliveInterval) * time.Second
|
|
fmuxCfg.LogOutput = io.Discard
|
|
session, err = fmux.Client(conn, fmuxCfg)
|
|
if err != nil {
|
|
return
|
|
}
|
|
stream, errRet := session.OpenStream()
|
|
if errRet != nil {
|
|
session.Close()
|
|
err = errRet
|
|
return
|
|
}
|
|
conn = stream
|
|
}
|
|
|
|
loginMsg := &msg.Login{
|
|
Arch: runtime.GOARCH,
|
|
Os: runtime.GOOS,
|
|
PoolCount: svr.cfg.PoolCount,
|
|
User: svr.cfg.User,
|
|
Version: version.Full(),
|
|
Timestamp: time.Now().Unix(),
|
|
RunID: svr.runID,
|
|
Metas: svr.cfg.Metas,
|
|
}
|
|
|
|
// Add auth
|
|
if err = svr.authSetter.SetLogin(loginMsg); err != nil {
|
|
return
|
|
}
|
|
|
|
if err = msg.WriteMsg(conn, loginMsg); err != nil {
|
|
return
|
|
}
|
|
|
|
var loginRespMsg msg.LoginResp
|
|
conn.SetReadDeadline(time.Now().Add(10 * time.Second))
|
|
if err = msg.ReadMsgInto(conn, &loginRespMsg); err != nil {
|
|
return
|
|
}
|
|
conn.SetReadDeadline(time.Time{})
|
|
|
|
if loginRespMsg.Error != "" {
|
|
err = fmt.Errorf("%s", loginRespMsg.Error)
|
|
xl.Error("%s", loginRespMsg.Error)
|
|
return
|
|
}
|
|
|
|
svr.runID = loginRespMsg.RunID
|
|
xl.ResetPrefixes()
|
|
xl.AppendPrefix(svr.runID)
|
|
|
|
svr.serverUDPPort = loginRespMsg.ServerUDPPort
|
|
xl.Info("login to server success, get run id [%s], server udp port [%d]", loginRespMsg.RunID, loginRespMsg.ServerUDPPort)
|
|
return
|
|
}
|
|
|
|
func (svr *Service) ReloadConf(pxyCfgs map[string]config.ProxyConf, visitorCfgs map[string]config.VisitorConf) error {
|
|
svr.cfgMu.Lock()
|
|
svr.pxyCfgs = pxyCfgs
|
|
svr.visitorCfgs = visitorCfgs
|
|
svr.cfgMu.Unlock()
|
|
|
|
return svr.ctl.ReloadConf(pxyCfgs, visitorCfgs)
|
|
}
|
|
|
|
func (svr *Service) Close() {
|
|
svr.GracefulClose(time.Duration(0))
|
|
}
|
|
|
|
func (svr *Service) GracefulClose(d time.Duration) {
|
|
atomic.StoreUint32(&svr.exit, 1)
|
|
if svr.ctl != nil {
|
|
svr.ctl.GracefulClose(d)
|
|
}
|
|
svr.cancel()
|
|
}
|