config_test.go 63 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435
  1. // Copyright (C) 2019-2022 Nicola Murino
  2. //
  3. // This program is free software: you can redistribute it and/or modify
  4. // it under the terms of the GNU Affero General Public License as published
  5. // by the Free Software Foundation, version 3.
  6. //
  7. // This program is distributed in the hope that it will be useful,
  8. // but WITHOUT ANY WARRANTY; without even the implied warranty of
  9. // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  10. // GNU Affero General Public License for more details.
  11. //
  12. // You should have received a copy of the GNU Affero General Public License
  13. // along with this program. If not, see <https://www.gnu.org/licenses/>.
  14. package config_test
  15. import (
  16. "encoding/json"
  17. "os"
  18. "path/filepath"
  19. "strings"
  20. "testing"
  21. "github.com/sftpgo/sdk/kms"
  22. "github.com/spf13/viper"
  23. "github.com/stretchr/testify/assert"
  24. "github.com/stretchr/testify/require"
  25. "github.com/drakkan/sftpgo/v2/command"
  26. "github.com/drakkan/sftpgo/v2/common"
  27. "github.com/drakkan/sftpgo/v2/config"
  28. "github.com/drakkan/sftpgo/v2/dataprovider"
  29. "github.com/drakkan/sftpgo/v2/ftpd"
  30. "github.com/drakkan/sftpgo/v2/httpclient"
  31. "github.com/drakkan/sftpgo/v2/httpd"
  32. "github.com/drakkan/sftpgo/v2/mfa"
  33. "github.com/drakkan/sftpgo/v2/plugin"
  34. "github.com/drakkan/sftpgo/v2/sftpd"
  35. "github.com/drakkan/sftpgo/v2/smtp"
  36. "github.com/drakkan/sftpgo/v2/util"
  37. )
  38. const (
  39. tempConfigName = "temp"
  40. )
  41. func reset() {
  42. viper.Reset()
  43. config.Init()
  44. }
  45. func TestLoadConfigTest(t *testing.T) {
  46. reset()
  47. configDir := ".."
  48. err := config.LoadConfig(configDir, "")
  49. assert.NoError(t, err)
  50. assert.NotEqual(t, httpd.Conf{}, config.GetHTTPConfig())
  51. assert.NotEqual(t, dataprovider.Config{}, config.GetProviderConf())
  52. assert.NotEqual(t, sftpd.Configuration{}, config.GetSFTPDConfig())
  53. assert.NotEqual(t, httpclient.Config{}, config.GetHTTPConfig())
  54. assert.NotEqual(t, smtp.Config{}, config.GetSMTPConfig())
  55. confName := tempConfigName + ".json"
  56. configFilePath := filepath.Join(configDir, confName)
  57. err = config.LoadConfig(configDir, confName)
  58. assert.NoError(t, err)
  59. err = os.WriteFile(configFilePath, []byte("{invalid json}"), os.ModePerm)
  60. assert.NoError(t, err)
  61. err = config.LoadConfig(configDir, confName)
  62. assert.NoError(t, err)
  63. err = os.WriteFile(configFilePath, []byte(`{"sftpd": {"max_auth_tries": "a"}}`), os.ModePerm)
  64. assert.NoError(t, err)
  65. err = config.LoadConfig(configDir, confName)
  66. assert.Error(t, err)
  67. err = os.Remove(configFilePath)
  68. assert.NoError(t, err)
  69. }
  70. func TestLoadConfigFileNotFound(t *testing.T) {
  71. reset()
  72. viper.SetConfigName("configfile")
  73. err := config.LoadConfig(os.TempDir(), "")
  74. assert.NoError(t, err)
  75. mfaConf := config.GetMFAConfig()
  76. assert.Len(t, mfaConf.TOTP, 1)
  77. }
  78. func TestEmptyBanner(t *testing.T) {
  79. reset()
  80. configDir := ".."
  81. confName := tempConfigName + ".json"
  82. configFilePath := filepath.Join(configDir, confName)
  83. err := config.LoadConfig(configDir, "")
  84. assert.NoError(t, err)
  85. sftpdConf := config.GetSFTPDConfig()
  86. sftpdConf.Banner = " "
  87. c := make(map[string]sftpd.Configuration)
  88. c["sftpd"] = sftpdConf
  89. jsonConf, _ := json.Marshal(c)
  90. err = os.WriteFile(configFilePath, jsonConf, os.ModePerm)
  91. assert.NoError(t, err)
  92. err = config.LoadConfig(configDir, confName)
  93. assert.NoError(t, err)
  94. sftpdConf = config.GetSFTPDConfig()
  95. assert.NotEmpty(t, strings.TrimSpace(sftpdConf.Banner))
  96. err = os.Remove(configFilePath)
  97. assert.NoError(t, err)
  98. ftpdConf := config.GetFTPDConfig()
  99. ftpdConf.Banner = " "
  100. c1 := make(map[string]ftpd.Configuration)
  101. c1["ftpd"] = ftpdConf
  102. jsonConf, _ = json.Marshal(c1)
  103. err = os.WriteFile(configFilePath, jsonConf, os.ModePerm)
  104. assert.NoError(t, err)
  105. err = config.LoadConfig(configDir, confName)
  106. assert.NoError(t, err)
  107. ftpdConf = config.GetFTPDConfig()
  108. assert.NotEmpty(t, strings.TrimSpace(ftpdConf.Banner))
  109. err = os.Remove(configFilePath)
  110. assert.NoError(t, err)
  111. }
  112. func TestEnabledSSHCommands(t *testing.T) {
  113. reset()
  114. configDir := ".."
  115. confName := tempConfigName + ".json"
  116. configFilePath := filepath.Join(configDir, confName)
  117. err := config.LoadConfig(configDir, "")
  118. assert.NoError(t, err)
  119. reset()
  120. sftpdConf := config.GetSFTPDConfig()
  121. sftpdConf.EnabledSSHCommands = []string{"scp"}
  122. c := make(map[string]sftpd.Configuration)
  123. c["sftpd"] = sftpdConf
  124. jsonConf, err := json.Marshal(c)
  125. assert.NoError(t, err)
  126. err = os.WriteFile(configFilePath, jsonConf, os.ModePerm)
  127. assert.NoError(t, err)
  128. err = config.LoadConfig(configDir, confName)
  129. assert.NoError(t, err)
  130. sftpdConf = config.GetSFTPDConfig()
  131. if assert.Len(t, sftpdConf.EnabledSSHCommands, 1) {
  132. assert.Equal(t, "scp", sftpdConf.EnabledSSHCommands[0])
  133. }
  134. err = os.Remove(configFilePath)
  135. assert.NoError(t, err)
  136. }
  137. func TestInvalidUploadMode(t *testing.T) {
  138. reset()
  139. configDir := ".."
  140. confName := tempConfigName + ".json"
  141. configFilePath := filepath.Join(configDir, confName)
  142. err := config.LoadConfig(configDir, "")
  143. assert.NoError(t, err)
  144. commonConf := config.GetCommonConfig()
  145. commonConf.UploadMode = 10
  146. c := make(map[string]common.Configuration)
  147. c["common"] = commonConf
  148. jsonConf, err := json.Marshal(c)
  149. assert.NoError(t, err)
  150. err = os.WriteFile(configFilePath, jsonConf, os.ModePerm)
  151. assert.NoError(t, err)
  152. err = config.LoadConfig(configDir, confName)
  153. assert.NoError(t, err)
  154. assert.Equal(t, 0, config.GetCommonConfig().UploadMode)
  155. err = os.Remove(configFilePath)
  156. assert.NoError(t, err)
  157. }
  158. func TestInvalidExternalAuthScope(t *testing.T) {
  159. reset()
  160. configDir := ".."
  161. confName := tempConfigName + ".json"
  162. configFilePath := filepath.Join(configDir, confName)
  163. err := config.LoadConfig(configDir, "")
  164. assert.NoError(t, err)
  165. providerConf := config.GetProviderConf()
  166. providerConf.ExternalAuthScope = 100
  167. c := make(map[string]dataprovider.Config)
  168. c["data_provider"] = providerConf
  169. jsonConf, err := json.Marshal(c)
  170. assert.NoError(t, err)
  171. err = os.WriteFile(configFilePath, jsonConf, os.ModePerm)
  172. assert.NoError(t, err)
  173. err = config.LoadConfig(configDir, confName)
  174. assert.NoError(t, err)
  175. assert.Equal(t, 0, config.GetProviderConf().ExternalAuthScope)
  176. err = os.Remove(configFilePath)
  177. assert.NoError(t, err)
  178. }
  179. func TestInvalidProxyProtocol(t *testing.T) {
  180. reset()
  181. configDir := ".."
  182. confName := tempConfigName + ".json"
  183. configFilePath := filepath.Join(configDir, confName)
  184. err := config.LoadConfig(configDir, "")
  185. assert.NoError(t, err)
  186. commonConf := config.GetCommonConfig()
  187. commonConf.ProxyProtocol = 10
  188. c := make(map[string]common.Configuration)
  189. c["common"] = commonConf
  190. jsonConf, err := json.Marshal(c)
  191. assert.NoError(t, err)
  192. err = os.WriteFile(configFilePath, jsonConf, os.ModePerm)
  193. assert.NoError(t, err)
  194. err = config.LoadConfig(configDir, confName)
  195. assert.NoError(t, err)
  196. assert.Equal(t, 0, config.GetCommonConfig().ProxyProtocol)
  197. err = os.Remove(configFilePath)
  198. assert.NoError(t, err)
  199. }
  200. func TestInvalidUsersBaseDir(t *testing.T) {
  201. reset()
  202. configDir := ".."
  203. confName := tempConfigName + ".json"
  204. configFilePath := filepath.Join(configDir, confName)
  205. err := config.LoadConfig(configDir, "")
  206. assert.NoError(t, err)
  207. providerConf := config.GetProviderConf()
  208. providerConf.UsersBaseDir = "."
  209. c := make(map[string]dataprovider.Config)
  210. c["data_provider"] = providerConf
  211. jsonConf, err := json.Marshal(c)
  212. assert.NoError(t, err)
  213. err = os.WriteFile(configFilePath, jsonConf, os.ModePerm)
  214. assert.NoError(t, err)
  215. err = config.LoadConfig(configDir, confName)
  216. assert.NoError(t, err)
  217. assert.Empty(t, config.GetProviderConf().UsersBaseDir)
  218. err = os.Remove(configFilePath)
  219. assert.NoError(t, err)
  220. }
  221. func TestInvalidInstallationHint(t *testing.T) {
  222. reset()
  223. configDir := ".."
  224. confName := tempConfigName + ".json"
  225. configFilePath := filepath.Join(configDir, confName)
  226. err := config.LoadConfig(configDir, "")
  227. assert.NoError(t, err)
  228. httpdConfig := config.GetHTTPDConfig()
  229. httpdConfig.Setup = httpd.SetupConfig{
  230. InstallationCode: "abc",
  231. InstallationCodeHint: " ",
  232. }
  233. c := make(map[string]httpd.Conf)
  234. c["httpd"] = httpdConfig
  235. jsonConf, err := json.Marshal(c)
  236. assert.NoError(t, err)
  237. err = os.WriteFile(configFilePath, jsonConf, os.ModePerm)
  238. assert.NoError(t, err)
  239. err = config.LoadConfig(configDir, confName)
  240. assert.NoError(t, err)
  241. httpdConfig = config.GetHTTPDConfig()
  242. assert.Equal(t, "abc", httpdConfig.Setup.InstallationCode)
  243. assert.Equal(t, "Installation code", httpdConfig.Setup.InstallationCodeHint)
  244. err = os.Remove(configFilePath)
  245. assert.NoError(t, err)
  246. }
  247. func TestDefenderProviderDriver(t *testing.T) {
  248. if config.GetProviderConf().Driver != dataprovider.SQLiteDataProviderName {
  249. t.Skip("this test is not supported with the current database provider")
  250. }
  251. reset()
  252. configDir := ".."
  253. confName := tempConfigName + ".json"
  254. configFilePath := filepath.Join(configDir, confName)
  255. providerConf := config.GetProviderConf()
  256. providerConf.Driver = dataprovider.BoltDataProviderName
  257. commonConfig := config.GetCommonConfig()
  258. commonConfig.DefenderConfig.Enabled = true
  259. commonConfig.DefenderConfig.Driver = common.DefenderDriverProvider
  260. c := make(map[string]any)
  261. c["common"] = commonConfig
  262. c["data_provider"] = providerConf
  263. jsonConf, err := json.Marshal(c)
  264. assert.NoError(t, err)
  265. err = os.WriteFile(configFilePath, jsonConf, os.ModePerm)
  266. assert.NoError(t, err)
  267. err = config.LoadConfig(configDir, confName)
  268. assert.NoError(t, err)
  269. assert.Equal(t, dataprovider.BoltDataProviderName, config.GetProviderConf().Driver)
  270. assert.Equal(t, common.DefenderDriverMemory, config.GetCommonConfig().DefenderConfig.Driver)
  271. err = os.Remove(configFilePath)
  272. assert.NoError(t, err)
  273. }
  274. func TestSetGetConfig(t *testing.T) {
  275. reset()
  276. sftpdConf := config.GetSFTPDConfig()
  277. sftpdConf.MaxAuthTries = 10
  278. config.SetSFTPDConfig(sftpdConf)
  279. assert.Equal(t, sftpdConf.MaxAuthTries, config.GetSFTPDConfig().MaxAuthTries)
  280. dataProviderConf := config.GetProviderConf()
  281. dataProviderConf.Host = "test host"
  282. config.SetProviderConf(dataProviderConf)
  283. assert.Equal(t, dataProviderConf.Host, config.GetProviderConf().Host)
  284. httpdConf := config.GetHTTPDConfig()
  285. httpdConf.Bindings = append(httpdConf.Bindings, httpd.Binding{Address: "0.0.0.0"})
  286. config.SetHTTPDConfig(httpdConf)
  287. assert.Equal(t, httpdConf.Bindings[0].Address, config.GetHTTPDConfig().Bindings[0].Address)
  288. commonConf := config.GetCommonConfig()
  289. commonConf.IdleTimeout = 10
  290. config.SetCommonConfig(commonConf)
  291. assert.Equal(t, commonConf.IdleTimeout, config.GetCommonConfig().IdleTimeout)
  292. ftpdConf := config.GetFTPDConfig()
  293. ftpdConf.CertificateFile = "cert"
  294. ftpdConf.CertificateKeyFile = "key"
  295. config.SetFTPDConfig(ftpdConf)
  296. assert.Equal(t, ftpdConf.CertificateFile, config.GetFTPDConfig().CertificateFile)
  297. assert.Equal(t, ftpdConf.CertificateKeyFile, config.GetFTPDConfig().CertificateKeyFile)
  298. webDavConf := config.GetWebDAVDConfig()
  299. webDavConf.CertificateFile = "dav_cert"
  300. webDavConf.CertificateKeyFile = "dav_key"
  301. config.SetWebDAVDConfig(webDavConf)
  302. assert.Equal(t, webDavConf.CertificateFile, config.GetWebDAVDConfig().CertificateFile)
  303. assert.Equal(t, webDavConf.CertificateKeyFile, config.GetWebDAVDConfig().CertificateKeyFile)
  304. kmsConf := config.GetKMSConfig()
  305. kmsConf.Secrets.MasterKeyPath = "apath"
  306. kmsConf.Secrets.URL = "aurl"
  307. config.SetKMSConfig(kmsConf)
  308. assert.Equal(t, kmsConf.Secrets.MasterKeyPath, config.GetKMSConfig().Secrets.MasterKeyPath)
  309. assert.Equal(t, kmsConf.Secrets.URL, config.GetKMSConfig().Secrets.URL)
  310. telemetryConf := config.GetTelemetryConfig()
  311. telemetryConf.BindPort = 10001
  312. telemetryConf.BindAddress = "0.0.0.0"
  313. config.SetTelemetryConfig(telemetryConf)
  314. assert.Equal(t, telemetryConf.BindPort, config.GetTelemetryConfig().BindPort)
  315. assert.Equal(t, telemetryConf.BindAddress, config.GetTelemetryConfig().BindAddress)
  316. pluginConf := []plugin.Config{
  317. {
  318. Type: "eventsearcher",
  319. },
  320. }
  321. config.SetPluginsConfig(pluginConf)
  322. if assert.Len(t, config.GetPluginsConfig(), 1) {
  323. assert.Equal(t, pluginConf[0].Type, config.GetPluginsConfig()[0].Type)
  324. }
  325. }
  326. func TestServiceToStart(t *testing.T) {
  327. reset()
  328. configDir := ".."
  329. err := config.LoadConfig(configDir, "")
  330. assert.NoError(t, err)
  331. assert.True(t, config.HasServicesToStart())
  332. sftpdConf := config.GetSFTPDConfig()
  333. sftpdConf.Bindings[0].Port = 0
  334. config.SetSFTPDConfig(sftpdConf)
  335. assert.False(t, config.HasServicesToStart())
  336. ftpdConf := config.GetFTPDConfig()
  337. ftpdConf.Bindings[0].Port = 2121
  338. config.SetFTPDConfig(ftpdConf)
  339. assert.True(t, config.HasServicesToStart())
  340. ftpdConf.Bindings[0].Port = 0
  341. config.SetFTPDConfig(ftpdConf)
  342. webdavdConf := config.GetWebDAVDConfig()
  343. webdavdConf.Bindings[0].Port = 9000
  344. config.SetWebDAVDConfig(webdavdConf)
  345. assert.True(t, config.HasServicesToStart())
  346. webdavdConf.Bindings[0].Port = 0
  347. config.SetWebDAVDConfig(webdavdConf)
  348. assert.False(t, config.HasServicesToStart())
  349. sftpdConf.Bindings[0].Port = 2022
  350. config.SetSFTPDConfig(sftpdConf)
  351. assert.True(t, config.HasServicesToStart())
  352. }
  353. func TestSSHCommandsFromEnv(t *testing.T) {
  354. reset()
  355. os.Setenv("SFTPGO_SFTPD__ENABLED_SSH_COMMANDS", "cd,scp")
  356. t.Cleanup(func() {
  357. os.Unsetenv("SFTPGO_SFTPD__ENABLED_SSH_COMMANDS")
  358. })
  359. configDir := ".."
  360. err := config.LoadConfig(configDir, "")
  361. assert.NoError(t, err)
  362. sftpdConf := config.GetSFTPDConfig()
  363. if assert.Len(t, sftpdConf.EnabledSSHCommands, 2) {
  364. assert.Equal(t, "cd", sftpdConf.EnabledSSHCommands[0])
  365. assert.Equal(t, "scp", sftpdConf.EnabledSSHCommands[1])
  366. }
  367. }
  368. func TestSMTPFromEnv(t *testing.T) {
  369. reset()
  370. os.Setenv("SFTPGO_SMTP__HOST", "smtp.example.com")
  371. os.Setenv("SFTPGO_SMTP__PORT", "587")
  372. t.Cleanup(func() {
  373. os.Unsetenv("SFTPGO_SMTP__HOST")
  374. os.Unsetenv("SFTPGO_SMTP__PORT")
  375. })
  376. configDir := ".."
  377. err := config.LoadConfig(configDir, "")
  378. assert.NoError(t, err)
  379. smtpConfig := config.GetSMTPConfig()
  380. assert.Equal(t, "smtp.example.com", smtpConfig.Host)
  381. assert.Equal(t, 587, smtpConfig.Port)
  382. }
  383. func TestMFAFromEnv(t *testing.T) {
  384. reset()
  385. os.Setenv("SFTPGO_MFA__TOTP__0__NAME", "main")
  386. os.Setenv("SFTPGO_MFA__TOTP__1__NAME", "additional_name")
  387. os.Setenv("SFTPGO_MFA__TOTP__1__ISSUER", "additional_issuer")
  388. os.Setenv("SFTPGO_MFA__TOTP__1__ALGO", "sha256")
  389. t.Cleanup(func() {
  390. os.Unsetenv("SFTPGO_MFA__TOTP__0__NAME")
  391. os.Unsetenv("SFTPGO_MFA__TOTP__1__NAME")
  392. os.Unsetenv("SFTPGO_MFA__TOTP__1__ISSUER")
  393. os.Unsetenv("SFTPGO_MFA__TOTP__1__ALGO")
  394. })
  395. configDir := ".."
  396. err := config.LoadConfig(configDir, "")
  397. assert.NoError(t, err)
  398. mfaConf := config.GetMFAConfig()
  399. require.Len(t, mfaConf.TOTP, 2)
  400. require.Equal(t, "main", mfaConf.TOTP[0].Name)
  401. require.Equal(t, "SFTPGo", mfaConf.TOTP[0].Issuer)
  402. require.Equal(t, "sha1", mfaConf.TOTP[0].Algo)
  403. require.Equal(t, "additional_name", mfaConf.TOTP[1].Name)
  404. require.Equal(t, "additional_issuer", mfaConf.TOTP[1].Issuer)
  405. require.Equal(t, "sha256", mfaConf.TOTP[1].Algo)
  406. }
  407. func TestDisabledMFAConfig(t *testing.T) {
  408. reset()
  409. configDir := ".."
  410. confName := tempConfigName + ".json"
  411. configFilePath := filepath.Join(configDir, confName)
  412. err := config.LoadConfig(configDir, "")
  413. assert.NoError(t, err)
  414. mfaConf := config.GetMFAConfig()
  415. assert.Len(t, mfaConf.TOTP, 1)
  416. reset()
  417. c := make(map[string]mfa.Config)
  418. c["mfa"] = mfa.Config{}
  419. jsonConf, err := json.Marshal(c)
  420. assert.NoError(t, err)
  421. err = os.WriteFile(configFilePath, jsonConf, os.ModePerm)
  422. assert.NoError(t, err)
  423. err = config.LoadConfig(configDir, confName)
  424. assert.NoError(t, err)
  425. mfaConf = config.GetMFAConfig()
  426. assert.Len(t, mfaConf.TOTP, 0)
  427. err = os.Remove(configFilePath)
  428. assert.NoError(t, err)
  429. }
  430. func TestFTPDOverridesFromEnv(t *testing.T) {
  431. reset()
  432. os.Setenv("SFTPGO_FTPD__BINDINGS__0__PASSIVE_IP_OVERRIDES__0__IP", "192.168.1.1")
  433. os.Setenv("SFTPGO_FTPD__BINDINGS__0__PASSIVE_IP_OVERRIDES__0__NETWORKS", "192.168.1.0/24, 192.168.3.0/25")
  434. os.Setenv("SFTPGO_FTPD__BINDINGS__0__PASSIVE_IP_OVERRIDES__1__IP", "192.168.2.1")
  435. os.Setenv("SFTPGO_FTPD__BINDINGS__0__PASSIVE_IP_OVERRIDES__1__NETWORKS", "192.168.2.0/24")
  436. cleanup := func() {
  437. os.Unsetenv("SFTPGO_FTPD__BINDINGS__0__PASSIVE_IP_OVERRIDES__0__IP")
  438. os.Unsetenv("SFTPGO_FTPD__BINDINGS__0__PASSIVE_IP_OVERRIDES__0__NETWORKS")
  439. os.Unsetenv("SFTPGO_FTPD__BINDINGS__0__PASSIVE_IP_OVERRIDES__1__IP")
  440. os.Unsetenv("SFTPGO_FTPD__BINDINGS__0__PASSIVE_IP_OVERRIDES__1__NETWORKS")
  441. }
  442. t.Cleanup(cleanup)
  443. configDir := ".."
  444. err := config.LoadConfig(configDir, "")
  445. assert.NoError(t, err)
  446. ftpdConf := config.GetFTPDConfig()
  447. require.Len(t, ftpdConf.Bindings, 1)
  448. require.Len(t, ftpdConf.Bindings[0].PassiveIPOverrides, 2)
  449. require.Equal(t, "192.168.1.1", ftpdConf.Bindings[0].PassiveIPOverrides[0].IP)
  450. require.Len(t, ftpdConf.Bindings[0].PassiveIPOverrides[0].Networks, 2)
  451. require.Equal(t, "192.168.2.1", ftpdConf.Bindings[0].PassiveIPOverrides[1].IP)
  452. require.Len(t, ftpdConf.Bindings[0].PassiveIPOverrides[1].Networks, 1)
  453. cleanup()
  454. cfg := make(map[string]any)
  455. cfg["ftpd"] = ftpdConf
  456. configAsJSON, err := json.Marshal(cfg)
  457. require.NoError(t, err)
  458. confName := tempConfigName + ".json"
  459. configFilePath := filepath.Join(configDir, confName)
  460. err = os.WriteFile(configFilePath, configAsJSON, os.ModePerm)
  461. assert.NoError(t, err)
  462. os.Setenv("SFTPGO_FTPD__BINDINGS__0__PASSIVE_IP_OVERRIDES__0__IP", "192.168.1.2")
  463. os.Setenv("SFTPGO_FTPD__BINDINGS__0__PASSIVE_IP_OVERRIDES__1__NETWORKS", "192.168.2.0/24,192.168.4.0/25")
  464. err = config.LoadConfig(configDir, confName)
  465. assert.NoError(t, err)
  466. ftpdConf = config.GetFTPDConfig()
  467. require.Len(t, ftpdConf.Bindings, 1)
  468. require.Len(t, ftpdConf.Bindings[0].PassiveIPOverrides, 2)
  469. require.Equal(t, "192.168.1.2", ftpdConf.Bindings[0].PassiveIPOverrides[0].IP)
  470. require.Len(t, ftpdConf.Bindings[0].PassiveIPOverrides[0].Networks, 2)
  471. require.Equal(t, "192.168.2.1", ftpdConf.Bindings[0].PassiveIPOverrides[1].IP)
  472. require.Len(t, ftpdConf.Bindings[0].PassiveIPOverrides[1].Networks, 2)
  473. err = os.Remove(configFilePath)
  474. assert.NoError(t, err)
  475. }
  476. func TestHTTPDSubObjectsFromEnv(t *testing.T) {
  477. reset()
  478. os.Setenv("SFTPGO_HTTPD__BINDINGS__0__SECURITY__HTTPS_PROXY_HEADERS__0__KEY", "X-Forwarded-Proto")
  479. os.Setenv("SFTPGO_HTTPD__BINDINGS__0__SECURITY__HTTPS_PROXY_HEADERS__0__VALUE", "https")
  480. os.Setenv("SFTPGO_HTTPD__BINDINGS__0__WEB_CLIENT_INTEGRATIONS__0__URL", "http://127.0.0.1/")
  481. os.Setenv("SFTPGO_HTTPD__BINDINGS__0__WEB_CLIENT_INTEGRATIONS__0__FILE_EXTENSIONS", ".pdf, .txt")
  482. os.Setenv("SFTPGO_HTTPD__BINDINGS__0__OIDC__CLIENT_ID", "client_id")
  483. os.Setenv("SFTPGO_HTTPD__BINDINGS__0__OIDC__CLIENT_SECRET", "client_secret")
  484. os.Setenv("SFTPGO_HTTPD__BINDINGS__0__OIDC__CONFIG_URL", "config_url")
  485. os.Setenv("SFTPGO_HTTPD__BINDINGS__0__OIDC__REDIRECT_BASE_URL", "redirect_base_url")
  486. os.Setenv("SFTPGO_HTTPD__BINDINGS__0__OIDC__USERNAME_FIELD", "email")
  487. cleanup := func() {
  488. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__0__SECURITY__HTTPS_PROXY_HEADERS__0__KEY")
  489. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__0__SECURITY__HTTPS_PROXY_HEADERS__0__VALUE")
  490. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__0__WEB_CLIENT_INTEGRATIONS__0__URL")
  491. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__0__WEB_CLIENT_INTEGRATIONS__0__FILE_EXTENSIONS")
  492. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__0__OIDC__CLIENT_ID")
  493. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__0__OIDC__CLIENT_SECRET")
  494. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__0__OIDC__CONFIG_URL")
  495. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__0__OIDC__REDIRECT_BASE_URL")
  496. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__0__OIDC__USERNAME_FIELD")
  497. }
  498. t.Cleanup(cleanup)
  499. configDir := ".."
  500. err := config.LoadConfig(configDir, "")
  501. assert.NoError(t, err)
  502. httpdConf := config.GetHTTPDConfig()
  503. require.Len(t, httpdConf.Bindings, 1)
  504. require.Len(t, httpdConf.Bindings[0].Security.HTTPSProxyHeaders, 1)
  505. require.Len(t, httpdConf.Bindings[0].WebClientIntegrations, 1)
  506. require.Equal(t, "client_id", httpdConf.Bindings[0].OIDC.ClientID)
  507. require.Equal(t, "client_secret", httpdConf.Bindings[0].OIDC.ClientSecret)
  508. require.Equal(t, "config_url", httpdConf.Bindings[0].OIDC.ConfigURL)
  509. require.Equal(t, "redirect_base_url", httpdConf.Bindings[0].OIDC.RedirectBaseURL)
  510. require.Equal(t, "email", httpdConf.Bindings[0].OIDC.UsernameField)
  511. cleanup()
  512. cfg := make(map[string]any)
  513. cfg["httpd"] = httpdConf
  514. configAsJSON, err := json.Marshal(cfg)
  515. require.NoError(t, err)
  516. confName := tempConfigName + ".json"
  517. configFilePath := filepath.Join(configDir, confName)
  518. err = os.WriteFile(configFilePath, configAsJSON, os.ModePerm)
  519. assert.NoError(t, err)
  520. os.Setenv("SFTPGO_HTTPD__BINDINGS__0__SECURITY__HTTPS_PROXY_HEADERS__0__VALUE", "http")
  521. os.Setenv("SFTPGO_HTTPD__BINDINGS__0__WEB_CLIENT_INTEGRATIONS__0__URL", "http://127.0.1.1/")
  522. os.Setenv("SFTPGO_HTTPD__BINDINGS__0__OIDC__CLIENT_SECRET", "new_client_secret")
  523. err = config.LoadConfig(configDir, confName)
  524. assert.NoError(t, err)
  525. httpdConf = config.GetHTTPDConfig()
  526. require.Len(t, httpdConf.Bindings, 1)
  527. require.Len(t, httpdConf.Bindings[0].Security.HTTPSProxyHeaders, 1)
  528. require.Equal(t, "http", httpdConf.Bindings[0].Security.HTTPSProxyHeaders[0].Value)
  529. require.Len(t, httpdConf.Bindings[0].WebClientIntegrations, 1)
  530. require.Equal(t, "http://127.0.1.1/", httpdConf.Bindings[0].WebClientIntegrations[0].URL)
  531. require.Equal(t, "client_id", httpdConf.Bindings[0].OIDC.ClientID)
  532. require.Equal(t, "new_client_secret", httpdConf.Bindings[0].OIDC.ClientSecret)
  533. require.Equal(t, "config_url", httpdConf.Bindings[0].OIDC.ConfigURL)
  534. require.Equal(t, "redirect_base_url", httpdConf.Bindings[0].OIDC.RedirectBaseURL)
  535. require.Equal(t, "email", httpdConf.Bindings[0].OIDC.UsernameField)
  536. err = os.Remove(configFilePath)
  537. assert.NoError(t, err)
  538. }
  539. func TestPluginsFromEnv(t *testing.T) {
  540. reset()
  541. os.Setenv("SFTPGO_PLUGINS__0__TYPE", "notifier")
  542. os.Setenv("SFTPGO_PLUGINS__0__NOTIFIER_OPTIONS__FS_EVENTS", "upload,download")
  543. os.Setenv("SFTPGO_PLUGINS__0__NOTIFIER_OPTIONS__PROVIDER_EVENTS", "add,update")
  544. os.Setenv("SFTPGO_PLUGINS__0__NOTIFIER_OPTIONS__PROVIDER_OBJECTS", "user,admin")
  545. os.Setenv("SFTPGO_PLUGINS__0__NOTIFIER_OPTIONS__RETRY_MAX_TIME", "2")
  546. os.Setenv("SFTPGO_PLUGINS__0__NOTIFIER_OPTIONS__RETRY_QUEUE_MAX_SIZE", "1000")
  547. os.Setenv("SFTPGO_PLUGINS__0__CMD", "plugin_start_cmd")
  548. os.Setenv("SFTPGO_PLUGINS__0__ARGS", "arg1,arg2")
  549. os.Setenv("SFTPGO_PLUGINS__0__SHA256SUM", "0a71ded61fccd59c4f3695b51c1b3d180da8d2d77ea09ccee20dac242675c193")
  550. os.Setenv("SFTPGO_PLUGINS__0__AUTO_MTLS", "1")
  551. os.Setenv("SFTPGO_PLUGINS__0__KMS_OPTIONS__SCHEME", kms.SchemeAWS)
  552. os.Setenv("SFTPGO_PLUGINS__0__KMS_OPTIONS__ENCRYPTED_STATUS", kms.SecretStatusAWS)
  553. os.Setenv("SFTPGO_PLUGINS__0__AUTH_OPTIONS__SCOPE", "14")
  554. t.Cleanup(func() {
  555. os.Unsetenv("SFTPGO_PLUGINS__0__TYPE")
  556. os.Unsetenv("SFTPGO_PLUGINS__0__NOTIFIER_OPTIONS__FS_EVENTS")
  557. os.Unsetenv("SFTPGO_PLUGINS__0__NOTIFIER_OPTIONS__PROVIDER_EVENTS")
  558. os.Unsetenv("SFTPGO_PLUGINS__0__NOTIFIER_OPTIONS__PROVIDER_OBJECTS")
  559. os.Unsetenv("SFTPGO_PLUGINS__0__NOTIFIER_OPTIONS__RETRY_MAX_TIME")
  560. os.Unsetenv("SFTPGO_PLUGINS__0__NOTIFIER_OPTIONS__RETRY_QUEUE_MAX_SIZE")
  561. os.Unsetenv("SFTPGO_PLUGINS__0__CMD")
  562. os.Unsetenv("SFTPGO_PLUGINS__0__ARGS")
  563. os.Unsetenv("SFTPGO_PLUGINS__0__SHA256SUM")
  564. os.Unsetenv("SFTPGO_PLUGINS__0__AUTO_MTLS")
  565. os.Unsetenv("SFTPGO_PLUGINS__0__KMS_OPTIONS__SCHEME")
  566. os.Unsetenv("SFTPGO_PLUGINS__0__KMS_OPTIONS__ENCRYPTED_STATUS")
  567. os.Unsetenv("SFTPGO_PLUGINS__0__AUTH_OPTIONS__SCOPE")
  568. })
  569. configDir := ".."
  570. err := config.LoadConfig(configDir, "")
  571. assert.NoError(t, err)
  572. pluginsConf := config.GetPluginsConfig()
  573. require.Len(t, pluginsConf, 1)
  574. pluginConf := pluginsConf[0]
  575. require.Equal(t, "notifier", pluginConf.Type)
  576. require.Len(t, pluginConf.NotifierOptions.FsEvents, 2)
  577. require.True(t, util.Contains(pluginConf.NotifierOptions.FsEvents, "upload"))
  578. require.True(t, util.Contains(pluginConf.NotifierOptions.FsEvents, "download"))
  579. require.Len(t, pluginConf.NotifierOptions.ProviderEvents, 2)
  580. require.Equal(t, "add", pluginConf.NotifierOptions.ProviderEvents[0])
  581. require.Equal(t, "update", pluginConf.NotifierOptions.ProviderEvents[1])
  582. require.Len(t, pluginConf.NotifierOptions.ProviderObjects, 2)
  583. require.Equal(t, "user", pluginConf.NotifierOptions.ProviderObjects[0])
  584. require.Equal(t, "admin", pluginConf.NotifierOptions.ProviderObjects[1])
  585. require.Equal(t, 2, pluginConf.NotifierOptions.RetryMaxTime)
  586. require.Equal(t, 1000, pluginConf.NotifierOptions.RetryQueueMaxSize)
  587. require.Equal(t, "plugin_start_cmd", pluginConf.Cmd)
  588. require.Len(t, pluginConf.Args, 2)
  589. require.Equal(t, "arg1", pluginConf.Args[0])
  590. require.Equal(t, "arg2", pluginConf.Args[1])
  591. require.Equal(t, "0a71ded61fccd59c4f3695b51c1b3d180da8d2d77ea09ccee20dac242675c193", pluginConf.SHA256Sum)
  592. require.True(t, pluginConf.AutoMTLS)
  593. require.Equal(t, kms.SchemeAWS, pluginConf.KMSOptions.Scheme)
  594. require.Equal(t, kms.SecretStatusAWS, pluginConf.KMSOptions.EncryptedStatus)
  595. require.Equal(t, 14, pluginConf.AuthOptions.Scope)
  596. cfg := make(map[string]any)
  597. cfg["plugins"] = pluginConf
  598. configAsJSON, err := json.Marshal(cfg)
  599. require.NoError(t, err)
  600. confName := tempConfigName + ".json"
  601. configFilePath := filepath.Join(configDir, confName)
  602. err = os.WriteFile(configFilePath, configAsJSON, os.ModePerm)
  603. assert.NoError(t, err)
  604. os.Setenv("SFTPGO_PLUGINS__0__CMD", "plugin_start_cmd1")
  605. os.Setenv("SFTPGO_PLUGINS__0__ARGS", "")
  606. os.Setenv("SFTPGO_PLUGINS__0__AUTO_MTLS", "0")
  607. os.Setenv("SFTPGO_PLUGINS__0__KMS_OPTIONS__SCHEME", kms.SchemeVaultTransit)
  608. os.Setenv("SFTPGO_PLUGINS__0__KMS_OPTIONS__ENCRYPTED_STATUS", kms.SecretStatusVaultTransit)
  609. err = config.LoadConfig(configDir, confName)
  610. assert.NoError(t, err)
  611. pluginsConf = config.GetPluginsConfig()
  612. require.Len(t, pluginsConf, 1)
  613. pluginConf = pluginsConf[0]
  614. require.Equal(t, "notifier", pluginConf.Type)
  615. require.Len(t, pluginConf.NotifierOptions.FsEvents, 2)
  616. require.True(t, util.Contains(pluginConf.NotifierOptions.FsEvents, "upload"))
  617. require.True(t, util.Contains(pluginConf.NotifierOptions.FsEvents, "download"))
  618. require.Len(t, pluginConf.NotifierOptions.ProviderEvents, 2)
  619. require.Equal(t, "add", pluginConf.NotifierOptions.ProviderEvents[0])
  620. require.Equal(t, "update", pluginConf.NotifierOptions.ProviderEvents[1])
  621. require.Len(t, pluginConf.NotifierOptions.ProviderObjects, 2)
  622. require.Equal(t, "user", pluginConf.NotifierOptions.ProviderObjects[0])
  623. require.Equal(t, "admin", pluginConf.NotifierOptions.ProviderObjects[1])
  624. require.Equal(t, 2, pluginConf.NotifierOptions.RetryMaxTime)
  625. require.Equal(t, 1000, pluginConf.NotifierOptions.RetryQueueMaxSize)
  626. require.Equal(t, "plugin_start_cmd1", pluginConf.Cmd)
  627. require.Len(t, pluginConf.Args, 0)
  628. require.Equal(t, "0a71ded61fccd59c4f3695b51c1b3d180da8d2d77ea09ccee20dac242675c193", pluginConf.SHA256Sum)
  629. require.False(t, pluginConf.AutoMTLS)
  630. require.Equal(t, kms.SchemeVaultTransit, pluginConf.KMSOptions.Scheme)
  631. require.Equal(t, kms.SecretStatusVaultTransit, pluginConf.KMSOptions.EncryptedStatus)
  632. require.Equal(t, 14, pluginConf.AuthOptions.Scope)
  633. err = os.Remove(configFilePath)
  634. assert.NoError(t, err)
  635. }
  636. func TestRateLimitersFromEnv(t *testing.T) {
  637. reset()
  638. os.Setenv("SFTPGO_COMMON__RATE_LIMITERS__0__AVERAGE", "100")
  639. os.Setenv("SFTPGO_COMMON__RATE_LIMITERS__0__PERIOD", "2000")
  640. os.Setenv("SFTPGO_COMMON__RATE_LIMITERS__0__BURST", "10")
  641. os.Setenv("SFTPGO_COMMON__RATE_LIMITERS__0__TYPE", "2")
  642. os.Setenv("SFTPGO_COMMON__RATE_LIMITERS__0__PROTOCOLS", "SSH, FTP")
  643. os.Setenv("SFTPGO_COMMON__RATE_LIMITERS__0__GENERATE_DEFENDER_EVENTS", "1")
  644. os.Setenv("SFTPGO_COMMON__RATE_LIMITERS__0__ENTRIES_SOFT_LIMIT", "50")
  645. os.Setenv("SFTPGO_COMMON__RATE_LIMITERS__0__ENTRIES_HARD_LIMIT", "100")
  646. os.Setenv("SFTPGO_COMMON__RATE_LIMITERS__0__ALLOW_LIST", ", 172.16.2.4, ")
  647. os.Setenv("SFTPGO_COMMON__RATE_LIMITERS__8__AVERAGE", "50")
  648. os.Setenv("SFTPGO_COMMON__RATE_LIMITERS__8__ALLOW_LIST", "192.168.1.1, 192.168.2.0/24")
  649. t.Cleanup(func() {
  650. os.Unsetenv("SFTPGO_COMMON__RATE_LIMITERS__0__AVERAGE")
  651. os.Unsetenv("SFTPGO_COMMON__RATE_LIMITERS__0__PERIOD")
  652. os.Unsetenv("SFTPGO_COMMON__RATE_LIMITERS__0__BURST")
  653. os.Unsetenv("SFTPGO_COMMON__RATE_LIMITERS__0__TYPE")
  654. os.Unsetenv("SFTPGO_COMMON__RATE_LIMITERS__0__PROTOCOLS")
  655. os.Unsetenv("SFTPGO_COMMON__RATE_LIMITERS__0__GENERATE_DEFENDER_EVENTS")
  656. os.Unsetenv("SFTPGO_COMMON__RATE_LIMITERS__0__ENTRIES_SOFT_LIMIT")
  657. os.Unsetenv("SFTPGO_COMMON__RATE_LIMITERS__0__ENTRIES_HARD_LIMIT")
  658. os.Unsetenv("SFTPGO_COMMON__RATE_LIMITERS__0__ALLOW_LIST")
  659. os.Unsetenv("SFTPGO_COMMON__RATE_LIMITERS__8__AVERAGE")
  660. os.Unsetenv("SFTPGO_COMMON__RATE_LIMITERS__8__ALLOW_LIST")
  661. })
  662. configDir := ".."
  663. err := config.LoadConfig(configDir, "")
  664. assert.NoError(t, err)
  665. limiters := config.GetCommonConfig().RateLimitersConfig
  666. require.Len(t, limiters, 2)
  667. require.Equal(t, int64(100), limiters[0].Average)
  668. require.Equal(t, int64(2000), limiters[0].Period)
  669. require.Equal(t, 10, limiters[0].Burst)
  670. require.Equal(t, 2, limiters[0].Type)
  671. protocols := limiters[0].Protocols
  672. require.Len(t, protocols, 2)
  673. require.True(t, util.Contains(protocols, common.ProtocolFTP))
  674. require.True(t, util.Contains(protocols, common.ProtocolSSH))
  675. require.True(t, limiters[0].GenerateDefenderEvents)
  676. require.Equal(t, 50, limiters[0].EntriesSoftLimit)
  677. require.Equal(t, 100, limiters[0].EntriesHardLimit)
  678. require.Len(t, limiters[0].AllowList, 1)
  679. require.Equal(t, "172.16.2.4", limiters[0].AllowList[0])
  680. require.Equal(t, int64(50), limiters[1].Average)
  681. require.Len(t, limiters[1].AllowList, 2)
  682. require.Equal(t, "192.168.1.1", limiters[1].AllowList[0])
  683. require.Equal(t, "192.168.2.0/24", limiters[1].AllowList[1])
  684. // we check the default values here
  685. require.Equal(t, int64(1000), limiters[1].Period)
  686. require.Equal(t, 1, limiters[1].Burst)
  687. require.Equal(t, 2, limiters[1].Type)
  688. protocols = limiters[1].Protocols
  689. require.Len(t, protocols, 4)
  690. require.True(t, util.Contains(protocols, common.ProtocolFTP))
  691. require.True(t, util.Contains(protocols, common.ProtocolSSH))
  692. require.True(t, util.Contains(protocols, common.ProtocolWebDAV))
  693. require.True(t, util.Contains(protocols, common.ProtocolHTTP))
  694. require.False(t, limiters[1].GenerateDefenderEvents)
  695. require.Equal(t, 100, limiters[1].EntriesSoftLimit)
  696. require.Equal(t, 150, limiters[1].EntriesHardLimit)
  697. }
  698. func TestSFTPDBindingsFromEnv(t *testing.T) {
  699. reset()
  700. os.Setenv("SFTPGO_SFTPD__BINDINGS__0__ADDRESS", "127.0.0.1")
  701. os.Setenv("SFTPGO_SFTPD__BINDINGS__0__PORT", "2200")
  702. os.Setenv("SFTPGO_SFTPD__BINDINGS__0__APPLY_PROXY_CONFIG", "false")
  703. os.Setenv("SFTPGO_SFTPD__BINDINGS__3__ADDRESS", "127.0.1.1")
  704. os.Setenv("SFTPGO_SFTPD__BINDINGS__3__PORT", "2203")
  705. t.Cleanup(func() {
  706. os.Unsetenv("SFTPGO_SFTPD__BINDINGS__0__ADDRESS")
  707. os.Unsetenv("SFTPGO_SFTPD__BINDINGS__0__PORT")
  708. os.Unsetenv("SFTPGO_SFTPD__BINDINGS__0__APPLY_PROXY_CONFIG")
  709. os.Unsetenv("SFTPGO_SFTPD__BINDINGS__3__ADDRESS")
  710. os.Unsetenv("SFTPGO_SFTPD__BINDINGS__3__PORT")
  711. })
  712. configDir := ".."
  713. err := config.LoadConfig(configDir, "")
  714. assert.NoError(t, err)
  715. bindings := config.GetSFTPDConfig().Bindings
  716. require.Len(t, bindings, 2)
  717. require.Equal(t, 2200, bindings[0].Port)
  718. require.Equal(t, "127.0.0.1", bindings[0].Address)
  719. require.False(t, bindings[0].ApplyProxyConfig)
  720. require.Equal(t, 2203, bindings[1].Port)
  721. require.Equal(t, "127.0.1.1", bindings[1].Address)
  722. require.True(t, bindings[1].ApplyProxyConfig) // default value
  723. }
  724. func TestCommandsFromEnv(t *testing.T) {
  725. reset()
  726. configDir := ".."
  727. confName := tempConfigName + ".json"
  728. configFilePath := filepath.Join(configDir, confName)
  729. err := config.LoadConfig(configDir, "")
  730. assert.NoError(t, err)
  731. commandConfig := config.GetCommandConfig()
  732. commandConfig.Commands = append(commandConfig.Commands, command.Command{
  733. Path: "cmd",
  734. Timeout: 10,
  735. Env: []string{"a=a"},
  736. })
  737. c := make(map[string]command.Config)
  738. c["command"] = commandConfig
  739. jsonConf, err := json.Marshal(c)
  740. require.NoError(t, err)
  741. err = os.WriteFile(configFilePath, jsonConf, os.ModePerm)
  742. require.NoError(t, err)
  743. err = config.LoadConfig(configDir, confName)
  744. require.NoError(t, err)
  745. commandConfig = config.GetCommandConfig()
  746. require.Equal(t, 30, commandConfig.Timeout)
  747. require.Len(t, commandConfig.Env, 0)
  748. require.Len(t, commandConfig.Commands, 1)
  749. require.Equal(t, "cmd", commandConfig.Commands[0].Path)
  750. require.Equal(t, 10, commandConfig.Commands[0].Timeout)
  751. require.Equal(t, []string{"a=a"}, commandConfig.Commands[0].Env)
  752. os.Setenv("SFTPGO_COMMAND__TIMEOUT", "25")
  753. os.Setenv("SFTPGO_COMMAND__ENV", "a=b,c=d")
  754. os.Setenv("SFTPGO_COMMAND__COMMANDS__0__PATH", "cmd1")
  755. os.Setenv("SFTPGO_COMMAND__COMMANDS__0__TIMEOUT", "11")
  756. os.Setenv("SFTPGO_COMMAND__COMMANDS__1__PATH", "cmd2")
  757. os.Setenv("SFTPGO_COMMAND__COMMANDS__1__TIMEOUT", "20")
  758. os.Setenv("SFTPGO_COMMAND__COMMANDS__1__ENV", "e=f")
  759. t.Cleanup(func() {
  760. os.Unsetenv("SFTPGO_COMMAND__TIMEOUT")
  761. os.Unsetenv("SFTPGO_COMMAND__ENV")
  762. os.Unsetenv("SFTPGO_COMMAND__COMMANDS__0__PATH")
  763. os.Unsetenv("SFTPGO_COMMAND__COMMANDS__0__TIMEOUT")
  764. os.Unsetenv("SFTPGO_COMMAND__COMMANDS__0__ENV")
  765. })
  766. err = config.LoadConfig(configDir, confName)
  767. assert.NoError(t, err)
  768. commandConfig = config.GetCommandConfig()
  769. require.Equal(t, 25, commandConfig.Timeout)
  770. require.Equal(t, []string{"a=b", "c=d"}, commandConfig.Env)
  771. require.Len(t, commandConfig.Commands, 2)
  772. require.Equal(t, "cmd1", commandConfig.Commands[0].Path)
  773. require.Equal(t, 11, commandConfig.Commands[0].Timeout)
  774. require.Equal(t, []string{"a=a"}, commandConfig.Commands[0].Env)
  775. require.Equal(t, "cmd2", commandConfig.Commands[1].Path)
  776. require.Equal(t, 20, commandConfig.Commands[1].Timeout)
  777. require.Equal(t, []string{"e=f"}, commandConfig.Commands[1].Env)
  778. err = os.Remove(configFilePath)
  779. assert.NoError(t, err)
  780. }
  781. func TestFTPDBindingsFromEnv(t *testing.T) {
  782. reset()
  783. os.Setenv("SFTPGO_FTPD__BINDINGS__0__ADDRESS", "127.0.0.1")
  784. os.Setenv("SFTPGO_FTPD__BINDINGS__0__PORT", "2200")
  785. os.Setenv("SFTPGO_FTPD__BINDINGS__0__APPLY_PROXY_CONFIG", "f")
  786. os.Setenv("SFTPGO_FTPD__BINDINGS__0__TLS_MODE", "2")
  787. os.Setenv("SFTPGO_FTPD__BINDINGS__0__FORCE_PASSIVE_IP", "127.0.1.2")
  788. os.Setenv("SFTPGO_FTPD__BINDINGS__0__PASSIVE_IP_OVERRIDES__0__IP", "172.16.1.1")
  789. os.Setenv("SFTPGO_FTPD__BINDINGS__0__TLS_CIPHER_SUITES", "TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256")
  790. os.Setenv("SFTPGO_FTPD__BINDINGS__0__PASSIVE_CONNECTIONS_SECURITY", "1")
  791. os.Setenv("SFTPGO_FTPD__BINDINGS__9__ADDRESS", "127.0.1.1")
  792. os.Setenv("SFTPGO_FTPD__BINDINGS__9__PORT", "2203")
  793. os.Setenv("SFTPGO_FTPD__BINDINGS__9__TLS_MODE", "1")
  794. os.Setenv("SFTPGO_FTPD__BINDINGS__9__MIN_TLS_VERSION", "13")
  795. os.Setenv("SFTPGO_FTPD__BINDINGS__9__FORCE_PASSIVE_IP", "127.0.1.1")
  796. os.Setenv("SFTPGO_FTPD__BINDINGS__9__PASSIVE_IP_OVERRIDES__3__IP", "192.168.1.1")
  797. os.Setenv("SFTPGO_FTPD__BINDINGS__9__PASSIVE_IP_OVERRIDES__3__NETWORKS", "192.168.1.0/24, 192.168.3.0/25")
  798. os.Setenv("SFTPGO_FTPD__BINDINGS__9__CLIENT_AUTH_TYPE", "2")
  799. os.Setenv("SFTPGO_FTPD__BINDINGS__9__DEBUG", "1")
  800. os.Setenv("SFTPGO_FTPD__BINDINGS__9__ACTIVE_CONNECTIONS_SECURITY", "1")
  801. os.Setenv("SFTPGO_FTPD__BINDINGS__9__CERTIFICATE_FILE", "cert.crt")
  802. os.Setenv("SFTPGO_FTPD__BINDINGS__9__CERTIFICATE_KEY_FILE", "cert.key")
  803. t.Cleanup(func() {
  804. os.Unsetenv("SFTPGO_FTPD__BINDINGS__0__ADDRESS")
  805. os.Unsetenv("SFTPGO_FTPD__BINDINGS__0__PORT")
  806. os.Unsetenv("SFTPGO_FTPD__BINDINGS__0__APPLY_PROXY_CONFIG")
  807. os.Unsetenv("SFTPGO_FTPD__BINDINGS__0__TLS_MODE")
  808. os.Unsetenv("SFTPGO_FTPD__BINDINGS__0__FORCE_PASSIVE_IP")
  809. os.Unsetenv("SFTPGO_FTPD__BINDINGS__0__PASSIVE_IP_OVERRIDES__0__IP")
  810. os.Unsetenv("SFTPGO_FTPD__BINDINGS__0__TLS_CIPHER_SUITES")
  811. os.Unsetenv("SFTPGO_FTPD__BINDINGS__0__ACTIVE_CONNECTIONS_SECURITY")
  812. os.Unsetenv("SFTPGO_FTPD__BINDINGS__9__ADDRESS")
  813. os.Unsetenv("SFTPGO_FTPD__BINDINGS__9__PORT")
  814. os.Unsetenv("SFTPGO_FTPD__BINDINGS__9__TLS_MODE")
  815. os.Unsetenv("SFTPGO_FTPD__BINDINGS__9__MIN_TLS_VERSION")
  816. os.Unsetenv("SFTPGO_FTPD__BINDINGS__9__FORCE_PASSIVE_IP")
  817. os.Unsetenv("SFTPGO_FTPD__BINDINGS__9__PASSIVE_IP_OVERRIDES__3__IP")
  818. os.Unsetenv("SFTPGO_FTPD__BINDINGS__9__PASSIVE_IP_OVERRIDES__3__NETWORKS")
  819. os.Unsetenv("SFTPGO_FTPD__BINDINGS__9__CLIENT_AUTH_TYPE")
  820. os.Unsetenv("SFTPGO_FTPD__BINDINGS__9__DEBUG")
  821. os.Unsetenv("SFTPGO_FTPD__BINDINGS__9__ACTIVE_CONNECTIONS_SECURITY")
  822. os.Unsetenv("SFTPGO_FTPD__BINDINGS__9__CERTIFICATE_FILE")
  823. os.Unsetenv("SFTPGO_FTPD__BINDINGS__9__CERTIFICATE_KEY_FILE")
  824. })
  825. configDir := ".."
  826. err := config.LoadConfig(configDir, "")
  827. assert.NoError(t, err)
  828. bindings := config.GetFTPDConfig().Bindings
  829. require.Len(t, bindings, 2)
  830. require.Equal(t, 2200, bindings[0].Port)
  831. require.Equal(t, "127.0.0.1", bindings[0].Address)
  832. require.False(t, bindings[0].ApplyProxyConfig)
  833. require.Equal(t, 2, bindings[0].TLSMode)
  834. require.Equal(t, 12, bindings[0].MinTLSVersion)
  835. require.Equal(t, "127.0.1.2", bindings[0].ForcePassiveIP)
  836. require.Len(t, bindings[0].PassiveIPOverrides, 0)
  837. require.Equal(t, 0, bindings[0].ClientAuthType)
  838. require.Len(t, bindings[0].TLSCipherSuites, 2)
  839. require.Equal(t, "TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256", bindings[0].TLSCipherSuites[0])
  840. require.Equal(t, "TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256", bindings[0].TLSCipherSuites[1])
  841. require.False(t, bindings[0].Debug)
  842. require.Equal(t, 1, bindings[0].PassiveConnectionsSecurity)
  843. require.Equal(t, 0, bindings[0].ActiveConnectionsSecurity)
  844. require.Equal(t, 2203, bindings[1].Port)
  845. require.Equal(t, "127.0.1.1", bindings[1].Address)
  846. require.True(t, bindings[1].ApplyProxyConfig) // default value
  847. require.Equal(t, 1, bindings[1].TLSMode)
  848. require.Equal(t, 13, bindings[1].MinTLSVersion)
  849. require.Equal(t, "127.0.1.1", bindings[1].ForcePassiveIP)
  850. require.Len(t, bindings[1].PassiveIPOverrides, 1)
  851. require.Equal(t, "192.168.1.1", bindings[1].PassiveIPOverrides[0].IP)
  852. require.Len(t, bindings[1].PassiveIPOverrides[0].Networks, 2)
  853. require.Equal(t, "192.168.1.0/24", bindings[1].PassiveIPOverrides[0].Networks[0])
  854. require.Equal(t, "192.168.3.0/25", bindings[1].PassiveIPOverrides[0].Networks[1])
  855. require.Equal(t, 2, bindings[1].ClientAuthType)
  856. require.Nil(t, bindings[1].TLSCipherSuites)
  857. require.Equal(t, 0, bindings[1].PassiveConnectionsSecurity)
  858. require.Equal(t, 1, bindings[1].ActiveConnectionsSecurity)
  859. require.True(t, bindings[1].Debug)
  860. require.Equal(t, "cert.crt", bindings[1].CertificateFile)
  861. require.Equal(t, "cert.key", bindings[1].CertificateKeyFile)
  862. }
  863. func TestWebDAVBindingsFromEnv(t *testing.T) {
  864. reset()
  865. os.Setenv("SFTPGO_WEBDAVD__BINDINGS__1__ADDRESS", "127.0.0.1")
  866. os.Setenv("SFTPGO_WEBDAVD__BINDINGS__1__PORT", "8000")
  867. os.Setenv("SFTPGO_WEBDAVD__BINDINGS__1__ENABLE_HTTPS", "0")
  868. os.Setenv("SFTPGO_WEBDAVD__BINDINGS__1__TLS_CIPHER_SUITES", "TLS_RSA_WITH_AES_128_CBC_SHA ")
  869. os.Setenv("SFTPGO_WEBDAVD__BINDINGS__1__PROXY_ALLOWED", "192.168.10.1")
  870. os.Setenv("SFTPGO_WEBDAVD__BINDINGS__1__CLIENT_IP_PROXY_HEADER", "X-Forwarded-For")
  871. os.Setenv("SFTPGO_WEBDAVD__BINDINGS__1__CLIENT_IP_HEADER_DEPTH", "2")
  872. os.Setenv("SFTPGO_WEBDAVD__BINDINGS__2__ADDRESS", "127.0.1.1")
  873. os.Setenv("SFTPGO_WEBDAVD__BINDINGS__2__PORT", "9000")
  874. os.Setenv("SFTPGO_WEBDAVD__BINDINGS__2__ENABLE_HTTPS", "1")
  875. os.Setenv("SFTPGO_WEBDAVD__BINDINGS__2__MIN_TLS_VERSION", "13")
  876. os.Setenv("SFTPGO_WEBDAVD__BINDINGS__2__CLIENT_AUTH_TYPE", "1")
  877. os.Setenv("SFTPGO_WEBDAVD__BINDINGS__2__PREFIX", "/dav2")
  878. os.Setenv("SFTPGO_WEBDAVD__BINDINGS__2__CERTIFICATE_FILE", "webdav.crt")
  879. os.Setenv("SFTPGO_WEBDAVD__BINDINGS__2__CERTIFICATE_KEY_FILE", "webdav.key")
  880. t.Cleanup(func() {
  881. os.Unsetenv("SFTPGO_WEBDAVD__BINDINGS__1__ADDRESS")
  882. os.Unsetenv("SFTPGO_WEBDAVD__BINDINGS__1__PORT")
  883. os.Unsetenv("SFTPGO_WEBDAVD__BINDINGS__1__ENABLE_HTTPS")
  884. os.Unsetenv("SFTPGO_WEBDAVD__BINDINGS__1__TLS_CIPHER_SUITES")
  885. os.Unsetenv("SFTPGO_WEBDAVD__BINDINGS__1__PROXY_ALLOWED")
  886. os.Unsetenv("SFTPGO_WEBDAVD__BINDINGS__1__CLIENT_IP_PROXY_HEADER")
  887. os.Unsetenv("SFTPGO_WEBDAVD__BINDINGS__1__CLIENT_IP_HEADER_DEPTH")
  888. os.Unsetenv("SFTPGO_WEBDAVD__BINDINGS__2__ADDRESS")
  889. os.Unsetenv("SFTPGO_WEBDAVD__BINDINGS__2__PORT")
  890. os.Unsetenv("SFTPGO_WEBDAVD__BINDINGS__2__ENABLE_HTTPS")
  891. os.Unsetenv("SFTPGO_WEBDAVD__BINDINGS__2__MIN_TLS_VERSION")
  892. os.Unsetenv("SFTPGO_WEBDAVD__BINDINGS__2__CLIENT_AUTH_TYPE")
  893. os.Unsetenv("SFTPGO_WEBDAVD__BINDINGS__2__PREFIX")
  894. os.Unsetenv("SFTPGO_WEBDAVD__BINDINGS__2__CERTIFICATE_FILE")
  895. os.Unsetenv("SFTPGO_WEBDAVD__BINDINGS__2__CERTIFICATE_KEY_FILE")
  896. })
  897. configDir := ".."
  898. err := config.LoadConfig(configDir, "")
  899. assert.NoError(t, err)
  900. bindings := config.GetWebDAVDConfig().Bindings
  901. require.Len(t, bindings, 3)
  902. require.Equal(t, 0, bindings[0].Port)
  903. require.Empty(t, bindings[0].Address)
  904. require.False(t, bindings[0].EnableHTTPS)
  905. require.Equal(t, 12, bindings[0].MinTLSVersion)
  906. require.Len(t, bindings[0].TLSCipherSuites, 0)
  907. require.Empty(t, bindings[0].Prefix)
  908. require.Equal(t, 0, bindings[0].ClientIPHeaderDepth)
  909. require.Equal(t, 8000, bindings[1].Port)
  910. require.Equal(t, "127.0.0.1", bindings[1].Address)
  911. require.False(t, bindings[1].EnableHTTPS)
  912. require.Equal(t, 12, bindings[1].MinTLSVersion)
  913. require.Equal(t, 0, bindings[1].ClientAuthType)
  914. require.Len(t, bindings[1].TLSCipherSuites, 1)
  915. require.Equal(t, "TLS_RSA_WITH_AES_128_CBC_SHA", bindings[1].TLSCipherSuites[0])
  916. require.Equal(t, "192.168.10.1", bindings[1].ProxyAllowed[0])
  917. require.Equal(t, "X-Forwarded-For", bindings[1].ClientIPProxyHeader)
  918. require.Equal(t, 2, bindings[1].ClientIPHeaderDepth)
  919. require.Empty(t, bindings[1].Prefix)
  920. require.Equal(t, 9000, bindings[2].Port)
  921. require.Equal(t, "127.0.1.1", bindings[2].Address)
  922. require.True(t, bindings[2].EnableHTTPS)
  923. require.Equal(t, 13, bindings[2].MinTLSVersion)
  924. require.Equal(t, 1, bindings[2].ClientAuthType)
  925. require.Nil(t, bindings[2].TLSCipherSuites)
  926. require.Equal(t, "/dav2", bindings[2].Prefix)
  927. require.Equal(t, "webdav.crt", bindings[2].CertificateFile)
  928. require.Equal(t, "webdav.key", bindings[2].CertificateKeyFile)
  929. require.Equal(t, 0, bindings[2].ClientIPHeaderDepth)
  930. }
  931. func TestHTTPDBindingsFromEnv(t *testing.T) {
  932. reset()
  933. sockPath := filepath.Clean(os.TempDir())
  934. os.Setenv("SFTPGO_HTTPD__BINDINGS__0__ADDRESS", sockPath)
  935. os.Setenv("SFTPGO_HTTPD__BINDINGS__0__PORT", "0")
  936. os.Setenv("SFTPGO_HTTPD__BINDINGS__0__TLS_CIPHER_SUITES", " TLS_AES_128_GCM_SHA256")
  937. os.Setenv("SFTPGO_HTTPD__BINDINGS__1__ADDRESS", "127.0.0.1")
  938. os.Setenv("SFTPGO_HTTPD__BINDINGS__1__PORT", "8000")
  939. os.Setenv("SFTPGO_HTTPD__BINDINGS__1__ENABLE_HTTPS", "0")
  940. os.Setenv("SFTPGO_HTTPD__BINDINGS__1__HIDE_LOGIN_URL", " 1")
  941. os.Setenv("SFTPGO_HTTPD__BINDINGS__1__BRANDING__WEB_ADMIN__NAME", "Web Admin")
  942. os.Setenv("SFTPGO_HTTPD__BINDINGS__1__BRANDING__WEB_CLIENT__SHORT_NAME", "WebClient")
  943. os.Setenv("SFTPGO_HTTPD__BINDINGS__2__ADDRESS", "127.0.1.1")
  944. os.Setenv("SFTPGO_HTTPD__BINDINGS__2__PORT", "9000")
  945. os.Setenv("SFTPGO_HTTPD__BINDINGS__2__ENABLE_WEB_ADMIN", "0")
  946. os.Setenv("SFTPGO_HTTPD__BINDINGS__2__ENABLE_WEB_CLIENT", "0")
  947. os.Setenv("SFTPGO_HTTPD__BINDINGS__2__ENABLED_LOGIN_METHODS", "3")
  948. os.Setenv("SFTPGO_HTTPD__BINDINGS__2__RENDER_OPENAPI", "0")
  949. os.Setenv("SFTPGO_HTTPD__BINDINGS__2__ENABLE_HTTPS", "1 ")
  950. os.Setenv("SFTPGO_HTTPD__BINDINGS__2__MIN_TLS_VERSION", "13")
  951. os.Setenv("SFTPGO_HTTPD__BINDINGS__2__CLIENT_AUTH_TYPE", "1")
  952. os.Setenv("SFTPGO_HTTPD__BINDINGS__2__TLS_CIPHER_SUITES", " TLS_AES_256_GCM_SHA384 , TLS_CHACHA20_POLY1305_SHA256")
  953. os.Setenv("SFTPGO_HTTPD__BINDINGS__2__PROXY_ALLOWED", " 192.168.9.1 , 172.16.25.0/24")
  954. os.Setenv("SFTPGO_HTTPD__BINDINGS__2__CLIENT_IP_PROXY_HEADER", "X-Real-IP")
  955. os.Setenv("SFTPGO_HTTPD__BINDINGS__2__CLIENT_IP_HEADER_DEPTH", "2")
  956. os.Setenv("SFTPGO_HTTPD__BINDINGS__2__HIDE_LOGIN_URL", "3")
  957. os.Setenv("SFTPGO_HTTPD__BINDINGS__2__WEB_CLIENT_INTEGRATIONS__1__URL", "http://127.0.0.1/")
  958. os.Setenv("SFTPGO_HTTPD__BINDINGS__2__WEB_CLIENT_INTEGRATIONS__1__FILE_EXTENSIONS", ".pdf, .txt")
  959. os.Setenv("SFTPGO_HTTPD__BINDINGS__2__WEB_CLIENT_INTEGRATIONS__2__URL", "http://127.0.1.1/")
  960. os.Setenv("SFTPGO_HTTPD__BINDINGS__2__WEB_CLIENT_INTEGRATIONS__3__FILE_EXTENSIONS", ".jpg, .txt")
  961. os.Setenv("SFTPGO_HTTPD__BINDINGS__2__OIDC__CLIENT_ID", "client id")
  962. os.Setenv("SFTPGO_HTTPD__BINDINGS__2__OIDC__CLIENT_SECRET", "client secret")
  963. os.Setenv("SFTPGO_HTTPD__BINDINGS__2__OIDC__CONFIG_URL", "config url")
  964. os.Setenv("SFTPGO_HTTPD__BINDINGS__2__OIDC__REDIRECT_BASE_URL", "redirect base url")
  965. os.Setenv("SFTPGO_HTTPD__BINDINGS__2__OIDC__USERNAME_FIELD", "preferred_username")
  966. os.Setenv("SFTPGO_HTTPD__BINDINGS__2__OIDC__ROLE_FIELD", "sftpgo_role")
  967. os.Setenv("SFTPGO_HTTPD__BINDINGS__2__OIDC__SCOPES", "openid")
  968. os.Setenv("SFTPGO_HTTPD__BINDINGS__2__OIDC__IMPLICIT_ROLES", "1")
  969. os.Setenv("SFTPGO_HTTPD__BINDINGS__2__OIDC__CUSTOM_FIELDS", "field1,field2")
  970. os.Setenv("SFTPGO_HTTPD__BINDINGS__2__SECURITY__ENABLED", "true")
  971. os.Setenv("SFTPGO_HTTPD__BINDINGS__2__SECURITY__ALLOWED_HOSTS", "*.example.com,*.example.net")
  972. os.Setenv("SFTPGO_HTTPD__BINDINGS__2__SECURITY__ALLOWED_HOSTS_ARE_REGEX", "1")
  973. os.Setenv("SFTPGO_HTTPD__BINDINGS__2__SECURITY__HOSTS_PROXY_HEADERS", "X-Forwarded-Host")
  974. os.Setenv("SFTPGO_HTTPD__BINDINGS__2__SECURITY__HTTPS_REDIRECT", "1")
  975. os.Setenv("SFTPGO_HTTPD__BINDINGS__2__SECURITY__HTTPS_HOST", "www.example.com")
  976. os.Setenv("SFTPGO_HTTPD__BINDINGS__2__SECURITY__HTTPS_PROXY_HEADERS__1__KEY", "X-Forwarded-Proto")
  977. os.Setenv("SFTPGO_HTTPD__BINDINGS__2__SECURITY__HTTPS_PROXY_HEADERS__1__VALUE", "https")
  978. os.Setenv("SFTPGO_HTTPD__BINDINGS__2__SECURITY__STS_SECONDS", "31536000")
  979. os.Setenv("SFTPGO_HTTPD__BINDINGS__2__SECURITY__STS_INCLUDE_SUBDOMAINS", "false")
  980. os.Setenv("SFTPGO_HTTPD__BINDINGS__2__SECURITY__STS_PRELOAD", "0")
  981. os.Setenv("SFTPGO_HTTPD__BINDINGS__2__SECURITY__CONTENT_TYPE_NOSNIFF", "t")
  982. os.Setenv("SFTPGO_HTTPD__BINDINGS__2__SECURITY__CONTENT_SECURITY_POLICY", "script-src $NONCE")
  983. os.Setenv("SFTPGO_HTTPD__BINDINGS__2__SECURITY__PERMISSIONS_POLICY", "fullscreen=(), geolocation=()")
  984. os.Setenv("SFTPGO_HTTPD__BINDINGS__2__SECURITY__CROSS_ORIGIN_OPENER_POLICY", "same-origin")
  985. os.Setenv("SFTPGO_HTTPD__BINDINGS__2__SECURITY__EXPECT_CT_HEADER", `max-age=86400, enforce, report-uri="https://foo.example/report"`)
  986. os.Setenv("SFTPGO_HTTPD__BINDINGS__2__EXTRA_CSS__0__PATH", "path1")
  987. os.Setenv("SFTPGO_HTTPD__BINDINGS__2__EXTRA_CSS__1__PATH", "path2")
  988. os.Setenv("SFTPGO_HTTPD__BINDINGS__2__BRANDING__WEB_ADMIN__FAVICON_PATH", "favicon.ico")
  989. os.Setenv("SFTPGO_HTTPD__BINDINGS__2__BRANDING__WEB_CLIENT__LOGO_PATH", "logo.png")
  990. os.Setenv("SFTPGO_HTTPD__BINDINGS__2__BRANDING__WEB_ADMIN__LOGIN_IMAGE_PATH", "login_image.png")
  991. os.Setenv("SFTPGO_HTTPD__BINDINGS__2__BRANDING__WEB_CLIENT__DISCLAIMER_NAME", "disclaimer")
  992. os.Setenv("SFTPGO_HTTPD__BINDINGS__2__BRANDING__WEB_ADMIN__DISCLAIMER_PATH", "disclaimer.html")
  993. os.Setenv("SFTPGO_HTTPD__BINDINGS__2__BRANDING__WEB_CLIENT__DEFAULT_CSS", "default.css")
  994. os.Setenv("SFTPGO_HTTPD__BINDINGS__2__BRANDING__WEB_CLIENT__EXTRA_CSS", "1.css,2.css")
  995. os.Setenv("SFTPGO_HTTPD__BINDINGS__2__CERTIFICATE_FILE", "httpd.crt")
  996. os.Setenv("SFTPGO_HTTPD__BINDINGS__2__CERTIFICATE_KEY_FILE", "httpd.key")
  997. t.Cleanup(func() {
  998. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__0__ADDRESS")
  999. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__0__PORT")
  1000. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__0__TLS_CIPHER_SUITES")
  1001. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__1__ADDRESS")
  1002. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__1__PORT")
  1003. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__1__ENABLE_HTTPS")
  1004. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__1__HIDE_LOGIN_URL")
  1005. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__1__BRANDING__WEB_ADMIN__NAME")
  1006. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__1__BRANDING__WEB_CLIENT__SHORT_NAME")
  1007. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__1__EXTRA_CSS__0__PATH")
  1008. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__2__ADDRESS")
  1009. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__2__PORT")
  1010. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__2__ENABLE_HTTPS")
  1011. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__2__MIN_TLS_VERSION")
  1012. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__2__ENABLE_WEB_ADMIN")
  1013. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__2__ENABLE_WEB_CLIENT")
  1014. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__2__ENABLED_LOGIN_METHODS")
  1015. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__2__RENDER_OPENAPI")
  1016. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__2__CLIENT_AUTH_TYPE")
  1017. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__2__TLS_CIPHER_SUITES")
  1018. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__2__PROXY_ALLOWED")
  1019. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__2__CLIENT_IP_PROXY_HEADER")
  1020. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__2__CLIENT_IP_HEADER_DEPTH")
  1021. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__2__HIDE_LOGIN_URL")
  1022. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__2__WEB_CLIENT_INTEGRATIONS__1__URL")
  1023. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__2__WEB_CLIENT_INTEGRATIONS__1__FILE_EXTENSIONS")
  1024. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__2__WEB_CLIENT_INTEGRATIONS__2__URL")
  1025. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__2__WEB_CLIENT_INTEGRATIONS__3__FILE_EXTENSIONS")
  1026. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__2__OIDC__CLIENT_ID")
  1027. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__2__OIDC__CLIENT_SECRET")
  1028. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__2__OIDC__CONFIG_URL")
  1029. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__2__OIDC__REDIRECT_BASE_URL")
  1030. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__2__OIDC__USERNAME_FIELD")
  1031. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__2__OIDC__ROLE_FIELD")
  1032. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__2__OIDC__SCOPES")
  1033. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__2__OIDC__IMPLICIT_ROLES")
  1034. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__2__OIDC__CUSTOM_FIELDS")
  1035. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__2__SECURITY__ENABLED")
  1036. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__2__SECURITY__ALLOWED_HOSTS")
  1037. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__2__SECURITY__ALLOWED_HOSTS_ARE_REGEX")
  1038. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__2__SECURITY__HOSTS_PROXY_HEADERS")
  1039. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__2__SECURITY__HTTPS_REDIRECT")
  1040. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__2__SECURITY__HTTPS_HOST")
  1041. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__2__SECURITY__HTTPS_PROXY_HEADERS__1__KEY")
  1042. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__2__SECURITY__HTTPS_PROXY_HEADERS__1__VALUE")
  1043. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__2__SECURITY__STS_SECONDS")
  1044. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__2__SECURITY__STS_INCLUDE_SUBDOMAINS")
  1045. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__2__SECURITY__STS_PRELOAD")
  1046. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__2__SECURITY__CONTENT_TYPE_NOSNIFF")
  1047. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__2__SECURITY__CONTENT_SECURITY_POLICY")
  1048. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__2__SECURITY__PERMISSIONS_POLICY")
  1049. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__2__SECURITY__CROSS_ORIGIN_OPENER_POLICY")
  1050. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__2__SECURITY__EXPECT_CT_HEADER")
  1051. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__2__EXTRA_CSS__0__PATH")
  1052. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__2__EXTRA_CSS__1__PATH")
  1053. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__2__BRANDING__WEB_ADMIN__FAVICON_PATH")
  1054. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__2__BRANDING__WEB_CLIENT__LOGO_PATH")
  1055. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__2__BRANDING__WEB_ADMIN__LOGIN_IMAGE_PATH")
  1056. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__2__BRANDING__WEB_CLIENT__DISCLAIMER_NAME")
  1057. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__2__BRANDING__WEB_ADMIN__DISCLAIMER_PATH")
  1058. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__2__BRANDING__WEB_CLIENT__DEFAULT_CSS")
  1059. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__2__BRANDING__WEB_CLIENT__EXTRA_CSS")
  1060. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__2__CERTIFICATE_FILE")
  1061. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__2__CERTIFICATE_KEY_FILE")
  1062. })
  1063. configDir := ".."
  1064. err := config.LoadConfig(configDir, "")
  1065. assert.NoError(t, err)
  1066. bindings := config.GetHTTPDConfig().Bindings
  1067. require.Len(t, bindings, 3)
  1068. require.Equal(t, 0, bindings[0].Port)
  1069. require.Equal(t, sockPath, bindings[0].Address)
  1070. require.False(t, bindings[0].EnableHTTPS)
  1071. require.Equal(t, 12, bindings[0].MinTLSVersion)
  1072. require.True(t, bindings[0].EnableWebAdmin)
  1073. require.True(t, bindings[0].EnableWebClient)
  1074. require.Equal(t, 0, bindings[0].EnabledLoginMethods)
  1075. require.True(t, bindings[0].RenderOpenAPI)
  1076. require.Len(t, bindings[0].TLSCipherSuites, 1)
  1077. require.Empty(t, bindings[0].OIDC.ConfigURL)
  1078. require.Equal(t, "TLS_AES_128_GCM_SHA256", bindings[0].TLSCipherSuites[0])
  1079. require.Equal(t, 0, bindings[0].HideLoginURL)
  1080. require.False(t, bindings[0].Security.Enabled)
  1081. require.Equal(t, 0, bindings[0].ClientIPHeaderDepth)
  1082. require.Len(t, bindings[0].OIDC.Scopes, 3)
  1083. require.Equal(t, 8000, bindings[1].Port)
  1084. require.Equal(t, "127.0.0.1", bindings[1].Address)
  1085. require.False(t, bindings[1].EnableHTTPS)
  1086. require.Equal(t, 12, bindings[0].MinTLSVersion)
  1087. require.True(t, bindings[1].EnableWebAdmin)
  1088. require.True(t, bindings[1].EnableWebClient)
  1089. require.Equal(t, 0, bindings[1].EnabledLoginMethods)
  1090. require.True(t, bindings[1].RenderOpenAPI)
  1091. require.Nil(t, bindings[1].TLSCipherSuites)
  1092. require.Equal(t, 1, bindings[1].HideLoginURL)
  1093. require.Empty(t, bindings[1].OIDC.ClientID)
  1094. require.Len(t, bindings[1].OIDC.Scopes, 3)
  1095. require.False(t, bindings[1].Security.Enabled)
  1096. require.Equal(t, "Web Admin", bindings[1].Branding.WebAdmin.Name)
  1097. require.Equal(t, "WebClient", bindings[1].Branding.WebClient.ShortName)
  1098. require.Equal(t, 0, bindings[1].ClientIPHeaderDepth)
  1099. require.Equal(t, 9000, bindings[2].Port)
  1100. require.Equal(t, "127.0.1.1", bindings[2].Address)
  1101. require.True(t, bindings[2].EnableHTTPS)
  1102. require.Equal(t, 13, bindings[2].MinTLSVersion)
  1103. require.False(t, bindings[2].EnableWebAdmin)
  1104. require.False(t, bindings[2].EnableWebClient)
  1105. require.Equal(t, 3, bindings[2].EnabledLoginMethods)
  1106. require.False(t, bindings[2].RenderOpenAPI)
  1107. require.Equal(t, 1, bindings[2].ClientAuthType)
  1108. require.Len(t, bindings[2].TLSCipherSuites, 2)
  1109. require.Equal(t, "TLS_AES_256_GCM_SHA384", bindings[2].TLSCipherSuites[0])
  1110. require.Equal(t, "TLS_CHACHA20_POLY1305_SHA256", bindings[2].TLSCipherSuites[1])
  1111. require.Len(t, bindings[2].ProxyAllowed, 2)
  1112. require.Equal(t, "192.168.9.1", bindings[2].ProxyAllowed[0])
  1113. require.Equal(t, "172.16.25.0/24", bindings[2].ProxyAllowed[1])
  1114. require.Equal(t, "X-Real-IP", bindings[2].ClientIPProxyHeader)
  1115. require.Equal(t, 2, bindings[2].ClientIPHeaderDepth)
  1116. require.Equal(t, 3, bindings[2].HideLoginURL)
  1117. require.Len(t, bindings[2].WebClientIntegrations, 1)
  1118. require.Equal(t, "http://127.0.0.1/", bindings[2].WebClientIntegrations[0].URL)
  1119. require.Equal(t, []string{".pdf", ".txt"}, bindings[2].WebClientIntegrations[0].FileExtensions)
  1120. require.Equal(t, "client id", bindings[2].OIDC.ClientID)
  1121. require.Equal(t, "client secret", bindings[2].OIDC.ClientSecret)
  1122. require.Equal(t, "config url", bindings[2].OIDC.ConfigURL)
  1123. require.Equal(t, "redirect base url", bindings[2].OIDC.RedirectBaseURL)
  1124. require.Equal(t, "preferred_username", bindings[2].OIDC.UsernameField)
  1125. require.Equal(t, "sftpgo_role", bindings[2].OIDC.RoleField)
  1126. require.Len(t, bindings[2].OIDC.Scopes, 1)
  1127. require.Equal(t, "openid", bindings[2].OIDC.Scopes[0])
  1128. require.True(t, bindings[2].OIDC.ImplicitRoles)
  1129. require.Len(t, bindings[2].OIDC.CustomFields, 2)
  1130. require.Equal(t, "field1", bindings[2].OIDC.CustomFields[0])
  1131. require.Equal(t, "field2", bindings[2].OIDC.CustomFields[1])
  1132. require.True(t, bindings[2].Security.Enabled)
  1133. require.Len(t, bindings[2].Security.AllowedHosts, 2)
  1134. require.Equal(t, "*.example.com", bindings[2].Security.AllowedHosts[0])
  1135. require.Equal(t, "*.example.net", bindings[2].Security.AllowedHosts[1])
  1136. require.True(t, bindings[2].Security.AllowedHostsAreRegex)
  1137. require.Len(t, bindings[2].Security.HostsProxyHeaders, 1)
  1138. require.Equal(t, "X-Forwarded-Host", bindings[2].Security.HostsProxyHeaders[0])
  1139. require.True(t, bindings[2].Security.HTTPSRedirect)
  1140. require.Equal(t, "www.example.com", bindings[2].Security.HTTPSHost)
  1141. require.Len(t, bindings[2].Security.HTTPSProxyHeaders, 1)
  1142. require.Equal(t, "X-Forwarded-Proto", bindings[2].Security.HTTPSProxyHeaders[0].Key)
  1143. require.Equal(t, "https", bindings[2].Security.HTTPSProxyHeaders[0].Value)
  1144. require.Equal(t, int64(31536000), bindings[2].Security.STSSeconds)
  1145. require.False(t, bindings[2].Security.STSIncludeSubdomains)
  1146. require.False(t, bindings[2].Security.STSPreload)
  1147. require.True(t, bindings[2].Security.ContentTypeNosniff)
  1148. require.Equal(t, "script-src $NONCE", bindings[2].Security.ContentSecurityPolicy)
  1149. require.Equal(t, "fullscreen=(), geolocation=()", bindings[2].Security.PermissionsPolicy)
  1150. require.Equal(t, "same-origin", bindings[2].Security.CrossOriginOpenerPolicy)
  1151. require.Equal(t, `max-age=86400, enforce, report-uri="https://foo.example/report"`, bindings[2].Security.ExpectCTHeader)
  1152. require.Equal(t, "favicon.ico", bindings[2].Branding.WebAdmin.FaviconPath)
  1153. require.Equal(t, "logo.png", bindings[2].Branding.WebClient.LogoPath)
  1154. require.Equal(t, "login_image.png", bindings[2].Branding.WebAdmin.LoginImagePath)
  1155. require.Equal(t, "disclaimer", bindings[2].Branding.WebClient.DisclaimerName)
  1156. require.Equal(t, "disclaimer.html", bindings[2].Branding.WebAdmin.DisclaimerPath)
  1157. require.Equal(t, "default.css", bindings[2].Branding.WebClient.DefaultCSS)
  1158. require.Len(t, bindings[2].Branding.WebClient.ExtraCSS, 2)
  1159. require.Equal(t, "1.css", bindings[2].Branding.WebClient.ExtraCSS[0])
  1160. require.Equal(t, "2.css", bindings[2].Branding.WebClient.ExtraCSS[1])
  1161. require.Equal(t, "httpd.crt", bindings[2].CertificateFile)
  1162. require.Equal(t, "httpd.key", bindings[2].CertificateKeyFile)
  1163. }
  1164. func TestHTTPClientCertificatesFromEnv(t *testing.T) {
  1165. reset()
  1166. configDir := ".."
  1167. confName := tempConfigName + ".json"
  1168. configFilePath := filepath.Join(configDir, confName)
  1169. err := config.LoadConfig(configDir, "")
  1170. assert.NoError(t, err)
  1171. httpConf := config.GetHTTPConfig()
  1172. httpConf.Certificates = append(httpConf.Certificates, httpclient.TLSKeyPair{
  1173. Cert: "cert",
  1174. Key: "key",
  1175. })
  1176. c := make(map[string]httpclient.Config)
  1177. c["http"] = httpConf
  1178. jsonConf, err := json.Marshal(c)
  1179. require.NoError(t, err)
  1180. err = os.WriteFile(configFilePath, jsonConf, os.ModePerm)
  1181. require.NoError(t, err)
  1182. err = config.LoadConfig(configDir, confName)
  1183. require.NoError(t, err)
  1184. require.Len(t, config.GetHTTPConfig().Certificates, 1)
  1185. require.Equal(t, "cert", config.GetHTTPConfig().Certificates[0].Cert)
  1186. require.Equal(t, "key", config.GetHTTPConfig().Certificates[0].Key)
  1187. os.Setenv("SFTPGO_HTTP__CERTIFICATES__0__CERT", "cert0")
  1188. os.Setenv("SFTPGO_HTTP__CERTIFICATES__0__KEY", "key0")
  1189. os.Setenv("SFTPGO_HTTP__CERTIFICATES__8__CERT", "cert8")
  1190. os.Setenv("SFTPGO_HTTP__CERTIFICATES__9__CERT", "cert9")
  1191. os.Setenv("SFTPGO_HTTP__CERTIFICATES__9__KEY", "key9")
  1192. t.Cleanup(func() {
  1193. os.Unsetenv("SFTPGO_HTTP__CERTIFICATES__0__CERT")
  1194. os.Unsetenv("SFTPGO_HTTP__CERTIFICATES__0__KEY")
  1195. os.Unsetenv("SFTPGO_HTTP__CERTIFICATES__8__CERT")
  1196. os.Unsetenv("SFTPGO_HTTP__CERTIFICATES__9__CERT")
  1197. os.Unsetenv("SFTPGO_HTTP__CERTIFICATES__9__KEY")
  1198. })
  1199. err = config.LoadConfig(configDir, confName)
  1200. require.NoError(t, err)
  1201. require.Len(t, config.GetHTTPConfig().Certificates, 2)
  1202. require.Equal(t, "cert0", config.GetHTTPConfig().Certificates[0].Cert)
  1203. require.Equal(t, "key0", config.GetHTTPConfig().Certificates[0].Key)
  1204. require.Equal(t, "cert9", config.GetHTTPConfig().Certificates[1].Cert)
  1205. require.Equal(t, "key9", config.GetHTTPConfig().Certificates[1].Key)
  1206. err = os.Remove(configFilePath)
  1207. assert.NoError(t, err)
  1208. config.Init()
  1209. err = config.LoadConfig(configDir, "")
  1210. require.NoError(t, err)
  1211. require.Len(t, config.GetHTTPConfig().Certificates, 2)
  1212. require.Equal(t, "cert0", config.GetHTTPConfig().Certificates[0].Cert)
  1213. require.Equal(t, "key0", config.GetHTTPConfig().Certificates[0].Key)
  1214. require.Equal(t, "cert9", config.GetHTTPConfig().Certificates[1].Cert)
  1215. require.Equal(t, "key9", config.GetHTTPConfig().Certificates[1].Key)
  1216. }
  1217. func TestHTTPClientHeadersFromEnv(t *testing.T) {
  1218. reset()
  1219. configDir := ".."
  1220. confName := tempConfigName + ".json"
  1221. configFilePath := filepath.Join(configDir, confName)
  1222. err := config.LoadConfig(configDir, "")
  1223. assert.NoError(t, err)
  1224. httpConf := config.GetHTTPConfig()
  1225. httpConf.Headers = append(httpConf.Headers, httpclient.Header{
  1226. Key: "key",
  1227. Value: "value",
  1228. URL: "url",
  1229. })
  1230. c := make(map[string]httpclient.Config)
  1231. c["http"] = httpConf
  1232. jsonConf, err := json.Marshal(c)
  1233. require.NoError(t, err)
  1234. err = os.WriteFile(configFilePath, jsonConf, os.ModePerm)
  1235. require.NoError(t, err)
  1236. err = config.LoadConfig(configDir, confName)
  1237. require.NoError(t, err)
  1238. require.Len(t, config.GetHTTPConfig().Headers, 1)
  1239. require.Equal(t, "key", config.GetHTTPConfig().Headers[0].Key)
  1240. require.Equal(t, "value", config.GetHTTPConfig().Headers[0].Value)
  1241. require.Equal(t, "url", config.GetHTTPConfig().Headers[0].URL)
  1242. os.Setenv("SFTPGO_HTTP__HEADERS__0__KEY", "key0")
  1243. os.Setenv("SFTPGO_HTTP__HEADERS__0__VALUE", "value0")
  1244. os.Setenv("SFTPGO_HTTP__HEADERS__0__URL", "url0")
  1245. os.Setenv("SFTPGO_HTTP__HEADERS__8__KEY", "key8")
  1246. os.Setenv("SFTPGO_HTTP__HEADERS__9__KEY", "key9")
  1247. os.Setenv("SFTPGO_HTTP__HEADERS__9__VALUE", "value9")
  1248. os.Setenv("SFTPGO_HTTP__HEADERS__9__URL", "url9")
  1249. t.Cleanup(func() {
  1250. os.Unsetenv("SFTPGO_HTTP__HEADERS__0__KEY")
  1251. os.Unsetenv("SFTPGO_HTTP__HEADERS__0__VALUE")
  1252. os.Unsetenv("SFTPGO_HTTP__HEADERS__0__URL")
  1253. os.Unsetenv("SFTPGO_HTTP__HEADERS__8__KEY")
  1254. os.Unsetenv("SFTPGO_HTTP__HEADERS__9__KEY")
  1255. os.Unsetenv("SFTPGO_HTTP__HEADERS__9__VALUE")
  1256. os.Unsetenv("SFTPGO_HTTP__HEADERS__9__URL")
  1257. })
  1258. err = config.LoadConfig(configDir, confName)
  1259. require.NoError(t, err)
  1260. require.Len(t, config.GetHTTPConfig().Headers, 2)
  1261. require.Equal(t, "key0", config.GetHTTPConfig().Headers[0].Key)
  1262. require.Equal(t, "value0", config.GetHTTPConfig().Headers[0].Value)
  1263. require.Equal(t, "url0", config.GetHTTPConfig().Headers[0].URL)
  1264. require.Equal(t, "key9", config.GetHTTPConfig().Headers[1].Key)
  1265. require.Equal(t, "value9", config.GetHTTPConfig().Headers[1].Value)
  1266. require.Equal(t, "url9", config.GetHTTPConfig().Headers[1].URL)
  1267. err = os.Remove(configFilePath)
  1268. assert.NoError(t, err)
  1269. config.Init()
  1270. err = config.LoadConfig(configDir, "")
  1271. require.NoError(t, err)
  1272. require.Len(t, config.GetHTTPConfig().Headers, 2)
  1273. require.Equal(t, "key0", config.GetHTTPConfig().Headers[0].Key)
  1274. require.Equal(t, "value0", config.GetHTTPConfig().Headers[0].Value)
  1275. require.Equal(t, "url0", config.GetHTTPConfig().Headers[0].URL)
  1276. require.Equal(t, "key9", config.GetHTTPConfig().Headers[1].Key)
  1277. require.Equal(t, "value9", config.GetHTTPConfig().Headers[1].Value)
  1278. require.Equal(t, "url9", config.GetHTTPConfig().Headers[1].URL)
  1279. }
  1280. func TestConfigFromEnv(t *testing.T) {
  1281. reset()
  1282. os.Setenv("SFTPGO_SFTPD__BINDINGS__0__ADDRESS", "127.0.0.1")
  1283. os.Setenv("SFTPGO_WEBDAVD__BINDINGS__0__PORT", "12000")
  1284. os.Setenv("SFTPGO_DATA_PROVIDER__PASSWORD_HASHING__ARGON2_OPTIONS__ITERATIONS", "41")
  1285. os.Setenv("SFTPGO_DATA_PROVIDER__POOL_SIZE", "10")
  1286. os.Setenv("SFTPGO_DATA_PROVIDER__IS_SHARED", "1")
  1287. os.Setenv("SFTPGO_DATA_PROVIDER__ACTIONS__EXECUTE_ON", "add")
  1288. os.Setenv("SFTPGO_KMS__SECRETS__URL", "local")
  1289. os.Setenv("SFTPGO_KMS__SECRETS__MASTER_KEY_PATH", "path")
  1290. os.Setenv("SFTPGO_TELEMETRY__TLS_CIPHER_SUITES", "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA")
  1291. os.Setenv("SFTPGO_HTTPD__SETUP__INSTALLATION_CODE", "123")
  1292. os.Setenv("SFTPGO_ACME__HTTP01_CHALLENGE__PORT", "5002")
  1293. t.Cleanup(func() {
  1294. os.Unsetenv("SFTPGO_SFTPD__BINDINGS__0__ADDRESS")
  1295. os.Unsetenv("SFTPGO_WEBDAVD__BINDINGS__0__PORT")
  1296. os.Unsetenv("SFTPGO_DATA_PROVIDER__PASSWORD_HASHING__ARGON2_OPTIONS__ITERATIONS")
  1297. os.Unsetenv("SFTPGO_DATA_PROVIDER__POOL_SIZE")
  1298. os.Unsetenv("SFTPGO_DATA_PROVIDER__IS_SHARED")
  1299. os.Unsetenv("SFTPGO_DATA_PROVIDER__ACTIONS__EXECUTE_ON")
  1300. os.Unsetenv("SFTPGO_KMS__SECRETS__URL")
  1301. os.Unsetenv("SFTPGO_KMS__SECRETS__MASTER_KEY_PATH")
  1302. os.Unsetenv("SFTPGO_TELEMETRY__TLS_CIPHER_SUITES")
  1303. os.Unsetenv("SFTPGO_HTTPD__SETUP__INSTALLATION_CODE")
  1304. os.Unsetenv("SFTPGO_ACME__HTTP01_CHALLENGE_PORT")
  1305. })
  1306. err := config.LoadConfig(".", "invalid config")
  1307. assert.NoError(t, err)
  1308. sftpdConfig := config.GetSFTPDConfig()
  1309. assert.Equal(t, "127.0.0.1", sftpdConfig.Bindings[0].Address)
  1310. assert.Equal(t, 12000, config.GetWebDAVDConfig().Bindings[0].Port)
  1311. dataProviderConf := config.GetProviderConf()
  1312. assert.Equal(t, uint32(41), dataProviderConf.PasswordHashing.Argon2Options.Iterations)
  1313. assert.Equal(t, 10, dataProviderConf.PoolSize)
  1314. assert.Equal(t, 1, dataProviderConf.IsShared)
  1315. assert.Len(t, dataProviderConf.Actions.ExecuteOn, 1)
  1316. assert.Contains(t, dataProviderConf.Actions.ExecuteOn, "add")
  1317. kmsConfig := config.GetKMSConfig()
  1318. assert.Equal(t, "local", kmsConfig.Secrets.URL)
  1319. assert.Equal(t, "path", kmsConfig.Secrets.MasterKeyPath)
  1320. telemetryConfig := config.GetTelemetryConfig()
  1321. assert.Len(t, telemetryConfig.TLSCipherSuites, 2)
  1322. assert.Equal(t, "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA", telemetryConfig.TLSCipherSuites[0])
  1323. assert.Equal(t, "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA", telemetryConfig.TLSCipherSuites[1])
  1324. assert.Equal(t, "123", config.GetHTTPDConfig().Setup.InstallationCode)
  1325. acmeConfig := config.GetACMEConfig()
  1326. assert.Equal(t, 5002, acmeConfig.HTTP01Challenge.Port)
  1327. }