util

Documentation

Index

• Constants
• Variables
• func ByteToString(orig []byte) string
• func CheckUnpriUserNS() error
• func FileExist(path string) bool
• func FindTargetDeviceID(mi *MountInfo) bool
• func GetAllCGroupSubSystem() ([]string, error)
• func GetCgroupVersion() (int, error)
• func GetKernelVersion() ([]int, error)
• func HttpSendJson(method string, url string, data string) (string, error)
• func IntContains(s []int, e int) bool
• func IsDir(FilePath string) bool
• func IsDirectory(path string) bool
• func IsSoftLink(FilePath string) bool
• func MakeDev(major, minor string) int
• func RandString(n int) string
• func ReadLines(path string) ([]string, error)
• func RemoveDuplicateElement(addrs []string) []string
• func RewriteFile(path string, content string, perm os.FileMode)
• func SetBlockAccessible(path string) error
• func ShellExec(shellPath string) error
• func StringContains(s []string, e string) bool
• func UnixHttpSend(method string, unixPath string, uri string, data string) (string, error)
• func WriteFile(path string, content string) error
• func WriteFileAdd(path string, content string) error
• func WriteShellcodeToCrontab(header string, filePath string, shellcode string) error
• type CgroupInfo
  • func GetAllCGroup() ([]CgroupInfo, error)
  • func GetCgroup(pid int) ([]CgroupInfo, error)
• type Level
• type LevelLogger
  • func (l *LevelLogger) Close()
  • func (l *LevelLogger) Debug(format string, v ...interface{})
  • func (l *LevelLogger) Error(format string, v ...interface{})
  • func (l *LevelLogger) Info(format string, v ...interface{})
  • func (l *LevelLogger) Warn(format string, v ...interface{})
• type MountInfo
  • func GetMountInfo() ([]MountInfo, error)
• type Wrapper
  • func NewStdoutWrapper() *Wrapper
  • func NewWrapper(writer io.Writer, colorful bool) *Wrapper

Constants

const (
	DebugPrefix = "[DEBUG] "
	InfoPrefix  = "[INFO_]  "
	WarnPrefix  = "[WARN_]  "
	ErrorPrefix = "[ERROR] "
)

Variables

var (
	RedBold    = color.New(color.FgRed).Add(color.Bold)
	GreenBold  = color.New(color.FgGreen).Add(color.Bold)
	YellowBold = color.New(color.FgYellow).Add(color.Bold)
	BlueBold   = color.New(color.FgBlue).Add(color.Bold)
)

Colorful Bold use like `GreenBold.Sprint(str)`

var (
	ColorDebugPrefix = GreenBold.Sprint(DebugPrefix)
	ColorInfoPrefix  = BlueBold.Sprint(InfoPrefix)
	ColorWarnPrefix  = YellowBold.Sprint(WarnPrefix)
	ColorErrorPrefix = RedBold.Sprint(ErrorPrefix)
)

var DefaultLevel = INFO

Functions

func ByteToString

func ByteToString(orig []byte) string

func CheckUnpriUserNS

func CheckUnpriUserNS() error

CheckUnpriUserNS checks if the current host enable unprivileged user namespace. reference:

https://blog.trailofbits.com/2019/07/19/understanding-docker-container-escapes/
https://unit42.paloaltonetworks.com/cve-2022-0492-cgroups/

exceptional case:

the sysctl files(/proc/sys/kernel/unprivileged_userns_clone) only exist in Debian, Ubuntu.
We can not check the sysctl file in other distros, test in CentOS Linux release 8.4.2105 (Core).

func FileExist

func FileExist(path string) bool

func FindTargetDeviceID

func FindTargetDeviceID(mi *MountInfo) bool

find block device id

func GetAllCGroupSubSystem

func GetAllCGroupSubSystem() ([]string, error)

func GetCgroupVersion

func GetCgroupVersion() (int, error)

get cgroup version V1/V2 hybrid mode will not work in container

func GetKernelVersion

func GetKernelVersion() ([]int, error)

get kernel version

func HttpSendJson

func HttpSendJson(method string, url string, data string) (string, error)

func IntContains

func IntContains(s []int, e int) bool

IntContains check string array contains a int number

func IsDir

func IsDir(FilePath string) bool

func IsDirectory

func IsDirectory(path string) bool

func IsSoftLink

func IsSoftLink(FilePath string) bool

func MakeDev

func MakeDev(major, minor string) int

func RandString

func RandString(n int) string

func ReadLines

func ReadLines(path string) ([]string, error)

ReadLines reads a whole file into memory and returns a slice of its lines. from https://stackoverflow.com/questions/5884154/read-text-file-into-string-array-and-write

func RemoveDuplicateElement

func RemoveDuplicateElement(addrs []string) []string

func RewriteFile

func RewriteFile(path string, content string, perm os.FileMode)

func SetBlockAccessible

func SetBlockAccessible(path string) error

set all block device accessible

func ShellExec

func ShellExec(shellPath string) error

ShellExec run shell script by bash

func StringContains

func StringContains(s []string, e string) bool

StringContains check string array contains a string

func UnixHttpSend

func UnixHttpSend(method string, unixPath string, uri string, data string) (string, error)

ref https://docs.docker.com/engine/api/v1.24/

func WriteFile

func WriteFile(path string, content string) error

func WriteFileAdd

func WriteFileAdd(path string, content string) error

func WriteShellcodeToCrontab

func WriteShellcodeToCrontab(header string, filePath string, shellcode string) error

Types

type CgroupInfo

type CgroupInfo struct {
	HierarchyID   int
	ControllerLst string // split by "," but should not be split
	CgroupPath    string
	OriginalInfo  string
}

func GetAllCGroup

func GetAllCGroup() ([]CgroupInfo, error)

func GetCgroup

func GetCgroup(pid int) ([]CgroupInfo, error)

GetCgroup returns the cgroup info of the process param pid: 0 = self, 1 = container main process

type Level

type Level uint8

const (
	ERROR Level = iota
	WARNNING
	INFO
	DEBUG
)

type LevelLogger

type LevelLogger struct {
	Level Level
	Color bool

	PrintFunc func(format string, v ...interface{})
}

func (*LevelLogger) Close

func (l *LevelLogger) Close()

func (*LevelLogger) Debug

func (l *LevelLogger) Debug(format string, v ...interface{})

func (*LevelLogger) Error

func (l *LevelLogger) Error(format string, v ...interface{})

func (*LevelLogger) Info

func (l *LevelLogger) Info(format string, v ...interface{})

func (*LevelLogger) Warn

func (l *LevelLogger) Warn(format string, v ...interface{})

type MountInfo

type MountInfo struct {
	Device            string
	Fstype            string
	Root              string
	MountPoint        string
	Opts              []string
	Major             string
	Minor             string
	SuperBlockOptions []string
}

func GetMountInfo

func GetMountInfo() ([]MountInfo, error)

type Wrapper

type Wrapper struct {
	LevelLogger
	// contains filtered or unexported fields
}

func NewStdoutWrapper

func NewStdoutWrapper() *Wrapper

func NewWrapper

func NewWrapper(writer io.Writer, colorful bool) *Wrapper