rotp 1.1.0 → 1.2.0

data/README.markdown

@@ -1,5 +1,9 @@
 # ROTP - The Ruby One Time Password Library
 
+A ruby library for generating one time passwords according to [ RFC 4226 ](http://tools.ietf.org/html/rfc4226) and the [ HOTP RFC ](http://tools.ietf.org/html/draft-mraihi-totp-timebased-00)
+
+This is compatible with Google Authenticator apps available for Android and iPhone
+
 ## Dependencies
 
 * OpenSSL
@@ -13,17 +17,24 @@
 
 ### Time based OTP's
 
-    totp = ROTP::TOTP.new("base32secret1234")
+    totp = ROTP::TOTP.new("base32secret3232")
     totp.now # => 492039
-    totp.at(Time.now.to_i + 30) # => 102922
+
+    # OTP verified for current time
+    totp.verify(492039) # => true
+    sleep 30
+    totp.verify(492039) # => false
 
 ### Counter based OTP's
 
-    hotp = ROTP::HOTP.new("base32secretkey1234")
-    hotp.at(0) # => 368431
-    hotp.at(1) # => 818794
-    hotp.at(1401) # => 320657
+    hotp = ROTP::HOTP.new("base32secretkey3232")
+    hotp.at(0) # => 260182
+    hotp.at(1) # => 55283
+    hotp.at(1401) # => 316439
 
+    # OTP verified with a counter
+    totp.verify(316439, 1401) # => true
+    totp.verify(316439, 1402) # => false
 
 ### Generating a Base32 Secret key
 
@@ -35,7 +46,8 @@ The library works with the Google Authenticator iPhone and Android app, and also
 includes the ability to generate provisioning URI's for use with the QR Code scanner
 built into the app.
 
-    hotp.provisioning_uri # => 'otpauth://totp/alice@google.com?secret=JBSWY3DPEHPK3PXP'
+    totp.provisioning_uri # => 'otpauth://totp/alice@google.com?secret=JBSWY3DPEHPK3PXP'
+    hotp.provisioning_uri # => 'otpauth://hotp/alice@google.com?secret=JBSWY3DPEHPK3PXP&counter=0'
 
 This can then be rendered as a QR Code which can then be scanned and added to the users
 list of OTP credentials.

data/lib/rotp/hotp.rb

@@ -7,6 +7,13 @@ module ROTP
       generate_otp(count)
     end
 
+    # Verifies the OTP passed in against the current time OTP
+    # @param [String/Integer] otp the OTP to check against
+    # @param [Integer] counter the counter of the OTP
+    def verify(otp, counter)
+      otp == self.at(counter)
+    end
+
     # Returns the provisioning URI for the OTP
     # This can then be encoded in a QR Code and used
     # to provision the Google Authenticator app

data/lib/rotp/totp.rb

@@ -26,6 +26,12 @@ module ROTP
       generate_otp(timecode(Time.now))
     end
 
+    # Verifies the OTP passed in against the current time OTP
+    # @param [String/Integer] otp the OTP to check against
+    def verify(otp, time = Time.now)
+      otp == self.at(time)
+    end
+
     # Returns the provisioning URI for the OTP
     # This can then be encoded in a QR Code and used
     # to provision the Google Authenticator app

data/lib/rotp/version.rb

@@ -1,3 +1,3 @@
 module ROTP
-  VERSION = "1.1.0"
+  VERSION = "1.2.0"
 end

data/spec/base_spec.rb

@@ -26,6 +26,11 @@ describe "HOTP example values from the rfc" do
     hotp.at(8).should ==(399871)
     hotp.at(9).should ==(520489)
   end
+  it "should verify an OTP and now allow reuse" do
+    hotp = ROTP::HOTP.new("GEZDGNBVGY3TQOJQGEZDGNBVGY3TQOJQ")
+    hotp.verify(520489, 9).should be_true
+    hotp.verify(520489, 10).should be_false
+  end
   it "should output its provisioning URI" do
     hotp = ROTP::HOTP.new("wrn3pqx5uqxqvnqr")
     hotp.provisioning_uri('mark@percival').should == "otpauth://hotp/mark@percival?secret=wrn3pqx5uqxqvnqr&counter=0"
@@ -46,6 +51,16 @@ describe "TOTP example values from the rfc" do
       totp.now.should ==(102705)
     end
   end
+  it "should validate a time based OTP" do
+    totp = ROTP::TOTP.new("wrn3pqx5uqxqvnqr")
+    Timecop.freeze(Time.at(1297553958)) do
+      totp.verify(102705).should be_true
+    end
+    Timecop.freeze(Time.at(1297553958 + 30)) do
+      totp.verify(102705).should be_false
+    end
+  end
+
 
   it "should output its provisioning URI" do
     totp = ROTP::TOTP.new("wrn3pqx5uqxqvnqr")

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rotp
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 31
   prerelease: 
   segments: 
   - 1
-  - 1
+  - 2
   - 0
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors: 
 - Mark Percival