config_test.go 69 KB

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