PyOTP 1.4__tar.gz → 1.4.1__tar.gz

{pyotp-1.4 → pyotp-1.4.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 1.0
 Name: pyotp
-Version: 1.4
+Version: 1.4.1
 Summary: https://github.com/nathforge/pyotp
 Home-page: https://github.com/nathforge/pyotp
 Author: Mark Percival (ported by Nathan Reynolds to Python)

{pyotp-1.4 → pyotp-1.4.1}/setup.py

@@ -3,7 +3,7 @@
 from distutils.core import setup
 
 setup(
-    version='1.4',
+    version='1.4.1',
     url='https://github.com/nathforge/pyotp',
     name='pyotp',
     description='https://github.com/nathforge/pyotp',

{pyotp-1.4 → pyotp-1.4.1}/src/pyotp/__init__.py

@@ -1,6 +1,8 @@
 from pyotp.otp import OTP
 from pyotp.hotp import HOTP
 from pyotp.totp import TOTP
+import utils
+
 import base64
 import random
 

{pyotp-1.4 → pyotp-1.4.1}/src/pyotp/hotp.py

@@ -1,5 +1,5 @@
 from pyotp.otp import OTP
-import urllib
+from pyotp import utils
 
 
 class HOTP(OTP):
@@ -19,17 +19,21 @@ class HOTP(OTP):
         """
         return unicode(otp) == unicode(self.at(counter))
 
-    def provisioning_uri(self, name, initial_count=0):
+    def provisioning_uri(self, name, initial_count=0, issuer_name=None):
         """
         Returns the provisioning URI for the OTP
         This can then be encoded in a QR Code and used
         to provision the Google Authenticator app
         @param [String] name of the account
         @param [Integer] initial_count starting counter value, defaults to 0
+        @param [String] the name of the OTP issuer; this will be the
+            organization title of the OTP entry in Authenticator
         @return [String] provisioning uri
         """
-        return 'otpauth://hotp/%(name)s?secret=%(secret)s&counter=%(initial_count)s' % {
-            'name': urllib.quote(name, safe='@'),
-            'secret': self.secret,
-            'initial_count': initial_count,
-        }
+        return utils.build_uri(
+            self.secret,
+            name,
+            initial_count=initial_count,
+            issuer_name=issuer_name,
+        )
+

{pyotp-1.4 → pyotp-1.4.1}/src/pyotp/totp.py

@@ -1,7 +1,7 @@
 from pyotp.otp import OTP
+from pyotp import utils
 import datetime
 import time
-import urllib
 
 
 class TOTP(OTP):
@@ -40,7 +40,7 @@ class TOTP(OTP):
 
         return unicode(otp) == unicode(self.at(for_time))
 
-    def provisioning_uri(self, name):
+    def provisioning_uri(self, name, issuer_name=None):
         """
         Returns the provisioning URI for the OTP
         This can then be encoded in a QR Code and used
@@ -48,10 +48,7 @@ class TOTP(OTP):
         @param [String] name of the account
         @return [String] provisioning uri
         """
-        return 'otpauth://totp/%(name)s?secret=%(secret)s' % {
-            'name': urllib.quote(name, safe='@'),
-            'secret': self.secret,
-        }
+        return utils.build_uri(self.secret, name, issuer_name=issuer_name)
 
     def timecode(self, for_time):
         i = time.mktime(for_time.timetuple())

pyotp-1.4.1/src/pyotp/utils.py

@@ -0,0 +1,46 @@
+import urllib
+
+
+def build_uri(secret, name, initial_count=None, issuer_name=None):
+    """
+    Returns the provisioning URI for the OTP; works for either TOTP or HOTP.
+
+    This can then be encoded in a QR Code and used to provision the Google
+    Authenticator app.
+
+    For module-internal use.
+
+    See also:
+        http://code.google.com/p/google-authenticator/wiki/KeyUriFormat
+
+    @param [String] the hotp/totp secret used to generate the URI
+    @param [String] name of the account
+    @param [Integer] initial_count starting counter value, defaults to None.
+        If none, the OTP type will be assumed as TOTP.
+    @param [String] the name of the OTP issuer; this will be the
+        organization title of the OTP entry in Authenticator
+    @return [String] provisioning uri
+    """
+    # initial_count may be 0 as a valid param
+    is_initial_count_present = (initial_count != None)
+
+    otp_type = 'hotp' if is_initial_count_present else 'totp'
+    base = 'otpauth://%s/' % otp_type
+
+    if issuer_name:
+        issuer_name = urllib.quote(issuer_name)
+        base += '%s:' % issuer_name
+
+    uri = '%(base)s%(name)s?secret=%(secret)s' % {
+        'name': urllib.quote(name, safe='@'),
+        'secret': secret,
+        'base': base,
+    }
+
+    if is_initial_count_present:
+        uri += '&counter=%s' % initial_count
+
+    if issuer_name:
+        uri += '&issuer=%s' % issuer_name
+
+    return uri

{pyotp-1.4 → pyotp-1.4.1}/test.py

@@ -32,7 +32,18 @@ class HOTPExampleValuesFromTheRFC(unittest.TestCase):
 
     def testProvisioningURI(self):
         hotp = pyotp.HOTP('wrn3pqx5uqxqvnqr')
-        self.assertEqual(hotp.provisioning_uri('mark@percival'), 'otpauth://hotp/mark@percival?secret=wrn3pqx5uqxqvnqr&counter=0')
+
+        self.assertEqual(
+            hotp.provisioning_uri('mark@percival'),
+            'otpauth://hotp/mark@percival?secret=wrn3pqx5uqxqvnqr&counter=0')
+
+        self.assertEqual(
+            hotp.provisioning_uri('mark@percival', initial_count=12),
+            'otpauth://hotp/mark@percival?secret=wrn3pqx5uqxqvnqr&counter=12')
+
+        self.assertEqual(
+            hotp.provisioning_uri('mark@percival', issuer_name='FooCorp!'),
+            'otpauth://hotp/FooCorp%21:mark@percival?secret=wrn3pqx5uqxqvnqr&counter=0&issuer=FooCorp%21')
 
 
 class TOTPExampleValuesFromTheRFC(unittest.TestCase):
@@ -57,7 +68,13 @@ class TOTPExampleValuesFromTheRFC(unittest.TestCase):
 
     def testProvisioningURI(self):
         totp = pyotp.TOTP('wrn3pqx5uqxqvnqr')
-        self.assertEqual(totp.provisioning_uri('mark@percival'), 'otpauth://totp/mark@percival?secret=wrn3pqx5uqxqvnqr')
+        self.assertEqual(
+            totp.provisioning_uri('mark@percival'),
+            'otpauth://totp/mark@percival?secret=wrn3pqx5uqxqvnqr')
+
+        self.assertEqual(
+            totp.provisioning_uri('mark@percival', issuer_name='FooCorp!'),
+            'otpauth://totp/FooCorp%21:mark@percival?secret=wrn3pqx5uqxqvnqr&issuer=FooCorp%21')
 
 
 class Timecop(object):