# securesystemslib
[![CI](https://github.com/secure-systems-lab/securesystemslib/workflows/Run%20Securesystemslib%20tests/badge.svg)](https://github.com/secure-systems-lab/securesystemslib/actions?query=workflow%3A%22Run+Securesystemslib+tests%22+branch%3Amain)
[![Documentation Status](https://readthedocs.org/projects/python-securesystemslib/badge/?version=latest)](https://python-securesystemslib.readthedocs.io/en/latest/?badge=latest)
Securesystemslib is a cryptography interface for signing and verifying digital
signatures. It is developed for the [TUF](https://theupdateframework.io) and
[in-toto](https://in-toto.io) projects: the key and signature containers are
compatible with metadata formats from those projects.
Under the hood, Securesystemslib can use various digital signing systems
(e.g. [cryptography](https://pypi.org/project/cryptography/), PIV hardware keys
and multiple cloud-based key management systems).
## Installation
The default installation supports [pure-Python `ed25519` signature
verification](https://github.com/pyca/ed25519) only. To enable other schemes and
signature creation, `securesystemslib` can be installed with *extras*. See
[pyproject.toml](pyproject.toml) for available *optional dependencies*.
```bash
# Install with ed25519, RSA, ECDSA sign and verify support
pip install securesystemslib[crypto]
```
```bash
# ...or with HSM (e.g. Yubikey) support
pip install securesystemslib[hsm]
```
## Usage
[python-securesystemslib.readthedocs.io](https://python-securesystemslib.readthedocs.io)
## Contact
- Questions and discussions:
[`#securesystemslib-python`](https://cloud-native.slack.com/archives/C05PF3GA7AL)
on [CNCF Slack](https://communityinviter.com/apps/cloud-native/cncf)
- Security issues: see [Security policy](docs/SECURITY.md)
- Other issues and requests: [*Open a new
issue*](https://github.com/secure-systems-lab/securesystemslib/issues/new)
## Contribute
See [Instructions for contributors](docs/CONTRIBUTING.md).
## Legacy key migration
Use
[`migrate_keys`](https://github.com/secure-systems-lab/securesystemslib/blob/v0.31.0/docs/migrate_key.py)
script to convert key pairs generated with legacy `keys` or `interface` modules
to a consistent standard format, which is compatible with
[`CryptoSigner`](docs/CRYPTO_SIGNER.md). The script requires
`securesystemslib~=0.31.0`.
Raw data
{
"_id": null,
"home_page": null,
"name": "securesystemslib",
"maintainer": null,
"docs_url": null,
"requires_python": "~=3.8",
"maintainer_email": null,
"keywords": "cryptography, ecdsa, ed25519, keys, rsa, signatures",
"author": null,
"author_email": "\"https://www.updateframework.com\" <theupdateframework@googlegroups.com>",
"download_url": "https://files.pythonhosted.org/packages/80/f5/242b9e3186cdb462dfa7d8bc6a7f8f2332edbcb588cbf27eafc4a0a12674/securesystemslib-1.0.0.tar.gz",
"platform": null,
"description": "# securesystemslib\n\n[![CI](https://github.com/secure-systems-lab/securesystemslib/workflows/Run%20Securesystemslib%20tests/badge.svg)](https://github.com/secure-systems-lab/securesystemslib/actions?query=workflow%3A%22Run+Securesystemslib+tests%22+branch%3Amain)\n[![Documentation Status](https://readthedocs.org/projects/python-securesystemslib/badge/?version=latest)](https://python-securesystemslib.readthedocs.io/en/latest/?badge=latest)\n\nSecuresystemslib is a cryptography interface for signing and verifying digital\nsignatures. It is developed for the [TUF](https://theupdateframework.io) and\n[in-toto](https://in-toto.io) projects: the key and signature containers are\ncompatible with metadata formats from those projects.\n\nUnder the hood, Securesystemslib can use various digital signing systems\n(e.g. [cryptography](https://pypi.org/project/cryptography/), PIV hardware keys\nand multiple cloud-based key management systems).\n\n## Installation\n\nThe default installation supports [pure-Python `ed25519` signature\nverification](https://github.com/pyca/ed25519) only. To enable other schemes and\nsignature creation, `securesystemslib` can be installed with *extras*. See\n[pyproject.toml](pyproject.toml) for available *optional dependencies*.\n\n```bash\n# Install with ed25519, RSA, ECDSA sign and verify support\npip install securesystemslib[crypto]\n```\n\n```bash\n# ...or with HSM (e.g. Yubikey) support\npip install securesystemslib[hsm]\n```\n\n## Usage\n[python-securesystemslib.readthedocs.io](https://python-securesystemslib.readthedocs.io)\n\n## Contact\n- Questions and discussions:\n [`#securesystemslib-python`](https://cloud-native.slack.com/archives/C05PF3GA7AL)\n on [CNCF Slack](https://communityinviter.com/apps/cloud-native/cncf)\n- Security issues: see [Security policy](docs/SECURITY.md)\n- Other issues and requests: [*Open a new\n issue*](https://github.com/secure-systems-lab/securesystemslib/issues/new)\n\n## Contribute\nSee [Instructions for contributors](docs/CONTRIBUTING.md).\n\n## Legacy key migration\n\nUse\n[`migrate_keys`](https://github.com/secure-systems-lab/securesystemslib/blob/v0.31.0/docs/migrate_key.py)\nscript to convert key pairs generated with legacy `keys` or `interface` modules\nto a consistent standard format, which is compatible with\n[`CryptoSigner`](docs/CRYPTO_SIGNER.md). The script requires\n`securesystemslib~=0.31.0`.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A library that provides cryptographic and general-purpose routines for Secure Systems Lab projects at NYU",
"version": "1.0.0",
"project_urls": {
"Homepage": "https://github.com/secure-systems-lab/securesystemslib",
"Issues": "https://github.com/secure-systems-lab/securesystemslib/issues",
"Source": "https://github.com/secure-systems-lab/securesystemslib"
},
"split_keywords": [
"cryptography",
" ecdsa",
" ed25519",
" keys",
" rsa",
" signatures"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "621bb7e749c4ff64518a7d4dbabe4f7aba9e66c52b2e374f56575130ad7bb8b2",
"md5": "e3df5b08f61be0583f49d89ea96cd21c",
"sha256": "a6d118c24eae8227a1cf2d9c173f47956709958f601eeaa38e86f6505a31455e"
},
"downloads": -1,
"filename": "securesystemslib-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e3df5b08f61be0583f49d89ea96cd21c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "~=3.8",
"size": 871048,
"upload_time": "2024-05-02T11:01:27",
"upload_time_iso_8601": "2024-05-02T11:01:27.145998Z",
"url": "https://files.pythonhosted.org/packages/62/1b/b7e749c4ff64518a7d4dbabe4f7aba9e66c52b2e374f56575130ad7bb8b2/securesystemslib-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "80f5242b9e3186cdb462dfa7d8bc6a7f8f2332edbcb588cbf27eafc4a0a12674",
"md5": "d1dbe3c7af498e27e287d1c4d240ac20",
"sha256": "50f5053e274066502da7785dfd12b21e61131ca6e8b57ecedd2da0d1e9cd66c1"
},
"downloads": -1,
"filename": "securesystemslib-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "d1dbe3c7af498e27e287d1c4d240ac20",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "~=3.8",
"size": 934573,
"upload_time": "2024-05-02T11:01:29",
"upload_time_iso_8601": "2024-05-02T11:01:29.886604Z",
"url": "https://files.pythonhosted.org/packages/80/f5/242b9e3186cdb462dfa7d8bc6a7f8f2332edbcb588cbf27eafc4a0a12674/securesystemslib-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-02 11:01:29",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "secure-systems-lab",
"github_project": "securesystemslib",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"requirements": [],
"tox": true,
"lcname": "securesystemslib"
}