|
- Metadata-Version: 2.4
- Name: python-jose
- Version: 3.5.0
- Summary: JOSE implementation in Python
- Home-page: http://github.com/mpdavis/python-jose
- Author: Michael Davis
- Author-email: mike.philip.davis@gmail.com
- License: MIT
- Project-URL: Documentation, https://python-jose.readthedocs.io/en/latest/
- Project-URL: Source, https://github.com/mpdavis/python-jose/
- Project-URL: Tracker, https://github.com/mpdavis/python-jose/issues/
- Project-URL: Changelog, https://github.com/mpdavis/python-jose/blob/master/CHANGELOG.md
- Keywords: jose jws jwe jwt json web token security signing
- Classifier: Development Status :: 5 - Production/Stable
- Classifier: Intended Audience :: Developers
- Classifier: Natural Language :: English
- Classifier: License :: OSI Approved :: MIT License
- Classifier: Programming Language :: Python
- Classifier: Programming Language :: Python :: 3
- Classifier: Programming Language :: Python :: 3 :: Only
- Classifier: Programming Language :: Python :: 3.9
- Classifier: Programming Language :: Python :: 3.10
- Classifier: Programming Language :: Python :: 3.11
- Classifier: Programming Language :: Python :: 3.12
- Classifier: Programming Language :: Python :: 3.13
- Classifier: Programming Language :: Python :: Implementation :: PyPy
- Classifier: Topic :: Utilities
- Requires-Python: >=3.9
- License-File: LICENSE
- Requires-Dist: ecdsa!=0.15
- Requires-Dist: rsa!=4.1.1,!=4.4,<5.0,>=4.0
- Requires-Dist: pyasn1>=0.5.0
- Provides-Extra: test
- Requires-Dist: pytest; extra == "test"
- Requires-Dist: pytest-cov; extra == "test"
- Provides-Extra: cryptography
- Requires-Dist: cryptography>=3.4.0; extra == "cryptography"
- Provides-Extra: pycrypto
- Requires-Dist: pycrypto<2.7.0,>=2.6.0; extra == "pycrypto"
- Provides-Extra: pycryptodome
- Requires-Dist: pycryptodome<4.0.0,>=3.3.1; extra == "pycryptodome"
- Dynamic: license-file
-
- python-jose
- ===========
-
- A JOSE implementation in Python
-
- |pypi| |Github Actions CI Status| |Coverage Status| |Docs| |style|
-
- Docs are available on ReadTheDocs_.
-
- The JavaScript Object Signing and Encryption (JOSE) technologies - JSON
- Web Signature (JWS), JSON Web Encryption (JWE), JSON Web Key (JWK), and
- JSON Web Algorithms (JWA) - collectively can be used to encrypt and/or
- sign content using a variety of algorithms. While the full set of
- permutations is extremely large, and might be daunting to some, it is
- expected that most applications will only use a small set of algorithms
- to meet their needs.
-
-
- Installation
- ------------
-
- ::
-
- $ pip install python-jose[cryptography]
-
-
- Cryptographic Backends
- ----------------------
-
- As of 3.3.0, python-jose implements three different cryptographic backends.
- The backend must be selected as an extra when installing python-jose.
- If you do not select a backend, the native-python backend will be installed.
-
- Unless otherwise noted, all backends support all operations.
-
- Due to complexities with setuptools, the native-python backend is always installed,
- even if you select a different backend on install.
- We recommend that you remove unnecessary dependencies in production.
-
- #. cryptography
-
- * This backend uses `pyca/cryptography`_ for all cryptographic operations.
- This is the recommended backend and is selected over all other backends if any others are present.
- * Installation: ``pip install python-jose[cryptography]``
- * Unused dependencies:
-
- * ``rsa``
- * ``ecdsa``
- * ``pyasn1``
-
- #. pycryptodome
-
- * This backend uses `pycryptodome`_ for all cryptographic operations.
- * Installation: ``pip install python-jose[pycryptodome]``
- * Unused dependencies:
-
- * ``rsa``
-
- #. native-python
-
- * This backend uses `python-rsa`_ and `python-ecdsa`_ for all cryptographic operations.
- This backend is always installed but any other backend will take precedence if one is installed.
- * Installation: ``pip install python-jose``
-
- .. note::
-
- The native-python backend cannot process certificates.
-
- Usage
- -----
-
- .. code-block:: python
-
- >>> from jose import jwt
- >>> token = jwt.encode({'key': 'value'}, 'secret', algorithm='HS256')
- u'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJrZXkiOiJ2YWx1ZSJ9.FG-8UppwHaFp1LgRYQQeS6EDQF7_6-bMFegNucHjmWg'
-
- >>> jwt.decode(token, 'secret', algorithms=['HS256'])
- {u'key': u'value'}
-
-
- Thanks
- ------
-
- This library was originally based heavily on the work of the folks over at PyJWT_.
-
- .. |pypi| image:: https://img.shields.io/pypi/v/python-jose?style=flat-square
- :target: https://pypi.org/project/python-jose/
- :alt: PyPI
- .. |Github Actions CI Status| image:: https://github.com/mpdavis/python-jose/actions/workflows/ci.yml/badge.svg
- :target: https://github.com/mpdavis/python-jose/actions/workflows/ci.yml
- :alt: Github Actions CI Status
- .. |Coverage Status| image:: http://codecov.io/github/mpdavis/python-jose/coverage.svg?branch=master
- :target: http://codecov.io/github/mpdavis/python-jose?branch=master
- .. |Docs| image:: https://readthedocs.org/projects/python-jose/badge/
- :target: https://python-jose.readthedocs.org/en/latest/
- .. _ReadTheDocs: https://python-jose.readthedocs.org/en/latest/
- .. _PyJWT: https://github.com/jpadilla/pyjwt
- .. _pyca/cryptography: http://cryptography.io/
- .. _pycryptodome: https://pycryptodome.readthedocs.io/en/latest/
- .. _pycrypto: https://www.dlitz.net/software/pycrypto/
- .. _python-ecdsa: https://github.com/warner/python-ecdsa
- .. _python-rsa: https://stuvel.eu/rsa
- .. |style| image:: https://img.shields.io/badge/code%20style-black-000000.svg
- :target: https://github.com/psf/black
- :alt: Code style: black
|