PyOTP 2.2.4__py2.py3-none-any.whl → 2.2.5__py2.py3-none-any.whl

pyotp/hotp.py

@@ -5,32 +5,47 @@ from .otp import OTP
 from .compat import str
 
 class HOTP(OTP):
+    """
+    Handler for HMAC-based OTP counters.
+    """
     def at(self, count):
         """
-        Generates the OTP for the given count
-        @param [Integer] count counter
-        @returns [Integer] OTP
+        Generates the OTP for the given count.
+
+        :param count: the OTP HMAC counter
+        :type count: int
+        :returns: OTP
+        :rtype: str
         """
         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
+        Verifies the OTP passed in against the current time OTP.
+
+        :param otp: the OTP to check against
+        :type otp: str
+        :param count: the OTP HMAC counter
+        :type count: int
         """
         return utils.strings_equal(str(otp), str(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
+        Returns the provisioning URI for the OTP.  This can then be
+        encoded in a QR Code and used to provision an OTP app like
+        Google Authenticator. See
+        https://github.com/google/google-authenticator/wiki/Key-Uri-Format
+        for more details.
+
+        :param name: name of the user account
+        :type name: str
+        :param initial_count: starting HMAC counter value, defaults to 0
+        :type initial_count: int
+        :param issuer_name: the name of the OTP issuer; this will be the
             organization title of the OTP entry in Authenticator
-        @return [String] provisioning uri
+        :returns: provisioning URI
+        :rtype: str
         """
         return utils.build_uri(
             self.secret,

pyotp/otp.py

@@ -6,16 +6,17 @@ import hmac
 from .compat import str
 
 class OTP(object):
+    """
+    Base class for OTP handlers.
+    """
     def __init__(self, s, digits=6, digest=hashlib.sha1):
         """
-        @param [String] secret in the form of base32
-        @option options digits [Integer] (6)
-            Number of integers in the OTP
-            Google Authenticate only supports 6 currently
-        @option options digest [Callable] (hashlib.sha1)
-            Digest used in the HMAC
-            Google Authenticate only supports 'sha1' currently
-        @returns [OTP] OTP instantiation
+        :param s: secret in base32 format
+        :type s: str
+        :param digits: number of integers in the OTP. Some apps expect this to be 6 digits, others support more.
+        :type digits: int
+        :param digest: digest function to use in the HMAC (expected to be sha1)
+        :type digest: callable
         """
         self.digits = digits
         self.digest = digest
@@ -23,10 +24,12 @@ class OTP(object):
 
     def generate_otp(self, input):
         """
-        @param [Integer] input the number used seed the HMAC
-        Usually either the counter, or the computed integer
-        based on the Unix timestamp
+        :param input: the HMAC counter value to use as the OTP input.
+            Usually either the counter, or the computed integer based on the Unix timestamp
+        :type input: int
         """
+        if input < 0:
+            raise ValueError('input must be positive integer')
         hasher = hmac.new(self.byte_secret(), self.int_to_bytestring(input), self.digest)
         hmac_hash = bytearray(hasher.digest())
         offset = hmac_hash[-1] & 0xf

pyotp/totp.py

@@ -8,20 +8,27 @@ from .otp import OTP
 from .compat import str
 
 class TOTP(OTP):
+    """
+    Handler for time-based OTP counters.
+    """
     def __init__(self, *args, **kwargs):
         """
-        @option options [Integer] interval (30) the time interval in seconds
-            for OTP This defaults to 30 which is standard.
+        :param interval: the time interval in seconds
+            for OTP. This defaults to 30.
+        :type interval: int
         """
         self.interval = kwargs.pop('interval', 30)
         super(TOTP, self).__init__(*args, **kwargs)
 
     def at(self, for_time, counter_offset=0):
         """
-        Accepts either a Unix timestamp integer or a Time object.
-        @param [Time/Integer] time the time to generate an OTP for
-        @param [Integer] counter_offset an amount of ticks to add to the time
-            counter
+        Accepts either a Unix timestamp integer or a datetime object.
+
+        :param for_time: the time to generate an OTP for
+        :type for_time: int or datetime
+        :param counter_offset: the amount of ticks to add to the time counter
+        :returns: OTP value
+        :rtype: str
         """
         if not isinstance(for_time, datetime.datetime):
             for_time = datetime.datetime.fromtimestamp(int(for_time))
@@ -30,16 +37,24 @@ class TOTP(OTP):
     def now(self):
         """
         Generate the current time OTP
-        @return [Integer] the OTP as an integer
+
+        :returns: OTP value
+        :rtype: str
         """
         return self.generate_otp(self.timecode(datetime.datetime.now()))
 
     def verify(self, otp, for_time=None, valid_window=0):
         """
-        Verifies the OTP passed in against the current time OTP
-        @param [String/Integer] otp the OTP to check against
-        @param [Integer] valid_window extends the validity to this many counter
-            ticks before and after the current one
+        Verifies the OTP passed in against the current time OTP.
+
+        :param otp: the OTP to check against
+        :type otp: str
+        :param for_time: Time to check OTP at (defaults to now)
+        :type for_time: int or datetime
+        :param valid_window: extends the validity to this many counter ticks before and after the current one
+        :type valid_window: int
+        :returns: True if verification succeeded, False otherwise
+        :rtype: bool
         """
         if for_time is None:
             for_time = datetime.datetime.now()
@@ -54,11 +69,18 @@ class TOTP(OTP):
 
     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
-        to provision the Google Authenticator app
-        @param [String] name of the account
-        @return [String] provisioning uri
+        Returns the provisioning URI for the OTP.  This can then be
+        encoded in a QR Code and used to provision an OTP app like
+        Google Authenticator. See
+        https://github.com/google/google-authenticator/wiki/Key-Uri-Format
+        for more details.
+
+        :param name: name of the user account
+        :type name: str
+        :param issuer_name: the name of the OTP issuer; this will be the
+            organization title of the OTP entry in Authenticator
+        :returns: provisioning URI
+        :rtype: str
         """
         return utils.build_uri(self.secret, name, issuer_name=issuer_name,
                                algorithm=self.digest().name,

pyotp/utils.py

@@ -25,17 +25,25 @@ def build_uri(secret, name, initial_count=None, issuer_name=None,
     See also:
         https://github.com/google/google-authenticator/wiki/Key-Uri-Format
 
-    @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.
+    :param secret: the hotp/totp secret used to generate the URI
+    :type secret: str
+    :param name: name of the account
+    :type name: str
+    :param 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
+    :type initial_count: int
+    :param issuer_name: the name of the OTP issuer; this will be the
         organization title of the OTP entry in Authenticator
-    @param [String] the algorithm used in the OTP generation.
-    @param [Integer] the length of the OTP generated code.
-    @param [Integer] the number of seconds the OTP generator is set to
+    :type issuer_name: str
+    :param algorithm: the algorithm used in the OTP generation.
+    :type algorithm: str
+    :param digits: the length of the OTP generated code.
+    :type digits: int
+    :param period: the number of seconds the OTP generator is set to
         expire every code.
-    @return [String] provisioning uri
+    :type period: int
+    :returns: provisioning uri
+    :rtype: str
     """
     # initial_count may be 0 as a valid param
     is_initial_count_present = (initial_count is not None)
@@ -53,7 +61,7 @@ def build_uri(secret, name, initial_count=None, issuer_name=None,
     label = quote(name)
     if issuer_name is not None:
         label = quote(issuer_name) + ':' + label
-        url_args['issuer'] = issuer_name
+        url_args['issuer'] = quote(issuer_name)
 
     if is_initial_count_present:
         url_args['counter'] = initial_count

{pyotp-2.2.4.dist-info → pyotp-2.2.5.dist-info}/DESCRIPTION.rst

@@ -31,7 +31,7 @@ Installation
 Usage
 -----
 
-Time based OTPs
+Time-based OTPs
 ~~~~~~~~~~~~~~~
 ::
 
@@ -60,23 +60,29 @@ Generating a base32 Secret Key
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 ::
 
-    pyotp.random_base32() # returns a 16 character base32 secret. Compatible with Google Authenticator
+    pyotp.random_base32() # returns a 16 character base32 secret. Compatible with Google Authenticator and other OTP apps
 
 Google Authenticator Compatible
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-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::
+PyOTP works with the Google Authenticator iPhone and Android app, as well as other OTP apps like Authy. PyOTP includes the
+ability to generate provisioning URIs for use with the QR Code scanner built into these MFA client apps::
 
-    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'
+    pyotp.totp.TOTP('JBSWY3DPEHPK3PXP').provisioning_uri("alice@google.com", issuer_name="Secure App")
 
-This can then be rendered as a QR Code which can then be scanned and added to the users list of OTP credentials.
+    >>> 'otpauth://totp/Secure%20App:alice%40google.com?secret=JBSWY3DPEHPK3PXP&issuer=Secure+App'
+
+    pyotp.hotp.HOTP('JBSWY3DPEHPK3PXP').provisioning_uri("alice@google.com", initial_count=0, issuer_name="Secure App")
+
+    >>> 'otpauth://hotp/Secure%20App:alice%40google.com?secret=JBSWY3DPEHPK3PXP&issuer=Secure+App&counter=0'
+
+This URL can then be rendered as a QR Code (for example, using https://github.com/neocotic/qrious) which can then be scanned
+and added to the users list of OTP credentials.
 
 Working example
 ~~~~~~~~~~~~~~~
 
-Scan the following barcode with your phone, using Google Authenticator
+Scan the following barcode with your phone's OTP app (e.g. Google Authenticator):
 
 .. image:: http://chart.apis.google.com/chart?cht=qr&chs=250x250&chl=otpauth%3A%2F%2Ftotp%2Falice%40google.com%3Fsecret%3DJBSWY3DPEHPK3PXP
 
@@ -90,7 +96,7 @@ Links
 ~~~~~
 
 * `Project home page (GitHub) <https://github.com/pyotp/pyotp>`_
-* `Documentation (Read the Docs) <https://pyotp.readthedocs.org/en/latest/>`_
+* `Documentation (Read the Docs) <https://pyotp.readthedocs.io/en/latest/>`_
 * `Package distribution (PyPI) <https://pypi.python.org/pypi/pyotp>`_
 * `Change log <https://github.com/pyotp/pyotp/blob/master/Changes.rst>`_
 * `RFC 4226: HOTP: An HMAC-Based One-Time Password <https://tools.ietf.org/html/rfc4226>`_
@@ -109,6 +115,6 @@ Links
 .. image:: https://img.shields.io/pypi/l/pyotp.svg
         :target: https://pypi.python.org/pypi/pyotp
 .. image:: https://readthedocs.org/projects/pyotp/badge/?version=latest
-        :target: https://pyotp.readthedocs.org/
+        :target: https://pyotp.readthedocs.io/
 
 

{pyotp-2.2.4.dist-info → pyotp-2.2.5.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.0
 Name: pyotp
-Version: 2.2.4
+Version: 2.2.5
 Summary: Python One Time Password Library
 Home-page: https://github.com/pyotp/pyotp
 Author: PyOTP contributors
@@ -51,7 +51,7 @@ Installation
 Usage
 -----
 
-Time based OTPs
+Time-based OTPs
 ~~~~~~~~~~~~~~~
 ::
 
@@ -80,23 +80,29 @@ Generating a base32 Secret Key
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 ::
 
-    pyotp.random_base32() # returns a 16 character base32 secret. Compatible with Google Authenticator
+    pyotp.random_base32() # returns a 16 character base32 secret. Compatible with Google Authenticator and other OTP apps
 
 Google Authenticator Compatible
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-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::
+PyOTP works with the Google Authenticator iPhone and Android app, as well as other OTP apps like Authy. PyOTP includes the
+ability to generate provisioning URIs for use with the QR Code scanner built into these MFA client apps::
 
-    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'
+    pyotp.totp.TOTP('JBSWY3DPEHPK3PXP').provisioning_uri("alice@google.com", issuer_name="Secure App")
 
-This can then be rendered as a QR Code which can then be scanned and added to the users list of OTP credentials.
+    >>> 'otpauth://totp/Secure%20App:alice%40google.com?secret=JBSWY3DPEHPK3PXP&issuer=Secure+App'
+
+    pyotp.hotp.HOTP('JBSWY3DPEHPK3PXP').provisioning_uri("alice@google.com", initial_count=0, issuer_name="Secure App")
+
+    >>> 'otpauth://hotp/Secure%20App:alice%40google.com?secret=JBSWY3DPEHPK3PXP&issuer=Secure+App&counter=0'
+
+This URL can then be rendered as a QR Code (for example, using https://github.com/neocotic/qrious) which can then be scanned
+and added to the users list of OTP credentials.
 
 Working example
 ~~~~~~~~~~~~~~~
 
-Scan the following barcode with your phone, using Google Authenticator
+Scan the following barcode with your phone's OTP app (e.g. Google Authenticator):
 
 .. image:: http://chart.apis.google.com/chart?cht=qr&chs=250x250&chl=otpauth%3A%2F%2Ftotp%2Falice%40google.com%3Fsecret%3DJBSWY3DPEHPK3PXP
 
@@ -110,7 +116,7 @@ Links
 ~~~~~
 
 * `Project home page (GitHub) <https://github.com/pyotp/pyotp>`_
-* `Documentation (Read the Docs) <https://pyotp.readthedocs.org/en/latest/>`_
+* `Documentation (Read the Docs) <https://pyotp.readthedocs.io/en/latest/>`_
 * `Package distribution (PyPI) <https://pypi.python.org/pypi/pyotp>`_
 * `Change log <https://github.com/pyotp/pyotp/blob/master/Changes.rst>`_
 * `RFC 4226: HOTP: An HMAC-Based One-Time Password <https://tools.ietf.org/html/rfc4226>`_
@@ -129,6 +135,6 @@ Links
 .. image:: https://img.shields.io/pypi/l/pyotp.svg
         :target: https://pypi.python.org/pypi/pyotp
 .. image:: https://readthedocs.org/projects/pyotp/badge/?version=latest
-        :target: https://pyotp.readthedocs.org/
+        :target: https://pyotp.readthedocs.io/
 
 

pyotp-2.2.5.dist-info/RECORD

@@ -0,0 +1,12 @@
+pyotp/__init__.py,sha256=3I4NkdbXw4iHBbtfL7-dbNv8XZn0EUzS0Fc1riI1CJ8,485
+pyotp/compat.py,sha256=QVb4buImn4PyP0qe5uLiXsO2-p4ItTGl01Vbt2dILNE,222
+pyotp/hotp.py,sha256=BsY90HvawLuye4PuY7Q5DY0_HmR-83N1FVfwuw-SunI,1776
+pyotp/otp.py,sha256=QPyHxZ7fY7_zlrMVVveGQrCfn6gatpaHO3-ok9XwCaU,2344
+pyotp/totp.py,sha256=C734M9EaFqCFa2G0bzpJ6sW1M9bIwJj8Ib3BMuztHGE,3175
+pyotp/utils.py,sha256=op4qfvo-b4sE5zFeRIOW7jhC6LXXLuODjNaEFYdZh-4,3482
+pyotp-2.2.5.dist-info/DESCRIPTION.rst,sha256=FASDLIZAvjB-IGhzvwZRnNvFvh7KroZk0cvfezrj9JA,5471
+pyotp-2.2.5.dist-info/METADATA,sha256=uVlep_WEqWdYGLTAo528H7ZJI-XKCgTNCM1yHMth3co,6167
+pyotp-2.2.5.dist-info/RECORD,,
+pyotp-2.2.5.dist-info/WHEEL,sha256=o2k-Qa-RMNIJmUdIc7KU6VWR_ErNRbWNlxDIpl7lm34,110
+pyotp-2.2.5.dist-info/metadata.json,sha256=pG8Q257aEUFTs4h1opMfmDLYhP6Cl2RawF1ZFBOdY8M,825
+pyotp-2.2.5.dist-info/top_level.txt,sha256=rFDgz6Sm4nbkYk6tlSRiMcJPyYdnY6LcZiAaYTxVc5k,6

{pyotp-2.2.4.dist-info → pyotp-2.2.5.dist-info}/metadata.json

@@ -1 +1 @@
-{"classifiers": ["Intended Audience :: Developers", "License :: OSI Approved :: BSD License", "Operating System :: MacOS :: MacOS X", "Operating System :: POSIX", "Programming Language :: Python", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3.3", "Programming Language :: Python :: 3.4", "Topic :: Software Development :: Libraries :: Python Modules"], "extensions": {"python.details": {"contacts": [{"email": "kislyuk@gmail.com", "name": "PyOTP contributors", "role": "author"}], "document_names": {"description": "DESCRIPTION.rst"}, "project_urls": {"Home": "https://github.com/pyotp/pyotp"}}}, "generator": "bdist_wheel (0.29.0)", "license": "BSD License", "metadata_version": "2.0", "name": "pyotp", "platform": "MacOS X", "summary": "Python One Time Password Library", "version": "2.2.4"}
+{"classifiers": ["Intended Audience :: Developers", "License :: OSI Approved :: BSD License", "Operating System :: MacOS :: MacOS X", "Operating System :: POSIX", "Programming Language :: Python", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3.3", "Programming Language :: Python :: 3.4", "Topic :: Software Development :: Libraries :: Python Modules"], "extensions": {"python.details": {"contacts": [{"email": "kislyuk@gmail.com", "name": "PyOTP contributors", "role": "author"}], "document_names": {"description": "DESCRIPTION.rst"}, "project_urls": {"Home": "https://github.com/pyotp/pyotp"}}}, "generator": "bdist_wheel (0.29.0)", "license": "BSD License", "metadata_version": "2.0", "name": "pyotp", "platform": "MacOS X", "summary": "Python One Time Password Library", "version": "2.2.5"}

pyotp-2.2.4.dist-info/RECORD

@@ -1,12 +0,0 @@
-pyotp/__init__.py,sha256=3I4NkdbXw4iHBbtfL7-dbNv8XZn0EUzS0Fc1riI1CJ8,485
-pyotp/compat.py,sha256=QVb4buImn4PyP0qe5uLiXsO2-p4ItTGl01Vbt2dILNE,222
-pyotp/hotp.py,sha256=npnuKlg4NWg5XLv2p3cMrDbtjZB24hpeQVNquFpMZdM,1467
-pyotp/otp.py,sha256=pyX-Rdo6AyyRAotMv-rAOQh82JtXp5tfCreIKmIq93E,2262
-pyotp/totp.py,sha256=2gk1cr-F3G8QBbkdSLggmKmWhEB3NqcQbhJTs6sAlvs,2561
-pyotp/utils.py,sha256=VTt1Dy_zR7YuhiNngYrrCmNBwroEYPpnl33rB1RO9p0,3310
-pyotp-2.2.4.dist-info/DESCRIPTION.rst,sha256=_DHPmEMWwU2DG7zN4cfuQp2THY2GqJnMD4SJwwx1uk4,5138
-pyotp-2.2.4.dist-info/METADATA,sha256=S-HdzGqhANkglB7IcKN5EYdk1Fu12bGF7xjBMxNsrgM,5834
-pyotp-2.2.4.dist-info/RECORD,,
-pyotp-2.2.4.dist-info/WHEEL,sha256=o2k-Qa-RMNIJmUdIc7KU6VWR_ErNRbWNlxDIpl7lm34,110
-pyotp-2.2.4.dist-info/metadata.json,sha256=0mlcDG4g6Q5r5KRX2wwT2_L7vEhqnTtg_Rh36hZld2w,825
-pyotp-2.2.4.dist-info/top_level.txt,sha256=rFDgz6Sm4nbkYk6tlSRiMcJPyYdnY6LcZiAaYTxVc5k,6