| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046 |
- // Copyright (C) 2019-2022 Nicola Murino
- //
- // This program is free software: you can redistribute it and/or modify
- // it under the terms of the GNU Affero General Public License as published
- // by the Free Software Foundation, version 3.
- //
- // This program is distributed in the hope that it will be useful,
- // but WITHOUT ANY WARRANTY; without even the implied warranty of
- // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- // GNU Affero General Public License for more details.
- //
- // You should have received a copy of the GNU Affero General Public License
- // along with this program. If not, see <https://www.gnu.org/licenses/>.
- // Package config manages the configuration
- package config
- import (
- "errors"
- "fmt"
- "os"
- "path/filepath"
- "strconv"
- "strings"
- "github.com/spf13/viper"
- "github.com/drakkan/sftpgo/v2/internal/acme"
- "github.com/drakkan/sftpgo/v2/internal/command"
- "github.com/drakkan/sftpgo/v2/internal/common"
- "github.com/drakkan/sftpgo/v2/internal/dataprovider"
- "github.com/drakkan/sftpgo/v2/internal/ftpd"
- "github.com/drakkan/sftpgo/v2/internal/httpclient"
- "github.com/drakkan/sftpgo/v2/internal/httpd"
- "github.com/drakkan/sftpgo/v2/internal/kms"
- "github.com/drakkan/sftpgo/v2/internal/logger"
- "github.com/drakkan/sftpgo/v2/internal/mfa"
- "github.com/drakkan/sftpgo/v2/internal/plugin"
- "github.com/drakkan/sftpgo/v2/internal/sftpd"
- "github.com/drakkan/sftpgo/v2/internal/smtp"
- "github.com/drakkan/sftpgo/v2/internal/telemetry"
- "github.com/drakkan/sftpgo/v2/internal/util"
- "github.com/drakkan/sftpgo/v2/internal/version"
- "github.com/drakkan/sftpgo/v2/internal/webdavd"
- )
- const (
- logSender = "config"
- // configName defines the name for config file.
- // This name does not include the extension, viper will search for files
- // with supported extensions such as "sftpgo.json", "sftpgo.yaml" and so on
- configName = "sftpgo"
- // ConfigEnvPrefix defines a prefix that environment variables will use
- configEnvPrefix = "sftpgo"
- )
- var (
- globalConf globalConfig
- defaultSFTPDBanner = fmt.Sprintf("SFTPGo_%v", version.Get().Version)
- defaultFTPDBanner = fmt.Sprintf("SFTPGo %v ready", version.Get().Version)
- defaultInstallCodeHint = "Installation code"
- defaultSFTPDBinding = sftpd.Binding{
- Address: "",
- Port: 2022,
- ApplyProxyConfig: true,
- }
- defaultFTPDBinding = ftpd.Binding{
- Address: "",
- Port: 0,
- ApplyProxyConfig: true,
- TLSMode: 0,
- CertificateFile: "",
- CertificateKeyFile: "",
- MinTLSVersion: 12,
- ForcePassiveIP: "",
- PassiveIPOverrides: nil,
- ClientAuthType: 0,
- TLSCipherSuites: nil,
- PassiveConnectionsSecurity: 0,
- ActiveConnectionsSecurity: 0,
- Debug: false,
- }
- defaultWebDAVDBinding = webdavd.Binding{
- Address: "",
- Port: 0,
- EnableHTTPS: false,
- CertificateFile: "",
- CertificateKeyFile: "",
- MinTLSVersion: 12,
- ClientAuthType: 0,
- TLSCipherSuites: nil,
- Prefix: "",
- ProxyAllowed: nil,
- ClientIPProxyHeader: "",
- ClientIPHeaderDepth: 0,
- }
- defaultHTTPDBinding = httpd.Binding{
- Address: "",
- Port: 8080,
- EnableWebAdmin: true,
- EnableWebClient: true,
- EnabledLoginMethods: 0,
- EnableHTTPS: false,
- CertificateFile: "",
- CertificateKeyFile: "",
- MinTLSVersion: 12,
- ClientAuthType: 0,
- TLSCipherSuites: nil,
- ProxyAllowed: nil,
- ClientIPProxyHeader: "",
- ClientIPHeaderDepth: 0,
- HideLoginURL: 0,
- RenderOpenAPI: true,
- WebClientIntegrations: nil,
- OIDC: httpd.OIDC{
- ClientID: "",
- ClientSecret: "",
- ConfigURL: "",
- RedirectBaseURL: "",
- UsernameField: "",
- RoleField: "",
- ImplicitRoles: false,
- Scopes: []string{"openid", "profile", "email"},
- CustomFields: []string{},
- Debug: false,
- },
- Security: httpd.SecurityConf{
- Enabled: false,
- AllowedHosts: nil,
- AllowedHostsAreRegex: false,
- HostsProxyHeaders: nil,
- HTTPSRedirect: false,
- HTTPSHost: "",
- HTTPSProxyHeaders: nil,
- STSSeconds: 0,
- STSIncludeSubdomains: false,
- STSPreload: false,
- ContentTypeNosniff: false,
- ContentSecurityPolicy: "",
- PermissionsPolicy: "",
- CrossOriginOpenerPolicy: "",
- ExpectCTHeader: "",
- },
- Branding: httpd.Branding{},
- }
- defaultRateLimiter = common.RateLimiterConfig{
- Average: 0,
- Period: 1000,
- Burst: 1,
- Type: 2,
- Protocols: []string{common.ProtocolSSH, common.ProtocolFTP, common.ProtocolWebDAV, common.ProtocolHTTP},
- AllowList: []string{},
- GenerateDefenderEvents: false,
- EntriesSoftLimit: 100,
- EntriesHardLimit: 150,
- }
- defaultTOTP = mfa.TOTPConfig{
- Name: "Default",
- Issuer: "SFTPGo",
- Algo: mfa.TOTPAlgoSHA1,
- }
- )
- type globalConfig struct {
- Common common.Configuration `json:"common" mapstructure:"common"`
- ACME acme.Configuration `json:"acme" mapstructure:"acme"`
- SFTPD sftpd.Configuration `json:"sftpd" mapstructure:"sftpd"`
- FTPD ftpd.Configuration `json:"ftpd" mapstructure:"ftpd"`
- WebDAVD webdavd.Configuration `json:"webdavd" mapstructure:"webdavd"`
- ProviderConf dataprovider.Config `json:"data_provider" mapstructure:"data_provider"`
- HTTPDConfig httpd.Conf `json:"httpd" mapstructure:"httpd"`
- HTTPConfig httpclient.Config `json:"http" mapstructure:"http"`
- CommandConfig command.Config `json:"command" mapstructure:"command"`
- KMSConfig kms.Configuration `json:"kms" mapstructure:"kms"`
- MFAConfig mfa.Config `json:"mfa" mapstructure:"mfa"`
- TelemetryConfig telemetry.Conf `json:"telemetry" mapstructure:"telemetry"`
- PluginsConfig []plugin.Config `json:"plugins" mapstructure:"plugins"`
- SMTPConfig smtp.Config `json:"smtp" mapstructure:"smtp"`
- }
- func init() {
- Init()
- }
- // Init initializes the global configuration.
- // It is not supposed to be called outside of this package.
- // It is exported to minimize refactoring efforts. Will eventually disappear.
- func Init() {
- // create a default configuration to use if no config file is provided
- globalConf = globalConfig{
- Common: common.Configuration{
- IdleTimeout: 15,
- UploadMode: 0,
- Actions: common.ProtocolActions{
- ExecuteOn: []string{},
- ExecuteSync: []string{},
- Hook: "",
- },
- SetstatMode: 0,
- TempPath: "",
- ProxyProtocol: 0,
- ProxyAllowed: []string{},
- PostConnectHook: "",
- PostDisconnectHook: "",
- DataRetentionHook: "",
- MaxTotalConnections: 0,
- MaxPerHostConnections: 20,
- WhiteListFile: "",
- DefenderConfig: common.DefenderConfig{
- Enabled: false,
- Driver: common.DefenderDriverMemory,
- BanTime: 30,
- BanTimeIncrement: 50,
- Threshold: 15,
- ScoreInvalid: 2,
- ScoreValid: 1,
- ScoreLimitExceeded: 3,
- ObservationTime: 30,
- EntriesSoftLimit: 100,
- EntriesHardLimit: 150,
- SafeListFile: "",
- BlockListFile: "",
- SafeList: []string{},
- BlockList: []string{},
- },
- RateLimitersConfig: []common.RateLimiterConfig{defaultRateLimiter},
- },
- ACME: acme.Configuration{
- Email: "",
- KeyType: "4096",
- CertsPath: "certs",
- CAEndpoint: "https://acme-v02.api.letsencrypt.org/directory",
- Domains: []string{},
- RenewDays: 30,
- HTTP01Challenge: acme.HTTP01Challenge{
- Port: 80,
- WebRoot: "",
- ProxyHeader: "",
- },
- TLSALPN01Challenge: acme.TLSALPN01Challenge{
- Port: 0,
- },
- },
- SFTPD: sftpd.Configuration{
- Bindings: []sftpd.Binding{defaultSFTPDBinding},
- MaxAuthTries: 0,
- Banner: defaultSFTPDBanner,
- HostKeys: []string{},
- HostCertificates: []string{},
- HostKeyAlgorithms: []string{},
- KexAlgorithms: []string{},
- Ciphers: []string{},
- MACs: []string{},
- TrustedUserCAKeys: []string{},
- RevokedUserCertsFile: "",
- LoginBannerFile: "",
- EnabledSSHCommands: []string{},
- KeyboardInteractiveAuthentication: false,
- KeyboardInteractiveHook: "",
- PasswordAuthentication: true,
- FolderPrefix: "",
- },
- FTPD: ftpd.Configuration{
- Bindings: []ftpd.Binding{defaultFTPDBinding},
- Banner: defaultFTPDBanner,
- BannerFile: "",
- ActiveTransfersPortNon20: true,
- PassivePortRange: ftpd.PortRange{
- Start: 50000,
- End: 50100,
- },
- DisableActiveMode: false,
- EnableSite: false,
- HASHSupport: 0,
- CombineSupport: 0,
- CertificateFile: "",
- CertificateKeyFile: "",
- CACertificates: []string{},
- CARevocationLists: []string{},
- },
- WebDAVD: webdavd.Configuration{
- Bindings: []webdavd.Binding{defaultWebDAVDBinding},
- CertificateFile: "",
- CertificateKeyFile: "",
- CACertificates: []string{},
- CARevocationLists: []string{},
- Cors: webdavd.CorsConfig{
- Enabled: false,
- AllowedOrigins: []string{},
- AllowedMethods: []string{},
- AllowedHeaders: []string{},
- ExposedHeaders: []string{},
- AllowCredentials: false,
- MaxAge: 0,
- OptionsPassthrough: false,
- OptionsSuccessStatus: 0,
- AllowPrivateNetwork: false,
- },
- Cache: webdavd.Cache{
- Users: webdavd.UsersCacheConfig{
- ExpirationTime: 0,
- MaxSize: 50,
- },
- MimeTypes: webdavd.MimeCacheConfig{
- Enabled: true,
- MaxSize: 1000,
- },
- },
- },
- ProviderConf: dataprovider.Config{
- Driver: "sqlite",
- Name: "sftpgo.db",
- Host: "",
- Port: 0,
- Username: "",
- Password: "",
- ConnectionString: "",
- SQLTablesPrefix: "",
- SSLMode: 0,
- RootCert: "",
- ClientCert: "",
- ClientKey: "",
- TrackQuota: 2,
- PoolSize: 0,
- UsersBaseDir: "",
- Actions: dataprovider.ObjectsActions{
- ExecuteOn: []string{},
- ExecuteFor: []string{},
- Hook: "",
- },
- ExternalAuthHook: "",
- ExternalAuthScope: 0,
- PreLoginHook: "",
- PostLoginHook: "",
- PostLoginScope: 0,
- CheckPasswordHook: "",
- CheckPasswordScope: 0,
- PasswordHashing: dataprovider.PasswordHashing{
- Argon2Options: dataprovider.Argon2Options{
- Memory: 65536,
- Iterations: 1,
- Parallelism: 2,
- },
- BcryptOptions: dataprovider.BcryptOptions{
- Cost: 10,
- },
- Algo: dataprovider.HashingAlgoBcrypt,
- },
- PasswordValidation: dataprovider.PasswordValidation{
- Admins: dataprovider.PasswordValidationRules{
- MinEntropy: 0,
- },
- Users: dataprovider.PasswordValidationRules{
- MinEntropy: 0,
- },
- },
- PasswordCaching: true,
- UpdateMode: 0,
- DelayedQuotaUpdate: 0,
- CreateDefaultAdmin: false,
- NamingRules: 1,
- IsShared: 0,
- BackupsPath: "backups",
- },
- HTTPDConfig: httpd.Conf{
- Bindings: []httpd.Binding{defaultHTTPDBinding},
- TemplatesPath: "templates",
- StaticFilesPath: "static",
- OpenAPIPath: "openapi",
- WebRoot: "",
- CertificateFile: "",
- CertificateKeyFile: "",
- CACertificates: nil,
- CARevocationLists: nil,
- SigningPassphrase: "",
- TokenValidation: 0,
- MaxUploadFileSize: 1048576000,
- Cors: httpd.CorsConfig{
- Enabled: false,
- AllowedOrigins: []string{},
- AllowedMethods: []string{},
- AllowedHeaders: []string{},
- ExposedHeaders: []string{},
- AllowCredentials: false,
- MaxAge: 0,
- OptionsPassthrough: false,
- OptionsSuccessStatus: 0,
- AllowPrivateNetwork: false,
- },
- Setup: httpd.SetupConfig{
- InstallationCode: "",
- InstallationCodeHint: defaultInstallCodeHint,
- },
- HideSupportLink: false,
- },
- HTTPConfig: httpclient.Config{
- Timeout: 20,
- RetryWaitMin: 2,
- RetryWaitMax: 30,
- RetryMax: 3,
- CACertificates: nil,
- Certificates: nil,
- SkipTLSVerify: false,
- Headers: nil,
- },
- CommandConfig: command.Config{
- Timeout: 30,
- Env: nil,
- Commands: nil,
- },
- KMSConfig: kms.Configuration{
- Secrets: kms.Secrets{
- URL: "",
- MasterKeyString: "",
- MasterKeyPath: "",
- },
- },
- MFAConfig: mfa.Config{
- TOTP: nil,
- },
- TelemetryConfig: telemetry.Conf{
- BindPort: 0,
- BindAddress: "127.0.0.1",
- EnableProfiler: false,
- AuthUserFile: "",
- CertificateFile: "",
- CertificateKeyFile: "",
- MinTLSVersion: 12,
- TLSCipherSuites: nil,
- },
- SMTPConfig: smtp.Config{
- Host: "",
- Port: 25,
- From: "",
- User: "",
- Password: "",
- AuthType: 0,
- Encryption: 0,
- Domain: "",
- TemplatesPath: "templates",
- },
- PluginsConfig: nil,
- }
- viper.SetEnvPrefix(configEnvPrefix)
- replacer := strings.NewReplacer(".", "__")
- viper.SetEnvKeyReplacer(replacer)
- viper.SetConfigName(configName)
- setViperDefaults()
- viper.AutomaticEnv()
- viper.AllowEmptyEnv(true)
- }
- // GetCommonConfig returns the common protocols configuration
- func GetCommonConfig() common.Configuration {
- return globalConf.Common
- }
- // SetCommonConfig sets the common protocols configuration
- func SetCommonConfig(config common.Configuration) {
- globalConf.Common = config
- }
- // GetSFTPDConfig returns the configuration for the SFTP server
- func GetSFTPDConfig() sftpd.Configuration {
- return globalConf.SFTPD
- }
- // SetSFTPDConfig sets the configuration for the SFTP server
- func SetSFTPDConfig(config sftpd.Configuration) {
- globalConf.SFTPD = config
- }
- // GetFTPDConfig returns the configuration for the FTP server
- func GetFTPDConfig() ftpd.Configuration {
- return globalConf.FTPD
- }
- // SetFTPDConfig sets the configuration for the FTP server
- func SetFTPDConfig(config ftpd.Configuration) {
- globalConf.FTPD = config
- }
- // GetWebDAVDConfig returns the configuration for the WebDAV server
- func GetWebDAVDConfig() webdavd.Configuration {
- return globalConf.WebDAVD
- }
- // SetWebDAVDConfig sets the configuration for the WebDAV server
- func SetWebDAVDConfig(config webdavd.Configuration) {
- globalConf.WebDAVD = config
- }
- // GetHTTPDConfig returns the configuration for the HTTP server
- func GetHTTPDConfig() httpd.Conf {
- return globalConf.HTTPDConfig
- }
- // SetHTTPDConfig sets the configuration for the HTTP server
- func SetHTTPDConfig(config httpd.Conf) {
- globalConf.HTTPDConfig = config
- }
- // GetProviderConf returns the configuration for the data provider
- func GetProviderConf() dataprovider.Config {
- return globalConf.ProviderConf
- }
- // SetProviderConf sets the configuration for the data provider
- func SetProviderConf(config dataprovider.Config) {
- globalConf.ProviderConf = config
- }
- // GetHTTPConfig returns the configuration for HTTP clients
- func GetHTTPConfig() httpclient.Config {
- return globalConf.HTTPConfig
- }
- // GetCommandConfig returns the configuration for external commands
- func GetCommandConfig() command.Config {
- return globalConf.CommandConfig
- }
- // GetKMSConfig returns the KMS configuration
- func GetKMSConfig() kms.Configuration {
- return globalConf.KMSConfig
- }
- // SetKMSConfig sets the kms configuration
- func SetKMSConfig(config kms.Configuration) {
- globalConf.KMSConfig = config
- }
- // GetTelemetryConfig returns the telemetry configuration
- func GetTelemetryConfig() telemetry.Conf {
- return globalConf.TelemetryConfig
- }
- // SetTelemetryConfig sets the telemetry configuration
- func SetTelemetryConfig(config telemetry.Conf) {
- globalConf.TelemetryConfig = config
- }
- // GetPluginsConfig returns the plugins configuration
- func GetPluginsConfig() []plugin.Config {
- return globalConf.PluginsConfig
- }
- // SetPluginsConfig sets the plugin configuration
- func SetPluginsConfig(config []plugin.Config) {
- globalConf.PluginsConfig = config
- }
- // GetMFAConfig returns multi-factor authentication config
- func GetMFAConfig() mfa.Config {
- return globalConf.MFAConfig
- }
- // GetSMTPConfig returns the SMTP configuration
- func GetSMTPConfig() smtp.Config {
- return globalConf.SMTPConfig
- }
- // GetACMEConfig returns the ACME configuration
- func GetACMEConfig() acme.Configuration {
- return globalConf.ACME
- }
- // HasServicesToStart returns true if the config defines at least a service to start.
- // Supported services are SFTP, FTP and WebDAV
- func HasServicesToStart() bool {
- if globalConf.SFTPD.ShouldBind() {
- return true
- }
- if globalConf.FTPD.ShouldBind() {
- return true
- }
- if globalConf.WebDAVD.ShouldBind() {
- return true
- }
- return false
- }
- func getRedactedPassword(value string) string {
- if value == "" {
- return value
- }
- return "[redacted]"
- }
- func getRedactedGlobalConf() globalConfig {
- conf := globalConf
- conf.Common.Actions.Hook = util.GetRedactedURL(conf.Common.Actions.Hook)
- conf.Common.StartupHook = util.GetRedactedURL(conf.Common.StartupHook)
- conf.Common.PostConnectHook = util.GetRedactedURL(conf.Common.PostConnectHook)
- conf.Common.PostDisconnectHook = util.GetRedactedURL(conf.Common.PostDisconnectHook)
- conf.Common.DataRetentionHook = util.GetRedactedURL(conf.Common.DataRetentionHook)
- conf.SFTPD.KeyboardInteractiveHook = util.GetRedactedURL(conf.SFTPD.KeyboardInteractiveHook)
- conf.HTTPDConfig.SigningPassphrase = getRedactedPassword(conf.HTTPDConfig.SigningPassphrase)
- conf.HTTPDConfig.Setup.InstallationCode = getRedactedPassword(conf.HTTPDConfig.Setup.InstallationCode)
- conf.ProviderConf.Password = getRedactedPassword(conf.ProviderConf.Password)
- conf.ProviderConf.Actions.Hook = util.GetRedactedURL(conf.ProviderConf.Actions.Hook)
- conf.ProviderConf.ExternalAuthHook = util.GetRedactedURL(conf.ProviderConf.ExternalAuthHook)
- conf.ProviderConf.PreLoginHook = util.GetRedactedURL(conf.ProviderConf.PreLoginHook)
- conf.ProviderConf.PostLoginHook = util.GetRedactedURL(conf.ProviderConf.PostLoginHook)
- conf.ProviderConf.CheckPasswordHook = util.GetRedactedURL(conf.ProviderConf.CheckPasswordHook)
- conf.SMTPConfig.Password = getRedactedPassword(conf.SMTPConfig.Password)
- conf.HTTPDConfig.Bindings = nil
- for _, binding := range globalConf.HTTPDConfig.Bindings {
- binding.OIDC.ClientID = getRedactedPassword(binding.OIDC.ClientID)
- binding.OIDC.ClientSecret = getRedactedPassword(binding.OIDC.ClientSecret)
- conf.HTTPDConfig.Bindings = append(conf.HTTPDConfig.Bindings, binding)
- }
- return conf
- }
- func setConfigFile(configDir, configFile string) {
- if configFile == "" {
- return
- }
- if !filepath.IsAbs(configFile) && util.IsFileInputValid(configFile) {
- configFile = filepath.Join(configDir, configFile)
- }
- viper.SetConfigFile(configFile)
- }
- // LoadConfig loads the configuration
- // configDir will be added to the configuration search paths.
- // The search path contains by default the current directory and on linux it contains
- // $HOME/.config/sftpgo and /etc/sftpgo too.
- // configFile is an absolute or relative path (to the config dir) to the configuration file.
- func LoadConfig(configDir, configFile string) error {
- var err error
- viper.AddConfigPath(configDir)
- setViperAdditionalConfigPaths()
- viper.AddConfigPath(".")
- setConfigFile(configDir, configFile)
- if err = viper.ReadInConfig(); err != nil {
- // if the user specify a configuration file we get os.ErrNotExist.
- // viper.ConfigFileNotFoundError is returned if viper is unable
- // to find sftpgo.{json,yaml, etc..} in any of the search paths
- if errors.As(err, &viper.ConfigFileNotFoundError{}) {
- logger.Debug(logSender, "", "no configuration file found")
- } else {
- // should we return the error and not start here?
- logger.Warn(logSender, "", "error loading configuration file: %v", err)
- logger.WarnToConsole("error loading configuration file: %v", err)
- }
- globalConf.MFAConfig.TOTP = []mfa.TOTPConfig{defaultTOTP}
- }
- err = viper.Unmarshal(&globalConf)
- if err != nil {
- logger.Warn(logSender, "", "error parsing configuration file: %v", err)
- logger.WarnToConsole("error parsing configuration file: %v", err)
- return err
- }
- // viper only supports slice of strings from env vars, so we use our custom method
- loadBindingsFromEnv()
- resetInvalidConfigs()
- logger.Debug(logSender, "", "config file used: '%#v', config loaded: %+v", viper.ConfigFileUsed(), getRedactedGlobalConf())
- return nil
- }
- func isUploadModeValid() bool {
- return globalConf.Common.UploadMode >= 0 && globalConf.Common.UploadMode <= 2
- }
- func isProxyProtocolValid() bool {
- return globalConf.Common.ProxyProtocol >= 0 && globalConf.Common.ProxyProtocol <= 2
- }
- func isExternalAuthScopeValid() bool {
- return globalConf.ProviderConf.ExternalAuthScope >= 0 && globalConf.ProviderConf.ExternalAuthScope <= 15
- }
- func resetInvalidConfigs() {
- if strings.TrimSpace(globalConf.SFTPD.Banner) == "" {
- globalConf.SFTPD.Banner = defaultSFTPDBanner
- }
- if strings.TrimSpace(globalConf.FTPD.Banner) == "" {
- globalConf.FTPD.Banner = defaultFTPDBanner
- }
- if strings.TrimSpace(globalConf.HTTPDConfig.Setup.InstallationCodeHint) == "" {
- globalConf.HTTPDConfig.Setup.InstallationCodeHint = defaultInstallCodeHint
- }
- if globalConf.ProviderConf.UsersBaseDir != "" && !util.IsFileInputValid(globalConf.ProviderConf.UsersBaseDir) {
- warn := fmt.Sprintf("invalid users base dir %#v will be ignored", globalConf.ProviderConf.UsersBaseDir)
- globalConf.ProviderConf.UsersBaseDir = ""
- logger.Warn(logSender, "", "Non-fatal configuration error: %v", warn)
- logger.WarnToConsole("Non-fatal configuration error: %v", warn)
- }
- if !isUploadModeValid() {
- warn := fmt.Sprintf("invalid upload_mode 0, 1 and 2 are supported, configured: %v reset upload_mode to 0",
- globalConf.Common.UploadMode)
- globalConf.Common.UploadMode = 0
- logger.Warn(logSender, "", "Non-fatal configuration error: %v", warn)
- logger.WarnToConsole("Non-fatal configuration error: %v", warn)
- }
- if !isProxyProtocolValid() {
- warn := fmt.Sprintf("invalid proxy_protocol 0, 1 and 2 are supported, configured: %v reset proxy_protocol to 0",
- globalConf.Common.ProxyProtocol)
- globalConf.Common.ProxyProtocol = 0
- logger.Warn(logSender, "", "Non-fatal configuration error: %v", warn)
- logger.WarnToConsole("Non-fatal configuration error: %v", warn)
- }
- if !isExternalAuthScopeValid() {
- warn := fmt.Sprintf("invalid external_auth_scope: %v reset to 0", globalConf.ProviderConf.ExternalAuthScope)
- globalConf.ProviderConf.ExternalAuthScope = 0
- logger.Warn(logSender, "", "Non-fatal configuration error: %v", warn)
- logger.WarnToConsole("Non-fatal configuration error: %v", warn)
- }
- if globalConf.Common.DefenderConfig.Enabled && globalConf.Common.DefenderConfig.Driver == common.DefenderDriverProvider {
- if !globalConf.ProviderConf.IsDefenderSupported() {
- warn := fmt.Sprintf("provider based defender is not supported with data provider %#v, "+
- "the memory defender implementation will be used. If you want to use the provider defender "+
- "implementation please switch to a shared/distributed data provider",
- globalConf.ProviderConf.Driver)
- globalConf.Common.DefenderConfig.Driver = common.DefenderDriverMemory
- logger.Warn(logSender, "", "Non-fatal configuration error: %v", warn)
- logger.WarnToConsole("Non-fatal configuration error: %v", warn)
- }
- }
- }
- func loadBindingsFromEnv() {
- for idx := 0; idx < 10; idx++ {
- getTOTPFromEnv(idx)
- getRateLimitersFromEnv(idx)
- getPluginsFromEnv(idx)
- getSFTPDBindindFromEnv(idx)
- getFTPDBindingFromEnv(idx)
- getWebDAVDBindingFromEnv(idx)
- getHTTPDBindingFromEnv(idx)
- getHTTPClientCertificatesFromEnv(idx)
- getHTTPClientHeadersFromEnv(idx)
- getCommandConfigsFromEnv(idx)
- }
- }
- func getTOTPFromEnv(idx int) {
- totpConfig := defaultTOTP
- if len(globalConf.MFAConfig.TOTP) > idx {
- totpConfig = globalConf.MFAConfig.TOTP[idx]
- }
- isSet := false
- name, ok := os.LookupEnv(fmt.Sprintf("SFTPGO_MFA__TOTP__%v__NAME", idx))
- if ok {
- totpConfig.Name = name
- isSet = true
- }
- issuer, ok := os.LookupEnv(fmt.Sprintf("SFTPGO_MFA__TOTP__%v__ISSUER", idx))
- if ok {
- totpConfig.Issuer = issuer
- isSet = true
- }
- algo, ok := os.LookupEnv(fmt.Sprintf("SFTPGO_MFA__TOTP__%v__ALGO", idx))
- if ok {
- totpConfig.Algo = algo
- isSet = true
- }
- if isSet {
- if len(globalConf.MFAConfig.TOTP) > idx {
- globalConf.MFAConfig.TOTP[idx] = totpConfig
- } else {
- globalConf.MFAConfig.TOTP = append(globalConf.MFAConfig.TOTP, totpConfig)
- }
- }
- }
- func getRateLimitersFromEnv(idx int) {
- rtlConfig := defaultRateLimiter
- if len(globalConf.Common.RateLimitersConfig) > idx {
- rtlConfig = globalConf.Common.RateLimitersConfig[idx]
- }
- isSet := false
- average, ok := lookupIntFromEnv(fmt.Sprintf("SFTPGO_COMMON__RATE_LIMITERS__%v__AVERAGE", idx))
- if ok {
- rtlConfig.Average = average
- isSet = true
- }
- period, ok := lookupIntFromEnv(fmt.Sprintf("SFTPGO_COMMON__RATE_LIMITERS__%v__PERIOD", idx))
- if ok {
- rtlConfig.Period = period
- isSet = true
- }
- burst, ok := lookupIntFromEnv(fmt.Sprintf("SFTPGO_COMMON__RATE_LIMITERS__%v__BURST", idx))
- if ok {
- rtlConfig.Burst = int(burst)
- isSet = true
- }
- rtlType, ok := lookupIntFromEnv(fmt.Sprintf("SFTPGO_COMMON__RATE_LIMITERS__%v__TYPE", idx))
- if ok {
- rtlConfig.Type = int(rtlType)
- isSet = true
- }
- protocols, ok := lookupStringListFromEnv(fmt.Sprintf("SFTPGO_COMMON__RATE_LIMITERS__%v__PROTOCOLS", idx))
- if ok {
- rtlConfig.Protocols = protocols
- isSet = true
- }
- allowList, ok := lookupStringListFromEnv(fmt.Sprintf("SFTPGO_COMMON__RATE_LIMITERS__%v__ALLOW_LIST", idx))
- if ok {
- rtlConfig.AllowList = allowList
- isSet = true
- }
- generateEvents, ok := lookupBoolFromEnv(fmt.Sprintf("SFTPGO_COMMON__RATE_LIMITERS__%v__GENERATE_DEFENDER_EVENTS", idx))
- if ok {
- rtlConfig.GenerateDefenderEvents = generateEvents
- isSet = true
- }
- softLimit, ok := lookupIntFromEnv(fmt.Sprintf("SFTPGO_COMMON__RATE_LIMITERS__%v__ENTRIES_SOFT_LIMIT", idx))
- if ok {
- rtlConfig.EntriesSoftLimit = int(softLimit)
- isSet = true
- }
- hardLimit, ok := lookupIntFromEnv(fmt.Sprintf("SFTPGO_COMMON__RATE_LIMITERS__%v__ENTRIES_HARD_LIMIT", idx))
- if ok {
- rtlConfig.EntriesHardLimit = int(hardLimit)
- isSet = true
- }
- if isSet {
- if len(globalConf.Common.RateLimitersConfig) > idx {
- globalConf.Common.RateLimitersConfig[idx] = rtlConfig
- } else {
- globalConf.Common.RateLimitersConfig = append(globalConf.Common.RateLimitersConfig, rtlConfig)
- }
- }
- }
- func getKMSPluginFromEnv(idx int, pluginConfig *plugin.Config) bool {
- isSet := false
- kmsScheme, ok := os.LookupEnv(fmt.Sprintf("SFTPGO_PLUGINS__%v__KMS_OPTIONS__SCHEME", idx))
- if ok {
- pluginConfig.KMSOptions.Scheme = kmsScheme
- isSet = true
- }
- kmsEncStatus, ok := os.LookupEnv(fmt.Sprintf("SFTPGO_PLUGINS__%v__KMS_OPTIONS__ENCRYPTED_STATUS", idx))
- if ok {
- pluginConfig.KMSOptions.EncryptedStatus = kmsEncStatus
- isSet = true
- }
- return isSet
- }
- func getAuthPluginFromEnv(idx int, pluginConfig *plugin.Config) bool {
- isSet := false
- authScope, ok := lookupIntFromEnv(fmt.Sprintf("SFTPGO_PLUGINS__%v__AUTH_OPTIONS__SCOPE", idx))
- if ok {
- pluginConfig.AuthOptions.Scope = int(authScope)
- isSet = true
- }
- return isSet
- }
- func getNotifierPluginFromEnv(idx int, pluginConfig *plugin.Config) bool {
- isSet := false
- notifierFsEvents, ok := lookupStringListFromEnv(fmt.Sprintf("SFTPGO_PLUGINS__%v__NOTIFIER_OPTIONS__FS_EVENTS", idx))
- if ok {
- pluginConfig.NotifierOptions.FsEvents = notifierFsEvents
- isSet = true
- }
- notifierProviderEvents, ok := lookupStringListFromEnv(fmt.Sprintf("SFTPGO_PLUGINS__%v__NOTIFIER_OPTIONS__PROVIDER_EVENTS", idx))
- if ok {
- pluginConfig.NotifierOptions.ProviderEvents = notifierProviderEvents
- isSet = true
- }
- notifierProviderObjects, ok := lookupStringListFromEnv(fmt.Sprintf("SFTPGO_PLUGINS__%v__NOTIFIER_OPTIONS__PROVIDER_OBJECTS", idx))
- if ok {
- pluginConfig.NotifierOptions.ProviderObjects = notifierProviderObjects
- isSet = true
- }
- notifierRetryMaxTime, ok := lookupIntFromEnv(fmt.Sprintf("SFTPGO_PLUGINS__%v__NOTIFIER_OPTIONS__RETRY_MAX_TIME", idx))
- if ok {
- pluginConfig.NotifierOptions.RetryMaxTime = int(notifierRetryMaxTime)
- isSet = true
- }
- notifierRetryQueueMaxSize, ok := lookupIntFromEnv(fmt.Sprintf("SFTPGO_PLUGINS__%v__NOTIFIER_OPTIONS__RETRY_QUEUE_MAX_SIZE", idx))
- if ok {
- pluginConfig.NotifierOptions.RetryQueueMaxSize = int(notifierRetryQueueMaxSize)
- isSet = true
- }
- return isSet
- }
- func getPluginsFromEnv(idx int) {
- pluginConfig := plugin.Config{}
- if len(globalConf.PluginsConfig) > idx {
- pluginConfig = globalConf.PluginsConfig[idx]
- }
- isSet := false
- pluginType, ok := os.LookupEnv(fmt.Sprintf("SFTPGO_PLUGINS__%v__TYPE", idx))
- if ok {
- pluginConfig.Type = pluginType
- isSet = true
- }
- if getNotifierPluginFromEnv(idx, &pluginConfig) {
- isSet = true
- }
- if getKMSPluginFromEnv(idx, &pluginConfig) {
- isSet = true
- }
- if getAuthPluginFromEnv(idx, &pluginConfig) {
- isSet = true
- }
- cmd, ok := os.LookupEnv(fmt.Sprintf("SFTPGO_PLUGINS__%v__CMD", idx))
- if ok {
- pluginConfig.Cmd = cmd
- isSet = true
- }
- cmdArgs, ok := lookupStringListFromEnv(fmt.Sprintf("SFTPGO_PLUGINS__%v__ARGS", idx))
- if ok {
- pluginConfig.Args = cmdArgs
- isSet = true
- }
- pluginHash, ok := os.LookupEnv(fmt.Sprintf("SFTPGO_PLUGINS__%v__SHA256SUM", idx))
- if ok {
- pluginConfig.SHA256Sum = pluginHash
- isSet = true
- }
- autoMTLS, ok := lookupBoolFromEnv(fmt.Sprintf("SFTPGO_PLUGINS__%v__AUTO_MTLS", idx))
- if ok {
- pluginConfig.AutoMTLS = autoMTLS
- isSet = true
- }
- if isSet {
- if len(globalConf.PluginsConfig) > idx {
- globalConf.PluginsConfig[idx] = pluginConfig
- } else {
- globalConf.PluginsConfig = append(globalConf.PluginsConfig, pluginConfig)
- }
- }
- }
- func getSFTPDBindindFromEnv(idx int) {
- binding := defaultSFTPDBinding
- if len(globalConf.SFTPD.Bindings) > idx {
- binding = globalConf.SFTPD.Bindings[idx]
- }
- isSet := false
- port, ok := lookupIntFromEnv(fmt.Sprintf("SFTPGO_SFTPD__BINDINGS__%v__PORT", idx))
- if ok {
- binding.Port = int(port)
- isSet = true
- }
- address, ok := os.LookupEnv(fmt.Sprintf("SFTPGO_SFTPD__BINDINGS__%v__ADDRESS", idx))
- if ok {
- binding.Address = address
- isSet = true
- }
- applyProxyConfig, ok := lookupBoolFromEnv(fmt.Sprintf("SFTPGO_SFTPD__BINDINGS__%v__APPLY_PROXY_CONFIG", idx))
- if ok {
- binding.ApplyProxyConfig = applyProxyConfig
- isSet = true
- }
- if isSet {
- if len(globalConf.SFTPD.Bindings) > idx {
- globalConf.SFTPD.Bindings[idx] = binding
- } else {
- globalConf.SFTPD.Bindings = append(globalConf.SFTPD.Bindings, binding)
- }
- }
- }
- func getFTPDPassiveIPOverridesFromEnv(idx int) []ftpd.PassiveIPOverride {
- var overrides []ftpd.PassiveIPOverride
- if len(globalConf.FTPD.Bindings) > idx {
- overrides = globalConf.FTPD.Bindings[idx].PassiveIPOverrides
- }
- for subIdx := 0; subIdx < 10; subIdx++ {
- var override ftpd.PassiveIPOverride
- var replace bool
- if len(globalConf.FTPD.Bindings) > idx && len(globalConf.FTPD.Bindings[idx].PassiveIPOverrides) > subIdx {
- override = globalConf.FTPD.Bindings[idx].PassiveIPOverrides[subIdx]
- replace = true
- }
- ip, ok := os.LookupEnv(fmt.Sprintf("SFTPGO_FTPD__BINDINGS__%v__PASSIVE_IP_OVERRIDES__%v__IP", idx, subIdx))
- if ok {
- override.IP = ip
- }
- networks, ok := lookupStringListFromEnv(fmt.Sprintf("SFTPGO_FTPD__BINDINGS__%v__PASSIVE_IP_OVERRIDES__%v__NETWORKS",
- idx, subIdx))
- if ok {
- override.Networks = networks
- }
- if len(override.Networks) > 0 {
- if replace {
- overrides[subIdx] = override
- } else {
- overrides = append(overrides, override)
- }
- }
- }
- return overrides
- }
- func getDefaultFTPDBinding(idx int) ftpd.Binding {
- binding := defaultFTPDBinding
- if len(globalConf.FTPD.Bindings) > idx {
- binding = globalConf.FTPD.Bindings[idx]
- }
- return binding
- }
- func getFTPDBindingFromEnv(idx int) {
- binding := getDefaultFTPDBinding(idx)
- isSet := false
- port, ok := lookupIntFromEnv(fmt.Sprintf("SFTPGO_FTPD__BINDINGS__%v__PORT", idx))
- if ok {
- binding.Port = int(port)
- isSet = true
- }
- address, ok := os.LookupEnv(fmt.Sprintf("SFTPGO_FTPD__BINDINGS__%v__ADDRESS", idx))
- if ok {
- binding.Address = address
- isSet = true
- }
- applyProxyConfig, ok := lookupBoolFromEnv(fmt.Sprintf("SFTPGO_FTPD__BINDINGS__%v__APPLY_PROXY_CONFIG", idx))
- if ok {
- binding.ApplyProxyConfig = applyProxyConfig
- isSet = true
- }
- certificateFile, ok := os.LookupEnv(fmt.Sprintf("SFTPGO_FTPD__BINDINGS__%v__CERTIFICATE_FILE", idx))
- if ok {
- binding.CertificateFile = certificateFile
- isSet = true
- }
- certificateKeyFile, ok := os.LookupEnv(fmt.Sprintf("SFTPGO_FTPD__BINDINGS__%v__CERTIFICATE_KEY_FILE", idx))
- if ok {
- binding.CertificateKeyFile = certificateKeyFile
- isSet = true
- }
- tlsMode, ok := lookupIntFromEnv(fmt.Sprintf("SFTPGO_FTPD__BINDINGS__%v__TLS_MODE", idx))
- if ok {
- binding.TLSMode = int(tlsMode)
- isSet = true
- }
- tlsVer, ok := lookupIntFromEnv(fmt.Sprintf("SFTPGO_FTPD__BINDINGS__%v__MIN_TLS_VERSION", idx))
- if ok {
- binding.MinTLSVersion = int(tlsVer)
- isSet = true
- }
- passiveIP, ok := os.LookupEnv(fmt.Sprintf("SFTPGO_FTPD__BINDINGS__%v__FORCE_PASSIVE_IP", idx))
- if ok {
- binding.ForcePassiveIP = passiveIP
- isSet = true
- }
- passiveIPOverrides := getFTPDPassiveIPOverridesFromEnv(idx)
- if len(passiveIPOverrides) > 0 {
- binding.PassiveIPOverrides = passiveIPOverrides
- isSet = true
- }
- clientAuthType, ok := lookupIntFromEnv(fmt.Sprintf("SFTPGO_FTPD__BINDINGS__%v__CLIENT_AUTH_TYPE", idx))
- if ok {
- binding.ClientAuthType = int(clientAuthType)
- isSet = true
- }
- tlsCiphers, ok := lookupStringListFromEnv(fmt.Sprintf("SFTPGO_FTPD__BINDINGS__%v__TLS_CIPHER_SUITES", idx))
- if ok {
- binding.TLSCipherSuites = tlsCiphers
- isSet = true
- }
- pasvSecurity, ok := lookupIntFromEnv(fmt.Sprintf("SFTPGO_FTPD__BINDINGS__%v__PASSIVE_CONNECTIONS_SECURITY", idx))
- if ok {
- binding.PassiveConnectionsSecurity = int(pasvSecurity)
- isSet = true
- }
- activeSecurity, ok := lookupIntFromEnv(fmt.Sprintf("SFTPGO_FTPD__BINDINGS__%v__ACTIVE_CONNECTIONS_SECURITY", idx))
- if ok {
- binding.ActiveConnectionsSecurity = int(activeSecurity)
- isSet = true
- }
- debug, ok := lookupBoolFromEnv(fmt.Sprintf("SFTPGO_FTPD__BINDINGS__%v__DEBUG", idx))
- if ok {
- binding.Debug = debug
- isSet = true
- }
- applyFTPDBindingFromEnv(idx, isSet, binding)
- }
- func applyFTPDBindingFromEnv(idx int, isSet bool, binding ftpd.Binding) {
- if isSet {
- if len(globalConf.FTPD.Bindings) > idx {
- globalConf.FTPD.Bindings[idx] = binding
- } else {
- globalConf.FTPD.Bindings = append(globalConf.FTPD.Bindings, binding)
- }
- }
- }
- func getWebDAVDBindingProxyConfigsFromEnv(idx int, binding *webdavd.Binding) bool {
- isSet := false
- proxyAllowed, ok := lookupStringListFromEnv(fmt.Sprintf("SFTPGO_WEBDAVD__BINDINGS__%v__PROXY_ALLOWED", idx))
- if ok {
- binding.ProxyAllowed = proxyAllowed
- isSet = true
- }
- clientIPProxyHeader, ok := os.LookupEnv(fmt.Sprintf("SFTPGO_WEBDAVD__BINDINGS__%v__CLIENT_IP_PROXY_HEADER", idx))
- if ok {
- binding.ClientIPProxyHeader = clientIPProxyHeader
- isSet = true
- }
- clientIPHeaderDepth, ok := lookupIntFromEnv(fmt.Sprintf("SFTPGO_WEBDAVD__BINDINGS__%v__CLIENT_IP_HEADER_DEPTH", idx))
- if ok {
- binding.ClientIPHeaderDepth = int(clientIPHeaderDepth)
- isSet = true
- }
- return isSet
- }
- func getWebDAVDBindingFromEnv(idx int) {
- binding := defaultWebDAVDBinding
- if len(globalConf.WebDAVD.Bindings) > idx {
- binding = globalConf.WebDAVD.Bindings[idx]
- }
- isSet := false
- port, ok := lookupIntFromEnv(fmt.Sprintf("SFTPGO_WEBDAVD__BINDINGS__%v__PORT", idx))
- if ok {
- binding.Port = int(port)
- isSet = true
- }
- address, ok := os.LookupEnv(fmt.Sprintf("SFTPGO_WEBDAVD__BINDINGS__%v__ADDRESS", idx))
- if ok {
- binding.Address = address
- isSet = true
- }
- certificateFile, ok := os.LookupEnv(fmt.Sprintf("SFTPGO_WEBDAVD__BINDINGS__%v__CERTIFICATE_FILE", idx))
- if ok {
- binding.CertificateFile = certificateFile
- isSet = true
- }
- certificateKeyFile, ok := os.LookupEnv(fmt.Sprintf("SFTPGO_WEBDAVD__BINDINGS__%v__CERTIFICATE_KEY_FILE", idx))
- if ok {
- binding.CertificateKeyFile = certificateKeyFile
- isSet = true
- }
- enableHTTPS, ok := lookupBoolFromEnv(fmt.Sprintf("SFTPGO_WEBDAVD__BINDINGS__%v__ENABLE_HTTPS", idx))
- if ok {
- binding.EnableHTTPS = enableHTTPS
- isSet = true
- }
- tlsVer, ok := lookupIntFromEnv(fmt.Sprintf("SFTPGO_WEBDAVD__BINDINGS__%v__MIN_TLS_VERSION", idx))
- if ok {
- binding.MinTLSVersion = int(tlsVer)
- isSet = true
- }
- clientAuthType, ok := lookupIntFromEnv(fmt.Sprintf("SFTPGO_WEBDAVD__BINDINGS__%v__CLIENT_AUTH_TYPE", idx))
- if ok {
- binding.ClientAuthType = int(clientAuthType)
- isSet = true
- }
- tlsCiphers, ok := lookupStringListFromEnv(fmt.Sprintf("SFTPGO_WEBDAVD__BINDINGS__%v__TLS_CIPHER_SUITES", idx))
- if ok {
- binding.TLSCipherSuites = tlsCiphers
- isSet = true
- }
- if getWebDAVDBindingProxyConfigsFromEnv(idx, &binding) {
- isSet = true
- }
- prefix, ok := os.LookupEnv(fmt.Sprintf("SFTPGO_WEBDAVD__BINDINGS__%v__PREFIX", idx))
- if ok {
- binding.Prefix = prefix
- isSet = true
- }
- if isSet {
- if len(globalConf.WebDAVD.Bindings) > idx {
- globalConf.WebDAVD.Bindings[idx] = binding
- } else {
- globalConf.WebDAVD.Bindings = append(globalConf.WebDAVD.Bindings, binding)
- }
- }
- }
- func getHTTPDSecurityProxyHeadersFromEnv(idx int) []httpd.HTTPSProxyHeader {
- var httpsProxyHeaders []httpd.HTTPSProxyHeader
- if len(globalConf.HTTPDConfig.Bindings) > idx {
- httpsProxyHeaders = globalConf.HTTPDConfig.Bindings[idx].Security.HTTPSProxyHeaders
- }
- for subIdx := 0; subIdx < 10; subIdx++ {
- var httpsProxyHeader httpd.HTTPSProxyHeader
- var replace bool
- if len(globalConf.HTTPDConfig.Bindings) > idx &&
- len(globalConf.HTTPDConfig.Bindings[idx].Security.HTTPSProxyHeaders) > subIdx {
- httpsProxyHeader = httpsProxyHeaders[subIdx]
- replace = true
- }
- proxyKey, ok := os.LookupEnv(fmt.Sprintf("SFTPGO_HTTPD__BINDINGS__%v__SECURITY__HTTPS_PROXY_HEADERS__%v__KEY",
- idx, subIdx))
- if ok {
- httpsProxyHeader.Key = proxyKey
- }
- proxyVal, ok := os.LookupEnv(fmt.Sprintf("SFTPGO_HTTPD__BINDINGS__%v__SECURITY__HTTPS_PROXY_HEADERS__%v__VALUE",
- idx, subIdx))
- if ok {
- httpsProxyHeader.Value = proxyVal
- }
- if httpsProxyHeader.Key != "" && httpsProxyHeader.Value != "" {
- if replace {
- httpsProxyHeaders[subIdx] = httpsProxyHeader
- } else {
- httpsProxyHeaders = append(httpsProxyHeaders, httpsProxyHeader)
- }
- }
- }
- return httpsProxyHeaders
- }
- func getHTTPDSecurityConfFromEnv(idx int) (httpd.SecurityConf, bool) { //nolint:gocyclo
- result := defaultHTTPDBinding.Security
- if len(globalConf.HTTPDConfig.Bindings) > idx {
- result = globalConf.HTTPDConfig.Bindings[idx].Security
- }
- isSet := false
- enabled, ok := lookupBoolFromEnv(fmt.Sprintf("SFTPGO_HTTPD__BINDINGS__%v__SECURITY__ENABLED", idx))
- if ok {
- result.Enabled = enabled
- isSet = true
- }
- allowedHosts, ok := lookupStringListFromEnv(fmt.Sprintf("SFTPGO_HTTPD__BINDINGS__%v__SECURITY__ALLOWED_HOSTS", idx))
- if ok {
- result.AllowedHosts = allowedHosts
- isSet = true
- }
- allowedHostsAreRegex, ok := lookupBoolFromEnv(fmt.Sprintf("SFTPGO_HTTPD__BINDINGS__%v__SECURITY__ALLOWED_HOSTS_ARE_REGEX", idx))
- if ok {
- result.AllowedHostsAreRegex = allowedHostsAreRegex
- isSet = true
- }
- hostsProxyHeaders, ok := lookupStringListFromEnv(fmt.Sprintf("SFTPGO_HTTPD__BINDINGS__%v__SECURITY__HOSTS_PROXY_HEADERS", idx))
- if ok {
- result.HostsProxyHeaders = hostsProxyHeaders
- isSet = true
- }
- httpsRedirect, ok := lookupBoolFromEnv(fmt.Sprintf("SFTPGO_HTTPD__BINDINGS__%v__SECURITY__HTTPS_REDIRECT", idx))
- if ok {
- result.HTTPSRedirect = httpsRedirect
- isSet = true
- }
- httpsHost, ok := os.LookupEnv(fmt.Sprintf("SFTPGO_HTTPD__BINDINGS__%v__SECURITY__HTTPS_HOST", idx))
- if ok {
- result.HTTPSHost = httpsHost
- isSet = true
- }
- httpsProxyHeaders := getHTTPDSecurityProxyHeadersFromEnv(idx)
- if len(httpsProxyHeaders) > 0 {
- result.HTTPSProxyHeaders = httpsProxyHeaders
- isSet = true
- }
- stsSeconds, ok := lookupIntFromEnv(fmt.Sprintf("SFTPGO_HTTPD__BINDINGS__%v__SECURITY__STS_SECONDS", idx))
- if ok {
- result.STSSeconds = stsSeconds
- isSet = true
- }
- stsIncludeSubDomains, ok := lookupBoolFromEnv(fmt.Sprintf("SFTPGO_HTTPD__BINDINGS__%v__SECURITY__STS_INCLUDE_SUBDOMAINS", idx))
- if ok {
- result.STSIncludeSubdomains = stsIncludeSubDomains
- isSet = true
- }
- stsPreload, ok := lookupBoolFromEnv(fmt.Sprintf("SFTPGO_HTTPD__BINDINGS__%v__SECURITY__STS_PRELOAD", idx))
- if ok {
- result.STSPreload = stsPreload
- isSet = true
- }
- contentTypeNosniff, ok := lookupBoolFromEnv(fmt.Sprintf("SFTPGO_HTTPD__BINDINGS__%v__SECURITY__CONTENT_TYPE_NOSNIFF", idx))
- if ok {
- result.ContentTypeNosniff = contentTypeNosniff
- isSet = true
- }
- contentSecurityPolicy, ok := os.LookupEnv(fmt.Sprintf("SFTPGO_HTTPD__BINDINGS__%v__SECURITY__CONTENT_SECURITY_POLICY", idx))
- if ok {
- result.ContentSecurityPolicy = contentSecurityPolicy
- isSet = true
- }
- permissionsPolicy, ok := os.LookupEnv(fmt.Sprintf("SFTPGO_HTTPD__BINDINGS__%v__SECURITY__PERMISSIONS_POLICY", idx))
- if ok {
- result.PermissionsPolicy = permissionsPolicy
- isSet = true
- }
- crossOriginOpenedPolicy, ok := os.LookupEnv(fmt.Sprintf("SFTPGO_HTTPD__BINDINGS__%v__SECURITY__CROSS_ORIGIN_OPENER_POLICY", idx))
- if ok {
- result.CrossOriginOpenerPolicy = crossOriginOpenedPolicy
- isSet = true
- }
- expectCTHeader, ok := os.LookupEnv(fmt.Sprintf("SFTPGO_HTTPD__BINDINGS__%v__SECURITY__EXPECT_CT_HEADER", idx))
- if ok {
- result.ExpectCTHeader = expectCTHeader
- isSet = true
- }
- return result, isSet
- }
- func getHTTPDOIDCFromEnv(idx int) (httpd.OIDC, bool) {
- result := defaultHTTPDBinding.OIDC
- if len(globalConf.HTTPDConfig.Bindings) > idx {
- result = globalConf.HTTPDConfig.Bindings[idx].OIDC
- }
- isSet := false
- clientID, ok := os.LookupEnv(fmt.Sprintf("SFTPGO_HTTPD__BINDINGS__%v__OIDC__CLIENT_ID", idx))
- if ok {
- result.ClientID = clientID
- isSet = true
- }
- clientSecret, ok := os.LookupEnv(fmt.Sprintf("SFTPGO_HTTPD__BINDINGS__%v__OIDC__CLIENT_SECRET", idx))
- if ok {
- result.ClientSecret = clientSecret
- isSet = true
- }
- configURL, ok := os.LookupEnv(fmt.Sprintf("SFTPGO_HTTPD__BINDINGS__%v__OIDC__CONFIG_URL", idx))
- if ok {
- result.ConfigURL = configURL
- isSet = true
- }
- redirectBaseURL, ok := os.LookupEnv(fmt.Sprintf("SFTPGO_HTTPD__BINDINGS__%v__OIDC__REDIRECT_BASE_URL", idx))
- if ok {
- result.RedirectBaseURL = redirectBaseURL
- isSet = true
- }
- usernameField, ok := os.LookupEnv(fmt.Sprintf("SFTPGO_HTTPD__BINDINGS__%v__OIDC__USERNAME_FIELD", idx))
- if ok {
- result.UsernameField = usernameField
- isSet = true
- }
- scopes, ok := lookupStringListFromEnv(fmt.Sprintf("SFTPGO_HTTPD__BINDINGS__%v__OIDC__SCOPES", idx))
- if ok {
- result.Scopes = scopes
- isSet = true
- }
- roleField, ok := os.LookupEnv(fmt.Sprintf("SFTPGO_HTTPD__BINDINGS__%v__OIDC__ROLE_FIELD", idx))
- if ok {
- result.RoleField = roleField
- isSet = true
- }
- implicitRoles, ok := lookupBoolFromEnv(fmt.Sprintf("SFTPGO_HTTPD__BINDINGS__%v__OIDC__IMPLICIT_ROLES", idx))
- if ok {
- result.ImplicitRoles = implicitRoles
- isSet = true
- }
- customFields, ok := lookupStringListFromEnv(fmt.Sprintf("SFTPGO_HTTPD__BINDINGS__%v__OIDC__CUSTOM_FIELDS", idx))
- if ok {
- result.CustomFields = customFields
- isSet = true
- }
- debug, ok := lookupBoolFromEnv(fmt.Sprintf("SFTPGO_HTTPD__BINDINGS__%v__OIDC__DEBUG", idx))
- if ok {
- result.Debug = debug
- isSet = true
- }
- return result, isSet
- }
- func getHTTPDUIBrandingFromEnv(prefix string, branding httpd.UIBranding) (httpd.UIBranding, bool) {
- isSet := false
- name, ok := os.LookupEnv(fmt.Sprintf("%s__NAME", prefix))
- if ok {
- branding.Name = name
- isSet = true
- }
- shortName, ok := os.LookupEnv(fmt.Sprintf("%s__SHORT_NAME", prefix))
- if ok {
- branding.ShortName = shortName
- isSet = true
- }
- faviconPath, ok := os.LookupEnv(fmt.Sprintf("%s__FAVICON_PATH", prefix))
- if ok {
- branding.FaviconPath = faviconPath
- isSet = true
- }
- logoPath, ok := os.LookupEnv(fmt.Sprintf("%s__LOGO_PATH", prefix))
- if ok {
- branding.LogoPath = logoPath
- isSet = true
- }
- loginImagePath, ok := os.LookupEnv(fmt.Sprintf("%s__LOGIN_IMAGE_PATH", prefix))
- if ok {
- branding.LoginImagePath = loginImagePath
- isSet = true
- }
- disclaimerName, ok := os.LookupEnv(fmt.Sprintf("%s__DISCLAIMER_NAME", prefix))
- if ok {
- branding.DisclaimerName = disclaimerName
- isSet = true
- }
- disclaimerPath, ok := os.LookupEnv(fmt.Sprintf("%s__DISCLAIMER_PATH", prefix))
- if ok {
- branding.DisclaimerPath = disclaimerPath
- isSet = true
- }
- defaultCSSPath, ok := os.LookupEnv(fmt.Sprintf("%s__DEFAULT_CSS", prefix))
- if ok {
- branding.DefaultCSS = defaultCSSPath
- isSet = true
- }
- extraCSS, ok := lookupStringListFromEnv(fmt.Sprintf("%s__EXTRA_CSS", prefix))
- if ok {
- branding.ExtraCSS = extraCSS
- isSet = true
- }
- return branding, isSet
- }
- func getHTTPDBrandingFromEnv(idx int) (httpd.Branding, bool) {
- result := defaultHTTPDBinding.Branding
- if len(globalConf.HTTPDConfig.Bindings) > idx {
- result = globalConf.HTTPDConfig.Bindings[idx].Branding
- }
- isSet := false
- webAdmin, ok := getHTTPDUIBrandingFromEnv(fmt.Sprintf("SFTPGO_HTTPD__BINDINGS__%v__BRANDING__WEB_ADMIN", idx),
- result.WebAdmin)
- if ok {
- result.WebAdmin = webAdmin
- isSet = true
- }
- webClient, ok := getHTTPDUIBrandingFromEnv(fmt.Sprintf("SFTPGO_HTTPD__BINDINGS__%v__BRANDING__WEB_CLIENT", idx),
- result.WebClient)
- if ok {
- result.WebClient = webClient
- isSet = true
- }
- return result, isSet
- }
- func getHTTPDWebClientIntegrationsFromEnv(idx int) []httpd.WebClientIntegration {
- var integrations []httpd.WebClientIntegration
- if len(globalConf.HTTPDConfig.Bindings) > idx {
- integrations = globalConf.HTTPDConfig.Bindings[idx].WebClientIntegrations
- }
- for subIdx := 0; subIdx < 10; subIdx++ {
- var integration httpd.WebClientIntegration
- var replace bool
- if len(globalConf.HTTPDConfig.Bindings) > idx &&
- len(globalConf.HTTPDConfig.Bindings[idx].WebClientIntegrations) > subIdx {
- integration = integrations[subIdx]
- replace = true
- }
- url, ok := os.LookupEnv(fmt.Sprintf("SFTPGO_HTTPD__BINDINGS__%v__WEB_CLIENT_INTEGRATIONS__%v__URL", idx, subIdx))
- if ok {
- integration.URL = url
- }
- extensions, ok := lookupStringListFromEnv(fmt.Sprintf("SFTPGO_HTTPD__BINDINGS__%v__WEB_CLIENT_INTEGRATIONS__%v__FILE_EXTENSIONS",
- idx, subIdx))
- if ok {
- integration.FileExtensions = extensions
- }
- if integration.URL != "" && len(integration.FileExtensions) > 0 {
- if replace {
- integrations[subIdx] = integration
- } else {
- integrations = append(integrations, integration)
- }
- }
- }
- return integrations
- }
- func getDefaultHTTPBinding(idx int) httpd.Binding {
- binding := defaultHTTPDBinding
- if len(globalConf.HTTPDConfig.Bindings) > idx {
- binding = globalConf.HTTPDConfig.Bindings[idx]
- }
- return binding
- }
- func getHTTPDNestedObjectsFromEnv(idx int, binding *httpd.Binding) bool {
- isSet := false
- webClientIntegrations := getHTTPDWebClientIntegrationsFromEnv(idx)
- if len(webClientIntegrations) > 0 {
- binding.WebClientIntegrations = webClientIntegrations
- isSet = true
- }
- oidc, ok := getHTTPDOIDCFromEnv(idx)
- if ok {
- binding.OIDC = oidc
- isSet = true
- }
- securityConf, ok := getHTTPDSecurityConfFromEnv(idx)
- if ok {
- binding.Security = securityConf
- isSet = true
- }
- brandingConf, ok := getHTTPDBrandingFromEnv(idx)
- if ok {
- binding.Branding = brandingConf
- isSet = true
- }
- return isSet
- }
- func getHTTPDBindingProxyConfigsFromEnv(idx int, binding *httpd.Binding) bool {
- isSet := false
- proxyAllowed, ok := lookupStringListFromEnv(fmt.Sprintf("SFTPGO_HTTPD__BINDINGS__%v__PROXY_ALLOWED", idx))
- if ok {
- binding.ProxyAllowed = proxyAllowed
- isSet = true
- }
- clientIPProxyHeader, ok := os.LookupEnv(fmt.Sprintf("SFTPGO_HTTPD__BINDINGS__%v__CLIENT_IP_PROXY_HEADER", idx))
- if ok {
- binding.ClientIPProxyHeader = clientIPProxyHeader
- isSet = true
- }
- clientIPHeaderDepth, ok := lookupIntFromEnv(fmt.Sprintf("SFTPGO_HTTPD__BINDINGS__%v__CLIENT_IP_HEADER_DEPTH", idx))
- if ok {
- binding.ClientIPHeaderDepth = int(clientIPHeaderDepth)
- isSet = true
- }
- return isSet
- }
- func getHTTPDBindingFromEnv(idx int) { //nolint:gocyclo
- binding := getDefaultHTTPBinding(idx)
- isSet := false
- port, ok := lookupIntFromEnv(fmt.Sprintf("SFTPGO_HTTPD__BINDINGS__%v__PORT", idx))
- if ok {
- binding.Port = int(port)
- isSet = true
- }
- address, ok := os.LookupEnv(fmt.Sprintf("SFTPGO_HTTPD__BINDINGS__%v__ADDRESS", idx))
- if ok {
- binding.Address = address
- isSet = true
- }
- certificateFile, ok := os.LookupEnv(fmt.Sprintf("SFTPGO_HTTPD__BINDINGS__%v__CERTIFICATE_FILE", idx))
- if ok {
- binding.CertificateFile = certificateFile
- isSet = true
- }
- certificateKeyFile, ok := os.LookupEnv(fmt.Sprintf("SFTPGO_HTTPD__BINDINGS__%v__CERTIFICATE_KEY_FILE", idx))
- if ok {
- binding.CertificateKeyFile = certificateKeyFile
- isSet = true
- }
- enableWebAdmin, ok := lookupBoolFromEnv(fmt.Sprintf("SFTPGO_HTTPD__BINDINGS__%v__ENABLE_WEB_ADMIN", idx))
- if ok {
- binding.EnableWebAdmin = enableWebAdmin
- isSet = true
- }
- enableWebClient, ok := lookupBoolFromEnv(fmt.Sprintf("SFTPGO_HTTPD__BINDINGS__%v__ENABLE_WEB_CLIENT", idx))
- if ok {
- binding.EnableWebClient = enableWebClient
- isSet = true
- }
- enabledLoginMethods, ok := lookupIntFromEnv(fmt.Sprintf("SFTPGO_HTTPD__BINDINGS__%v__ENABLED_LOGIN_METHODS", idx))
- if ok {
- binding.EnabledLoginMethods = int(enabledLoginMethods)
- isSet = true
- }
- renderOpenAPI, ok := lookupBoolFromEnv(fmt.Sprintf("SFTPGO_HTTPD__BINDINGS__%v__RENDER_OPENAPI", idx))
- if ok {
- binding.RenderOpenAPI = renderOpenAPI
- isSet = true
- }
- enableHTTPS, ok := lookupBoolFromEnv(fmt.Sprintf("SFTPGO_HTTPD__BINDINGS__%v__ENABLE_HTTPS", idx))
- if ok {
- binding.EnableHTTPS = enableHTTPS
- isSet = true
- }
- tlsVer, ok := lookupIntFromEnv(fmt.Sprintf("SFTPGO_HTTPD__BINDINGS__%v__MIN_TLS_VERSION", idx))
- if ok {
- binding.MinTLSVersion = int(tlsVer)
- isSet = true
- }
- clientAuthType, ok := lookupIntFromEnv(fmt.Sprintf("SFTPGO_HTTPD__BINDINGS__%v__CLIENT_AUTH_TYPE", idx))
- if ok {
- binding.ClientAuthType = int(clientAuthType)
- isSet = true
- }
- tlsCiphers, ok := lookupStringListFromEnv(fmt.Sprintf("SFTPGO_HTTPD__BINDINGS__%v__TLS_CIPHER_SUITES", idx))
- if ok {
- binding.TLSCipherSuites = tlsCiphers
- isSet = true
- }
- if getHTTPDBindingProxyConfigsFromEnv(idx, &binding) {
- isSet = true
- }
- hideLoginURL, ok := lookupIntFromEnv(fmt.Sprintf("SFTPGO_HTTPD__BINDINGS__%v__HIDE_LOGIN_URL", idx))
- if ok {
- binding.HideLoginURL = int(hideLoginURL)
- isSet = true
- }
- if getHTTPDNestedObjectsFromEnv(idx, &binding) {
- isSet = true
- }
- setHTTPDBinding(isSet, binding, idx)
- }
- func setHTTPDBinding(isSet bool, binding httpd.Binding, idx int) {
- if isSet {
- if len(globalConf.HTTPDConfig.Bindings) > idx {
- globalConf.HTTPDConfig.Bindings[idx] = binding
- } else {
- globalConf.HTTPDConfig.Bindings = append(globalConf.HTTPDConfig.Bindings, binding)
- }
- }
- }
- func getHTTPClientCertificatesFromEnv(idx int) {
- tlsCert := httpclient.TLSKeyPair{}
- if len(globalConf.HTTPConfig.Certificates) > idx {
- tlsCert = globalConf.HTTPConfig.Certificates[idx]
- }
- cert, ok := os.LookupEnv(fmt.Sprintf("SFTPGO_HTTP__CERTIFICATES__%v__CERT", idx))
- if ok {
- tlsCert.Cert = cert
- }
- key, ok := os.LookupEnv(fmt.Sprintf("SFTPGO_HTTP__CERTIFICATES__%v__KEY", idx))
- if ok {
- tlsCert.Key = key
- }
- if tlsCert.Cert != "" && tlsCert.Key != "" {
- if len(globalConf.HTTPConfig.Certificates) > idx {
- globalConf.HTTPConfig.Certificates[idx] = tlsCert
- } else {
- globalConf.HTTPConfig.Certificates = append(globalConf.HTTPConfig.Certificates, tlsCert)
- }
- }
- }
- func getHTTPClientHeadersFromEnv(idx int) {
- header := httpclient.Header{}
- if len(globalConf.HTTPConfig.Headers) > idx {
- header = globalConf.HTTPConfig.Headers[idx]
- }
- key, ok := os.LookupEnv(fmt.Sprintf("SFTPGO_HTTP__HEADERS__%v__KEY", idx))
- if ok {
- header.Key = key
- }
- value, ok := os.LookupEnv(fmt.Sprintf("SFTPGO_HTTP__HEADERS__%v__VALUE", idx))
- if ok {
- header.Value = value
- }
- url, ok := os.LookupEnv(fmt.Sprintf("SFTPGO_HTTP__HEADERS__%v__URL", idx))
- if ok {
- header.URL = url
- }
- if header.Key != "" && header.Value != "" {
- if len(globalConf.HTTPConfig.Headers) > idx {
- globalConf.HTTPConfig.Headers[idx] = header
- } else {
- globalConf.HTTPConfig.Headers = append(globalConf.HTTPConfig.Headers, header)
- }
- }
- }
- func getCommandConfigsFromEnv(idx int) {
- cfg := command.Command{}
- if len(globalConf.CommandConfig.Commands) > idx {
- cfg = globalConf.CommandConfig.Commands[idx]
- }
- path, ok := os.LookupEnv(fmt.Sprintf("SFTPGO_COMMAND__COMMANDS__%v__PATH", idx))
- if ok {
- cfg.Path = path
- }
- timeout, ok := lookupIntFromEnv(fmt.Sprintf("SFTPGO_COMMAND__COMMANDS__%v__TIMEOUT", idx))
- if ok {
- cfg.Timeout = int(timeout)
- }
- env, ok := lookupStringListFromEnv(fmt.Sprintf("SFTPGO_COMMAND__COMMANDS__%v__ENV", idx))
- if ok {
- cfg.Env = env
- }
- if cfg.Path != "" {
- if len(globalConf.CommandConfig.Commands) > idx {
- globalConf.CommandConfig.Commands[idx] = cfg
- } else {
- globalConf.CommandConfig.Commands = append(globalConf.CommandConfig.Commands, cfg)
- }
- }
- }
- func setViperDefaults() {
- viper.SetDefault("common.idle_timeout", globalConf.Common.IdleTimeout)
- viper.SetDefault("common.upload_mode", globalConf.Common.UploadMode)
- viper.SetDefault("common.actions.execute_on", globalConf.Common.Actions.ExecuteOn)
- viper.SetDefault("common.actions.execute_sync", globalConf.Common.Actions.ExecuteSync)
- viper.SetDefault("common.actions.hook", globalConf.Common.Actions.Hook)
- viper.SetDefault("common.setstat_mode", globalConf.Common.SetstatMode)
- viper.SetDefault("common.temp_path", globalConf.Common.TempPath)
- viper.SetDefault("common.proxy_protocol", globalConf.Common.ProxyProtocol)
- viper.SetDefault("common.proxy_allowed", globalConf.Common.ProxyAllowed)
- viper.SetDefault("common.post_connect_hook", globalConf.Common.PostConnectHook)
- viper.SetDefault("common.post_disconnect_hook", globalConf.Common.PostDisconnectHook)
- viper.SetDefault("common.data_retention_hook", globalConf.Common.DataRetentionHook)
- viper.SetDefault("common.max_total_connections", globalConf.Common.MaxTotalConnections)
- viper.SetDefault("common.max_per_host_connections", globalConf.Common.MaxPerHostConnections)
- viper.SetDefault("common.whitelist_file", globalConf.Common.WhiteListFile)
- viper.SetDefault("common.defender.enabled", globalConf.Common.DefenderConfig.Enabled)
- viper.SetDefault("common.defender.driver", globalConf.Common.DefenderConfig.Driver)
- viper.SetDefault("common.defender.ban_time", globalConf.Common.DefenderConfig.BanTime)
- viper.SetDefault("common.defender.ban_time_increment", globalConf.Common.DefenderConfig.BanTimeIncrement)
- viper.SetDefault("common.defender.threshold", globalConf.Common.DefenderConfig.Threshold)
- viper.SetDefault("common.defender.score_invalid", globalConf.Common.DefenderConfig.ScoreInvalid)
- viper.SetDefault("common.defender.score_valid", globalConf.Common.DefenderConfig.ScoreValid)
- viper.SetDefault("common.defender.score_limit_exceeded", globalConf.Common.DefenderConfig.ScoreLimitExceeded)
- viper.SetDefault("common.defender.observation_time", globalConf.Common.DefenderConfig.ObservationTime)
- viper.SetDefault("common.defender.entries_soft_limit", globalConf.Common.DefenderConfig.EntriesSoftLimit)
- viper.SetDefault("common.defender.entries_hard_limit", globalConf.Common.DefenderConfig.EntriesHardLimit)
- viper.SetDefault("common.defender.safelist_file", globalConf.Common.DefenderConfig.SafeListFile)
- viper.SetDefault("common.defender.blocklist_file", globalConf.Common.DefenderConfig.BlockListFile)
- viper.SetDefault("common.defender.safelist", globalConf.Common.DefenderConfig.SafeList)
- viper.SetDefault("common.defender.blocklist", globalConf.Common.DefenderConfig.BlockList)
- viper.SetDefault("acme.email", globalConf.ACME.Email)
- viper.SetDefault("acme.key_type", globalConf.ACME.KeyType)
- viper.SetDefault("acme.certs_path", globalConf.ACME.CertsPath)
- viper.SetDefault("acme.ca_endpoint", globalConf.ACME.CAEndpoint)
- viper.SetDefault("acme.domains", globalConf.ACME.Domains)
- viper.SetDefault("acme.renew_days", globalConf.ACME.RenewDays)
- viper.SetDefault("acme.http01_challenge.port", globalConf.ACME.HTTP01Challenge.Port)
- viper.SetDefault("acme.http01_challenge.webroot", globalConf.ACME.HTTP01Challenge.WebRoot)
- viper.SetDefault("acme.http01_challenge.proxy_header", globalConf.ACME.HTTP01Challenge.ProxyHeader)
- viper.SetDefault("acme.tls_alpn01_challenge.port", globalConf.ACME.TLSALPN01Challenge.Port)
- viper.SetDefault("sftpd.max_auth_tries", globalConf.SFTPD.MaxAuthTries)
- viper.SetDefault("sftpd.banner", globalConf.SFTPD.Banner)
- viper.SetDefault("sftpd.host_keys", globalConf.SFTPD.HostKeys)
- viper.SetDefault("sftpd.host_certificates", globalConf.SFTPD.HostCertificates)
- viper.SetDefault("sftpd.host_key_algorithms", globalConf.SFTPD.HostKeyAlgorithms)
- viper.SetDefault("sftpd.kex_algorithms", globalConf.SFTPD.KexAlgorithms)
- viper.SetDefault("sftpd.ciphers", globalConf.SFTPD.Ciphers)
- viper.SetDefault("sftpd.macs", globalConf.SFTPD.MACs)
- viper.SetDefault("sftpd.trusted_user_ca_keys", globalConf.SFTPD.TrustedUserCAKeys)
- viper.SetDefault("sftpd.revoked_user_certs_file", globalConf.SFTPD.RevokedUserCertsFile)
- viper.SetDefault("sftpd.login_banner_file", globalConf.SFTPD.LoginBannerFile)
- viper.SetDefault("sftpd.enabled_ssh_commands", sftpd.GetDefaultSSHCommands())
- viper.SetDefault("sftpd.keyboard_interactive_authentication", globalConf.SFTPD.KeyboardInteractiveAuthentication)
- viper.SetDefault("sftpd.keyboard_interactive_auth_hook", globalConf.SFTPD.KeyboardInteractiveHook)
- viper.SetDefault("sftpd.password_authentication", globalConf.SFTPD.PasswordAuthentication)
- viper.SetDefault("sftpd.folder_prefix", globalConf.SFTPD.FolderPrefix)
- viper.SetDefault("ftpd.banner", globalConf.FTPD.Banner)
- viper.SetDefault("ftpd.banner_file", globalConf.FTPD.BannerFile)
- viper.SetDefault("ftpd.active_transfers_port_non_20", globalConf.FTPD.ActiveTransfersPortNon20)
- viper.SetDefault("ftpd.passive_port_range.start", globalConf.FTPD.PassivePortRange.Start)
- viper.SetDefault("ftpd.passive_port_range.end", globalConf.FTPD.PassivePortRange.End)
- viper.SetDefault("ftpd.disable_active_mode", globalConf.FTPD.DisableActiveMode)
- viper.SetDefault("ftpd.enable_site", globalConf.FTPD.EnableSite)
- viper.SetDefault("ftpd.hash_support", globalConf.FTPD.HASHSupport)
- viper.SetDefault("ftpd.combine_support", globalConf.FTPD.CombineSupport)
- viper.SetDefault("ftpd.certificate_file", globalConf.FTPD.CertificateFile)
- viper.SetDefault("ftpd.certificate_key_file", globalConf.FTPD.CertificateKeyFile)
- viper.SetDefault("ftpd.ca_certificates", globalConf.FTPD.CACertificates)
- viper.SetDefault("ftpd.ca_revocation_lists", globalConf.FTPD.CARevocationLists)
- viper.SetDefault("webdavd.certificate_file", globalConf.WebDAVD.CertificateFile)
- viper.SetDefault("webdavd.certificate_key_file", globalConf.WebDAVD.CertificateKeyFile)
- viper.SetDefault("webdavd.ca_certificates", globalConf.WebDAVD.CACertificates)
- viper.SetDefault("webdavd.ca_revocation_lists", globalConf.WebDAVD.CARevocationLists)
- viper.SetDefault("webdavd.cors.enabled", globalConf.WebDAVD.Cors.Enabled)
- viper.SetDefault("webdavd.cors.allowed_origins", globalConf.WebDAVD.Cors.AllowedOrigins)
- viper.SetDefault("webdavd.cors.allowed_methods", globalConf.WebDAVD.Cors.AllowedMethods)
- viper.SetDefault("webdavd.cors.allowed_headers", globalConf.WebDAVD.Cors.AllowedHeaders)
- viper.SetDefault("webdavd.cors.exposed_headers", globalConf.WebDAVD.Cors.ExposedHeaders)
- viper.SetDefault("webdavd.cors.allow_credentials", globalConf.WebDAVD.Cors.AllowCredentials)
- viper.SetDefault("webdavd.cors.options_passthrough", globalConf.WebDAVD.Cors.OptionsPassthrough)
- viper.SetDefault("webdavd.cors.options_success_status", globalConf.WebDAVD.Cors.OptionsSuccessStatus)
- viper.SetDefault("webdavd.cors.allow_private_network", globalConf.WebDAVD.Cors.AllowPrivateNetwork)
- viper.SetDefault("webdavd.cors.max_age", globalConf.WebDAVD.Cors.MaxAge)
- viper.SetDefault("webdavd.cache.users.expiration_time", globalConf.WebDAVD.Cache.Users.ExpirationTime)
- viper.SetDefault("webdavd.cache.users.max_size", globalConf.WebDAVD.Cache.Users.MaxSize)
- viper.SetDefault("webdavd.cache.mime_types.enabled", globalConf.WebDAVD.Cache.MimeTypes.Enabled)
- viper.SetDefault("webdavd.cache.mime_types.max_size", globalConf.WebDAVD.Cache.MimeTypes.MaxSize)
- viper.SetDefault("data_provider.driver", globalConf.ProviderConf.Driver)
- viper.SetDefault("data_provider.name", globalConf.ProviderConf.Name)
- viper.SetDefault("data_provider.host", globalConf.ProviderConf.Host)
- viper.SetDefault("data_provider.port", globalConf.ProviderConf.Port)
- viper.SetDefault("data_provider.username", globalConf.ProviderConf.Username)
- viper.SetDefault("data_provider.password", globalConf.ProviderConf.Password)
- viper.SetDefault("data_provider.sslmode", globalConf.ProviderConf.SSLMode)
- viper.SetDefault("data_provider.root_cert", globalConf.ProviderConf.RootCert)
- viper.SetDefault("data_provider.client_cert", globalConf.ProviderConf.ClientCert)
- viper.SetDefault("data_provider.client_key", globalConf.ProviderConf.ClientKey)
- viper.SetDefault("data_provider.connection_string", globalConf.ProviderConf.ConnectionString)
- viper.SetDefault("data_provider.sql_tables_prefix", globalConf.ProviderConf.SQLTablesPrefix)
- viper.SetDefault("data_provider.track_quota", globalConf.ProviderConf.TrackQuota)
- viper.SetDefault("data_provider.pool_size", globalConf.ProviderConf.PoolSize)
- viper.SetDefault("data_provider.users_base_dir", globalConf.ProviderConf.UsersBaseDir)
- viper.SetDefault("data_provider.actions.execute_on", globalConf.ProviderConf.Actions.ExecuteOn)
- viper.SetDefault("data_provider.actions.execute_for", globalConf.ProviderConf.Actions.ExecuteFor)
- viper.SetDefault("data_provider.actions.hook", globalConf.ProviderConf.Actions.Hook)
- viper.SetDefault("data_provider.external_auth_hook", globalConf.ProviderConf.ExternalAuthHook)
- viper.SetDefault("data_provider.external_auth_scope", globalConf.ProviderConf.ExternalAuthScope)
- viper.SetDefault("data_provider.pre_login_hook", globalConf.ProviderConf.PreLoginHook)
- viper.SetDefault("data_provider.post_login_hook", globalConf.ProviderConf.PostLoginHook)
- viper.SetDefault("data_provider.post_login_scope", globalConf.ProviderConf.PostLoginScope)
- viper.SetDefault("data_provider.check_password_hook", globalConf.ProviderConf.CheckPasswordHook)
- viper.SetDefault("data_provider.check_password_scope", globalConf.ProviderConf.CheckPasswordScope)
- viper.SetDefault("data_provider.password_hashing.bcrypt_options.cost", globalConf.ProviderConf.PasswordHashing.BcryptOptions.Cost)
- viper.SetDefault("data_provider.password_hashing.argon2_options.memory", globalConf.ProviderConf.PasswordHashing.Argon2Options.Memory)
- viper.SetDefault("data_provider.password_hashing.argon2_options.iterations", globalConf.ProviderConf.PasswordHashing.Argon2Options.Iterations)
- viper.SetDefault("data_provider.password_hashing.argon2_options.parallelism", globalConf.ProviderConf.PasswordHashing.Argon2Options.Parallelism)
- viper.SetDefault("data_provider.password_hashing.algo", globalConf.ProviderConf.PasswordHashing.Algo)
- viper.SetDefault("data_provider.password_validation.admins.min_entropy", globalConf.ProviderConf.PasswordValidation.Admins.MinEntropy)
- viper.SetDefault("data_provider.password_validation.users.min_entropy", globalConf.ProviderConf.PasswordValidation.Users.MinEntropy)
- viper.SetDefault("data_provider.password_caching", globalConf.ProviderConf.PasswordCaching)
- viper.SetDefault("data_provider.update_mode", globalConf.ProviderConf.UpdateMode)
- viper.SetDefault("data_provider.delayed_quota_update", globalConf.ProviderConf.DelayedQuotaUpdate)
- viper.SetDefault("data_provider.create_default_admin", globalConf.ProviderConf.CreateDefaultAdmin)
- viper.SetDefault("data_provider.naming_rules", globalConf.ProviderConf.NamingRules)
- viper.SetDefault("data_provider.is_shared", globalConf.ProviderConf.IsShared)
- viper.SetDefault("data_provider.backups_path", globalConf.ProviderConf.BackupsPath)
- viper.SetDefault("httpd.templates_path", globalConf.HTTPDConfig.TemplatesPath)
- viper.SetDefault("httpd.static_files_path", globalConf.HTTPDConfig.StaticFilesPath)
- viper.SetDefault("httpd.openapi_path", globalConf.HTTPDConfig.OpenAPIPath)
- viper.SetDefault("httpd.web_root", globalConf.HTTPDConfig.WebRoot)
- viper.SetDefault("httpd.certificate_file", globalConf.HTTPDConfig.CertificateFile)
- viper.SetDefault("httpd.certificate_key_file", globalConf.HTTPDConfig.CertificateKeyFile)
- viper.SetDefault("httpd.ca_certificates", globalConf.HTTPDConfig.CACertificates)
- viper.SetDefault("httpd.ca_revocation_lists", globalConf.HTTPDConfig.CARevocationLists)
- viper.SetDefault("httpd.signing_passphrase", globalConf.HTTPDConfig.SigningPassphrase)
- viper.SetDefault("httpd.token_validation", globalConf.HTTPDConfig.TokenValidation)
- viper.SetDefault("httpd.max_upload_file_size", globalConf.HTTPDConfig.MaxUploadFileSize)
- viper.SetDefault("httpd.cors.enabled", globalConf.HTTPDConfig.Cors.Enabled)
- viper.SetDefault("httpd.cors.allowed_origins", globalConf.HTTPDConfig.Cors.AllowedOrigins)
- viper.SetDefault("httpd.cors.allowed_methods", globalConf.HTTPDConfig.Cors.AllowedMethods)
- viper.SetDefault("httpd.cors.allowed_headers", globalConf.HTTPDConfig.Cors.AllowedHeaders)
- viper.SetDefault("httpd.cors.exposed_headers", globalConf.HTTPDConfig.Cors.ExposedHeaders)
- viper.SetDefault("httpd.cors.allow_credentials", globalConf.HTTPDConfig.Cors.AllowCredentials)
- viper.SetDefault("httpd.cors.max_age", globalConf.HTTPDConfig.Cors.MaxAge)
- viper.SetDefault("httpd.cors.options_passthrough", globalConf.HTTPDConfig.Cors.OptionsPassthrough)
- viper.SetDefault("httpd.cors.options_success_status", globalConf.HTTPDConfig.Cors.OptionsSuccessStatus)
- viper.SetDefault("httpd.cors.allow_private_network", globalConf.HTTPDConfig.Cors.AllowPrivateNetwork)
- viper.SetDefault("httpd.setup.installation_code", globalConf.HTTPDConfig.Setup.InstallationCode)
- viper.SetDefault("httpd.setup.installation_code_hint", globalConf.HTTPDConfig.Setup.InstallationCodeHint)
- viper.SetDefault("httpd.hide_support_link", globalConf.HTTPDConfig.HideSupportLink)
- viper.SetDefault("http.timeout", globalConf.HTTPConfig.Timeout)
- viper.SetDefault("http.retry_wait_min", globalConf.HTTPConfig.RetryWaitMin)
- viper.SetDefault("http.retry_wait_max", globalConf.HTTPConfig.RetryWaitMax)
- viper.SetDefault("http.retry_max", globalConf.HTTPConfig.RetryMax)
- viper.SetDefault("http.ca_certificates", globalConf.HTTPConfig.CACertificates)
- viper.SetDefault("http.skip_tls_verify", globalConf.HTTPConfig.SkipTLSVerify)
- viper.SetDefault("command.timeout", globalConf.CommandConfig.Timeout)
- viper.SetDefault("command.env", globalConf.CommandConfig.Env)
- viper.SetDefault("kms.secrets.url", globalConf.KMSConfig.Secrets.URL)
- viper.SetDefault("kms.secrets.master_key", globalConf.KMSConfig.Secrets.MasterKeyString)
- viper.SetDefault("kms.secrets.master_key_path", globalConf.KMSConfig.Secrets.MasterKeyPath)
- viper.SetDefault("telemetry.bind_port", globalConf.TelemetryConfig.BindPort)
- viper.SetDefault("telemetry.bind_address", globalConf.TelemetryConfig.BindAddress)
- viper.SetDefault("telemetry.enable_profiler", globalConf.TelemetryConfig.EnableProfiler)
- viper.SetDefault("telemetry.auth_user_file", globalConf.TelemetryConfig.AuthUserFile)
- viper.SetDefault("telemetry.certificate_file", globalConf.TelemetryConfig.CertificateFile)
- viper.SetDefault("telemetry.certificate_key_file", globalConf.TelemetryConfig.CertificateKeyFile)
- viper.SetDefault("telemetry.min_tls_version", globalConf.TelemetryConfig.MinTLSVersion)
- viper.SetDefault("telemetry.tls_cipher_suites", globalConf.TelemetryConfig.TLSCipherSuites)
- viper.SetDefault("smtp.host", globalConf.SMTPConfig.Host)
- viper.SetDefault("smtp.port", globalConf.SMTPConfig.Port)
- viper.SetDefault("smtp.from", globalConf.SMTPConfig.From)
- viper.SetDefault("smtp.user", globalConf.SMTPConfig.User)
- viper.SetDefault("smtp.password", globalConf.SMTPConfig.Password)
- viper.SetDefault("smtp.auth_type", globalConf.SMTPConfig.AuthType)
- viper.SetDefault("smtp.encryption", globalConf.SMTPConfig.Encryption)
- viper.SetDefault("smtp.domain", globalConf.SMTPConfig.Domain)
- viper.SetDefault("smtp.templates_path", globalConf.SMTPConfig.TemplatesPath)
- }
- func lookupBoolFromEnv(envName string) (bool, bool) {
- value, ok := os.LookupEnv(envName)
- if ok {
- converted, err := strconv.ParseBool(strings.TrimSpace(value))
- if err == nil {
- return converted, ok
- }
- }
- return false, false
- }
- func lookupIntFromEnv(envName string) (int64, bool) {
- value, ok := os.LookupEnv(envName)
- if ok {
- converted, err := strconv.ParseInt(strings.TrimSpace(value), 10, 64)
- if err == nil {
- return converted, ok
- }
- }
- return 0, false
- }
- func lookupStringListFromEnv(envName string) ([]string, bool) {
- value, ok := os.LookupEnv(envName)
- if ok {
- var result []string
- for _, v := range strings.Split(value, ",") {
- val := strings.TrimSpace(v)
- if val != "" {
- result = append(result, val)
- }
- }
- return result, true
- }
- return nil, false
- }
|