PyJWT 0.4.0

JSON Web Token implementation in Python

A Python implementation of JSON Web Token draft 01.

Installing

$ pip install PyJWT

A Note on Dependencies:

RSA and ECDSA signatures depend on the cryptography package. If you plan on using any of those algorithms, you’ll need to install it as well.

$ pip install cryptography

Usage

import jwt
jwt.encode({'some': 'payload'}, 'secret')

Additional headers may also be specified.

jwt.encode({'some': 'payload'}, 'secret', headers={'kid': '230498151c214b788dd97f22b85410a5'})

Note the resulting JWT will not be encrypted, but verifiable with a secret key.

jwt.decode('someJWTstring', 'secret')

If the secret is wrong, it will raise a jwt.DecodeError telling you as such. You can still get the payload by setting the verify argument to False.

jwt.decode('someJWTstring', verify=False)

Algorithms

The JWT spec supports several algorithms for cryptographic signing. This library currently supports:

• HS256 - HMAC using SHA-256 hash algorithm (default)

• HS384 - HMAC using SHA-384 hash algorithm

• HS512 - HMAC using SHA-512 hash algorithm

• ES256 - ECDSA signature algorithm using SHA-256 hash algorithm

• ES384 - ECDSA signature algorithm using SHA-384 hash algorithm

• ES512 - ECDSA signature algorithm using SHA-512 hash algorithm

• RS256 - RSASSA-PKCS1-v1_5 signature algorithm using SHA-256 hash algorithm

• RS384 - RSASSA-PKCS1-v1_5 signature algorithm using SHA-384 hash algorithm

• RS512 - RSASSA-PKCS1-v1_5 signature algorithm using SHA-512 hash algorithm

Change the algorithm with by setting it in encode:

jwt.encode({'some': 'payload'}, 'secret', 'HS512')

When using the RSASSA-PKCS1-v1_5 algorithms, the key argument in both jwt.encode() and jwt.decode() ("secret" in the examples) is expected to be either an RSA public or private key in PEM format.

When using the ECDSA algorithms, the key argument is expected to be an Elliptic Curve private key or an Elliptic Curve public key in PEM foramt.

Tests

You can run tests from the project root after cloning with:

$ python tests/test_jwt.py

Support of reserved claim names

JSON Web Token defines some reserved claim names and defines how they should be used. PyJWT supports these reserved claim names:

• “exp” (Expiration Time) Claim

• “nbf” (Not Before Time) Claim

• “iss” (Issuer) Claim

• “aud” (Audience) Claim

Expiration Time Claim

From draft 01 of the JWT spec:

The exp (expiration time) claim identifies the expiration time on or after which the JWT MUST NOT be accepted for processing. The processing of the exp claim requires that the current date/time MUST be before the expiration date/ti