Add alternative TUF metadata repo implementation (WIP) #512
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
renatav
reviewed
Aug 23, 2024
Remove unused pyopenssl Signed-off-by: Lukas Puehringer <lukas.puehringer@nyu.edu>
Implements basic primitives, defined by the python-tuf Repository abstraction, to read and edit metadata on disk, handling version and expiry bumps, and signature creation, and facilitating snapshot and timestamp creation. And adds exemplary API methods that use these primitives while preserving consistent repo states: - create - add_target_files - add_keys Can be tested with: ``` PYTEST_DISABLE_PLUGIN_AUTOLOAD=1 pytest --noconftest taf/tests/tuf/ ``` More detailed usage docs + migration path TBD... Signed-off-by: Lukas Puehringer <lukas.puehringer@nyu.edu>
The original design aimed at separating the concepts of delegation (adding public keys) and signing (using private keys). Since the MetadataRepository assumes that metadata can be signed rightaway after edit (e.g. after having added a delegation), which in turn requires private keys to be available, we might as well conflate these two concepts. The advantage is that the signer cache does not have to be managed independently and is more likely to stay in sync with the delegations. Signed-off-by: Lukas Puehringer <lukas.puehringer@nyu.edu>
Signed-off-by: Lukas Puehringer <lukas.puehringer@nyu.edu>
This should really happen upstream (see linked issue) Signed-off-by: Lukas Puehringer <lukas.puehringer@nyu.edu>
YkSigner provides a minimal compatibility layer over `taf.yubikey`
module functions for use with MetadataRepository.
Even though a yubikey signer implementation (HSMSigner) based on
pykcs11 is available in securesystemslib, YkSigner was added for the
following reasons:
- TAF requires rsa support for yubikeys, but HSMSigner only supports
ecdsa. Adding rsa support to HSMSigner, or providing a custom
pykcs11-based RSAHSMSigner is feasible, and seems desirable, but
requires more effort than this YkSigner did.
- TAF provides a few additional features, like setting up a Yubikey,
changing pins, etc., which will not be added to securesystemslib.
This means the current Yubikey infrastructure based on yubikey-manager
needs to be preserved for the time being. Thus it made sense to
re-use the existing implementation for YkSigner.
- YkSigner show-cases the new Signer API and might be used as blue print
for future Signer implementations in TAF.
This commit adds basic tests with fake and real Yubikey:
```
REAL_YK=1 PYTEST_DISABLE_PLUGIN_AUTOLOAD=1 \
pytest --noconftest taf/tests/tuf/ taf/tests/tuf/test_yk.py -s
```
Signed-off-by: Lukas Puehringer <lukas.puehringer@nyu.edu>
This allows running previously added YkSigner tests, but breaks other things, which need change anyway in the course of upgrading to latest tuf/securesystemslib. Signed-off-by: Lukas Puehringer <lukas.puehringer@nyu.edu>
|
I just pushed See 42fbfac commit message for details. Notes about tests:
|
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.
Implements basic primitives, defined by the python-tuf Repository abstraction, to read and edit metadata on disk, handling version and expiry bumps, and signature creation, and facilitating snapshot and timestamp creation.
And adds exemplary API methods that use these primitives while preserving consistent repo states:
Can be tested with:
More details about the design, and recommendations for how to move on from here can be found in this Google doc.