otp 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9c347957dce5fa1a828f04c97e6c4ad600a06e8a
+  data.tar.gz: 3bd57768dd62dbcf301115d62ff7957ff6a06395
+SHA512:
+  metadata.gz: ff936f0e8dd58332943d6871f8df6f7eaa7f270253dbecd8ec3bf652d57dbabd23b5d162bdcee77e7ac88f6d58afcff58a99efade8b21f0e68808f89f7c29c36
+  data.tar.gz: e1270fd1fdfcf1c68164159758c2eac6325ec5144c3974f315e59cfc38cc876f4664654cb352e5ca105f78d69ee27cfd05a2a1eaf8968c977e589af1178711e2

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Yuuzou Gotou
+
+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,38 @@
+# One-Time Password Library
+
+This library provides an implementation of 
+HMAC-Based One-Time Password Algorithm (HOTP; RFC4226) and
+Time-Based One-Time Password Algorithm (HOTP; RFC6238).
+The Algorithm details can be referred at the following URLs.
+
+* HOTP: http://tools.ietf.org/html/rfc4226
+* TOTP: http://tools.ietf.org/html/rfc6238
+
+## Usage
+
+To create new TOTP secret:
+
+    require "otp"
+
+    totp = OTP::TOTP.new
+    totp.new_secret  # create random secret
+    p totp.secret    #=> "YVMR2G7N4OAXGKFC" (BASE32-formated HMAC key)
+    p totp.algorithm #=> "SHA1" (HMAC algorithm; default SHA1)
+    p totp.digits    #=> 6 (number of password digits; default 6)
+    p totp.period    #=> 30 (time step period in second; default 30)
+    p totp.time      #=> nil (UNIX time by Time or Integer; nil for the current time)
+    p totp.password  #=> "123456" (password for the current time)
+
+To verify given TOTP password:
+
+    require "otp"
+
+    totp = OTP::TOTP.new
+    totp.secret = "YVMR2G7N4OAXGKFC"
+    p totp.verify("123456")  #=> true/false (verify given passowrd)
+
+The value of "secret" is encoded with BASE32 algorithm to be compatible
+with Google Authenticator URI format.
+
+* BASE32: http://tools.ietf.org/html/rfc4648
+* Google Authenticator Key URI format: https://github.com/google/google-authenticator/wiki/Key-Uri-Format

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |test|
+  test.pattern = "test/**/test_*.rb"
+  test.verbose = true
+end
+
+task :default => :test

data/lib/otp.rb

@@ -0,0 +1,3 @@
+require "otp/version"
+require "otp/totp"
+require "otp/hotp"

data/lib/otp/base.rb

@@ -0,0 +1,44 @@
+require "otp/utils"
+require "otp/base32"
+
+module OTP
+  class Base
+    include OTP::Utils
+
+    attr_accessor :secret
+    attr_accessor :algorithm
+    attr_accessor :digits
+
+    def initialize(secret=nil, algorithm="SHA1", digits=6)
+      self.secret = secret
+      self.algorithm = algorithm
+      self.digits = digits
+    end
+
+    def new_secret(num_bytes=10)
+      s = (0...num_bytes).map{ Random.rand(256).chr }.join
+      self.secret = OTP::Base32.encode(s)
+    end
+
+    def moving_factor
+      raise NotImplementedError
+    end
+
+    def otp
+      hash = hmac(algorithm, OTP::Base32.decode(secret),
+                  pack_int64(moving_factor))
+      return truncate(hash)
+    end
+
+    def password
+      pw = (otp % (10 ** digits)).to_s
+      pw = "0" + pw while pw.length < digits
+      return pw
+    end
+
+    def verify(otp)
+      return false if otp.nil? || otp.empty?
+      return compare(password, otp)
+    end
+  end
+end

data/lib/otp/base32.rb

@@ -0,0 +1,62 @@
+module OTP
+  module Base32
+    BASE32_ENCODE = %w(
+      A B C D E F G H I J K L M N O P
+      Q R S T U V W X Y Z 2 3 4 5 6 7
+    )
+
+    BASE32_DECODE = {
+      ?A=>0,  ?B=>1,  ?C=>2,  ?D=>3,  ?E=>4,  ?F=>5,  ?G=>6,  ?H=>7, 
+      ?I=>8,  ?J=>9,  ?K=>10, ?L=>11, ?M=>12, ?N=>13, ?O=>14, ?P=>15,
+      ?Q=>16, ?R=>17, ?S=>18, ?T=>19, ?U=>20, ?V=>21, ?W=>22, ?X=>23, 
+      ?Y=>24, ?Z=>25, ?2=>26, ?3=>27, ?4=>28, ?5=>29, ?6=>30, ?7=>31, 
+      ?==>-1,
+    }
+
+    module_function
+
+    def encode(bytes)
+      return nil unless bytes
+      ret = ""
+      bytes = bytes.dup.force_encoding("binary")
+      off = 0
+      while off < bytes.length
+        n = 0
+        bits = bytes[off, 5]
+        l = bits.length
+        bits << "\0" while bits.length < 5
+        bits.each_byte{|b| n = (n << 8) | b }
+        8.times do |i|
+          ret << ((l*8/5 < i) ? ?= : BASE32_ENCODE[(n >> (7-i)*5) & 0x1f])
+        end
+        off += 5
+      end
+      return ret
+    end
+
+    def decode(chars)
+      return nil unless chars
+      ret = ""
+      chars = chars.upcase
+      ret.force_encoding("binary")
+      off = 0
+      while off < chars.length
+        n = l = 0
+        bits = chars[off, 8]
+        bits << "=" while bits.length < 8
+        bits.each_char.with_index do |c, i|
+          d = BASE32_DECODE[c]
+          raise ArgumentError, "invalid char: #{c}" unless d
+          n <<= 5
+          if d >= 0
+            n |= d
+            l = i * 5 / 8
+          end
+        end
+        ret << (0..l).map{|i| (n >> 32 - i * 8) & 0xff }.pack("c*")
+        off += 8
+      end
+      return ret
+    end
+  end
+end

data/lib/otp/hotp.rb

@@ -0,0 +1,16 @@
+require "otp/base"
+
+module OTP
+  class HOTP < OTP::Base
+    attr_accessor :count
+
+    def initialize(*args)
+      super
+      self.count = 0
+    end
+
+    def moving_factor
+      return count
+    end
+  end
+end

data/lib/otp/totp.rb

@@ -0,0 +1,17 @@
+require "otp/base"
+
+module OTP
+  class TOTP < OTP::Base
+    attr_accessor :period, :time
+
+    def initialize(*args)
+      super
+      self.period = 30
+      self.time = nil
+    end
+
+    def moving_factor
+      return (time || Time.now).to_i / period
+    end
+  end
+end

data/lib/otp/utils.rb

@@ -0,0 +1,27 @@
+require "openssl"
+
+module OTP
+  module Utils
+    private
+
+    def pack_int64(i)
+      return [i >> 32 & 0xffffffff, i & 0xffffffff].pack("NN")
+    end
+
+    def hmac(algorithm, secret, text)
+      mac = OpenSSL::HMAC.new(secret, algorithm)
+      mac << text
+      return mac.digest
+    end
+
+    def truncate(hash)
+      offset = hash[-1].ord & 0xf
+      binary = hash[offset, 4]
+      return binary.unpack("N")[0] & 0x7fffffff
+    end
+
+    def compare(a, b)
+      return a.to_i == b.to_i
+    end
+  end
+end

data/lib/otp/version.rb

@@ -0,0 +1,4 @@
+module OTP
+  VERSION = "0.0.2"
+end
+

data/otp.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'otp/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "otp"
+  spec.version       = OTP::VERSION
+  spec.authors       = ["Yuuzou Gotou"]
+  spec.email         = ["gotoyuzo@notwork.org"]
+  spec.summary       = %q{One-Time Password Library}
+  spec.description   = %q{An implementation of HOTP (RFC4226) and TOTP (RFC6238).}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+end

data/test/test_base32.rb

@@ -0,0 +1,30 @@
+require "test/unit"
+require "otp/base32"
+
+class TestBase32 < Test::Unit::TestCase
+  def assert_encode(plain, encoded)
+    assert_equal(::OTP::Base32.encode(plain), encoded)
+  end
+
+  def assert_decode(encoded, plain)
+    plain &&= plain.dup.force_encoding("binary")
+    assert_equal(::OTP::Base32.decode(encoded), plain)
+  end
+
+  def assert_encode_decode(plain, encoded)
+    assert_encode(plain, encoded)
+    assert_decode(encoded, plain)
+  end
+
+  def test_base32
+    assert_encode_decode(nil, nil)
+    assert_encode_decode("", "")
+    assert_encode_decode("f", "MY======")
+    assert_encode_decode("fo", "MZXQ====")
+    assert_encode_decode("foo", "MZXW6===")
+    assert_encode_decode("foob", "MZXW6YQ=")
+    assert_encode_decode("fooba", "MZXW6YTB")
+    assert_encode_decode("foobar", "MZXW6YTBOI======")
+    assert_encode_decode("\u{3042}\u{3044}\u{3046}\u{3048}\u{304a}", "4OAYFY4BQTRYDBXDQGEOHAMK")
+  end
+end

data/test/test_hotp.rb

@@ -0,0 +1,26 @@
+require "test/unit"
+require "otp"
+
+class TestHTOP < Test::Unit::TestCase
+  def assert_hotp(hotp, count, pass)
+    hotp.count = count
+    assert_equal(hotp.password, pass)
+    assert(hotp.verify(pass))
+    assert(!hotp.verify(pass.chop))
+  end
+
+  def test_hotp
+    seed = "12345678901234567890"
+    hotp = OTP::HOTP.new(OTP::Base32.encode(seed), "SHA1", 6)
+    assert_hotp(hotp, 0, "755224")
+    assert_hotp(hotp, 1, "287082")
+    assert_hotp(hotp, 2, "359152")
+    assert_hotp(hotp, 3, "969429")
+    assert_hotp(hotp, 4, "338314")
+    assert_hotp(hotp, 5, "254676")
+    assert_hotp(hotp, 6, "287922")
+    assert_hotp(hotp, 7, "162583")
+    assert_hotp(hotp, 8, "399871")
+    assert_hotp(hotp, 9, "520489")
+  end
+end

data/test/test_totp.rb

@@ -0,0 +1,44 @@
+require "test/unit"
+require "otp"
+
+class TestTOTP < Test::Unit::TestCase
+  def assert_totp(totp, time, pass)
+    totp.time = time
+    assert_equal(totp.password, pass)
+    assert(totp.verify(pass))
+    assert(!totp.verify(pass.chop))
+  end
+
+  def test_totp_sha1
+    seed = "12345678901234567890"
+    totp = OTP::TOTP.new(OTP::Base32.encode(seed), "SHA1", 8)
+    assert_totp(totp, 59,          "94287082")
+    assert_totp(totp, 1111111109,  "07081804")
+    assert_totp(totp, 1111111111,  "14050471")
+    assert_totp(totp, 1234567890,  "89005924")
+    assert_totp(totp, 2000000000,  "69279037")
+    assert_totp(totp, 20000000000, "65353130")
+  end
+
+  def test_totp_sha256
+    seed = "12345678901234567890123456789012"
+    totp = OTP::TOTP.new(OTP::Base32.encode(seed), "SHA256", 8)
+    assert_totp(totp, 59,          "46119246")
+    assert_totp(totp, 1111111109,  "68084774")
+    assert_totp(totp, 1111111111,  "67062674")
+    assert_totp(totp, 1234567890,  "91819424")
+    assert_totp(totp, 2000000000,  "90698825")
+    assert_totp(totp, 20000000000, "77737706")
+  end
+
+  def test_totp_sha512
+    seed = "1234567890123456789012345678901234567890123456789012345678901234"
+    totp = OTP::TOTP.new(OTP::Base32.encode(seed), "SHA512", 8)
+    assert_totp(totp, 59,          "90693936")
+    assert_totp(totp, 1111111109,  "25091201")
+    assert_totp(totp, 1111111111,  "99943326")
+    assert_totp(totp, 1234567890,  "93441116")
+    assert_totp(totp, 2000000000,  "38618901")
+    assert_totp(totp, 20000000000, "47863826")
+  end
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: otp
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Yuuzou Gotou
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: An implementation of HOTP (RFC4226) and TOTP (RFC6238).
+email:
+- gotoyuzo@notwork.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/otp.rb
+- lib/otp/base.rb
+- lib/otp/base32.rb
+- lib/otp/hotp.rb
+- lib/otp/totp.rb
+- lib/otp/utils.rb
+- lib/otp/version.rb
+- otp.gemspec
+- test/test_base32.rb
+- test/test_hotp.rb
+- test/test_totp.rb
+homepage: ''
+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.2.2
+signing_key: 
+specification_version: 4
+summary: One-Time Password Library
+test_files:
+- test/test_base32.rb
+- test/test_hotp.rb
+- test/test_totp.rb