1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98
|
JSON Web Encryption (JWE)
=========================
The jwe Module implements the `JSON Web Encryption`_ standard.
A JSON Web Encryption is represented by a JWE object, related utility
classes and functions are available in this module too.
.. _JSON Web Encryption: https://tools.ietf.org/html/rfc7516
Classes
-------
.. autoclass:: jwcrypto.jwe.JWE
:members:
:show-inheritance:
Variables
---------
.. autodata:: jwcrypto.jwe.default_allowed_algs
Exceptions
----------
.. autoclass:: jwcrypto.jwe.InvalidJWEOperation
:members:
:show-inheritance:
.. autoclass:: jwcrypto.jwe.InvalidJWEData
:members:
:show-inheritance:
.. autoclass:: jwcrypto.jwe.InvalidJWEKeyType
:members:
:show-inheritance:
.. autoclass:: jwcrypto.jwe.InvalidJWEKeyLength
:members:
:show-inheritance:
.. autoclass:: jwcrypto.jwe.InvalidCEKeyLength
:members:
:show-inheritance:
Registries
----------
.. autodata:: jwcrypto.jwe.JWEHeaderRegistry
:annotation:
Examples
--------
Symmetric keys
~~~~~~~~~~~~~~
Encrypt a JWE token::
>>> from jwcrypto import jwk, jwe
>>> from jwcrypto.common import json_encode
>>> key = jwk.JWK.generate(kty='oct', size=256)
>>> payload = "My Encrypted message"
>>> jwetoken = jwe.JWE(payload.encode('utf-8'),
... json_encode({"alg": "A256KW",
... "enc": "A256CBC-HS512"}))
>>> jwetoken.add_recipient(key)
>>> enc = jwetoken.serialize()
Decrypt a JWE token::
>>> jwetoken = jwe.JWE()
>>> jwetoken.deserialize(enc)
>>> jwetoken.decrypt(key)
>>> payload = jwetoken.payload
Asymmetric keys
~~~~~~~~~~~~~~~
Encrypt a JWE token::
>>> from jwcrypto import jwk, jwe
>>> from jwcrypto.common import json_encode, json_decode
>>> public_key = jwk.JWK()
>>> private_key = jwk.JWK.generate(kty='RSA', size=2048)
>>> public_key.import_key(**json_decode(private_key.export_public()))
>>> payload = "My Encrypted message"
>>> protected_header = {
... "alg": "RSA-OAEP-256",
... "enc": "A256CBC-HS512",
... "typ": "JWE",
... "kid": public_key.thumbprint(),
... }
>>> jwetoken = jwe.JWE(payload.encode('utf-8'),
... recipient=public_key,
... protected=protected_header)
>>> enc = jwetoken.serialize()
Decrypt a JWE token::
>>> jwetoken = jwe.JWE()
>>> jwetoken.deserialize(enc, key=private_key)
>>> payload = jwetoken.payload
|