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

docs: spec updates for arbitrary blob signing #811

Merged
merged 88 commits into from
Mar 8, 2024
Merged

Conversation

rgnote
Copy link
Contributor

@rgnote rgnote commented Oct 28, 2023

CLI Spec updated for Arbitrary blob signing. Proposal https://hackmd.io/ewbJr2ZnT4a8U1ObDVXcSw?view#CLI-Spec and https://hackmd.io/@-KPyDkW6QfGA-pldFa13pA/ByuHffALa

Signing Scheme and trust policy updates : notaryproject/specifications#283

Signed-off-by: rgnote [email protected]

@codecov-commenter
Copy link

codecov-commenter commented Oct 28, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 67.35%. Comparing base (eaa5fb4) to head (2750c4b).
Report is 9 commits behind head on main.

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #811      +/-   ##
==========================================
+ Coverage   64.93%   67.35%   +2.42%     
==========================================
  Files          45       45              
  Lines        2729     2166     -563     
==========================================
- Hits         1772     1459     -313     
+ Misses        795      545     -250     
  Partials      162      162              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@shizhMSFT shizhMSFT changed the title Spec updates for arbitrary blob signing doc: spec updates for arbitrary blob signing Oct 30, 2023
@shizhMSFT shizhMSFT changed the title doc: spec updates for arbitrary blob signing docs: spec updates for arbitrary blob signing Oct 30, 2023
@Two-Hearts
Copy link
Contributor

Before diving into the detailed UX design, shall we have a PR in the https://github.com/notaryproject/specifications repo to add the new specs related to blob? For example, signature payload, trust policy, ect.

specs/commandline/blob.md Outdated Show resolved Hide resolved
specs/commandline/blob.md Outdated Show resolved Hide resolved
specs/commandline/blob.md Outdated Show resolved Hide resolved
specs/commandline/blob.md Outdated Show resolved Hide resolved
specs/commandline/blob.md Outdated Show resolved Hide resolved
specs/commandline/blob.md Outdated Show resolved Hide resolved
Copy link
Contributor

@yizha1 yizha1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @rgnote I left some comments

specs/commandline/blob.md Outdated Show resolved Hide resolved
specs/commandline/blob.md Show resolved Hide resolved
specs/commandline/blob.md Outdated Show resolved Hide resolved
specs/commandline/blob.md Outdated Show resolved Hide resolved
Copy link
Contributor

@yizha1 yizha1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @rgnote. I left additional comments.

specs/commandline/blob.md Outdated Show resolved Hide resolved
specs/commandline/blob.md Show resolved Hide resolved
specs/commandline/blob.md Outdated Show resolved Hide resolved
specs/commandline/blob.md Outdated Show resolved Hide resolved
specs/commandline/blob.md Outdated Show resolved Hide resolved
specs/commandline/blob.md Outdated Show resolved Hide resolved
specs/commandline/blob.md Outdated Show resolved Hide resolved
specs/commandline/policy.md Outdated Show resolved Hide resolved
specs/commandline/blob.md Outdated Show resolved Hide resolved
specs/commandline/blob.md Outdated Show resolved Hide resolved
specs/commandline/blob.md Outdated Show resolved Hide resolved
specs/commandline/blob.md Outdated Show resolved Hide resolved
specs/commandline/blob.md Outdated Show resolved Hide resolved
specs/commandline/blob.md Outdated Show resolved Hide resolved
specs/commandline/blob.md Outdated Show resolved Hide resolved
Copy link
Contributor

@yizha1 yizha1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM with a nit, but I am not a maintainer of notation repo

specs/commandline/blob.md Outdated Show resolved Hide resolved
specs/commandline/policy.md Outdated Show resolved Hide resolved
specs/commandline/blob.md Outdated Show resolved Hide resolved
specs/commandline/blob.md Outdated Show resolved Hide resolved
specs/commandline/blob.md Outdated Show resolved Hide resolved
specs/commandline/blob.md Outdated Show resolved Hide resolved
specs/commandline/blob.md Outdated Show resolved Hide resolved
specs/commandline/blob.md Show resolved Hide resolved
Copy link
Contributor

@priteshbandi priteshbandi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we add some note, for help of top level sign, verify, inspect and list that they only applies to oci.

@rgnote
Copy link
Contributor Author

rgnote commented Nov 17, 2023

Should we add some note, for help of top level sign, verify, inspect and list that they only applies to oci.

They were already updated to note that they work with OCI artifacts.

priteshbandi
priteshbandi previously approved these changes Nov 18, 2023
Copy link
Contributor

@priteshbandi priteshbandi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approving this pull request, and we can address the following comments in the next PR:

  1. Support 'blob sign' and 'verify' commands to function with standard input and output?
  2. In my opinion, merely mentioning 'oci' in the command description (or in help) isn't sufficient; it should be more prominent

Copy link
Contributor

@yizha1 yizha1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM with some minor comments.

specs/commandline/blob.md Outdated Show resolved Hide resolved
specs/commandline/policy.md Outdated Show resolved Hide resolved
specs/commandline/sign.md Outdated Show resolved Hide resolved
specs/commandline/blob.md Outdated Show resolved Hide resolved
specs/commandline/blob.md Show resolved Hide resolved
specs/commandline/blob.md Outdated Show resolved Hide resolved
specs/commandline/blob.md Outdated Show resolved Hide resolved
specs/commandline/blob.md Outdated Show resolved Hide resolved
specs/commandline/blob.md Show resolved Hide resolved
specs/commandline/verify.md Outdated Show resolved Hide resolved
specs/commandline/sign.md Show resolved Hide resolved
specs/commandline/inspect.md Outdated Show resolved Hide resolved
specs/commandline/blob.md Outdated Show resolved Hide resolved
rgnote and others added 25 commits March 8, 2024 11:46
Co-authored-by: Shiwei Zhang <[email protected]>
Signed-off-by: Rakesh Gariganti <[email protected]>
Signed-off-by: rgnote <[email protected]>
Signed-off-by: rgnote <[email protected]>
Signed-off-by: Patrick Zheng <[email protected]>
Signed-off-by: rgnote <[email protected]>
Co-authored-by: Shiwei Zhang <[email protected]>
Signed-off-by: Rakesh Gariganti <[email protected]>
Signed-off-by: rgnote <[email protected]>
Co-authored-by: Shiwei Zhang <[email protected]>
Signed-off-by: Rakesh Gariganti <[email protected]>
Signed-off-by: rgnote <[email protected]>
@rgnote rgnote merged commit ba28208 into notaryproject:main Mar 8, 2024
5 checks passed
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

Successfully merging this pull request may close these issues.