Sentinel Licensing API Prerequisites
You may have to install the Sentinel LDK Run-time Environment in order to enable the Licensing API. For more information, see Situations That Require Sentinel LDK Run-time Environment.
Vendor Code
It is necessary to provide the Vendor Code in order to access a Sentinel protection key and its resources, including memory. Vendor Codes are usually stored in the VendorCodes directory. The location of the directory is described later in this topic.
In the Sentinel LDK Demo Kit, customers are provided with Sentinel HL Demo keys that work with the DEMOMA Vendor Code. This Vendor Code can be used to apply protection with the Sentinel Licensing API.
NOTE Do not distribute software protected with a Sentinel HL Demo key. This Sentinel protection key is only for evaluation purposes.
The Starter Kit you receive for Sentinel LDK contains two Vendor keys—a Developer key and a Master key. These keys contain your company’s unique Vendor Code. The Developer key is used by engineers for adding protection to your software. With Sentinel LDK-EMS hosted by Thales, you do not require the Master key; however, you should store it in a secure location to protect against misuse.
Sentinel Vendor Suite applications (Sentinel LDK Envelope, Sentinel LDK ToolBox, and Sentinel LDK-EMS) must recognize and have access to the unique Vendor Code that was assigned to you when you received your Starter Kit. Your Vendor Code is stored inside each Vendor key. You introduce one of the Vendor keys using the Master Wizard, as described in the following section.
For more information, see Vendor Code.
Extracting the Vendor Code from Sentinel Vendor Keys
You need to extract the Vendor Code from your Vendor keys so that the Sentinel LDK system will recognize it when you are working with any of the Vendor Suite applications. The Master Wizard extracts the Vendor Code for you.
Depending on your Sentinel LDK configuration, if you launch a Sentinel Vendor Suite application, and you have connected a new Vendor key to your computer, the Master Wizard will launch automatically. Alternatively, you can launch the Master Wizard manually.
For detailed information on using the Master Wizard, see the section on introducing Vendor keys in the Sentinel LDK Installation Guide.
By default, your Vendor Code information is saved in the following directory:
%UserProfile%\Documents\Thales\Sentinel LDK 10.0\VendorCodes
Vendor-specific File Naming Conventions
The format of a Vendor Code file name is BatchCode.hvc. For example, if your Batch Code is W3FLY, the file name will be W3FLY.hvc. (The Batch Code is a representation of your Vendor Code.) Your Vendor keys and all your Sentinel HL keys are labeled with your Batch Code.
By default, Sentinel Vendor Suite applications search the VendorCodes folder for your Vendor Code/Batch Code information.
Licensing API
At the time the Master Wizard extracts the Vendor Codes, it downloads your customized Licensing API libraries from Thales servers.
Your customized API libraries are saved in the following directory:
%UserProfile%\Documents\Thales\Sentinel LDK 10.0\API\Licensing
The APIs for each language are stored in a separate subdirectory. The format of API library names (for Windows) is hasp_windows_vendorID.libraryExtension.
Example
For C applications, the following libraries are downloaded:
| Library | Description |
|---|---|
| hasp_windows_vendorID.dll | Dynamic version of the API library |
| hasp_windows_vendorID.lib | Implemented library for hasp_windows_vendorID.dll library |
| libhasp_windows_vendorID.lib | Static version of the API library |
| libhasp_windows_bcc_vendorID.lib | Static version of API library compiled with Borland C compiler |
vendorID represents the vendor ID for your Batch Code or demo for the DEMOMA Batch Code.