jwt_keeper 4.0.1 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 26a338e78f6af549348419350f802cb0eea3afead33d967eef694d2e45850faf
-  data.tar.gz: '081c9b805dd36d5a2650faa693ad73b54583a132827fdf490a349c970482f0f5'
+  metadata.gz: '0781e4deae7439d13aadad57e1c3fa6dd224cd791c90672ee647815af2ebf70a'
+  data.tar.gz: 9be046da200f6d6f6e17c2f747c398e7b5abe13e1fe1517a7b288d9dec468ea8
 SHA512:
-  metadata.gz: f7168ef5c0ad904a0cedf95da5b9a2e934e322af10327637bde820298ea21209f4c62104f05a2e6153d6a498aa715340a926d294e6d0d7302f67b559112e600c
-  data.tar.gz: d94f5e45932d679718e5ee5e6d810fa6c4ea3fe037f5bad3629a9719b7d748da7a62d54ed1782715f84e50a85e5bbc5f96ca20211ace602442bd124f1ca6f8d6
+  metadata.gz: a58d6573eb512abce406c8726a15eebac3136d5c05b5305c9b5cd8d040f2facd6c050071d86a8bb885523485ea6217b2596f6bc14771d0e5d0c878278b0bdd66
+  data.tar.gz: 6a1086f9933a1daf4fc48e2ea7af4c2fe8c7b26c248a84f096cde00e9e2af3302258a894cdcb88211a281756a2b847713d6a6bd87233b66d1ca10fe64b3b6459

data/lib/jwt_keeper/controller.rb

@@ -29,7 +29,7 @@ module JWTKeeper
       @authentication_token ||=
         JWTKeeper::Token.find(
           request.headers['Authorization'].split.last,
-          defined?(cookies) && cookies.signed['jwt_keeper']
+          cookie_secret: defined?(cookies) && cookies.signed['jwt_keeper']
         )
     end
 

data/lib/jwt_keeper/token.rb

@@ -2,14 +2,16 @@ 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
@@ -17,27 +19,28 @@ module JWTKeeper
       }
 
       @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)
+      claims = decode(raw_token, secret: secret, cookie_secret: cookie_secret)
       return nil if claims.nil?
 
-      new_token = new({}, cookie_secret)
+      new_token = new(secret: secret, cookie_secret: cookie_secret)
       new_token.claims = claims
 
       return nil if new_token.revoked?
@@ -114,7 +117,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
@@ -134,8 +141,10 @@ 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)
+      secret ||= JWTKeeper.configuration.secret
+
+      JWT.decode(raw_token, secret.to_s + cookie_secret.to_s, true,
                  algorithm: JWTKeeper.configuration.algorithm,
                  verify_iss: true,
                  verify_aud: true,
@@ -156,7 +165,7 @@ module JWTKeeper
     # @!visibility private
     def encode
       JWT.encode(claims.compact,
-                 JWTKeeper.configuration.secret.to_s + cookie_secret.to_s,
+                 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 = '4.0.1'.freeze
+  VERSION = '5.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

data/spec/lib/jwt_keeper/token_spec.rb

@@ -24,6 +24,15 @@ 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
     end
 
     describe '.find' do
@@ -46,20 +55,30 @@ 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
     end
 
     describe '.rotate' do
@@ -194,6 +213,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: 4.0.1
+  version: 5.0.0
 platform: ruby
 authors:
 - David Rivera
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-02-27 00:00:00.000000000 Z
+date: 2021-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler