Replace python-jose with PyJWT #227
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
sirosen
added
bug
jaswilli
reviewed
Sep 28, 2017
docs/optional_dependencies.rst
Outdated
| You may install supported versions of ``python-jose`` by install the SDK with | ||
| its ``globus_sdk[jwt]`` extra. Simply specify ``globus_sdk[jwt]`` in your | ||
| dependencies. | ||
| install ``globus_sd[jwt]``. This extra target includes dependencies which we |
Replace python-jose with pyjwt+cryptography. Update requirement/optional dependency spec to state `globus-sdk[jwt]`, no mention of python-jose (obviously), but less obviously no mention of pyjwt or cryptography. `globus-sdk[jwt]` extra now specfies pyjwt[crypto], which installs pyjwt and cryptography. Some implementation details: - pyjwt does not decode JWKs into RSA keys internally -- but it provides a facility to do this - pyjwt does not validate the `at_hash` claim; we're dropping this validation, and relying on signature and audience validation as good enough - get the valid signing algos from the OIDC conf and pass them to pyjwt; pyjwt will then pull the used algo from the id_token and match it against this list (currently RS512 only) - Had to update a mock to support this
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Inspired in part by the discovery that a python-jose dependency, pycrypto, can't install on macOS 10.13.
python-jose advertises that it can support
cryptographyas a backend, but there's no install method which chooses that crypto lib -- you'd need to manually install cryptography and install python-jose without resolving its dependencies.pyjwt[crypto]works out of the box.This may enable us to make
globus-sdk[jwt]the default install, and make thejwtextra empty. It depends on whether or not the cross-platform promise ofcryptographylives up to its name.Update requirement/optional dependency spec to state
globus-sdk[jwt], no mention of python-jose (obviously), but less obviously no mention of pyjwt or cryptography.Some implementation details:
at_hashclaim; we're dropping this validation, and relying on signature and audience validation as good enoughOnce we have this, we can discuss next steps (release v1.2.1 of the SDK with it, or maybe try having it install on appveyor). There's also an interesting interplay between
pyjwt[crypto]->cryptographyandglobus-cli[delegate-proxy]->cryptographywhich we should discuss/explore.