Add GetMachineCode method (#5)

* Add GetMachineCode method

* Add IsOnRightMachine method

* Update package info

* Update docs

Author: artemlos

README.md

@@ -17,9 +17,8 @@ The code below will work exactly as the one explained in the [key verification t
 First, we need to add the namespaces:
 
 ```python
-from licensing.helpers import Helpers
-from licensing.models import Response, RSAPublicKey
-from licensing.methods import Key
+from licensing.models import *
+from licensing.methods import Key, Helpers
 ```
 
 Now we can perform the actual key verification:
@@ -29,10 +28,10 @@ pubKey = "<RSAKeyValue><Modulus>sGbvxwdlDbqFXOMlVUnAF5ew0t0WpPW7rFpI5jHQOFkht/32
 
 res = Key.activate(token="WyIyNTU1IiwiRjdZZTB4RmtuTVcrQlNqcSszbmFMMHB3aWFJTlBsWW1Mbm9raVFyRyJd",\
                    rsa_pub_key=pubKey,\
-                   product_id=3349, key="ICVLD-VVSZR-ZTICT-YKGXL", machine_code="test")
+                   product_id=3349, key="ICVLD-VVSZR-ZTICT-YKGXL", machine_code=Helpers.GetMachineCode())
 
-if res[0] == None:
-    print("An error occured: {0}".format(res[1]))
+if res[0] == None not Helpers.IsOnRightMachine(res[0]):
+    print("An error occurred: {0}".format(res[1]))
 else:
     print("Success")
 
@@ -45,7 +44,7 @@ else:
 * `token` - the access token (can be found [here](https://app.cryptolens.io/docs/api/v3/QuickStart#api-keys), in *API Keys* section).
 * `product_id` - the id of the product can be found on the product page.
 * `key` - the license key to be verified
-* `machine_code` - the unique id of the device (we are working on adding a method similar to `Helpers.GetMachineCode()`).
+* `machine_code` - the unique id of the device.
 
 ### Offline activation (saving/loading licenses)
 
@@ -66,6 +65,9 @@ When loading it back, we can use the code below:
 with open('licensefile.skm', 'r') as f:
     license_key = LicenseKey.load_from_string(pubKey, f.read())
 
-    print("Feature 1: " + str(license_key.f1))
-    print("License expires: " + str(license_key.expires))
+    if not Helpers.IsOnRightMachine(license_key):
+        print("NOTE: This license file does not belong to this machine.")
+    else:
+        print("Feature 1: " + str(license_key.f1))
+        print("License expires: " + str(license_key.expires))
 ```

licensing/internal.py

@@ -9,17 +9,25 @@
 from Crypto.Hash import SHA256
 from Crypto.PublicKey import RSA
 import urllib.request
+import hashlib
 
-class Helpers:
+class HelperMethods:
 
     server_address = "https://app.cryptolens.io/api/"
 
+    def get_SHA256(string):
+        """
+        Compute the SHA256 signature of a string.
+        """
+        return hashlib.sha256(string.encode("utf-8")).hexdigest()
+    
+    
     def verify_signature(response, rsaPublicKey):       
         """
         Verifies a signature from .NET RSACryptoServiceProvider.
         """
-        cryptoPubKey = RSA.construct((Helpers.base642int(rsaPublicKey.modulus),\
-                                      Helpers.base642int(rsaPublicKey.exponent)))
+        cryptoPubKey = RSA.construct((HelperMethods.base642int(rsaPublicKey.modulus),\
+                                      HelperMethods.base642int(rsaPublicKey.exponent)))
         h = SHA256.new(base64.b64decode(response.license_key.encode("utf-8")))
         verifier = PKCS1_v1_5.new(cryptoPubKey)
         return verifier.verify(h, base64.b64decode(response.signature.encode("utf-8")))
@@ -38,7 +46,7 @@ def send_request(method, params):
             method: the path of the method, eg. key/activate
             params: a dictionary of parameters
         """    
-        return urllib.request.urlopen(Helpers.server_address + method, \
+        return urllib.request.urlopen(HelperMethods.server_address + method, \
                                       urllib.parse.urlencode(params)\
                                       .encode("utf-8")).read().decode("utf-8")
 

licensing/methods.py

@@ -5,7 +5,9 @@
 @author: Artem Los
 """
 
-from licensing.internal import Helpers
+import platform
+import sys
+from licensing.internal import HelperMethods
 from licensing.models import *
 
 class Key:
@@ -14,7 +16,6 @@ class Key:
     License key related methods. More docs: https://app.cryptolens.io/docs/api/v3/Key.
     """
 
-    
     def activate(token, rsa_pub_key, product_id, key, machine_code, fields_to_return = 0,\
                  metadata = False, floating_time_interval = 0,\
                  max_overdraft = 0):
@@ -30,7 +31,7 @@ def activate(token, rsa_pub_key, product_id, key, machine_code, fields_to_return
         response = Response("","","","")
 
         try:
-            response = Response.from_string(Helpers.send_request("key/activate", {"token":token,\
+            response = Response.from_string(HelperMethods.send_request("key/activate", {"token":token,\
                                                   "ProductId":product_id,\
                                                   "key":key,\
                                                   "MachineCode":machine_code,\
@@ -49,9 +50,49 @@ def activate(token, rsa_pub_key, product_id, key, machine_code, fields_to_return
             return (None, response.message)
         else:
             try:
-                if Helpers.verify_signature(response, pubkey):
+                if HelperMethods.verify_signature(response, pubkey):
                     return (LicenseKey.from_response(response), response.message)
                 else:
                     return (None, "The signature check failed.")
             except Exception:
-                return (None, "The signature check failed.")
+                return (None, "The signature check failed.")
+            
+            
+class Helpers:
+    
+    def GetMachineCode():
+        
+        """
+        Get a unique identifier for this device.
+        """
+        
+        res = []
+        res.append(platform.machine())
+        res.append(platform.machine())
+        res.append(platform.processor())
+        res.append(platform.system())
+        res.append(platform.architecture()[1])
+        # safer than using architecture()[0]
+        # see https://docs.python.org/3/library/platform.html#platform.architecture
+        res.append(str(sys.maxsize > 2**32))
+        
+        return HelperMethods.get_SHA256(":".join(res))
+    
+    def IsOnRightMachine(license_key):
+        
+        """
+        Check if the device is registered with the license key.
+        """
+        
+        current_mid = Helpers.GetMachineCode()
+        
+        if license_key.activated_machines == None:
+            return False
+        
+        for act_machine in license_key.activated_machines:
+            
+            if current_mid == act_machine.Mid:
+                return True
+            
+        return False
+        

licensing/models.py

@@ -10,7 +10,15 @@
 import datetime
 import copy
 
-from licensing.internal import Helpers
+from licensing.internal import HelperMethods
+
+class ActivatedMachine:
+    def __init__(self, IP, Mid, Time):
+        self.IP = IP
+        self.Mid = Mid
+        
+        # TODO: check if time is int, and convert to datetime in this case.
+        self.Time = Time
 
 class LicenseKey:
 
@@ -52,11 +60,13 @@ def from_response(response):
 
         obj = json.loads(base64.b64decode(response.license_key).decode('utf-8'))
 
+        
+        
         return LicenseKey(obj["ProductId"], obj["ID"], obj["Key"], datetime.datetime.fromtimestamp(obj["Created"]),\
                           datetime.datetime.fromtimestamp(obj["Expires"]), obj["Period"], obj["F1"], obj["F2"], \
                           obj["F3"], obj["F4"],obj["F5"],obj["F6"], obj["F7"], \
                           obj["F8"], obj["Notes"], obj["Block"], obj["GlobalId"],\
-                          obj["Customer"], obj["ActivatedMachines"], obj["TrialActivation"], \
+                          obj["Customer"], LicenseKey.__load_activated_machines(obj["ActivatedMachines"]), obj["TrialActivation"], \
                           obj["MaxNoOfMachines"], obj["AllowedMachines"], obj["DataObjects"], \
                           datetime.datetime.fromtimestamp(obj["SignDate"]), response)
 
@@ -89,14 +99,24 @@ def load_from_string(rsa_pub_key, string):
         else:
             try:
                 pubKey = RSAPublicKey.from_string(rsa_pub_key)
-                if Helpers.verify_signature(response, pubKey):
+                if HelperMethods.verify_signature(response, pubKey):
                     return LicenseKey.from_response(response)
                 else:
                     return None
             except Exception:
                 return None
+            
+    def __load_activated_machines(obj):
+        
+        if obj == None:
+            return None
+        
+        arr = []
 
+        for item in obj:
+            arr.append(ActivatedMachine(**item))
 
+        return arr
 
 class Response:
 

setup.py

@@ -2,13 +2,13 @@
 setup(
   name = 'licensing',         # How you named your package folder (MyLib)
   packages = ['licensing'],   # Chose the same as "name"
-  version = '0.3',      # Start with a small number and increase it with every change you make
+  version = '0.4',      # Start with a small number and increase it with every change you make
   license='MIT',        # Chose a license from here: https://help.github.com/articles/licensing-a-repository
   description = 'Client library for Cryptolens licensing Web API.',   # Give a short description about your library
   author = 'Cryptolens AB',                   # Type in your name
   author_email = '[email protected]',      # Type in your E-Mail
   url = 'https://cryptolens.io',   # Provide either the link to your github or to your website
-  download_url = 'https://github.com/Cryptolens/cryptolens-python/archive/v_03.tar.gz',    # I explain this later on
+  download_url = 'https://github.com/Cryptolens/cryptolens-python/archive/v_04.tar.gz',    # I explain this later on
   keywords = ['software licensing', 'licensing library', 'cryptolens'],   # Keywords that define your package best
   install_requires=[            # I get to this in a second
           'pycrypto'

test.py

@@ -5,17 +5,16 @@
 @author: Artem Los
 """
 
-from licensing.internal import Helpers
-from licensing.models import Response, RSAPublicKey, LicenseKey
-from licensing.methods import Key
+from licensing.models import *
+from licensing.methods import Key, Helpers
 
 pubKey = "<RSAKeyValue><Modulus>sGbvxwdlDbqFXOMlVUnAF5ew0t0WpPW7rFpI5jHQOFkht/326dvh7t74RYeMpjy357NljouhpTLA3a6idnn4j6c3jmPWBkjZndGsPL4Bqm+fwE48nKpGPjkj4q/yzT4tHXBTyvaBjA8bVoCTnu+LiC4XEaLZRThGzIn5KQXKCigg6tQRy0GXE13XYFVz/x1mjFbT9/7dS8p85n8BuwlY5JvuBIQkKhuCNFfrUxBWyu87CFnXWjIupCD2VO/GbxaCvzrRjLZjAngLCMtZbYBALksqGPgTUN7ZM24XbPWyLtKPaXF2i4XRR9u6eTj5BfnLbKAU5PIVfjIS+vNYYogteQ==</Modulus><Exponent>AQAB</Exponent></RSAKeyValue>"
 
 res = Key.activate(token="WyIyNjA1IiwiTjhZQUpIYXJPaVdBV0ozQUlKVC9tamdDbFZDRzhZRHpaU243L2R2eCJd",\
                    rsa_pub_key=pubKey,\
-                   product_id=3349, key="ICVLD-VVSZR-ZTICT-YKGXL", machine_code="test")
+                   product_id=3349, key="ICVLD-VVSZR-ZTICT-YKGXL", machine_code=Helpers.GetMachineCode())
 
-if res[0] == None:
+if res[0] == None or not Helpers.IsOnRightMachine(res[0]):
     print("An error occured: {0}".format(res[1]))
 else:
     print("Success")
@@ -35,6 +34,11 @@
 with open('licensefile.skm', 'r') as f:
     license_key = LicenseKey.load_from_string(pubKey, f.read())
 
-    print("Feature 1: " + str(license_key.f1))
-    print("License expires: " + str(license_key.expires))
-    
+    if not Helpers.IsOnRightMachine(license_key):
+        print("NOTE: This license file does not belong to this machine.")
+    else:
+        print("Feature 1: " + str(license_key.f1))
+        print("License expires: " + str(license_key.expires))
+    
+print(Helpers.GetMachineCode())
+