sys

Documentation

Index

• func Connections(parent *proclib.Process) []netlib.Connection
• func DetectOS() string
• func Exec(executable string, disown bool) (string, error)
• func Files(path string) (files []filelib.File, err error)
• func Import() script.Library
• func Include() script.Option
• func Library() script.Library
• func OpenFile(filePath string) (file.Type, error)
• func Processes() (procs []proclib.Process)
• type File
  • func (f *File) Move(dstPath string) error
  • func (f *File) Remove() error
  • func (f *File) Sync() error

Functions

func Connections

func Connections(parent *proclib.Process) []netlib.Connection

Connections uses the gopsutil/net to get all connections created by a process (or all by default).

@callable: sys.connections @param: parent @?Process @retval: connections @[]Connection

@usage: connections = sys.connections()

func DetectOS

func DetectOS() string

DetectOS uses the GOOS variable to determine the OS.

@callable: sys.detectOS @retval: os @string

@usage: os = sys.detectOS()

func Exec

func Exec(executable string, disown bool) (string, error)

Exec uses the os/exec.command to execute the passed executable/params.

@callable: sys.exec @param: executable @String @param: disown @?Bool @retval: output @String @retval: err @Error

@usage: output = sys.exec("/usr/sbin/nginx", disown=True)

func Files

func Files(path string) (files []filelib.File, err error)

Files uses the ioutil.ReadDir to get all files in a given path.

@callable: sys.files @retval: files @[]File

@usage: files = sys.files()

func Import

func Import() script.Library

@DEPRECATE Import the sys library to enable scripts to access low level system functionality.

func Include

func Include() script.Option

Include the sys library in a script environment.

func Library

func Library() script.Library

Library prepares a new sys library for use within a script environment.

func OpenFile

func OpenFile(filePath string) (file.Type, error)

OpenFile uses os.Open to Open a file.

@callable: sys.openFile @param: path @string @retval: file @File @retval: err @Error

@usage: f, err = sys.openFile("/usr/bin/malware")

func Processes

func Processes() (procs []proclib.Process)

Processes uses the gopsutil/process to get all processes.

@callable: sys.processes @retval: procs @[]Process

@usage: processes = sys.processes()

Types

type File

type File struct {
	*os.File
}

File is our impl of File.

func (*File) Move

func (f *File) Move(dstPath string) error

Move uses os.Rename to move a file/folder

func (*File) Remove

func (f *File) Remove() error

Remove uses os.Remove to remove a file/folder. WARNING: basically works like rm -rf

func (*File) Sync

func (f *File) Sync() error

Sync closes and then reopens the file.