Skip to content

CHANGELOG.md

Latest commit

 

History

History
380 lines (233 loc) · 12.9 KB

CHANGELOG.md

File metadata and controls

380 lines (233 loc) · 12.9 KB

Change Log

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog and this project adheres to Semantic Versioning.

Changes for the upcoming release can be found in the changelog.d directory in this repository.

Do NOT add changelog entries here! This changelog is managed by towncrier and is compiled at release time.

.. towncrier release notes start

1.19.2 (2022-01-08)

Bugfixes

  • Fixed usage of deprecated functions for python 3.10, djangorestframework 3.13, and django 4.0 (#107)

1.19.1 (2021-05-18)

Bugfixes

  • Fix broken migration for 'blacklisted' token ids. The migration released in v1.18.0 would fail if you had any existing blacklisted tokens. (#94)

1.19.0 (2021-03-29)

Features

  • Adds PyJWT 2.x support. Note that this is only supported on Python 3.6+ as PyJWT 2.x only supports that. PyJWT 1.x is also still supported and continues to work on the same set of Python versions as before. (#91)

1.18.0 (2021-03-18)

Features

  • Apply 'blacklist' to any token from the same line of refreshed tokens as any invalidated token, where token ids are available. Avoid storing whole auth tokens when JWT_TOKEN_ID setting is set to 'require'. Please see notes in docs on migrating from JWT_TOKEN_ID 'allow' (the default) to 'require' (recommended). (#84)

1.17.3 (2020-12-14)

Bugfixes

  • Improve error handling for tokens with an unrecognized key identifier (kid). (#78)
  • Fixed JWT creation status codes from 200 to 201 (#80)

Misc

  • Add obtain_token management command (#62)

1.17.2 (2020-09-20)

Features

  • If the authentication header cant be parsed, fall back to cookies or allow other handlers. (#71)

1.17.1 (2020-08-25)

Bugfixes

  • Improve error handling for invalid tokens. (#77)

1.17.0 (2020-08-14)

Features

  • Default to including a token ID claim (jti) in all tokens. For tokens resulting from refresh, also include the token ID of the original token in the chain of refreshes as orig_jti. (#69)

Improved Documentation

  • Add explanation for blacklisting feature to the documentation. (#61)
  • When the Authorization header is sent with a different prefix other than default it raises error. It should return None and continue toward the other authentication middleware. (#65)
  • Added a section about protecting views properly using the appropriate decorator for function based view and variable for class based views. (#67)

1.16.2 (2020-06-26)

Bugfixes

  • Allow use without blacklist app being installed. (#51)
  • Fix Python 2 regression in model translations not being unicode aware, and use lazy gettext in the models so they can be imported before the translation system has been is initialised. (#54)
  • Use got_or_create on blacklist token creation instead of a database uniqueness on the token parameter to make blacklist functionality work on MySQL. (#58)

1.16.1 (2020-04-30)

Features

  • Use DRF's JSON encoder for JWT tokens, to allow for encoding e.g. users that have UUID primary keys. (#50)

Bugfixes

1.16.0 (2020-04-23)

Features

    • Support multiple algorithms and keys

      Existing code made key rollovers or algorithm changes hard and basically required a breaking change: Once any of JWT_ALGORITHM, JWT_SECRET_KEY, or JWT_PRIVATE_KEY/JWT_PUBLIC_KEY were changed, existing tokens were rendered invalid.

      We now support JWT_ALGORITHM, JWT_SECRET_KEY, and JWT_PUBLIC_KEY optionally being a list, where all members are accepted as valid.

      When JWT_SECRET_KEY is a list, the first member is used for signing and all others are accepted for verification.

    • Support multiple keys with key ids

      We also support identifing keys by key id (kid header): When a JWT carries a key id, we can identify immediately if it is known and only need to make at most one verification attempt.

      To configure keys with ids, JWT_SECRET_KEY, JWT_PRIVATE_KEY and JWT_PUBLIC_KEY can now also be a dict in the form

      { "kid1": key1, "kid2": key2, ... }

      When a JWT does not carry a key id (kid header), the default is to fall back to trying all keys if keys are named (defined as a dict). Setting JWT_INSIST_ON_KID: True avoids this fallback and requires any JWT to be validated to carry a key id if key IDs are used

      NOTE: For python < 3.7, use a collections.OrderedDict object instead of a dict

    • Require cryptographic dependencies of PyJWT

      We changed the PyJWT requirement to include support for RSA by default. This was done to improve the user experience, but will lead to cryptography support be installed where not already present.

      See: https://pyjwt.readthedocs.io/en/latest/installation.html#cryptographic-dependencies-optional (#33)

Bugfixes

  • Fix deprecation warnings in Django 3 caused by imports of ugettext and force_text. (#45)
  • Remove the tests that reload the settings module. For some reason, pytest's monkeypatch was failing to mock settings when executed after these tests. Since these tests tested runtime behavior that would have been caught by users on startup anyway, it's easier to remove them than fix them. (#48)

Misc

  • Add the manual deploy stage until te Travis build is fixed (#48)

1.15.2 (2020-03-30)

Bugfixes

  • Added new encrypted PyPI API token for travis deployment. (#39)
  • Fixed issues when the JWT_GET_USER_SECRET_KEY method is overridden,
    • If the payload contains a non-existent user, a validation error will be raised (same as when the method is not overridden).
    • The jwt_get_secret_key will now use the JWT_PAYLOAD_GET_USERNAME_HANDLER configuration. (#41)

1.15.1 (2020-03-12)

Bugfixes

  • Added check in authentication if blacklist app is installed before checking if any Blacklisted tokens exist (#35)
  • Security: Disallow refresh token for blacklisted tokens. (#37)

1.15.0 (2020-02-19)

Features

  • Blacklisting allows the user to blacklist his own token. (#27)

Deprecations and Removals

  • Drop support for Python 3.3 and 3.4 (#27)

Misc

  • changed occurrences of smart_text to smart_str since it was deprecated in Django 3.X (#28)

1.14.0 (2020-01-29)

Features

  • Impersonation allows the service to perform actions on the client’s behalf. A typical use case would be troubleshooting. We can act like the user who submitted an issue without requiring its login credentials. (#26)

  • added JWT_AUTH_COOKIE_* settings paralleling Django's SESSION_COOKIE_* which are used for JWT_AUTH_COOKIE and JWT_IMPERSONATION_COOKIE

    This changes the default Secure attribute from False to True. Users wishing to use JWT cookies over http (as in no TLS/SSL) need to set JWT_AUTH_COOKIE_SECURE to False.

    This change is intentional to follow common best common practice.

    With Django versions >= 2.1.0, the Samesite attribute is set to Lax by default. (#29)

Improved Documentation

  • Document compatibility with Python 3.7. (#23)
  • Add support for Django 3.0, Python 3.8 and djangorestframework 3.11 (#24)

Misc

    • Run the test suite against the demo project. The same project can be used for local development as well.
    • Add the serve environment to tox that starts the demo project's development server. To use it, run: $ tox -e serve (#24)

1.13.4 (2019-12-13)

Bugfixes

  • Remove serialization on response data in BaseJSONWebTokenAPIView because it breaks custom response payload handlers which add extra data to the response payload. This change aligns this fork more closely with the original and makes it easier to use this fork as a drop-in replacement for the original. Also change the ReponsePayload from a namedtuple to a dictionary because namedtuple is not JSON serializable (#22)

1.13.3 (2019-10-17)

Features

    • Added support for djangorestframework 3.10 (#18)
  • Allow control of setting the user_id in the payload with JWT_PAYLOAD_INCLUDE_USER_ID. (#20)

1.13.2 (2019-08-26)

Bugfixes

  • Use pk to get profile's id in rest_framework_jwt.utils.jwt_create_payload. (#15)

1.13.1 (2019-08-23)

Bugfixes

  • Pass request to django.contrib.auth.authenticate. (#14)

1.13.0 (2019-04-23)

Features

  • Added on_delete to tests.models.UserProfile.user required by Django 2.2, and added Django 2.x, Python 3.7 and djangorestframework 3.9 to the support matrix. (#9)

1.12.10 (2018-12-21)

No significant changes.

1.12.9 (2018-12-21)

Misc

  • Fixed inconsistent View names. (#7)

1.12.8 (2018-12-21)

Breaking Changes

  • The default configuration of JWT_AUTH_HEADER_PREFIX was changed from JWT to Bearer. Add "JWT_AUTH_HEADER_PREFIX": "JWT", to your JWT_AUTH if want to keep the previous behavior.

Misc

  • Updated docs. Drop support for Django < 1.8 and DRF < 3.7.x. (#6)

1.12.7 (2018-12-17)

Misc

  • Switch to Travis CI build stages (#3)

1.12.3 (2018-12-13)

Misc

  • Project restructuring according to SDS code style and conventions. (#2)