two_factor_cookies 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9713b369c8e8f380b513419c48aecf9ece9452b3
-  data.tar.gz: 6884bce7e414cafaaf41db49bd7219a890aef13e
+  metadata.gz: 241ec50e9eff97c7afea1414e8b29314cb583d22
+  data.tar.gz: ba4267a354328a32050c47c161494ecd5b7c46fc
 SHA512:
-  metadata.gz: 7421c34e7c0b19cc41f20fa52141aa843e750689ebe1d0df4ed8f62d1ecd0c4f7e22797e9659724a5673916ec0b3d41dc4ab9ee3310ed786210d938ddffd0ff8
-  data.tar.gz: b70483ca83b32182b4db5e3a64f2bcf450c5262297548158d800d96cd77ce8af0e2612060054da7a7a5e4cf678b261d3a087bea1ab82fc415629dcb76e91fd32
+  metadata.gz: 47991ccded64ecaf8a6986c0f04585527d37e5af6775ddfa75cd6bacba313a86406bf017da2b62c7826f57befae17e4a9249684b8f18983ba046da570d6a0706
+  data.tar.gz: 558a837a8afc2ccc4beca5a3a1331a1d324ce88e8c5a681f10e26422eec7f8e552749ae986f189a514f8958d4bef8c497969e8703611278c0da8ef517d44ef34

data/README.md

@@ -1,14 +1,13 @@
 # TwoFactorCookies
-Short description and motivation.
-
-## Usage
-How to use my plugin.
+Simple two factor logon using Twilio SMS for code delivery and ROTP fpr code generation and verification.
+The aim is to be configurable and work with as many kinds of authentication as possible.
+All information needed is placed in encrypted cookies.
 
 ## Installation
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'two_factor_cookies', git: 'git@bitbucket.org:cs2software/two_factor_cookies.git', branch: 'master'
+gem 'two_factor_cookies', '0.1.1'
 ```
 
 And then execute:
@@ -22,14 +21,94 @@ The gem is a rails engine, so it needs to be mounted to a location in `routes.rb
 mount TwoFactorCookies::Engine, at: '/two_factor_cookies'
 ```
 
-Todo: Document initializeer
+The gem needs to be configured. The example below can be copied and placed in an initializer, eg. `config/initializers/2fa_setup.rb`
+```ruby
+TwoFactorCookies.configure do |config|
+  # One time password (otp) generation and verification
+  # Must be a 160 bit (32 character) base32 secret. The rotp gem included in the project can generate such a key by typing this in the console: ROTP::Base32.random
+  config.otp_generation_secret_key =  MUST BE FILLED
+
+  # Cookie expiry
+  # When a user will need to perform 2fa again
+  # config.two_factor_authentication_expiry = 30.days.from_now
+  # How much time a user has to type in the otp sent to his phone
+  # config.otp_expiry = 30.minutes.from_now
+
+  # Twilio API credentials
+  config.twilio_account_sid = MUST BE FILLED
+  # phone number is the number, that will be shown on the receiving phone. It can also be a string, for example the name of your company
+  config.twilio_phone_number = MUST BE FILLED
+  config.twilio_auth_token = MUST BE FILLED
+
+  # User model
+  # user_model_name is used as the permit option in toggle_two_factor_controller
+  # config.user_model_name = :user
+  # config.phone_number_field_name = :phone_number
+  # config.username_field_name = :username
+
+  # Controllers
+  # The route you want two_factor_authentication_controller to redirect to. Would typically be where, your user is redirected to after logging in.
+  config.two_factor_authentication_success_route = MUST BE FILLED
+  # The route you want toggle_two_factor_controller to route to after a user has toggled two factor
+  config.toggle_two_factor_success_route = MUST BE FILLED
+  # The route you want toggle_two_factor_controller to route to after a user has confirmed their phone number
+  config.confirm_phone_number_success_route = MUST BE FILLED
+
+  # If you need or want to replace the layout in the two_factor_authentication_controller, add a path here, eg. 'two_factor_cookies/two_factor_authentication'
+  #config.layout_path = nil
+
+  # In order to know which user is attempting to login, the two factor authentication controller checks current_user. It
+  # looks at its parent for this method. The default parent is ApplicationController. If you use devise or have
+  # implemented current_user elsewhere, you need to supply the parent constant here
+  # config.two_factor_authentication_controller_parent = '::ApplicationController'
+
+  # If you check for additional values when determining if a user is authenticated, you need to tell the controller how
+  # to determine these values. Add a hash of key-value pairs here, where the key is the name, you want in the cookie,
+  # the value is the method used to find whatever value you want as a string. Example:
+  # { customer_no: 'current_company.customer_no' }
+  # config.additional_authentication_values = nil
+
+  # any params sent along when enabling 2fa that needs to be updated on the user model, for example a phone number
+  # config.update_params = nil
+
+  # If another engine than main_app contains the routes you want the 2fa controllers to redirect to, write the engine
+  # name here as a string
+  #config.engine_name = 'main_app'
+end
 
-In your ApplicationController you must include TwoFactorAuthentication
+```
+
+In your ApplicationController you must include TwoFactorAuthenticate
+```ruby
+class ApplicationController < ActionController::Base
+  include TwoFactorAuthenticate
+```
 
+### Using your own template for submitting otps
 The gem includes a template for submitting one time passwords. To override it, a partial named 'show' must be placed under `two_factor_cookies/two_factor_authentication`
 
-## Contributing
-Contribution directions go here.
+### Necessary methods on your user model
+TwoFactorCookies relies on a number of methods being present on your user model: `enabled_two_factor?`, `confirmed_phone_number?`, `disable_two_factor!`, `enable_two_factor!`, `confirm_phone_number!` and `disaffirm_phone_number!`.
+
+If using ActiveRecord or Mongoid, `enabled_two_factor?` and `confirmed_phone_number?` will be automatically added, if your user model has fields named `enabled_two_factor` and `confirmed_phone_number`
+
+#### Example implementations
+```ruby
+   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
+```
+
+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.
 
 ## License
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/two_factor_cookies/configuration.rb

@@ -2,7 +2,7 @@ module TwoFactorCookies
   class Configuration
     attr_accessor :otp_generation_secret_key, :two_factor_authentication_success_route, :confirm_phone_number_success_route,
       :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, :user_model_namespace, :username_field_name,
+      :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
 
@@ -15,7 +15,6 @@ module TwoFactorCookies
       @twilio_phone_number = nil
       @twilio_auth_token = nil
 
-      @user_model_namespace = nil
       @user_model_name = :user
       @phone_number_field_name = :phone_number
       @username_field_name = :username
@@ -29,9 +28,6 @@ module TwoFactorCookies
       @additional_authentication_values = {}
 
       @update_params = nil
-
-
-
       @engine_name = 'main_app'
     end
   end

data/lib/two_factor_cookies/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: two_factor_cookies
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Nicolai Bach Woller
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-01 00:00:00.000000000 Z
+date: 2019-08-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails