Merged
Conversation
kylewillmon
approved these changes
Nov 9, 2023
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Overview
This PR escapes the plus sign character when emitting qualifiers into a PURL string. This avoids problems when parsing PURLs using packageurl-dotnet, packageurl-go, packageurl-java, packageurl-js, or packageurl-ruby, all of which incorrectly convert plus signs in qualifiers into spaces on read as if the qualifiers were x-www-form-urlencoded.
This PR does not fix the compatibility problem when parsing a PURL produced by packageurl-dotnet, packageurl-go, or packageurl-ruby, which incorrectly convert spaces to plus signs in qualifiers on write for the same reason. We can't tell what implementation generated the PURL so we can't tell whether it correctly implements the qualifier section of the spec or not.
This PR also does not fix the problem where packageurl-dotnet, packageurl-java, and packageurl-ruby incorrectly convert plus signs in other parts of the purl into spaces on read, or the problem where packageurl-dotnet and packageurl-ruby incorrectly convert spaces in other parts of the purl into plus signs on write. This is pretty clearly an implementation error because even if the qualifiers were x-www-form-urlencoded, the rest of the PURL is definitely not x-www-form-urlencoded.
Checklist
Issue
Ref #11