deblan-mirror/sftpgo
1
0
Fork 0
mirror of https://github.com/drakkan/sftpgo.git synced 2024-06-03 00:42:12 +02:00
Code Issues Packages Projects Releases Wiki Activity
sftpgo/docs/dare.md
Nicola Murino 5a549a88fe
update to Go 1.17
2021-08-18 14:39:56 +02:00

2.1 KiB
Raw Blame History

Data At Rest Encryption (DARE)

SFTPGo supports data at-rest encryption via its cryptfs virtual file system, in this mode SFTPGo transparently encrypts and decrypts data (to/from the local disk) on-the-fly during uploads and/or downloads, making sure that the files at-rest on the server-side are always encrypted.

Data At Rest Encryption is supported for local filesystem, for cloud storage backends you can use their server side encryption feature.

So, because of the way it works, as described here above, when you set up an encrypted filesystem for a user you need to make sure it points to an empty path/directory (that has no files in it). Otherwise, it would try to decrypt existing files that are not encrypted in the first place and fail.

The SFTPGo's cryptfs is a tiny wrapper around sio therefore data is encrypted and authenticated using AES-256-GCM or ChaCha20-Poly1305. AES-GCM will be used if the CPU provides hardware support for it.

The only required configuration parameter is a passphrase, each file will be encrypted using an unique, randomly generated secret key derived from the given passphrase using the HMAC-based Extract-and-Expand Key Derivation Function (HKDF) as defined in RFC 5869. It is important to note that the per-object encryption key is never stored anywhere: it is derived from your passphrase and a randomly generated initialization vector just before encryption/decryption. The initialization vector is stored with the file.

The passphrase is stored encrypted itself according to your KMS configuration and is required to decrypt any file encrypted using an encryption key derived from it.

The encrypted filesystem has some limitations compared to the local, unencrypted, one:

  • Resuming uploads is not supported.
  • Opening a file for both reading and writing at the same time is not supported and so clients that require advanced filesystem-like features such as sshfs are not supported too.
  • Truncate is not supported.
  • System commands such as git or rsync are not supported: they will store data unencrypted.