feat: add support for signed user metadata in notation sign and verify cmds by byronchien · Pull Request #507 · notaryproject/notation

byronchien · 2023-01-13T01:33:22Z

Adds support for signed user metadata in notation sign and notation verify. Relevant spec

This PR depends on notaryproject/notation-go#242 please review notation-go/pull/242 first

example sign usage:

chienb@a07817b52895 notation % notation sign $IMAGE --user-metadata io.wabbit-networks.buildId=123 --user-metadata io.wabbit-networks.buildTime=123
Warning: Always sign the artifact using digest(`@sha256:...`) rather than a tag(`:v1`) because tags are mutable and a tag reference can point to a different artifact than the one signed.
Resolved artifact tag `v1` to digest `sha256:5a07385af4e6b6af81b0ebfd435aedccdfa3507f0609c658209e1aba57159b2b` before signing.
Successfully signed localhost:5000/net-monitor@sha256:5a07385af4e6b6af81b0ebfd435aedccdfa3507f0609c658209e1aba57159b2b

example metadata displayed on verification (without metadata flag)

chienb@a07817b52895 notation % notation verify $IMAGE
Resolved artifact tag `v1` to digest `sha256:5a07385af4e6b6af81b0ebfd435aedccdfa3507f0609c658209e1aba57159b2b` before verification.
Warning: The resolved digest may not point to the same signed artifact, since tags are mutable.
Successfully verified signature for localhost:5000/net-monitor@sha256:5a07385af4e6b6af81b0ebfd435aedccdfa3507f0609c658209e1aba57159b2b

The artifact was signed with the following user metadata.

KEY                          VALUE
io.wabbit-networks.buildTime   123
io.wabbit-networks.buildId     123

example verification:

chienb@a07817b52895 notation % notation verify $IMAGE --user-metadata io.wabbit-networks.buildTime=123
Resolved artifact tag `v1` to digest `sha256:5a07385af4e6b6af81b0ebfd435aedccdfa3507f0609c658209e1aba57159b2b` before verification.
Warning: The resolved digest may not point to the same signed artifact, since tags are mutable.
Successfully verified signature for localhost:5000/net-monitor@sha256:5a07385af4e6b6af81b0ebfd435aedccdfa3507f0609c658209e1aba57159b2b

The artifact was signed with the following user metadata.

KEY                            VALUE
io.wabbit-networks.buildTime   123
io.wabbit-networks.buildId     123

example verification failure

chienb@a07817b52895 notation % notation verify $IMAGE --user-metadata foo=bar
Resolved artifact tag `v1` to digest `sha256:5a07385af4e6b6af81b0ebfd435aedccdfa3507f0609c658209e1aba57159b2b` before verification.
Warning: The resolved digest may not point to the same signed artifact, since tags are mutable.
Error: signature verification failed: signature verification failed

Not in this PR: error messaging. In the spec update, we mentioned that there should be an error message if the verification fails due to the metadata not being present, but if there are multiple verifications that fail for different reasons, is there a desired order to prioritize the what the end error message displayed is?

Signed-off-by: Byron Chien chienb@amazon.com

Signed-off-by: Byron Chien <chienb@amazon.com>

byronchien · 2023-01-13T01:33:48Z

related: notaryproject/notation-go#242

internal/cmd/flags.go

cmd/notation/verify.go

Signed-off-by: Byron Chien <chienb@amazon.com>

cmd/notation/sign.go

cmd/notation/verify.go

priteshbandi

LGTM

JeyJeyGao · 2023-02-01T04:48:42Z

The pipeline was failed. Please update the code.

priteshbandi · 2023-02-01T18:10:11Z

The pipeline was failed. Please update the code.

This PR depends on notaryproject/notation-go#242 and that's the reason build is failing.

@JeyJeyGao In the spirit of expediting the rc2 release, can you please review the code, we can make a small update when notaryproject/notation-go#242 is merged ?

patrickzheng200

LGTM with one comment.

cmd/notation/sign.go

patrickzheng200

LGTM

Signed-off-by: Byron Chien <chienb@amazon.com>

Co-authored-by: Patrick Zheng <patrickzheng@microsoft.com> Signed-off-by: Byron Chien <chienb@amazon.com>

Signed-off-by: Byron Chien <chienb@amazon.com>

internal/cmd/flags.go

cmd/notation/verify.go

Signed-off-by: Byron Chien <chienb@amazon.com>

yizha1 · 2023-02-07T07:41:20Z

@byronchien could you fix the conflict?

byronchien · 2023-02-07T18:25:11Z

resolved conflict

Signed-off-by: Byron Chien <chienb@amazon.com>

codecov-commenter · 2023-02-08T17:15:22Z

Codecov Report

❌ Patch coverage is 5.26316% with 36 lines in your changes missing coverage. Please review.
✅ Project coverage is 36.06%. Comparing base (5c27944) to head (de7057b).
⚠️ Report is 417 commits behind head on main.

Files with missing lines	Patch %	Lines
cmd/notation/verify.go	5.26%	18 Missing ⚠️
cmd/notation/sign.go	5.55%	17 Missing ⚠️
cmd/notation/key.go	0.00%	1 Missing ⚠️

❌ Your project status has failed because the head coverage (36.06%) is below the target coverage (70.00%). You can increase the head coverage or adjust the target coverage.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #507      +/-   ##
==========================================
+ Coverage   35.15%   36.06%   +0.90%     
==========================================
  Files          29       29              
  Lines        1502     1528      +26     
==========================================
+ Hits          528      551      +23     
- Misses        955      958       +3     
  Partials       19       19

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

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

…y cmds (notaryproject#507) Adds support for signed user metadata in `notation sign` and `notation verify`. [Relevant spec](notaryproject#498) example sign usage: chienb@a07817b52895 notation % notation sign $IMAGE --user-metadata io.wabbit-networks.buildId=123 --user-metadata io.wabbit-networks.buildTime=123 Successfully signed localhost:5000/net-monitor@sha256:5a07385af4e6b6af81b0ebfd435aedccdfa3507f0609c658209e1aba57159b2b --------------- example verification: chienb@a07817b52895 notation % notation verify $IMAGE --user-metadata io.wabbit-networks.buildTime=123 Resolved artifact tag `v1` to digest `sha256:5a07385af4e6b6af81b0ebfd435aedccdfa3507f0609c658209e1aba57159b2b` before verification. Warning: The resolved digest may not point to the same signed artifact, since tags are mutable. Successfully verified signature for localhost:5000/net-monitor@sha256:5a07385af4e6b6af81b0ebfd435aedccdfa3507f0609c658209e1aba57159b2b The artifact was signed with the following user metadata. KEY VALUE io.wabbit-networks.buildTime 123 io.wabbit-networks.buildId 123 ----- Signed-off-by: Byron Chien <chienb@amazon.com>

Adds additional flag and passes values to notation-go

0488b33

Signed-off-by: Byron Chien <chienb@amazon.com>

byronchien mentioned this pull request Jan 13, 2023

feat: add support for signed user metadata notaryproject/notation-go#242

Merged

priteshbandi requested review from patrickzheng200, priteshbandi and shizhMSFT and removed request for patrickzheng200 January 13, 2023 09:08

priteshbandi reviewed Jan 13, 2023

View reviewed changes

internal/cmd/flags.go Outdated Show resolved Hide resolved

cmd/notation/verify.go Outdated Show resolved Hide resolved

cmd/notation/verify.go Outdated Show resolved Hide resolved

Fix usage, add error message

e0c5113

Signed-off-by: Byron Chien <chienb@amazon.com>

priteshbandi reviewed Jan 18, 2023

View reviewed changes

cmd/notation/sign.go Show resolved Hide resolved

cmd/notation/verify.go Outdated Show resolved Hide resolved

priteshbandi reviewed Jan 19, 2023

View reviewed changes

priteshbandi approved these changes Jan 19, 2023

View reviewed changes

priteshbandi changed the title ~~Adds additional flag and passes values to notation-go~~ Adds support for signed user metadata in notation sign and verify cmds Feb 1, 2023

patrickzheng200 reviewed Feb 2, 2023

View reviewed changes

cmd/notation/sign.go Outdated Show resolved Hide resolved

patrickzheng200 approved these changes Feb 3, 2023

View reviewed changes

byronchien and others added 5 commits February 6, 2023 16:23

Merge branch 'notaryproject:main' into attestations-impl

0160c8d

Signed-off-by: Byron Chien <chienb@amazon.com>

Ignore envelope parsing error and explain in comment

7e3e9e4

Signed-off-by: Byron Chien <chienb@amazon.com>

use RemoteSignOptions and fix verify error

5fa6511

Signed-off-by: Byron Chien <chienb@amazon.com>

Use embedded struct

9a54cbc

Signed-off-by: Byron Chien <chienb@amazon.com>

Update UserMetadata() usage

431ecbf

Signed-off-by: Byron Chien <chienb@amazon.com>

byronchien force-pushed the attestations-impl branch from 27396c8 to 5f040e0 Compare February 7, 2023 00:26

byronchien and others added 2 commits February 6, 2023 16:28

Update cmd/notation/sign.go

5ae32bb

Co-authored-by: Patrick Zheng <patrickzheng@microsoft.com> Signed-off-by: Byron Chien <chienb@amazon.com>

Fix RemoteSignOptions initialization

1c3cddf

Signed-off-by: Byron Chien <chienb@amazon.com>

byronchien force-pushed the attestations-impl branch from 5f040e0 to 1c3cddf Compare February 7, 2023 00:29

shizhMSFT reviewed Feb 7, 2023

View reviewed changes

internal/cmd/flags.go Show resolved Hide resolved

cmd/notation/verify.go Outdated Show resolved Hide resolved

Spacing nit, check metadata presence

2760660

Signed-off-by: Byron Chien <chienb@amazon.com>

shizhMSFT changed the title ~~Adds support for signed user metadata in notation sign and verify cmds~~ feat: add support for signed user metadata in notation sign and verify cmds Feb 8, 2023

byronchien and others added 2 commits February 8, 2023 08:27

Merge branch 'main' into attestations-impl

8b39d13

Signed-off-by: Byron Chien <chienb@amazon.com>

Use ParseFlagMap instead of ParseFlagPluginConfig

8b8ea52

Signed-off-by: Byron Chien <chienb@amazon.com>

byronchien force-pushed the attestations-impl branch from a5d4634 to 8b8ea52 Compare February 8, 2023 16:28

Update go.mod for notation-go changes

de7057b

Signed-off-by: Byron Chien <chienb@amazon.com>

priteshbandi merged commit 51951af into notaryproject:main Feb 8, 2023

Conversation

byronchien commented Jan 13, 2023 • edited by priteshbandi Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

byronchien commented Jan 13, 2023

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!

JeyJeyGao commented Feb 1, 2023

Uh oh!

priteshbandi commented Feb 1, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

patrickzheng200 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

patrickzheng200 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

yizha1 commented Feb 7, 2023

Uh oh!

byronchien commented Feb 7, 2023

Uh oh!

codecov-commenter commented Feb 8, 2023 • edited by codecov bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

byronchien commented Jan 13, 2023 •

edited by priteshbandi

Loading

priteshbandi commented Feb 1, 2023 •

edited

Loading

codecov-commenter commented Feb 8, 2023 •

edited by codecov bot

Loading