config_test.go 67 KB

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