extend virtual folders support to all storage backends

Fixes #241
2025-12-08 07:10:56 +03:00 · 2021-03-21 19:15:47 +01:00
parent 0286da2356
commit d6dc3a507e
70 changed files with 6825 additions and 3740 deletions
--- a/vfs/filesystem.go
+++ b/vfs/filesystem.go
@@ -0,0 +1,104 @@
+package vfs
+
+import "github.com/drakkan/sftpgo/kms"
+
+// FilesystemProvider defines the supported storage filesystems
+type FilesystemProvider int
+
+// supported values for FilesystemProvider
+const (
+	LocalFilesystemProvider     FilesystemProvider = iota // Local
+	S3FilesystemProvider                                  // AWS S3 compatible
+	GCSFilesystemProvider                                 // Google Cloud Storage
+	AzureBlobFilesystemProvider                           // Azure Blob Storage
+	CryptedFilesystemProvider                             // Local encrypted
+	SFTPFilesystemProvider                                // SFTP
+)
+
+// Filesystem defines cloud storage filesystem details
+type Filesystem struct {
+	RedactedSecret string             `json:"-"`
+	Provider       FilesystemProvider `json:"provider"`
+	S3Config       S3FsConfig         `json:"s3config,omitempty"`
+	GCSConfig      GCSFsConfig        `json:"gcsconfig,omitempty"`
+	AzBlobConfig   AzBlobFsConfig     `json:"azblobconfig,omitempty"`
+	CryptConfig    CryptFsConfig      `json:"cryptconfig,omitempty"`
+	SFTPConfig     SFTPFsConfig       `json:"sftpconfig,omitempty"`
+}
+
+// SetEmptySecretsIfNil sets the secrets to empty if nil
+func (f *Filesystem) SetEmptySecretsIfNil() {
+	if f.S3Config.AccessSecret == nil {
+		f.S3Config.AccessSecret = kms.NewEmptySecret()
+	}
+	if f.GCSConfig.Credentials == nil {
+		f.GCSConfig.Credentials = kms.NewEmptySecret()
+	}
+	if f.AzBlobConfig.AccountKey == nil {
+		f.AzBlobConfig.AccountKey = kms.NewEmptySecret()
+	}
+	if f.CryptConfig.Passphrase == nil {
+		f.CryptConfig.Passphrase = kms.NewEmptySecret()
+	}
+	if f.SFTPConfig.Password == nil {
+		f.SFTPConfig.Password = kms.NewEmptySecret()
+	}
+	if f.SFTPConfig.PrivateKey == nil {
+		f.SFTPConfig.PrivateKey = kms.NewEmptySecret()
+	}
+}
+
+// GetACopy returns a copy
+func (f *Filesystem) GetACopy() Filesystem {
+	f.SetEmptySecretsIfNil()
+	fs := Filesystem{
+		Provider: f.Provider,
+		S3Config: S3FsConfig{
+			Bucket:            f.S3Config.Bucket,
+			Region:            f.S3Config.Region,
+			AccessKey:         f.S3Config.AccessKey,
+			AccessSecret:      f.S3Config.AccessSecret.Clone(),
+			Endpoint:          f.S3Config.Endpoint,
+			StorageClass:      f.S3Config.StorageClass,
+			KeyPrefix:         f.S3Config.KeyPrefix,
+			UploadPartSize:    f.S3Config.UploadPartSize,
+			UploadConcurrency: f.S3Config.UploadConcurrency,
+		},
+		GCSConfig: GCSFsConfig{
+			Bucket:               f.GCSConfig.Bucket,
+			CredentialFile:       f.GCSConfig.CredentialFile,
+			Credentials:          f.GCSConfig.Credentials.Clone(),
+			AutomaticCredentials: f.GCSConfig.AutomaticCredentials,
+			StorageClass:         f.GCSConfig.StorageClass,
+			KeyPrefix:            f.GCSConfig.KeyPrefix,
+		},
+		AzBlobConfig: AzBlobFsConfig{
+			Container:         f.AzBlobConfig.Container,
+			AccountName:       f.AzBlobConfig.AccountName,
+			AccountKey:        f.AzBlobConfig.AccountKey.Clone(),
+			Endpoint:          f.AzBlobConfig.Endpoint,
+			SASURL:            f.AzBlobConfig.SASURL,
+			KeyPrefix:         f.AzBlobConfig.KeyPrefix,
+			UploadPartSize:    f.AzBlobConfig.UploadPartSize,
+			UploadConcurrency: f.AzBlobConfig.UploadConcurrency,
+			UseEmulator:       f.AzBlobConfig.UseEmulator,
+			AccessTier:        f.AzBlobConfig.AccessTier,
+		},
+		CryptConfig: CryptFsConfig{
+			Passphrase: f.CryptConfig.Passphrase.Clone(),
+		},
+		SFTPConfig: SFTPFsConfig{
+			Endpoint:                f.SFTPConfig.Endpoint,
+			Username:                f.SFTPConfig.Username,
+			Password:                f.SFTPConfig.Password.Clone(),
+			PrivateKey:              f.SFTPConfig.PrivateKey.Clone(),
+			Prefix:                  f.SFTPConfig.Prefix,
+			DisableCouncurrentReads: f.SFTPConfig.DisableCouncurrentReads,
+		},
+	}
+	if len(f.SFTPConfig.Fingerprints) > 0 {
+		fs.SFTPConfig.Fingerprints = make([]string, len(f.SFTPConfig.Fingerprints))
+		copy(fs.SFTPConfig.Fingerprints, f.SFTPConfig.Fingerprints)
+	}
+	return fs
+}