aghos

Documentation

Overview

Package aghos contains utilities for functions requiring system calls and other OS-specific APIs. OS-specific network handling should go to aghnet instead.

Index

• Constants
• Variables
• func ConfigureSyslog(serviceName string) error
• func HaveAdminRights() (bool, error)
• func IsOpenWrt() (ok bool)
• func RunCommand(command string, arguments ...string) (int, string, error)
• func SendProcessSignal(pid int, sig syscall.Signal) error
• func SetGroup(groupName string) (err error)
• func SetRlimit(val uint64) (err error)
• func SetUser(userName string) (err error)
• func Unsupported(op string) (err error)
• type FileWalker
  • func (c FileWalker) Walk(initPattern string) (ok bool, err error)
• type UnsupportedError
  • func (err *UnsupportedError) Error() (msg string)

Constants

const MaxCmdOutputSize = 2 * 1024

MaxCmdOutputSize is the maximum length of performed shell command output.

const MaxWalkedFileSize = 1024 * 1024

MaxWalkedFileSize is the maximum length of the file that FileWalker can check.

Variables

var NativeEndian = binary.LittleEndian

NativeEndian is the native endianness of this system.

Functions

func ConfigureSyslog

func ConfigureSyslog(serviceName string) error

ConfigureSyslog reroutes standard logger output to syslog.

func HaveAdminRights

func HaveAdminRights() (bool, error)

HaveAdminRights checks if the current user has root (administrator) rights.

func IsOpenWrt

func IsOpenWrt() (ok bool)

IsOpenWrt returns true if host OS is OpenWrt.

func RunCommand

func RunCommand(command string, arguments ...string) (int, string, error)

RunCommand runs shell command.

func SendProcessSignal

func SendProcessSignal(pid int, sig syscall.Signal) error

SendProcessSignal sends signal to a process.

func SetGroup

func SetGroup(groupName string) (err error)

SetGroup sets the effective group ID of the calling process.

func SetRlimit

func SetRlimit(val uint64) (err error)

SetRlimit sets user-specified limit of how many fd's we can use.

See https://github.com/AdguardTeam/AdGuardHome/internal/issues/659.

func SetUser

func SetUser(userName string) (err error)

SetUser sets the effective user ID of the calling process.

func Unsupported

func Unsupported(op string) (err error)

Unsupported is a helper that returns an *UnsupportedError with the Op field set to op and the OS field set to the current OS.

Types

type FileWalker

type FileWalker func(r io.Reader) (patterns []string, cont bool, err error)

FileWalker is the signature of a function called for files in the file tree. As opposed to filepath.Walk it only walk the files (not directories) matching the provided pattern and those returned by function itself. All patterns should be valid for filepath.Glob. If cont is false, the walking terminates. Each opened file is also limited for reading to MaxWalkedFileSize.

TODO(e.burkov): Consider moving to the separate package like pathutil.

TODO(e.burkov): Think about passing filename or any additional data.

func (FileWalker) Walk

func (c FileWalker) Walk(initPattern string) (ok bool, err error)

Walk starts walking the files defined by initPattern. It only returns true if c signed to stop walking.

type UnsupportedError

type UnsupportedError struct {
	Op string
	OS string
}

UnsupportedError is returned by functions and methods when a particular operation Op cannot be performed on the current OS.

func (*UnsupportedError) Error

func (err *UnsupportedError) Error() (msg string)

Error implements the error interface for *UnsupportedError.