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
|
JSON Web Key (JWK)
==================
The jwk Module implements the `JSON Web Key`_ standard.
A JSON Web Key is represented by a JWK object, related utility classes and
functions are available in this module too.
.. _JSON Web Key: http://tools.ietf.org/html/rfc7517
Classes
-------
.. autoclass:: jwcrypto.jwk.JWK
:members:
:show-inheritance:
.. autoclass:: jwcrypto.jwk.JWKSet
:members:
:show-inheritance:
Exceptions
----------
.. autoclass:: jwcrypto.jwk.InvalidJWKType
:members:
:show-inheritance:
.. autoclass:: jwcrypto.jwk.InvalidJWKValue
:members:
:show-inheritance:
.. autoclass:: jwcrypto.jwk.InvalidJWKOperation
:members:
:show-inheritance:
.. autoclass:: jwcrypto.jwk.InvalidJWKUsage
:members:
:show-inheritance:
Registries
----------
.. autodata:: jwcrypto.jwk.JWKTypesRegistry
:annotation:
.. autodata:: jwcrypto.jwk.JWKValuesRegistry
:annotation:
.. autodata:: jwcrypto.jwk.JWKParamsRegistry
:annotation:
.. autodata:: jwcrypto.jwk.JWKEllipticCurveRegistry
:annotation:
.. autodata:: jwcrypto.jwk.JWKUseRegistry
:annotation:
.. autodata:: jwcrypto.jwk.JWKOperationsRegistry
:annotation:
Examples
--------
Create a 256bit symmetric key::
>>> from jwcrypto import jwk
>>> key = jwk.JWK.generate(kty='oct', size=256)
Export the key with::
>>> key.export() #doctest: +ELLIPSIS
'{"k":"...","kty":"oct"}'
Create a 2048bit RSA key pair::
>>> jwk.JWK.generate(kty='RSA', size=2048) #doctest: +ELLIPSIS
{"kid":"Missing Key ID","thumbprint":"..."}
Create a P-256 EC key pair and export the public key::
>>> key = jwk.JWK.generate(kty='EC', crv='P-256')
>>> key.export(private_key=False) #doctest: +ELLIPSIS
'{"crv":"P-256","kty":"EC","x":"...","y":"..."}'
Import a P-256 Public Key::
>>> expkey = {"y":"VYlYwBfOTIICojCPfdUjnmkpN-g-lzZKxzjAoFmDRm8",
... "x":"3mdE0rODWRju6qqU01Kw5oPYdNxBOMisFvJFH1vEu9Q",
... "crv":"P-256","kty":"EC"}
>>> key = jwk.JWK(**expkey)
Import a Key from a PEM file::
>>> with open("public.pem", "rb") as pemfile: #doctest: +SKIP
... key = jwk.JWK.from_pem(pemfile.read())
|