active_model_otp 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9d9aedb666900aee840275449fcdb4c2fb912c27
-  data.tar.gz: de9ef98a499709f05a3a836cd50242c74f8b1fdf
+  metadata.gz: a53fb4e15fa9408222f26928a84d9b1f67919b86
+  data.tar.gz: f436275d42c9e8e78c074809be7cbc06da3e9c16
 SHA512:
-  metadata.gz: bc0e46abcdae3948c4ea3bf51d92848ecc887d83efb611f7828b830d45f4d2372e0aa45d1c229e627de6e5d404c1ebb626d4c130ed6a3f14980cae6de33da122
-  data.tar.gz: 302bcfde4c0b3d33355cf44ed9b8896a1f83c615c3fafdc9c741ae171955ab78197e5de9b31ac0a4cc7d60fd801c2718c08949f7fc724e8b821e852d10a67179
+  metadata.gz: 4c409cf8191c2511f7f7c984d0b2623463f65a835e5b86d6cec3dd59b9f91836f8a5d5308b164d328c773dbebe76c51e0c9ae0503048bc81e8326280d57a2379
+  data.tar.gz: 2b69f18d93545ea5e0e41bc3bc10930887f2f7f1b95dbee947b6e9eed256cc5b78f80014fa7e11e2f3d271f204ccf5dad9b412f9c1193404dcda64478e1d116a

data/CHANGELOG.md

@@ -1,4 +1,11 @@
-#unreleased
+#v1.2.0
+- Added Counter based OTP (HOTP) (@ResultsMayVary ) https://github.com/heapsource/active_model_otp/pull/19
+- Adding options to provisioning uri, so we can include issuer (@doon) https://github.com/heapsource/active_model_otp/pull/15
+
+#v1.1.0
+- Add function to re-geterante the OTP secret (@TikiTDO) https://github.com/heapsource/active_model_otp/pull/14
+- Added option to pass OTP length (@shivanibhanwal) https://github.com/heapsource/active_model_otp/pull/13
+
 #v1.0.0
 - Avoid overriding predefined otp_column value when initializing resource (Ilan Stern) https://github.com/heapsource/active_model_otp/pull/10
 - Pad OTP codes with less than 6 digits (Johan Brissmyr) https://github.com/heapsource/active_model_otp/pull/7

data/README.md

@@ -1,8 +1,12 @@
 [![Build Status](https://travis-ci.org/heapsource/active_model_otp.png)](https://travis-ci.org/heapsource/active_model_otp)
+[![Gem Version](https://badge.fury.io/rb/active_model_otp.svg)](http://badge.fury.io/rb/active_model_otp)
+[![Dependency Status](https://gemnasium.com/heapsource/active_model_otp.svg)](https://gemnasium.com/heapsource/active_model_otp)
+[![Code Climate](https://codeclimate.com/github/heapsource/active_model_otp/badges/gpa.svg)](https://codeclimate.com/github/heapsource/active_model_otp)
+
 
 # ActiveModel::Otp
 
-**ActiveModel::Otp** makes adding **Two Factor Authentication**(TFA) to a model simple, let's see what's required to get AMo::Otp working in our Application, using Rails 4.0 (AMo::Otp is also compatible with Rails 3.x versions) we're going to use an User model and some authentication to it. Inspired in AM::SecurePassword
+**ActiveModel::Otp** makes adding **Two Factor Authentication** (TFA) to a model simple. Let's see what's required to get AMo::Otp working in our Application, using Rails 4.0 (AMo::Otp is also compatible with Rails 3.x versions). We're going to use a User model and some authentication to do it. Inspired by AM::SecurePassword
 
 ## Installation
 
@@ -14,7 +18,7 @@ And then execute:
 
     $ bundle
 
-Or install it yourself as:
+Or install it yourself as follows:
 
     $ gem install active_model_otp
 
@@ -29,7 +33,7 @@ rails g migration AddOtpSecretKeyToUsers otp_secret_key:string
       create    db/migrate/20130707010931_add_otp_secret_key_to_users.rb
 ```
 
-We’ll then need to run rake db:migrate to update the users table in the database. The next step is to update the model code. We need to use has_one_time_password to tell it will be use TFA.
+We’ll then need to run rake db:migrate to update the users table in the database. The next step is to update the model code. We need to use has_one_time_password to make it use TFA.
 
 ```ruby
 class User < ActiveRecord::Base
@@ -42,20 +46,19 @@ Note: If you're adding this to an existing user model you'll need to generate *o
 User.all.each { |user| user.update_attribute(:otp_secret_key, ROTP::Base32.random_base32) }
 ```
 
-For use a custom column for store the secret key field you can us the column_name option
+To use a custom column to store the secret key field you can use the column_name option. It is also possible to generate codes with a specified length.
 
 ```ruby
 class User < ActiveRecord::Base
-  has_one_time_password column_name: :my_otp_secret_column
+  has_one_time_password column_name: :my_otp_secret_column, length: 4
 end
 ```
 
+## Usage
 
-##Usage
-
-The has_one_time_password sentence provides to the model some useful methods in order to implement our TFA system. AMo:Otp generates one time passwords according to [RFC 4226](http://tools.ietf.org/html/rfc4226) and the [HOTP RFC](http://tools.ietf.org/html/draft-mraihi-totp-timebased-00). This is compatible with Google Authenticator apps available for Android and iPhone, and now in use on GMail.
+The has_one_time_password statement provides to the model some useful methods in order to implement our TFA system. AMo:Otp generates one time passwords according to [TOTP RFC 6238](http://tools.ietf.org/html/rfc4226) and the [HOTP RFC 4226](http://tools.ietf.org/html/rfc4226). This is compatible with Google Authenticator apps available for Android and iPhone, and now in use on GMail.
 
-The otp_secret_key is saved automatically when a object is created,
+The otp_secret_key is saved automatically when an object is created,
 
 ```ruby
 user = User.create(email: "hello@heapsource.com")
@@ -63,9 +66,9 @@ user.otp_secret_key
  => "jt3gdd2qm6su5iqh"
 ```
 
-**Note:** You can fork the applications for [iPhone](https://github.com/heapsource/google-authenticator) & [Android](https://github.com/heapsource/google-authenticator.android) and customize it
+**Note:** You can fork the applications for [iPhone](https://github.com/heapsource/google-authenticator) & [Android](https://github.com/heapsource/google-authenticator.android) and customize them
 
-### Getting current code (ex. to send via SMS)
+### Getting current code (e.g. to send via SMS)
 ```ruby
 user.otp_code # => '186522'
 sleep 30
@@ -94,19 +97,66 @@ sleep 30 # lets wait again
 user.authenticate_otp('186522', drift: 60) # => true
 ```
 
+## Counter based OTP
+
+An additonal counter field is required in our ``User`` Model
+
+```ruby
+rails g migration AddCounterForOtpToUsers otp_counter:integer
+=>
+      invoke  active_record
+      create    db/migrate/20130707010931_add_counter_for_otp_to_users.rb
+```
+
+In addition set the counter flag option to true
+
+```ruby
+class User < ActiveRecord::Base
+  has_one_time_password counter_based: true
+end
+```
+
+And for a custom counter column
+
+```ruby
+class User < ActiveRecord::Base
+  has_one_time_password counter_based: true, counter_column_name: :my_otp_secret_counter_column
+end
+```
+
+Authentication is done the same. You can manually adjust the counter for your usage or set auto_increment on success to true.
+
+```ruby
+user.authenticate_otp('186522') # => true
+user.authenticate_otp('186522', auto_increment: true) # => true
+user.authenticate_otp('186522') # => false
+user.otp_counter -= 1
+user.authenticate_otp('186522') # => true
+```
+
+When retrieving an ```otp_code``` you can also pass the ```auto_increment``` option.
+
+```ruby
+user.otp_code # => '186522'
+user.otp_code # => '186522'
+user.otp_code(auto_increment: true) # => '768273'
+user.otp_code(auto_increment: true) # => '002811'
+user.otp_code # => '002811'
+```
+
 ## Google Authenticator Compatible
 
 The library works with the Google Authenticator iPhone and Android app, and also includes the ability to generate provisioning URI's to use with the QR Code scanner built into the app.
 
 ```ruby
-# Use you user's emails for generate the provisioning_url
+# Use your user's email address to generate the provisioning_url
 user.provisioning_uri # => 'otpauth://totp/hello@heapsource.com?secret=2z6hxkdwi3uvrnpn'
 
-# Use a custom fied for generate the provisioning_url
+# Use a custom field to generate the provisioning_url
 user.provisioning_uri("hello") # => 'otpauth://totp/hello?secret=2z6hxkdwi3uvrnpn'
 ```
 
-This can then be rendered as a QR Code which can then be scanned and added to the users list of OTP credentials.
+This can then be rendered as a QR Code which can be scanned and added to the users list of OTP credentials.
 
 ### Working example
 

data/lib/active_model/one_time_password.rb

@@ -5,20 +5,27 @@ module ActiveModel
     module ClassMethods
 
       def has_one_time_password(options = {})
-
-        cattr_accessor :otp_column_name
-        class_attribute :otp_digits
+        cattr_accessor :otp_column_name, :otp_counter_column_name
+        class_attribute :otp_digits, :otp_counter_based
 
         self.otp_column_name = (options[:column_name] || "otp_secret_key").to_s
         self.otp_digits = options[:length] || 6
 
+        self.otp_counter_based = (options[:counter_based] || false)
+        self.otp_counter_column_name = (
+          options[:counter_column_name] || "otp_counter"
+          ).to_s
+
         include InstanceMethodsOnActivation
 
-        before_create { self.otp_regenerate_secret if !self.otp_column}
+        before_create do
+          self.otp_regenerate_secret if !otp_column
+          self.otp_regenerate_counter if otp_counter_based && !otp_counter
+        end
 
         if respond_to?(:attributes_protected_by_default)
           def self.attributes_protected_by_default #:nodoc:
-            super + [self.otp_column_name]
+            super + [otp_column_name, otp_counter_column_name]
           end
         end
       end
@@ -29,29 +36,56 @@ module ActiveModel
         self.otp_column = ROTP::Base32.random_base32
       end
 
+      def otp_regenerate_counter
+        self.otp_counter = 1
+      end
+
       def authenticate_otp(code, options = {})
-        totp = ROTP::TOTP.new(self.otp_column, {digits: self.otp_digits})
-        if drift = options[:drift]
-          totp.verify_with_drift(code, drift)
+        if otp_counter_based
+          hotp = ROTP::HOTP.new(otp_column, digits: otp_digits)
+          result = hotp.verify(code, otp_counter)
+          if result && options[:auto_increment]
+            self.otp_counter += 1
+            save if !new_record?
+          end
+          result
         else
-          totp.verify(code)
+          totp = ROTP::TOTP.new(otp_column, digits: otp_digits)
+          if drift = options[:drift]
+            totp.verify_with_drift(code, drift)
+          else
+            totp.verify(code)
+          end
         end
       end
 
       def otp_code(options = {})
-        if options.is_a? Hash
-          time = options.fetch(:time, Time.now)
-          padding = options.fetch(:padding, true)
+        if otp_counter_based
+          if options[:auto_increment]
+            self.otp_counter += 1
+            save if !new_record?
+          end
+          ROTP::HOTP.new(otp_column, digits: otp_digits).at(self.otp_counter)
         else
-          time = options
-          padding = true
+          if options.is_a? Hash
+            time = options.fetch(:time, Time.now)
+            padding = options.fetch(:padding, true)
+          else
+            time = options
+            padding = true
+          end
+          ROTP::TOTP.new(otp_column, digits: otp_digits).at(time, padding)
         end
-        ROTP::TOTP.new(self.otp_column, {digits: self.otp_digits}).at(time, padding)
       end
 
-      def provisioning_uri(account = nil)
+      def provisioning_uri(account = nil, options = {})
         account ||= self.email if self.respond_to?(:email)
-        ROTP::TOTP.new(self.otp_column).provisioning_uri(account)
+
+        if otp_counter_based
+          ROTP::HOTP.new(otp_column, options).provisioning_uri(account)
+        else
+          ROTP::TOTP.new(otp_column, options).provisioning_uri(account)
+        end
       end
 
       def otp_column
@@ -61,6 +95,14 @@ module ActiveModel
       def otp_column=(attr)
         self.send("#{self.class.otp_column_name}=", attr)
       end
+
+      def otp_counter
+        self.send(self.class.otp_counter_column_name)
+      end
+
+      def otp_counter=(attr)
+        self.send("#{self.class.otp_counter_column_name}=", attr)
+      end
     end
   end
 end

data/lib/active_model/otp/version.rb

@@ -1,5 +1,5 @@
 module ActiveModel
   module Otp
-    VERSION = "1.1.0"
+    VERSION = "1.2.0"
   end
 end

data/test/one_time_password_test.rb

@@ -61,6 +61,13 @@ class OtpTest < MiniTest::Unit::TestCase
     assert_match %r{otpauth://totp/roberto@heapsource\.com\?secret=\w{16}}, @visitor.provisioning_uri
   end
 
+  def test_provisioning_uri_with_options
+    assert_match  %r{otpauth://totp/roberto@heapsource\.com\?issuer=Example&secret=\w{16}},@user.provisioning_uri(nil,issuer: "Example")
+    assert_match %r{otpauth://totp/roberto@heapsource\.com\?issuer=Example&secret=\w{16}}, @visitor.provisioning_uri(nil,issuer: "Example")
+    assert_match %r{otpauth://totp/roberto\?issuer=Example&secret=\w{16}}, @user.provisioning_uri("roberto", issuer: "Example")
+    assert_match %r{otpauth://totp/roberto\?issuer=Example&secret=\w{16}}, @visitor.provisioning_uri("roberto", issuer: "Example")
+  end
+
   def test_regenerate_otp
     secret = @user.otp_column
     @user.otp_regenerate_secret

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_model_otp
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Guillermo Iguaran
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-10 00:00:00.000000000 Z
+date: 2015-02-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel