●Change8

Migrating to JWT Libraries v3.0.0.beta1

Version v3.0.0.beta1 introduces 8 breaking changes. This guide details how to update your code.

Released: 1/25/2025

8
Breaking Changes
1
Migration Steps
3
Affected Symbols

⚠️ Check Your Code

If you use any of these symbols, you need to read this guide:

JWT::EncodedToken#verify!JWT::JWA::SigningAlgorithmJWK::KeyFinder

Breaking Changes

●Issue #1

Require token signature to be verified before accessing payload.

●Issue #2

Drop support for the HS512256 algorithm.

●Issue #3

Remove deprecated claim verification methods.

●Issue #4

Remove dependency to rbnacl.

●Issue #5

Support only stricter base64 decoding (RFC 4648).

●Issue #6

Custom algorithms are required to include `JWT::JWA::SigningAlgorithm`.

●Issue #7

Require RSA keys to be at least 2048 bits.

●Issue #8

Base64 encode and decode the k value for HMAC JWKs.

Migration Steps

  1. 1
    Consult the [upgrade guide](UPGRADING.md) for detailed upgrade instructions.

Release Summary

This major beta release introduces significant breaking changes, including stricter signature verification, removal of deprecated methods and the rbnacl dependency, and updates to algorithm and key requirements. It also adds the convenient JWT::EncodedToken#verify! method.

Need More Details?

View the full release notes and all changes for JWT Libraries v3.0.0.beta1.

View Full Changelog