Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

refactor(purl): use TypeApk from purl #5232

Merged
merged 3 commits into from
Sep 26, 2023
Merged

refactor(purl): use TypeApk from purl #5232

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
29188a8
use TypeApk from purl
DmitriyLewen Sep 22, 2023
6ab0afc
Merge branch 'main' into 'chrome/apk-type-from-purl'
DmitriyLewen Sep 25, 2023
04d3975
refactor: some tweaks
knqyf263 Sep 26, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
28 changes: 17 additions & 11 deletions pkg/purl/purl.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@ import (
)

const (
TypeAPK = "apk" // not defined in github.com/package-url/packageurl-go
TypeOCI = "oci"
TypeDart = "dart"
)
Expand Down Expand Up @@ -135,7 +134,7 @@ func (p *PackageURL) LangType() ftypes.LangType {
}

func (p *PackageURL) IsOSPkg() bool {
return p.Type == TypeAPK || p.Type == packageurl.TypeDebian || p.Type == packageurl.TypeRPM
return p.Type == packageurl.TypeApk || p.Type == packageurl.TypeDebian || p.Type == packageurl.TypeRPM
}

func (p *PackageURL) BOMRef() string {
Expand Down Expand Up @@ -180,11 +179,10 @@ func NewPackageURL(t ftypes.TargetType, metadata types.Metadata, pkg ftypes.Pack
if metadata.OS != nil {
namespace = string(metadata.OS.Family)
}
case TypeAPK: // TODO: replace with packageurl.TypeApk once they add it.
qualifiers = append(qualifiers, parseApk(metadata.OS)...)
if metadata.OS != nil {
namespace = string(metadata.OS.Family)
}
case packageurl.TypeApk:
var qs packageurl.Qualifiers
name, namespace, qs = parseApk(name, metadata.OS)
qualifiers = append(qualifiers, qs...)
case packageurl.TypeMaven, string(ftypes.Gradle): // TODO: replace with packageurl.TypeGradle once they add it.
namespace, name = parseMaven(name)
case packageurl.TypePyPi:
Expand Down Expand Up @@ -246,17 +244,25 @@ func parseOCI(metadata types.Metadata) (packageurl.PackageURL, error) {
return *packageurl.NewPackageURL(packageurl.TypeOCI, "", name, digest.DigestStr(), qualifiers, ""), nil
}

func parseApk(fos *ftypes.OS) packageurl.Qualifiers {
// ref. https://github.com/package-url/purl-spec/blob/master/PURL-TYPES.rst#apk
func parseApk(pkgName string, fos *ftypes.OS) (string, string, packageurl.Qualifiers) {
// the name must be lowercase
pkgName = strings.ToLower(pkgName)

if fos == nil {
return packageurl.Qualifiers{}
return pkgName, "", nil
}

return packageurl.Qualifiers{
// the namespace must be lowercase
ns := strings.ToLower(string(fos.Family))
qs := packageurl.Qualifiers{
{
Key: "distro",
Value: fos.Name,
},
}

return pkgName, ns, qs
}

// ref. https://github.com/package-url/purl-spec/blob/a748c36ad415c8aeffe2b8a4a5d8a50d16d6d85f/PURL-TYPES.rst#deb
Expand Down Expand Up @@ -384,7 +390,7 @@ func purlType(t ftypes.TargetType) string {
case ftypes.RustBinary, ftypes.Cargo:
return packageurl.TypeCargo
case ftypes.Alpine:
return TypeAPK
return packageurl.TypeApk
case ftypes.Debian, ftypes.Ubuntu:
return packageurl.TypeDebian
case ftypes.RedHat, ftypes.CentOS, ftypes.Rocky, ftypes.Alma,
Expand Down
2 changes: 1 addition & 1 deletion pkg/sbom/spdx/unmarshal.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -178,7 +178,7 @@ func (s *SPDX) parsePackages(pkgs map[common.ElementID]*spdx.Package) error {
return xerrors.Errorf("failed to parse package: %w", err)
}
switch pkgURL.Type {
case purl.TypeAPK, packageurl.TypeDebian, packageurl.TypeRPM:
case packageurl.TypeApk, packageurl.TypeDebian, packageurl.TypeRPM:
osPkgs = append(osPkgs, *pkg)
default:
// Language-specific packages
Expand Down