clerk-sdk-ruby 3.2.0 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7e5b0d6f82c56ddfe8791511ecf1312aff901c8070a3b225fe9210a991002ebd
-  data.tar.gz: 9955424ce840e42db36b246642b69983d89d3ab8c35667027d48f225a08fe9ae
+  metadata.gz: 7744ad750d46b3102978f5b07956bb4f9b6a34635282fc3b0e082a98be92da47
+  data.tar.gz: 30e879ce6e9f2945a85451b9141b077f5d3ea31dbe4d30b16ceda2fe18a7aa32
 SHA512:
-  metadata.gz: 2ddfdc48fa90ecb3134e881cc9a277e88af66be69239a020f9bc4bea287902186faa7ff721d322e68e96603563b96d6ac60a72b4a481c0e19be1e006516126c3
-  data.tar.gz: 8c726270e98329aaed14a8e0a4ca54701c4cea9eccff14ecea888b639f026f9c40469cc5905f81dbe678305e295ed9995e0e198b7d408c79d938eb8d2253e165
+  metadata.gz: a0c95f53c97b59dcf24ff4963b746a75e6f20ed4d26118aecaad0b04e43f8ca694b96d4f73017d62e03d58e8a0128f05161dd6825c7c89b3e2bb5cda6f291d76
+  data.tar.gz: d1f6220cfbd9d28114631d09d896f883eda94ec8589531099ff8033995e598ed92866cec7b1797d2c3534d487218eea1173be80f56b11594209132e653a26feb

data/CHANGELOG.md

@@ -1,8 +1,17 @@
 ## unreleased
 
+## 3.3.0 - 2024-11-22
+
+- changed: Align reverification names with other SDKs [https://github.com/clerk/clerk-sdk-ruby/pull/73]
+
+
+## 3.3.0.beta1 - 2024-11-04
+
+- feat: Add helpers for Step Up auth / re-verification [https://github.com/clerk/clerk-sdk-ruby/pull/72]
+
 ## 3.2.0 - 2024-04-08
 
-- fix: Infinite redirect loop when client_uat=0 and __session exists (#55) [https://github.com/clerk/clerk-sdk-ruby/pull/55]
+- fix: Infinite redirect loop when client_uat=0 and `__session` exists [https://github.com/clerk/clerk-sdk-ruby/pull/55]
 
 ## 3.1.0 - 2024-03-19
 

data/lib/clerk/authenticatable.rb

@@ -73,6 +73,16 @@ module Clerk
       !!clerk_verified_session_claims
     end
 
+    def clerk_user_needs_reverification?(params=StepUp::PRESETS[:strict])
+      !request.env['clerk'].is_user_reverified?(params)
+    end
+
+    def clerk_render_reverification(missing_config=nil)
+      payload = request.env['clerk'].reverification_error_payload(missing_config)
+
+      render status: 403, json: payload
+    end
+
     def clerk_sign_in_url
       ENV.fetch("CLERK_SIGN_IN_URL")
     end

data/lib/clerk/constants.rb

@@ -0,0 +1,10 @@
+module Clerk
+  module StepUp
+    PRESETS = {
+      strict_mfa:  { after_minutes: 10,   level: :multi_factor  },
+      strict:      { after_minutes: 10,   level: :second_factor },
+      moderate:    { after_minutes: 60,   level: :second_factor },
+      lax:         { after_minutes: 1440, level: :second_factor }
+    }
+  end
+end

data/lib/clerk/rack_middleware_v2.rb

@@ -60,6 +60,51 @@ module Clerk
       @session_claims["org_permissions"]
     end
 
+    # Returns true if the session needs to perform step up verification
+    def is_user_reverified?(params)
+      return false if session_claims.nil?
+
+      fva           = session_claims["fva"]
+      level         = params[:level]
+      after_minutes = Integer(params[:after_minutes])
+
+      # the feature is disabled
+      return true if fva.nil?
+
+      return false if after_minutes.nil? || level.nil?
+
+      factor1_age, factor2_age = fva
+      is_valid_factor1 = factor1_age != -1 && after_minutes > factor1_age
+      is_valid_factor2 = factor2_age != -1 && after_minutes > factor2_age
+
+      case level
+      when :first_factor
+        is_valid_factor1
+      when :second_factor
+        factor2_age == -1 ? is_valid_factor1 : is_valid_factor2
+      when :multi_factor
+        factor2_age == -1 ? is_valid_factor1 : is_valid_factor1 && is_valid_factor2
+      end
+    end
+
+    def reverification_error_payload(missing_config)
+      {
+        clerk_error: {
+          type:     "forbidden",
+          reason:   "reverification-error",
+          metadata: { reverification: missing_config, }
+        }
+      }
+    end
+
+    def reverification_response(missing_config=nil)
+      [
+        403,
+        { "Content-Type" => "application/json" },
+        [reverification_error_payload(missing_config).to_json],
+      ]
+    end
+
     private
 
     def fetch_user(user_id)

data/lib/clerk/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Clerk
-  VERSION = "3.2.0"
+  VERSION = "3.3.0"
 end

data/lib/clerk.rb

@@ -2,6 +2,7 @@
 
 require_relative "clerk/version"
 require_relative "clerk/sdk"
+require_relative "clerk/constants"
 
 module Clerk
   class << self

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: clerk-sdk-ruby
 version: !ruby/object:Gem::Version
-  version: 3.2.0
+  version: 3.3.0
 platform: ruby
 authors:
 - Clerk
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-04-08 00:00:00.000000000 Z
+date: 2024-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -109,6 +109,7 @@ files:
 - docs/clerk-logo-light.png
 - lib/clerk.rb
 - lib/clerk/authenticatable.rb
+- lib/clerk/constants.rb
 - lib/clerk/errors.rb
 - lib/clerk/jwks_cache.rb
 - lib/clerk/rack_middleware.rb
@@ -152,7 +153,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: Clerk SDK for Ruby.