Repository (non-Global) Security Advisories have major usability challenges

[mbauman]

Select Topic Area

Product Feedback

Body

The distinction between repository and global security advisories is confusing and problematic. It breaks the GHSA identifier. Specifically:

• Given a GHSA identifier, I do not know how to fetch its data. It may be:
  • A global-only GHSA, accessible through the /advisories endpoint.
  • Both a global and a repository GHSA. The global advisory is accessible through the /advisories endpoint. The repository advisory is inaccessible by API unless I also know its entire originating url or repository. The data between these two identically-identified advisories are almost always different. (This is issue GHSA-qq97-vm5h-rrhg out-of sync. Why does it have different states? github/advisory-database#224)
  • A repository-only GHSA, accessible only with its entire originating url or repository.
• Repository GHSAs from unreviewed ecosystems that have been reviewed by GitHub staff and have been assigned a CVE do not have the corresponding CVE imported into as an unreviewed global advisory (unlike all other CVEs). Ironically, if I were to have requested a CVE from another CNA, I would get a global GHSA that I could reference unambiguously and it could even appropriately use alias information.
• The licensing of repository security advisories is unclear.

There are two simple APIs that would greatly alleviate many of the pains that come from this muddled situation:

• There is an internal GitHub API that is able to look up repository advisories by their ID alone. This is evidenced by the fact that the plaintext GHSA-vmp8-hg63-v2hp is auto-linked here. Exposing this as a public API would be hugely beneficial.
• The ability to ask for newly published public repository advisories would similarly help downstream consumers. In my case, I'd like to see if any of the 10k packages in my unreviewed ecosystem have any updated or new advisories. The only way to do this right now is to ping all 10k repositories.

Fundamentally, though, it seems quite ironic to have built such a well-designed unique identifier only to intentionally break its uniqueness. The advisory ecosystem is well-versed with aliased IDs. GitHub's advisory db would be very well served if it could detangle the global and repository IDs, using distinct identifiers (or even distinct prefixes!) that reference each-other with aliases instead.

[github-actions[bot]]

💬 Your Product Feedback Has Been Submitted 🎉

Thank you for taking the time to share your insights with us! Your feedback is invaluable as we build a better GitHub experience for all our users.

Here's what you can expect moving forward ⏩

• Your input will be carefully reviewed and cataloged by members of our product teams. 
  • Due to the high volume of submissions, we may not always be able to provide individual responses.
  • Rest assured, your feedback will help chart our course for product improvements.
• Other users may engage with your post, sharing their own perspectives or experiences. 
• GitHub staff may reach out for further clarification or insight. 
  • We may 'Answer' your discussion if there is a current solution, workaround, or roadmap/changelog post related to the feedback.

Where to look to see what's shipping 👀

• Read the Changelog for real-time updates on the latest GitHub features, enhancements, and calls for feedback.
• Explore our Product Roadmap, which details upcoming major releases and initiatives.

What you can do in the meantime 💻

• Upvote and comment on other user feedback Discussions that resonate with you.
• Add more information at any point! Useful details include: use cases, relevant labels, desired outcomes, and any accompanying screenshots.

As a member of the GitHub community, your participation is essential. While we can't promise that every suggestion will be implemented, we want to emphasize that your feedback is instrumental in guiding our decisions and priorities.

Thank you once again for your contribution to making GitHub even better! We're grateful for your ongoing support and collaboration in shaping the future of our platform. ⭐