Knox ML Encryption Tool

Installation

1. Log in to Knox Developer Dashboard > Download.

2. Download one of the following:

   • Knox ML encryption tool — Linux

     Supported OS version — Ubuntu 20.04

   • Knox ML encryption tool — Windows

     Supported OS version — Windows 10

3. Run the executable. On Linux, follow below steps to run the Knox ML Encryption Tool:

   1. Unzip KnoxMLEncryptionToolLinuxV1.2.zip.

   2. Change the permission and run the setup.

      > chmod 777 setup.sh
      > sudo./setup.sh
      

   3. Run the Tool from Desktop icon.

UI parameters

To generate the encrypted neural model package, following inputs from the user are required:

Supported software packages

Following are the software packages and its versions supported by Knox ML Encryption 1.2 tool.

Encrypt files

To encrypt your ML model, open the Knox ML Encryption Tool on your computer and do as follows depending on the tool’s version. To see which version you can use depending on device, refer to Knox ML Encryption Tool Revision.

Model Encryption Tool V1.1 steps

1. Click Get Started.

2. (Optional) click Settings icon and select the path where you want to save the encrypted model.

3. Click Utility option next to Settings icon. Browse and select the certificate file used to sign the APK and click Generate Hash.

4. Click Copy Hash and add it to the Allowed Apps List along side of the package name for the App.

5. Return to Encrypt Screen and add plain ML Model file and its package version.

6. Enter Model Package version and add Allowed_Apps List under Set Model Policy section. Refer to Template option for proper format.

7. Click Encrypt. The KMLPKG file is created.

8. Click View File button to view the encrypted package file.

Model Encryption Tool V1.2 steps

Tool Configurations

Before encryption, you need to do some configurations. In the image, Action 1 shows the Settings tab, Action 2 shows the Utility tab, and Action 3 shows the Resource Manager tab.

Settings Tab

In the Settings tab, you can choose the location to save the encrypted models. If you do not select any location, the encrypted model is saved at the same location as the raw model. Action 4 in in the image shows the Change button to click first and Action 5 shows the Select folder button after browsing to the desired location. Action 6 shows the selected location under Location.

Utility Tab

In the Utility tab you can choose the certificate used to sign the APK and generate hash which is used during packaging after model encryption. Action 7 in the image shows the Browse button to choose this certificate file. After choosing the certificate, its path is visible under Location shown by Action 8. Action 9 shows the Generate Hash button. After hash generation, hash code is visible in Generated Hash box. Click Copy to copy Hash and add it to the Allowed Apps List along side of the package name for the App.

Resource Manager Tab

In the Resource Manager tab you can download resources required for conversion of models to ONNX. This is a one-time process and once downloaded, the resources will remain downloaded. Alternatively, resources can be downloaded during encryption, as and when required.

1. Click Get Started button as shown in Action 1 in the image. Action 2 shows the Encrypt file highlighted with blue underline, Action 3 shows the ML File format button, and Action 4 displays the disabled Add button.

   

2. Select Model type from drop down list as demonstrated by Action 7 and download the resources required to convert ML model to ONNX model type as demonstrated by Action 8.

   

3. Click the Add button as demonstrated in Action 4. This opens up the file browser. Select the appropriate file as indicated in Action 9 and after the selection, click Open as indicated in Action 10. The name of the selected file is visible in the ML File field as shown in Action 11.

   

4. Add the package name as demonstrated in Action 12. To select Allowed Apps List click the Add button as in Action 13. A file browser pops up. Select the appropriate list and click Open as demonstrated in the Action 14 and 15.

   

   

5. The allowed apps list file name is visible in the Allowed Apps field as demonstrated in Action 16. If ONNX conversion option is selected, Click the Next button and provide input parameters required for ONNX conversion, otherwise click the Encrypt button as demonstrated in Action 17, and encryption process starts as demonstrated in Action 18.

6. As the encryption is completed you are redirected to the Encryption Successful!. Your encrypted model package is generated in the folder specified. Clicking on View file as shown in Action 19 takes you to the generated package.

   

Types of Encrypted Knox ML output packages

You can generate following two types of Knox ML packages:

• KONPKG — This ONNX converted-ML model package format is supported by Knox ML Encryption Tool v1.2 onwards. This format is currently supported in devices with SDK 3.8 with KnoxML version v1.2 or higher.

• KMLPKG — This ML model package format is supported by Knox ML Encryption Tool v1.1 onwards. This format is currently supported in devices with SDK 3.7.1 with KnoxML version v1.1 or higher.

Deploy encrypted package to app

You can deploy the generated model package by keeping it in the application assets folder. Knox SDK provides the APIs to load the model in the application run-time.

To load the Model package in the application run-time, make a File Descriptor (FD) or create a data buffer of the package—if the package is present in the assets of the application—and call the subsequent API. To learn more about the development process, see model protection deployment, but ensure that you have the Knox SDK installed before you do so.

Troubleshooting

If you run into any errors, a failure log is generated. You can create a support ticket through your Knox Partner Portal > Support. Attach the failure log with the ticket and describe the issue in detail so that we can reproduce it to fix the error.