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.

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

Address gaps in documentation of VEX implementation in SPDX 3.0 #948

Open
VenkatTechnologist opened this issue Mar 30, 2024 · 9 comments
Open
Assignees
Milestone

Comments

@VenkatTechnologist
Copy link

VenkatTechnologist commented Mar 30, 2024

While going through SPDX 3.0 model VEX implementation, Venkat observed that there were gaps in documentation of the implementation. Specifically, the following were observed:

  1. There is no documentation for the how VEX objects are implemented in SPDX and its structure
  2. There is no mapping of VEX objects to the SPDX. The team felt that it would be better to have a mapping
  3. There are no examples of various scenarios of how the VEX would be implemented in SPDX format

In the SPDX security meeting that happened on March 20th, 2024, which @goneall , @kestewart , Jeff Schutt, and @VenkatTechnologist attended, it was decided to have a document in the Annexure directory for the mapping and the examples.

In another email thread between Venkat, @goneall, @puerco , @kestewart, and Jeff Schutt, Venkat pointed out that there is no formal documentation for how VEX objects are implemented in SPDX and its structure. This email was also forwarded to @rnjudge by Venkat.

This issue is to track and resolve these gaps.

@goneall
Copy link
Member

goneall commented Mar 31, 2024

We can add the mapping as a markdown file to the annexes directory in the spdx-spec v3 branch.

@goneall goneall added this to the 3.1 milestone Apr 6, 2024
@VenkatTechnologist
Copy link
Author

I've made a few changes in the document that we are preparing for the mapping to reflect that there is currently no SPDX field for VEX doc version.

@puerco, can you please review the comments and the updated contents and respond back? Thanks.

@rnjudge
Copy link
Contributor

rnjudge commented Apr 12, 2024

@VenkatTechnologist where is the document?

@VenkatTechnologist
Copy link
Author

VenkatTechnologist commented Apr 13, 2024 via email

@rnjudge
Copy link
Contributor

rnjudge commented Apr 16, 2024

It's currently getting prepared in my Google drive with edit access to Gary, Jeff, and @puerco. If you would like, I can add you too, Rose.

Please add me :) I have been on maternity leave but before that heavily involved in the security profile. Thank you!

@VenkatTechnologist
Copy link
Author

Sure, and welcome back! Please let me know the email id. that can be used to add you. Thanks.

@rnjudge
Copy link
Contributor

rnjudge commented Apr 17, 2024

@VenkatTechnologist rose.judge@broadcom.com please, thank you!

@VenkatTechnologist
Copy link
Author

There seems to be no formal VEX spec. specifying the structure of VEX implementation in SPDX. I propose that we add that as part of this document and call this document as 'VEX support in SPDX' (or on similar lines).

@goneall
Copy link
Member

goneall commented Apr 28, 2024

Transferring this issue to the spec repo since we are fixing this in an Annex

@goneall goneall transferred this issue from spdx/spdx-3-model Apr 28, 2024
@goneall goneall modified the milestones: 3.1, 3.0.1 Apr 28, 2024
@VenkatTechnologist VenkatTechnologist changed the title Need VEX to SPDX mappings Address gaps in documentation of VEX implementation in SPDX 3.0 Apr 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants