// Package service allows to start and stop the SFTPGo service package service import ( "fmt" "math/rand" "os" "os/signal" "path/filepath" "strings" "syscall" "time" "github.com/drakkan/sftpgo/config" "github.com/drakkan/sftpgo/dataprovider" "github.com/drakkan/sftpgo/httpd" "github.com/drakkan/sftpgo/logger" "github.com/drakkan/sftpgo/sftpd" "github.com/drakkan/sftpgo/utils" "github.com/grandcat/zeroconf" "github.com/rs/zerolog" ) const ( logSender = "service" ) var ( chars = []rune("ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789") ) // Service defines the SFTPGo service type Service struct { ConfigDir string ConfigFile string LogFilePath string LogMaxSize int LogMaxBackups int LogMaxAge int LogCompress bool LogVerbose bool PortableMode int PortableUser dataprovider.User Shutdown chan bool } // Start initializes the service func (s *Service) Start() error { logLevel := zerolog.DebugLevel if !s.LogVerbose { logLevel = zerolog.InfoLevel } if !filepath.IsAbs(s.LogFilePath) && len(s.LogFilePath) > 0 && s.LogFilePath != "." { s.LogFilePath = filepath.Join(s.ConfigDir, s.LogFilePath) } logger.InitLogger(s.LogFilePath, s.LogMaxSize, s.LogMaxBackups, s.LogMaxAge, s.LogCompress, logLevel) if s.PortableMode == 1 { logger.EnableConsoleLogger(logLevel) if len(s.LogFilePath) == 0 { logger.DisableLogger() } } version := utils.GetAppVersion() logger.Info(logSender, "", "starting SFTPGo %v, config dir: %v, config file: %v, log max size: %v log max backups: %v "+ "log max age: %v log verbose: %v, log compress: %v", version.GetVersionAsString(), s.ConfigDir, s.ConfigFile, s.LogMaxSize, s.LogMaxBackups, s.LogMaxAge, s.LogVerbose, s.LogCompress) // in portable mode we don't read configuration from file if s.PortableMode != 1 { config.LoadConfig(s.ConfigDir, s.ConfigFile) } providerConf := config.GetProviderConf() err := dataprovider.Initialize(providerConf, s.ConfigDir) if err != nil { logger.Error(logSender, "", "error initializing data provider: %v", err) logger.ErrorToConsole("error initializing data provider: %v", err) return err } dataProvider := dataprovider.GetProvider() sftpdConf := config.GetSFTPDConfig() httpdConf := config.GetHTTPDConfig() if s.PortableMode == 1 { // create the user for portable mode err = dataprovider.AddUser(dataProvider, s.PortableUser) if err != nil { logger.ErrorToConsole("error adding portable user: %v", err) return err } } sftpd.SetDataProvider(dataProvider) go func() { logger.Debug(logSender, "", "initializing SFTP server with config %+v", sftpdConf) if err := sftpdConf.Initialize(s.ConfigDir); err != nil { logger.Error(logSender, "", "could not start SFTP server: %v", err) logger.ErrorToConsole("could not start SFTP server: %v", err) } s.Shutdown <- true }() if httpdConf.BindPort > 0 { httpd.SetDataProvider(dataProvider) go func() { if err := httpdConf.Initialize(s.ConfigDir); err != nil { logger.Error(logSender, "", "could not start HTTP server: %v", err) logger.ErrorToConsole("could not start HTTP server: %v", err) } s.Shutdown <- true }() } else { logger.Debug(logSender, "", "HTTP server not started, disabled in config file") if s.PortableMode != 1 { logger.DebugToConsole("HTTP server not started, disabled in config file") } } return nil } // Wait blocks until the service exits func (s *Service) Wait() { if s.PortableMode != 1 { registerSigHup() } <-s.Shutdown } // Stop terminates the service unblocking the Wait method func (s *Service) Stop() { close(s.Shutdown) logger.Debug(logSender, "", "Service stopped") } // StartPortableMode starts the service in portable mode func (s *Service) StartPortableMode(sftpdPort int, enabledSSHCommands []string, advertiseService, advertiseCredentials bool) error { if s.PortableMode != 1 { return fmt.Errorf("service is not configured for portable mode") } var err error rand.Seed(time.Now().UnixNano()) if len(s.PortableUser.Username) == 0 { s.PortableUser.Username = "user" } if len(s.PortableUser.PublicKeys) == 0 && len(s.PortableUser.Password) == 0 { var b strings.Builder for i := 0; i < 8; i++ { b.WriteRune(chars[rand.Intn(len(chars))]) } s.PortableUser.Password = b.String() } dataProviderConf := config.GetProviderConf() dataProviderConf.Driver = dataprovider.MemoryDataProviderName dataProviderConf.Name = "" dataProviderConf.CredentialsPath = filepath.Join(os.TempDir(), "credentials") config.SetProviderConf(dataProviderConf) httpdConf := config.GetHTTPDConfig() httpdConf.BindPort = 0 config.SetHTTPDConfig(httpdConf) sftpdConf := config.GetSFTPDConfig() sftpdConf.MaxAuthTries = 12 if sftpdPort > 0 { sftpdConf.BindPort = sftpdPort } else { // dynamic ports starts from 49152 sftpdConf.BindPort = 49152 + rand.Intn(15000) } if utils.IsStringInSlice("*", enabledSSHCommands) { sftpdConf.EnabledSSHCommands = sftpd.GetSupportedSSHCommands() } else { sftpdConf.EnabledSSHCommands = enabledSSHCommands } config.SetSFTPDConfig(sftpdConf) err = s.Start() if err != nil { return err } var mDNSService *zeroconf.Server if advertiseService { version := utils.GetAppVersion() meta := []string{ fmt.Sprintf("version=%v", version.GetVersionAsString()), } if advertiseCredentials { logger.InfoToConsole("Advertising credentials via multicast DNS") meta = append(meta, fmt.Sprintf("user=%v", s.PortableUser.Username)) if len(s.PortableUser.Password) > 0 { meta = append(meta, fmt.Sprintf("password=%v", s.PortableUser.Password)) } else { logger.InfoToConsole("Unable to advertise key based credentials via multicast DNS, we don't have the private key") } } mDNSService, err = zeroconf.Register( fmt.Sprintf("SFTPGo portable %v", sftpdConf.BindPort), // service instance name "_sftp-ssh._tcp", // service type and protocol "local.", // service domain sftpdConf.BindPort, // service port meta, // service metadata nil, // register on all network interfaces ) if err != nil { mDNSService = nil logger.WarnToConsole("Unable to advertise SFTP service via multicast DNS: %v", err) } else { logger.InfoToConsole("SFTP service advertised via multicast DNS") } } sig := make(chan os.Signal, 1) signal.Notify(sig, os.Interrupt, syscall.SIGTERM) go func() { <-sig if mDNSService != nil { logger.InfoToConsole("unregistering multicast DNS service") mDNSService.Shutdown() } s.Stop() }() logger.InfoToConsole("Portable mode ready, SFTP port: %v, user: %#v, password: %#v, public keys: %v, directory: %#v, "+ "permissions: %v, enabled ssh commands: %v", sftpdConf.BindPort, s.PortableUser.Username, s.PortableUser.Password, s.PortableUser.PublicKeys, s.getPortableDirToServe(), s.PortableUser.Permissions, sftpdConf.EnabledSSHCommands) return nil } func (s *Service) getPortableDirToServe() string { var dirToServe string if s.PortableUser.FsConfig.Provider == 1 { dirToServe = s.PortableUser.FsConfig.S3Config.KeyPrefix } else if s.PortableUser.FsConfig.Provider == 2 { dirToServe = s.PortableUser.FsConfig.GCSConfig.KeyPrefix } else { dirToServe = s.PortableUser.HomeDir } return dirToServe }