google_authenticator_auth 1.0.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009.
+ 
+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

@@ -0,0 +1,25 @@
+A simple class to work with Google Authenticator from ruby. Can 
+generate a secret key along with qrcode url/image and generate
+one time passwords for a secret key.
+
+See Also: http://code.google.com/p/google-authenticator/
+
+
+Generating the Secret Key
+----------------------------------------------------
+ga = GoogleAuthenticator.new
+ga.secret_key # => "NINWS2QUIQD2LA2Z" 
+ga.qrcode_url('user@domain.com') # => "otpauth://totp/user@domain.com?secret=NINWS2QUIQD2LA2Z"
+ga.qrcode_image_url('user@domain.com') # => "https://chart.googleapis.com/chart?chs=350x350&cht=qr&choe=UTF-8&chl=otpauth://totp/user@domain.com?secret=NINWS2QUIQD2LA2Z"
+
+
+# Verifying a Key
+----------------------------------------------------
+ga = GoogleAuthenticator.new('NINWS2QUIQD2LA2Z')
+ga.key_valid?(key) # => true or false
+
+
+# Generate Your Own Keys
+---------------------------------------------------
+ga = GoogleAuthenticator.new('NINWS2QUIQD2LA2Z')
+ga.get_keys # => [Previous, Current, Next]

data/Rakefile

@@ -0,0 +1,37 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'rake/gempackagetask'
+
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+task :default => :test
+
+desc 'Generate documentation for the google_authenticator_auth plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'google_authenticator_auth'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+find_file = lambda do |name|
+  file_name = lambda {|path| File.join(path, "#{name}.rb")}
+  root = $:.detect do |path|
+    File.exist?(file_name[path])
+  end
+  file_name[root] if root
+end
+
+TEST_LOADER = find_file['rake/rake_test_loader']
+multiruby = lambda do |glob|
+  system 'multiruby', TEST_LOADER, *Dir.glob(glob)
+end
+
+Rake::TestTask.new(:test) do |test|
+  test.ruby_opts << "-W"
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end

data/lib/google_authenticator_auth.rb

@@ -0,0 +1,85 @@
+#!/usr/bin/env ruby
+# A simple class to work with Google Authenticator from ruby
+#
+# can generate a secret key along with qrcode url/image and authenticate
+# keys against a secret key
+#
+# See Also: http://code.google.com/p/google-authenticator/
+#
+require 'rubygems'
+require 'base32'
+require 'openssl'
+require 'uri'
+
+class GoogleAuthenticator
+
+  # Load class with the provided secret key.  If no key is
+  # provided generate a new random secret key
+  def initialize(key=nil)
+    @secret_key = key.nil? ? GoogleAuthenticator.generate_secret_key : key
+  end
+
+  # Generate a unique secret key
+  def self.generate_secret_key
+    Base32.encode( (0...10).map{(rand(255)).chr}.join )
+  end
+
+  # Google Charts image URL (resulting image can be scanned by
+  # the Google Authenticator app to automaticly import secret key
+  def qrcode_image_url(label,wh=350)
+    "https://chart.googleapis.com/chart?chs=#{wh}x#{wh}&cht=qr&choe=UTF-8&chl=" + uri_parser.escape(qrcode_url(label))
+  end
+
+  # QRCode URL used to generate a QRCode that can be scanned into
+  # Google Authenticator (see qrcode_image_url)
+  def qrcode_url(label)
+    "otpauth://totp/#{label}?secret=#{@secret_key}"
+  end
+
+  # Current secret key
+  def secret_key
+    @secret_key
+  end
+
+  # Checks to see if the key is valid for the current secret key
+  def key_valid?(key)
+    get_keys.include?(key.to_i)
+  end
+
+  # Found at https://gist.github.com/987839
+  # Returns an array containing the previous, current, and next
+  # valid key for the current secret key
+  def get_keys
+    keys = []
+    int = 30
+    now = Time.now.to_i / int
+    key = Base32.decode @secret_key
+    sha = OpenSSL::Digest::Digest.new('sha1')
+
+    (-1..1).each do |x|
+      bytes = [ now + x ].pack('>q').reverse
+      hmac = OpenSSL::HMAC.digest(sha, key.to_s, bytes)
+      offset = nil
+      if RUBY_VERSION > '1.9'
+        offset = hmac[-1].ord & 0x0F
+      else
+        offset = hmac[-1] & 0x0F
+      end
+      hash = hmac[offset...offset + 4]
+
+      code = hash.reverse.unpack('L')[0]
+      code &= 0x7FFFFFFF
+      code %= 1000000
+
+      keys << code
+    end
+
+    keys
+  end
+
+  protected
+  def uri_parser
+    @uri_parser ||= URI.const_defined?(:Parser) ? URI::Parser.new : URI
+  end
+
+end

data/test/google_authenticator_auth_test.rb

@@ -0,0 +1,34 @@
+# encoding: utf-8
+require File.expand_path(File.join(File.dirname(__FILE__),'test_helper'))
+
+class GoogleAuthenticatorAuthTest < ActiveSupport::TestCase
+
+  test "should create a random key when started with no paramaters" do
+    ga = GoogleAuthenticator.new
+    assert_not_nil ga.secret_key
+  end
+ 
+  test "should use provided secret key" do
+    ga = GoogleAuthenticator.new('NINWS2QUIQD2LA2Z')
+    assert_equal ga.secret_key, 'NINWS2QUIQD2LA2Z'
+  end
+
+  test "should return three keys" do
+    ga = GoogleAuthenticator.new
+    assert_equal ga.get_keys.length, 3
+  end 
+
+  test "should return a valid qrcode url" do
+    ga = GoogleAuthenticator.new('NINWS2QUIQD2LA2Z')
+    assert_equal ga.qrcode_image_url("user@domain.com"), "https://chart.googleapis.com/chart?chs=350x350&cht=qr&choe=UTF-8&chl=otpauth://totp/user@domain.com?secret=NINWS2QUIQD2LA2Z"
+    assert_equal ga.qrcode_url("user@domain.com"), "otpauth://totp/user@domain.com?secret=NINWS2QUIQD2LA2Z"
+  end
+
+  test "returned keys should be valid" do
+    ga = GoogleAuthenticator.new
+    ga.get_keys.each do |key|
+      assert ga.key_valid?(key)
+    end
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,7 @@
+
+require 'rubygems'
+gem "test-unit", ">= 2.0.5"
+require 'active_support'
+#require 'active_support/test_case'
+require 'test/unit'
+require File.join(File.dirname(__FILE__),'../lib/google_authenticator_auth.rb')

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification 
+name: google_authenticator_auth
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- David Ricciardi
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-07-01 00:00:00 +00:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: builder
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: test-unit
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+description: google authenticator auth
+email: nricciar@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+- MIT-LICENSE
+files: 
+- lib/google_authenticator_auth.rb
+- Rakefile
+- README
+- MIT-LICENSE
+- test/google_authenticator_auth_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/nricciar/google_authenticator_auth
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A simple class to work with Google Authenticator from ruby
+test_files: 
+- test/google_authenticator_auth_test.rb
+- test/test_helper.rb