jwt 2.9.3 → 3.1.2

data/README.md

@@ -1,224 +1,157 @@
 # JWT
 
 [![Gem Version](https://badge.fury.io/rb/jwt.svg)](https://badge.fury.io/rb/jwt)
-[![Build Status](https://github.com/jwt/ruby-jwt/workflows/test/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)
+[![Build Status](https://github.com/jwt/ruby-jwt/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/jwt/ruby-jwt/actions)
+[![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.
 
 If you have further questions related to development or usage, join us: [ruby-jwt google group](https://groups.google.com/forum/#!forum/ruby-jwt).
 
-## Announcements
-* Ruby 2.4 support was dropped in version 2.4.0
-* Ruby 1.9.3 support was dropped at December 31st, 2016.
-* Version 1.5.3 yanked. See: [#132](https://github.com/jwt/ruby-jwt/issues/132) and [#133](https://github.com/jwt/ruby-jwt/issues/133)
-
-See [CHANGELOG.md](CHANGELOG.md) for a complete set of changes.
+See [CHANGELOG.md](CHANGELOG.md) for a complete set of changes and [upgrade guide](UPGRADING.md) for upgrading between major versions.
 
 ## 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`
 
-## Algorithms and Usage
-
-The JWT spec supports NONE, HMAC, RSASSA, ECDSA and RSASSA-PSS algorithms for cryptographic signing. Currently the jwt gem supports NONE, HMAC, RSASSA and ECDSA. If you are using 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
+And run `bundle install`
 
-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.
+Finally require the gem in your application
 
 ```ruby
-  JWT.configuration.deprecation_warnings = :warn # default is :once
+require 'jwt'
 ```
 
-### Base64 decoding
+## Algorithms and Usage
+
+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.
 
-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).
+Additionally the EdDSA algorithm is supported via a the [jwt-eddsa gem](https://rubygems.org/gems/jwt-eddsa).
 
-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
-```
+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)
 
 ### **NONE**
 
-* none - unsigned token
+- none - unsigned token
 
 ```ruby
-require 'jwt'
-
 payload = { data: 'test' }
+token   = JWT.encode(payload, nil, 'none')
+# => "eyJhbGciOiJub25lIn0.eyJkYXRhIjoidGVzdCJ9."
 
-# IMPORTANT: set nil as password parameter
-token = JWT.encode payload, nil, 'none'
-
-# eyJhbGciOiJub25lIn0.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
-#   {"alg"=>"none"} # header
-# ]
-puts decoded_token
+decoded_token = JWT.decode(token, nil, true, { algorithm: 'none' })
+#  => [
+#       {"data"=>"test"}, # payload
+#       {"alg"=>"none"} # header
+#     ]
 ```
 
 ### **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.
+payload     = { data: 'test' }
 hmac_secret = 'my$ecretK3y'
 
-token = JWT.encode payload, hmac_secret, 'HS256'
-
-# eyJhbGciOiJIUzI1NiJ9.eyJkYXRhIjoidGVzdCJ9.pNIWIL34Jo13LViZAJACzK6Yf0qnvT_BuwOxiMCPE-Y
-puts token
-
-decoded_token = JWT.decode token, hmac_secret, true, { algorithm: 'HS256' }
+token = JWT.encode(payload, hmac_secret, 'HS256')
+# => "eyJhbGciOiJIUzI1NiJ9.eyJkYXRhIjoidGVzdCJ9.pNIWIL34Jo13LViZAJACzK6Yf0qnvT_BuwOxiMCPE-Y"
 
-# Array
-# [
-#   {"data"=>"test"}, # payload
-#   {"alg"=>"HS256"} # header
-# ]
-puts decoded_token
+decoded_token = JWT.decode(token, hmac_secret, true, { algorithm: 'HS256' })
+# => [
+#      {"data"=>"test"}, # payload
+#      {"alg"=>"HS256"} # header
+#    ]
 ```
 
 ### **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
-rsa_public = rsa_private.public_key
+payload     = { data: 'test' }
+rsa_private = OpenSSL::PKey::RSA.generate(2048)
+rsa_public  = rsa_private.public_key
 
-token = JWT.encode payload, rsa_private, 'RS256'
+token = JWT.encode(payload, rsa_private, 'RS256')
+# => "eyJhbGciOiJSUzI1NiJ9.eyJkYXRhIjoidGVzdCJ9.CCkO35qFPijW8Gwhbt8a80PB9fc9FJ19hCMnXSgoDF6Mlvlt0A4G-ah..."
 
-# eyJhbGciOiJSUzI1NiJ9.eyJkYXRhIjoidGVzdCJ9.GplO4w1spRgvEJQ3-FOtZr-uC8L45Jt7SN0J4woBnEXG_OZBSNcZjAJWpjadVYEe2ev3oUBFDYM1N_-0BTVeFGGYvMewu8E6aMjSZvOpf1cZBew-Vt4poSq7goG2YRI_zNPt3af2lkPqXD796IKC5URrEvcgF5xFQ-6h07XRDpSRx1ECrNsUOt7UM3l1IB4doY11GzwQA5sHDTmUZ0-kBT76ZMf12Srg_N3hZwphxBtudYtN5VGZn420sVrQMdPE_7Ni3EiWT88j7WCr1xrF60l8sZT3yKCVleG7D2BEXacTntB7GktBv4Xo8OKnpwpqTpIlC05dMowMkz3rEAAYbQ
-puts token
-
-decoded_token = JWT.decode token, rsa_public, true, { algorithm: 'RS256' }
-
-# Array
-# [
-#   {"data"=>"test"}, # payload
-#   {"alg"=>"RS256"} # header
-# ]
-puts decoded_token
+decoded_token = JWT.decode(token, rsa_public, true, { algorithm: 'RS256' })
+# => [
+#      {"data"=>"test"}, # payload
+#      {"alg"=>"RS256"} # header
+#    ]
 ```
 
 ### **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
+payload   = { data: 'test' }
 ecdsa_key = OpenSSL::PKey::EC.generate('prime256v1')
 
-token = JWT.encode payload, ecdsa_key, 'ES256'
-
-# eyJhbGciOiJFUzI1NiJ9.eyJkYXRhIjoidGVzdCJ9.AlLW--kaF7EX1NMX9WJRuIW8NeRJbn2BLXHns7Q5TZr7Hy3lF6MOpMlp7GoxBFRLISQ6KrD0CJOrR8aogEsPeg
-puts token
+token = JWT.encode(payload, ecdsa_key, 'ES256')
+# => "eyJhbGciOiJFUzI1NiJ9.eyJkYXRhIjoidGVzdCJ9.AlLW--kaF7EX1NMX9WJRuIW8NeRJbn2BLXHns7Q5TZr7Hy3lF6MOpMlp7GoxBFRLISQ6KrD0CJOrR8aogEsPeg"
 
-decoded_token = JWT.decode token, ecdsa_key, true, { algorithm: 'ES256' }
-
-# Array
-# [
-#    {"test"=>"data"}, # payload
-#    {"alg"=>"ES256"} # header
-# ]
-puts decoded_token
+decoded_token = JWT.decode(token, ecdsa_key, true, { algorithm: 'ES256' })
+# => [
+#      {"test"=>"data"}, # payload
+#      {"alg"=>"ES256"} # header
+#    ]
 ```
 
-### **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
+### **EdDSA**
 
-```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
-# ]
-
-```
+Since version 3.0, the EdDSA algorithm has 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'
-```
+payload     = { data: 'test' }
+rsa_private = OpenSSL::PKey::RSA.generate(2048)
+rsa_public  = rsa_private.public_key
 
-* PS256 - RSASSA-PSS using SHA-256 hash algorithm
-* PS384 - RSASSA-PSS using SHA-384 hash algorithm
-* PS512 - RSASSA-PSS using SHA-512 hash algorithm
+token = JWT.encode(payload, rsa_private, 'PS256')
+# => "eyJhbGciOiJQUzI1NiJ9.eyJkYXRhIjoidGVzdCJ9.BRWizdUjD5zAWw-EDBcrl3dDpQDAePz9Ol3XKC43SggU47G8OWwveA_..."
 
-```ruby
-rsa_private = OpenSSL::PKey::RSA.generate 2048
-rsa_public = rsa_private.public_key
-
-token = JWT.encode payload, rsa_private, 'PS256'
-
-# eyJhbGciOiJQUzI1NiJ9.eyJkYXRhIjoidGVzdCJ9.KEmqagMUHM-NcmXo6818ZazVTIAkn9qU9KQFT1c5Iq91n0KRpAI84jj4ZCdkysDlWokFs3Dmn4MhcXP03oJKLFgnoPL40_Wgg9iFr0jnIVvnMUp1kp2RFUbL0jqExGTRA3LdAhuvw6ZByGD1bkcWjDXygjQw-hxILrT1bENjdr0JhFd-cB0-ps5SB0mwhFNcUw-OM3Uu30B1-mlFaelUY8jHJYKwLTZPNxHzndt8RGXF8iZLp7dGb06HSCKMcVzhASGMH4ZdFystRe2hh31cwcvnl-Eo_D4cdwmpN3Abhk_8rkxawQJR3duh8HNKc4AyFPo7SabEaSu2gLnLfN3yfg
-puts token
-
-decoded_token = JWT.decode token, rsa_public, true, { algorithm: 'PS256' }
-
-# Array
-# [
-#   {"data"=>"test"}, # payload
-#   {"alg"=>"PS256"} # header
-# ]
-puts decoded_token
+decoded_token = JWT.decode(token, rsa_public, true, { algorithm: 'PS256' })
+# => [
+#      {"data"=>"test"}, # payload
+#      {"alg"=>"PS256"} # header
+#    ]
 ```
 
 ### **Custom algorithms**
@@ -230,7 +163,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
@@ -248,82 +180,191 @@ module CustomHS512Algorithm
   end
 end
 
-token = ::JWT.encode({'pay' => 'load'}, 'secret', CustomHS512Algorithm)
-payload, header = ::JWT.decode(token, 'secret', true, algorithm: CustomHS512Algorithm)
-```
+payload  = { data: 'test' }
+token    = JWT.encode(payload, 'secret', CustomHS512Algorithm)
+# => "eyJhbGciOiJIUzUxMiJ9.eyJkYXRhIjoidGVzdCJ9.aBNoejLEM2WMF3TxzRDKlehYdG2ATvFpGNauTI4GSD2VJseS_sC8covrVMlgslf0aJM4SKb3EIeORJBFPtZ33w"
 
-## Support for reserved claim names
-JSON Web Token defines some reserved claim names and defines how they should be
-used. JWT supports these reserved claim names:
+decoded_token = JWT.decode(token, 'secret', true, algorithm: CustomHS512Algorithm)
+# => [
+#      {"data"=>"test"}, # payload
+#      {"alg"=>"HS512"} # header
+#    ]
+```
 
- - '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
+### Add custom header fields
 
-## Add custom header fields
-Ruby-jwt gem supports custom [header fields](https://tools.ietf.org/html/rfc7519#section-5)
+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, algorithm='HS256', header_fields={}
+payload = { data: 'test' }
+
+token = JWT.encode(payload, nil, 'none', { typ: 'JWT' })
+# => "eyJ0eXAiOiJKV1QiLCJhbGciOiJub25lIn0.eyJkYXRhIjoidGVzdCJ9."
+
+decoded_token = JWT.decode(token, nil, true, { algorithm: 'none' })
+#  => [
+#       {"data"=>"test"}, # payload
+#       {"typ"=>"JWT", "alg"=>"none"} # header
+#     ]
+```
+
+## `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
+payload = { exp: Time.now.to_i + 60, jti: '1234', sub: "my-subject" }
+header =  { kid: 'hmac' }
+
+token = JWT::Token.new(payload: payload, header: header)
+token.sign!(algorithm: 'HS256', key: "secret")
+
+token.jwt
+# => "eyJraWQiOiJobWFjIiwiYWxnIjoiSFMyNTYifQ.eyJleHAiOjE3NTAwMDU0NzksImp0aSI6IjEyMzQiLCJzdWIiOiJteS1zdWJqZWN0In0.NRLcK6fYr3IdNfmncJePMWLQ34M4n14EgqSYrQIjL9w"
 ```
 
-**Example:**
+### Verifying and decoding a token
+
+The `JWT::EncodedToken` can be used as a token object that allows verification of signatures and claims.
 
 ```ruby
-require 'jwt'
+encoded_token = JWT::EncodedToken.new(token.jwt)
 
-payload = { data: 'test' }
+encoded_token.verify_signature!(algorithm: 'HS256', key: "secret")
+encoded_token.verify_signature!(algorithm: 'HS256', key: "wrong_secret") # raises JWT::VerificationError
+encoded_token.verify_claims!(:exp, :jti)
+encoded_token.verify_claims!(sub: ["not-my-subject"]) # raises JWT::InvalidSubError
+encoded_token.claim_errors(sub: ["not-my-subject"]).map(&:message) # => ["Invalid subject. Expected [\"not-my-subject\"], received my-subject"]
+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'}
+```
+
+A JWK can be used to sign and verify the token if it's possible to derive the signing algorithm from the key.
+
+```ruby
+jwk_json = '{
+ "kty": "oct",
+ "k": "c2VjcmV0",
+ "alg": "HS256",
+ "kid": "hmac"
+}'
+
+jwk = JWT::JWK.import(JSON.parse(jwk_json))
+
+token = JWT::Token.new(payload: payload, header: header)
+
+token.sign!(key: jwk, algorithm: 'HS256')
 
-# IMPORTANT: set nil as password parameter
-token = JWT.encode payload, nil, 'none', { typ: 'JWT' }
+encoded_token = JWT::EncodedToken.new(token.jwt)
+encoded_token.verify!(signature: { algorithm: ["HS256", "HS512"], key: jwk})
+```
+
+#### Using a keyfinder
 
-# eyJhbGciOiJub25lIiwidHlwIjoiSldUIn0.eyJkYXRhIjoidGVzdCJ9.
-puts token
+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.
 
-# Set password to nil and validation to false otherwise this won't work
-decoded_token = JWT.decode token, nil, false
+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)
 
-# Array
-# [
-#   {"data"=>"test"}, # payload
-#   {"typ"=>"JWT", "alg"=>"none"} # header
-# ]
-puts decoded_token
+# 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.
+
+```ruby
+token = JWT::Token.new(payload: { pay: 'load' })
+token.sign!(algorithm: 'HS256', key: "secret")
+token.detach_payload!
+token.jwt # => "eyJhbGciOiJIUzI1NiJ9..UEhDY1Qlj29ammxuVRA_-gBah4qTy5FngIWg0yEAlC0"
+token.encoded_payload # => "eyJwYXkiOiJsb2FkIn0"
+```
+
+The `JWT::EncodedToken` class can be used to decode a token with a detached payload by providing the payload to the token instance in separate.
+
+```ruby
+encoded_token = JWT::EncodedToken.new(token.jwt)
+encoded_token.encoded_payload = "eyJwYXkiOiJsb2FkIn0"
+encoded_token.verify_signature!(algorithm: 'HS256', key: "secret")
+encoded_token.payload # => {"pay"=>"load"}
+```
+
+## Claims
+
+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
+
 ### 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
 exp_payload = { data: 'data', exp: exp }
 
-token = JWT.encode exp_payload, hmac_secret, 'HS256'
+token = JWT.encode(exp_payload, hmac_secret, 'HS256')
 
 begin
-  decoded_token = JWT.decode token, hmac_secret, true, { algorithm: 'HS256' }
+  decoded_token = JWT.decode(token, hmac_secret, true, { algorithm: 'HS256' })
 rescue JWT::ExpiredSignature
   # Handle expired token, e.g. logout user or deny access
 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' }
+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
@@ -332,11 +373,11 @@ leeway = 30 # seconds
 exp_payload = { data: 'data', exp: exp }
 
 # build expired token
-token = JWT.encode exp_payload, hmac_secret, 'HS256'
+token = JWT.encode(exp_payload, hmac_secret, 'HS256')
 
 begin
   # add leeway to ensure the token is still accepted
-  decoded_token = JWT.decode token, hmac_secret, true, { exp_leeway: leeway, algorithm: 'HS256' }
+  decoded_token = JWT.decode(token, hmac_secret, true, { exp_leeway: leeway, algorithm: 'HS256' })
 rescue JWT::ExpiredSignature
   # Handle expired token, e.g. logout user or deny access
 end
@@ -346,30 +387,29 @@ 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
 nbf_payload = { data: 'data', nbf: nbf }
 
-token = JWT.encode nbf_payload, hmac_secret, 'HS256'
+token = JWT.encode(nbf_payload, hmac_secret, 'HS256')
 
 begin
-  decoded_token = JWT.decode token, hmac_secret, true, { algorithm: 'HS256' }
+  decoded_token = JWT.decode(token, hmac_secret, true, { algorithm: 'HS256' })
 rescue JWT::ImmatureSignature
   # Handle invalid token, e.g. logout user or deny access
 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' }
+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
@@ -378,11 +418,11 @@ leeway = 30
 nbf_payload = { data: 'data', nbf: nbf }
 
 # build expired token
-token = JWT.encode nbf_payload, hmac_secret, 'HS256'
+token = JWT.encode(nbf_payload, hmac_secret, 'HS256')
 
 begin
   # add leeway to ensure the token is valid
-  decoded_token = JWT.decode token, hmac_secret, true, { nbf_leeway: leeway, algorithm: 'HS256' }
+  decoded_token = JWT.decode(token, hmac_secret, true, { nbf_leeway: leeway, algorithm: 'HS256' })
 rescue JWT::ImmatureSignature
   # Handle invalid token, e.g. logout user or deny access
 end
@@ -392,7 +432,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.
 
@@ -400,11 +440,11 @@ You can pass multiple allowed issuers as an Array, verification will pass if one
 iss = 'My Awesome Company Inc. or https://my.awesome.website/'
 iss_payload = { data: 'data', iss: iss }
 
-token = JWT.encode iss_payload, hmac_secret, 'HS256'
+token = JWT.encode(iss_payload, hmac_secret, 'HS256')
 
 begin
   # Add iss to the validation to check if the token has been manipulated
-  decoded_token = JWT.decode token, hmac_secret, true, { iss: iss, verify_iss: true, algorithm: 'HS256' }
+  decoded_token = JWT.decode(token, hmac_secret, true, { iss: iss, verify_iss: true, algorithm: 'HS256' })
 rescue JWT::InvalidIssuerError
   # Handle invalid token, e.g. logout user or deny access
 end
@@ -415,24 +455,24 @@ On supported ruby versions (>= 2.5) you can also delegate to methods, on older v
 to convert them to proc (using `to_proc`)
 
 ```ruby
-JWT.decode token, hmac_secret, true,
+JWT.decode(token, hmac_secret, true,
            iss: %r'https://my.awesome.website/',
            verify_iss: true,
-           algorithm: 'HS256'
+           algorithm: 'HS256')
 ```
 
 ```ruby
-JWT.decode token, hmac_secret, true,
+JWT.decode(token, hmac_secret, true,
            iss: ->(issuer) { issuer.start_with?('My Awesome Company Inc') },
            verify_iss: true,
-           algorithm: 'HS256'
+           algorithm: 'HS256')
 ```
 
 ```ruby
-JWT.decode token, hmac_secret, true,
+JWT.decode(token, hmac_secret, true,
            iss: method(:valid_issuer?),
            verify_iss: true,
-           algorithm: 'HS256'
+           algorithm: 'HS256')
 
 # somewhere in the same class:
 def valid_issuer?(issuer)
@@ -444,17 +484,17 @@ 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']
 aud_payload = { data: 'data', aud: aud }
 
-token = JWT.encode aud_payload, hmac_secret, 'HS256'
+token = JWT.encode(aud_payload, hmac_secret, 'HS256')
 
 begin
   # Add aud to the validation to check if the token has been manipulated
-  decoded_token = JWT.decode token, hmac_secret, true, { aud: aud, verify_aud: true, algorithm: 'HS256' }
+  decoded_token = JWT.decode(token, hmac_secret, true, { aud: aud, verify_aud: true, algorithm: 'HS256' })
 rescue JWT::InvalidAudError
   # Handle invalid token, e.g. logout user or deny access
   puts 'Audience Error'
@@ -473,15 +513,15 @@ jti_raw = [hmac_secret, iat].join(':').to_s
 jti = Digest::MD5.hexdigest(jti_raw)
 jti_payload = { data: 'data', iat: iat, jti: jti }
 
-token = JWT.encode jti_payload, hmac_secret, 'HS256'
+token = JWT.encode(jti_payload, hmac_secret, 'HS256')
 
 begin
   # If :verify_jti is true, validation will pass if a JTI is present
-  #decoded_token = JWT.decode token, hmac_secret, true, { verify_jti: true, algorithm: 'HS256' }
+  #decoded_token = JWT.decode(token, hmac_secret, true, { verify_jti: true, algorithm: 'HS256' })
   # Alternatively, pass a proc with your own code to check if the JTI has already been used
-  decoded_token = JWT.decode token, hmac_secret, true, { verify_jti: proc { |jti| my_validation_method(jti) }, algorithm: 'HS256' }
+  decoded_token = JWT.decode(token, hmac_secret, true, { verify_jti: proc { |jti| my_validation_method(jti) }, algorithm: 'HS256' })
   # or
-  decoded_token = JWT.decode token, hmac_secret, true, { verify_jti: proc { |jti, payload| my_validation_method(jti, payload) }, algorithm: 'HS256' }
+  decoded_token = JWT.decode(token, hmac_secret, true, { verify_jti: proc { |jti, payload| my_validation_method(jti, payload) }, algorithm: 'HS256' })
 rescue JWT::InvalidJtiError
   # Handle invalid token, e.g. logout user or deny access
   puts 'Error'
@@ -492,19 +532,17 @@ 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
 iat_payload = { data: 'data', iat: iat }
 
-token = JWT.encode iat_payload, hmac_secret, 'HS256'
+token = JWT.encode(iat_payload, hmac_secret, 'HS256')
 
 begin
   # Add iat to the validation to check if the token has been manipulated
-  decoded_token = JWT.decode token, hmac_secret, true, { verify_iat: true, algorithm: 'HS256' }
+  decoded_token = JWT.decode(token, hmac_secret, true, { verify_iat: true, algorithm: 'HS256' })
 rescue JWT::InvalidIatError
   # Handle invalid token, e.g. logout user or deny access
 end
@@ -514,17 +552,17 @@ 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'
 sub_payload = { data: 'data', sub: sub }
 
-token = JWT.encode sub_payload, hmac_secret, 'HS256'
+token = JWT.encode(sub_payload, hmac_secret, 'HS256')
 
 begin
   # Add sub to the validation to check if the token has been manipulated
-  decoded_token = JWT.decode token, hmac_secret, true, { sub: sub, verify_sub: true, algorithm: 'HS256' }
+  decoded_token = JWT.decode(token, hmac_secret, true, { sub: sub, verify_sub: true, algorithm: 'HS256' })
 rescue JWT::InvalidSubError
   # Handle invalid token, e.g. logout user or deny access
 end
@@ -535,6 +573,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)
@@ -546,8 +585,6 @@ JWT::Claims.verify_payload!({"exp" => Time.now.to_i - 10}, exp: { leeway: 11})
 JWT::Claims.verify_payload!({"exp" => Time.now.to_i + 10, "sub" => "subject"}, :exp, sub: "subject")
 ```
 
-
-
 ### Finding a Key
 
 To dynamically find the key for verifying the JWT signature, pass a block to the decode block. The block receives headers and the original payload as parameters. It should return with the key to verify the signature that was used to sign the JWT.
@@ -558,7 +595,7 @@ iss_payload = { data: 'data', iss: issuers.first }
 
 secrets = { issuers.first => hmac_secret, issuers.last => 'hmac_secret2' }
 
-token = JWT.encode iss_payload, hmac_secret, 'HS256'
+token = JWT.encode(iss_payload, hmac_secret, 'HS256')
 
 begin
   # Add iss to the validation to check if the token has been manipulated
@@ -573,9 +610,10 @@ 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' }
+JWT.decode(token, hmac_secret, true, { required_claims: ['exp'], algorithm: 'HS256' })
 ```
 
 ### X.509 certificates in x5c header
@@ -599,7 +637,7 @@ rescue JWT::DecodeError
 end
 ```
 
-### JSON Web Key (JWK)
+## JSON Web Key (JWK)
 
 JWK is a JSON structure representing a cryptographic key. This gem currently supports RSA, EC, OKP and HMAC keys. OKP support requires [RbNaCl](https://github.com/RubyCrypto/rbnacl) and currently only supports the Ed25519 curve.
 
@@ -626,14 +664,14 @@ algorithms = jwks.map { |key| key[:alg] }.compact.uniq
 JWT.decode(token, nil, true, algorithms: algorithms, jwks: jwks)
 ```
 
-
-The `jwks` option can also be given as a lambda that evaluates every time a kid is resolved.
+The `jwks` option can also be given as a lambda that evaluates every time a key identifier is resolved.
 This can be used to implement caching of remotely fetched JWK Sets.
 
-If the requested `kid` is not found from the given set the loader will be called a second time with the `kid_not_found` option set to `true`.
+Key identifiers can be specified using `kid`, `x5t` header parameters.
+If the requested identifier is not found from the given set the loader will be called a second time with the `kid_not_found` option set to `true`.
 The application can choose to implement some kind of JWK cache invalidation or other mechanism to handle such cases.
 
-Tokens without a specified `kid` are rejected by default.
+Tokens without a specified key identifier (`kid` or `x5t`) are rejected by default.
 This behaviour may be overwritten by setting the `allow_nil_kid` option for `decode` to `true`.
 
 ```ruby
@@ -712,7 +750,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.
 
@@ -721,7 +759,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:
 
@@ -732,6 +770,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