Documentation
¶
Overview ¶
Package util provides some common utility methods
Index ¶
- func ByteCountIEC(b int64) string
- func ByteCountSI(b int64) string
- func CheckTCP4Port(port int)
- func CleanDirInput(dirInput string) string
- func CleanPath(p string) string
- func CleanPathWithBase(base, p string) string
- func Contains[T comparable](elems []T, v T) bool
- func EncodeTLSCertToPem(tlsCert *x509.Certificate) (string, error)
- func FindSharedDataPath(name, searchDir string) string
- func GenerateECDSAKeys(file string) error
- func GenerateEd25519Keys(file string) error
- func GenerateRSAKeys(file string) error
- func GenerateRandomBytes(length int) []byte
- func GenerateUniqueID() string
- func GetAbsolutePath(name string) (string, error)
- func GetDirsForVirtualPath(virtualPath string) []string
- func GetDurationAsString(d time.Duration) string
- func GetHTTPLocalAddress(r *http.Request) string
- func GetIPFromRemoteAddress(remoteAddress string) string
- func GetIntFromPointer(val *int64) int64
- func GetRealIP(r *http.Request, header string, depth int) string
- func GetRedactedURL(rawurl string) string
- func GetSSHPublicKeyAsString(pubKey []byte) (string, error)
- func GetStringFromPointer(val *string) string
- func GetTLSCiphersFromNames(cipherNames []string) []uint16
- func GetTLSVersion(val int) uint16
- func GetTimeAsMsSinceEpoch(t time.Time) int64
- func GetTimeFromMsecSinceEpoch(msec int64) time.Time
- func GetTimeFromPointer(val *time.Time) time.Time
- func HTTPListenAndServe(srv *http.Server, address string, port int, isTLS bool, logSender string) error
- func IsByteArrayEmpty(b []byte) bool
- func IsEmailValid(email string) bool
- func IsFileInputValid(fileInput string) bool
- func IsStringPrefixInSlice(obj string, list []string) bool
- func LoadTemplate(base *template.Template, paths ...string) *template.Template
- func NilIfEmpty(s string) *string
- func PanicOnError(err error)
- func ParseAllowedIPAndRanges(allowed []string) ([]func(net.IP) bool, error)
- func ParseBytes(s string) (int64, error)
- func PrependFileInfo(files []os.FileInfo, info os.FileInfo) []os.FileInfo
- func Remove(elems []string, val string) []string
- func RemoveDuplicates(obj []string, trim bool) []string
- type Conn
- type GenericError
- type MethodDisabledError
- type RecordNotFoundError
- type ValidationError
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ByteCountIEC ¶
ByteCountIEC returns humanized size in IEC (binary) format
func ByteCountSI ¶
ByteCountSI returns humanized size in SI (decimal) format
func CheckTCP4Port ¶
func CheckTCP4Port(port int)
CheckTCP4Port quits the app if bind on the given IPv4 port fails. This is a ugly hack to avoid to bind on an already used port. It is required on Windows only. Upstream does not consider this behaviour a bug: https://github.com/golang/go/issues/45150
func CleanDirInput ¶
CleanDirInput sanitizes user input for directories. On Windows it removes any trailing `"`. We try to help windows users that set an invalid path such as "C:\ProgramData\SFTPGO\". This will only help if the invalid path is the last argument, for example in this command: sftpgo.exe serve -c "C:\ProgramData\SFTPGO\" -l "sftpgo.log" the -l flag will be ignored and the -c flag will get the value `C:\ProgramData\SFTPGO" -l sftpgo.log` since the backslash after SFTPGO escape the double quote. This is definitely a bad user input
func CleanPathWithBase ¶
CleanPathWithBase returns a clean POSIX (/) absolute path to work with. The specified base will be used if the provided path is not absolute
func Contains ¶
func Contains[T comparable](elems []T, v T) bool
Contains reports whether v is present in elems.
func EncodeTLSCertToPem ¶
func EncodeTLSCertToPem(tlsCert *x509.Certificate) (string, error)
EncodeTLSCertToPem returns the specified certificate PEM encoded. This can be verified using openssl x509 -in cert.crt -text -noout
func FindSharedDataPath ¶
FindSharedDataPath searches for the specified directory name in searchDir and in system-wide shared data directories. If name is an absolute path it is returned unmodified.
func GenerateECDSAKeys ¶
GenerateECDSAKeys generate ecdsa private and public keys and write the private key to specified file and the public key to the specified file adding the .pub suffix
func GenerateEd25519Keys ¶
GenerateEd25519Keys generate ed25519 private and public keys and write the private key to specified file and the public key to the specified file adding the .pub suffix
func GenerateRSAKeys ¶
GenerateRSAKeys generate rsa private and public keys and write the private key to specified file and the public key to the specified file adding the .pub suffix
func GenerateRandomBytes ¶
GenerateRandomBytes generates the secret to use for JWT auth
func GetAbsolutePath ¶
GetAbsolutePath returns an absolute path using the current dir as base if name defines a relative path
func GetDirsForVirtualPath ¶
GetDirsForVirtualPath returns all the directory for the given path in reverse order for example if the path is: /1/2/3/4 it returns: [ "/1/2/3/4", "/1/2/3", "/1/2", "/1", "/" ]
func GetDurationAsString ¶
GetDurationAsString returns a string representation for a time.Duration
func GetHTTPLocalAddress ¶
GetHTTPLocalAddress returns the local address for an http.Request or empty if it cannot be determined
func GetIPFromRemoteAddress ¶
GetIPFromRemoteAddress returns the IP from the remote address. If the given remote address cannot be parsed it will be returned unchanged
func GetIntFromPointer ¶
GetIntFromPointer returns the int value or zero
func GetRealIP ¶
GetRealIP returns the ip address as result of parsing the specified header and using the specified depth
func GetRedactedURL ¶
GetRedactedURL returns the url redacting the password if any
func GetSSHPublicKeyAsString ¶
GetSSHPublicKeyAsString returns an SSH public key serialized as string
func GetStringFromPointer ¶
GetStringFromPointer returns the string value or empty if nil
func GetTLSCiphersFromNames ¶
GetTLSCiphersFromNames returns the TLS ciphers from the specified names
func GetTLSVersion ¶
GetTLSVersion returns the TLS version for integer: - 12 means TLS 1.2 - 13 means TLS 1.3 default is TLS 1.2
func GetTimeAsMsSinceEpoch ¶
GetTimeAsMsSinceEpoch returns unix timestamp as milliseconds from a time struct
func GetTimeFromMsecSinceEpoch ¶
GetTimeFromMsecSinceEpoch return a time struct from a unix timestamp with millisecond precision
func GetTimeFromPointer ¶
GetTimeFromPointer returns the time value or now
func HTTPListenAndServe ¶
func HTTPListenAndServe(srv *http.Server, address string, port int, isTLS bool, logSender string) error
HTTPListenAndServe is a wrapper for ListenAndServe that support both tcp and Unix-domain sockets
func IsByteArrayEmpty ¶
IsByteArrayEmpty return true if the byte array is empty or a new line
func IsEmailValid ¶
IsEmailValid returns true if the specified email address is valid
func IsFileInputValid ¶
IsFileInputValid returns true this is a valid file name. This method must be used before joining a file name, generally provided as user input, with a directory
func IsStringPrefixInSlice ¶
IsStringPrefixInSlice searches a string prefix in a slice and returns true if a matching prefix is found
func LoadTemplate ¶
LoadTemplate parses the given template paths. It behaves like template.Must but it writes a log before exiting. You can optionally provide a base template (e.g. to define some custom functions)
func NilIfEmpty ¶
NilIfEmpty returns nil if the input string is empty
func ParseAllowedIPAndRanges ¶
ParseAllowedIPAndRanges returns a list of functions that allow to find if an IP is equal or is contained within the allowed list
func ParseBytes ¶
ParseBytes parses a string representation of bytes into the number of bytes it represents.
ParseBytes("42 MB") -> 42000000, nil ParseBytes("42 mib") -> 44040192, nil
copied from here:
https://github.com/dustin/go-humanize/blob/master/bytes.go
with minor modifications
func PrependFileInfo ¶
PrependFileInfo prepends a file info to a slice in an efficient way. We, optimistically, assume that the slice has enough capacity
func RemoveDuplicates ¶
RemoveDuplicates returns a new slice removing any duplicate element from the initial one
Types ¶
type Conn ¶
type Conn struct {
net.Conn
ReadTimeout time.Duration
WriteTimeout time.Duration
ReadThreshold int32
WriteThreshold int32
BytesReadFromDeadline atomic.Int32
BytesWrittenFromDeadline atomic.Int32
}
Conn wraps a net.Conn, and sets a deadline for every read and write operation.
type GenericError ¶
type GenericError struct {
// contains filtered or unexported fields
}
GenericError raised for not well categorized error
func NewGenericError ¶
func NewGenericError(error string) *GenericError
NewGenericError returns a generic error
func (*GenericError) Error ¶
func (e *GenericError) Error() string
type MethodDisabledError ¶
type MethodDisabledError struct {
// contains filtered or unexported fields
}
MethodDisabledError raised if a method is disabled in config file. For example, if user management is disabled, this error is raised every time a user operation is done using the REST API
func NewMethodDisabledError ¶
func NewMethodDisabledError(error string) *MethodDisabledError
NewMethodDisabledError returns a method disabled error
func (*MethodDisabledError) Error ¶
func (e *MethodDisabledError) Error() string
Method disabled error details
type RecordNotFoundError ¶
type RecordNotFoundError struct {
// contains filtered or unexported fields
}
RecordNotFoundError raised if a requested object is not found
func NewRecordNotFoundError ¶
func NewRecordNotFoundError(error string) *RecordNotFoundError
NewRecordNotFoundError returns a not found error
func (*RecordNotFoundError) Error ¶
func (e *RecordNotFoundError) Error() string
type ValidationError ¶
type ValidationError struct {
// contains filtered or unexported fields
}
ValidationError raised if input data is not valid
func NewValidationError ¶
func NewValidationError(error string) *ValidationError
NewValidationError returns a validation errors
func (*ValidationError) GetErrorString ¶
func (e *ValidationError) GetErrorString() string
GetErrorString returns the unmodified error string
Source Files