feat: add inspect blob commands #888

rrsemlani · 2024-02-13T01:44:23Z

Adding inspect blob commands.
Spec Pr used for ref: #811

cmd/notation/blob/inspect.go

cmd/notation/internal/sharedutils/inspect.go

priteshbandi · 2024-02-21T18:43:51Z

Also as per spec we have a new field called signature envelope type. Please add support for it in both oci and blob inspect command.

cmd/notation/blob/cmd.go

cmd/notation/blob/inspect.go

cmd/notation/blob/cmd.go

cmd/notation/blob/inspect.go

cmd/notation/blob/inspect_test.go

cmd/notation/main.go

cmd/notation/blob/inspect.go

Signed-off-by: Rishab Semlani <[email protected]>

codecov-commenter · 2024-04-04T05:27:21Z

Codecov Report

Attention: Patch coverage is 68.68132% with 57 lines in your changes missing coverage. Please review.

Project coverage is 71.05%. Comparing base (eaa5fb4) to head (3ee161f).
Report is 71 commits behind head on main.

Files	Patch %	Lines
cmd/notation/internal/outputs/inspect.go	70.53%	23 Missing and 10 partials ⚠️
cmd/notation/blob/inspect.go	47.50%	21 Missing ⚠️
cmd/notation/internal/osutil/read.go	86.66%	1 Missing and 1 partial ⚠️
cmd/notation/inspect.go	80.00%	0 Missing and 1 partial ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #888      +/-   ##
==========================================
+ Coverage   64.93%   71.05%   +6.12%     
==========================================
  Files          45       49       +4     
  Lines        2729     2246     -483     
==========================================
- Hits         1772     1596     -176     
+ Misses        795      453     -342     
- Partials      162      197      +35

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

Signed-off-by: Rishab Semlani <[email protected]>

internal/testdata/Output.txt

cmd/notation/blob/inspect.go

cmd/notation/internal/outputs/inspect.go

cmd/notation/blob/inspect.go

cmd/notation/blob/inspect_test.go

Signed-off-by: Rishab Semlani <[email protected]>

cmd/notation/blob/inspect.go

cmd/notation/internal/osutil/read.go

cmd/notation/blob/inspect.go

cmd/notation/blob/inspect_test.go

internal/testdata/LargeFile.txt

Signed-off-by: Rishab Semlani <[email protected]>

cmd/notation/internal/osutil/read.go

cmd/notation/internal/outputs/inspect.go

Two-Hearts · 2024-05-30T07:56:10Z

cmd/notation/internal/outputs/inspect.go

+	}
+}
+
+func Signatures(mediaType string, digest string, output InspectOutput, sigFile []byte) (error, []SignatureOutput) {


This function is called Signatures and returning an array of SignatureOutput, so it seems to be processing multiple signatures. However, from its input sigFile []byte and logic sigEnvelope, err := signature.ParseEnvelope(mediaType, sigFile), it actually can only process one signature per call. Please make sure this is by design.

Two-Hearts · 2024-05-30T07:57:38Z

cmd/notation/internal/outputs/inspect.go

+	skippedSignatures := false
+	if err != nil {
+		logSkippedSignature(digest, err)
+		skippedSignatures = true


Since you are return nil, nil right after this line, toggling this local bool seems redundant?

Two-Hearts · 2024-05-30T08:12:37Z

cmd/notation/internal/outputs/inspect.go

+
+		certListNode := sigNode.Add("certificates")
+		for _, cert := range signature.Certificates {
+			certNode := certListNode.AddPair("SHA256 fingerprint", cert.SHA256Fingerprint)


I have a use case that the user would like to have an array of SHA256 fingerprints, starting from the leaf cert to the root cert, in the output. For example, if the SHA256 fingerprints for leaf is aaaaa, for intermediate 1 is bbbbb, for intermediate 2 is ccccc, and for root is ddddd. Then when I run notation blob inspect my_sig, I could get an array ["aaaaa", "bbbbb", "ccccc", "ddddd"] from the final output.
The current implementation does not support it, where I have to copy/paste/assemble such an array myself. Can we add a new field to the output to show the array?
/cc: @yizha1 @FeynmanZhou

Displaying duplicate information in CLI output is not recommended. Instead, users can opt to emit notation output in JSON format and utilize tools like jq to extract the desired text.

Displaying duplicate information in CLI output is not recommended. Instead, users can opt to emit notation output in JSON format and utilize tools like jq to extract the desired text.

Asking users to do a jq on the output is extra work though, where we could save this effort for them by adding a field in the output. @yizha1 for your comments please.

@priteshbandi Here is the scenario:

Users produce OCI signatures based on Notary Project specifications. When users attach signatures to OCI artifact in OCI registries, users need to add a specific annotation io.cncf.notary.x509chain.thumbprint#S256 per Notary Project OCI signature spec. It is not easy for users to 1) generate the fingerprints, 2) figure out the order based on the spec.

As blob inspect has all these information, so it will improve the user experience to get ordered x509 chain thumbprints in an easy way, and help more users to adopt Notary Project spec. So, my suggestion would be blob inspect to support output certificate SHA256 fingerprints with a new field under current certificates, for example

certificate SHA256 fingerprints: ["leaf-sha256-fingerprint","intermediate-sha256-fingerprint","root-sha256-fingerprint"]

This will not block this PR, if you agree, we can create a new issue to track this work. It will be a simple work, but save a big effort for our users.

Two-Hearts

Please add corresponding E2E test cases for blob inspect command under test/e2e.

github-actions · 2024-08-12T01:54:40Z

This PR is stale because it has been opened for 45 days with no activity. Remove stale label or comment. Otherwise, it will be closed in 30 days.

Signed-off-by: Rishab Semlani <[email protected]>

github-actions · 2024-10-20T02:05:07Z

This PR is stale because it has been opened for 45 days with no activity. Remove stale label or comment. Otherwise, it will be closed in 30 days.

github-actions · 2024-11-20T02:02:50Z

PR closed due to no activity in the past 30 days.

rrsemlani requested review from gokarnm, JeyJeyGao, justincormack, NiazFK, priteshbandi, rgnote, shizhMSFT, SteveLasker, toddysm and Two-Hearts as code owners February 13, 2024 01:44

rrsemlani force-pushed the rsemlani_notation_inspect branch 4 times, most recently from 1ffee89 to 3b75784 Compare February 13, 2024 20:14

priteshbandi reviewed Feb 16, 2024

View reviewed changes

cmd/notation/blob/inspect.go Outdated Show resolved Hide resolved

cmd/notation/internal/sharedutils/inspect.go Outdated Show resolved Hide resolved

cmd/notation/internal/sharedutils/inspect.go Outdated Show resolved Hide resolved

priteshbandi reviewed Feb 21, 2024

View reviewed changes

rrsemlani force-pushed the rsemlani_notation_inspect branch from 665c5f8 to 53d25cf Compare March 22, 2024 23:25

priteshbandi reviewed Mar 24, 2024

View reviewed changes

rrsemlani force-pushed the rsemlani_notation_inspect branch from 53d25cf to 3272be7 Compare April 2, 2024 17:31

rrsemlani requested review from vaninrao10 and yizha1 as code owners April 2, 2024 17:31

rrsemlani force-pushed the rsemlani_notation_inspect branch from 3272be7 to 9788c7a Compare April 2, 2024 17:39

rrsemlani added 5 commits April 3, 2024 14:31

Adding sign and inspect blob commands

af88c66

Signed-off-by: Rishab Semlani <[email protected]>

Adding sign and inspect blob commands

586e5e6

Signed-off-by: Rishab Semlani <[email protected]>

Adding inspect blob commands

873b060

Signed-off-by: Rishab Semlani <[email protected]>

Adding inspect blob commands

474ee17

Signed-off-by: Rishab Semlani <[email protected]>

Adding sign and inspect blob commands

7e8dbe0

Signed-off-by: Rishab Semlani <[email protected]>

rrsemlani force-pushed the rsemlani_notation_inspect branch from 9788c7a to 7e8dbe0 Compare April 3, 2024 21:55

Adding inspect blob commands

d6a58f1

Signed-off-by: Rishab Semlani <[email protected]>

Adding inspect blob commands

d423ce9

Signed-off-by: Rishab Semlani <[email protected]>

priteshbandi reviewed Apr 4, 2024

View reviewed changes

cmd/notation/internal/outputs/inspect.go Show resolved Hide resolved

priteshbandi reviewed Apr 4, 2024

View reviewed changes

cmd/notation/blob/inspect.go Outdated Show resolved Hide resolved

cmd/notation/blob/inspect.go Outdated Show resolved Hide resolved

cmd/notation/blob/inspect.go Outdated Show resolved Hide resolved

priteshbandi reviewed Apr 4, 2024

View reviewed changes

cmd/notation/blob/inspect_test.go Outdated Show resolved Hide resolved

cmd/notation/blob/inspect_test.go Outdated Show resolved Hide resolved

rrsemlani added 3 commits April 4, 2024 02:14

Adding inspect blob commands

a7daaba

Signed-off-by: Rishab Semlani <[email protected]>

Adding inspect blob commands

d89f8e4

Signed-off-by: Rishab Semlani <[email protected]>

Adding inspect blob commands

fc6fd6b

Signed-off-by: Rishab Semlani <[email protected]>

priteshbandi reviewed Apr 4, 2024

View reviewed changes

rrsemlani added 6 commits April 4, 2024 14:57

Adding inspect blob commands

deb4e8c

Signed-off-by: Rishab Semlani <[email protected]>

Adding inspect blob commands

961be04

Signed-off-by: Rishab Semlani <[email protected]>

Adding inspect blob commands

6edecc3

Signed-off-by: Rishab Semlani <[email protected]>

Adding inspect blob commands

dcb0610

Signed-off-by: Rishab Semlani <[email protected]>

Adding inspect blob commands

3b0f99a

Signed-off-by: Rishab Semlani <[email protected]>

Adding inspect blob commands

3ee161f

Signed-off-by: Rishab Semlani <[email protected]>

Two-Hearts reviewed May 30, 2024

View reviewed changes

shizhMSFT changed the title ~~Adding inspect blob commands~~ feat: add inspect blob commands Jun 4, 2024

github-actions bot added Stale and removed Stale labels Aug 12, 2024

rrsemlani and others added 2 commits September 4, 2024 11:48

Adding inspect blob commands

12285c4

Signed-off-by: Rishab Semlani <[email protected]>

Merge branch 'main' into rsemlani_notation_inspect

661f048

Signed-off-by: Rishab Semlani <[email protected]>

priteshbandi mentioned this pull request Oct 15, 2024

Notation to sign and verify arbitrary data #741

Open

github-actions bot added the Stale label Oct 20, 2024

github-actions bot closed this Nov 20, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add inspect blob commands #888

feat: add inspect blob commands #888

rrsemlani commented Feb 13, 2024

priteshbandi commented Feb 21, 2024

codecov-commenter commented Apr 4, 2024 •

edited by codecov bot

Loading

Two-Hearts May 30, 2024

Two-Hearts May 30, 2024

Two-Hearts May 30, 2024 •

edited

Loading

priteshbandi Jun 10, 2024

Two-Hearts Jun 10, 2024

yizha1 Jun 27, 2024

Two-Hearts left a comment

github-actions bot commented Aug 12, 2024

github-actions bot commented Oct 20, 2024

github-actions bot commented Nov 20, 2024

feat: add inspect blob commands #888

feat: add inspect blob commands #888

Conversation

rrsemlani commented Feb 13, 2024

priteshbandi commented Feb 21, 2024

codecov-commenter commented Apr 4, 2024 • edited by codecov bot Loading

Codecov Report

Two-Hearts May 30, 2024

Choose a reason for hiding this comment

Two-Hearts May 30, 2024

Choose a reason for hiding this comment

Two-Hearts May 30, 2024 • edited Loading

Choose a reason for hiding this comment

priteshbandi Jun 10, 2024

Choose a reason for hiding this comment

Two-Hearts Jun 10, 2024

Choose a reason for hiding this comment

yizha1 Jun 27, 2024

Choose a reason for hiding this comment

Two-Hearts left a comment

Choose a reason for hiding this comment

github-actions bot commented Aug 12, 2024

github-actions bot commented Oct 20, 2024

github-actions bot commented Nov 20, 2024

codecov-commenter commented Apr 4, 2024 •

edited by codecov bot

Loading

Two-Hearts May 30, 2024 •

edited

Loading