Function Groups

Sentinel Licensing API functions are categorized into five groups, based on common functionality and linkage.

>Session functions

>Encryption/Decryption functions

>Memory functions

>Time functions

>Management functions

Session Functions

A session is created by executing a successful login call to a license residing in a specific Sentinel protection key. For more information about logging in, see Login Options. At the end of a session, use the logout function to close the session.

Encryption Functions

You can encrypt or decrypt data buffers using the AES-based encryption engine in the Sentinel protection key. The encryption engine uses symmetric encryption. This means that the same encryption key is used later to decrypt the data buffer.

Memory Functions

Use the memory to store data to be used by the application at run‑time, and information that can be used later to verify and identify an end user. Control of access to sensitive data forms an integral part of your protection scheme.

The Sentinel Licensing API can be used to:

>Read data buffers stored in the Protection Key memory

>Write data buffers to the Protection Key memory

The size of the data buffers is restricted by the memory available in the specific Sentinel protection key type. For information about the memory capacity of the available Sentinel protection keys, refer to the Sentinel HL Data Sheet.

Time Functions

Sentinel Licensing API can be used to access:

>the real-time clock in a Sentinel HL Time key or Sentinel HL NetTime key

>the V‑Clock in a Sentinel HL (Driverless configuration) key. For more information, see How Sentinel LDK Protects Time-based Licenses With V-Clock.

This functionality enables you to read the time. Two date and time conversion functions are included in the Sentinel Licensing API.

Management Functions

The Sentinel Licensing API includes functions that enable you to retrieve information on the system components, the current login session, the status of a deployed Sentinel protection key, and license updates.

When using Sentinel SL keys, the Transfer function enables you to:

> detach a license from a pool of network seats.

>rehost a protection key from one of a customer's machines to another.

You can also use the Update function to install updates. You do not need to be logged in to a session in order to perform this function. For additional information, see the Sentinel Licensing API Reference.