twofactor 0.0.2

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MjAzZmNmYmRiZWVkZjI1OTEwMTE3OTAzMzM3ODg2ZDZhNmY4ZTQ4ZA==
+  data.tar.gz: !binary |-
+    OTkyYWI0ZGM0MDU4OWY2OWE1N2Y1MWE4ODVlNjdkYzY3N2Q0ODdhMQ==
+SHA512:
+  metadata.gz: !binary |-
+    Y2UxNjE1YjM0ZTlhZjJhYTg0OGEwOTU2NjJjZWZkOGE1MGVmOTJmNzM5ODhk
+    M2IwNDc1YmU4NmM5MTBiNTc3MmVhYmU2MjE5MTgxNzUxYjA5M2RhODA1Y2Zj
+    NzQwZTQ1NGUxZmE3NmVmMDBlZDllYzcxZTU0NzAwYzgyYjY0NmY=
+  data.tar.gz: !binary |-
+    OGM0ZjU4ZGY2Y2I0MGI3NTYwYTI5ZjZlMTM2ZWZkNTU4MDQxNjFhODVkZTZk
+    NjUyYTg5MDQ4OTEyOWU4N2E3NTIwMmNhNDY3MWRlZTQ2N2ZiNzBjYzdhODc1
+    MzYxM2ExMmQzMGM4MGQ2ZTQ1MGM3ODE1MmVhN2FjNGZlZjJjYjg=

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 YOURNAME
+
+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/Rakefile

@@ -0,0 +1,32 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Twofactor'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/generators/twofactor/install_generator.rb

@@ -0,0 +1,63 @@
+module Twofactor
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.dirname(__FILE__)
+
+    #First arg : Model Name which needs Two-factor auth
+    #Second arg : Reference field that needs to be used(This field will appear in the client's Google Authenticator app. Defaults to 'email')
+    #Third arg : Template type to use for twofactor_register default page (takes one of erb / haml / slim)
+    #Fourth arg : Controller that could be configured with TwoFactor actions( Defaults to Controller with modelname pluralized )
+    #Fifth arg : Table name corresponding to the model. ( Defaults to Rails' choice. )
+    def initialize(*runtime_args)
+      super(*runtime_args)
+      @args = runtime_args
+    end
+
+    class InvalidParameterError < StandardError
+      def initialize(msg = "Provide a valid model name & reference_field field.")
+        super(msg)
+      end
+    end
+    class InvalidTemplateTypeError < StandardError
+      def initialize(msg = "Provide a valid template type. slim (or) haml (or) erb.")
+        super(msg)
+      end
+    end
+    def install_twofactor
+      args = @args.first
+      options = {}
+      options[:model_name] = args.first
+      options[:reference_field] = args.second
+      options[:template_type] = args.third
+      options[:controller] = args.fourth
+      options[:table_name] = args.fifth
+      model = options[:model_name]
+      @reference_field = options[:reference_field]
+
+      if(model.nil? || model.blank? || @reference_field.nil? || @reference_field.blank?)
+        raise InvalidParameterError
+      else
+        @model_name = model.capitalize
+      end
+
+      raise InvalidTemplateTypeError unless ['haml','erb','slim'].include? options[:template_type]
+
+      controller_name = options[:controller].present? ? options[:controller] : "#{@model_name.pluralize}Controller"
+      table_name = options[:table_name].present? ? options[:table_name] : @model_name.tableize
+
+      template 'templates/twofactor_config.rb', 'config/initializers/twofactor_config.rb'
+
+      template 'templates/twofactor_migration.rb', File.join('db', 'migrate', "#{Time.now.strftime('%Y%m%d%H%M%S')}_add_twofactor_fields_to_#{table_name}.rb")
+      template_location = controller_name == 'ApplicationController' ? 'twofactor' : controller_name.gsub('Controller','').tableize
+      copy_file "templates/twofactor_register.html.#{options[:template_type]}", "app/views/#{template_location}/twofactor_register.html.#{options[:template_type]}"
+      twofactor_actions = "\n  public\n"\
+        "    def twofactor_register\n"\
+        "      model_object = (Rails.application.class::TWOFACTOR_MODEL_NAME).constantize.find_by_id(params[:id])\n"\
+        "      qrcode = Twofactor::TwoStep.enable_twofactor_auth(model_object)\n"\
+        "      render :template => \"#{template_location}/twofactor_register\", :locals => {:qrcode => qrcode}\n"\
+        "    end\n\n"
+      inject_into_file "app/controllers/#{controller_name.underscore}.rb", twofactor_actions, :before => /^end/
+      c_name = controller_name.gsub("Controller","").underscore
+      route "get '#{c_name}/twofactor_register/:id' => '#{c_name}#twofactor_register', as: 'twofactor_register'"
+    end
+  end
+end

data/lib/generators/twofactor/templates/twofactor_config.rb

@@ -0,0 +1,20 @@
+#Model to be used for twofacter authentication
+<%= "#{Rails.application.class}::TWOFACTOR_MODEL_NAME = '#{@model_name}'" %>
+
+#Reference Field to be displayed on authenticator mobile app (Defaults to CL argument provided during gem installation)
+<%= "#{Rails.application.class}::TWOFACTOR_REFERENCE_FIELD = '#{@reference_field}'" %>
+
+#Attribute in the model that holds the secret key generated by the gem
+<%= "#{Rails.application.class}::TWOFACTOR_SECRET_ATTRIBUTE = 'twofactor_secret'" %>
+
+#Attribute in the model that holds 2factor enabled/disabled flag
+<%= "#{Rails.application.class}::TWOFACTOR_FLAG_ATTRIBUTE = 'twofactor_enabled'" %>
+
+#QR-Code size
+<%= "#{Rails.application.class}::TWOFACTOR_QRCODE_SIZE = 6" %>
+
+#QR-Code quality
+<%= "#{Rails.application.class}::TWOFACTOR_QRCODE_QUALITY = 'm'" %>
+
+#Override if you'd like to replace Your application's Name with your choice (This will appear in user's authenticator app for his reference)
+<%= "#{Rails.application.class}::TWOFACTOR_PROVIDER_NAME = ''" %>

data/lib/generators/twofactor/templates/twofactor_migration.rb

@@ -0,0 +1,6 @@
+class AddTwofactorFieldsTo<%= @model_name.pluralize %> < ActiveRecord::Migration
+  def change
+    add_column <%= ":#{@model_name.tableize}" %>, :twofactor_enabled, :boolean, :default => false
+    add_column <%= ":#{@model_name.tableize}" %>, :twofactor_secret, :string
+  end
+end 

data/lib/generators/twofactor/templates/twofactor_register.html.erb

@@ -0,0 +1,21 @@
+<style type='text/css'>
+table {
+  border-width: 0;
+  border-style: none;
+  border-color: #0000ff;
+  border-collapse: collapse;
+}
+
+td {
+  border-left: solid 10px #000;
+  padding: 0; 
+  margin: 0; 
+  width: 0px; 
+  height: 10px; 
+}
+
+td.black { border-color: #000; }
+td.white { border-color: #fff; }
+</style>
+<%= raw qrcode.as_html %>
+<%= link_to "Back", :back %>

data/lib/generators/twofactor/templates/twofactor_register.html.haml

@@ -0,0 +1,20 @@
+:css
+  table {
+    border-width: 0;
+    border-style: none;
+    border-color: #0000ff;
+    border-collapse: collapse;
+  }
+  
+  td {
+    border-left: solid 10px #000;
+    padding: 0; 
+    margin: 0; 
+    width: 0px; 
+    height: 10px; 
+  }
+  
+  td.black { border-color: #000; }
+  td.white { border-color: #fff; }
+= raw qrcode.as_html
+= link_to "Back", :back

data/lib/generators/twofactor/templates/twofactor_register.html.slim

@@ -0,0 +1,20 @@
+css:
+  | table {
+    | border-width: 0;
+    | border-style: none;
+    | border-color: #0000ff;
+    | border-collapse: collapse;
+  | }
+  
+  | td {
+    | border-left: solid 10px #000;
+    | padding: 0;
+    | margin: 0;
+    | width: 0px;
+    | height: 10px;
+  | }
+  
+  | td.black { border-color: #000; }
+  | td.white { border-color: #fff; }
+= raw qrcode.as_html
+= link_to "Back", :back

data/lib/tasks/twofactor_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :twofactor do
+#   # Task goes here
+# end

data/lib/twofactor.rb

@@ -0,0 +1,31 @@
+require 'base32'
+require 'totp'
+require 'rqrcode'
+module Twofactor
+  class TwoStep
+    def self.enable_twofactor_auth(model_object)
+      model_object.update_attribute(Rails.application.class::TWOFACTOR_SECRET_ATTRIBUTE, ::Base32.encode(rand(36**6).to_s(36)))
+      model_object.update_attribute(Rails.application.class::TWOFACTOR_FLAG_ATTRIBUTE, true)
+      qrcode = ::RQRCode::QRCode.new("otpauth://totp/#{provider_name}:#{model_object[Rails.application.class::TWOFACTOR_REFERENCE_FIELD]}?secret=#{model_object[Rails.application.class::TWOFACTOR_SECRET_ATTRIBUTE]}&issuer=#{provider_name}", :size => Rails.application.class::TWOFACTOR_QRCODE_SIZE, :level => Rails.application.class::TWOFACTOR_QRCODE_QUALITY.to_sym)
+      return qrcode
+    end
+    def self.disable_twofactor_auth(model_object)
+      model_object.update_attribute(Rails.application.class::TWOFACTOR_SECRET_ATTRIBUTE, nil)
+      model_object.update_attribute(Rails.application.class::TWOFACTOR_FLAG_ATTRIBUTE, false)
+      return true
+    end
+    def self.valid_code?(model_object, code)
+      ::TOTP.valid?(model_object[Rails.application.class::TWOFACTOR_SECRET_ATTRIBUTE], code)
+    end
+
+    private
+
+    def self.provider_name
+      if Rails.application.class::TWOFACTOR_PROVIDER_NAME.blank?
+        return Rails.application.config.session_options[:key].sub(/^_/,'').sub(/_session/,'')
+      else
+        return Rails.application.class::TWOFACTOR_PROVIDER_NAME
+      end
+    end
+  end
+end

data/lib/twofactor/version.rb

@@ -0,0 +1,3 @@
+module Twofactor
+  VERSION = "0.0.2"
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: twofactor
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- venkatramanka
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-09-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: rqrcode
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: totp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A gem to integrate your Rails app with Google 2Factor-authenticator mobile
+  apps
+email:
+- venkatka@outlook.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- Rakefile
+- lib/generators/twofactor/install_generator.rb
+- lib/generators/twofactor/templates/twofactor_config.rb
+- lib/generators/twofactor/templates/twofactor_migration.rb
+- lib/generators/twofactor/templates/twofactor_register.html.erb
+- lib/generators/twofactor/templates/twofactor_register.html.haml
+- lib/generators/twofactor/templates/twofactor_register.html.slim
+- lib/tasks/twofactor_tasks.rake
+- lib/twofactor.rb
+- lib/twofactor/version.rb
+homepage: https://github.com/venkatramanka/twofactor
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: A gem to integrate your Rails app with Google 2Factor-authenticator mobile
+  apps
+test_files: []