common

package

Go to main page

Versions in this module

v2

v2.6.0

May 15, 2024

Changes in this version

+ const UploadModeAzureBlobStoreOnError

+ const UploadModeGCSStoreOnError

+ const UploadModeS3StoreOnError

type BaseTransfer

+ func (t *BaseTransfer) SetMetadata(val map[string]string)

type CertManager

+ func (m *CertManager) HasCertificate(certID string) bool

type Configuration

+ Metadata MetadataConfig

+ ResumeMaxSize int64

+ ServerVersion string

+ Umask string

type ConnectionStatus

+ CurrentTime int64

+ type DirListerAt struct

+ func (l *DirListerAt) Add(fi os.FileInfo)

+ func (l *DirListerAt) Close() error

+ func (l *DirListerAt) ListAt(f []os.FileInfo, _ int64) (int, error)

+ func (l *DirListerAt) Next(limit int) ([]os.FileInfo, error)

type EventParams

+ Extension string

+ Metadata map[string]string

+ UID string

+ type MetadataConfig struct

+ Read int

v2.5.6

Dec 18, 2023

v2.5.5

Nov 10, 2023

v2.5.4

Jul 14, 2023

v2.5.3

Jun 29, 2023

v2.5.2

Jun 17, 2023

Changes in this version

type EventParams

+ Email string

v2.5.1

May 20, 2023

v2.5.0

May 3, 2023

Changes in this version

+ const IDPLoginAdmin

+ const IDPLoginUser

+ func HandleIDPLoginEvent(params EventParams, customFields *map[string]any) (*dataprovider.User, *dataprovider.Admin, error)

+ func RunOnDemandRule(name string) error

type ActiveConnection

+ GetRole func() string

type ActiveQuotaScan

+ Role string

type BaseConnection

+ func (c *BaseConnection) Copy(virtualSourcePath, virtualTargetPath string) error

+ func (c *BaseConnection) GetRole() string

+ func (c *BaseConnection) IsSameResource(virtualSourcePath, virtualTargetPath string) bool

type Configuration

+ AllowListStatus int

+ ProxySkipped []string

+ RenameMode int

+ func (c *Configuration) GetRateLimitersStatus() (bool, []string)

+ func (c *Configuration) IsAllowListEnabled() bool

type Defender

+ IsSafe func(ip, protocol string) bool

type EventParams

+ Elapsed int64

+ IDPCustomFields *map[string]string

+ Role string

type MetadataCheck

+ Role string

type RetentionCheck

+ Role string

v2.4.6

Dec 18, 2023

v2.4.5

Apr 8, 2023

Changes in this version

type BaseConnection

+ func (c *BaseConnection) GetCreateChecks(virtualPath string, isNewFile bool) int

type BaseTransfer

+ func (t *BaseTransfer) ConvertError(err error) error

v2.4.4

Feb 4, 2023

Changes in this version

type DefenderConfig

+ ScoreNoAuth int

v2.4.3

Jan 6, 2023

v2.4.2

Nov 25, 2022

v2.4.1

Nov 12, 2022

Changes in this version

type BaseConnection

+ func (c *BaseConnection) RemoveAll(virtualPath string) error

v2.4.0

Oct 23, 2022

Changes in this version

+ const DefaultTLSKeyPaidID

+ const DefenderDriverMemory

+ const DefenderDriverProvider

+ const HTTPAuthenticationHeader

+ const OperationPreDownload

+ const OperationPreUpload

+ const OperationSSHCmd

+ const ProtocolDataRetention

+ const ProtocolFTP

+ const ProtocolHTTP

+ const ProtocolHTTPShare

+ const ProtocolOIDC

+ const ProtocolSCP

+ const ProtocolSFTP

+ const ProtocolSSH

+ const ProtocolWebDAV

+ const RetentionCheckNotificationEmail

+ const RetentionCheckNotificationHook

+ const StatAttrPerms

+ const StatAttrSize

+ const StatAttrTimes

+ const StatAttrUIDGID

+ const TransferDownload

+ const TransferUpload

+ const UploadModeAtomic

+ const UploadModeAtomicWithResume

+ const UploadModeStandard

+ var ActiveMetadataChecks MetadataChecks

+ var Config Configuration

+ var Connections ActiveConnections

+ var ErrConnectionDenied = errors.New("you are not allowed to connect")

+ var ErrCrtRevoked = errors.New("your certificate has been revoked")

+ var ErrGenericFailure = errors.New("failure")

+ var ErrInternalFailure = errors.New("internal failure")

+ var ErrNoBinding = errors.New("no binding configured")

+ var ErrNoCredentials = errors.New("no credential provided")

+ var ErrNotExist = errors.New("no such file or directory")

+ var ErrOpUnsupported = errors.New("operation unsupported")

+ var ErrPermissionDenied = errors.New("permission denied")

+ var ErrQuotaExceeded = errors.New("denying write due to space limit")

+ var ErrReadQuotaExceeded = errors.New("denying read due to quota limit")

+ var ErrShuttingDown = errors.New("the service is shutting down")

+ var ErrTransferAborted = errors.New("transfer aborted")

+ var ErrTransferClosed = errors.New("transfer already closed")

+ var QuotaScans ActiveScans

+ func AddDefenderEvent(ip string, event HostEvent)

+ func CheckClosing() error

+ func DeleteDefenderHost(ip string) bool

+ func ExecuteActionNotification(conn *BaseConnection, ...) error

+ func ExecutePreAction(conn *BaseConnection, operation, filePath, virtualPath string, fileSize int64, ...) error

+ func GetDefenderBanTime(ip string) (*time.Time, error)

+ func GetDefenderHost(ip string) (dataprovider.DefenderEntry, error)

+ func GetDefenderHosts() ([]dataprovider.DefenderEntry, error)

+ func GetDefenderScore(ip string) (int, error)

+ func HandleCertificateEvent(params EventParams)

+ func Initialize(c Configuration, isShared int) error

+ func InitializeActionHandler(handler ActionHandler)

+ func IsBanned(ip string) bool

+ func LimitRate(protocol, ip string) (time.Duration, error)

+ func Reload() error

+ func WaitForTransfers(graceTime int)

+ type ActionHandler interface

+ Handle func(notification *notifier.FsEvent) error

+ type ActiveConnection interface

+ AddTransfer func(t ActiveTransfer)

+ CloseFS func() error

+ Disconnect func() error

+ GetClientVersion func() string

+ GetCommand func() string

+ GetConnectionTime func() time.Time

+ GetID func() string

+ GetLastActivity func() time.Time

+ GetLocalAddress func() string

+ GetMaxSessions func() int

+ GetProtocol func() string

+ GetRemoteAddress func() string

+ GetTransfers func() []ConnectionTransfer

+ GetUsername func() string

+ RemoveTransfer func(t ActiveTransfer)

+ SignalTransferClose func(transferID int64, err error)

+ type ActiveConnections struct

+ func (conns *ActiveConnections) Add(c ActiveConnection) error

+ func (conns *ActiveConnections) AddClientConnection(ipAddr string)

+ func (conns *ActiveConnections) AddSSHConnection(c *SSHConnection)

+ func (conns *ActiveConnections) Close(connectionID string) bool

+ func (conns *ActiveConnections) GetActiveSessions(username string) int

+ func (conns *ActiveConnections) GetClientConnections() int32

+ func (conns *ActiveConnections) GetStats() []ConnectionStatus

+ func (conns *ActiveConnections) IsNewConnectionAllowed(ipAddr string) error

+ func (conns *ActiveConnections) Remove(connectionID string)

+ func (conns *ActiveConnections) RemoveClientConnection(ipAddr string)

+ func (conns *ActiveConnections) RemoveSSHConnection(connectionID string)

+ func (conns *ActiveConnections) Swap(c ActiveConnection) error

+ type ActiveQuotaScan struct

+ StartTime int64

+ Username string

+ type ActiveRetentionChecks struct

+ Checks []RetentionCheck

+ var RetentionChecks ActiveRetentionChecks

+ func (c *ActiveRetentionChecks) Add(check RetentionCheck, user *dataprovider.User) *RetentionCheck

+ func (c *ActiveRetentionChecks) Get() []RetentionCheck

+ type ActiveScans struct

+ FolderScans []ActiveVirtualFolderQuotaScan

+ UserScans []ActiveQuotaScan

+ func (s *ActiveScans) AddUserQuotaScan(username string) bool

+ func (s *ActiveScans) AddVFolderQuotaScan(folderName string) bool

+ func (s *ActiveScans) GetUsersQuotaScans() []ActiveQuotaScan

+ func (s *ActiveScans) GetVFoldersQuotaScans() []ActiveVirtualFolderQuotaScan

+ func (s *ActiveScans) RemoveUserQuotaScan(username string) bool

+ func (s *ActiveScans) RemoveVFolderQuotaScan(folderName string) bool

+ type ActiveTransfer interface

+ GetDownloadedSize func() int64

+ GetID func() int64

+ GetRealFsPath func(fsPath string) string

+ GetSize func() int64

+ GetStartTime func() time.Time

+ GetTruncatedSize func() int64

+ GetType func() int

+ GetUploadedSize func() int64

+ GetVirtualPath func() string

+ HasSizeLimit func() bool

+ SetTimes func(fsPath string, atime time.Time, mtime time.Time) bool

+ SignalClose func(err error)

+ Truncate func(fsPath string, size int64) (int64, error)

+ type ActiveVirtualFolderQuotaScan struct

+ Name string

+ StartTime int64

+ type BaseConnection struct

+ ID string

+ User dataprovider.User

+ func NewBaseConnection(id, protocol, localAddr, remoteAddr string, user dataprovider.User) *BaseConnection

+ func (c *BaseConnection) AddTransfer(t ActiveTransfer)

+ func (c *BaseConnection) CheckParentDirs(virtualPath string) error

+ func (c *BaseConnection) CloseFS() error

+ func (c *BaseConnection) CreateDir(virtualPath string, checkFilePatterns bool) error

+ func (c *BaseConnection) CreateSymlink(virtualSourcePath, virtualTargetPath string) error

+ func (c *BaseConnection) DoStat(virtualPath string, mode int, checkFilePatterns bool) (os.FileInfo, error)

+ func (c *BaseConnection) GetConnectionTime() time.Time

+ func (c *BaseConnection) GetErrorForDeniedFile(policy int) error

+ func (c *BaseConnection) GetFsAndResolvedPath(virtualPath string) (vfs.Fs, string, error)

+ func (c *BaseConnection) GetFsError(fs vfs.Fs, err error) error

+ func (c *BaseConnection) GetGenericError(err error) error

+ func (c *BaseConnection) GetID() string

+ func (c *BaseConnection) GetLastActivity() time.Time

+ func (c *BaseConnection) GetMaxSessions() int

+ func (c *BaseConnection) GetMaxWriteSize(quotaResult vfs.QuotaCheckResult, isResume bool, fileSize int64, ...) (int64, error)

+ func (c *BaseConnection) GetNotExistError() error

+ func (c *BaseConnection) GetOpUnsupportedError() error

+ func (c *BaseConnection) GetPermissionDeniedError() error

+ func (c *BaseConnection) GetProtocol() string

+ func (c *BaseConnection) GetQuotaExceededError() error

+ func (c *BaseConnection) GetReadQuotaExceededError() error

+ func (c *BaseConnection) GetRemoteIP() string

+ func (c *BaseConnection) GetTransferID() int64

+ func (c *BaseConnection) GetTransferQuota() dataprovider.TransferQuota

+ func (c *BaseConnection) GetTransfers() []ConnectionTransfer

+ func (c *BaseConnection) GetUsername() string

+ func (c *BaseConnection) HasSpace(checkFiles, getUsage bool, requestPath string) (vfs.QuotaCheckResult, dataprovider.TransferQuota)

+ func (c *BaseConnection) IsNotExistError(err error) bool

+ func (c *BaseConnection) IsQuotaExceededError(err error) bool

+ func (c *BaseConnection) IsRemoveDirAllowed(fs vfs.Fs, fsPath, virtualPath string) error

+ func (c *BaseConnection) IsRemoveFileAllowed(virtualPath string) error

+ func (c *BaseConnection) ListDir(virtualPath string) ([]os.FileInfo, error)

+ func (c *BaseConnection) Log(level logger.LogLevel, format string, v ...any)

+ func (c *BaseConnection) RemoveDir(virtualPath string) error

+ func (c *BaseConnection) RemoveFile(fs vfs.Fs, fsPath, virtualPath string, info os.FileInfo) error

+ func (c *BaseConnection) RemoveTransfer(t ActiveTransfer)

+ func (c *BaseConnection) Rename(virtualSourcePath, virtualTargetPath string) error

+ func (c *BaseConnection) SetProtocol(protocol string)

+ func (c *BaseConnection) SetStat(virtualPath string, attributes *StatAttributes) error

+ func (c *BaseConnection) SignalTransferClose(transferID int64, err error)

+ func (c *BaseConnection) SignalTransfersAbort() error

+ func (c *BaseConnection) UpdateLastActivity()

+ type BaseTransfer struct

+ AbortTransfer atomic.Bool

+ BytesReceived atomic.Int64

+ BytesSent atomic.Int64

+ Connection *BaseConnection

+ ErrTransfer error

+ File vfs.File

+ Fs vfs.Fs

+ ID int64

+ InitialSize int64

+ MaxWriteSize int64

+ MinWriteOffset int64

+ func NewBaseTransfer(file vfs.File, conn *BaseConnection, cancelFn func(), ...) *BaseTransfer

+ func (t *BaseTransfer) CheckRead() error

+ func (t *BaseTransfer) CheckWrite() error

+ func (t *BaseTransfer) Close() error

+ func (t *BaseTransfer) GetAbortError() error

+ func (t *BaseTransfer) GetDownloadedSize() int64

+ func (t *BaseTransfer) GetFsPath() string

+ func (t *BaseTransfer) GetID() int64

+ func (t *BaseTransfer) GetRealFsPath(fsPath string) string

+ func (t *BaseTransfer) GetSize() int64

+ func (t *BaseTransfer) GetStartTime() time.Time

+ func (t *BaseTransfer) GetTransferQuota() dataprovider.TransferQuota

+ func (t *BaseTransfer) GetTruncatedSize() int64

+ func (t *BaseTransfer) GetType() int

+ func (t *BaseTransfer) GetUploadedSize() int64

+ func (t *BaseTransfer) GetVirtualPath() string

+ func (t *BaseTransfer) HandleThrottle()

+ func (t *BaseTransfer) HasSizeLimit() bool

+ func (t *BaseTransfer) SetCancelFn(cancelFn func())

+ func (t *BaseTransfer) SetFtpMode(mode string)

+ func (t *BaseTransfer) SetTimes(fsPath string, atime time.Time, mtime time.Time) bool

+ func (t *BaseTransfer) SignalClose(err error)

+ func (t *BaseTransfer) TransferError(err error)

+ func (t *BaseTransfer) Truncate(fsPath string, size int64) (int64, error)

+ type CertManager struct

+ func NewCertManager(keyPairs []TLSKeyPair, configDir, logSender string) (*CertManager, error)

+ func (m *CertManager) GetCertificateFunc(certID string) func(*tls.ClientHelloInfo) (*tls.Certificate, error)

+ func (m *CertManager) GetRootCAs() *x509.CertPool

+ func (m *CertManager) IsRevoked(crt *x509.Certificate, caCrt *x509.Certificate) bool

+ func (m *CertManager) LoadCRLs() error

+ func (m *CertManager) LoadRootCAs() error

+ func (m *CertManager) Reload() error

+ func (m *CertManager) SetCACertificates(caCertificates []string)

+ func (m *CertManager) SetCARevocationLists(caRevocationLists []string)

+ type Configuration struct

+ Actions ProtocolActions

+ AllowSelfConnections int

+ DataRetentionHook string

+ DefenderConfig DefenderConfig

+ IdleTimeout int

+ MaxPerHostConnections int

+ MaxTotalConnections int

+ PostConnectHook string

+ PostDisconnectHook string

+ ProxyAllowed []string

+ ProxyProtocol int

+ RateLimitersConfig []RateLimiterConfig

+ SetstatMode int

+ StartupHook string

+ TempPath string

+ UploadMode int

+ WhiteListFile string

+ func (c *Configuration) ExecutePostConnectHook(ipAddr, protocol string) error

+ func (c *Configuration) ExecuteStartupHook() error

+ func (c *Configuration) GetProxyListener(listener net.Listener) (*proxyproto.Listener, error)

+ func (c *Configuration) IsAtomicUploadEnabled() bool

+ type ConnectionStatus struct

+ ClientVersion string

+ Command string

+ ConnectionID string

+ ConnectionTime int64

+ LastActivity int64

+ Node string

+ Protocol string

+ RemoteAddress string

+ Transfers []ConnectionTransfer

+ Username string

+ func (c *ConnectionStatus) GetConnectionDuration() string

+ func (c *ConnectionStatus) GetConnectionInfo() string

+ func (c *ConnectionStatus) GetTransfersAsString() string

+ type ConnectionTransfer struct

+ DLSize int64

+ HasSizeLimit bool

+ ID int64

+ OperationType string

+ Size int64

+ StartTime int64

+ ULSize int64

+ VirtualPath string

+ type Defender interface

+ AddEvent func(ip string, event HostEvent)

+ DeleteHost func(ip string) bool

+ GetBanTime func(ip string) (*time.Time, error)

+ GetHost func(ip string) (dataprovider.DefenderEntry, error)

+ GetHosts func() ([]dataprovider.DefenderEntry, error)

+ GetScore func(ip string) (int, error)

+ IsBanned func(ip string) bool

+ Reload func() error

+ type DefenderConfig struct

+ BanTime int

+ BanTimeIncrement int

+ BlockList []string

+ BlockListFile string

+ Driver string

+ Enabled bool

+ EntriesHardLimit int

+ EntriesSoftLimit int

+ ObservationTime int

+ SafeList []string

+ SafeListFile string

+ ScoreInvalid int

+ ScoreLimitExceeded int

+ ScoreValid int

+ Threshold int

+ type EventParams struct

+ Event string

+ FileSize int64

+ FsPath string

+ FsTargetPath string

+ Groups []sdk.GroupMapping

+ IP string

+ Name string

+ Object plugin.Renderer

+ ObjectName string

+ ObjectType string

+ Protocol string

+ Status int

+ Timestamp int64

+ VirtualPath string

+ VirtualTargetPath string

+ func (p *EventParams) AddError(err error)

+ type HTTPAuthProvider interface

+ IsEnabled func() bool

+ ValidateCredentials func(username, password string) bool

+ func NewBasicAuthProvider(authUserFile string) (HTTPAuthProvider, error)

+ type HostEvent int

+ const HostEventLimitExceeded

+ const HostEventLoginFailed

+ const HostEventNoLoginTried

+ const HostEventUserNotFound

+ type HostList struct

+ IPAddresses map[string]bool

+ Ranges cidranger.Ranger

+ type HostListFile struct

+ CIDRNetworks []string

+ IPAddresses []string

+ type MetadataCheck struct

+ StartTime int64

+ Username string

+ type MetadataChecks struct

+ func (c *MetadataChecks) Add(username string) bool

+ func (c *MetadataChecks) Get() []MetadataCheck

+ func (c *MetadataChecks) Remove(username string) bool

+ type ProtocolActions struct

+ ExecuteOn []string

+ ExecuteSync []string

+ Hook string

+ type RateLimiterConfig struct

+ AllowList []string

+ Average int64

+ Burst int

+ EntriesHardLimit int

+ EntriesSoftLimit int

+ GenerateDefenderEvents bool

+ Period int64

+ Protocols []string

+ Type int

+ type RateLimiterType int

+ type RetentionCheck struct

+ Email string

+ Folders []dataprovider.FolderRetention

+ Notifications []RetentionCheckNotification

+ StartTime int64

+ Username string

+ func (c *RetentionCheck) Start() error

+ func (c *RetentionCheck) Validate() error

+ type RetentionCheckNotification = string

+ type SSHConnection struct

+ func NewSSHConnection(id string, conn net.Conn) *SSHConnection

+ func (c *SSHConnection) Close() error

+ func (c *SSHConnection) GetID() string

+ func (c *SSHConnection) GetLastActivity() time.Time

+ func (c *SSHConnection) UpdateLastActivity()

+ type StatAttributes struct

+ Atime time.Time

+ Flags int

+ GID int

+ Mode os.FileMode

+ Mtime time.Time

+ Size int64

+ UID int

+ type TLSKeyPair struct

+ Cert string

+ ID string

+ Key string

+ type TransfersChecker interface

+ AddTransfer func(transfer dataprovider.ActiveTransfer)

+ GetOverquotaTransfers func() []overquotaTransfer

+ RemoveTransfer func(ID int64, connectionID string)

+ UpdateTransferCurrentSizes func(ulSize, dlSize, ID int64, connectionID string)

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