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

[User Story] - notation generates key and corresponding certificate for testing #252

Closed
5 tasks
yizha1 opened this issue Jul 19, 2022 · 5 comments · Fixed by #265
Closed
5 tasks

[User Story] - notation generates key and corresponding certificate for testing #252

yizha1 opened this issue Jul 19, 2022 · 5 comments · Fixed by #265
Assignees
Labels
enhancement New feature or request epic new work which requires one or more features, tasks, or issues to complete. user Story Scenario which drives value written as a user story
Milestone

Comments

@yizha1
Copy link
Contributor

yizha1 commented Jul 19, 2022

Summary

As a tester, I want to generate key and corresponding certificate to test notation signing and verifying features

Intended Outcome

  • An RSA key and corresponding self-signed certificate can be generated in an easy way.
  • Testers can sign OCI artifacts using the key with notation sign command
  • Testers can verify signed OCI artifacts against the self-signed certificate with notation verify command
  • The RSA key and corresponding self-signed certificate are stored locally. The directory structure should follow section Signing key store of Spec : Notation directory structure #167
  • multiple keys and certificates can be generated given different host names
  • Tester can select which key and certificate pair to test notation signing and verifying.
  • Tester can remove specific key and certificate pair when they are not used

Additional context
Tester could be developer or any person who is interested in notation project and want to try notation features.

Work items

  • Update notation CLI spec for this user story
  • Implementation of generating RSA keys and corresponding self-signed certificates
  • Implementation of removing specific key and certificate
  • Implementation of notation signing and verifying against testing keys and self-signed certificates
  • Implementation of directory structure for Key and certificates according to Signing key store section of Spec : Notation directory structure #167
@yizha1 yizha1 added enhancement New feature or request epic new work which requires one or more features, tasks, or issues to complete. user Story Scenario which drives value written as a user story labels Jul 19, 2022
@yizha1 yizha1 added this to the Discuss milestone Jul 19, 2022
@yizha1 yizha1 changed the title [User Story] - notation generates key and certificate for testing [User Story] - notation generates key and corresponding certificate for testing Jul 19, 2022
@SteveLasker
Copy link
Contributor

Just a note this work user story is important for our getting started scenarios.
Adopters need a quick and easy means to get started, without any dependency on a cloud provider.

@JeyJeyGao
Copy link
Contributor

JeyJeyGao commented Jul 20, 2022

I'm working on this work item. The generated keys & certs will be stored in {CONFIG}/notation/localkeys/.

Implementation of directory structure for Key and certificates according to Signing key store section of #167

But the {CONFIG}/notation/signingkeys.json doesn't exist now, signing key information is tracked in config.json, there will be a breaking change to split the config.json file. Is it another work item? Do we need to finish it in RC1, or just keep the current config.json structure? The config example is here. @SteveLasker @shizhMSFT

@shizhMSFT
Copy link
Contributor

@JeyJeyGao Yes, the config.json should be split into config.json and signingkeys.json. It will be another work item and is in the scope of RC.1 or before.

@yizha1
Copy link
Contributor Author

yizha1 commented Jul 30, 2022

One bug found here #259, which broke this feature.

@yizha1 yizha1 modified the milestones: Discuss, alpha-3 Jul 30, 2022
@yizha1 yizha1 moved this from Todo to In Progress in Notary Project Planning Board Jul 30, 2022
@shizhMSFT shizhMSFT linked a pull request Aug 2, 2022 that will close this issue
@iamsamirzon
Copy link
Contributor

@yizha1 - Please consider the changes going in this fix to not break the "directory structure" based trust store and verification experience spec. Rakesh is working on notaryproject/notation-go#95

Repository owner moved this from In Progress to Done in Notary Project Planning Board Aug 5, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request epic new work which requires one or more features, tasks, or issues to complete. user Story Scenario which drives value written as a user story
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

5 participants