config_test.go 67 KB

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