devise-jwt-revocation_strategies-redis 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b985ed2d07aeaf7d71a47caed6106f0edfd69b0fa34072aece1e078628535b8a
+  data.tar.gz: 7453be272908b15a497b0b5eb66241d3d46a7577f05320d30b4feaa99a39e122
+SHA512:
+  metadata.gz: e6a9f89f7d83cac478f913424be105e95926794480f639422abaccefab86762e4bd1776d8e5dc7a6b253b2c382d960c86178d0ea847934a2eae0bcfec54965d3
+  data.tar.gz: eae47c2ad8be287a8f98cb14f9e7c90942d7099bdb37b25d114ce2fff35b73f5eb428f8f9465e84d99760a4d0481fa172925150aec2159359d4f61d7d42753ec

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,8 @@
+AllCops:
+  TargetRubyVersion: 3.0
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes

data/README.md

@@ -0,0 +1,42 @@
+# Devise::Jwt::RevocationStrategies::Redis
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+
+## Usage
+
+### Configuration
+- Setting up Redis
+Ensure that you have Redis installed and running. You can configure the Redis connection URL in your environment variables. For example:
+```#.env
+REDIS_AUTH_URL=redis://localhost:6379/0
+```
+
+Setup your devise model:
+```ruby
+class User < ApplicationRecord
+  include Devise::Jwt::RevocationStrategies::Redis::JwtDispatcher
+
+  devise :database_authenticatable, # your enabled modules
+         :jwt_authenticatable, jwt_revocation_strategy: Devise::Jwt::RevocationStrategies::Redis
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/devise-jwt-revocation_strategies-redis.

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/devise/jwt/revocation_strategies/redis/jwt_dispatcher.rb

@@ -0,0 +1,35 @@
+require 'json'
+require 'active_support/concern'
+
+module Devise
+  module Jwt
+    module RevocationStrategies
+      module Redis
+        module JwtDispatcher
+          extend ActiveSupport::Concern
+
+          included do
+            def on_jwt_dispatch(token, payload)
+              raise ArgumentError, 'payload cannot be nil' if payload.nil?
+
+              jti = payload['jti']
+              save_token_in_redis(jti, payload['sub'], payload['exp'])
+            end
+          end
+
+          private
+
+          def save_token_in_redis(jti, user_id, exp)
+            raise ArgumentError, 'sub cannot be nil' if user_id.nil? || user_id.empty?
+            raise ArgumentError, 'jti cannot be nil' if jti.nil? || jti.empty?
+            raise ArgumentError, 'exp cannot be nil' if exp.nil?
+
+            redis_key = "jwt:#{user_id}"
+            $redis_auth.sadd(redis_key, jti)
+            $redis_auth.expireat(redis_key, exp)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/devise/jwt/revocation_strategies/redis/version.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Devise
+  module Jwt
+    module RevocationStrategies
+      module Redis
+        VERSION = "0.1.0"
+      end
+    end
+  end
+end

data/lib/devise/jwt/revocation_strategies/redis.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require_relative "redis/version"
+require_relative 'redis/jwt_dispatcher'
+require 'redis'
+require 'dotenv-rails'
+
+module Devise
+  module Jwt
+    module RevocationStrategies
+      module Redis
+        Dotenv.load
+        $redis_auth ||= ::Redis.new(url: ENV.fetch('REDIS_AUTH_URL') { 'redis://localhost:6379/0' })
+
+        class Error < StandardError; end
+        # Checks if the JWT has been revoked.
+        #
+        # @param payload [Hash] the payload of the JWT, which includes the 'jti' (JWT ID).
+        # @param _user [Object] the user object (unused in this method).
+        # @return [Boolean] true if the JWT has been revoked or if there is an error accessing Redis, false otherwise.
+        def self.jwt_revoked?(payload, _user)
+          return true if payload.nil? || payload['jti'].nil? || payload['sub'].nil?  # Check if JTI or user ID is nil
+
+          redis_key = "jwt:#{payload['sub']}"  # Using user ID to get the Set
+          !$redis_auth.sismember(redis_key, payload['jti'])
+        end
+
+        # Revokes a JWT by deleting its entry from Redis.
+        #
+        # @param payload [Hash] The payload of the JWT, which should include the 'jti' (JWT ID).
+        # @param _user [Object] The user object (not used in this method).
+        #
+        # @return nil
+        def self.revoke_jwt(payload, _user)
+          user_id = payload['sub'] rescue nil
+          jti = payload['jti'] rescue nil
+
+          return if user_id.nil?
+
+          redis_key = "jwt:#{user_id}"
+          $redis_auth.srem(redis_key, jti)  # Remove the specific JWT from the Set
+        end
+
+        def self.revoke_all_jwts_for_user(user_id)
+          redis_key = "jwt:#{user_id}"
+          $redis_auth.del(redis_key)  # Delete the entire Set to revoke all tokens
+        end
+      end
+    end
+  end
+end

data/sig/devise/jwt/revocation_strategies/redis.rbs

@@ -0,0 +1,10 @@
+module Devise
+  module Jwt
+    module RevocationStrategies
+      module Redis
+        VERSION: String
+        # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: devise-jwt-revocation_strategies-redis
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- kokorolx
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-09-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This gem provides a strategy for revoking JWT tokens in a Rails application
+  using Devise, utilizing Redis for token storage and revocation management.
+email:
+- kokoro.lehoang@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- README.md
+- Rakefile
+- lib/devise/jwt/revocation_strategies/redis.rb
+- lib/devise/jwt/revocation_strategies/redis/jwt_dispatcher.rb
+- lib/devise/jwt/revocation_strategies/redis/version.rb
+- sig/devise/jwt/revocation_strategies/redis.rbs
+homepage: https://github.com/kokorolx/devise-jwt-revocation_strategies-redis
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/kokorolx/devise-jwt-revocation_strategies-redis
+  source_code_uri: https://github.com/kokorolx/devise-jwt-revocation_strategies-redis
+  changelog_uri: https://github.com/kokorolx/devise-jwt-revocation_strategies-redis/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.16
+signing_key:
+specification_version: 4
+summary: A gem to revoke JWT tokens using Redis for Devise.
+test_files: []