Skip to content

Commit

Permalink
signer: deprecate SSlibSigner and sslib keydict
Browse files Browse the repository at this point in the history
Signed-off-by: Lukas Puehringer <[email protected]>
  • Loading branch information
lukpueh committed Aug 10, 2023
1 parent f021d8b commit 9ddde6d
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 2 deletions.
12 changes: 10 additions & 2 deletions securesystemslib/signer/_key.py
Original file line number Diff line number Diff line change
Expand Up @@ -192,7 +192,11 @@ class SSlibKey(Key):
"""Key implementation for RSA, Ed25519, ECDSA keys"""

def to_securesystemslib_key(self) -> Dict[str, Any]:
"""Internal helper, returns a classic securesystemslib keydict"""
"""Internal helper, returns a classic securesystemslib keydict.
.. deprecated:: 0.28.0
Please use ``CryptoSigner`` instead of securesystemslib keydicts.
"""
return {
"keyid": self.keyid,
"keytype": self.keytype,
Expand All @@ -202,7 +206,11 @@ def to_securesystemslib_key(self) -> Dict[str, Any]:

@classmethod
def from_securesystemslib_key(cls, key_dict: Dict[str, Any]) -> "SSlibKey":
"""Constructor from classic securesystemslib keydict"""
"""Constructor from classic securesystemslib keydict
.. deprecated:: 0.28.0
Please use ``CryptoSigner`` instead of securesystemslib keydicts.
"""
# ensure possible private keys are not included in keyval
return SSlibKey(
key_dict["keyid"],
Expand Down
3 changes: 3 additions & 0 deletions securesystemslib/signer/_sslib_signer.py
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,9 @@ class SSlibSigner(Signer):
key_dict:
A securesystemslib-style key dictionary. This is an implementation
detail, not part of public API
.. deprecated:: 0.28.0
Please use ``CryptoSigner`` instead.
"""

ENVVAR_URI_SCHEME = "envvar"
Expand Down

0 comments on commit 9ddde6d

Please sign in to comment.