Do not require key vault at start up time #442
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Previously a public key was used to fetch the related signer from keyvault to then extract that same public key from the signer and pass it to add_key. This can be shortened by passing the original public_key directly to add_key. Signed-off-by: Lukas Puehringer <[email protected]>
Add class to load and cache arbitrary securesystemslib Signer instances. Currently, signers are loaded from the configured KEYVAULT only. Compared to IKeyVault, SignerStore has a few advantages: - does not need to be subclassed to support different signer types - can easily be changed to load signers from other locations, than KEYVAULT, e.g. from a URI (see repository-service-tuf/repository-service-tuf#580) - supports lazy loading of signers Signed-off-by: Lukas Puehringer <[email protected]>
- Init IKeyVault only if RSTUF_KEYVAULT_BACKEND is set - Add meaningful error message, if RSTUF_KEYVAULT_BACKEND is needed (at signing time) but unset. Signed-off-by: Lukas Puehringer <[email protected]>
Signed-off-by: Lukas Puehringer <[email protected]>
Signed-off-by: Lukas Puehringer <[email protected]>
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #442 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 14 15 +1
Lines 1009 1025 +16
=========================================
+ Hits 1009 1025 +16 ☔ View full report in Codecov by Sentry. |
kairoaraujo
previously approved these changes
Jan 24, 2024
Signed-off-by: Lukas Puehringer <[email protected]>
kairoaraujo
approved these changes
Jan 24, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR allows starting the worker without key vault configuration. Unlike a previous attempt (#441), it does not change any specific key vault initialisation code, but instead skips key vault initialisation altogether, if the configuration is not provided.
In addition, the repository is updated to retrieve signers from a newly added signer store, instead of calling the key vault directly. Under the hood, the signer store does use the existing key vault, but only when needed. Moreover, this design makes it easier to provide a meaningful error message about missing config, again, only when needed.
Also note that in the future the signer store can easily be extended to fetch signers from other locations, e.g. URIs provided via public key metadata.
See commits for details!