helpers

Documentation

Index

• Constants
• func AllPkgTreeToPurl(v *model.AllPkgTree) string
• func ArtifactClientKey(input *generated.ArtifactInputSpec) string
• func ArtifactServerKey(input *model.ArtifactInputSpec) string
• func CreateVulnInput(vulnID string) (*generated.VulnerabilityInputSpec, error)
• func GetKey[T any, R any](item T, transformer func(T) R) R
• func GuacFilePurl(alg string, digest string, filename *string) string
• func GuacGenericPurl(s string) string
• func GuacPkgPurl(pkgName string, pkgVersion *string) string
• func GuacSrcIdToSourceInput(srcID string) (*generated.SourceInputSpec, error)
• func IsVcs(s string) bool
• func LicenseClientKey(l *generated.LicenseInputSpec) string
• func LicenseServerKey(l *model.LicenseInputSpec) string
• func PkgInputSpecToPurl(currentPkg *model.PkgInputSpec) string
• func PkgToPurl(purlType, namespace, name, version, subpath string, qualifiersList []string) string
• func PurlToPkg(purlUri string) (*model.PkgInputSpec, error)
• func PurlToPkgFilter(purl string) (model.PkgSpec, error)
• func SanitizeString(s string) string
• func SourceToSourceInput(srcType, namespace, name string, revision *string) *generated.SourceInputSpec
• func UpdatePurlForPackageNamespaces(packageObj *model.Package) ([]*model.PackageNamespace, error)
• func VcsToSrc(vcsUri string) (*model.SourceInputSpec, error)
• type PkgIds
  • func PkgClientKey(pkg *generated.PkgInputSpec) PkgIds
  • func PkgServerKey(pkg *model.PkgInputSpec) PkgIds
• type SrcIds
  • func SrcClientKey(src *generated.SourceInputSpec) SrcIds
  • func SrcServerKey(src *model.SourceInputSpec) SrcIds
• type VulnIds
  • func VulnClientKey(vuln *generated.VulnerabilityInputSpec) VulnIds
  • func VulnServerKey(vuln *model.VulnerabilityInputSpec) VulnIds

Constants

const (
	PurlTypeGuac  = "guac"
	PurlFilesGuac = "pkg:guac/files/"
	PurlPkgGuac   = "pkg:guac/pkg/"
)

Functions

func AllPkgTreeToPurl

func AllPkgTreeToPurl(v *model.AllPkgTree) string

AllPkgTreeToPurl takes one package trie evaluation and converts it into a PURL it will only do this for one PURL, and will ignore other pkg tries in the fragment

func ArtifactClientKey

func ArtifactClientKey(input *generated.ArtifactInputSpec) string

func ArtifactServerKey

func ArtifactServerKey(input *model.ArtifactInputSpec) string

func CreateVulnInput

func CreateVulnInput(vulnID string) (*generated.VulnerabilityInputSpec, error)

func GetKey

func GetKey[T any, R any](item T, transformer func(T) R) R

collect is a simple helper to transform collections of a certain type to another type using the transform function func(T) R

func GuacFilePurl

func GuacFilePurl(alg string, digest string, filename *string) string

func GuacGenericPurl

func GuacGenericPurl(s string) string

func GuacPkgPurl

func GuacPkgPurl(pkgName string, pkgVersion *string) string

func GuacSrcIdToSourceInput

func GuacSrcIdToSourceInput(srcID string) (*generated.SourceInputSpec, error)

convert src ID to source input that will be used by the clearly defined parser example: "uri": "sourcearchive::org.apache.commons::commons-text::1.9::?"

func IsVcs

func IsVcs(s string) bool

func LicenseClientKey

func LicenseClientKey(l *generated.LicenseInputSpec) string

func LicenseServerKey

func LicenseServerKey(l *model.LicenseInputSpec) string

func PkgInputSpecToPurl

func PkgInputSpecToPurl(currentPkg *model.PkgInputSpec) string

func PkgToPurl

func PkgToPurl(purlType, namespace, name, version, subpath string, qualifiersList []string) string

func PurlToPkg

func PurlToPkg(purlUri string) (*model.PkgInputSpec, error)

PurlToPkg converts a purl URI string into a graphql package node

func PurlToPkgFilter

func PurlToPkgFilter(purl string) (model.PkgSpec, error)

PurlToPkgFilter converts a purl URI string into a graphql package filter spec. The result will only match the input purl, and no other packages. The filter is created with Guac's purl special casing.

func SanitizeString

func SanitizeString(s string) string

func SourceToSourceInput

func SourceToSourceInput(srcType, namespace, name string, revision *string) *generated.SourceInputSpec

func UpdatePurlForPackageNamespaces

func UpdatePurlForPackageNamespaces(packageObj *model.Package) ([]*model.PackageNamespace, error)

func VcsToSrc

func VcsToSrc(vcsUri string) (*model.SourceInputSpec, error)

Types

type PkgIds

type PkgIds struct {
	TypeId      string
	NamespaceId string
	NameId      string
	VersionId   string
}

func PkgClientKey

func PkgClientKey(pkg *generated.PkgInputSpec) PkgIds

func PkgServerKey

func PkgServerKey(pkg *model.PkgInputSpec) PkgIds

type SrcIds

type SrcIds struct {
	TypeId      string
	NamespaceId string
	NameId      string
}

func SrcClientKey

func SrcClientKey(src *generated.SourceInputSpec) SrcIds

func SrcServerKey

func SrcServerKey(src *model.SourceInputSpec) SrcIds

type VulnIds

type VulnIds struct {
	TypeId          string
	VulnerabilityID string
}

func VulnClientKey

func VulnClientKey(vuln *generated.VulnerabilityInputSpec) VulnIds

func VulnServerKey

func VulnServerKey(vuln *model.VulnerabilityInputSpec) VulnIds