config_test.go 71 KB

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