otp 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8cbd2209dffb82f3c54afdea2346ad7e0ed260d2
-  data.tar.gz: e7383b28e5878069abc456c608bf14544ab49fd1
+  metadata.gz: 0c73f2c47bcd8a1d4b36391d5b8ffd77fee13670
+  data.tar.gz: 29c50f0d362b6abd5d018c69301f919dfffc748c
 SHA512:
-  metadata.gz: c471ff52aca2b750dd641308eeac8a8891f969506442e60cc1d9bd659bae4a68a067e51c765976215ecfdb68342869d3d102f9b25731ed8b7ab0623cbfd7df25
-  data.tar.gz: 877c4ec9abcc75191a1c5af5a04ff7965db08b43b7ffa7b9959abdf1d5f5f2899e13eeea7894e10d1881dcdc777cc89e43114514309acd3950ed9b0244787fa7
+  metadata.gz: 234d1455ead02f326578c8a2470586eb056c8c91ace926476ff384e53843ef1a58481d015e8dc05442b6830834703cb1b5205344cdca6e9aa7ad7e1df9204b0b
+  data.tar.gz: cd3df6b91c9fb94f138646913aa6a3efdaa8988e0c3a96fb3b0dd58a3a9d32065425c932226cafad893d22fec14565997b2b4a92f76a0d30995498a4597820e5

data/.gitignore

@@ -19,4 +19,5 @@ tmp
 *.so
 *.o
 *.a
+*.swp
 mkmf.log

data/README.md

@@ -4,13 +4,8 @@
 [![Gem Version](https://badge.fury.io/rb/otp.svg)](https://rubygems.org/gems/otp)
 [![License](https://img.shields.io/badge/license-MIT-blue.svg?style=flat)](https://github.com/gotoyuzo/otp/blob/master/LICENSE.txt)
 
-This library provides an implementation of 
-HMAC-Based One-Time Password Algorithm (HOTP; RFC4226) and
+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
 
@@ -43,8 +38,20 @@ To verify given TOTP password:
     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.
+You can use the last and post option parameters to verify several generations, including before and after the current password.
+
+    # verify passwords from last 2 generation to post 1 generation
+    p totp.verify("123456", last: 2, post: 1)
+
+## Related Information
+
+TOTP and HOTP algorithm details can be referred at the following URLs.
+
+* HOTP: An HMAC-Based One-Time Password Algorithm - http://tools.ietf.org/html/rfc4226
+* TOTP: Time-Based One-Time Password Algorithm - http://tools.ietf.org/html/rfc6238
+
+In the OTP URI format, the value of "secret" is encoded with BASE32 algorithm.
+The Format details are described in the document of Google Authenticator.
 
-* BASE32: http://tools.ietf.org/html/rfc4648
-* Google Authenticator Key URI format: https://github.com/google/google-authenticator/wiki/Key-Uri-Format
+* The Base16, Base32, and Base64 Data Encodings - http://tools.ietf.org/html/rfc4648
+* Google Authenticator Key URI format - https://github.com/google/google-authenticator/wiki/Key-Uri-Format

data/lib/otp/base32.rb

@@ -1,11 +1,11 @@
 module OTP
   module Base32
-    BASE32_ENCODE = %w(
+    ENCODE_CHARS = %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 = {
+    DECODE_MAP = {
       ?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, 
@@ -13,23 +13,35 @@ module OTP
       ?==>-1,
     }
 
+    DECODE_LENGTH = {
+      1 => 1,  #  5 bits -> 1 byte (irregular)
+      2 => 1,  # 10 bits -> 1 byte
+      3 => 2,  # 15 bits -> 2 bytes (irregular)
+      4 => 2,  # 20 bits -> 2 bytes
+      5 => 3,  # 25 bits -> 3 bytes
+      6 => 4,  # 30 bits -> 4 bytes (irregular)
+      7 => 4,  # 35 bits -> 4 bytes
+      8 => 5,  # 40 bits -> 5 bytes
+    }
+
     module_function
 
-    def encode(bytes)
+    def encode(bytes, padding: true)
       return nil unless bytes
+      pad = padding ? ?= : ""
       ret = ""
       bytes = bytes.dup.force_encoding("binary")
       off = 0
       while off < bytes.length
         n = 0
         bits = bytes[off, 5]
-        l = bits.length
+        off += 5
+        l = (bits.length * 8.0 / 5.0).ceil
         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])
+        (1..8).each do |i|
+          ret << ((i > l) ? pad : ENCODE_CHARS[(n >> (8-i)*5) & 0x1f])
         end
-        off += 5
       end
       return ret
     end
@@ -43,18 +55,24 @@ module OTP
       while off < chars.length
         n = l = 0
         bits = chars[off, 8]
+        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
+          d = DECODE_MAP[c]
+          if d.nil?
+            raise ArgumentError, "invalid char: #{c}"
+          elsif d < 0
+            n <<= 5 * (8-i)
+            off = chars.length
+            break
+          else
+            n <<= 5
             n |= d
-            l = i * 5 / 8
+            l = ((i+1) * 5.0 / 8.0).floor
+            l = DECODE_LENGTH[i+1]
           end
         end
-        ret << (0..l).map{|i| (n >> 32 - i * 8) & 0xff }.pack("c*")
-        off += 8
+        ret << (1..l).map{|i| (n >> 40 - i * 8) & 0xff }.pack("c*")
       end
       return ret
     end

data/lib/otp/version.rb

@@ -1,4 +1,4 @@
 module OTP
-  VERSION = "0.0.7"
+  VERSION = "0.0.8"
 end
 

data/test/test_base32.rb

@@ -2,8 +2,8 @@ require "test/unit"
 require "otp/base32"
 
 class TestBase32 < Test::Unit::TestCase
-  def assert_encode(encoded, plain)
-    assert_equal(encoded, ::OTP::Base32.encode(plain))
+  def assert_encode(encoded, plain, padding: true)
+    assert_equal(encoded, ::OTP::Base32.encode(plain, padding: padding))
   end
 
   def assert_decode(plain, encoded)
@@ -11,9 +11,9 @@ class TestBase32 < Test::Unit::TestCase
     assert_equal(plain, ::OTP::Base32.decode(encoded))
   end
 
-  def assert_encode_decode(plain, encoded)
+  def assert_encode_decode(plain, encoded, padding: true)
     assert_decode(plain, encoded)
-    assert_encode(encoded, plain)
+    assert_encode(encoded, plain, padding: padding)
   end
 
   def test_base32
@@ -28,6 +28,18 @@ class TestBase32 < Test::Unit::TestCase
     assert_encode_decode("\u{3042}\u{3044}\u{3046}\u{3048}\u{304a}", "4OAYFY4BQTRYDBXDQGEOHAMK")
   end
 
+  def test_base32_without_padding
+    assert_encode_decode(nil, nil, padding: false)
+    assert_encode_decode("", "", padding: false)
+    assert_encode_decode("f", "MY", padding: false)
+    assert_encode_decode("fo", "MZXQ", padding: false)
+    assert_encode_decode("foo", "MZXW6", padding: false)
+    assert_encode_decode("foob", "MZXW6YQ", padding: false)
+    assert_encode_decode("fooba", "MZXW6YTB", padding: false)
+    assert_encode_decode("foobar", "MZXW6YTBOI", padding: false)
+    assert_encode_decode("\u{3042}\u{3044}\u{3046}\u{3048}\u{304a}", "4OAYFY4BQTRYDBXDQGEOHAMK", padding: false)
+  end
+
   def test_truncated_decode
     assert_decode("f", "MY")
     assert_decode("fo", "MZXQ")
@@ -38,4 +50,23 @@ class TestBase32 < Test::Unit::TestCase
     assert_decode("foo", "mzxw6")
     assert_decode("foob", "mzxw6yq")
   end
+
+  def test_unspecified
+    assert_raise(ArgumentError){ OTP::Base32.decode("MY0") }
+    assert_decode("", "=")
+    assert_decode("`", "M=======")
+    assert_decode("fn", "MZX=====")
+    assert_decode("foo`", "MZXW6Y==")
+    assert_decode("`", "M=======G")
+    assert_decode("fn", "MZX=====G")
+    assert_decode("foo`", "MZXW6Y==G")
+    assert_decode("`", "M")
+    assert_decode("fn", "MZX")
+    assert_decode("foo`", "MZXW6Y")
+    assert_decode("fooba", "MZXW6YTB===")
+    assert_decode("f", "MY=AAAAA")
+    assert_decode("fo", "MZXQ=AAA")
+    assert_decode("foo", "MZXW6=AA")
+    assert_decode("foo", "MZXW6=00")
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: otp
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - Yuuzou Gotou
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-05 00:00:00.000000000 Z
+date: 2015-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler