utils

Documentation

Overview

Forked from https://github.com/sigstore/cosign/blob/v1.7.1/pkg/sget/sget.go

Index

• Constants
• Variables
• func ByteFormat(inputNum float64, precision int) string
• func ColorPrintYAML(text string)
• func CreateDirectory(path string, mode os.FileMode) error
• func CreateFilePath(destination string) error
• func CreatePathAndCopy(source string, destination string) error
• func DoesHostnamesMatch(url1 string, url2 string) (bool, error)
• func DownloadToFile(url string, target string, cosignKeyPath string)
• func ExecCommandWithContext(ctx context.Context, showLogs bool, commandName string, args ...string) (string, string, error)
• func ExecCommandWithContextAndDir(ctx context.Context, dir string, showLogs bool, commandName string, ...) (string, string, error)
• func ExecLaunchURL(url string) error
• func Fetch(url string) io.ReadCloser
• func FindYamlTemplates(config any, prefix string, suffix string) (map[string]*string, error)
• func GetFinalExecutablePath() (string, error)
• func GetHtpasswdString(username string, password string) (string, error)
• func GetSha256Sum(path string) (string, error)
• func InvalidPath(path string) bool
• func IsRHEL() bool
• func IsUrl(source string) bool
• func IsValidHostName() bool
• func ListDirectories(directory string) ([]string, error)
• func MakeTempDir(tmpDir string) (string, error)
• func RandomString(length int) string
• func ReadYaml(path string, destConfig any) error
• func RecursiveFileList(dir string, pattern *regexp.Regexp) (files []string, err error)
• func ReloadYamlTemplate(config any, mappings map[string]string) error
• func ReplaceTextTemplate(path string, mappings map[string]string)
• func RoundUp(input float64, places int) (newVal float64)
• func RunPreflightChecks()
• func Sget(image, key string, out io.Writer, ctx context.Context) error
• func SwapHost(src string, targetHost string) (string, error)
• func SwapHostWithoutChecksum(src string, targetHost string) (string, error)
• func ValidHostname(hostname string) bool
• func ValidateSha256Sum(expectedChecksum string, path string)
• func VerifyBinary(binary string) bool
• func WriteFile(path string, data []byte) error
• func WriteYaml(path string, srcConfig any, perm fs.FileMode) error
• type Image
  • func ParseImageURL(src string) (out Image, err error)

Constants

const SGETProtocol = "sget://"

Variables

var TempPathPrefix = "zarf-"

Functions

func ByteFormat

func ByteFormat(inputNum float64, precision int) string

func ColorPrintYAML

func ColorPrintYAML(text string)

func CreateDirectory

func CreateDirectory(path string, mode os.FileMode) error

CreateDirectory creates a directory for the given path and file mode

func CreateFilePath

func CreateFilePath(destination string) error

func CreatePathAndCopy

func CreatePathAndCopy(source string, destination string) error

func DoesHostnamesMatch

func DoesHostnamesMatch(url1 string, url2 string) (bool, error)

DoesHostnamesMatch returns a boolean indicating if the hostname of two different URLs are the same.

func DownloadToFile

func DownloadToFile(url string, target string, cosignKeyPath string)

func ExecCommandWithContext

func ExecCommandWithContext(ctx context.Context, showLogs bool, commandName string, args ...string) (string, string, error)

ExecCommandWithContext executes a given command with args in the current working directory.

func ExecCommandWithContextAndDir

func ExecCommandWithContextAndDir(ctx context.Context, dir string, showLogs bool, commandName string, args ...string) (string, string, error)

ExecCommandWithContextAndDir executes a given command with args in the specified directory.

func ExecLaunchURL

func ExecLaunchURL(url string) error

func Fetch

func Fetch(url string) io.ReadCloser

func FindYamlTemplates

func FindYamlTemplates(config any, prefix string, suffix string) (map[string]*string, error)

FindYamlTemplates finds strings with a given prefix in a config.

func GetFinalExecutablePath

func GetFinalExecutablePath() (string, error)

GetFinalExecutablePath returns the absolute path to the zarf executable, following any symlinks along the way

func GetHtpasswdString

func GetHtpasswdString(username string, password string) (string, error)

GetHtpasswdString converts a username and password to a properly formatted and hashed format for `htpasswd`

func GetSha256Sum

func GetSha256Sum(path string) (string, error)

GetSha256Sum returns the computed SHA256 Sum of a given file

func InvalidPath

func InvalidPath(path string) bool

InvalidPath checks if the given path exists

func IsRHEL

func IsRHEL() bool

func IsUrl

func IsUrl(source string) bool

func IsValidHostName

func IsValidHostName() bool

func ListDirectories

func ListDirectories(directory string) ([]string, error)

func MakeTempDir

func MakeTempDir(tmpDir string) (string, error)

func RandomString

func RandomString(length int) string

func ReadYaml

func ReadYaml(path string, destConfig any) error

func RecursiveFileList

func RecursiveFileList(dir string, pattern *regexp.Regexp) (files []string, err error)

RecursiveFileList walks a path with an optional regex pattern and returns a slice of file paths

func ReloadYamlTemplate

func ReloadYamlTemplate(config any, mappings map[string]string) error

ReloadYamlTemplate marshals a given config, replaces strings and unmarshals it back.

func ReplaceTextTemplate

func ReplaceTextTemplate(path string, mappings map[string]string)

ReplaceTextTemplate loads a file from a given path, replaces text in it and writes it back in place

func RoundUp

func RoundUp(input float64, places int) (newVal float64)

func RunPreflightChecks

func RunPreflightChecks()

func Sget

func Sget(image, key string, out io.Writer, ctx context.Context) error

Sget performs a cosign signature verification on a given image using the specified public key.

func SwapHost

func SwapHost(src string, targetHost string) (string, error)

SwapHost Perform base url replacement and adds a crc32 of the original url to the end of the src

func SwapHostWithoutChecksum

func SwapHostWithoutChecksum(src string, targetHost string) (string, error)

SwapHostWithoutChecksum Perform base url replacement but avoids adding a checksum of the original url.

func ValidHostname

func ValidHostname(hostname string) bool

func ValidateSha256Sum

func ValidateSha256Sum(expectedChecksum string, path string)

func VerifyBinary

func VerifyBinary(binary string) bool

VerifyBinary returns true if binary is available

func WriteFile

func WriteFile(path string, data []byte) error

func WriteYaml

func WriteYaml(path string, srcConfig any, perm fs.FileMode) error

Types

type Image

type Image struct {
	Host        string
	Name        string
	Path        string
	Tag         string
	Digest      string
	Reference   string
	TagOrDigest string
}

func ParseImageURL

func ParseImageURL(src string) (out Image, err error)