jwt_sessions 2.5.0 → 2.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cb5fdf14070b5d76ee868b427684fba6797cada31600e28b3346c601d7a3079e
-  data.tar.gz: fb709c41d45a11ea6e5b2d93f991326c0ddd4a562995dc837099af138b86ee08
+  metadata.gz: ad42d33af309b3295e9aa6402179df2a9a0ac5e17618d133427e27edafca9578
+  data.tar.gz: e67b97b9bf3a2aec4bba3f66cc517d4dad03bcb4ce73269147cce31bcd9d85d4
 SHA512:
-  metadata.gz: 742c465fe4f58ca7327cc1257b98e21f658e891c12e5637bde92c8ca48010a284db43ec8af0ff53454f6642927a1de1cb2b5473619d7c5ecdaba706fba6e4527
-  data.tar.gz: 6247a76e67522e23211a6a6791312d6c50b06598b34743a92f7c32ec841a75928a6eae08d17fc3968fb9cff3ec886efcf7e0a19fe7bea9291dc7b0560fd0a658
+  metadata.gz: fe6bc8a993388688a85d6b86ea139ab8d3123b628db77181fa4db6ba68d92c0080ca16fdfcaeb3567be9f2a07896df711cb9edb9c7845d6a226408e6fda00de9
+  data.tar.gz: 712ea681644f82710f5d561a96e78df86c1c3e4c225b8535a9d1cd2e03bcb363d93e4b42764847b786461e26f6f9440a3f85b026e02fa557c647a5866eef70dc

data/CHANGELOG.md

@@ -0,0 +1,55 @@
+## 2.7.0 (October 05, 2021)
+
+Features:
+
+- added redis_client setting to JWTSessions::StoreAdapters::RedisStoreAdapter
+
+## 2.6.0 (June 01, 2021)
+
+Features:
+
+- added support for all Redis settings
+
+Support:
+
+- updated jwt to '>= 2.2.3'
+- switched to redis scan when looking for keys
+- removed extra gems from gemspec deps
+- updated gems in dummy apps
+
+## 2.5.2 (July 06, 2020)
+
+Bugfixes:
+
+- fixed `Using the last argument as keyword parameters is deprecated;` warnings
+
+## 2.5.1 (April 20, 2020)
+
+Features:
+
+- added changelog
+
+Bugfixes:
+
+- fixed double exp key in payload
+
+Support:
+
+- moved decode error text to a constant within token class
+
+## 2.5.0 (April 12, 2020)
+
+Features:
+
+- added new error class `JWTSessions::Errors::Expired`
+
+## 2.4.3 (September 19, 2019)
+
+Bugfixes:
+
+- fixed lookup for refresh token for namespaced sessions
+
+Support:
+
+- updated sqlite to ~> 1.4 in `dummy_api`
+- added 2.6.3 Ruby to CI

data/README.md

@@ -153,11 +153,11 @@ end
 ```
 
 Specify an encryption key for JSON Web Tokens in `config/initializers/jwt_session.rb` \
-It is advisable to store the key itself within the app secrets.
+It is advisable to store the key itself in a secure way, f.e. within app credentials.
 
 ```ruby
 JWTSessions.algorithm = "HS256"
-JWTSessions.encryption_key = Rails.application.secrets.secret_jwt_encryption_key
+JWTSessions.encryption_key = Rails.application.credentials.secret_jwt_encryption_key
 ```
 
 Most of the encryption algorithms require private and public keys to sign a token. However, HMAC requires only a single key and you can use the `encryption_key` shortcut to sign the token. For other algorithms you must specify private and public keys separately.
@@ -369,6 +369,21 @@ JWTSessions.token_store = :redis, { redis_url: "redis://localhost:6397" }
 
 **NOTE:** if `REDIS_URL` environment variable is set it is used automatically.
 
+SSL, timeout, reconnect, etc. redis settings are supported:
+```ruby
+JWTSessions.token_store = :redis, {
+  read_timeout: 1.5,
+  reconnect_attempts: 10,
+  ssl_params: { verify_mode: OpenSSL::SSL::VERIFY_NONE }
+}
+```
+
+If you already have a configured Redis client, you can pass it among the options to reduce opened connections to a Redis server:
+
+```ruby
+JWTSessions.token_store = :redis, {redis_client: Redis.current}
+```
+
 ##### JWT signature
 
 ```ruby
@@ -449,7 +464,7 @@ It is defined globally, but can be overridden on a session level. See `JWTSessio
 `JWTSessions::Errors::InvalidPayload` - token's payload doesn't contain required keys or they are invalid. \
 `JWTSessions::Errors::Unauthorized` - token can't be decoded or JWT claims are invalid. \
 `JWTSessions::Errors::ClaimsVerification` - JWT claims are invalid (inherited from `JWTSessions::Errors::Unauthorized`). \
-`JWTSessions::Errors::Expired` - token is expired (inherited from `JWTSessions::Errors::Unauthorized`).
+`JWTSessions::Errors::Expired` - token is expired (inherited from `JWTSessions::Errors::ClaimsVerification`).
 
 #### CSRF and cookies
 
@@ -592,6 +607,13 @@ session = JWTSessions::Session.new(namespace: "ie-sessions")
 session.flush_namespaced # will flush all sessions which belong to the same namespace
 ```
 
+Selectively flush one single session inside a namespace by its access token:
+
+```ruby
+session = JWTSessions::Session.new(namespace: "ie-sessions", payload: payload)
+session.flush_by_access_payload # will flush a specific session which belongs to an existing namespace
+```
+
 Flush access tokens only:
 
 ```ruby

data/lib/jwt_sessions/store_adapters/memory_store_adapter.rb

@@ -5,7 +5,7 @@ module JWTSessions
     class MemoryStoreAdapter < AbstractStoreAdapter
       attr_reader :storage
 
-      def initialize(options)
+      def initialize(**options)
         raise ArgumentError, "Memory store doesn't support any options" if options.any?
         @storage = Hash.new do |h, k|
           h[k] = Hash.new { |hh, kk| hh[kk] = {} }

data/lib/jwt_sessions/store_adapters/redis_store_adapter.rb

@@ -7,16 +7,20 @@ module JWTSessions
 
       REFRESH_KEYS = %i[csrf access_uid access_expiration expiration].freeze
 
-      def initialize(token_prefix: JWTSessions.token_prefix, **options)
+      def initialize(token_prefix: JWTSessions.token_prefix, redis_client: nil, **options)
         @prefix = token_prefix
 
-        begin
-          require "redis"
-          @storage = configure_redis_client(options)
-        rescue LoadError => e
-          msg = "Could not load the 'redis' gem, please add it to your gemfile or " \
-                "configure a different adapter (e.g. JWTSessions.store_adapter = :memory)"
-          raise e.class, msg, e.backtrace
+        if redis_client
+          @storage = redis_client
+        else
+          begin
+            require "redis"
+            @storage = configure_redis_client(**options)
+          rescue LoadError => e
+            msg = "Could not load the 'redis' gem, please add it to your gemfile or " \
+                  "configure a different adapter (e.g. JWTSessions.store_adapter = :memory)"
+            raise e.class, msg, e.backtrace
+          end
         end
       end
 
@@ -62,7 +66,7 @@ module JWTSessions
       end
 
       def all_refresh_tokens(namespace)
-        keys_in_namespace = storage.keys(refresh_key("*", namespace))
+        keys_in_namespace = scan_keys(refresh_key("*", namespace))
         (keys_in_namespace || []).each_with_object({}) do |key, acc|
           uid = uid_from_key(key)
           acc[uid] = fetch_refresh(uid, namespace)
@@ -80,7 +84,7 @@ module JWTSessions
 
       private
 
-      def configure_redis_client(redis_url: nil, redis_host: nil, redis_port: nil, redis_db_name: nil)
+      def configure_redis_client(redis_url: nil, redis_host: nil, redis_port: nil, redis_db_name: nil, **options)
         if redis_url && (redis_host || redis_port || redis_db_name)
           raise ArgumentError, "redis_url cannot be passed along with redis_host, redis_port or redis_db_name options"
         end
@@ -91,7 +95,7 @@ module JWTSessions
           redis_db_name: redis_db_name
         )
 
-        Redis.new(url: redis_url)
+        Redis.new(options.merge(url: redis_url))
       end
 
       def build_redis_url(redis_host: nil, redis_port: nil, redis_db_name: nil)
@@ -111,7 +115,7 @@ module JWTSessions
 
       def first_refresh_key(uid)
         key = full_refresh_key(uid, "*")
-        (storage.keys(key) || []).first
+        (scan_keys(key) || []).first
       end
 
       def refresh_key(uid, namespace)
@@ -126,6 +130,20 @@ module JWTSessions
       def uid_from_key(key)
         key.split("_").last
       end
+
+      def scan_keys(key_pattern)
+        cursor = 0
+        all_keys = []
+
+        loop do
+          cursor, keys = storage.scan(cursor, match: key_pattern, count: 1000)
+          all_keys |= keys
+
+          break if cursor == "0"
+        end
+
+        all_keys
+      end
     end
   end
 end

data/lib/jwt_sessions/store_adapters.rb

@@ -9,7 +9,7 @@ module JWTSessions
     def self.build_by_name(adapter, options = nil)
       camelized_adapter = adapter.to_s.split('_').map(&:capitalize).join
       adapter_class_name = "#{camelized_adapter}StoreAdapter"
-      StoreAdapters.const_get(adapter_class_name).new(options || {})
+      StoreAdapters.const_get(adapter_class_name).new(**(options || {}))
     end
   end
 end

data/lib/jwt_sessions/token.rb

@@ -4,6 +4,8 @@ require "jwt"
 
 module JWTSessions
   class Token
+    DECODE_ERROR = "cannot decode the token"
+
     class << self
       def encode(payload)
         exp_payload = meta.merge(payload)
@@ -20,18 +22,18 @@ module JWTSessions
       rescue JWT::DecodeError => e
         raise Errors::Unauthorized, e.message
       rescue StandardError
-        raise Errors::Unauthorized, "could not decode a token"
+        raise Errors::Unauthorized, DECODE_ERROR
       end
 
       def decode!(token)
         decode_options = { algorithm: JWTSessions.algorithm }
         JWT.decode(token, JWTSessions.public_key, false, decode_options)
       rescue StandardError
-        raise Errors::Unauthorized, "could not decode a token"
+        raise Errors::Unauthorized, DECODE_ERROR
       end
 
       def meta
-        { exp: JWTSessions.access_expiration }
+        { "exp" => JWTSessions.access_expiration }
       end
     end
   end

data/lib/jwt_sessions/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module JWTSessions
-  VERSION = "2.5.0"
+  VERSION = "2.7.0"
 end

data/lib/jwt_sessions.rb

@@ -155,7 +155,7 @@ module JWTSessions
   private
 
   def supported_algos
-    algos = JWT::Algos.constants - [:Unsupported]
-    algos.map { |algo| JWT::Algos.const_get(algo)::SUPPORTED }.flatten + [NONE]
+    algos = JWT::Algos::ALGOS - [JWT::Algos::Unsupported]
+    algos.map { |algo| algo::SUPPORTED }.flatten + [NONE]
   end
 end

data/test/units/jwt_sessions/store_adapters/test_redis_store_adapter.rb

@@ -20,13 +20,18 @@ class TestRedisStoreAdapter < Minitest::Test
     end
   end
 
-  def test_error_on_unknown_option
-    assert_raises ArgumentError do
-      JWTSessions::StoreAdapters::RedisStoreAdapter.new(
-        redis_url: "redis://127.0.0.1:6379/0",
-        something: "something"
-      )
-    end
+  def test_support_of_extra_options
+    adapter = JWTSessions::StoreAdapters::RedisStoreAdapter.new(
+      redis_url: "redis://127.0.0.1:6379",
+      ssl_params: { verify_mode: OpenSSL::SSL::VERIFY_NONE },
+      reconnect_delay: 2,
+      timeout: 8
+    )
+    options = adapter.storage.instance_variable_get(:@options)
+
+    assert_equal 8, options[:timeout]
+    assert_equal 2, options[:reconnect_delay]
+    assert_equal 0, options[:ssl_params][:verify_mode]
   end
 
   def test_default_url
@@ -72,4 +77,10 @@ class TestRedisStoreAdapter < Minitest::Test
     adapter = JWTSessions::StoreAdapters::RedisStoreAdapter.new
     assert_equal "redis://127.0.0.2:6322/0", adapter.storage.connection[:id]
   end
+
+  def test_configuration_via_redis_client
+    client = Object.new
+    adapter = JWTSessions::StoreAdapters::RedisStoreAdapter.new(redis_client: client)
+    assert_equal client, adapter.storage
+  end
 end

data/test/units/jwt_sessions/test_token.rb

@@ -110,11 +110,11 @@ class TestToken < Minitest::Test
   def test_token_leeway_decode
     JWTSessions.encryption_key = "abcdefghijklmnopqrstuvwxyzABCDEF"
     JWTSessions.jwt_options.leeway = 50
-    token   = JWTSessions::Token.encode(payload.merge(exp: Time.now.to_i - 20))
+    token   = JWTSessions::Token.encode(payload.merge("exp" => Time.now.to_i - 20))
     decoded = JWTSessions::Token.decode(token).first
     assert_equal payload["user_id"], decoded["user_id"]
     assert_equal payload["secret"], decoded["secret"]
-    token   = JWTSessions::Token.encode(payload.merge(exp: Time.now.to_i - 100))
+    token   = JWTSessions::Token.encode(payload.merge("exp" => Time.now.to_i - 100))
     assert_raises JWTSessions::Errors::Unauthorized do
       JWTSessions::Token.decode(token)
     end
@@ -141,7 +141,7 @@ class TestToken < Minitest::Test
   end
 
   def test_payload_exp_time
-    token = JWTSessions::Token.encode(payload.merge(exp: Time.now.to_i - (3600 * 24)))
+    token = JWTSessions::Token.encode(payload.merge("exp" => Time.now.to_i - (3600 * 24)))
     assert_raises JWTSessions::Errors::Expired do
       JWTSessions::Token.decode(token)
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jwt_sessions
 version: !ruby/object:Gem::Version
-  version: 2.5.0
+  version: 2.7.0
 platform: ruby
 authors:
 - Yulia Oletskaya
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-04-12 00:00:00.000000000 Z
+date: 2021-10-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jwt
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.1.1
+        version: 2.2.3
     - - "<"
       - !ruby/object:Gem::Version
         version: '3'
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.1.1
+        version: 2.2.3
     - - "<"
       - !ruby/object:Gem::Version
         version: '3'
@@ -44,34 +44,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '1.16'
-- !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.11'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.11'
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.11'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.11'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -92,6 +64,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
 - LICENSE
 - README.md
 - lib/jwt_sessions.rb
@@ -120,8 +93,12 @@ files:
 homepage: http://rubygems.org/gems/jwt_sessions
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  homepage_uri: https://github.com/tuwukee/jwt_sessions
+  changelog_uri: https://github.com/tuwukee/jwt_sessions/blob/master/CHANGELOG.md
+  source_code_uri: https://github.com/tuwukee/jwt_sessions
+  bug_tracker_uri: https://github.com/tuwukee/jwt_sessions/issues
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -136,8 +113,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.2.5
+signing_key:
 specification_version: 4
 summary: JWT Sessions
 test_files: