pax_global_header00006660000000000000000000000064145712714010014514gustar00rootroot0000000000000052 comment=7cb81af9593b9512bb946c55c85609948c48aab9 packageurl-go-0.1.3/000077500000000000000000000000001457127140100142365ustar00rootroot00000000000000packageurl-go-0.1.3/.github/000077500000000000000000000000001457127140100155765ustar00rootroot00000000000000packageurl-go-0.1.3/.github/workflows/000077500000000000000000000000001457127140100176335ustar00rootroot00000000000000packageurl-go-0.1.3/.github/workflows/test.yaml000066400000000000000000000022011457127140100214710ustar00rootroot00000000000000name: test on: [push, pull_request] jobs: test: strategy: matrix: go-version: [1.21.x, 1.22.x] os: [ubuntu-latest] runs-on: ${{ matrix.os }} steps: - name: Install Go uses: actions/setup-go@v2 with: go-version: ${{ matrix.go-version }} - name: Checkout code uses: actions/checkout@v2 - name: Download test data run: curl -L https://raw.githubusercontent.com/package-url/purl-spec/master/test-suite-data.json -o testdata/test-suite-data.json - name: Test go fmt run: test -z $(go fmt ./...) - name: Golangci-lint uses: golangci/golangci-lint-action@v2 with: only-new-issues: true - name: Test coverage run: go test -covermode atomic -coverprofile='profile.cov' ./... - name: Send coverage if: runner.os == 'Linux' env: COVERALLS_TOKEN: ${{ secrets.GITHUB_TOKEN }} run: | go install github.com/mattn/goveralls@latest $(go env GOPATH)/bin/goveralls -coverprofile=profile.cov -service=github - name: Fuzz tests run: make fuzz packageurl-go-0.1.3/.gitignore000066400000000000000000000004621457127140100162300ustar00rootroot00000000000000# Binaries for programs and plugins *.exe *.dll *.so *.dylib # Test binary, build with `go test -c` *.test # Output of the go coverage tool, specifically when used with LiteIDE *.out # Project-local glide cache, RE: https://github.com/Masterminds/glide/issues/736 .glide/ testdata/test-suite-data.json packageurl-go-0.1.3/.golangci.yaml000066400000000000000000000004631457127140100167660ustar00rootroot00000000000000# individual linter configs go here linters-settings: # default linters are enabled `golangci-lint help linters` linters: disable-all: true enable: - deadcode - errcheck - gosimple - govet - ineffassign - staticcheck - structcheck - typecheck - unused - varcheckpackageurl-go-0.1.3/LICENSE000066400000000000000000000020371457127140100152450ustar00rootroot00000000000000Copyright (c) the purl authors Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. packageurl-go-0.1.3/Makefile000066400000000000000000000005331457127140100156770ustar00rootroot00000000000000.PHONY: test clean lint test: curl -Ls https://raw.githubusercontent.com/package-url/purl-spec/master/test-suite-data.json -o testdata/test-suite-data.json go test -v -cover ./... fuzz: go test -fuzztime=1m -fuzz . clean: find . -name "test-suite-data.json" | xargs rm -f lint: go get -u golang.org/x/lint/golint golint -set_exit_status packageurl-go-0.1.3/README.md000066400000000000000000000047141457127140100155230ustar00rootroot00000000000000# packageurl-go [![build](https://github.com/package-url/packageurl-go/workflows/test/badge.svg)](https://github.com/package-url/packageurl-go/actions?query=workflow%3Atest) [![Coverage Status](https://coveralls.io/repos/github/package-url/packageurl-go/badge.svg)](https://coveralls.io/github/package-url/packageurl-go) [![PkgGoDev](https://pkg.go.dev/badge/github.com/package-url/packageurl-go)](https://pkg.go.dev/github.com/package-url/packageurl-go) [![Go Report Card](https://goreportcard.com/badge/github.com/package-url/packageurl-go)](https://goreportcard.com/report/github.com/package-url/packageurl-go) Go implementation of the package url spec. ## Install ``` go get -u github.com/package-url/packageurl-go ``` ## Versioning The versions will follow the spec. So if the spec is released at ``1.0``. Then all versions in the ``1.x.y`` will follow the ``1.x`` spec. ## Usage ### Create from parts ```go package main import ( "fmt" "github.com/package-url/packageurl-go" ) func main() { instance := packageurl.NewPackageURL("test", "ok", "name", "version", nil, "") fmt.Printf("%s", instance.ToString()) } ``` ### Parse from string ```go package main import ( "fmt" "github.com/package-url/packageurl-go" ) func main() { instance, err := packageurl.FromString("test:ok/name@version") if err != nil { panic(err) } fmt.Printf("%#v", instance) } ``` ## Test Testing using the normal ``go test`` command. Using ``make test`` will pull the test fixtures shared between all package-url projects and then execute the tests. ``` curl -Ls https://raw.githubusercontent.com/package-url/purl-spec/master/test-suite-data.json -o testdata/test-suite-data.json go test -v -cover ./... === RUN TestFromStringExamples --- PASS: TestFromStringExamples (0.00s) === RUN TestToStringExamples --- PASS: TestToStringExamples (0.00s) === RUN TestStringer --- PASS: TestStringer (0.00s) === RUN TestQualifiersMapConversion --- PASS: TestQualifiersMapConversion (0.00s) PASS github.com/package-url/packageurl-go coverage: 90.7% of statements ok github.com/package-url/packageurl-go 0.004s coverage: 90.7% of statements ``` ## Fuzzing Fuzzing is done with standard [Go fuzzing](https://go.dev/doc/fuzz/), introduced in Go 1.18. Fuzz tests check for inputs that cause `FromString` to panic. Using `make fuzz` will run fuzz tests for one minute. To run fuzz tests longer: ``` go test -fuzztime=60m -fuzz . ``` Or omit `-fuzztime` entirely to run indefinitely. packageurl-go-0.1.3/VERSION000066400000000000000000000000061457127140100153020ustar00rootroot000000000000000.0.0 packageurl-go-0.1.3/fuzz_test.go000066400000000000000000000023651457127140100166300ustar00rootroot00000000000000/* Copyright (c) the purl authors Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ package packageurl import ( "fmt" "testing" ) func FuzzFromString(f *testing.F) { f.Fuzz(func(t *testing.T, s string) { // Test that parsing doesn't panic. _, _ = FromString(s) fmt.Print(s) }) } packageurl-go-0.1.3/go.mod000066400000000000000000000000651457127140100153450ustar00rootroot00000000000000module github.com/package-url/packageurl-go go 1.18 packageurl-go-0.1.3/mit.LICENSE000077700000000000000000000000001457127140100170332LICENSEustar00rootroot00000000000000packageurl-go-0.1.3/packageurl.go000066400000000000000000000445251457127140100167150ustar00rootroot00000000000000/* Copyright (c) the purl authors Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ // Package packageurl implements the package-url spec package packageurl import ( "errors" "fmt" "net/url" "path" "regexp" "sort" "strings" ) var ( // QualifierKeyPattern describes a valid qualifier key: // // - The key must be composed only of ASCII letters and numbers, '.', // '-' and '_' (period, dash and underscore). // - A key cannot start with a number. QualifierKeyPattern = regexp.MustCompile(`^[A-Za-z\.\-_][0-9A-Za-z\.\-_]*$`) // TypePattern describes a valid type: // // - The type must be composed only of ASCII letters and numbers, '.', // '+' and '-' (period, plus and dash). // - A type cannot start with a number. TypePattern = regexp.MustCompile(`^[A-Za-z\.\-\+][0-9A-Za-z\.\-\+]*$`) ) // These are the known purl types as defined in the spec. Some of these require // special treatment during parsing. // https://github.com/package-url/purl-spec#known-purl-types var ( // TypeAlpm is a pkg:alpm purl. TypeAlpm = "alpm" // TypeApk is a pkg:apk purl. TypeApk = "apk" // TypeBitbucket is a pkg:bitbucket purl. TypeBitbucket = "bitbucket" // TypeBitnami is a pkg:bitnami purl. TypeBitnami = "bitnami" // TypeCargo is a pkg:cargo purl. TypeCargo = "cargo" // TypeCocoapods is a pkg:cocoapods purl. TypeCocoapods = "cocoapods" // TypeComposer is a pkg:composer purl. TypeComposer = "composer" // TypeConan is a pkg:conan purl. TypeConan = "conan" // TypeConda is a pkg:conda purl. TypeConda = "conda" // TypeCran is a pkg:cran purl. TypeCran = "cran" // TypeDebian is a pkg:deb purl. TypeDebian = "deb" // TypeDocker is a pkg:docker purl. TypeDocker = "docker" // TypeGem is a pkg:gem purl. TypeGem = "gem" // TypeGeneric is a pkg:generic purl. TypeGeneric = "generic" // TypeGithub is a pkg:github purl. TypeGithub = "github" // TypeGolang is a pkg:golang purl. TypeGolang = "golang" // TypeHackage is a pkg:hackage purl. TypeHackage = "hackage" // TypeHex is a pkg:hex purl. TypeHex = "hex" // TypeHuggingface is pkg:huggingface purl. TypeHuggingface = "huggingface" // TypeMLflow is pkg:mlflow purl. TypeMLFlow = "mlflow" // TypeMaven is a pkg:maven purl. TypeMaven = "maven" // TypeNPM is a pkg:npm purl. TypeNPM = "npm" // TypeNuget is a pkg:nuget purl. TypeNuget = "nuget" // TypeOCI is a pkg:oci purl TypeOCI = "oci" // TypePub is a pkg:pub purl. TypePub = "pub" // TypePyPi is a pkg:pypi purl. TypePyPi = "pypi" // TypeQPKG is a pkg:qpkg purl. TypeQpkg = "qpkg" // TypeRPM is a pkg:rpm purl. TypeRPM = "rpm" // TypeSWID is pkg:swid purl TypeSWID = "swid" // TypeSwift is pkg:swift purl TypeSwift = "swift" // KnownTypes is a map of types that are officially supported by the spec. // See https://github.com/package-url/purl-spec/blob/master/PURL-TYPES.rst#known-purl-types KnownTypes = map[string]struct{}{ TypeAlpm: {}, TypeApk: {}, TypeBitbucket: {}, TypeBitnami: {}, TypeCargo: {}, TypeCocoapods: {}, TypeComposer: {}, TypeConan: {}, TypeConda: {}, TypeCran: {}, TypeDebian: {}, TypeDocker: {}, TypeGem: {}, TypeGeneric: {}, TypeGithub: {}, TypeGolang: {}, TypeHackage: {}, TypeHex: {}, TypeHuggingface: {}, TypeMaven: {}, TypeMLFlow: {}, TypeNPM: {}, TypeNuget: {}, TypeOCI: {}, TypePub: {}, TypePyPi: {}, TypeQpkg: {}, TypeRPM: {}, TypeSWID: {}, TypeSwift: {}, } TypeApache = "apache" TypeAndroid = "android" TypeAtom = "atom" TypeBower = "bower" TypeBrew = "brew" TypeBuildroot = "buildroot" TypeCarthage = "carthage" TypeChef = "chef" TypeChocolatey = "chocolatey" TypeClojars = "clojars" TypeCoreos = "coreos" TypeCpan = "cpan" TypeCtan = "ctan" TypeCrystal = "crystal" TypeDrupal = "drupal" TypeDtype = "dtype" TypeDub = "dub" TypeElm = "elm" TypeEclipse = "eclipse" TypeGitea = "gitea" TypeGitlab = "gitlab" TypeGradle = "gradle" TypeGuix = "guix" TypeHaxe = "haxe" TypeHelm = "helm" TypeJulia = "julia" TypeLua = "lua" TypeMelpa = "melpa" TypeMeteor = "meteor" TypeNim = "nim" TypeNix = "nix" TypeOpam = "opam" TypeOpenwrt = "openwrt" TypeOsgi = "osgi" TypeP2 = "p2" TypePear = "pear" TypePecl = "pecl" TypePERL6 = "perl6" TypePlatformio = "platformio" TypeEbuild = "ebuild" TypePuppet = "puppet" TypeSourceforge = "sourceforge" TypeSublime = "sublime" TypeTerraform = "terraform" TypeVagrant = "vagrant" TypeVim = "vim" TypeWORDPRESS = "wordpress" TypeYocto = "yocto" // CandidateTypes is a map of types that are not yet officially supported by the spec, // but are being considered for inclusion. // See https://github.com/package-url/purl-spec/blob/master/PURL-TYPES.rst#other-candidate-types-to-define CandidateTypes = map[string]struct{}{ TypeApache: {}, TypeAndroid: {}, TypeAtom: {}, TypeBower: {}, TypeBrew: {}, TypeBuildroot: {}, TypeCarthage: {}, TypeChef: {}, TypeChocolatey: {}, TypeClojars: {}, TypeCoreos: {}, TypeCpan: {}, TypeCtan: {}, TypeCrystal: {}, TypeDrupal: {}, TypeDtype: {}, TypeDub: {}, TypeElm: {}, TypeEclipse: {}, TypeGitea: {}, TypeGitlab: {}, TypeGradle: {}, TypeGuix: {}, TypeHaxe: {}, TypeHelm: {}, TypeJulia: {}, TypeLua: {}, TypeMelpa: {}, TypeMeteor: {}, TypeNim: {}, TypeNix: {}, TypeOpam: {}, TypeOpenwrt: {}, TypeOsgi: {}, TypeP2: {}, TypePear: {}, TypePecl: {}, TypePERL6: {}, TypePlatformio: {}, TypeEbuild: {}, TypePuppet: {}, TypeSourceforge: {}, TypeSublime: {}, TypeTerraform: {}, TypeVagrant: {}, TypeVim: {}, TypeWORDPRESS: {}, TypeYocto: {}, } ) // Qualifier represents a single key=value qualifier in the package url type Qualifier struct { Key string Value string } func (q Qualifier) String() string { // A value must be a percent-encoded string return fmt.Sprintf("%s=%s", q.Key, url.PathEscape(q.Value)) } // Qualifiers is a slice of key=value pairs, with order preserved as it appears // in the package URL. type Qualifiers []Qualifier // urlQuery returns a raw URL query with all the qualifiers as keys + values. func (q Qualifiers) urlQuery() (rawQuery string) { v := make(url.Values) for _, qq := range q { v.Add(qq.Key, qq.Value) } return v.Encode() } // QualifiersFromMap constructs a Qualifiers slice from a string map. To get a // deterministic qualifier order (despite maps not providing any iteration order // guarantees) the returned Qualifiers are sorted in increasing order of key. func QualifiersFromMap(mm map[string]string) Qualifiers { q := Qualifiers{} for k, v := range mm { q = append(q, Qualifier{Key: k, Value: v}) } // sort for deterministic qualifier order sort.Slice(q, func(i int, j int) bool { return q[i].Key < q[j].Key }) return q } // Map converts a Qualifiers struct to a string map. func (qq Qualifiers) Map() map[string]string { m := make(map[string]string) for i := 0; i < len(qq); i++ { k := qq[i].Key v := qq[i].Value m[k] = v } return m } func (qq Qualifiers) String() string { var kvPairs []string for _, q := range qq { kvPairs = append(kvPairs, q.String()) } return strings.Join(kvPairs, "&") } func (qq *Qualifiers) Normalize() error { qs := *qq normedQQ := make(Qualifiers, 0, len(qs)) for _, q := range qs { if q.Key == "" { return fmt.Errorf("key is missing from qualifier: %v", q) } if q.Value == "" { // Empty values are equivalent to the key being omitted from the PackageURL. continue } key := strings.ToLower(q.Key) if !validQualifierKey(key) { return fmt.Errorf("invalid qualifier key: %q", key) } normedQQ = append(normedQQ, Qualifier{key, q.Value}) } sort.Slice(normedQQ, func(i, j int) bool { return normedQQ[i].Key < normedQQ[j].Key }) for i := 1; i < len(normedQQ); i++ { if normedQQ[i-1].Key == normedQQ[i].Key { return fmt.Errorf("duplicate qualifier key: %q", normedQQ[i].Key) } } *qq = normedQQ return nil } // PackageURL is the struct representation of the parts that make a package url type PackageURL struct { Type string Namespace string Name string Version string Qualifiers Qualifiers Subpath string } // NewPackageURL creates a new PackageURL struct instance based on input func NewPackageURL(purlType, namespace, name, version string, qualifiers Qualifiers, subpath string) *PackageURL { return &PackageURL{ Type: purlType, Namespace: namespace, Name: name, Version: version, Qualifiers: qualifiers, Subpath: subpath, } } // ToString returns the human-readable instance of the PackageURL structure. // This is the literal purl as defined by the spec. func (p *PackageURL) ToString() string { u := &url.URL{ Scheme: "pkg", RawQuery: p.Qualifiers.urlQuery(), Fragment: p.Subpath, } paths := []string{p.Type} // we need to escape each segment by itself, so that we don't escape "/" in the namespace. for _, segment := range strings.Split(p.Namespace, "/") { if segment == "" { continue } paths = append(paths, escape(segment)) } nameWithVersion := escape(p.Name) if p.Version != "" { nameWithVersion += "@" + escape(p.Version) } paths = append(paths, nameWithVersion) u.Opaque = strings.Join(paths, "/") return u.String() } func (p PackageURL) String() string { return p.ToString() } // FromString parses a valid package url string into a PackageURL structure func FromString(purl string) (PackageURL, error) { u, err := url.Parse(purl) if err != nil { return PackageURL{}, fmt.Errorf("failed to parse as URL: %w", err) } if u.Scheme != "pkg" { return PackageURL{}, fmt.Errorf("purl scheme is not \"pkg\": %q", u.Scheme) } p := u.Opaque // if a purl starts with pkg:/ or even pkg://, we need to fall back to host + path. if p == "" { p = strings.TrimPrefix(path.Join(u.Host, u.Path), "/") } typ, p, ok := strings.Cut(p, "/") if !ok { return PackageURL{}, fmt.Errorf("purl is missing type or name") } typ = strings.ToLower(typ) qualifiers, err := parseQualifiers(u.RawQuery) if err != nil { return PackageURL{}, fmt.Errorf("invalid qualifiers: %w", err) } namespace, name, version, err := separateNamespaceNameVersion(p) if err != nil { return PackageURL{}, err } pURL := PackageURL{ Qualifiers: qualifiers, Type: typ, Namespace: namespace, Name: name, Version: version, Subpath: u.Fragment, } err = pURL.Normalize() return pURL, err } // Normalize converts p to its canonical form, returning an error if p is invalid. func (p *PackageURL) Normalize() error { typ := strings.ToLower(p.Type) if !validType(typ) { return fmt.Errorf("invalid type %q", typ) } namespace := strings.Trim(p.Namespace, "/") if err := p.Qualifiers.Normalize(); err != nil { return fmt.Errorf("invalid qualifiers: %v", err) } if p.Name == "" { return errors.New("purl is missing name") } subpath := strings.Trim(p.Subpath, "/") segs := strings.Split(p.Subpath, "/") for i, s := range segs { if (s == "." || s == "..") && i != 0 { return fmt.Errorf("invalid Package URL subpath: %q", p.Subpath) } } *p = PackageURL{ Type: typ, Namespace: typeAdjustNamespace(typ, namespace), Name: typeAdjustName(typ, p.Name, p.Qualifiers), Version: typeAdjustVersion(typ, p.Version), Qualifiers: p.Qualifiers, Subpath: subpath, } return validCustomRules(*p) } // escape the given string in a purl-compatible way. func escape(s string) string { // for compatibility with other implementations and the purl-spec, we want to escape all // characters, which is what "QueryEscape" does. The issue with QueryEscape is that it encodes // " " (space) as "+", which is valid in a query, but invalid in a path (see // https://stackoverflow.com/questions/2678551/when-should-space-be-encoded-to-plus-or-20) for // context). // To work around that, we replace the "+" signs with the path-compatible "%20". return strings.ReplaceAll(url.QueryEscape(s), "+", "%20") } func separateNamespaceNameVersion(path string) (ns, name, version string, err error) { name = path if namespaceSep := strings.LastIndex(name, "/"); namespaceSep != -1 { ns, name = name[:namespaceSep], name[namespaceSep+1:] ns, err = url.PathUnescape(ns) if err != nil { return "", "", "", fmt.Errorf("error unescaping namespace: %w", err) } } if versionSep := strings.LastIndex(name, "@"); versionSep != -1 { name, version = name[:versionSep], name[versionSep+1:] version, err = url.PathUnescape(version) if err != nil { return "", "", "", fmt.Errorf("error unescaping version: %w", err) } } name, err = url.PathUnescape(name) if err != nil { return "", "", "", fmt.Errorf("error unescaping name: %w", err) } if name == "" { return "", "", "", fmt.Errorf("purl is missing name") } return ns, name, version, nil } func parseQualifiers(rawQuery string) (Qualifiers, error) { // we need to parse the qualifiers ourselves and cannot rely on the `url.Query` type because // that uses a map, meaning it's unordered. We want to keep the order of the qualifiers, so this // function re-implements the `url.parseQuery` function based on our `Qualifier` type. Most of // the code here is taken from `url.parseQuery`. q := Qualifiers{} for rawQuery != "" { var key string key, rawQuery, _ = strings.Cut(rawQuery, "&") if strings.Contains(key, ";") { return nil, fmt.Errorf("invalid semicolon separator in query") } if key == "" { continue } key, value, _ := strings.Cut(key, "=") key, err := url.QueryUnescape(key) if err != nil { return nil, fmt.Errorf("error unescaping qualifier key %q", key) } if !validQualifierKey(key) { return nil, fmt.Errorf("invalid qualifier key: '%s'", key) } value, err = url.QueryUnescape(value) if err != nil { return nil, fmt.Errorf("error unescaping qualifier value %q", value) } q = append(q, Qualifier{ Key: strings.ToLower(key), Value: value, }) } return q, nil } // Make any purl type-specific adjustments to the parsed namespace. // See https://github.com/package-url/purl-spec#known-purl-types func typeAdjustNamespace(purlType, ns string) string { switch purlType { case TypeAlpm, TypeApk, TypeBitbucket, TypeComposer, TypeDebian, TypeGithub, TypeGolang, TypeNPM, TypeRPM, TypeQpkg: return strings.ToLower(ns) } return ns } // Make any purl type-specific adjustments to the parsed name. // See https://github.com/package-url/purl-spec#known-purl-types func typeAdjustName(purlType, name string, qualifiers Qualifiers) string { quals := qualifiers.Map() switch purlType { case TypeAlpm, TypeApk, TypeBitbucket, TypeBitnami, TypeComposer, TypeDebian, TypeGithub, TypeGolang, TypeNPM: return strings.ToLower(name) case TypePyPi: return strings.ToLower(strings.ReplaceAll(name, "_", "-")) case TypeMLFlow: return adjustMlflowName(name, quals) } return name } // Make any purl type-specific adjustments to the parsed version. // See https://github.com/package-url/purl-spec#known-purl-types func typeAdjustVersion(purlType, version string) string { switch purlType { case TypeHuggingface: return strings.ToLower(version) } return version } // https://github.com/package-url/purl-spec/blob/master/PURL-TYPES.rst#mlflow func adjustMlflowName(name string, qualifiers map[string]string) string { if repo, ok := qualifiers["repository_url"]; ok { if strings.Contains(repo, "azureml") { // Azure ML is case-sensitive and must be kept as-is return name } else if strings.Contains(repo, "databricks") { // Databricks is case-insensitive and must be lowercased return strings.ToLower(name) } else { // Unknown repository type, keep as-is return name } } else { // No repository qualifier given, keep as-is return name } } // validQualifierKey validates a qualifierKey against our QualifierKeyPattern. func validQualifierKey(key string) bool { return QualifierKeyPattern.MatchString(key) } // validType validates a type against our TypePattern. func validType(typ string) bool { return TypePattern.MatchString(typ) } // validCustomRules evaluates additional rules for each package url type, as specified in the package-url specification. // On success, it returns nil. On failure, a descriptive error will be returned. func validCustomRules(p PackageURL) error { q := p.Qualifiers.Map() switch p.Type { case TypeConan: if p.Namespace != "" { if val, ok := q["channel"]; ok { if val == "" { return errors.New("the qualifier channel must be not empty if namespace is present") } } else { return errors.New("channel qualifier does not exist") } } else { if val, ok := q["channel"]; ok { if val != "" { return errors.New("namespace is required if channel is non empty") } } } case TypeSwift: if p.Namespace == "" { return errors.New("namespace is required") } if p.Version == "" { return errors.New("version is required") } case TypeCran: if p.Version == "" { return errors.New("version is required") } } return nil } packageurl-go-0.1.3/packageurl_test.go000066400000000000000000000363161457127140100177530ustar00rootroot00000000000000/* Copyright (c) the purl authors Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ package packageurl_test import ( "encoding/json" "fmt" "os" "reflect" "regexp" "sort" "strings" "testing" "github.com/package-url/packageurl-go" ) type TestFixture struct { Description string `json:"description"` Purl string `json:"purl"` CanonicalPurl string `json:"canonical_purl"` PackageType string `json:"type"` Namespace string `json:"namespace"` Name string `json:"name"` Version string `json:"version"` QualifierMap OrderedMap `json:"qualifiers"` Subpath string `json:"subpath"` IsInvalid bool `json:"is_invalid"` } // OrderedMap is used to store the TestFixture.QualifierMap, to ensure that the // declaration order of qualifiers is preserved. type OrderedMap struct { OrderedKeys []string Map map[string]string } // qualifiersMapPattern is used to parse the TestFixture "qualifiers" field to // ensure that it's a json object. var qualifiersMapPattern = regexp.MustCompile(`(?ms)^\{.*\}$`) // UnmarshalJSON unmarshals the qualifiers field for a TestFixture. The // qualifiers field is given as a json object such as: // // "qualifiers": {"arch": "i386", "distro": "fedora-25"} // // This function performs in-order parsing of these values into an OrderedMap to // preserve items in order of declaration. Note that parsing as a // map[string]string won't preserve element order. func (m *OrderedMap) UnmarshalJSON(bytes []byte) error { data := string(bytes) switch data { case "null": m.OrderedKeys = []string{} m.Map = make(map[string]string) return nil default: // ensure that the data is a json object "{...}" if !qualifiersMapPattern.MatchString(data) { return fmt.Errorf("qualifiers parse error: not a json object: %s", data) } // find out the order in which map keys occur dec := json.NewDecoder(strings.NewReader(data)) // consume opening '{' _, _ = dec.Token() for dec.More() { t, _ := dec.Token() switch token := t.(type) { case json.Delim: if token != '}' { return fmt.Errorf("qualifiers parse error: expected delimiter '}', got: %v", token) } // closed json object -> we're done case string: // this token is a dictionary key m.OrderedKeys = append(m.OrderedKeys, token) // consume the value (the token following the colon after the key) _, _ = dec.Token() } } // now that we know the key order, just fill the OrderedMap.Map field if err := json.Unmarshal(bytes, &m.Map); err != nil { return err } return nil } } // Qualifiers converts the TestFixture.QualifierMap field to an object of type // packageurl.Qualifiers. func (t TestFixture) Qualifiers() packageurl.Qualifiers { q := packageurl.Qualifiers{} for _, key := range t.QualifierMap.OrderedKeys { q = append(q, packageurl.Qualifier{Key: key, Value: t.QualifierMap.Map[key]}) } return q } // TestFromStringExamples verifies that parsing example strings produce expected // results. func TestFromStringExamples(t *testing.T) { // Read the json file data, err := os.ReadFile("testdata/test-suite-data.json") if err != nil { t.Fatal(err) } // Load the json file contents into a structure testData := []TestFixture{} err = json.Unmarshal(data, &testData) if err != nil { t.Fatal(err) } // Use FromString on each item in the test set for _, tc := range testData { // Should parse without issue p, err := packageurl.FromString(tc.Purl) if tc.IsInvalid == false { if err != nil { t.Logf("%s failed: %s", tc.Description, err) t.Fail() } // verify parsing if p.Type != tc.PackageType { t.Logf("%s: incorrect package type: wanted: '%s', got '%s'", tc.Description, tc.PackageType, p.Type) t.Fail() } if p.Namespace != tc.Namespace { t.Logf("%s: incorrect namespace: wanted: '%s', got '%s'", tc.Description, tc.Namespace, p.Namespace) t.Fail() } if p.Name != tc.Name { t.Logf("%s: incorrect name: wanted: '%s', got '%s'", tc.Description, tc.Name, p.Name) t.Fail() } if p.Version != tc.Version { t.Logf("%s: incorrect version: wanted: '%s', got '%s'", tc.Description, tc.Version, p.Version) t.Fail() } want := tc.Qualifiers() sort.Slice(want, func(i, j int) bool { return want[i].Key < want[j].Key }) got := p.Qualifiers sort.Slice(got, func(i, j int) bool { return got[i].Key < got[j].Key }) if !reflect.DeepEqual(want, got) { t.Logf("%s: incorrect qualifiers: wanted: '%#v', got '%#v'", tc.Description, want, p.Qualifiers) t.Fail() } if p.Subpath != tc.Subpath { t.Logf("%s: incorrect subpath: wanted: '%s', got '%s'", tc.Description, tc.Subpath, p.Subpath) t.Fail() } } else { // Invalid cases if err == nil { t.Logf("%s did not fail and returned %#v", tc.Description, p) t.Fail() } } } } // TestToStringExamples verifies that the resulting package urls created match // the expected format. func TestToStringExamples(t *testing.T) { // Read the json file data, err := os.ReadFile("testdata/test-suite-data.json") if err != nil { t.Fatal(err) } // Load the json file contents into a structure var testData []TestFixture err = json.Unmarshal(data, &testData) if err != nil { t.Fatal(err) } // Use ToString on each item for _, tc := range testData { // Skip invalid items if tc.IsInvalid == true { continue } instance := packageurl.NewPackageURL( tc.PackageType, tc.Namespace, tc.Name, tc.Version, // Use QualifiersFromMap so that the qualifiers have a defined order, which is needed for string comparisons packageurl.QualifiersFromMap(tc.Qualifiers().Map()), tc.Subpath) result := instance.ToString() // NOTE: We create a purl with ToString and then load into a PackageURL // because qualifiers may not be in any order. By reparsing back // we can ensure the data transfers between string and instance form. canonical, _ := packageurl.FromString(tc.CanonicalPurl) toTest, _ := packageurl.FromString(result) // If the two results don't equal then the ToString failed if !reflect.DeepEqual(toTest, canonical) { t.Logf("%s failed: %s != %s", tc.Description, result, tc.CanonicalPurl) t.Fail() } } } // TestStringer verifies that the Stringer implementation produces results // equivalent with the ToString method. func TestStringer(t *testing.T) { // Read the json file data, err := os.ReadFile("testdata/test-suite-data.json") if err != nil { t.Fatal(err) } // Load the json file contents into a structure var testData []TestFixture err = json.Unmarshal(data, &testData) if err != nil { t.Fatal(err) } // Use ToString on each item for _, tc := range testData { // Skip invalid items if tc.IsInvalid == true { continue } purlPtr := packageurl.NewPackageURL( tc.PackageType, tc.Namespace, tc.Name, tc.Version, tc.Qualifiers(), tc.Subpath) purlValue := *purlPtr // Verify that the Stringer implementation returns a result // equivalent to ToString(). if purlPtr.ToString() != purlPtr.String() { t.Logf("%s failed: Stringer implementation differs from ToString: %s != %s", tc.Description, purlPtr.String(), purlPtr.ToString()) t.Fail() } // Verify that the %s format modifier works for values. fmtStr := purlValue.String() if fmtStr != purlPtr.String() { t.Logf("%s failed: %%s format modifier does not work on values: %s != %s", tc.Description, fmtStr, purlPtr.ToString()) t.Fail() } } } // Verify correct conversion of Qualifiers to a string map and vice versa. func TestQualifiersMapConversion(t *testing.T) { tests := []struct { kvMap map[string]string qualifiers packageurl.Qualifiers }{ { kvMap: map[string]string{}, qualifiers: packageurl.Qualifiers{}, }, { kvMap: map[string]string{"arch": "amd64"}, qualifiers: packageurl.Qualifiers{ packageurl.Qualifier{Key: "arch", Value: "amd64"}, }, }, { kvMap: map[string]string{"arch": "amd64", "os": "linux"}, qualifiers: packageurl.Qualifiers{ packageurl.Qualifier{Key: "arch", Value: "amd64"}, packageurl.Qualifier{Key: "os", Value: "linux"}, }, }, } for _, test := range tests { // map -> Qualifiers got := packageurl.QualifiersFromMap(test.kvMap) if !reflect.DeepEqual(got, test.qualifiers) { t.Logf("map -> qualifiers conversion failed: got: %#v, wanted: %#v", got, test.qualifiers) t.Fail() } // Qualifiers -> map mp := test.qualifiers.Map() if !reflect.DeepEqual(mp, test.kvMap) { t.Logf("qualifiers -> map conversion failed: got: %#v, wanted: %#v", mp, test.kvMap) t.Fail() } } } func TestNameEscaping(t *testing.T) { testCases := map[string]string{ "abc": "pkg:deb/abc", "ab/c": "pkg:deb/ab%2Fc", } for name, output := range testCases { t.Run(name, func(t *testing.T) { p := &packageurl.PackageURL{Type: "deb", Name: name} if s := p.ToString(); s != output { t.Fatalf("wrong escape. expected=%q, got=%q", output, s) } }) } } func TestQualifierMissingEqual(t *testing.T) { input := "pkg:npm/test-pkg?key" want := packageurl.PackageURL{ Type: "npm", Name: "test-pkg", Qualifiers: packageurl.Qualifiers{}, } got, err := packageurl.FromString(input) if err != nil { t.Fatalf("FromString(%s): unexpected error: %v", input, err) } if !reflect.DeepEqual(want, got) { t.Fatalf("FromString(%s): want %q got %q", input, want, got) } } func TestNormalize(t *testing.T) { testCases := []struct { name string input packageurl.PackageURL want packageurl.PackageURL wantErr bool }{{ name: "type is case insensitive", input: packageurl.PackageURL{ Type: "NpM", Name: "pkg", }, want: packageurl.PackageURL{ Type: "npm", Name: "pkg", Qualifiers: packageurl.Qualifiers{}, }, }, { name: "type is manditory", input: packageurl.PackageURL{ Name: "pkg", }, wantErr: true, }, { name: "leading and traling / on namespace are trimmed", input: packageurl.PackageURL{ Type: "npm", Namespace: "/namespace/org/", Name: "pkg", }, want: packageurl.PackageURL{ Type: "npm", Namespace: "namespace/org", Name: "pkg", Qualifiers: packageurl.Qualifiers{}, }, }, { name: "qualifiers with empty values are removed", input: packageurl.PackageURL{ Type: "npm", Name: "pkg", Qualifiers: packageurl.Qualifiers{{ Key: "k1", Value: "v1", }, { Key: "k2", Value: "", }, { Key: "k3", Value: "v3", }}, }, want: packageurl.PackageURL{ Type: "npm", Name: "pkg", Qualifiers: packageurl.Qualifiers{{ Key: "k1", Value: "v1", }, { Key: "k3", Value: "v3", }}, }, }, { name: "qualifiers are sorted by key", input: packageurl.PackageURL{ Type: "npm", Name: "pkg", Qualifiers: packageurl.Qualifiers{{ Key: "k3", Value: "v3", }, { Key: "k2", Value: "v2", }, { Key: "k1", Value: "v1", }}, }, want: packageurl.PackageURL{ Type: "npm", Name: "pkg", Qualifiers: packageurl.Qualifiers{{ Key: "k1", Value: "v1", }, { Key: "k2", Value: "v2", }, { Key: "k3", Value: "v3", }}, }, }, { name: "duplicate keys are invalid", input: packageurl.PackageURL{ Type: "npm", Name: "pkg", Qualifiers: packageurl.Qualifiers{{ Key: "k1", Value: "v1", }, { Key: "k1", Value: "v2", }}, }, wantErr: true, }, { name: "keys are made lower case", input: packageurl.PackageURL{ Type: "npm", Name: "pkg", Qualifiers: packageurl.Qualifiers{{ Key: "KeY", Value: "v1", }}, }, want: packageurl.PackageURL{ Type: "npm", Name: "pkg", Qualifiers: packageurl.Qualifiers{{ Key: "key", Value: "v1", }}, }, }, { name: "name is required", input: packageurl.PackageURL{ Type: "npm", }, wantErr: true, }, { name: "leading and traling / on subpath are trimmed", input: packageurl.PackageURL{ Type: "npm", Name: "pkg", Subpath: "/sub/path/", }, want: packageurl.PackageURL{ Type: "npm", Name: "pkg", Qualifiers: packageurl.Qualifiers{}, Subpath: "sub/path", }, }, { name: "'.' is an invalid subpath segment", input: packageurl.PackageURL{ Type: "npm", Name: "pkg", Subpath: "/sub/./path/", }, wantErr: true, }, { name: "'..' is an invalid subpath segment", input: packageurl.PackageURL{ Type: "npm", Name: "pkg", Subpath: "/sub/../path/", }, wantErr: true, }, { name: "'./' is a valid subpath prefix", input: packageurl.PackageURL{ Type: "npm", Name: "pkg", Subpath: "./sub/path", }, want: packageurl.PackageURL{ Type: "npm", Name: "pkg", Qualifiers: packageurl.Qualifiers{}, Subpath: "./sub/path", }, }, { name: "'../' is a valid subpath prefix", input: packageurl.PackageURL{ Type: "npm", Name: "pkg", Subpath: "../sub/path", }, want: packageurl.PackageURL{ Type: "npm", Name: "pkg", Qualifiers: packageurl.Qualifiers{}, Subpath: "../sub/path", }, }, { name: "known type namespace adjustments", input: packageurl.PackageURL{ Type: "npm", Namespace: "NaMeSpAcE", Name: "pkg", }, want: packageurl.PackageURL{ Type: "npm", Namespace: "namespace", Name: "pkg", Qualifiers: packageurl.Qualifiers{}, }, }, { name: "known type name adjustments", input: packageurl.PackageURL{ Type: "npm", Name: "nAmE", }, want: packageurl.PackageURL{ Type: "npm", Name: "name", Qualifiers: packageurl.Qualifiers{}, }, }, { name: "known type version adjustments", input: packageurl.PackageURL{ Type: "huggingface", Name: "name", Version: "VeRsIoN", }, want: packageurl.PackageURL{ Type: "huggingface", Name: "name", Version: "version", Qualifiers: packageurl.Qualifiers{}, }, }} for _, testCase := range testCases { t.Run(testCase.name, func(t *testing.T) { got := testCase.input err := got.Normalize() if err != nil && testCase.wantErr { return } if err != nil && !testCase.wantErr { t.Fatalf("Normalize(%s): unexpected error: %v", testCase.name, err) } if testCase.wantErr { t.Fatalf("Normalize(%s): want error, got none", testCase.name) } if !reflect.DeepEqual(testCase.want, got) { t.Fatalf("Normalize(%s):\nwant %#v\ngot %#v", testCase.name, testCase.want, got) } }) } } packageurl-go-0.1.3/testdata/000077500000000000000000000000001457127140100160475ustar00rootroot00000000000000packageurl-go-0.1.3/testdata/.gitkeep000066400000000000000000000000001457127140100174660ustar00rootroot00000000000000packageurl-go-0.1.3/testdata/fuzz/000077500000000000000000000000001457127140100170455ustar00rootroot00000000000000packageurl-go-0.1.3/testdata/fuzz/FuzzFromString/000077500000000000000000000000001457127140100220165ustar00rootroot00000000000000771e938e4458e983a736261a702e27c7a414fd660a15b63034f290b146d2f217000066400000000000000000000000341457127140100317420ustar00rootroot00000000000000packageurl-go-0.1.3/testdata/fuzz/FuzzFromStringgo test fuzz v1 string("0") d0a861fe9b7c443af2b649e08753442111b630dd29fcd570543db3f9351158aa000066400000000000000000000000351457127140100323110ustar00rootroot00000000000000packageurl-go-0.1.3/testdata/fuzz/FuzzFromStringgo test fuzz v1 string("?A")