system

Documentation

Index

• Constants
• type Environment
• type File
• type Info
  • func GetInfo(ctx context.Context) *Info
  • func GetInfoWithChecks(ctx context.Context, checks []*proto.Checks) (*Info, error)
  • func (i *Info) SetFlags(rosenpassEnabled, rosenpassPermissive bool, serverSSHAllowed *bool, ...)
• type NetworkAddress
• type StaticInfo
• type SysInfo

Constants

const DeviceNameCtxKey = "deviceName"

DeviceNameCtxKey context key for device name

const OsNameCtxKey = "OsName"

OsNameCtxKey context key for operating system name

const OsVersionCtxKey = "OsVersion"

OsVersionCtxKey context key for operating system version

const UiVersionCtxKey = "user-agent"

UiVersionCtxKey context key for user UI version

Types

type Environment

type Environment struct {
	Cloud    string
	Platform string
}

type File

type File struct {
	Path             string
	Exist            bool
	ProcessIsRunning bool
}

type Info

type Info struct {
	GoOS               string
	Kernel             string
	Platform           string
	OS                 string
	OSVersion          string
	Hostname           string
	CPUs               int
	NetbirdVersion     string
	UIVersion          string
	KernelVersion      string
	NetworkAddresses   []NetworkAddress
	SystemSerialNumber string
	SystemProductName  string
	SystemManufacturer string
	Environment        Environment
	Files              []File // for posture checks

	RosenpassEnabled    bool
	RosenpassPermissive bool
	ServerSSHAllowed    bool
	DisableClientRoutes bool
	DisableServerRoutes bool
	DisableDNS          bool
	DisableFirewall     bool
}

Info is an object that contains machine information Most of the code is taken from https://github.com/matishsiao/goInfo

func GetInfo

func GetInfo(ctx context.Context) *Info

GetInfo retrieves and parses the system information

func GetInfoWithChecks

func GetInfoWithChecks(ctx context.Context, checks []*proto.Checks) (*Info, error)

GetInfoWithChecks retrieves and parses the system information with applied checks.

func (*Info) SetFlags

func (i *Info) SetFlags(
	rosenpassEnabled, rosenpassPermissive bool,
	serverSSHAllowed *bool,
	disableClientRoutes, disableServerRoutes,
	disableDNS, disableFirewall bool,
)

type NetworkAddress

type NetworkAddress struct {
	NetIP netip.Prefix
	Mac   string
}

type StaticInfo

type StaticInfo struct {
	SystemSerialNumber string
	SystemProductName  string
	SystemManufacturer string
	Environment        Environment
}

StaticInfo is an object that contains machine information that does not change

type SysInfo

type SysInfo struct {
	ChassisSerial string
	ProductSerial string
	BoardSerial   string

	ProductName   string
	BoardName     string
	ProductVendor string
}

SysInfo used to moc out the sysinfo getter