frp/cmd/frpc/sub/root.go

232 lines
5.9 KiB
Go
Raw Normal View History

2018-04-10 17:46:49 +08:00
// Copyright 2018 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 sub
import (
"fmt"
2022-03-28 12:12:35 +08:00
"io/fs"
"net"
2018-04-10 17:46:49 +08:00
"os"
"os/signal"
2022-03-28 12:12:35 +08:00
"path/filepath"
2018-04-10 17:46:49 +08:00
"strconv"
2022-03-28 12:12:35 +08:00
"sync"
2018-04-10 17:46:49 +08:00
"syscall"
"time"
"github.com/fatedier/frp/client"
2020-09-23 13:49:14 +08:00
"github.com/fatedier/frp/pkg/auth"
"github.com/fatedier/frp/pkg/config"
"github.com/fatedier/frp/pkg/util/log"
"github.com/fatedier/frp/pkg/util/version"
"github.com/spf13/cobra"
2018-04-10 17:46:49 +08:00
)
const (
CfgFileTypeIni = iota
CfgFileTypeCmd
)
var (
cfgFile string
2022-03-28 12:12:35 +08:00
cfgDir string
2018-04-10 17:46:49 +08:00
showVersion bool
serverAddr string
user string
protocol string
token string
logLevel string
logFile string
logMaxDays int
disableLogColor bool
2018-04-10 17:46:49 +08:00
proxyName string
2020-05-24 17:48:37 +08:00
localIP string
2018-04-10 17:46:49 +08:00
localPort int
remotePort int
useEncryption bool
useCompression bool
customDomains string
subDomain string
httpUser string
httpPwd string
locations string
hostHeaderRewrite string
role string
sk string
multiplexer string
2018-04-10 17:46:49 +08:00
serverName string
bindAddr string
bindPort int
2018-12-11 15:06:54 +08:00
tlsEnable bool
2018-04-10 17:46:49 +08:00
)
func init() {
2019-04-08 15:39:14 +08:00
rootCmd.PersistentFlags().StringVarP(&cfgFile, "config", "c", "./frpc.ini", "config file of frpc")
2022-03-28 12:12:35 +08:00
rootCmd.PersistentFlags().StringVarP(&cfgDir, "config_dir", "", "", "config directory, run one frpc service for each file in config directory")
2018-04-10 17:46:49 +08:00
rootCmd.PersistentFlags().BoolVarP(&showVersion, "version", "v", false, "version of frpc")
}
2020-05-19 10:49:29 +08:00
func RegisterCommonFlags(cmd *cobra.Command) {
cmd.PersistentFlags().StringVarP(&serverAddr, "server_addr", "s", "127.0.0.1:7000", "frp server's address")
cmd.PersistentFlags().StringVarP(&user, "user", "u", "", "user")
cmd.PersistentFlags().StringVarP(&protocol, "protocol", "p", "tcp", "tcp or kcp or websocket")
cmd.PersistentFlags().StringVarP(&token, "token", "t", "", "auth token")
cmd.PersistentFlags().StringVarP(&logLevel, "log_level", "", "info", "log level")
cmd.PersistentFlags().StringVarP(&logFile, "log_file", "", "console", "console or file path")
cmd.PersistentFlags().IntVarP(&logMaxDays, "log_max_days", "", 3, "log file reversed days")
cmd.PersistentFlags().BoolVarP(&disableLogColor, "disable_log_color", "", false, "disable log color in console")
cmd.PersistentFlags().BoolVarP(&tlsEnable, "tls_enable", "", false, "enable frpc tls")
}
2018-04-10 17:46:49 +08:00
var rootCmd = &cobra.Command{
Use: "frpc",
Short: "frpc is the client of frp (https://github.com/fatedier/frp)",
RunE: func(cmd *cobra.Command, args []string) error {
if showVersion {
fmt.Println(version.Full())
return nil
}
2022-03-28 12:12:35 +08:00
// If cfgDir is not empty, run multiple frpc service for each config file in cfgDir.
// Note that it's only designed for testing. It's not guaranteed to be stable.
if cfgDir != "" {
var wg sync.WaitGroup
filepath.WalkDir(cfgDir, func(path string, d fs.DirEntry, err error) error {
if err != nil {
return nil
}
if d.IsDir() {
return nil
}
wg.Add(1)
2022-04-14 11:24:36 +08:00
time.Sleep(time.Millisecond)
2022-03-28 12:12:35 +08:00
go func() {
defer wg.Done()
err := runClient(path)
if err != nil {
fmt.Printf("frpc service error for config file [%s]\n", path)
}
}()
return nil
})
wg.Wait()
return nil
}
2018-04-10 17:46:49 +08:00
// Do not show command usage here.
err := runClient(cfgFile)
if err != nil {
fmt.Println(err)
os.Exit(1)
}
return nil
},
}
func Execute() {
if err := rootCmd.Execute(); err != nil {
os.Exit(1)
}
}
2022-03-28 12:12:35 +08:00
func handleSignal(svr *client.Service, doneCh chan struct{}) {
ch := make(chan os.Signal, 1)
2018-04-10 17:46:49 +08:00
signal.Notify(ch, syscall.SIGINT, syscall.SIGTERM)
<-ch
2021-10-19 15:02:45 +08:00
svr.GracefulClose(500 * time.Millisecond)
2022-03-28 12:12:35 +08:00
close(doneCh)
2018-04-10 17:46:49 +08:00
}
func parseClientCommonCfgFromCmd() (cfg config.ClientCommonConf, err error) {
cfg = config.GetDefaultClientConf()
ipStr, portStr, err := net.SplitHostPort(serverAddr)
if err != nil {
err = fmt.Errorf("invalid server_addr: %v", err)
2018-04-10 17:46:49 +08:00
return
}
cfg.ServerAddr = ipStr
cfg.ServerPort, err = strconv.Atoi(portStr)
2018-04-10 17:46:49 +08:00
if err != nil {
err = fmt.Errorf("invalid server_addr: %v", err)
2018-04-10 17:46:49 +08:00
return
}
cfg.User = user
cfg.Protocol = protocol
cfg.LogLevel = logLevel
cfg.LogFile = logFile
cfg.LogMaxDays = int64(logMaxDays)
cfg.DisableLogColor = disableLogColor
// Only token authentication is supported in cmd mode
2020-05-24 17:48:37 +08:00
cfg.ClientConfig = auth.GetDefaultClientConf()
cfg.Token = token
cfg.TLSEnable = tlsEnable
cfg.Complete()
if err = cfg.Validate(); err != nil {
err = fmt.Errorf("Parse config error: %v", err)
return
}
return
2018-04-10 17:46:49 +08:00
}
func runClient(cfgFilePath string) error {
cfg, pxyCfgs, visitorCfgs, err := config.ParseClientConfig(cfgFilePath)
if err != nil {
return err
}
return startService(cfg, pxyCfgs, visitorCfgs, cfgFilePath)
}
2020-06-02 22:48:55 +08:00
func startService(
cfg config.ClientCommonConf,
pxyCfgs map[string]config.ProxyConf,
visitorCfgs map[string]config.VisitorConf,
cfgFile string,
) (err error) {
log.InitLog(cfg.LogWay, cfg.LogFile, cfg.LogLevel,
cfg.LogMaxDays, cfg.DisableLogColor)
2022-03-28 12:12:35 +08:00
if cfgFile != "" {
log.Trace("start frpc service for config file [%s]", cfgFile)
defer log.Trace("frpc service for config file [%s] stopped", cfgFile)
}
svr, errRet := client.NewService(cfg, pxyCfgs, visitorCfgs, cfgFile)
2019-02-01 19:26:10 +08:00
if errRet != nil {
err = errRet
return
}
2018-04-10 17:46:49 +08:00
2022-03-28 12:12:35 +08:00
kcpDoneCh := make(chan struct{})
2018-04-10 17:46:49 +08:00
// Capture the exit signal if we use kcp.
if cfg.Protocol == "kcp" {
2022-03-28 12:12:35 +08:00
go handleSignal(svr, kcpDoneCh)
2018-04-10 17:46:49 +08:00
}
err = svr.Run()
if err == nil && cfg.Protocol == "kcp" {
2018-12-11 15:06:54 +08:00
<-kcpDoneCh
}
2018-04-10 17:46:49 +08:00
return
}