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

Remove legacy interfaces/implementation #731

Closed
lukpueh opened this issue Feb 7, 2024 · 3 comments
Closed

Remove legacy interfaces/implementation #731

lukpueh opened this issue Feb 7, 2024 · 3 comments
Labels
contribfest Issues for KubeCon EU contribfest discussion Issues that require discussion

Comments

@lukpueh
Copy link
Member

lukpueh commented Feb 7, 2024

The lack of a clear API in securesystemslib has been described in #270 (also see below for related issues).

The new Signer API (secureystemslib.signer) provides a by far more powerful replacement API for signing and verifying digital signatures.

This issue calls for the removal of legacy interfaces/implementation, in order to finalise securesystemslib's transition to the Signer API.

IMPORTANT: The removal and a subsequent release must be coordinated with securesystemslib users, most notably in-toto, python-tuf, and RSTUF. cc @adityasaky, @SantiagoTorres, @trishankatdatadog, @jku, @joshuagl, @kairoaraujo, @MVrachev.

Modules to remove

  • keys.py
  • {rsa, ecdsa, ed25519}_keys.py
  • interface.py
  • schema.py
  • _sslib_signer.py
  • settings.py

Other

  • formats.py (remove all but encode_canonical)
  • remove deprecated methods in SSlibKey

Maybe revise

  • util.py (e.g. #245)
  • hash.py
  • storage.py (consider move to python-tuf)

closes #183, #172 #219, #270, #280, #286, #309, #310, #367

@jku
Copy link
Collaborator

jku commented Feb 7, 2024

cc @woodruffw: This should have no effect on sigstore-python (as encode_canonical() remains available) but FYI.

@woodruffw
Copy link
Contributor

Thanks for the heads up!

@lukpueh lukpueh added discussion Issues that require discussion contribfest Issues for KubeCon EU contribfest labels Mar 14, 2024
lukpueh added a commit to lukpueh/securesystemslib that referenced this issue Apr 10, 2024
In preparation for the removal of legacy key interfaces and formats
(secure-systems-lab#731), we provided a key file migration script in docs/ (secure-systems-lab#658).

The script itself uses the legacy interfaces and thus should be removed
from the current git tree together with them.

This patch removes the script, including tests and test data, but keeps
a tagged reference in the README, so that it can still be used with the
pre-legacy-removal version of securesystemslib.

Signed-off-by: Lukas Puehringer <lukas.puehringer@nyu.edu>
@lukpueh
Copy link
Member Author

lukpueh commented Apr 19, 2024

Maybe revise

  • hash.py
  • storage.py (consider move to python-tuf)

That's all what's left here. I suggest to move the discussion to #270 and close here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
contribfest Issues for KubeCon EU contribfest discussion Issues that require discussion
Projects
None yet
Development

No branches or pull requests

3 participants