active_model_otp 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.ruby-version

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in has_one_time_password.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Guillermo Iguaran, Roberto Miranda, Firebase.co
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,131 @@
+# 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
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'active_model_otp'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install active_model_otp
+
+## Setting your Model
+
+We're going to add a field to our ``User`` Model, so each user can have an otp secret key. The next step is to run the migration generator in order to add the secret key field.
+
+```ruby
+rails g migration AddOtpSecretKeyToUsers otp_secret_key:string
+=>
+      invoke  active_record
+      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.
+
+```ruby
+class User < ActiveRecord::Base
+  has_one_time_password
+end
+```
+
+
+##Usage
+
+The has_one_time_password sentence provides to the model some useful methods in order to implement our TFA system. 
+The otp_secret_key is saved automatically when a object is created, otp_secret_key is generated 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.
+
+```ruby
+user = User.create(email: "hello@heapsource.com")
+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
+
+### Getting current code (ex. to send via SMS)
+```ruby
+user.otp_code # => '186522'
+sleep 30
+user.otp_code # => '850738'
+```
+
+### Authenticating using a code
+
+```ruby
+user.authenticate_otp('186522') # => true
+sleep 30 # let's wait 30 secs
+user.authenticate_otp('186522') # => false
+```
+
+### Authenticating using a slightly old code
+
+```ruby
+user.authenticate_otp('186522') # => true
+sleep 30 # lets wait again
+user.authenticate_otp('186522', drift: 60) # => true
+```
+
+## 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 provision_url
+user.provision_uri # => 'otpauth://totp/hello@heapsource.com?secret=2z6hxkdwi3uvrnpn'
+
+# Use a custom fied for generate the provision_url
+user.provision_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.
+
+### Working example
+
+Scan the following barcode with your phone, using Google Authenticator
+
+![QRCODE](http://qrfree.kaywa.com/?l=1&s=8&d=otpauth%3A%2F%2Ftotp%2Froberto%40heapsource.com%3Fsecret%3D2z6hxkdwi3uvrnpn)
+
+Now run the following and compare the output
+
+```ruby
+require "active_model_otp"
+class User
+  extend ActiveModel::Callbacks
+  include ActiveModel::Validations
+  include ActiveModel::OneTimePassword
+
+  define_model_callbacks :create
+  attr_accessor :otp_secret_key, :email
+
+  has_one_time_password
+end
+user = User.new
+user.email = 'roberto@heapsource.com'
+user.otp_secret_key = "2z6hxkdwi3uvrnpn"
+puts "Current code #{user.otp_code}"
+```
+
+### Useful Examples
+
+#### Generating QR Code with Google Charts API
+
+#### Generating QR Code with rqrcode and chunky_png
+
+#### Sendind code via email with Twilio
+
+#### Using with Mongoid
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,27 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+Bundler::GemHelper.install_tasks
+
+task :console do
+  puts "Loading development console..."
+  system("irb -r active_model_otp")
+end
+
+task :help do
+  puts "Available rake tasks: "
+  puts "rake console - Run a IRB console with all enviroment loaded"
+  puts "rake test - Run tests"
+end
+
+task :test do
+  Dir.chdir('test')
+end
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << '../lib'
+  t.libs << '../test'
+  t.test_files = FileList['*_test.rb']
+  t.verbose = false
+end
+
+task :default => :test

data/active_model_otp.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'active_model/otp/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "active_model_otp"
+  spec.version       = ActiveModel::Otp::VERSION
+  spec.authors       = ["Guillermo Iguaran", "Roberto Miranda", "Firebase.co"]
+  spec.email         = ["guilleiguaran@gmail.com", "rjmaltamar@gmail.com", "hello@firebase.co"]
+  spec.description   = %q{Adds methods to set and authenticate against one time passwords. Inspired in AM::SecurePassword"}
+  spec.summary       = "Adds methods to set and authenticate against one time passwords."
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activemodel"
+  spec.add_dependency "rotp"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest"
+end

data/lib/active_model/one_time_password.rb

@@ -0,0 +1,41 @@
+module ActiveModel
+  module OneTimePassword
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def has_one_time_password(options = {})
+
+        include InstanceMethodsOnActivation
+
+        before_create { self.otp_secret_key = ROTP::Base32.random_base32 }
+
+        if respond_to?(:attributes_protected_by_default)
+          def self.attributes_protected_by_default #:nodoc:
+            super + ["otp_secret_key"]
+          end
+        end
+      end
+    end
+
+    module InstanceMethodsOnActivation
+      def authenticate_otp(code, options = {})
+        totp = ROTP::TOTP.new(self.otp_secret_key)
+        if drift = options[:drift]
+          totp.verify_with_drift(code, drift)
+        else
+          totp.verify(code)
+        end
+      end
+
+      def otp_code(time = Time.now)
+        ROTP::TOTP.new(self.otp_secret_key).at(time)
+      end
+
+      def provisioning_uri(account = nil)
+        account ||= self.email if self.respond_to?(:email)
+        ROTP::TOTP.new(self.otp_secret_key).provisioning_uri(account)
+      end
+
+    end
+  end
+end

data/lib/active_model/otp/version.rb

@@ -0,0 +1,5 @@
+module ActiveModel
+  module Otp
+    VERSION = "0.0.1"
+  end
+end

data/lib/active_model_otp.rb

@@ -0,0 +1,8 @@
+require "active_model"
+require "active_support/core_ext/class/attribute_accessors"
+require "rotp"
+require "active_model/one_time_password"
+
+ActiveSupport.on_load(:active_record) do
+  include ActiveModel::OneTimePassword
+end

data/test/models/user.rb

@@ -0,0 +1,11 @@
+class User
+  extend ActiveModel::Callbacks
+  include ActiveModel::Validations
+  include ActiveModel::OneTimePassword
+
+  define_model_callbacks :create
+  attr_accessor :otp_secret_key, :email
+
+  has_one_time_password
+
+end

data/test/one_time_password_test.rb

@@ -0,0 +1,33 @@
+require "test_helper"
+
+class OtpTest < MiniTest::Unit::TestCase
+  def setup
+    @user = User.new
+    @user.email = 'roberto@heapsource.com'
+    @user.run_callbacks :create
+  end
+
+  def test_authenticate_with_otp
+    code = @user.otp_code
+
+    assert @user.authenticate_otp(code)
+  end
+
+  def test_authenticate_with_otp_when_drift_is_allowed
+    code = @user.otp_code(Time.now - 30)
+
+    assert @user.authenticate_otp(code, drift: 60)
+  end
+
+  def test_otp_code
+    assert_match(/\d{6}/, @user.otp_code.to_s)
+  end
+
+  def test_provisioning_uri_with_provided_account
+    assert_match %r{otpauth://totp/roberto\?secret=\w{16}}, @user.provisioning_uri("roberto")
+  end
+
+  def test_provisioning_uri_with_email_field
+    assert_match %r{otpauth://totp/roberto@heapsource\.com\?secret=\w{16}}, @user.provisioning_uri
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,12 @@
+testdir = File.dirname(__FILE__)
+$LOAD_PATH.unshift testdir unless $LOAD_PATH.include?(testdir)
+
+libdir = File.dirname(File.dirname(__FILE__)) + '/lib'
+$LOAD_PATH.unshift libdir unless $LOAD_PATH.include?(libdir)
+
+require "rubygems"
+require "active_model_otp"
+require "minitest/unit"
+require "minitest/autorun"
+
+Dir["models/*.rb"].each {|file| require file }

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: active_model_otp
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Guillermo Iguaran
+- Roberto Miranda
+- Firebase.co
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rotp
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Adds methods to set and authenticate against one time passwords. Inspired
+  in AM::SecurePassword"
+email:
+- guilleiguaran@gmail.com
+- rjmaltamar@gmail.com
+- hello@firebase.co
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- active_model_otp.gemspec
+- lib/active_model/one_time_password.rb
+- lib/active_model/otp/version.rb
+- lib/active_model_otp.rb
+- test/models/user.rb
+- test/one_time_password_test.rb
+- test/test_helper.rb
+homepage: ''
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Adds methods to set and authenticate against one time passwords.
+test_files:
+- test/models/user.rb
+- test/one_time_password_test.rb
+- test/test_helper.rb