purl

Documentation

Index

• Constants
• type PackageURL
  • func FromString(purl string) (*PackageURL, error)
  • func NewPackageURL(t ftypes.TargetType, metadata types.Metadata, pkg ftypes.Package) (PackageURL, error)
  • func (p *PackageURL) BOMRef() string
  • func (p *PackageURL) Class() types.ResultClass
  • func (p *PackageURL) LangType() ftypes.LangType
  • func (p *PackageURL) Package() *ftypes.Package

Constants

const (
	TypeOCI  = "oci"
	TypeDart = "dart"

	// 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(purl string) (*PackageURL, error)

func NewPackageURL

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

nolint: gocyclo

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) Package

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