Protection Python Applications Using Script Envelope

Absolute path of the directory that contains the Python application to protect.

Absolute path of the directory to which the protected Python application will be written. No additional manual steps are required before you execute the application.

Parameter that contains one or more sets of sub-parameters input_glob and (optionally) ignore_glob and feature_id (described later). The sub-parameters in each set identify a subset of files in the application to be protected with a specific Feature ID.

For example:

         "to_be_protected": [
             {
                      "input_glob": "*.*",
                      "ignore_glob": "moduleC.py",
                      "feature_id": 4
             },
             {
                      "input_glob": "CD/*.py",
                      "feature_id": 14
             },
             {
                      "input_glob": ["EF/*.py", "GH/*.py"]
             }
          ],

The parameters in the example state that:

> All files in the root folder (excluding moduleC.py), will be protected with Feature ID 4.

> All Python files in the CD folder will be protected with Feature ID 14.

> All Python files in the EF and GH folders will be protected by default with the global_feature_id described later.

Run-time stub modules will be created for .py files. All other files are handled as data files that are to be used at run time.

The following files are copied from the input_root location to the output_root location with no change:

>Files that are not included in any input_glob parameter.

>Files included in an input_glob parameter but excluded using the ignore_glob parameter.

To protect model files:

>To apply model file protection for TensorFlow, the to_be_protected parameter must include the TensorFlow model files. For example:

             {
                      "input_glob": "model.keras",
                      "ignore_glob": "",
                      "feature_id": 0
             }

>To apply model file protection for Pytorch, the to_be_protected parameter must include the Pytorch model files. For example:

             {
                      "input_glob": "model.pt",
                      "ignore_glob": "",
                      "feature_id": 0
             }

Glob pattern that identifies the files under the input root to be protected by Envelope using the associated Feature ID (see feature_id below).

For example:

You can specify multiple patterns. For example:

For details, see https://docs.python.org/3/library/glob.html.

(Optional) Files to exclude from the input glob.

For example:

"input_glob": "**/*.py"
"ignore_glob": "fileA.py"

This example indicates that Script Envelope should recursively protect all .py files under the root folder, excluding fileA.py.

(Optional) Feature ID (in the range 0 - 65535) for the Python script (.py) files in the associated input_glob that you are protecting. If feature_id is not specified, the global Feature ID (described in global_feature_id below) is used.

If provided, the protected program will only search for a Sentinel protection key according to the custom login scope that you specify.

For information on the syntax for login scope parameters, see the topic "Scope Input XML Tags" in Sentinel Licensing API Reference. You can also paste a login scope that was created using Sentinel LDK ToolBox in this field.

Note: If the custom scope contains the following:

custom_scope: "<haspscope><hasp type="HASP-HL" /></haspscope>",

the hasp type="HASP-HL" must be escaped by the "\" as follows:

"custom_scope": "<haspscope>hasp type=\"HASP-HL\" /></haspscope>",

(Optional) Global Feature ID (in the range 0 - 65535) for the complete application that you are protecting. This Feature ID is also applied by default for any input_glob (under to_be_protected) for which a corresponding feature_id is not specified.

Default: 0

(Optional) Specify a time interval (in seconds) of 0-65535 for periodic background checks for a Sentinel protection key with the required licenses. Default: 300 seconds.

If you specify a value of 0, a periodic background check is not performed.

Regardless of the setting for this parameter, the License Manager checks for the required license when the application is started.

(Optional) Specifies how run-time user messages are delivered. Available output modes are:

>windows – If assigned the value true, messages are displayed in a message box.

>stderr – If assigned the value true, messages are written to the console.

Default: If no output modes are specified, windows mode is set to true and stderr mode is set to false.

The relative or absolute path and name for the project file that you prepared earlier.