Configuration File Structure

Set a time interval for periodic background checks for a protection key.

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

For more information, see Behavior of Periodic Background Check.

Number of grace periods to grant the user if a background check determines that the required protection key is not connected.

This tag is only applicable if <BACKGROUND_CHECK> is enabled.

For more information, see Behavior of Periodic Background Check.

Note: For applications that execute in a Docker container, this parameter must be set to -1. Abort and Retry options are not supported.

Options for displaying/logging end user messages. You can select one or more options. Separate multiple entries by commas.

Note: When you protect an application with output option 1 (the default setting), the protected application requires XServer at runtime. A GUI-based application always requires XServer for its own user interface in any event. However, for a command-line application, GUI output is not recommended, because the command-line application will then require XServer specifically for output of Envelope messages. Thales recommends that you protect a command-line application with the output option of 4, and not with the default setting.

With output option 1: If XServer is not installed or is not working properly on the end user machine, then on any error or warning, the message “No Protocol specified” will be displayed on the terminal that the user is using to run the protected application.

Encryption level for the executable code.

As you increase the encryption level, the security of the protected application increases. However, the start-up time also increases. Select the highest level that does not cause an unacceptable start-up delay.

Whether to allow debugging for the protected application.

This feature is applicable for both executables and shared objects.

Whether to allow memory dumps for the protected application. If memory dumps are disallowed:

> Core file will not be generated in case of application failure.

> Debugging for the protected application is automatically disallowed. This overrides the setting for <ALLOW_DEBUG>.

This feature is applicable for both executables and shared objects.

NOTE   When debugging is allowed, memory dumps are also allowed regardless of the setting for the <ALLOW_MEMDUMP> tag. (Protection against memory dumps does not work when debugging of the protected application is allowed.)

For information on taking memory dumps. see the description of --memdump .

Whether the Data Protection module should be inserted into the protected application. This module enables the protected application to access data files that were protected with the Sentinel LDK Data Protection utility.

For more information, see the description of protecting data files in the Sentinel LDK Software Protection and Licensing Guide (for Sentinel EMS or Sentinel LDK-EMS).

Whether to preserve a shared object’s symbol section in the protected shared object to enable linking against it at build time. Not applicable for executables.

Note: This option adds additional imports from pthread and dl shared objects into a protected shared object. Thus, it is required to resolve pthread and dl dependencies at build time.

The following example compiles the main application with a protected shared library:

g++ -o main main.cpp -L<libraryPath> -l
 <protectedSharedObject> -lpthread -ldl

Definition of the data that is to be searched for the Sentinel licenses, in XML format. Within the <LOGIN_SCOPE> element, the characters “<” and “>” must be replaced by the character entities “<” and “>”.

Example

How to use the login_scope element for protection for a specific Key ID (hasp id):

<LOGIN_SCOPE>
&lt;?xml version="1.0" encoding="UTF-8"?&gt;
&lt;haspscope&gt;
&lt;hasp id="1183674833" /&gt;
&lt;/haspscope&gt;
</LOGIN_SCOPE>

Note: For information on the syntax for these parameters, see the topic "Scope Input XML Tags" in the Sentinel Licensing API Reference. You can also paste a login scope that was created using Sentinel LDK ToolBox into this element, replacing the “<” and “>” characters as described.