vfs

package

Go to main page

Versions in this module

v2

v2.3.6

Oct 12, 2022

v2.3.5

Sep 17, 2022

v2.3.4

Sep 1, 2022

v2.3.3

Aug 5, 2022

v2.3.2

Jul 29, 2022

v2.3.1

Jun 10, 2022

v2.3.0

Jun 4, 2022

Changes in this version

type AzBlobFsConfig

+ func (c *AzBlobFsConfig) ValidateAndEncryptCredentials(additionalData string) error

type BaseVirtualFolder

+ Groups []string

+ func (v *BaseVirtualFolder) GetGroupsAsString() string

+ func (v *BaseVirtualFolder) GetLastQuotaUpdateAsString() string

type CryptFsConfig

+ func (c *CryptFsConfig) ValidateAndEncryptCredentials(additionalData string) error

type GCSFsConfig

+ func (c *GCSFsConfig) ValidateAndEncryptCredentials(additionalData string) error

type S3FsConfig

+ func (c *S3FsConfig) ValidateAndEncryptCredentials(additionalData string) error

type SFTPFsConfig

+ KeyPassphrase *kms.Secret

+ func (c *SFTPFsConfig) ValidateAndEncryptCredentials(additionalData string) error

v2.2.3

Apr 30, 2022

v2.2.2

Feb 6, 2022

Changes in this version

type AzBlobFsConfig

+ AccountKey *kms.Secret

+ SASURL *kms.Secret

type CryptFsConfig

+ Passphrase *kms.Secret

type Filesystem

+ func (f *Filesystem) SetEmptySecrets()

type GCSFsConfig

+ Credentials *kms.Secret

type S3FsConfig

+ AccessSecret *kms.Secret

type SFTPFsConfig

+ Password *kms.Secret

+ PrivateKey *kms.Secret

v2.2.1

Dec 31, 2021

Changes in this version

type AzureBlobFs

+ func (fs *AzureBlobFs) CheckMetadata() error

type Fs

+ CheckMetadata func() error

type GCSFs

+ func (fs *GCSFs) CheckMetadata() error

type OsFs

+ func (*OsFs) CheckMetadata() error

type S3Fs

+ func (fs *S3Fs) CheckMetadata() error

type SFTPFs

+ func (*SFTPFs) CheckMetadata() error

type VirtualFolder

+ func (v *VirtualFolder) CheckMetadataConsistency() error

v2.2.0

Nov 27, 2021

Changes in this version

+ var ErrSFTPLoop = errors.New("SFTP loop or nested local SFTP folders detected")

+ var ErrStorageSizeUnavailable = errors.New("unable to get available size for this storage backend")

+ var ErrVfsUnsupported = errors.New("not supported")

+ func GetCredentialsDirPath() string

+ func GetTempPath() string

+ func HasOpenRWSupport(fs Fs) bool

+ func IsBufferedSFTPFs(fs Fs) bool

+ func IsCryptOsFs(fs Fs) bool

+ func IsDirectory(fs Fs, path string) (bool, error)

+ func IsLocalOrCryptoFs(fs Fs) bool

+ func IsLocalOrSFTPFs(fs Fs) bool

+ func IsLocalOrUnbufferedSFTPFs(fs Fs) bool

+ func IsLocalOsFs(fs Fs) bool

+ func IsSFTPFs(fs Fs) bool

+ func SetCredentialsDirPath(credentialsPath string)

+ func SetPathPermissions(fs Fs, path string, uid int, gid int)

+ func SetSFTPFingerprints(fp []string)

+ func SetTempPath(fsPath string)

+ type AzBlobFsConfig struct

+ func (c *AzBlobFsConfig) EncryptCredentials(additionalData string) error

+ func (c *AzBlobFsConfig) HideConfidentialData()

+ func (c *AzBlobFsConfig) Validate() error

+ type AzureBlobFs struct

+ func (*AzureBlobFs) Chmod(name string, mode os.FileMode) error

+ func (*AzureBlobFs) Chown(name string, uid int, gid int) error

+ func (*AzureBlobFs) Chtimes(name string, atime, mtime time.Time) error

+ func (*AzureBlobFs) Close() error

+ func (*AzureBlobFs) GetAtomicUploadPath(name string) string

+ func (*AzureBlobFs) GetAvailableDiskSize(dirName string) (*sftp.StatVFS, error)

+ func (*AzureBlobFs) GetDirSize(dirname string) (int, int64, error)

+ func (*AzureBlobFs) HasVirtualFolders() bool

+ func (*AzureBlobFs) IsAtomicUploadSupported() bool

+ func (*AzureBlobFs) IsNotExist(err error) bool

+ func (*AzureBlobFs) IsNotSupported(err error) bool

+ func (*AzureBlobFs) IsPermission(err error) bool

+ func (*AzureBlobFs) IsUploadResumeSupported() bool

+ func (*AzureBlobFs) Join(elem ...string) string

+ func (*AzureBlobFs) MkdirAll(name string, uid int, gid int) error

+ func (*AzureBlobFs) Readlink(name string) (string, error)

+ func (*AzureBlobFs) Symlink(source, target string) error

+ func (*AzureBlobFs) Truncate(name string, size int64) error

+ func (fs *AzureBlobFs) CheckRootPath(username string, uid int, gid int) bool

+ func (fs *AzureBlobFs) ConnectionID() string

+ func (fs *AzureBlobFs) Create(name string, flag int) (File, *PipeWriter, func(), error)

+ func (fs *AzureBlobFs) GetMimeType(name string) (string, error)

+ func (fs *AzureBlobFs) GetRelativePath(name string) string

+ func (fs *AzureBlobFs) Lstat(name string) (os.FileInfo, error)

+ func (fs *AzureBlobFs) Mkdir(name string) error

+ func (fs *AzureBlobFs) Name() string

+ func (fs *AzureBlobFs) Open(name string, offset int64) (File, *pipeat.PipeReaderAt, func(), error)

+ func (fs *AzureBlobFs) ReadDir(dirname string) ([]os.FileInfo, error)

+ func (fs *AzureBlobFs) Remove(name string, isDir bool) error

+ func (fs *AzureBlobFs) Rename(source, target string) error

+ func (fs *AzureBlobFs) ResolvePath(virtualPath string) (string, error)

+ func (fs *AzureBlobFs) ScanRootDirContents() (int, int64, error)

+ func (fs *AzureBlobFs) Stat(name string) (os.FileInfo, error)

+ func (fs *AzureBlobFs) Walk(root string, walkFn filepath.WalkFunc) error

+ type BaseVirtualFolder struct

+ Description string

+ FsConfig Filesystem

+ ID int64

+ LastQuotaUpdate int64

+ MappedPath string

+ Name string

+ UsedQuotaFiles int

+ UsedQuotaSize int64

+ Users []string

+ func (v *BaseVirtualFolder) GetACopy() BaseVirtualFolder

+ func (v *BaseVirtualFolder) GetEncryptionAdditionalData() string

+ func (v *BaseVirtualFolder) GetGCSCredentialsFilePath() string

+ func (v *BaseVirtualFolder) GetQuotaSummary() string

+ func (v *BaseVirtualFolder) GetStorageDescrition() string

+ func (v *BaseVirtualFolder) GetUsersAsString() string

+ func (v *BaseVirtualFolder) HasRedactedSecret() bool

+ func (v *BaseVirtualFolder) IsLocalOrLocalCrypted() bool

+ func (v *BaseVirtualFolder) PrepareForRendering()

+ type CryptFs struct

+ func (*CryptFs) IsUploadResumeSupported() bool

+ func (*CryptFs) Truncate(name string, size int64) error

+ func (fs *CryptFs) ConvertFileInfo(info os.FileInfo) os.FileInfo

+ func (fs *CryptFs) Create(name string, flag int) (File, *PipeWriter, func(), error)

+ func (fs *CryptFs) GetMimeType(name string) (string, error)

+ func (fs *CryptFs) Name() string

+ func (fs *CryptFs) Open(name string, offset int64) (File, *pipeat.PipeReaderAt, func(), error)

+ func (fs *CryptFs) ReadDir(dirname string) ([]os.FileInfo, error)

+ type CryptFsConfig struct

+ func (c *CryptFsConfig) EncryptCredentials(additionalData string) error

+ func (c *CryptFsConfig) HideConfidentialData()

+ func (c *CryptFsConfig) Validate() error

+ type File interface

+ Name func() string

+ Stat func() (os.FileInfo, error)

+ Truncate func(size int64) error

+ type FileInfo struct

+ func NewFileInfo(name string, isDirectory bool, sizeInBytes int64, modTime time.Time, ...) *FileInfo

+ func (fi *FileInfo) IsDir() bool

+ func (fi *FileInfo) ModTime() time.Time

+ func (fi *FileInfo) Mode() os.FileMode

+ func (fi *FileInfo) Name() string

+ func (fi *FileInfo) SetMode(mode os.FileMode)

+ func (fi *FileInfo) Size() int64

+ func (fi *FileInfo) Sys() interface{}

+ type Filesystem struct

+ AzBlobConfig AzBlobFsConfig

+ CryptConfig CryptFsConfig

+ GCSConfig GCSFsConfig

+ Provider sdk.FilesystemProvider

+ RedactedSecret string

+ S3Config S3FsConfig

+ SFTPConfig SFTPFsConfig

+ func (f *Filesystem) GetACopy() Filesystem

+ func (f *Filesystem) HasRedactedSecret() bool

+ func (f *Filesystem) HideConfidentialData()

+ func (f *Filesystem) IsEqual(other *Filesystem) bool

+ func (f *Filesystem) SetEmptySecretsIfNil()

+ func (f *Filesystem) SetNilSecretsIfEmpty()

+ func (f *Filesystem) Validate(helper ValidatorHelper) error

+ type Fs interface

+ CheckRootPath func(username string, uid int, gid int) bool

+ Chmod func(name string, mode os.FileMode) error

+ Chown func(name string, uid int, gid int) error

+ Chtimes func(name string, atime, mtime time.Time) error

+ Close func() error

+ ConnectionID func() string

+ Create func(name string, flag int) (File, *PipeWriter, func(), error)

+ GetAtomicUploadPath func(name string) string

+ GetAvailableDiskSize func(dirName string) (*sftp.StatVFS, error)

+ GetDirSize func(dirname string) (int, int64, error)

+ GetMimeType func(name string) (string, error)

+ GetRelativePath func(name string) string

+ HasVirtualFolders func() bool

+ IsAtomicUploadSupported func() bool

+ IsNotExist func(err error) bool

+ IsNotSupported func(err error) bool

+ IsPermission func(err error) bool

+ IsUploadResumeSupported func() bool

+ Join func(elem ...string) string

+ Lstat func(name string) (os.FileInfo, error)

+ Mkdir func(name string) error

+ MkdirAll func(name string, uid int, gid int) error

+ Name func() string

+ Open func(name string, offset int64) (File, *pipeat.PipeReaderAt, func(), error)

+ ReadDir func(dirname string) ([]os.FileInfo, error)

+ Readlink func(name string) (string, error)

+ Remove func(name string, isDir bool) error

+ Rename func(source, target string) error

+ ResolvePath func(sftpPath string) (string, error)

+ ScanRootDirContents func() (int, int64, error)

+ Stat func(name string) (os.FileInfo, error)

+ Symlink func(source, target string) error

+ Truncate func(name string, size int64) error

+ Walk func(root string, walkFn filepath.WalkFunc) error

+ func NewAzBlobFs(connectionID, localTempDir, mountPath string, config AzBlobFsConfig) (Fs, error)

+ func NewCryptFs(connectionID, rootDir, mountPath string, config CryptFsConfig) (Fs, error)

+ func NewGCSFs(connectionID, localTempDir, mountPath string, config GCSFsConfig) (Fs, error)

+ func NewOsFs(connectionID, rootDir, mountPath string) Fs

+ func NewS3Fs(connectionID, localTempDir, mountPath string, config S3FsConfig) (Fs, error)

+ func NewSFTPFs(connectionID, mountPath, localTempDir string, forbiddenSelfUsernames []string, ...) (Fs, error)

+ type GCSFs struct

+ func (*GCSFs) Chmod(name string, mode os.FileMode) error

+ func (*GCSFs) Chown(name string, uid int, gid int) error

+ func (*GCSFs) Chtimes(name string, atime, mtime time.Time) error

+ func (*GCSFs) GetAtomicUploadPath(name string) string

+ func (*GCSFs) GetAvailableDiskSize(dirName string) (*sftp.StatVFS, error)

+ func (*GCSFs) GetDirSize(dirname string) (int, int64, error)

+ func (*GCSFs) IsAtomicUploadSupported() bool

+ func (*GCSFs) IsNotExist(err error) bool

+ func (*GCSFs) IsNotSupported(err error) bool

+ func (*GCSFs) IsPermission(err error) bool

+ func (*GCSFs) IsUploadResumeSupported() bool

+ func (*GCSFs) Join(elem ...string) string

+ func (*GCSFs) MkdirAll(name string, uid int, gid int) error

+ func (*GCSFs) Readlink(name string) (string, error)

+ func (*GCSFs) Symlink(source, target string) error

+ func (*GCSFs) Truncate(name string, size int64) error

+ func (GCSFs) HasVirtualFolders() bool

+ func (fs *GCSFs) CheckRootPath(username string, uid int, gid int) bool

+ func (fs *GCSFs) Close() error

+ func (fs *GCSFs) ConnectionID() string

+ func (fs *GCSFs) Create(name string, flag int) (File, *PipeWriter, func(), error)

+ func (fs *GCSFs) GetMimeType(name string) (string, error)

+ func (fs *GCSFs) GetRelativePath(name string) string

+ func (fs *GCSFs) Lstat(name string) (os.FileInfo, error)

+ func (fs *GCSFs) Mkdir(name string) error

+ func (fs *GCSFs) Name() string

+ func (fs *GCSFs) Open(name string, offset int64) (File, *pipeat.PipeReaderAt, func(), error)

+ func (fs *GCSFs) ReadDir(dirname string) ([]os.FileInfo, error)

+ func (fs *GCSFs) Remove(name string, isDir bool) error

+ func (fs *GCSFs) Rename(source, target string) error

+ func (fs *GCSFs) ResolvePath(virtualPath string) (string, error)

+ func (fs *GCSFs) ScanRootDirContents() (int, int64, error)

+ func (fs *GCSFs) Stat(name string) (os.FileInfo, error)

+ func (fs *GCSFs) Walk(root string, walkFn filepath.WalkFunc) error

+ type GCSFsConfig struct

+ func (c *GCSFsConfig) HideConfidentialData()

+ func (c *GCSFsConfig) Validate(credentialsFilePath string) error

+ type OsFs struct

+ func (*OsFs) Chmod(name string, mode os.FileMode) error

+ func (*OsFs) Chown(name string, uid int, gid int) error

+ func (*OsFs) Chtimes(name string, atime, mtime time.Time) error

+ func (*OsFs) Close() error

+ func (*OsFs) Create(name string, flag int) (File, *PipeWriter, func(), error)

+ func (*OsFs) GetAtomicUploadPath(name string) string

+ func (*OsFs) GetAvailableDiskSize(dirName string) (*sftp.StatVFS, error)

+ func (*OsFs) HasVirtualFolders() bool

+ func (*OsFs) IsAtomicUploadSupported() bool

+ func (*OsFs) IsNotExist(err error) bool

+ func (*OsFs) IsNotSupported(err error) bool

+ func (*OsFs) IsPermission(err error) bool

+ func (*OsFs) IsUploadResumeSupported() bool

+ func (*OsFs) Join(elem ...string) string

+ func (*OsFs) Mkdir(name string) error

+ func (*OsFs) Open(name string, offset int64) (File, *pipeat.PipeReaderAt, func(), error)

+ func (*OsFs) ReadDir(dirname string) ([]os.FileInfo, error)

+ func (*OsFs) Remove(name string, isDir bool) error

+ func (*OsFs) Symlink(source, target string) error

+ func (*OsFs) Truncate(name string, size int64) error

+ func (*OsFs) Walk(root string, walkFn filepath.WalkFunc) error

+ func (fs *OsFs) CheckRootPath(username string, uid int, gid int) bool

+ func (fs *OsFs) ConnectionID() string

+ func (fs *OsFs) GetDirSize(dirname string) (int, int64, error)

+ func (fs *OsFs) GetMimeType(name string) (string, error)

+ func (fs *OsFs) GetRelativePath(name string) string

+ func (fs *OsFs) Lstat(name string) (os.FileInfo, error)

+ func (fs *OsFs) MkdirAll(name string, uid int, gid int) error

+ func (fs *OsFs) Name() string

+ func (fs *OsFs) Readlink(name string) (string, error)

+ func (fs *OsFs) Rename(source, target string) error

+ func (fs *OsFs) ResolvePath(virtualPath string) (string, error)

+ func (fs *OsFs) ScanRootDirContents() (int, int64, error)

+ func (fs *OsFs) Stat(name string) (os.FileInfo, error)

+ type PipeWriter struct

+ func NewPipeWriter(w *pipeat.PipeWriterAt) *PipeWriter

+ func (p *PipeWriter) Close() error

+ func (p *PipeWriter) Done(err error)

+ func (p *PipeWriter) Write(data []byte) (int, error)

+ func (p *PipeWriter) WriteAt(data []byte, off int64) (int, error)

+ type QuotaCheckResult struct

+ AllowedFiles int

+ AllowedSize int64

+ HasSpace bool

+ QuotaFiles int

+ QuotaSize int64

+ UsedFiles int

+ UsedSize int64

+ func (q *QuotaCheckResult) GetRemainingFiles() int

+ func (q *QuotaCheckResult) GetRemainingSize() int64

+ type S3Fs struct

+ func (*S3Fs) Chmod(name string, mode os.FileMode) error

+ func (*S3Fs) Chown(name string, uid int, gid int) error

+ func (*S3Fs) Chtimes(name string, atime, mtime time.Time) error

+ func (*S3Fs) Close() error

+ func (*S3Fs) GetAtomicUploadPath(name string) string

+ func (*S3Fs) GetAvailableDiskSize(dirName string) (*sftp.StatVFS, error)

+ func (*S3Fs) GetDirSize(dirname string) (int, int64, error)

+ func (*S3Fs) HasVirtualFolders() bool

+ func (*S3Fs) IsAtomicUploadSupported() bool

+ func (*S3Fs) IsNotExist(err error) bool

+ func (*S3Fs) IsNotSupported(err error) bool

+ func (*S3Fs) IsPermission(err error) bool

+ func (*S3Fs) IsUploadResumeSupported() bool

+ func (*S3Fs) Join(elem ...string) string

+ func (*S3Fs) MkdirAll(name string, uid int, gid int) error

+ func (*S3Fs) Readlink(name string) (string, error)

+ func (*S3Fs) Symlink(source, target string) error

+ func (*S3Fs) Truncate(name string, size int64) error

+ func (fs *S3Fs) CheckRootPath(username string, uid int, gid int) bool

+ func (fs *S3Fs) ConnectionID() string

+ func (fs *S3Fs) Create(name string, flag int) (File, *PipeWriter, func(), error)

+ func (fs *S3Fs) GetMimeType(name string) (string, error)

+ func (fs *S3Fs) GetRelativePath(name string) string

+ func (fs *S3Fs) Lstat(name string) (os.FileInfo, error)

+ func (fs *S3Fs) Mkdir(name string) error

+ func (fs *S3Fs) Name() string

+ func (fs *S3Fs) Open(name string, offset int64) (File, *pipeat.PipeReaderAt, func(), error)

+ func (fs *S3Fs) ReadDir(dirname string) ([]os.FileInfo, error)

+ func (fs *S3Fs) Remove(name string, isDir bool) error

+ func (fs *S3Fs) Rename(source, target string) error

+ func (fs *S3Fs) ResolvePath(virtualPath string) (string, error)

+ func (fs *S3Fs) ScanRootDirContents() (int, int64, error)

+ func (fs *S3Fs) Stat(name string) (os.FileInfo, error)

+ func (fs *S3Fs) Walk(root string, walkFn filepath.WalkFunc) error

+ type S3FsConfig struct

+ func (c *S3FsConfig) EncryptCredentials(additionalData string) error

+ func (c *S3FsConfig) HideConfidentialData()

+ func (c *S3FsConfig) Validate() error

+ type SFTPFs struct

+ func (*SFTPFs) GetAtomicUploadPath(name string) string

+ func (*SFTPFs) HasVirtualFolders() bool

+ func (*SFTPFs) IsNotExist(err error) bool

+ func (*SFTPFs) IsNotSupported(err error) bool

+ func (*SFTPFs) IsPermission(err error) bool

+ func (*SFTPFs) Join(elem ...string) string

+ func (fs *SFTPFs) CheckRootPath(username string, uid int, gid int) bool

+ func (fs *SFTPFs) Chmod(name string, mode os.FileMode) error

+ func (fs *SFTPFs) Chown(name string, uid int, gid int) error

+ func (fs *SFTPFs) Chtimes(name string, atime, mtime time.Time) error

+ func (fs *SFTPFs) Close() error

+ func (fs *SFTPFs) ConnectionID() string

+ func (fs *SFTPFs) Create(name string, flag int) (File, *PipeWriter, func(), error)

+ func (fs *SFTPFs) GetAvailableDiskSize(dirName string) (*sftp.StatVFS, error)

+ func (fs *SFTPFs) GetDirSize(dirname string) (int, int64, error)

+ func (fs *SFTPFs) GetMimeType(name string) (string, error)

+ func (fs *SFTPFs) GetRelativePath(name string) string

+ func (fs *SFTPFs) IsAtomicUploadSupported() bool

+ func (fs *SFTPFs) IsUploadResumeSupported() bool

+ func (fs *SFTPFs) Lstat(name string) (os.FileInfo, error)

+ func (fs *SFTPFs) Mkdir(name string) error

+ func (fs *SFTPFs) MkdirAll(name string, uid int, gid int) error

+ func (fs *SFTPFs) Name() string

+ func (fs *SFTPFs) Open(name string, offset int64) (File, *pipeat.PipeReaderAt, func(), error)

+ func (fs *SFTPFs) ReadDir(dirname string) ([]os.FileInfo, error)

+ func (fs *SFTPFs) Readlink(name string) (string, error)

+ func (fs *SFTPFs) Remove(name string, isDir bool) error

+ func (fs *SFTPFs) Rename(source, target string) error

+ func (fs *SFTPFs) ResolvePath(virtualPath string) (string, error)

+ func (fs *SFTPFs) ScanRootDirContents() (int, int64, error)

+ func (fs *SFTPFs) Stat(name string) (os.FileInfo, error)

+ func (fs *SFTPFs) Symlink(source, target string) error

+ func (fs *SFTPFs) Truncate(name string, size int64) error

+ func (fs *SFTPFs) Walk(root string, walkFn filepath.WalkFunc) error

+ type SFTPFsConfig struct

+ func (c *SFTPFsConfig) EncryptCredentials(additionalData string) error

+ func (c *SFTPFsConfig) HideConfidentialData()

+ func (c *SFTPFsConfig) Validate() error

+ type ValidatorHelper interface

+ GetEncryptionAdditionalData func() string

+ GetGCSCredentialsFilePath func() string

+ type VirtualFolder struct

+ QuotaFiles int

+ QuotaSize int64

+ VirtualPath string

+ func (v *VirtualFolder) GetACopy() VirtualFolder

+ func (v *VirtualFolder) GetFilesystem(connectionID string, forbiddenSelfUsers []string) (Fs, error)

+ func (v *VirtualFolder) HasNoQuotaRestrictions(checkFiles bool) bool

+ func (v *VirtualFolder) IsIncludedInUserQuota() bool

+ func (v *VirtualFolder) ScanQuota() (int, int64, error)

Other modules containing this package

github.com/drakkan/sftpgo

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL