https://github.com/mpdavis/python-jose

A JOSE implementation in Python
https://github.com/mpdavis/python-jose

jose jwt python

Last synced: about 2 months ago
JSON representation

A JOSE implementation in Python

• Host: GitHub
• URL: https://github.com/mpdavis/python-jose
• Owner: mpdavis
• License: mit
• Created: 2015-04-20T19:19:35.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2024-05-21T19:12:04.000Z (4 months ago)
• Last Synced: 2024-05-22T14:06:47.476Z (4 months ago)
• Topics: jose, jwt, python
• Language: Python
• Size: 722 KB
• Stars: 1,489
• Watchers: 28
• Forks: 230
• Open Issues: 102
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

• awesomeLibrary - python-jose - A JOSE implementation in Python. (语言资源库 / python)
• awesome-python-resources - GitHub - 41% open · ⏱️ 09.02.2022): (验证)
• best-of-web-python - GitHub - 56% open · ⏱️ 30.05.2024): (Authorization & Authentication)
• awesome-starts - mpdavis/python-jose - A JOSE implementation in Python (Python)
• starred-awesome - python-jose - A JOSE implementation in Python (Python)

README

        
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/workflows/main/badge.svg?branch=master

   :target: https://github.com/mpdavis/python-jose/actions?workflow=main

   :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