config_test.go 63 KB

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