JSON Web Encryption implementation in Python
Project description
# PyJWE
[JSON Web Encryption](https://tools.ietf.org/html/rfc7516) implementation in Python
[![PyPI version](https://badge.fury.io/py/PyJWE.svg)](https://badge.fury.io/py/PyJWE)
[![Build Status](https://travis-ci.org/chrisseto/pyjwe.svg?branch=master)](https://travis-ci.org/chrisseto/pyjwe)
## Basic Usage
```python
import jwe
key = b'MySecretKey'
salt = b'pepper'
derived_key = jwe.kdf(key, salt)
encoded = jwe.encrypt(b'SuperSecretData', derived_key)
print(encoded)
jwe.decrypt(encoded, derived_key) # b'SuperSecretData'
```
## FAQ
### What is the kdf function? Should I use it? Do I have to use it?
`jwe.kdf` is a very simple [key derivation function](https://en.wikipedia.org/wiki/Key_derivation_function) that uses the [PBKDF2](https://en.wikipedia.org/wiki/PBKDF2).
It is mostly there for the purpose of [key stretching](https://en.wikipedia.org/wiki/Key_stretching) so that users' keys do not have to be the perfect length for AES256.
You do not have to use it, but if you do not your key must be exactly 256 bits.
### Why is `dir` the only algorithm supported?
Because [key wrapping](https://en.wikipedia.org/wiki/Key_Wrap) is more or less [completely useless](https://security.stackexchange.com/questions/40052/when-do-i-use-nist-aes-key-wrapping).
### Why is AES 256 GCM the only encryption methd?
It met my needs and I've yet to need another method.
Feel free to submit an issue if you would like another method implemented.
[JSON Web Encryption](https://tools.ietf.org/html/rfc7516) implementation in Python
[![PyPI version](https://badge.fury.io/py/PyJWE.svg)](https://badge.fury.io/py/PyJWE)
[![Build Status](https://travis-ci.org/chrisseto/pyjwe.svg?branch=master)](https://travis-ci.org/chrisseto/pyjwe)
## Basic Usage
```python
import jwe
key = b'MySecretKey'
salt = b'pepper'
derived_key = jwe.kdf(key, salt)
encoded = jwe.encrypt(b'SuperSecretData', derived_key)
print(encoded)
jwe.decrypt(encoded, derived_key) # b'SuperSecretData'
```
## FAQ
### What is the kdf function? Should I use it? Do I have to use it?
`jwe.kdf` is a very simple [key derivation function](https://en.wikipedia.org/wiki/Key_derivation_function) that uses the [PBKDF2](https://en.wikipedia.org/wiki/PBKDF2).
It is mostly there for the purpose of [key stretching](https://en.wikipedia.org/wiki/Key_stretching) so that users' keys do not have to be the perfect length for AES256.
You do not have to use it, but if you do not your key must be exactly 256 bits.
### Why is `dir` the only algorithm supported?
Because [key wrapping](https://en.wikipedia.org/wiki/Key_Wrap) is more or less [completely useless](https://security.stackexchange.com/questions/40052/when-do-i-use-nist-aes-key-wrapping).
### Why is AES 256 GCM the only encryption methd?
It met my needs and I've yet to need another method.
Feel free to submit an issue if you would like another method implemented.
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
PyJWE-1.0.0.tar.gz
(8.1 kB
view details)
File details
Details for the file PyJWE-1.0.0.tar.gz
.
File metadata
- Download URL: PyJWE-1.0.0.tar.gz
- Upload date:
- Size: 8.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | e3b3de7be4fcc260e5f1a47ead9c9a9211d8ce98f9e1d88d9a7225198aa9ce47 |
|
MD5 | f440a1f2e46e1c134027bfdaf3961000 |
|
BLAKE2b-256 | 59f99d8f24fdcae49fcb18607bdde460fdfc80a55721b86014d0c2fb617ee8b2 |