otp 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9c347957dce5fa1a828f04c97e6c4ad600a06e8a
-  data.tar.gz: 3bd57768dd62dbcf301115d62ff7957ff6a06395
+  metadata.gz: 2c5be10fdb528da5e72ee28f45a98265c7fad8e4
+  data.tar.gz: 237c2004139b3314964b3a93bb4b2ed7eacb22d6
 SHA512:
-  metadata.gz: ff936f0e8dd58332943d6871f8df6f7eaa7f270253dbecd8ec3bf652d57dbabd23b5d162bdcee77e7ac88f6d58afcff58a99efade8b21f0e68808f89f7c29c36
-  data.tar.gz: e1270fd1fdfcf1c68164159758c2eac6325ec5144c3974f315e59cfc38cc876f4664654cb352e5ca105f78d69ee27cfd05a2a1eaf8968c977e589af1178711e2
+  metadata.gz: 30734912941bd921dccc0f0cb98a2e45c2d83e251b2bd359647d2685a5655d389fca40f3514d21731fc6665e03ce8102224d513e714772e1610393c16b6f944c
+  data.tar.gz: d0a3a72ba084e92dc638c07bc76d14d663754c9725d175b1994e4c134c9ac86c28a1f7a20812a634a952c71d2443ee9cfdbc7b0a4116f5392b22ac668f85b260

data/README.md

@@ -23,6 +23,11 @@ To create new TOTP secret:
     p totp.time      #=> nil (UNIX time by Time or Integer; nil for the current time)
     p totp.password  #=> "123456" (password for the current time)
 
+    # Format TOTP URI. Otpauth scheme URLs can be read by OTP::URI.parse.
+    totp.issuer = "My Company"
+    totp.accountname = "account@exaple.com"
+    p totp.to_uri    #=> "otpauth://totp/My%20Company:account@exaple.com?secret=47JBA7ZWDDLNZJMX&issuer=My+Company"
+
 To verify given TOTP password:
 
     require "otp"

data/lib/otp/base.rb

@@ -1,18 +1,23 @@
 require "otp/utils"
 require "otp/base32"
+require "otp/uri"
 
 module OTP
   class Base
     include OTP::Utils
 
+    DEFAULT_DIGITS = 6
+    DEFAULT_ALGORITHM = "SHA1"
+
     attr_accessor :secret
     attr_accessor :algorithm
     attr_accessor :digits
+    attr_accessor :issuer, :accountname
 
-    def initialize(secret=nil, algorithm="SHA1", digits=6)
+    def initialize(secret=nil, algorithm=nil, digits=nil)
       self.secret = secret
-      self.algorithm = algorithm
-      self.digits = digits
+      self.algorithm = algorithm || DEFAULT_ALGORITHM
+      self.digits = digits || DEFAULT_DIGITS
     end
 
     def new_secret(num_bytes=10)
@@ -40,5 +45,19 @@ module OTP
       return false if otp.nil? || otp.empty?
       return compare(password, otp)
     end
+
+    ## URI related methods
+
+    def to_uri
+      OTP::URI.format(self)
+    end
+
+    def type_specific_uri_params
+      raise NotImplementedError
+    end
+
+    def extract_type_specific_uri_param
+      raise NotImplementedError
+    end
   end
 end

data/lib/otp/hotp.rb

@@ -12,5 +12,15 @@ module OTP
     def moving_factor
       return count
     end
+
+    def type_specific_uri_params
+      return {count: count}
+    end
+
+    def extract_type_specific_uri_params(query)
+      if value = query["count"]
+        self.count = value.to_i
+      end
+    end
   end
 end

data/lib/otp/totp.rb

@@ -4,14 +4,28 @@ module OTP
   class TOTP < OTP::Base
     attr_accessor :period, :time
 
+    DEFAULT_PERIOD = 30
+
     def initialize(*args)
       super
-      self.period = 30
+      self.period = DEFAULT_PERIOD
       self.time = nil
     end
 
     def moving_factor
       return (time || Time.now).to_i / period
     end
+
+    def type_specific_uri_params
+      params = {}
+      params["period"] = period if period != DEFAULT_PERIOD
+      return params
+    end
+
+    def extract_type_specific_uri_params(query)
+      if value = query["period"]
+        self.period = value.to_i
+      end
+    end
   end
 end

data/lib/otp/uri.rb

@@ -0,0 +1,73 @@
+require "uri"
+
+module OTP
+  module URI
+    module_function
+
+    SCHEME = "othauth"
+
+    def parse(uri_string)
+      uri = ::URI.parse(uri_string)
+      raise "URI scheme not match: #{uri.scheme}" unless uri.scheme != SCHEME
+      otp = otp_class(uri).new
+      if %r{/(?:([^:]*): *)?(.+)} =~ uri.path
+        otp.issuer = $1
+        otp.accountname = $2
+      end
+      query = Hash[::URI.decode_www_form(uri.query)]
+      otp.secret = query["secret"]
+      if value = query["algorithm"]
+        otp.algorithm = value
+      end
+      if value = query["issuer"]
+        otp.issuer = value
+      end
+      if value = query["digits"]
+        otp.digits = value.to_i
+      end
+      otp.extract_type_specific_uri_params(query)
+      return otp
+    end
+
+    def format(otp)
+      raise "secret must be set" if otp.secret.nil?
+      raise "accountname must be set" if otp.accountname.nil?
+      typename = otp.class.name.split("::")[-1].downcase
+      label = otp.issuer ? "#{otp.issuer}:#{otp.accountname}" : otp.accountname
+      params = pickup_params(otp)
+      return "otpauth://%s/%s?%s" % [
+        ::URI.encode(typename),
+        ::URI.encode(label),
+        ::URI.encode_www_form(params)
+      ]
+    end
+
+    def otp_class(uri)
+      case uri.host.upcase
+      when "HOTP"
+        OTP::HOTP
+      when "TOTP"
+        OTP::TOTP
+      else
+        raise "unknown OTP type: #{uri.host}"
+      end
+    end
+
+    def pickup_params(otp)
+      param_spec = [
+        [:secret, nil],
+        [:issuer, nil],
+        [:algorithm, OTP::Base::DEFAULT_ALGORITHM],
+        [:digits, OTP::Base::DEFAULT_DIGITS],
+      ]
+      params = param_spec.reduce({}) do |h, (name, default)|
+        value = otp.send(name)
+        if value && value != default
+          h[name] = value
+        end
+        h
+      end
+      return params.merge(otp.type_specific_uri_params)
+    end
+  end
+end

data/lib/otp/version.rb

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

data/test/test_base32.rb

@@ -2,18 +2,18 @@ require "test/unit"
 require "otp/base32"
 
 class TestBase32 < Test::Unit::TestCase
-  def assert_encode(plain, encoded)
-    assert_equal(::OTP::Base32.encode(plain), encoded)
+  def assert_encode(encoded, plain)
+    assert_equal(encoded, ::OTP::Base32.encode(plain))
   end
 
-  def assert_decode(encoded, plain)
+  def assert_decode(plain, encoded)
     plain &&= plain.dup.force_encoding("binary")
-    assert_equal(::OTP::Base32.decode(encoded), plain)
+    assert_equal(plain, ::OTP::Base32.decode(encoded))
   end
 
   def assert_encode_decode(plain, encoded)
-    assert_encode(plain, encoded)
-    assert_decode(encoded, plain)
+    assert_decode(plain, encoded)
+    assert_encode(encoded, plain)
   end
 
   def test_base32

data/test/test_hotp.rb

@@ -4,7 +4,7 @@ require "otp"
 class TestHTOP < Test::Unit::TestCase
   def assert_hotp(hotp, count, pass)
     hotp.count = count
-    assert_equal(hotp.password, pass)
+    assert_equal(pass, hotp.password)
     assert(hotp.verify(pass))
     assert(!hotp.verify(pass.chop))
   end

data/test/test_totp.rb

@@ -4,7 +4,7 @@ require "otp"
 class TestTOTP < Test::Unit::TestCase
   def assert_totp(totp, time, pass)
     totp.time = time
-    assert_equal(totp.password, pass)
+    assert_equal(pass, totp.password)
     assert(totp.verify(pass))
     assert(!totp.verify(pass.chop))
   end

data/test/test_uri.rb

@@ -0,0 +1,49 @@
+require "test/unit"
+require "otp"
+
+class TestURI < Test::Unit::TestCase
+  def test_totp
+    secret = OTP::Base32.encode("12345678901234567890")
+    totp = OTP::TOTP.new
+    totp.secret = secret
+    totp.algorithm = "SHA256"
+    totp.digits = 8
+    totp.period = 60
+    totp.issuer = "My Company"
+    totp.accountname = "account@example.com"
+    uri = totp.to_uri
+
+    otp = OTP::URI.parse(uri)
+    assert_equal(OTP::TOTP, otp.class)
+    assert_equal(secret, otp.secret)
+    assert_equal("SHA256", otp.algorithm)
+    assert_equal(8, otp.digits)
+    assert_equal(60, otp.period)
+    assert_equal("account@example.com", otp.accountname)
+    assert_equal("My Company", otp.issuer)
+    totp.time = otp.time = Time.now
+    assert_equal(otp.password, totp.password)
+  end
+
+  def test_hotp
+    secret = OTP::Base32.encode("12345678901234567890")
+    hotp = OTP::HOTP.new
+    hotp.secret = secret
+    hotp.algorithm = "SHA256"
+    hotp.digits = 8
+    hotp.count = 1234
+    hotp.issuer = "My Company"
+    hotp.accountname = "account@example.com"
+    uri = hotp.to_uri
+
+    otp = OTP::URI.parse(uri)
+    assert_equal(OTP::HOTP, otp.class)
+    assert_equal(secret, otp.secret)
+    assert_equal("SHA256", otp.algorithm)
+    assert_equal(8, otp.digits)
+    assert_equal(1234, otp.count)
+    assert_equal("account@example.com", otp.accountname)
+    assert_equal("My Company", otp.issuer)
+    assert_equal(otp.password, hotp.password)
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: otp
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Yuuzou Gotou
@@ -55,12 +55,14 @@ files:
 - lib/otp/base32.rb
 - lib/otp/hotp.rb
 - lib/otp/totp.rb
+- lib/otp/uri.rb
 - lib/otp/utils.rb
 - lib/otp/version.rb
 - otp.gemspec
 - test/test_base32.rb
 - test/test_hotp.rb
 - test/test_totp.rb
+- test/test_uri.rb
 homepage: ''
 licenses:
 - MIT
@@ -89,3 +91,4 @@ test_files:
 - test/test_base32.rb
 - test/test_hotp.rb
 - test/test_totp.rb
+- test/test_uri.rb