Getting Started with Sentinel LDK Cloud Licensing (CL) Service

Looking for a powerful, centralized, role-based solution for handling all of your software protection, licensing, and entitlement needs? You've come to the right place!

Sentinel EMS entitlement management system has a straightforward design that walks you through the process of defining the various features and products that match the features and products in your back office system (ERP, CRM, billing system, or sales system).

Sentinel LDK is a comprehensive, out-of-the-box software monetization solution that protects and licenses your applications and services, so that you can maximize revenues while introducing flexible and customer-centric offerings into the market.

Cloud Licensing (CL) Service combines Sentinel EMS and Sentinel LDK to provide a user-centric, identity-based approach to cloud licensing that Thales hosts for you on a secure, cloud license manager server. CL Service comprises two main components. Sentinel EMS provides licensing and account (identity) management; Sentinel LDK Cloud License Manager Service provides consumption management for cloud licenses and accounts.

The Basics

The following are the foundation of Sentinel EMS with Sentinel LDK enforcement. It's important to understand these terms before you perform the steps in this Getting Started Guide.

Features

Features are the basic building blocks of products and licenses. Each feature can represent anything from a functional component to an entire application. Learn MoreClosed  This means that you can create a separate feature for a specific functionality, such as "Print" or "Edit & Save", or you can create a feature for each module or for an entire application.

After you define at least one feature, you can add that feature to a product. This enables you to sell a product with one or more licensed features.

Feature ID. The feature ID is a unique identifier. During runtime, the Sentinel Licensing API call uses the feature ID. Always ensure that the feature ID is the same in both Sentinel EMS and the Sentinel LDK application you are using to protect your application (Sentinel LDK Envelope or Sentinel Licensing API).

Products

A product represents a saleable item in your organization—such as a software application—usually with a SKU or similar unit. You can package products with individual features and memory files. Learn MoreClosed  Both features and memory files are optional.

License models and terms.Sentinel LDK enforcement provides configurable, out-of-the-box license models.

You assign a license model and license terms to a feature when you add the feature to a product.

Setting license terms per feature occurrence lets you vary the license terms as needed. This flexibility gives you full control over feature usage whether you include one feature per product, the same feature in multiple products, or multiple copies of a feature in a single product.

Product ID. A product typically has a unique ID. However, multiple products can share the same product ID. This lets you replace one product with another. For example, you might want to create an "upgrade" product for a saleable item to enable customers to pay the price difference and upgrade from a subscription license to a perpetual license. In this case, both the original and upgrade products would need the same product ID.

When ready, you add products to entitlements so that the vendor can generate licenses for distribution to customers.

Entitlements

An entitlement is a customer order for one or more products. Similar to orders in your back office system (ERP, CRM, billing system, or sales system), an entitlement specifies the products that a customer is entitled to use. Learn MoreClosed  It also includes contact details, the products ordered, the features and memory files bundled in the products, licensing terms, the number of copies of your product that are available to that customer (quantity), and the entitlement ID (EID). Each entitlement can also be mapped to an actual order or other reference ID in your system using the External ID or Ref ID fields in Sentinel EMS.

When an entitlement is ready to be processed, you mark it as complete. That enables the next step, which is generating a license and pushing it to the cloud using Produce and Push.

Cloud Licensing Service

Cloud licensing service (also known as CL Service) refers to software and service licensing that Thales hosts on a service-hosted, cloud license manager server. Learn MoreClosed  
Cloud licensing uses identity-based access via accounts to give the vendor or customer granular control over who can access a cloud license. The software vendor can optionally delegate end-user account management to administrator contacts, as described in Accounts.

Accounts

An account represents a set of cloud licensing permissions that grant authorization rights to a customer's end user to access protected applications or services on one or more client devices (also known as registered machines). Accounts are an integral part of cloud licensing. Learn MoreClosed  To enable client authentication and access control, each account is assigned a unique identity string. This identity string must be installed on the client device where the vendor's application runs. When the vendor's application tries to launch on that device, the client communicates with the cloud licensing service on Thales' service-hosted, cloud license manager server, which authenticates the client identity based on the identity string and verifies the access permissions assigned to the account. If the account is authorized to access the application, the application opens and runs.

Each account is associated with a customer and is defined for a specific end user. When you create an account, you select the customer and specify the name and email address of the end user. By default, the end user then receives an email that includes a clickable link that automatically installs the identity string on the client device. Accounts inherit the access permissions (known as cloud licensing permissions) that are defined for the associated customer. You can modify these settings for a specific account if needed.

Accounts can be created on the Sentinel EMS vendor or customer portal, depending on whether the vendor or a customer's administrator contact creates and manages accounts. Both vendors and administrator contacts can also view the list of activated products on the respective portals, as well as manage the list of registered machines on which each account can access protected applications.

Identity Credentials

Identity credentials are used to verify the identity of a client device and grant access to a cloud-based license. Learn MoreClosed  Unique identity credentials are generated automatically when you create an account. These credentials comprise an identity string that contains a unique, read-only, 7-character identity code and an identity link, which is used to install the identity string on the end user's device.

End users can install an identity string on a client device by clicking the identity link that is sent automatically by email when the account is created. If you choose not to send the identity link automatically, then you must share this identity link directly with the end user in some other manner.

After the identity string is installed, the device shares its identity string with the Sentinel EMS cloud license manager server whenever the application or service starts, or as defined in your application (for example, you might set authentication verification "per session" instead of "at login"). After successful verification, the device accesses your protected application or service.

TIP   Want to learn more about any of the concepts and terminology used in Sentinel EMS with Sentinel LDK enforcement? Check out the Glossary at the end of this guide.

Sentinel EMS Workflow

The following diagram illustrates the end-to-end workflow of creating and delivering a cloud license in Sentinel EMS using the Cloud Licensing Service. Each section represents a part in this getting started guide.

Sentinel cloud-licensing workflow

Sentinel cloud-licensing workflow

ClosedLearn about the different personae in the Sentinel EMS workflow

Vendors. Vendors use the Sentinel EMS vendor portal.   Closed View the different Sentinel EMS personae in the vendor's organization

Administrator. Performs the initial setup and subsequent maintenance.

Product Owner. Defines the features and products in the catalog.

Customer Manager or Entitlement Manager (order taker).

Defines the customer and administrator contacts.

Defines entitlements.

(Optional) If the vendor's organization handles end-user accounts:

-  Creates end-user accounts, and

-  Provides end users with unique identity credentials to access cloud licenses.

Activation Manager. Generates licenses.

Administrator Contacts. (Optional) Vendors can delegate end-user account management directly to their customers by creating administrator contacts. The administrator contact uses the Sentinel EMS customer portal.  ClosedLearn what the administrator contact does

Creates end-user accounts, and

Provides end users with unique identity credentials to access cloud licenses.

End users. The customers' end users use their work or personal devices (machines).  ClosedLearn what the end user does

a. Receives a unique identity string that provides access to one or more cloud licenses. This string identifies the relevant account and may be shared by the vendor or customer.

b.Installs the identity string on one or more devices. This enables the vendor's protected application to access the cloud licenses from the end user's device as needed.

How does the end user receive and install the identity string? In most cases, the end user receives an email containing an installation link. The end user must click that installation link from the device on which they plan to run the vendor's application. This automatically installs the identity string on the relevant device.

c.Uses the vendor's application on those devices. Typically, when the application starts, it sends a request to the cloud license manager server, which validates the device's identity and grants permission to use the licensed features or services.

ClosedSee what's not included in this workflow

  



Before You Begin

Install the latest version of Sentinel LDK. For instructions, see Sentinel LDK Installation Guide with Sentinel EMS.

Review The Basics to learn about the Sentinel EMS components.

Make sure that your Thales account enables you to access Sentinel EMS. At minimum, you need a role in Sentinel EMS that includes Customer Management permissions. Contact your Thales representative for assistance if needed.



One-Time Setup

Make sure that you are connected to the Sentinel EMS vendor portal.  ClosedShow me how

1.Navigate to the URL shared by Thales.

2.Log on using the user name and password provided by Thales.

Create a Catalog

In this section, you create a catalog that includes your saleable items—a feature and a product. Make sure that you are connected to the Sentinel EMS vendor portal.  ClosedShow me how

1.Navigate to the URL shared by Thales.

2.Log on using the user name and password provided by Thales.

Define a Customer and Administrator Contact

In this section, you define a customer for the entitlement that you will be creating later. At this stage, you will also create an administrator contact for the customer. Adding an administrator contact lets you delegate account management directly to the customer. Without an administrator contact, you, the vendor, would have the sole responsibility of managing your customers' end-user accounts. Make sure that you are connected to the Sentinel EMS vendor portal.  ClosedShow me how

1.Navigate to the URL shared by Thales.

2.Log on using the user name and password provided by Thales.

Generate a License and Push It to the Cloud

In this section, you generate a license and push that license to Thales' cloud license server manager using Sentinel EMS with Sentinel LDK enforcement.

First you will generate an entitlement to fulfill an order for a specific customer. Then you will use Produce and Push to generate a cloud license for the product features included in the entitlement. The license will automatically be pushed to Thales's service-hosted, cloud license manager server, making it ready to share with the customer's end users. Make sure that you are connected to the Sentinel EMS vendor portal.  ClosedShow me how

1.Navigate to the URL shared by Thales.

2.Log on using the user name and password provided by Thales.

Manage End User Accounts

Earlier, you created an administrator contact, who is responsible for handling account management for your customer. You are now using that persona to create an account for your customer's end user. You will enable the Send Notification option to send an email directly to the end user, informing them that they can start using the TextEditor application by clicking the link in the email. Clicking this link installs identity credentials on the end user's machine using an identity string. This string is used to authorize the use of the application on that machine.

Where do you create an end user account?

Vendors create accounts from the Sentinel EMS vendor portal. Customers' administrator contacts create accounts from the Sentinel EMS customer portal.

For the purposes of this training, you can use either portal to create an account.



End User Starts Using the Application

Now that you have created an account, the customer's end user can install their unique identity credentials and launch your protected application or service.

For the purposes of this training, let's assume that:

Your application is already packaged together with Sentinel Run-time Environment.

The end user has already installed the application on the target device and is just waiting for the license to use the application.



Glossary

Let's review the concepts and terminology that you need to know to work with Sentinel LDK enforcement in Sentinel EMS.  ClosedShow the glossary

Activation | Application | Batch Code | Burning a Key | Catalog | C2V | Cloud Licensing Permissions | Customers and Contacts | Devices | Enforcement | Identity Code | Identity String | License Model | Locking Type | Market Group | Memory | Namespace (Batch Code) | Produce and Push | Unlocked from Device (Product) | V2CP

Concept Description

Activation

(License Generation)

The process of generating or updating a license package (V2CP file) for one or more products.

A license can be locked to a specific device, or it can be unlocked, as described in Unlocked from Device (Product).

Application

In the context of Sentinel LDK, application or protected application refers to the vendor's application, which is licensed and protected by the Sentinel LDK Licensing API (native or REST) and/or Sentinel Envelope, and packaged with Sentinel Run-time Environment. For more details on these components, see Sentinel LDK and navigate to the relevant guide.

Application can refer to a software application, a service, and so on.

Batch Code See Namespace (Batch Code).
Burning a Key

Activates an entitlement by burning the license file directly on a Sentinel HL key (dongle).

Catalog

A container for all of your assets, including products, features, memory files, license models, and namespaces.

For more details, see Sentinel EMS User Guide for Sentinel LDK.

C2V

and

V2CP

files

C2V (Customer-to-Vendor). A file containing data about deployed Sentinel protection keys or data about the customer's device, such as its fingerprint. The customer sends the C2V file to the vendor, often by email. The vendor then uses the C2V file to generate a license for the customer when activating an entitlement.

V2CP (Vendor-to-Customer Package file). A package file from the software vendor that contains one or more license update files (V2C files) for a Sentinel protection key on the customer's device.

Cloud Licensing Permissions

Cloud licensing permissions delineate access and usage permissions for CL keys. Permissions are set at global, customer, and account levels.

For more details, see Sentinel EMS User Guide for Sentinel LDK.

Customers and Contacts

A customer can be an organization that owns an entitlement or a current or potential buyer of an entitlement. Typically, you generate entitlements for a customer who has placed an order. A customer can have one or more contacts. An administrator contact uses the Sentinel EMS customer portal to manage end-user accounts for their customer.

Devices

In Sentinel EMS with Sentinel LDK, a device is anything on which customers can install your licensed application, including, but not limited to, computers, tablets, phones, and watches.

See also: Registered Machine

Enforcement

Licensing technology, such as Sentinel LDK, that controls and secures your software application.

Identity Code

An identity code is a unique, read-only, 7-character string that is part of the full identity string.

For more details, see Sentinel EMS User Guide for Sentinel LDK.

Identity String

An identity string designates the client identity for the account as defined in the cloud licensing service database. When the end user runs a protected application, the local license manager on the user's machine uses the identity string to consume a license from the relevant protection key on the service-hosted, cloud license manager server.

If the end user has the appropriate permissions, the end user can use the identity string to detach a license from the service-hosted, cloud license manager server and then run the protected application offline.

For more details, see Sentinel EMS User Guide for Sentinel LDK.

License Model

The license terms for a feature. You set the license model when adding a feature to a product, or when modifying a feature in an entitlement. License models:

Define in Entitlement. Enables the order taker to define the license type when creating an entitlement (when each individual order is processed). (Available only when creating a Product.)

Execution Count. The maximum number of times the feature may be used.
(Not relevant for products that are not locked to a device. See Unlocked from Device (Product).)

Expiration Date. The date on which the license for the feature will expire.

Perpetual. Default license model. The license can be used an unlimited number of times and for an unlimited period of time.

Time from First Use. The number of days until the license expires. The number of days is counted from the date on which the licensed feature is first used.

Time from License Generation. The number of days until the license expires. The number of days is counted from the date on which the license is generated.
(Not relevant for products that are not locked to a device. See Unlocked from Device (Product).)

For more details, see Sentinel EMS User Guide for Sentinel LDK.

Locking Type

The level of protection for a product according to the type of Sentinel protection key supplied with the product. You set the locking type when defining a product. Locking types can be hardware-based (Sentinel HL keys) or software-based (Sentinel SL keys). When using the Cloud Licensing service, you must select one of the SL AdminMode options, such as the default HL or SL AdminMode or SL UserMode option.

The following locking types are available:

HL. Use for burning licenses on physical, Sentinel HL keys (dongles).

SL UserMode. Use for activating licenses on Sentinel SL UserMode keys (software).

Does not require the installation of Sentinel Run-time Environment (RTE).

Provides a lower level of security for products that are not locked to a device than SL Admin mode.

Provides the highest level of compatibility with future operating system updates.

SL AdminMode. Use for activating licenses on Sentinel SL AdminMode keys (software).

Requires the installation of Sentinel Run-time Environment (RTE).

Supports all license terms, including concurrency and detachable licenses.

Provides a high level of compatibility with future operating system updates.

HL or SL AdminMode. Use for either Sentinel HL keys or Sentinel SL AdminMode keys.

HL or SL AdminMode or SL UserMode. (Default) Use this locking type if the decision on which type of Sentinel protection key is to be shipped with the product is made when each order is processed.

For more details, see Sentinel EMS User Guide for Sentinel LDK.

Market Group

A market group applies data access control for specific catalog elements and their entitlements. Typically, a target group of users share common characteristics, such as geographical locations or business units.

For more details, see Sentinel EMS User Guide for Sentinel LDK.

Memory

Memory files let you store sensitive data in the Sentinel protection key. For example, you might want to store user data or homegrown license code.

You create memory files from the Memory tab. You associate memory files when creating a product. For more details, see Sentinel EMS User Guide for Sentinel LDK.

Namespace (Batch Code)

A namespace represents your company's unique vendor code. ("Namespace" is known as "batch code" in Sentinel LDK.)

When you order Sentinel protection keys from Thales, you specify your namespace, which is both written to the keys before dispatch and printed on the outside of each Sentinel HL key. Your company can have one or more namespaces. The namespace for Sentinel protection keys with a demo vendor code is DEMOMA.

In Sentinel EMS, a namespace also acts as a workspace, differentiating between separate storage locations. If you have multiple namespaces, the features, memory files, and products in each namespace are available only to those users who have permissions for that namespace. Users with roles that have entitlement-related permissions (such as order takers) can access these items from all namespaces.

For more details, see Sentinel EMS User Guide for Sentinel LDK.

Produce and Push

"Produce and Push" generates a cloud license and pushes the license to the Thales service-hosted, cloud license manager server in a single step.

After produce and push is performed, the vendor or administrator contact can create accounts for end users, so that end users can access the protected application or service as soon as they receive their unique identity credentials and install the protected application.

On the Sentinel EMS customer portal, an administrator contact can create and manage end user accounts, view the list of activated products, and manage the list of registered machines on which each end user can access protected applications. The vendor can also perform these tasks on the Sentinel EMS vendor portal.

For more details, see Sentinel EMS User Guide for Sentinel LDK.

Registered Machine

A registered machine is a client device that is linked to an account to enable access to licenses for protected applications from the Thales service-hosted, cloud license manager server.

Also known as device or client device.

For more details, see Sentinel EMS User Guide for Sentinel LDK.

Role

A role is a set of permissions for using specific entities in Sentinel EMS.

For more details, see Sentinel EMS User Guide for Sentinel LDK.

Unlocked from Device (Product)

A product that is distributed with a license that is not locked to a specific device and can therefore be installed freely by any user on any device. Typical uses include:

Trial licenses (free for up to 90 days), which can start from the date of license generation or first use, depending on the License Model. (The Execution Count and Time From License Generation license models are not relevant for products that are not locked to a device.)

"Unlimited" products that or may not have licensing restrictions. For example, you might apply a Perpetual license, you may decide to limit the time period, you may use a different mechanism to license the application, or you may decide not to impose any licensing restrictions at all.

When you create an entitlement, you can include products that are either locked to a device or unlocked from a device, but not both.

For more details, see Sentinel EMS User Guide for Sentinel LDK.