serverconf.go 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606
  1. package servercfg
  2. import (
  3. "errors"
  4. "io"
  5. "net/http"
  6. "os"
  7. "strconv"
  8. "strings"
  9. "time"
  10. "github.com/gravitl/netmaker/config"
  11. "github.com/gravitl/netmaker/models"
  12. )
  13. // EmqxBrokerType denotes the broker type for EMQX MQTT
  14. const EmqxBrokerType = "emqx"
  15. var (
  16. Version = "dev"
  17. Is_EE = false
  18. )
  19. // SetHost - sets the host ip
  20. func SetHost() error {
  21. remoteip, err := GetPublicIP()
  22. if err != nil {
  23. return err
  24. }
  25. os.Setenv("SERVER_HOST", remoteip)
  26. return nil
  27. }
  28. // GetServerConfig - gets the server config into memory from file or env
  29. func GetServerConfig() config.ServerConfig {
  30. var cfg config.ServerConfig
  31. cfg.APIConnString = GetAPIConnString()
  32. cfg.CoreDNSAddr = GetCoreDNSAddr()
  33. cfg.APIHost = GetAPIHost()
  34. cfg.APIPort = GetAPIPort()
  35. cfg.MasterKey = "(hidden)"
  36. cfg.DNSKey = "(hidden)"
  37. cfg.AllowedOrigin = GetAllowedOrigin()
  38. cfg.RestBackend = "off"
  39. cfg.NodeID = GetNodeID()
  40. cfg.StunHost = GetStunAddr()
  41. cfg.StunPort = GetStunPort()
  42. cfg.BrokerType = GetBrokerType()
  43. cfg.EmqxRestEndpoint = GetEmqxRestEndpoint()
  44. if IsRestBackend() {
  45. cfg.RestBackend = "on"
  46. }
  47. cfg.DNSMode = "off"
  48. if IsDNSMode() {
  49. cfg.DNSMode = "on"
  50. }
  51. cfg.DisplayKeys = "off"
  52. if IsDisplayKeys() {
  53. cfg.DisplayKeys = "on"
  54. }
  55. cfg.DisableRemoteIPCheck = "off"
  56. if DisableRemoteIPCheck() {
  57. cfg.DisableRemoteIPCheck = "on"
  58. }
  59. cfg.Database = GetDB()
  60. cfg.Platform = GetPlatform()
  61. cfg.Version = GetVersion()
  62. // == auth config ==
  63. var authInfo = GetAuthProviderInfo()
  64. cfg.AuthProvider = authInfo[0]
  65. cfg.ClientID = authInfo[1]
  66. cfg.ClientSecret = authInfo[2]
  67. cfg.FrontendURL = GetFrontendURL()
  68. cfg.Telemetry = Telemetry()
  69. cfg.Server = GetServer()
  70. cfg.Verbosity = GetVerbosity()
  71. cfg.IsEE = "no"
  72. if Is_EE {
  73. cfg.IsEE = "yes"
  74. }
  75. return cfg
  76. }
  77. // GetServerConfig - gets the server config into memory from file or env
  78. func GetServerInfo() models.ServerConfig {
  79. var cfg models.ServerConfig
  80. cfg.Server = GetServer()
  81. cfg.MQUserName = GetMqUserName()
  82. cfg.MQPassword = GetMqPassword()
  83. cfg.API = GetAPIConnString()
  84. cfg.CoreDNSAddr = GetCoreDNSAddr()
  85. cfg.APIPort = GetAPIPort()
  86. cfg.DNSMode = "off"
  87. cfg.Broker = GetPublicBrokerEndpoint()
  88. if IsDNSMode() {
  89. cfg.DNSMode = "on"
  90. }
  91. cfg.Version = GetVersion()
  92. cfg.Is_EE = Is_EE
  93. cfg.StunHost = GetStunAddr()
  94. cfg.StunPort = GetStunPort()
  95. return cfg
  96. }
  97. // GetFrontendURL - gets the frontend url
  98. func GetFrontendURL() string {
  99. var frontend = ""
  100. if os.Getenv("FRONTEND_URL") != "" {
  101. frontend = os.Getenv("FRONTEND_URL")
  102. } else if config.Config.Server.FrontendURL != "" {
  103. frontend = config.Config.Server.FrontendURL
  104. }
  105. return frontend
  106. }
  107. // GetAPIConnString - gets the api connections string
  108. func GetAPIConnString() string {
  109. conn := ""
  110. if os.Getenv("SERVER_API_CONN_STRING") != "" {
  111. conn = os.Getenv("SERVER_API_CONN_STRING")
  112. } else if config.Config.Server.APIConnString != "" {
  113. conn = config.Config.Server.APIConnString
  114. }
  115. return conn
  116. }
  117. // SetVersion - set version of netmaker
  118. func SetVersion(v string) {
  119. Version = v
  120. }
  121. // GetVersion - version of netmaker
  122. func GetVersion() string {
  123. return Version
  124. }
  125. // GetDB - gets the database type
  126. func GetDB() string {
  127. database := "sqlite"
  128. if os.Getenv("DATABASE") != "" {
  129. database = os.Getenv("DATABASE")
  130. } else if config.Config.Server.Database != "" {
  131. database = config.Config.Server.Database
  132. }
  133. return database
  134. }
  135. // GetAPIHost - gets the api host
  136. func GetAPIHost() string {
  137. serverhost := "127.0.0.1"
  138. remoteip, _ := GetPublicIP()
  139. if os.Getenv("SERVER_HTTP_HOST") != "" {
  140. serverhost = os.Getenv("SERVER_HTTP_HOST")
  141. } else if config.Config.Server.APIHost != "" {
  142. serverhost = config.Config.Server.APIHost
  143. } else if os.Getenv("SERVER_HOST") != "" {
  144. serverhost = os.Getenv("SERVER_HOST")
  145. } else {
  146. if remoteip != "" {
  147. serverhost = remoteip
  148. }
  149. }
  150. return serverhost
  151. }
  152. // GetAPIPort - gets the api port
  153. func GetAPIPort() string {
  154. apiport := "8081"
  155. if os.Getenv("API_PORT") != "" {
  156. apiport = os.Getenv("API_PORT")
  157. } else if config.Config.Server.APIPort != "" {
  158. apiport = config.Config.Server.APIPort
  159. }
  160. return apiport
  161. }
  162. // GetStunAddr - gets the stun host address
  163. func GetStunAddr() string {
  164. stunAddr := ""
  165. if os.Getenv("STUN_DOMAIN") != "" {
  166. stunAddr = os.Getenv("STUN_DOMAIN")
  167. } else if config.Config.Server.StunHost != "" {
  168. stunAddr = config.Config.Server.StunHost
  169. }
  170. return stunAddr
  171. }
  172. // GetCoreDNSAddr - gets the core dns address
  173. func GetCoreDNSAddr() string {
  174. addr, _ := GetPublicIP()
  175. if os.Getenv("COREDNS_ADDR") != "" {
  176. addr = os.Getenv("COREDNS_ADDR")
  177. } else if config.Config.Server.CoreDNSAddr != "" {
  178. addr = config.Config.Server.CoreDNSAddr
  179. }
  180. return addr
  181. }
  182. // GetPublicBrokerEndpoint - returns the public broker endpoint which shall be used by netclient
  183. func GetPublicBrokerEndpoint() string {
  184. if os.Getenv("BROKER_ENDPOINT") != "" {
  185. return os.Getenv("BROKER_ENDPOINT")
  186. } else {
  187. return config.Config.Server.Broker
  188. }
  189. }
  190. // GetMessageQueueEndpoint - gets the message queue endpoint
  191. func GetMessageQueueEndpoint() (string, bool) {
  192. host, _ := GetPublicIP()
  193. if os.Getenv("SERVER_BROKER_ENDPOINT") != "" {
  194. host = os.Getenv("SERVER_BROKER_ENDPOINT")
  195. } else if config.Config.Server.ServerBrokerEndpoint != "" {
  196. host = config.Config.Server.ServerBrokerEndpoint
  197. } else if os.Getenv("BROKER_ENDPOINT") != "" {
  198. host = os.Getenv("BROKER_ENDPOINT")
  199. } else if config.Config.Server.Broker != "" {
  200. host = config.Config.Server.Broker
  201. } else {
  202. host += ":1883" // default
  203. }
  204. return host, strings.Contains(host, "wss") || strings.Contains(host, "ssl") || strings.Contains(host, "mqtts")
  205. }
  206. // GetBrokerType - returns the type of MQ broker
  207. func GetBrokerType() string {
  208. if os.Getenv("BROKER_TYPE") != "" {
  209. return os.Getenv("BROKER_TYPE")
  210. } else {
  211. return "mosquitto"
  212. }
  213. }
  214. // GetMasterKey - gets the configured master key of server
  215. func GetMasterKey() string {
  216. key := ""
  217. if os.Getenv("MASTER_KEY") != "" {
  218. key = os.Getenv("MASTER_KEY")
  219. } else if config.Config.Server.MasterKey != "" {
  220. key = config.Config.Server.MasterKey
  221. }
  222. return key
  223. }
  224. // GetDNSKey - gets the configured dns key of server
  225. func GetDNSKey() string {
  226. key := "secretkey"
  227. if os.Getenv("DNS_KEY") != "" {
  228. key = os.Getenv("DNS_KEY")
  229. } else if config.Config.Server.DNSKey != "" {
  230. key = config.Config.Server.DNSKey
  231. }
  232. return key
  233. }
  234. // GetAllowedOrigin - get the allowed origin
  235. func GetAllowedOrigin() string {
  236. allowedorigin := "*"
  237. if os.Getenv("CORS_ALLOWED_ORIGIN") != "" {
  238. allowedorigin = os.Getenv("CORS_ALLOWED_ORIGIN")
  239. } else if config.Config.Server.AllowedOrigin != "" {
  240. allowedorigin = config.Config.Server.AllowedOrigin
  241. }
  242. return allowedorigin
  243. }
  244. // IsRestBackend - checks if rest is on or off
  245. func IsRestBackend() bool {
  246. isrest := true
  247. if os.Getenv("REST_BACKEND") != "" {
  248. if os.Getenv("REST_BACKEND") == "off" {
  249. isrest = false
  250. }
  251. } else if config.Config.Server.RestBackend != "" {
  252. if config.Config.Server.RestBackend == "off" {
  253. isrest = false
  254. }
  255. }
  256. return isrest
  257. }
  258. // IsMetricsExporter - checks if metrics exporter is on or off
  259. func IsMetricsExporter() bool {
  260. export := false
  261. if os.Getenv("METRICS_EXPORTER") != "" {
  262. if os.Getenv("METRICS_EXPORTER") == "on" {
  263. export = true
  264. }
  265. } else if config.Config.Server.MetricsExporter != "" {
  266. if config.Config.Server.MetricsExporter == "on" {
  267. export = true
  268. }
  269. }
  270. return export
  271. }
  272. // IsMessageQueueBackend - checks if message queue is on or off
  273. func IsMessageQueueBackend() bool {
  274. ismessagequeue := true
  275. if os.Getenv("MESSAGEQUEUE_BACKEND") != "" {
  276. if os.Getenv("MESSAGEQUEUE_BACKEND") == "off" {
  277. ismessagequeue = false
  278. }
  279. } else if config.Config.Server.MessageQueueBackend != "" {
  280. if config.Config.Server.MessageQueueBackend == "off" {
  281. ismessagequeue = false
  282. }
  283. }
  284. return ismessagequeue
  285. }
  286. // Telemetry - checks if telemetry data should be sent
  287. func Telemetry() string {
  288. telemetry := "on"
  289. if os.Getenv("TELEMETRY") == "off" {
  290. telemetry = "off"
  291. }
  292. if config.Config.Server.Telemetry == "off" {
  293. telemetry = "off"
  294. }
  295. return telemetry
  296. }
  297. // GetServer - gets the server name
  298. func GetServer() string {
  299. server := ""
  300. if os.Getenv("SERVER_NAME") != "" {
  301. server = os.Getenv("SERVER_NAME")
  302. } else if config.Config.Server.Server != "" {
  303. server = config.Config.Server.Server
  304. }
  305. return server
  306. }
  307. func GetVerbosity() int32 {
  308. var verbosity = 0
  309. var err error
  310. if os.Getenv("VERBOSITY") != "" {
  311. verbosity, err = strconv.Atoi(os.Getenv("VERBOSITY"))
  312. if err != nil {
  313. verbosity = 0
  314. }
  315. } else if config.Config.Server.Verbosity != 0 {
  316. verbosity = int(config.Config.Server.Verbosity)
  317. }
  318. if verbosity < 0 || verbosity > 4 {
  319. verbosity = 0
  320. }
  321. return int32(verbosity)
  322. }
  323. // IsDNSMode - should it run with DNS
  324. func IsDNSMode() bool {
  325. isdns := true
  326. if os.Getenv("DNS_MODE") != "" {
  327. if os.Getenv("DNS_MODE") == "off" {
  328. isdns = false
  329. }
  330. } else if config.Config.Server.DNSMode != "" {
  331. if config.Config.Server.DNSMode == "off" {
  332. isdns = false
  333. }
  334. }
  335. return isdns
  336. }
  337. // IsDisplayKeys - should server be able to display keys?
  338. func IsDisplayKeys() bool {
  339. isdisplay := true
  340. if os.Getenv("DISPLAY_KEYS") != "" {
  341. if os.Getenv("DISPLAY_KEYS") == "off" {
  342. isdisplay = false
  343. }
  344. } else if config.Config.Server.DisplayKeys != "" {
  345. if config.Config.Server.DisplayKeys == "off" {
  346. isdisplay = false
  347. }
  348. }
  349. return isdisplay
  350. }
  351. // DisableRemoteIPCheck - disable the remote ip check
  352. func DisableRemoteIPCheck() bool {
  353. disabled := false
  354. if os.Getenv("DISABLE_REMOTE_IP_CHECK") != "" {
  355. if os.Getenv("DISABLE_REMOTE_IP_CHECK") == "on" {
  356. disabled = true
  357. }
  358. } else if config.Config.Server.DisableRemoteIPCheck != "" {
  359. if config.Config.Server.DisableRemoteIPCheck == "on" {
  360. disabled = true
  361. }
  362. }
  363. return disabled
  364. }
  365. // GetPublicIP - gets public ip
  366. func GetPublicIP() (string, error) {
  367. endpoint := ""
  368. var err error
  369. iplist := []string{"https://ip.server.gravitl.com", "https://ifconfig.me", "https://api.ipify.org", "https://ipinfo.io/ip"}
  370. publicIpService := os.Getenv("PUBLIC_IP_SERVICE")
  371. if publicIpService != "" {
  372. // prepend the user-specified service so it's checked first
  373. iplist = append([]string{publicIpService}, iplist...)
  374. } else if config.Config.Server.PublicIPService != "" {
  375. publicIpService = config.Config.Server.PublicIPService
  376. // prepend the user-specified service so it's checked first
  377. iplist = append([]string{publicIpService}, iplist...)
  378. }
  379. for _, ipserver := range iplist {
  380. client := &http.Client{
  381. Timeout: time.Second * 10,
  382. }
  383. resp, err := client.Get(ipserver)
  384. if err != nil {
  385. continue
  386. }
  387. defer resp.Body.Close()
  388. if resp.StatusCode == http.StatusOK {
  389. bodyBytes, err := io.ReadAll(resp.Body)
  390. if err != nil {
  391. continue
  392. }
  393. endpoint = string(bodyBytes)
  394. break
  395. }
  396. }
  397. if err == nil && endpoint == "" {
  398. err = errors.New("public address not found")
  399. }
  400. return endpoint, err
  401. }
  402. // GetPlatform - get the system type of server
  403. func GetPlatform() string {
  404. platform := "linux"
  405. if os.Getenv("PLATFORM") != "" {
  406. platform = os.Getenv("PLATFORM")
  407. } else if config.Config.Server.Platform != "" {
  408. platform = config.Config.Server.Platform
  409. }
  410. return platform
  411. }
  412. // GetSQLConn - get the sql connection string
  413. func GetSQLConn() string {
  414. sqlconn := "http://"
  415. if os.Getenv("SQL_CONN") != "" {
  416. sqlconn = os.Getenv("SQL_CONN")
  417. } else if config.Config.Server.SQLConn != "" {
  418. sqlconn = config.Config.Server.SQLConn
  419. }
  420. return sqlconn
  421. }
  422. // GetNodeID - gets the node id
  423. func GetNodeID() string {
  424. var id string
  425. var err error
  426. // id = getMacAddr()
  427. if os.Getenv("NODE_ID") != "" {
  428. id = os.Getenv("NODE_ID")
  429. } else if config.Config.Server.NodeID != "" {
  430. id = config.Config.Server.NodeID
  431. } else {
  432. id, err = os.Hostname()
  433. if err != nil {
  434. return ""
  435. }
  436. }
  437. return id
  438. }
  439. func SetNodeID(id string) {
  440. config.Config.Server.NodeID = id
  441. }
  442. // GetAuthProviderInfo = gets the oauth provider info
  443. func GetAuthProviderInfo() (pi []string) {
  444. var authProvider = ""
  445. defer func() {
  446. if authProvider == "oidc" {
  447. if os.Getenv("OIDC_ISSUER") != "" {
  448. pi = append(pi, os.Getenv("OIDC_ISSUER"))
  449. } else if config.Config.Server.OIDCIssuer != "" {
  450. pi = append(pi, config.Config.Server.OIDCIssuer)
  451. } else {
  452. pi = []string{"", "", ""}
  453. }
  454. }
  455. }()
  456. if os.Getenv("AUTH_PROVIDER") != "" && os.Getenv("CLIENT_ID") != "" && os.Getenv("CLIENT_SECRET") != "" {
  457. authProvider = strings.ToLower(os.Getenv("AUTH_PROVIDER"))
  458. if authProvider == "google" || authProvider == "azure-ad" || authProvider == "github" || authProvider == "oidc" {
  459. return []string{authProvider, os.Getenv("CLIENT_ID"), os.Getenv("CLIENT_SECRET")}
  460. } else {
  461. authProvider = ""
  462. }
  463. } else if config.Config.Server.AuthProvider != "" && config.Config.Server.ClientID != "" && config.Config.Server.ClientSecret != "" {
  464. authProvider = strings.ToLower(config.Config.Server.AuthProvider)
  465. if authProvider == "google" || authProvider == "azure-ad" || authProvider == "github" || authProvider == "oidc" {
  466. return []string{authProvider, config.Config.Server.ClientID, config.Config.Server.ClientSecret}
  467. }
  468. }
  469. return []string{"", "", ""}
  470. }
  471. // GetAzureTenant - retrieve the azure tenant ID from env variable or config file
  472. func GetAzureTenant() string {
  473. var azureTenant = ""
  474. if os.Getenv("AZURE_TENANT") != "" {
  475. azureTenant = os.Getenv("AZURE_TENANT")
  476. } else if config.Config.Server.AzureTenant != "" {
  477. azureTenant = config.Config.Server.AzureTenant
  478. }
  479. return azureTenant
  480. }
  481. // GetMqPassword - fetches the MQ password
  482. func GetMqPassword() string {
  483. password := ""
  484. if os.Getenv("MQ_PASSWORD") != "" {
  485. password = os.Getenv("MQ_PASSWORD")
  486. } else if config.Config.Server.MQPassword != "" {
  487. password = config.Config.Server.MQPassword
  488. }
  489. return password
  490. }
  491. // GetMqUserName - fetches the MQ username
  492. func GetMqUserName() string {
  493. password := ""
  494. if os.Getenv("MQ_USERNAME") != "" {
  495. password = os.Getenv("MQ_USERNAME")
  496. } else if config.Config.Server.MQUserName != "" {
  497. password = config.Config.Server.MQUserName
  498. }
  499. return password
  500. }
  501. // GetEmqxRestEndpoint - returns the REST API Endpoint of EMQX
  502. func GetEmqxRestEndpoint() string {
  503. return os.Getenv("EMQX_REST_ENDPOINT")
  504. }
  505. // IsBasicAuthEnabled - checks if basic auth has been configured to be turned off
  506. func IsBasicAuthEnabled() bool {
  507. var enabled = true //default
  508. if os.Getenv("BASIC_AUTH") != "" {
  509. enabled = os.Getenv("BASIC_AUTH") == "yes"
  510. } else if config.Config.Server.BasicAuth != "" {
  511. enabled = config.Config.Server.BasicAuth == "yes"
  512. }
  513. return enabled
  514. }
  515. // GetLicenseKey - retrieves pro license value from env or conf files
  516. func GetLicenseKey() string {
  517. licenseKeyValue := os.Getenv("LICENSE_KEY")
  518. if licenseKeyValue == "" {
  519. licenseKeyValue = config.Config.Server.LicenseValue
  520. }
  521. return licenseKeyValue
  522. }
  523. // GetNetmakerAccountID - get's the associated, Netmaker, account ID to verify ownership
  524. func GetNetmakerAccountID() string {
  525. netmakerAccountID := os.Getenv("NETMAKER_ACCOUNT_ID")
  526. if netmakerAccountID == "" {
  527. netmakerAccountID = config.Config.Server.NetmakerAccountID
  528. }
  529. return netmakerAccountID
  530. }
  531. func GetStunPort() int {
  532. port := 3478 //default
  533. if os.Getenv("STUN_PORT") != "" {
  534. portInt, err := strconv.Atoi(os.Getenv("STUN_PORT"))
  535. if err == nil {
  536. port = portInt
  537. }
  538. } else if config.Config.Server.StunPort != 0 {
  539. port = config.Config.Server.StunPort
  540. }
  541. return port
  542. }
  543. func IsProxyEnabled() bool {
  544. var enabled = false //default
  545. if os.Getenv("PROXY") != "" {
  546. enabled = os.Getenv("PROXY") == "on"
  547. } else if config.Config.Server.Proxy != "" {
  548. enabled = config.Config.Server.Proxy == "on"
  549. }
  550. return enabled
  551. }