12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220 |
- // Copyright (C) 2019-2023 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 sftpd
- import (
- "bytes"
- "encoding/hex"
- "encoding/json"
- "errors"
- "fmt"
- "io"
- "io/fs"
- "net"
- "os"
- "path"
- "path/filepath"
- "runtime/debug"
- "strings"
- "sync"
- "time"
- "github.com/pkg/sftp"
- "golang.org/x/crypto/ssh"
- "github.com/drakkan/sftpgo/v2/internal/common"
- "github.com/drakkan/sftpgo/v2/internal/dataprovider"
- "github.com/drakkan/sftpgo/v2/internal/logger"
- "github.com/drakkan/sftpgo/v2/internal/metric"
- "github.com/drakkan/sftpgo/v2/internal/util"
- "github.com/drakkan/sftpgo/v2/internal/vfs"
- )
- const (
- defaultPrivateRSAKeyName = "id_rsa"
- defaultPrivateECDSAKeyName = "id_ecdsa"
- defaultPrivateEd25519KeyName = "id_ed25519"
- sourceAddressCriticalOption = "source-address"
- )
- var (
- sftpExtensions = []string{"[email protected]"}
- supportedHostKeyAlgos = []string{
- ssh.CertAlgoRSASHA512v01, ssh.CertAlgoRSASHA256v01,
- ssh.CertAlgoRSAv01, ssh.CertAlgoDSAv01, ssh.CertAlgoECDSA256v01,
- ssh.CertAlgoECDSA384v01, ssh.CertAlgoECDSA521v01, ssh.CertAlgoED25519v01,
- ssh.KeyAlgoECDSA256, ssh.KeyAlgoECDSA384, ssh.KeyAlgoECDSA521,
- ssh.KeyAlgoRSASHA512, ssh.KeyAlgoRSASHA256,
- ssh.KeyAlgoRSA, ssh.KeyAlgoDSA,
- ssh.KeyAlgoED25519,
- }
- preferredHostKeyAlgos = []string{
- ssh.CertAlgoRSASHA512v01, ssh.CertAlgoRSASHA256v01,
- ssh.CertAlgoECDSA256v01,
- ssh.CertAlgoECDSA384v01, ssh.CertAlgoECDSA521v01, ssh.CertAlgoED25519v01,
- ssh.KeyAlgoECDSA256, ssh.KeyAlgoECDSA384, ssh.KeyAlgoECDSA521,
- ssh.KeyAlgoRSASHA512, ssh.KeyAlgoRSASHA256,
- ssh.KeyAlgoED25519,
- }
- supportedKexAlgos = []string{
- "curve25519-sha256", "[email protected]",
- "ecdh-sha2-nistp256", "ecdh-sha2-nistp384", "ecdh-sha2-nistp521",
- "diffie-hellman-group14-sha256", "diffie-hellman-group16-sha512",
- "diffie-hellman-group18-sha512", "diffie-hellman-group14-sha1",
- "diffie-hellman-group1-sha1",
- }
- supportedCiphers = []string{
- "[email protected]", "[email protected]",
- "[email protected]",
- "aes128-ctr", "aes192-ctr", "aes256-ctr",
- "aes128-cbc", "aes192-cbc", "aes256-cbc",
- "3des-cbc",
- "arcfour", "arcfour128", "arcfour256",
- }
- supportedMACs = []string{
- "[email protected]", "hmac-sha2-256",
- "[email protected]", "hmac-sha2-512",
- "hmac-sha1", "hmac-sha1-96",
- }
- revokedCertManager = revokedCertificates{
- certs: map[string]bool{},
- }
- sftpAuthError = newAuthenticationError(nil, "")
- )
- // 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"`
- // 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"`
- // 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"`
- // HostCertificates defines public host certificates.
- // Each certificate can be defined as a path relative to the configuration directory or an absolute one.
- // Certificate's public key must match a private host key otherwise it will be silently ignored.
- HostCertificates []string `json:"host_certificates" mapstructure:"host_certificates"`
- // HostKeyAlgorithms lists the public key algorithms that the server will accept for host
- // key authentication.
- HostKeyAlgorithms []string `json:"host_key_algorithms" mapstructure:"host_key_algorithms"`
- // Diffie-Hellman moduli files.
- // Each moduli file can be defined as a path relative to the configuration directory or an absolute one.
- // If set, "diffie-hellman-group-exchange-sha256" and "diffie-hellman-group-exchange-sha1" KEX algorithms
- // will be available, `diffie-hellman-group-exchange-sha256` will be enabled by default if you
- // don't explicitly set KEXs
- Moduli []string `json:"moduli" mapstructure:"moduli"`
- // 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"`
- // Path to a file containing the revoked user certificates.
- // This file must contain a JSON list with the public key fingerprints of the revoked certificates.
- // Example content:
- // ["SHA256:bsBRHC/xgiqBJdSuvSTNpJNLTISP/G356jNMCRYC5Es","SHA256:119+8cL/HH+NLMawRsJx6CzPF1I3xC+jpM60bQHXGE8"]
- RevokedUserCertsFile string `json:"revoked_user_certs_file" mapstructure:"revoked_user_certs_file"`
- // 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"`
- // 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"`
- // KeyboardInteractiveAuthentication specifies whether keyboard interactive authentication is allowed.
- // If no keyboard interactive hook or auth plugin is defined the default is to prompt for the user password and then the
- // one time authentication code, if defined.
- KeyboardInteractiveAuthentication bool `json:"keyboard_interactive_authentication" mapstructure:"keyboard_interactive_authentication"`
- // 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"`
- // Virtual root folder prefix to include in all file operations (ex: /files).
- // The virtual paths used for per-directory permissions, file patterns etc. must not include the folder prefix.
- // The prefix is only applied to SFTP requests, SCP and other SSH commands will be automatically disabled if
- // you configure a prefix.
- // This setting can help some migrations from OpenSSH. It is not recommended for general usage.
- FolderPrefix string `json:"folder_prefix" mapstructure:"folder_prefix"`
- certChecker *ssh.CertChecker
- parsedUserCAKeys []ssh.PublicKey
- }
- type authenticationError struct {
- err error
- loginMethod string
- }
- func (e *authenticationError) Error() string {
- return fmt.Sprintf("Authentication error: %v", e.err)
- }
- // Is reports if target matches
- func (e *authenticationError) Is(target error) bool {
- _, ok := target.(*authenticationError)
- return ok
- }
- // Unwrap returns the wrapped error
- func (e *authenticationError) Unwrap() error {
- return e.err
- }
- func (e *authenticationError) getLoginMethod() string {
- return e.loginMethod
- }
- func newAuthenticationError(err error, loginMethod string) *authenticationError {
- return &authenticationError{err: err, loginMethod: loginMethod}
- }
- // 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
- }
- func (c *Configuration) getServerConfig() *ssh.ServerConfig {
- 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, newAuthenticationError(fmt.Errorf("could not validate public key credentials: %w", err),
- dataprovider.SSHLoginMethodPublicKey)
- }
- return sp, nil
- },
- NextAuthMethodsCallback: func(conn ssh.ConnMetadata) []string {
- var nextMethods []string
- user, err := dataprovider.GetUserWithGroupSettings(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, newAuthenticationError(fmt.Errorf("could not validate password credentials: %w", err),
- dataprovider.SSHLoginMethodPassword)
- }
- return sp, nil
- }
- serviceStatus.Authentications = append(serviceStatus.Authentications, dataprovider.LoginMethodPassword)
- }
- serviceStatus.Authentications = append(serviceStatus.Authentications, dataprovider.SSHLoginMethodPublicKey)
- return serverConfig
- }
- func (c *Configuration) updateSupportedAuthentications() {
- serviceStatus.Authentications = util.RemoveDuplicates(serviceStatus.Authentications, false)
- if util.Contains(serviceStatus.Authentications, dataprovider.LoginMethodPassword) &&
- util.Contains(serviceStatus.Authentications, dataprovider.SSHLoginMethodPublicKey) {
- serviceStatus.Authentications = append(serviceStatus.Authentications, dataprovider.SSHLoginMethodKeyAndPassword)
- }
- if util.Contains(serviceStatus.Authentications, dataprovider.SSHLoginMethodKeyboardInteractive) &&
- util.Contains(serviceStatus.Authentications, dataprovider.SSHLoginMethodPublicKey) {
- serviceStatus.Authentications = append(serviceStatus.Authentications, dataprovider.SSHLoginMethodKeyAndKeyboardInt)
- }
- }
- // Initialize the SFTP server and add a persistent listener to handle inbound SFTP connections.
- func (c *Configuration) Initialize(configDir string) error {
- serviceStatus.Authentications = nil
- serverConfig := c.getServerConfig()
- 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
- }
- if err := c.loadModuli(configDir); err != nil {
- return err
- }
- sftp.SetSFTPExtensions(sftpExtensions...) //nolint:errcheck // we configure valid SFTP Extensions so we cannot get an error
- if err := c.configureSecurityOptions(serverConfig); err != nil {
- return err
- }
- c.configureKeyboardInteractiveAuth(serverConfig)
- c.configureLoginBanner(serverConfig, configDir)
- c.checkSSHCommands()
- c.checkFolderPrefix()
- 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()
- util.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
- c.updateSupportedAuthentications()
- 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 {
- // see https://github.com/golang/go/blob/4aa1efed4853ea067d665a952eee77c52faac774/src/net/http/server.go#L3046
- if ne, ok := err.(net.Error); ok && ne.Temporary() { //nolint:staticcheck
- 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
- }
- tempDelay = 0
- go c.AcceptInboundConnection(conn, serverConfig)
- }
- }
- func (c *Configuration) configureSecurityOptions(serverConfig *ssh.ServerConfig) error {
- if len(c.HostKeyAlgorithms) == 0 {
- c.HostKeyAlgorithms = preferredHostKeyAlgos
- } else {
- c.HostKeyAlgorithms = util.RemoveDuplicates(c.HostKeyAlgorithms, true)
- }
- for _, hostKeyAlgo := range c.HostKeyAlgorithms {
- if !util.Contains(supportedHostKeyAlgos, hostKeyAlgo) {
- return fmt.Errorf("unsupported host key algorithm %#v", hostKeyAlgo)
- }
- }
- serverConfig.HostKeyAlgorithms = c.HostKeyAlgorithms
- if len(c.KexAlgorithms) > 0 {
- c.KexAlgorithms = util.RemoveDuplicates(c.KexAlgorithms, true)
- for _, kex := range c.KexAlgorithms {
- if !util.Contains(supportedKexAlgos, kex) {
- return fmt.Errorf("unsupported key-exchange algorithm %#v", kex)
- }
- }
- serverConfig.KeyExchanges = c.KexAlgorithms
- }
- if len(c.Ciphers) > 0 {
- c.Ciphers = util.RemoveDuplicates(c.Ciphers, true)
- for _, cipher := range c.Ciphers {
- if !util.Contains(supportedCiphers, cipher) {
- return fmt.Errorf("unsupported cipher %#v", cipher)
- }
- }
- serverConfig.Ciphers = c.Ciphers
- }
- if len(c.MACs) > 0 {
- c.MACs = util.RemoveDuplicates(c.MACs, true)
- for _, mac := range c.MACs {
- if !util.Contains(supportedMACs, mac) {
- return fmt.Errorf("unsupported MAC algorithm %#v", mac)
- }
- }
- serverConfig.MACs = c.MACs
- }
- return nil
- }
- 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.KeyboardInteractiveAuthentication {
- return
- }
- if c.KeyboardInteractiveHook != "" {
- if !strings.HasPrefix(c.KeyboardInteractiveHook, "http") {
- if !filepath.IsAbs(c.KeyboardInteractiveHook) {
- logger.WarnToConsole("invalid keyboard interactive authentication program: %q must be an absolute path",
- c.KeyboardInteractiveHook)
- logger.Warn(logSender, "", "invalid keyboard interactive authentication program: %q 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, newAuthenticationError(fmt.Errorf("could not validate keyboard interactive credentials: %w", err),
- dataprovider.SSHLoginMethodKeyboardInteractive)
- }
- return sp, nil
- }
- serviceStatus.Authentications = append(serviceStatus.Authentications, dataprovider.SSHLoginMethodKeyboardInteractive)
- }
- func canAcceptConnection(ip string) bool {
- if common.IsBanned(ip, common.ProtocolSSH) {
- logger.Log(logger.LevelDebug, common.ProtocolSSH, "", "connection refused, ip %#v is banned", ip)
- return false
- }
- if err := common.Connections.IsNewConnectionAllowed(ip, common.ProtocolSSH); err != nil {
- logger.Log(logger.LevelDebug, common.ProtocolSSH, "", "connection not allowed from ip %q: %v", ip, err)
- 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 trace: %v", r, string(debug.Stack()))
- }
- }()
- ipAddr := util.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())
- defer user.CloseFs() //nolint:errcheck
- if err = user.CheckFsRoot(connectionID); err != nil {
- logger.Warn(logSender, connectionID, "unable to check fs root: %v", err)
- return
- }
- logger.Log(logger.LevelInfo, common.ProtocolSSH, connectionID,
- "User %q logged in with %q, from ip %q, client version %q", user.Username, loginType,
- ipAddr, string(sconn.ClientVersion()))
- dataprovider.UpdateLastLogin(&user)
- 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("%s_%d", connectionID, counter)
- switch req.Type {
- case "subsystem":
- if string(req.Payload[4:]) == "sftp" {
- ok = true
- connection := &Connection{
- BaseConnection: common.NewBaseConnection(connID, common.ProtocolSFTP, conn.LocalAddr().String(),
- conn.RemoteAddr().String(), user),
- ClientVersion: string(sconn.ClientVersion()),
- RemoteAddr: conn.RemoteAddr(),
- LocalAddr: conn.LocalAddr(),
- channel: channel,
- folderPrefix: c.FolderPrefix,
- }
- 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.LocalAddr().String(),
- conn.RemoteAddr().String(), user),
- ClientVersion: string(sconn.ClientVersion()),
- RemoteAddr: conn.RemoteAddr(),
- LocalAddr: conn.LocalAddr(),
- channel: channel,
- folderPrefix: c.FolderPrefix,
- }
- 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 trace: %v", r, string(debug.Stack()))
- }
- }()
- if err := common.Connections.Add(connection); err != nil {
- errClose := connection.Disconnect()
- logger.Info(logSender, "", "unable to add connection: %v, close err: %v", err, errClose)
- return
- }
- defer common.Connections.Remove(connection.GetID())
- // Create the server instance for the channel using the handler we created above.
- server := sftp.NewRequestServer(channel, c.createHandlers(connection), sftp.WithRSAllocator(),
- sftp.WithStartDirectory(connection.User.Filters.StartDirectory))
- defer server.Close()
- if err := server.Serve(); errors.Is(err, io.EOF) {
- exitStatus := sshSubsystemExitStatus{Status: uint32(0)}
- _, err = channel.SendRequest("exit-status", false, ssh.Marshal(&exitStatus))
- connection.Log(logger.LevelInfo, "connection closed, sent exit status %+v error: %v", exitStatus, err)
- } else if err != nil {
- connection.Log(logger.LevelError, "connection closed with error: %v", err)
- }
- }
- func (c *Configuration) createHandlers(connection *Connection) sftp.Handlers {
- if c.FolderPrefix != "" {
- prefixMiddleware := newPrefixMiddleware(c.FolderPrefix, connection)
- return sftp.Handlers{
- FileGet: prefixMiddleware,
- FilePut: prefixMiddleware,
- FileCmd: prefixMiddleware,
- FileList: prefixMiddleware,
- }
- }
- 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 {
- var sftpAuthErr *authenticationError
- if errors.As(err, &sftpAuthErr) {
- if sftpAuthErr.getLoginMethod() == dataprovider.SSHLoginMethodPublicKey {
- event := common.HostEventLoginFailed
- if errors.Is(err, util.ErrNotFound) {
- event = common.HostEventUserNotFound
- }
- common.AddDefenderEvent(ip, common.ProtocolSSH, event)
- return
- }
- }
- }
- } else {
- logger.ConnectionFailedLog("", ip, dataprovider.LoginMethodNoAuthTryed, common.ProtocolSSH, err.Error())
- metric.AddNoAuthTryed()
- common.AddDefenderEvent(ip, common.ProtocolSSH, 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 util.Contains(user.Filters.DeniedProtocols, common.ProtocolSSH) {
- logger.Info(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.Info(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, common.ProtocolSSH, conn.PartialSuccessMethods()) {
- logger.Info(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)
- }
- if user.MustSetSecondFactorForProtocol(common.ProtocolSSH) {
- logger.Info(logSender, connectionID, "cannot login user %#v, second factor authentication is not set",
- user.Username)
- return nil, fmt.Errorf("second factor authentication is not set for user %#v", user.Username)
- }
- remoteAddr := conn.RemoteAddr().String()
- if !user.IsLoginFromAddrAllowed(remoteAddr) {
- logger.Info(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 publicKey != "" {
- 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 util.Contains(c.EnabledSSHCommands, "*") {
- c.EnabledSSHCommands = GetSupportedSSHCommands()
- return
- }
- sshCommands := []string{}
- for _, command := range c.EnabledSSHCommands {
- command = strings.TrimSpace(command)
- if util.Contains(supportedSSHCommands, command) {
- 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
- logger.Debug(logSender, "", "enabled SSH commands %v", c.EnabledSSHCommands)
- }
- func (c *Configuration) checkFolderPrefix() {
- if c.FolderPrefix != "" {
- c.FolderPrefix = path.Join("/", c.FolderPrefix)
- if c.FolderPrefix == "/" {
- c.FolderPrefix = ""
- }
- }
- if c.FolderPrefix != "" {
- c.EnabledSSHCommands = nil
- logger.Debug(logSender, "", "folder prefix %#v configured, SSH commands are disabled", c.FolderPrefix)
- }
- }
- 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); errors.Is(err, fs.ErrNotExist) {
- 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 = util.GenerateRSAKeys(autoFile)
- } else if k == defaultPrivateECDSAKeyName {
- err = util.GenerateECDSAKeys(autoFile)
- } else {
- err = util.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 {
- k = strings.TrimSpace(k)
- if filepath.IsAbs(k) {
- if _, err := os.Stat(k); errors.Is(err, fs.ErrNotExist) {
- 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 = util.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 = util.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 = util.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
- }
- func (c *Configuration) loadModuli(configDir string) error {
- supportedKexAlgos = util.Remove(supportedKexAlgos, "diffie-hellman-group-exchange-sha1")
- supportedKexAlgos = util.Remove(supportedKexAlgos, "diffie-hellman-group-exchange-sha256")
- for _, m := range c.Moduli {
- m = strings.TrimSpace(m)
- if !util.IsFileInputValid(m) {
- logger.Warn(logSender, "", "unable to load invalid moduli file %q", m)
- logger.WarnToConsole("unable to load invalid host moduli file %q", m)
- continue
- }
- if !filepath.IsAbs(m) {
- m = filepath.Join(configDir, m)
- }
- logger.Info(logSender, "", "loading moduli file %q", m)
- if err := ssh.ParseModuli(m); err != nil {
- return err
- }
- supportedKexAlgos = append(supportedKexAlgos, "diffie-hellman-group-exchange-sha1",
- "diffie-hellman-group-exchange-sha256")
- }
- 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
- }
- hostCertificates, err := c.loadHostCertificates(configDir)
- if err != nil {
- return err
- }
- serviceStatus.HostKeys = nil
- for _, hostKey := range c.HostKeys {
- hostKey = strings.TrimSpace(hostKey)
- if !util.IsFileInputValid(hostKey) {
- logger.Warn(logSender, "", "unable to load invalid host key %q", hostKey)
- logger.WarnToConsole("unable to load invalid host key %q", hostKey)
- continue
- }
- if !filepath.IsAbs(hostKey) {
- hostKey = filepath.Join(configDir, hostKey)
- }
- logger.Info(logSender, "", "Loading private host key %q", 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)
- for _, cert := range hostCertificates {
- signer, err := ssh.NewCertSigner(cert, private)
- if err == nil {
- serverConfig.AddHostKey(signer)
- logger.Info(logSender, "", "Host certificate loaded for host key %#v, fingerprint %#v",
- hostKey, ssh.FingerprintSHA256(signer.PublicKey()))
- }
- }
- }
- 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) loadHostCertificates(configDir string) ([]*ssh.Certificate, error) {
- var certs []*ssh.Certificate
- for _, certPath := range c.HostCertificates {
- certPath = strings.TrimSpace(certPath)
- if !util.IsFileInputValid(certPath) {
- logger.Warn(logSender, "", "unable to load invalid host certificate %#v", certPath)
- logger.WarnToConsole("unable to load invalid host certificate %#v", certPath)
- continue
- }
- if !filepath.IsAbs(certPath) {
- certPath = filepath.Join(configDir, certPath)
- }
- certBytes, err := os.ReadFile(certPath)
- if err != nil {
- return certs, fmt.Errorf("unable to load host certificate %#v: %w", certPath, err)
- }
- parsed, _, _, _, err := ssh.ParseAuthorizedKey(certBytes)
- if err != nil {
- return nil, fmt.Errorf("unable to parse host certificate %#v: %w", certPath, err)
- }
- cert, ok := parsed.(*ssh.Certificate)
- if !ok {
- return nil, fmt.Errorf("the file %#v is not an SSH certificate", certPath)
- }
- if cert.CertType != ssh.HostCert {
- return nil, fmt.Errorf("the file %#v is not an host certificate", certPath)
- }
- certs = append(certs, cert)
- }
- return certs, nil
- }
- func (c *Configuration) initializeCertChecker(configDir string) error {
- for _, keyPath := range c.TrustedUserCAKeys {
- keyPath = strings.TrimSpace(keyPath)
- if !util.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
- },
- }
- if c.RevokedUserCertsFile != "" {
- if !util.IsFileInputValid(c.RevokedUserCertsFile) {
- return fmt.Errorf("invalid revoked user certificate: %#v", c.RevokedUserCertsFile)
- }
- if !filepath.IsAbs(c.RevokedUserCertsFile) {
- c.RevokedUserCertsFile = filepath.Join(configDir, c.RevokedUserCertsFile)
- }
- }
- revokedCertManager.filePath = c.RevokedUserCertsFile
- return revokedCertManager.load()
- }
- 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 := util.GetIPFromRemoteAddress(conn.RemoteAddr().String())
- cert, ok := pubKey.(*ssh.Certificate)
- var certFingerprint string
- if ok {
- certFingerprint = ssh.FingerprintSHA256(cert.Key)
- 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 = errors.New("ssh: certificate signed by unrecognized authority")
- user.Username = conn.User()
- updateLoginMetrics(&user, ipAddr, method, err)
- return nil, err
- }
- if len(cert.ValidPrincipals) == 0 {
- err = fmt.Errorf("ssh: certificate %s has no valid principals, user: \"%s\"", certFingerprint, conn.User())
- user.Username = conn.User()
- updateLoginMetrics(&user, ipAddr, method, err)
- return nil, err
- }
- if revokedCertManager.isRevoked(certFingerprint) {
- err = fmt.Errorf("ssh: certificate %s is revoked", certFingerprint)
- 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, ok); err == nil {
- if ok {
- keyID = fmt.Sprintf("%s: ID: %s, serial: %v, CA %s %s", certFingerprint,
- cert.KeyId, cert.Serial, cert.Type(), ssh.FingerprintSHA256(cert.SignatureKey))
- }
- if user.IsPartialAuth(method) {
- logger.Debug(logSender, connectionID, "user %q 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 := util.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 := util.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) {
- metric.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 errors.Is(err, util.ErrNotFound) {
- event = common.HostEventUserNotFound
- }
- common.AddDefenderEvent(ip, common.ProtocolSSH, event)
- }
- }
- metric.AddLoginResult(method, err)
- dataprovider.ExecutePostLoginHook(user, method, ip, common.ProtocolSSH, err)
- }
- type revokedCertificates struct {
- filePath string
- mu sync.RWMutex
- certs map[string]bool
- }
- func (r *revokedCertificates) load() error {
- if r.filePath == "" {
- return nil
- }
- logger.Debug(logSender, "", "loading revoked user certificate file %#v", r.filePath)
- info, err := os.Stat(r.filePath)
- if err != nil {
- return fmt.Errorf("unable to load revoked user certificate file %#v: %w", r.filePath, err)
- }
- maxSize := int64(1048576 * 5) // 5MB
- if info.Size() > maxSize {
- return fmt.Errorf("unable to load revoked user certificate file %#v size too big: %v/%v bytes",
- r.filePath, info.Size(), maxSize)
- }
- content, err := os.ReadFile(r.filePath)
- if err != nil {
- return fmt.Errorf("unable to read revoked user certificate file %#v: %w", r.filePath, err)
- }
- var certs []string
- err = json.Unmarshal(content, &certs)
- if err != nil {
- return fmt.Errorf("unable to parse revoked user certificate file %#v: %w", r.filePath, err)
- }
- r.mu.Lock()
- defer r.mu.Unlock()
- r.certs = map[string]bool{}
- for _, fp := range certs {
- r.certs[fp] = true
- }
- logger.Debug(logSender, "", "revoked user certificate file %#v loaded, entries: %v", r.filePath, len(r.certs))
- return nil
- }
- func (r *revokedCertificates) isRevoked(fp string) bool {
- r.mu.RLock()
- defer r.mu.RUnlock()
- return r.certs[fp]
- }
- // Reload reloads the list of revoked user certificates
- func Reload() error {
- return revokedCertManager.load()
- }
|