PyOTP 1.4.2__py2.py3-none-any.whl

pyotp/__init__.py

@@ -0,0 +1,18 @@
+from __future__ import print_function, unicode_literals, division, absolute_import
+
+import random as _random
+
+from pyotp.hotp import HOTP
+from pyotp.otp import OTP
+from pyotp.totp import TOTP
+from . import utils
+
+VERSION = '1.4.2'
+
+
+def random_base32(length=16, random=_random.SystemRandom(),
+                  chars=list('ABCDEFGHIJKLMNOPQRSTUVWXYZ234567')):
+    return ''.join(
+        random.choice(chars)
+        for _ in range(length)
+    )

pyotp/hotp.py

@@ -0,0 +1,40 @@
+from __future__ import print_function, unicode_literals, division, absolute_import
+
+from pyotp.otp import OTP
+from pyotp import utils
+
+
+class HOTP(OTP):
+    def at(self, count):
+        """
+        Generates the OTP for the given count
+        @param [Integer] count counter
+        @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 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
+            organization title of the OTP entry in Authenticator
+        @return [String] provisioning uri
+        """
+        return utils.build_uri(
+            self.secret,
+            name,
+            initial_count=initial_count,
+            issuer_name=issuer_name,
+        )

pyotp/otp.py

@@ -0,0 +1,60 @@
+from __future__ import print_function, unicode_literals, division, absolute_import
+
+import base64
+import hashlib
+import hmac
+
+
+class OTP(object):
+    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
+        """
+        self.digits = digits
+        self.digest = digest
+        self.secret = s
+
+    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
+        """
+        hmac_hash = hmac.new(
+            self.byte_secret(),
+            self.int_to_bytestring(input),
+            self.digest,
+        ).digest()
+
+        hmac_hash = bytearray(hmac_hash)
+        offset = hmac_hash[-1] & 0xf
+        code = ((hmac_hash[offset] & 0x7f) << 24 |
+                (hmac_hash[offset + 1] & 0xff) << 16 |
+                (hmac_hash[offset + 2] & 0xff) << 8 |
+                (hmac_hash[offset + 3] & 0xff))
+        return code % 10 ** self.digits
+
+    def byte_secret(self):
+        return base64.b32decode(self.secret, casefold=True)
+
+    @staticmethod
+    def int_to_bytestring(i, padding=8):
+        """
+        Turns an integer to the OATH specified
+        bytestring, which is fed to the HMAC
+        along with the secret
+        """
+        result = bytearray()
+        while i != 0:
+            result.append(i & 0xFF)
+            i >>= 8
+        # It's necessary to convert the final result from bytearray to bytes because
+        # the hmac functions in python 2.6 and 3.3 don't work with bytearray
+        return bytes(bytearray(reversed(result)).rjust(padding, b'\0'))

pyotp/totp.py

@@ -0,0 +1,58 @@
+from __future__ import print_function, unicode_literals, division, absolute_import
+
+import datetime
+import time
+
+from pyotp import utils
+from pyotp.otp import OTP
+
+
+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.
+        """
+        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.
+        Time objects will be adjusted to UTC automatically
+        @param [Time/Integer] time the time to generate an OTP for
+        """
+        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
+        @param [String/Integer] otp the OTP to check against
+        """
+        if for_time is None:
+            for_time = datetime.datetime.now()
+
+        return utils.strings_equal(str(otp), str(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
+        to provision the Google Authenticator app
+        @param [String] name of the account
+        @return [String] provisioning uri
+        """
+        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/utils.py

@@ -0,0 +1,79 @@
+from __future__ import print_function, unicode_literals, division, absolute_import
+
+try:
+    from urllib.parse import quote
+except ImportError:
+    from urllib import quote
+
+
+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 is not None)
+
+    otp_type = 'hotp' if is_initial_count_present else 'totp'
+    base = 'otpauth://%s/' % otp_type
+
+    if issuer_name:
+        issuer_name = quote(issuer_name)
+        base += '%s:' % issuer_name
+
+    uri = '%(base)s%(name)s?secret=%(secret)s' % {
+        'name': 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
+
+
+def strings_equal(s1, s2):
+    """
+    Timing-attack resistant string comparison.
+
+    Normal comparison using == will short-circuit on the first mismatching
+    character. This avoids that by scanning the whole string, though we
+    still reveal to a timing attack whether the strings are the same
+    length.
+    """
+    try:
+        # Python 3.3+ and 2.7.7+ include a timing-attack-resistant
+        # comparison function, which is probably more reliable than ours.
+        # Use it if available.
+        from hmac import compare_digest
+
+        return compare_digest(s1, s2)
+    except ImportError:
+        pass
+
+    if len(s1) != len(s2):
+        return False
+
+    differences = 0
+    for c1, c2 in zip(s1, s2):
+        differences |= ord(c1) ^ ord(c2)
+    return differences == 0

pyotp-1.4.2.dist-info/DESCRIPTION.rst

@@ -0,0 +1,112 @@
+PyOTP - The Python One-Time Password Library
+============================================
+
+PyOTP is a Python library for generating and verifying one-time passwords. It can be used to implement two-factor (2FA)
+or multi-factor (MFA) authentication methods in web applications and in other systems that require users to log in.
+
+Open MFA standards are defined in `RFC 4226 <https://tools.ietf.org/html/rfc4226>`_ (HOTP: An HMAC-Based One-Time
+Password Algorithm) and in `RFC 6238 <https://tools.ietf.org/html/rfc6238>`_ (TOTP: Time-Based One-Time Password
+Algorithm). PyOTP implements server-side support for both of these standards. Client-side support can be enabled by
+sending authentication codes to users over SMS or email (HOTP) or, for TOTP, by instructing users to use `Google
+Authenticator <https://en.wikipedia.org/wiki/Google_Authenticator>`_, `Authy <https://www.authy.com/>`_, or another
+compatible app. Users can set up auth tokens in their apps easily by using their phone camera to scan `otpauth://
+<https://github.com/google/google-authenticator/wiki/Key-Uri-Format>`_ QR codes provided by PyOTP.
+
+Quick overview of using One Time Passwords on your phone
+--------------------------------------------------------
+
+* OTPs involve a shared secret, stored both on the phone and the server
+* OTPs can be generated on a phone without internet connectivity
+* OTPs should always be used as a second factor of authentication(if your phone is lost, you account is still secured with a password)
+* Google Authenticator allows you to store multiple OTP secrets and provision those using a QR Code(no more typing in the secret)
+
+Installation
+------------
+::
+
+    pip install pyotp
+
+Usage
+-----
+
+Time based OTPs
+~~~~~~~~~~~~~~~
+::
+
+    totp = pyotp.TOTP('base32secret3232')
+    totp.now() # => 492039
+
+    # OTP verified for current time
+    totp.verify(492039) # => True
+    time.sleep(30)
+    totp.verify(492039) # => False
+
+Counter-based OTPs
+~~~~~~~~~~~~~~~~~~
+::
+
+    hotp = pyotp.HOTP('base32secret3232')
+    hotp.at(0) # => 260182
+    hotp.at(1) # => 55283
+    hotp.at(1401) # => 316439
+
+    # OTP verified with a counter
+    hotp.verify(316439, 1401) # => True
+    hotp.verify(316439, 1402) # => False
+
+Generating a base32 Secret Key
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+::
+
+    pyotp.random_base32() # returns a 16 character base32 secret. Compatible with Google Authenticator
+
+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::
+
+    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'
+
+This can then be rendered as a QR Code 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
+
+![QR Code for OTP](http://chart.apis.google.com/chart?cht=qr&chs=250x250&chl=otpauth%3A%2F%2Ftotp%2Falice%40google.com%3Fsecret%3DJBSWY3DPEHPK3PXP)
+
+Now run the following and compare the output::
+
+    import pyotp
+    totp = pyotp.TOTP("JBSWY3DPEHPK3PXP")
+    print "Current OTP: %s" % totp.now()
+
+Links
+~~~~~
+
+* `Project home page (GitHub) <https://github.com/pyotp/pyotp>`_
+* `Documentation (Read the Docs) <https://pyotp.readthedocs.org/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>`_
+* `RFC 6238: TOTP: Time-Based One-Time Password Algorithm <https://tools.ietf.org/html/rfc6238>`_
+* `ROTP <https://github.com/mdp/rotp>`_ - Original Ruby OTP library by `Mark Percival <https://github.com/mdp>`_
+* `OTPHP <https://github.com/lelag/otphp>`_ - PHP port of ROTP by `Le Lag <https://github.com/lelag>`_
+
+.. image:: https://img.shields.io/travis/pyotp/pyotp.svg
+        :target: https://travis-ci.org/pyotp/pyotp
+.. image:: https://img.shields.io/coveralls/pyotp/pyotp.svg
+        :target: https://coveralls.io/r/pyotp/pyotp?branch=master
+.. image:: https://img.shields.io/pypi/v/pyotp.svg
+        :target: https://pypi.python.org/pypi/pyotp
+.. image:: https://img.shields.io/pypi/dm/pyotp.svg
+        :target: https://pypi.python.org/pypi/pyotp
+.. 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/
+
+

pyotp-1.4.2.dist-info/METADATA

@@ -0,0 +1,132 @@
+Metadata-Version: 2.0
+Name: pyotp
+Version: 1.4.2
+Summary: Python One Time Password Library
+Home-page: https://github.com/pyotp/pyotp
+Author: PyOTP contributors
+Author-email: kislyuk@gmail.com
+License: BSD License
+Platform: MacOS X
+Platform: Posix
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Operating System :: MacOS :: MacOS X
+Classifier: Operating System :: POSIX
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 2.7
+Classifier: Programming Language :: Python :: 3.3
+Classifier: Programming Language :: Python :: 3.4
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+
+PyOTP - The Python One-Time Password Library
+============================================
+
+PyOTP is a Python library for generating and verifying one-time passwords. It can be used to implement two-factor (2FA)
+or multi-factor (MFA) authentication methods in web applications and in other systems that require users to log in.
+
+Open MFA standards are defined in `RFC 4226 <https://tools.ietf.org/html/rfc4226>`_ (HOTP: An HMAC-Based One-Time
+Password Algorithm) and in `RFC 6238 <https://tools.ietf.org/html/rfc6238>`_ (TOTP: Time-Based One-Time Password
+Algorithm). PyOTP implements server-side support for both of these standards. Client-side support can be enabled by
+sending authentication codes to users over SMS or email (HOTP) or, for TOTP, by instructing users to use `Google
+Authenticator <https://en.wikipedia.org/wiki/Google_Authenticator>`_, `Authy <https://www.authy.com/>`_, or another
+compatible app. Users can set up auth tokens in their apps easily by using their phone camera to scan `otpauth://
+<https://github.com/google/google-authenticator/wiki/Key-Uri-Format>`_ QR codes provided by PyOTP.
+
+Quick overview of using One Time Passwords on your phone
+--------------------------------------------------------
+
+* OTPs involve a shared secret, stored both on the phone and the server
+* OTPs can be generated on a phone without internet connectivity
+* OTPs should always be used as a second factor of authentication(if your phone is lost, you account is still secured with a password)
+* Google Authenticator allows you to store multiple OTP secrets and provision those using a QR Code(no more typing in the secret)
+
+Installation
+------------
+::
+
+    pip install pyotp
+
+Usage
+-----
+
+Time based OTPs
+~~~~~~~~~~~~~~~
+::
+
+    totp = pyotp.TOTP('base32secret3232')
+    totp.now() # => 492039
+
+    # OTP verified for current time
+    totp.verify(492039) # => True
+    time.sleep(30)
+    totp.verify(492039) # => False
+
+Counter-based OTPs
+~~~~~~~~~~~~~~~~~~
+::
+
+    hotp = pyotp.HOTP('base32secret3232')
+    hotp.at(0) # => 260182
+    hotp.at(1) # => 55283
+    hotp.at(1401) # => 316439
+
+    # OTP verified with a counter
+    hotp.verify(316439, 1401) # => True
+    hotp.verify(316439, 1402) # => False
+
+Generating a base32 Secret Key
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+::
+
+    pyotp.random_base32() # returns a 16 character base32 secret. Compatible with Google Authenticator
+
+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::
+
+    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'
+
+This can then be rendered as a QR Code 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
+
+![QR Code for OTP](http://chart.apis.google.com/chart?cht=qr&chs=250x250&chl=otpauth%3A%2F%2Ftotp%2Falice%40google.com%3Fsecret%3DJBSWY3DPEHPK3PXP)
+
+Now run the following and compare the output::
+
+    import pyotp
+    totp = pyotp.TOTP("JBSWY3DPEHPK3PXP")
+    print "Current OTP: %s" % totp.now()
+
+Links
+~~~~~
+
+* `Project home page (GitHub) <https://github.com/pyotp/pyotp>`_
+* `Documentation (Read the Docs) <https://pyotp.readthedocs.org/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>`_
+* `RFC 6238: TOTP: Time-Based One-Time Password Algorithm <https://tools.ietf.org/html/rfc6238>`_
+* `ROTP <https://github.com/mdp/rotp>`_ - Original Ruby OTP library by `Mark Percival <https://github.com/mdp>`_
+* `OTPHP <https://github.com/lelag/otphp>`_ - PHP port of ROTP by `Le Lag <https://github.com/lelag>`_
+
+.. image:: https://img.shields.io/travis/pyotp/pyotp.svg
+        :target: https://travis-ci.org/pyotp/pyotp
+.. image:: https://img.shields.io/coveralls/pyotp/pyotp.svg
+        :target: https://coveralls.io/r/pyotp/pyotp?branch=master
+.. image:: https://img.shields.io/pypi/v/pyotp.svg
+        :target: https://pypi.python.org/pypi/pyotp
+.. image:: https://img.shields.io/pypi/dm/pyotp.svg
+        :target: https://pypi.python.org/pypi/pyotp
+.. 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/
+
+

pyotp-1.4.2.dist-info/RECORD

@@ -0,0 +1,11 @@
+pyotp/__init__.py,sha256=l3t-6ZXG4K9JrF6n_NzGfHeDl5Fxje5z4ZrrRetz3mA,446
+pyotp/hotp.py,sha256=HNpFU0E9h_nUg-47yiVGtvOwxRKs-_8YZCRzJgoD_zQ,1380
+pyotp/otp.py,sha256=Va2Sf-ITUf3VDYz4kra5nMZ_KKVYufDyTV0KlRnYUOw,2033
+pyotp/totp.py,sha256=mLZL-G7IdIoEk-BcdyTL-EzXonK94Gkr_xtEa2eB8b8,1971
+pyotp/utils.py,sha256=_wqL2s2pE9jHFpoXaBWELlngWoktPYLOZ5vYRp0q7i0,2349
+pyotp-1.4.2.dist-info/DESCRIPTION.rst,sha256=5zAiiWMILqZD0S3kDsNUlYoNdl2aC6yaquMM2cCRAE0,4756
+pyotp-1.4.2.dist-info/METADATA,sha256=CBg_xdU--8D3yhkrRIgT0_xnBVe_5z6VhbKcy5VmqxY,5452
+pyotp-1.4.2.dist-info/metadata.json,sha256=0J2O--25ja42URBYCS3wfKd16kPxHRMdDebf9kvyn-s,789
+pyotp-1.4.2.dist-info/RECORD,,
+pyotp-1.4.2.dist-info/top_level.txt,sha256=rFDgz6Sm4nbkYk6tlSRiMcJPyYdnY6LcZiAaYTxVc5k,6
+pyotp-1.4.2.dist-info/WHEEL,sha256=6lxp_S3wZGmTBtGMVmNNLyvKFcp7HqQw2Wn4YYk-Suo,110

pyotp-1.4.2.dist-info/WHEEL

@@ -0,0 +1,6 @@
+Wheel-Version: 1.0
+Generator: bdist_wheel (0.23.0)
+Root-Is-Purelib: true
+Tag: py2-none-any
+Tag: py3-none-any
+

pyotp-1.4.2.dist-info/metadata.json

@@ -0,0 +1 @@
+{"license": "BSD License", "document_names": {"description": "DESCRIPTION.rst"}, "name": "pyotp", "metadata_version": "2.0", "contacts": [{"role": "author", "email": "kislyuk@gmail.com", "name": "PyOTP contributors"}], "generator": "bdist_wheel (0.23.0)", "summary": "Python One Time Password Library", "project_urls": {"Home": "https://github.com/pyotp/pyotp"}, "platform": "MacOS X", "version": "1.4.2", "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"]}

pyotp-1.4.2.dist-info/top_level.txt

@@ -0,0 +1 @@
+pyotp