Mirrors/sftpgo
1
0
Fork 0
mirror of https://github.com/drakkan/sftpgo.git synced 2025-12-07 06:40:54 +03:00
Code Issues Packages Projects Releases Wiki Activity

Refactor the logging system

Browse Source 
* created a "Log" function for type "Connection"
* created a "log" function for type "Provider"
* replace logger calls to Log/log where possible

I also renamed PGSSQL to PGSQL, as this seemed to be a typo

Signed-off-by: Jo Vandeginste <Jo.Vandeginste@kuleuven.be>
This commit is contained in:
Jo Vandeginste
2019-09-06 11:23:06 +02:00
committed by drakkan
parent a7363a16be
commit abbb7f272b
11 changed files with 176 additions and 106 deletions
Download Patch File Download Diff File Expand all files Collapse all files

80
sftpd/handler.go
View File

@@ -40,6 +40,20 @@ type Connection struct {
sshConn *ssh.ServerConn
}
// Log outputs a log entry to the configured logger
func (c Connection) Log(level string, sender string, format string, v ...interface{}) {
switch level {
case "info":
logger.Info(sender, c.ID, format, v...)
case "warn":
logger.Warn(sender, c.ID, format, v...)
case "error":
logger.Error(sender, c.ID, format, v...)
default:
logger.Debug(sender, c.ID, format, v...)
}
}
// Fileread creates a reader for a file on the system and returns the reader back.
func (c Connection) Fileread(request *sftp.Request) (io.ReaderAt, error) {
updateConnectionActivity(c.ID)
@@ -62,11 +76,11 @@ func (c Connection) Fileread(request *sftp.Request) (io.ReaderAt, error) {
file, err := os.Open(p)
if err != nil {
logger.Error(logSender, c.ID, "could not open file %#v for reading: %v", p, err)
c.Log(Error, logSender, "could not open file %#v for reading: %v", p, err)
return nil, sftp.ErrSshFxFailure
}
logger.Debug(logSender, c.ID, "fileread requested for path: %#v", p)
c.Log(Debug, logSender, "fileread requested for path: %#v", p)
transfer := Transfer{
file: file,
@@ -113,13 +127,13 @@ func (c Connection) Filewrite(request *sftp.Request) (io.WriterAt, error) {
}
if statErr != nil {
logger.Error(logSender, c.ID, "error performing file stat %#v: %v", p, statErr)
c.Log(Error, logSender, "error performing file stat %#v: %v", p, statErr)
return nil, sftp.ErrSshFxFailure
}
// This happen if we upload a file that has the same name of an existing directory
if stat.IsDir() {
logger.Warn(logSender, c.ID, "attempted to open a directory for writing to: %#v", p)
c.Log(Warn, logSender, "attempted to open a directory for writing to: %#v", p)
return nil, sftp.ErrSshFxOpUnsupported
}
@@ -141,7 +155,7 @@ func (c Connection) Filecmd(request *sftp.Request) error {
return sftp.ErrSshFxOpUnsupported
}
logger.Debug(logSender, c.ID, "new cmd, method: %v, sourcePath: %#v, targetPath: %#v", request.Method,
c.Log(Debug, logSender, "new cmd, method: %v, sourcePath: %#v, targetPath: %#v", request.Method,
p, target)
switch request.Method {
@@ -204,11 +218,11 @@ func (c Connection) Filelist(request *sftp.Request) (sftp.ListerAt, error) {
return nil, sftp.ErrSshFxPermissionDenied
}
logger.Debug(logSender, c.ID, "requested list file for dir: %#v", p)
c.Log(Debug, logSender, "requested list file for dir: %#v", p)
files, err := ioutil.ReadDir(p)
if err != nil {
logger.Error(logSender, c.ID, "error listing directory: %#v", err)
c.Log(Error, logSender, "error listing directory: %#v", err)
return nil, sftp.ErrSshFxFailure
}
@@ -218,12 +232,12 @@ func (c Connection) Filelist(request *sftp.Request) (sftp.ListerAt, error) {
return nil, sftp.ErrSshFxPermissionDenied
}
logger.Debug(logSender, c.ID, "requested stat for file: %#v", p)
c.Log(Debug, logSender, "requested stat for file: %#v", p)
s, err := os.Stat(p)
if os.IsNotExist(err) {
return nil, sftp.ErrSshFxNoSuchFile
} else if err != nil {
logger.Error(logSender, c.ID, "error running STAT on file: %#v", err)
c.Log(Error, logSender, "error running STAT on file: %#v", err)
return nil, sftp.ErrSshFxFailure
}
@@ -253,7 +267,7 @@ func (c Connection) handleSFTPRename(sourcePath string, targetPath string) error
return sftp.ErrSshFxPermissionDenied
}
if err := os.Rename(sourcePath, targetPath); err != nil {
logger.Error(logSender, c.ID, "failed to rename file, source: %#v target: %#v: %v", sourcePath, targetPath, err)
c.Log(Error, logSender, "failed to rename file, source: %#v target: %#v: %v", sourcePath, targetPath, err)
return sftp.ErrSshFxFailure
}
logger.CommandLog(renameLogSender, sourcePath, targetPath, c.User.Username, c.ID, c.protocol)
@@ -268,11 +282,11 @@ func (c Connection) handleSFTPRmdir(path string) error {
numFiles, size, fileList, err := utils.ScanDirContents(path)
if err != nil {
logger.Error(logSender, c.ID, "failed to remove directory %#v, scanning error: %v", path, err)
c.Log(Error, logSender, "failed to remove directory %#v, scanning error: %v", path, err)
return sftp.ErrSshFxFailure
}
if err := os.RemoveAll(path); err != nil {
logger.Error(logSender, c.ID, "failed to remove directory %#v: %v", path, err)
c.Log(Error, logSender, "failed to remove directory %#v: %v", path, err)
return sftp.ErrSshFxFailure
}
@@ -289,7 +303,7 @@ func (c Connection) handleSFTPSymlink(sourcePath string, targetPath string) erro
return sftp.ErrSshFxPermissionDenied
}
if err := os.Symlink(sourcePath, targetPath); err != nil {
logger.Warn(logSender, c.ID, "failed to create symlink %#v -> %#v: %v", sourcePath, targetPath, err)
c.Log(Warn, logSender, "failed to create symlink %#v -> %#v: %v", sourcePath, targetPath, err)
return sftp.ErrSshFxFailure
}
@@ -303,7 +317,7 @@ func (c Connection) handleSFTPMkdir(path string) error {
}
if err := c.createMissingDirs(filepath.Join(path, "testfile")); err != nil {
logger.Error(logSender, c.ID, "error making missing dir for path %#v: %v", path, err)
c.Log(Error, logSender, "error making missing dir for path %#v: %v", path, err)
return sftp.ErrSshFxFailure
}
logger.CommandLog(mkdirLogSender, path, "", c.User.Username, c.ID, c.protocol)
@@ -319,12 +333,12 @@ func (c Connection) handleSFTPRemove(path string) error {
var fi os.FileInfo
var err error
if fi, err = os.Lstat(path); err != nil {
logger.Error(logSender, c.ID, "failed to remove a file %#v: stat error: %v", path, err)
c.Log(Error, logSender, "failed to remove a file %#v: stat error: %v", path, err)
return sftp.ErrSshFxFailure
}
size = fi.Size()
if err := os.Remove(path); err != nil {
logger.Error(logSender, c.ID, "failed to remove a file/symlink %#v: %v", path, err)
c.Log(Error, logSender, "failed to remove a file/symlink %#v: %v", path, err)
return sftp.ErrSshFxFailure
}
@@ -339,7 +353,7 @@ func (c Connection) handleSFTPRemove(path string) error {
func (c Connection) handleSFTPUploadToNewFile(requestPath, filePath string) (io.WriterAt, error) {
if !c.hasSpace(true) {
logger.Info(logSender, c.ID, "denying file write due to space limit")
c.Log(Info, logSender, "denying file write due to space limit")
return nil, sftp.ErrSshFxFailure
}
@@ -351,13 +365,13 @@ func (c Connection) handleSFTPUploadToNewFile(requestPath, filePath string) (io.
err := c.createMissingDirs(requestPath)
if err != nil {
logger.Error(logSender, c.ID, "error making missing dir for path %#v: %v", requestPath, err)
c.Log(Error, logSender, "error making missing dir for path %#v: %v", requestPath, err)
return nil, sftp.ErrSshFxFailure
}
file, err := os.Create(filePath)
if err != nil {
logger.Error(logSender, c.ID, "error creating file %#v: %v", requestPath, err)
c.Log(Error, logSender, "error creating file %#v: %v", requestPath, err)
return nil, sftp.ErrSshFxFailure
}
@@ -384,7 +398,7 @@ func (c Connection) handleSFTPUploadToExistingFile(pflags sftp.FileOpenFlags, re
fileSize int64) (io.WriterAt, error) {
var err error
if !c.hasSpace(false) {
logger.Info(logSender, c.ID, "denying file write due to space limit")
c.Log(Info, logSender, "denying file write due to space limit")
return nil, sftp.ErrSshFxFailure
}
@@ -392,14 +406,14 @@ func (c Connection) handleSFTPUploadToExistingFile(pflags sftp.FileOpenFlags, re
if osFlags&os.O_TRUNC == 0 {
// see https://github.com/pkg/sftp/issues/295
logger.Info(logSender, c.ID, "upload resume is not supported, returning error for file: %#v", requestPath)
c.Log(Info, logSender, "upload resume is not supported, returning error for file: %#v", requestPath)
return nil, sftp.ErrSshFxOpUnsupported
}
if uploadMode == uploadModeAtomic {
err = os.Rename(requestPath, filePath)
if err != nil {
logger.Error(logSender, c.ID, "error renaming existing file for atomic upload, source: %#v, dest: %#v, err: %v",
c.Log(Error, logSender, "error renaming existing file for atomic upload, source: %#v, dest: %#v, err: %v",
requestPath, filePath, err)
return nil, sftp.ErrSshFxFailure
}
@@ -407,7 +421,7 @@ func (c Connection) handleSFTPUploadToExistingFile(pflags sftp.FileOpenFlags, re
// we use 0666 so the umask is applied
file, err := os.OpenFile(filePath, osFlags, 0666)
if err != nil {
logger.Error(logSender, c.ID, "error opening existing file, flags: %v, source: %#v, err: %v", pflags, filePath, err)
c.Log(Error, logSender, "error opening existing file, flags: %v, source: %#v, err: %v", pflags, filePath, err)
return nil, sftp.ErrSshFxFailure
}
@@ -439,15 +453,15 @@ func (c Connection) hasSpace(checkFiles bool) bool {
numFile, size, err := dataprovider.GetUsedQuota(dataProvider, c.User.Username)
if err != nil {
if _, ok := err.(*dataprovider.MethodDisabledError); ok {
logger.Warn(logSender, c.ID, "quota enforcement not possible for user %v: %v", c.User.Username, err)
c.Log(Warn, logSender, "quota enforcement not possible for user %v: %v", c.User.Username, err)
return true
}
logger.Warn(logSender, c.ID, "error getting used quota for %v: %v", c.User.Username, err)
c.Log(Warn, logSender, "error getting used quota for %v: %v", c.User.Username, err)
return false
}
if (checkFiles && c.User.QuotaFiles > 0 && numFile >= c.User.QuotaFiles) ||
(c.User.QuotaSize > 0 && size >= c.User.QuotaSize) {
logger.Debug(logSender, c.ID, "quota exceed for user %v, num files: %v/%v, size: %v/%v check files: %v",
c.Log(Debug, logSender, "quota exceed for user %v, num files: %v/%v, size: %v/%v check files: %v",
c.User.Username, numFile, c.User.QuotaFiles, size, c.User.QuotaSize, checkFiles)
return false
}
@@ -468,14 +482,14 @@ func (c Connection) buildPath(rawPath string) (string, error) {
// path chain until we hit a directory that _does_ exist and can be validated.
_, err = c.findFirstExistingDir(r)
if err != nil {
logger.Warn(logSender, c.ID, "error resolving not existent path: %#v", err)
c.Log(Warn, logSender, "error resolving not existent path: %#v", err)
}
return r, err
}
err = c.isSubDir(p)
if err != nil {
logger.Warn(logSender, c.ID, "Invalid path resolution, dir: %#v outside user home: %#v err: %v", p, c.User.HomeDir, err)
c.Log(Warn, logSender, "Invalid path resolution, dir: %#v outside user home: %#v err: %v", p, c.User.HomeDir, err)
}
return r, err
}
@@ -502,7 +516,7 @@ func (c Connection) findNonexistentDirs(path string) ([]string, error) {
}
err = c.isSubDir(p)
if err != nil {
logger.Warn(logSender, c.ID, "Error finding non existing dir: %v", err)
c.Log(Warn, logSender, "Error finding non existing dir: %v", err)
}
return results, err
}
@@ -511,7 +525,7 @@ func (c Connection) findNonexistentDirs(path string) ([]string, error) {
func (c Connection) findFirstExistingDir(path string) (string, error) {
results, err := c.findNonexistentDirs(path)
if err != nil {
logger.Warn(logSender, c.ID, "unable to find non existent dirs: %v", err)
c.Log(Warn, logSender, "unable to find non existent dirs: %v", err)
return "", err
}
var parent string
@@ -542,11 +556,11 @@ func (c Connection) isSubDir(sub string) error {
// home dir must exist and it is already a validated absolute path
parent, err := filepath.EvalSymlinks(c.User.HomeDir)
if err != nil {
logger.Warn(logSender, c.ID, "invalid home dir %#v: %v", c.User.HomeDir, err)
c.Log(Warn, logSender, "invalid home dir %#v: %v", c.User.HomeDir, err)
return err
}
if !strings.HasPrefix(sub, parent) {
logger.Warn(logSender, c.ID, "dir %#v is not inside: %#v ", sub, parent)
c.Log(Warn, logSender, "dir %#v is not inside: %#v ", sub, parent)
return fmt.Errorf("dir %#v is not inside: %#v", sub, parent)
}
return nil
@@ -561,7 +575,7 @@ func (c Connection) createMissingDirs(filePath string) error {
for i := range dirsToCreate {
d := dirsToCreate[last-i]
if err := os.Mkdir(d, 0777); err != nil {
logger.Error(logSender, c.ID, "error creating missing dir: %#v", d)
c.Log(Error, logSender, "error creating missing dir: %#v", d)
return err
}
utils.SetPathPermissions(d, c.User.GetUID(), c.User.GetGID())