|
1 |
| -## AWS Signer plugin for Notation |
| 1 | +## AWS Signer Plugin for Notation |
2 | 2 |
|
3 | 3 | [](https://github.com/aws/aws-signer-notation-plugin/actions/workflows/build.yml?query=workflow%3Abuild+event%3Apush+branch%3Amain)
|
4 | 4 | [](https://codecov.io/gh/aws/aws-signer-notation-plugin)
|
5 | 5 | [](https://pkg.go.dev/github.com/aws/aws-signer-notation-plugin@main)
|
6 | 6 |
|
7 |
| -TODO: Fill this README out! |
| 7 | +[Notation](https://github.com/notaryproject/notation) is an open source tool developed by the [Notary Project](https://notaryproject.dev/), which supports signing and verifying container images and other artifacts. The AWS Signer Notation plugin, allows users of Notation ([notation CLI](https://github.com/notaryproject/notation) and [notation-go](https://github.com/notaryproject/notation-go)) to sign and verify artifacts (such as container images) using AWS Signer. [AWS Signer](https://docs.aws.amazon.com/signer/latest/developerguide/Welcome.html) is a fully managed code-signing service to ensure the trust and integrity of your code. AWS Signer manages the code-signing certificates, secures private keys, and manages key rotation without requiring users to take any action. |
8 | 8 |
|
9 |
| -Be sure to: |
| 9 | +The plugin is compliant with the [Notary Project specification](https://github.com/notaryproject/specifications/tree/main). It uses the AWS Signer _SignPayload_ API for signing, and _GetRevocationStatus_ API for signature verification. |
10 | 10 |
|
11 |
| -* Change the title in this README |
12 |
| -* Edit your repository description on GitHub |
| 11 | +## Getting Started |
| 12 | +To use AWS Signer Notation plugin: |
13 | 13 |
|
14 |
| -## Security |
| 14 | +* Notation CLI - Please refer [AWS Signer documentation](https://docs.aws.amazon.com/signer/latest/developerguide/container-workflow.html) for guidance on signing and verifying OCI artifacts. |
| 15 | +* notation-go library - You can use this plugin as library with notation-go, eliminating the need for invoking plugin executable. Please refer the provided [examples](https://github.com/aws/aws-signer-notation-plugin/tree/main/examples) on how to use plugin as library with notation-go. |
15 | 16 |
|
16 |
| -See [CONTRIBUTING](CONTRIBUTING.md#security-issue-notifications) for more information. |
| 17 | +## Building from Source |
17 | 18 |
|
18 |
| -## License |
| 19 | +1. Install go. For more information, refer [go documentation](https://golang.org/doc/install). |
| 20 | +2. The plugin uses go modules for dependency management. For more information, refer [go modules](https://github.com/golang/go/wiki/Modules). |
| 21 | +3. Run `make build` to build the AWS Signer Notation plugin. |
| 22 | +4. Upon completion of the build process, the plugin executable will be created at `build/bin/notation-com.amazonaws.signer.notation.plugin`. |
| 23 | + |
| 24 | +Now you can use this plugin executable with notation CLI by using the following command: |
| 25 | + |
| 26 | +`notation plugin install --file ./build/bin/notation-com.amazonaws.signer.notation.plugin` |
| 27 | + |
| 28 | +### Make Targets |
| 29 | +The following targets are available. Each may be run with `make <target>`. |
19 | 30 |
|
20 |
| -This project is licensed under the Apache-2.0 License. |
| 31 | +| Make Target | Description | |
| 32 | +|:-----------------|:--------------------------------------------------------------------------------------| |
| 33 | +| `help` | shows available make targets | |
| 34 | +| `build` | builds the plugin executable for current environment (e.g. Linux, Darwin and Windows) | |
| 35 | +| `test` | runs all the unit tests using `go test` | |
| 36 | +| `generate-mocks` | generates the mocks required for unit tests | |
| 37 | +| `clean` | removes build artifacts and auto generated mocks. | |
| 38 | + |
| 39 | +## Security disclosures |
| 40 | +To report a potential security issue, please do not create a new Issue in the repository. Instead, please report using the instructions [here ](https://aws.amazon.com/security/vulnerability-reporting/) or email [AWS security directly ](mailto:[email protected]). |
| 41 | + |
| 42 | +## License |
| 43 | +This project is licensed under the [Apache-2.0](LICENSE) License. |
21 | 44 |
|
0 commit comments