researchable_jwt-authenticable 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: abeaaf5f3a590567cc0e31b701204f3fea0ef6598fddfa03eb97dcb34beb4436
-  data.tar.gz: e72942114fc0c82482d01d8a6e9b8c4083fc2223466290de06e2b6ffb4c4397e
+  metadata.gz: 774ef8d7205e1cb743e03ad7f658e0df91db3c77b349accbc3dd62b02ac3d7df
+  data.tar.gz: cca34a23985fa690828759f2d85e7175a980aabccdc578b31d795d109daa604f
 SHA512:
-  metadata.gz: '00519275b196a8d5b2dd2d75c1a1951ed8b91076e937ed34285f768eec98365468aaa4881c9a7084c03b5d0d495b0ce70bc7ffc6ebd19148f8335a3def579ef9'
-  data.tar.gz: ba644ed5e3a31da8d29ca334d393857ae3abf97e9d694613b850d9ee98ddb4d27e16be5113450d9859dda256fafbb582594a9af78c07275a50d33cb4305ab63f
+  metadata.gz: 773a8d193f54f53cf254224ea1db9b1a720183abf9644c36b9734139b6dd497dd52d610b3d1b45d5932d9732f7c8027f73b911aade2968acf32291c476f1f1b5
+  data.tar.gz: 7276f611cf981d9752a634b9ecc6e270f50f7c397804184ccc632d3db9d948fad33911929133e856adcf2878a4075abad76d5d246ff889dd8956ce70eef8f4ed

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [1.2.0](https://gitlab.com/researchable/general/gems/jwt-authenticable/compare/v1.1.0...v1.2.0) (2023-10-11)
+
+
+### Features
+
+* allow skipping 2fa ([541de8a](https://gitlab.com/researchable/general/gems/jwt-authenticable/commit/541de8a7ac4cc2029c00b44f30dde2486b4dfb06))
+
 # [1.1.0](https://gitlab.com/researchable/general/gems/jwt-authenticable/compare/v1.0.1...v1.1.0) (2023-06-30)
 
 

data/lib/jwt_authenticable/auth.rb

@@ -11,28 +11,33 @@ module JwtAuthenticable
 
     # Authenticates a user.
     # @raise MissingAuthScope if the jwt does not have the right scope
-    def authenticate_user!
-      validate_jwt_token! token: authorization_token!
+    def authenticate_user!(skip_2fa: false)
+      validate_jwt_token! token: authorization_token!, skip_2fa: skip_2fa
     rescue MissingAuth, MissingAuthScope, InvalidAuthScheme, TwoFANotEnabledError, JWT::VerificationError,
            JWT::ExpiredSignature => e
       unauthorized(e.message)
     end
 
+    def authenticate_user_without_2fa!
+      authenticate_user!(skip_2fa: true)
+    end
+
     # Consider any method below as private and not meant to be used by including classes
 
     # Validate that the JWT token signature and the following claims are valid:
     #  - exp
     #  - scope
     # @param token [String] JWT token string (just the token, with the header, payload and signature separated by '.')
-    # @param is_researcher [Boolean] Whether to validate the token as a researcher's or a participant's
+    # @param skip_2fa [Boolean] When set to true it will not raise a TwoFANotEnabledError if the jwt payload does not
+    #                           contain the 2fa claim.
     # @raise AuthorizationError if the user is trying to login with the incorrect rights.
     # @return [Hash] the JWT payload
-    def validate_jwt_token!(token:)
+    def validate_jwt_token!(token:, skip_2fa: false)
       # NOTE: it is still safe if JWT_SECRET_KEY is not set. The method will trigger a JWT exception
       payload = JWT.decode(token, JwtAuthenticable.config.jwt_secret_key, true,
                            { algorithm: algorithm }).first
 
-      raise TwoFANotEnabledError if JwtAuthenticable.config.enforce_2fa && !payload['2fa']
+      raise TwoFANotEnabledError if JwtAuthenticable.config.enforce_2fa && !payload['2fa'] && !skip_2fa
 
       payload
     end

data/lib/jwt_authenticable/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module JwtAuthenticable
-  VERSION = '1.1.0'
+  VERSION = '1.2.0'
 end

data/node_modules/semantic-release-rubygem/src/__tests__/fixtures/valid/lib/test-gem/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module TestGem
-  VERSION = '1.1.0'
+  VERSION = '1.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: researchable_jwt-authenticable
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Researchable
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-06-30 00:00:00.000000000 Z
+date: 2023-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-configurable
@@ -67,7 +67,7 @@ files:
 - node_modules/semantic-release-rubygem/src/__tests__/fixtures/prerelease/lib/test-gem/version.rb
 - node_modules/semantic-release-rubygem/src/__tests__/fixtures/valid/lib/test-gem/version.rb
 - sig/jwt_authenticable.rbs
-homepage: https://gitlab.com/researchable/general/gems/jwt-authenticable/-/blob/v1.1.0/README.md
+homepage: https://gitlab.com/researchable/general/gems/jwt-authenticable/-/blob/v1.2.0/README.md
 licenses:
 - MIT
 metadata: