multi_factor_auth 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 88c4f71cb48564cb65693d855c357fb3eaa37cd4
+  data.tar.gz: 5a26bdfdb9b91c03587b0d86d2c7e02255da6f59
+SHA512:
+  metadata.gz: b600ca7c937d81d5d3f7788c7b61d152fec31592ef2c15314efc6598d6d2506b7711ce048ef848e68436e3a86822d0854a4507203f784e660d478862eb94cd48
+  data.tar.gz: 16a031077b38d1095ec12d46ebe1e75c7684fbef554f0b8ebdfb304a10d6e0c5b02c38202d3becf37d180742cde918f5ec96e767efa9e68ee653c5bf61327eba

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at dean.wang@tbwa.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,40 @@
+PATH
+  remote: .
+  specs:
+    multi_factor_auth (0.1.0)
+      base32 (~> 0.3.2)
+      rotp (~> 3.1.0)
+      rqrcode (~> 0.10.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    awesome_print (1.7.0)
+    base32 (0.3.2)
+    chunky_png (1.3.6)
+    coderay (1.1.1)
+    method_source (0.8.2)
+    minitest (5.9.0)
+    pry (0.10.4)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rake (10.5.0)
+    rotp (3.1.0)
+    rqrcode (0.10.1)
+      chunky_png (~> 1.0)
+    slop (3.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  awesome_print
+  bundler (~> 1.12)
+  minitest (~> 5.0)
+  multi_factor_auth!
+  pry
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.12.5

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Dean Wang
+
+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,80 @@
+# MultiFactorAuth
+
+A ruby library for generating one time passwords and QR Codes.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'multi_factor_auth'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install multi_factor_auth
+
+## Usage
+
+### Time based OTP's
+
+```ruby
+totp = MultiFactorAuth::TOTP.new("base32secret3232", issuer: "My Service")
+totp.now # => "492039"
+
+# OTP verified for current time
+totp.verify("492039") # => true
+sleep 30
+totp.verify("492039") # => false
+totp.provisioning_uri("alice@google.com")
+```
+
+### Counter based OTP's
+
+```ruby
+hotp = MultiFactorAuth::HOTP.new("base32secretkey3232")
+hotp.at(0) # => "260182"
+hotp.at(1) # => "055283"
+hotp.at(1401) # => "316439"
+
+# OTP verified with a counter
+hotp.verify("316439", 1401) # => true
+hotp.verify("316439", 1402) # => false
+```
+
+### Generating a Base32 Secret key
+
+```ruby
+MultiFactorAuth::Base32.random_base32  # returns a 16 character base32 secret. Compatible with Google Authenticator
+```
+
+### Generating a QR Code
+
+```ruby
+totp = MultiFactorAuth::TOTP.new("base32secretkey3232")
+qrcode = totp.qr_code("alice@google.com")
+image = qrcode.as_png
+svg = qrcode.as_svg
+html = qrcode.as_html
+string = qrcode.as_ansi
+string = qrcode.to_s
+```
+## Resources
+
+* [QR Codes](https://github.com/whomwah/rqrcode)
+* [Base32 Library](https://github.com/stesla/base32)
+* [The Ruby One Time Password Library](https://github.com/mdp/rotp)
+
+## Contributing
+
+* Fork the project
+* Send a pull request
+
+## License
+
+Open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "multi_factor_auth"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/multi_factor_auth.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+require "multi_factor_auth/version"
+require "multi_factor_auth/totp"
+require "multi_factor_auth/hotp"
+
+module MultiFactorAuth
+
+end

data/lib/multi_factor_auth/hotp.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+require 'forwardable'
+require "multi_factor_auth/methods"
+
+module MultiFactorAuth
+
+  class HOTP
+    extend Methods
+    extend Forwardable
+
+    delegate [:at, :verify, :verify_with_retries, :provisioning_uri] => :@instance
+
+    def initialize base32, options = {}
+      @instance = ROTP::HOTP.new base32, options
+    end
+  end
+end

data/lib/multi_factor_auth/methods.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+require 'rotp'
+require 'rqrcode'
+require 'base32'
+require 'securerandom'
+
+module MultiFactorAuth
+
+  module Methods
+
+    def self.extended base
+      base.class_eval do
+        def qr_code email, opts = {}
+          self.singleton_class.generate_qr_code provisioning_uri(email), opts
+        end
+      end
+    end
+
+    def generate_secret str_or_arr = nil
+      case str_or_arr
+      when Array
+        Base32.encode Digest::MD5.hexdigest("#{str_or_arr.join(SecureRandom.uuid)}")
+      when String
+        Base32.encode Digest::MD5.hexdigest(str_or_arr)
+      else
+        random_base32
+      end
+    end
+
+    def random_base32
+      ROTP::Base32.random_base32
+    end
+
+    def generate_qr_code link, opts = {}
+      RQRCode::QRCode.new(link, {level: :h}.merge(opts))
+    end
+
+  end
+end

data/lib/multi_factor_auth/totp.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+require 'forwardable'
+require "multi_factor_auth/methods"
+
+module MultiFactorAuth
+
+  class TOTP
+    extend Methods
+    extend Forwardable
+
+    delegate [:at, :now, :verify ,:verify_with_drift, :provisioning_uri] => :@instance
+
+    def initialize base32, options = {}
+      @instance = ROTP::TOTP.new base32, options
+    end
+  end
+end

data/lib/multi_factor_auth/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module MultiFactorAuth
+  VERSION = "0.1.0"
+end

data/multi_factor_auth.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'multi_factor_auth/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "multi_factor_auth"
+  spec.version       = MultiFactorAuth::VERSION
+  spec.authors       = ["cfanbase"]
+  spec.email         = ["cfanbase@gmail.com"]
+
+  spec.summary       = "Two-factor authentication"
+  spec.description   = "A ruby library for generating one time passwords and QR Codes"
+  spec.homepage      = "https://github.com/cfanbase/multi_factor_auth"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "base32", "~> 0.3.2"
+  spec.add_dependency "rotp", "~> 3.1.0"
+  spec.add_dependency "rqrcode", "~> 0.10.1"
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "awesome_print"
+  spec.add_development_dependency "pry"
+end

metadata

@@ -0,0 +1,170 @@
+--- !ruby/object:Gem::Specification
+name: multi_factor_auth
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- cfanbase
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-07-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: base32
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.2
+- !ruby/object:Gem::Dependency
+  name: rotp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: rqrcode
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A ruby library for generating one time passwords and QR Codes
+email:
+- cfanbase@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/multi_factor_auth.rb
+- lib/multi_factor_auth/hotp.rb
+- lib/multi_factor_auth/methods.rb
+- lib/multi_factor_auth/totp.rb
+- lib/multi_factor_auth/version.rb
+- multi_factor_auth.gemspec
+homepage: https://github.com/cfanbase/multi_factor_auth
+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.1
+signing_key: 
+specification_version: 4
+summary: Two-factor authentication
+test_files: []