Sentinel Hardware Keys Developer's Guide - Customer Connection ...

Copyright © 2009, SafeNet, Inc. 

All rights reserved. 

We have attempted to make this document complete, accurate, and useful, but we cannot guarantee it to be 

perfect. When we discover errors or omissions, or they are brought to our attention, we endeavor to correct 

them in succeeding releases of the product. SafeNet, Inc. is not responsible for any direct or indirect damages or 

loss of business resulting from inaccuracies or omissions. The specifications contained in this document are subject 

to change without notice. 

SafeNet, Sentinel, Sentinel V-Clock, CodeCover, and the Business Layer APIs are either registered trademarks or 

trademarks of SafeNet, Inc. Microsoft, Windows, Windows 95, Windows 98, Windows ME, Windows NT, Windows 

2000, Windows XP, Windows Server 2003, Windows Vista, Windows Server 2008, Windows Server 2008 R2, 

Windows 7, and Internet Explorer are either trademarks or registered trademarks of Microsoft Corporation in 

the United States and other countries. Java is a trademark of Sun Microsystems, Inc. in the United States and 

other countries. Linux is a trademark of Linus Torvalds, in the United States and other countries. Mac and the 

Mac logo are trademarks of Apple Computer, Inc., registered in the U.S. and other countries. All other trademarks 

are the property of their respective owners. 

The Sentinel Keys SDK makes use of certain third-party software. Please refer to Acknowledgments.pdf under 

the Manuals directory for details. 

CONFIDENTIAL INFORMATION 

The Sentinel Keys SDK is designed to protect your software applications from unauthorized use. It is in your best 

interest to protect the information herein from access by unauthorized individuals. 

Part Number 002266-001, Revision J 

Software versions 1.3.1 

Revision Action/Change Date 

A 1.0.0 release for Windows 32-bit platforms November 2005 

B 1.0.2 release for Linux platforms May 2006 

C 1.0.2 release for Windows 32-bit and x64 platforms August 2006 

D 1.0.2 release for Macintosh platforms September 2006 

E 1.0.3 release for Windows Vista 32-bit and x64 platforms March 2007 

ii Sentinel Hardware Keys Developer’s Guide

Revision Action/Change Date 

F 1.2.0 release for Windows 32-bit and x64 platforms December 2007 

G 1.2.1 release for cross platform support (Windows, Linux, 

and Macintosh). 

H 1.3.0 release for cross platform support (Windows, Linux, 


J 1.3.1 release for cross platform support (Windows, Linux, 


May 2008 

June 2009 

November 2009 

Sentinel Hardware Keys Developer’s Guide iii

Certifications 

European Community Directive Conformance Statement 

WEEE and RoHS Compliance 

Sentinel Hardware Keys are in conformity with the protection requirements of EC 

Council Directive 89/336/EEC. Conformity is declared to the following applicable standards 

for electro-magnetic compatibility immunity and susceptibility; CISPR22 and 

IEC801. This product satisfies the CLASS B limits of EN 55022. 

Mac OS X Universal Logo Compliance 

Sentinel Hardware Keys are environment-friendly and comply 

to Waste Electrical and Electronic Equipment (WEEE) and 

Restriction of Hazardous Substances (RoHS) standards. 

The WEEE symbol indicates that the electronic devices 

included with this product package must not be disposed of 

with other non-electrical waste. It is the responsibility of 

your organization to dispose of your electronic waste by 

handing it over to a designated collection point for the recycling 

of waste electrical and electronic equipment (WEEE). 

The Sentinel Hardware Keys SDK is designed for the Macintosh operating 

system (Mac OS X) and runs natively on both PowerPC- and Intelbased 

computers from Apple. 

iv Sentinel Hardware Keys Developer’s Guide

USB 2.0 Compliance 

Ready for Red Hat Linux 

This logo is a registered trademark of Red Hat, Inc. 

WHQL Certification 

Sentinel Hardware Keys comply to the USB 2.0 standards. 

The Sentinel Hardware Keys SDK is supported on Red Hat Linux. 

The Sentinel System Driver (for Windows) is certified by Windows Hardware Quality Lab (WHQL) for Windows 

2000, Windows XP (32-bit and x64), Windows Server 2003 (32-bit and x64), Windows Vista (32-bit and x64), 

Windows Server 2008 (32-bit and x64), Windows Server 2008 R2 (x64), and Windows 7 (32-bit and x64) 

Sentinel Hardware Keys Developer’s Guide v

FCC Compliance 

FC 

Sentinel Hardware Keys have passed the FCC Self-authorization process of Computers and Computer 

Peripherals. FCC Part 15 Class B Specifications. 

FCC Notice to Users 

This equipment has been tested and found to comply with the limits for a class B digital device, pursuant to part 

15 of the FCC Rules. These limits are designed to provide reasonable protection against harmful interference in a 

residential installation. This equipment generates, uses and can radiate radio frequency energy and if not 

installed and used in accordance with the instructions, may cause harmful interference to radio communications. 

However, there is no guarantee that interference will not occur in a particular installation. If this equipment 

does cause harmful interference to radio or television reception, which can be determined by turning the equipment 

off and on, the user is encouraged to try to correct the interference by one or more of the following measures: 

Reorient or relocate the receiving antenna. 

Increase the separation between the equipment and receiver. 

Connect the equipment into an outlet on a circuit different from that to which the receiver is connected. 

Consult the dealer or an experienced radio/TV technician for help. 

In order to maintain compliance with FCC regulations, shielded cables must be used with this equipment. Operation 

with non-approved equipment or unshielded cables is likely to result in interference to radio and TV 

reception. The user is cautioned that changes and modifications made to the equipment without the approval 

of manufacturer could void the user's authority to operate this equipment. 

vi Sentinel Hardware Keys Developer’s Guide

Table Of Contents 

Certifications ................................................................................................................. iv 

Preface ........................................................................................... xiii 

Where to Find Information? ........................................................................................ xiii 

Conventions Used in This Guide.................................................................................. xiv 

Technical Support ....................................................................................................... xvi 

SafeNet Sales Offices ................................................................................................... xvii 

Export Considerations ............................................................................................... xviii 

We Welcome Your Comments .................................................................................. xviii 

Part 1: Sentinel Hardware Keys Basics................. 1 

Chapter 1 – Introduction .................................................................. 3 

Software Piracy Hurts Your Business.............................................................................3 

Sentinel Keys Protect Against Software Piracy ..............................................................4 

License Models to Increase Your Revenue .....................................................................6 

Sentinel Keys Offer Sophisticated Protection..................................................................7 

Frequently Asked Questions.........................................................................................14 

Chapter 2 – Sentinel Hardware Keys SDK Components............... 19 

Overview ......................................................................................................................19 

Developer Key...............................................................................................................21 

Distributor Key .............................................................................................................23 

Sentinel Keys ................................................................................................................24 

Sentinel Hardware Keys Developer’s Guide vii

Contents 

Sentinel Keys Server .................................................................................................... 28 

Sentinel System Driver ................................................................................................ 31 

Sentinel Keys Toolkit ................................................................................................... 33 

Command-Line CodeCover Utility ............................................................................... 35 

Key Programming APIs............................................................................................... 36 

Compiler Interfaces ..................................................................................................... 38 

License Manager (Stand-alone)................................................................................... 39 

Sentinel Keys License Monitor..................................................................................... 40 

Sentinel Protection Installer........................................................................................ 43 

Configuration Files ...................................................................................................... 44 

Remote Update Options ............................................................................................... 44 

Frequently Asked Questions........................................................................................ 45 

Chapter 3 – Planning Application Protection and 

Licensing Strategy .......................................................................... 51 

About Features, Templates, and Groups ..................................................................... 51 

Planning Application Protection and Licensing Strategy ........................................... 61 

Frequently Asked Questions........................................................................................ 70 

Part 2: Designing and Implementing 

Protection............................................................. 73 

Chapter 4 – Protecting Applications Using CodeCover ................ 75 

Add CodeCover Feature Dialog Box............................................................................. 76 

Adding Files................................................................................................................. 76 

Providing Licensing Settings ....................................................................................... 79 

Providing Networking Settings ................................................................................... 80 

Providing Security Settings ......................................................................................... 83 

Customizing Error Messages........................................................................................ 85 

Customizing CodeCover Error Message Title ............................................................... 86 

Changing File Encryption Settings .............................................................................. 87 

Applying CodeCover Protection .................................................................................. 89 

CodeCover Protection Using the Command-Line Utility ............................................. 91 

CodeCover Protection using Custom CodeCover Key.................................................. 95 

viii Sentinel Hardware Keys Developer’s Guide

Contents 

What’s Next? ................................................................................................................98 

Frequently Asked Questions...................................................................................... 100 

Chapter 5 – Protecting Applications Using API........................... 109 

Steps to Protect Applications Using API.................................................................... 109 

Adding API Features ................................................................................................. 113 

What’s Next? ............................................................................................................. 132 


Chapter 6 – Secure Remote Updates............................................ 137 

Secure Remote Updates ............................................................................................. 137 

Secure Remote Feature/License Update .................................................................... 139 

Secure Remote New License Addition....................................................................... 145 

Remote Update Codes ................................................................................................ 149 

Remote Update Methods............................................................................................ 151 

About Remote Update Actions .................................................................................. 157 

Generating Update Codes .......................................................................................... 162 


Chapter 7 – Implementing Secure Licensing............................... 167 

Vulnerability Assessment - Basic Types of Attacks ................................................... 168 

Tips and Tricks .......................................................................................................... 171 


Part 3: Grouping Licenses and 

Programming Hardware Keys .......................... 185 

Chapter 8 – License Grouping ...................................................... 187 

Why Create Groups?.................................................................................................. 187 

Creating New Groups ................................................................................................ 189 

Loading Groups ......................................................................................................... 190 

Duplicating Groups ................................................................................................... 191 

Removing Groups...................................................................................................... 191 

Sentinel Hardware Keys Developer’s Guide ix

Contents 

Sending Group Files to Distributors........................................................................... 191 

Viewing Group Layouts............................................................................................. 192 

Modifying Default Feature Instances......................................................................... 193 

Creating New Feature Instances ............................................................................... 193 

Add Templates to Groups .......................................................................................... 194 

Remove Templates From Groups .............................................................................. 194 

Export-File Manager.................................................................................................. 195 

Locking/Unlocking Groups ....................................................................................... 196 


Chapter 9 – Programming Sentinel Hardware Keys................... 203 

Programming Sentinel Keys using Sentinel Keys Toolkit ......................................... 203 

Programming Sentinel Keys using the Key Programming APIs............................... 208 


Part 4: Distributing Protected Applications .... 221 

Chapter 10 – Redistributables for Customers and Distributors 223 

Checklist for Customers And Distributors ................................................................. 223 

Deploying Sentinel System Driver ............................................................................. 225 

Deploying Sentinel Keys Server................................................................................. 227 

Deploying (Client) Configuration File........................................................................ 227 

Deploying Secure Update Utility................................................................................ 228 

Deploying Secure Update Wizard (Windows Only) ................................................... 230 

Deploying Sentinel Data Protection Driver (Windows Only) .................................... 235 

Deploying Stand-alone License Manager .................................................................. 237 

Deploying System Administrator’s Help.................................................................... 239 


Appendix A – Troubleshooting .................................................... 243 

Problems and Solutions............................................................................................. 243 

x Sentinel Hardware Keys Developer’s Guide

Contents 

Appendix B – Glossary .................................................................. 257 

A ................................................................................................................................ 257 

B ................................................................................................................................ 258 

C ................................................................................................................................ 259 

D ................................................................................................................................ 261 

E................................................................................................................................. 262 

F................................................................................................................................. 264 

G ................................................................................................................................ 265 

H ................................................................................................................................ 265 

K ................................................................................................................................ 266 

L................................................................................................................................. 266 

M ............................................................................................................................... 268 

N ................................................................................................................................ 268 

O ................................................................................................................................ 268 

P ................................................................................................................................ 269 

Q ................................................................................................................................ 269 

R ................................................................................................................................ 270 

S................................................................................................................................. 270 

T ................................................................................................................................ 273 

U ................................................................................................................................ 274 

W ............................................................................................................................... 275 

Appendix C – Sentinel Keys Hardware Specifications ............... 277 

Appendix D – Migration from SuperPro and UltraPro ............... 279 

Stage 1 - Distribute Sentinel Dual Hardware Keys .................................................... 279 

Stage 2 - Design New Protection Strategy................................................................. 281 

Index .............................................................................................. 283 

Sentinel Hardware Keys Developer’s Guide xi

Contents 

xii Sentinel Hardware Keys Developer’s Guide

Preface 

Thank you for choosing Sentinel Hardware Keys—the state-of-the-art USB 

tokens with advanced cryptographic capabilities. Using Sentinel Hardware 

Keys, you can: 

Protect your intellectual property from piracy. 

Implement different license models for different customers. 

Secure your product revenue. 

Where to Find Information? 

The Sentinel Hardware Keys SDK documentation is for the following users: 

You want to... Recommended 

References 

Manager or New User 

Understand the product installation, 

features and benefits 

Application Programmer 

Plan, design, and implement the 

application protection. 

Program Sentinel Hardware Keys for 

your customers. 

Release notes 

Part I of this guide 

Sentinel Keys Toolkit Help 

Part I and Part II of this guide 

Business Layer API Help 

Sentinel Keys Toolkit Help 

Part III of this guide 

Help included with the License 

Manager application 

Sentinel Hardware Keys Developer’s Guide xiii

Conventions Used in This Guide 

You want to... Recommended 

References 

Builder 

Prepare the protected application for 

release, including deploying the 

redistributables. 

Customers and Helpdesk 

Learn how to use the hardware key and 

the redistributables, like the Sentinel 

System Driver, Sentinel Keys Server, 

configuration file. 


Please note the following conventions used in this guide: 

Convention Meaning 

Part IV of the guide 

Sentinel Protection Installer Help 

(for 

Windows only) 

System Administrator’s Help 

FAQs included in the Sentinel 

Keys Toolkit Help 

Courier Denotes syntax, prompts and code examples. Bold 

Courier type represents characters that you type; for 

example: logon. 

Bold Lettering Words in boldface type represent keystrokes, menu 

items, window names or fields. 

Italic Lettering Words in italic type represent file names and directory 

names; it is also used for emphasis. 

The root drive on your system where your operating 

system is installed. 

xiv Sentinel Hardware Keys Developer’s Guide

Convention Meaning 


The path where the software, in context, is installed. 

For example, the default for Sentinel 

Hardware Keys SDK is as follows: 

On Windows 32-bit: :\Program 

Files\SafeNet Sentinel\Sentinel Keys\ 

On Windows x64: :\Program 

Files(x86)\SafeNet Sentinel\Sentinel Keys\ 

On Linux: /opt/safenet_sentinel/sentinel_keys/ 

 

On Macintosh: /Applications/Safenet Sentinel/Sentinel 

Keys/ 

The default path for the Personal folder on Windows 

2000/XP (32-bit and x64)/Server 2003 (32-bit and x64) 

systems is: :\Documents and Settings\user 

name. 

The default path for the Personal folder on Windows 

Vista (32-bit and x64)/Server 2008 (32-bit and x64)/ Server 

2008 R2 (x64)/Windows 7 systems is: :\Users\user name. 

Refers to the default user's directory on Linux and 

Macintosh. 

Sentinel Hardware Keys Developer’s Guide xv

Technical Support 

Technical Support 

If you have questions, need additional assistance, or encounter a problem, 

please contact Technical Support using the information given below: 

Technical Support Contact Information 

Customer Connection Center (C3) 

http://c3.safenet-inc.com 

Existing customers with a Customer Connection Center account can log in to 

manage incidents, get latest software upgrades and access the complete 

SafeNet Knowledge Base repository. 

Support and Downloads 

http://www.safenet-inc.com/Support 

Provides access to knowledge base and quick downloads for various products. 

E-mail-based Support 

support@safenet-inc.com 

Telephone-based Support 

United States (800) 545-6608, (410) 931-7520 

France 0825 341000 

Germany 01803 7246269 

United Kingdom 0870 7529200, +1 410 931-7520 

Australia and New 

Zealand 

+1 410 931-7520 

China (86) 10 8851 9191 

India +1 410 931-7520 

xvi Sentinel Hardware Keys Developer’s Guide

SafeNet Sales Offices 

SafeNet Sales Offices 

For more information about SafeNet products and offerings, contact the 

sales offices located in the following countries: 

Australia 

+61 2 9906 2988 

Finland 

+358 20 500 7800 

Hong Kong 

+852 3157 7111 

Korea 

+82 31 705 8212 

Singapore 

+65 6297 6196 

U.S. (Massachusetts) 

+1 978.539.4800 

U.S. (Irvine, California) 

+1 949.450.7300 

Brazil 

+55 11 6121 6455 

France 

+33 1 47 55 74 70 

India 

+91 120 4020797 

+91 120 4020555 

+91 22 3240 2984 

Mexico 

+52-55-5202-5411, 

+52-55-5202-5445 

Taiwan 

886 2 8698 1238 

U.S. (New Jersey) 

+1 201 876 3457 

U.S. (San Jose, California) 

+ (408) 452 7651 

China 

+86 10 88519191 

Germany 

+49 (0) 89 288 90251 

Japan (Tokyo) 

+ 81 3 5776 2751 

Netherlands 

+31 73 658 1900 

UK (Camberley) 

+44 0 1276 608000 

U.S. (Virginia) 

+1 703 647 8400 

U.S. (Torrance, California) 

+1 310.533.8100 

Tip: Please visit http://www.safenet-inc.com/Support for the most up-to-date 

information about Sentinel Keys, downloads, FAQs, and technical notes. 

Sentinel Hardware Keys Developer’s Guide xvii

We Welcome Your Comments 

Export Considerations 

We offer products that are based on encryption technology. The Bureau of 

Industry and Security (BIS) in the U.S. Department of Commerce administers 

the export controls on our commercial encryption products. 

Rules governing exports of encryption can be found in the Export Administration 

Regulations (EAR), 15 CFR Parts 730-774, which implements the 

Export Administration Act (“EAA” 50 U.S.C. App. 2401 et seq.). 

An Important Note 

BIS requires that each entity exporting products be familiar with and comply 

with their obligations described in the Export Administration 

Regulations. Please note that the regulations are subject to change. We recommend 

that you obtain your own legal advice when attempting to export 

any product that uses encryption. In addition, some countries may restrict 

certain levels of encryption imported into their country. We recommend 

consulting legal counsel in the appropriate country or the applicable governmental 

agencies in the particular country. 

We Welcome Your Comments 

To help us improve future versions of the documentation, we want to know 

about any corrections, clarifications or further information you would find 

useful. When you contact us, please include the following information: 

The title and version of the guide you are referring to. 

The version of the software you are using. 

Your name, company name, job title, phone number, and e-mail 

address. 

Send us e-mail at: techsupport@safenet-inc.com 

xviii Sentinel Hardware Keys Developer’s Guide

Part 1 

Sentinel Hardware Keys 

Basics 

Software piracy problem and its solution 

Sentinel Hardware Keys SDK components 

Planning application protection and licensing 

strategy

Chapter 1 

Introduction 

In this chapter we will assess how software piracy threatens your profits and 

understand how Sentinel Hardware Keys (also referred as “Sentinel Keys”) 

can curb widespread piracy and add value to your software distribution. 

Software Piracy Hurts Your Business 

Software piracy hurts the bottom-line of your business. Every year a huge 

share of revenue is lost due to piracy—affecting your profits and subsequently 

the product research and development prospects. 

Software piracy can occur in many forms, varying from malicious counterfeiting 

to unintended violations of the license agreement by users who may 

be unaware they are doing so (for example, more than permissible number 

of users using the application concurrently, unreported installations, and 

exchange of software disks among peers). 

Software licensing not only effectively secures against piracy but can also 

enhance product versatility with flexible licensing models. You can use new 

avenues to distribute your applications and ultimately improve your returnon-investment. 

Moreover, software protection must be simple to implement, 

so that your schedules are not burdened with lengthy training and licensing 

implementation. Read on to know how Sentinel Keys can do all this and 

much more! 

Sentinel Hardware Keys Developer’s Guide 3

Chapter 1 – Introduction 

Contents Glossary Index Troubleshooting 

Sentinel Keys Protect Against Software Piracy 

4 Sentinel Hardware Keys Developer’s Guide 

 

Sentinel Keys provide hardware token-based licensing to your software 

application(s). These also provide better market penetration through easyto-implement 

licensing models, such as demos, lease, and network licenses. 

This section briefly explains the process of protecting your application and 

describes how the protected application will behave when your customers 

run it. 

In order to protect your application, you first need to design the protection 

strategy in the Sentinel Keys Toolkit 1 (referred as Toolkit hereafter). The 

Toolkit is the main application using which you will do everything from preparing 

a protection strategy to programming hardware keys. 

Note: You may also program your Sentinel Keys using the Key Programming APIs. 

Please refer to the section “Programming Sentinel Keys using the Key Programming 

APIs”. 

The Toolkit provides two basic methods to protect your applications: 

CodeCover Protection 2 : The method in which protective wrappers 

are put around the application quickly and easily. For more details, 

see Chapter 4, “Protecting Applications Using CodeCover,” on page 

75. 

API Protection: The method in which you insert the Business Layer 

API functions into your application's source code. For more details, 

see Chapter 5, “Protecting Applications Using API,” on page 109. 

Whatever method you choose, the outcome will be a protected application, 

different from the original application. The protected application is dependent 

on the Sentinel Key for execution. It will check for the presence of the 

Sentinel Key in order to run successfully. If the operation is successful, the 

application is allowed to run. If it fails, such as when the correct Sentinel 

1.Available only on Windows. 

2. Available only on Windows and can be used for protecting Windows 32-bit and 64-bit executables, 

DLLs, and BPLs.

Sentinel Keys Protect Against Software Piracy 


Key is not attached or has been tampered with, access to the application is 

denied. Since the application can be programmed to check for the Sentinel 

Key periodically, it is impossible to remove it while the application is running. 

As a result, the protected application is allowed to run only when the 

stipulated licensing conditions are met. For example, the users may be able 

to freely copy your application, but will not be able to execute it beyond the 

number of users allowed. 

You can see the diagram below to understand the typical behavior on the 

customer site when the correct Sentinel Key is attached or not. 

Licensing Behavior on Application Run-time 




Note: The Secure Communication Tunnel (term used in the diagram above) is 

explained on page 14. 

License Models to Increase Your Revenue 


 

Sentinel Keys provide the most advanced hardware-based protection 

against software piracy. For software vendors and developers, it opens a new 

world of opportunities by preventing illegal copying and distribution of their 

proprietary applications. It also provides better market penetration by 

increasing the product usage/trial rate among the potential customers. A 

few examples are described below. Using Sentinel Keys, you can: 

Lease the protected application for a certain period. Later, your 

customers may want to extend the lease or convert it to a perpetual 

license. 

To lease your applications, you can choose from RTC-based Sentinel 

Keys or non-RTC tokens with Sentinel V-ClockTM . 

RTC-based Sentinel Keys contain an internal real-time clock to track 

the exact date and time of the leased applications. The real clock keeps 

track of time independent of the system clock—providing the best 

solution against time tampering attacks. 

The non-RTC tokens with Sentinel V-Clock also allow reliable and 

secure distribution of time-limited applications. These do not require 

an on-board battery to detect time tampering. 

Sell demo versions of the protected application. These can be 

upgraded to full-versions whenever desired. 

Provide stand-alone and network 3 licenses for individual customers 

and enterprise-level set-ups. 

Protect multiple applications with a single Sentinel Key. 

3. Also known as concurrent or floating licenses.

Sentinel Keys Offer Sophisticated Protection 


Activate and renew applications/features, increase lease/demo limits, 

add new licenses and convert to full versions remotely (such as, using 

an e-mail). 


This section provides a summary of the main features of Sentinel Keys SDK, 

which make it the most reliable and chosen solution to protect your intellectual 

property and copyrights. 

Hardware Key with Cutting-edge Security Technology 

Sentinel Keys use the cutting-edge technology for superior security. Here are 

the major highlights of the hardware key: 

Contains the ECC algorithm for digital signing and verification, 

providing data authentication, confidentiality, integrity, and nonrepudiation. 

Contains the 128-bit AES algorithm for block encryption/decryption 

and query-response protection. 

Provides secure communication using the Secure Communication 

Tunnel. The tunnel is an end-to-end secured session between the 

application and the Sentinel Key. The communication packets are 

encrypted using the AES algorithm, for which the session key is 

generated using ECC-based key exchange (ECKAS-DH1). 

Allows random generation of ECC and AES keys. Unlimited number of 

keys can be generated. 

Uses chip-on-board (COB) technology for better performance, high 

reliability, and greater protection against reverse engineering. 

Uses mirroring and self-correction for higher reliability against 

memory corruption. 

Has the in-built capability to write-once in the field. It means that 

ignoring the access rights, the data can be modified at run-time only 





 

once. Hence, it prevents unauthorized revisions of the data contained 

in the Sentinel Key. 

Supports universal binaries for compatibility with PowerPC and Intelbased 

Macintosh systems. 

USB 2.0 compliant, full-speed for bulk transfer. 

16-bit RISC MCU for high performance. 

WHQL certified Sentinel System Driver for Windows 2000, XP (32-bit 

and x64), Server 2003 (32-bit and x64), Vista (32-bit and x64), 

Server 2008 (32-bit and x64), Server 2008 R2 (x64), and Windows 7 

(32-bit and x64) compatibility. 

Role-enforcement Using Hardware Keys 

The Toolkit application is used to prepare important and confidential license 

policies. Hence, it is important to restrict the unauthorized access to the 

Toolkit. To control this, you are provided with a developer key, a hardware 

key to authenticate developers. Other users, who do not have the developer 

key, might be able to access the Toolkit, but will not be able to do any productive 

tasks (such as, prototyping the protection strategies, etc.). You can 

further prevent unauthorized use of your developer key by setting a password 

for it. This will ensure that any malicious user having access to your 

developer key cannot use it to tamper the protection strategy or program the 

Sentinel Keys, Also, once you have programmed Sentinel Keys for your customers, 

other developers cannot program or update them using their 

developer keys. 

Similarly, your sales distributors require a distributor key (the hardware key 

you specifically program for each distributor) to program Sentinel Keys for 

your customers 

Innovative Licensing Models for Market Penetration 

Sentinel Keys not only secure unauthorized usage of your software, but also 

provide options to package your software differently to suit different price or 

feature categories. Using Sentinel Keys, you can:



Easily create demos, time-limited, and executions-limited software 

packages. 

Distribute stand-alone licenses, typically used by home users and 

individuals. 

Distribute floating licenses, typically used in enterprises. 

Lease your software for certain time periods. 

Allow license sharing for each Seat user. 

Allow terminal clients. 

Robust Protection Options 

The Sentinel Keys SDK provides robust methods to protect applications. It 

has options to quickly protect your applications (using the CodeCover and 

Quick CodeCover) and ways to implement intensive and controlled protection 

strategies (using API protection). Here are the quick highlights of these 

methods: 

The CodeCover 4 provides automatic and faster protection for 

Windows executables, DLLs, and BPLs. It is capable of protecting 

against debugging, disassembling, reverse-engineering, and memory 

dumping attacks. The Quick CodeCover is a variant of the CodeCover 

and offers basic protection. It is typically used for getting started with 

the Toolkit and protecting applications. 

CodeCover Command-Line Protection - CodeCover protection 

using command-line options not only saves your time but also 

enables you to execute Sentinel CodeCover protection from batch 

files without going through the Sentinel Keys Toolkit screens. 

The Sentinel Keys Command-Line CodeCover Utility is also 

referred to as CMDShell.exe. The utility is a console-based program 

that protects executables, DLLs, and BPLs via command-line. For 

4.An automatic method of protecting Windows executables, DLLs, and BPLs. It does not 

require source code of your application. 




more information, please refer to the section “Command-Line 

CodeCover Utility”. 


 

Under API protection, you call the Business Layer API functions into 

your application source code. These functions let you implement both 

basic and advanced protection, There are functions for 

encrypting\decrypting data using 128-bit AES, digitally 

signing\verifying data using ECC, reading and writing data into the 

key memory (such as, integers, Boolean, string, and raw data). 

For a quick look at the Business Layer API functions, see the diagram 

below. The Business Layer API Help contains details on using each API 

function. You can launch it from the Help menu of the Toolkit, 

browse in the Help directory of the compiler interfaces.

The Business Layer API Functions 



Smart and Flexible (One-time) Implementations 

The Toolkit is based on the architecture that divides the complete licensing 

process as per the different roles seen in real-life. Typically, the license 

designing and implementation part is done by the developers, while the 

license management and hardware key programming is handled by marketing 

and administration personnel, involved in license fulfillment. 

The stand-alone License Manager application is also available for your distributors 

using which they can program Sentinel Keys. The number of 

licenses sold by them can be traced using the distributor key count. The 

count can be updated remotely. 





 

Note: If desired, your Sentinel Key vendors can program Sentinel Keys in bulk for 

you. See the option described on page 206. 

Convenient Licensing for Your Customers 

Sentinel Keys are ultimately deployed on your customer's site to allow 

authorized access to your protected applications. The following features 

ensure that the licensing process is enforced without being inconvenient: 

Easy-to-carry, small, and durable tokens. 

Hardware-based licenses unaffected by application crashes/ 

uninstallations. 

Self-guided license installation/updates using the Secure Update 

Wizard (for Windows only). 

Remote license installation, addition and updates (via e-mail and file). 

License tracking and client information using a Web browser-based 

monitoring tool. The same tool provides an option to system 

administrators for canceling licenses. 

Support for widely used TCP/IPv4 along with the next generation 

Internet protocol TCP/IPv65 , on Windows, Linux and Macintosh. 

XML-based configuration files for network application users and 

Sentinel Keys Server. 

Support for Different Types of Programming 

Environments 

Sentinel Hardware Keys offer different interfaces for programming that 

enable a quick implementation of your protection strategy. 

5.TCP/IPv6 communication (between the application and the hardware key) is supported 

only on the same subnet. Please see Question 12 of Chapter 2 to view the list of operating systems 

on which SHK supports IPv6.

Programming 

Utility 

Sentinel Keys 

Toolkit 

Stand-alone 

License 

Manager 

Key 

Programming 

APIs 



The table below provides a summary of each programming component and 

the category of users using them. 

Various Key Programming Interfaces for Sentinel Keys 

User Associated File/ 

Key 

Usage Description 

Developer Developer Key Refer to page 203, for more information. 

Distributor Distributor 

Key 

.lgx file 

Developer Developer 

Key 

*.ISV file 

Distributor Distributor 

Key 

*.DIS file 

The .lgx file is a package of licenses that 

you want to program in the Sentinel Key 

for your customers. 

Only a Developer along with a Developer 

Key, can generate the *.ISV file, using the 

Sentinel Keys Toolkit. Once generated, this 

file is programmed into the end user 

token, in association with a Developer Key. 

Only a Developer, along with a Developer 

Key, and in the presence of a Distributor 

Key, can generate the *.DIS file, using the 

Sentinel Keys Toolkit. Once, generated by 

a Developer, it is provided to the 

Distributor. The distributor programs the 

end user token with its contents, in 

association with a valid Distributor Key. 

Operator *.OPR file Only a Developer, along with a Developer 

Key, and in the presence of an end user 

token, can generate the *.OPR file, using 

the Sentinel Keys Toolkit. Once generated, 

this file is programmed into the end user 

token at the fulfillment center, without 

any authentication. 

Note: The .lgx/*.ISV/*.DIS/*.OPR files are generated by the Developer using the 

Sentinel Keys Toolkit. 




Frequently Asked Questions 

Question 1 - What is the Secure Communication Tunnel? 

The Secure Communication Tunnel is an end-to-end secured session 

between the client and the Sentinel Key for providing secure private communication. 

The communication packets are encrypted using the AES 

algorithm, for which the session key is generated using ECC-based key 

exchange (ECKAS-DH1). 

It provides maximum protection against the following types of attacks that 

can foil the security of your protected applications: 

Record/playback attacks 

Driver emulation attacks 

Middle layer key communication attacks 

Brute force attacks 


 

The tunnel is created at the time of obtaining a license and is maintained 

throughout the session. The tunnel can exist over a local workstation for 

stand-alone applications and on a subnet for network application. 

The following diagrams depict how the protected application and Sentinel 

Key communicates over the secure communication tunnel, in network and 

stand-alone modes.



Secure Communication Tunnel 




Question 2 - What are the typical ways to verify the presence of the 

Sentinel Key? 


 

Sentinel Key is a state-of-the-art cryptographic device with many capabilities. 

For example, you can use the 128-bit AES algorithm for data 

encryption/decryption or use the ECC algorithm for digital signing and verification. 

The Sentinel Keys can also store variety of data in its memory like, 

strings, integers, Boolean, and raw data commonly used by developers. 

You can utilize these capabilities to verify Sentinel Key's presence via a rich 

set of Business Layer API functions. In addition, you can wrap multiple 

CodeCover layers around your compiled files, which is only for Windows 

executables, DLLs, and BPLs. Both the methods provide secure and robust 

licensing. 

Given below are a few examples of verifying the Sentinel Key's presence: 

Use the SFNTReadString API function to read a string written on the 

Sentinel Key. 

Use the SFNTEncrypt API function to encrypt the data. 

Use the SFNTDecrypt API function to decrypt the data. 

Use the SFNTSign API function to digitally sign the data. 

Use the SFNTVerify API function to verify the digital signature. 

Use the SFNTQueryFeature API function to perform the queryresponse 

operation and to verify the licensing controls. 

Note: The Sentinel Keys client library functions are known as the Business Layer 

API functions. For more information, refer to its Help available under the 

Help menu of the Toolkit. 

Question 3 - Is it always necessary to use the Toolkit for protecting 

applications? 

The workflow of protecting application requires you to use the Toolkit for 

almost all the tasks, from preparing protection strategies to programming 

hardware keys. However, you may also program your keys using the Key



Programming APIs. Refer to the section, “Programming Sentinel Keys 

using the Key Programming APIs”. 

Please do not try implementing the licensing scheme incompletely or 

directly (such as by just calling the Business Layer API functions and linking 

libraries). Refer to the Sentinel Keys Toolkit Help or this guide for understanding 

the complete steps involved. 




18 Sentinel Hardware Keys Developer’s Guide

Chapter 2 

Sentinel Hardware Keys SDK 

Components 

Overview 

This chapter provides information about the major components included in 

the Sentinel Hardware Keys SDK. 

The Sentinel Keys SDK contains various components that are used by the 

following category of users: 

Developer - An individual or a software development company that 

uses the Sentinel Keys SDK to protect and license their applications. 

Distributor - An individual/organization authorized by the 

developer to distribute the protected application along with the 

Sentinel Keys. 

Customer - An individual/organization using a Sentinel Key 

protected application. 

Operator - An individual/group who is unaware of the contents on 

the Sentinel Keys, and is more concerned about the number of tokens 

being programmed using the programming utility/stand-alone 

executable provided to him by a Developer. 


Chapter 2 – Sentinel Hardware Keys SDK Components 


Deployer: An individual responsible for protecting applications at 

the customer’s site using a Custom CodeCover Key and Command- 

Line CodeCover Utility provided by a Developer. 

The table below provides a summary of hardware keys that are included in 

Sentinel Keys SDK. 

Summary of the Sentinel Hardware Keys 

Component Description 

Developer Key The hardware key that must be attached to the system where the Toolkit is 

running. 

Distributor Key The hardware key that must be attached to the system where the stand-alone 

License Manager application is running (typically meant for the distributors). 

Sentinel Key The hardware key that is programmed with the application protection 

strategy (by a developer or distributor) and shipped to the customers. A 

customer cannot use the protected application without it. Sentinel Key is 

available for both the stand-alone and network environments (and is 

referred hereafter as stand-alone key and network key, respectively). 

Following table provides summary of each of the Sentinel Keys SDK 

component. 

Summary of the Sentinel Keys SDK Components 



Server 

Sentinel 

System Driver 


Toolkit 

Command-Line 

CodeCover 

Utility 

Key 

Programming 

APIs 

A program that manages the Sentinel Keys license information in a network. 

The device driver for all the USB tokens included in the SDK. 

A Java application used by the developer for preparing the application 

protection strategy and performing related activities. 

A console-based program that protects executables, DLLs, and BPLs using the 

CodeCover method via command-line. Please refer to the Command-Line 

CodeCover Utility ReadMe, for more information. 

Set of API functions used for programming Sentinel Hardware Keys, and 

creating update packets. Please refer to the Key Programming API Help, for 

more information. 


Compiler 

Interfaces 


License 

Manager 


License 

Monitor 


Protection 

Installer 

Configuration 

Files 

Remote 

Update 

Options 

Developer Key 

Developer Key 


Summary of the Sentinel Keys SDK Components 


The popular languages/compiler interfaces for implementing the API 

protection. 

A stand-alone application used by the distributor for programming Sentinel 

Keys for customers. 

A Web based tool using which the system administrator (on the customer’s 

site) can monitor, track, and cancel licenses. This tool also helps view/update 

the information related to Sentinel Keys Server, stored in the server-side 


An installer that can be either run directly or integrated with your application 

installer to redistribute the Sentinel System Driver, Sentinel Keys Server, and 

Sentinel Protection Server. Refer to Chapter 10, “Redistributables for 

Customers and Distributors,” on page 223 for more information. 

Refers to the two configuration files (client-side and server-side) that can be 

used by your customers for configuring the protected application and 

Sentinel Keys Server, respectively. 

Refers to the methods for updating applications and hardware keys in the 

field (the process is known as remote update process). 

The subsequent sections contain details of each component mentioned in 

above tables. 

The developer key is meant for you—the software publisher/vendor, who 

prepares the application protection strategy using the Toolkit. The developer 

key provides an authentication and signing mechanism to the 

developer—much more convenient and secure than the key access passwords 

because it contains 128-bit AES secret keys for the following: 

Digitally signing the licenses programmed into the Sentinel Keys 

Encrypting the remote update packets 




Digitally signing the licenses programmed into the distributor keys 

These seeds are unique for each developer. As a result, a license created 

using your developer key will not match with that of any other developer. 

Please note that: 

Uniquely Matched Hardware Keys 

You typically require one developer key to use the Toolkit. 

No configuration/programming is required to use the developer key. 

The USB device can be plugged-in and is ready for use as soon as it is 

detected by the system. 


 

You will not be able to build (prototype) the protection strategy in the 

Toolkit, unless the developer key is plugged-in. 

If your developer key supports password authentication and if you 

have enabled the authentication (refer Question 7), the Toolkit allows 

you to perform the key-dependent operations (refer Question 11) only 

after specifying the correct password. 

Password-protected Developer Key 

A developer key for which access has been restricted using a password is 

called a password-protected developer key. A password is defined by the developer 

who owns the developer key. The password length can vary from 8 to 

16 alphanumeric characters.

Distributor Key 



Note: A password can be set for only those developer keys for which the Configure 

Password option on the Options menu of Sentinel Keys Toolkit is 

enabled. 

A password-protected key can be used to perform key-dependent operations 

(refer Question 11), only after the valid password has been specified. The 

password remains valid for a particular session till the developer key is 

plugged out. 

You can change the password or disable it. To do so, you must remember the 

original password. The Frequently Asked Questions section of this chapter 

contains complete steps for enabling/disabling/changing the password. 

Do NOT forget the password of your developer key! If forgotten, the Toolkit does 

not allow you to reset/disable/change the password; and you will need to contact 

SafeNet to request for the new developer key. 

The distributor keys are meant for your sales distributors authorized to program 

Sentinel Keys for your customers using the strategy you created. 

Note that: 

The distributor key can contain a metering count to control the 

number of licenses programmed by the distributor. 

You will provide them a file (paired with the distributor key) using 

which they will import the protection strategy in the License Manager 

application. The details are provided in Chapter 9, “Programming 

Sentinel Hardware Keys,” on page 203. 

Each distributor requires a different distributor key and its paired file. 

Note: You will need to order more distributor keys, if more than one distributors 

are to program Sentinel Keys for your customers. 





The Sentinel Keys are meant for your customers. They will be able to run 

your protected application only if the correct Sentinel Key is accessed. It is 

available for both stand-alone and network environments: 

Top-view of Sentinel Key 


 

Stand-alone Keys 

Refers to the hardware keys that allow access to the protected 

application(s) on a system. A stand-alone key is connected directly to 

a user’s local workstation. Stand-alone keys have zero (0) hard limit 

and do not serve any license requests from network. Hence, these can 

neither be detected by the Sentinel Keys Server running on the 

system, nor monitored by the Sentinel Keys License Monitor. 

Network Keys 

A network key allows multiple network clients to run the protected 

application concurrently. It is typically connected to a networked 

system where the Sentinel Keys Server is running. The network keys 

are meant for the number of users defined by the hard limit. If desired,



you can program a user limit for restricting the hard limit (see Hard 

Limit). 

One Network Key For Multiple Clients in LAN/WAN 

Sentinel Keys Models 

Details about the Sentinel Keys Models 

Model Name Description Characteristics 

Sentinel S Stand-alone 

non-RTC version 

Form-factor: USB 

Total memory: 8KB 

Hard-limit: Zero (0); for standalone 

users only 

Algorithms: AES and ECC 

Sentinel V-Clock 




Details about the Sentinel Keys Models (Continued) 


Sentinel SN Network non-RTC 

version 

Sentinel ST Stand-alone RTC 

version 

Sentinel SNT Network RTC 

version 

Sentinel X Stand-alone 

Extended Memory 

non-RTC version 

Sentinel XN Network Extended 

Memory non-RTC 

version 



Hard-limit: 3, 5, 10, 25, 50, 100, 

and 250 






users only 


Real Time Clock battery with lifetime 

of 4 years 



Hard-limit: 3, 5, 10, 25, 50, 100, 

and 250. 



of 4 years 




users only 





Hard-limit: 3, 5, 10, 25, 50, 100, 

and 250 






Details about the Sentinel Keys Models (Continued) 


Sentinel XT Stand-alone 

Extended Memory 

RTC version 

Sentinel XNT Network Extended 

Memory RTC 

version 




users only 



of 4 years 



Hard-limit: 3, 5, 10, 25, 50, 100, 

and 250. 



of 4 years 

See also, Appendix C, “Sentinel Keys Hardware Specifications,” on page 

277. 

Note: A Sentinel Key can also be initialized as Custom CodeCover Key for protecting 

application at the customer’s site. For information on Custom Code- 

Cover Key, see “About Custom CodeCover Key” on page 95. 

Sentinel Extended Memory Hardware Key (SHK XM) 

SHK XM is a 64K variant of Sentinel keys that can be utilized to create 

advanced and robust protection strategies of larger size. With a memory size 

as large as 64K, SHK XM provides the following benefits: 

Increased Feature Size: The maximum size of data that can be 

stored in the Raw Data and String features has been increased from 

256 bytes to 2032 bytes. 

Enhanced License Size: The size of licenses that can be 

programmed into Sentinel Keys of 8K memory is limited to 1792 




bytes. SHK XM allows you to program licenses of a size as much as 

4080 bytes. This provides the following benefits: 


 

More licenses —You can design 7-8 licenses of 2032 bytes each, 

at the License Manager stage of the Toolkit. 

More features per license—You can add more number of 

features in your license. 

The above capabilities of SHK XM can be utilized to create advanced and 

robust protection strategies of larger size. 

Sentinel Dual Hardware Keys 

Sentinel Dual Hardware Keys provide migration platform for Sentinel Ultra- 

Pro and Sentinel SuperPro developers and customers to the much-advanced 

Sentinel Hardware Keys. Sentinel Dual Hardware Keys are available in USB 

form factor with the following two flavors: 

Sentinel Dual Hardware Keys for UltraPro: Meant for Sentinel 

UltraPro-based developers and customers 

Sentinel Dual Hardware Keys for SuperPro: Meant for Sentinel 

SuperPro-based developers and customers 

Refer to “Migration from SuperPro and UltraPro” on page 279 for more 

details. 

Sentinel Keys Server 

The Sentinel Keys Server manages the licenses available with the Sentinel 

Keys attached to a system. 

It maintains a database of the Sentinel Keys attached to a networked system 

and handles the availability, maintenance, sharing, and cancellation of 

licenses for its clients. It must be redistributed with your network applications. 

A few of its important characteristics are given below: 

The Sentinel Keys Server is available across platforms. For example, 

Sentinel Keys attached to a Windows system can be accessed by a 

protected application running on Linux and vice-versa.



Sentinel Keys Server provides an HTTP interface to view the Sentinel 

Key(s) and license details via a Web browser, and to update server-side 

configuration file. It is known as the Sentinel Keys License Monitor. 

Sentinel Keys Server only manages the network keys attached to a 

system. It does not manage the stand-alone keys. 

Note: Administrator privileges are required for installing, starting, stopping, and 

restarting the Sentinel Keys Server. 

For Windows 

Supports the following platforms: 

Windows 2000 Professional 

Windows XP Professional (32-bit and 64-bit) 

Windows Server 2003 (32-bit and 64-bit) 

Windows Vista Ultimate (32-bit and 64-bit) 


Windows Server 2008 R2 (64-bit) 

Windows 7 (32-bit and 64-bit) 

Supports TCP/IPv4 and TCP/IPv6 1 protocols. 

Installed at the following path on a Windows 32-bit NT-based system: 

:\Program Files\Common Files\SafeNet Sentinel\Sentinel 

Keys Server. 

Installed at the following path on a Windows x64 system: 

\Program Files(x86)\Common Files\SafeNet 

Sentinel\Sentinel Keys Server. 

It runs as a service on the Windows system. 

1.Supported only on the same subnet. Please see Question 12 to view the list of operating systems 

on which SHK supports IPv6. 




For Linux (Daemon) 

Supports the following platforms: 

Red Hat Enterprise Linux ES/AS 4.7 and 5.4 (32-bit and x64) 

Red Hat Enterprise Linux WS 4.7 and 5.4 (32-bit and x64) 

Red Hat Enterprise Linux Desktop 4.7 and 5.4 (32-bit and x64) 

Fedora 9.0 (32-bit and x64), 10.0 (32-bit), and 11.0 (32-bit) 

Open Suse 11.1 (32-bit and x64) 

Suse Linux Enterprise Server 10.2 (32-bit and x64) 


Installed at the following path on a Linux system: /opt/ 

safenet_sentinel/common_files/sentinel_keys_server. 

For Macintosh 

Supports the following 32-bit and x64 platforms: 

Macintosh 10.3.9 (32-bit), 10.4.11 (32-bit), and 10.5.8 (32-bit) 

for PowerPC 

Macintosh 10.4.11 (32-bit), 10.5.8 (32-bit), and 10.6.1 (32-bit 

and x64) for Intel 


Installed at the following path on a Macintosh system: /Applications/ 

Safenet Sentinel/Common Files/Sentinel Keys Server. 


 

1.Supported only on the same subnet. Please see Question 12 to view the list of operating systems 

on which IPv6 is supported.

Sentinel System Driver 



The Sentinel System Driver is the device driver for communicating with the 

USB hardware keys listed below. It must also be redistributed with your protected 

applications: 


Sentinel Dual Hardware Keys 

Developer Keys 

Distributor Keys 

UltraPro Keys 

SuperPro Keys 

Sentinel Duo Keys (for SuperPro-protected applications on 

Macintosh) 

The platform-specific information is given below: 

For Windows 

Supports the following Windows platforms (Windows NT does not 

support USB): 

Windows 98 and ME (for only client-side support) 

Windows 2000 Professional 

Windows XP Professional (32-bit and 64-bit) 


Windows Vista Ultimate (32-bit and 64-bit) 


Windows Server 2008 R2 (64-bit) 

Windows 7 (32-bit and 64-bit) 

Microsoft Windows Hardware Quality Labs (WHQL) certified for 

Windows 2000, XP (32-bit and x64), Server 2003 (32-bit and x64), 




Vista (32-bit and x64), Server 2008 (32-bit and x64), Server 2008 

R2 (x64), and Windows 7 (32-bit and x64). 


 



System Driver. 


\Program Files (x86)\Common Files\SafeNet 

Sentinel\Sentinel System Driver. 

For Linux (USB Daemon) 

Supports the following Linux platforms: 

Red Hat Enterprise Linux ES/AS 4.7 and 5.4 (32-bit and x64) 

Red Hat Enterprise Linux WS 4.7 and 5.4 (32-bit and x64) 

Red Hat Enterprise Linux Desktop 4.7 and 5.4 (32-bit and x64) 

Fedora 9.0 (32-bit and x64), 10.0 (32-bit), and 11.0 (32-bit) 

Open Suse 11.1 (32-bit and x64) 

Suse Linux Enterprise Server 10.2 (32-bit and x64) 

Installed at the following path on a Linux system: /opt/ 

safenet_sentinel/common_files/sentinel_usb_daemon. 

For Macintosh (KEXT) 

Supports the following 32-bit and x64 Macintosh platforms: 

Macintosh 10.3.9 (32-bit), 10.4.11 (32-bit), and 10.5.8 (32-bit) 

for PowerPC 

Macintosh 10.4.11 (32-bit), 10.5.8 (32-bit), and 10.6.1 (32-bit 

and x64) for Intel 

Installed at the following path on a Macintosh system: /System/ 

Library/Extensions.

Backward-compatibility Information 

Sentinel Keys Toolkit 


For Macintosh, if any of the following Sentinel products are already installed 

on your system, then the installation package will upgrade the existing Sentinel 

System Driver (KEXT/Framework): 

Sentinel UltraPro SDK 

Sentinel SuperPro SDK 

Sentinel Protection Installer 

Sentinel Keys Toolkit 

The Toolkit is a Java application. It is used for preparing the application protection 

strategy and programming hardware keys for your customers and 

distributors. Here are some features of the Toolkit: 

About the Toolkit Screens 

This section introduces you to the various screens of the Toolkit and guides 

you on the tasks that can be performed in each screen. For more details, you 

can refer to the Sentinel Keys Toolkit Help. 

Quick CodeCover 

In the Quick CodeCover screen, you can protect an executable with popular 

licensing controls, like an expiration date, expiration time, and execution 

count. 

The CodeCover tab on the License Designer screen provides you with 

advanced options, like multi-file and data file protection, and so on. 

License Designer 

In the License Designer screen, you can design and build your application 

protection strategy—a license template consisting of CodeCover and API 

features. You can begin by creating a template using the License Designer 

wizard. 




For Windows, you may also associate the Secure Update Wizard here for 

remote activation. 

License Manager 


 

In the License Manager screen, you can package the licenses and program 

hardware keys. Groups are created to package the license (templates). Subsequently, 

these groups are used for programming Sentinel Keys and 

distributor keys. Using the Export - File Manager dialog of License Manager, 

you can export .ISV, .DIS, *.OPR, and .NLF files used for key 

programming and remote license additions. Using the License Manager 

screen, you can also create a Custom CodeCover Key and generate update 

code for modifying the expiry date of a Custom CodeCover keys. 

Update Manager 

In the Update Manager screen, you can create update actions and generate 

update codes for remotely updating the hardware keys. 

API Explorer 

In the API Explorer screen, you can experiment with the Business Layer 

API prior to adding them into your source code. It also generates the usage 

code in popular programming languages for a platform. 

Key Status Panel 

A Key Status panel (in the left-side of the Toolkit) that displays the developer, 

distributor, and Sentinel hardware keys attached to the system. You can 

select the hardware key using the left and right arrow buttons. This panel 

can be used to view details of the attached hardware key, including the key 

type, developer ID, and serial number. For Sentinel Keys, the Key Status 

panel helps you identify the capability which can be: 

RTC— Sentinel Key with real-time clock (RTC) 

NRTC—Sentinel Key with no real-time clock (RTC) support 

DUAL— Sentinel Dual Hardware key

Command-Line CodeCover Utility 


XM RTC—Sentinel Extended Memory (XM) Hardware Key with RTC 

support 

XM NRTC—Sentinel Extended Memory (XM) Hardware Key with no 

RTC support 

Note: For Distributor and Developer keys, the capability is displayed as NEU to 

indicate that the attached key is a Non End User key. 

The following figure shows how the key status panel appears for a developer 

key, distributor key, and for a non-RTC Sentinel Key. 

Key Status Panel 

Note: The Key Status panel behaves different in the API Explorer screen, where 

it establishes contact with the Sentinel Key only when the SFNTGetLicense 

API function is successfully executed. 


The Command-Line CodeCover Utility is meant for the developers who 

want to incorporate the process of protecting files (applying the CodeCover 

layer) into their application build process. This allows them to protect files 

without having to use the Toolkit. The tool protects the files using the 

options specified in the license template file and programs the license into 





 

the Sentinel Key attached to the system. This tool also provides the developer 

an option to customize the source files and the destination path, using 

the CodeCover option XML file. 

You need to attach both the Developer Key and Sentinel Key (of the same 

developer ID), to protect files and program keys using the Command-Line 

CodeCover Utility. However, if you are using the Custom CodeCover Key, 

the Developer Key and Sentinel Key are not required as in that case the utility 

can be used for applying only the CodeCover protection and not for 

programming Sentinel Keys. 

For more information, refer to “CodeCover Protection Using the Command- 

Line Utility” on page 91. 

Key Programming APIs 

Key Programming APIs include the API functions used for: 

Programming the Sentinel Hardware Keys 

Provides a Toolkit independent programming environment wherein 

the license group files are exported by the developer and programmed 

into the memory of the Sentinel Keys using the Key Programming 

API functions. 

Refer to section, “Programming Sentinel Keys using the Key 

Programming APIs” on page 208. 

Creating Update Packets: The update packets are generated to: 

Enable creation of data buffers 1 (also termed as update packets) 

that overwrites new values to the existing features in the Sentinel 

Hardware Keys in field, or 

Overwrite the values (provided at the license designing stage) by 

key programming the Sentinel Key, with .ISV/.DIS/.OPR file, 

before it is distributed to the end user. 

Note: SFNTCreateUpdatePacket API function of the Key Programming library is 

1.Set of encrypted data.



used to generate the update codes. Refer to, page 149. 

The update packets enable you to update the end user token for the license 

feature(s) as follows: 

1. License/Feature Update: 

AES and ECC 

Activating, Deactivating, or Modifying Key 

Overwriting, Incrementing or Detaching Execution Count 

Setting new Expiration date, Detaching Lease 

Integer, String, Raw, Boolean 

Modifying value 

Changing Write Password 

Counter 

Overwriting and Incrementing the Counter value 

Set User Limit 

2. Sentinel Key Update 

Set Device Date 

Set Cheat Counter 

Note: Please refer to the Key Programming API Help, for more information. 




Compiler Interfaces 

For implementing the API-based protection, the following language/compiler 

interfaces are provided: 

For Windows a 

Compiler/Environment Version Type 

AutoCAD (ARX) 14, 2000, 2004, and 

2007 b 


 

Static (MT) Static (MD) Dynamic 

Borland C 5.5 

Borland C++ Builder 5.0 and 6.0 

Borland Delphi 5.0 and 6.0 

COM object (Microsoft Visual C) 6.0 

Microsoft Visual BASIC 6.0 

Microsoft C# .NET 2002, 2003, 2005c, 2008 c , and 2010c Microsoft VB .NET 2002, 2003, 2005 c , 

2008 c , and 2010 c 

Microsoft Visual C++ 6.0, 7.0, 8.0, 9.0, and 

10.0 

a. The Windows x64 libraries are provided for Microsoft VC, .NET C#, VB .NET, and COM only. 

b. The ReadMe files for these compiler interfaces are provided at the location, \Compiler 

Interfaces\Other Interfaces\. 

c. For Windows x64 platforms, versions 2005, 2008, and 2010 are supported. 

 

 

 

 

Java Native interface (J2SE SDK) 1.5 and 1.6 

Fortran Intel Visual 9.0 b 

Foxpro Microsoft Visual 9.0 b 

Windev Pc Soft 11.0 b 

Macromedia Flash 8.0 b 

Power Builder 10.0 b

GCC a 

For Linux 


Java Native interface (J2SE SDK) a 

a. Also supported on Linux x64 platform. 

Static Dynamic 

4.0.2 

1.5 and 1.6 

For Macintosh 


Code Warrior a 

GCC b 

REALbasic a 

Java Native interface (J2SE 

SDK) c 

Xcode b 

a. Available only on Macintosh PowerPC. 

b. Also supported on x64 platform. 

c. Also supported on Macintosh Intel x64 platform. 

Static Shared Framework 

10.0 

4.2 

2007, 2008, and 

2009 

1.5 and above 

2.x on Mac 10.4.11 

3.x on Mac 10.5.8 

and 10.6.1 

For Carbon, the supported versions are: 10.3.9, 10.4.11, 

and 10.5.8 

License Manager (Stand-alone) 

License Manager (Stand-alone) 


 

 

 

A Java application that your distributor can use for programming Sentinel 

Keys for customers. You also need to provide a license group file (.lgx) and 

the associated distributor key. A license group is a package of licenses that 

you want to program in the Sentinel Key for your customers. 





 

Tip: The License Manager application resembles the License Manager screen of 

the Toolkit. However, the functionality is limited to programming Sentinel 

Keys. The License Manager Help included with the application describes the 

steps for using it. 

Sentinel Keys License Monitor 

Sentinel Keys License Monitor is a Web-based management tool that provides 

a user-friendly interface to Sentinel Keys Server. It is used for the 

following: 

To view details of the Sentinel Keys and clients accessing them. It is a 

convenient way to view and track license activity and analyze 

application usage. For example, your customer could use it to 

determine whether or not enough licenses were purchased, based on 

license demand. 

To cancel the licenses issued to clients from a Sentinel Key. For details 

on canceling a license, please refer to the Sentinel Keys System 

Administrator Help. 

To view and configure the start-up settings for the Sentinel Keys 

Server, which are stored in the server-side configuration file 

(sntlconfigsrvr.xml). 

Sentinel Keys License Monitor provides critical information related to Sentinel 

Keys Server, such as number of keys attached and licenses in use. Hence 

its access is restricted to only a specific set of users in a network. Only an 

authorized set of users, defined in the sntlconfigsrvr.xml, can access Sentinel 

Keys License Monitor. 

Following is the information displayed on the various pages of Sentinel Keys 

License Monitor: 

Welcome Page 

The Welcome page provides an overview of the enhancements and new 

features in the current release of Sentinel Keys License Monitor. It also dis-



plays answers to some frequently- asked questions for an better 

understanding of the enhancements. 

Keys Information Page 

The Keys Information page provides details about the network keys connected 

to the Sentinel Keys Server. These details (as displayed on different 

pages) include: 

Main Page 

Sentinel Keys Server host's IP address 

Number of Sentinel Keys attached to the system 

Serial Number 

Hard Limit 

Total number of licenses in use (sum of licenses issued from the 

Sentinel Key) 

License Information Page (clicking Keys# will display this 

page) 

License # (a list of licenses/templates programmed into the 

Sentinel Key) 

License ID 

User limit 

Number of licenses in use 

Client Information Page (clicking License# will display this 

page) 

Option to cancel licenses (if enabled) 

(Client) System name 

User name 

Client login time 

Client process ID 




Configuration Page 


 

The Configuration page helps view/edit the Sentinel Keys Server configuration 

settings, which are specified in the server-side configuration file. You 

can edit the following fields: 

Error log: Specifies the name (not the path) of the log file, which is 

used to record errors related to network/client-server 

configuration. 

Response log: Specifies the name (not the path) of the log file, 

which is used to record the transaction log for Sentinel Keys 

Server. It records information related to the Sentinel Keys Server 

startup, shut-down, clients accessing the network keys and 

licenses in-use. The specified file is created at the location where 

the Sentinel Keys Server is installed. 

SKLM Port: Sets the Sentinel Keys License Monitor HTTP port. 

The default port is 7002. It can be set as a value between 1024 to 

65535. Setting the value to 0 disables the SKLM port. 

Server Port: Sets the Sentinel Keys Server socket port. The default 

port is 7001. It can be set as a value between 1024 to 65535. 

Make sure that the port specified is not in use, and the same value 

is specified in the client-side configuration file. Setting the value to 

0 disables the Server port. 

Protocol(s): Sets the network protocol for the client-server 

communication. The supported protocols are SP_TCP_PROTOCOL 

(for TCP/IPv4) and SP_TCP6_PROTOCOL (for TCP/IPv6 1 ). 

Authorized user list: Specifies the IPv4 addresses of the remote 

clients that are allowed to access Sentinel Keys License Monitor. 

Only a valid IPv4 address can be entered (NOT computer name, 

MAC address, or IPv6 address). The maximum number of IP 

addresses allowed is 32. By default, the loopback address is 

displayed in this field. 

1.Supported only on the same subnet. Please see Question n to view the list of operating systems 

on which SHK supports IPv6.



To save the settings specified on the Configuration page in the server-side 

configuration file, click Update. The Sentinel Keys Server will use these settings 

on next restart. 

Note: If multiple users concurrently update the server-side configuration file 

(directly or by using Sentinel Keys License Monitor), the file reflects only 

the last saved changes (the changes done by the user who is the last one to 

click Update). 

Please refer to the Sentinel Keys System Administrator Help for more information 

on Sentinel Keys License Monitor. 


The Sentinel Protection Installer is an integrated installer of the Sentinel 

System Driver, Sentinel Protection Server, and Sentinel Keys Server. These 

components are required by the customers using your protected 

applications. 

Note: No additional steps are needed to deploy Sentinel Keys License Monitor, 

unless you are customizing its .class files. Refer to the Customizing Sentinel 

Keys License Monitor - ReadMe for details on customization. 

Using Sentinel Protection Installer, the deployment of redistributables 

becomes rather simple. It offers you the following two choices: 

You can directly ship the Sentinel Protection Installer to your 

customers. They can run the installer to install Sentinel System 

Driver and/or Sentinel Keys Server without any assistance. A copy of 

this installer is also available at our Technical Support Web site 

(www.safenet-inc.com/support/tech/sentinel.asp). 

If desired, you can integrate the Sentinel System Driver and Sentinel 

Keys Server along with your application’s installer. 

For more details on redistributables, see Chapter 10, “Redistributables for 

Customers and Distributors,” on page 223. 




Configuration Files 

Sentinel Keys SDK provides you the following configuration files: 

Client-side Configuration File (sntlconfig.xml) 

Using this file, the protected application users can set these 

parameters: the network protocol, Sentinel Keys Server host, 

heartbeat interval for maintaining license time, and Sentinel Keys 

Server socket port. See the section “About Client-side Configuration 

File” on page 66 for details. 


 

Server-side Configuration File (sntlconfigsrvr.xml) 

Using this file, the system administrator (root user) on the customer 

site can set the start-up parameters for Sentinel Keys Server. These 

parameters include: the network protocol for client-server 

communication, Sentinel Keys License Monitor HTTP port, Sentinel 

Keys Server socket port, logging details, and allowed users of Sentinel 

Keys License Monitor. The information stored in this file can be 

updated by a remote network user using Sentinel keys License 

Monitor. The server-side configuration file is located at the following 

path: 

Remote Update Options 

On Windows: :\Program Files\Common Files\SafeNet 

Sentinel\Sentinel Keys Server\sntlconfigsrvr.xml. 

On Linux: /opt/safenet_sentinel/common_files/sentinel_keys_server/ 

Sntlconfigsrvr.xml. 

On Macintosh: /Applications/Safenet Sentinel/Common Files/Sentinel 

Keys Server/Sntlconfigsrvr.xml. 

You can provide the following options to your customers for updating hardware 

keys in the field: 

Secure Update Utility 

Secure Update Wizard (for Windows only)

Secure Update API 



Your distributors can use the Secure Update Utility for easily updating the 

distributor keys. 

Refer to Chapter 6, “Secure Remote Updates,” on page 137 for details. 


Question 1: Can a stand-alone key be used by a single user in the 

network? 

No. A stand-alone key provides licenses to the users on the system where it 

is attached (local workstation). 

Its licenses are neither managed by the Sentinel Keys Server, nor monitored 

by the Sentinel Keys License Monitor. 

Question 2: How can I install and run the Toolkit? 

For details on installation, please refer to the Release Notes available in the 

Manuals directory. 

Question 3: I received some hardware keys with the SDK. How do I 

order additional hardware keys? 

The Sentinel Keys SDK has the following three hardware keys: 

Developer Key 

This is required by the developer who uses the Sentinel Keys Toolkit. 

You require ONLY ONE developer key. If you happen to lose it, contact 

your SafeNet Sales representative for replacement. 

Sentinel Key 

This will be programmed for your customers—without which they 

will not be able to run your protected applications. To order additional 

Sentinel Keys, you should contact the SafeNet Sales representative 

They can guide you further on which Sentinel Key suits your 

requirements best. In general, you should be aware about the 

following: 

Do you want stand-alone keys or network keys? 




If you want network keys, what is the hard limit you want? 


This will be programmed for your sales distributors, so you can 

control the number of licenses they program into the Sentinel Keys. 

To order additional distributor keys, you should contact the SafeNet 

Sales representative. 


 

Question 4: I have installed Sentinel Hardware Keys on Linux/Macintosh, 

but I do not see the Toolkit in the installed components. Is it 

supported on Linux/Macintosh? 

No, the Toolkit is not available on Linux/Macintosh. Sentinel Hardware 

Keys (version 1.2.1 and higher) enable the developer to generate header files 

for protecting applications on Linux/Macintosh from Windows Toolkit. 

Developers need to transfer the header files generated with Windows Toolkit 

manually to the Linux/Macintosh platform. Refer to the release notes for a 

detailed list of installed components on all supported platforms. 

Question 5: How can I identify if my developer key supports password 

protection capability? 

In Sentinel Keys Toolkit, look for the Configure Password option on the 

Options menu. This option is enabled for ONLY those developer keys that 

support password protection capability. 

Question 6: I forgot my developer key’s password. How can I get a 

new password or disable the authentication? 

If you have forgotten your developer key’s password, then contact your 

SafeNet Sales representative for a new developer key. 

You can still explore the Toolkit interface by selecting the Skip this ISV 

token check box when prompted for password. But, the key-dependent 

operations will not be allowed till the correct password is entered. Please see 

Question 11 to view the list of these key-dependent operations. 

Question 7: How can I set a password for my developer key? 

1. Open the Sentinel Keys Toolkit, and click Options -> Configure 

Password -> Enable Password. (The Configure Password option 

is enabled for only those developer keys that support password

authentication.) 



2. Enter the password in the New Password and Confirm Password 

fields. The password can contain 8 to 16 alphanumeric characters. 

3. Click OK. 

Note: After the password is successfully set, the Enable Password option is disabled. 

The option becomes available again only if you disable the authentication. 

Now, the Toolkit will prompt you to enter the password as soon as you plugin 

the developer key. Only after specifying the correct password, you can 

access the complete functions of Toolkit. However, if you choose to skip the 

password, you are not allowed to perform key-dependent functions (refer 

Question 11). On skipping the password, Toolkit does not prompt for password 

for that particular Toolkit session. 

Question 8: Can I enable my developer’s key password again once I 

have disabled it? 

Yes. The steps to enable the password are similar to the steps of setting a 

password, as explained in Question 7 above. 

Question 9: How to change the password of my developer key? 


Password -> Disable/Change Password. 

2. Select the Change Password check box. 

3. Enter your old password in the Password field. 

4. Enter the new password in the New Password and Confirm Password 

fields. The password can contain 8 to 16 alphanumeric characters. 

5. Click OK. 




Question 10: I configured a password for my developer key. But I 

no longer want to use it. How can I disable it? 


Password -> Disable/Change Password. 

2. Enter the developer key’s password in the Password field, and click 

OK. 


 

Question 11: Which operations are not permitted in Toolkit when 

password authentication for the developer key is skipped? 

You cannot perform the following key-dependent operations until you enter 

the correct password for the developer key: 

Building the protection strategy 

Programming hardware keys 

Creating a WPS file 

Generating *ISV, *.DIS, *.OPR, and *.NLF files 

Generating update codes 

Question 12: What is the minimum operating system support 

required for using IPv6? 

The IPv6 support has been provided only for the same subnet. Following 

table lists the minimum operating system support required for using IPv6 in 

SHK. 

IPv6 supported Operating Systems 

Operating System Supported Versions 

Windows Windows XP Professional 

Windows Server 2003 

Windows Vista - Ultimate 

Windows Server 2008 

Windows Server 2008 R2 

Windows 7



IPv6 supported Operating Systems 

Operating System Supported Versions 

Linux Red Hat Enterprise Linux ES/AS 4.7 and 5.4 

Red Hat Enterprise Linux WS 4.7 and 5.4 

Red Hat Enterprise Linux Desktop 4.7 and 5.4 

Fedora 9.0, 10.0, and 11.0 

Open Suse 11.1 

Suse Linux Enterprise Server 10.2 

Macintosh Macintosh 10.5.8 (for PowerPC and Intel) and 10.6.1 

(for Intel) 





Chapter 3 

Planning Application 

Protection and Licensing 

Strategy 

The first part of this chapter introduces you to the concepts used for planning 

the application protection and licensing strategy. The latter part 

breaks-down the various tasks involved in planning application protection. 

About Features, Templates, and Groups 

This section explains the concepts of features, license templates, and groups 

as used in the Sentinel Hardware Keys Toolkit and other components. 

Features 

A feature is the most basic unit of an application protection strategy. The 

Toolkit assigns a feature ID to every feature created in a license template. 

Described below are the features you can create in the Toolkit: 

CodeCover Feature 

When you use a CodeCover feature, protective wrappers are put 


Chapter 3 – Planning Application Protection and Licensing Strategy 



 

around your application (.exe, .dll, or .bpl) that guard it from 

unauthorized access. Refer to the section on page 55 for more details. 

API Features 

When you use API features to protect your applications, you need to 

add the Business Layer API functions into your application code. You 

can create the following API features in the Toolkit: 

AES - A 128-bit AES algorithm-based feature that allows you to: 

Encrypt data 

Decrypt data 

Use the query-response protection 1 

Specify licensing controls (like, expiration date, expiration 

time, and an execution count). 

ECC - An ECC algorithm-based feature that allows you to: 

Digitally sign content 

Verify signed content 

Specify licensing controls (like, expiration date, expiration 

time, and an execution count). 

String - A data feature that can contain up to 2032 2 ASCII 

printable characters. 

Raw Data - A data feature that can contain 2032 2 -bytes of any 

developer-defined data type, including printable/non-printable 

characters and hexadecimal numbers. For example, _4ÒJë¿:"A"g- 

Æµþ_n°_Ç&´_Â). 

Integers - A data feature that can contain any of the following 

integers: 8-bit (0 to 255), 16-bit (0 to 65,535), or 32-bit (0 to 

4,294,967,295). 

1. To understand the query-response protection, please see “Implement Query-Response Protection” 

on page 172. 

2.The maximum length is 2032 bytes for SHK XM keys; and 888 bytes for non-XM keys.



Boolean - A data feature that can contain a true or false value. 

Counter - A data feature that can contain a count-down value 

between 0 to 4,294,967,295. 

(License) Template 

A license template is a container of features that define your application protection 

strategy. The Toolkit assigns a unique license ID to every license 

template created/duplicated, so that multiple licenses can be programmed 

in a Sentinel Key. 

Note: The license templates are created in the License Designer screen using 

the License Designer Wizard. Refer to the Sentinel Keys Toolkit Help for 

complete details. 

A license template is typically created to secure a single application. Each 

template can have multiple features to control the distinct application functionality, 

such as the compile, save, and print operations. 

For example, AppSoft Corp wants to protect its three applications—WordEditor 

App, Database App, and Drawing App. It creates three license templates 

to protect each application. Each license template has multiple features that 

control the independent functionality of the application, such as the Counter 

feature can control the number of times the File Save option can be run. 

Group 

A group 3 is a package of licenses (templates) that you want to program in 

the Sentinel Key for your customers. These groups can be created to meet 

the packaging and licensing requirements. 

Note: The license groups are created in the License Manager screen. More 

information on license grouping is provided in “License Grouping” on 

page 187. 

3. The distributor keys are also programmed with a group. 




Relating Features, Templates, and Groups 




About CodeCover Protection (For Windows Only) 

In CodeCover, protective wrappers are put around your application that 

guard it from unauthorized access. CodeCover encrypts your original application 

and will deny access unless the correct Sentinel Key is always present 

and all the licensing conditions are met. 

The CodeCover has multi-layer architecture. The previous layer, only if executed 

successfully, will decrypt the successive layer. Multiple layers provide 

extra protection to your application—similar to what multiple locks provide 

to your door. Breaking them require additional resources, time, and skill 

that could potentially deter hacking attacks. Further, due to the random 

pattern of the layers, no two CodeCover implementations are same. 

CodeCover Protection in Action 

CodeCover also provides the following security options that you can choose 

while adding a CodeCover feature (steps are provided in Chapter 4, “Protecting 

Applications Using CodeCover,” on page 75): 

Multi-layered Protection 

The CodeCover provides multi-layered protection. Since the joint 

between an application and the CodeCover layers is vulnerable to 





 

attacks, you can choose the number of layers the CodeCover uses to 

protect your application, from level 1 to 5. Level 1 provides reasonable 

protection and level 5 provides the most protection. However, with 

each level of protection added, the size of the application and the time 

it takes to start up also increases. By default, level 3 multi-layering is 

used. 

Anti-debugging Protection 

The CodeCover is capable of detecting debuggers, like SoftICE and 

OllyDbg. It can also provide reasonable protection against breakpoints 

targeted at important functions. You can choose to deny 

application execution in the presence of debuggers. An error message 

is displayed when the protected application is executed from a 

debugger to indicate that the application can not run. Also, if a 

debugger is attached to the running application, the application 

terminates silently within two minutes. 

Anti-reverse Engineering Protection 

Using CodeCover SDK macros, you can add additional level of security 

to your application. CodeCover SDK provides run-time protection to 

your business logic. You can protect important parts of your 

application (strings, constants, and code fragments) for various 

compiler interfaces available, such as Visual C, Visual BASIC, and 

Delphi. 

Using CodeCover SDK macros, you can either obfuscate or encrypt 

your important data. The code fragments obfuscated with Code Morphing 

are difficult to understand in disassemblers and during runtime 

analysis. You can use Crypt macros to encrypt important code 

fragments, constants, and strings. The encrypted code fragments are 

decrypted only when executed and are encrypted back after their execution 

is complete. The constants and strings are decrypted in a temporary 

memory area which is cleared after the usage is complete. 

Refer to the ReadMe available at the \Sentinel Keys Toolkit\Shell 

SDK\Help\English folder for details.



Note: For 32-bit, Code Morphing is supported for Visual C++ compilers and runtime 

encryption is supported for Visual C++, Visual BASIC, and Delphi compilers. 

For 64-bit, run-time encryption is supported only for Visual C++ applications. 

Also, you can implement CodeCover SDK in unmanaged part of the mixed 

mode .NET applications. 

Anti-dumping Protection 

CodeCover provides protection against a memory dump of the 

protected application. You need to select the Hide import symbols 

check box (under the Security tab of Add/Edit CodeCover Feature 

dialog box) to enable this added protection. 

Anti-disassembling Protection 

A CodeCover-protected application is difficult to disassemble due to 

the use of expert techniques, like Maze technology and dummy 

macros. 

Enhanced security for .NET applications 

.NET Enhancements feature provides enhanced security to pure .NET 

applications (executables and DLLs). 

Support for Terminal Client 

Using the support for Terminal Client you can protect your 

applications in a terminal service environment. It is similar to using 

Windows Remote Desktop. 

Data File Protection 

Using CodeCover, you can encrypt your important data files that are 

used by the protected application at run-time. The encrypted data 

files cannot be accessed from other applications. You can also specify 

to use standard AES algorithm for encrypting the data files. However, 

AES encryption should not be used to protect data files if the 

application executes on Windows 9x as well. 

Note: Data file protection is not supported with 32-bit and 64-bit .NET DLLs. 




When to Use CodeCover? 

The CodeCover is a popular method of protecting Windows executables, 

DLLs, and BPLs because: 

It is extremely easy to implement. People with no-programming 

experience can use it without any hassles. 

It does not require source code of your application. 

It uses the 128-bit AES algorithm for protection. 

It allows implementing the most-popular licensing models in just a 

few clicks. 


 

It helps implement anti-debugging, anti-reverse engineering 

protection; and other security features that are not available with API 

protection. 

About API Protection 

When you use API features to protect your applications, you need to add the 

Business Layer API into your application code. 

The Business Layer API are the Sentinel Keys API functions—used for communicating 

between your application and the Sentinel Key. These API 

functions can be used for verifying the Sentinel Key's presence by obtaining 

a license, reading/writing data on its memory, encrypting/decrypting data, 

signing/verifying data, sending queries and evaluating responses and so on. 

These API functions provide a high-level interaction with the Sentinel Key 

and drastically reduce the efforts involved in implementing several popular 

license models, like demo and leases. 

Note: For platforms other than Windows, CodeCover is not available. 

Using the Business Layer API functions, you can control the amount, frequency, 

and location of the software locks within your application. If an 

unexpected response is received, the action taken is left up to you.



The more locks you add to your application, the more difficult it will be for 

hackers to break your application’s protection. 

When to Use API Features? 

Compared to CodeCover, this method of protection is most commonly used 

when: 

You have access to the source code of the application. 

You want to have control over the protection techniques used to 

secure your application. For example, you can control the amount, 

frequency, and location of the software locks4 within your application; 

and the action taken if an unexpected response is received is left up to 

you. Generally, the more locks you add to your application, the more 

difficult it will be for hackers to break your application’s protection. 

You have a little more time available to implement and test your 

application protection. Typically, the API protection takes longer than 

the CodeCover. Because, to implement the API protection, you must 

understand the various functions and manually add them to your 

code. 

You want to take advantage of the state-of-the-art protection 

techniques possible with Sentinel Keys—like AES-based encryption/ 

decryption, ECC-based signing/verification—in addition to the usual 

data reading and writing methods. Using the API protection, you can 

implement protection, both basic and advanced, that work best for 

your application. 

4. Refers to a decision point in your protected application. The purpose of a software 

lock is to verify the presence of the correct Sentinel Key. For example, an application 

might verify the validity of the signed data or send query data to the Sentinel Key 

and require a specific response in order to continue execution. Other software locks 

may simply read the data and compare it to the value known. 




Creating Features, Templates, and Groups 

You must create a license template in the License Designer screen to add 

features to it. Use the License Designer Wizard to create a license template. 

The Sentinel Keys Toolkit Help provides detailed steps on adding and managing 

features, templates, and groups. 

License Designer Wizard 

Chapter 4, “Protecting Applications Using CodeCover,” on page 75 contain 

steps for adding CodeCover feature. 

Chapter 5, “Protecting Applications Using API,” on page 109 contain steps 

for adding API features. 

Chapter 8, “License Grouping,” on page 187 contain steps on creating license 

groups. 


Planning Application Protection and Licensing Strategy 


Planning Application Protection and Licensing 

Strategy 

To design the application protection strategy, several factors involving 

licensing and security are to be considered. This section discusses a few of 

them: 

How would you like to protect your applications—using 

CodeCover or API features (Business Layer API 

functions)? 

The decision to choose the protection method depends on various factors, 

such as time-in-hand, access to the source code, which platform(s) you are 

supporting and so on. We recommend you understand both the methods 

using the information provided on page 55 and page 58. 

How many different license templates do you need? 

This is typically dependent on the number of applications you want to protect. 

Each license template has a license ID that will distinctly identify it 

when multiple applications are protected using one Sentinel Key. You can 




create a group of the license templates to be programmed into a Sentinel 

Key. 

Which API features will you use? 


 

There are seven API features provided in the Toolkit, including AES and 

ECC. In general, you must include at least one AES feature to implement the 

query-response protection (see page 172). Other factors that help you in 

choosing appropriate features are: 

Estimate the number of independent features that need to be 

controlled/licensed. 

Decide your licensing policy, such as whether you want to provide 

perpetual licenses or demo or try-and-buy licenses. You can create 

time-limited or executions-limited demos. These can be combined 

with a suitable remote activation method to provide try-and-buy 

licenses. 

Identify the data that needs to be digitally signed/ verified and 

encrypted/decrypted. Depending on which you will add one or more 

AES and ECC features. 

Identify the critical data that need to be protected, such as the user 

registration number. Using data type features (String, Boolean, Raw 

Data, and Integers), you can store variety of data in the Sentinel Key 

memory. 

Note: While creating the license groups you can modify the licensing settings, 

such as the expiration date, time, or execution count. This will NOT affect 

the CodeCover or API implemented in the application/source code.



What should be the maximum memory size of the group 

I can program in the Sentinel Key? 

Size of the License Group: The maximum size of the group that can 

be programmed depends only upon the memory size of the attached 

user key. The size of the group should always be less than the memory 

size of the attached user key. The memory size of the group to be 

programmed in the Sentinel Key is shown in the Group Layout. 

Size of the License Template: The maximum memory size of a 

license template in a group must not exceed 4080 bytes. 

Would you like to specify the number of 

users—different from the hard limit? 

Sentinel Keys come with standard hard limits (3, 5, 10, 25, 50, 100, and 

250), you might want to impose a soft-limit—known as the user limit. 

The user limit restricts the number of users allowed by the hard limit. Otherwise, 

the number of users allowed is equivalent to the hard limit. For 

example, if the Sentinel Key hard limit is 25 and you need to allow for maximum 

15 users, then stipulating a user limit equal to 15 meets your 

requirements exactly. 

Specifying User Limit 

The user limit common (global) to a license. You can associate it with a 

license template in the Toolkit. 

You can specify a user limit using various options in the Toolkit (such as, at 

the time of creating a template using the License Designer wizard). A 

quick option, suitable for an already created template, is described below: 

1. In the License Designer screen, load the template for which a user 

limit is to be specified. 

2. In the template layout, select a template and right-click to open a 

short-cut menu. 





 

3. Click Properties. The dialog box shows the user limit for the license 

template. Note that if 0 user limit is specified now (also the default 

value), then it is not possible to customize the user limit afterward; the 

user limit will always be equal to the hard limit. However, if you specify 

a value other than zero, then you can optionally modify it later 

through the following means: 

At the time of programming Sentinel Keys. To do so, make sure you 

keep the Override user limit later check box selected. 

Remotely update the user limit by using the Update user limit 

command (see the last row of the table “Feature and License Action 

Type” on page 158 for details). 

Note: The user limit can be updated remotely only if a non-zero user limit was 

specified in the license template. 

Do you plan to allow/disallow license sharing? 

A license is said to be shared when multiple instances of a protected application 

on a seat can be run using one license. 

A seat represents a user name and MAC address combination. 

For a stand-alone key user, a license is always shared. 

For network key users, license sharing is not enabled by default. 

Therefore each instance of the application (regardless of the seat) will 

consume one user limit/hard limit.

Enabling License Sharing 



The decision to share licenses depends on your licensing policy. To enable 

license sharing: 

For CodeCover-protected applications, you can specify ON in the 

License sharing option (under the Networking tab). 

For API-protected applications, you need to call the SFNTGetLicense 

function with the SP_SHARE_ON flag. 

Are you protecting applications for a stand-alone or 

network environment? 

This decision will help you in choosing the type of Sentinel Key you want to 

ship with your protected application. Please note that a stand-alone key 

cannot provide licenses to network users; while, a network key can provide 

licenses to users across LAN/WAN. 

In addition, you will also need to decide the access mode you want to set in 

your application. For extensive and busy networks, you can ship a clientside 

configuration file with your protected application. 

About Access Modes 

An access mode determines the route a protected application follows to 

obtain a license. Sentinel Keys Toolkit allows you to use one of the following 

access modes: 

Stand-alone mode (SP_STANDALONE_MODE) 

The application looks for a license on the same system without 

requiring the Sentinel Keys Server (it directly accesses the Sentinel 

System Driver). If the required Sentinel Key is not attached to the 

system, an error is returned. 

Server mode (SP_SERVER_MODE) 

The application obtains a license from a network key. It does not look 

for a stand-alone key. A specific host can be set using the 

SFNTSetContactServer API function or the client-side configuration 

file. Else, the license request will be broadcasted within the subnet. 




However, note that SFNTSetContactServer has higher priority over 

the client-side configuration file. 

About Client-side Configuration File 


 

The client-side configuration file is meant for your customers—the protected 

application users. By default, this configuration file exists, by the 

name sntlconfig.xml, in the same directory where your protected application 

is installed. However, you can specify a different name and path for the configuration 

file by using either the SFNTSetConfigFile Business Layer API or 

the Customize Sentinel configuration file path and name option 

available in the Toolkit during CodeCover protection. 

The protected application users can set the parameters (tags) described 

below: 

Protocol 

Sets the network protocol for client-server communication. If a protocol is 

specified here, the same must be set in the server configuration file. 

Tag Values 

For Windows/Linux/Macintosh, the following protocols (tags) are 

supported. 

TCP/IPv4 (SP_TCP_PROTOCOL) - The default protocol supported. 

TCP/IPv6 5 (SP_TCP6_PROTOCOL) 

ContactServer 

Sets the Sentinel Keys Server host (the system where the Sentinel Key is 

attached). It can be set across LAN and WAN. 

Multiple entries (up to 100) can be specified, separated using a new line 

character (the Enter key). The license will be searched for in the order mentioned 

(top to bottom). 

5.Supported only on the same subnet



Please note that the SFNTSetContactServer function has higher priority 

over this tag. If the tag is empty, the license request will be broadcasted 

within the subnet. 

Tag Values 

For Windows: You can set a workstation name, IP address, or 

NetBIOS name. 

For Linux: You can set a workstation name or an IP address. 

For Macintosh: You can set a workstation name or an IP address. 

Heartbeat/Maintain License Time 

Sets the heartbeat interval for maintaining the license acquired by network 

applications. Please note that any setting in SFNTSetHeartbeat (for API-protected 

applications) or under the Networking tab (for CodeCover-protected 

applications) will override the value specified in the configuration file. 

Tag Values 

The default value is 120 seconds. It can be set as any value from 1 minute to 

30 days, in multiples of 1 second. You can also choose from the following 

constants: 

SP_MAX_HEARTBEAT = 2592000 

SP_MIN_HEARTBEAT = 60 

SP_INFINITE_HEARTBEAT = 0xFFFFFFFF 

ServerPort 

Sets the Sentinel Keys Server port. 

Tag Values 

The default port is 7001. It can be set as a value between 1024 to 65535. 

Make sure of the following: 

The port specified is not already in use. 

The same value must be specified in the client-side configuration file. 




Protecting For Stand-alone Environments 

When protecting an application for stand-alone environment, you must 

note the following points: 

Distribute a stand-alone key with your protected application. 

The Sentinel Keys Server is not required by stand-alone applications. 


 

You must specify stand-alone access mode using the options described 

below: 

For API-protected applications, call the SFNTGetLicense API 

function with the SP_STANDALONE_MODE flag. 

For CodeCover/Quick CodeCover-protected applications, select 

STANDALONE from the Access mode drop-down box. 

The network API functions, like SFNTGetServerInfo will return error. 

Note: The terminal clients can access both the network and stand-alone Sentinel 

Keys in a network. To allow stand-alone keys (Sentinel S and ST) access, set 

the SP_ENABLE_TERMINAL_CLIENT flag in the SFNTGetLicense API function. 

The network keys (Sentinel SN and SNT) can be accessed without any 

such setting. 

Protecting for Network Environments 

Distribute a network key with your protected application. 

Specify network access mode using the following options: 

For API-protected applications, call the SFNTGetLicense API 

function with the SP_NETWORK_MODE flag. 

For CodeCover/Quick CodeCover-protected applications, select 

NETWORK from the Access mode drop-down box. 

When network mode is set, the application looks for a Sentinel Key 

with a license in the following sequence. If the required Sentinel 

Key is not found or a license is not available, an error is returned: 

1.The host specified in the SFNTSetContactServer API function.



2.If Step 1 fails, it looks for the host in the ContactServer tag of 

the client-side configuration file. 

3.If Step 2 fails or the ContactServer tag is empty, the license 

request will be broadcasted within the subnet. 

Note: Broadcasting requires additional network resources and may result in a 

longer time to acquire a license. If network resources and timing is an issue 

for your customers, you may want to set the Sentinel Keys Server host in 

the SFNTSetContactServer API function or they can set it in the client-side 


To allow license sharing for seat users, call the SFNTGetLicense API 

function with the SP_SHARE_ON flag. Else, each instance will 

consume an individual user limit/hard limit. 

Note: You can use the option, Use short ECC for Key Exchange, available at 

the License Designer stage of Toolkit to improve the performance of SFNT- 

GetLicense API in network mode. 

Would you like to allow updating Sentinel Keys 

remotely? If so, then which method would you choose? 

The remote updates allow you to update products, features, and add licenses 

to the hardware keys in the field, using simple methods like, file and e-mail. 

You can choose from the following three methods of remote activation: 

Integrate the Secure Update Wizard with your application (option 

available for Windows only). 

Ship the Secure Update Utility with your application. 

Implement a custom remote activation option using the Secure 

Update API. 

Refer to Chapter 6, “Secure Remote Updates,” on page 137 for details. 






 

Question 1 - How many features can be added into a license 

template? 

You can add up to 255 features into your license template, depending upon 

the size of your token. However, you must make sure to limit the license template 

size to 4080 bytes, while programming your token. 

Question 2 - Can I use the CodeCover and API protection together? 

Yes. For Windows platforms, we recommend combining the API-based custom 

protection with CodeCover. It adds an extra layer of protection. The 

CodeCover encrypts your final executable, which makes it difficult to disassemble 

or debug your application. Even if the attacker manages to overcome 

the difficult task of removing the CodeCover, the application inside is still 

protected—due to two strong layers of protection. 

Question 3 - What is the type of data that can be encrypted/ 

decrypted? 

All kinds of digital data/content can be encrypted/decrypted. 

Question 4 - What is the type of data that can be signed/verified? 

All kinds of digital data/content can be signed/verified. 

Question 5 - What is the size of data that can be encrypted/ 

decrypted? 

You can encrypt/decrypt blocks of 16-bytes using SFNTEncrypt/SFNTDecrypt. 

For larger data, you can use the function in a loop. 

Question 6 - What is the size of data that can be signed/verified? 

The maximum data length that can be sign/verified is 0xFFFFFFFF.



Question 7 - How to specify the number of users for an application/ 

feature? 

By default, the number of users is equal to the hard limit of the Sentinel Key. 

The Sentinel Keys come with the following “standard” hard limits: 3, 5, 10, 

25, 50, 100, and 250. To set the number of users different from that, you 

can specify the user limit for a license under the License/Feature Properties 

dialog box. Here are the steps to open this dialog box: 

1. Right-click the feature (title) in the layout. A short-cut menu appears. 

2. Click Properties. The License/Feature Properties dialog box 

appears. 

Question 8 - For multiple applications, can I specify different user 

limits? 

If you are protecting multiple applications using one Sentinel Key—each 

supporting different number of users in a network—you need to take care of 

the following: 

Distribute a network key with your suit of protected applications. 

Set the user limit for each license template. However, the total number 

of concurrent users cannot exceed the hard limit. There must be a 

hard limit available—regardless of the user limit availability—before 

a license can be obtained. For example, assume the hard limit of your 

Sentinel Key is 20. If you are protecting three applications with a 

single key, you could use the following user limits: 

Set the user limit for application A to ten (10) 

Set the user limit for application B to seven (7) 

Set the user limit for application C to ten (10) 

Notice that the total number of user limits (27) is greater than the 

hard limit (20). This means, if ten users are running the Application 

A, only ten hard limit is left. If seven users are running Application B, 

only three hard limit is left for Application C. Thus, even though 





 

Application C has 10 user limit available, only three users can run it. 

This is because the hard limit is obtained first, then the user limit. 

You may want to share the licenses for seat users. 

Question 9 - Can I import protection strategies (.ltx files), created 

with earlier Windows/Linux/Macintosh versions of Sentinel Hardware 

Keys, in the latest Toolkit version? 

Yes, the protection strategies (.ltx files), created with earlier versions of Sentinel 

Hardware Keys Toolkit on any of the supported platforms, can be 

imported in the latest Sentinel Hardware Keys Toolkit version.

Part 2 

Designing and 

Implementing Protection 

Using the CodeCover protection 

Using the Business Layer API protection 

Designing remote update strategy 

The best practices for secure licensing

Chapter 4 

Protecting Applications 

Using CodeCover 

In this chapter, we will describe how to protect your applications using 

CodeCover. To learn about the CodeCover method of protecting applications, 

see Chapter 3, “About CodeCover Protection (For Windows Only),” on page 

55. 

The CodeCover features can be added only using the Windows version of the 

Toolkit, using any of the following options: 

Under the CodeCover tab of the License Designer screen - This 

option allows you to add a CodeCover feature to an existing license 

template. The complete steps are covered in this chapter. 

Using the License Designer Wizard - This option allows you to 

create a license template by adding a CodeCover or API feature to it. 

Refer to the Sentinel Keys Toolkit Help for complete steps. 

Note: Quick CodeCover, shown on the introductory screen, is a gateway to the 

Toolkit. You can use it for quickly protecting an executable with basic 

licensing controls, like expiration date and execution count. Consider using 

the CodeCover tab on the License Designer screen to make use of 

advanced options, like protecting multiple files at one time and encrypting 

data files. 


Chapter 4 – Protecting Applications Using CodeCover 


Add CodeCover Feature Dialog Box 

Adding Files 

To obtain the Add CodeCover Feature dialog box: 

1. In the License Designer screen, load the template to which the 

CodeCover feature will be added. The loaded template shows in the 

template layout. 

2. Click the CodeCover tab. 

3. Click the Add button. The Add CodeCover Feature dialog box 

appears. 

To add the files for CodeCover protection: 

1. Under the Files tab, click the Add button. 


 

You must add at least one executable, DLL, or BPL file to proceed. You 

can add files from various directories, including any data files. The 

CodeCover layer will be applied to the executables, DLLs, and BPLs; all 

other files will be encrypted at protection-time and can only be 

decrypted at run-time using the protected application. 

2. Type or browse for the path of the destination directory in the edit 

field under the Change destination path check box. This is the destination 

path for writing the output files (recommended step). The 

output files are placed at the specified destination path, within the 

replicated directory structure (similar to original path). 

If you clear this check box, the output files will overwrite the original 

files once the Protect button is clicked. Hence, we recommend that 

you always specify a different path for generating the output files. 

You can select the Use absolute path only check box if you want to 

store all the output files in one folder, rather than in separate folders 

(identified by original directory structure). Do NOT select this check

Adding Files 


box if any of the files you are protecting have same names. 

Note: For better understanding of where the destination files are stored, you can 

refer to the figure “Output Files at the Destination Path (when absolute 

path is not specified)” on page 90. 

3. Specify a CodeCover name (necessary). The constant name will be 

automatically generated. However, you may modify it if needed. 

4. Provide comments for this feature (optional). You can now provide 

the licensing settings. 




Add CodeCover Feature Dialog Box 


Providing Licensing Settings 

To provide the licensing settings: 

Providing Licensing Settings 


1. Click the Licensing tab in the Add CodeCover Feature dialog box. 

2. Choose the desired attributes. Depending on which the other options 

will be disabled/enabled. The attributes are described below: 

CodeCover Licensing Attributes 

Attribute Description Default Setting 

Active Select to provide a perpetual license 

for using the application. 

Lease Select to allow specifying an 

expiration date or expiration time for 

the application. Else, the application 

will use a perpetual license. 

Limit 

executions 

Select to allow specifying the number 

of times the protected application will 

run for. 

Selected 

Not selected 

Not selected 

3. Specify values for default feature instance. The options are described 

below: 

Default Feature Instance Settings 

Item Description Default Setting 

Secret key The 128-bit AES secret key. By default, a secret key is 

generated and shown in 

the Toolkit. You can use the 

icon shown next to 

the Secret key field to 

generate another secret 

key. 

Expiration date Specify an expiration date 

(mm/dd/yy format). 

One year from current date 




Default Feature Instance Settings (Continued) 


Expiration time Specify an expiration time 

(in minutes). 

14400 minutes (10 days) 

Execution count Specify an execution count 

for running the protected 

application. 


 

Note: If you specify both the licensing controls—lease and limited executions—the 

application will expire as soon as any of these limits is reached. 

4. Selecting the Add instances later check box will allow you to add 

new feature instances later in the License Manager screen. This 

option helps in modifying the "licensing values" without modifying 

the "licensing implementation" in the application/code. 

For example, the programmer who implemented the application protection 

had set the expiration date as "10/10/05" and also selected 

this check box. Later, if desired, the marketing/key programming personnel 

can modify it to suit some customer's requirement (such as, 

10/10/07) and program the Sentinel Key. This does not require you 

to apply the CodeCover protection again, modify the API calls, or 

repackage the product. 

You can now specify the networking settings (such as, the access 

mode, license sharing, and maintain license time interval) under the 

Networking tab. 

Providing Networking Settings 

To provide the networking settings: 

1. Click the Networking tab in the Add CodeCover Feature dialog 

box. 

1

2. Specify options using the information below: 

Access 

Mode 

License 

Sharing 

Providing Networking Settings 


CodeCover Networking Settings 


Maintain 

license time 

Terminal 

Client 

Specifies the access mode to 

find the Sentinel Key. 

Specifies whether license 

sharing is enabled or 

disabled. 

Sets the interval for which 

the Sentinel Keys Server 

maintains the license. 

Allows you to protect an 

application in a Terminal 

Service environment. 

This option is enabled only in 

stand-alone mode. It is not 

available in network mode as 

remote client services are 

already ON for network 

applications. 

STANDALONE (Stand-alone 

mode) 

OFF (License sharing not 

allowed for network users) 

120 seconds. If you do not 

modify the default value, 

license time/heartbeat interval 

(if specified) in the 

configuration file will override 

it. 

OFF (Terminal Client service is 

disabled for stand-alone 

applications by default). 

Setting this option to ON 

enables Terminal Client 

Services for CodeCoverprotected 

applications, in 

stand-alone mode. 

For API-protected applications, 

you need to call the 

SFNTGetLicense function with 

the 

SP_ENABLE_TERMINAL_CLIENT 

flag (in API Explorer). 




Customize 


configurati 

on file path 

and name 

CodeCover Networking Settings (Continued) 


Allows you to specify a 

different name and path for 

the client-side configuration 

file. Click Browse or type the 

configuration file path in the 

edit field. The maximum 

length of the configuration 

file’s path and name is 255 

characters. 

The protected application 

will use the configuration file 

with the specified name and 

path for execution. If this file 

does not exist, the 

application uses the 

broadcast mode to obtain 

the license over the network. 

Note: For the license template 

files imported 

from previous Toolkit 

versions, the 

default configuration 

file— sntlconfig.xml, 

is used. 

Enabled when access mode is 

set to NETWORK. By default, 

the check box is not selected. 

You may now specify the advanced security settings for a CodeCover-protected 

application under the Security tab. 


 

If you keep the check box 

clear, the default 

configuration file— 

sntlconfig.xml, is used. This file 

is stored in the same directory 

that of protected application.

Providing Security Settings 

To provide the security settings: 

Providing Security Settings 


1. Click the Security tab in the Add CodeCover Feature dialog box. 

2. Specify options using the information below: 

CodeCover Security Settings 

Item Description Default 

Setting 

Multi-layering 

levels 

Allow my 

application to 

run when a 

debugger is 

present 

You can choose from layers with varying 

strengths, from level 1 to 5. The size of the 

application increases, as more protection code 

is added with higher levels. Level 1 provides 

reasonable protection, with minimum 

increase in the file size. Level 5 

provides maximum protection and maximum 

increase in the file size. 

Please note that you must always run the 

output files (protected applications) in an 

environment, typical to your product users, to 

experience its performance. If the size of the 

application is an issue, you may choose the 

best-fitting level of protection. 

You can keep the check box cleared to deny 

application execution in a debugger. At runtime, 

the protected application will terminate 

if it detects a debugger on the system. Nonmalicious 

users will close the debugger and 

start the application again. 

However, if for some reason you want to 

allow your application to run in the presence 

of debuggers, select this check box. 

Level 3 

Not 

selected 




I have used 

CodeCover 

SDK 

Hide import 

symbols 

Use AES 

Encryption for 

data files 

CodeCover Security Settings (Continued) 


Setting 

Select this check box if you have implemented 

the CodeCover SDK features (Code 

Morphing and/or run-time encryption/ 

decryption) to protect your important code 

fragments, constants, and string data. 

Refer to the ReadMe available in the \Sentinel 

Keys Toolkit\Shell SDK\Help\English folder for 

more details. 

Select this check box to hide your import 

symbols. However, please note that this 

option does not apply to the file types 

discussed in Question 4 (see “Frequently 

Asked Questions” at the end of this chapter). 

The Hide import symbols option is ignored if 

there is any data file to be protected or the 

file encryption settings have been specified. 

Select this check box if you want the data files 

to be encrypted with the standard AES 

encryption. 

Do not select the check box if you want to run 

your application on Windows 98/Me or if your 

application uses the data files protected on 

Windows 9x. 

Not 

selected 

Selected 

Selected 


.NET 

Enhancement 

Customizing Error Messages 


You may now customize the CodeCover error messages and/or change the 

file encryption settings. 

Customizing Error Messages 

You can customize the CodeCover application run-time error messages by 

clicking the Customize the CodeCover error messages link, available 

while adding/editing the CodeCover feature in License Designer of Sentinel 

Keys Toolkit. This is an optional step and the default text messages will 

be shown if you do not modify them. 

To customize the error messages: 

CodeCover Security Settings (Continued) 


Setting 

.NET Enhancement feature provides enhanced 

security to pure .NET applications 

(executables and DLLs). The feature performs 

the following functions: 

Hides original entry point method (only 

.NET executable) 

Encrypts strings of original application 

Encrypts constant of original application 

When this feature is selected then the 

SDNPro.dll (for 32-bit .NET applications) 

and SDNPro64.dll (for 64-bit .NET 

applications) needs to be provided to the enduser 

along with the protected application. 

Note: To use the .NET enhancement feature 

for protecting .NET applications, the machine 

should have the same version of .NET Framework 

and .NET SDK installed. The mixed code 

applications are not supported with the .NET 

Enhancement option. 

Not 

Selected 

1. Click the Customize the CodeCover error messages link, in the 




Add CodeCover Feature dialog box. The Edit CodeCover error 

messages dialog box appears. 

2. You must review the existing messages before deciding to modify 

them. Afterward, you may select an error message from the list for 

modification. 

3. In the edit field, write your message text. It can contain up to 200 

characters. 


 

4. If you are not satisfied with your message text, click Restore to accept 

the original message. Clicking Restore All will replace all the customized 

messages with their original text strings. 

5. You can select one of the following message types for the error messages 

that appear during the execution of a protected application: 

Windows Message: Select if your application is GUI-based. The 

application run-time error messages will be displayed in a message 

box. 

Console Message: Select if your application is console-based. The 

application run-time error messages will be displayed at the 

command-prompt. However for GUI applications, the message 

type is automatically switched from Console Message to 

Windows Message. 

No Message: Select if you do not want to display the run-time 

error messages. 

Customizing CodeCover Error Message Title 

You can customize the CodeCover run-time error message title by clicking 

Customize the CodeCover error message title link, available while adding/editing 

the CodeCover feature in License Designer of Sentinel Keys 

Toolkit. This is an optional step and if you do not use this option, then the 

default string (the application name) is displayed as the title on the error 

message dialog.

To customize the error message title: 

Changing File Encryption Settings 


1. Click the Customize the CodeCover error message title link, in 

the Add CodeCover Feature dialog box. The Customize Code- 

Cover Error Message Title dialog box appears. 

2. Select your choice of title from the following two options provided on 

the dialog: 

Default: This option allows the application name to be displayed as 

the title on the Error Message dialog. Select the Use default string as 

title check box to use this option. 

Custom: This option allows you to define a new caption (blank/ 

customized text string) as the title on the Error Message dialog. You 

can select either of the following options, while customizing the 

CodeCover error message title: 

Use a blank title: Select this option to have a blank title for the 

error message dialog. 

Define a new title: Select this option to enter your own text as 

the title of the error message dialog. This field accepts up to 80 

characters. 

3. Click OK to return to License Designer where you find the CodeCover 

feature added under the CodeCover tab. 

To modify the data file encryption settings, see the steps below. 

Changing File Encryption Settings 

In the CodeCover file encryption settings dialog box, you can specify 

your choices for encrypting the external files, other than the executables, 

DLLs, and BPLs—such as, data files or other file types. Your protected application 

will automatically and transparently decrypt these files at run-time, 

as needed. 

When not-in-use these files remain encrypted. If your application creates 

one of these files, it will be decrypted only if the correct Sentinel Key is being 




used to run the application. Though this step is optional for adding a Code- 

Cover feature, and by default all files, other than .exe, .dll, and .bpl, you 

selected under the Files tab, will be encrypted. 

To specify the file encryption settings: 

1. Click the Change the file encryption options link in the Add 

CodeCover Feature dialog box. The CodeCover file encryption 

settings dialog box appears. 


 

2. Select the Encrypt/decrypt the following files at run-time check 

box. Now, type the file extensions in the edit field. This field can contain 

up to 255 characters. You can filter files using the wildcard symbols 

asterisk (*) and semicolon (;). The 8.10 naming convention is 

followed, meaning that the file name and extension cannot exceed 8 

and 10 characters, respectively. File filters like, *.*, *name.* are not 

acceptable. Given below is a description of the valid conventions: 

Providing Files for Encryption/Decryption 

Convention Example 

*.extension *.txt will encrypt/decrypt files. For example, 

settings.txt and install.txt. 

name*.* safe*.* will encrypt/decrypt files. For example, 

safeobj.htm and safenet.cpp. 

name*.extension safe*.txt will encrypt/decrypt files. For example, 

safeobj.txt and safenet.txt. 

3. The Toolkit automatically generates an encryption seed. If you want 

to provide your own encryption seed, select the Specify my own 

encryption seed check box and edit the value. Please note that if the 

encrypted data files are shared by multiple applications, all the applications 

must use the same encryption seed. The seed can consist of 

two strings of 14 hexadecimal characters each (forming a 112-bit 

long seed). 

4. Click OK. You are returned to the Add CodeCover Feature dialog 

box.

Applying CodeCover Protection 


5. Click OK. You are returned to the License Designer screen where 

you find the CodeCover feature added under the CodeCover tab. 

Note: Your customers need to receive and install the data protection driver in the 

scenarios where you are protecting either of the following: 

- Encrypted data files for Windows 9x, or 

- .NET applications for 9x 

The data protection driver installer can be found in the \Data Protection 

Driver directory of the Sentinel Keys CD. See also, “Deploying Sentinel 

Data Protection Driver (Windows Only)” on page 235. 

Applying CodeCover Protection 

After selecting your choices in the Add CodeCover Feature dialog box, 

you must now click the Protect button. This will wrap the CodeCover layer 

around your executables, DLLs, BPLs; and encrypt the data files (if any). 

This may take time depending upon the number of files and layers you have 

added. 

If you had cleared the Change destination path check box under the 

Files tab, your original files were overwritten during the protection process. 

Your source files are replaced by the output files. Otherwise, your protected 

files were written at the path specified in the Change destination path 

edit field. 

Please note that if you had selected multiple files from different disk drives 

on your system, then the protected files will be copied to the individual 

directories identified by the appropriate drive names and path names (see 

the screen-shot below for an example). This is to ensure that files carrying 




same name, even if selected from different path, are not overwritten during 

the protection and their source path can be tracked easily. 

Output Files at the Destination Path 

(when absolute path is not specified) 

If you selected the Use absolute path only check box, all the output files 

will be stored together in one specified folder, and not in separate folders. 


CodeCover Protection Using the Command-Line Utility 


CodeCover Protection Using the Command-Line 

Utility 

Before you can use the Command-Line CodeCover Utility, you require the 

following Command-Line Utility components on a new system: 

Files to be copied: Before you use the Command-Line Utility on a 

system on which the Sentinel Keys software installation has not been 

performed, you must copy certain files/components to it. Following is 

a list of all possible files/components that you must copy. 

RelLic.dll 

SKCoreJDK.dll 

SKIntfJDK.dll 

SKShell.dll 

SKShellJDK.dll 

DesignIDJDK.dll 

LanguageLibJDK.dll 

OsPlatLibJNI.dll 

DNHelp.dll 

RelLic64.dll 

SDNPro64.dll 

SDNPro.dll 

SKShell641.dll 

SKShell642.dll 

DNHelp.exe 

CMorph.exe 




Note: The above binaries should be copied to the folder where the files CMD- 

Shell.exe, and ShellCommandLine.jar reside. 

Required Installations: 


 

Sentinel System Driver 7.5.1: Sentinel System Driver version 

7.5.1, the Device Driver for the hardware keys should be installed 

on the system so as to detect the keys. 

JRE version 1.6.0: Apart from the above files, please make sure to 

install JRE version 1.6.0 on your system so as to launch the 

Command-Line CodeCover utility. 

Attached Key Specifications: A Developer - User key pair of same 

Developer ID, should be attached to the system. If the utility is being 

used to protect applications at the customer’s location, then only a 

Custom CodeCover key is attached. 

File to be Generated: Sentinel keys License template file (.ltm file), 

created using Toolkit and programmed using the Developer - User key 

pair. 

Default path of .ltm file on a Windows system is: :\Documents and Settings\\My 

Documents\Sentinel Keys 1.3\My License 

Templates\LICENSE_NAME_FOLDER\LICENSE_NAME.ltm. 

Note: You may also use a strategy created (and saved as a License Template) in 

the Quick CodeCover screen of the Toolkit. 

Using the Command-Line CodeCover Utility 

This section provides details on using the Command-Line CodeCover Utility. 

1. Attach the hardware key(s) as specified below: 

For building protection strategy or programming Sentinel 

Keys: Attach the Sentinel Hardware Key and the Developer key to an 

available USB port on your system. The developer ID of the Sentinel

CodeCover Protection Using the Command-Line Utility 


Key and the Developer Key should be the same as that of the 

Developer Key that was used to program the created license. 

For protecting an application at customer’s site: Attach the 

Custom CodeCover Key to an available USB port on your system. 

Ensure not to attach any other hardware key. 

2. Run the Command-Line CodeCover Utility with the appropriate command-line 

options. 

The Command-Line CodeCover Utility Interface 

If desired, you can integrate the utility into your application build process 

(which might be done using a batch file or build script in some environments). 

The following options are provided: 

CMDShell [/?] [/S] /F LicenseTemplateFilePath [/P Password] [/L1 or / 

L2 LogFilePath] [/G or /U CodeCoverOptionFile Path] [/CK] [/RL] 




Note: At a time, only an instance of either the Toolkit, or the Command-Line 

CodeCover utility can be run. 

The following table describes the commands displayed on the Command- 

Line Utility screen: 

Option Description 

/? Displays the help. 

/S Denotes the silent mode and suppresses all messages sent to the 

console. 

/F 

LicenseTemplateFilePa 

th 

Provides the full path of the Sentinel Keys Toolkit license template file 

to load the license template. 

/P Password Specifies the password of the attached developer key for 

authentication. You must use this option if the developer key, using 

which you want to protect the application, is password-protected. 

This option is always used along with the /F option which specifies the 

license template file. 

/L1 LogFilePath Provides the full path of the log file to generate a brief log. 

/L2 LogFilePath Provides the full path of the log file to generate a detailed log. 

/CK Protects files using the Custom CodeCover Key at the customer’s 

location. When using this option, the Developer and Sentinel keys are 

not required. This option cannot be used to program the license into a 


/G 

CodeCoverOptionFile 

/U 

CodeCoverOptionFile 

Generates the CodeCover option XML file using the license template 

file. 

The XML file specifies the source file name and the destination path of 

the various protection features present in the license. This option is 

always used along with the /F option which specifies the license 

template file. 

Protects only the files mentioned in the CodeCover option XML file. This 

option is always used along with the /F option which specifies the 

license template file. 

/RL Retains license in the token once the files have been protected. 


CodeCover Protection using Custom CodeCover Key 


Note: The license template file name and the log file name cannot contain any of 

the following characters: / * ? “ < > | 

Please refer to the Command-Line CodeCover Utility ReadMe, for more 

information. 

CodeCover Protection using Custom CodeCover 

Key 

About Custom CodeCover Key 

In certain situations, you may be required to 

protect applications at the customer’s location. 

For instance, a customer customizes an 

application for some specific requirements 

and then wants you to apply the CodeCover 

protection to the customized application. 

The usual scenario is to carry the developer 

key to customer’s place and then use the 

Command-Line CodeCover Utility to protect 

the files. However, it involves the risk of 

developer key being misplaced and misused 

for creating extra licenses/modifying existing 

licenses. For such scenarios (involving application 

protection at customer’s end), you are 

advised to use the Custom CodeCover Key. 

Please Note: 

What is a Custom Code- 

Cover Key? 

A Custom CodeCover key is a 

Sentinel Key that helps you 

protect applications using 

the Command-Line Code- 

Cover Utility, without 

requiring a developer key. It 

is used to apply CodeCover 

protection to applications at 

the end user’s site. 

A Custom CodeCover key cannot be used to design protection 

strategies or to program Sentinel Keys. It can only be used for 

protecting files using CodeCover. 

It protects files using the options specified in a license template file; 

with the help of Command-Line CodeCover Utility. The license 

template file is created using the same developer key that is used to 

create Custom CodeCover key. 





 

The license template to be programmed into the Custom CodeCover 

key must have at least one CodeCover feature. The features other than 

CodeCover (if present) are ignored. 

Each Custom CodeCover key has an validity date (called global lease 

date) that specifies the date till when this key can be used for 

protection. 

Creating Custom CodeCover Key 

A Custom CodeCover key is created using the Custom CodeCover Key tab 

on the License Manager screen of the Sentinel Keys Toolkit. 

The Custom CodeCover Key Tab 

1. Attach the Sentinel Key that you want to initialize as Custom Code- 

Cover key to a USB port. Attach a developer key of the same developer

CodeCover Protection using Custom CodeCover Key 


ID as that of Sentinel Key. Make sure to select the Sentinel Key in the 

Key Status panel. 

Note: Make sure to attach only one Sentinel Key. 

2. On the License Manager screen, load the group containing the 

license templates that you want to program into the Custom Code- 

Cover key. Select the license(s) having at least one CodeCover feature; 

and if required further select the CodeCover features you want to program 

into the Custom CodeCover Key. 

Note: While creating Custom CodeCover key, the Toolkit ignores API features (if 

any) in the selected license templates. Only CodeCover features are programmed 

into the Custom CodeCover key. 

3. Click the Custom CodeCover Key tab on the License Manager 

screen of the Toolkit. 

4. Click the date picker icon, and select an Expiry Date till which you 

want the Custom CodeCover key to remain valid. 

5. Click Make CodeCover Key to initialize the attached Sentinel Key as 

Custom CodeCover key. The “Key programmed” message appears 

after the Custom CodeCover has been successfully created. 

Using Custom CodeCover Key 

An individual (referred to as deployer) uses the Custom CodeCover key and 

Command-Line CodeCover Utility to protect an application at the customer’s 

location. The customer can then execute the protected application 

using his Sentinel Key. 

The Command-Line CodeCover Utility provides the /CK option that you 

need to use for protecting files using the Custom CodeCover key. For more 

details, please see “Using the Command-Line CodeCover Utility” on page 92. 




What’s Next? 

Updating Custom CodeCover Key 

You may need to update the Custom CodeCover key for extending its expiry 

date. Follow the below steps to update the Custom CodeCover key: 


 

1. Generate a request code (.req file). This request code contains details, 

such as serial number and developer ID, of the Custom CodeCover key. 

2. On the Custom CodeCover Key tabbed page, load the request code 

(.req) file. 

3. Select a developer key in the Key Status panel. The developer key 

should have the same developer ID as that of the Custom CodeCover 

key for which you are generating the update code. 

4. By default, the serial number of the Custom CodeCover key using 

which the .req file was generated is displayed, in the Token Serial 

Number field. You can replace it by the serial number of other Custom 

CodeCover key which you want to update. 

5. Specify a new expiry date for the Custom CodeCover key. 

6. Click Generate Update Code to generate an update code (.upw file), 

which contains the modified expiry date for the custom CodeCover 

key. 

7. Either save the update code to a specified location or e-mail it directly 

to the customer, at the location of whom the Custom CodeCover key is 

used. 

8. Apply the update code using the Secure Update Utility/Secure Update 

Wizard, to update the expiry date of the Custom CodeCover key. 

After adding a CodeCover feature to the license template, you may now: 

Add API features to the license template (see Chapter 5, “Protecting 

Applications Using API,” on page 109).



Build the license template using the instructions described in the 

Sentinel Keys Toolkit Help. 

You can now test your protected application. We recommend testing 

your application to verify that it executes correctly with the 

appropriate Sentinel Key both attached and missing. 

Note: If you are testing your protected application in network environment, 

make sure to restart the Sentinel Keys Server. 





Question 1: Compared to CodeCover option (in the License 

Designer screen), what are the security settings used by Quick 

CodeCover? 

Quick CodeCover makes use of the following security settings (by default). 

The differences with the CodeCover tab (available on the License 

Designer screen) are noted below: 

Multi-layer level - 3. For CodeCover, these levels can be increased/ 

decreased. 

Anti-debugging added - Yes. For CodeCover, you can choose to 

allow/disallow debugging of your application. 


 

Hide import symbols - Yes. For best security settings, Quick 

CodeCover hides the import symbols. However, if the application type 

is not compatible with this setting, Quick CodeCover automatically 

disables this security setting. For CodeCover, you can allow/disallow 

hiding the import table of your application at the time of adding a 

CodeCover feature. 

Question 2: What are the file types/compilers supported by 

CodeCover? 

The table below lists the file types/compilers supported by CodeCover for 32bit 

applications: 

File Types/Compilers Supported by CodeCover 

Compiler/Tool Version Executable DLLs 

Visual C++ 5.0, 6.0, 7.0, 7.1, 8.0, 9.0, 

10.0 

Yes Yes 

Visual Basic 5.0, 6.0 Yes No 

Visual FoxPro 5.0, 6.0, 7.0, 8.0, 9.0 Yes NA 

Borland C++ 

Builder a 

6.0, v2006 Yes Yes 

Borland Delphi 7.0, v2006, v2007 Yes Yes

Power Builder 6.0, 7.0, 8.0, 9.0, 10.0, 10.5, 

11.0 

Director 5.0, 6.0, 8.0, 8.5, 9.0, 10.1, 

MX 2004 

VB .NET b 

C# a 



File Types/Compilers Supported by CodeCover (Continued) 


7.0, 7.1, 8.0, 9.0, and 10.0 

with .NET Framework 

version 1.1, 2.0, 3.0, 3.5, 

and 4.0 

7.0, 7.1, 8.0, 9.0, and 10.0 

with .NET Framework 

version 1.1, 2.0, 3.0, 3.5, 

and 4.0 

Yes No 

Yes NA 

Yes Yes c 

Yes Yes b 

Delphi .NET v2006 Yes Yes 

Borland C# v2006 Yes Yes 

MFC 6.0, 7.0, 7.1, 8.0, 9.0, and 

10.0 

Yes Yes 

Authorware 6.0, 7.0 Yes No 

Windev 11, 12 Yes No 

Labview 7.1 Yes No 

Prolog 7.1 Yes No 

GameMaker 5.0, 7.0 Yes NA 

Excelsior JET 6.0, 6.4 Yes Yes 

Xenoage JEStart 2.0 Yes NA 

MDM Zinc d 2.5, 3.0 Yes NA 

a. Also supports protection of Borland Package Libraries (BPLs). 

b. Applications compiled with Any CPU configuration will execute as 32-bit pro 

cesses on 64-bit platforms. 

c. The.NET Framework must be present on your system for protecting .NET 

DLLs. 

d. MDM Zinc version 2.5.0.6 applications are not supported. 





 

The table below lists the file types/compilers supported by CodeCover for 64bit 

applications: 

File Types/Compilers Supported by CodeCover 


Visual C++ 8.0, 9.0, 10.0 Yes Yes 

VB .NET a 

C# a 

8.0, 9.0, 10.0 with .NET 

Framework version 2.0, 

3.0, 3.5, and 4.0 

8.0, 9.0, 10.0 with .NET 

Framework version 2.0, 

3.0, 3.5, and 4.0 

Yes Yes b 

Yes Yes b 

a. Binaries built with Any CPU and X86 configurations are supported. 

b. The.NET Framework must be present on your system for protecting .NET DLLs. 

Question 3: What are the file types supported by CodeCover for 

encryption/decryption? 

The table below lists the file types supported by CodeCover for encryption/ 

decryption: 

File Types and Applications Supported for Encryption/Decryption 

File Type Applications 

DOC WordPad, MS Word 

RTF WordPad, MS Word 

HTML Internet Explorer, MS Word 

GIF Internet Explorer, MS Paint 

JPEG Internet Explorer, MS Paint 

TIFF Internet Explorer, MS Paint 

BMP Internet Explorer, MS Paint 

PDF Adobe Acrobat Reader 

PPT MS PowerPoint 

XLS MS Excel



File Types and Applications Supported for Encryption/Decryption 

Question 4: What are the file types not supported by the “Hide 

import symbols” option? 

The Hide import symbols option (under the Security tab) cannot be 

applied to the following file types: 

.NET 

Visual FoxPro 

Director 

Power Builder 

Adobe Acrobat Reader (PDF files) 

Windev 

Authorware 

Prolog 

GameMaker 

Excelsior JET 

Xenoage JEStart 

MDM Zinc 

File Type Applications 

MDB MS Access 

SWF Macromedia Flash 

Applications that use SmartHeap DLLs 

When you are also using data file encryption option 

Note: The Hide import symbols option is ignored if there is any data file to be 

protected or the file encryption settings have been specified. 




Question 5: Can I protect .NET DLLs using CodeCover? Are there 

any prerequisites for protecting .NET DLLs? 

Yes, you can protect both .NET executables and DLLs using CodeCover. 

However, please note the following: 


 

For .NET 1.0, 1.1, 2.0, 3.0, and 3.5 DLLs, you need to install .NET 

SDK of the same version as of the .NET DLL you want to protect. For 

example, install .NET SDK 1.1 to protect .NET 1.1 DLLs and .NET SDK 

2.0 to protect .NET 2.0 DLLs. 

For .NET 4.0 (Beta1/Beta 2) DLLs, you need to install Windows SDK 

7.0 and .NET Framework 2.0. 

Please note that an exception may occur while executing a 32-bit .NET 2.0, 

3.0, 3.5, or 4.0 DLL, protected using CodeCover. This exception occurs 

when applications are compiled using Any CPU configuration with only 

DLLs being protected and both executable and DLL being executed on a 64bit 

platform. To avoid this, please use any of the following methods with the 

executable calling this DLL: 

Select x86 configuration at the build time. 

Use the CorFlags Conversion tool to modify the binary (Type 

CorFlags theApp.exe /32bit+ in the command prompt and 

press Enter). 

Question 6: I am using XML serialization in my .NET executables. 

Are there any precautions to be taken care of? 

Here are the precautions to be taken care of while using CodeCover: 

Note: Windows 64-bit .NET applications that use XML serialization cannot be 

licensed on 32-bit operating system when .NET Enhancement option is 

selected.

.NET Framework 

Version 

Using “.NET 

Enhancement” 

Option 



Guidelines 

1.1 No The licensed application requires .NET 

Framework v 2.0 at run-time 

1.1 Yes The licensed application requires .NET 

Framework v 2.0 at run-time 

2.0, 3.0 and 3.5 No The .NET SDK 2.0 must be installed on 

system. The 

.XMLSerializers.dll is 

generated automatically during the 

licensing process. This DLL must be 

shipped with your licensed application. 

2.0, 3.0 and 3.5 Yes .NET SDK 2.0 must be installed on 

system.The 





4.0 No Windows SDK 7.0 must be installed on 

system. The 





4.0 Yes Windows SDK 7.0 must be installed on 

system. The 



licensing process. This must be shipped 

along with your licensed application. 

Question 7: Why do .NET executables protected using Quick Code- 

Cover and CodeCover methods fail to run if it is signed with strong 

names? 

Protecting .NET executables, signed with strong names, is not supported. 





 

Question 8: Why do Vista applications that require .mui files fail to 

run when protected using Quick CodeCover and CodeCover 

methods? 

These protected files on Vista need .mui1 files to execute. These .mui files are 

stored inside the default language folder (for example, en-US for an English 

version) that must be placed at a location where the protected executable 

resides. 

For example, for an English version of vista, if the protected Notepad.exe 

resides in C:\ protected then the .mui files must reside at the same location 

inside the en-US folder. Please check for the .mui files, located at the location 

as advised in the example. 

For more FAQs, refer to the Sentinel Keys Toolkit Help. 

Question 9: Are there any special files to be distributed to the end 

user for applications protected using the .NET Enhancement 

feature? 

The following DLLs should be distributed to end users: 

For 32-bit .NET applications protected using the .NET 

Enhancement security option: 

SDNPro.dll: If SDNPro.dll is not present with the protected 

application, then protected application will not execute and an 

error will be displayed that SDNPro.dll is missing. 

For 64-bit .NET applications protected using the .NET Enhancement 

security option: 

SDNPro64.dll (when .NET enhancement option is selected during 

protection): If SDNPro64.dll is not present with the protected 

application, then the protected application will not execute and an 

error will be displayed that SDNPro64.dll is missing. 

1.Files required for language and region settings.



Question 10: What precautions should I take while protecting 

applications using CodeCover? 

We recommend you to protect only the RELEASE build applications for 

CodeCover, as the memory management and optimizations may differ for 

DEBUG and RELEASE build applications. 

Hence, it is recommended not to use CodeCover protection for the DEBUG 

built applications. 

Question 11: Why is it so that when I protect the DLL that is statically 

linked to the application, the application fails to execute with 

the protected DLL. Whereas, if the DLL is linked dynamically, it executes 

successfully? 

This is a static linked DLL issue that occurs once you have protected your 

application. Please use one of the following tips while protecting a statically 

linked DLL to resolve this issue: 

Protect both the static linked DLL, and executable instead of 

protecting only the DLL. 

Use LoadLibrary instead of linking the DLL statically. 

Question 12: What is the advantage of using the Command-Line 

CodeCover utility? 

The Command-Line CodeCover utility is an exe file. And as such, it can be 

called by your project building script, to protect your desired application. 

This eliminates the dependency on the Toolkit to protect the application. 

Question 13: Will there be any difference in my protected application 

if I protect my file using the Command-Line CodeCover utility, 

instead of the Protect button provided in the License Designer 

stage of the Sentinel Keys Toolkit? 

The Command-Line CodeCover utility uses the license template (*.ltm) file to 

get the various protection options (like: protection layer level, licensing 

mode, network settings, etc. Hence, there is no difference between the file 

protected via the Command-Line CodeCover utility or Sentinel Keys Toolkit. 





 

Question 14: Does the Command-Line CodeCover utility provides 

any option to change the protection options? 

The Command-Line CodeCover provides a way to customize the source path 

and the destination path only. In case you want to edit the other options, 

then you have to edit the license via the Sentinel Keys Toolkit, and then use 

the new license template (*.ltm) file (after programming the license), with 

the Command-Line CodeCover utility.

Chapter 5 

Protecting Applications 

Using API 

In this chapter, we will describe how to add API features in the Toolkit. To 

learn about the API-based method of protecting applications, see “About 

API Protection” on page 58. 

Steps to Protect Applications Using API 

The steps for protecting applications using the Business Layer API functions 

are as follows: 

Prepare a Conceptual Plan 

In the initial stage you need to decide which software locks to use for protecting 

your application. The purpose of a software lock is to verify the 

presence of the correct Sentinel Key. You will begin by contacting the Sentinel 

Key for a license (SFNTGetLicense API call). Subsequently, you can craft 

variety of software locks to check the presence of the Sentinel Key, such as 

encrypting the data using the AES algorithm present in the key. Please refer 

to the Business Layer API Help to understand the various API functions. 


Chapter 5 – Protecting Applications Using API 


Many of these software locks can be used for implementing popular licensing 

models. For example, you can call the SFNTEncrypt API function to 

verify your lease or demo validity. 

Add the API Features to License Template 

Which API features need to be added in the license template? To drive the 

functionality of the software locks, you need to add appropriate API features. 

You can choose from the API features discussed in the topic 

“Features” on page 51. The chapter describes the steps of adding API 

features. 

Evaluate the Business Layer API Calls for Familiarity 


 

In the API Explorer screen, you can experiment with the Business Layer 

API prior to adding them into your source code. Corresponding to each 

function, it also generates the usage code for various languages. The Sentinel 

Keys Toolkit Help contains steps on using the API Explorer. 

Re-build the License Template (if Required) 

In case you modified your API features or template properties, after evaluating 

the API functions, you need to re-build the license template to generate 

the "final set" of header file 1 , libraries, and code sketch 2 . 

1. The header file is generated at the time of building a license template. It contains important 

information for your (license) strategy, including the developer ID, license ID, feature ID, software 

key, query-response table (if you have included an AES feature in your template), and a 

public key (if you included a ECC feature in your template). 

2. The code sketch consists of an outline of the Business Layer API functions that you should 

incorporate in your source code. It is a good reference when you are not sure which API functions 

are relevant for your particular strategy.

Steps to Protect Applications Using API 


Add the Business Layer API Functions into Source Code, 

Compile, and Link 

You now need to insert the Business Layer API calls into your application 

source code. The code sketch for your license template can guide you on the 

relevant API functions that can be called. Also, do refer to the best practices 

described in Chapter 7, “Implementing Secure Licensing,” on page 167. 

Finally, compile and link your application after including the Sentinel Keys 

header files and libraries. 

Apply the CodeCover Protection (for Windows 

Applications Only) 

For extra protection, you can apply CodeCover over your API-protected 

(compiled) applications. However, this step is optional and depends on 

whether your executables, DLLs, and BPLs are supported by the CodeCover 

or not. The steps for using the CodeCover are described in Chapter 4, “Protecting 

Applications Using CodeCover,” on page 75. 

Test the Protected Application 

You can now test your protected application. We recommend testing your 

application to verify that it executes correctly with the appropriate Sentinel 

Key both attached and missing. 

Tip: If you are testing your protected application in network environment, make 

sure to restart the Sentinel Keys Server. 




Steps for Protecting Applications Using API 


Adding API Features 



The API features can be added using any of the following ways: 

Under the API tab of the License Designer screen - This option 

allows you to add an API feature to an existing license template. The 

complete steps are covered in this chapter. 

Using the License Designer Wizard - This option allows you to 

create a license template by adding a CodeCover or API feature to it. 

Refer to the Sentinel Keys Toolkit Help for complete steps. 

Add Feature Dialog Box 

To obtain the Add Feature dialog box: 

1. In the License Designer screen, load the template to which the API 

feature will be added. The loaded template is shown in the template 

layout. 

2. Click the API tab. 

3. Click the Add button. The Add Features dialog box appears. 




Adding AES Feature 

Add Features Dialog Box 


 

1. In the License Designer screen, load the template to which the AES 

feature will be added. 


3. Click Add. The Add Features dialog box appears. 

4. Select AES from the list of API features.




will be enabled/disabled. The attributes are described below: 

Attributes 


Active When only this check box is selected 

the feature can be used for: 

Encryption, decryption, queryresponse 

protection 

Providing a perpetual license for 

using the application. 

AES-based 

encryption 

AES-based 

decryption 

When Lease and/or Limit executions 

check box(es) are also selected, the 

feature can be used for: 

Encryption, decryption, queryresponse 

protection 

Providing a time-limited or executions-limited 

license for using the 

application. 

Select to encrypt 16-byte blocks using 

the AES algorithm. 

You need to call SFNTEncrypt API 

function in your code. Refer to the 

Business Layer API Help for details on 

the function. 

Select to decrypt 16-byte blocks of 

encrypted data using the AES 

algorithm. 

You need to call SFNTDecrypt API 

function in your code. Refer to the 

Business Layer API Help for details on 

the function. 





Selected 

Not selected 

Not selected 

Not selected 




Limit 

executions 


below: 

Default Feature Instance 


Secret key The 128-bit AES secret key. By default, a secret key is 

generated and shown in the 

Expiration 

date 

Expiration 

time 

Execution 

count 

Attributes (Continued) 




run for. 

Write random Select this check box for randomly 

generating the secret key at the time 

of programming the Sentinel Key. The 

random value is generated by the 

Sentinel Key itself and is not known to 

you/your application. Selecting this 

will automatically disable the 

Secret Key field. 

Specify an expiration date 


Specify an expiration time 

(in minutes). 

Specify an execution count 


application. 


 

Toolkit. You can use the icon 

shown next to the Secret key 

field to generate another secret 

key. However, this button is 

disabled when the Write 

Random attribute check box is 

selected because the Sentinel Key 

generates it randomly at the time 

of programming. 



1 

Not selected 

Not selected
















8. Provide a name for this feature (necessary). 

9. The constant name will be automatically generated. However, you 

may modify it, if needed. 

10. You may optionally provide comments. When done, click OK. 

Note: You can use the following Business Layer API functions for an AES feature: 

- SFNTQueryFeature - To implement the query-response protection with/ 

without the licensing checks. 

- SFNTEncrypt - To encrypt 16-byte blocks. 

- SFNTDecrypt - To decrypt 16-byte encrypted blocks. 

Adding ECC Feature 

1. In the License Designer screen, load the template to which the ECC 







4. Select ECC from the list of API features. 


will be disabled/enabled. The attributes are described below: 

Attributes 


Active When only this check box is selected 

the feature can be used for: 

Data signing and verification 

Providing a perpetual license for 

using the application. 

When Lease and/or Limit executions 

check box(es) are also selected, the 

feature can be used for: 

Data signing and verification 

Providing a time-limited or executions-limited 

license for using the 

application. 

ECC-based 

signing 

Select to sign digital content using the 

ECC algorithm. You need to call 

SFNTSign API function in your code. 

Refer to the Business Layer API Help 

for details on the function. 





Limit 

executions 



run for. 

Selected 

Selected 

Not selected 

Not selected 




Write random Select this check box for randomly 

generating the private key and public 

key pair at the time of programming 

the Sentinel Key. When generated 

randomly, the private and public key 

pair will not be shown in the Toolkit; 

however, the public key will be written 

in the header file. Selecting this will 

automatically disable the Private 

Key and Public Key fields. 

ECC-based Key 

Exchange 

Not selected 


below: 

Private 

Key 

This is not supported in the current 

release. However, please keep it 

selected. 

Default Feature Instance 

Selected 


The private key used for 

data signing. 



Public Key The public key used for 

data verification. It will be 

written into the header 

file. 

By default, a pair of private and 

public keys is generated and 

shown in the Toolkit. 

You can use the icon shown 

next to the Private key field to 

generate another pair. 

However, this button is disabled 

when the Write Random 

attribute check box is selected 

because the Sentinel Key 

generates them randomly at the 

time of programming. 

-same as above- 




Expiration 

date 

Expiration 

time 

Execution 

count 

Default Feature Instance (Continued) 


Specify an expiration date 


Specify an expiration time 

(in minutes). 

Specify an execution count 


application. 


 




















1



Note: You can use the following Business Layer API functions for an ECC feature: 

- SFNTSign - To sign content. 

- SFNTVerify - To verify the signed content. 

Adding Counter Feature 


Counter feature will be added. 



4. Select Counter. 

5. Specify a value between 0 to 4,294,967,295 for the default instance. 









Note: You can use the following Business Layer API functions for a Counter feature: 

- SFNTCounterDecrement - To decrement the Counter value by specified 

amount on each call. 

- SFNTReadInteger - To read the Counter value. 




Adding String Feature 


String feature will be added. 




 

4. Select String. Depending on which the other options will be enabled/ 

disabled. The attributes are described below: 

Attributes 


Write-Random If selected, a unique random string will 

be written as the feature value when 

the Sentinel Key is programmed. You 

can specify its length in the String 

Length field. 

The random value is generated by the 


you/your application. However, you 

can call the SFNTReadString API 

function to read the value. 

Please note that this value can be 

overwritten in the field using the 

Update value command or by calling 

the SFNTWriteString API function 

(requires the write password 

you specified). 

Read-Only Select this check box if you do not 

want to allow writing the feature 

value by the protected application 

(that calls the SFNTWriteString API 

function). 

Not Selected 

Not selected





Write-Once Select this check box if you want to 

allow writing the feature only once, 

without providing a write password 

(specify any value in the 

WritePassword parameter of the 

SFNTWriteString API function). This 

attribute is suitable for accepting 

string data that a user provides only 

once for validation (such as the user 

name) without exposing 

the write password. 

However, note that this value can be 


Update value command. 

Typically, this attribute is best used 

with the read-only attribute. 

Not selected 

5. Specify a string containing up to 2032 3 ASCII printable characters 

for the default instance. 

If Write-Random check box is clear, you can click Browse to copy 

the contents of a file into the string feature. 

6. Specify a write password if you want to write the feature value using 

the SFNTWriteString API function. The option will be disabled if you 

have selected the Read-Only option. 





The option will be disabled if you have selected the Write-once and/ 

or Write-random option. 

3.The maximum length is 2032 bytes for SHK XM keys; and 888 bytes for non-XM keys. 





 

8. If you selected the check box described in step 7, specify the maximum 

size. It has to be greater than the existing string length and less than 

2032 ASCII printable characters. The overridden values will never 

exceed the maximum limit set. 





Note: You can use the following Business Layer API functions for a String feature: 

- SFNTReadString - To read the String feature value. 

- SFNTWriteString - To write the String feature value. 

Adding Raw Data Feature 

1. In the License Designer screen, load the template to which the Raw 

Data feature will be added. 


3. Click Add. The Add Features dialog box appears.



4. Select Raw Data. Depending on which the other options will be disabled/enabled. 

The attributes are described below: 

Attributes 


Write random If selected, some unique random raw 

data will be written as the feature 

value when the Sentinel Key is 

programmed. You can specify its 

length in the Raw Data Length 

field. The random value is generated 

by the Sentinel Key itself and is not 

known to you/your application. 

However, you can call the 

SFNTReadRawData API function to 

read the value. Please note that this 

value can be overwritten in the field 

using the Update value command or 

by calling the SFNTWriteRawData API 

function (requires the write password 


Read-only Select this check box if you do not 


value by the protected application. 




Write-once Select this check box if you want to 



(specify NULL in the WritePassword 

parameter of the SFNTWriteRawData 

API function). This attribute is suitable 

for accepting raw data that a user 

provides only once for validation (such 

as the registration number) without 

exposing the write password. 




Not Selected 

Not selected 

Not selected 




5. Specify a value containing up to 2032 4 raw data value (any developer-defined 

data type—including printable/non-printable ASCII 

characters and hexadecimal numbers) for the default instance. 


 

If the Write-Random check box is clear, you can click Browse to 

copy the contents of a file into the raw data feature. You can specify 

Offset and Length, in bytes, for the file contents you want to copy. By 

default, Offset is 0 and Length is 2032, indicating that only first 2032 

bytes of data is copied. Alternatively. you can also click the Hex-ASCII 

converter to browse the file. 


the SFNTWriteRawData API function. The option will be disabled if 

you have selected the Read-only option. 





The option will be disabled if you have selected the Write-Once and/ 


8. If you selected the check box described in step 7, specify the maximum 

size. It has to be greater than the existing feature size and less than 

2032 raw data characters. The overridden values will never exceed 

the maximum limit set. 





4.The maximum length is 2032 bytes for SHK XM keys; and 888 bytes for non-XM keys.



Note: You can use the following Business Layer API functions for a Raw Data feature: 

- SFNTReadRawData - To read the Raw Data feature value. 

- SFNTWriteRawData - To write the Raw Data feature value. 

Adding Integer Feature 

1. In the License Designer screen, load the template to which the Integer 




4. Select Integer. Depending on which the other options will be disabled/enabled. 


Attributes 


Write random If selected, some unique random 

integer data will be written as the 

feature value when the Sentinel Key is 

programmed. You can specify its 

length in the range specified 

by the Integer type radio buttons. 




can call the SFNTReadInteger API 

function to read the value. 




the SFNTWriteInteger API function 



Not Selected 









However, this value can be written in 

the field using the Update value 

command. 

If you selected Write random check 

box, the value will be written at the 

time of programming the Sentinel Key. 

You can read the Integer feature value 

using the SFNTReadInteger function. 

Not selected 





parameter of the SFNTWriteInteger 

API function). This attribute is suitable 

for accepting integer data that a user 

provides only once for validation (such 

as the registration number) without 

exposing the write password. 




5. Choose the integer type from the options shown: 

8-bit integer: A value between 0 and 255. 

16-bit integer: A value between 0 and 65,535. 

32-bit integer: A value between 0 and 4,294,967,295. 

6. Specify an integer value for the default instance. 

Not selected 


 


the SFNTWriteInteger API function. The option will be disabled if you 

have selected the Read-only option.







The option will be disabled if you have selected the Write-once and/or 

Write-random option. 





Note: You can use the following Business Layer API functions for an Integer feature: 

- SFNTReadInteger - To read the Integer feature value. 

- SFNTWriteInteger - To write the Integer feature value. 

Adding Boolean Feature 


Boolean feature will be added. 






4. Select Boolean. Depending on which the other options will be disabled/enabled. 


Attributes 


Write random If selected, a random Boolean value 

will be written as the feature value 

when the Sentinel Key is programmed. 




can call the SFNTReadInteger 

API function to read the value. 




the SFNTWriteInteger API function 






However, this value can be written in 

the field using the Update value 

command. 

If you selected Write random check 

box, the value will be written at the 

time of programming the Sentinel Key. 

You can read the Integer feature value 

using the SFNTReadInteger function. 





parameter of the SFNTWriteInteger 

API function). 




Not Selected 

Not selected 

Not selected 




5. Specify a true (1)or false (0) value for the default instance. 


the SFNTWriteInteger API function. The option will be disabled if you 

have selected the Read-only option. 





8. The option will be disabled if you have selected the Write-once and/ 






Note: API functions for Boolean feature 

You can use the following Business Layer API functions for a Boolean feature: 

- SFNTReadInteger - To read the Boolean feature value. 

- SFNTWriteInteger - To write the Boolean feature value. 





After adding the API features, you may now: 

Build the license template using the instructions described in the 

Sentinel Keys Toolkit Help. When a license template is built, the 

following tasks are performed: 

Sentinel Key is programmed with the license information. 

Header file is generated. 

Code sketch is generated. 

Add the Business Layer API functions into your application’s source 

code, 

The Business Layer API Help provides complete details on each function. 

Also, do refer to the best practices described in Chapter 7, 

“Implementing Secure Licensing,” on page 167. 

Compile your application after including the Sentinel Keys header 

files and libraries. You may also apply CodeCover protection to your 

Windows executables and data files (if the file types are supported). 

You can now test your protected application. We recommend testing 

your application to verify that it executes correctly with the 

appropriate Sentinel Key both attached and missing. 

Note: If you are testing your protected application in network environment, 

make sure to restart the Sentinel Keys Server after building the license 

template. 


Business Layer API - Quick Reference 

SFNTSetContactServer - Sets the Sentinel Keys Server to be contacted for obtaining a 

license. 

SFNTSetConfigFile - Allows to reconfigure the name and path of the client-side configuration 

file. 

SFNTGetLicense - Obtains a license from the Sentinel Key having required developer ID and 

license ID. 

SFNTQueryFeature - Performs the query-response operation and verifies the licensing controls. 

SFNTEncrypt - Encrypts data using the AES algorithm. 

SFNTDecrypt - Decrypts data using the AES algorithm. 

SFNTSign - Signs content using the ECSSH algorithm. 

SFNTVerify - Verifies the digitally signed content using the public key. 

SFNTSetHeartbeat - Sets the heartbeat interval for maintaining a license. 

SFNTCounterDecrement - Decrements the Counter value by a specified amount. 

SFNTReadInteger - Reads Integer, Boolean, and Counter feature values of the in the Sentinel 

Key. 

SFNTWriteInteger - Updates the Integer and Boolean feature values in the Sentinel Key. 

SFNTWriteRawData - Updates the Raw Data feature value in the Sentinel Key. 

SFNTReadRawData - Reads the Raw Data feature value in the Sentinel Key. 

SFNTReadString - Reads the String feature value in the Sentinel Key. 

SFNTWriteString - Updates the String feature value in the Sentinel Key. 

SFNTGetFeatureInfo - Obtains information about a feature. 

SFNTGetLicenseInfo - Obtains information about a license. 



SFNTGetServerInfo - Obtains information about the Sentinel Keys Server that granted 

license(s) to the application. 

SFNTEnumServer - Enumerates the Sentinel Keys Servers running within the subnet for a 

Sentinel Key (having the desired developer ID and license ID combination). 

SFNTGetDeviceInfo - Obtains information about the Sentinel Key attached to a system. 

SFNTReleaseLicense - Releases the license and cleans up the memory allocated to the client 

library resources. 






 

Question 1 - Can I modify the feature ID? 

If required, you can modify the feature ID assigned by the Toolkit. Specify a 

numeric value between 1 to 255 in the Feature ID text box. It must be 

unique for a license template. 

Question 2 - What is a code sketch? 

The code sketch is the protection plan generated by the Toolkit when a 

license template is built. It consists of an outline of the Business Layer API 

functions that you should incorporate in your source code. It is a good reference 

when you are not sure which API functions are relevant for your 

particular strategy. 

The code sketch is written into an HTML file present in the Toolkit working 

folder. 

It can be generated for the most-frequently used development languages. 

To view the code sketch, you can either click View under the Build Options 

tab, or navigate to the Toolkit working folder. 

Question 3 - Are there any API samples provided? 

Yes. Sample applications are provided that demonstrate various licensing 

models, such as lease and demos. These samples make use of Business Layer 

API functions, suitable for that licensing scheme. 

Follow the steps given below:



1. Load a sample license template provided in the Toolkit. 

Load Sample 

2. Provide your build options under the Build Options tab, such as 

specify the development language you want the sample for. 

3. Build it by clicking the Build button. The following dialog box will 

appear (the dialog box differs across platforms) on completion of the 

build process for Windows sample. 

Take me there Link 

4. Click the Take me there link (the dialog box differs across platforms). 

You are directed to the language-specific directory for the sample, 





 

wherein you can compile the sample application and understand the 

API functions used. 

Note: For more FAQs and troubleshooting tips, refer to the Sentinel Keys Toolkit 

Help.

Chapter 6 

Secure Remote Updates 

Secure remote updates provide a method to update the hardware keys 

already deployed with the customers and distributors. This chapter 

describes the complete process of updating keys remotely. 

Usually, most of the product trials/purchases are followed by certain updates 

and activations. For example, customers who earlier used a demo version of 

AppSoftDrawing might want to buy a perpetual license later. Or, your enterprise 

customers might wish to increase the number of users allowed to run 

the application. Under rare circumstances, you might need to update the 

security settings in the key memory, such as revising the cheat counter 

value, deactivating the algorithms, or modifying the write password for a 

feature and so on. Secure remote updates allow you doing all this and much 

more in a few easy steps! 

Secure Remote Updates 

The secure update process does not require you to withdraw existing Sentinel 

Keys from the field, ship new keys, provide additional software, or visit 

the customer site. You do not even need to prepare a remote update strategy 

in advance at the time of license designing. 


Chapter 6 – Secure Remote Updates 


The following table lists the two types of Secure Remote Update methods, 

scenarios in which these methods are useful, and the file generated in each 

process. 

Remote Update Methods Update Scenario File Generated 

Secure Remote Feature/ 

License Update 

Secure Remote New License 

Addition 

To modify values of 

existing features in 

existing licenses 

To add a new license, or 

add/remove features to/ 

from an existing license 

.upw 

(update code file) 

.nlf 

(new license file) 


 

Note: A license (template) is considered to be new if its License ID is distinct from 

the license IDs of licenses available in the end user token. 

A license (template) is considered to be existing if its license ID matches the 

license ID of any of the licenses available in the end user token. 

The following illustration explains the remote update processes involved in 

updating Sentinel Keys with feature/license updates, or new license 

additions.

Secure Remote Feature/License Update 



The Sentinel Keys can be updated for features/licenses using files or e-mails 

in one of the following ways: 

Bidirectional Update 

Unidirectional Update 

Bidirectional Update 

In this process, there is a bidirectional flow of the update information 

between the end user and the developer as described below: 

1. The customer generates a request code. 

2. The customer sends the request code (.req file) using an e-mail to the 

developer. 

3. The developer loads the license template for which the request was 

sent. 

4. The developer clicks the Bidirectional Update option button under 

the Key Activator tab. 

5. The developer loads the request code (.req) file. 

Note: When the request code is loaded in the Update Manager, the License IDs of 

all the licenses are displayed. The developer views the licenses by using the 

arrow buttons ( , or ). 

6. The developer clicks Load to load the selected license. 

7. The developer creates update actions (described on page 157). 

8. The developer clicks Generate Update Code to generate an update 

code (described on page 162). 





 

9. The developer sends the update code (.upw) file using an e-mail to the 

customer. 

10.The customer applies the update code using the secure update utility/ 

secure update wizard, to have access to the requested applications/ 

features. 

Bidirectional Remote Update Process 

The remote update bidirectional process allows you to update keys securely 

because: 

The updates codes are encrypted using the AES secret key. 

Due to the "one time update" capability built in the hardware, an 

update code cannot be used more than once. 

The "update code" and "request code" form a unique pair—an update 

code can update only that hardware key whose request code was used 

to generate it.



Note: The Secure Remote Update process can also be used by your distributors to 

increment the exhausted metering count. They can do so using the Secure 

Update Utility or a custom option that calls the Secure Update API functions. 

See “Updating Distributor Key Metering Count” on page 206 for 

details. Also, refer to the Secure Update API - ReadMe for details on using 

Secure Update API functions. 

Unidirectional Update 

Unidirectional Update is a one-way update, that targets single or multiple 

Sentinel Hardware Key(s) present in the field. A Unidirectional update could 

be of the following two types: 

1. Unidirectional Single Target Update: The Developer generates the 

update code without any request code from the end user, and applies 

the update code to a specified Sentinel Hardware Key with a particular 

Serial Number. 

2. Unidirectional Broadcast Update: The Developer generates the 

update code without any request code from the end user, and broadcasts 

the code to all the end users possessing Sentinel Keys with the 

same DeveloperID. 

Some exceptions in the unidirectional mode are listed as follows: 

Only the update actions for License/Feature are shown in the Action 

List. 

For Sentinel Keys, the following update actions are not supported in 

the unidirectional mode: 

Set cheat counter (only for non-RTC keys) 

Set device date 

For Distributor Keys, the following update actions are not supported 

in the unidirectional mode: 

Metering count 

Modify File Encryption Key (hex) 





 

Under License/Feature actions, creating update codes for updating 

few features like Counter, AES and ECC’s expiration time and counter 

are restricted. Hence, you will not be able to select the following 

features in the action list while generating an update code (*.upw) file 

in unidirectional mode. 

Increment Counter (for Counter, ECC, AES) 

Overwrite Counter (for Counter, ECC, AES) 

Set Expiration time (for ECC, AES) 

Unidirectional Single Target Update 

The unidirectional single target update process is as described below: 

1. The developer loads the license template for which the update code 

needs to be generated. 

2. The developer clicks the Unidirectional Update option button 

under the Key Activator tab. 

3. The developer selects the Only update a specified SHK token 

check box. 

4. The developer enters the serial number (derived from a database 

maintained by the developer) of the Sentinel Key targeted for unidirectional 

single target update, in the Token Serial Number field. 

5. The developer selects the actions to be performed on the Key. The 

update actions are listed, corresponding to the License/Feature 

Action Types, present in the token. See “About Remote Update 

Actions” on page 157. 




customer.



8. The customer applies the update code to have access to the requested 

applications/features. 

Note: The developer must maintain a database at the time of key programming, 

in which all the license group information which is to be programmed in 

the token should be stored. Without this information or incomplete information, 

updating the tokens could fail. 

Unidirectional Single Target Remote Update Process 

Unidirectional Broadcast Update 

The unidirectional broadcast update process is as described below: 

1. The developer loads the license template for which the update code 

needs to be generated. 

2. The developer clicks the Unidirectional Update option button 

under the Key Activator tab. 

3. The developer selects the actions to be performed on the Key. The 

update actions are listed, corresponding to the License/Feature 1 




Action Types, present in the token. See “About Remote Update 

Actions” on page 157. 




 


customer. 

6. The customers apply the update code to have access to the requested 

applications/features. 

Unidirectional Broadcast Remote Update Process 

1.Some features like Counter, AES, ECC, and Lease are restricted for selection, from the action 

list while generating *.upw file in unidirectional mode.

Secure Remote New License Addition 



Remote license addition method allows you to add new license(s) in the end 

user token present in the field. 

Note: A license (template) is considered to be new if its License ID is distinct from 

the license IDs of licenses available in the end user token. 

A license (template) is considered to be existing if its license ID matches the 

license ID of any of the licenses available in the end user token. 

The following table explains the scenarios in which the remote license addition 

process is useful. 

Scenario Token State Description 

Fresh License 

Addition 

New License 

Addition 

New Feature 

Addition 

Empty You have sent an empty token in the field and 

now you wish to add license(s) in the end user 

token remotely. 

Token with 

existing 

license(s) 

Token with 

existing 

license(s) 

The end user token has license L1 bound to 

application A1, and now you want to send a 

new license L2 bound to application A2. 

The end user token has license L1 with features 

F1, and F2, and you want to add another 

feature say F3 in the same license L1, present in 

the token. 

This is achieved by first deleting all the existing 

licenses from the token and then adding the 

modified L1 as the new license. 

Note: Do make sure to delete all licenses if 

you are adding the same license with a 

new feature. Otherwise, license loading 

fails displaying the message, “License 

already exists”. 





 

New license addition through secure update library requires the creation of 

license addition 2 (*.nlf) file. The following section explains the processes 

involved in new license additions into the end user tokens. 

Remote New License Addition Process 

The Sentinel Keys can be updated for new licenses in one of the following 

ways: 

Bidirectional New License Addition 

Unidirectional New License Addition 

Bidirectional New License Addition 

In this mode the developer 

loads the request code, 

received from the customer to 

retrieve the Serial number and 

Device Update Counter values. 

License addition in this mode 

targets a single end user token. 

This bidirectional flow of the 

license addition information 

between the end user and the 

developer is described below: 

1. The developer opens the 

License Manager screen. 

Device Update Counter is the global update counter 

in the end user token which is incremented every 

time any of the following operations are performed 

on the token: 

Deleting all licenses before adding new licenses 

using *.NLF file. 

Cheat counter value updates. 

Last known date and time (LKDT) updates, once 

the lease operation has been performed. 

User limit value updates. 

When the request code is generated, the value of 

device update counter is stored in the *.req file. 

2. Using the Group Management dialog box, the developer loads the 

group for which the license addition (*.nlf) file needs to be exported. 

3. The developer clicks the Export-File Manager icon ( ) to open 

the Export-File Manager wizard. 

2.The *.nlf file is created for new license addition(s) in the end user token using the Secure 

Update library. The end user is able to load the license(s) into the local SHK token by applying 

this license addition file.



4. In the Export-File Manager wizard, the developer selects Export a file 

for License Addition. (Allows creation of *.NLF file), and clicks 

Next. 

5. The developer selects the Bidirectional mode from the Mode dropdown, 

and clicks Next. 

6. The developer browses and selects the request code (.req) file in the 

Request Code File field. The request code file populates the Serial 

Number and Device Update Counter 3 values in the respective 

fields. 

7. The developer may select the Delete all licenses from token check 

box, if required, to remove all the licenses from the token. 

Selecting this check box displays a warning, “This will remove all the 

licenses from the token. Are you sure you want to do this?”. Click Yes to 

confirm, and it removes all the existing licenses from your token, 

before loading a new license. 

8. The developer clicks Next to continue further in the wizard. After 

defining a destination path in the File Name field, specifies the cheat 

counter value in the Cheat Counter (only for non-RTC keys) field, 

and then clicks Generate. The loadable license packets are generated 

and exported in the form of *.nlf file. 

9. The developer sends the license addition (*.nlf) file using an e-mail to 

the customer. 

10.The customer applies the license addition code to use the new license. 

Unidirectional New License Addition 

In this mode, the developer generates the new license addition code without 

any request code from the end user. It is assumed that the Serial Number 

and Device Update Counter is known to the developer. 

3.The Device Update Counter, stored in the .req file in bidirectional mode, is needed when the 

developer wants to delete all licenses from the Sentinel Key, before loading new licenses. 




1. The developer opens the License Manager screen. 

2. Using the Group Management dialog box, the developer loads the 

group for which the new license addition (*.nlf) file needs to be 

exported. 

3. The developer clicks the Export-File Manager icon ( ) to open 



 

4. In the Export-File Manager wizard, selects Export a file for License 

Addition. (Allows creation of *.NLF), and clicks Next. 

5. The developer selects the Unidirectional mode from the Mode dropdown, 

and enters the serial number to apply the license addition code 

for a particular end user token (Unidirectional Single Target Mode). 

When the Single Target check box is unselected, the new license 

addition update is applicable to multiple end user tokens of the same 

Developer ID (Unidirectional Broadcast Mode4 ). 

The developer may select the Delete all licenses from token check 

box, if required, to remove all the licenses from the token. 

Selecting this check box displays a warning, “This will remove all the 

licenses from the token. Are you sure you want to do this?”. Click Yes to 

confirm, and it deletes all licenses from the token before loading a new 

license. 

This activates the Device Update Counter 5 check box for the developer 

to enter the device update counter value, required for formatting 

the token. 

6. The developer clicks Next to continue further in the wizard. After 

defining a destination path in the File Name field, specifies the cheat 

4.In unidirectional license addition mode, if the developer unselects the Single Target check 

box then the new license addition (*.nlf) file is generated for multiple end user tokens of the 

same developer ID. The developer is restricted to delete all licenses from tokens, in this mode, 

before loading a license. 

5.In unidirectional mode, you need to keep track of this value while sending the update 

codes.

Remote Update Codes 


counter value in the Cheat Counter (only for non-RTC keys) field, 

and then clicks Generate. The loadable license packets are generated 

and exported in the form of *.nlf file. 

Note: The update packets for LKDT packet is also integrated with the *.nlf file. 

7. The developer sends the license addition (*.nlf) file using an e-mail to 

the customer. 

8. The customer applies the license addition code to use the new license. 

Remote Update Codes 

Request Code 

Refers to the code generated (as a .req file) by the customers/distributors as a 

request to update their hardware keys. It contains the hardware key details 

(such as, the serial number) and the license information. 

Update Code 

Refers to the code generated by the developer. It defines the actions that you 

want to apply on the hardware key. The update code is generated under the 

Key Activator tab of the Toolkit. 

As a developer, only you have the rights for generating update codes to allow 

secure remote update. 

Note: An update code can also be generated using the SFNTCreateUpdatePacket 

API function of the Key Programming library. 

The update packets created using this function can be applied as a buffer 

and saved as a *.upw file to be further applied into the end user token 

using either the Secure Update Utility, or the SFNTApplyUpdateCode 

function from the Secure Update library. 




License Addition Code 

Refers to the code generated (as *.nlf file) by the developer for adding new 

license(s) files into the end user token through the Secure Update Utility/ 

Wizard, or the SFNTApplyUpdateCode () function of Secure Update Library. 

The *.nlf file is generated using the Export-File Manager under the 

License Manager stage of the Toolkit. 


Remote Update Methods 



You can use any of the following methods to update hardware keys 

remotely: 

Secure Update Wizard (available for Windows only) 


Secure Update API 

Secure Update Wizard 

The Secure Update Wizard provides a developer-branded graphical option to 

customers for remotely activating features/applications. It is suitable for 

activating licenses remotely under the following scenarios: 

Converting a trial/demo application to a full version 

Activating an inactive feature/application after installation 

Adding a new license 

You can brand the Secure Update Wizard with your custom graphics and 

text while associating it with your CodeCover/API-protected applications. 

The wizard collects product and publisher information to process a license 

activation request. It allows you to choose how the product activation will 

be presented to your customer, and defines the methods (file and/or e-mail) 

your customer can use to activate the product. 

When your customer runs the application, he/she will have the option of 

clicking the Try or Buy button: 

The Try button allows your customer to use the product for a 

specified time limit or determined number of executions. 

The Buy button prompts your customer for the necessary 

information and completes the product activation. 





 

Note: The Secure Update Wizard is localization ready. You can translate the wizard 

text and messages—currently in U.S. English—into a language of your 

choice. 

Refer to the Sentinel Keys Toolkit Help for complete details on integrating the 

Secure Update Wizard with your CodeCover or API-protected application. 

Also, Chapter 10, “Redistributables for Customers and Distributors,” on 

page 223 describes what to ship along with your protected application to 

allow remote updates.



Secure Update Wizard Interface 

(The example shows how the interface can be branded to suit your preferences) 


The Secure Update Utility is a stand-alone application and provides an alternative 

for updating hardware keys. 

Using the Secure Update Utility, a customer/distributor can easily generate a 

request code file (.req). In response, the developer will provide an update 

code file (.upw), or a new license addition file (.nlf). The .upw or .nlf file can 




be applied by the customer/distributor using the same utility, or directly by 

double-clicking the file (if the One-Click License Update facility is enabled). 

Note: Since, the .upw file generated by Sentinel Hardware Keys (version 1.2 and 

higher) will not be applied using the Secure Update library of version 1.0, 

please make sure that you distribute the latest Secure Update Utility and 

associated DLLs to your customer/distributor. 


 

The One-Click License Update facility allows your customers to directly 

update the key by double-clicking the .upw or .nlf file. On Windows 98, double-clicking 

a .upw or .nlf file initiates the Secure Update Utility rather than 

directly updating the key. To enable the one-click license update facility, you 

need to tune your application installer for creating certain registry entries 

(specific to .nlf and .upw files) at the client machine. These registry entries 

are listed in the following table: 

For .nlf Files 

Installer Registries for One-Click License Update 

Registry Value 

HKEY_CLASSES_ROOT\.nlf nlffile 

HKEY_CLASSES_ROOT\nlffil 

e 

HKEY_CLASSES_ROOT\nlffil 

e\shell\open\command 

For .upw Files 

HKEY_CLASSES_ROOT\.upw upwfile 

HKEY_CLASSES_ROOT\upwfi 

le 

HKEY_CLASSES_ROOT\upwfi 

le\shell\open\command 

New License Addition File 

It is a dynamic value that specifies the location 

where the SecureUpdateUtility.exe is installed 

on the client’s machine. The installer adds this 

registry value after the installation of Secure 

Update Utility. 

Secure Update File 

It is a dynamic value that specifies the location 

where the SecureUpdateUtility.exe is installed 

on the client’s machine. The installer adds this 

registry value after the installation of Secure 

Update Utility.



For Windows, a GUI-based application is provided (see screenshot below). 

For other platforms, a command-line utility is provided. 

Secure Update Utility Interface on Windows 





 

The table below quickly compares the Secure Update Wizard and Secure 

Update Utility to help you in choosing the method that suits your needs best: 

Secure Update Wizard Secure Update Utility 

Wizard-based and graphical. You can 

customize the user-interface, instructions, 

and include custom graphics, 

like a splash screen. 

Localization-ready. 

Best suited for try-and-buy applications 

that use expiration date, time, 

and execution count. 

It can be integrated with your protected 

application (as described in the 

Sentinel Keys Toolkit Help). 

Since it is installed with the protected 

application, your customers can use it 

for updating stand-alone keys. 

Available only for Windows. 

Remote Update API 

Compact and ready-to-use 

(requires no configuration). 

Suitable for updating the hardware 

key memory and features 

with all the action types defined 

on page 157. It can also be used 

for incrementing the counter 

programmed into distributor 

keys. 

Can be shipped as an independent 

utility. See also, “Deploying 

Secure Update Utility” on 

page 228. 

Can be used for updating standalone 

or network keys. 

Available for all supported platforms 

on Windows, Linux, and 

Macintosh. 

A developer may instead create a customized remote update option using 

the Secure Update API functions implemented in SecureUpdate.h. It is available 

at the following path in your Sentinel Keys SDK installation: 

For Windows: \Secure Update\Secure Update Utility\INTF. 

Please note that separate libraries are provided for Windows 32-bit 

and x64. 

For Linux: /secure_update/SecureUpdateUtility/INTF/ 

For Macintosh: /Secure Update/Secure Update Utility/INTF/

About Remote Update Actions 


Note: Refer to the Secure Update API - ReadMe for more information on Secure 

Update API functions. 


To be able to update Sentinel Keys and distributor keys in the field, you must 

define the update actions under the Add Actions tab of the Update Manager 

screen. 

Actions contain one or more commands grouped together, so you do not have 

to select the commands individually when generating update codes. The 

various commands are described in “Action Types” on page 157. 

When you generate an update code, the actions you select are encrypted 

into the update code specific to the selected hardware key. When the update 

code is entered in the Secure Update Wizard or Secure Update Utility, the 

actions and commands are applied to the key. 

Note: The task of adding remote update actions is not a part of license designing 

stage. You can add actions even after deploying your protected applications 

when the customer/distributor sends a request code. 

Action Types 

The following three categories of actions exist: 

For Features 

Choose License/Feature action type for: 

Updating the license template settings—like user limit—in the 


Updating the feature settings—like an execution date, execution 

count and so on—in the Sentinel Key. 

Given below are the steps: 




1. In the Update Manager screen, load the license template for which 

the actions are to be created. 


 

2. Under Action Types, select the License/Feature radio button (if not 

already selected). 

3. Click Add. The Add action for features dialog box appears. 

4. Under Features and Commands, select the check box shown beside 

the feature for which commands are to be added. The applicable commands 

appear in the right-side panel (under Commands Options). 

The top-most command in the Command drop-down list is automatically 

selected. If desired, you can remove it using the Remove 

Command button. The table below shows you the possible commands 

that can be added for each feature type: 

Feature and License Action Type 

Command Description Applies to 

Update value Updates the existing feature value. String 

Raw Data 

Integer 

Boolean 

Change write 

password 

Increment 

counter* 

Overwrite 

counter* 

Activate AES 

feature 

Deactivate AES 

feature 

Changes the existing Write Password. String 

Raw Data 

Integer 

Boolean 

Increments the existing Counter feature value 

by the amount you specify. 

Replaces the existing Counter feature value 

with the value you specify. 

Enables a disabled AES algorithm. AES 

Counter 

Counter 

Disables an enabled AES algorithm. AES

Modify AES secret 

key 

Overwrite 

execution count* 

Increment 

execution count* 

Detach execution 

count 

Set expiration 

date 

Set expiration 

time* 

Detach lease 

control 

Activate ECC 

feature 

Deactivate ECC 

feature 

Modify ECC 

private key 

Feature and License Action Type (Continued) 

Replaces the existing secret key with the value 

you specify. 

Replaces the existing execution count value 

with the value you specify. 

Increments the existing Counter feature value 

by the amount you specify. 

Detaches the existing execution count value 

and makes the license perpetual. 

Updates the existing Expiration Date with the 

value specified. 




Adds the specified Expiration Time (in minutes) 

to the existing value. 

Detaches the expiration date and expiration 

time control associated with the feature 

and makes the license perpetual. 

* One time update actions. 

5. Provide a name for the action in the Action name field. It can contain 

up to 20 characters. 

Sentinel Hardware Keys Developer’s Guide 159 

AES 

Enables a disabled ECC algorithm. ECC 

Disables an enabled ECC algorithm. ECC 

Updates the Private Key. 

Note: The ISV can copy the Public Key and 

embed it in the application for sign and 

verify. 

Update user limit Updates the User limit associated with a license 

(template). This will remain disabled 

if you set the user limit as 0 in the License 

Designer screen. 

AES 

ECC 

AES 

ECC 

AES 

ECC 

AES 

ECC 

AES 

ECC 

AES 

ECC 

ECC 

License Template




 

The name should be concise, yet descriptive, so the people generating 

update codes can easily see how the hardware key will be updated. 

6. You may optionally include comments for the action in the Action 

comments field. 

7. Click OK to add the action. 

Adding Actions For Sentinel Keys 

Choose Sentinel Key action type for: 

Updating the cheat counter in the Sentinel Key. 

Updating the hardware key time in the Sentinel Key. 

To add actions for the Sentinel Keys: 



2. Under Action Types, select the Sentinel Key radio button. 

3. Click Add. The Add action for Sentinel Key dialog box appears. 

Shown below are commands applicable to Sentinel Keys: 


Set cheat 

counter* 

Sets the Cheat Counter (for non-RTC tokens only) Sentinel Key 

Set device date* Sets the hardware key date and time as per GMT. Sentinel Key 


4. Provide a name for the action in the Action name field. It can consist 

of up to 20 characters. 




comments field.


Adding Actions For Distributor Key 

Choose Distributor Key action type for: 



Updating the metering count in the distributor key. 

Updating the File Encryption Key (FEK) in the distributor key. 

To add actions for the distributor keys: 



2. Under Action Types, select the Distributor key radio button. 

3. Click Add. The Add action for Distributor Key dialog box appears. 

Shown below are commands applicable to distributor keys: 


Metering count* Overwrites the existing metering count in the 

distributor key or increases it by 

the amount specified. 

Modify File 

Encryption Key 

Updates the FEK. This is to be used when you want 

to modify the encryption key used earlier (while 

creating an .lgx file). 




4. Provide a name for the action in the Action name field. It can consist 

of up to 20 characters. 




Comments field. 





Generating Update Codes 


 

You can generate update codes to activate features/applications, or new 

license additions remotely. For a bidirectional update you must have 

obtained a request code from the customer6 who has requested remote activation 

of features/applications. 

The following section explains the Sentinel Key details you must know for 

generating an update code file (.upw) or a new license addition file (.nlf): 

1. Remote Feature/License Update: Requires generating a .upw, 

update code file from the Key Activator tab of the Toolkit. The 

update file can be generated using either of the following methods: 

Bidirectional Update: Requires the following files to generate the 

.upw, update code file: 

A Request Code (.req) file from your customer 

Unidirectional Update: The unidirectional update could be one of 

the following types: 

Unidirectional Single Target Update: Requires the Sentinel 

Key Serial Number targeted for a single target update. 

Unidirectional Broadcast Update: Requires the common 

Developer ID for all the Sentinel Keys targeted for a unidirectional 

broadcast update. 

Note: In all of the above modes, the cheat counter value can be specified in the 

Cheat Counter (only for non-RTC keys) field, before generating the 

*.nlf file. The update packets for LKDT packet is also integrated with the 

*.nlf file. 

2. Remote License Addition: Requires generating a .nlf, new license 

addition file from the Export-File Manager of License Manager in 

Toolkit. 

6. Your distributors might also require update codes to remotely update distributor 

keys with them.



Bidirectional License Addition: Requires the following files to 

generate the .nlf, new license addition code file: 

A Request Code (.req) file from your customer 

Unidirectional License Addition: The unidirectional license 

addition could be one of the following types: 

Unidirectional Single Target License Addition: Requires the 

following information by the developer, to generate the .nlf, new 

license addition code file: 

Serial Number of the Sentinel Key in field, targeted for a single 

target license addition 

The Device Update Counter value for formatting the Key before 

loading a license. 

Unidirectional Broadcast License Addition: Requires the 

common Developer ID for all the Sentinel Keys targeted for a 

unidirectional broadcast update. 

Note: In all of the above modes, the cheat counter value can be specified in the 

Cheat Counter (only for non-RTC keys) field, before generating the 

*.nlf file. The update packets for LKDT packet is also integrated with the 

*.nlf file. 


Question 1 - Why cannot I use telephone or fax to exchange request 

code and updates codes? 

Since both the codes are written in encrypted format (and might contain 

non-printable characters), they cannot be communicated over a phone or 

fax. 

Question 2 - What kind of customization can be done for the Secure 

Update Wizard interface on Windows? 





 

Because the Secure Update Wizard is integrated with the CodeCover/APIprotected 

application at the license designing stage, its interface can be customized 

to include your product and company-specific information (like, 

product name, version, and copyright), text (like, e-mail address and content) 

and images (like, splash image and application icon). 

Question 3 - What are the steps that a customer undergoes to activate 

the application using Secure Update Wizard? 

The topic “Walk-through of Secure Update Wizard (Screens)” in the Sentinel 

Keys Toolkit Help describes these steps. 

Question 4 - Apart from the Sentinel Key and my application, what 

other files I need to ship along with my protected application? 

Please refer to Chapter 10, “Redistributables for Customers and Distributors,” 

on page 223 for complete information. 

Question 5 - Can I use the same request code (.req) file to generate 

an update code (.upw) file, and a license addition (.nlf) file? 

No, you are not advised to do so, because when the request code is generated, 

the value of device update counter is stored in the *.req file. which is 

incremented every time you follow any of the following operations on the 

token: 

Formatting before adding new licenses using *.nlf file. 

Updating cheat counter value. 

Updating Last known date and time (LKDT) value, once the lease 

operation has been performed. 

Updating user limit value. 

Now, consider a scenario wherein you applied the *.req file to generate a 

*.upw file, and later used the same *.req file to generate the *.nlf file. The 

device update counter value in the *.req file may not match its value on the 

token if you have performed any of the operations listed above, hence 

restricting the process of applying the license addition code (*.nlf) file.



Question 6 - Can Secure Update Utility of version 1.0 apply the .upw 

file generated by SHK1.2.1 and higher? 

No, since the .upw file generated by Sentinel Hardware Keys version 1.2.1 

and higher will not be applied using the Secure Update library of version 

1.0, please ensure that you distribute the latest Secure Update Utility and 

associated DLLs to your customer/distributor. 

Question 7 - If I select Delete all licenses from token while generating 

*.nlf file, will the end user be able to apply this file on the token 

as many times as he/she wants? 

No, the new license can be added only once by applying the license addition 

(.nlf) file. 

Question 8 - What is the role of Device Update Counter value in 

removing all licenses from the token? In what scenarios its value is 

updated? 

Device Update Counter is the global update counter in the end user token 

which is incremented every time all licenses from the token are deleted. Its 

value is also updated in the following scenarios: 

Cheat counter value updates. 

Last known date and time (LKDT) updates, once the lease operation 

has been performed. 

User limit value updates. 

Question 9 - In case of Bidirectional Updates, which factors should 

be taken in consideration before generating the update code for a 

feature? 

The ISV’s should ensure that one Update file shall contain a single update 

action because the update actions of conflicting nature should not be 

applied with each other. The list of such update actions is provided below: 

Counter 

Increment Counter 

Overwrite Counter 




AES/ECC 

Overwrite Execution Counter 

Increment Execution Counter 

Detach Counter 

Distributor key 

Increment Counter 

Overwrite Counter 


 

Question 10 - How can I enable the One-Click License Update facility 

for my customers? 

You need to modify your application installer to create registry entries specific 

to .nlf and .upw files. These registry entries are listed in Table , “Installer 

Registries for One-Click License Update,” on page 154.

Chapter 7 

Implementing Secure 

Licensing 

Protecting a software application is never fail-safe. A good analogy are automobiles; 

they are stolen every day. However, there are many vehicles, despite 

their high value, that thieves avoid because they are too difficult to steal. 

This is generally the result of an auto manufacturer that purchased the best 

lock available and spent the time to integrate it properly. Otherwise, even the 

strongest lock can be easily defeated. 

Sentinel Key provides the best software protection system available today. 

However, like the auto manufacturer, you must take the time to properly 

implement the system or it will be bypassed. 

The goal of any software protection strategy is to make the cost of defeating 

it much more than purchasing the software legitimately. Once this is in 

place, users get more value from buying the software than stealing it. You 

should provide a security strategy that fits in with the value of the software 

itself—the higher the value of the software, the more time you should spend 

protecting it. 

This chapter provides you tips on implementing secure licensing strategies. 

If you are using an API-based protection strategy, keep in mind the following 

guidelines to ensure your strategy is effective. 


Chapter 7 – Implementing Secure Licensing 


Note: Creating your own customized protection scheme requires you to understand 

the API functions described in the Sentinel Keys Toolkit Help. 

Vulnerability Assessment - Basic Types of Attacks 


 

Before you can plan a good protection strategy, you need to understand the 

type of attacks targeted at breaking licensing. The diagram below shows the 

vulnerable points typically targeted for attacks: 

Basic Types of Attacks

Attack the Hardware 

Vulnerability Assessment - Basic Types of Attacks 


Typically, this method is extremely difficult, time-consuming, and requires 

very expensive equipment to do. Moreover, the Sentinel Key use chip-onboard 

(COB) technology for high reliability, and greater protection against 

reverse-engineering. The Sentinel Key memory is encrypted using multiple 

unique random keys to defeat memory clones. 

Attack the SafeNet Components 

Generally, the hacker targets the SafeNet-supplied components (such as, 

driver replacement or emulation and replay attacks), so that they return 

correct answers to the application without the Sentinel Key being plugged 

in. To combat such attacks, all the communication between the components 

is passed through a Secure Communication Tunnel that makes use of industry-standard 

algorithms (see “Hardware Key with Cutting-edge Security 

Technology” on page 7). 

Attack the Communication Between Parties 

The communication between the various parties involved in licensing—the 

developer, customer, and distributor—is also prone to attacks. For example, 

a customer may try applying the update code multiple times. However, due 

to the “one time update” capability of the hardware key, an update code cannot 

be used more than once. 

Also, the distributor may program more number of licenses for customers 

than he/she is allowed for. To prevent this, you can specify a limit to meter 

the licenses programmed. For details, refer to “Programming Distributor 

Keys” on page 204. 

Time Tampering Attacks 

System time tampering or rolling back of the system clock is one of the mostcommon 

way of license infringement for lease/trial applications. To address 

this, you can use Sentinel Key with real-time clock. It contains a tamperresistant 

internal real-time clock that indicate the exact date and time to 

track the usage of the leased applications. The real clock keeps track of time 




independent of the system clock—providing the best solution against time 

tampering attacks. 

Non-RTC tokens with Sentinel V-Clock also allow reliable and secure distribution 

of time-limited applications. These do not require an on-board 

battery to detect time tampering and allow you to tolerate the number of 

time tampering attempts specified in the cheat counter. 

Cheat Counter Behavior 


 

Cheat counter is a count-down value that allows tolerating the time tampering 

attacks ranging between 1 second to 30 days (excluding the daylight 

savings) till it reaches zero. Its behavior is described as follows: 

Cheat Counter Behavior 

Scenario Outcome Corrective Measures 

When the system clock is 

tampered for a duration 

between 1 second to 30 

days (excluding the 

daylight savings) 

When the system clock is 

tampered more than once 

(between 1 second to 30 

days) during 

one power-up session of 

the Sentinel Key a 

The system clock is 

tampered for more than 30 

days 

Cheat counter 

decrements by one. 

The AES/ECC algorithms 

are disabled—regardless 

of the cheat counter 

value. 

This prevents against 

multiple time tampering 

attempts during one 

power-up session. 

The AES/ECC algorithms 

are disabled—regardless 

of the cheat counter 

value. 

The application will run successfully till 

cheat counter has reached zero. After 

which, the AES/ECC algorithms are 

disabled and the associated API 

functions return error. You can decide 

the behavior of the application under 

such circumstances. 

If the Sentinel Key is re-plugged, 

normal functionality can be 

resumed. 

If the system clock is corrected, normal 

functionality can be resumed. 

If the system clock is corrected, normal 

functionality can be resumed. 

a. Refers to the duration between the plug-in and plug-out of the Sentinel Key.

Tips and Tricks 

Attack the Application 



Since most software developers do not write security code everyday, this is 

often the easiest target. Since a poorly protected application may only 

require a few quick changes to operate without the Sentinel Key attached, 

hackers might try code patching or fake the application components. Fortunately, 

by using many of the tips in this chapter this can also be made 

extremely difficult. The remaining chapter discusses such methods. 

We have provided many tips and tricks you can implement in your 

application. Each tip protects against specific type of attack—and multiple 

methods will complement each other. 

Use CodeCover to Encrypt Your Executable (For 

Windows) 

For Windows applications, you can combine your API elements-based custom 

protection with CodeCover and add an extra layer of protection. The 

CodeCover encrypts your final executable, which makes it difficult to disassemble 

or debug your application. 

Even if the attacker manages to overcome the difficult task of removing the 

CodeCover, the application inside is still protected—due to two strong layers 

of protection. 

Use CodeCover SDK 

CodeCover SDK provides run-time protection by making use of obfuscation 

and encryption. It also binds the original application to the CodeCover module. 

This ensures that if an attempt is made to recreate the application after 

removing the CodeCover protection, the application does not execute successfully. 

This is because decryption and obfuscation are dependent on the 

CodeCover module for execution. 




Implement Query-Response Protection 


 

The AES algorithm-based query/response protection is the primary method 

of securing an application. Simply storing data in the key memory is relatively 

easier to mimic because once the hacker knows what the memory 

should contain, they can modify the application to return those values 

instead of actually reading them from the Sentinel Key. 

Query-response protection is a challenge-response like technique driven by 

the AES algorithm programmed in the Sentinel Key. The application sends a 

query to the Sentinel Key, which sends a response calculated using the AES 

algorithm, for evaluation. If the response obtained matches the expected 

response, the key is assumed to be present and application is allowed to run. 

Using the SFNTQueryFeature API on an AES feature programmed into the 

Sentinel Key allows your application to issue a nearly infinite amount of 

unique challenges. This mechanism becomes the backbone of your protection 

strategy since it is extremely difficult to duplicate the correct responses. 

You can implement this protection by adding an AES feature to your template 

and then using the SFNTQueryFeature API to challenge the algorithm 

stored in the license. 

However, just using the API once in your application is not enough; there 

are many other tips, like given below, you should endeavor to employ.

Query-Response Protection 

Create a Large Query/Response Table 



If your application only knows a few challenges to issue to the Sentinel Key, 

then it becomes easier to predict them. However, a large table will take a 

long time to use every possibility; thereby increasing the time taken to emulate 

every possible challenge. 

Split Large Table 

You must split the large table into several smaller tables. This places the 

tables at multiple locations inside your protected application and makes it 

difficult to find them all. 




Tip: The query/response table is written into the design header file when you 

build a license template containing an AES feature. 1 

Query Frequently 

If you rely on a single call at the beginning of your code, it is relatively easy 

for a skilled hacker to isolate the call and defeat your protection. Another 

potential problem with querying only once is that a user could remove the 

Sentinel Key after starting the application. The key could then be used to 

run another copy of the application. 2 

Query Randomly 


 

You must design the protection strategy to have the application pick the 

challenge from the query/response table randomly. This makes it difficult to 

anticipate what the challenge will be. Once you choose a challenge, use this 

one challenge repeatedly for some period of time (such as each time the program 

is run, or once a day). If your application uses a different challenge 

every time, then it will cycle through all available challenges in a faster time 

frame. This speeds up the time it takes to listen to every possible challenge. 

Add Noise to your Query Checks 

Generate random queries and then dismiss the results. This generates a 

large amount of unused data among the useful data. Anyone trying to 

record your communications with the key will need to record large amounts 

of data and have trouble deciphering what is meaningful. 

Generate New Tables Frequently 

Each time you create an update to your application, regenerate the query/ 

response table. If an attacker has been able to record all the challenges used 

1. The query/response table will be generated for a CodeCover feature when you select the 

Include CodeCover features check box under the Build Options tab. 

2. To address this, you may also like to use the SFNTSetHeartbeat API function which will 

release the license after specified idle period.



by your program, the update will suddenly require this work to be repeated. 

If you have used the tips discussed above, it will likely be time consuming so 

the illegitimate user is stuck using outdated software. 

Specify Cheat Counter Value 

You can specify a cheat counter value only for non-RTC Sentinel Keys. 

The cheat counter value is global to the Sentinel Key. It applies to all the features 

having lease attribute enabled. You can specify a the cheat counter 

value right before programming hardware keys in the License Manager 

screen. 

If desired, you can use the Secure Update process to increment the cheat 

counter in the field. 

Note: You should call the SFNTQueryFeature function in your application code to 

detect time tampering. In addition, the SFNTEncrypt, SFNTDecrypt, SFNT- 

Sign, and SFNTGetDeviceInfo functions also check for system time tampering. 

Use AES Algorithm to Encrypt Data 

You can use the AES algorithm present in the Sentinel Key for encrypting 

16-byte data blocks. AES has withstood intense scrutiny from the cryptography 

experts and is adopted by National Institute of Standards and 

Technology (NIST) as US FIPS PUB 197 in November 2001 (after a 5-year 

standardization process). It is trusted by many organizations and has a 

proven track record. 

It provides an impenetrable security check because the AES algorithm and 

the 128-bit randomly generated secret key it uses are embedded in the Sentinel 

Key—not accessible to any debugging or memory dumping program. 

You need to: 

Call the SFNTEncrypt API function to send the plain data and have it 

encrypted. 




Call the SFNTDecrypt API function obtain the decrypted data. If the 

decrypted data matches the plain data, the correct Sentinel Key is 

assumed to be present. 

It becomes impossible to replicate these results by skipping the Sentinel Key 

because all the operations are performed in the hardware. 

SFNTEncrypt and SFNTDecrypt Operations 

You can use encryption to protect your application in many ways. 

Encrypt the Query/Response Table 

You should encrypt the query/response table, making it extremely difficult 

to find and use the table by looking at the code. If you only decrypt challenges 

as you use them, then the attacker never sees the table in a fully 

decrypted form. 




Encrypt Critical Data Used by the Application 

All applications at some point require data to operate. Encrypt important 

data files or constants used by your program so it will only operate properly 

with the Sentinel Key attached. 

Verify Data Integrity Using ECC Signing and Verification 

ECC is a public key algorithm (uses public and private key pairs) based on 

discrete logarithms that are much more difficult to challenge at equivalent 

key lengths. You can use the ECC algorithm to implement security checks in 

the application as follows: 

1. Generate a random message. 

2. Call the SFNTSign API function to sign this message using the private 

key is stored secretly in the Sentinel Key. 

3. Call the SFNTVerify API function to verifies the signature using the 

known public key of the token. If the function returns success, the 

correct Sentinel Key is assumed to be present. 




SFNTVerify Operation 


 

You may even sign part of your application data (such as constants) and verify 

its integrity before you use it. You can implement a similar signature 

verification scheme for your digital content (such as, text files and images) 

and store the 42-bit signature as raw data in the Sentinel Key memory. 

Decentralize Your Security Checks 

Decentralizing the security checks throughout the code is a good practice. 

This requires each place in the code to be modified in order for the application 

to run without the key. Restricting them to a few places can lead to easy 

detection and elimination subsequently. Given below are more tips: 

Use In-line Functions in Place of a Centralized Function 

Creating a single function call that checks the key and then making function 

calls throughout the code does not decentralize. Instead, only the 

security check function must be modified to operate without the key. 

Use Many Different Security Checks 

If you use the same security check in many places of the code, then you can 

find each check by searching for patterns. 

Tip: Place the security checks in hard-to-trace operations. For example, if you 

scatter you check throughout a series of database operations, it can be 

extremely time consuming to trace the calls.

Scatter the Security Checks 



Security checks typically consist of multiple steps: calling the key, evaluating 

the returned value, and acting on the evaluation results. Instead of putting 

the entire strategy at one place in your code, you should disperse the check 

all over to make the relation between them not obvious. A security check is 

harder to break if its code components are physically separated into different 

sections of the application instead of being located together. 

Use Multiple Threads to Your Advantage 

If the work of an individual security check happens over multiple threads, 

then tracing through the operation can be complicated. This makes debugging 

the code very difficult. 

Use Returned Values as Variables 

One effective technique to hide security checks in a high-level language is to 

use returned values to control application flow. With this method, a value 

returned by the key becomes a logical pointer or selection key to the next 

execution step or subroutine. This makes analysis of your code more 

difficult. 

Another way to use a returned value is to add it to the value of a variable so 

the sum is the desired value of the variable. If the variable is used in other 

parts of the code, then that code is dependent on the call to the hardware 

key. 

For example, suppose that at some point in your application you want a 

variable to contain the floating value 13.0. Assume that one of the query 

strings you send to the key returns the decimal number 12,345. 

Set the floating variable to -12,332.0. 

Send the query. 

Add the response to the variable. 




Note: Use floating values for comparison. Instead of using only the SP_SUCCESS 

decimal value for comparing the API return codes, you may add floating 

point values (like 1.5) to it. This provides more security against reverse 

engineering of the assembly code. 

If the correct key is attached, the variable will contain the proper value. In 

actual practice, this technique is most effective if the mathematics behind 

the correct value is more complicated than simple addition. 

Checksum Your Code 


 

You should adopt the practice of making a checksum of your critical data. 

You should also verify the validity of the application and any DLLs or shared 

libraries that it uses. This helps detect if the code or data has been modified 

and identify when your application has been tampered. 

Dealing With Missing Sentinel Keys 

If no Sentinel Key is attached to the computer or in network when a protected 

application is run, an error is returned by the SFNTGetLicense API 

function. If a connection is established, but the key is later removed, subsequent 

API functions will return errors. Refer to the Business Layer API Help 

for exact status codes. 

If your application detects that the Sentinel Key is not present, it is up to you 

to decide what action you want to take. Typically, you should not shut down 

your application because of a single unexpected response. 

Instead, repeat your query; if the response is still wrong, then you can take 

action. Possible actions include: 

Display a message and wait for the user to respond. This method does 

not prevent users from running the application, but it makes doing so 

extremely annoying, especially if the application queries the 

hardware key frequently. 

Shut down the application after a predetermined number of failed 

queries. (However, only under the most extraordinary circumstances



should you terminate your application without allowing the users to 

first save their work). 

Allow the application to appear as if it is functioning properly, while in 

fact it is not. (Be very careful if you use this method; less drastic 

actions should be considered first.) 

Display a critical error message and tell the user to contact your 

technical support department. 

These are just some suggested actions; you can implement any combination 

of them to suit your needs. Remember, other events, such as network transmission 

errors can also cause your application to detect a hardware key 

problem. Since these are almost always innocent events, you should design 

your strategy to be as forgiving of them as possible, while still maintaining 

protection integrity. 

Change your Strategy 

Finally, as you perform software updates to your application in the field, 

devote time to change and improve your security checks. The longer the 

checks exist in the field, the more time there is to attack the mechanism. 

Eventually, even the toughest checks might be overcome. However, if you 

continually update your checks, then you can stay one step ahead. Consider 

this action part of a planned maintenance to keep your security at its peak 

level. 

Note: For more personalized assistance in integrating the security checks in your 

application, please contact our Technical Support using the information 

given on page xvi. 






 

Question 1 - If the application failed to obtain a license in one 

attempt, do I need to call the SFNTGetLicense function multiple 

times? 

We recommend calling SFNTGetLicense a few more times, before exiting the 

application. For example, you can call the SFNTGetLicense, despite of 

encountering SP_ERR_UNIT_NOT_FOUND error in stand-alone environments 

and SP_ERR_NO_LICENSE_AVAILABLE in network environments. 

Question 2 - Under which conditions are the AES/ECC algorithms in 

the token disabled? 

The AES and ECC algorithms are NEVER disabled in the token, unless you 

apply the deactivation remote update commands (Deactivate AES algorithms 

and Deactivate ECC algorithm). However, under the following 

conditions, they appear disabled because the licensing functionality associated 

with them has expired and the SFNTQueryFeature API function 

returns an error: 

When the lease period (based on the expiration date or time you 

specified) has been reached. 

When the number of executions allowed have finished. 

When the time tampering takes place as defined in the cheat counter 

scenarios on page 170. 

Question 3 - Where can I find the query-response pairs for the AES 

feature I created? In which format are these written? 

The query-response pairs are available in the header file generated under 

the Build Options tab. These are written in the hexadecimal format. You 

can convert it into ASCII format using the method described below (sample):



Sample Conversion of Hexadecimal into ASCII 





Part 3 

Grouping Licenses and 

Programming Hardware 

Keys 

License grouping and management 

Programming Sentinel Hardware Keys using Sentinel Keys 

Toolkit and the Key Programming APIs

Chapter 8 

License Grouping 

This chapter describes how you can create and manage license groups. 

A group is a package of licenses (templates) that you want to program in the 

Sentinel Key for your customers. 1 The license groups are created in the 

License Manager screen. Different groups can be created to create different 

license packages. 

Why Create Groups? 

The ability to bundle license templates into groups allows you to create 

innovative licensing models in the most straight-forward manner. Using 

groups you can: 

Program multiple licenses into a single Sentinel Key in just a few 

clicks. Because each license is independent of the other, the Sentinel 

Key makes it possible for you to offer products for both enterprise-level 

and small-scale customers. 

Modify the licensing values—like expiration date/time, executions, 

number of users—without modifying the application protection code. 

Since these values are preserved as groups, the licensing strategies 

can be reused to fulfill different customer requirements. 

1. The distributor keys are also programmed with a group. 


Chapter 8 – License Grouping 


Make the market fulfillment activity independent of the license 

designing and implementation. The two set of activities are typically 

unrelated and occur at different stages in a product life cycle. 


 

For example, the AppSoft marketing team can now roll different editions of 

their applications, at different times—without engineering's assistance. In 

fact, for bulk orders the Sentinel Key programming activity can be delegated 

to your Sentinel Key vendor (see “Creating WPS File” on page 206). 

Bundling Applications Using Groups

Creating New Groups 

To create a new group: 

Creating New Groups 


1. Before you move to the License Manager screen, use the License 

Designer screen to build all of the templates you plan to use. Make 

sure that both the developer key and Sentinel Key are attached to the 

system. 

2. In License Manager, click the Load license group icon ( ). The 

Group Management dialog box appears. 

3. Click Create. The Create Group dialog box appears. The template 

that you built in License Designer are shown here. 

Create Group Dialog Box 




4. Add the templates that you want to include in a group. 

5. Specify a group name. The user name automatically appears as the 

default owner. 

6. Specify comments (optional). 

7. Click OK. 

Loading Groups 


 

If you update the license template in the License Designer screen after 

adding it to a group, follow the steps described below, to reflect the changes 

in the group. This is important because, in the License Manager screen 

only a copy of the original license template is worked upon. If the original 

license template is updated, its copy in the License Manager screen must 

be updated as well. 

1. Build the updated template in the License Designer screen. 

2. Remove the template from the group (in the License Manager 

screen). 

3. Add the template again to the group (in the License Manager 

screen). 

Only the loaded group is shown in the group layout. To load a group: 



2. Select the group you want to load currently. 

3. Click Load. The loaded group is shown in the group layout.

Duplicating Groups 

Sending Group Files to Distributors 


You may duplicate groups to copy the settings. To duplicate a group: 



2. Select the group you want to load currently. 

3. Click Duplicate. The Duplicate Group dialog box appears. 

4. Specify a group name. The user name automatically appears as the 

default owner. 

5. Specify comments (optional). 

6. Click OK. 

Removing Groups 

To remove a group: 



2. Select the group you want to remove. 

3. Click Remove. A message box appear for confirmation. 

4. Click OK. 

Sending Group Files to Distributors 

If you want to send updated group files to your distributor without programming 

a new distributor key, you can use this option. 

To create a file for your distributor: 






2. Select the group you want to send. 

3. Click Create File. The Create File dialog box appears. 

4. Specify a path to write the file. 

5. Provide the same File Encryption Key (FEK) used earlier (when you 

programmed the distributor key, see page 204). 

6. Click OK. 

Viewing Group Layouts 

The group layout shows the license group currently loaded, its templates, 

features (default and new), and memory requirement. 

Group Layout 


Creating New Feature Instances 


Note: Only the license templates selected using check boxes will be programmed 

in the Sentinel Key/distributor key. By default, all the license templates are 

selected. If the memory size of the group has exceeded that of hardware 

key, an error will be shown at the time of programming. 

Modifying Default Feature Instances 

You can modify the licensing values of the default feature instance after adding 

it to a group. This feature is provided to take care of the situations when 

minor modifications in the licensing values are required after a protected 

application is complied/protected already. 

To modify default feature values: 

1. Load a group from the Group Management dialog box. 

2. In the group layout, select the default feature instance. In the rightside 

panel, the options are shown. Please note that for default 

instances only the Update button is enabled—all other options 

remain disabled. 

3. Modify the values as desired. 

4. When done, click Update. 

Creating New Feature Instances 

If desired, you can create new feature instances having different licensing 

values. This will save you from modifying the default instance every time 

you receive a different licensing requirement. The new instances become a 

part of the feature node in the group layout, so that you can select the 

appropriate instance and program the Sentinel Key. 





 

Note: You can add new feature instances ONLY IF you selected the Add 

instance(s) later check box while adding CodeCover and API features. For 

some features, you can even specify the maximum limit up to which a 

value can be edited. 

To add new instances: 

1. Load a group from the Group Management dialog box. 

2. In the group layout, select the feature name. In the right-side panel, 

the options are shown. Please note that only the Add button is 

enabled—all other options remain disabled. 

3. Modify the values as desired. You cannot override the maximum limits 

specified. 

4. When done, click Add. 

Add Templates to Groups 

You can add templates to a group created already. Here are the steps to do 

so: 

1. Load the group to which the license templates are to be added. 

2. In License Manager, click the Add License Template icon ( ). The 

Add Template to Group dialog box opens. 

3. Select the license template(s) using the check box(es). 

4. Click Add. When done, you are brought back to the License Manager 

screen. 

Remove Templates From Groups 

You can remove templates from a group created already. Here are the steps 

to do so:

Export-File Manager 



1. Load the group from which the license templates are to be removed. 

2. In License Manager, click the Remove License Template icon ( ). 

The Remove Template from Group dialog box opens. 

3. Select the license template(s) using the check box(es). 

4. Click Remove. When done, you are brought back to the License 

Manager screen. 

The License manager allows you to export the loaded *.LGP file in any of the 

four formats (*.ISV, *.DIS, *.OPR, *.NLF). 

To export the license group files: 

1. Using the Group Management dialog box, load the group from 

which the license group files are to be exported. 

2. In License Manager, click the Export-File Manager icon ( ) to open 


3. In the Export-File Manager wizard, select the type of file you wish to 

export. Click Next. 

4. Configure your inputs for the selected file type and click Next. 

5. Click Generate. The license group information contents are now 

generated for the selected file type. 

Define/view additional comments by clicking the Add comments to 

the file hyperlink. 

Note: For more information on the Export-File Manager wizard process, please 

refer to the Sentinel Keys Toolkit Help. 




Locking/Unlocking Groups 

You can lock a group in the License Manager screen to disable its editing. 

Locking Group 

1. Load the group to be locked. 


 

2. In License Manager, click the Lock the License Group icon ( ). The 

Lock\Unlock Group dialog box appears. 

3. In the Password field, enter the password. These are case-sensitive 

and can contain 4 to 32 ASCII characters. 

4. In the Confirm Password field, enter the same password for confirmation. 

5. Click OK. 

Note: Do not forget the password to unlock the group! If you forget your password, 

there is no “backdoor” that is available to give you access to your 

group. Thus, it is VERY important that you remember the password you use 

to lock your group. 

Unlocking a Group 

You will need to unlock the group in order to load it. 

For an Unloaded Group 

1. Click the Load button on the Group Management dialog box. A 

small dialog box appears prompting you to provide the password. 

2. Specify the password. 

3. Click OK.

For a Loaded Group 



1. In License Manager, click the icon. The Lock\Unlock Group 

dialog box appears. 

2. Specify the password. 

3. Click OK. 


Question 1 - What is a default feature instance? How does it differ 

from other non-default/new feature instances? 

When you add a CodeCover or API feature in the License Designer screen, 

it is known as the default feature instance. If Add instances later check 

box is selected during this process, new feature instances can be created in 

the License Manager screen. 

These are known as the non-default or new feature instances. The option to 

create new feature instances provides the flexibility of changing the licensing 

values right-before programming hardware keys, without having to 

change the protection strategy (created in the License Designer screen). 

The FAQs below provide more information. 

Question 2 - What is the difference between “updating the default 

instance” and “adding a new instance? 

Updating a default feature instance allows you to modify the licensing settings 

right-before programming a batch of Sentinel Keys. This modification 

does not affect your protection implementation at the application-level. For 

example, you can specify 999 executions instead of 99, without generating 

the header file again, or applying the CodeCover protection again, and so on. 

However, updating the default instance can be quite tedious when the 

licensing values need to be modified quite frequently. Further, the updated 

values overwrite the values specified earlier (non-persistent). Therefore, it 

might be useful to add different feature instances having different licensing 




values. Using the radio buttons in the group layout, you can choose the 

required feature instance to be programmed in a hardware key. 


 

Question 3 - Which settings can be modified when instances are 

added or updated? 

You can modify the following while creating groups: 

User limit 

Please note you will be able to modify the user limit value only if you 

specified a non-zero value in the License Designer screen. 

To modify the user limit, select the license template in the group 

layout to view its existing user limit (see the screen-shot below). Click 

OK after modifying the user limit. Note that the user limit specified 

here will override the value you provided in the License Designer 

screen. 

Update User Limit 

Update existing licensing values 

For example, you might want to change the expiration date. Select the 

default feature in the group layout to view the update option (see the 

screen-shot below). Modify the licensing value (such as, the 

Expiration Date) and click Update to save the modifications.

Update Existing Licensing Values 



Add new feature instances with different licensing values 

For example, instead of updating the default instance for a batch of 

hardware keys being programmed, you can create multiple feature 

instances—each with different set of licensing values. Select the 

feature name (top-most item in the feature node) in the group layout. 

If you had selected the Add instances later check box while creating 

that feature in the License Designer screen, you will see the Add 

button enabled in the right-side panel. Modify the licensing values 

and click Add to create the new feature instance. 




Add New Feature Instances 

Question 4 - The options to add new instances or update existing 

instances appear grayed-out. What could be the reason? 


 

Probably the group is locked. Unlock a group using the steps described in the 

Sentinel Keys Toolkit Help. 

Question 5 - Can my distributor also create groups and modify 

licensing settings? 

No. A distributor can only receive the groups created by you. The standalone 

Sentinel Keys License Manager application does not allow modifying 

the licensing values (see the screen-shot below, where a distributor can only 

choose the number of Sentinel Keys to be programmed in a batch).

Stand-alone License Manager 



Question 6 - In the “Add Template to Group” dialog box, I am unable 

to select a license template. What could be the reason? 

This could happen when the license template was updated in the License 

Designer screen but was not built to reflect the changes. Build the license 

template in the License Designer screen to enable the check box shown 

beside the template name. 





Chapter 9 

Programming Sentinel 

Hardware Keys 

This chapter describes how to program the Sentinel Keys and distributor 

keys in the License Manager screen in the Sentinel Keys Toolkit. 

It also briefs on the steps to program the Sentinel Keys using the Key Programming 

APIs. 

Programming Sentinel Keys using Sentinel Keys 

Toolkit 

Given below are the steps for programming Sentinel Keys (in the Toolkit): 

1. Load the group, using which you want to program the Sentinel Key, 

from the Group Management dialog box. 

2. In the group layout, select the required licenses (templates and features) 

to be programmed in a Sentinel Key. You can program multiple 

licenses in a Sentinel Key. 

3. Click the Program Sentinel Key tab. 

4. Select whether you want to program a single key or multiple keys. 


Chapter 9 – Programming Sentinel Hardware Keys 


5. Attach the key (or keys) to be programmed to the USB port(s)/hub. 

You can attach as many keys as possible over the USB ports on your 

system. 

6. Specify the Cheat Counter value. It will be global for the Sentinel 

Key (applicable only to non-RTC Sentinel Keys). 

7. Click Make Keys. Please do not attach/detach keys from the port/ 

hub while the process is in progress. 

Programming Distributor Keys 


 

If desired, you can allow your sales distributors to program Sentinel Keys for 

your customers. You need to provide them with the following items: 

Sentinel License Manager application (stand-alone) 

Group file (.lgx) containing the licenses (templates) that you want to 

allow them to program. 

Corresponding to every group is a distributor key that contains a 

metering count (optional) to track how many licenses they 

programmed. 

Note: The group file (.lgx) and distributor key form a unique pair. Hence, a distributor 

key will not work for any other group file generated with some 

other distributor key. 

To program a distributor key and create its associated group file: 

1. Load the group from the Group Management dialog box. 

2. In the group layout, select the required licenses (templates) using the 

check boxes. You can provide a group file containing multiple licenses 

(and one instance of each feature). 

When you are programming hardware key for your distributors, it is 

up to you to decide which license templates and features you want to 

include in it (you will note that check boxes are provided against the 

templates and features in the group layout). However, only one

Programming Sentinel Keys using Sentinel Keys Toolkit 


instance of a feature can be included (you will note that radio buttons 

are provided against feature instances). If your distributor requires 

licenses with different values (depending on the customer requirements), 

you will need to add a new instance and send the updated 

group file to the distributor. Your distributor can receive the group 

file, using the distributor key shipped with the earlier group. 

3. Click the Program Distributor Key tab. 

4. Select metering setting for your distributor: 

Non-metered 

Unlimited number of Sentinel Keys can be programmed by your 

distributor. 

Metered 

Specify a value between 1 to 65535. The metering count will be 

decremented by one for each license programmed. 

5. Specify a File Encryption Key (FEK). Make sure that you do NOT specify 

same FEK for every distributor. 

You must make a note of this down somewhere so that, if required, 

you can send updated group files to your distributors without programming 

a new distributor key. You may also copy the FEK to clipboard, 

by clicking the (Copies FEK to clipboard) icon. 

6. Specify a Cheat Counter value that you want your distributors to program 

in the non-RTC Sentinel Keys. 

7. Attach a single distributor key you purchased from SafeNet to your 

USB port/hub (it is not same as developer key or Sentinel Key). 

8. Click Make Distributor Key. 

9. Specify a path to write the group file (.lgx) for your distributor. 




Updating Distributor Key Metering Count 

When the metering count on a distributor key reaches zero, the distributor 

will no longer be able to program Sentinel Keys. You can increment the 

count on a distributor key (and charge for doing so) in the same way that 

you update Sentinel Keys in the field. 

For doing so, you must add the Metering count command in the distributor 

key actions (see “Adding Actions For Distributor Key” on page 161) for 

the license template. 

To remotely update a distributor key: 

1. Ask your distributor to run the Secure Update Utility, while the distributor 

key is connected to his system, to generate a request code. 

2. Tell your distributor to send the request code to you (using an e-mail 

or file). 

3. Create a distributor key action type with the desired metering count. 


 

4. Enter the request code in the Key Activator tab. The key information 

is extracted from the request code. 

5. Select the action created in step 3. 

6. Click Generate Update Code. The Toolkit generates an update 

code—specific to the distributor’s key. 

7. Send the update code back to the distributor. 

8. Distributor enters the update code in the Secure Update Utility. The 

key is updated and the distributor can again program keys. 

Creating WPS File 

If desired, you can also write a .wps file for your Sentinel Key vendors. Using 

the .wps file they can program Sentinel Keys in bulk for you.

To create an .wps file: 

Programming Sentinel Keys using Sentinel Keys Toolkit 


1. Load the group from the Group Management dialog box. 

2. In the layout, select the required licenses (templates) using the check 

boxes. You can create a file containing multiple licenses (having one 

instance per feature). 

3. Click the Program Sentinel Key tab. 

4. Click Create WPS File. 

5. Specify a path for writing the file. 

6. Click Save. 




Programming Sentinel Keys using the Key 

Programming APIs 


 

Using the Key Programming APIs is a quick and effortless way for programming 

Sentinel Keys in bulk. 

The Key Programming APIs enable you to create your own programming 

utility or a stand- alone executable to program each Sentinel Key with the 

license group file exported using the Export-File Manager wizard in the 

License Manager of Sentinel Keys Toolkit. 

Note: For more information on the API functions, please refer to the Key Programming 

API Help. 

Steps for Using the Key Programming APIs 

Given below are the three major steps involved in programming Sentinel 

Keys using the Key Programming APIs. 

1. Generate a License Group File for Export 

2. Implement the Key Programming APIs 

3. Compile and Create your own Programming Utility 

Step 1- Generating a License Group File for Export 

Before you can use the API functions described in this document, you must 

generate a license group file for the product keys you want to program. 

The steps below briefly describe the process you need to follow to export the 

license group information created at the License Manager stage of the 

Toolkit. 

1. Using the Group Management dialog box, load the group from 

which the license group files are to be exported.

Programming Sentinel Keys using the Key Programming APIs 


2. In License Manager, click the Export-File Manager icon ( ) to open 

the Export-File Manager wizard. The Export-File Manager wizard 

enables you to create a valid export file. 

3. In the Export-File Manager wizard, select the type of file you wish to 

export. Click Next. The contents of these files will be different for each 

of the category of users as described in the table below: 

Types of license group files to be exported for Sentinel Keys Programming 

File Type Category of 

Users 

*.ISV Developer a 

*.DIS Distributor b 

Description 

The *.ISV file contains basic information about the licenses 

and features, a protection 

strategy should consist of. 

Only a Developer, along with a Developer Key, can generate 

this file and then program it onto the end user token. 

The *.DIS file contains information related to licenses and 

features to be programmed in the end user token using the 

Key Programming API library and is bound to a Distributor 

Key using the File Encryption Key. 

Only a Developer, along with a Developer Key, and in the 

presence of a Distributor Key, can generate this file. The file is 

generated by a Developer and then provided to the 

Distributor that enables the distributor to program the end 

user token in association with a valid Distributor Key. 

*.OPR Operator c The *.OPR file contains license images which can be 

programmed on the token using the Key Programming API 

library. 

Only a Developer, along with a Developer Key, and in the 

presence of a end user token, can generate this file. This file is 

programmed onto the end user token at the fulfillment 

center. 

a. An individual or a software development company that uses the Sentinel Keys SDK to protect 

and license their applications. 




b.An individual/organization authorized by the developer to distribute the protected application 

along with the Sentinel Keys 

c.An individual/group who is unaware of the contents, and is more concerned about the number 

of tokens being programmed using the programming utility/stand-alone executable provided to 

him by a developer. 

4. Configure your inputs for the selected file and click Next. Enter the 

following information as per the selected file type: 

File Types and Required Inputs 

File Type Information 

*.ISV Define Location and Enter the cheat counter value: 

Browse and select the destination folder for the exported 

file, and enter the cheat counter value in the Cheat Counter 

(only for non-RTC keys) field. The default is 0. 

Note: You may also define/view additional comments by 

clicking the Add comments to the file hyperlink. 

*.DIS Specify the File Encryption Key a as programmed on the 

Distributor Key and then continue to select the destination 

folder for the file. 

*.OPR Define Location and Enter the cheat counter value: 



(only for non-RTC keys) b field. The default is 0. 


clicking the Add comments to the file hyperlink. 

a. The distributor file is bound to the distributor token File Encryption Key; 

thereby allowing the rightful recipient to decrypt and use the file. 

b.Refer to section, “Cheat Counter Behavior” on page 170. 


 

Define Location and Enter the cheat counter value: 



(only for non-RTC keys) b field. The default is 0. 


clicking the Add comments to the file hyperlink.

Programming Sentinel Keys using the Key Programming APIs 


5. Click Generate. The license group information contents are now 

generated for each of the three category of users. 

Step 2 - Implementing the Key Programming APIs into your 

Solution 

Once you have successfully exported the License Group file (*.ISV/*.DIS/ 

*.OPR) onto your system, you need to program the Sentinel Key with the 

exported file. 

The Sentinel Keys are programmed with the *.ISV/*.DIS/*.OPR file information, 

using the Key Programming API library. 

Please refer to the Key Programming API Help, for more information on 

implementing the Key Programming APIs into your solution. 

Step 3 - Compiling your Solution and Creating a 

Programming Utility 

Finally, compile and link your application after including the Sentinel Keys 

header files and libraries. 

You may now create your own programming utility or a stand-alone executable 

to be distributed to your operators for bulk programming. 






 

Question1 - How would I know if the group I created exceeds the 

amount of memory available in the Sentinel Key? 

In case the size of the group exceeds the memory size of your sentinel key, 

then you will get the error (stating that your key does not have sufficient 

memory to program the group) while programming the key. 

The group must not exceed 1776 bytes for 8KB memory Sentinel Key, and 

4080 bytes for 64 KB memory Sentinel Key (SHK XM). Else, the Toolkit displays 

an error message. The memory size of the group to be programmed in 

the Sentinel Key is shown in the Group Layout. 

Question 2 - How many hardware keys can be programmed at a 

time? 

On a Windows system, you can program up to 256 USB keys at a time. On a 

Linux and Macintosh system, you can program up to 32 USB keys at a time. 

However, the time taken will be according to the number of hardware keys 

attached. Please also make sure of the following: 

Do not attach/remove hardware keys during programming. 

Wait for progress bar to complete (show 100% status complete), 

before you remove the hardware keys. 

Question 3 - I am unable to program the hardware keys? What 

should I do? 

An error can occur while programming hardware keys due to hardware or 

software reasons. You should verify if the hardware key is firmly connected 

to the USB port/hub. The LED on the hardware key should be illuminated to 

verify if it has been plugged-in properly. 

To determine if a programming failure is due to a software error or a hardware 

error, try programming another hardware key with the same group. If 

the programming is successful, the previous error was hardware-related. If 

you try programming many keys, and all of them fail programming, the 

error is software-related.



If you suspect a technical problem, contact SafeNet Technical Support to 

help you in troubleshooting. The support representative will work with you 

to rule out resolvable software and/or configuration problems. If the problem 

cannot be resolved, you will be issued a RMA (Return Material 

Authorization) number. To ensure proper handling is acknowledged for the 

returned keys, you must obtain a RMA number prior to shipping the products. 

After you have obtained an RMA number and are ready to package the 

hardware keys for shipping, please make sure that you use "cold plastic" or 

"conductive plastic" to avoid any further damage. 

Question 4 - Is it possible to reprogram the already programmed 

hardware keys? 

Yes. 

Question 5 - Are there any log files created at the time of programming 

hardware keys? 

Yes. The following log file are created when the Sentinel Keys, distributor 

keys, and Custom CodeCover Keys are programmed: 

EndUserLog.xml - For Sentinel Keys 

MakeKeysLog.xml - For distributor keys 

CodeCoverLog.xml - For Custom CodeCover keys 

These contain information, including the following: 

Date and time at which the hardware key was programmed 

Serial number 

Developer ID 

Global lease value (only for Custom CodeCover keys) 

Information about the license groups and templates, including the 

number of licenses programmed. 

The default location for these log files on Windows systems is: 

\.safenet 




Question 6 - Is Sentinel Keys Toolkit the only utility using which I 

can program my Sentinel Keys? 

No. You have several other options for doing so. Sentinel Hardware Keys 

offer different interfaces for programming that enable a quick and easy 

implementation of your protection strategy. 

The table below provides a summary (description) of each programming 

component and the category of users using them. 


Programming Utility User Associated File/Key Usage Description 


Toolkit 

Stand-alone 


Developer Developer Key Refer to “Programming 

Sentinel Keys using Sentinel 

Keys Toolkit” on page 203. 

Distributor Distributor key 

license group file 

(.lgx) 


 

The .lgx file is a package of 

licenses that you want to 

program in the Sentinel Key 

for your customers.

Utility/Executable 

developed out of 

the Key 

Programming APIs 




Programming Utility User Associated File/Key Usage Description 

Developer Developer Key 

*.ISV file 

Distributor Distributor Key 

*.DIS file 

Only a Developer, along 

with a Developer Key, can 

generate this file and then 

program it onto the end 

user token. 

The file is bound to a 

Distributor Key using the 

File Encryption Key. 

Only a Developer, along 

with a Developer Key, and in 

the presence of a Distributor 

Key, can generate this file. 

The file is generated by a 

Developer and then 

provided to the Distributor 

that enables the distributor 

to program the end user 

token in association with a 

valid Distributor Key. 

Operator *.OPR file Only a Developer, along 

with a Developer Key, and in 

the presence of a end user 

token, can generate this file. 

This file is programmed onto 

the end user token at the 

fulfillment center. 

Question 7 - What do I need Key Programming APIs for? 

Key Programming API (Setup) library can be used for two purposes: 

1. Programming the license information generated by Toolkit. 

2. Updating the instance values of features, based on conditions. 




Question 8 - How is the update packet created using the Key Programming 

API library different from the ones created using the 

secure update library? 


 

Secure update allows you to create updates using a predefined interface, 

whereas using Key Programming APIs you can define your own values programmatically 

or through an interface designed by you. 

Question 9 - How to create an update packet using the Key Programming 

APIs? 

For information on how to create an update packet, please look for the 

SampleUpdate folder located at the location, \Key Programming\Visual 

C++\Samples\SampleUpdate in the SDK. 

Question 10 - How do I generate the information to be programmed 

onto the token? 

Use the Export-File Manager wizard at the License Manager stage to generate 

the programmable information. Refer to, Generating a License Group 

File, on page 208. 

Question 11 - How do I program this generated information onto 

the token, using the Key Programming APIs? 

For information on how to program this generated information on your 

token, please look for the ProgramExportFile folder located at the location, 

\Key Programming\Visual C++\Samples\ProgramExportFile in the 

SDK. 

Question 12 - What are the constants, defined in the Key Programming 

APIs, used for? 

These constants allows you to manipulate the instruction to the Key Programming 

APIs. Please refer to the samples, located at the location 

\Key Programming\Visual C++\Samples, for more information.



Question 13 - How can I define the end consumer of my update 

code? 

These updates can be used by either the Key Programming APIs, or the 

Secure Update Library. 

#define SP_PACKET_TYPE_ONE: Creates a license image for the Key 

Programming API 

#define SP_PACKET_TYPE_TWO: Creates a license image for the 

Secure Update library 

Question 14 - What are the different feature types and how can I 

use them? 

Please refer to the sample update to get information about different feature 

types and their usage. 

Question 15 - I get an error while programming the distributor file. 

What is this? 

Please refer to the error code descriptions for the source of the error and its 

description. The error codes have been listed down in the Key Programming 

API Help. 

Question 16 - My developer key is password-protected. How shall I 

use it to program Sentinel keys, using the Key Programming APIs ? 

Since you have set up a password for your developer key, you must specify it 

before programming Sentinel keys. To do so, you need to call the SFNTVerifyUser 

API that helps authenticate the password of the developer key. The 

developer key’s password contains 8-16 alphanumeric characters. 

Once the password is verified, you can create update packets to modify the 

key values, using the SFNTCreateUpdatePacket API. 

Question 17 - How to program a String/Raw Data Feature with 10K 

(or more) data into an SHK XM Key? 

To program a String/Raw Data Feature with 10K (or more) data into a SHK 

XM Key: 

1. Split the 10K (or more) data into chunks of 2032 bytes or less. 





 

2. Create a License Template and add a Raw Data feature for each chunk 

of data (generated at step 1) in the License Designer screen of the 

Toolkit. 

3. Create a License Group in the License Manager screen. 

4. Add the License Template (created at step 2) into the new License 

Group. 

5. Click Make Keys under the Program Sentinel Key tab in the 

License Manager screen to program the license group into the 

attached SHK XM Key. 

Question 18 - How to program a String/Raw Data Feature with 

2032 bytes data into SHK XM Key using Key Programming APIs? 

To program a SHK XM Key with String/Raw Data feature containing 2032 

bytes data using Key Programming APIs: 

1. Use the header file sentinelsetup.h and the library SentinelSetupW.dll. 

2. Export the *.ISV, *.DIS, or *.OPR file with Sentinel Keys Toolkit. 

3. Call the Key Programming API, SFNTProgramKey, as explained in 

the Key Programming API Help. However, the length of Raw Data feature 

can be 2032 bytes. 

Note: The files exported from earlier Toolkit versions can be imported by Key 

Programming API library of version 1.3.0 (and later); but the reverse operation 

is not possible. 

Question 19- How to program a String/Raw Data Feature with 2032 

bytes data into SHK XM Key with License Manager Utility? 

To program a String/Raw Data feature with 2032 bytes data into SHK XM 

Key with License Manager Utility: 

1. Click Start>Programs>SafeNet Sentinel>Sentinel Keys English>License 

Manger to open the License Manger utility.



2. Import the license group file generated with Toolkit of version 1.3.0 

or later. 

3. Click Make Keys to program the Key. 

Note: The license group file generated with Toolkit 1.2.1 (and earlier) can be 

imported by License Manager Utility version 1.3.0 (and later) whereas the 

reverse is not allowed. 





Part 4 

Distributing Protected 

Applications 

Checklist of redistributables for customers and 

distributors 

Information on deploying the redistributables

Chapter 10 

Redistributables for 

Customers and Distributors 

This chapter guides you on the items that you must ship to your: 

Customers who will be using the protected applications. 

Distributors who will be programming the Sentinel Keys for 

customers. 

Please make sure that you are familiar with your application’s licensing and 

protection strategy, so that you can choose the appropriate items for 

deployment. 

Checklist for Customers And Distributors 

The table below shows a list of all possible items that you should consider 

before packaging the applications/CDs for your customers and distributors. 

If your company uses distributors to sell your products, then all the customer 

items must also be passed to your distributors. 


Chapter 10 – Redistributables for Customers and Distributors 


Check List of the Items to Be Redistributed 

Component Summary Customer Distributor 

Sentinel System Driver Device driver for the hardware keys 

Sentinel Keys Server a 

Configuration file 

(client) 


and its Help b 


(only Windows) 

Sentinel Data Protection 

Driver (only Windows) 

Sentinel Keys System 

Administrator’s Help 


self-extracting installer 

Distributor key and 

.lgx file 

hhupd.exe and 

hhactivex.dll (only 

Windows) 

Rellic.dll, and Rellic64.dll 

(only for 32-bit and 64bit 

Windows 

applications) 

License manager for network 

applications 

For setting up the host to be contacted, 

network protocol, heartbeat interval, 

and Sentinel Keys Server socket port on 

the client-side (application) 

For updating hardware keys in the field 

Required only for Windows when you 

associated the Secure Update Wizard for 

remote updates 

Required only when you have either of 

the following in CodeCover: 

- Encrypted data files for Windows 9x, or 

- .NET applications for 9x 

HTML Help for the system administrator 

on the customer site 

Stand-alone application for 

programming Sentinel Keys 

Hardware key for a distributor and 

associated group (.lgx file) c 

Needed for viewing the.chm files (on 

Windows), like Secure Update Utility 

Help. 

Needed only for executables protected 

using CodeCover to release the license. 


SDNPro.dll, and 

SDNPro64.dll (only for 

32-bit and 64-bit 

Windows applications) 

Deploying Sentinel System Driver 

When to Deploy? 

Deploying Sentinel System Driver 


Check List of the Items to Be Redistributed (Continued) 

Component Summary Customer Distributor 

Sentinel System Driver is the USB device driver for using the hardware keys. 

It must be redistributed to all customers and distributors. 

Where to Deploy? 

The Sentinel System Driver must be deployed on the system where the hardware 

key is attached (whether stand-alone or network key). For platforms 

supported and installation path, refer to “Sentinel System Driver” on 

page 31. 

How to Deploy? 

You can use the Sentinel Protection Installer to deploy the Sentinel System 

Driver and/or Sentinel Keys Server (including related items like, the Sentinel 

Keys Server configuration file and Sentinel Keys License Monitor). 

For Windows 

Needed only when .NET enhancement 

option is selected during protection. 

a. Also includes Sentinel Keys License Monitor files and (server-side) configuration file. 

b. Your distributors may also use it for updating the distributor keys. 

c. Each distributor requires a different pair of distributor key and group file (.lgx). 

The Sentinel Protection Installer provides various installation options, 

including the ones that use Windows Installer merge modules and MSI. The 

developers who create Windows Installer-based installation programs can 




refer to the Sentinel Protection Installer Help for details. It is available at: 

\Sentinel Protection Installer\English\help. 

For Linux 


 

The Sentinel Keys Protection Installer provides RPMs for the Sentinel System 

Driver (sntl-sud-7.5.1-0.i386.rpm) and Sentinel Keys Server (shk-server- 

1.3.1-0.i386.rpm). You may either run the skpi_install.sh script to install the 

two components, or use the following RPM commands: 

Use the rpm -ivh --force --nodeps sntl-sud-7.5.1- 

0.i386.rpm command to install the Sentinel System Driver (USB 

daemon). 

Use the rpm -ivh --force shk-server-1.3.1-0.i386.rpm 

command to install the Sentinel Keys Server. 

For Macintosh 

The Sentinel Keys Protection Installer installs the Sentinel System Driver 

(KEXT), Sentinel Keys Server (Daemon) and Sentinel Framework 1 . 

You need to ship the complete contents of the /Sentinel Keys Protection 

Installer directory. The /Sentinel Keys Protection Installer directory contains 

the SentinelKeysProtechtionInstaller.pkg package to allow installation of the 

Sentinel System Driver and Sentinel Keys Server. 

Tip: Keep watching http://www.safenet-inc.com/support for the latest releases of 

Sentinel Keys Protection Installer. You can provide the same Web address to 

your customers/distributors for downloads. 

For stand-alone environments, you can use the SentinelSystemDriver.pkg, 

available in the SDK CD. This will only install the Sentinel System Driver and 

related files. This installer will also install an uninstallation script at: /Applications/SafeNet 

Sentinel/Common Files/Sentinel System Driver/. Your 

customers can run this to remove the Sentinel System Driver and its files. 

1. If Sentinel UltraPro /SuperPro already exists on the target system.

Deploying (Client) Configuration File 


Note: The uninstallation script available with the Sentinel Keys Protection 

Installer (at: /Applications/SafeNet Sentinel/Sentinel Keys //Sentinel 

Keys Protection Installer/English/) will uninstall both the Sentinel System 

Driver and Sentinel Keys Server. 

Deploying Sentinel Keys Server 


It is the license manager for your network applications. It must be shipped 

with applications that use network keys. 


The Sentinel Keys Server must be installed on the networked system where 

the Sentinel Key is attached. For platforms supported and installation path, 

refer to “Sentinel Keys Server” on page 28. 

How to Deploy? 

Please refer to the information given in the “How to Deploy” section of the 

topic “Deploying Sentinel System Driver” on page 225. 

Note: No additional steps are needed to deploy Sentinel Keys License Monitor, 

unless you are customizing its .class files. Refer to the Customizing Sentinel 

Keys License Monitor - ReadMe for details on customization. 

Deploying (Client) Configuration File 

When to Deploy 

If you want to allow your customers to set any/all of the following settings, 

you must ship the configuration file: 

Network protocol for client-server communication 




Sentinel Keys Server host 

Heartbeat interval for maintaining the license acquired by network 

applications 

Sentinel Keys Server socket port 

Where to Deploy 

By default, this file exists in the same directory where your protected application 

is installed. However, it may exists at a different location (with a 

different name) if you have customized its name and path. 

How to Deploy 

You can include it in your application’s installation program. It is available 

at the following path: 

For Windows: \Configuration File Template. 

For Linux: /Configuration_File_Template. 

For Macintosh: /Configuration File Template. 


 

Note: The Sentinel Keys Server configuration file is deployed along with the Sentinel 

Keys Server in its installation directory. You need not ship it separately. 

However, you may provide instructions to your customers on how to 

set parameters in the configuration files. 

Deploying Secure Update Utility 


You need to deploy the Secure Update utility when you are providing activations 

in the field. It provides an alternative to Secure Update Wizard (for 

Windows only) and Secure Update API. 

This utility can be used for updating Sentinel Keys and distributor keys 

remotely.


Deploying Secure Update Utility 


The Secure Update Utility must be installed on the same system where the 

Sentinel Key/distributor key is attached. This is because the hardware keys 

cannot be updated over network. Be sure to modify your installation programs 

appropriately. 

How to Deploy 

Install the following items as a part of your application’s setup routine: 

For Windows 

SecureUpdateUtility.exe (available at: \Secure Update\Secure 

Update Utility) 

SecureUpdate.dll (location same as the executable above) 

.chm Help file (available at: \Secure Update\Secure Update 

Utility\Language packs\en_US) 

Note: If you are shipping a .chm file, you may also need to ship hhupd.exe and 

hhactivx.dll. Generally, these files reside in the \System directory of a Windows 

system. Otherwise, these can downloaded from: . 

For Linux 

Secure Update Utility application (available at: / 

secure_update/SecureUpdateUtility). 

libSecureUpdate32.so (location same as the utility above) 

HTML Help file (available at: /secure_update/ 

SecureUpdateUtility/language_packs/en_US. You need to ship the 

WEBHELP directory along with the index.htm file) 




For Macintosh 

Secure Update Utility application (available at: /Secure 

Update/Secure Update Utility/INTF). 

libSecureUpdate32.dylib (location same as the utility above) 


 

HTML Help file (available at: /Secure Update/Secure Update 

Utility/Language Packs/en_US. You need to ship the WEBHELP 

directory along with the index.htm file) 

Deploying Secure Update Wizard (Windows Only) 


The Secure Update Wizard need to be deployed on a Windows-based customer’s 

system only if you are planning to update Sentinel Keys remotely 

and not using the Secure Update utility or API functions. 


The Secure Update Wizard must be installed on the same system where the 

Sentinel Key is attached. Hence, if your application is a stand-alone application, 

the Secure Update Wizard must be installed on each workstation. 

How to Deploy 

For CodeCover-protected Applications 

For CodeCover-protected applications, you need to copy the following files at 

the location where your product executable resides. 

UpdateWizard.exe: The Secure Update Wizard executable. 

.cab: The compressed file for the template.

Error Code 

(Decimal) 

For API-protected Applications 



For API-protected applications, you need to call the UpdateWizard API function 

on the application startup. You also need to install the following files at 

the location where the application executables resides: 

UpdateWizard.exe: The Secure Update Wizard executable. 

.cab: The compressed file for the template. 

UPWITF.dll: A DLL that exports the UpdateWizard API. You can 

obtain its copy from the following location in your Sentinel Keys SDK 

installation: \Secure Update\Update Wizard\INTF. 

UpdateWizard API Function 

Format 

unsigned short UpdateWizard (SPP_UPDATE_WIZARD_INFO p_UpdInfo); 

Parameter 

Name Direction Type Description 

p_UpdInfo IN SPP_UPDATE_WIZARD_INFO Contains the Update 

Wizard configuration. 

Points to the 

SPP_UPDATE_WIZARD 

_INFO structure. 

Return Values 

If successful, the function returns SP_SUCCESS. If an error occurs, the function 

returns one of the following error codes: 

0 SP_SUCCESS 

Success. 

Description 

501 SP_ERR_KEY_NOT_FOUND 

The Valid hardware key not found. The Update Code is not meant for this 

key. 




Error Code 

(Decimal) 

502 SP_ERR_ILLEGAL_UPDATE 

One or more commands could not be performed. 

503 SP_ERR_DLL_LOAD_ERROR 

The Secure Update library not found, which is: 

SecureUpdate.DLL for Windows 

SecureUpdate.so for Linux 

libSecureUpdate32.dylib for Macintosh 

504 SP_ERR_NO_CONFIG_FILE 

Update wizard not able to locate the configuration file. 

505 SP_ERR_INVALID_CONFIG_FILE 

Not a valid Configuration file. 

506 SP_ERR_UPDATE_WIZARD_NOT_FOUND 

Could not find UpdateWizard.exe. 

507 SP_ERR_UPDATE_WIZARD_SPAWN_ERROR 

There was an error in spawning the Update Wizard. 

508 SP_ERR_EXCEPTION_ERROR 

An exception error occurred within the Update Wizard. 

509 SP_ERR_INVALID_CLIENT_LIB 

Not a valid Secure Update DLL. 

Description 

510 SP_ERR_CABINET_DLL 

The CABINET.DLL is not found on target system. 

511 SP_ERR_INSUFFICIENT_REQ_CODE_BUFFER 

The size of the request buffer is not sufficient to hold the request code. 

512 SP_ERR_UPDATE_WIZARD_USER_CANCELLED 

The application was canceled when the try/buy option is shown. Applicable 

only to applications that use Sentinel Update Wizard and are protected using 

CodeCover. 

513 SP_ERR_INVALID_DLL_VERSION 

The Secure Update DLL version is invalid. Use DLL version 1.2 or higher to 

apply the packet information. 

514 SP_ERR_INVALID_FILE_TYPE 

The type of the file is invalid. File types can be .upw or .nlf. 


SPP_UPDATE_WIZARD_INFO Structure 



Error Code 

Description 

(Decimal) 

/* Common error codes for Secure Update and Key Programming Library*/ 

212 SP_ERR_COMMUNICATIONS_ERROR 

Unable to communicate with the Sentinel Key. Make sure of the 

following: 

The Sentinel System Driver is installed and running. 

The client and the Sentinel Keys Server use the same protocol. 

The Sentinel Key is attached properly. 

There is no network-related problem (for example, network congestion or 

break-down). 

226 SP_ERR_UNIT_NOT_FOUND 

The specified Sentinel Key is not found. 

230 SP_ERR_DUPLICATE_LIC_ID 

The License ID you specified, already exists. 

231 SP_ERR_DECRYPTION_FAILED 

The decryption process failed. 

232 SP_ERR_BAD_CHKSUM 

The checksum value not matching. 

233 SP_ERR_BAD_LICENSE_IMAGE 

The license image is corrupt in the .OPR file. 

234 SP_ERR_INSUFFICIENT_MEMORY 

Insufficient memory in key to load a license. 

The structure contains settings for the Update Wizard. The caller fills in the 

fields of the structure that they want to use as the settings for the Update 

Wizard. It is passed to the function UpdateWizard to run the Update Wizard. 

Format 

typedef struct SP_UPDATE_WIZARD_INFO { 

DWORD size; 

DWORD wndHandle; 




long spawnAndWait; 

long enableTryButton; 

long daysLeft; 

long executionsLeft; 

long minutesLeft; 

char configFile[SP_MAX_PATH_LEN]; 

} SP_UPDATE_WIZARD_INFO, *SPP_UPDATE_WIZARD_INFO; 

Member Information 

Item Description 

size Specifies the size of the SPP_UPDATE_WIZARD_INFO, in 

bytes. This parameter is required. 

wndHandle Specifies the handle to the application’s main window. This 

parameter is required. 

spawnAndWait Flag that indicates whether to run and wait for the Update 

Wizard to quit. Set the field value to 1 to run and wait. A 

value of 0 will run the Update Wizard and return 

immediately. 

enableTryButton This member defines the state of the Try button on the 

Update Wizard. It has the 

following values: 

DISABLE_TRY_BUTTON (0) - The Try button is not visible. 

ENABLE_TRY_BUTTON (1) - The Try button is visible. 

daysLeft Defines the number of days left for a demo license. This 

option displays a status line on the Update Wizard screen 

indicating to the customer how many days are left for a trial 

period. Define a value of 0 to indicate that the trial period 

has expired and –1 or undefined to disable this feature. This 

option is only valid when enableTryButton is set to 

ENABLE_TRY_BUTTON. 


Deploying Sentinel Data Protection Driver (Windows Only) 

Item Description 


executionsLeft Defines the number of executions left for a demo license. 

This option displays a status line on the Update Wizard 

screen indicating to the customer how many executions 

are left for a trial period. Define a value of 0 to indicate 

that the trial period has expired and –1 or undefined to 

disable this feature. This option is only valid when 

enableTryButton is set to ENABLE_TRY_BUTTON. 

minutesLeft Defines the number of minutes left for a demo license. This 

option displays a status line on the Update Wizard screen 

indicating to the customer how many minutes or hours 

are left for a trial period. Define a value of 0 to indicate 

that the trial period has expired and –1 or undefined to 

disable this feature. This option is only valid when 

enableTryButton is set to ENABLE_TRY_BUTTON. 

configFile Refers to the .cab file. The file name must be fully qualified, 

path plus file name. This parameter is required. 

Deploying Sentinel Data Protection Driver 

(Windows Only) 


Deployment of Sentinel Data Protection Driver is required only for Windows 

98/ME systems. 

If you have encrypted data files or .NET applications that have been protected 

using CodeCover, then you need to deploy the Sentinel Data 

Protection Driver on your customer’s system. 

How to Deploy 

The \Data Protection Driver directory in the Sentinel Keys SDK CD consists of 

the following files: 

File Description 

Instdrvr.exe The Data Protection driver installer. 




File Description 

Instdrvr.c C source code of the Instdrvr.exe utility for you. You can use it 

to customize the driver installation and registry modification 

procedure. 

Sentdata.vxd The Data Protection driver. 

Readme.pdf A readme file that has details on the installation. 

You can either ship Instdrvr.exe and Sentdata.vxd files to your customer with 

the following instructions on how to load the driver: 

1. Copy the directory contents to a system. 

2. Select Run from the Taskbar and run the instdrvr.exe file. 

3. When the message “Driver installed! Restart your system” appears, 

click OK. 

4. Now, restart the system. The following files have been copied into 

your System folder and required registry entries are made: 

WINDOWS\SYSTEM\SENTDATA.VXD 

WINDOWS\SYSTEM\INSTDRVR.EXE 

Otherwise, you can modify this installation program for your own installation 

needs, we have provided the C source code that installs this program. 


 

You need to call the program to check for the type of operating system being 

used. You also need to remind customers that their computer must be 

rebooted after installing the data protection driver in order to load the driver. 

Your installation program may call the data protection driver with the following 

command line options: 


/P Specifies the source path for sentdata.vxd. If not included, 

the installer looks for the.VXD file in the directory where the 

driver installer resides.


Deploying Stand-alone License Manager 


/U Uninstalls the driver. The installation program returns a zero 

if it was successful; otherwise, it returns the error code of the 

last Win32 API call that had an error (if applicable). 

The installation program returns a zero if it was successful; otherwise, it 

returns the error code of the last Win32 API call that had an error (if applicable). 

If the unsuccessful API call does not return an error, the installer 

returns a -1. 

Deploying Stand-alone License Manager 


You need to provide the stand-alone License Manager application to your 

product distributors/resellers, so that they can program Sentinel Keys for 

the customers on their own. This application is supported on Windows platforms 

only. 





It must be deployed in the /System folder on the system where the protected 

application is installed. 

Hardware Requirements Software Requirements 

Processor 

Windows: 

- 64-bit processors: Athlon 64 or 

Opteron processors from AMD - Xeon 

with EM64T or Pentium 4 with EM64T 

from Intel 

- 32-bit processors: Pentium II or above 

Monitor and Display Settings 

VGA Monitor with 1024 x 768 resolution 

(1152 x 864 recommended) 

Hard Disk Space 

10 MB free hard disk space 

RAM 

128 MB RAM (256 MB recommended) 

Peripherals 

At least two USB ports (to attach the 

ISV key, LM or End User key). 

Disk Drive 

CD-ROM if installing using a CD. 

How to Deploy 

Operating System 

Windows 2000, Windows XP (32-bit and x64), 

or Windows Server 2003 (32-bit and x64), Windows 

Vista - Service Pack 1 (32-bit and x64), 

Windows Server 2008 (32-bit and x64), Windows 

Server 2008 R2 (64-bit), and Windows 7 

(32-bit and 64-bit) 


 

Java Runtime Environment 

Java 2 Runtime Environment version 1.6 or 

higher. A copy might be included with the 

License Manager installer. Else, you may download 

the latest version from http:// 

java.sun.com. 

Web Browser 

32-bit versions of the Internet Explorer (6.0 or 

later), Mozilla FireFox (1.0 or later), Safari (1.3 

or later). You may need to allow the blocked 

content (that uses Active X controls or scripts) 

in order to view the Help. 

PDF File Viewer 

Adobe Acrobat Reader 4.0 or higher. 

An installer is included in the Sentinel Keys installation CD using which, 

your distributors can install the following components: 

The License Manager application 

The License Manager Help file 

Java 2 Run-time Environment (version 1.6)

For Windows 

Deploying System Administrator’s Help 


The self-extracting installer is available at the following location in the 

media: \Sentinel Keys License Manager\English. 

Deploying System Administrator’s Help 

This Online Help contains information about the following topics that are of 

interest for the system administers and users of protected applications: 

Using Sentinel Key 

Deploying and troubleshooting Sentinel System Driver 

Deploying and troubleshooting Sentinel Keys Server 

Deploying and troubleshooting Sentinel Keys License Monitor 

Using client-side and server-side configuration files 

Updating Sentinel Keys remotely 

You can provide the complete Help to your customers, or use a portion of it 

(by copying the text), depending on what exact information they require. 

You may include it in your product documentation, print it, or send to your 

customers via e-mail. Your customers need Internet Explorer 6.0 (or higher) 

Netscape Navigator 4.6 (or higher) to view the Help. 

How to Deploy 

Distribute the complete contents of the directory (path mentioned below) 

along with the index.htm page. The index.htm page is used for launching the 

System Administrator’s Help. 

For Windows: 

\Manuals\English\SentinelKeysManual\SysAdminHelp 

For Linux 

/manuals/english/SysAdminHelp 




For Macintosh 

/Manuals/English/SysAdminHelp 



 

Question 1 - Where is the Sentinel System Driver installed? Can I 

modify its location? 

The Sentinel System Driver is installed at the following location. Its location 

cannot be modified: 



System Driver 

Installed at the following path on a Windows x64 system: \Program Files(x86)\Common Files\SafeNet Sentinel\Sentinel 

System Driver. 

On Linux: /opt/safenet_sentinel/common_files/sentinel_usb_daemon 

On Macintosh: /System/Library/Extensions 

Question 2 - Where is the Sentinel Keys Server installed? Can I modify 

its location? 

The Sentinel Keys Server is installed at the following location. Its location 

cannot be modified: 



Keys Server 


\Program Files(x86)\Common Files\SafeNet 

Sentinel\Sentinel Keys Server 

On Linux: /opt/safenet_sentinel/common_files/sentinel_keys_server 

On Macintosh: /Applications/Safenet Sentinel/Common Files/Sentinel 

Keys Server



Question 3 - Does the Sentinel Protection Installer also install Java 

Run-time Environment? 

The Sentinel Protection Installer does not install Java Run-time Environment 

because neither the Sentinel System Driver, nor Sentinel Keys Server 

require it. However, it is required for using the Sentinel Keys License Monitor. 

You can download a copy from http://www.java.sun.com. A copy of JRE 

version 1.6.0 is also included in the Sentinel Keys SDK CD you received. 

For Macintosh, J2RE version 1.6 is not included in the Sentinel Keys SDK 

CD, you can download a copy from http://www.apple.com/java. 

Question 4 - What are the options available for using the Sentinel 

Protection Installer in a Windows Installer based installation 

program? 

You can use the Sentinel Protection Installer in the following ways to install 

Sentinel System Driver and/or Sentinel Keys Server. 

Using merge modules - The SentinelKeysUSBDriver.msm and/or 

SentinelKeysServer.msm merge modules are packaged forms of 

redistributables and can be integrated seamlessly with your 

InstallShield for Windows Installer and WISE installation programs. 

The merge modules contain the necessary files and registry entries, 

hence free you from the burdensome task of creating entries 

manually. Also, using merge modules the above-mentioned Sentinel 

Key redistributables are installed and uninstalled with your 

application. 

Note: Supports standard and basic projects 

The merge modules support both the basic and standard project types. 

Using MSI - If your Windows Installer based program does not 

support merge modules, you can make use of Sentinel Protection 

Installer (English) package for installing the abovementioned 

Sentinel Key redistributables. 

Using setup.exe - For legacy installers (such as, batch files or consolebased 

setup programs), you can use setup.exe available in 

\Sentinel Protection Installer\English directory to run a 




graphic installer that does step-by-step installation. Alternatively, the 

setup program can be executed quietly using the command-line 

switches. 

Graphical Sentinel Protection Installer 


 

Internet Installer - You may even point your customers to 

download the latest version of the Sentinel Protection Installer 

themselves from http://www.safenet-inc.com/support/tech/sentinel.asp. 

A copy of the self-extracting installer is available at: 

\Sentinel Protection Installer\English\Internet Installer. 

For additional information, refer to the Sentinel Protection Installer Help.

Appendix A 

Troubleshooting 

This appendix on troubleshooting assists in providing solutions to the typical 

problems you might face, while using Sentinel Hardware Keys to protect 

your application. 

In addition to the information contained in this chapter, you can also access 

the following resources for your queries. 

The SafeNet Knowledge Base at http://c3.safenet-inc.com/search.asp 

Sentinel Keys Toolkit Help, integrated with the Toolkit, for a list of 

CodeCover and API specific error codes. 

Problems and Solutions 

Problem: Time/Date Tampering 

You are using Sentinel Keys Toolkit to protect an application with a Lease 

License, and Make Keys works successfully. Now, for testing purposes when 

you set your system date forward, a time tampering error occurs and you 

can no longer generate keys or protect other applications with the toolkit. 

This happens even after you set the date on your system correctly. How can 

you rectify this error? 

Solution: 

Solution for Keys - 


Appendix A – Troubleshooting 


1. Remove the USB key. 

2. Set your system’s date and time, and then reinsert the USB key. 

3. Start the protected application. 

Solution for Toolkit: 

For a toolkit error, build a different template, and then rebuild the original 

template. 


 

Problem: Application Startup Time 

You have an application that takes about 3 seconds to start when unprotected. 

When protected using CodeCover, it takes about 15 seconds to start. 

How can you control the CodeCover options to effect the protected application 

startup time? 

Solution: 

The CodeCover provides multi-layered protection levels from 1 to 5. More is 

the number of layers, more is the startup time; and vice versa. By default, 

level 3 multi-layering is used. You need to change the multi-layering level to 

effect the protected application startup time. 

To access the Multi-layer level option, open the License Designer screen 

in the Toolkit. Select the CodeCover tab, and then click Edit. Select the 

Security tab, and under the Advance Options section, is the Multi-layer 

level option. 

Problem: Updating Keys 

You are using Sentinel Hardware Keys for protecting two applications and 

each application is set up with a different license template (the first application 

uses License template A, and the second application uses License template 

B). 

Customer 1 purchases the first application. We program the key for License 

template A. A month later, Customer 1 purchases the second application, 

therefore we need to add License Template B to the key.



Can Secure Update be used to update the key for adding a new license? 

Solution: 

Yes, Sentinel Hardware Keys Secure Update allows you to activate and add 

user licenses to the key. Refer to, “Secure Remote New License Addition” on 

page 145. 

Problem: Protecting .EXE, .DLL, and .BPL files using a 

Command Line Interface 

You want to use a command line interface for protecting .exe, .dll, and .bpl 

files. 

Solution: 

Use the Command-Line CodeCover Utility (CMDShell.exe) in the SDK that 

provides 32/64-bit CodeCover support, to protect your .exe, .dll, and .bpl 

files. Refer to, “CodeCover Protection Using the Command-Line Utility” on 

page 91. 

Problem: Backing up the Templates, Features, and 

Groups 

You want to back up the templates, features, and groups generated in the 

toolkit. 

Solution: 

By default, there are two directories to backup the templates, features, and 

groups generated in the toolkit. 

Programs are stored in the directory, \Sentinel Keys 

Toolkit. 

The license group files are stored at: \My 

Documents\Sentinel Keys \My License Groups. 

Note - The license group files are stored at: \Documents\Sentinel Keys\My License Groups on 

Windows Vista. 




The license template files are stored at: \My 

Documents\Sentinel Keys \My License Templates. 

Note - The license template files are stored at: \Documents\Sentinel Keys\My License Templates on 

Windows Vista. 

You can change the default License and Group templates directories by 

using the following steps: 

1. Navigate to Options > Setting > Working Folder > Folder Settings 

on Sentinel Keys Toolkit. 


 

2. Enter the new paths for License and Group templates respectively, and 

click Reset. 

3. Click OK. 

Problem: Performing Silent Command Line Driver and 

Server Install 

You want to know what files are needed to perform a silent command line 

driver, and server install. 

Solution: 

Use the command: setup /v”/qn ADDLOCAL=USB_Driver,SentinelKeysServer 

REBOOT=ReallySuppress CONFIRMUPGRADE=TRUE 

ENABLEFIREWALL=TRUE" 

The files needed are: 

Data1.cab 

Sentinel Protection Installer 7.6.2.exe 

Sentinel Protection Installer 7.6.2.msi 

setup.exe



Problem: Accessing Sentinel Hardware Key on a different 

network subnet 

You want to access a Sentinel Hardware Key on a different network subnet. 

Solution: 

Create a configuration file and place it in the same directory as the executable 

file. In the configuration file, under the ContactServer section, enter the 

IP Address of the server computer. 

Note: There is a sample configuration file at the location, \Configuration 

File Template. 

Problem: Ethernet Port for Sentinel Keys Server 

You want to know which Ethernet Port is used for Sentinel Keys Server. 

Solution: 

UDP port 7001. In case UDP port 7001 is blocked, open the port in the 

advanced option of the IP firewall. 

Note: This applies to networked implementation of security only. 

Problem: Monitoring Sentinel Hardware Keys licenses 

in Use 

You want to monitor Sentinel Hardware Keys licenses that are in use on the 

key server. 

Solution: 

You can do the same by connecting to http://localhost:7002, or http:// 

IP_Address:7002 





 

Problem: License Monitor fails to launch with Java Runtime 

Environment (JRE) 1.6.0, Installed on Windows 

Server 2003/Server 2008/Server 2008 R2/Windows 7 64bit 

Systems 

Java Runtime Environment (JRE) 1.6.0, installed on Windows Server 2003/ 

Server 2008/Server 2008 R2/Windows 7 64-bit systems restricts launching 

the Sentinel Keys License Monitor. 

Solution: 

You can either uninstall Java Runtime Environment (JRE) 1.6.0 and install 

the 1.5.0 version, or try customizing the settings in Internet Explorer. 

Customizing Settings in Internet Explorer 

1. Launch Internet Explorer. 

2. From the Tools menu, select Internet Options. 

3. Click the Advanced tab. 

4. Under Browsing, select the checkbox titled, Enable third-party 

browser extensions (requires restart). 

5. Click OK to apply the settings specified. 

Launch the License Monitor successfully after customizing the above settings 

in Internet Explorer running on a Windows Server 2003/Server 

2008/Server 2008 R2/Windows 7 64-bit system, with Java Runtime Environment 

(JRE) 1.6.0. 

Problem: Upgrading the Sentinel USB Driver and Sentinel 

Keys Server 

You want to upgrade the Sentinel USB Driver and Sentinel Keys Server.

Solution: 



Use the following steps to upgrade the Sentinel USB Driver and Sentinel Keys 

Server: 

1. Verify that the USB or parallel port is working correctly. 

2. Log in as Administrator. 

3. Unplug the key(s). 

4. Remove the old Sentinel Protection Server/Driver/Combo and reinstall 

the Sentinel Protection Installer. 

Go to Start > Settings > Control Panel > Add or Remove Programs 

(Vista is Programs and Features). Select both the Sentinel 

Protection Installer and Sentinel System Driver, and then click 

Remove. 

5. Shut Down, and then restart your system. 

6. Download and install the new Sentinel Protection Installer v7.6.2 

from the location www.safenet-inc.com/support/tech/sentinel.asp. 

Note: If you are using standalone applications, you can perform a custom install 

and uncheck both the servers from the installation. The Sentinel Keys 

Server only needs to be installed on a Sentinel Hardware Keys server computer. 

The Sentinel Protection Server only needs to be installed on a Super- 

Pro and/or UltraPro key server computer. 

7. Plug in the key(s). 

8. Download Sentinel Advanced Medic from the location 

www.safenet-inc.com/support/tech/sentinel.asp, and run it to make sure 

the key(s) is being detected correctly. 

The driver version in medic should be 7.5.1. If Medic detects the key, 

then it indicates that the computer, operating system, port, key and 

driver are working correctly. 




Note: Medic does not detect the 64-bit operating system version correctly. 

9. Test the application software. 

Problem: Uninstalling the Sentinel Keys Server 

You want to uninstall the Sentinel Keys Server without uninstalling the 

Sentinel Driver. 

Solution: 


 

On the computer running the Sentinel Keys Server, run :\Program 

Files\Common Files\SafeNet Sentinel\Sentinel Protection Server\ 

loadserv.exe. Specify the service name, :\Program Files\Common 

Files\SafeNet Sentinel\Sentinel Keys Server\ sntlkeyssrvr.exe and click Remove 

Service. 

Problem: Selecting .Net Framework version 

When protecting a .NET application with multiple versions installed, you 

want to select the version of .Net Framework to be used. 

Solution: 

The .config file appname.exe.config decides which version of .NET Framework 

will be used. 

A Sample appname.exe.config is as follows: 

 

 

 

 



Problem: Runtime error message R6034 from Code- 

Cover protected .EXE file. 

You receive an error message R6034 when protecting a .exe file using 

CodeCover. 

Solution: 

There are two ways to avoid this error: 

Remove the msvcr80.dll file from c:\windows\system32 folder or any 

other execution path, or 

Make a manifest file and place it in the same folder where the 

protected application is located. 

Whereas the original exe file name is app.exe, the manifest file name is 

in the format app.exe.manifest. 

A Sample app.exe.manifest is as follows: 

 

 

 

 

 

 

 

 

Problem: Building Multiple Applications to a Single Key 

You want to build multiple applications to a single key. 




Solution: 


 

Use the following series of steps to build multiple applications to a single key: 

1. In License Designer of Sentinel Keys Toolkit, create a template for 

each application. 

2. In License Manager, create a group that includes both the templates. 

3. Click Make Keys, to program the group into the key. 

Problem: Protecting an Integrated Application using 

CodeCover 

You want to protect an integrated application using CodeCover. 

Solution: 

Use the following series of steps to build multiple applications to a single key: 

1. In License Designer of Sentinel Keys Toolkit, create a CodeCover template 

for the application to be protected. 

2. Create an API template for the integrated application. 

3. In License Manager, create a group that includes both the templates. 

4. Click Make Keys, to program the group into the key. 

Problem: Programming Keys using Remote Desktop 

You want to program keys using remote desktop. 

Solution: 

Yes, you can program keys using Remote Desktop. However, you cannot 

program keys connected to a different computer.

Problem: The application receives a 

SP_ERR_INVALID_LICENSE error 



The application receives a SP_ERR_INVALID_LICENSE error after a license 

is obtained. 

Solution: 

This error could occur when the license is timed-out. The license time interval 

is probably set too short. You can recommend to your customers that 

they use the client-side configuration file for setting a longer license time 

interval. 


SP_ERR_SERVER_PROBABLY_NOT_UP error 

The application receives a SP_ERR_SERVER_PROBABLY_NOT_UP error, 

even when the Sentinel Keys Server is running. 

Solution: 

This error could occur when the network is busy. To overcome this 

error, you should re-try by calling the API function again. If the 

customers are facing this error, recommend that they launch the 

application again. 

This error may also occur when the server port is already in-use. You 

can verify this in the system EventLog or the Sentinel Keys Server 

error log file. To troubleshoot this, you can set a non-busy port in the 

server-side configuration file to run the Sentinel Keys Server. Make 

sure that the same port is set in the client-side configuration file. 


SP_ERR_PROTOCOL_NOT_INSTALLED error 

The application receives a SP_ERR_PROTOCOL_NOT_INSTALLED error. 

Solution: 





 

This error is encountered when the protocol used for communication is not 

installed on the client system. You can modify the protocol in the client-side 


Note: Only TCP/IP is supported on Linux and Macintosh. 

Problem: The Configuration File settings were not 

applied 

The Configuration File settings were not applied. 

Solution: 

If the client-side configuration file’s name and path have not 

been customized: The client-side configuration file must be present 

in the directory where your application's executable resides. 

If the client-side configuration file’s name and path have been 

customized: Make sure that the file with the customized name exists 

at the specified path. Also ensure that the file is valid and contains 

parameters in correct format. 

The server-side configuration file must be present in the directory 

where the Sentinel Keys Server is installed. The parameter settings 

will not be applied if the file is moved to any other location. 

Make sure that you specify only one value for a parameter (except 

setting the ContactServer tag and the Protocol tag in the client and 

server-side configuration files, respectively). 

The Sentinel Keys Server must be restarted if the server-side 

configuration file is updated. 

Problem: Files not being Encrypted 

While protecting, one of your files is not being encrypted.

Solution: 



If any of your input files (the application executable, or any other files you 

have selected for encryption) have the read-only attribute set, CodeCover 

may not be able to protect the file. Clear the read-only attributes in the file’s 

Properties dialog box, then try again. 

Problem: Releasing a License 

You have closed the CodeCover-protected application on your system to free 

up a license. However, the Sentinel Keys License Monitor still shows the 

license in use. 

Solution: 

You should manually cancel the license in the Sentinel Keys License Monitor. 

To automatically release the license on application exit, copy the 

relLic.dll (for 32-bit application executable) or relLic64.dll (for 64-bit application 

executable) in the directory that contains the application executable. 

This DLL can be obtained from \Sentinel Keys Toolkit directory of the Sentinel 

Keys SDK installation. 

Problem: Application fails to execute with a statically 

linked protected DLL 

When you protect the DLL that is statically linked to the application, the 

application fails to execute with the protected DLL. Whereas, if the DLL is 

linked dynamically, it executes successfully. 

Solution: 

This is a static linked DLL issue that occurs once you have protected your 

application. Please follow the following tips while protecting a statically 

linked DLL to resolve this issue. 

Protect both the static linked DLL, and executable instead of 

protecting only the DLL. 

Use Load Library instead of linking the DLL statically. 




Problem: Unable to Program the Hardware Keys 

You are unable to program the hardware keys. 

Solution: 


 

An error can occur while programming hardware keys due to hardware or 

software reasons. You should verify the hardware key is firmly connected to 

the USB port/hub. The LED on the hardware key should be illuminated to 

verify if it has been plugged-in properly. 

To determine if a programming failure is due to a software error or a hardware 

error, try programming another hardware key with the same group. If 

the programming is successful, the previous error was hardware-related. If 

you try programming many keys, and all of them fail programming, the 

error is software-related. 

If you suspect a technical problem, contact SafeNet Technical Support to 

help you in troubleshooting. The support representative will work with you 

to rule out resolvable software and/or configuration problems. If the problem 

cannot be resolved, you will be issued a RMA (Return Material 

Authorization) number. To ensure proper handling is acknowledged for the 

returned keys, you must obtain a RMA number prior to shipping the 

products. 

After you have obtained an RMA number and are ready to package the 

hardware keys for shipping, please make sure that you use “cold plastic” or 

“conductive plastic” to avoid any further damage. 

Problem: Error Programming a Distributor File 

You get an error while programming the distributor file, using the Key Programming 

APIs. 

Solution: 

Please refer to the error code descriptions for the source of the error and its 

description. The error codes have been listed down in the Key Programming 

API Help.

Appendix B 

Glossary 

A 

Access Mode 

An access mode determines the route a protected application follows to 

obtain a license. See page 65 for more information. 

Action 

Refers to a collection of remote update commands. 

AES 

Short for Advanced Encryption Standard—an industry-standard symmetric 

key encryption algorithm. You can use it through the AES feature to 

encrypt/decrypt 16-bytes of data. 

API 

Short for Application Program Interface. The set of client interface routines 

your application uses to communicate with the Sentinel Key. 


Appendix B – Glossary 


B 

ASCII 

Short for American Standard Code for Information Interchange; a code for 

information exchange between computers made by different companies; a 

string of 7 binary digits represents each character; used in most 

microcomputers. 

Asymmetric Key Encryption System 


 

Also referred as the public key encryption system. It uses a pair of keys—a 

private key and a public key—to encrypt and decrypt data. 

The asymmetric algorithms are considered to be slower than the symmetric 

algorithms for a comparable key size. Typically, the former are used for 

encrypting the hash values and symmetric session keys (which are comparatively 

much smaller in size than bulk data). 

Bidirectional Code Generation 

The Developer generates this code (Feature/License update [.upw], or New 

License Addition [.nlf]) with a request code from the end user, and updates a 

single key in field. 

Block 

A sequence of bits of fixed length; longer sequences of bits can be broken 

down into blocks. 

Courtesy - http://www.rsasecurity.com 

Borland Package Library (BPL) 

BPL is a special dynamic-link library (DLL) that is used for building Borland 

applications; and contains modules to be shared across multiple projects.

C 

 

Business Layer API 


Refers to the Sentinel Keys client library API functions—used for communicating 

between your application and the Sentinel Key. See page 58 and 

page 133 for more information. A separate Business Layer API Help is also 

provided (you can launch it from the Help menu of the Sentinel Keys 

Toolkit). 

Cheat Counter 

A count-down value that allows tolerating the time tampering attacks ranging 

between 1 second to 30 days (excluding the daylight savings) till it 

reaches zero. See page 169 for more information. 

CodeCover 

An automatic method of protecting Windows executables, DLLs, and BPLs. 

It does not require source code of your application. See page 55 for more 

information. 

Code Morphing 

Code Morphing is the technique to obfuscate important parts of application 

code (such as strings, constants, and code fragments). The obfuscated code 

is difficult to analyze in disassemblers and during run-time analysis. The use 

of Code Morphing helps add extra security to an application by hiding the 

implementation logic of sensitive code from reverse engineering techniques. 

To use Code Morphing, you need to implement CodeCover SDK macros in 

your source code. Refer to the ReadMe available at the \Sentinel 

Keys Toolkit\Shell SDK\Help\English folder for details. 

Code Sketch 

The protection plan generated by the Toolkit when a license template is 

built. It consists of an outline of the Business Layer API functions that you 


C



should incorporate in your source code. It is a good reference when you are 

not sure which API functions are relevant for your particular strategy. The 

code sketch is written into an HTML file present in the Toolkit working 

folder. It can be generated for the most-frequently used development 

languages. 

To view the code sketch, you can either click View under the Build Options 

tab, or navigate to the Toolkit working folder. 

Command 

Refers to the function calls that describe what will be done to a hardware 

key in the field. For example, the Change write password command will 

change the Write Password associated with the feature. 


A console-based program that protects executables, DLLs, and BPLs using 

the CodeCover method via command-line. 

Customer 

An individual or organization using the application protected with Sentinel 

Key. 

Custom CodeCover Key 


 

A Sentinel Key initialized to protect applications at the end user’s site, using 

the Command-Line CodeCover Utility. It eliminates the need to carry a developer 

key to the customer’s location; to avoid any licensing violations that 

may occur if the developer key is lost. 

A Custom CodeCover key contains only CodeCover features and can be used 

to protect applications till a specified date. It can not be used to program 

hardware keys or modify licensing strategies.

D 

 

Decryption 


The conversion of encrypted data into plain text data (the original form), so 

it can deciphered by the intended recipients/process. 

Developer 

An individual or a software development company that uses the Sentinel 

Keys SDK to protect and license their applications. 

Developer ID 

A unique identification code for the hardware keys provided by SafeNet to 

the developer. You can view the developer ID in the Key Status panel of the 

Toolkit. 

Developer Key 

The hardware key must to be used for preparing the application protection 

strategy using the Toolkit. You must always plug-in the developer key in 

order to build a license template. See also, “Developer Key” on page 21. 

Digital Signature 

A digital guarantee that information has not been modified, as if it were protected 

by a tamper-proof seal that is broken if the content were altered. The 

two major applications of digital signatures are for setting up a secure connection 

to a Web site and verifying the integrity of files transmitted. 

Courtesy - http://www.answers.com/ 

Distributor 

An entity/organization authorized by the developer to distribute the protected 

application along with the Sentinel Keys. They can also program 

Sentinel Keys using the License Manager (stand-alone) application. 


D



E 



 

The hardware key that your distributor requires to use the License Manager 

(stand-alone) application. It has the capability to validate the file sent by the 

developer for programming Sentinel Keys. It can also digitally sign the 

license templates programmed into the Sentinel Keys. 

ECC 

Short for Elliptic Curve Cryptography. It is an alternative method for implementing 

public key cryptography. ECC is primarily used for creating digital 

signatures—signed with a private key and verified with the public key. 

ECKAS is used for key exchange to create a shared secret key. 

ECC uses points on an elliptic curve to derive a 163-bit public key that is 

equivalent in strength to a 1024-bit RSA key. The public key is created by 

agreeing on a standard generator point in an elliptic curve group (elliptic 

curve mathematics is a branch of number theory) and multiplying that 

point by a random number (the private key). Although the starting point 

and public key are known, it is extremely difficult to backtrack and derive 

the private key. 

Courtesy - http://www.answers.com/ 

Encryption 

The conversion of plain text data into a form that cannot be read by unintended 

recipients. The encrypted data is referred to as cipher text. 

End User Token 

The Sentinel Key, used to protect the applications, being used by an individual 

or an organization.

Execution Count 


The number of times the application will run for. It can be a value between 1 

and 65535. The counter is decremented by one every time the application is 

executed. 

Expiration Date 

The fixed date after which the protected application will not run. Specify for 

leasing your applications/features. 

Expiration Time 

The time period, after which the protected application will not run. The time 

period will start soon after the application is executed first. Specify for leasing 

your applications/features. For example, 

The expiration time chosen is 60 minutes. 

The application is first executed at 1500 hours of 30 September, 

2007. 

Therefore, the application will expire at 1600 hours of 30 September, 

2007. 

Note: If you are creating the licensing strategy much in advance and expect that 

the expiration date may approach rather soon, then choose expiration 

time instead. The expiration time will begin only after the first execution. 


E



F 

Feature(s) 

A feature refers to the most-basic unit of a protection strategy (license template). 

Refer to the topic “About Features, Templates, and Groups” on 

page 51 for details. 

FEK 

Short for File Encryption Key. Refers to a 16-byte AES secret key used for 

encrypting/decrypting the license group file (.lgx) sent to your distributor. 

Feature Attributes 

An attribute defines the properties of a feature. Refer to the Sentinel Keys 

Toolkit Help for a list of feature attributes. 

Feature ID 


 

An identifier of a feature in the license template. It is assigned by the Toolkit 

while a feature is created. 

Feature Instance 

Refers to a feature with attributes defined. When CodeCover and API features 

are added in the License Designer screen, the default feature 

instances are said to be created. 

Additional (new) feature instances can be added in the License Manager 

screen while creating groups (if the Add instances later check box is 

selected in the License Designer screen while adding/editing the default 

feature instance). 

Firmware 

Computer programming instructions that are stored in a read-only memory 

unit rather than being implemented through software.

G 

H 

 

Group 


A group is a package of licenses (templates) that you want to program in the 

Sentinel Key for your customers and distributors. Groups are also used to 

program distributor keys. 

Hard Limit 

The hard limit is the factory-programmed limit that defines the maximum 

number of users allowed by the hardware key. Sentinel Keys are available 

with the following hard limits: 3, 5, 10, 25, 50, 100, and 250. Sentinel Keys 

with 0 hard limit are known as stand-alone keys. 

Header File 

The header file is generated at the time of building a license template. For 

example, SentinelKeysLicense.h for Visual C. 

It contains important information for your (license) strategy, including the 

license ID, feature ID, software key, query-response table (if you have 

included an AES feature in your template), and a public key (if you included 

a ECC feature in your template). 

Heartbeat 

The interval for which the Sentinel Keys Server maintains the license. By 

default, it releases the license after two minutes (120 seconds). 

Hexadecimal 

Refers to the base-16 number system, which consists of 16 unique symbols: 

the numbers 0 to 9 and the letters A to F. 


H



K 

L 

Key 


 

A string of bits used widely in cryptography, allowing people to encrypt and 

decrypt data; a key can be used to perform other mathematical operations as 

well. Given a cipher (the encryption-decryption algorithm), a key determines 

the mapping of the plaintext (the data to be encrypted) to the 

ciphertext (the encrypted data). 


Key Exchange 

A process used by two more parties to exchange keys in cryptosystems. 



A set of API functions that enable you to create your own programming utility 

or a stand- alone executable to program each Sentinel Key with the 

license group file exported using the Export-File Manager wizard in the 

License Manager of Sentinel Keys Toolkit. 

Certain Key Programming API functions also allow you to create update 

packets for inserting value instances to Sentinel Keys or licenses. 

License 

A license is an agreement under which your customer is granted the right to 

use an application in the manner specified in the software license 

agreement.

License Addition Code 


Refers to the code generated (as *.nlf file) by the developer for adding new 

license(s) files into the end user token through the secure update library. 

The *.nlf file is generated using the Export-File Manager wizard under the 

License Manager stage of the Toolkit. 

License ID 

A 16-bit identifier generated by the Toolkit for the license template you 

created. 

It is written into the Sentinel Key memory at the time of programming. The 

SFNTGetLicense function makes use of the license ID and developer ID for 

finding your Sentinel Keys on the customers' site. 

License Sharing 

When multiple instances of a protected application on a seat can be run 

using one license. A seat represents a user name and MAC address 

combination. 

License Template 

A license template is a container of features that define your application protection 

strategy. 

Corresponding to every license template is a license ID that identifies the 

license in the Sentinel Key. 

A Sentinel Key can contain multiple licenses (templates)—depending on the 

memory size and the features included. Using the license grouping option of 

Toolkit, you can bundle multiple licenses into one group, so that one Sentinel 

Key can be deployed to license multiple applications on a customer site. 


L



M 

N 

O 

MAC Address 

Stands for Media Access Control Address, a hardware address that uniquely 

identifies each node of a network. 

Network Applications 


 

A network application is designed to be run on multiple computers so that 

several users can run it concurrently. You should attach the Sentinel Key on 

a networked system, where the Sentinel Keys Server and Sentinel System 

Driver are also installed. 

For stand-alone applications, the Sentinel Key must be attached to each 

workstation. 

Network Keys 

A network key allows multiple network clients to run the protected application 

concurrently. 

It is typically connected to a networked system running the Sentinel Keys 

Server in the subnet. 

The network keys are meant for the number of users defined by the hard 

limit. If desired, you can program a user limit for restricting the hard limit. 

One-Click License Update 

It is the ability to directly update/add license to a key by just double-clicking 

the .upw or .nlf file. It is a quick shortcut to apply the update/license code 

avoiding a series of steps, which include opening the Secure Update Utility, 

browsing the required file, and clicking Apply Code.

P 

Q 

 


As a developer, you can enable the One-Click license Update facility for a 

customer/distributor by creating certain registry entries via your installer. 

Personal Folder 

See “Conventions Used in This Guide” on page xiv. 

Private Key 

In public-key cryptography, this is the secret key. Sentinel Keys contain the 

ECC private keys, primarily used for key exchange and digital signatures. 

Public Key 

In public-key cryptography this key is made public to all. It is primarily used 

for verifying digital signatures and solving the key exchange problem. 

Public Key Cryptography 

Cryptography based on methods involving a public key and a private key. 

Query Data 

The data scrambled using the AES algorithm in the Sentinel Key. You program 

your application to send queries to the Sentinel Key. The Sentinel Key 

scrambles the string using the AES algorithm and returns a response to the 

application. 

Query-Response Protection 

Please see the topic “Implement Query-Response Protection” on page 172. 


Q



R 

S 

Request Code 


 

Refers to the code generated (as a .req file) by the customers/distributors as a 

request to update their hardware keys. It contains the hardware key details 

(such as, the serial number) and the license information. 

Your customers can generate it using the option you allow—Secure Update 

utility, Secure Update Wizard (for Windows only), or some custom utility 

that calls the Secure Update API functions. Your distributors can generate it 

using the Secure Update utility or some custom utility (to update the distributor 

key count). 

Using the request code, an update code, or a license addition code is generated 

under the Key Activator tab of the Toolkit. 

Response Data 

The scrambled result derived when the Sentinel Key processes the query 

data using the AES algorithm. The Sentinel Key returns the response data to 

the application. The application then uses the response to determine 

whether the user is authorized to run the application. 

Seat 

A seat represents a user name and MAC address combination. 

Secret Key 

A secret key generally refers to the key in a secret key cryptography system, 

in which both sides use the same key. It may also refer to the private key in a 

public key cryptography system, because the private key must also be kept 

"secret." 

The AES feature uses a 128-bit long secret key to encrypt/decrypt data.

Secure Communication Tunnel 


An end-to-end secured session between the client and the Sentinel Key for 

providing secure private communication. The communication packets are 

encrypted using the AES algorithm, for which the session key is generated 

using ECC-based key exchange (ECKAS-DH1). 


The Secure Update utility is used for updating the Sentinel Keys and distributor 

keys remotely. It provides an alternative to the Secure Update Wizard. 


The hardware key meant to be used by your customer in order to run the 

protected application. It can be attached to a stand-alone or network system 

depending the key type. 

A Sentinel Key can be programmed by you (the developer) or your distributor 

with a license group. 


The Sentinel System Driver is the device driver for communicating with the 

hardware keys (Sentinel Key, developer key, and distributor keys). For Linux, 

a user-level daemon is provided. For Macintosh, a kernel extension module 

(KEXT ) is provided. 


The Sentinel Keys License Monitor shows the details of the Sentinel Keys 

and clients accessing them via a Web browser. It is a convenient way to view 

and track license activity and analyze application usage. 


Sentinel Protection Installer can install the Sentinel System Driver and Sentinel 

Keys Server on a system. These components are typically required by 

your customers for running the protected applications. 


S




Sentinel Keys Server is the network license manager of the Sentinel Keys. It 

maintains a database of the Sentinel Keys attached to a networked system 

and handles the availability, maintenance, sharing, and cancellation of 

licenses for its clients. 


The Secure Update Wizard provides a graphical option to your Windowsbased 

customers for activating features/applications in the field. It is suitable 

for activating trial/demo applications. 

Serial Number 


 

A 32-bit value sequentially assigned per key. It is pre-programmed and cannot 

be modified. 

Silent Mode 

The silent mode denoted by /S in Command-Line CodeCover protection, suppresses 

the display of information related to CodeCover features present in 

the license template file. For example, source file, destination path, protection 

layer level, etc. 

Software Key 

The scrambled public key used for creating the Secure Communication Tunnel. 

It is passed as a parameter in the SFNTGetLicense API function and is 

written into the header file. 

Software Lock 

A decision point in a protected application. The purpose of a software lock is 

to verify the presence of the correct Sentinel Key. For example, an application 

might verify the validity of the signed data or send query data to the 

Sentinel Key and require a specific response in order to continue execution.

T 

 


Other software locks may simply read the data and compare it to the value 

known. 

Stand-alone Applications 

A stand-alone application is licensed to run on a single computer without 

using a network. This type is used most often when an application is used by 

a single person on a particular computer. Typically, when you have purchased 

a stand-alone application, you will receive a key for each user that 

will be running the application. 

Stand-alone Keys 

Refers to the Sentinel Keys with zero (0) hard limit. It is typically connected 

to a user’s local workstation, providing access to the protected application 

only on a single system. 

Symmetric Key Encryption System 

The symmetric key encryption systems use a single, common key to encrypt 

and decrypt the message (known as the secret key). This is in contrast to the 

asymmetric key encryption systems, which use a private key and a public 

key to encrypt and decrypt messages, respectively. 

Toolkit 

The Sentinel Keys Toolkit is a Java application; which is available for the 

Windows platform. It is used for preparing the application protection strategy 

and programming hardware keys for your customers and distributors. 

See page 33 for more information on Toolkit GUI. 


T



U 

Unidirectional Broadcast Code Generation 


License Addition [.nlf]) without any request code from the end user, and 

broadcasts the code to all the end users possessing Sentinel Keys with the 

same DeveloperID. 

Unidirectional Single Target Code Generation 


License Addition [.nlf]) without any request code from the end user, and 

applies the code to a specified Sentinel Hardware Key with a particular 

Serial Number. 

Universal Binary 


 

A universal binary is an executable file that runs natively on both 

PowerPC and Intel-based Macintosh computers, which was first introduced 

at the 2005 WWDC to ease the transition from the existing PowerPC architecture 

to Intel in 2006 and 2007. Universal binaries are fat binaries that 

include both PowerPC and x86 versions of a compiled application, allowing 

the application to run on both architectures. 

Courtesy - en.wikipedia.org 

Update Code 

Refers to the code generated by the developer against the request code. It 

defines the actions that you want to apply on the hardware key. 

The update code is generated (a .upw file) under the Key Activator tab of

W 

 


W 


the Toolkit. See page 162 for more information on generating update codes. 

USB 

Short for Universal Serial Bus. A technology that features one “universal” 

plug type for all USB peripheral-to-PC connections. USB replaces all the different 

kinds of serial and parallel port connectors with one standardized 

plug and port. 

USB simplifies the connection of peripherals to computers by providing an 

instant, no-hassle way to connect USB peripherals. With USB-equipped PCs 

and peripherals are automatically configured and ready for use. 

Sentinel Keys are USB 2.0 compliant. 

User limit 

A soft limit that restricts the number of users allowed by the hard limit. Otherwise, 

the number of users allowed is equivalent to the hard limit. 

Write Password 

A hexadecimal value that allows writing a feature. It is applicable to all the 

features except AES, ECC, and Counter. 

You can provide a write password at the time of creating a feature, depending 

on the attributes you choose. For example, if you selected the Read-only 

attribute, the write password will be ignored. 

Working Folder 

A directory on your windows system where the Toolkit writes the protection 

strategy-related files. 

On a supported Windows system, the default working folder is: 

\My Documents\Sentinel Keys .



Note: On a Windows Vista system, the default working folder is: \Documents\Sentinel Keys . 

.DIS 

A Distributor file that contains information related to licenses and features 

to be programmed in the end user token using the Key Programming API 

library and is bound to a Distributor Key using the File Encryption Key. 

.ISV 

The *.ISV file contains basic information about the licenses and features, a 

protection strategy consists of and to be programmed in the end user token 

using the Key Programming API library. Only a Developer, along with a 

Developer Key, can generate this file and then program it onto the end user 

token. 

.NLF 

A New License Addition file that is created for a new license addition in the 

end user token using the Secure Update library. 

*.OPR 


 

The *.OPR file contains basic information about the licenses and features, a 

protection strategy consists of and to be programmed in the end user token 

using the Key Programming API library. Only a Developer, along with a 

Developer Key, and in the presence of an end user token, can generate this 

file. This file is programmed onto the end user token at the fulfillment center.

Appendix C 

Sentinel Keys Hardware 

Specifications 

This appendix contains details about the Sentinel Key hardware. 

Sentinel Key - S (Standard) Hardware Specifications 

EMC and Product Safety Compliance 

FCC Part 15, Subpart B, CLASS B 

CE EN55022: 1998, CLASS B 

EN55024: 1998, CLASS B 

VCCI CAN-CSA V3/2001.04 (VCCI) 

CISPR 22:1997, CLASS B 

UL 94V-0 Material Flammability 

Environmental Characteristics 

Operating Temperature 0 degree C to 70 degree C 

Storage Temperature -55 degree C to 70 degree C 

Humidity 5 - 95% RH (non-condensing) 

Shock /Vibration 20-50Hz:.19mm DISPL 

50-1000Hz: 0.5G ACCEL 


Appendix C – Sentinel Keys Hardware Specifications 


Sentinel Key - S (Standard) Hardware Specifications (Continued) 

Dimensions 

Width 0.630" 

Height 0.315" 

Depth 2.192" 

Weight 0.24 ounces/6.9g (For S, SN, I, D, and DUAL) 

0.25 ounces/7.1g (For SX and SN XM) 

Electrical Characteristics 

Operating Voltage 4.0V - 5.5V 

Static Current 20mA max 

Operating Current 25mA max 

Suspend Current 1mA typ. 1.5mA max 

LED Circuit Power Consumption 69mW typ. 

Data Retention More than 200 years 

Memory Cycle Life 1,000,000 erase/write cycles 

External Oscillator Frequencies 12MHz 

Internal Oscillator Frequencies 8 MHz 

CPU Core Frequencies 48MHz (VDD>4.1V) 

8MHz (VDD

Appendix D 

Migration from SuperPro 

and UltraPro 

This appendix describes the suggested migration path for Sentinel SuperPro 

and UltraPro developers to the much-advanced Sentinel Hardware Keys. It 

is divided into two sequential stages-offering easy upgrades for you and your 

customers. 

Stage 1 - Distribute Sentinel Dual Hardware Keys 

In Stage 1, you will be creating a customer-base for Sentinel Hardware Keys 

by distributing Sentinel Dual Hardware Keys instead of SuperPro or Ultra- 

Pro. These keys have support for your current protection scheme (SuperPro 

or UltraPro) and enable seamless migration to your future protection 

scheme (Sentinel Hardware Keys). 

All you need to do is: 

1. Order Sentinel Dual Hardware Keys (instead of Sentinel SuperPro or 

UltraPro Keys) through your Sentinel sales representative. You need 

to be aware of the following: 

Sentinel Dual Hardware Keys are available in USB form factor only 


Appendix D – Migration from SuperPro and UltraPro 


Sentinel Dual Hardware Keys are available for stand-alone and 

network versions. 


 

Sentinel Dual Hardware Keys have 256 cells of memory for use by 

your SuperPro or UltraPro implementation so you will receive a 

new model number with your kit. 

2. Program Sentinel Dual Hardware Keys with the same protection 

strategy you prepared for SuperPro or UltraPro Keys. 

SuperPro developers can straightaway program Sentinel Dual Hardware 

Keys with the protection strategy they prepared for SuperPro 

Keys. However, Sentinel UltraPro developers need to make a small 

modification (described below) before they program the design into 

Dual Keys. Note that in stage 1 you need not do any modifications in 

the application code or API implementation: 

In the Protection Manager screen, select the project form the 

drop-down list that has your design. 

Select the design in the Designs list and note down its design ID 

(shown in top-middle of the Protection Manager screen). 

Click the Duplicate button shown next to the Designs panel. The 

Duplicate Design dialog box appears. 

Modify the design name, as two designs with same name cannot 

co-exist in a project. 

Click OK. 

Select the duplicated design and right-click to open a short-cut 

menu. 

Select the option to view design properties. The Design 

Properties dialog box appears. 

Modify the design ID of the duplicated design same as the existing 

design. 

Click OK.

Stage 2 - Design New Protection Strategy 


Attach the Sentinel Dual Hardware Key to a USB port/hub on your 

system. 

Click the Build button to prototype the duplicated design. 

3. Distribute the latest Sentinel System Driver with your protected application 

to support Sentinel Dual Hardware Keys. You may allow the 

driver to be downloaded from your Website. A copy can be downloaded 

from SafeNet Website (http:// www.safenet-inc.com/support/ 

tech/sentinel.asp). 

Stage 2 - Design New Protection Strategy 

In stage 2, you will be implementing a new protection strategy using the 

Sentinel Keys Toolkit. This can ideally be done for the upcoming releases of 

your software. You need to: 

1. Order the Sentinel Hardware Keys development kit through your Sentinel 

sales representative. 

2. After installation, use the Sentinel Keys Toolkit to implement superior 

CodeCover and/or high-level Business Layer API protection-including 

AES-based encryption/decryption and ECC-based signing/verification. 

Note: You will NOT be able to import/re-use your legacy API or CodeCover Super- 

Pro or UltraPro code base (prepared using Sentinel SuperPro or UltraPro 

kits) in the Sentinel Keys Toolkit. Since the Sentinel Hardware Keys use the 

latest security technologies, you will need to implement your new, highly 

secure protection strategy from scratch. 

Existing (Stage 1) Customers Who Want to Upgrade - You can 

upgrade the existing customers to the latest version of your software 

remotely, without shipping new hardware keys. 1 The Sentinel Dual 

1. The upgrade licenses can be generated using a higher version of Sentinel Keys Toolkit (to 

be released later in this year). 


Appendix D – Migration from SuperPro and UltraPro 


Hardware Keys can function as Sentinel Hardware Keys to support 

your latest software release. You will need to ship them: 

New application installer and any associated redistributables 


 

Upgrade license code (.upw file): After this license code is applied 

(using Secure Update utility or any other custom action), the Dual 

key will support Sentinel Hardware Keys-dependent applications. 

These license codes can be applied universally to the Sentinel Dual 

Hardware Keys distributed in stage 1. 

New Customers Who Do Not Have Sentinel Dual Hardware 

Keys - You can program Sentinel Hardware Keys for customers who 

are buying your software for the first-time. You will need to ship 

them: 

New application installer and any associated redistributables 

Sentinel Hardware Key 

Note: The license code can be configured to continue/discontinue the support of 

SuperPro or UltraPro-dependent applications that were using the same 

key. Hence, the protection for the older versions can remain, if desired. The 

Sentinel Dual Hardware Key can simultaneously support both the Sentinel 

Keys-protected applications and SuperPro or UltraPro-protected applications.

Index 

Symbols 

.req 149 

.upw 149, 162 

.vxd 236 

.wps 206 

A 

access mode 65, 81, 257 

action 157, 257 

active, attribute 79 

add instances later 80, 

120 

AES 52, 257 

AES, feature 

about 52 

adding 114 

algorithm 

AES 257 

anti-debugging 56, 83 

anti-disassembling 57 

anti-dumping 57 

anti-reverse 

engineering 56 

API 257 

API Explorer 

about 34 

API protection 58–136 

API samples 134 

application protection 

API method 58 

CodeCover method 55 

planning 61–72 

ASCII 183, 258 

asymmetric key 258 

attributes, feature 264 

B 

Boolean, feature 

about 53 

adding 129 

building template 132 

Business Layer API 133 

C 

cheat counter 160, 170 

checklist, 

redistributables 223 

checksum code 180 

Code Morphing 56, 84, 

259 

code sketch 134, 259 

CodeCover SDK 

module 56, 84, 171 

CodeCover, feature 

about 55 

adding files 76 

customizing CodeCover 

error message 

title 86 

customizing 

messages 85 

file encryption 87 

files supported 100 

licensing settings 79 

networking settings 80 

Protect button 89 

security settings 83 

command 157, 260 

Command-Line CodeCover 

Utility 9, 35, 91 

options 94 

pre-requisites 91 

using 92 

configuration file 

client-side 44, 66, 

81–82, 227, 254 

server-side 44, 254 

conventions, manual xiv 

Counter, feature 

about 53 

adding 121 

Custom CodeCover Key 95 

customer 



Index 


who is? 260 

D 

data file encryption 84 

Data Protection Driver 235 

decrypting 261 

default instance 119, 198 

developer 21, 261 

who is? 261 

developer ID 261 

developer key 21, 45, 261 

password-protected 22, 

94, 217 

device date 160 

digital signature 177, 261 

disabled algorithms 182 

distributor 

distributor key 204, 262 


distributor key 45 

E 

ECC 52, 177, 261–262 

ECC, feature 

about 52 

adding 117 

encrypting 262 

execution count 262 

expiration date 263 

expiration time 263 

export considerations xviii 

exporting license group 

file 195 

F 

feature attributes 264 

feature ID 134, 264 

feature instance 264 

features 60, 264 

FEK 264 

firmware 264 

G 

group 53 

group layout 63 

group 

management 187–20 

1 

group, license 60, 265 

groups 187 

H 

hard limit 63, 265 

hardware keys 

ordering 45 

header file 265 

heartbeat 265 

Help 

System Administrator’s 

Help 239 

hexadecimal 183, 265 

hiding import symbols 84 

I 

in-line functions 178 

instance, feature 264 

Integer, feature 

about 52 

adding 127 

K 

key exchange 266 

Key Programming 

APIs 36, 208 

implementing 211 

steps for using 208 

Key Status panel 34 

key, secret 266, 270 

L 

lease, attribute 79 


 

license 266 

license addition code 150, 

267 

License Designer 

about 33 

license ID 267 


about 34 


wizard 209 

stand-alone 

application 39, 237 

license sharing 64, 81, 

267 

license template 53, 132, 

267 

limit executions, 

attribute 79 

M 

MAC address 268 

metering count, distributor 

key 

programming 205 

updating 161, 206 

migration 279 

missing Sentinel Keys 180 

models 

Sentinel Key 25 

multi-layering 55, 83, 244 

multi-threading 179 

N 

network applications 268 

network keys 24, 268 

O 

obfuscated code 56, 259 

One-Click License 

Update 154, 268

P 

personal folder 269 

piracy attacks 168 

private key 269 

programming 

distributor keys 204 

Sentinel Keys 203 

public key 269 

public key 

cryptography 269 

Q 

query-response 

protection 172, 

269–270 

Quick CodeCover 

about 33 

R 

Raw Data, feature 

about 52 

adding 124 

read-only, attribute 125, 

128 


regulations, export xviii 

remote updates, 

planning 137–164 

request code 149, 270 

S 

SafeNet Knowledge 

Base 243 

secret key 266, 270 

Secure Update Utility 153, 

156, 228 

Secure Update 

Wizard 156, 164, 230, 

272 

security for .NET 

applications 57, 85 

Sentinel Dual Hardware 

Keys 28, 279 

Sentinel Extended Memory 

Hardware Key 27, 218 


about 24, 271 

hardware specs 277, 

279 

models 25 

ordering 45 

programming 203 

protection 16 

redistributing 223 

Sentinel Keys Protection 

Installer 225 

Sentinel Keys SDK 

components 19 

Sentinel Keys Server 28, 

227 

Sentinel Protection 

Installer 43, 225–226 

serial number 272 

SFNTGetLicense 182 

sntlconfig 44, 66, 82 

sntlconfigsrvr 40, 44, 272 

problem 3, 168 

solution 4, 6 

SP_SERVER_MODE 65 

SP_STANDALONE_MODE 

65 

stand-alone 

applications 273 

stand-alone keys 24, 273 

String, feature 

about 52 

adding 122 

symmetric key 273 

Index 


T 

template, license 53, 60, 

132, 267 

terminal client 57, 68, 81 

time tampering 169, 243 

tips and tricks 167–183 

Toolkit 

about 33 

screens 33 

U 

update code 149, 162, 

274 

Update Manager 

about 34 

UpdateWizard API 231 

USB 274 

USB daemon 32 

user limit 63, 275 

V 

verifying data 177 

W 

working folder 275 

write password 275 

write-once 125, 128 

write-random 125, 129 


Index

Sentinel Hardware Keys Developer's Guide - Customer Connection ...

Create successful ePaper yourself

Delete template?

Save as template?