jwt_sessions 2.4.2 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 603df513aaba9a73e5360895ea7fffddf52dd02e
-  data.tar.gz: f70b523406ae364b05d16b45423d3b98971f4c75
+SHA256:
+  metadata.gz: 8a485796c7aa19c00c79992111ed0135c0ec93af6e88aff80b233be779bb2301
+  data.tar.gz: d0b89a924589aa8450cfcaefb2061674db4d61cb32ed5ace92f1cab021db1fb1
 SHA512:
-  metadata.gz: f937d9d3362f0ec7c63dc4af813038a3a0b49647a29e6f0338583ae106094cc9677bc83790ae330df3ef46d1159d441cab595cb62f274294a1fdc7af23ecb2cb
-  data.tar.gz: fd37c7ec5f318893567dfce15ba8562c35a25b0ec8c53c12707947ba0f81e9d973144c0f153364ff1e3a92d17eab58c8a91ec1f4f67f0f84457334c83da38f8e
+  metadata.gz: e0bef3934719502d51f1299b210fad2df87360ef91cc3471384c3840870f3d548f43c5c5c1ff89a33e9e8847b706f9b7e1d2c240f288a21a16533369d8b0fce5
+  data.tar.gz: cd8b450b1a09e13290e3ac6ec5bcd17cf52c7314f01044ca1c2888321816585ff27eb7ae7b3935f5aa388fec3c11d9b8ebb0fe2c5fdde5a99cbc390932c4a646

data/CHANGELOG.md

@@ -0,0 +1,49 @@
+## 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

@@ -15,10 +15,11 @@ XSS/CSRF safe JWT auth designed for SPA
     - [Rails integration](#rails-integration)
     - [Non-Rails usage](#non-rails-usage)
   - [Configuration](#configuration)
-        - [Token store](#token-store)
-        - [JWT signature](#jwt-signature)
-        - [Request headers and cookies names](#request-headers-and-cookies-names)
-        - [Expiration time](#expiration-time)
+      - [Token store](#token-store)
+      - [JWT signature](#jwt-signature)
+      - [Request headers and cookies names](#request-headers-and-cookies-names)
+      - [Expiration time](#expiration-time)
+      - [Exceptions](#exceptions)
       - [CSRF and cookies](#csrf-and-cookies)
         - [Refresh with access token](#refresh-with-access-token)
       - [Refresh token hijack protection](#refresh-token-hijack-protection)
@@ -368,6 +369,15 @@ 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 }
+}
+```
+
 ##### JWT signature
 
 ```ruby
@@ -441,6 +451,15 @@ JWTSessions.refresh_exp_time = 604800 # 1 week in seconds
 
 It is defined globally, but can be overridden on a session level. See `JWTSessions::Session.new` options for more info.
 
+##### Exceptions
+
+`JWTSessions::Errors::Error` - base class, all possible exceptions are inhereted from it. \
+`JWTSessions::Errors::Malconfigured` - some required gem settings are empty, or methods are not implemented. \
+`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::ClaimsVerification`).
+
 #### CSRF and cookies
 
 When you use cookies as your tokens transport it becomes vulnerable to CSRF. That is why both the login and refresh methods of the `Session` class produce CSRF tokens for you. `Authorization` mixin expects that this token is sent with all requests except GET and HEAD in a header specified among this gem's settings (`X-CSRF-Token` by default). Verification will be done automatically and the `Authorization` exception will be raised in case of a mismatch between the token from the header and the one stored in the session. \
@@ -455,7 +474,7 @@ session.masked_csrf(access_token)
 
 Sometimes it is not secure enough to store the refresh tokens in web / JS clients. \
 This is why you have the option to only use an access token and to not pass the refresh token to the client at all. \
-Session accepts `refresh_by_access_allowed: true` setting, which links the access token to the corresponding refresh token. \
+Session accepts `refresh_by_access_allowed: true` setting, which links the access token to the corresponding refresh token.
 
 Example Rails login controller, which passes an access token token via cookies and renders CSRF:
 
@@ -490,7 +509,18 @@ tokens  = session.refresh_by_access_payload
 
 In case of token forgery and successful refresh performed by an attacker the original user will have to logout. \
 To protect the endpoint use the before_action `authorize_refresh_by_access_request!`. \
-Refresh should be performed once the access token is already expired and we need to use the `claimless_payload` method in order to skip JWT expiration validation (and other claims) in order to proceed. \
+Refresh should be performed once the access token is already expired and we need to use the `claimless_payload` method in order to skip JWT expiration validation (and other claims) in order to proceed.
+
+Optionally `refresh_by_access_payload` accepts a block argument (the same way `refresh` method does).
+The block will be called if the refresh action is performed before the access token is expired.
+Thereby it's possible to prohibit users from making refresh calls while their access token is still active.
+
+```ruby
+tokens = session.refresh_by_access_payload do
+  # here goes malicious activity alert
+  raise JWTSessions::Errors::Unauthorized, "Refresh action is performed before the expiration of the access token."
+end
+```
 
 Example Rails refresh by access controller with cookies as token transport:
 
@@ -571,6 +601,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.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/lib/jwt_sessions/errors.rb

@@ -5,5 +5,6 @@ module JWTSessions
     class InvalidPayload < Error; end
     class Unauthorized < Error; end
     class ClaimsVerification < Unauthorized; end
+    class Expired < ClaimsVerification; end
   end
 end

data/lib/jwt_sessions/session.rb

@@ -37,7 +37,7 @@ module JWTSessions
     end
 
     def session_exists?(token, token_type = :access)
-      send(:"#{token_type}_token_data", token)
+      send(:"#{token_type}_token_data", token, true)
       true
     rescue Errors::Unauthorized
       false
@@ -142,20 +142,20 @@ module JWTSessions
     end
 
     def refresh_csrf(refresh_token)
-      refresh_token_instance = refresh_token_data(refresh_token)
+      refresh_token_instance = refresh_token_data(refresh_token, true)
       CSRFToken.new(refresh_token_instance.csrf)
     end
 
-    def access_token_data(token)
+    def access_token_data(token, _first_match = false)
       uid = token_uid(token, :access, @access_claims)
       data = store.fetch_access(uid)
       raise Errors::Unauthorized, "Access token not found" if data.empty?
       data
     end
 
-    def refresh_token_data(token)
+    def refresh_token_data(token, first_match = false)
       uid = token_uid(token, :refresh, @refresh_claims)
-      retrieve_refresh_token(uid)
+      retrieve_refresh_token(uid, first_match: first_match)
     end
 
     def token_uid(token, type, claims)
@@ -177,8 +177,8 @@ module JWTSessions
       val
     end
 
-    def retrieve_refresh_token(uid)
-      @_refresh = RefreshToken.find(uid, store, namespace)
+    def retrieve_refresh_token(uid, first_match: false)
+      @_refresh = RefreshToken.find(uid, store, namespace, first_match: first_match)
     end
 
     def tokens_hash

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/store_adapters/abstract_store_adapter.rb

@@ -11,7 +11,8 @@ module JWTSessions
         raise NotImplementedError
       end
 
-      def fetch_refresh(_uid, _namespace)
+      # Set first_match to true to look up through all namespaces
+      def fetch_refresh(_uid, _namespace, _first_match)
         raise NotImplementedError
       end
 

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] = {} }
@@ -22,8 +22,16 @@ module JWTSessions
         storage[""]["access"].store(uid, access_token)
       end
 
-      def fetch_refresh(uid, namespace, _first_match = false)
-        value_if_not_expired(uid, "refresh", namespace.to_s)
+      def fetch_refresh(uid, namespace, first_match = false)
+        if first_match
+          storage.keys.each do |namespace_key|
+            val = value_if_not_expired(uid, "refresh", namespace_key)
+            return val unless val.empty?
+          end
+          {}
+        else
+          value_if_not_expired(uid, "refresh", namespace.to_s)
+        end
       end
 
       def persist_refresh(uid:, access_expiration:, access_uid:, csrf:, expiration:, namespace: "")

data/lib/jwt_sessions/store_adapters/redis_store_adapter.rb

@@ -12,7 +12,7 @@ module JWTSessions
 
         begin
           require "redis"
-          @storage = configure_redis_client(options)
+          @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)"
@@ -62,7 +62,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 +80,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 +91,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 +111,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 +126,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/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)
@@ -13,23 +15,25 @@ module JWTSessions
       def decode(token, claims = {})
         decode_options = { algorithm: JWTSessions.algorithm }.merge(JWTSessions.jwt_options.to_h).merge(claims)
         JWT.decode(token, JWTSessions.public_key, JWTSessions.validate?, decode_options)
-      rescue JWT::InvalidIssuerError, JWT::InvalidIatError, JWT::InvalidAudError, JWT::InvalidSubError, JWT::InvalidJtiError, JWT::ExpiredSignature => e
+      rescue JWT::ExpiredSignature => e
+        raise Errors::Expired, e.message
+      rescue JWT::InvalidIssuerError, JWT::InvalidIatError, JWT::InvalidAudError, JWT::InvalidSubError, JWT::InvalidJtiError => e
         raise Errors::ClaimsVerification, e.message
       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.4.2"
+  VERSION = "2.6.0"
 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

data/test/units/jwt_sessions/test_session.rb

@@ -69,6 +69,18 @@ class TestSession < Minitest::Test
     end
   end
 
+  def test_refresh_with_namespace
+    @new_session = JWTSessions::Session.new(
+      payload: payload,
+      namespace: "custom-namespace"
+    )
+    new_tokens = @new_session.login
+    refreshed_tokens = @new_session.refresh(new_tokens[:refresh])
+    decoded_access = JWTSessions::Token.decode(refreshed_tokens[:access]).first
+    assert_equal REFRESH_KEYS, refreshed_tokens.keys.sort
+    assert_equal payload[:test], decoded_access["test"]
+  end
+
   def test_refresh_by_access_payload
     session = JWTSessions::Session.new(payload: payload, refresh_by_access_allowed: true)
     session.login

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,8 +141,8 @@ class TestToken < Minitest::Test
   end
 
   def test_payload_exp_time
-    token = JWTSessions::Token.encode(payload.merge(exp: Time.now.to_i - (3600 * 24)))
-    assert_raises JWTSessions::Errors::Unauthorized do
+    token = JWTSessions::Token.encode(payload.merge("exp" => Time.now.to_i - (3600 * 24)))
+    assert_raises JWTSessions::Errors::Expired do
       JWTSessions::Token.decode(token)
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jwt_sessions
 version: !ruby/object:Gem::Version
-  version: 2.4.2
+  version: 2.6.0
 platform: ruby
 authors:
 - Yulia Oletskaya
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-30 00:00:00.000000000 Z
+date: 2021-06-01 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,7 +93,11 @@ files:
 homepage: http://rubygems.org/gems/jwt_sessions
 licenses:
 - MIT
-metadata: {}
+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:
@@ -136,18 +113,17 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: JWT Sessions
 test_files:
 - test/units/test_jwt_sessions.rb
 - test/units/test_token_store.rb
-- test/units/jwt_sessions/store_adapters/test_memory_store_adapter.rb
-- test/units/jwt_sessions/store_adapters/test_redis_store_adapter.rb
-- test/units/jwt_sessions/test_access_token.rb
 - test/units/jwt_sessions/test_csrf_token.rb
+- test/units/jwt_sessions/test_access_token.rb
+- test/units/jwt_sessions/store_adapters/test_redis_store_adapter.rb
+- test/units/jwt_sessions/store_adapters/test_memory_store_adapter.rb
+- test/units/jwt_sessions/test_token.rb
 - test/units/jwt_sessions/test_refresh_token.rb
 - test/units/jwt_sessions/test_session.rb
-- test/units/jwt_sessions/test_token.rb