authie 4.0.0.rc7 → 4.0.0.rc10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 44634d5c60eeabd533457e52d0c6926fc7e72a91affd8d9bd1ff18bc07884c5c
-  data.tar.gz: 310b072244bbcd463d7615e2e77b94c7829bae98af0508276b952ea000e3bb44
+  metadata.gz: c2ba869656ec43ca7b92803584ad2361ad2a7c443b2b69bc7f7bac2c0e991218
+  data.tar.gz: 67340e7ab60e5fafb35a17a8760611d5f1c25a3ae67abf75363f7210ec3cb181
 SHA512:
-  metadata.gz: c560dafa6d2b626f753e6afac7152ea2d950536b4a520fcd4454b88fbd8978884523fe44ce1ae90547565a1090e8e447d48a983f91d2a52cf8824f77c1ac993d
-  data.tar.gz: 75642d5fb4aa28807e9fc32e77e4de90cf1527da81ddccdcd4b2bf0c233240c2642acb7b100e7931bc2a169429289626c962ab88bc305a2cf016446e2ac229b5
+  metadata.gz: b6f3604a227d448f0d2724eb6566f83c4b665121fd3d9075691bdccd4e72370a230b4916ae1a8fd8b68fff893e81b5bd39170be2c5ebe244817fa33c5365daf7
+  data.tar.gz: fcde4d28afbc7bab2727150c69be0baa527a89e65bb1047159499247771b2284bec104f54bbd7adf7db52f18dacac58ab0817085d8b42ff8f07e226b201bffe6

data/db/migrate/20220502180100_add_two_factor_required_to_sessions.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class AddTwoFactorRequiredToSessions < ActiveRecord::Migration[4.2]
+  def change
+    add_column :authie_sessions, :skip_two_factor, :boolean, default: false
+  end
+end

data/lib/authie/config.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'authie/event_manager'
-
 module Authie
   class Config
     attr_accessor :session_inactivity_timeout
@@ -10,7 +8,6 @@ module Authie
     attr_accessor :browser_id_cookie_name
     attr_accessor :session_token_length
     attr_accessor :extend_session_expiry_on_touch
-    attr_accessor :events
 
     def initialize
       @session_inactivity_timeout = 12.hours
@@ -19,7 +16,6 @@ module Authie
       @browser_id_cookie_name = :browser_id
       @session_token_length = 64
       @extend_session_expiry_on_touch = false
-      @events = EventManager.new
     end
   end
 
@@ -32,5 +28,9 @@ module Authie
       block.call(config)
       config
     end
+
+    def notify(event, args = {}, &block)
+      ActiveSupport::Notifications.instrument("#{event}.authie", args, &block)
+    end
   end
 end

data/lib/authie/controller_delegate.rb

@@ -34,7 +34,9 @@ module Authie
           httponly: true,
           secure: @controller.request.ssl?
         }
-        Authie.config.events.dispatch(:set_browser_id, proposed_browser_id)
+        Authie.notify(:set_browser_id,
+                      browser_id: proposed_browser_id,
+                      controller: @controller)
       end
       proposed_browser_id
     end

data/lib/authie/session.rb

@@ -94,7 +94,7 @@ module Authie
       @session.requests += 1
       extend_session_expiry_if_appropriate
       @session.save!
-      Authie.config.events.dispatch(:session_touched, self)
+      Authie.notify(:touch, session: self)
       self
     end
 
@@ -105,7 +105,7 @@ module Authie
     def see_password
       @session.password_seen_at = Time.now
       @session.save!
-      Authie.config.events.dispatch(:seen_password, self)
+      Authie.notify(:see_password, session: self)
       self
     end
 
@@ -114,11 +114,12 @@ module Authie
     #
     # @raises [ActiveRecord::RecordInvalid]
     # @return [Authie::Session]
-    def mark_as_two_factored
+    def mark_as_two_factored(skip: nil)
       @session.two_factored_at = Time.now
       @session.two_factored_ip = @controller.request.ip
+      @session.skip_two_factor = skip unless skip.nil?
       @session.save!
-      Authie.config.events.dispatch(:marked_as_two_factor, self)
+      Authie.notify(:mark_as_two_factor, session: self)
       self
     end
 
@@ -129,7 +130,7 @@ module Authie
     # @return [Authie::Session]
     def start
       set_cookie
-      Authie.config.events.dispatch(:start_session, session)
+      Authie.notify(:session_start, session: self)
       self
     end
 
@@ -152,7 +153,7 @@ module Authie
         httponly: true,
         expires: @session.expires_at
       }
-      Authie.config.events.dispatch(:session_cookie_updated, self)
+      Authie.notify(:cookie_updated, session: session)
       true
     end
     # rubocop:enable Naming/AccessorMethodName
@@ -164,7 +165,7 @@ module Authie
     def validate_browser_id
       if cookies[:browser_id] != @session.browser_id
         invalidate
-        Authie.config.events.dispatch(:browser_id_mismatch_error, self)
+        Authie.notify(:browser_id_mismatch_error, session: self)
         raise BrowserMismatch, 'Browser ID mismatch'
       end
 
@@ -174,7 +175,7 @@ module Authie
     def validate_active
       unless @session.active?
         invalidate
-        Authie.config.events.dispatch(:invalid_session_error, self)
+        Authie.notify(:invalid_session_error, session: self)
         raise InactiveSession, 'Session is no longer active'
       end
 
@@ -184,7 +185,7 @@ module Authie
     def validate_expiry
       if @session.expired?
         invalidate
-        Authie.config.events.dispatch(:expired_session_error, self)
+        Authie.notify(:expired_session_error, session: self)
         raise ExpiredSession, 'Persistent session has expired'
       end
 
@@ -194,7 +195,7 @@ module Authie
     def validate_inactivity
       if @session.inactive?
         invalidate
-        Authie.config.events.dispatch(:inactive_session_error, self)
+        Authie.notify(:inactive_session_error, session:  self)
         raise InactiveSession, 'Non-persistent session has expired'
       end
 
@@ -204,7 +205,7 @@ module Authie
     def validate_host
       if @session.host && @session.host != @controller.request.host
         invalidate
-        Authie.config.events.dispatch(:host_mismatch_error, self)
+        Authie.notify(:host_mismatch_error, session: self)
         raise HostMismatch, "Session was created on #{@session.host} but accessed using #{@controller.request.host}"
       end
 
@@ -263,6 +264,7 @@ module Authie
       end
 
       delegate :hash_token, to: SessionModel
+      delegate :cleanup, to: SessionModel
     end
 
     # Backwards compatibility with Authie < 4.0. These methods were all available on sessions
@@ -304,6 +306,7 @@ module Authie
     delegate :two_factored_at, to: :session
     delegate :two_factored_ip, to: :session
     delegate :two_factored?, to: :session
+    delegate :skip_two_factor?, to: :session
     delegate :update, to: :session
     delegate :update!, to: :session
     delegate :user_agent, to: :session

data/lib/authie/session_model.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'active_record/base'
+require 'active_record'
 require 'securerandom'
 require 'authie/config'
 
@@ -136,13 +136,13 @@ module Authie
 
       # Cleanup any old sessions.
       def cleanup
-        Authie.config.events.dispatch(:before_cleanup)
-        # Invalidate transient sessions that haven't been used
-        active.where('expires_at IS NULL AND last_activity_at < ?',
-                     Authie.config.session_inactivity_timeout.ago).each(&:invalidate!)
-        # Invalidate persistent sessions that have expired
-        active.where('expires_at IS NOT NULL AND expires_at < ?', Time.now).each(&:invalidate!)
-        Authie.config.events.dispatch(:after_cleanup)
+        Authie.notify(:cleanup) do
+          # Invalidate transient sessions that haven't been used
+          active.where('expires_at IS NULL AND last_activity_at < ?',
+                       Authie.config.session_inactivity_timeout.ago).each(&:invalidate!)
+          # Invalidate persistent sessions that have expired
+          active.where('expires_at IS NOT NULL AND expires_at < ?', Time.now).each(&:invalidate!)
+        end
         true
       end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: authie
 version: !ruby/object:Gem::Version
-  version: 4.0.0.rc7
+  version: 4.0.0.rc10
 platform: ruby
 authors:
 - Adam Cooke
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-05-02 00:00:00.000000000 Z
+date: 2022-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -232,13 +232,13 @@ files:
 - db/migrate/20170417170000_add_token_hashes_to_authie_sessions.rb
 - db/migrate/20170421174100_add_index_to_token_hashes_on_authie_sessions.rb
 - db/migrate/20180215152200_add_host_to_authie_sessions.rb
+- db/migrate/20220502180100_add_two_factor_required_to_sessions.rb
 - lib/authie.rb
 - lib/authie/config.rb
 - lib/authie/controller_delegate.rb
 - lib/authie/controller_extension.rb
 - lib/authie/engine.rb
 - lib/authie/error.rb
-- lib/authie/event_manager.rb
 - lib/authie/rack_controller.rb
 - lib/authie/session.rb
 - lib/authie/session_model.rb

data/lib/authie/event_manager.rb

@@ -1,32 +0,0 @@
-# frozen_string_literal: true
-
-module Authie
-  class EventManager
-    attr_reader :callbacks
-
-    def initialize
-      @callbacks = {}
-    end
-
-    def dispatch(event, *args)
-      callbacks = @callbacks[event.to_sym]
-      return if callbacks.nil?
-
-      callbacks.each do |cb|
-        cb.call(*args)
-      end
-    end
-
-    def on(event, &block)
-      @callbacks[event.to_sym] ||= []
-      @callbacks[event.to_sym] << block
-    end
-
-    def remove(event, block)
-      cb = @callbacks[event.to_sym]
-      return if cb.nil?
-
-      cb.delete(block)
-    end
-  end
-end