diff options
| author | Johannes Jarbratt <47516968+johachi@users.noreply.github.com> | 2021-04-28 20:42:36 +0900 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-04-28 07:42:36 -0400 |
| commit | 0da422394be3555d5b3cb52761864d2819787eff (patch) | |
| tree | 44e7ecdbb4267c498ef89f0e149a2414600757cf | |
| parent | 545931dafd9ec318e8d8acff6d5a4daeedf50863 (diff) | |
| download | pyjwt-0da422394be3555d5b3cb52761864d2819787eff.tar.gz | |
Fix incorrect documentation for jwt (#651)
* Fix incorrect default values
* Added verify_nbf
* Fix incorrect `require` option
* [pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
| -rw-r--r-- | docs/api.rst | 19 |
1 files changed, 12 insertions, 7 deletions
diff --git a/docs/api.rst b/docs/api.rst index 2553359..2b38b4a 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -43,13 +43,18 @@ API Reference :param dict options: extended decoding and validation options - * ``require_exp=False`` check that ``exp`` (expiration) claim is present - * ``require_iat=False`` check that ``iat`` (issued at) claim is present - * ``require_nbf=False`` check that ``nbf`` (not before) claim is present - * ``verify_aud=False`` check that ``aud`` (audience) claim matches ``audience`` - * ``verify_iat=False`` check that ``iat`` (issued at) claim value is an integer - * ``verify_exp=False`` check that ``exp`` (expiration) claim value is OK - * ``verify_iss=False`` check that ``iss`` (issuer) claim matches ``issuer`` + * ``require=[]`` list of claims that must be present. E.g. ``require=["exp", "iat", "nbf"]``. + Only verifies that the claims exists. Does NOT verify that the claims are valid. + * ``verify_aud=True`` but will be ignored if ``verify_signature`` is ``False``. + Check that ``aud`` (audience) claim matches ``audience`` + * ``verify_iat=True`` but will be ignored if ``verify_signature`` is ``False``. + Check that ``iat`` (issued at) claim value is an integer + * ``verify_exp=True`` but will be ignored if ``verify_signature`` is ``False``. + Check that ``exp`` (expiration) claim value is OK + * ``verify_iss=True`` but will be ignored if ``verify_signature`` is ``False``. + Check that ``iss`` (issuer) claim matches ``issuer`` + * ``verify_nbf=True`` but will be ignored if ``verify_signature`` is ``False``. + Check that ``nbf`` (not before) is in the past * ``verify_signature=True`` verify the JWT cryptographic signature :param Iterable audience: optional, the value for ``verify_aud`` check |