Skip to content

"rsync for cloud storage" - Google Drive, S3, Dropbox, Backblaze B2, One Drive, Swift, Hubic, Wasabi, Google Cloud Storage, Azure Blob, Azure Files, Yandex Files

sftp: docs: clarify the security boundaries of --sftp-skip-links

Nick Craig-Woodd8b4966fa6df
diff --git a/backend/sftp/sftp.go b/backend/sftp/sftp.go
index f7f56e168..f798d7a49 100644
--- a/backend/sftp/sftp.go
+++ b/backend/sftp/sftp.go
@@ -269,9 +269,15 @@ E.g. the second example above should be rewritten as:
Help: "The command used to read XXH128 hashes.\n\nLeave blank for autodetect.",
Advanced: true,
}, {
- Name: "skip_links",
- Default: false,
- Help: "Set to skip any symlinks and any other non regular files.",
+ Name: "skip_links",
+ Default: false,
+ Help: `Set to skip any symlinks and any other non regular files.
+
+This only affects listing: symlinks and other non regular files are
+omitted from directory listings. It is not a security control and does
+not prevent writes from following symlinks on the server - confining an
+SFTP account to a directory must be enforced server side (for example
+with a chroot jail or restricted permissions).`,
Advanced: true,
}, {
Name: "subsystem",