util

package
v0.0.0-...-433fd04 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 17, 2021 License: Apache-2.0 Imports: 32 Imported by: 0

Documentation

Index

Constants

View Source
const SystemdListenFDsStart = 3

SystemdListenFDsStart is the number of the first file descriptor that might have been opened by systemd when socket activation is enabled. It's always 3 in real-world usage (i.e. the first file descriptor opened after stdin, stdout and stderr), so this constant should always be the value passed to GetListeners, except for unit tests.

Variables

This section is empty.

Functions

func AppArmorProfile

func AppArmorProfile() string

AppArmorProfile returns the current apparmor profile.

func CanonicalNetworkAddress

func CanonicalNetworkAddress(address string) string

CanonicalNetworkAddress parses the given network address and returns a string of the form "host:port", possibly filling it with the default port if it's missing.

func CanonicalNetworkAddressFromAddressAndPort

func CanonicalNetworkAddressFromAddressAndPort(address string, port int) string

CanonicalNetworkAddressFromAddressAndPort returns a network address from separate address and port values. The address accepts values such as "[::]", "::" and "localhost".

func CheckTrustState

func CheckTrustState(cert x509.Certificate, trustedCerts map[string]x509.Certificate, networkCert *shared.CertInfo, trustCACertificates bool) (bool, string)

CheckTrustState checks whether the given client certificate is trusted (i.e. it has a valid time span and it belongs to the given list of trusted certificates).

func CompareConfigs

func CompareConfigs(config1, config2 map[string]string, exclude []string) error

CompareConfigs compares two config maps and returns an error if they differ.

func CompareVersions

func CompareVersions(version1, version2 [2]int) (int, error)

CompareVersions the versions of two LXD nodes.

A version consists of the version the node's schema and the number of API extensions it supports.

Return 0 if they equal, 1 if the first version is greater than the second and 2 if the second is greater than the first.

Return an error if inconsistent versions are detected, for example the first node's schema is greater than the second's, but the number of extensions is smaller.

func CopyConfig

func CopyConfig(config map[string]string) map[string]string

CopyConfig creates a new map with a copy of the given config.

func EtagCheck

func EtagCheck(r *http.Request, data interface{}) error

EtagCheck validates the hash of the current state with the hash provided by the client

func EtagHash

func EtagHash(data interface{}) (string, error)

EtagHash hashes the provided data and returns the sha256

func GenerateSequenceInt64

func GenerateSequenceInt64(begin, end, step int) ([]int64, error)

GenerateSequenceInt64 returns a sequence within a given range with given steps.

func GetArchitectures

func GetArchitectures() ([]int, error)

GetArchitectures returns the list of supported architectures.

func GetExecPath

func GetExecPath() string

GetExecPath returns the path to the current binary

func GetIdmapSet

func GetIdmapSet() *idmap.IdmapSet

GetIdmapSet reads the uid/gid allocation.

func GetListeners

func GetListeners(start int) []net.Listener

GetListeners returns the socket-activated network listeners, if any.

The 'start' parameter must be SystemdListenFDsStart, except in unit tests, see the docstring of SystemdListenFDsStart below.

func GetStableRandomGenerator

func GetStableRandomGenerator(seed string) (*rand.Rand, error)

GetStableRandomGenerator returns a stable random generator. Uses the FNV-1a hash algorithm to convert the seed string into an int64 for use as seed to the non-cryptographic random number generator.

func GetStableRandomInt64FromList

func GetStableRandomInt64FromList(seed int64, list []int64) (int64, error)

GetStableRandomInt64FromList returns a stable random value from a given list.

func HTTPClient

func HTTPClient(certificate string, proxy proxyFunc) (*http.Client, error)

HTTPClient returns an http.Client using the given certificate and proxy.

func HugepagesPath

func HugepagesPath() (string, error)

HugepagesPath attempts to locate the mount point of the hugepages filesystem.

func InMemoryNetwork

func InMemoryNetwork() (net.Listener, func() net.Conn)

InMemoryNetwork creates a fully in-memory listener and dial function.

Each time the dial function is invoked a new pair of net.Conn objects will be created using net.Pipe: the listener's Accept method will unblock and return one end of the pipe and the other end will be returned by the dial function.

func IsAddressCovered

func IsAddressCovered(address1, address2 string) bool

IsAddressCovered detects if network address1 is actually covered by address2, in the sense that they are either the same address or address2 is specified using a wildcard with the same port of address1.

func IsJSONRequest

func IsJSONRequest(r *http.Request) bool

IsJSONRequest returns true if the content type of the HTTP request is JSON.

func IsRecursionRequest

func IsRecursionRequest(r *http.Request) bool

IsRecursionRequest checks whether the given HTTP request is marked with the "recursion" flag in its form values.

func ListenAddresses

func ListenAddresses(value string) ([]string, error)

ListenAddresses returns a list of host:port combinations at which this machine can be reached

func LoadCert

func LoadCert(dir string) (*shared.CertInfo, error)

LoadCert reads the LXD server certificate from the given var dir.

If a cluster certificate is found it will be loaded instead. If neither a server or cluster certfificate exists, a new server certificate will be generated.

func LoadClusterCert

func LoadClusterCert(dir string) (*shared.CertInfo, error)

LoadClusterCert reads the LXD cluster certificate from the given var dir.

If a cluster certificate doesn't exist, a new one is generated.

func LoadModule

func LoadModule(module string) error

LoadModule loads the kernel module with the given name, by invoking modprobe.

func LoadServerCert

func LoadServerCert(dir string) (*shared.CertInfo, error)

LoadServerCert reads the LXD server certificate from the given var dir.

func NetworkInterfaceAddress

func NetworkInterfaceAddress() string

NetworkInterfaceAddress returns the first global unicast address of any of the system network interfaces. Return the empty string if none is found.

func PasswordCheck

func PasswordCheck(secret string, password string) error

PasswordCheck validates the provided password against the encoded secret

func RuntimeLiblxcVersionAtLeast

func RuntimeLiblxcVersionAtLeast(major int, minor int, micro int) bool

RuntimeLiblxcVersionAtLeast checks if the system's liblxc matches the provided version requirement

func ServerTLSConfig

func ServerTLSConfig(cert *shared.CertInfo) *tls.Config

ServerTLSConfig returns a new server-side tls.Config generated from the give certificate info.

func SplitNTrimSpace

func SplitNTrimSpace(s string, sep string, n int, nilIfEmpty bool) []string

SplitNTrimSpace returns result of strings.SplitN() and then strings.TrimSpace() on each element. Accepts nilIfEmpty argument which if true, will return nil slice if s is empty (after trimming space).

func SupportsFilesystem

func SupportsFilesystem(filesystem string) bool

SupportsFilesystem checks whether a given filesystem is already supported by the kernel. Note that if the filesystem is a module, you may need to load it first.

func SysctlGet

func SysctlGet(path string) (string, error)

SysctlGet retrieves the value of a sysctl file in /proc/sys.

func SysctlSet

func SysctlSet(parts ...string) error

SysctlSet writes a value to a sysctl file in /proc/sys. Requires an even number of arguments as key/value pairs. E.g. SysctlSet("path1", "value1", "path2", "value2")

func WriteCert

func WriteCert(dir, prefix string, cert, key, ca []byte) error

WriteCert writes the given material to the appropriate certificate files in the given LXD var directory.

func WriteJSON

func WriteJSON(w http.ResponseWriter, body interface{}, debug bool) error

WriteJSON encodes the body as JSON and sends it back to the client

Types

type ContextAwareRequest

type ContextAwareRequest interface {
	WithContext(ctx context.Context) *http.Request
}

ContextAwareRequest is an interface implemented by http.Request starting from Go 1.8. It supports graceful cancellation using a context.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL