Skip to main content

JOSE implementation in Python

Project description

A JOSE implementation in Python

Build Status Coverage Status Docs

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

Custom Backends

As of 3.0.0, python-jose uses the pure-python rsa module by default for RSA signing and verification. If necessary, other RSA backends are supported. Options include crytography, pycryptodome, and pycrypto.

In order to use a custom backend, install python-jose with the appropriate extra.

It is recommended that a custom backend is used in production, as the pure-python rsa module is slow.

The crytography option is a good default.

$ pip install python-jose[cryptography]
$ pip install python-jose[pycryptodome]
$ pip install python-jose[pycrypto]

Usage

>>> 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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

python-jose-3.0.1.tar.gz (19.4 kB view details)

Uploaded Source

Built Distribution

python_jose-3.0.1-py2.py3-none-any.whl (25.5 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file python-jose-3.0.1.tar.gz.

File metadata

  • Download URL: python-jose-3.0.1.tar.gz
  • Upload date:
  • Size: 19.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: Python-urllib/2.7

File hashes

Hashes for python-jose-3.0.1.tar.gz
Algorithm Hash digest
SHA256 ed7387f0f9af2ea0ddc441d83a6eb47a5909bd0c8a72ac3250e75afec2cc1371
MD5 f5f921985e5259559bf6ab9e60b1704e
BLAKE2b-256 d1c1ecc8b1229f0e8cdaef93da903d4495579edea529f77eb42e60908879d3b7

See more details on using hashes here.

File details

Details for the file python_jose-3.0.1-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for python_jose-3.0.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 29701d998fe560e52f17246c3213a882a4a39da7e42c7015bcc1f7823ceaff1c
MD5 28066388afe29a9c485665ee749e9a2b
BLAKE2b-256 96dac0dcc5e7a98a53440b8db3cf9771345fa696754f79e8734ea59123f7d734

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page