Skip to content

Proposal for new folder structure for notaryproject/notaryproject #48

@yizha1

Description

@yizha1

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)

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions