hostop

Documentation

Overview

Package hostop contains an interface to represent the execution of atomic host operations at a higher privilege.

Index

• func HostPidNamespace() (bool, error)
• func InsideContainer() bool
• type HostOp
  • func NewMountHostOp(opts ...HostOpOption) HostOp
• type HostOpOption
  • func WithAssumeContainer() HostOpOption
  • func WithAssumeHost() HostOpOption
  • func WithContainerDetection() HostOpOption
  • func WithLogger(logger logr.Logger) HostOpOption
• type NsTypeName

Functions

func HostPidNamespace

func HostPidNamespace() (bool, error)

HostPidNamespace checks whether the current process is using host's PID namespace.

func InsideContainer

func InsideContainer() bool

InsideContainer checks whether the current process is being executed inside of a container.

Types

type HostOp

type HostOp interface {
	// Do executes the action at a privileged context at the host.
	Do(action func() error) error
}

func NewMountHostOp

func NewMountHostOp(opts ...HostOpOption) HostOp

type HostOpOption

type HostOpOption func(*hostOpOpts)

func WithAssumeContainer

func WithAssumeContainer() HostOpOption

WithAssumeContainer ensures that HostOp always assume it is being executed from inside a container, and therefore attempts the necessary privilege escalations.

func WithAssumeHost

func WithAssumeHost() HostOpOption

WithAssumeHost ensures that HostOp always assume that it is being executed directly in the host.

func WithContainerDetection

func WithContainerDetection() HostOpOption

WithContainerDetection ensures that HostOp tries to auto detect whether or not the code is being executed from inside a container.

func WithLogger

func WithLogger(logger logr.Logger) HostOpOption

WithLogger sets a logger to be used whilst executing operations.

type NsTypeName

type NsTypeName string

const (
	Mount NsTypeName = "ns/mnt"
)