internal

Documentation

Overview

Package internal contains miscellaneous functions and objects useful within syft but should not be used externally.

Index

• Constants
• Variables
• func CloseAndLogError(closer io.Closer, location string)
• func HasAnyOfPrefixes(input string, prefixes ...string) bool
• func IsArchive(mimeType string) bool
• func IsErrPath(err error) bool
• func IsErrPathPermission(err error) bool
• func IsExecutable(mimeType string) bool
• func IsPipedInput() (bool, error)
• func MatchNamedCaptureGroups(regEx *regexp.Regexp, content string) map[string]string
• func Tprintf(tmpl string, data map[string]interface{}) string
• func TruncateMiddleEllipsis(input string, maxLen int) string
• type ErrPath
  • func (e ErrPath) Error() string
• type StringSet
  • func NewStringSet() StringSet
  • func NewStringSetFromSlice(start []string) StringSet
  • func (s StringSet) Add(i string)
  • func (s StringSet) Contains(i string) bool
  • func (s StringSet) Remove(i string)
  • func (s StringSet) ToSlice() []string

Constants

const (
	// ApplicationName is the non-capitalized name of the application (do not change this)
	ApplicationName = "syft"

	// JSONSchemaVersion is the current schema version output by the JSON encoder
	// This is roughly following the "SchemaVer" guidelines for versioning the JSON schema. Please see schema/json/README.md for details on how to increment.
	JSONSchemaVersion = "3.0.1"
)

Variables

var (
	ArchiveMIMETypeSet = strset.New(

		[]string{

			"application/x-archive",
			"application/x-cpio",
			"application/x-shar",
			"application/x-iso9660-image",
			"application/x-sbx",
			"application/x-tar",

			"application/x-bzip2",
			"application/gzip",
			"application/x-lzip",
			"application/x-lzma",
			"application/x-lzop",
			"application/x-snappy-framed",
			"application/x-xz",
			"application/x-compress",
			"application/zstd",

			"application/x-7z-compressed",
			"application/x-ace-compressed",
			"application/x-astrotite-afa",
			"application/x-alz-compressed",
			"application/vnd.android.package-archive",
			"application/x-freearc",
			"application/x-arj",
			"application/x-b1",
			"application/vnd.ms-cab-compressed",
			"application/x-cfs-compressed",
			"application/x-dar",
			"application/x-dgc-compressed",
			"application/x-apple-diskimage",
			"application/x-gca-compressed",
			"application/java-archive",
			"application/x-lzh",
			"application/x-lzx",
			"application/x-rar-compressed",
			"application/x-stuffit",
			"application/x-stuffitx",
			"application/x-gtar",
			"application/x-ms-wim",
			"application/x-xar",
			"application/zip",
			"application/x-zoo",
		}...,
	)

	ExecutableMIMETypeSet = strset.New(
		[]string{
			"application/x-executable",
			"application/x-mach-binary",
			"application/x-elf",
			"application/x-sharedlib",
			"application/vnd.microsoft.portable-executable",
		}...,
	)
)

Functions

func CloseAndLogError

func CloseAndLogError(closer io.Closer, location string)

CloseAndLogError closes the given io.Closer and reports any errors found as a warning in the log

func HasAnyOfPrefixes

func HasAnyOfPrefixes(input string, prefixes ...string) bool

HasAnyOfPrefixes returns an indication if the given string has any of the given prefixes.

func IsArchive

func IsArchive(mimeType string) bool

func IsErrPath

func IsErrPath(err error) bool

func IsErrPathPermission

func IsErrPathPermission(err error) bool

func IsExecutable

func IsExecutable(mimeType string) bool

func IsPipedInput

func IsPipedInput() (bool, error)

IsPipedInput returns true if there is no input device, which means the user **may** be providing input via a pipe.

func MatchNamedCaptureGroups

func MatchNamedCaptureGroups(regEx *regexp.Regexp, content string) map[string]string

MatchNamedCaptureGroups takes a regular expression and string and returns all of the named capture group results in a map. This is only for the first match in the regex. Callers shouldn't be providing regexes with multiple capture groups with the same name.

func Tprintf

func Tprintf(tmpl string, data map[string]interface{}) string

Tprintf renders a string from a given template string and field values

func TruncateMiddleEllipsis

func TruncateMiddleEllipsis(input string, maxLen int) string

Types

type ErrPath

type ErrPath struct {
	Path string
	Err  error
}

func (ErrPath) Error

func (e ErrPath) Error() string

type StringSet

type StringSet map[string]struct{}

StringSet represents a set of string types.

func NewStringSet

func NewStringSet() StringSet

NewStringSet creates a new empty StringSet.

func NewStringSetFromSlice

func NewStringSetFromSlice(start []string) StringSet

NewStringSetFromSlice creates a StringSet populated with values from the given slice.

func (StringSet) Add

func (s StringSet) Add(i string)

Add a string to the set.

func (StringSet) Contains

func (s StringSet) Contains(i string) bool

Contains indicates if the given string is contained within the set.

func (StringSet) Remove

func (s StringSet) Remove(i string)

Remove a string from the set.

func (StringSet) ToSlice

func (s StringSet) ToSlice() []string

ToSlice returns a sorted slice of strings that are contained within the set.