jwt 2.10.1 → 3.0.0

data/README.md

@@ -2,9 +2,8 @@
 
 [![Gem Version](https://badge.fury.io/rb/jwt.svg)](https://badge.fury.io/rb/jwt)
 [![Build Status](https://github.com/jwt/ruby-jwt/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/jwt/ruby-jwt/actions)
-[![Code Climate](https://codeclimate.com/github/jwt/ruby-jwt/badges/gpa.svg)](https://codeclimate.com/github/jwt/ruby-jwt)
-[![Test Coverage](https://codeclimate.com/github/jwt/ruby-jwt/badges/coverage.svg)](https://codeclimate.com/github/jwt/ruby-jwt/coverage)
-[![Issue Count](https://codeclimate.com/github/jwt/ruby-jwt/badges/issue_count.svg)](https://codeclimate.com/github/jwt/ruby-jwt)
+[![Maintainability](https://qlty.sh/badges/6f61c5a6-6e23-41a7-8896-a3ce8b006655/maintainability.svg)](https://qlty.sh/gh/jwt/projects/ruby-jwt)
+[![Code Coverage](https://qlty.sh/badges/6f61c5a6-6e23-41a7-8896-a3ce8b006655/test_coverage.svg)](https://qlty.sh/gh/jwt/projects/ruby-jwt)
 
 A ruby implementation of the [RFC 7519 OAuth JSON Web Token (JWT)](https://tools.ietf.org/html/rfc7519) standard.
 
@@ -14,50 +13,34 @@ See [CHANGELOG.md](CHANGELOG.md) for a complete set of changes.
 
 ## Upcoming breaking changes
 
-Notable changes in the upcoming **version 3.0**:
-
-- The indirect dependency to [rbnacl](https://github.com/RubyCrypto/rbnacl) will be removed:
-  - Support for the non-standard SHA512256 algorithm will be removed.
-  - Support for Ed25519 will be moved to a [separate gem](https://github.com/anakinj/jwt-eddsa) for better dependency handling.
-
-- Base64 decoding will no longer fallback on the looser RFC 2045.
-
-- Claim verification has been [split into separate classes](https://github.com/jwt/ruby-jwt/pull/605) and has [a new api](https://github.com/jwt/ruby-jwt/pull/626) and lead to the following deprecations:
-  - The `::JWT::ClaimsValidator` class will be removed in favor of the functionality provided by `::JWT::Claims`.
-  - The `::JWT::Claims::verify!` method will be removed in favor of `::JWT::Claims::verify_payload!`.
-  - The `::JWT::JWA.create` method will be removed.
-  - The `::JWT::Verify` class will be removed in favor of the functionality provided by `::JWT::Claims`.
-  - Calling `::JWT::Claims::Numeric.new` with a payload will be removed in favor of `::JWT::Claims::verify_payload!(payload, :numeric)`.
-  - Calling `::JWT::Claims::Numeric.verify!` with a payload will be removed in favor of `::JWT::Claims::verify_payload!(payload, :numeric)`.
-
-- The internal algorithms were [restructured](https://github.com/jwt/ruby-jwt/pull/607) to support extensions from separate libraries. The changes lead to a few deprecations and new requirements:
-  - The `sign` and `verify` static methods on all the algorithms (`::JWT::JWA`) will be removed.
-  - Custom algorithms are expected to include the `JWT::JWA::SigningAlgorithm` module.
+Check out breaking changes in the upcoming **version 3.0** from the [upgrade guide](UPGRADING.md)
 
 ## Sponsors
 
-|Logo|Message|
-|-|-|
-|![auth0 logo](https://user-images.githubusercontent.com/83319/31722733-de95bbde-b3ea-11e7-96bf-4f4e8f915588.png)|If you want to quickly add secure token-based authentication to Ruby projects, feel free to check Auth0's Ruby SDK and free plan at [auth0.com/developers](https://auth0.com/developers?utm_source=GHsponsor&utm_medium=GHsponsor&utm_campaign=rubyjwt&utm_content=auth)|
+| Logo                                                                                                             | Message                                                                                                                                                                                                                                                                  |
+| ---------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| ![auth0 logo](https://user-images.githubusercontent.com/83319/31722733-de95bbde-b3ea-11e7-96bf-4f4e8f915588.png) | If you want to quickly add secure token-based authentication to Ruby projects, feel free to check Auth0's Ruby SDK and free plan at [auth0.com/developers](https://auth0.com/developers?utm_source=GHsponsor&utm_medium=GHsponsor&utm_campaign=rubyjwt&utm_content=auth) |
 
 ## Installing
 
-### Using Rubygems:
+### Using Rubygems
 
 ```bash
 gem install jwt
 ```
 
-### Using Bundler:
+### Using Bundler
 
 Add the following to your Gemfile
-```
+
+```bash
 gem 'jwt'
 ```
 
 And run `bundle install`
 
 Finally require the gem in your application
+
 ```ruby
 require 'jwt'
 ```
@@ -66,32 +49,15 @@ require 'jwt'
 
 The jwt gem natively supports the NONE, HMAC, RSASSA, ECDSA and RSASSA-PSS algorithms via the openssl library. The gem can be extended with additional or alternative implementations of the algorithms via extensions.
 
-Additionally the EdDSA algorithm is supported via a [separate gem](https://rubygems.org/gems/jwt-eddsa).
+Additionally the EdDSA algorithm is supported via a the [jwt-eddsa gem](https://rubygems.org/gems/jwt-eddsa).
 
 For safe cryptographic signing, you need to specify the algorithm in the options hash whenever you call `JWT.decode` to ensure that an attacker [cannot bypass the algorithm verification step](https://auth0.com/blog/critical-vulnerabilities-in-json-web-token-libraries/). **It is strongly recommended that you hard code the algorithm, as you may leave yourself vulnerable by dynamically picking the algorithm**
 
-See: [ JSON Web Algorithms (JWA) 3.1. "alg" (Algorithm) Header Parameter Values for JWS](https://tools.ietf.org/html/rfc7518#section-3.1)
-
-### Deprecation warnings
-
-Deprecation warnings are logged once (`:once` option) by default to avoid spam in logs. Other options are `:silent` to completely silence warnings and `:warn` to log every time a deprecated path is executed.
-
-```ruby
-  JWT.configuration.deprecation_warnings = :warn # default is :once
-```
-
-### Base64 decoding
-
-In the past the gem has been supporting the Base64 decoding specified in [RFC2045](https://www.rfc-editor.org/rfc/rfc2045) allowing newlines and blanks in the base64 encoded payload. In future versions base64 decoding will be stricter and only comply to [RFC4648](https://www.rfc-editor.org/rfc/rfc4648).
-
-The stricter base64 decoding when processing tokens can be done via the `strict_base64_decoding` configuration accessor.
-```ruby
-  JWT.configuration.strict_base64_decoding = true # default is false
-```
+See [JSON Web Algorithms (JWA) 3.1. "alg" (Algorithm) Header Parameter Values for JWS](https://tools.ietf.org/html/rfc7518#section-3.1)
 
 ### **NONE**
 
-* none - unsigned token
+- none - unsigned token
 
 ```ruby
 
@@ -116,9 +82,9 @@ puts decoded_token
 
 ### **HMAC**
 
-* HS256 - HMAC using SHA-256 hash algorithm
-* HS384 - HMAC using SHA-384 hash algorithm
-* HS512 - HMAC using SHA-512 hash algorithm
+- HS256 - HMAC using SHA-256 hash algorithm
+- HS384 - HMAC using SHA-384 hash algorithm
+- HS512 - HMAC using SHA-512 hash algorithm
 
 ```ruby
 # The secret must be a string. With OpenSSL 3.0/openssl gem `<3.0.1`, JWT::DecodeError will be raised if it isn't provided.
@@ -141,9 +107,9 @@ puts decoded_token
 
 ### **RSA**
 
-* RS256 - RSA using SHA-256 hash algorithm
-* RS384 - RSA using SHA-384 hash algorithm
-* RS512 - RSA using SHA-512 hash algorithm
+- RS256 - RSA using SHA-256 hash algorithm
+- RS384 - RSA using SHA-384 hash algorithm
+- RS512 - RSA using SHA-512 hash algorithm
 
 ```ruby
 rsa_private = OpenSSL::PKey::RSA.generate(2048)
@@ -166,10 +132,10 @@ puts decoded_token
 
 ### **ECDSA**
 
-* ES256 - ECDSA using P-256 and SHA-256
-* ES384 - ECDSA using P-384 and SHA-384
-* ES512 - ECDSA using P-521 and SHA-512
-* ES256K - ECDSA using P-256K and SHA-256
+- ES256 - ECDSA using P-256 and SHA-256
+- ES384 - ECDSA using P-384 and SHA-384
+- ES512 - ECDSA using P-521 and SHA-512
+- ES256K - ECDSA using P-256K and SHA-256
 
 ```ruby
 ecdsa_key = OpenSSL::PKey::EC.generate('prime256v1')
@@ -189,49 +155,18 @@ decoded_token = JWT.decode(token, ecdsa_key, true, { algorithm: 'ES256' })
 puts decoded_token
 ```
 
-### **EDDSA**
-
-In order to use this algorithm you need to add the `RbNaCl` gem to you `Gemfile`.
-
-```ruby
-gem 'rbnacl'
-```
-
-For more detailed installation instruction check the official [repository](https://github.com/RubyCrypto/rbnacl) on GitHub.
-
-* ED25519
-
-```ruby
-private_key = RbNaCl::Signatures::Ed25519::SigningKey.new('abcdefghijklmnopqrstuvwxyzABCDEF')
-public_key = private_key.verify_key
-token = JWT.encode payload, private_key, 'ED25519'
-
-# eyJhbGciOiJFRDI1NTE5In0.eyJkYXRhIjoidGVzdCJ9.6xIztXyOupskddGA_RvKU76V9b2dCQUYhoZEVFnRimJoPYIzZ2Fm47CWw8k2NTCNpgfAuxg9OXjaiVK7MvrbCQ
-puts token
-
-decoded_token = JWT.decode token, public_key, true, { algorithm: 'ED25519' }
-# Array
-# [
-#  {"test"=>"data"}, # payload
-#  {"alg"=>"ED25519"} # header
-# ]
+### **EdDSA**
 
-```
+This algorithm has since version 3.0 been moved to the [jwt-eddsa gem](https://rubygems.org/gems/jwt-eddsa).
 
 ### **RSASSA-PSS**
 
-In order to use this algorithm you need to add the `openssl` gem to your `Gemfile` with a version greater or equal to `2.1`.
+- PS256 - RSASSA-PSS using SHA-256 hash algorithm
+- PS384 - RSASSA-PSS using SHA-384 hash algorithm
+- PS512 - RSASSA-PSS using SHA-512 hash algorithm
 
 ```ruby
-gem 'openssl', '~> 2.1'
-```
-
-* PS256 - RSASSA-PSS using SHA-256 hash algorithm
-* PS384 - RSASSA-PSS using SHA-384 hash algorithm
-* PS512 - RSASSA-PSS using SHA-512 hash algorithm
-
-```ruby
-rsa_private = OpenSSL::PKey::RSA.generate 2048
+rsa_private = OpenSSL::PKey::RSA.generate(2048)
 rsa_public = rsa_private.public_key
 
 token = JWT.encode(payload, rsa_private, 'PS256')
@@ -249,37 +184,6 @@ decoded_token = JWT.decode(token, rsa_public, true, { algorithm: 'PS256' })
 puts decoded_token
 ```
 
-### Add custom header fields
-Ruby-jwt gem supports custom [header fields](https://tools.ietf.org/html/rfc7519#section-5)
-To add custom header fields you need to pass `header_fields` parameter
-
-```ruby
-token = JWT.encode(payload, key, algorithm='HS256', header_fields={})
-```
-
-**Example:**
-
-```ruby
-
-payload = { data: 'test' }
-
-# IMPORTANT: set nil as password parameter
-token = JWT.encode(payload, nil, 'none', { typ: 'JWT' })
-
-# eyJhbGciOiJub25lIiwidHlwIjoiSldUIn0.eyJkYXRhIjoidGVzdCJ9.
-puts token
-
-# Set password to nil and validation to false otherwise this won't work
-decoded_token = JWT.decode(token, nil, false)
-
-# Array
-# [
-#   {"data"=>"test"}, # payload
-#   {"typ"=>"JWT", "alg"=>"none"} # header
-# ]
-puts decoded_token
-```
-
 ### **Custom algorithms**
 
 When encoding or decoding a token, you can pass in a custom object through the `algorithm` option to handle signing or verification. This custom object must include or extend the `JWT::JWA::SigningAlgorithm` module and implement certain methods:
@@ -289,7 +193,6 @@ When encoding or decoding a token, you can pass in a custom object through the `
 
 For customization options check the details from `JWT::JWA::SigningAlgorithm`.
 
-
 ```ruby
 module CustomHS512Algorithm
   extend JWT::JWA::SigningAlgorithm
@@ -311,10 +214,44 @@ token = ::JWT.encode({'pay' => 'load'}, 'secret', CustomHS512Algorithm)
 payload, header = ::JWT.decode(token, 'secret', true, algorithm: CustomHS512Algorithm)
 ```
 
+### Add custom header fields
+
+The ruby-jwt gem supports custom [header fields](https://tools.ietf.org/html/rfc7519#section-5)
+To add custom header fields you need to pass `header_fields` parameter
+
+```ruby
+token = JWT.encode(payload, key, 'HS256', {})
+```
+
+**Example:**
+
+```ruby
+
+payload = { data: 'test' }
+
+# IMPORTANT: set nil as password parameter
+token = JWT.encode(payload, nil, 'none', { typ: 'JWT' })
+
+# eyJhbGciOiJub25lIiwidHlwIjoiSldUIn0.eyJkYXRhIjoidGVzdCJ9.
+puts token
+
+# Set password to nil and validation to false otherwise this won't work
+decoded_token = JWT.decode(token, nil, false)
+
+# Array
+# [
+#   {"data"=>"test"}, # payload
+#   {"typ"=>"JWT", "alg"=>"none"} # header
+# ]
+puts decoded_token
+```
+
 ## `JWT::Token` and `JWT::EncodedToken`
 
 The `JWT::Token` and `JWT::EncodedToken` classes can be used to manage your JWTs.
 
+### Signing and encoding a token
+
 ```ruby
 token = JWT::Token.new(payload: { exp: Time.now.to_i + 60, jti: '1234', sub: "my-subject" }, header: { kid: 'hmac' })
 token.sign!(algorithm: 'HS256', key: "secret")
@@ -322,7 +259,10 @@ token.sign!(algorithm: 'HS256', key: "secret")
 token.jwt # => "eyJhbGciOiJIUzI1N..."
 ```
 
-The `JWT::EncodedToken` can be used to create a token object that allows verification of signatures and claims
+### Verifying and decoding a token
+
+The `JWT::EncodedToken` can be used as a token object that allows verification of signatures and claims.
+
 ```ruby
 encoded_token = JWT::EncodedToken.new(token.jwt)
 
@@ -335,6 +275,48 @@ encoded_token.payload # => { 'exp'=>1234, 'jti'=>'1234", 'sub'=>'my-subject' }
 encoded_token.header # {'kid'=>'hmac', 'alg'=>'HS256'}
 ```
 
+The `JWT::EncodedToken#verify!` method can be used to verify signature and claim verification in one go. The `exp` claim is verified by default.
+
+```ruby
+encoded_token = JWT::EncodedToken.new(token.jwt)
+encoded_token.verify!(signature: {algorithm: 'HS256', key: "secret"})
+encoded_token.payload # => { 'exp'=>1234, 'jti'=>'1234", 'sub'=>'my-subject' }
+encoded_token.header # {'kid'=>'hmac', 'alg'=>'HS256'}
+```
+
+#### Keyfinders
+
+A keyfinder can be used to verify a signature. A keyfinder is an object responding to the `#call` method. The method expects to receive one argument, which is the token to be verified.
+
+An example on using the built-in JWK keyfinder.
+
+```ruby
+# Create and sign a token
+jwk = JWT::JWK.new(OpenSSL::PKey::RSA.generate(2048))
+token = JWT::Token.new(payload: { pay: 'load' }, header: { kid: jwk.kid })
+token.sign!(algorithm: 'RS256', key: jwk.signing_key)
+
+# Create keyfinder object, verify and decode token
+key_finder = JWT::JWK::KeyFinder.new(jwks: JWT::JWK::Set.new(jwk))
+encoded_token = JWT::EncodedToken.new(token.jwt)
+encoded_token.verify!(signature: { algorithm: 'RS256', key_finder: key_finder})
+encoded_token.payload # => { 'pay' => 'load' }
+```
+
+Using a custom keyfinder proc.
+
+```ruby
+# Create and sign a token
+key = OpenSSL::PKey::RSA.generate(2048)
+token = JWT::Token.new(payload: { pay: 'load' })
+token.sign!(algorithm: 'RS256', key: key)
+
+# Verify and decode token
+encoded_token = JWT::EncodedToken.new(token.jwt)
+encoded_token.verify!(signature: { algorithm: 'RS256', key_finder: ->(_token){ key.public_key }})
+encoded_token.payload # => { 'pay' => 'load' }
+```
+
 ### Detached payload
 
 The `::JWT::Token#detach_payload!` method can be use to detach the payload from the JWT.
@@ -361,21 +343,19 @@ encoded_token.payload # => {"pay"=>"load"}
 JSON Web Token defines some reserved claim names and defines how they should be
 used. JWT supports these reserved claim names:
 
- - 'exp' (Expiration Time) Claim
- - 'nbf' (Not Before Time) Claim
- - 'iss' (Issuer) Claim
- - 'aud' (Audience) Claim
- - 'jti' (JWT ID) Claim
- - 'iat' (Issued At) Claim
- - 'sub' (Subject) Claim
+- 'exp' (Expiration Time) Claim
+- 'nbf' (Not Before Time) Claim
+- 'iss' (Issuer) Claim
+- 'aud' (Audience) Claim
+- 'jti' (JWT ID) Claim
+- 'iat' (Issued At) Claim
+- 'sub' (Subject) Claim
 
 ### Expiration Time Claim
 
 From [Oauth JSON Web Token 4.1.4. "exp" (Expiration Time) Claim](https://tools.ietf.org/html/rfc7519#section-4.1.4):
 
-> The `exp` (expiration time) claim identifies the expiration time on or after which the JWT MUST NOT be accepted for processing. The processing of the `exp` claim requires that the current date/time MUST be before the expiration date/time listed in the `exp` claim. Implementers MAY provide for some small `leeway`, usually no more than a few minutes, to account for clock skew. Its value MUST be a number containing a ***NumericDate*** value. Use of this claim is OPTIONAL.
-
-**Handle Expiration Claim**
+> The `exp` (expiration time) claim identifies the expiration time on or after which the JWT MUST NOT be accepted for processing. The processing of the `exp` claim requires that the current date/time MUST be before the expiration date/time listed in the `exp` claim. Implementers MAY provide for some small `leeway`, usually no more than a few minutes, to account for clock skew. Its value MUST be a number containing a **_NumericDate_** value. Use of this claim is OPTIONAL.
 
 ```ruby
 exp = Time.now.to_i + 4 * 3600
@@ -391,12 +371,13 @@ end
 ```
 
 The Expiration Claim verification can be disabled.
+
 ```ruby
 # Decode token without raising JWT::ExpiredSignature error
 JWT.decode(token, hmac_secret, true, { verify_expiration: false, algorithm: 'HS256' })
 ```
 
-**Adding Leeway**
+Leeway and the exp claim.
 
 ```ruby
 exp = Time.now.to_i - 10
@@ -419,9 +400,7 @@ end
 
 From [Oauth JSON Web Token 4.1.5. "nbf" (Not Before) Claim](https://tools.ietf.org/html/rfc7519#section-4.1.5):
 
-> The `nbf` (not before) claim identifies the time before which the JWT MUST NOT be accepted for processing. The processing of the `nbf` claim requires that the current date/time MUST be after or equal to the not-before date/time listed in the `nbf` claim. Implementers MAY provide for some small `leeway`, usually no more than a few minutes, to account for clock skew. Its value MUST be a number containing a ***NumericDate*** value. Use of this claim is OPTIONAL.
-
-**Handle Not Before Claim**
+> The `nbf` (not before) claim identifies the time before which the JWT MUST NOT be accepted for processing. The processing of the `nbf` claim requires that the current date/time MUST be after or equal to the not-before date/time listed in the `nbf` claim. Implementers MAY provide for some small `leeway`, usually no more than a few minutes, to account for clock skew. Its value MUST be a number containing a **_NumericDate_** value. Use of this claim is OPTIONAL.
 
 ```ruby
 nbf = Time.now.to_i - 3600
@@ -437,12 +416,13 @@ end
 ```
 
 The Not Before Claim verification can be disabled.
+
 ```ruby
 # Decode token without raising JWT::ImmatureSignature error
 JWT.decode(token, hmac_secret, true, { verify_not_before: false, algorithm: 'HS256' })
 ```
 
-**Adding Leeway**
+Leeway and the nbf claim.
 
 ```ruby
 nbf = Time.now.to_i + 10
@@ -465,7 +445,7 @@ end
 
 From [Oauth JSON Web Token 4.1.1. "iss" (Issuer) Claim](https://tools.ietf.org/html/rfc7519#section-4.1.1):
 
-> The `iss` (issuer) claim identifies the principal that issued the JWT. The processing of this claim is generally application specific. The `iss` value is a case-sensitive string containing a ***StringOrURI*** value. Use of this claim is OPTIONAL.
+> The `iss` (issuer) claim identifies the principal that issued the JWT. The processing of this claim is generally application specific. The `iss` value is a case-sensitive string containing a **_StringOrURI_** value. Use of this claim is OPTIONAL.
 
 You can pass multiple allowed issuers as an Array, verification will pass if one of them matches the `iss` value in the payload.
 
@@ -517,7 +497,7 @@ end
 
 From [Oauth JSON Web Token 4.1.3. "aud" (Audience) Claim](https://tools.ietf.org/html/rfc7519#section-4.1.3):
 
-> The `aud` (audience) claim identifies the recipients that the JWT is intended for. Each principal intended to process the JWT MUST identify itself with a value in the audience claim. If the principal processing the claim does not identify itself with a value in the `aud` claim when this claim is present, then the JWT MUST be rejected. In the general case, the `aud` value is an array of case-sensitive strings, each containing a ***StringOrURI*** value. In the special case when the JWT has one audience, the `aud` value MAY be a single case-sensitive string containing a ***StringOrURI*** value. The interpretation of audience values is generally application specific. Use of this claim is OPTIONAL.
+> The `aud` (audience) claim identifies the recipients that the JWT is intended for. Each principal intended to process the JWT MUST identify itself with a value in the audience claim. If the principal processing the claim does not identify itself with a value in the `aud` claim when this claim is present, then the JWT MUST be rejected. In the general case, the `aud` value is an array of case-sensitive strings, each containing a **_StringOrURI_** value. In the special case when the JWT has one audience, the `aud` value MAY be a single case-sensitive string containing a **_StringOrURI_** value. The interpretation of audience values is generally application specific. Use of this claim is OPTIONAL.
 
 ```ruby
 aud = ['Young', 'Old']
@@ -565,9 +545,7 @@ end
 
 From [Oauth JSON Web Token 4.1.6. "iat" (Issued At) Claim](https://tools.ietf.org/html/rfc7519#section-4.1.6):
 
-> The `iat` (issued at) claim identifies the time at which the JWT was issued. This claim can be used to determine the age of the JWT. The `leeway` option is not taken into account when verifying this claim. The `iat_leeway` option was removed in version 2.2.0. Its value MUST be a number containing a ***NumericDate*** value. Use of this claim is OPTIONAL.
-
-**Handle Issued At Claim**
+> The `iat` (issued at) claim identifies the time at which the JWT was issued. This claim can be used to determine the age of the JWT. The `leeway` option is not taken into account when verifying this claim. The `iat_leeway` option was removed in version 2.2.0. Its value MUST be a number containing a **_NumericDate_** value. Use of this claim is OPTIONAL.
 
 ```ruby
 iat = Time.now.to_i
@@ -587,7 +565,7 @@ end
 
 From [Oauth JSON Web Token 4.1.2. "sub" (Subject) Claim](https://tools.ietf.org/html/rfc7519#section-4.1.2):
 
-> The `sub` (subject) claim identifies the principal that is the subject of the JWT. The Claims in a JWT are normally statements about the subject. The subject value MUST either be scoped to be locally unique in the context of the issuer or be globally unique. The processing of this claim is generally application specific. The sub value is a case-sensitive string containing a ***StringOrURI*** value. Use of this claim is OPTIONAL.
+> The `sub` (subject) claim identifies the principal that is the subject of the JWT. The Claims in a JWT are normally statements about the subject. The subject value MUST either be scoped to be locally unique in the context of the issuer or be globally unique. The processing of this claim is generally application specific. The sub value is a case-sensitive string containing a **_StringOrURI_** value. Use of this claim is OPTIONAL.
 
 ```ruby
 sub = 'Subject'
@@ -608,6 +586,7 @@ end
 The JWT claim verifications can be used to verify any Hash to include expected keys and values.
 
 A few example on verifying the claims for a payload:
+
 ```ruby
 JWT::Claims.verify_payload!({"exp" => Time.now.to_i + 10}, :numeric, :exp)
 JWT::Claims.valid_payload?({"exp" => Time.now.to_i + 10}, :exp)
@@ -644,6 +623,7 @@ end
 ### Required Claims
 
 You can specify claims that must be present for decoding to be successful. JWT::MissingRequiredClaim will be raised if any are missing
+
 ```ruby
 # Will raise a JWT::MissingRequiredClaim error if the 'exp' claim is absent
 JWT.decode(token, hmac_secret, true, { required_claims: ['exp'], algorithm: 'HS256' })
@@ -782,7 +762,7 @@ jwk_hash = jwk.export
 thumbprint_as_the_kid = jwk_hash[:kid]
 ```
 
-# Development and testing
+## Development and testing
 
 The tests are written with rspec. [Appraisal](https://github.com/thoughtbot/appraisal) is used to ensure compatibility with 3rd party dependencies providing cryptographic features.
 
@@ -791,7 +771,7 @@ bundle install
 bundle exec appraisal rake test
 ```
 
-# Releasing
+## Releasing
 
 To cut a new release adjust the [version.rb](lib/jwt/version.rb) and [CHANGELOG](CHANGELOG.md) with desired version numbers and dates and commit the changes. Tag the release with the version number using the following command:
 
@@ -802,6 +782,7 @@ rake release:source_control_push
 This will tag a new version an trigger a [GitHub action](.github/workflows/push_gem.yml) that eventually will push the gem to rubygems.org.
 
 ## How to contribute
+
 See [CONTRIBUTING](CONTRIBUTING.md).
 
 ## Contributors

data/UPGRADING.md

@@ -0,0 +1,47 @@
+# Upgrading ruby-jwt to >= 3.0.0
+
+## Removal of the indirect [RbNaCl](https://github.com/RubyCrypto/rbnacl) dependency
+
+Historically, the set of supported algorithms was extended by including the `rbnacl` gem in the application's Gemfile. On load, ruby-jwt tried to load the gem and, if available, extend the algorithms to those provided by the `rbnacl/libsodium` libraries. This indirect dependency has caused some maintenance pain and confusion about which versions of the gem are supported.
+
+Some work to ease the way alternative algorithms can be implemented has been done. This enables the extraction of the algorithm provided by `rbnacl`.
+
+The extracted algorithms now live in the [jwt-eddsa](https://rubygems.org/gems/jwt-eddsa) gem.
+
+### Dropped support for HS512256
+
+The algorithm HS512256 (HMAC-SHA-512 truncated to 256-bits) is not part of any JWA/JWT RFC and therefore will not be supported anymore. It was part of the HMAC algorithms provided by the indirect [RbNaCl](https://github.com/RubyCrypto/rbnacl) dependency. Currently, there are no direct substitutes for the algorithm.
+
+### `JWT::EncodedToken#payload` will raise before token is verified
+
+To avoid accidental use of unverified tokens, the `JWT::EncodedToken#payload` method will raise an error if accessed before the token signature has been verified.
+
+To access the payload before verification, use the method `JWT::EncodedToken#unverified_payload`.
+
+## Stricter requirements on Base64 encoded data
+
+Base64 decoding will no longer fallback on the looser RFC 2045. The biggest difference is that the looser version was ignoring whitespaces and newlines, whereas the stricter version raises errors in such cases.
+
+If you, for example, read tokens from files, there could be problems with trailing newlines. Make sure you trim your input before passing it to the decoding mechanisms.
+
+## Claim verification revamp
+
+Claim verification has been [split into separate classes](https://github.com/jwt/ruby-jwt/pull/605) and has [a new API](https://github.com/jwt/ruby-jwt/pull/626), leading to the following deprecations:
+
+- The `::JWT::ClaimsValidator` class will be removed in favor of the functionality provided by `::JWT::Claims`.
+- The `::JWT::Claims::verify!` method will be removed in favor of `::JWT::Claims::verify_payload!`.
+- The `::JWT::JWA.create` method will be removed.
+- The `::JWT::Verify` class will be removed in favor of the functionality provided by `::JWT::Claims`.
+- Calling `::JWT::Claims::Numeric.new` with a payload will be removed in favor of `::JWT::Claims::verify_payload!(payload, :numeric)`.
+- Calling `::JWT::Claims::Numeric.verify!` with a payload will be removed in favor of `::JWT::Claims::verify_payload!(payload, :numeric)`.
+
+## Algorithm restructuring
+
+The internal algorithms were [restructured](https://github.com/jwt/ruby-jwt/pull/607) to support extensions from separate libraries. The changes led to a few deprecations and new requirements:
+
+- The `sign` and `verify` static methods on all the algorithms (`::JWT::JWA`) will be removed.
+- Custom algorithms are expected to include the `JWT::JWA::SigningAlgorithm` module.
+
+## Base64 the `k´ value for HMAC JWKs
+
+The gem was missing the Base64 encoding and decoding when representing and parsing a HMAC key as a JWK. This issue is now addressed. The added encoding will break compatibility with JWKs produced by older versions of the gem.

data/lib/jwt/base64.rb

@@ -14,22 +14,13 @@ module JWT
       end
 
       # Decode a string with URL-safe Base64 complying with RFC 4648.
-      # Deprecated support for RFC 2045 remains for now. ("All line breaks or other characters not found in Table 1 must be ignored by decoding software")
       # @api private
       def url_decode(str)
         ::Base64.urlsafe_decode64(str)
       rescue ArgumentError => e
         raise unless e.message == 'invalid base64'
-        raise Base64DecodeError, 'Invalid base64 encoding' if JWT.configuration.strict_base64_decoding
 
-        loose_urlsafe_decode64(str).tap do
-          Deprecations.warning('Invalid base64 input detected, could be because of invalid padding, trailing whitespaces or newline chars. Graceful handling of invalid input will be dropped in the next major version of ruby-jwt', only_if_valid: true)
-        end
-      end
-
-      def loose_urlsafe_decode64(str)
-        str += '=' * (4 - str.length.modulo(4))
-        ::Base64.decode64(str.tr('-_', '+/'))
+        raise Base64DecodeError, 'Invalid base64 encoding'
       end
     end
   end

data/lib/jwt/claims/numeric.rb

@@ -5,18 +5,6 @@ module JWT
     # The Numeric class is responsible for validating numeric claims in a JWT token.
     # The numeric claims are: exp, iat and nbf
     class Numeric
-      # The Compat class provides backward compatibility for numeric claim validation.
-      # @api private
-      class Compat
-        def initialize(payload)
-          @payload = payload
-        end
-
-        def verify!
-          JWT::Claims.verify_payload!(@payload, :numeric)
-        end
-      end
-
       # List of numeric claims that can be validated.
       NUMERIC_CLAIMS = %i[
         exp
@@ -26,14 +14,6 @@ module JWT
 
       private_constant(:NUMERIC_CLAIMS)
 
-      # @api private
-      def self.new(*args)
-        return super if args.empty?
-
-        Deprecations.warning('Calling ::JWT::Claims::Numeric.new with the payload will be removed in the next major version of ruby-jwt')
-        Compat.new(*args)
-      end
-
       # Verifies the numeric claims in the JWT context.
       #
       # @param context [Object] the context containing the JWT payload.
@@ -43,18 +23,6 @@ module JWT
         validate_numeric_claims(context.payload)
       end
 
-      # Verifies the numeric claims in the JWT payload.
-      #
-      # @param payload [Hash] the JWT payload containing the claims.
-      # @param _args [Hash] additional arguments (not used).
-      # @raise [JWT::InvalidClaimError] if any numeric claim is invalid.
-      # @return [nil]
-      # @deprecated The ::JWT::Claims::Numeric.verify! method will be removed in the next major version of ruby-jwt
-      def self.verify!(payload:, **_args)
-        Deprecations.warning('The ::JWT::Claims::Numeric.verify! method will be removed in the next major version of ruby-jwt.')
-        JWT::Claims.verify_payload!(payload, :numeric)
-      end
-
       private
 
       def validate_numeric_claims(payload)

data/lib/jwt/claims.rb

@@ -11,7 +11,6 @@ require_relative 'claims/not_before'
 require_relative 'claims/numeric'
 require_relative 'claims/required'
 require_relative 'claims/subject'
-require_relative 'claims/verification_methods'
 require_relative 'claims/verifier'
 
 module JWT
@@ -33,12 +32,6 @@ module JWT
     Error = Struct.new(:message, keyword_init: true)
 
     class << self
-      # @deprecated Use {verify_payload!} instead. Will be removed in the next major version of ruby-jwt.
-      def verify!(payload, options)
-        Deprecations.warning('The ::JWT::Claims.verify! method is deprecated will be removed in the next major version of ruby-jwt')
-        DecodeVerifier.verify!(payload, options)
-      end
-
       # Checks if the claims in the JWT payload are valid.
       # @example
       #

data/lib/jwt/configuration/container.rb

@@ -30,7 +30,6 @@ module JWT
       def reset!
         @decode                 = DecodeConfiguration.new
         @jwk                    = JwkConfiguration.new
-        @strict_base64_decoding = false
 
         self.deprecation_warnings = :once
       end