README
¶
Notation
Notation is a CLI project to add signatures as standard items in the OCI registry ecosystem, and to build a set of simple tooling for signing and verifying these signatures. This should be viewed as similar security to checking git commit signatures, although the signatures are generic and can be used for additional purposes. Notation is an implementation of the Notary Project specifications.
You can find the Notary Project README to learn about the overall Notary Project.
[!NOTE] The documentation for installing Notation CLI is available here.
Table of Contents
Quick Start
- Quick start: Sign and validate a container image
- Try out Notation in this Killercoda interactive sandbox environment
- Build, sign, and verify container images using Notation with Azure Key Vault or AWS Signer
Community
Notary Project is a CNCF Incubating project. We ❤ your contribution.
Development and Contributing
- Build Notation from source code
- Governance for Notary Project
- Maintainers and reviewers list
- Regular conversations for Notary Project occur on the Cloud Native Computing Slack notary-project channel.
Notary Project Community Meeting
- Mondays 5-6 PM PDT, 4-5 PM PST, 8-9 PM EDT, 7-8 PM EST, 8-9 AM Shanghai
- Thursdays 9-10 AM PDT, 8-9 AM PST, 12 PM EDT, 11 AM EST, 5 PM UK
Join us at Zoom Dial-in link / Passcode: 77777. Please see the CNCF Calendar for community meeting details. Meeting notes are captured on hackmd.io.
Release Management
The Notation release process is defined in RELEASE_MANAGEMENT.md.
Support
Support for the Notation project is defined in supported releases.
Code of Conduct
This project has adopted the CNCF Code of Conduct. See CODE_OF_CONDUCT.md for further details.
License
This project is covered under the Apache 2.0 license. You can read the license here.
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
notation
command
|
|
|
notation/blob
Package blob provides the implementation of the `notation blob` command
|
Package blob provides the implementation of the `notation blob` command |
|
notation/blob/policy
Package policy provides the import and show commands for blob trust policy.
|
Package policy provides the import and show commands for blob trust policy. |
|
notation/internal/display
Package display provides functionalities for command printouts.
|
Package display provides functionalities for command printouts. |
|
notation/internal/display/metadata
Package metadata defines interfaces for handlers that render metadata information for each command.
|
Package metadata defines interfaces for handlers that render metadata information for each command. |
|
notation/internal/display/metadata/text
Package text provides the text output in human-readable format for metadata information.
|
Package text provides the text output in human-readable format for metadata information. |
|
notation/internal/display/output
Package output provides functionalities of displaying command printouts.
|
Package output provides functionalities of displaying command printouts. |
|
notation/internal/flag
Package flag contains common flags for all commands.
|
Package flag contains common flags for all commands. |
|
notation/internal/sign
Package sign provides utility methods related to sign commands.
|
Package sign provides utility methods related to sign commands. |
|
notation/internal/verify
Package verify provides utility methods related to verification commands.
|
Package verify provides utility methods related to verification commands. |
|
internal
|
|
|
config
Package config provides utility methods related to Notation config.json.
|
Package config provides utility methods related to Notation config.json. |