two_factor_cookies 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 241ec50e9eff97c7afea1414e8b29314cb583d22
-  data.tar.gz: ba4267a354328a32050c47c161494ecd5b7c46fc
+SHA256:
+  metadata.gz: 8ccf0f45cecbc377af4bd82b5ac202731a8c09e160202199dd6133a613bbcc2c
+  data.tar.gz: 20d7518de754fbfe4fe5c58cd820d0d04544a55497485ce3ab22967d954cd7ba
 SHA512:
-  metadata.gz: 47991ccded64ecaf8a6986c0f04585527d37e5af6775ddfa75cd6bacba313a86406bf017da2b62c7826f57befae17e4a9249684b8f18983ba046da570d6a0706
-  data.tar.gz: 558a837a8afc2ccc4beca5a3a1331a1d324ce88e8c5a681f10e26422eec7f8e552749ae986f189a514f8958d4bef8c497969e8703611278c0da8ef517d44ef34
+  metadata.gz: 696b69c8e9b4b08dbc886b5c7cbcb0fb1b7a085dc92488eecd3d8bcb1b430df5873b6196cc18d5612c1b179fb63a1a1aabaad1fd0e5cfbf622fe66e073ee38ee
+  data.tar.gz: e29110160189fe56898b998b68f33bff6d68af084773c57ea7791f68633b71f2f96371ff3cac01e9efb1c89ddc15c8ed0d9453ad1c6d759c7ade83ef33b6af52

data/README.md

@@ -94,21 +94,41 @@ If using ActiveRecord or Mongoid, `enabled_two_factor?` and `confirmed_phone_num
 
 #### Example implementations
 ```ruby
-   def disable_two_factor!
-    self.enabled_two_factor = false
-    save
-  end
+def disable_two_factor!
+  self.enabled_two_factor = false
+  save
+end
 ```
 If for example you want to delete the phone number, when disabling 2fa, it could be done here
 ```ruby
-  def disaffirm_phone_number!
-    self.confirmed_phone_number = false
-    self.phone_number = nil
-    save
-  end
+def disaffirm_phone_number!
+  self.confirmed_phone_number = false
+  self.phone_number = nil
+  save
+end
 ```
 
 When disabling two factor authentication, `disaffirm_phone_number!` is also called and a new confirmation of the phone number is required, if 2fa is enabled again.
 
+## ToggleTwoFactorController
+### Toggling two factor on and off
+Toggling two factor on and off is handled by the `ToggleTwoFactorController` in the action also named `toggle_two_factor`. It requires whatever form is used for this to supply parameters in the format
+```ruby
+{ user: { enabled_two_factor: '1' } }
+```
+`user` in the param is the name of the user model in the app, taken from the configuration. If enabled_two_factor is '1', two factor is toggled on. If enabled_two_factor is anything else, two factor will be toggled off
+
+#### Logging
+The gem can be configured to log, when 2fa is toggled on or off. To do this you must configure `logging_module` with a module that has `log` defined in whatever way makes sense in your project. The method will be passed a message consisting of a translation with a user id.
+```
+module Log
+  extend ActiveSupport::Concern
+
+  def log(message)
+    Rails.logger.info message
+  end
+end
+```
+
 ## License
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/app/controllers/two_factor_cookies/toggle_two_factor_controller.rb

@@ -1,5 +1,7 @@
 TwoFactorCookies.const_set('ToggleTwoFactorController',
   Class.new('TwoFactorCookies::TwoFactorAuthenticationController'.constantize) do
+    include TwoFactorCookies.configuration.logging_module.constantize if TwoFactorCookies.configuration.logging_module
+
     def update
       if TwoFactorCookies::OneTimePasswordGenerator.verify_code(
         confirm_phone_number_params[:one_time_password],
@@ -23,9 +25,11 @@ TwoFactorCookies.const_set('ToggleTwoFactorController',
         current_user.enable_two_factor!
         current_user.update(update_params) if TwoFactorCookies.configuration.update_params
         set_authenticated_cookie
+        log(I18n.t('two_factor_cookies.logger.toggle_2fa_on', id: current_user.id)) if TwoFactorCookies.configuration.logging_module
       else
         current_user.disable_two_factor!
         current_user.disaffirm_phone_number!
+        log(I18n.t('two_factor_cookies.logger.toggle_2fa_off', id: current_user.id)) if TwoFactorCookies.configuration.logging_module
       end
 
       redirect_to eval(TwoFactorCookies.configuration.engine_name).public_send(

data/config/locales/en.yml

@@ -14,3 +14,9 @@ en:
       flash:
         confirmed: Phone number confirmed
         wrong_one_time_password: Wrong code - try again
+    logger:
+      toggle_2fa_on: "Two factor toggled on for user id %{id}"
+      toggle_2fa_off: "Two factor toggled off for user id %{id}"
+      confirm_phone_number_success: "Confirmation of phone number %{phone_number} successful for user id %{id}"
+      confirm_phone_number_fail: "Confirmation of phone number %{phone_number} failed for user id %{id}"
+

data/lib/two_factor_cookies/configuration.rb

@@ -4,7 +4,7 @@ module TwoFactorCookies
       :toggle_two_factor_success_route, :two_factor_authentication_expiry, :otp_expiry, :twilio_account_sid,
       :twilio_phone_number, :twilio_auth_token, :phone_number_field_name, :user_model_name, :username_field_name,
       :two_factor_authentication_controller_parent, :skip_before_action, :layout_path, :additional_authentication_values,
-      :update_params, :engine_name
+      :update_params, :engine_name, :logging_module
 
     def initialize
       @otp_generation_secret_key = nil
@@ -24,6 +24,7 @@ module TwoFactorCookies
       @confirm_phone_number_success_route = nil
       @layout_path = nil
       @two_factor_authentication_controller_parent = '::ApplicationController'
+      @logging_module = nil
 
       @additional_authentication_values = {}
 

data/lib/two_factor_cookies/version.rb

@@ -1,3 +1,3 @@
 module TwoFactorCookies
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: two_factor_cookies
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Nicolai Bach Woller
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-02 00:00:00.000000000 Z
+date: 2019-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -159,9 +159,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Simple two factor logon - with Twilio SMS for code delivery
 test_files: []
-has_rdoc: