purl

Documentation

Index

• Constants
• type PackageURL
  • func FromString(s string) (*PackageURL, error)
  • func New(t ftypes.TargetType, metadata types.Metadata, pkg ftypes.Package) (*PackageURL, error)
  • func WithPath(purl *packageurl.PackageURL, filePath string) *PackageURL
  • func (p *PackageURL) BOMRef() string
  • func (p *PackageURL) Class() types.ResultClass
  • func (p *PackageURL) LangType() ftypes.LangType
  • func (p *PackageURL) Match(target *packageurl.PackageURL) bool
  • func (p *PackageURL) Package() *ftypes.Package
  • func (p *PackageURL) Unwrap() *packageurl.PackageURL

Constants

const (
	TypeOCI = "oci"

	// TypeK8s is a custom type for Kubernetes components in PURL.
	//  - namespace: The service provider such as EKS or GKE. It is not case sensitive and must be lowercased.
	//     Known namespaces:
	//       - empty (upstream)
	//       - eks (AWS)
	//       - aks (GCP)
	//       - gke (Azure)
	//       - rke (Rancher)
	//  - name: The k8s component name and is case sensitive.
	//  - version: The combined version and release of a component.
	//
	//  Examples:
	//    - pkg:k8s/upstream/k8s.io%2Fapiserver@1.24.1
	//    - pkg:k8s/eks/k8s.io%2Fkube-proxy@1.26.2-eksbuild.1
	TypeK8s = "k8s"

	NamespaceEKS = "eks"
	NamespaceAKS = "aks"
	NamespaceGKE = "gke"
	NamespaceRKE = "rke"
	NamespaceOCP = "ocp"

	TypeUnknown = "unknown"
)

Types

type PackageURL

type PackageURL struct {
	packageurl.PackageURL
	FilePath string
}

func FromString

func FromString(s string) (*PackageURL, error)

func New

func New(t ftypes.TargetType, metadata types.Metadata, pkg ftypes.Package) (*PackageURL, error)

nolint: gocyclo

func WithPath

func WithPath(purl *packageurl.PackageURL, filePath string) *PackageURL

WithPath wraps packageurl.PackageURL with the given file path

func (*PackageURL) BOMRef

func (p *PackageURL) BOMRef() string

func (*PackageURL) Class

func (p *PackageURL) Class() types.ResultClass

func (*PackageURL) LangType

func (p *PackageURL) LangType() ftypes.LangType

LangType returns an application type in Trivy nolint: gocyclo

func (*PackageURL) Match

func (p *PackageURL) Match(target *packageurl.PackageURL) bool

Match returns true if the given PURL "target" satisfies the constraint PURL "p". - If the constraint does not have a version, it will match any version in the target. - If the constraint has qualifiers, the target must have the same set of qualifiers to match.

func (*PackageURL) Package

func (p *PackageURL) Package() *ftypes.Package

func (*PackageURL) Unwrap

func (p *PackageURL) Unwrap() *packageurl.PackageURL