utils

Documentation

Overview

Package utils provides common utilities for the tryssh application.

Index

• Constants
• func CheckFileIsExist(filename string) bool
• func ClearMasterKey()
• func CreateFile(filePath string, perm fs.FileMode) error
• func Decrypt(encrypted string, key []byte) (string, error)
• func Encrypt(plaintext string, key []byte) (string, error)
• func Error(args ...interface{})
• func Errorf(format string, args ...interface{})
• func Errorln(args ...interface{})
• func Fatal(args ...interface{})
• func Fatalf(format string, args ...interface{})
• func Fatalln(args ...interface{})
• func FileYamlMarshalAndWrite(path string, conf interface{}) error
• func GetCachedMasterKey() ([]byte, error)
• func GetMasterKey() ([]byte, error)
• func Info(args ...interface{})
• func Infof(format string, args ...interface{})
• func Infoln(args ...interface{})
• func IsEncrypted(s string) bool
• func MaskSecret(s string) string
• func ReadFile(filePath string) ([]byte, bool)
• func RemoveDuplicate(s []string) []string
• func SetLogLevel(level logrus.Level)
• func ToInterfaceSlice[T any](s []T) []interface{}
• func UpdateFile(filePath string, fileContent []byte, perm fs.FileMode) error
• func Warn(args ...interface{})
• func Warnf(format string, args ...interface{})
• func Warnln(args ...interface{})

Constants

const ConfigFileMode = 0600

ConfigFileMode is the default file permission used for config files.

Functions

func CheckFileIsExist

func CheckFileIsExist(filename string) bool

CheckFileIsExist returns true if the file exists (including when unreadable due to permissions).

func ClearMasterKey

func ClearMasterKey()

ClearMasterKey removes the cached master key from memory.

func CreateFile

func CreateFile(filePath string, perm fs.FileMode) error

CreateFile creates an empty file with the specified permissions atomically.

func Decrypt

func Decrypt(encrypted string, key []byte) (string, error)

Decrypt decrypts a prefixed base64 string back to plaintext.

func Encrypt

func Encrypt(plaintext string, key []byte) (string, error)

Encrypt encrypts plaintext and returns a prefixed base64 string.

func Error

func Error(args ...interface{})

Error logs error messages at the Error level.

func Errorf

func Errorf(format string, args ...interface{})

Errorf logs formatted error messages at the Error level.

func Errorln

func Errorln(args ...interface{})

Errorln logs error messages with a newline at the Error level.

func Fatal

func Fatal(args ...interface{})

Fatal logs messages at the Fatal level and exits.

func Fatalf

func Fatalf(format string, args ...interface{})

Fatalf logs formatted messages at the Fatal level and exits.

func Fatalln

func Fatalln(args ...interface{})

Fatalln logs messages with a newline at the Fatal level and exits.

func FileYamlMarshalAndWrite

func FileYamlMarshalAndWrite(path string, conf interface{}) error

FileYamlMarshalAndWrite marshals the given value to YAML and writes it atomically to the specified path, creating parent directories as needed.

func GetCachedMasterKey

func GetCachedMasterKey() ([]byte, error)

GetCachedMasterKey returns the master key only if already cached or available via the environment variable, without prompting interactively.

func GetMasterKey

func GetMasterKey() ([]byte, error)

GetMasterKey returns the cached master key, prompting for it if necessary.

func Info

func Info(args ...interface{})

Info logs informational messages at the Info level.

func Infof

func Infof(format string, args ...interface{})

Infof logs formatted informational messages at the Info level.

func Infoln

func Infoln(args ...interface{})

Infoln logs informational messages with a newline at the Info level.

func IsEncrypted

func IsEncrypted(s string) bool

IsEncrypted checks if a value has the encrypted prefix.

func MaskSecret

func MaskSecret(s string) string

MaskSecret masks a secret string, returning a fixed-length indicator.

func ReadFile

func ReadFile(filePath string) ([]byte, bool)

ReadFile reads the entire file and returns its contents.

func RemoveDuplicate

func RemoveDuplicate(s []string) []string

RemoveDuplicate removes duplicate strings from the slice, preserving order.

func SetLogLevel

func SetLogLevel(level logrus.Level)

SetLogLevel changes the global log level.

func ToInterfaceSlice

func ToInterfaceSlice[T any](s []T) []interface{}

ToInterfaceSlice converts a typed slice to []interface{} using generics.

func UpdateFile

func UpdateFile(filePath string, fileContent []byte, perm fs.FileMode) error

UpdateFile writes the given content to the file with the specified permissions atomically using a temporary file and rename to prevent corruption on crash.

func Warn

func Warn(args ...interface{})

Warn logs warning messages at the Warn level.

func Warnf

func Warnf(format string, args ...interface{})

Warnf logs formatted warning messages at the Warn level.

func Warnln

func Warnln(args ...interface{})

Warnln logs warning messages with a newline at the Warn level.