config_test.go 69 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598
  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__TLS_CIPHER_SUITES", "TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256")
  858. os.Setenv("SFTPGO_FTPD__BINDINGS__0__PASSIVE_CONNECTIONS_SECURITY", "1")
  859. os.Setenv("SFTPGO_FTPD__BINDINGS__9__ADDRESS", "127.0.1.1")
  860. os.Setenv("SFTPGO_FTPD__BINDINGS__9__PORT", "2203")
  861. os.Setenv("SFTPGO_FTPD__BINDINGS__9__TLS_MODE", "1")
  862. os.Setenv("SFTPGO_FTPD__BINDINGS__9__MIN_TLS_VERSION", "13")
  863. os.Setenv("SFTPGO_FTPD__BINDINGS__9__FORCE_PASSIVE_IP", "127.0.1.1")
  864. os.Setenv("SFTPGO_FTPD__BINDINGS__9__PASSIVE_IP_OVERRIDES__3__IP", "192.168.1.1")
  865. os.Setenv("SFTPGO_FTPD__BINDINGS__9__PASSIVE_IP_OVERRIDES__3__NETWORKS", "192.168.1.0/24, 192.168.3.0/25")
  866. os.Setenv("SFTPGO_FTPD__BINDINGS__9__CLIENT_AUTH_TYPE", "2")
  867. os.Setenv("SFTPGO_FTPD__BINDINGS__9__DEBUG", "1")
  868. os.Setenv("SFTPGO_FTPD__BINDINGS__9__ACTIVE_CONNECTIONS_SECURITY", "1")
  869. os.Setenv("SFTPGO_FTPD__BINDINGS__9__CERTIFICATE_FILE", "cert.crt")
  870. os.Setenv("SFTPGO_FTPD__BINDINGS__9__CERTIFICATE_KEY_FILE", "cert.key")
  871. t.Cleanup(func() {
  872. os.Unsetenv("SFTPGO_FTPD__BINDINGS__0__ADDRESS")
  873. os.Unsetenv("SFTPGO_FTPD__BINDINGS__0__PORT")
  874. os.Unsetenv("SFTPGO_FTPD__BINDINGS__0__APPLY_PROXY_CONFIG")
  875. os.Unsetenv("SFTPGO_FTPD__BINDINGS__0__TLS_MODE")
  876. os.Unsetenv("SFTPGO_FTPD__BINDINGS__0__FORCE_PASSIVE_IP")
  877. os.Unsetenv("SFTPGO_FTPD__BINDINGS__0__PASSIVE_IP_OVERRIDES__0__IP")
  878. os.Unsetenv("SFTPGO_FTPD__BINDINGS__0__TLS_CIPHER_SUITES")
  879. os.Unsetenv("SFTPGO_FTPD__BINDINGS__0__ACTIVE_CONNECTIONS_SECURITY")
  880. os.Unsetenv("SFTPGO_FTPD__BINDINGS__9__ADDRESS")
  881. os.Unsetenv("SFTPGO_FTPD__BINDINGS__9__PORT")
  882. os.Unsetenv("SFTPGO_FTPD__BINDINGS__9__TLS_MODE")
  883. os.Unsetenv("SFTPGO_FTPD__BINDINGS__9__MIN_TLS_VERSION")
  884. os.Unsetenv("SFTPGO_FTPD__BINDINGS__9__FORCE_PASSIVE_IP")
  885. os.Unsetenv("SFTPGO_FTPD__BINDINGS__9__PASSIVE_IP_OVERRIDES__3__IP")
  886. os.Unsetenv("SFTPGO_FTPD__BINDINGS__9__PASSIVE_IP_OVERRIDES__3__NETWORKS")
  887. os.Unsetenv("SFTPGO_FTPD__BINDINGS__9__CLIENT_AUTH_TYPE")
  888. os.Unsetenv("SFTPGO_FTPD__BINDINGS__9__DEBUG")
  889. os.Unsetenv("SFTPGO_FTPD__BINDINGS__9__ACTIVE_CONNECTIONS_SECURITY")
  890. os.Unsetenv("SFTPGO_FTPD__BINDINGS__9__CERTIFICATE_FILE")
  891. os.Unsetenv("SFTPGO_FTPD__BINDINGS__9__CERTIFICATE_KEY_FILE")
  892. })
  893. err := config.LoadConfig(configDir, "")
  894. assert.NoError(t, err)
  895. bindings := config.GetFTPDConfig().Bindings
  896. require.Len(t, bindings, 2)
  897. require.Equal(t, 2200, bindings[0].Port)
  898. require.Equal(t, "127.0.0.1", bindings[0].Address)
  899. require.False(t, bindings[0].ApplyProxyConfig)
  900. require.Equal(t, 2, bindings[0].TLSMode)
  901. require.Equal(t, 12, bindings[0].MinTLSVersion)
  902. require.Equal(t, "127.0.1.2", bindings[0].ForcePassiveIP)
  903. require.Len(t, bindings[0].PassiveIPOverrides, 0)
  904. require.Equal(t, 0, bindings[0].ClientAuthType)
  905. require.Len(t, bindings[0].TLSCipherSuites, 2)
  906. require.Equal(t, "TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256", bindings[0].TLSCipherSuites[0])
  907. require.Equal(t, "TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256", bindings[0].TLSCipherSuites[1])
  908. require.False(t, bindings[0].Debug)
  909. require.Equal(t, 1, bindings[0].PassiveConnectionsSecurity)
  910. require.Equal(t, 0, bindings[0].ActiveConnectionsSecurity)
  911. require.Equal(t, 2203, bindings[1].Port)
  912. require.Equal(t, "127.0.1.1", bindings[1].Address)
  913. require.True(t, bindings[1].ApplyProxyConfig) // default value
  914. require.Equal(t, 1, bindings[1].TLSMode)
  915. require.Equal(t, 13, bindings[1].MinTLSVersion)
  916. require.Equal(t, "127.0.1.1", bindings[1].ForcePassiveIP)
  917. require.Len(t, bindings[1].PassiveIPOverrides, 1)
  918. require.Equal(t, "192.168.1.1", bindings[1].PassiveIPOverrides[0].IP)
  919. require.Len(t, bindings[1].PassiveIPOverrides[0].Networks, 2)
  920. require.Equal(t, "192.168.1.0/24", bindings[1].PassiveIPOverrides[0].Networks[0])
  921. require.Equal(t, "192.168.3.0/25", bindings[1].PassiveIPOverrides[0].Networks[1])
  922. require.Equal(t, 2, bindings[1].ClientAuthType)
  923. require.Nil(t, bindings[1].TLSCipherSuites)
  924. require.Equal(t, 0, bindings[1].PassiveConnectionsSecurity)
  925. require.Equal(t, 1, bindings[1].ActiveConnectionsSecurity)
  926. require.True(t, bindings[1].Debug)
  927. require.Equal(t, "cert.crt", bindings[1].CertificateFile)
  928. require.Equal(t, "cert.key", bindings[1].CertificateKeyFile)
  929. }
  930. func TestWebDAVMimeCache(t *testing.T) {
  931. reset()
  932. err := config.LoadConfig(configDir, "")
  933. assert.NoError(t, err)
  934. webdavdConf := config.GetWebDAVDConfig()
  935. webdavdConf.Cache.MimeTypes.CustomMappings = []webdavd.CustomMimeMapping{
  936. {
  937. Ext: ".custom",
  938. Mime: "application/custom",
  939. },
  940. }
  941. cfg := map[string]any{
  942. "webdavd": webdavdConf,
  943. }
  944. data, err := json.Marshal(cfg)
  945. assert.NoError(t, err)
  946. confName := tempConfigName + ".json"
  947. configFilePath := filepath.Join(configDir, confName)
  948. err = os.WriteFile(configFilePath, data, 0666)
  949. assert.NoError(t, err)
  950. reset()
  951. err = config.LoadConfig(configDir, confName)
  952. assert.NoError(t, err)
  953. mappings := config.GetWebDAVDConfig().Cache.MimeTypes.CustomMappings
  954. if assert.Len(t, mappings, 1) {
  955. assert.Equal(t, ".custom", mappings[0].Ext)
  956. assert.Equal(t, "application/custom", mappings[0].Mime)
  957. }
  958. // now add from env
  959. os.Setenv("SFTPGO_WEBDAVD__CACHE__MIME_TYPES__CUSTOM_MAPPINGS__1__EXT", ".custom1")
  960. os.Setenv("SFTPGO_WEBDAVD__CACHE__MIME_TYPES__CUSTOM_MAPPINGS__1__MIME", "application/custom1")
  961. t.Cleanup(func() {
  962. os.Unsetenv("SFTPGO_WEBDAVD__CACHE__MIME_TYPES__CUSTOM_MAPPINGS__0__EXT")
  963. os.Unsetenv("SFTPGO_WEBDAVD__CACHE__MIME_TYPES__CUSTOM_MAPPINGS__0__MIME")
  964. os.Unsetenv("SFTPGO_WEBDAVD__CACHE__MIME_TYPES__CUSTOM_MAPPINGS__1__EXT")
  965. os.Unsetenv("SFTPGO_WEBDAVD__CACHE__MIME_TYPES__CUSTOM_MAPPINGS__1__MIME")
  966. })
  967. reset()
  968. err = config.LoadConfig(configDir, confName)
  969. assert.NoError(t, err)
  970. mappings = config.GetWebDAVDConfig().Cache.MimeTypes.CustomMappings
  971. if assert.Len(t, mappings, 2) {
  972. assert.Equal(t, ".custom", mappings[0].Ext)
  973. assert.Equal(t, "application/custom", mappings[0].Mime)
  974. assert.Equal(t, ".custom1", mappings[1].Ext)
  975. assert.Equal(t, "application/custom1", mappings[1].Mime)
  976. }
  977. // override from env
  978. os.Setenv("SFTPGO_WEBDAVD__CACHE__MIME_TYPES__CUSTOM_MAPPINGS__0__EXT", ".custom0")
  979. os.Setenv("SFTPGO_WEBDAVD__CACHE__MIME_TYPES__CUSTOM_MAPPINGS__0__MIME", "application/custom0")
  980. reset()
  981. err = config.LoadConfig(configDir, confName)
  982. assert.NoError(t, err)
  983. mappings = config.GetWebDAVDConfig().Cache.MimeTypes.CustomMappings
  984. if assert.Len(t, mappings, 2) {
  985. assert.Equal(t, ".custom0", mappings[0].Ext)
  986. assert.Equal(t, "application/custom0", mappings[0].Mime)
  987. assert.Equal(t, ".custom1", mappings[1].Ext)
  988. assert.Equal(t, "application/custom1", mappings[1].Mime)
  989. }
  990. err = os.Remove(configFilePath)
  991. assert.NoError(t, err)
  992. }
  993. func TestWebDAVBindingsFromEnv(t *testing.T) {
  994. reset()
  995. os.Setenv("SFTPGO_WEBDAVD__BINDINGS__1__ADDRESS", "127.0.0.1")
  996. os.Setenv("SFTPGO_WEBDAVD__BINDINGS__1__PORT", "8000")
  997. os.Setenv("SFTPGO_WEBDAVD__BINDINGS__1__ENABLE_HTTPS", "0")
  998. os.Setenv("SFTPGO_WEBDAVD__BINDINGS__1__TLS_CIPHER_SUITES", "TLS_RSA_WITH_AES_128_CBC_SHA ")
  999. os.Setenv("SFTPGO_WEBDAVD__BINDINGS__1__PROXY_ALLOWED", "192.168.10.1")
  1000. os.Setenv("SFTPGO_WEBDAVD__BINDINGS__1__CLIENT_IP_PROXY_HEADER", "X-Forwarded-For")
  1001. os.Setenv("SFTPGO_WEBDAVD__BINDINGS__1__CLIENT_IP_HEADER_DEPTH", "2")
  1002. os.Setenv("SFTPGO_WEBDAVD__BINDINGS__2__ADDRESS", "127.0.1.1")
  1003. os.Setenv("SFTPGO_WEBDAVD__BINDINGS__2__PORT", "9000")
  1004. os.Setenv("SFTPGO_WEBDAVD__BINDINGS__2__ENABLE_HTTPS", "1")
  1005. os.Setenv("SFTPGO_WEBDAVD__BINDINGS__2__MIN_TLS_VERSION", "13")
  1006. os.Setenv("SFTPGO_WEBDAVD__BINDINGS__2__CLIENT_AUTH_TYPE", "1")
  1007. os.Setenv("SFTPGO_WEBDAVD__BINDINGS__2__PREFIX", "/dav2")
  1008. os.Setenv("SFTPGO_WEBDAVD__BINDINGS__2__CERTIFICATE_FILE", "webdav.crt")
  1009. os.Setenv("SFTPGO_WEBDAVD__BINDINGS__2__CERTIFICATE_KEY_FILE", "webdav.key")
  1010. os.Setenv("SFTPGO_WEBDAVD__BINDINGS__2__DISABLE_WWW_AUTH_HEADER", "1")
  1011. t.Cleanup(func() {
  1012. os.Unsetenv("SFTPGO_WEBDAVD__BINDINGS__1__ADDRESS")
  1013. os.Unsetenv("SFTPGO_WEBDAVD__BINDINGS__1__PORT")
  1014. os.Unsetenv("SFTPGO_WEBDAVD__BINDINGS__1__ENABLE_HTTPS")
  1015. os.Unsetenv("SFTPGO_WEBDAVD__BINDINGS__1__TLS_CIPHER_SUITES")
  1016. os.Unsetenv("SFTPGO_WEBDAVD__BINDINGS__1__PROXY_ALLOWED")
  1017. os.Unsetenv("SFTPGO_WEBDAVD__BINDINGS__1__CLIENT_IP_PROXY_HEADER")
  1018. os.Unsetenv("SFTPGO_WEBDAVD__BINDINGS__1__CLIENT_IP_HEADER_DEPTH")
  1019. os.Unsetenv("SFTPGO_WEBDAVD__BINDINGS__2__ADDRESS")
  1020. os.Unsetenv("SFTPGO_WEBDAVD__BINDINGS__2__PORT")
  1021. os.Unsetenv("SFTPGO_WEBDAVD__BINDINGS__2__ENABLE_HTTPS")
  1022. os.Unsetenv("SFTPGO_WEBDAVD__BINDINGS__2__MIN_TLS_VERSION")
  1023. os.Unsetenv("SFTPGO_WEBDAVD__BINDINGS__2__CLIENT_AUTH_TYPE")
  1024. os.Unsetenv("SFTPGO_WEBDAVD__BINDINGS__2__PREFIX")
  1025. os.Unsetenv("SFTPGO_WEBDAVD__BINDINGS__2__CERTIFICATE_FILE")
  1026. os.Unsetenv("SFTPGO_WEBDAVD__BINDINGS__2__CERTIFICATE_KEY_FILE")
  1027. os.Unsetenv("SFTPGO_WEBDAVD__BINDINGS__2__DISABLE_WWW_AUTH_HEADER")
  1028. })
  1029. err := config.LoadConfig(configDir, "")
  1030. assert.NoError(t, err)
  1031. bindings := config.GetWebDAVDConfig().Bindings
  1032. require.Len(t, bindings, 3)
  1033. require.Equal(t, 0, bindings[0].Port)
  1034. require.Empty(t, bindings[0].Address)
  1035. require.False(t, bindings[0].EnableHTTPS)
  1036. require.Equal(t, 12, bindings[0].MinTLSVersion)
  1037. require.Len(t, bindings[0].TLSCipherSuites, 0)
  1038. require.Empty(t, bindings[0].Prefix)
  1039. require.Equal(t, 0, bindings[0].ClientIPHeaderDepth)
  1040. require.False(t, bindings[0].DisableWWWAuthHeader)
  1041. require.Equal(t, 8000, bindings[1].Port)
  1042. require.Equal(t, "127.0.0.1", bindings[1].Address)
  1043. require.False(t, bindings[1].EnableHTTPS)
  1044. require.Equal(t, 12, bindings[1].MinTLSVersion)
  1045. require.Equal(t, 0, bindings[1].ClientAuthType)
  1046. require.Len(t, bindings[1].TLSCipherSuites, 1)
  1047. require.Equal(t, "TLS_RSA_WITH_AES_128_CBC_SHA", bindings[1].TLSCipherSuites[0])
  1048. require.Equal(t, "192.168.10.1", bindings[1].ProxyAllowed[0])
  1049. require.Equal(t, "X-Forwarded-For", bindings[1].ClientIPProxyHeader)
  1050. require.Equal(t, 2, bindings[1].ClientIPHeaderDepth)
  1051. require.Empty(t, bindings[1].Prefix)
  1052. require.False(t, bindings[1].DisableWWWAuthHeader)
  1053. require.Equal(t, 9000, bindings[2].Port)
  1054. require.Equal(t, "127.0.1.1", bindings[2].Address)
  1055. require.True(t, bindings[2].EnableHTTPS)
  1056. require.Equal(t, 13, bindings[2].MinTLSVersion)
  1057. require.Equal(t, 1, bindings[2].ClientAuthType)
  1058. require.Nil(t, bindings[2].TLSCipherSuites)
  1059. require.Equal(t, "/dav2", bindings[2].Prefix)
  1060. require.Equal(t, "webdav.crt", bindings[2].CertificateFile)
  1061. require.Equal(t, "webdav.key", bindings[2].CertificateKeyFile)
  1062. require.Equal(t, 0, bindings[2].ClientIPHeaderDepth)
  1063. require.True(t, bindings[2].DisableWWWAuthHeader)
  1064. }
  1065. func TestHTTPDBindingsFromEnv(t *testing.T) {
  1066. reset()
  1067. sockPath := filepath.Clean(os.TempDir())
  1068. os.Setenv("SFTPGO_HTTPD__BINDINGS__0__ADDRESS", sockPath)
  1069. os.Setenv("SFTPGO_HTTPD__BINDINGS__0__PORT", "0")
  1070. os.Setenv("SFTPGO_HTTPD__BINDINGS__0__TLS_CIPHER_SUITES", " TLS_AES_128_GCM_SHA256")
  1071. os.Setenv("SFTPGO_HTTPD__BINDINGS__1__ADDRESS", "127.0.0.1")
  1072. os.Setenv("SFTPGO_HTTPD__BINDINGS__1__PORT", "8000")
  1073. os.Setenv("SFTPGO_HTTPD__BINDINGS__1__ENABLE_HTTPS", "0")
  1074. os.Setenv("SFTPGO_HTTPD__BINDINGS__1__HIDE_LOGIN_URL", " 1")
  1075. os.Setenv("SFTPGO_HTTPD__BINDINGS__1__BRANDING__WEB_ADMIN__NAME", "Web Admin")
  1076. os.Setenv("SFTPGO_HTTPD__BINDINGS__1__BRANDING__WEB_CLIENT__SHORT_NAME", "WebClient")
  1077. os.Setenv("SFTPGO_HTTPD__BINDINGS__2__ADDRESS", "127.0.1.1")
  1078. os.Setenv("SFTPGO_HTTPD__BINDINGS__2__PORT", "9000")
  1079. os.Setenv("SFTPGO_HTTPD__BINDINGS__2__ENABLE_WEB_ADMIN", "0")
  1080. os.Setenv("SFTPGO_HTTPD__BINDINGS__2__ENABLE_WEB_CLIENT", "0")
  1081. os.Setenv("SFTPGO_HTTPD__BINDINGS__2__ENABLE_REST_API", "0")
  1082. os.Setenv("SFTPGO_HTTPD__BINDINGS__2__ENABLED_LOGIN_METHODS", "3")
  1083. os.Setenv("SFTPGO_HTTPD__BINDINGS__2__RENDER_OPENAPI", "0")
  1084. os.Setenv("SFTPGO_HTTPD__BINDINGS__2__ENABLE_HTTPS", "1 ")
  1085. os.Setenv("SFTPGO_HTTPD__BINDINGS__2__MIN_TLS_VERSION", "13")
  1086. os.Setenv("SFTPGO_HTTPD__BINDINGS__2__CLIENT_AUTH_TYPE", "1")
  1087. os.Setenv("SFTPGO_HTTPD__BINDINGS__2__TLS_CIPHER_SUITES", " TLS_AES_256_GCM_SHA384 , TLS_CHACHA20_POLY1305_SHA256")
  1088. os.Setenv("SFTPGO_HTTPD__BINDINGS__2__PROXY_ALLOWED", " 192.168.9.1 , 172.16.25.0/24")
  1089. os.Setenv("SFTPGO_HTTPD__BINDINGS__2__CLIENT_IP_PROXY_HEADER", "X-Real-IP")
  1090. os.Setenv("SFTPGO_HTTPD__BINDINGS__2__CLIENT_IP_HEADER_DEPTH", "2")
  1091. os.Setenv("SFTPGO_HTTPD__BINDINGS__2__HIDE_LOGIN_URL", "3")
  1092. os.Setenv("SFTPGO_HTTPD__BINDINGS__2__WEB_CLIENT_INTEGRATIONS__1__URL", "http://127.0.0.1/")
  1093. os.Setenv("SFTPGO_HTTPD__BINDINGS__2__WEB_CLIENT_INTEGRATIONS__1__FILE_EXTENSIONS", ".pdf, .txt")
  1094. os.Setenv("SFTPGO_HTTPD__BINDINGS__2__WEB_CLIENT_INTEGRATIONS__2__URL", "http://127.0.1.1/")
  1095. os.Setenv("SFTPGO_HTTPD__BINDINGS__2__WEB_CLIENT_INTEGRATIONS__3__FILE_EXTENSIONS", ".jpg, .txt")
  1096. os.Setenv("SFTPGO_HTTPD__BINDINGS__2__OIDC__CLIENT_ID", "client id")
  1097. os.Setenv("SFTPGO_HTTPD__BINDINGS__2__OIDC__CLIENT_SECRET", "client secret")
  1098. os.Setenv("SFTPGO_HTTPD__BINDINGS__2__OIDC__CONFIG_URL", "config url")
  1099. os.Setenv("SFTPGO_HTTPD__BINDINGS__2__OIDC__REDIRECT_BASE_URL", "redirect base url")
  1100. os.Setenv("SFTPGO_HTTPD__BINDINGS__2__OIDC__USERNAME_FIELD", "preferred_username")
  1101. os.Setenv("SFTPGO_HTTPD__BINDINGS__2__OIDC__ROLE_FIELD", "sftpgo_role")
  1102. os.Setenv("SFTPGO_HTTPD__BINDINGS__2__OIDC__SCOPES", "openid")
  1103. os.Setenv("SFTPGO_HTTPD__BINDINGS__2__OIDC__IMPLICIT_ROLES", "1")
  1104. os.Setenv("SFTPGO_HTTPD__BINDINGS__2__OIDC__CUSTOM_FIELDS", "field1,field2")
  1105. os.Setenv("SFTPGO_HTTPD__BINDINGS__2__OIDC__INSECURE_SKIP_SIGNATURE_CHECK", "1")
  1106. os.Setenv("SFTPGO_HTTPD__BINDINGS__2__OIDC__DEBUG", "1")
  1107. os.Setenv("SFTPGO_HTTPD__BINDINGS__2__SECURITY__ENABLED", "true")
  1108. os.Setenv("SFTPGO_HTTPD__BINDINGS__2__SECURITY__ALLOWED_HOSTS", "*.example.com,*.example.net")
  1109. os.Setenv("SFTPGO_HTTPD__BINDINGS__2__SECURITY__ALLOWED_HOSTS_ARE_REGEX", "1")
  1110. os.Setenv("SFTPGO_HTTPD__BINDINGS__2__SECURITY__HOSTS_PROXY_HEADERS", "X-Forwarded-Host")
  1111. os.Setenv("SFTPGO_HTTPD__BINDINGS__2__SECURITY__HTTPS_REDIRECT", "1")
  1112. os.Setenv("SFTPGO_HTTPD__BINDINGS__2__SECURITY__HTTPS_HOST", "www.example.com")
  1113. os.Setenv("SFTPGO_HTTPD__BINDINGS__2__SECURITY__HTTPS_PROXY_HEADERS__1__KEY", "X-Forwarded-Proto")
  1114. os.Setenv("SFTPGO_HTTPD__BINDINGS__2__SECURITY__HTTPS_PROXY_HEADERS__1__VALUE", "https")
  1115. os.Setenv("SFTPGO_HTTPD__BINDINGS__2__SECURITY__STS_SECONDS", "31536000")
  1116. os.Setenv("SFTPGO_HTTPD__BINDINGS__2__SECURITY__STS_INCLUDE_SUBDOMAINS", "false")
  1117. os.Setenv("SFTPGO_HTTPD__BINDINGS__2__SECURITY__STS_PRELOAD", "0")
  1118. os.Setenv("SFTPGO_HTTPD__BINDINGS__2__SECURITY__CONTENT_TYPE_NOSNIFF", "t")
  1119. os.Setenv("SFTPGO_HTTPD__BINDINGS__2__SECURITY__CONTENT_SECURITY_POLICY", "script-src $NONCE")
  1120. os.Setenv("SFTPGO_HTTPD__BINDINGS__2__SECURITY__PERMISSIONS_POLICY", "fullscreen=(), geolocation=()")
  1121. os.Setenv("SFTPGO_HTTPD__BINDINGS__2__SECURITY__CROSS_ORIGIN_OPENER_POLICY", "same-origin")
  1122. os.Setenv("SFTPGO_HTTPD__BINDINGS__2__SECURITY__EXPECT_CT_HEADER", `max-age=86400, enforce, report-uri="https://foo.example/report"`)
  1123. os.Setenv("SFTPGO_HTTPD__BINDINGS__2__EXTRA_CSS__0__PATH", "path1")
  1124. os.Setenv("SFTPGO_HTTPD__BINDINGS__2__EXTRA_CSS__1__PATH", "path2")
  1125. os.Setenv("SFTPGO_HTTPD__BINDINGS__2__BRANDING__WEB_ADMIN__FAVICON_PATH", "favicon.ico")
  1126. os.Setenv("SFTPGO_HTTPD__BINDINGS__2__BRANDING__WEB_CLIENT__LOGO_PATH", "logo.png")
  1127. os.Setenv("SFTPGO_HTTPD__BINDINGS__2__BRANDING__WEB_ADMIN__LOGIN_IMAGE_PATH", "login_image.png")
  1128. os.Setenv("SFTPGO_HTTPD__BINDINGS__2__BRANDING__WEB_CLIENT__DISCLAIMER_NAME", "disclaimer")
  1129. os.Setenv("SFTPGO_HTTPD__BINDINGS__2__BRANDING__WEB_ADMIN__DISCLAIMER_PATH", "disclaimer.html")
  1130. os.Setenv("SFTPGO_HTTPD__BINDINGS__2__BRANDING__WEB_CLIENT__DEFAULT_CSS", "default.css")
  1131. os.Setenv("SFTPGO_HTTPD__BINDINGS__2__BRANDING__WEB_CLIENT__EXTRA_CSS", "1.css,2.css")
  1132. os.Setenv("SFTPGO_HTTPD__BINDINGS__2__CERTIFICATE_FILE", "httpd.crt")
  1133. os.Setenv("SFTPGO_HTTPD__BINDINGS__2__CERTIFICATE_KEY_FILE", "httpd.key")
  1134. t.Cleanup(func() {
  1135. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__0__ADDRESS")
  1136. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__0__PORT")
  1137. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__0__TLS_CIPHER_SUITES")
  1138. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__1__ADDRESS")
  1139. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__1__PORT")
  1140. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__1__ENABLE_HTTPS")
  1141. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__1__HIDE_LOGIN_URL")
  1142. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__1__BRANDING__WEB_ADMIN__NAME")
  1143. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__1__BRANDING__WEB_CLIENT__SHORT_NAME")
  1144. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__1__EXTRA_CSS__0__PATH")
  1145. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__2__ADDRESS")
  1146. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__2__PORT")
  1147. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__2__ENABLE_HTTPS")
  1148. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__2__MIN_TLS_VERSION")
  1149. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__2__ENABLE_WEB_ADMIN")
  1150. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__2__ENABLE_WEB_CLIENT")
  1151. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__2__ENABLE_REST_API")
  1152. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__2__ENABLED_LOGIN_METHODS")
  1153. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__2__RENDER_OPENAPI")
  1154. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__2__CLIENT_AUTH_TYPE")
  1155. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__2__TLS_CIPHER_SUITES")
  1156. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__2__PROXY_ALLOWED")
  1157. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__2__CLIENT_IP_PROXY_HEADER")
  1158. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__2__CLIENT_IP_HEADER_DEPTH")
  1159. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__2__HIDE_LOGIN_URL")
  1160. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__2__WEB_CLIENT_INTEGRATIONS__1__URL")
  1161. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__2__WEB_CLIENT_INTEGRATIONS__1__FILE_EXTENSIONS")
  1162. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__2__WEB_CLIENT_INTEGRATIONS__2__URL")
  1163. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__2__WEB_CLIENT_INTEGRATIONS__3__FILE_EXTENSIONS")
  1164. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__2__OIDC__CLIENT_ID")
  1165. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__2__OIDC__CLIENT_SECRET")
  1166. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__2__OIDC__CONFIG_URL")
  1167. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__2__OIDC__REDIRECT_BASE_URL")
  1168. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__2__OIDC__USERNAME_FIELD")
  1169. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__2__OIDC__ROLE_FIELD")
  1170. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__2__OIDC__SCOPES")
  1171. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__2__OIDC__IMPLICIT_ROLES")
  1172. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__2__OIDC__CUSTOM_FIELDS")
  1173. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__2__OIDC__INSECURE_SKIP_SIGNATURE_CHECK")
  1174. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__2__OIDC__DEBUG")
  1175. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__2__SECURITY__ENABLED")
  1176. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__2__SECURITY__ALLOWED_HOSTS")
  1177. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__2__SECURITY__ALLOWED_HOSTS_ARE_REGEX")
  1178. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__2__SECURITY__HOSTS_PROXY_HEADERS")
  1179. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__2__SECURITY__HTTPS_REDIRECT")
  1180. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__2__SECURITY__HTTPS_HOST")
  1181. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__2__SECURITY__HTTPS_PROXY_HEADERS__1__KEY")
  1182. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__2__SECURITY__HTTPS_PROXY_HEADERS__1__VALUE")
  1183. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__2__SECURITY__STS_SECONDS")
  1184. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__2__SECURITY__STS_INCLUDE_SUBDOMAINS")
  1185. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__2__SECURITY__STS_PRELOAD")
  1186. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__2__SECURITY__CONTENT_TYPE_NOSNIFF")
  1187. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__2__SECURITY__CONTENT_SECURITY_POLICY")
  1188. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__2__SECURITY__PERMISSIONS_POLICY")
  1189. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__2__SECURITY__CROSS_ORIGIN_OPENER_POLICY")
  1190. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__2__SECURITY__EXPECT_CT_HEADER")
  1191. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__2__EXTRA_CSS__0__PATH")
  1192. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__2__EXTRA_CSS__1__PATH")
  1193. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__2__BRANDING__WEB_ADMIN__FAVICON_PATH")
  1194. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__2__BRANDING__WEB_CLIENT__LOGO_PATH")
  1195. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__2__BRANDING__WEB_ADMIN__LOGIN_IMAGE_PATH")
  1196. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__2__BRANDING__WEB_CLIENT__DISCLAIMER_NAME")
  1197. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__2__BRANDING__WEB_ADMIN__DISCLAIMER_PATH")
  1198. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__2__BRANDING__WEB_CLIENT__DEFAULT_CSS")
  1199. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__2__BRANDING__WEB_CLIENT__EXTRA_CSS")
  1200. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__2__CERTIFICATE_FILE")
  1201. os.Unsetenv("SFTPGO_HTTPD__BINDINGS__2__CERTIFICATE_KEY_FILE")
  1202. })
  1203. err := config.LoadConfig(configDir, "")
  1204. assert.NoError(t, err)
  1205. bindings := config.GetHTTPDConfig().Bindings
  1206. require.Len(t, bindings, 3)
  1207. require.Equal(t, 0, bindings[0].Port)
  1208. require.Equal(t, sockPath, bindings[0].Address)
  1209. require.False(t, bindings[0].EnableHTTPS)
  1210. require.Equal(t, 12, bindings[0].MinTLSVersion)
  1211. require.True(t, bindings[0].EnableWebAdmin)
  1212. require.True(t, bindings[0].EnableWebClient)
  1213. require.True(t, bindings[0].EnableRESTAPI)
  1214. require.Equal(t, 0, bindings[0].EnabledLoginMethods)
  1215. require.True(t, bindings[0].RenderOpenAPI)
  1216. require.Len(t, bindings[0].TLSCipherSuites, 1)
  1217. require.Empty(t, bindings[0].OIDC.ConfigURL)
  1218. require.Equal(t, "TLS_AES_128_GCM_SHA256", bindings[0].TLSCipherSuites[0])
  1219. require.Equal(t, 0, bindings[0].HideLoginURL)
  1220. require.False(t, bindings[0].Security.Enabled)
  1221. require.Equal(t, 0, bindings[0].ClientIPHeaderDepth)
  1222. require.Len(t, bindings[0].OIDC.Scopes, 3)
  1223. require.False(t, bindings[0].OIDC.InsecureSkipSignatureCheck)
  1224. require.False(t, bindings[0].OIDC.Debug)
  1225. require.Equal(t, 8000, bindings[1].Port)
  1226. require.Equal(t, "127.0.0.1", bindings[1].Address)
  1227. require.False(t, bindings[1].EnableHTTPS)
  1228. require.Equal(t, 12, bindings[0].MinTLSVersion)
  1229. require.True(t, bindings[1].EnableWebAdmin)
  1230. require.True(t, bindings[1].EnableWebClient)
  1231. require.True(t, bindings[1].EnableRESTAPI)
  1232. require.Equal(t, 0, bindings[1].EnabledLoginMethods)
  1233. require.True(t, bindings[1].RenderOpenAPI)
  1234. require.Nil(t, bindings[1].TLSCipherSuites)
  1235. require.Equal(t, 1, bindings[1].HideLoginURL)
  1236. require.Empty(t, bindings[1].OIDC.ClientID)
  1237. require.Len(t, bindings[1].OIDC.Scopes, 3)
  1238. require.False(t, bindings[1].OIDC.InsecureSkipSignatureCheck)
  1239. require.False(t, bindings[1].OIDC.Debug)
  1240. require.False(t, bindings[1].Security.Enabled)
  1241. require.Equal(t, "Web Admin", bindings[1].Branding.WebAdmin.Name)
  1242. require.Equal(t, "WebClient", bindings[1].Branding.WebClient.ShortName)
  1243. require.Equal(t, 0, bindings[1].ClientIPHeaderDepth)
  1244. require.Equal(t, 9000, bindings[2].Port)
  1245. require.Equal(t, "127.0.1.1", bindings[2].Address)
  1246. require.True(t, bindings[2].EnableHTTPS)
  1247. require.Equal(t, 13, bindings[2].MinTLSVersion)
  1248. require.False(t, bindings[2].EnableWebAdmin)
  1249. require.False(t, bindings[2].EnableWebClient)
  1250. require.False(t, bindings[2].EnableRESTAPI)
  1251. require.Equal(t, 3, bindings[2].EnabledLoginMethods)
  1252. require.False(t, bindings[2].RenderOpenAPI)
  1253. require.Equal(t, 1, bindings[2].ClientAuthType)
  1254. require.Len(t, bindings[2].TLSCipherSuites, 2)
  1255. require.Equal(t, "TLS_AES_256_GCM_SHA384", bindings[2].TLSCipherSuites[0])
  1256. require.Equal(t, "TLS_CHACHA20_POLY1305_SHA256", bindings[2].TLSCipherSuites[1])
  1257. require.Len(t, bindings[2].ProxyAllowed, 2)
  1258. require.Equal(t, "192.168.9.1", bindings[2].ProxyAllowed[0])
  1259. require.Equal(t, "172.16.25.0/24", bindings[2].ProxyAllowed[1])
  1260. require.Equal(t, "X-Real-IP", bindings[2].ClientIPProxyHeader)
  1261. require.Equal(t, 2, bindings[2].ClientIPHeaderDepth)
  1262. require.Equal(t, 3, bindings[2].HideLoginURL)
  1263. require.Len(t, bindings[2].WebClientIntegrations, 1)
  1264. require.Equal(t, "http://127.0.0.1/", bindings[2].WebClientIntegrations[0].URL)
  1265. require.Equal(t, []string{".pdf", ".txt"}, bindings[2].WebClientIntegrations[0].FileExtensions)
  1266. require.Equal(t, "client id", bindings[2].OIDC.ClientID)
  1267. require.Equal(t, "client secret", bindings[2].OIDC.ClientSecret)
  1268. require.Equal(t, "config url", bindings[2].OIDC.ConfigURL)
  1269. require.Equal(t, "redirect base url", bindings[2].OIDC.RedirectBaseURL)
  1270. require.Equal(t, "preferred_username", bindings[2].OIDC.UsernameField)
  1271. require.Equal(t, "sftpgo_role", bindings[2].OIDC.RoleField)
  1272. require.Len(t, bindings[2].OIDC.Scopes, 1)
  1273. require.Equal(t, "openid", bindings[2].OIDC.Scopes[0])
  1274. require.True(t, bindings[2].OIDC.ImplicitRoles)
  1275. require.Len(t, bindings[2].OIDC.CustomFields, 2)
  1276. require.Equal(t, "field1", bindings[2].OIDC.CustomFields[0])
  1277. require.Equal(t, "field2", bindings[2].OIDC.CustomFields[1])
  1278. require.True(t, bindings[2].OIDC.InsecureSkipSignatureCheck)
  1279. require.True(t, bindings[2].OIDC.Debug)
  1280. require.True(t, bindings[2].Security.Enabled)
  1281. require.Len(t, bindings[2].Security.AllowedHosts, 2)
  1282. require.Equal(t, "*.example.com", bindings[2].Security.AllowedHosts[0])
  1283. require.Equal(t, "*.example.net", bindings[2].Security.AllowedHosts[1])
  1284. require.True(t, bindings[2].Security.AllowedHostsAreRegex)
  1285. require.Len(t, bindings[2].Security.HostsProxyHeaders, 1)
  1286. require.Equal(t, "X-Forwarded-Host", bindings[2].Security.HostsProxyHeaders[0])
  1287. require.True(t, bindings[2].Security.HTTPSRedirect)
  1288. require.Equal(t, "www.example.com", bindings[2].Security.HTTPSHost)
  1289. require.Len(t, bindings[2].Security.HTTPSProxyHeaders, 1)
  1290. require.Equal(t, "X-Forwarded-Proto", bindings[2].Security.HTTPSProxyHeaders[0].Key)
  1291. require.Equal(t, "https", bindings[2].Security.HTTPSProxyHeaders[0].Value)
  1292. require.Equal(t, int64(31536000), bindings[2].Security.STSSeconds)
  1293. require.False(t, bindings[2].Security.STSIncludeSubdomains)
  1294. require.False(t, bindings[2].Security.STSPreload)
  1295. require.True(t, bindings[2].Security.ContentTypeNosniff)
  1296. require.Equal(t, "script-src $NONCE", bindings[2].Security.ContentSecurityPolicy)
  1297. require.Equal(t, "fullscreen=(), geolocation=()", bindings[2].Security.PermissionsPolicy)
  1298. require.Equal(t, "same-origin", bindings[2].Security.CrossOriginOpenerPolicy)
  1299. require.Equal(t, `max-age=86400, enforce, report-uri="https://foo.example/report"`, bindings[2].Security.ExpectCTHeader)
  1300. require.Equal(t, "favicon.ico", bindings[2].Branding.WebAdmin.FaviconPath)
  1301. require.Equal(t, "logo.png", bindings[2].Branding.WebClient.LogoPath)
  1302. require.Equal(t, "login_image.png", bindings[2].Branding.WebAdmin.LoginImagePath)
  1303. require.Equal(t, "disclaimer", bindings[2].Branding.WebClient.DisclaimerName)
  1304. require.Equal(t, "disclaimer.html", bindings[2].Branding.WebAdmin.DisclaimerPath)
  1305. require.Equal(t, "default.css", bindings[2].Branding.WebClient.DefaultCSS)
  1306. require.Len(t, bindings[2].Branding.WebClient.ExtraCSS, 2)
  1307. require.Equal(t, "1.css", bindings[2].Branding.WebClient.ExtraCSS[0])
  1308. require.Equal(t, "2.css", bindings[2].Branding.WebClient.ExtraCSS[1])
  1309. require.Equal(t, "httpd.crt", bindings[2].CertificateFile)
  1310. require.Equal(t, "httpd.key", bindings[2].CertificateKeyFile)
  1311. }
  1312. func TestHTTPClientCertificatesFromEnv(t *testing.T) {
  1313. reset()
  1314. confName := tempConfigName + ".json"
  1315. configFilePath := filepath.Join(configDir, confName)
  1316. err := config.LoadConfig(configDir, "")
  1317. assert.NoError(t, err)
  1318. httpConf := config.GetHTTPConfig()
  1319. httpConf.Certificates = append(httpConf.Certificates, httpclient.TLSKeyPair{
  1320. Cert: "cert",
  1321. Key: "key",
  1322. })
  1323. c := make(map[string]httpclient.Config)
  1324. c["http"] = httpConf
  1325. jsonConf, err := json.Marshal(c)
  1326. require.NoError(t, err)
  1327. err = os.WriteFile(configFilePath, jsonConf, os.ModePerm)
  1328. require.NoError(t, err)
  1329. err = config.LoadConfig(configDir, confName)
  1330. require.NoError(t, err)
  1331. require.Len(t, config.GetHTTPConfig().Certificates, 1)
  1332. require.Equal(t, "cert", config.GetHTTPConfig().Certificates[0].Cert)
  1333. require.Equal(t, "key", config.GetHTTPConfig().Certificates[0].Key)
  1334. os.Setenv("SFTPGO_HTTP__CERTIFICATES__0__CERT", "cert0")
  1335. os.Setenv("SFTPGO_HTTP__CERTIFICATES__0__KEY", "key0")
  1336. os.Setenv("SFTPGO_HTTP__CERTIFICATES__8__CERT", "cert8")
  1337. os.Setenv("SFTPGO_HTTP__CERTIFICATES__9__CERT", "cert9")
  1338. os.Setenv("SFTPGO_HTTP__CERTIFICATES__9__KEY", "key9")
  1339. t.Cleanup(func() {
  1340. os.Unsetenv("SFTPGO_HTTP__CERTIFICATES__0__CERT")
  1341. os.Unsetenv("SFTPGO_HTTP__CERTIFICATES__0__KEY")
  1342. os.Unsetenv("SFTPGO_HTTP__CERTIFICATES__8__CERT")
  1343. os.Unsetenv("SFTPGO_HTTP__CERTIFICATES__9__CERT")
  1344. os.Unsetenv("SFTPGO_HTTP__CERTIFICATES__9__KEY")
  1345. })
  1346. err = config.LoadConfig(configDir, confName)
  1347. require.NoError(t, err)
  1348. require.Len(t, config.GetHTTPConfig().Certificates, 2)
  1349. require.Equal(t, "cert0", config.GetHTTPConfig().Certificates[0].Cert)
  1350. require.Equal(t, "key0", config.GetHTTPConfig().Certificates[0].Key)
  1351. require.Equal(t, "cert9", config.GetHTTPConfig().Certificates[1].Cert)
  1352. require.Equal(t, "key9", config.GetHTTPConfig().Certificates[1].Key)
  1353. err = os.Remove(configFilePath)
  1354. assert.NoError(t, err)
  1355. config.Init()
  1356. err = config.LoadConfig(configDir, "")
  1357. require.NoError(t, err)
  1358. require.Len(t, config.GetHTTPConfig().Certificates, 2)
  1359. require.Equal(t, "cert0", config.GetHTTPConfig().Certificates[0].Cert)
  1360. require.Equal(t, "key0", config.GetHTTPConfig().Certificates[0].Key)
  1361. require.Equal(t, "cert9", config.GetHTTPConfig().Certificates[1].Cert)
  1362. require.Equal(t, "key9", config.GetHTTPConfig().Certificates[1].Key)
  1363. }
  1364. func TestHTTPClientHeadersFromEnv(t *testing.T) {
  1365. reset()
  1366. confName := tempConfigName + ".json"
  1367. configFilePath := filepath.Join(configDir, confName)
  1368. err := config.LoadConfig(configDir, "")
  1369. assert.NoError(t, err)
  1370. httpConf := config.GetHTTPConfig()
  1371. httpConf.Headers = append(httpConf.Headers, httpclient.Header{
  1372. Key: "key",
  1373. Value: "value",
  1374. URL: "url",
  1375. })
  1376. c := make(map[string]httpclient.Config)
  1377. c["http"] = httpConf
  1378. jsonConf, err := json.Marshal(c)
  1379. require.NoError(t, err)
  1380. err = os.WriteFile(configFilePath, jsonConf, os.ModePerm)
  1381. require.NoError(t, err)
  1382. err = config.LoadConfig(configDir, confName)
  1383. require.NoError(t, err)
  1384. require.Len(t, config.GetHTTPConfig().Headers, 1)
  1385. require.Equal(t, "key", config.GetHTTPConfig().Headers[0].Key)
  1386. require.Equal(t, "value", config.GetHTTPConfig().Headers[0].Value)
  1387. require.Equal(t, "url", config.GetHTTPConfig().Headers[0].URL)
  1388. os.Setenv("SFTPGO_HTTP__HEADERS__0__KEY", "key0")
  1389. os.Setenv("SFTPGO_HTTP__HEADERS__0__VALUE", "value0")
  1390. os.Setenv("SFTPGO_HTTP__HEADERS__0__URL", "url0")
  1391. os.Setenv("SFTPGO_HTTP__HEADERS__8__KEY", "key8")
  1392. os.Setenv("SFTPGO_HTTP__HEADERS__9__KEY", "key9")
  1393. os.Setenv("SFTPGO_HTTP__HEADERS__9__VALUE", "value9")
  1394. os.Setenv("SFTPGO_HTTP__HEADERS__9__URL", "url9")
  1395. t.Cleanup(func() {
  1396. os.Unsetenv("SFTPGO_HTTP__HEADERS__0__KEY")
  1397. os.Unsetenv("SFTPGO_HTTP__HEADERS__0__VALUE")
  1398. os.Unsetenv("SFTPGO_HTTP__HEADERS__0__URL")
  1399. os.Unsetenv("SFTPGO_HTTP__HEADERS__8__KEY")
  1400. os.Unsetenv("SFTPGO_HTTP__HEADERS__9__KEY")
  1401. os.Unsetenv("SFTPGO_HTTP__HEADERS__9__VALUE")
  1402. os.Unsetenv("SFTPGO_HTTP__HEADERS__9__URL")
  1403. })
  1404. err = config.LoadConfig(configDir, confName)
  1405. require.NoError(t, err)
  1406. require.Len(t, config.GetHTTPConfig().Headers, 2)
  1407. require.Equal(t, "key0", config.GetHTTPConfig().Headers[0].Key)
  1408. require.Equal(t, "value0", config.GetHTTPConfig().Headers[0].Value)
  1409. require.Equal(t, "url0", config.GetHTTPConfig().Headers[0].URL)
  1410. require.Equal(t, "key9", config.GetHTTPConfig().Headers[1].Key)
  1411. require.Equal(t, "value9", config.GetHTTPConfig().Headers[1].Value)
  1412. require.Equal(t, "url9", config.GetHTTPConfig().Headers[1].URL)
  1413. err = os.Remove(configFilePath)
  1414. assert.NoError(t, err)
  1415. config.Init()
  1416. err = config.LoadConfig(configDir, "")
  1417. require.NoError(t, err)
  1418. require.Len(t, config.GetHTTPConfig().Headers, 2)
  1419. require.Equal(t, "key0", config.GetHTTPConfig().Headers[0].Key)
  1420. require.Equal(t, "value0", config.GetHTTPConfig().Headers[0].Value)
  1421. require.Equal(t, "url0", config.GetHTTPConfig().Headers[0].URL)
  1422. require.Equal(t, "key9", config.GetHTTPConfig().Headers[1].Key)
  1423. require.Equal(t, "value9", config.GetHTTPConfig().Headers[1].Value)
  1424. require.Equal(t, "url9", config.GetHTTPConfig().Headers[1].URL)
  1425. }
  1426. func TestConfigFromEnv(t *testing.T) {
  1427. reset()
  1428. os.Setenv("SFTPGO_SFTPD__BINDINGS__0__ADDRESS", "127.0.0.1")
  1429. os.Setenv("SFTPGO_WEBDAVD__BINDINGS__0__PORT", "12000")
  1430. os.Setenv("SFTPGO_DATA_PROVIDER__PASSWORD_HASHING__ARGON2_OPTIONS__ITERATIONS", "41")
  1431. os.Setenv("SFTPGO_DATA_PROVIDER__POOL_SIZE", "10")
  1432. os.Setenv("SFTPGO_DATA_PROVIDER__IS_SHARED", "1")
  1433. os.Setenv("SFTPGO_DATA_PROVIDER__ACTIONS__EXECUTE_ON", "add")
  1434. os.Setenv("SFTPGO_KMS__SECRETS__URL", "local")
  1435. os.Setenv("SFTPGO_KMS__SECRETS__MASTER_KEY_PATH", "path")
  1436. os.Setenv("SFTPGO_TELEMETRY__TLS_CIPHER_SUITES", "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA")
  1437. os.Setenv("SFTPGO_HTTPD__SETUP__INSTALLATION_CODE", "123")
  1438. os.Setenv("SFTPGO_ACME__HTTP01_CHALLENGE__PORT", "5002")
  1439. t.Cleanup(func() {
  1440. os.Unsetenv("SFTPGO_SFTPD__BINDINGS__0__ADDRESS")
  1441. os.Unsetenv("SFTPGO_WEBDAVD__BINDINGS__0__PORT")
  1442. os.Unsetenv("SFTPGO_DATA_PROVIDER__PASSWORD_HASHING__ARGON2_OPTIONS__ITERATIONS")
  1443. os.Unsetenv("SFTPGO_DATA_PROVIDER__POOL_SIZE")
  1444. os.Unsetenv("SFTPGO_DATA_PROVIDER__IS_SHARED")
  1445. os.Unsetenv("SFTPGO_DATA_PROVIDER__ACTIONS__EXECUTE_ON")
  1446. os.Unsetenv("SFTPGO_KMS__SECRETS__URL")
  1447. os.Unsetenv("SFTPGO_KMS__SECRETS__MASTER_KEY_PATH")
  1448. os.Unsetenv("SFTPGO_TELEMETRY__TLS_CIPHER_SUITES")
  1449. os.Unsetenv("SFTPGO_HTTPD__SETUP__INSTALLATION_CODE")
  1450. os.Unsetenv("SFTPGO_ACME__HTTP01_CHALLENGE_PORT")
  1451. })
  1452. err := config.LoadConfig(".", "invalid config")
  1453. assert.NoError(t, err)
  1454. sftpdConfig := config.GetSFTPDConfig()
  1455. assert.Equal(t, "127.0.0.1", sftpdConfig.Bindings[0].Address)
  1456. assert.Equal(t, 12000, config.GetWebDAVDConfig().Bindings[0].Port)
  1457. dataProviderConf := config.GetProviderConf()
  1458. assert.Equal(t, uint32(41), dataProviderConf.PasswordHashing.Argon2Options.Iterations)
  1459. assert.Equal(t, 10, dataProviderConf.PoolSize)
  1460. assert.Equal(t, 1, dataProviderConf.IsShared)
  1461. assert.Len(t, dataProviderConf.Actions.ExecuteOn, 1)
  1462. assert.Contains(t, dataProviderConf.Actions.ExecuteOn, "add")
  1463. kmsConfig := config.GetKMSConfig()
  1464. assert.Equal(t, "local", kmsConfig.Secrets.URL)
  1465. assert.Equal(t, "path", kmsConfig.Secrets.MasterKeyPath)
  1466. telemetryConfig := config.GetTelemetryConfig()
  1467. assert.Len(t, telemetryConfig.TLSCipherSuites, 2)
  1468. assert.Equal(t, "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA", telemetryConfig.TLSCipherSuites[0])
  1469. assert.Equal(t, "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA", telemetryConfig.TLSCipherSuites[1])
  1470. assert.Equal(t, "123", config.GetHTTPDConfig().Setup.InstallationCode)
  1471. acmeConfig := config.GetACMEConfig()
  1472. assert.Equal(t, 5002, acmeConfig.HTTP01Challenge.Port)
  1473. }