PyOTP 1.3.1__tar.gz → 1.4.1__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 1.0
 Name: pyotp
-Version: 1.3.1
+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.3.1 → pyotp-1.4.1}/setup.py

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

{pyotp-1.3.1 → 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.3.1 → 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):
@@ -10,26 +10,30 @@ class HOTP(OTP):
         @returns [Integer] OTP
         """
         return self.generate_otp(count)
-    
+
     def verify(self, otp, counter):
         """
         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
         """
-        return otp == self.at(counter)
-    
-    def provisioning_uri(self, name, initial_count=0):
+        return unicode(otp) == unicode(self.at(counter))
+
+    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.3.1 → pyotp-1.4.1}/src/pyotp/totp.py

@@ -1,18 +1,18 @@
 from pyotp.otp import OTP
+from pyotp import utils
 import datetime
 import time
-import urllib
 
 
 class TOTP(OTP):
     def __init__(self, *args, **kwargs):
         """
-        @option options [Integer] interval (30) the time interval in seconds for OTP
-            This defaults to 30 which is standard.
+        @option options [Integer] interval (30) the time interval in seconds
+            for OTP This defaults to 30 which is standard.
         """
         self.interval = kwargs.pop('interval', 30)
         super(TOTP, self).__init__(*args, **kwargs)
-    
+
     def at(self, for_time):
         """
         Accepts either a Unix timestamp integer or a Time object.
@@ -22,14 +22,14 @@ class TOTP(OTP):
         if not isinstance(for_time, datetime.datetime):
             for_time = datetime.datetime.fromtimestamp(int(for_time))
         return self.generate_otp(self.timecode(for_time))
-    
+
     def now(self):
         """
         Generate the current time OTP
         @return [Integer] the OTP as an integer
         """
         return self.generate_otp(self.timecode(datetime.datetime.now()))
-    
+
     def verify(self, otp, for_time=None):
         """
         Verifies the OTP passed in against the current time OTP
@@ -37,9 +37,10 @@ class TOTP(OTP):
         """
         if for_time is None:
             for_time = datetime.datetime.now()
-        return otp == self.at(for_time)
-    
-    def provisioning_uri(self, name):
+
+        return unicode(otp) == unicode(self.at(for_time))
+
+    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
@@ -47,11 +48,8 @@ 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())
         return int(i / self.interval)

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.3.1 → pyotp-1.4.1}/test.py

@@ -23,15 +23,27 @@ class HOTPExampleValuesFromTheRFC(unittest.TestCase):
         self.assertEqual(hotp.at(7), 162583)
         self.assertEqual(hotp.at(8), 399871)
         self.assertEqual(hotp.at(9), 520489)
-    
+
     def testVerifyAnOTPAndNowAllowReuse(self):
         hotp = pyotp.HOTP('GEZDGNBVGY3TQOJQGEZDGNBVGY3TQOJQ')
         self.assertTrue(hotp.verify(520489, 9))
         self.assertFalse(hotp.verify(520489, 10))
-    
+        self.assertFalse(hotp.verify("520489", 10))
+
     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):
@@ -40,45 +52,52 @@ class TOTPExampleValuesFromTheRFC(unittest.TestCase):
         self.assertEqual(totp.at(1111111111), 50471)
         self.assertEqual(totp.at(1234567890), 5924)
         self.assertEqual(totp.at(2000000000), 279037)
-    
+
     def testMatchTheGoogleAuthenticatorOutput(self):
         totp = pyotp.TOTP('wrn3pqx5uqxqvnqr')
         with Timecop(1297553958):
             self.assertEqual(totp.now(), 102705)
-    
+
     def testValidateATimeBasedOTP(self):
         totp = pyotp.TOTP('wrn3pqx5uqxqvnqr')
         with Timecop(1297553958):
             self.assertTrue(totp.verify(102705))
+            self.assertTrue(totp.verify("102705"))
         with Timecop(1297553958 + 30):
             self.assertFalse(totp.verify(102705))
-    
+
     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):
     """
     Half-assed clone of timecop.rb, just enough to pass our tests.
     """
-    
+
     def __init__(self, freeze_timestamp):
         self.freeze_timestamp = freeze_timestamp
-    
+
     def __enter__(self):
         self.real_datetime = datetime.datetime
         datetime.datetime = self.frozen_datetime()
-    
+
     def __exit__(self, type, value, traceback):
         datetime.datetime = self.real_datetime
-    
+
     def frozen_datetime(self):
         class FrozenDateTime(datetime.datetime):
             @classmethod
             def now(cls):
                 return cls.fromtimestamp(timecop.freeze_timestamp)
-        
+
         timecop = self
         return FrozenDateTime