doc: notation Inspect Command line Spec by vaninrao10 · Pull Request #500 · notaryproject/notation

vaninrao10 · 2023-01-05T21:18:19Z

Use Case / Scenarios:

```
Troubleshooting
```
```
Auditing
```

If verification of the image digest / signature digest fails due to wrong certificate configuration, user will execute the inspect command to extract the certificate thumb print, a hash of a certificate which is a unique identifier for certificates.

shizhMSFT · 2023-01-06T06:25:47Z

@vaninrao10 What's the difference between this PR and #490? BTW, could you revise the PR title to conform the conventional commit style?

iamsamirzon · 2023-01-06T06:39:35Z

@vaninrao10 What's the difference between this PR and #490? BTW, could you revise the PR title to conform the conventional commit style?

@shizhMSFT - No change. 490 was abandoned as there was an unexpected error with committing its change. Vani just moved the same files/edits into this new PR. Could you remind me the "conventional commit style". I could perhaps make the changes for Vani, so you can approve and she can merge the PR in the morning.

shizhMSFT · 2023-01-06T06:49:40Z

Could you remind me the "conventional commit style".

Basically, changing the PR title to doc: notation Inspect Command line Spec. Here are the details.

specs/commandline/inspect.md

FeynmanZhou

Only a couple of comments left above

codecov-commenter · 2023-01-11T00:04:21Z

Codecov Report

Merging #500 (a7901f1) into main (c736231) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #500   +/-   ##
=======================================
  Coverage   29.57%   29.57%           
=======================================
  Files          26       26           
  Lines        1515     1515           
=======================================
  Hits          448      448           
  Misses       1050     1050           
  Partials       17       17

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

specs/commandline/inspect.md

priteshbandi

LGTM with following feedback

specs/commandline/inspect.md

priteshbandi

LGTM

vaninrao10 · 2023-01-12T21:03:10Z

LGTM

For Shiwei's comment - With "notation inspect < repo/individual-signature-digest >" how do we know whether it is a manifest of a signature or a signed artifact? Since there is an ambiguity, will need the right customer experience approach.

Included a message output as follows for the signed artifact "Inspecting all signatures for signed artifact"
Include a message output as follows for the signature "Inspecting signature".
Additional "mediaType" field in JSON which will depict if it is a signed artifact or signature.
This spec only talks about signed artifact hence signature level inspect is not defined yet.

yizha1 · 2023-01-13T02:56:49Z

notation inspect individual-signature-digest

Maybe it is more intuitive to introduce a flag later for single signature

notation inspect --signature <individual-signature-digest>

specs/commandline/inspect.md

vaninrao10 · 2023-01-13T14:27:07Z

notation inspect individual-signature-digest

Maybe it is more intuitive to introduce a flag later for single signature

notation inspect --signature <individual-signature-digest>

Added the comment in the new issue so we dont lose this comment.

specs/commandline/inspect.md

Changes to the review - Signed-off-by: Vani Rao <vaninrao@amazon.com> Signed-off-by: vaninrao10 <111005862+vaninrao10@users.noreply.github.com>

to the new branch - Signed-off-by: Vani Rao <vaninrao@amazon.com> Signed-off-by: vaninrao10 <111005862+vaninrao10@users.noreply.github.com>

…azon.com>and Feynman Update the comments from Shiwei. Signed-off-by: Vani Rao <vaninrao@amazon.com>and Feynman Signed-off-by: vaninrao10 <111005862+vaninrao10@users.noreply.github.com>

Cert Chain added - Signed-off-by: Vani Rao <vaninrao@amazon.com> Signed-off-by: vaninrao10 <111005862+vaninrao10@users.noreply.github.com>

Vertical lines added - Signed-off-by: Vani Rao <vaninrao@amazon.com> Signed-off-by: vaninrao10 <111005862+vaninrao10@users.noreply.github.com>

….com> Vertical lines format change Signed-off-by: Vani Rao <vaninrao@amazon.com> Signed-off-by: vaninrao10 <111005862+vaninrao10@users.noreply.github.com>

…igned artifact passed in the inspect command - Signed-off-by: Vani Rao <vaninrao@amazon.com> Resolved the ambiguity whether it is a manifest of a signature or a signed artifact passed in the inspect command - Signed-off-by: Vani Rao <vaninrao@amazon.com> Signed-off-by: vaninrao10 <111005862+vaninrao10@users.noreply.github.com>

…@amazon.com> Shiweis small changes w.r.t space - Signed-off-by: Vani Rao <vaninrao@amazon.com> Signed-off-by: vaninrao10 <111005862+vaninrao10@users.noreply.github.com>

Caption change Signed-off-by: Vani Rao <vaninrao@amazon.com> Signed-off-by: vaninrao10 <111005862+vaninrao10@users.noreply.github.com>

FeynmanZhou

LGTM.

shizhMSFT

LGTM

yizha1

LGTM, a little bit later, but I want to share my opinions. @vaninrao10 Thanks Vani, you did a great job.

Use Case / Scenarios: - Troubleshooting - Auditing - If verification of the image digest / signature digest fails due towrong certificate configuration, user will execute the inspect commandto extract the certificate thumb print, a hash of a certificate which is a unique identifier for certificates. Signed-off-by: vaninrao10 <111005862+vaninrao10@users.noreply.github.com>

vaninrao10 force-pushed the vani-branch-2 branch from 4a5f366 to 12a77ab Compare January 5, 2023 21:21

vaninrao10 requested a review from iamsamirzon January 5, 2023 21:21

iamsamirzon approved these changes Jan 5, 2023

View reviewed changes

vaninrao10 requested review from shizhMSFT and yizha1 January 5, 2023 21:29

vaninrao10 changed the title ~~Notation Inspect Command line Spec~~ doc: notation Inspect Command line Spec Jan 6, 2023

shizhMSFT reviewed Jan 9, 2023

View reviewed changes

shizhMSFT requested review from FeynmanZhou and priteshbandi January 9, 2023 13:41

shizhMSFT added this to the RC-2 milestone Jan 9, 2023

shizhMSFT added the documentation Improvements or additions to documentation label Jan 9, 2023

shizhMSFT assigned vaninrao10 Jan 9, 2023

FeynmanZhou reviewed Jan 9, 2023

View reviewed changes

specs/commandline/inspect.md Show resolved Hide resolved

FeynmanZhou reviewed Jan 9, 2023

View reviewed changes

vaninrao10 force-pushed the vani-branch-2 branch from 646da2f to 3f6528b Compare January 11, 2023 00:04

shizhMSFT reviewed Jan 11, 2023

View reviewed changes

specs/commandline/inspect.md Outdated Show resolved Hide resolved

specs/commandline/inspect.md Show resolved Hide resolved

specs/commandline/inspect.md Outdated Show resolved Hide resolved

specs/commandline/inspect.md Outdated Show resolved Hide resolved

vaninrao10 force-pushed the vani-branch-2 branch from 8c07c19 to 1c7f94a Compare January 12, 2023 00:18

priteshbandi approved these changes Jan 12, 2023

View reviewed changes

shizhMSFT reviewed Jan 12, 2023

View reviewed changes

vaninrao10 force-pushed the vani-branch-2 branch from 74aa57d to d797f5c Compare January 12, 2023 16:12

priteshbandi reviewed Jan 12, 2023

View reviewed changes

specs/commandline/inspect.md Outdated Show resolved Hide resolved

priteshbandi approved these changes Jan 12, 2023

View reviewed changes

vaninrao10 force-pushed the vani-branch-2 branch from aa9f007 to d71c6f9 Compare January 12, 2023 20:34

priteshbandi mentioned this pull request Jan 12, 2023

doc: notation Inspect Command line Spec - Phase 2 #506

Open

vaninrao10 force-pushed the vani-branch-2 branch from 25c03c7 to 83c18f5 Compare January 12, 2023 20:54

shizhMSFT reviewed Jan 13, 2023

View reviewed changes

vaninrao10 force-pushed the vani-branch-2 branch from fe259dd to 9c02e43 Compare January 13, 2023 14:37

shizhMSFT reviewed Jan 13, 2023

View reviewed changes

specs/commandline/inspect.md Outdated Show resolved Hide resolved

vaninrao10 added 9 commits January 13, 2023 10:03

Changes to the review - Signed-off-by: Vani Rao <vaninrao@amazon.com>

190dbbe

Changes to the review - Signed-off-by: Vani Rao <vaninrao@amazon.com> Signed-off-by: vaninrao10 <111005862+vaninrao10@users.noreply.github.com>

to the new branch - Signed-off-by: Vani Rao <vaninrao@amazon.com>

64f03f0

to the new branch - Signed-off-by: Vani Rao <vaninrao@amazon.com> Signed-off-by: vaninrao10 <111005862+vaninrao10@users.noreply.github.com>

Update the comments from Shiwei. Signed-off-by: Vani Rao <vaninrao@am…

d3f2928

…azon.com>and Feynman Update the comments from Shiwei. Signed-off-by: Vani Rao <vaninrao@amazon.com>and Feynman Signed-off-by: vaninrao10 <111005862+vaninrao10@users.noreply.github.com>

Cert Chain added - Signed-off-by: Vani Rao <vaninrao@amazon.com>

2a88a9e

Cert Chain added - Signed-off-by: Vani Rao <vaninrao@amazon.com> Signed-off-by: vaninrao10 <111005862+vaninrao10@users.noreply.github.com>

Vertical lines added - Signed-off-by: Vani Rao <vaninrao@amazon.com>

10dd5a1

Vertical lines added - Signed-off-by: Vani Rao <vaninrao@amazon.com> Signed-off-by: vaninrao10 <111005862+vaninrao10@users.noreply.github.com>

Vertical lines format change Signed-off-by: Vani Rao <vaninrao@amazon…

10e803a

….com> Vertical lines format change Signed-off-by: Vani Rao <vaninrao@amazon.com> Signed-off-by: vaninrao10 <111005862+vaninrao10@users.noreply.github.com>

Shiweis small changes w.r.t space - Signed-off-by: Vani Rao <vaninrao…

54976ed

…@amazon.com> Shiweis small changes w.r.t space - Signed-off-by: Vani Rao <vaninrao@amazon.com> Signed-off-by: vaninrao10 <111005862+vaninrao10@users.noreply.github.com>

Caption change Signed-off-by: Vani Rao <vaninrao@amazon.com>

a7901f1

Caption change Signed-off-by: Vani Rao <vaninrao@amazon.com> Signed-off-by: vaninrao10 <111005862+vaninrao10@users.noreply.github.com>

vaninrao10 force-pushed the vani-branch-2 branch from 4142bd8 to a7901f1 Compare January 13, 2023 15:03

FeynmanZhou approved these changes Jan 13, 2023

View reviewed changes

shizhMSFT approved these changes Jan 13, 2023

View reviewed changes

priteshbandi merged commit 1281179 into notaryproject:main Jan 13, 2023

yizha1 reviewed Jan 14, 2023

View reviewed changes

Conversation

vaninrao10 commented Jan 5, 2023

Uh oh!

shizhMSFT commented Jan 6, 2023

Uh oh!

iamsamirzon commented Jan 6, 2023

Uh oh!

shizhMSFT commented Jan 6, 2023

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

FeynmanZhou left a comment

Choose a reason for hiding this comment

Uh oh!

codecov-commenter commented Jan 11, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

priteshbandi left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

priteshbandi left a comment

Choose a reason for hiding this comment

Uh oh!

vaninrao10 commented Jan 12, 2023

Uh oh!

yizha1 commented Jan 13, 2023

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

vaninrao10 commented Jan 13, 2023

Uh oh!

Uh oh!

FeynmanZhou left a comment

Choose a reason for hiding this comment

Uh oh!

shizhMSFT left a comment

Choose a reason for hiding this comment

Uh oh!

yizha1 left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

codecov-commenter commented Jan 11, 2023 •

edited

Loading