client.go 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401
  1. // Copyright 2020 The frp Authors
  2. //
  3. // Licensed under the Apache License, Version 2.0 (the "License");
  4. // you may not use this file except in compliance with the License.
  5. // You may obtain a copy of the License at
  6. //
  7. // http://www.apache.org/licenses/LICENSE-2.0
  8. //
  9. // Unless required by applicable law or agreed to in writing, software
  10. // distributed under the License is distributed on an "AS IS" BASIS,
  11. // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12. // See the License for the specific language governing permissions and
  13. // limitations under the License.
  14. package config
  15. import (
  16. "fmt"
  17. "os"
  18. "path/filepath"
  19. "strings"
  20. "github.com/fatedier/frp/pkg/auth"
  21. "github.com/fatedier/frp/pkg/util/util"
  22. "gopkg.in/ini.v1"
  23. )
  24. // ClientCommonConf contains information for a client service. It is
  25. // recommended to use GetDefaultClientConf instead of creating this object
  26. // directly, so that all unspecified fields have reasonable default values.
  27. type ClientCommonConf struct {
  28. auth.ClientConfig `ini:",extends"`
  29. // ServerAddr specifies the address of the server to connect to. By
  30. // default, this value is "0.0.0.0".
  31. ServerAddr string `ini:"server_addr" json:"server_addr"`
  32. // ServerPort specifies the port to connect to the server on. By default,
  33. // this value is 7000.
  34. ServerPort int `ini:"server_port" json:"server_port"`
  35. // HTTPProxy specifies a proxy address to connect to the server through. If
  36. // this value is "", the server will be connected to directly. By default,
  37. // this value is read from the "http_proxy" environment variable.
  38. HTTPProxy string `ini:"http_proxy" json:"http_proxy"`
  39. // LogFile specifies a file where logs will be written to. This value will
  40. // only be used if LogWay is set appropriately. By default, this value is
  41. // "console".
  42. LogFile string `ini:"log_file" json:"log_file"`
  43. // LogWay specifies the way logging is managed. Valid values are "console"
  44. // or "file". If "console" is used, logs will be printed to stdout. If
  45. // "file" is used, logs will be printed to LogFile. By default, this value
  46. // is "console".
  47. LogWay string `ini:"log_way" json:"log_way"`
  48. // LogLevel specifies the minimum log level. Valid values are "trace",
  49. // "debug", "info", "warn", and "error". By default, this value is "info".
  50. LogLevel string `ini:"log_level" json:"log_level"`
  51. // LogMaxDays specifies the maximum number of days to store log information
  52. // before deletion. This is only used if LogWay == "file". By default, this
  53. // value is 0.
  54. LogMaxDays int64 `ini:"log_max_days" json:"log_max_days"`
  55. // DisableLogColor disables log colors when LogWay == "console" when set to
  56. // true. By default, this value is false.
  57. DisableLogColor bool `ini:"disable_log_color" json:"disable_log_color"`
  58. // AdminAddr specifies the address that the admin server binds to. By
  59. // default, this value is "127.0.0.1".
  60. AdminAddr string `ini:"admin_addr" json:"admin_addr"`
  61. // AdminPort specifies the port for the admin server to listen on. If this
  62. // value is 0, the admin server will not be started. By default, this value
  63. // is 0.
  64. AdminPort int `ini:"admin_port" json:"admin_port"`
  65. // AdminUser specifies the username that the admin server will use for
  66. // login.
  67. AdminUser string `ini:"admin_user" json:"admin_user"`
  68. // AdminPwd specifies the password that the admin server will use for
  69. // login.
  70. AdminPwd string `ini:"admin_pwd" json:"admin_pwd"`
  71. // AssetsDir specifies the local directory that the admin server will load
  72. // resources from. If this value is "", assets will be loaded from the
  73. // bundled executable using statik. By default, this value is "".
  74. AssetsDir string `ini:"assets_dir" json:"assets_dir"`
  75. // PoolCount specifies the number of connections the client will make to
  76. // the server in advance. By default, this value is 0.
  77. PoolCount int `ini:"pool_count" json:"pool_count"`
  78. // TCPMux toggles TCP stream multiplexing. This allows multiple requests
  79. // from a client to share a single TCP connection. If this value is true,
  80. // the server must have TCP multiplexing enabled as well. By default, this
  81. // value is true.
  82. TCPMux bool `ini:"tcp_mux" json:"tcp_mux"`
  83. // TCPMuxKeepaliveInterval specifies the keep alive interval for TCP stream multipler.
  84. // If TCPMux is true, heartbeat of application layer is unnecessary because it can only rely on heartbeat in TCPMux.
  85. TCPMuxKeepaliveInterval int64 `ini:"tcp_mux_keepalive_interval" json:"tcp_mux_keepalive_interval"`
  86. // User specifies a prefix for proxy names to distinguish them from other
  87. // clients. If this value is not "", proxy names will automatically be
  88. // changed to "{user}.{proxy_name}". By default, this value is "".
  89. User string `ini:"user" json:"user"`
  90. // DNSServer specifies a DNS server address for FRPC to use. If this value
  91. // is "", the default DNS will be used. By default, this value is "".
  92. DNSServer string `ini:"dns_server" json:"dns_server"`
  93. // LoginFailExit controls whether or not the client should exit after a
  94. // failed login attempt. If false, the client will retry until a login
  95. // attempt succeeds. By default, this value is true.
  96. LoginFailExit bool `ini:"login_fail_exit" json:"login_fail_exit"`
  97. // Start specifies a set of enabled proxies by name. If this set is empty,
  98. // all supplied proxies are enabled. By default, this value is an empty
  99. // set.
  100. Start []string `ini:"start" json:"start"`
  101. //Start map[string]struct{} `json:"start"`
  102. // Protocol specifies the protocol to use when interacting with the server.
  103. // Valid values are "tcp", "kcp" and "websocket". By default, this value
  104. // is "tcp".
  105. Protocol string `ini:"protocol" json:"protocol"`
  106. // TLSEnable specifies whether or not TLS should be used when communicating
  107. // with the server. If "tls_cert_file" and "tls_key_file" are valid,
  108. // client will load the supplied tls configuration.
  109. TLSEnable bool `ini:"tls_enable" json:"tls_enable"`
  110. // TLSCertPath specifies the path of the cert file that client will
  111. // load. It only works when "tls_enable" is true and "tls_key_file" is valid.
  112. TLSCertFile string `ini:"tls_cert_file" json:"tls_cert_file"`
  113. // TLSKeyPath specifies the path of the secret key file that client
  114. // will load. It only works when "tls_enable" is true and "tls_cert_file"
  115. // are valid.
  116. TLSKeyFile string `ini:"tls_key_file" json:"tls_key_file"`
  117. // TLSTrustedCaFile specifies the path of the trusted ca file that will load.
  118. // It only works when "tls_enable" is valid and tls configuration of server
  119. // has been specified.
  120. TLSTrustedCaFile string `ini:"tls_trusted_ca_file" json:"tls_trusted_ca_file"`
  121. // TLSServerName specifices the custom server name of tls certificate. By
  122. // default, server name if same to ServerAddr.
  123. TLSServerName string `ini:"tls_server_name" json:"tls_server_name"`
  124. // By default, frpc will connect frps with first custom byte if tls is enabled.
  125. // If DisableCustomTLSFirstByte is true, frpc will not send that custom byte.
  126. DisableCustomTLSFirstByte bool `ini:"disable_custom_tls_first_byte" json:"disable_custom_tls_first_byte"`
  127. // HeartBeatInterval specifies at what interval heartbeats are sent to the
  128. // server, in seconds. It is not recommended to change this value. By
  129. // default, this value is 30. Set negative value to disable it.
  130. HeartbeatInterval int64 `ini:"heartbeat_interval" json:"heartbeat_interval"`
  131. // HeartBeatTimeout specifies the maximum allowed heartbeat response delay
  132. // before the connection is terminated, in seconds. It is not recommended
  133. // to change this value. By default, this value is 90. Set negative value to disable it.
  134. HeartbeatTimeout int64 `ini:"heartbeat_timeout" json:"heartbeat_timeout"`
  135. // Client meta info
  136. Metas map[string]string `ini:"-" json:"metas"`
  137. // UDPPacketSize specifies the udp packet size
  138. // By default, this value is 1500
  139. UDPPacketSize int64 `ini:"udp_packet_size" json:"udp_packet_size"`
  140. // Include other config files for proxies.
  141. IncludeConfigFiles []string `ini:"includes" json:"includes"`
  142. }
  143. // GetDefaultClientConf returns a client configuration with default values.
  144. func GetDefaultClientConf() ClientCommonConf {
  145. return ClientCommonConf{
  146. ClientConfig: auth.GetDefaultClientConf(),
  147. ServerAddr: "0.0.0.0",
  148. ServerPort: 7000,
  149. HTTPProxy: os.Getenv("http_proxy"),
  150. LogFile: "console",
  151. LogWay: "console",
  152. LogLevel: "info",
  153. LogMaxDays: 3,
  154. DisableLogColor: false,
  155. AdminAddr: "127.0.0.1",
  156. AdminPort: 0,
  157. AdminUser: "",
  158. AdminPwd: "",
  159. AssetsDir: "",
  160. PoolCount: 1,
  161. TCPMux: true,
  162. TCPMuxKeepaliveInterval: 60,
  163. User: "",
  164. DNSServer: "",
  165. LoginFailExit: true,
  166. Start: make([]string, 0),
  167. Protocol: "tcp",
  168. TLSEnable: false,
  169. TLSCertFile: "",
  170. TLSKeyFile: "",
  171. TLSTrustedCaFile: "",
  172. HeartbeatInterval: 30,
  173. HeartbeatTimeout: 90,
  174. Metas: make(map[string]string),
  175. UDPPacketSize: 1500,
  176. IncludeConfigFiles: make([]string, 0),
  177. }
  178. }
  179. func (cfg *ClientCommonConf) Complete() {
  180. if cfg.LogFile == "console" {
  181. cfg.LogWay = "console"
  182. } else {
  183. cfg.LogWay = "file"
  184. }
  185. }
  186. func (cfg *ClientCommonConf) Validate() error {
  187. if cfg.HeartbeatTimeout > 0 && cfg.HeartbeatInterval > 0 {
  188. if cfg.HeartbeatTimeout < cfg.HeartbeatInterval {
  189. return fmt.Errorf("invalid heartbeat_timeout, heartbeat_timeout is less than heartbeat_interval")
  190. }
  191. }
  192. if cfg.TLSEnable == false {
  193. if cfg.TLSCertFile != "" {
  194. fmt.Println("WARNING! tls_cert_file is invalid when tls_enable is false")
  195. }
  196. if cfg.TLSKeyFile != "" {
  197. fmt.Println("WARNING! tls_key_file is invalid when tls_enable is false")
  198. }
  199. if cfg.TLSTrustedCaFile != "" {
  200. fmt.Println("WARNING! tls_trusted_ca_file is invalid when tls_enable is false")
  201. }
  202. }
  203. if cfg.Protocol != "tcp" && cfg.Protocol != "kcp" && cfg.Protocol != "websocket" {
  204. return fmt.Errorf("invalid protocol")
  205. }
  206. for _, f := range cfg.IncludeConfigFiles {
  207. absDir, err := filepath.Abs(filepath.Dir(f))
  208. if err != nil {
  209. return fmt.Errorf("include: parse directory of %s failed: %v", f, absDir)
  210. }
  211. if _, err := os.Stat(absDir); os.IsNotExist(err) {
  212. return fmt.Errorf("include: directory of %s not exist", f)
  213. }
  214. }
  215. return nil
  216. }
  217. // Supported sources including: string(file path), []byte, Reader interface.
  218. func UnmarshalClientConfFromIni(source interface{}) (ClientCommonConf, error) {
  219. f, err := ini.LoadSources(ini.LoadOptions{
  220. Insensitive: false,
  221. InsensitiveSections: false,
  222. InsensitiveKeys: false,
  223. IgnoreInlineComment: true,
  224. AllowBooleanKeys: true,
  225. }, source)
  226. if err != nil {
  227. return ClientCommonConf{}, err
  228. }
  229. s, err := f.GetSection("common")
  230. if err != nil {
  231. return ClientCommonConf{}, fmt.Errorf("invalid configuration file, not found [common] section")
  232. }
  233. common := GetDefaultClientConf()
  234. err = s.MapTo(&common)
  235. if err != nil {
  236. return ClientCommonConf{}, err
  237. }
  238. common.Metas = GetMapWithoutPrefix(s.KeysHash(), "meta_")
  239. return common, nil
  240. }
  241. // if len(startProxy) is 0, start all
  242. // otherwise just start proxies in startProxy map
  243. func LoadAllProxyConfsFromIni(
  244. prefix string,
  245. source interface{},
  246. start []string,
  247. ) (map[string]ProxyConf, map[string]VisitorConf, error) {
  248. f, err := ini.LoadSources(ini.LoadOptions{
  249. Insensitive: false,
  250. InsensitiveSections: false,
  251. InsensitiveKeys: false,
  252. IgnoreInlineComment: true,
  253. AllowBooleanKeys: true,
  254. }, source)
  255. if err != nil {
  256. return nil, nil, err
  257. }
  258. proxyConfs := make(map[string]ProxyConf)
  259. visitorConfs := make(map[string]VisitorConf)
  260. if prefix != "" {
  261. prefix += "."
  262. }
  263. startProxy := make(map[string]struct{})
  264. for _, s := range start {
  265. startProxy[s] = struct{}{}
  266. }
  267. startAll := true
  268. if len(startProxy) > 0 {
  269. startAll = false
  270. }
  271. // Build template sections from range section And append to ini.File.
  272. rangeSections := make([]*ini.Section, 0)
  273. for _, section := range f.Sections() {
  274. if !strings.HasPrefix(section.Name(), "range:") {
  275. continue
  276. }
  277. rangeSections = append(rangeSections, section)
  278. }
  279. for _, section := range rangeSections {
  280. err = renderRangeProxyTemplates(f, section)
  281. if err != nil {
  282. return nil, nil, fmt.Errorf("failed to render template for proxy %s: %v", section.Name(), err)
  283. }
  284. }
  285. for _, section := range f.Sections() {
  286. name := section.Name()
  287. if name == ini.DefaultSection || name == "common" || strings.HasPrefix(name, "range:") {
  288. continue
  289. }
  290. _, shouldStart := startProxy[name]
  291. if !startAll && !shouldStart {
  292. continue
  293. }
  294. roleType := section.Key("role").String()
  295. if roleType == "" {
  296. roleType = "server"
  297. }
  298. switch roleType {
  299. case "server":
  300. newConf, newErr := NewProxyConfFromIni(prefix, name, section)
  301. if newErr != nil {
  302. return nil, nil, fmt.Errorf("failed to parse proxy %s, err: %v", name, newErr)
  303. }
  304. proxyConfs[prefix+name] = newConf
  305. case "visitor":
  306. newConf, newErr := NewVisitorConfFromIni(prefix, name, section)
  307. if newErr != nil {
  308. return nil, nil, newErr
  309. }
  310. visitorConfs[prefix+name] = newConf
  311. default:
  312. return nil, nil, fmt.Errorf("proxy %s role should be 'server' or 'visitor'", name)
  313. }
  314. }
  315. return proxyConfs, visitorConfs, nil
  316. }
  317. func renderRangeProxyTemplates(f *ini.File, section *ini.Section) error {
  318. // Validation
  319. localPortStr := section.Key("local_port").String()
  320. remotePortStr := section.Key("remote_port").String()
  321. if localPortStr == "" || remotePortStr == "" {
  322. return fmt.Errorf("local_port or remote_port is empty")
  323. }
  324. localPorts, err := util.ParseRangeNumbers(localPortStr)
  325. if err != nil {
  326. return err
  327. }
  328. remotePorts, err := util.ParseRangeNumbers(remotePortStr)
  329. if err != nil {
  330. return err
  331. }
  332. if len(localPorts) != len(remotePorts) {
  333. return fmt.Errorf("local ports number should be same with remote ports number")
  334. }
  335. if len(localPorts) == 0 {
  336. return fmt.Errorf("local_port and remote_port is necessary")
  337. }
  338. // Templates
  339. prefix := strings.TrimSpace(strings.TrimPrefix(section.Name(), "range:"))
  340. for i := range localPorts {
  341. tmpname := fmt.Sprintf("%s_%d", prefix, i)
  342. tmpsection, err := f.NewSection(tmpname)
  343. if err != nil {
  344. return err
  345. }
  346. copySection(section, tmpsection)
  347. tmpsection.NewKey("local_port", fmt.Sprintf("%d", localPorts[i]))
  348. tmpsection.NewKey("remote_port", fmt.Sprintf("%d", remotePorts[i]))
  349. }
  350. return nil
  351. }
  352. func copySection(source, target *ini.Section) {
  353. for key, value := range source.KeysHash() {
  354. target.NewKey(key, value)
  355. }
  356. }