google-authenticator-rails 0.0.1

data/.gitignore

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

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Jared McFarland
+
+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,102 @@
+# Google::Authenticator
+
+Rails (ActiveRecord) integration with the Google Authenticator apps for Android and the iPhone.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'google-authenticator-rails'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install google-authenticator-rails
+
+## Usage
+
+Example:
+
+```ruby
+class User
+acts_as_google_authenticated
+end
+
+@user = User.new
+@user.set_google_secret!          # => true
+@user.google_qr_uri               # => http://path.to.google/qr?with=params
+@user.google_authenticate(123456) # => true
+```
+
+Google Labels
+When setting up an account with the GoogleAuthenticator you need to provide
+a label for that account (to distinguish it from other accounts).
+
+GoogleAuthenticatorRails allows you to customize how the record will create
+that label.  There are three options:
+  - The default just uses the column "email" on the model
+  - You can specify a custom column with the :column_name option
+  - You can specify a custom method via a symbol or a proc
+
+Examples:
+
+```ruby
+class User
+	acts_as_google_authenticated :column => :user_name
+end
+
+@user = User.new(:user_name => "ted")
+@user.google_label                      # => "ted"
+
+class User
+	acts_as_google_authenticated :method => :user_name_with_label
+
+	def user_name_with_label
+	  "#{user_name}@mysweetservice.com"
+	end
+end
+
+@user = User.new(:user_name => "ted")
+@user.google_label                    # => "ted@mysweetservice.com"
+
+class User
+	acts_as_google_authenticated :method => Proc.new { |user| user.user_name_with_label.upcase }
+
+	def user_name_with_label
+	  "#{user_name}@mysweetservice.com"
+	end
+end
+
+@user = User.new(:user_name => "ted")
+@user.google_label                    # => "TED@MYSWEETSERVICE.COM"
+```
+
+You can also sepcify a column for storing the google secret.  The default is `google_secret`.
+
+Example
+
+```ruby
+class User
+	acts_as_google_authenticated :google_secret_column => :mfa_secret
+end
+
+@user = User.new
+@user.set_google_secret!
+@user.mfa_secret 		 # => "56ahi483"
+```
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## License
+
+MIT.

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/google-authenticator.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/google-authenticator-rails/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Jared McFarland"]
+  gem.email         = ["jared.online@gmail.com"]
+  gem.description   = %q{Add the ability to use the Google Authenticator with ActiveRecord.}
+  gem.summary       = %q{Add the ability to use the Google Authenticator with ActiveRecord.}
+  gem.homepage      = "http://github.com/jaredonline/google-authenticator-rails"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "google-authenticator-rails"
+  gem.require_paths = ["lib"]
+  gem.version       = Google::Authenticator::Rails::VERSION
+  
+  gem.add_dependency "activesupport", "~> 3.2.0"
+  gem.add_dependency "rotp"
+  gem.add_dependency "activerecord", "~> 3.2.0"
+  gem.add_dependency "google-qr"
+  
+  gem.add_development_dependency "rspec", "~> 2.8.0"
+  gem.add_development_dependency "sqlite3"
+end

data/lib/google-authenticator-rails.rb

@@ -0,0 +1,13 @@
+# Stuff the gem requireds
+# 
+require 'active_support'
+require 'active_record'
+require 'openssl'
+require 'rotp'
+require 'google-qr'
+
+# Stuff the gem is
+# 
+require "google-authenticator-rails/version"
+require 'google-authenticator-rails/google'
+require 'google-authenticator-rails/active_record'

data/lib/google-authenticator-rails/active_record.rb

@@ -0,0 +1,66 @@
+require 'google-authenticator-rails/active_record/google_authentication'
+require 'google-authenticator-rails/active_record/acts_as_google_authenticated'
+
+class ActiveRecord::Base # :nodoc:
+  
+  # This is the single integration point.  Monkey patch ActiveRecord::Base
+  # to include the ActsAsGoogleAuthenticated module, which allows a user 
+  # to call User.acts_as_google_authenticated.
+  # 
+  # The model being used must have a string column named "google_secret", or an explicitly
+  # named column.
+  # 
+  # Example:
+  # 
+  #   class User
+  #     acts_as_google_authenticated
+  #   end
+  # 
+  #   @user = user.new
+  #   @user.set_google_secret!          # => true
+  #   @user.google_qr_uri               # => http://path.to.google/qr?with=params
+  #   @user.google_authenticate(123456) # => true
+  # 
+  # Google Labels
+  # When setting up an account with the GoogleAuthenticator you need to provide
+  # a label for that account (to distinguish it from other accounts).
+  # 
+  # GoogleAuthenticatorRails allows you to customize how the record will create
+  # that label.  There are three options:
+  #   - The default just uses the column "email" on the model
+  #   - You can specify a custom column with the :column_name option
+  #   - You can specify a custom method via a symbol or a proc
+  # 
+  # Examples:
+  # 
+  #   class User
+  #     acts_as_google_authenticated :column => :user_name
+  #   end
+  # 
+  #   @user = User.new(:user_name => "ted")
+  #   @user.google_label                      # => "ted"
+  # 
+  #   class User
+  #     acts_as_google_authenticated :method => :user_name_with_label
+  # 
+  #     def user_name_with_label
+  #       "#{user_name}@mysweetservice.com"
+  #     end
+  #   end
+  # 
+  #   @user = User.new(:user_name => "ted")
+  #   @user.google_label                    # => "ted@mysweetservice.com"
+  # 
+  #   class User
+  #     acts_as_google_authenticated :method => Proc.new { |user| user.user_name_with_label.upcase }
+  #     
+  #     def user_name_with_label
+  #       "#{user_name}@mysweetservice.com"
+  #     end
+  #   end
+  #   
+  #   @user = User.new(:user_name => "ted")
+  #   @user.google_label                    # => "TED@MYSWEETSERVICE.COM"
+  # 
+  include ActiveRecord::ActsAsGoogleAuthenticated
+end

data/lib/google-authenticator-rails/active_record/acts_as_google_authenticated.rb

@@ -0,0 +1,35 @@
+module ActiveRecord # :nodoc:
+  module ActsAsGoogleAuthenticated # :nodoc:
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods # :nodoc
+
+      # Initializes the class attributes with the specified options and includes the 
+      # GoogleAuthentication module
+      # 
+      # Options:
+      #   [:column_name] the name of the column used to create the google_label
+      #   [:method] name of the method to call to created the google_label
+      #             it supercedes :column_name
+      #   [:google_secret_column] the column the secret will be stored in, defaults
+      #                           to "google_secret"
+      def acts_as_google_authenticated(options = {})
+        @google_label_column  = options[:column_name]           || :email
+        @google_label_method  = options[:method]                || :default_google_label_method
+        @google_secret_column = options[:google_secret_column]  || :google_secret
+        
+        attr_accessible @google_secret_column
+
+        [:google_label_column, :google_label_method, :google_secret_column].each do |cattr|
+          self.class.__send__(:define_method, cattr) do
+            instance_variable_get("@#{cattr}")
+          end
+        end
+
+        include ActiveRecord::GoogleAuthentication
+      end
+    end
+  end
+end

data/lib/google-authenticator-rails/active_record/google_authentication.rb

@@ -0,0 +1,34 @@
+module ActiveRecord # :nodoc:
+  module GoogleAuthentication # :nodoc:
+    def set_google_secret!
+      update_attributes("#{self.class.google_secret_column}" => Google::Authenticator::Rails::generate_secret)
+    end
+
+    def google_authenticate(code)
+      Google::Authenticator::Rails.valid?(code, google_secret_value)
+    end
+
+    def google_qr_uri
+      GoogleQR.new(data: ROTP::TOTP.new(google_secret_value).provisioning_uri(google_label), size: "200x200").to_s
+    end
+
+    def google_label
+      method = self.class.google_label_method
+      case method
+        when Proc
+          method.call(self)
+        when Symbol, String
+          self.__send__(method)
+      end
+    end
+
+    private
+    def default_google_label_method
+      self.__send__(self.class.google_label_column)
+    end
+
+    def google_secret_value
+      self.__send__(self.class.google_secret_column)
+    end
+  end
+end

data/lib/google-authenticator-rails/google.rb

@@ -0,0 +1 @@
+require 'google-authenticator-rails/google/rails'

data/lib/google-authenticator-rails/google/rails.rb

@@ -0,0 +1 @@
+require 'google-authenticator-rails/google/rails/rotp_integration'

data/lib/google-authenticator-rails/google/rails/rotp_integration.rb

@@ -0,0 +1,26 @@
+# Sets up some basic accessors for use with the ROTP module
+# 
+module Google
+  module Authenticator # :nodoc:
+    module Rails # :nodoc:
+      # Drift is set to 6 because ROTP drift is not inclusive.  This allows a drift of 5 seconds.
+      DRIFT = 6
+       
+      def self.generate_password(secret, iteration)
+        ROTP::HOTP.new(secret).at(iteration)
+      end
+    
+      def self.time_based_password(secret)
+        ROTP::TOTP.new(secret).now
+      end
+    
+      def self.valid?(code, secret)
+        ROTP::TOTP.new(secret).verify_with_drift(code, DRIFT)
+      end
+      
+      def self.generate_secret
+        ROTP::Base32.random_base32
+      end
+    end
+  end
+end

data/lib/google-authenticator-rails/version.rb

@@ -0,0 +1,7 @@
+module Google
+  module Authenticator
+    module Rails
+      VERSION = "0.0.1"
+    end
+  end
+end

data/spec/google_authenticator_spec.rb

@@ -0,0 +1,122 @@
+require 'spec_helper'
+
+class User < ActiveRecord::Base
+  attr_accessible :email, :user_name
+  
+  acts_as_google_authenticated
+end
+
+class CustomUser < ActiveRecord::Base
+  attr_accessible :email, :user_name
+
+  acts_as_google_authenticated :google_secret_column => :mfa_secret
+end
+
+describe Google::Authenticator::Rails do
+  before do
+    ROTP::Base32.stub!(:random_base32).and_return("5qlcip7azyjuwm36")
+  end
+  
+  it 'implements counter based passwords' do
+    Google::Authenticator::Rails::generate_password("test", 1).should == 812658
+    Google::Authenticator::Rails::generate_password("test", 2).should == 73348
+  end
+  
+  it 'implements time based password' do
+    time = Time.parse("2012-08-07 11:11:11 AM +0700")
+    Time.stub!(:now).and_return(time)
+    Google::Authenticator::Rails::time_based_password("test").should == 472374
+  end
+  
+  it 'can validate a code' do
+    time = Time.parse("2012-08-07 11:11:11 AM +0700")
+    Time.stub!(:now).and_return(time)
+    Google::Authenticator::Rails::valid?(472374, "test").should be_true
+  end
+  
+  it 'can create a secret' do
+    Google::Authenticator::Rails::generate_secret.should == "5qlcip7azyjuwm36"
+  end
+  
+  context 'integration with ActiveRecord'  do
+    
+    before do
+      time = Time.parse("2012-08-07 11:11:00 AM +0700")
+      Time.stub!(:now).and_return(time)
+      @user = User.create(email: "test@test.com", user_name: "test_user")
+      @user.google_secret = "test"
+    end
+    
+    it 'validates codes' do
+      @user.google_authenticate(472374).should be_true
+    end
+    
+    it 'validates with 5 seconds of drift' do
+      time = Time.parse("2012-08-07 11:11:34 AM +0700")
+      Time.stub!(:now).and_return(time)
+      @user.google_authenticate(472374).should be_true
+    end
+    
+    it 'does not validate with 6 seconds of drift' do
+      time = Time.parse("2012-08-07 11:11:36 AM +0700")
+      Time.stub!(:now).and_return(time)
+      @user.google_authenticate(472374).should be_false
+    end
+    
+    it 'creates a secret' do
+      @user.set_google_secret!
+      @user.google_secret.should == "5qlcip7azyjuwm36"
+    end
+    
+    context 'secret column' do
+      before do
+        Google::Authenticator::Rails.stub!(:generate_secret).and_return("test")
+        @user = CustomUser.create(email: "test@test.com", user_name: "test_user")
+        @user.set_google_secret!
+      end
+
+      it 'validates code' do
+        @user.google_authenticate(472374).should be_true
+      end
+
+      it 'generates a url for a qr code' do
+        @user.google_qr_uri.should == "https://chart.googleapis.com/chart?cht=qr&chl=otpauth%3A%2F%2Ftotp%2Ftest%40test.com%3Fsecret%3Dtest&chs=200x200"
+      end
+    end
+
+    context 'qr codes' do
+      
+      it 'generates a url for a qr code' do
+        @user.set_google_secret!
+        @user.google_qr_uri.should == "https://chart.googleapis.com/chart?cht=qr&chl=otpauth%3A%2F%2Ftotp%2Ftest%40test.com%3Fsecret%3D5qlcip7azyjuwm36&chs=200x200"
+      end
+      
+      it 'can generate off any column' do
+        @user.class.acts_as_google_authenticated :column_name => :user_name
+        @user.set_google_secret!
+        @user.google_qr_uri.should == "https://chart.googleapis.com/chart?cht=qr&chl=otpauth%3A%2F%2Ftotp%2Ftest_user%3Fsecret%3D5qlcip7azyjuwm36&chs=200x200"
+      end
+      
+      it 'can generate with a custom proc' do
+        @user.class.acts_as_google_authenticated :method => Proc.new { |user| "#{user.user_name}@futureadvisor-admin" }
+        @user.set_google_secret!
+        @user.google_qr_uri.should == "https://chart.googleapis.com/chart?cht=qr&chl=otpauth%3A%2F%2Ftotp%2Ftest_user%40futureadvisor-admin%3Fsecret%3D5qlcip7azyjuwm36&chs=200x200"
+      end
+      
+      it 'can generate with a method symbol' do
+        @user.class.acts_as_google_authenticated :method => :email
+        @user.set_google_secret!
+        @user.google_qr_uri.should == "https://chart.googleapis.com/chart?cht=qr&chl=otpauth%3A%2F%2Ftotp%2Ftest%40test.com%3Fsecret%3D5qlcip7azyjuwm36&chs=200x200"
+      end
+      
+      it 'can generate with a method string' do
+        @user.class.acts_as_google_authenticated :method => "email"
+        @user.set_google_secret!
+        @user.google_qr_uri.should == "https://chart.googleapis.com/chart?cht=qr&chl=otpauth%3A%2F%2Ftotp%2Ftest%40test.com%3Fsecret%3D5qlcip7azyjuwm36&chs=200x200"
+      end
+      
+    end
+    
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,27 @@
+require 'google-authenticator-rails'
+require 'time'
+require 'active_record'
+require 'rotp'
+
+ActiveRecord::Base.establish_connection(
+  :adapter => 'sqlite3',
+  :database => ':memory:'
+)
+
+ActiveRecord::Schema.define do
+  self.verbose = false
+
+  create_table :users, :force => true do |t|
+    t.string :google_secret
+    t.string :email
+    t.string :user_name
+    t.timestamps
+  end
+
+  create_table :custom_users, :force => true do |t|
+    t.string :mfa_secret
+    t.string :email
+    t.string :user_name
+    t.timestamps
+  end
+end

metadata

@@ -0,0 +1,160 @@
+--- !ruby/object:Gem::Specification
+name: google-authenticator-rails
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Jared McFarland
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.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: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: google-qr
+  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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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: Add the ability to use the Google Authenticator with ActiveRecord.
+email:
+- jared.online@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- google-authenticator.gemspec
+- lib/google-authenticator-rails.rb
+- lib/google-authenticator-rails/active_record.rb
+- lib/google-authenticator-rails/active_record/acts_as_google_authenticated.rb
+- lib/google-authenticator-rails/active_record/google_authentication.rb
+- lib/google-authenticator-rails/google.rb
+- lib/google-authenticator-rails/google/rails.rb
+- lib/google-authenticator-rails/google/rails/rotp_integration.rb
+- lib/google-authenticator-rails/version.rb
+- spec/google_authenticator_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/jaredonline/google-authenticator-rails
+licenses: []
+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.24
+signing_key: 
+specification_version: 3
+summary: Add the ability to use the Google Authenticator with ActiveRecord.
+test_files:
+- spec/google_authenticator_spec.rb
+- spec/spec_helper.rb