rotp 2.1.2 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 249d6f491f01af9144f3e7e6573e40f5f6b33039
-  data.tar.gz: 21959028b9d02f4c112ef0f3a9e1573c935fcef3
+  metadata.gz: 17c7287512c5437d21d34d9d0eae73f42cce0501
+  data.tar.gz: a2b8c0c4133681b23af7a30c34f9e6d0386e1f65
 SHA512:
-  metadata.gz: 2b3b5ce10fb037701d5c73b1a1a095a9bd0186baf6cc29ba7e6fe20d1aabcf9b59444588969e1175da044ca1159529d1915722620101d65780c95d0a3b4bdbcd
-  data.tar.gz: 3f61abe5b65d0a8a180b7297c09f9654637a23a7e39446358dd7095e883ff5c65afce5f23420bfdaa29a0a6a04469013ab078b31ef4a003cf1140e697adca376
+  metadata.gz: dc396f7711a415619afd44e5b2d1eba90dada73990a4531fb5bede1dc0d7c8c620e745be388e85ad34d290878a14e92e194ed9379ff0226964cac97070eada7c
+  data.tar.gz: 9ed66cff8f1b90b54252842131d1f2c046d87a1082381470b8ea0c7b2e3cda890039967b1b458d771ca3e5f4f7f5a3892fdaff6f408b8618ff357405e9727b31

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ### Changelog
 
+#### 3.0.0
+
+- Provisioning URL includes issuer label per RFC 5234 See mdp/rotp/pull/51
+
 #### 2.1.2
 
 - Remove string literals to prepare immutable strings in Ruby 3.0

data/README.md

@@ -39,6 +39,7 @@ Optionally, you can provide an issuer which will be used as a title in Google Au
 
 ```ruby
 totp = ROTP::TOTP.new("base32secret3232", issuer: "My Service")
+totp.provisioning_uri("alice@google.com")
 ```
 
 ### Counter based OTP's
@@ -68,8 +69,8 @@ Provisioning URI's generated by ROTP are compatible with the Google Authenticato
 to be scanned with the in-built QR Code scanner.
 
 ```ruby
-totp.provisioning_uri("alice@google.com") # => 'otpauth://totp/alice@google.com?secret=JBSWY3DPEHPK3PXP'
-hotp.provisioning_uri("alice@google.com", 0) # => 'otpauth://hotp/alice@google.com?secret=JBSWY3DPEHPK3PXP&counter=0'
+totp.provisioning_uri("alice@google.com") # => 'otpauth://totp/issuer:alice@google.com?secret=JBSWY3DPEHPK3PXP'
+hotp.provisioning_uri("alice@google.com", 0) # => 'otpauth://hotp/issuer: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

data/lib/rotp/totp.rb

@@ -51,9 +51,14 @@ module ROTP
     # This can then be encoded in a QR Code and used
     # to provision the Google Authenticator app
     # @param [String] name of the account
-    # @return [String] provisioning uri
+    # @return [String] provisioning URI
     def provisioning_uri(name)
-      encode_params("otpauth://totp/#{URI.encode(name)}",
+      # The format of this URI is documented at:
+      # https://github.com/google/google-authenticator/wiki/Key-Uri-Format
+      # For compatibility the issuer appears both before that account name and also in the
+      # query string.
+      issuer_string = issuer.nil? ? "" : "#{URI.encode(issuer)}:"
+      encode_params("otpauth://totp/#{issuer_string}#{URI.encode(name)}",
                     :secret => secret, :period => (interval==30 ? nil : interval), :issuer => issuer)
     end
 

data/lib/rotp/version.rb

@@ -1,3 +1,3 @@
 module ROTP
-  VERSION = "2.1.2"
+  VERSION = "3.0.0"
 end

data/spec/lib/rotp/totp_spec.rb

@@ -101,7 +101,7 @@ RSpec.describe ROTP::TOTP do
       let(:totp)  { ROTP::TOTP.new 'JBSWY3DPEHPK3PXP', issuer: 'FooCo' }
 
       it 'has the correct format' do
-        expect(uri).to match %r{\Aotpauth:\/\/totp.+}
+        expect(uri).to match %r{\Aotpauth:\/\/totp/FooCo:.+}
       end
 
       it 'includes the secret as parameter' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rotp
 version: !ruby/object:Gem::Version
-  version: 2.1.2
+  version: 3.0.0
 platform: ruby
 authors:
 - Mark Percival
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-12 00:00:00.000000000 Z
+date: 2016-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: guard-rspec