4 | MindLake Tutorial: Python SDK
5 | 6 |7 | A step-by-step cookbook for beginner to access Mind Lake ! 8 |
9 |
4 | 7 | A step-by-step cookbook for beginner to access Mind Lake ! 8 |
9 |
4 | 7 | A step-by-step cookbook for Wallet Configuration to access Mind Lake ! 8 |
9 |
4 | 7 | A step-by-step cookbook for Python Configuration ! 8 |
9 | 10 | 11 | ## :star2: 0. Step by step tutorial 12 | This is part of support chapter for MindLake step-by-step tutorial for [Python](README.md) 13 | 14 | ## :star2: 1. Configure Python In Your Local Environment 15 | 16 | ### :notebook_with_decorative_cover: Table of Contents 17 | - [:star2: 0. Step by step tutorial](#star2-0-step-by-step-tutorial) 18 | - [:star2: 1. Configure Python In Your Local Environment](#star2-1-configure-python-in-your-local-environment) 19 | - [:notebook\_with\_decorative\_cover: Table of Contents](#notebook_with_decorative_cover-table-of-contents) 20 | - [:art: 1.1 For Mac OS](#art-11-for-mac-os) 21 | - [:dart: 1.1.1 Choice 1: Install Python with Official Installer](#dart-111-choice-1-install-python-with-official-installer) 22 | - [:gear: 1.1.1.1 Step1: Download the Official Installer](#gear-1111-step1-download-the-official-installer) 23 | - [:gear: 1.1.1.2 Step2: Run the Installer](#gear-1112-step2-run-the-installer) 24 | - [:gear: 1.1.1.3 Step3: Verify the Python Installation](#gear-1113-step3-verify-the-python-installation) 25 | - [:dart: 1.1.2 Choice 2: Install Python with HomeBrew](#dart-112-choice-2-install-python-with-homebrew) 26 | - [:gear: 1.1.2.1 Step1: Install HomeBrew (If you don't have Homebrew installed)](#gear-1121-step1-install-homebrew-if-you-dont-have-homebrew-installed) 27 | - [:gear: 1.1.2.2 Step2: Install Python](#gear-1122-step2-install-python) 28 | - [:gear: 1.1.2.3 Step3: Verify the Python Installation](#gear-1123-step3-verify-the-python-installation) 29 | - [:art: 1.2 For Windows](#art-12-for-windows) 30 | - [:dart: 1.2.1 Step1: Download the Official Installer](#dart-121-step1-download-the-official-installer) 31 | - [:dart: 1.2.2 Step2: Running the Executable Installer](#dart-122-step2-running-the-executable-installer) 32 | - [:dart: 1.2.3 Step3: Verify the Python Installation](#dart-123-step3-verify-the-python-installation) 33 | 34 | ### :art: 1.1 For Mac OS 35 | 36 | #### :dart: 1.1.1 Choice 1: Install Python with Official Installer 37 | ##### :gear: 1.1.1.1 Step1: Download the Official Installer 38 | Here is an example of Python installation with official installer, you can also choose other package management tools like HomeBrew or Conda. 39 | 1. Navigate to python.org, specifically to [Downloads > MacOS](https://www.python.org/downloads/macos/) and download the latest installation file. 40 | 2. Click on the latest stable release of Python link under the latest Python releases for macOS. The latest available version of Python as of this writing is 3.11.3 41 |  42 | 43 | 3. Now you'll be able to see the version-specific information. Scroll down on this page until you see a table with all available installation files. 44 | 4. Select and download the file that in the description says macOS under the operating system. 45 | 46 | ##### :gear: 1.1.1.2 Step2: Run the Installer 47 |  48 | To proceed with a default installation of Python, click the "Continue" button. Default option is recommended if you're new to Python and want to install it with standard features. Simply wait for the installation to complete and then click the "Close" button. 49 | 50 | ##### :gear: 1.1.1.3 Step3: Verify the Python Installation 51 | * Find and open "Terminal" or other shell terminal in LauchPad. 52 |  53 | * Enter the following command in terminal: 54 | ```shell 55 | python --version 56 | ``` 57 | An example of the output is: 58 | ``` 59 | Python 3.11.3 60 | ``` 61 | 62 | #### :dart: 1.1.2 Choice 2: Install Python with HomeBrew 63 | If you need to install Python from the command line on macOS, the Homebrew package manager is a reliable option. Follow the steps below to install Python via Homebrew: 64 | ##### :gear: 1.1.2.1 Step1: Install HomeBrew (If you don't have Homebrew installed) 65 | 1. Open a browser and go to https://brew.sh. 66 |  67 | 2. Under the "Install Homebrew" title, copy the command 68 | ```shell 69 | /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)" 70 | ``` 71 |  72 | 3. Then open a terminal window, paste the copied command, and press the 'Enter' or 'Return' button. 73 |  74 | 4. Enter your macOS credentials if and when asked. 75 | 5. If prompted, install Apple's command line developer tools. 76 | 6. If prompted, copy, paste and execute the command to add Homebrew to your shell profile file. 77 |  78 | 79 | ##### :gear: 1.1.2.2 Step2: Install Python 80 | 1. Enter the following command in terminal to upgrade Homebrew: 81 | ```shell 82 | brew update && brew upgrade 83 | ``` 84 | 2. Install Python using this command: 85 | ```shell 86 | brew install python3 87 | ``` 88 | 89 |  90 | 91 | 92 | ##### :gear: 1.1.2.3 Step3: Verify the Python Installation 93 | Enter the following command in terminal: 94 | ```shell 95 | python --version 96 | ``` 97 | An example of the output is: 98 | ``` 99 | Python 3.11.3 100 | ``` 101 | 102 | 103 | ### :art: 1.2 For Windows 104 | #### :dart: 1.2.1 Step1: Download the Official Installer 105 | Here is an example of Python installation with official installer, you can also choose other package management tools like Anaconda. 106 | 1. Go to the official Python download page for Windows. 107 | 2. Find a stable Python 3 release. This tutorial was tested with Python version 3.11.3. 108 | 3. Click the appropriate link for your system to download the executable file: Windows installer (64-bit) or Windows installer (32-bit). 109 | 110 | #### :dart: 1.2.2 Step2: Running the Executable Installer 111 | 1. After the installer is downloaded, double-click the .exe file, for example python-3.11.3-amd64.exe, to run the Python installer. 112 | 2. Select the __Add python.exe to PATH__ checkbox, which enables users to launch Python from the command line. 113 |  114 | 3. If you’re just getting started with Python and you want to install it with default features as described in the dialog, then click __Install Now__. 115 | 4. Simply wait for the installation to complete and then click the __Close__ button. 116 |  117 | 118 | #### :dart: 1.2.3 Step3: Verify the Python Installation 119 | Press __Win(⊞) + r__ in keyboard and enter `cmd` to open the command prompt. 120 |  121 | Enter the following command in the command prompt: 122 | ```cmd 123 | python --version 124 | ``` 125 | An example of the output is: 126 | ``` 127 | Python 3.11.3 128 | ``` 129 | -------------------------------------------------------------------------------- /tests/test_link.py: -------------------------------------------------------------------------------- 1 | from test_base import * 2 | 3 | import test_base 4 | import mindlakesdk 5 | 6 | 7 | import logging 8 | setLogging(logging.INFO) 9 | # setLogging(logging.DEBUG) 10 | 11 | import env 12 | #logging.warning('walletPrivateKey = %s'%env.walletPrivateKey) 13 | 14 | print("============= start test ============") 15 | 16 | 17 | print("============= link encrypted table ============") 18 | def test_link_table_to_mywalletcocoon_alice_encrypted(mindlake: MindLake): 19 | print_test_functions() 20 | 21 | tableNameAlice = 'test_table_encrypted_Alice' 22 | test_base.drop_test_table(mindlake, tableNameAlice) 23 | test_base.create_test_table_encrypted(mindlake, tableNameAlice) 24 | data = { 25 | 'int4': 123, 26 | 'int8': 1234567890, 27 | 'float4': 1.2345678901234567890, 28 | 'float8': 1.2345678901234567890, 29 | 'decimal': 12345678901234567890, 30 | 'text': 'Hello', 31 | 'timestamp': datetime.datetime.now() 32 | } 33 | q = test_base.insert_test_table_encrypted(mindlake, tableNameAlice, data) 34 | 35 | cocoonName = "test_cocoon_alice_encrypted" 36 | test_base.create_test_cocoon(mindlake, cocoonName) 37 | code = test_base.link_table_to_cocoon_test(mindlake, tableNameAlice, cocoonName) 38 | assert code == 0, "alice can not link her table to her cocoon !" 39 | 40 | def test_link_table_to_otherwalletcocoon_bob_encrypted(mindlake: MindLake): 41 | print_test_functions() 42 | 43 | tableNameAlice = 'test_table_encrypted_Alice' 44 | cocoonName = "test_cocoon_bob_encrypted" 45 | test_base.create_test_cocoon(mindlake, cocoonName) 46 | code = test_base.link_table_to_cocoon_test(mindlake, tableNameAlice, cocoonName) 47 | assert code != 0, "bob can link alice's table to his cocoon !" 48 | # also need to check error code 49 | 50 | 51 | 52 | 53 | print("============= link nonencrypted table ============") 54 | def test_link_table_to_mywalletcocoon_alice_nonencrypted(mindlake: MindLake): 55 | print_test_functions() 56 | 57 | tableNameAlice = 'test_table_nonencrypted_Alice' 58 | test_base.drop_test_table(mindlake, tableNameAlice) 59 | test_base.create_test_table_nonencrypted(mindlake, tableNameAlice) 60 | test_base.insert_test_table_nonencrypted(mindlake, tableNameAlice) 61 | 62 | cocoonName = "test_cocoon_alice_nonencrypted" 63 | test_base.create_test_cocoon(mindlake, cocoonName) 64 | code = test_base.link_table_to_cocoon_test(mindlake, tableNameAlice, cocoonName) 65 | assert code == 0, "alice can not link her table to her cocoon !" 66 | 67 | def test_link_table_to_otherwalletcocoon_bob_nonencrypted(mindlake: MindLake): 68 | print_test_functions() 69 | 70 | tableNameAlice = 'test_table_nonencrypted_Alice' 71 | cocoonName = "test_cocoon_bob_nonencrypted" 72 | test_base.create_test_cocoon(mindlake, cocoonName) 73 | code = test_base.link_table_to_cocoon_test(mindlake, tableNameAlice, cocoonName) 74 | assert code != 0, "bob can link alice's table to his cocoon !" 75 | # also need to check error code 76 | 77 | 78 | 79 | print("============= link nonencrypted table ============") 80 | def test_unique_link(mindlake: MindLake): 81 | print_test_functions() 82 | 83 | cocoonName1 = "test_cocoon_alice_nonencrypted" 84 | result = mindlake.datalake.listTablesByCocoon(cocoonName1) 85 | logging.warning('listTablesByCocoon: %s %s %s'%(cocoonName1, result.code, result.message)) 86 | tables = result.data 87 | logging.debug(tables) 88 | tableNameAlice1 = 'test_table_nonencrypted_Alice' 89 | assert tableNameAlice1 in tables, 'table should be linked to cocoon !' 90 | 91 | cocoonName2 = "test_cocoon_alice_encrypted" 92 | result = mindlake.datalake.listTablesByCocoon(cocoonName2) 93 | logging.warning('listTablesByCocoon: %s %s %s'%(cocoonName2, result.code, result.message)) 94 | tables = result.data 95 | logging.debug(tables) 96 | tableNameAlice2 = 'test_table_encrypted_Alice' 97 | assert tableNameAlice2 in tables, 'table should be linked to cocoon !' 98 | 99 | code = test_base.link_table_to_cocoon_test(mindlake, tableNameAlice1, cocoonName2) 100 | cocoonName2 = "test_cocoon_alice_encrypted" 101 | result = mindlake.datalake.listTablesByCocoon(cocoonName2) 102 | logging.warning('listTablesByCocoon: %s %s %s'%(cocoonName2, result.code, result.message)) 103 | tables = result.data 104 | tableNameAlice1 = 'test_table_encrypted_Alice' 105 | assert tableNameAlice1 in tables, 'table should be linked to other cocoon !' 106 | 107 | cocoonName1 = "test_cocoon_alice_nonencrypted" 108 | result = mindlake.datalake.listTablesByCocoon(cocoonName1) 109 | logging.warning('listTablesByCocoon: %s %s %s'%(cocoonName1, result.code, result.message)) 110 | tables = result.data 111 | tableNameAlice1 = 'test_table_nonencrypted_Alice' 112 | assert tableNameAlice1 not in tables, 'table should be linked to other cocoon and not exist in previous cocoon!' 113 | 114 | 115 | print("============= link non-existing table ============") 116 | def test_link_nonexist_table(mindlake: MindLake): 117 | print_test_functions() 118 | 119 | tableName = 'test_table_nonencrypted_nobody' 120 | cocoonName = "test_cocoon_alice_encrypted" 121 | 122 | code = test_base.link_table_to_cocoon_test(mindlake, tableName, cocoonName) 123 | 124 | assert code != 0, "non exist table can not be linked !" 125 | 126 | 127 | print("============= link non-existing cocoon ============") 128 | def test_link_nonexist_cocoon(mindlake: MindLake): 129 | print_test_functions() 130 | 131 | tableName = 'test_cocoon_alice_encrypted' 132 | cocoonName = "test_cocoon_nobody_encrypted" 133 | 134 | code = test_base.link_table_to_cocoon_test(mindlake, tableName, cocoonName) 135 | 136 | assert code != 0, "non exist cocoon can not be linked !" 137 | 138 | 139 | 140 | print("============= complete 4 ============") 141 | def cases(walletPrivateKeyAlice, walletPrivateKeyBob, walletAddressAlice, walletAddressBob, appKey, GATEWAY): 142 | logging.info("==== start test | %s ===="%(__file__)) 143 | mindlakeAlice = mindlakesdk.connect(walletPrivateKeyAlice, appKey, GATEWAY) 144 | mindlakeBob = mindlakesdk.connect(walletPrivateKeyBob, appKey, GATEWAY) 145 | test_base.drop_all_cocoon_and_table(mindlakeAlice) 146 | test_base.drop_all_cocoon_and_table(mindlakeBob) 147 | 148 | test_link_table_to_mywalletcocoon_alice_encrypted(mindlakeAlice) 149 | test_link_table_to_mywalletcocoon_alice_nonencrypted(mindlakeAlice) 150 | 151 | test_link_table_to_otherwalletcocoon_bob_nonencrypted(mindlakeBob) 152 | test_link_table_to_otherwalletcocoon_bob_encrypted(mindlakeBob) 153 | 154 | test_unique_link(mindlakeAlice) 155 | 156 | test_link_nonexist_table(mindlakeAlice) 157 | test_link_nonexist_cocoon(mindlakeAlice) 158 | logging.info("==== complete test | %s ====\n\n"%(__file__)) 159 | 160 | if __name__ == "__main__": 161 | cases(env.walletPrivateKeyAlice, env.walletPrivateKeyBob, env.walletAddressAlice, env.walletAddressBob, env.appKey, env.GATEWAY) 162 | 163 | -------------------------------------------------------------------------------- /mindlakesdk/permission.py: -------------------------------------------------------------------------------- 1 | import base64 2 | import datetime 3 | import json 4 | import logging 5 | import uuid 6 | 7 | from mindlakesdk.utils import ResultType, Session 8 | import mindlakesdk.utils 9 | import mindlakesdk.message 10 | 11 | class Permission: 12 | def __init__(self, session: Session): 13 | self.__session = session 14 | 15 | def grant(self, targetWalletAddress: str, columns: list, targetChainID: str = None) -> ResultType: 16 | session = self.__session 17 | if not targetChainID: 18 | targetChainID = session.chainID 19 | result = mindlakesdk.message.getPKidByWalletAddress(session, targetWalletAddress, targetChainID) 20 | if not result: 21 | return result 22 | targetPKID = result.data["publicKeyId"] 23 | logging.debug("Get PK ID from wallet address: " + targetWalletAddress + ' - ' + targetPKID) 24 | policy = { 25 | 'issuer_dek_group': [], 26 | 'subject_dek_group': [] 27 | } 28 | for column in columns: 29 | tableName, columnName = column.split('.') 30 | result = mindlakesdk.message.getDKbyName(session, session.walletAddress, tableName, columnName) 31 | if not result: 32 | return result 33 | groupID = result.data['groupId'] 34 | policy['issuer_dek_group'].append({ 35 | 'groupid': groupID, 36 | 'min': 1, 37 | 'max': 1000 38 | }) 39 | result = self.__createPolicyBody(self.__session.pkID, targetPKID, policy) 40 | if not result: 41 | return result 42 | policyBodyJson = result.data 43 | signature = self.__signPolicy(policyBodyJson) 44 | signatureB64 = base64.b64encode(signature).decode('utf-8') 45 | return mindlakesdk.message.sendGrant(self.__session, policyBodyJson, signatureB64) 46 | 47 | def confirm(self, policyID: str) -> ResultType: 48 | result = mindlakesdk.message.getPolicyBySerialNumber(self.__session, policyID) 49 | if not result: 50 | return result 51 | policyBodyJson = result.data 52 | policyBody = json.loads(policyBodyJson) 53 | if policyBody['subject_pukid'] != self.__session.pkID: 54 | logging.debug("Self pukid: " + self.__session.pkID) 55 | logging.debug("Policy pukid: " + policyBody['subject_pukid']) 56 | return mindlakesdk.utils.ResultType(60002, "The policy is not for you") 57 | signature = self.__signPolicy(policyBodyJson) 58 | signatureB64 = base64.b64encode(signature).decode('utf-8') 59 | return mindlakesdk.message.sendConfirm(self.__session, policyBodyJson, signatureB64) 60 | 61 | def revoke(self, targetWalletAddress: str, targetChainID: str = None) -> ResultType: 62 | return self.grant(targetWalletAddress, [], targetChainID) 63 | 64 | def grantToSelf(self): 65 | result = mindlakesdk.message.getDKbyName(self.__session) 66 | if not result: 67 | return result 68 | groupID = result.data['groupId'] 69 | policy = { 70 | 'issuer_dek_group': [{ 71 | 'groupid': groupID, 72 | 'min': 1, 73 | 'max': 1000 74 | }], 75 | 'subject_dek_group': [{ 76 | 'groupid': groupID, 77 | 'min': 1, 78 | 'max': 1000 79 | }] 80 | } 81 | result = self.__createPolicyBody(self.__session.pkID, 82 | self.__session.pkID, 83 | policy) 84 | if not result: 85 | return result 86 | policyBodyJson = result.data 87 | signature = self.__signPolicy(policyBodyJson) 88 | signatureB64 = base64.b64encode(signature).decode('utf-8') 89 | return mindlakesdk.message.sendSelfGrant(self.__session, policyBodyJson, signatureB64) 90 | 91 | def __createPolicyBody(self, 92 | issuerPukid, 93 | subjectPukid, 94 | policy, 95 | version = 1, 96 | serialNum = None, 97 | notBefore = None, 98 | notAfter = None, 99 | resultDK = "SUBJECT", 100 | operation = ['*'], 101 | postProc = "NULL", 102 | preProc = "NULL") -> ResultType: 103 | result = mindlakesdk.message.getPolicyByPKid(self.__session, issuerPukid, subjectPukid) 104 | if not result: 105 | return result 106 | policyBodyJson = result.data 107 | if policyBodyJson: 108 | logging.debug("Policy already exists, loading existing Policy") 109 | policyBody = json.loads(policyBodyJson) 110 | else: 111 | if not serialNum: 112 | serialNum = str(uuid.uuid4()) 113 | if not notBefore: 114 | notBefore = datetime.datetime.now() 115 | if not notAfter: 116 | notAfter = datetime.datetime.now() + datetime.timedelta(days=365) 117 | policyBody = {} 118 | policyBody['version'] = version 119 | policyBody['serial_num'] = serialNum 120 | policyBody['issuer_pukid'] = issuerPukid 121 | policyBody['subject_pukid'] = subjectPukid 122 | policyBody['validity'] = {} 123 | policyBody['validity']['not_after'] = notAfter.astimezone().strftime('%Y%m%d%H%M%S%z') 124 | policyBody['validity']['not_before'] = notBefore.astimezone().strftime('%Y%m%d%H%M%S%z') 125 | policyBody['policies'] = {} 126 | policyBody['policies']['operation'] = operation 127 | policyBody['policies']['post_proc'] = postProc 128 | policyBody['policies']['pre_proc'] = preProc 129 | policyBody['policies']['result_dek'] = resultDK 130 | policyBody['policies'].update(policy) 131 | policyBodyJson = json.dumps(policyBody) 132 | return ResultType(0, "Success", policyBodyJson) 133 | 134 | def __signPolicy(self, policyBodyJson) -> bytes: 135 | toBeSignedBytes = policyBodyJson.encode('utf-8') 136 | signature = mindlakesdk.utils.rsaSign(self.__session.sk, toBeSignedBytes) 137 | return b'\x01' + signature 138 | 139 | def listGrantee(self) -> ResultType: 140 | return mindlakesdk.message.sendListGrantee(self.__session) 141 | 142 | def listGrantedColumn(self, walletAddress: str, targetChainID: str = None) -> ResultType: 143 | if not targetChainID: 144 | targetChainID = self.__session.chainID 145 | return mindlakesdk.message.sendListGrantedColumn(self.__session, walletAddress, targetChainID) 146 | 147 | def listOwner(self) -> ResultType: 148 | return mindlakesdk.message.sendListOwner(self.__session) 149 | 150 | def listOwnerColumn(self, walletAddress: str, targetChainID: str = None) -> ResultType: 151 | if not targetChainID: 152 | targetChainID = self.__session.chainID 153 | return mindlakesdk.message.sendListOwnerColumn(self.__session, walletAddress, targetChainID) 154 | -------------------------------------------------------------------------------- /tests/test_sharing.py: -------------------------------------------------------------------------------- 1 | from test_base import * 2 | 3 | import datetime 4 | import pprint 5 | import test_base 6 | # test_base.drop_all_cocoon_and_table(env.walletPrivateKey) 7 | import mindlakesdk 8 | 9 | import logging 10 | setLogging(logging.INFO) 11 | # setLogging(logging.DEBUG) 12 | 13 | import env 14 | #logging.warning('walletPrivateKey = %s'%env.walletPrivateKey) 15 | 16 | print("============= start test ============") 17 | 18 | def prepare_test(mindlake: MindLake): 19 | tableName = 'test_table_encrypted_1' 20 | test_base.drop_test_table(mindlake, tableName) 21 | test_base.create_test_table_encrypted(mindlake, tableName) 22 | 23 | # by now, I should have at least one table and one cocoon, and table link to cocoon 24 | print("============= test preparation completed ============") 25 | 26 | def test_insert_encrypted_data(mindlake: MindLake, data): 27 | tableName = 'test_table_encrypted_1' 28 | encryptedData = {} 29 | for k, v in data.items(): 30 | print(f"===== encrypt {k} in column =====") 31 | currentColumn = 'data' + k 32 | q = mindlake.cryptor.encrypt(v, f'{tableName}.{currentColumn}') 33 | print('Code: ', q.code, q.message, f'encrypt {k}') 34 | assert q and isinstance(q.data, str) and q.data[:2] == '\\x', 'encryption test failed !' 35 | encryptedData[currentColumn] = q.data 36 | 37 | sql = f"""INSERT INTO "{tableName}" 38 | VALUES ( 39 | '{encryptedData['dataint4']}', 40 | '{encryptedData['dataint8']}', 41 | '{encryptedData['datafloat4']}', 42 | '{encryptedData['datafloat8']}', 43 | '{encryptedData['datadecimal']}', 44 | '{encryptedData['datatext']}', 45 | '{encryptedData['datatimestamp']}') RETURNING *""" 46 | print(sql) 47 | q = mindlake.datalake.query(sql) 48 | print('Code: ', q.code, q.message, 'INSERT') 49 | assert q, 'encryption test failed !' 50 | # logging.debug(q.data) 51 | 52 | def test_query_decrypt_shared(mindlake: MindLake, ownerWalletAddress, data, grantColumn): 53 | tableName = 'test_table_encrypted_1' 54 | 55 | print("===== select * =====") 56 | queryResult = mindlake.datalake.query(f'SELECT * FROM "{ownerWalletAddress[2:].lower()}"."{tableName}"') 57 | print('Code: ', queryResult.code, queryResult.message, 'SELECT') 58 | # logging.debug(queryResult.data) 59 | count_select_all = len(queryResult.data['data']) 60 | assert queryResult and count_select_all == 2, 'decryption test failed !' 61 | row = queryResult.data['data'][1] 62 | columnList = queryResult.data['columnList'] 63 | for i, cell in enumerate(row): 64 | print(f"===== decrypt column num {i} {columnList[i]} ===== {cell}") 65 | q = mindlake.cryptor.decrypt(cell) 66 | print('Code: ', q.code, q.message, 'DECRYPT ', columnList[i]) 67 | print('Decrypted: Column', i, columnList[i], q.data) 68 | print('Origin:', data[columnList[i][4:]]) 69 | if columnList[i] == 'datafloat4' or columnList[i] == 'datafloat8': 70 | if columnList[i][4:] in grantColumn: 71 | assert q and abs(q.data - data[columnList[i][4:]]) < 0.01, 'decryption test failed !' 72 | else: 73 | assert q.code == 60003, 'decryption test failed !' 74 | else: 75 | if columnList[i][4:] in grantColumn: 76 | assert q and q.data == data[columnList[i][4:]], 'decryption test failed !' 77 | else: 78 | assert q.code == 60003, 'decryption test failed !' 79 | 80 | def test_share_column(mindlake: MindLake, granteeWalletAddress, grantColumn): 81 | tableName = 'test_table_encrypted_1' 82 | print(f"===== share column {' '.join(grantColumn)} =====") 83 | q = mindlake.permission.grant(granteeWalletAddress, [tableName + '.data' + column for column in grantColumn]) 84 | print('Code: ', q.code, q.message, 'SHARE COLUMN') 85 | print('serialNum: ', q.data) 86 | assert q, 'share column failed !' 87 | return q.data 88 | 89 | def test_confirm_share(mindlake: MindLake, serialNum): 90 | print(f"===== confirm share {serialNum} =====") 91 | q = mindlake.permission.confirm(serialNum) 92 | print('Code: ', q.code, q.message, 'CONFIRM SHARE') 93 | assert q, 'confirm share failed !' 94 | 95 | def test_revoke_share(mindlake: MindLake, granteeWalletAddress): 96 | print(f"===== revoke share =====") 97 | q = mindlake.permission.revoke(granteeWalletAddress) 98 | print('Code: ', q.code, q.message, 'REVOKE SHARE') 99 | assert q.code == 0, 'revoke share failed !' 100 | 101 | 102 | def test_share_to_nobody(mindlake:MindLake, grantColumn, walletAddressNobody): 103 | tableName = 'test_table_encrypted_1' 104 | print(f"===== share column {' '.join(grantColumn)} =====") 105 | q = mindlake.permission.grant(walletAddressNobody, [tableName + '.data' + column for column in grantColumn]) 106 | print('Code: ', q.code, q.message, 'SHARE COLUMN') 107 | print('serialNum: ', q.data) 108 | assert q.code == 0, 'can not share to nobody !' 109 | return q.data 110 | 111 | 112 | def test_list_guarantee(): 113 | pass 114 | 115 | def cases(walletPrivateKeyAlice, walletPrivateKeyBob, walletAddressAlice, walletAddressBob, appKey, GATEWAY): 116 | logging.info("==== start test | %s ===="%(__file__)) 117 | 118 | mindlakeAlice = mindlakesdk.connect(walletPrivateKeyAlice, appKey, GATEWAY) 119 | assert mindlakeAlice, 'connect failed !' 120 | mindlakeBob = mindlakesdk.connect(walletPrivateKeyBob, appKey, GATEWAY) 121 | assert mindlakeBob, mindlakeBob.message 122 | test_base.drop_all_cocoon_and_table(mindlakeAlice) 123 | prepare_test(mindlakeAlice) 124 | data = { 125 | 'int4': 123, 126 | 'int8': 1234567890, 127 | 'float4': 1.2345678901234567890, 128 | 'float8': 1.2345678901234567890, 129 | 'decimal': 12345678901234567890, 130 | 'text': 'Hello', 131 | 'timestamp': datetime.datetime.now() 132 | } 133 | test_insert_encrypted_data(mindlakeAlice, data) 134 | test_insert_encrypted_data(mindlakeAlice, data) 135 | r = mindlakeAlice.permission.revoke(walletAddressBob) 136 | assert r, r.message 137 | print("No permission granted. Attemp to decrypt all columns") 138 | test_query_decrypt_shared(mindlakeBob, walletAddressAlice, data, []) 139 | print("============= complete 1 ============") 140 | 141 | grantColumn = ['int4'] 142 | serialNum = test_share_column(mindlakeAlice, walletAddressBob, grantColumn) 143 | test_confirm_share(mindlakeBob, serialNum) 144 | print(f"Permission of {' '.join(grantColumn)} granted. Attemp to decrypt all columns") 145 | test_query_decrypt_shared(mindlakeBob, walletAddressAlice, data, grantColumn) 146 | print("============= complete 2 ============") 147 | 148 | grantColumn = ['int8', 'float4', 'float8'] 149 | serialNum = test_share_column(mindlakeAlice, walletAddressBob, grantColumn) 150 | print(f"Permission of {' '.join(grantColumn)} granted. Attemp to decrypt all columns") 151 | test_confirm_share(mindlakeBob, serialNum) 152 | test_query_decrypt_shared(mindlakeBob, walletAddressAlice, data, grantColumn) 153 | print("============= complete 3 ============") 154 | 155 | test_revoke_share(mindlakeAlice, walletAddressBob) 156 | print(f"Revoke all permission. Attemp to decrypt all columns") 157 | test_query_decrypt_shared(mindlakeBob, walletAddressAlice, data, []) 158 | print("============= complete 4 ============") 159 | 160 | logging.info("==== complete test | %s ====\n\n"%(__file__)) 161 | 162 | if __name__ == "__main__": 163 | cases(env.walletPrivateKeyAlice, env.walletPrivateKeyBob, env.walletAddressAlice, env.walletAddressBob, env.appKey, env.GATEWAY) -------------------------------------------------------------------------------- /mindlakesdk/message.py: -------------------------------------------------------------------------------- 1 | from mindlakesdk.utils import ResultType, request, Session 2 | import logging 3 | 4 | def getNounce(session: Session): 5 | data = {"bizType":203} 6 | result = request(data, session) 7 | if result: 8 | return ResultType(result["code"], result["message"], result["data"]) 9 | else: 10 | return ResultType(60001, "Network error", None) 11 | 12 | 13 | def sendLogin(session: Session, signatureHex): 14 | data = {"bizType":201,"walletAddress":session.walletAddress,"signature":signatureHex} 15 | result = request(data, session) 16 | if result: 17 | if result["code"] == 0: 18 | # TODO: add exception handling 19 | session.isLogin = True 20 | session.token = result["data"]["token"] 21 | return ResultType(result["code"], result["message"], result["data"]) 22 | else: 23 | return ResultType(60001, "Network error", None) 24 | 25 | def getChainInfo(session: Session): 26 | data = {"bizType":205} 27 | result = request(data, session) 28 | if result: 29 | return ResultType(result["code"], result["message"], result["data"]) 30 | else: 31 | return ResultType(60001, "Network error", None) 32 | 33 | def getAccountInfo(session: Session): 34 | data = {"bizType":120} 35 | result = __requestCommon(session, data) 36 | if result: 37 | session.isRegistered = result.data["isRegistered"] and result.data["isMekProvision"] and result.data["isSelfBcl"] 38 | session.accountID = int(result.data["mekId"]) 39 | session.nodePK = result.data["publicKey"] 40 | return result 41 | 42 | def getPKid(session: Session): 43 | data = {"bizType":103,"mekId":session.accountID} 44 | result = __requestCommon(session, data) 45 | if result: 46 | session.pkID = result.data 47 | return result 48 | 49 | def sendMKRegister(session: Session, envelope): 50 | data = {"bizType":102, "envelope":envelope, "databasePublicKey":session.nodePK} 51 | return __requestCommon(session, data) 52 | 53 | def sendPKRegister(session: Session, pkIDStr, publicKey, rsaSigStr, mkSigStr): 54 | data = { 55 | "bizType":104, 56 | "mekId":session.accountID, 57 | "pukId":pkIDStr, 58 | "publicKey":publicKey, 59 | "privateSig":rsaSigStr, 60 | "mekSig":mkSigStr 61 | } 62 | return __requestCommon(session, data) 63 | 64 | def getDKbyName(session: Session, walletAddress: str = None, 65 | table: str = None, column: str = None) -> ResultType: 66 | data = {"bizType":108, "walletAddress":walletAddress, "table":table, "column":column} 67 | return __requestCommon(session, data) 68 | 69 | def getNextDKid(session: Session) -> ResultType: 70 | data = {"bizType":109, "mekId":session.accountID} 71 | return __requestCommon(session, data) 72 | 73 | def getDKbyCid(session: Session, cid: int) -> ResultType: 74 | data = {"bizType":111, "ctxId":cid} 75 | return __requestCommon(session, data) 76 | 77 | def sendDKRegister(session: Session, table, column, dkID, dkCipherStr, grpIDStr, gAuthStr) -> ResultType: 78 | data = { 79 | "bizType":110, 80 | "mekId":session.accountID, 81 | "table":table, 82 | "column":column, 83 | "dekId":dkID, 84 | "dekCipherStr":dkCipherStr, 85 | "grpIdStr":grpIDStr, 86 | "groupAuthStr":gAuthStr 87 | } 88 | return __requestCommon(session, data) 89 | 90 | def getDataTypeByName(session: Session, tableName: str, columnName: str) -> ResultType: 91 | data = {"bizType":107, "tableName":tableName, "column":columnName} 92 | return __requestCommon(session, data) 93 | 94 | def getPolicyByPKid(session: Session, issuePKid: str, subjectPKid: str) -> ResultType: 95 | data = {"bizType":118, "issuePukId":issuePKid, "subjectPukId":subjectPKid} 96 | return __requestCommon(session, data) 97 | 98 | def getPolicyBySerialNumber(session: Session, serialNumber: str) -> ResultType: 99 | data = {"bizType":116, "serialNum":serialNumber} 100 | return __requestCommon(session, data) 101 | 102 | def getPKidByWalletAddress(session: Session, walletAddress: str, targetChainID: str) -> ResultType: 103 | data = {"bizType":119, "targetWalletAddress":walletAddress, "targetChain":targetChainID} 104 | return __requestCommon(session, data) 105 | 106 | def sendGrant(session: Session, policyBodyJson: str, signature: str) -> ResultType: 107 | data = {"bizType":115, "bclBody":policyBodyJson, "privateSig":signature} 108 | return __requestCommon(session, data) 109 | 110 | def sendConfirm(session: Session, policyBodyJson: str, signature: str) -> ResultType: 111 | data = {"bizType":117, "bclBody":policyBodyJson, "privateSig":signature} 112 | return __requestCommon(session, data) 113 | 114 | def sendSelfGrant(session: Session, policyBodyJson: str, signature: str) -> ResultType: 115 | data = {"bizType":106, "bclBody":policyBodyJson, "privateSig":signature} 116 | return __requestCommon(session, data) 117 | 118 | def sendCreateTable(session: Session, tableName: str, columns: list, primaryKey: list = None) -> ResultType: 119 | data = {"bizType":123, "tableName":tableName, "columns":columns, "pkColumns":primaryKey} 120 | return __requestCommon(session, data) 121 | 122 | def sendListCocoon(session: Session) -> ResultType: 123 | data = {"bizType":122} 124 | return __requestCommon(session, data) 125 | 126 | def sendListTablesByCocoon(session: Session, cocoonName: str) -> ResultType: 127 | data = {"bizType":125, 'cocoonName': cocoonName} 128 | return __requestCommon(session, data) 129 | 130 | def sendLinkTableToCocoon(session: Session, tableName: str, cocoonName: str) -> ResultType: 131 | data = {"bizType":124, 'tableName': tableName, 'cocoonName': cocoonName} 132 | return __requestCommon(session, data) 133 | 134 | def sendCreateCocoon(session: Session, cocoonName: str) -> ResultType: 135 | data = {"bizType":121, 'cocoonName': cocoonName} 136 | return __requestCommon(session, data) 137 | 138 | def sendQuery(session: Session, executeSql) -> ResultType: 139 | data = {"bizType":114, 'executeSql': executeSql} 140 | return __requestCommon(session, data) 141 | 142 | def sendQueryForDataAndMeta(session: Session, executeSql) -> ResultType: 143 | data = {"bizType":113, 'executeSql': executeSql} 144 | return __requestCommon(session, data) 145 | 146 | def sendDropCocoon(session: Session, cocoonName: str) -> ResultType: 147 | data = {"bizType":129, 'cocoonName': cocoonName} 148 | return __requestCommon(session, data) 149 | 150 | def sendDropTable(session: Session, tableName: str) -> ResultType: 151 | data = {"bizType":128, 'tableName': tableName} 152 | return __requestCommon(session, data) 153 | 154 | def sendListGrantee(session: Session) -> ResultType: 155 | data = {"bizType":126} 156 | return __requestCommon(session, data) 157 | 158 | def sendListGrantedColumn(session: Session, targetWalletAddress: str, targetChainID: str) -> ResultType: 159 | data = {"bizType":127, 'targetWalletAddress': targetWalletAddress, 'targetChain': targetChainID} 160 | return __requestCommon(session, data) 161 | 162 | def sendListOwner(session: Session) -> ResultType: 163 | data = {"bizType":130} 164 | return __requestCommon(session, data) 165 | 166 | def sendListOwnerColumn(session: Session, targetWalletAddress: str, targetChainID: str) -> ResultType: 167 | data = {"bizType":131, 'targetWalletAddress': targetWalletAddress, 'targetChain': targetChainID} 168 | return __requestCommon(session, data) 169 | 170 | def __requestCommon(session: Session, data: str) -> ResultType: 171 | if session.isLogin: 172 | result = request(data, session) 173 | if result: 174 | return ResultType(result["code"], result["message"], result["data"]) 175 | else: 176 | return ResultType(60001, "Network error", None) 177 | else: 178 | return ResultType(40001, "Not logged in", None) -------------------------------------------------------------------------------- /mindlakesdk/cryptor.py: -------------------------------------------------------------------------------- 1 | import datetime 2 | from decimal import Decimal 3 | import struct 4 | from enum import Enum 5 | from Crypto.Random import get_random_bytes 6 | from mindlakesdk.utils import ResultType, Session, DataType 7 | import mindlakesdk.message 8 | import mindlakesdk.keyhelper 9 | import mindlakesdk.utils 10 | 11 | class Cryptor: 12 | 13 | class EncType(Enum): 14 | enc_int4 = 1 15 | enc_int8 = 2 16 | enc_float4 = 3 17 | enc_float8 = 4 18 | enc_decimal = 6 19 | enc_text = 7 20 | enc_timestamp = 8 21 | 22 | def __init__(self, session: Session): 23 | self.__session = session 24 | self.cryptParamsByColumn = {} 25 | self.cryptParamsByID = {} 26 | 27 | def encrypt(self, data, columnOrType) -> ResultType: 28 | result = self.__getEncryptParams(columnOrType) 29 | if not result: 30 | return result 31 | ctxid, encTypeNum, dk, alg, dataType = result.data 32 | data = Cryptor.__encodeByDataType(data, dataType) 33 | header = Cryptor.__genCryptoHeader(ctxid, encTypeNum) 34 | checkCode = Cryptor.__genCheckCode(data, 1) 35 | data_to_enc = data + checkCode 36 | if alg == 3: 37 | iv = get_random_bytes(16) 38 | encrypted_data = mindlakesdk.utils.aesEncrypt(dk, iv, data_to_enc) 39 | elif alg == 0: 40 | iv = get_random_bytes(12) 41 | encrypted_data = mindlakesdk.utils.aesGCMEncrypt(dk, iv, data_to_enc) 42 | buf = header + iv + encrypted_data 43 | tmp = buf[1:] 44 | checkCode2 = Cryptor.__genCheckCode(tmp, 1) 45 | result = checkCode2 + tmp 46 | resultHex = '\\x' + result.hex() 47 | return ResultType(0, None, resultHex) 48 | 49 | def __getEncryptParams(self, columnOrType): 50 | result = self.cryptParamsByColumn.get(columnOrType) 51 | if not result: 52 | if isinstance(columnOrType, DataType): 53 | dataType = columnOrType 54 | result = mindlakesdk.message.getDKbyName(self.__session) 55 | if not result: 56 | return result 57 | else: 58 | tableName, columnName = columnOrType.split('.') 59 | result = mindlakesdk.message.getDataTypeByName(self.__session, tableName, columnName) 60 | if not result: 61 | return result 62 | dataType = DataType(result.data) 63 | result = mindlakesdk.message.getDKbyName(self.__session, self.__session.walletAddress, tableName, columnName) 64 | # Temporary solution for MS not returning Error Code 65 | if result.code == 40010: 66 | # DK not found, create one 67 | result = mindlakesdk.keyhelper.genDK(self.__session, tableName, columnName) 68 | if not result: 69 | return result 70 | elif not result: 71 | return result 72 | else: 73 | pass 74 | encTypeNum = Cryptor.EncType['enc_' + dataType.name].value 75 | ctxid = result.data['ctxId'] 76 | dkCipher = result.data['encryptedDek'] 77 | dkID, dk = mindlakesdk.keyhelper.decryptDKb64(self.__session.mk, dkCipher) 78 | alg = result.data['algorithm'] 79 | result = (ctxid, encTypeNum, dk, alg, dataType) 80 | self.cryptParamsByColumn[columnOrType] = result 81 | self.cryptParamsByID[ctxid] = (dk, alg) 82 | return ResultType(0, None, result) 83 | 84 | 85 | def __encodeByDataType(data, dataType: DataType) -> bytes: 86 | if dataType == DataType.int4: 87 | result = struct.pack("