jwt_keeper 3.3.0 → 6.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b2c902b7848d7fe72b7ad437badc5cf549b299d4b2ae2dc9150b7f42d63855a3
-  data.tar.gz: 77a18a0cfeb2b198f13affa3792feaeb1235d5fa2f6ae599038bb3e2245b41b2
+  metadata.gz: 135ae5f5451cdcd997de5a5208642833ef5d043038b020fc96b67415c243b8b7
+  data.tar.gz: f940045097cb8cbd2d281bd1b887598f7c2f0f7bf25e598b834978e61a9337f8
 SHA512:
-  metadata.gz: bc177da58d088bdaeeba97049628d0908f05ef9bd717674a34b511a14e70289604a87647c01853ec3aeb988fb80cd95f4c4a96d0741a1133efc72f2138b9bd98
-  data.tar.gz: 97dde3b11a5584357028abb7d9523d548c53ccb8e0211a4b31089f177747c1d9fca7521bf4984837a540ec2c46080a51adacd30e322fcd4408e6d8d732cad21e
+  metadata.gz: dfa8fe29790a114e9f180822f32015fb5881cc268b249b757bec44df0ed419b203e33c27f439ed019cbdeecdbc6aa34512930c4210b5c000a77adb5da6dee07c
+  data.tar.gz: 881df471eaa098d00614578f551d2e67414cdee8260c45e7ad90a2cdca71fd2af52b3c88ebd8d9fa61bedaf9863dceaee7281a6f5f92f56b238111bf4b382527

data/README.md

@@ -32,12 +32,15 @@ raw_token_string = token.to_jwt
 The designed rails token flow is to receive and respond to requests with the token being present in the `Authorization` part of the header. This is to allow us to seamlessly rotate the tokens on the fly without having to rebuff the request as part of the user flow. Automatic rotation happens as part of the `require_authentication` action, meaning that you will always get the latest token data as created by `generate_claims` in your controllers. This new token is added to the response with the `write_authentication_token` action.
 
 ```bash
-rake generate jwt_keeper:install
+rails generate jwt_keeper:install
 ```
 
 ```ruby
 class ApplicationController < ActionController::Base
+  include JWTKeeper::Controller
+
   before_action :require_authentication
+  rescue_from JWTKeeper::NotAuthenticatedError, with: :not_authenticated
 
   def not_authenticated
     # Overload to return status 401

data/lib/generators/templates/jwt_keeper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 JWTKeeper.configure do |config|
   # The time to expire for the tokens
   # config.expiry           = 1.hour
@@ -26,6 +28,9 @@ JWTKeeper.configure do |config|
 
   # the location of redis config file
   # config.redis_connection = Redis.new(connection_options)
+  # config.redis_connection = ConnectionPool.new(size: ENV.fetch('RAILS_MAX_THREADS', 5)) do
+  #   Redis.new(url: ENV['REDISCLOUD_URL'] || 'redis://localhost:6379/')
+  # end
 
   # A unique idenfitier for the token version.
   # config.version          = 1

data/lib/jwt_keeper.rb

@@ -23,6 +23,4 @@ module JWTKeeper
 
     @configuration = new_configuration.freeze
   end
-
-  require 'jwt_keeper/engine' if defined?(Rails)
 end

data/lib/jwt_keeper/configuration.rb

@@ -4,8 +4,8 @@ module JWTKeeper
       algorithm:       'HS512',
       secret:           nil,
       expiry:           24.hours,
-      issuer:           'api.example.com',
-      audience:         'example.com',
+      issuer:           nil,
+      audience:         nil,
       redis_connection: nil,
       version:          nil,
       cookie_lock:      false,

data/lib/jwt_keeper/controller.rb

@@ -10,7 +10,7 @@ module JWTKeeper
 
       if token.nil?
         clear_authentication_token
-        return not_authenticated
+        raise JWTKeeper::NotAuthenticatedError
       end
 
       if token.version_mismatch? || token.pending?
@@ -29,7 +29,7 @@ module JWTKeeper
       @authentication_token ||=
         JWTKeeper::Token.find(
           request.headers['Authorization'].split.last,
-          cookies.signed['jwt_keeper']
+          cookie_secret: defined?(cookies) && cookies.signed['jwt_keeper']
         )
     end
 
@@ -39,7 +39,7 @@ module JWTKeeper
     def write_authentication_token(token)
       return clear_authentication_token if token.nil?
       response.headers['Authorization'] = "Bearer #{token.to_jwt}"
-      cookies.signed['jwt_keeper'] = token.to_cookie
+      defined?(cookies) && cookies.signed['jwt_keeper'] = token.to_cookie
       @authentication_token = token
     end
 
@@ -47,17 +47,10 @@ module JWTKeeper
     # @return [void]
     def clear_authentication_token
       response.headers['Authorization'] = nil
-      cookies.delete('jwt_keeper')
+      defined?(cookies) && cookies.delete('jwt_keeper')
       @authentication_token = nil
     end
 
-    # The default action for denying non-authenticated connections.
-    # You can override this method in your controllers
-    # @return [void]
-    def not_authenticated
-      redirect_to root_path
-    end
-
     # The default action for accepting authenticated connections.
     # You can override this method in your controllers
     # @return [void]

data/lib/jwt_keeper/datastore.rb

@@ -27,12 +27,28 @@ module JWTKeeper
 
       # @!visibility private
       def set_with_expiry(jti, seconds, type)
-        JWTKeeper.configuration.redis_connection.setex(jti, seconds, type)
+        redis = JWTKeeper.configuration.redis_connection
+
+        if redis.is_a?(Redis)
+          redis.setex(jti, seconds, type)
+        elsif defined?(ConnectionPool) && redis.is_a?(ConnectionPool)
+          redis.with { |conn| conn.setex(jti, seconds, type) }
+        else
+          throw 'Bad Redis Connection'
+        end
       end
 
       # @!visibility private
       def get(jti)
-        JWTKeeper.configuration.redis_connection.get(jti)
+        redis = JWTKeeper.configuration.redis_connection
+
+        if redis.is_a?(Redis)
+          redis.get(jti)
+        elsif defined?(ConnectionPool) && redis.is_a?(ConnectionPool)
+          redis.with { |conn| conn.get(jti) }
+        else
+          throw 'Bad Redis Connection'
+        end
       end
     end
   end

data/lib/jwt_keeper/exceptions.rb

@@ -1,4 +1,7 @@
 module JWTKeeper
+  # the session is invalid
+  class NotAuthenticatedError < StandardError; end
+
   # The token is invalid
   class InvalidTokenError < StandardError; end
 

data/lib/jwt_keeper/token.rb

@@ -2,41 +2,47 @@ module JWTKeeper
   # This class acts as the main interface to wrap the concerns of JWTs. Handling everything from
   # encoding to invalidation.
   class Token
-    attr_accessor :claims, :cookie_secret
+    attr_accessor :claims, :secret, :cookie_secret
 
     # Initalizes a new web token
-    # @param private_claims [Hash] the custom claims to encode
-    # @param cookie_secret [String] the cookie secret to use during encoding
+    # @param options [Hash] the custom claims to encode
+    # @param secret the secret to use during encoding, defaults to config
+    # @param cookie_secret the cookie secret to use during encoding
     # @return [void]
-    def initialize(private_claims = {}, cookie_secret = nil)
-      @cookie_secret = cookie_secret
+    def initialize(options = {})
+      @secret = options.delete(:secret) || JWTKeeper.configuration.secret
+      @cookie_secret = options.delete(:cookie_secret)
       @claims = {
         nbf: DateTime.now.to_i, # not before
         iat: DateTime.now.to_i, # issued at
         jti: SecureRandom.uuid  # JWT ID
       }
+
       @claims.merge!(JWTKeeper.configuration.base_claims)
-      @claims.merge!(private_claims)
+      @claims.merge!(options)
       @claims[:exp] = @claims[:exp].to_i if @claims[:exp].is_a?(Time)
     end
 
     # Creates a new web token
-    # @param private_claims [Hash] the custom claims to encode
+    # @param options [Hash] the custom claims to encode
+    # @param secret the secret to use during encoding, defaults to config
     # @return [Token] token object
-    def self.create(private_claims)
+    def self.create(options)
       cookie_secret = SecureRandom.hex(16) if JWTKeeper.configuration.cookie_lock
-      new(private_claims, cookie_secret)
+      new(options.merge(cookie_secret: cookie_secret))
     end
 
     # Decodes and validates an existing token
     # @param raw_token [String] the raw token
     # @param cookie_secret [String] the cookie secret
     # @return [Token] token object
-    def self.find(raw_token, cookie_secret = nil)
-      claims = decode(raw_token, cookie_secret)
+    def self.find(raw_token, secret: nil, cookie_secret: nil, iss: nil)
+      claims = decode(raw_token, secret: secret, cookie_secret: cookie_secret, iss: iss)
       return nil if claims.nil?
 
-      new_token = new(claims, cookie_secret)
+      new_token = new(secret: secret, cookie_secret: cookie_secret, iss: iss)
+      new_token.claims = claims
+
       return nil if new_token.revoked?
       new_token
     end
@@ -67,6 +73,7 @@ module JWTKeeper
     # @param new_claims [Hash] Used to override and update claims during rotation
     # @return [Token]
     def rotate(new_claims = nil)
+      return self if claims[:iss] != JWTKeeper.configuration.issuer
       revoke
 
       new_claims ||= claims.except(:iss, :aud, :exp, :nbf, :iat, :jti)
@@ -111,7 +118,11 @@ module JWTKeeper
     # Checks if the token invalid?
     # @return [Boolean]
     def invalid?
-      self.class.decode(encode, cookie_secret).nil? || revoked?
+      self.class.decode(
+        encode,
+        secret: secret,
+        cookie_secret: cookie_secret
+      ).nil? || revoked?
     end
 
     # Encodes the jwt
@@ -131,8 +142,11 @@ module JWTKeeper
     end
 
     # @!visibility private
-    def self.decode(raw_token, cookie_secret)
-      JWT.decode(raw_token, JWTKeeper.configuration.secret.to_s + cookie_secret.to_s, true,
+    def self.decode(raw_token, secret: nil, cookie_secret: nil, iss: nil)
+      secret ||= JWTKeeper.configuration.secret
+      iss ||= JWTKeeper.configuration.issuer
+
+      JWT.decode(raw_token, secret.to_s + cookie_secret.to_s, true,
                  algorithm: JWTKeeper.configuration.algorithm,
                  verify_iss: true,
                  verify_aud: true,
@@ -140,7 +154,7 @@ module JWTKeeper
                  verify_sub: false,
                  verify_jti: false,
                  leeway: 0,
-                 iss: JWTKeeper.configuration.issuer,
+                 iss: iss,
                  aud: JWTKeeper.configuration.audience
                 ).first.symbolize_keys
 
@@ -152,8 +166,8 @@ module JWTKeeper
 
     # @!visibility private
     def encode
-      JWT.encode(claims,
-                 JWTKeeper.configuration.secret.to_s + cookie_secret.to_s,
+      JWT.encode(claims.compact,
+                 secret.to_s + cookie_secret.to_s,
                  JWTKeeper.configuration.algorithm
                 )
     end

data/lib/jwt_keeper/version.rb

@@ -1,4 +1,4 @@
 # Gem Version
 module JWTKeeper
-  VERSION = '3.3.0'.freeze
+  VERSION = '6.0.0'.freeze
 end

data/spec/lib/jwt_keeper/controller_spec.rb

@@ -5,6 +5,7 @@ RSpec.describe JWTKeeper do
     include_context 'initialize config'
 
     let(:token) { JWTKeeper::Token.create(claim: "The Earth is Flat") }
+
     subject(:test_controller) do
       cookies_klass = Class.new(Hash) do
         def signed
@@ -51,7 +52,6 @@ RSpec.describe JWTKeeper do
       it { is_expected.to respond_to(:read_authentication_token) }
       it { is_expected.to respond_to(:write_authentication_token) }
       it { is_expected.to respond_to(:clear_authentication_token) }
-      it { is_expected.to respond_to(:not_authenticated) }
       it { is_expected.to respond_to(:authenticated) }
       it { is_expected.to respond_to(:regenerate_claims) }
     end
@@ -76,13 +76,9 @@ RSpec.describe JWTKeeper do
 
       context 'with expired token' do
         let(:token) { JWTKeeper::Token.create(exp: 3.hours.ago) }
-        before do
-          allow(test_controller).to receive(:not_authenticated)
-        end
 
-        it 'calls not_authenticated' do
-          subject.require_authentication
-          expect(subject).to have_received(:not_authenticated).once
+        it 'raises NotAuthenticated' do
+          expect { subject.require_authentication }.to raise_error(JWTKeeper::NotAuthenticatedError)
         end
       end
 
@@ -161,16 +157,5 @@ RSpec.describe JWTKeeper do
         expect(subject.response.headers['Authorization']).to be_nil
       end
     end
-
-    describe '#not_authenticated' do
-      before do
-        allow(test_controller).to receive(:redirect_to)
-      end
-
-      it 'it calls redirect_to' do
-        subject.not_authenticated
-        expect(subject).to have_received(:redirect_to).with('/')
-      end
-    end
   end
 end

data/spec/lib/jwt_keeper/token_spec.rb

@@ -24,6 +24,25 @@ module JWTKeeper
         it { is_expected.to be_instance_of described_class }
         it { expect(subject.claims[:exp]).to eql private_claims[:exp] }
       end
+
+      context 'when overriding default secret' do
+        subject { described_class.create(**private_claims, secret: secret) }
+
+        let(:secret) { SecureRandom.uuid }
+
+        it { is_expected.to be_instance_of described_class }
+        it { expect(subject.claims[:claim]).to eql private_claims[:claim] }
+      end
+
+      context 'when overriding default issuer' do
+        subject { described_class.create(**private_claims, iss: issuer) }
+
+        let(:issuer) { 'ISSUER' }
+
+        it { is_expected.to be_instance_of described_class }
+        it { expect(subject.claims[:claim]).to eql private_claims[:claim] }
+        it { expect(subject.claims[:iss]).to eql issuer }
+      end
     end
 
     describe '.find' do
@@ -46,20 +65,47 @@ module JWTKeeper
         before { JWTKeeper.configure(JWTKeeper::Configuration.new(config.merge(cookie_lock: true))) }
 
         context 'with no cookie' do
-          subject { described_class.find(raw_token, nil) }
+          subject { described_class.find(raw_token, cookie_secret: nil) }
           it { is_expected.to be nil }
         end
 
         context 'with bad cookie' do
-          subject { described_class.find(raw_token, 'BAD_COOKIE') }
+          subject { described_class.find(raw_token, cookie_secret: 'BAD_COOKIE') }
           it { is_expected.to be nil }
         end
 
         context 'with valid cookie' do
-          subject { described_class.find(raw_token, token.cookie_secret) }
+          subject { described_class.find(raw_token, cookie_secret: token.cookie_secret) }
           it { is_expected.to be_instance_of described_class }
         end
       end
+
+      context 'when overriding default secret' do
+        subject { described_class.find(raw_token, secret: secret) }
+
+        let(:token) { described_class.create(**private_claims, secret: secret) }
+        let(:secret) { SecureRandom.uuid }
+
+        it { is_expected.to be_instance_of described_class }
+        it { expect(subject.claims[:claim]).to eql private_claims[:claim] }
+      end
+
+      context 'when overriding default issuer' do
+        subject { described_class.find(raw_token, iss: issuer) }
+
+        let(:token) { described_class.create(**private_claims, iss: issuer) }
+        let(:issuer) { 'ISSUER' }
+
+        it { is_expected.to be_instance_of described_class }
+        it { expect(subject.claims[:claim]).to eql private_claims[:claim] }
+        it { expect(subject.claims[:iss]).to eql issuer }
+
+        context 'with an issuer mismatch' do
+          subject { described_class.find(raw_token) }
+
+          it { is_expected.to be nil }
+        end
+      end
     end
 
     describe '.rotate' do
@@ -181,6 +227,13 @@ module JWTKeeper
       it { expect(new_token).to be_valid }
       it { expect(old_token.claims[:claim]).to eq new_token.claims[:claim] }
       it { expect(old_token.cookie_secret).not_to eq new_token.cookie_secret }
+
+      context 'with a foreign issued token' do
+        let(:old_token) { described_class.create(**private_claims, iss: 'ISSUER') }
+        let(:new_token) { old_token.rotate }
+
+        it { expect(old_token).to eq new_token }
+      end
     end
 
     describe '#valid?' do
@@ -194,6 +247,16 @@ module JWTKeeper
       context 'when valid' do
         it { is_expected.to be_valid }
       end
+
+      context 'with overriden secret' do
+        subject { described_class.create(**private_claims, secret: secret) }
+
+        let(:secret) { SecureRandom.uuid }
+
+        context 'when valid' do
+          it { is_expected.to be_valid }
+        end
+      end
     end
 
     describe '#invalid?' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jwt_keeper
 version: !ruby/object:Gem::Version
-  version: 3.3.0
+  version: 6.0.0
 platform: ruby
 authors:
 - David Rivera
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-12-11 00:00:00.000000000 Z
+date: 2021-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -249,7 +249,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.3
 signing_key:
 specification_version: 4
 summary: JWT for Rails made easy