Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update CHANGELOG.md #584

Merged
merged 1 commit into from
Dec 23, 2020
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
62 changes: 44 additions & 18 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,49 @@ This project adheres to [Semantic Versioning](https://semver.org/).

[v2.0.0][2.0.0]
-------------------------------------------------------------------------
### Highlights
### Changed

#### Drop support for Python 2

#### Require cryptography >= 3

#### Drop support for PyCrypto and ECDSA

We've kept this around for a long time, mostly for environments that didn't allow installing cryptography.

#### Drop CLI

Dropped the included cli entry point.

#### Improve typings

We no longer need to use mypy Python 2 compatibility mode (comments)

#### `jwt.encode(...)` return type

Tokens are returned as string instead of a byte string

#### Dropped deprecated errors

Removed `ExpiredSignature`, `InvalidAudience`, and `InvalidIssuer`. Use `ExpiredSignatureError`, `InvalidAudienceError`, and `InvalidIssuerError` instead.

#### Dropped deprecated `verify_expiration` param in `jwt.decode(...)`

Use `jwt.decode(encoded, key, algorithms=["HS256"], options={"verify_exp": False})` instead.

#### Dropped deprecated `verify` param in `jwt.decode(...)`

Use `jwt.decode(encoded, key, options={"verify_signature": False})` instead.

#### Require explicit `algorithms` in `jwt.decode(...)` by default

Example: `jwt.decode(encoded, key, algorithms=["HS256"])`.

#### Dropped deprecated `require_*` options in `jwt.decode(...)`

For example, instead of `jwt.decode(encoded, key, algorithms=["HS256"], options={"require_exp": True})`, use `jwt.decode(encoded, key, algorithms=["HS256"], options={"require": ["exp"]})`.

### Added

#### Introduce better experience for JWKs

Expand Down Expand Up @@ -43,25 +85,9 @@ print(data)

#### Support for JWKs containing ECDSA keys

#### Drop support for Python 2

#### Require cryptography >= 3

#### Drop support for PyCrypto and ECDSA

We've kept this around for a long time, mostly for environments that didn't allow installing cryptography.

#### Drop CLI

Dropped the included cli entry point.

#### Improve typings

We no longer need to use mypy Python 2 compatibility mode (comments)

#### Add support for Ed25519 / EdDSA

### Changes
### Pull Requests

- Add PyPy3 to the test matrix (#550) by @jdufresne
- Require tweak (#280) by @psafont
Expand Down