utils

Documentation

Index

• Constants
• func Annotations(labels []string) (bundle string, userAnnotations map[string]string)
• func CleanPath(path string) string
• func CloseExecFrom(minFd int) error
• func ExitStatus(status unix.WaitStatus) int
• func GenerateRandomName(prefix string, size int) (string, error)
• func GetIntSize() int
• func NewSockPair(name string) (parent *os.File, child *os.File, err error)
• func RecvFd(socket *os.File) (*os.File, error)
• func ResolveRootfs(uncleanRootfs string) (string, error)
• func SearchLabels(labels []string, query string) string
• func SendFd(socket *os.File, name string, fd uintptr) error
• func WriteJSON(w io.Writer, v interface{}) error

Constants

const MaxNameLen = 4096

MaxSendfdLen is the maximum length of the name of a file descriptor being sent using SendFd. The name of the file handle returned by RecvFd will never be larger than this value.

Functions

func Annotations

func Annotations(labels []string) (bundle string, userAnnotations map[string]string)

Annotations returns the bundle path and user defined annotations from the libcontainer state. We need to remove the bundle because that is a label added by libcontainer.

func CleanPath

func CleanPath(path string) string

CleanPath makes a path safe for use with filepath.Join. This is done by not only cleaning the path, but also (if the path is relative) adding a leading '/' and cleaning it (then removing the leading '/'). This ensures that a path resulting from prepending another path will always resolve to lexically be a subdirectory of the prefixed path. This is all done lexically, so paths that include symlinks won't be safe as a result of using CleanPath.

func CloseExecFrom

func CloseExecFrom(minFd int) error

func ExitStatus

func ExitStatus(status unix.WaitStatus) int

ExitStatus returns the correct exit status for a process based on if it was signaled or exited cleanly

func GenerateRandomName

func GenerateRandomName(prefix string, size int) (string, error)

GenerateRandomName returns a new name joined with a prefix. This size specified is used to truncate the randomly generated value

func GetIntSize

func GetIntSize() int

func NewSockPair

func NewSockPair(name string) (parent *os.File, child *os.File, err error)

NewSockPair returns a new unix socket pair

func RecvFd

func RecvFd(socket *os.File) (*os.File, error)

RecvFd waits for a file descriptor to be sent over the given AF_UNIX socket. The file name of the remote file descriptor will be recreated locally (it is sent as non-auxiliary data in the same payload).

func ResolveRootfs

func ResolveRootfs(uncleanRootfs string) (string, error)

ResolveRootfs ensures that the current working directory is not a symlink and returns the absolute path to the rootfs

func SearchLabels

func SearchLabels(labels []string, query string) string

SearchLabels searches a list of key-value pairs for the provided key and returns the corresponding value. The pairs must be separated with '='.

func SendFd

func SendFd(socket *os.File, name string, fd uintptr) error

SendFd sends a file descriptor over the given AF_UNIX socket. In addition, the file.Name() of the given file will also be sent as non-auxiliary data in the same payload (allowing to send contextual information for a file descriptor).

func WriteJSON

func WriteJSON(w io.Writer, v interface{}) error

WriteJSON writes the provided struct v to w using standard json marshaling