zaikio-jwt_auth 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c782ad558e422167c59f3c29dfdd9533d97153a17f05955a12eb127e32d55a68
-  data.tar.gz: 063fc86f98d24d70e496f324ccc87ec32f71f61ba50c91a70708ca20afe8b1c7
+  metadata.gz: e030f7e4c7f0be8b37a722ff691b7bf1398cd31ca449b41a9923b51f5a008df8
+  data.tar.gz: 13a0d7a174af3ca58772b116e22d2fcc893291d59010ce127df82f1dca77ea5c
 SHA512:
-  metadata.gz: 4b24750a7edda299537d85f6bf852a85aaba442f77a18d6c9998d3ef491fa1b329b843b23ddc7b2b6f309ab3abac2c94e0448eef2c7370a9a59014e8823add84
-  data.tar.gz: 8b39b2cdaa531bb985b59a374584e6ba2d0167213f9e70185be84462843044478026bc74b8d24e972cd840e1a4402a8ff5390245948fd0b3393ebb1ccc31baa7
+  metadata.gz: c91befdc7f28018a2e19bcafdcbd805ef87467a6fde8fc1b4899b6c6a327a6a89327902f84bdd07f42749c265535cdc3b83bd6289e958fcd2b4d520e46462d94
+  data.tar.gz: aa56620ee2936346ef5b6d73ff0e8189ad8cc46d7ab44ca36783ad744f577513fb4786fa48023f4918491b04f166d9f0db5b66ef8b9f9a7d6ee04a315938bde7

data/README.md

@@ -192,6 +192,18 @@ This client supports any implementation of
 but you can also write your own client that supports these methods: `#read(key)`,
 `#write(key, value)`, `#delete(key)`
 
+### Pass custom options to JWT auth
+
+In some cases you want to add custom options to the JWT check. For example you want to allow expired JWTs when revoking access tokens.
+
+```rb
+class API::RevokedAccessTokensController < API::ApplicationController
+  def jwt_options
+    { verify_expiration: false }
+  end
+end
+```
+
 ## Contributing
 
 **Make sure you have the dummy app running locally to validate your changes.**

data/lib/zaikio/jwt_auth/version.rb

@@ -1,5 +1,5 @@
 module Zaikio
   module JWTAuth
-    VERSION = "2.0.0".freeze
+    VERSION = "2.1.0".freeze
   end
 end

data/lib/zaikio/jwt_auth.rb

@@ -54,14 +54,16 @@ module Zaikio
 
     HEADER_FORMAT = /\ABearer (.+)\z/.freeze
 
-    def self.extract(authorization_header_string)
+    def self.extract(authorization_header_string, **options)
       return TokenData.new(Zaikio::JWTAuth.mocked_jwt_payload) if Zaikio::JWTAuth.mocked_jwt_payload
 
       return if authorization_header_string.blank?
 
       return unless (token = authorization_header_string[HEADER_FORMAT, 1])
 
-      payload, = JWT.decode(token, nil, true, algorithms: ["RS256"], jwks: JWK.loader)
+      options.reverse_merge!(algorithms: ["RS256"], jwks: JWK.loader)
+
+      payload, = JWT.decode(token, nil, true, **options)
 
       TokenData.new(payload)
     end
@@ -93,7 +95,7 @@ module Zaikio
 
     module InstanceMethods
       def authenticate_by_jwt
-        token_data = Zaikio::JWTAuth.extract(request.headers["Authorization"])
+        token_data = Zaikio::JWTAuth.extract(request.headers["Authorization"], **jwt_options)
         return render_error("no_jwt_passed", status: :unauthorized) unless token_data
 
         return if show_error_if_token_is_revoked(token_data)
@@ -150,6 +152,10 @@ module Zaikio
       def render_error(error, status: :forbidden)
         render(status: status, json: { "errors" => [error] })
       end
+
+      def jwt_options
+        {}
+      end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zaikio-jwt_auth
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - crispymtn
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-04-29 00:00:00.000000000 Z
+date: 2022-08-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob