doorkeeper-jwt 0.4.0 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 32f8802b270dd6aff8c6ded3545b79fc84be4fa2dc856401e39f60a2818ef986
-  data.tar.gz: adfeb942ae99d8631d44cdeb722c6e40967b2319cc1398191bcb22ca50f2e047
+  metadata.gz: '04826fc219f000cfbb34243981e137fdc91f54d4aaf9d2e4ee16c8db5bc80763'
+  data.tar.gz: 2cd2fe00356eae0b93a461c0aa58b52c489ae457a93f69cd1dcd73757b51746e
 SHA512:
-  metadata.gz: 4a24d1a2a83d19d1bbe96b57da628bd3cd42842e1dd92a782b3bbe16b98cd6fa0594a79f83d61d6b22db6f46716c986b3e3a7eb3b948bce29fd093234baad84b
-  data.tar.gz: 55d64e0e301287f05b07548b7110c04c83fbef478bb43d09b4ce03a72d235a45bfaa44349ab77f58922cdb7fe4bfa8918adc25fa818c203c5ec778cf3ac1c846
+  metadata.gz: efa77d9a020f5a5665365acd3dccd9605a30c0bf7fd4d9b60027b0ed0827aa2a11f93dc45a7857609fe690be98fd8f8b34cabf025648dfcfd1a1cc5dd91f72ac
+  data.tar.gz: bb8d14619a2a724047d46c25f6f3c0127bd52f94834128037059883f98842159fdac71edd88bdcc1d9f2fadf96cb7c9c896f24171d5a1eed9cd1e16474979568

data/.github/dependabot.yml

@@ -0,0 +1,7 @@
+version: 2
+updates:
+- package-ecosystem: bundler
+  directory: "/"
+  schedule:
+    interval: daily
+  open-pull-requests-limit: 10

data/.github/workflows/ci.yml

@@ -0,0 +1,38 @@
+name: CI
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    name: >-
+      Ruby ${{ matrix.ruby }}
+    env:
+      CI: true
+    runs-on: ${{ matrix.os }}
+    continue-on-error: ${{ endsWith(matrix.ruby, 'head') || matrix.ruby == 'debug' || matrix.experimental }}
+    if: |
+      !(   contains(github.event.pull_request.title,  '[ci skip]')
+        || contains(github.event.pull_request.title,  '[skip ci]'))
+    strategy:
+      fail-fast: true
+      matrix:
+        experimental: [false]
+        os: [ ubuntu-latest ]
+        ruby:
+          - 2.6
+          - 2.7
+          - '3.0'
+          - '3.1'
+    steps:
+      - name: Repo checkout
+        uses: actions/checkout@v2
+
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+
+      - name: Run tests
+        timeout-minutes: 10
+        run: bundle exec rake test

data/.hound.yml

@@ -1,2 +1,3 @@
 rubocop:
   config_file: .rubocop.yml
+  version: 0.72.0

data/.rubocop.yml

@@ -8,12 +8,48 @@ AllCops:
   ExtraDetails: true
   TargetRubyVersion: 2.5
 
+Metrics/LineLength:
+  Exclude:
+    - spec/**/*
+  Max: 100
+
 Metrics/BlockLength:
-  Enabled: false
+  Exclude:
+    - spec/**/*
+    - doorkeeper-jwt.gemspec
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
 
-Metrics/MethodLength:
+Style/FrozenStringLiteralComment:
+  Enabled: true
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: consistent_comma
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: consistent_comma
+
+Style/SymbolArray:
+  MinSize: 3
+Style/WordArray:
+  MinSize: 3
+
+Style/ClassAndModuleChildren:
+  Exclude:
+    - spec/**/*
+Style/NumericPredicate:
+  Enabled: false
+Style/DoubleNegation:
   Enabled: false
 
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+Layout/TrailingBlankLines:
+  Enabled: true
+Layout/DotPosition:
+  EnforcedStyle: leading
 
 Naming/FileName:
   Exclude:

data/CHANGELOG.md

@@ -6,9 +6,24 @@ project adheres to [Semantic Versioning](http://semver.org/).
 
 ## master
 
+Add here
+
+## [0.4.2] - 2024-08-12
+
+-  Rename encryption_method to signing_method [#53](https://github.com/doorkeeper-gem/doorkeeper-jwt/pull/53)
+-  Fix default token generation [#56](https://github.com/doorkeeper-gem/doorkeeper-jwt/pull/56)
+
+### Fixed
+
+- Fixed default token generation to return a random hex value [#56](https://github.com/doorkeeper-gem/doorkeeper-jwt/pull/56)
+
+## [0.4.1] - 2022-02-23
+
+- JWT gem requirement relaxed to use any version >= 2.1
+
 ### Changed
 
-## [0.4.0] - 2019-06-11
+## [0.4.0] - 2019-10-02
 
 - Restructured library files to follow naming conventions. (https://guides.rubygems.org/name-your-gem/).
 - Add support of new doorkeeper with encryption [#30](https://github.com/doorkeeper-gem/doorkeeper-jwt/pull/30)

data/Gemfile

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in doorkeeper-jwt.gemspec
 gemspec
 
-gem 'coveralls', require: false
-gem 'rubocop', '~> 0.59.2', require: false
-gem 'rubocop-rspec', '~> 1.30', require: false
+gem "coveralls", require: false
+gem "rubocop", "~> 1.8", require: false
+gem "rubocop-rspec", "~> 3.0", require: false

data/README.md

@@ -49,9 +49,11 @@ Doorkeeper::JWT.configure do
     {
       iss: 'My App',
       iat: Time.current.utc.to_i,
+      aud: opts[:application][:uid],
 
       # @see JWT reserved claims - https://tools.ietf.org/html/draft-jones-json-web-token-07#page-7
       jti: SecureRandom.uuid,
+      sub: user.id,
 
       user: {
         id: user.id,
@@ -62,27 +64,29 @@ Doorkeeper::JWT.configure do
 
   # Optionally set additional headers for the JWT. See
   # https://tools.ietf.org/html/rfc7515#section-4.1
-  token_headers do |opts|
-    { kid: opts[:application][:uid] }
-  end
+  # JWK can be used to automatically verify RS* tokens client-side if token's kid matches a public kid in /oauth/discovery/keys
+  # token_headers do |_opts|
+  #   key = OpenSSL::PKey::RSA.new(File.read(File.join('path', 'to', 'file.pem')))
+  #   { kid: JWT::JWK.new(key)[:kid] }
+  # end
 
   # Use the application secret specified in the access grant token. Defaults to
   # `false`. If you specify `use_application_secret true`, both `secret_key` and
   # `secret_key_path` will be ignored.
   use_application_secret false
 
-  # Set the encryption secret. This would be shared with any other applications
-  # that should be able to read the payload of the token. Defaults to "secret".
+  # Set the signing secret. This would be shared with any other applications
+  # that should be able to verify the authenticity of the token. Defaults to "secret".
   secret_key ENV['JWT_SECRET']
 
-  # If you want to use RS* encoding specify the path to the RSA key to use for
+  # If you want to use RS* algorithms specify the path to the RSA key to use for
   # signing. If you specify a `secret_key_path` it will be used instead of
   # `secret_key`.
   secret_key_path File.join('path', 'to', 'file.pem')
 
-  # Specify encryption type (https://github.com/progrium/ruby-jwt). Defaults to
+  # Specify cryptographic signing algorithm type (https://github.com/progrium/ruby-jwt). Defaults to
   # `nil`.
-  encryption_method :hs512
+  signing_method :hs512
 end
 ```
 

data/Rakefile

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new
 

data/bin/console

@@ -1,8 +1,8 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require 'bundler/setup'
-require 'doorkeeper-jwt'
+require "bundler/setup"
+require "doorkeeper-jwt"
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -12,6 +12,6 @@ require 'doorkeeper-jwt'
 #
 # Pry.start
 
-require 'irb'
+require "irb"
 
 IRB.start

data/doorkeeper-jwt.gemspec

@@ -1,31 +1,31 @@
 # frozen_string_literal: true
 
-lib = File.expand_path('lib', __dir__)
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
-require 'doorkeeper/jwt/version'
+require "doorkeeper/jwt/version"
 
 Gem::Specification.new do |spec|
-  spec.name    = 'doorkeeper-jwt'
+  spec.name = "doorkeeper-jwt"
   spec.version = Doorkeeper::JWT.gem_version
-  spec.authors = ['Chris Warren']
-  spec.email   = ['chris@expectless.com']
+  spec.authors = ["Chris Warren", "Nikita Bulai"]
+  spec.email = ["chris@expectless.com"]
 
-  spec.summary     = 'JWT token generator for Doorkeeper'
-  spec.description = 'JWT token generator extension for Doorkeeper'
-  spec.homepage    = 'https://github.com/chriswarren/doorkeeper-jwt'
-  spec.license     = 'MIT'
+  spec.summary = "JWT token generator for Doorkeeper"
+  spec.description = "JWT token generator extension for Doorkeeper"
+  spec.homepage = "https://github.com/chriswarren/doorkeeper-jwt"
+  spec.license = "MIT"
 
-  spec.bindir        = 'exe'
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ['lib']
+  spec.bindir = "exe"
+  spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
 
-  spec.add_dependency 'jwt', '~> 2.1'
+  spec.add_dependency "jwt", ">= 2.1"
 
-  spec.add_development_dependency 'bundler', '>= 1.16', '< 3'
-  spec.add_development_dependency 'pry', '~> 0'
-  spec.add_development_dependency 'rake', '~> 12.3'
-  spec.add_development_dependency 'rspec', '~> 3.8'
+  spec.add_development_dependency "bundler", ">= 1.16", "< 3"
+  spec.add_development_dependency "pry", "~> 0"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.8"
 end

data/lib/doorkeeper/jwt/config.rb

@@ -4,7 +4,7 @@ module Doorkeeper
   module JWT
     class MissingConfiguration < StandardError
       def initialize
-        super('Configuration for doorkeeper-jwt missing.')
+        super("Configuration for doorkeeper-jwt missing.")
       end
     end
 
@@ -28,19 +28,25 @@ module Doorkeeper
         end
 
         def use_application_secret(value)
-          @config.instance_variable_set('@use_application_secret', value)
+          @config.instance_variable_set("@use_application_secret", value)
         end
 
         def secret_key(value)
-          @config.instance_variable_set('@secret_key', value)
+          @config.instance_variable_set("@secret_key", value)
         end
 
         def secret_key_path(value)
-          @config.instance_variable_set('@secret_key_path', value)
+          @config.instance_variable_set("@secret_key_path", value)
         end
 
+        # For backward compatibility. This library does not support encryption.
         def encryption_method(value)
-          @config.instance_variable_set('@encryption_method', value)
+          @config.instance_variable_set("@signing_method", value)
+          Kernel.warn("[DOORKEEPER-JWT]: Please use signing_method instead, this option is deprecated and will be removed soon")
+        end
+
+        def signing_method(value)
+          @config.instance_variable_set("@signing_method", value)
         end
       end
 
@@ -111,14 +117,14 @@ module Doorkeeper
 
       option(
         :token_payload,
-        default: proc { { token: SecureRandom.method(:hex) } }
+        default: proc { { token: SecureRandom.hex } },
       )
 
       option :token_headers, default: proc { {} }
       option :use_application_secret, default: false
       option :secret_key, default: nil
       option :secret_key_path, default: nil
-      option :encryption_method, default: nil
+      option :signing_method, default: nil
 
       def use_application_secret
         @use_application_secret ||= false
@@ -132,8 +138,8 @@ module Doorkeeper
         @secret_key_path ||= nil
       end
 
-      def encryption_method
-        @encryption_method ||= nil
+      def signing_method
+        @signing_method ||= nil
       end
     end
   end

data/lib/doorkeeper/jwt/version.rb

@@ -10,11 +10,11 @@ module Doorkeeper
       # Semantic versioning
       MAJOR = 0
       MINOR = 4
-      TINY = 0
+      TINY = 2
       PRE = nil
 
       # Full version number
-      STRING = [MAJOR, MINOR, TINY, PRE].compact.join('.')
+      STRING = [MAJOR, MINOR, TINY, PRE].compact.join(".")
     end
   end
 end

data/lib/doorkeeper/jwt.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require 'doorkeeper/jwt/version'
-require 'doorkeeper/jwt/config'
-require 'jwt'
+require "doorkeeper/jwt/version"
+require "doorkeeper/jwt/config"
+require "jwt"
 
 module Doorkeeper
   module JWT
@@ -11,7 +11,7 @@ module Doorkeeper
         ::JWT.encode(
           token_payload(opts),
           secret_key(opts),
-          encryption_method,
+          signing_method,
           token_headers(opts)
         )
       end
@@ -31,22 +31,22 @@ module Doorkeeper
 
         return application_secret(opts) if use_application_secret?
         return secret_key_file unless secret_key_file.nil?
-        return rsa_key if rsa_encryption?
-        return ecdsa_key if ecdsa_encryption?
+        return rsa_key if rsa_signing?
+        return ecdsa_key if ecdsa_signing?
 
         Doorkeeper::JWT.configuration.secret_key
       end
 
       def secret_key_file
         return nil if Doorkeeper::JWT.configuration.secret_key_path.nil?
-        return rsa_key_file if rsa_encryption?
-        return ecdsa_key_file if ecdsa_encryption?
+        return rsa_key_file if rsa_signing?
+        return ecdsa_key_file if ecdsa_signing?
       end
 
-      def encryption_method
-        return 'none' unless Doorkeeper::JWT.configuration.encryption_method
+      def signing_method
+        return "none" unless Doorkeeper::JWT.configuration.signing_method
 
-        Doorkeeper::JWT.configuration.encryption_method.to_s.upcase
+        Doorkeeper::JWT.configuration.signing_method.to_s.upcase
       end
 
       def use_application_secret?
@@ -56,8 +56,8 @@ module Doorkeeper
       def application_secret(opts)
         if opts[:application].nil?
           raise(
-            'JWT `use_application_secret` is enabled, but application is nil.' \
-            ' This can happen if `client_id` was absent in the request params.'
+            "JWT `use_application_secret` is enabled, but application is nil." \
+            " This can happen if `client_id` was absent in the request params."
           )
         end
 
@@ -75,20 +75,20 @@ module Doorkeeper
 
         if secret.nil?
           raise(
-            'JWT `use_application_secret` is enabled, but the application' \
-            ' secret is nil.'
+            "JWT `use_application_secret` is enabled, but the application" \
+            " secret is nil."
           )
         end
 
         secret
       end
 
-      def rsa_encryption?
-        /RS\d{3}/ =~ encryption_method
+      def rsa_signing?
+        /RS\d{3}/ =~ signing_method
       end
 
-      def ecdsa_encryption?
-        /ES\d{3}/ =~ encryption_method
+      def ecdsa_signing?
+        /ES\d{3}/ =~ signing_method
       end
 
       def rsa_key

metadata

@@ -1,27 +1,28 @@
 --- !ruby/object:Gem::Specification
 name: doorkeeper-jwt
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.2
 platform: ruby
 authors:
 - Chris Warren
+- Nikita Bulai
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-10-02 00:00:00.000000000 Z
+date: 2024-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jwt
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.1'
 - !ruby/object:Gem::Dependency
@@ -64,14 +65,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -93,11 +94,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/dependabot.yml"
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".hound.yml"
 - ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -128,7 +130,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.2
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: JWT token generator for Doorkeeper

data/.travis.yml

@@ -1,6 +0,0 @@
-language: ruby
-rvm:
-  - 2.2
-  - 2.3
-  - 2.4
-  - 2.5