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

Proposal for new folder structure for notaryproject/notaryproject #48

Open
yizha1 opened this issue Jul 26, 2023 · 1 comment
Open

Proposal for new folder structure for notaryproject/notaryproject #48

yizha1 opened this issue Jul 26, 2023 · 1 comment

Comments

@yizha1
Copy link
Contributor

yizha1 commented Jul 26, 2023

This issue is to track the proposal of new folder structure of issue #38.

The proposal from @toddysm is

  • Structure:
    • specifications repository
      • oci-signature-specification folder
        Those specifications are OCI specific and describe how the Notary Project Signing Scheme is applied to signatures stored in OCI registries. The folder contains the following documents:
        • Signature Specification referred to as "Notary Project OCI Signature Specification" or just "OCI Signature Specification" if the Notary Project reference is implied.
        • Signing and Verification Workflow referred to as "Notary Project OCI Signing and Verification Workflow" or just "OCI Signing and Verification Workflow" if the Notary Project reference is implied.
        • Signing Envelope COSE referred to as "Notary Project OCI COSE Envelope" or just "OCI COSE Envelope" if the Notary Project reference is implied. Ideally, we would like to have COSE envelope spec that is not specific to OCI.
        • Signing Envelope JWS referred to as "Notary Project OCI JWS Envelope" or just "OCI JWS Envelope" if the Notary Project reference is implied. Ideally, we would like to have JWS envelope spec that is not specific to OCI.
      • signing-scheme folder
        This specification is not specific to any storage and describes the supported signing schemes. Ideally any tool that supports those schemes should be able to produce signatures that are understood by Notary Project tools. Ideally, we would like to have non-OCI specific envelope specifications in this folder also. This folder contains the following documents:
        • Signing Scheme referred to as "Notary Project Signing Scheme" or just "Signing Scheme" if the Notary Project reference is implied.

In the future, this repository may contain specifications about identities, attestations, counter receipts, etc. depending on how the Notary Project evolves.

Comments received:

@FeynmanZhou #38 (comment)
@iamsamirzon #38 (comment)
@SteveLasker #38 (comment)

@yizha1
Copy link
Contributor Author

yizha1 commented Aug 1, 2023

One comment from @Two-Hearts on the file name of keymanagementrequirements.md, see details notaryproject/specifications#263 (comment), as part of folder structure and content, it could be addressed by this issue

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

No branches or pull requests

1 participant