Merge pull request #102 from iovation/3.8-DEV

Feature/totp (#101)

Author: jnpblrdrgz

CHANGES.rst

@@ -1,6 +1,11 @@
 CHANGELOG for LaunchKey Python SDK
 ==================================
 
+3.8.0
+-----
+
+* Added TOTP generate_user_totp and remove_user_totp to Directory Client and verify_totp to Service Client
+
 3.7.0
 -----
 

Pipfile

@@ -5,7 +5,7 @@ verify_ssl = true
 
 [packages]
 launchkey = {path = ".",editable = true}
-urllib3 = ">= 1.24.2"  # Ensure CVE-2019-11324 is mitigated
+urllib3 = ">= 1.25.10"
 
 [dev-packages]
 # From setup.py tests_require to lock testing requirements
@@ -14,15 +14,15 @@ nose-exclude = ">= 0.5.0, < 1.0.0"
 mock = ">= 2.0.0, < 3.0.0"
 ddt = ">= 1.1.1, < 2.0.0"
 # Tools for static analysis
-flake8 = "~=3.6.0"
-pylint = "~=2.2.2"
+flake8 = "~=3.8.3"
+pylint = "~=2.5.3"
 coverage = "~=4.5.2"
-astroid = "~=2.1.0"  # Remove after pylint is updated to 2.3.0+
 # Tools for multi-environment testing before sending to CI
 tox = "~=3.7.0"
 behave = "~=1.2.6"
 appium-python-client = "*"
 pyhamcrest = "*"
+pyotp = "*"
 
 [requires]
-python = "~=3.4"
+python = "~=3.6"

Pipfile.lock

@@ -186,6 +186,39 @@ When a user logs out
 
     service_client.session_end(user)
 
+TOTP
+****
+
+A user can have TOTP configured via the `generate_user_totp` method on the `DirectoryClient`.
+
+.. code-block:: python
+
+    identifier = "my-permanent-unique-user-identifier"
+    configuration = directory_client.generate_user_totp(identifier)
+    print("    Secret:    " + configuration.secret)
+    print("    Algorithm: " + configuration.algorithm)
+    print("    Period:    " + configuration.period)
+    print("    Digits:    " + configuration.digits)
+
+TOTP configurations can be removed via the `generate_user_totp` method on the `DirectoryClient`.
+
+.. code-block:: python
+
+    identifier = "my-permanent-unique-user-identifier"
+    directory_client.remove_user_totp(identifier)
+
+Finally codes can be validated via the `verify_totp` method on the `ServiceClient`.
+
+.. code-block:: python
+
+    identifier = "my-permanent-unique-user-identifier"
+    otp = "569874"
+    valid = service_client.verify_totp(identifier, otp)
+    if valid:
+        # Handle success scenario
+    else:
+        # Handle failure scenario
+
 Dealing with Webhooks
 *********************
 

README.rst

@@ -10,6 +10,7 @@ click = "*"
 six = "*"
 launchkey = {path = "./../..", editable = true}
 urllib3 = ">= 1.24.2"  # Ensure CVE-2019-11324 is mitigated
+qrcode = "*"
 
 [requires]
 python_version = "3.7"