json-jwt 1.9.1 → 1.17.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 366867063d5d6443dc46c34adadd1a3fd4a7b574
-  data.tar.gz: 8295a9c7c3620e1cb32d47e4b27f2e6fbf947790
+SHA256:
+  metadata.gz: c53a91e5d33b3d3faa375c424a1aacba227456756da3eafe1794014ee69dae44
+  data.tar.gz: 5edb64703e8c0a0b91bceeff2d6313abbfbd86eee1623567cd2335e2cea7b1da
 SHA512:
-  metadata.gz: 5ce3939943d51965ca03d2dd34c6c40623b2d337ca6b8206dcc90ae29cf0e450c205bd66191ad6bc29f70edcf3567d92ad30cc96ee20dec3b737bbae134960b4
-  data.tar.gz: 7fdd1b34b2535b3fd905e46badd0d2cee536a071eb434bc145179c07772019823bff4fc2fc22eefebb40479570439e430cab9ad1e26849775cbfc45de2952bbb
+  metadata.gz: b1f8b09219b80b0e2350450522e53ead2dc344662617e517916063cc7a08f5c9dff5ba9d81f3ff3ebabadae708c71286db4b086d5093af0fb459cf1793ae3c28
+  data.tar.gz: da998f84ffaf2996b7ef02d9ad2f4aff6067ec14c352bb0f0f0811474506f00212171f8623363462b03dbe2f17832cb3873b9882dd70c5a136e4ba97e7b61217

data/.github/FUNDING.yml

@@ -0,0 +1,3 @@
+# These are supported funding model platforms
+
+github: nov

data/.github/workflows/spec.yml

@@ -0,0 +1,31 @@
+name: Spec
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+permissions:
+  contents: read
+
+jobs:
+  spec:
+    runs-on: ubuntu-latest
+    name: Ruby ${{ matrix.ruby }}
+    strategy:
+      matrix:
+        ruby:
+          - '3.2'
+          - '3.3'
+          - '3.4'
+          - '4.0'
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+    - name: Run Specs
+      run: bundle exec rake spec

data/.gitmodules

@@ -1,3 +1,3 @@
 [submodule "spec/helpers/json-jwt-nimbus"]
 	path = spec/helpers/json-jwt-nimbus
-	url = git://github.com/nov/json-jwt-nimbus.git
+	url = https://github.com/nov/json-jwt-nimbus.git

data/CHANGELOG.md

@@ -0,0 +1,17 @@
+## [Unreleased]
+
+## [1.16.0] - 2022-10-08
+
+### Fixed
+
+- Remove padding oracle by @btoews in https://github.com/nov/json-jwt/pull/109
+
+## [1.16.0] - 2022-10-08
+
+### Added
+
+- start recording CHANGELOG
+
+### Changed
+
+* Switch from httpclient to faraday v2 https://github.com/nov/json-jwt/pull/110

data/Gemfile

@@ -1,3 +1,3 @@
-source "http://rubygems.org"
+source "https://rubygems.org"
 
 gemspec

data/README.md

@@ -2,8 +2,6 @@
 
 JSON Web Token and its family (JSON Web Signature, JSON Web Encryption and JSON Web Key) in Ruby
 
-[![Build Status](https://secure.travis-ci.org/nov/json-jwt.png)](http://travis-ci.org/nov/json-jwt)
-
 ## Installation
 
 ```
@@ -49,6 +47,17 @@ input = "jwt_header.jwt_claims.jwt_signature"
 JSON::JWT.decode(input, public_key)
 ```
 
+If you need to get a JWK from `jwks_uri` of OpenID Connect IdP, you can use `JSON::JWK::Set::Fetcher` to fetch (& optionally cache) it.
+
+```ruby
+# JWK Set Fetching & Caching
+# NOTE: Optionally by setting cache instance, JWKs are cached by kid.
+JSON::JWK::Set::Fetcher.cache = Rails.cache
+
+JSON::JWK::Set::Fetcher.fetch(jwks_uri, kid: kid)
+# => returns JSON::JWK instance or raise JSON::JWK::Set::KidNotFound
+```
+
 For more details, read [Documentation Wiki](https://github.com/nov/json-jwt/wiki).
 
 ## Note on Patches/Pull Requests

data/VERSION

@@ -1 +1 @@
-1.9.1
+1.17.2

data/json-jwt.gemspec

@@ -7,16 +7,21 @@ Gem::Specification.new do |gem|
   gem.summary     = %q{JSON Web Token and its family (JSON Web Signature, JSON Web Encryption and JSON Web Key) in Ruby}
   gem.description = %q{JSON Web Token and its family (JSON Web Signature, JSON Web Encryption and JSON Web Key) in Ruby}
   gem.license     = 'MIT'
-  gem.files         = `git ls-files`.split("\n")
-  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.files         = `git ls-files`.split("\n").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
   gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   gem.require_paths = ['lib']
-  gem.add_runtime_dependency 'url_safe_base64'
-  gem.add_runtime_dependency 'activesupport'
+  gem.required_ruby_version = '>= 2.4'
+  gem.add_runtime_dependency 'activesupport', '>= 4.2'
+  gem.add_runtime_dependency 'base64'
   gem.add_runtime_dependency 'bindata'
-  gem.add_runtime_dependency 'securecompare'
+  gem.add_runtime_dependency 'aes_key_wrap'
+  gem.add_runtime_dependency 'faraday', '~> 2.0'
+  gem.add_runtime_dependency 'faraday-follow_redirects'
   gem.add_development_dependency 'rake'
   gem.add_development_dependency 'simplecov'
+  gem.add_development_dependency 'webmock'
   gem.add_development_dependency 'rspec'
   gem.add_development_dependency 'rspec-its'
 end

data/lib/json/jose.rb

@@ -1,4 +1,4 @@
-require 'securecompare'
+require 'active_support/security_utils'
 
 module JSON
   module JOSE
@@ -6,11 +6,12 @@ module JSON
 
     included do
       extend ClassMethods
-      include SecureCompare
       register_header_keys :alg, :jku, :jwk, :x5u, :x5t, :x5c, :kid, :typ, :cty, :crit
+
+      # NOTE: not used anymore in this gem, but keeping in case developers are calling it.
       alias_method :algorithm, :alg
 
-      attr_accessor :header
+      attr_writer :header
       def header
         @header ||= {}
       end
@@ -25,14 +26,24 @@ module JSON
       when JSON::JWK
         key.to_key
       when JSON::JWK::Set
-        key.detect do |jwk|
-          jwk[:kid] && jwk[:kid] == kid
-        end.try(:to_key) or raise JWK::Set::KidNotFound
+        key[kid]&.to_key or raise JWK::Set::KidNotFound
       else
         key
       end
     end
 
+    def secure_compare(a, b)
+      if ActiveSupport::SecurityUtils.respond_to?(:fixed_length_secure_compare)
+        begin
+          ActiveSupport::SecurityUtils.fixed_length_secure_compare(a, b)
+        rescue ArgumentError
+          false
+        end
+      else
+        ActiveSupport::SecurityUtils.secure_compare(a, b)
+      end
+    end
+
     module ClassMethods
       def register_header_keys(*keys)
         keys.each do |header_key|
@@ -45,15 +56,15 @@ module JSON
         end
       end
 
-      def decode(input, key_or_secret = nil, algorithms = nil, encryption_methods = nil)
+      def decode(input, key_or_secret = nil, algorithms = nil, encryption_methods = nil, allow_blank_payload = false)
         if input.is_a? Hash
-          decode_json_serialized input, key_or_secret, algorithms, encryption_methods
+          decode_json_serialized input, key_or_secret, algorithms, encryption_methods, allow_blank_payload
         else
-          decode_compact_serialized input, key_or_secret, algorithms, encryption_methods
+          decode_compact_serialized input, key_or_secret, algorithms, encryption_methods, allow_blank_payload
         end
-      rescue JSON::ParserError
+      rescue JSON::ParserError, ArgumentError
         raise JWT::InvalidFormat.new("Invalid JSON Format")
       end
     end
   end
-end
+end

data/lib/json/jwe.rb

@@ -1,5 +1,6 @@
 require 'securerandom'
 require 'bindata'
+require 'aes_key_wrap'
 
 module JSON
   class JWE
@@ -13,9 +14,10 @@ module JSON
 
     attr_accessor(
       :public_key_or_secret, :private_key_or_secret,
-      :plain_text, :cipher_text, :authentication_tag, :iv, :auth_data,
-      :content_encryption_key, :jwe_encrypted_key, :encryption_key, :mac_key
+      :plain_text, :cipher_text, :iv, :auth_data,
+      :content_encryption_key, :encryption_key, :mac_key
     )
+    attr_writer :jwe_encrypted_key, :authentication_tag
 
     register_header_keys :enc, :epk, :zip, :apu, :apv
     alias_method :encryption_method, :enc
@@ -31,7 +33,7 @@ module JSON
       self.mac_key, self.encryption_key = derive_encryption_and_mac_keys
       cipher.key = encryption_key
       self.iv = cipher.random_iv # NOTE: 'iv' has to be set after 'key' for GCM
-      self.auth_data = UrlSafeBase64.encode64 header.to_json
+      self.auth_data = Base64.urlsafe_encode64 header.to_json, padding: false
       cipher.auth_data = auth_data if gcm?
       self.cipher_text = cipher.update(plain_text) + cipher.final
       self
@@ -41,17 +43,29 @@ module JSON
       raise UnexpectedAlgorithm.new('Unexpected alg header') unless algorithms.blank? || Array(algorithms).include?(alg)
       raise UnexpectedAlgorithm.new('Unexpected enc header') unless encryption_methods.blank? || Array(encryption_methods).include?(enc)
       self.private_key_or_secret = with_jwk_support private_key_or_secret
-      cipher.decrypt
       self.content_encryption_key = decrypt_content_encryption_key
       self.mac_key, self.encryption_key = derive_encryption_and_mac_keys
+
+      verify_cbc_authentication_tag! if cbc?
+
+      cipher.decrypt
       cipher.key = encryption_key
       cipher.iv = iv # NOTE: 'iv' has to be set after 'key' for GCM
       if gcm?
+        # https://github.com/ruby/openssl/issues/63
+        raise DecryptionFailed.new('Invalid authentication tag') if authentication_tag.length < 16
         cipher.auth_tag = authentication_tag
         cipher.auth_data = auth_data
       end
-      self.plain_text = cipher.update(cipher_text) + cipher.final
-      verify_cbc_authentication_tag! if cbc?
+
+      begin
+        self.plain_text = cipher.update(cipher_text) + cipher.final
+      rescue OpenSSL::OpenSSLError
+        # Ensure that the same error is raised for invalid PKCS7 padding
+        # as for invalid signatures. This prevents padding-oracle attacks.
+        raise DecryptionFailed
+      end
+
       self
     end
 
@@ -63,7 +77,7 @@ module JSON
         cipher_text,
         authentication_tag
       ].collect do |segment|
-        UrlSafeBase64.encode64 segment.to_s
+        Base64.urlsafe_encode64 segment.to_s, padding: false
       end.join('.')
     end
 
@@ -71,21 +85,21 @@ module JSON
       case options[:syntax]
       when :general
         {
-          protected:  UrlSafeBase64.encode64(header.to_json),
+          protected:  Base64.urlsafe_encode64(header.to_json, padding: false),
           recipients: [{
-            encrypted_key: UrlSafeBase64.encode64(jwe_encrypted_key)
+            encrypted_key: Base64.urlsafe_encode64(jwe_encrypted_key, padding: false)
           }],
-          iv:         UrlSafeBase64.encode64(iv),
-          ciphertext: UrlSafeBase64.encode64(cipher_text),
-          tag:        UrlSafeBase64.encode64(authentication_tag)
+          iv:         Base64.urlsafe_encode64(iv, padding: false),
+          ciphertext: Base64.urlsafe_encode64(cipher_text, padding: false),
+          tag:        Base64.urlsafe_encode64(authentication_tag, padding: false)
         }
       else
         {
-          protected:     UrlSafeBase64.encode64(header.to_json),
-          encrypted_key: UrlSafeBase64.encode64(jwe_encrypted_key),
-          iv:            UrlSafeBase64.encode64(iv),
-          ciphertext:    UrlSafeBase64.encode64(cipher_text),
-          tag:           UrlSafeBase64.encode64(authentication_tag)
+          protected:     Base64.urlsafe_encode64(header.to_json, padding: false),
+          encrypted_key: Base64.urlsafe_encode64(jwe_encrypted_key, padding: false),
+          iv:            Base64.urlsafe_encode64(iv, padding: false),
+          ciphertext:    Base64.urlsafe_encode64(cipher_text, padding: false),
+          tag:           Base64.urlsafe_encode64(authentication_tag, padding: false)
         }
       end
     end
@@ -95,15 +109,15 @@ module JSON
     # common
 
     def gcm?
-      [:A128GCM, :A256GCM].include? encryption_method.try(:to_sym)
+      [:A128GCM, :A256GCM].include? encryption_method&.to_sym
     end
 
     def cbc?
-      [:'A128CBC-HS256', :'A256CBC-HS512'].include? encryption_method.try(:to_sym)
+      [:'A128CBC-HS256', :'A256CBC-HS512'].include? encryption_method&.to_sym
     end
 
     def dir?
-      :dir == algorithm.try(:to_sym)
+      :dir == alg&.to_sym
     end
 
     def cipher
@@ -112,7 +126,7 @@ module JSON
     end
 
     def cipher_name
-      case encryption_method.try(:to_sym)
+      case encryption_method&.to_sym
       when :A128GCM
         'aes-128-gcm'
       when :A256GCM
@@ -127,7 +141,7 @@ module JSON
     end
 
     def sha_size
-      case encryption_method.try(:to_sym)
+      case encryption_method&.to_sym
       when :'A128CBC-HS256'
         256
       when :'A256CBC-HS512'
@@ -155,15 +169,13 @@ module JSON
     # encryption
 
     def jwe_encrypted_key
-      @jwe_encrypted_key ||= case algorithm.try(:to_sym)
+      @jwe_encrypted_key ||= case alg&.to_sym
       when :RSA1_5
         public_key_or_secret.public_encrypt content_encryption_key
       when :'RSA-OAEP'
         public_key_or_secret.public_encrypt content_encryption_key, OpenSSL::PKey::RSA::PKCS1_OAEP_PADDING
-      when :A128KW
-        raise NotImplementedError.new('A128KW not supported yet')
-      when :A256KW
-        raise NotImplementedError.new('A256KW not supported yet')
+      when :A128KW, :A256KW
+        AESKeyWrap.wrap content_encryption_key, public_key_or_secret
       when :dir
         ''
       when :'ECDH-ES'
@@ -209,15 +221,13 @@ module JSON
 
     def decrypt_content_encryption_key
       fake_content_encryption_key = generate_content_encryption_key # NOTE: do this always not to make timing difference
-      case algorithm.try(:to_sym)
+      case alg&.to_sym
       when :RSA1_5
         private_key_or_secret.private_decrypt jwe_encrypted_key
       when :'RSA-OAEP'
         private_key_or_secret.private_decrypt jwe_encrypted_key, OpenSSL::PKey::RSA::PKCS1_OAEP_PADDING
-      when :A128KW
-        raise NotImplementedError.new('A128KW not supported yet')
-      when :A256KW
-        raise NotImplementedError.new('A256KW not supported yet')
+      when :A128KW, :A256KW
+        AESKeyWrap.unwrap jwe_encrypted_key, private_key_or_secret
       when :dir
         private_key_or_secret
       when :'ECDH-ES'
@@ -244,18 +254,25 @@ module JSON
         sha_digest, mac_key, secured_input
       )[0, sha_size / 2 / 8]
       unless secure_compare(authentication_tag, expected_authentication_tag)
-        raise DecryptionFailed.new('Invalid authentication tag')
+        raise DecryptionFailed
       end
     end
 
     class << self
-      def decode_compact_serialized(input, private_key_or_secret, algorithms = nil, encryption_methods = nil)
+      def decode_compact_serialized(input, private_key_or_secret, algorithms = nil, encryption_methods = nil, allow_blank_payload = false)
+        if allow_blank_payload
+          raise InvalidFormat.new("JWE w/ blank payload is not supported.")
+        end
         unless input.count('.') + 1 == NUM_OF_SEGMENTS
           raise InvalidFormat.new("Invalid JWE Format. JWE should include #{NUM_OF_SEGMENTS} segments.")
         end
         jwe = new
-        _header_json_, jwe.jwe_encrypted_key, jwe.iv, jwe.cipher_text, jwe.authentication_tag = input.split('.').collect do |segment|
-          UrlSafeBase64.decode64 segment
+        _header_json_, jwe.jwe_encrypted_key, jwe.iv, jwe.cipher_text, jwe.authentication_tag = input.split('.', NUM_OF_SEGMENTS).collect do |segment|
+          begin
+            Base64.urlsafe_decode64 segment
+          rescue ArgumentError
+            raise DecryptionFailed
+          end
         end
         jwe.auth_data = input.split('.').first
         jwe.header = JSON.parse(_header_json_).with_indifferent_access
@@ -265,7 +282,7 @@ module JSON
         jwe
       end
 
-      def decode_json_serialized(input, private_key_or_secret, algorithms = nil, encryption_methods = nil)
+      def decode_json_serialized(input, private_key_or_secret, algorithms = nil, encryption_methods = nil, allow_blank_payload = false)
         input = input.with_indifferent_access
         jwe_encrypted_key = if input[:recipients].present?
           input[:recipients].first[:encrypted_key]
@@ -279,7 +296,7 @@ module JSON
           input[:ciphertext],
           input[:tag]
         ].join('.')
-        decode_compact_serialized compact_serialized, private_key_or_secret, algorithms, encryption_methods
+        decode_compact_serialized compact_serialized, private_key_or_secret, algorithms, encryption_methods, allow_blank_payload
       end
     end
   end

data/lib/json/jwk/jwkizable.rb

@@ -5,17 +5,17 @@ module JSON
         def to_jwk(ex_params = {})
           params = {
             kty: :RSA,
-            e: UrlSafeBase64.encode64(e.to_s(2)),
-            n: UrlSafeBase64.encode64(n.to_s(2))
+            e: Base64.urlsafe_encode64(e.to_s(2), padding: false),
+            n: Base64.urlsafe_encode64(n.to_s(2), padding: false)
           }.merge ex_params
           if private?
             params.merge!(
-              d: UrlSafeBase64.encode64(d.to_s(2)),
-              p: UrlSafeBase64.encode64(p.to_s(2)),
-              q: UrlSafeBase64.encode64(q.to_s(2)),
-              dp: UrlSafeBase64.encode64(dmp1.to_s(2)),
-              dq: UrlSafeBase64.encode64(dmq1.to_s(2)),
-              qi: UrlSafeBase64.encode64(iqmp.to_s(2)),
+              d: Base64.urlsafe_encode64(d.to_s(2), padding: false),
+              p: Base64.urlsafe_encode64(p.to_s(2), padding: false),
+              q: Base64.urlsafe_encode64(q.to_s(2), padding: false),
+              dp: Base64.urlsafe_encode64(dmp1.to_s(2), padding: false),
+              dq: Base64.urlsafe_encode64(dmq1.to_s(2), padding: false),
+              qi: Base64.urlsafe_encode64(iqmp.to_s(2), padding: false),
             )
           end
           JWK.new params
@@ -27,10 +27,10 @@ module JSON
           params = {
             kty: :EC,
             crv: curve_name,
-            x: UrlSafeBase64.encode64([coordinates[:x]].pack('H*')),
-            y: UrlSafeBase64.encode64([coordinates[:y]].pack('H*'))
+            x: Base64.urlsafe_encode64([coordinates[:x]].pack('H*'), padding: false),
+            y: Base64.urlsafe_encode64([coordinates[:y]].pack('H*'), padding: false)
           }.merge ex_params
-          params[:d] = UrlSafeBase64.encode64([coordinates[:d]].pack('H*')) if private_key?
+          params[:d] = Base64.urlsafe_encode64([coordinates[:d]].pack('H*'), padding: false) if private_key?
           JWK.new params
         end
 
@@ -44,6 +44,8 @@ module JSON
             :'P-384'
           when 'secp521r1'
             :'P-521'
+          when 'secp256k1'
+            :secp256k1
           else
             raise UnknownAlgorithm.new('Unknown EC Curve')
           end

data/lib/json/jwk/set/fetcher.rb

@@ -0,0 +1,93 @@
+module JSON
+  class JWK
+    class Set
+      module Fetcher
+        class UnexpectedFormat < JWT::Exception; end
+
+        class Cache
+          def fetch(cache_key, options = {})
+            yield
+          end
+
+          def delete(cache_key, options = {}); end
+        end
+
+        def self.logger
+          @@logger
+        end
+        def self.logger=(logger)
+          @@logger = logger
+        end
+        self.logger = Logger.new(STDOUT)
+        self.logger.progname = 'JSON::JWK::Set::Fetcher'
+
+        def self.debugging?
+          @@debugging
+        end
+        def self.debugging=(boolean)
+          @@debugging = boolean
+        end
+        def self.debug!
+          self.debugging = true
+        end
+        def self.debug(&block)
+          original = self.debugging?
+          debug!
+          yield
+        ensure
+          self.debugging = original
+        end
+        self.debugging = false
+
+        def self.http_client
+          Faraday.new(headers: {user_agent: "JSON::JWK::Set::Fetcher #{VERSION}"}) do |faraday|
+            faraday.response :raise_error
+            faraday.response :follow_redirects
+            faraday.response :logger, JSON::JWK::Set::Fetcher.logger if debugging?
+            faraday.adapter Faraday.default_adapter
+            http_config.try(:call, faraday)
+          end
+        end
+        def self.http_config(&block)
+          @@http_config ||= block
+        end
+
+        def self.cache=(cache)
+          @@cache = cache
+        end
+        def self.cache
+          @@cache
+        end
+        self.cache = Cache.new
+
+        def self.fetch(jwks_uri, kid:, auto_detect: true, **options)
+          cache_key = [
+            'json:jwk:set',
+            OpenSSL::Digest::MD5.hexdigest(jwks_uri),
+            kid
+          ].collect(&:to_s).join(':')
+
+          parsed_jwks = JSON.parse(
+            cache.fetch(cache_key, options) do
+              http_client.get(jwks_uri).body
+            end
+          )
+
+          unless parsed_jwks.is_a?(Hash) && parsed_jwks['keys'].is_a?(Array)
+            cache.delete(cache_key, options)
+            raise UnexpectedFormat
+          end
+
+          jwks = Set.new(parsed_jwks)
+          cache.delete(cache_key, options) if jwks[kid].blank?
+
+          if auto_detect
+            jwks[kid] or raise KidNotFound
+          else
+            jwks
+          end
+        end
+      end
+    end
+  end
+end

data/lib/json/jwk/set.rb

@@ -19,10 +19,16 @@ module JSON
         'application/jwk-set+json'
       end
 
+      def [](kid)
+        detect do |jwk|
+          jwk[:kid] && jwk[:kid] == kid
+        end
+      end
+
       def as_json(options = {})
         # NOTE: Array.new wrapper is requied to avoid CircularReferenceError
         {keys: Array.new(self)}
       end
     end
   end
-end
+end