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

Finalize reserved prefix for annotation keys to store notary specific metadata in signature envelope. #106

Closed
priteshbandi opened this issue Oct 15, 2021 · 4 comments · Fixed by #142

Comments

@priteshbandi
Copy link
Contributor

priteshbandi commented Oct 15, 2021

We need to finalize notary v2 reserved prefix for annotation keys to store notary specific metadata.
See #102

once we have finalized the prefix please update signature-specification.md > Payload section with following blurb.

The prefix `TBD` is reserved for use in Notary v2 and MUST NOT be used outside this specification. In Notary v2 annotations are being used to store signed attributes

Resources: https://github.com/opencontainers/image-spec/blob/main/annotations.md#rules

@priteshbandi priteshbandi changed the title Finalize annotations for descriptor in signature payload. Finalize reserved prefix for annotation keys to store notary specific metadata in signature envelope. Oct 15, 2021
@SteveLasker
Copy link
Contributor

how about: org.cncf.notary.*
This follows the annotations convention under the image manifest
It's also aligned with org.cncf.oras.artifact.* from PR #82

@priteshbandi
Copy link
Contributor Author

org.cncf.notary.* sounds good to me. Is there any legal or any other formality required?

@jonjohnsonjr
Copy link

how about: org.cncf.notary.*

What relationship does notary have to the Christina Noble Children's Foundation?

@SteveLasker
Copy link
Contributor

I think what @jonjohnsonjr is trying to say is:

The image spec calls out a suggestion to use internet reverse namespaces for annotations. You might want to consider this reverse domain pattern...

  • Keys MUST be unique within this map, and best practice is to namespace the keys.
  • Keys SHOULD be named using a reverse domain notation - e.g. com.example.myKey.

We've been using the logical namespace of org.cncf.notary.* but this is confusing when you consider reverse domains, vs. logical ownership. While I don't think we'll have a true collision with the Christina Noble Chidren's Foundation, it's a good thing to cleanup.

How about io.cncf.notary

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 a pull request may close this issue.

3 participants