config_test.go 70 KB

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