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.

Sign up for GitHub

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

docs: Remove pre 1.0.0 disclaimers #802

Merged
merged 1 commit into from
Apr 30, 2024
Merged

docs: Remove pre 1.0.0 disclaimers #802

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletions docs/signer.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Signer API

.. currentmodule:: securesystemslib.signer

The signer module provides a simple and unified cryptographic signing and signature verification API designed to work consistently regardless of the underlying signing technology. This is achieved with abstract interfaces backed by multiple implementations:
The signer module provides a simple and unified cryptographic signing and signature verification API designed to work consistently regardless of the underlying signing technology. This is achieved with abstract interfaces backed by multiple implementations:

* ``Signer.sign``
* ``Key.verify_signature``
Expand Down Expand Up @@ -59,8 +59,7 @@ which may happen on different systems and at different points in time:

4. **Verify**, given a configured public key

.. warning::
The API is experimental and may change without warning in versions ``<1.0.0``.
.. note::

See `'New Signer API' <https://theupdateframework.github.io/python-tuf/2023/01/24/securesystemslib-signer-api.html>`_ blog post
for background infos.
Expand Down
3 changes: 0 additions & 3 deletions securesystemslib/dsse.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,9 +116,6 @@ def sign(self, signer: Signer) -> Signature:
def verify(self, keys: List[Key], threshold: int) -> Dict[str, Key]:
"""Verify the payload with the provided Keys.

NOTE: This API is experimental and might change (see
secure-systems-lab/dsse#55)

Arguments:
keys: A list of public keys to verify the signatures.
threshold: Number of signatures needed to pass the verification.
Expand Down