package sftpd import ( "bytes" "encoding/hex" "encoding/json" "fmt" "io" "net" "os" "path/filepath" "runtime/debug" "strings" "time" "github.com/pkg/sftp" "golang.org/x/crypto/ssh" "github.com/drakkan/sftpgo/common" "github.com/drakkan/sftpgo/dataprovider" "github.com/drakkan/sftpgo/logger" "github.com/drakkan/sftpgo/metrics" "github.com/drakkan/sftpgo/utils" "github.com/drakkan/sftpgo/vfs" ) const ( defaultPrivateRSAKeyName = "id_rsa" defaultPrivateECDSAKeyName = "id_ecdsa" defaultPrivateEd25519KeyName = "id_ed25519" sourceAddressCriticalOption = "source-address" ) var ( sftpExtensions = []string{"statvfs@openssh.com"} ) // Binding defines the configuration for a network listener type Binding struct { // The address to listen on. A blank value means listen on all available network interfaces. Address string `json:"address" mapstructure:"address"` // The port used for serving requests Port int `json:"port" mapstructure:"port"` // Apply the proxy configuration, if any, for this binding ApplyProxyConfig bool `json:"apply_proxy_config" mapstructure:"apply_proxy_config"` } // GetAddress returns the binding address func (b *Binding) GetAddress() string { return fmt.Sprintf("%s:%d", b.Address, b.Port) } // IsValid returns true if the binding port is > 0 func (b *Binding) IsValid() bool { return b.Port > 0 } // HasProxy returns true if the proxy protocol is active for this binding func (b *Binding) HasProxy() bool { return b.ApplyProxyConfig && common.Config.ProxyProtocol > 0 } // Configuration for the SFTP server type Configuration struct { // Identification string used by the server Banner string `json:"banner" mapstructure:"banner"` // Addresses and ports to bind to Bindings []Binding `json:"bindings" mapstructure:"bindings"` // Deprecated: please use Bindings BindPort int `json:"bind_port" mapstructure:"bind_port"` // Deprecated: please use Bindings BindAddress string `json:"bind_address" mapstructure:"bind_address"` // Deprecated: please use the same key in common configuration IdleTimeout int `json:"idle_timeout" mapstructure:"idle_timeout"` // Maximum number of authentication attempts permitted per connection. // If set to a negative number, the number of attempts is unlimited. // If set to zero, the number of attempts are limited to 6. MaxAuthTries int `json:"max_auth_tries" mapstructure:"max_auth_tries"` // Deprecated: please use the same key in common configuration UploadMode int `json:"upload_mode" mapstructure:"upload_mode"` // Actions to execute on file operations and SSH commands Actions common.ProtocolActions `json:"actions" mapstructure:"actions"` // Deprecated: please use HostKeys Keys []Key `json:"keys" mapstructure:"keys"` // HostKeys define the daemon's private host keys. // Each host key can be defined as a path relative to the configuration directory or an absolute one. // If empty or missing, the daemon will search or try to generate "id_rsa" and "id_ecdsa" host keys // inside the configuration directory. HostKeys []string `json:"host_keys" mapstructure:"host_keys"` // KexAlgorithms specifies the available KEX (Key Exchange) algorithms in // preference order. KexAlgorithms []string `json:"kex_algorithms" mapstructure:"kex_algorithms"` // Ciphers specifies the ciphers allowed Ciphers []string `json:"ciphers" mapstructure:"ciphers"` // MACs Specifies the available MAC (message authentication code) algorithms // in preference order MACs []string `json:"macs" mapstructure:"macs"` // TrustedUserCAKeys specifies a list of public keys paths of certificate authorities // that are trusted to sign user certificates for authentication. // The paths can be absolute or relative to the configuration directory TrustedUserCAKeys []string `json:"trusted_user_ca_keys" mapstructure:"trusted_user_ca_keys"` // LoginBannerFile the contents of the specified file, if any, are sent to // the remote user before authentication is allowed. LoginBannerFile string `json:"login_banner_file" mapstructure:"login_banner_file"` // Deprecated: please use the same key in common configuration SetstatMode int `json:"setstat_mode" mapstructure:"setstat_mode"` // List of enabled SSH commands. // We support the following SSH commands: // - "scp". SCP is an experimental feature, we have our own SCP implementation since // we can't rely on scp system command to proper handle permissions, quota and // user's home dir restrictions. // The SCP protocol is quite simple but there is no official docs about it, // so we need more testing and feedbacks before enabling it by default. // We may not handle some borderline cases or have sneaky bugs. // Please do accurate tests yourself before enabling SCP and let us known // if something does not work as expected for your use cases. // SCP between two remote hosts is supported using the `-3` scp option. // - "md5sum", "sha1sum", "sha256sum", "sha384sum", "sha512sum". Useful to check message // digests for uploaded files. These commands are implemented inside SFTPGo so they // work even if the matching system commands are not available, for example on Windows. // - "cd", "pwd". Some mobile SFTP clients does not support the SFTP SSH_FXP_REALPATH and so // they use "cd" and "pwd" SSH commands to get the initial directory. // Currently `cd` do nothing and `pwd` always returns the "/" path. // // The following SSH commands are enabled by default: "md5sum", "sha1sum", "cd", "pwd". // "*" enables all supported SSH commands. EnabledSSHCommands []string `json:"enabled_ssh_commands" mapstructure:"enabled_ssh_commands"` // Absolute path to an external program or an HTTP URL to invoke for keyboard interactive authentication. // Leave empty to disable this authentication mode. KeyboardInteractiveHook string `json:"keyboard_interactive_auth_hook" mapstructure:"keyboard_interactive_auth_hook"` // PasswordAuthentication specifies whether password authentication is allowed. PasswordAuthentication bool `json:"password_authentication" mapstructure:"password_authentication"` // Deprecated: please use the same key in common configuration ProxyProtocol int `json:"proxy_protocol" mapstructure:"proxy_protocol"` // Deprecated: please use the same key in common configuration ProxyAllowed []string `json:"proxy_allowed" mapstructure:"proxy_allowed"` certChecker *ssh.CertChecker parsedUserCAKeys []ssh.PublicKey } // Key contains information about host keys // Deprecated: please use HostKeys type Key struct { // The private key path as absolute path or relative to the configuration directory PrivateKey string `json:"private_key" mapstructure:"private_key"` } type authenticationError struct { err string } func (e *authenticationError) Error() string { return fmt.Sprintf("Authentication error: %s", e.err) } // ShouldBind returns true if there is at least a valid binding func (c *Configuration) ShouldBind() bool { for _, binding := range c.Bindings { if binding.IsValid() { return true } } return false } // Initialize the SFTP server and add a persistent listener to handle inbound SFTP connections. func (c *Configuration) Initialize(configDir string) error { serverConfig := &ssh.ServerConfig{ NoClientAuth: false, MaxAuthTries: c.MaxAuthTries, PublicKeyCallback: func(conn ssh.ConnMetadata, pubKey ssh.PublicKey) (*ssh.Permissions, error) { sp, err := c.validatePublicKeyCredentials(conn, pubKey) if err == ssh.ErrPartialSuccess { return sp, err } if err != nil { return nil, &authenticationError{err: fmt.Sprintf("could not validate public key credentials: %v", err)} } return sp, nil }, NextAuthMethodsCallback: func(conn ssh.ConnMetadata) []string { var nextMethods []string user, err := dataprovider.UserExists(conn.User()) if err == nil { nextMethods = user.GetNextAuthMethods(conn.PartialSuccessMethods(), c.PasswordAuthentication) } return nextMethods }, ServerVersion: fmt.Sprintf("SSH-2.0-%v", c.Banner), } if c.PasswordAuthentication { serverConfig.PasswordCallback = func(conn ssh.ConnMetadata, pass []byte) (*ssh.Permissions, error) { sp, err := c.validatePasswordCredentials(conn, pass) if err != nil { return nil, &authenticationError{err: fmt.Sprintf("could not validate password credentials: %v", err)} } return sp, nil } } if !c.ShouldBind() { return common.ErrNoBinding } if err := c.checkAndLoadHostKeys(configDir, serverConfig); err != nil { serviceStatus.HostKeys = nil return err } if err := c.initializeCertChecker(configDir); err != nil { return err } sftp.SetSFTPExtensions(sftpExtensions...) //nolint:errcheck // we configure valid SFTP Extensions so we cannot get an error c.configureSecurityOptions(serverConfig) c.configureKeyboardInteractiveAuth(serverConfig) c.configureLoginBanner(serverConfig, configDir) c.checkSSHCommands() exitChannel := make(chan error, 1) serviceStatus.Bindings = nil for _, binding := range c.Bindings { if !binding.IsValid() { continue } serviceStatus.Bindings = append(serviceStatus.Bindings, binding) go func(binding Binding) { addr := binding.GetAddress() utils.CheckTCP4Port(binding.Port) listener, err := net.Listen("tcp", addr) if err != nil { logger.Warn(logSender, "", "error starting listener on address %v: %v", addr, err) exitChannel <- err return } if binding.ApplyProxyConfig && common.Config.ProxyProtocol > 0 { proxyListener, err := common.Config.GetProxyListener(listener) if err != nil { logger.Warn(logSender, "", "error enabling proxy listener: %v", err) exitChannel <- err return } listener = proxyListener } exitChannel <- c.serve(listener, serverConfig) }(binding) } serviceStatus.IsActive = true serviceStatus.SSHCommands = c.EnabledSSHCommands return <-exitChannel } func (c *Configuration) serve(listener net.Listener, serverConfig *ssh.ServerConfig) error { logger.Info(logSender, "", "server listener registered, address: %v", listener.Addr().String()) var tempDelay time.Duration // how long to sleep on accept failure for { conn, err := listener.Accept() if err != nil { if ne, ok := err.(net.Error); ok && ne.Temporary() { if tempDelay == 0 { tempDelay = 5 * time.Millisecond } else { tempDelay *= 2 } if max := 1 * time.Second; tempDelay > max { tempDelay = max } logger.Warn(logSender, "", "accept error: %v; retrying in %v", err, tempDelay) time.Sleep(tempDelay) continue } logger.Warn(logSender, "", "unrecoverable accept error: %v", err) return err } go c.AcceptInboundConnection(conn, serverConfig) } } func (c *Configuration) configureSecurityOptions(serverConfig *ssh.ServerConfig) { if len(c.KexAlgorithms) > 0 { serverConfig.KeyExchanges = c.KexAlgorithms } if len(c.Ciphers) > 0 { serverConfig.Ciphers = c.Ciphers } if len(c.MACs) > 0 { serverConfig.MACs = c.MACs } } func (c *Configuration) configureLoginBanner(serverConfig *ssh.ServerConfig, configDir string) { if len(c.LoginBannerFile) > 0 { bannerFilePath := c.LoginBannerFile if !filepath.IsAbs(bannerFilePath) { bannerFilePath = filepath.Join(configDir, bannerFilePath) } bannerContent, err := os.ReadFile(bannerFilePath) if err == nil { banner := string(bannerContent) serverConfig.BannerCallback = func(conn ssh.ConnMetadata) string { return banner } } else { logger.WarnToConsole("unable to read SFTPD login banner file: %v", err) logger.Warn(logSender, "", "unable to read login banner file: %v", err) } } } func (c *Configuration) configureKeyboardInteractiveAuth(serverConfig *ssh.ServerConfig) { if c.KeyboardInteractiveHook == "" { return } if !strings.HasPrefix(c.KeyboardInteractiveHook, "http") { if !filepath.IsAbs(c.KeyboardInteractiveHook) { logger.WarnToConsole("invalid keyboard interactive authentication program: %#v must be an absolute path", c.KeyboardInteractiveHook) logger.Warn(logSender, "", "invalid keyboard interactive authentication program: %#v must be an absolute path", c.KeyboardInteractiveHook) return } _, err := os.Stat(c.KeyboardInteractiveHook) if err != nil { logger.WarnToConsole("invalid keyboard interactive authentication program:: %v", err) logger.Warn(logSender, "", "invalid keyboard interactive authentication program:: %v", err) return } } serverConfig.KeyboardInteractiveCallback = func(conn ssh.ConnMetadata, client ssh.KeyboardInteractiveChallenge) (*ssh.Permissions, error) { sp, err := c.validateKeyboardInteractiveCredentials(conn, client) if err != nil { return nil, &authenticationError{err: fmt.Sprintf("could not validate keyboard interactive credentials: %v", err)} } return sp, nil } } func canAcceptConnection(ip string) bool { if common.IsBanned(ip) { logger.Log(logger.LevelDebug, common.ProtocolSSH, "", "connection refused, ip %#v is banned", ip) return false } if !common.Connections.IsNewConnectionAllowed(ip) { logger.Log(logger.LevelDebug, common.ProtocolSSH, "", "connection refused, configured limit reached") return false } _, err := common.LimitRate(common.ProtocolSSH, ip) if err != nil { return false } if err := common.Config.ExecutePostConnectHook(ip, common.ProtocolSSH); err != nil { return false } return true } // AcceptInboundConnection handles an inbound connection to the server instance and determines if the request should be served or not. func (c *Configuration) AcceptInboundConnection(conn net.Conn, config *ssh.ServerConfig) { defer func() { if r := recover(); r != nil { logger.Error(logSender, "", "panic in AcceptInboundConnection: %#v stack strace: %v", r, string(debug.Stack())) } }() ipAddr := utils.GetIPFromRemoteAddress(conn.RemoteAddr().String()) common.Connections.AddClientConnection(ipAddr) defer common.Connections.RemoveClientConnection(ipAddr) if !canAcceptConnection(ipAddr) { conn.Close() return } // Before beginning a handshake must be performed on the incoming net.Conn // we'll set a Deadline for handshake to complete, the default is 2 minutes as OpenSSH conn.SetDeadline(time.Now().Add(handshakeTimeout)) //nolint:errcheck sconn, chans, reqs, err := ssh.NewServerConn(conn, config) if err != nil { logger.Debug(logSender, "", "failed to accept an incoming connection: %v", err) checkAuthError(ipAddr, err) return } // handshake completed so remove the deadline, we'll use IdleTimeout configuration from now on conn.SetDeadline(time.Time{}) //nolint:errcheck defer conn.Close() var user dataprovider.User // Unmarshal cannot fails here and even if it fails we'll have a user with no permissions json.Unmarshal([]byte(sconn.Permissions.Extensions["sftpgo_user"]), &user) //nolint:errcheck loginType := sconn.Permissions.Extensions["sftpgo_login_method"] connectionID := hex.EncodeToString(sconn.SessionID()) if err = user.CheckFsRoot(connectionID); err != nil { errClose := user.CloseFs() logger.Warn(logSender, connectionID, "unable to check fs root: %v close fs error: %v", err, errClose) return } defer user.CloseFs() //nolint:errcheck logger.Log(logger.LevelInfo, common.ProtocolSSH, connectionID, "User id: %d, logged in with: %#v, username: %#v, home_dir: %#v remote addr: %#v", user.ID, loginType, user.Username, user.HomeDir, ipAddr) dataprovider.UpdateLastLogin(&user) //nolint:errcheck sshConnection := common.NewSSHConnection(connectionID, conn) common.Connections.AddSSHConnection(sshConnection) defer common.Connections.RemoveSSHConnection(connectionID) go ssh.DiscardRequests(reqs) channelCounter := int64(0) for newChannel := range chans { // If its not a session channel we just move on because its not something we // know how to handle at this point. if newChannel.ChannelType() != "session" { logger.Log(logger.LevelDebug, common.ProtocolSSH, connectionID, "received an unknown channel type: %v", newChannel.ChannelType()) newChannel.Reject(ssh.UnknownChannelType, "unknown channel type") //nolint:errcheck continue } channel, requests, err := newChannel.Accept() if err != nil { logger.Log(logger.LevelWarn, common.ProtocolSSH, connectionID, "could not accept a channel: %v", err) continue } channelCounter++ sshConnection.UpdateLastActivity() // Channels have a type that is dependent on the protocol. For SFTP this is "subsystem" // with a payload that (should) be "sftp". Discard anything else we receive ("pty", "shell", etc) go func(in <-chan *ssh.Request, counter int64) { for req := range in { ok := false connID := fmt.Sprintf("%v_%v", connectionID, counter) switch req.Type { case "subsystem": if string(req.Payload[4:]) == "sftp" { ok = true connection := Connection{ BaseConnection: common.NewBaseConnection(connID, common.ProtocolSFTP, conn.RemoteAddr().String(), user), ClientVersion: string(sconn.ClientVersion()), RemoteAddr: conn.RemoteAddr(), channel: channel, } go c.handleSftpConnection(channel, &connection) } case "exec": // protocol will be set later inside processSSHCommand it could be SSH or SCP connection := Connection{ BaseConnection: common.NewBaseConnection(connID, "sshd_exec", conn.RemoteAddr().String(), user), ClientVersion: string(sconn.ClientVersion()), RemoteAddr: conn.RemoteAddr(), channel: channel, } ok = processSSHCommand(req.Payload, &connection, c.EnabledSSHCommands) } if req.WantReply { req.Reply(ok, nil) //nolint:errcheck } } }(requests, channelCounter) } } func (c *Configuration) handleSftpConnection(channel ssh.Channel, connection *Connection) { defer func() { if r := recover(); r != nil { logger.Error(logSender, "", "panic in handleSftpConnection: %#v stack strace: %v", r, string(debug.Stack())) } }() common.Connections.Add(connection) defer common.Connections.Remove(connection.GetID()) // Create a new handler for the currently logged in user's server. handler := c.createHandler(connection) // Create the server instance for the channel using the handler we created above. server := sftp.NewRequestServer(channel, handler, sftp.WithRSAllocator()) defer server.Close() if err := server.Serve(); err == io.EOF { connection.Log(logger.LevelDebug, "connection closed, sending exit status") exitStatus := sshSubsystemExitStatus{Status: uint32(0)} _, err = channel.SendRequest("exit-status", false, ssh.Marshal(&exitStatus)) connection.Log(logger.LevelDebug, "sent exit status %+v error: %v", exitStatus, err) } else if err != nil { connection.Log(logger.LevelWarn, "connection closed with error: %v", err) } } func (c *Configuration) createHandler(connection *Connection) sftp.Handlers { return sftp.Handlers{ FileGet: connection, FilePut: connection, FileCmd: connection, FileList: connection, } } func checkAuthError(ip string, err error) { if authErrors, ok := err.(*ssh.ServerAuthError); ok { // check public key auth errors here for _, err := range authErrors.Errors { if err != nil { // these checks should be improved, we should check for error type and not error strings if strings.Contains(err.Error(), "public key credentials") { event := common.HostEventLoginFailed if strings.Contains(err.Error(), "not found") { event = common.HostEventUserNotFound } common.AddDefenderEvent(ip, event) break } } } } else { logger.ConnectionFailedLog("", ip, dataprovider.LoginMethodNoAuthTryed, common.ProtocolSSH, err.Error()) metrics.AddNoAuthTryed() common.AddDefenderEvent(ip, common.HostEventNoLoginTried) dataprovider.ExecutePostLoginHook(&dataprovider.User{}, dataprovider.LoginMethodNoAuthTryed, ip, common.ProtocolSSH, err) } } func loginUser(user *dataprovider.User, loginMethod, publicKey string, conn ssh.ConnMetadata) (*ssh.Permissions, error) { connectionID := "" if conn != nil { connectionID = hex.EncodeToString(conn.SessionID()) } if !filepath.IsAbs(user.HomeDir) { logger.Warn(logSender, connectionID, "user %#v has an invalid home dir: %#v. Home dir must be an absolute path, login not allowed", user.Username, user.HomeDir) return nil, fmt.Errorf("cannot login user with invalid home dir: %#v", user.HomeDir) } if utils.IsStringInSlice(common.ProtocolSSH, user.Filters.DeniedProtocols) { logger.Debug(logSender, connectionID, "cannot login user %#v, protocol SSH is not allowed", user.Username) return nil, fmt.Errorf("protocol SSH is not allowed for user %#v", user.Username) } if user.MaxSessions > 0 { activeSessions := common.Connections.GetActiveSessions(user.Username) if activeSessions >= user.MaxSessions { logger.Debug(logSender, "", "authentication refused for user: %#v, too many open sessions: %v/%v", user.Username, activeSessions, user.MaxSessions) return nil, fmt.Errorf("too many open sessions: %v", activeSessions) } } if !user.IsLoginMethodAllowed(loginMethod, conn.PartialSuccessMethods()) { logger.Debug(logSender, connectionID, "cannot login user %#v, login method %#v is not allowed", user.Username, loginMethod) return nil, fmt.Errorf("login method %#v is not allowed for user %#v", loginMethod, user.Username) } remoteAddr := conn.RemoteAddr().String() if !user.IsLoginFromAddrAllowed(remoteAddr) { logger.Debug(logSender, connectionID, "cannot login user %#v, remote address is not allowed: %v", user.Username, remoteAddr) return nil, fmt.Errorf("login for user %#v is not allowed from this address: %v", user.Username, remoteAddr) } json, err := json.Marshal(user) if err != nil { logger.Warn(logSender, connectionID, "error serializing user info: %v, authentication rejected", err) return nil, err } if len(publicKey) > 0 { loginMethod = fmt.Sprintf("%v: %v", loginMethod, publicKey) } p := &ssh.Permissions{} p.Extensions = make(map[string]string) p.Extensions["sftpgo_user"] = string(json) p.Extensions["sftpgo_login_method"] = loginMethod return p, nil } func (c *Configuration) checkSSHCommands() { if utils.IsStringInSlice("*", c.EnabledSSHCommands) { c.EnabledSSHCommands = GetSupportedSSHCommands() return } sshCommands := []string{} for _, command := range c.EnabledSSHCommands { if utils.IsStringInSlice(command, supportedSSHCommands) { sshCommands = append(sshCommands, command) } else { logger.Warn(logSender, "", "unsupported ssh command: %#v ignored", command) logger.WarnToConsole("unsupported ssh command: %#v ignored", command) } } c.EnabledSSHCommands = sshCommands } func (c *Configuration) generateDefaultHostKeys(configDir string) error { var err error defaultHostKeys := []string{defaultPrivateRSAKeyName, defaultPrivateECDSAKeyName, defaultPrivateEd25519KeyName} for _, k := range defaultHostKeys { autoFile := filepath.Join(configDir, k) if _, err = os.Stat(autoFile); os.IsNotExist(err) { logger.Info(logSender, "", "No host keys configured and %#v does not exist; try to create a new host key", autoFile) logger.InfoToConsole("No host keys configured and %#v does not exist; try to create a new host key", autoFile) if k == defaultPrivateRSAKeyName { err = utils.GenerateRSAKeys(autoFile) } else if k == defaultPrivateECDSAKeyName { err = utils.GenerateECDSAKeys(autoFile) } else { err = utils.GenerateEd25519Keys(autoFile) } if err != nil { logger.Warn(logSender, "", "error creating host key %#v: %v", autoFile, err) logger.WarnToConsole("error creating host key %#v: %v", autoFile, err) return err } } c.HostKeys = append(c.HostKeys, k) } return err } func (c *Configuration) checkHostKeyAutoGeneration(configDir string) error { for _, k := range c.HostKeys { if filepath.IsAbs(k) { if _, err := os.Stat(k); os.IsNotExist(err) { keyName := filepath.Base(k) switch keyName { case defaultPrivateRSAKeyName: logger.Info(logSender, "", "try to create non-existent host key %#v", k) logger.InfoToConsole("try to create non-existent host key %#v", k) err = utils.GenerateRSAKeys(k) if err != nil { logger.Warn(logSender, "", "error creating host key %#v: %v", k, err) logger.WarnToConsole("error creating host key %#v: %v", k, err) return err } case defaultPrivateECDSAKeyName: logger.Info(logSender, "", "try to create non-existent host key %#v", k) logger.InfoToConsole("try to create non-existent host key %#v", k) err = utils.GenerateECDSAKeys(k) if err != nil { logger.Warn(logSender, "", "error creating host key %#v: %v", k, err) logger.WarnToConsole("error creating host key %#v: %v", k, err) return err } case defaultPrivateEd25519KeyName: logger.Info(logSender, "", "try to create non-existent host key %#v", k) logger.InfoToConsole("try to create non-existent host key %#v", k) err = utils.GenerateEd25519Keys(k) if err != nil { logger.Warn(logSender, "", "error creating host key %#v: %v", k, err) logger.WarnToConsole("error creating host key %#v: %v", k, err) return err } default: logger.Warn(logSender, "", "non-existent host key %#v will not be created", k) logger.WarnToConsole("non-existent host key %#v will not be created", k) } } } } if len(c.HostKeys) == 0 { if err := c.generateDefaultHostKeys(configDir); err != nil { return err } } return nil } // If no host keys are defined we try to use or generate the default ones. func (c *Configuration) checkAndLoadHostKeys(configDir string, serverConfig *ssh.ServerConfig) error { if err := c.checkHostKeyAutoGeneration(configDir); err != nil { return err } serviceStatus.HostKeys = nil for _, hostKey := range c.HostKeys { if !utils.IsFileInputValid(hostKey) { logger.Warn(logSender, "", "unable to load invalid host key %#v", hostKey) logger.WarnToConsole("unable to load invalid host key %#v", hostKey) continue } if !filepath.IsAbs(hostKey) { hostKey = filepath.Join(configDir, hostKey) } logger.Info(logSender, "", "Loading private host key %#v", hostKey) privateBytes, err := os.ReadFile(hostKey) if err != nil { return err } private, err := ssh.ParsePrivateKey(privateBytes) if err != nil { return err } k := HostKey{ Path: hostKey, Fingerprint: ssh.FingerprintSHA256(private.PublicKey()), } serviceStatus.HostKeys = append(serviceStatus.HostKeys, k) logger.Info(logSender, "", "Host key %#v loaded, type %#v, fingerprint %#v", hostKey, private.PublicKey().Type(), k.Fingerprint) // Add private key to the server configuration. serverConfig.AddHostKey(private) } var fp []string for idx := range serviceStatus.HostKeys { h := &serviceStatus.HostKeys[idx] fp = append(fp, h.Fingerprint) } vfs.SetSFTPFingerprints(fp) return nil } func (c *Configuration) initializeCertChecker(configDir string) error { for _, keyPath := range c.TrustedUserCAKeys { if !utils.IsFileInputValid(keyPath) { logger.Warn(logSender, "", "unable to load invalid trusted user CA key: %#v", keyPath) logger.WarnToConsole("unable to load invalid trusted user CA key: %#v", keyPath) continue } if !filepath.IsAbs(keyPath) { keyPath = filepath.Join(configDir, keyPath) } keyBytes, err := os.ReadFile(keyPath) if err != nil { logger.Warn(logSender, "", "error loading trusted user CA key %#v: %v", keyPath, err) logger.WarnToConsole("error loading trusted user CA key %#v: %v", keyPath, err) return err } parsedKey, _, _, _, err := ssh.ParseAuthorizedKey(keyBytes) if err != nil { logger.Warn(logSender, "", "error parsing trusted user CA key %#v: %v", keyPath, err) logger.WarnToConsole("error parsing trusted user CA key %#v: %v", keyPath, err) return err } c.parsedUserCAKeys = append(c.parsedUserCAKeys, parsedKey) } c.certChecker = &ssh.CertChecker{ SupportedCriticalOptions: []string{ sourceAddressCriticalOption, }, IsUserAuthority: func(k ssh.PublicKey) bool { for _, key := range c.parsedUserCAKeys { if bytes.Equal(k.Marshal(), key.Marshal()) { return true } } return false }, } return nil } func (c *Configuration) validatePublicKeyCredentials(conn ssh.ConnMetadata, pubKey ssh.PublicKey) (*ssh.Permissions, error) { var err error var user dataprovider.User var keyID string var sshPerm *ssh.Permissions var certPerm *ssh.Permissions connectionID := hex.EncodeToString(conn.SessionID()) method := dataprovider.SSHLoginMethodPublicKey ipAddr := utils.GetIPFromRemoteAddress(conn.RemoteAddr().String()) cert, ok := pubKey.(*ssh.Certificate) if ok { if cert.CertType != ssh.UserCert { err = fmt.Errorf("ssh: cert has type %d", cert.CertType) user.Username = conn.User() updateLoginMetrics(&user, ipAddr, method, err) return nil, err } if !c.certChecker.IsUserAuthority(cert.SignatureKey) { err = fmt.Errorf("ssh: certificate signed by unrecognized authority") user.Username = conn.User() updateLoginMetrics(&user, ipAddr, method, err) return nil, err } if err := c.certChecker.CheckCert(conn.User(), cert); err != nil { user.Username = conn.User() updateLoginMetrics(&user, ipAddr, method, err) return nil, err } certPerm = &cert.Permissions } if user, keyID, err = dataprovider.CheckUserAndPubKey(conn.User(), pubKey.Marshal(), ipAddr, common.ProtocolSSH); err == nil { if user.IsPartialAuth(method) { logger.Debug(logSender, connectionID, "user %#v authenticated with partial success", conn.User()) return certPerm, ssh.ErrPartialSuccess } sshPerm, err = loginUser(&user, method, keyID, conn) if err == nil && certPerm != nil { // if we have a SSH user cert we need to merge certificate permissions with our ones // we only set Extensions, so CriticalOptions are always the ones from the certificate sshPerm.CriticalOptions = certPerm.CriticalOptions if certPerm.Extensions != nil { for k, v := range certPerm.Extensions { sshPerm.Extensions[k] = v } } } } user.Username = conn.User() updateLoginMetrics(&user, ipAddr, method, err) return sshPerm, err } func (c *Configuration) validatePasswordCredentials(conn ssh.ConnMetadata, pass []byte) (*ssh.Permissions, error) { var err error var user dataprovider.User var sshPerm *ssh.Permissions method := dataprovider.LoginMethodPassword if len(conn.PartialSuccessMethods()) == 1 { method = dataprovider.SSHLoginMethodKeyAndPassword } ipAddr := utils.GetIPFromRemoteAddress(conn.RemoteAddr().String()) if user, err = dataprovider.CheckUserAndPass(conn.User(), string(pass), ipAddr, common.ProtocolSSH); err == nil { sshPerm, err = loginUser(&user, method, "", conn) } user.Username = conn.User() updateLoginMetrics(&user, ipAddr, method, err) return sshPerm, err } func (c *Configuration) validateKeyboardInteractiveCredentials(conn ssh.ConnMetadata, client ssh.KeyboardInteractiveChallenge) (*ssh.Permissions, error) { var err error var user dataprovider.User var sshPerm *ssh.Permissions method := dataprovider.SSHLoginMethodKeyboardInteractive if len(conn.PartialSuccessMethods()) == 1 { method = dataprovider.SSHLoginMethodKeyAndKeyboardInt } ipAddr := utils.GetIPFromRemoteAddress(conn.RemoteAddr().String()) if user, err = dataprovider.CheckKeyboardInteractiveAuth(conn.User(), c.KeyboardInteractiveHook, client, ipAddr, common.ProtocolSSH); err == nil { sshPerm, err = loginUser(&user, method, "", conn) } user.Username = conn.User() updateLoginMetrics(&user, ipAddr, method, err) return sshPerm, err } func updateLoginMetrics(user *dataprovider.User, ip, method string, err error) { metrics.AddLoginAttempt(method) if err != nil { logger.ConnectionFailedLog(user.Username, ip, method, common.ProtocolSSH, err.Error()) if method != dataprovider.SSHLoginMethodPublicKey { // some clients try all available public keys for a user, we // record failed login key auth only once for session if the // authentication fails in checkAuthError event := common.HostEventLoginFailed if _, ok := err.(*dataprovider.RecordNotFoundError); ok { event = common.HostEventUserNotFound } common.AddDefenderEvent(ip, event) } } metrics.AddLoginResult(method, err) dataprovider.ExecutePostLoginHook(user, method, ip, common.ProtocolSSH, err) }