Sentinel Hardware Keys SDK

Version 1.2.0 for Windows – Release

Notes
This document contains an overview of the product, new features, and installation of the Senti-
nelTM Keys SDK release version 1.2 for Windows.

Product Overview
Sentinel Hardware Keys (also referred as “Sentinel Keys”) provide secure and advanced, token-
based licensing to your software applications. These also provide better market penetration
through easy-to-implement licensing models, such as demos, lease, and network (also known as
concurrent or floating) licenses.

What’s New in This Release?

This release supports the following new features:

Introducing Key Programming APIs

Key Programming APIs are a set of API functions used for:
■ Programming the Sentinel Hardware Keys
Provides a Toolkit independent programming environment wherein the license group
files are exported and programmed into the memory of the Sentinel Keys.
■ Creating Update Packets The update packets are generated to:
❑ Enable creation of data buffers1 (also termed as update packets) that overwrites new
values to the existing features in the Sentinel Hardware Keys in field, or
❑ Overwite 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.

1.Set of encrypted data.

Sentinel Hardware Keys SDK Version 1.2.0 for Windows – Release Notes 1
What’s New in This Release?

Command-Line Shell Support

The Command-Line Shell Utility is a console-based program that protects executables and DLLs
using the Shell method via command-line. It is meant for the developers who want to:
■ Incorporate the process of protecting files (applying the Shell layer) into their application
build process.
■ Protect files without using the Toolkit.
■ Override/Customize the source / destination file path, provided during license designing,
in Toolkit.

Secure Update Enhancement

Secure remote updates provide a method to update licenses in the Sentinel Hardware Key(s)
already deployed with the customers and distributors. The Secure remote update functionality
has been enhanced in this release to include the following:
■ 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:
❑ Unidirectional Single Target: An update code is generated without any request
code from the end user, and is applied to a specified Sentinel Hardware Key with a
particular Serial Number.
❑ Unidirectional Broadcast: An update code is generated without any request code
from the end user, and is then broadcasted to all the end users possessing Sentinel Keys
with the same DeveloperID.
■ Remote New License Additions: Remote license addition method allows you to add
new license(s) in the end user token present in the field. New license addition through
secure update library requires the creation of license addition (*.nlf) file, generated using
the Export Manager wizard of Sentinel Keys Toolkit. The Sentinel Keys can be updated
for new licenses in one of the following ways:
❑ Unidirectional New License Addition: Updates the hardware Keys for which no
request code was generated. It is a one-to-one way update, that targets single or
multiple Sentinel Hardware Key(s) present in the field.
❑ Bidirectional New License Addition: Updates the hardware Keys for which a
request code was generated. It is a two-way update that targets a single Sentinel
Hardware Key present in the field.

Shell Enhancements
The following shell enhancements have been implemented in this release:
■ Enhancement to .NET application security: The .NET Enhancements feature
provides enhanced security to pure .NET applications (exes and dlls).
■ Support for Windows 64-bit applications: The shell engine now protects 32-bit as
well as 64-bit applications.
■ Supports data files extension up to 10 bytes: Data file names can be 8 bytes long
along with an extension that could be 10 bytes long.

2 Sentinel Hardware Keys SDK Version 1.2.0 for Windows – Release Notes
 What’s New in This Release?

■ Customize Error message title: The error message titles can now be customized using
the customize error message title option.
■ Encryption/decryption of Data Files: The SHK Shell (both 32-bit and 64-bit) provides
functionality for encryption and decryption of the files along with the protected
application.

Toolkit Enhancement
Toolkit has been modified to generate the Code sketch for Java language under the Build
options tab in License Designer.

Additional Support for the following Compiler Interfaces

For implementing the API-based protection, the following language/compiler interfaces have
been added:

Compiler/Environment Version Type

Static (MT) Static (MD) Dynamic

Fortran Intel Visual 9.0 9
Foxpro Microsoft Visual 9.0 9
Windev Pc Soft 11.0 9

Sentinel Hardware Keys SDK Version 1.2.0 for Windows – Release Notes 3
What’s New in This Release?

Enhancements and Problems Corrected in This Release

Command-Line Shell Support

The new command-line shell utility allows developers to protect files without using the Toolkit.
Using this utility, the developers incorporate the process of protecting files into their application
build process.

Key Programming API Support

The Key Programming API functions offer the benefits of:
■ Toolkit Independent Key Programming, and
■ Generation of Update Codes
The Key Programming API functions work as an application to program files and generate an
update code without using the Sentinel Keys Toolkit. For more information, refer to the Key Pro-
gramming API Help.

SHK Shell Enhancements

The SHK 1.2 Shell has been enhanced as per the details provided in the section, “Shell Enhance-
ments” on page 2.

License Group Size Increased to Fit into Various Memory Keys Size
The maximum size of the group that can be programmed now 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.

New Error Code for SFNTGetLicense API function

A new error code SP_ERR_CANNOT_OPEN_DRIVER has been added for SFNTGetLicense
API function, to display an error message when either the Sentinel System Driver is not installed
properly, or not loaded.

Interpretable interface for Java (Windows) added

Java interface introduced for Windows. This interface is completely compatible with the Linux
and Macintosh Java Interface versions.

Application Built in Borland C++ Could Not be Protected by Shell.

Earlier, the application built in Borland C++ could not be protected by Shell. This has now been
fixed for this release.

Known Issue

The Installation Guide fails to open when launched from the Help menu on
SetupSys Driver
The Help on setupsysdriver.exe is not visible on Vista platforms. This is because of discontinua-
tion of WinHlp32.exe by Microsoft on Vista platforms. Please refer to Microsoft’s knowledge base
article 917607 for more details and download Winhlp32.exe to view the help.

4 Sentinel Hardware Keys SDK Version 1.2.0 for Windows – Release Notes
 Installation

Unpacking the Sentinel Keys SDK

The Sentinel Keys SDK contains the following items:
■ The Sentinel Keys SDK (the product diskette)
■ The Developer Key (meant for you—the developer—who will prepare the protection
strategy)
■ The Distributor Key (meant for your distributor)2
■ The Sentinel Key (meant for your customers, who will use the protected application).

Installation
This section contains information regarding the Sentinel Keys version 1.2 installation.
A common (32-bit) installer is provided for both 32-bit and 64-bit Windows operating systems.
It will install exactly same set of files on both the operating systems. The files or directories with
(x64) suffix contain 64-bit specific files and are installed on 32-bit Windows as well, so that you
can build x64 applications on your 32-bit Windows system.
The Sentinel System Driver is supported on Windows 98, ME, 2000, XP, Server 2003, and Win-
dows Vista. A 64-bit version is included for the x64 editions of Windows XP, Server 2003 and
Windows Vista. The Sentinel System Driver is installed at the following locations:
■ For 32-bit applications: <OS drive:>\Program Files \Common Files\SafeNet Sentinel\Sentinel
System Driver.
■ For 64-bit applications: <OS drive:>\Program Files (x86)\Common Files\SafeNet
Sentinel\Sentinel System Driver.
Please note that the Sentinel Keys Server is a 32-bit Windows services that can support clients
running protected applications in Windows 32 bit and 64-bit, Linux, and Macintosh
environments.

2. A single hardware key is included with this package, so that you can evaluate them. To obtain more units for your
distributors and customers, contact your Sentinel Keys sales representative.

Sentinel Hardware Keys SDK Version 1.2.0 for Windows – Release Notes 5
Installation

System Requirements
Please note the following hardware and software system requirements for installing
Sentinel Hardware Keys SDK:

Hardware Requirements Software Requirements

❑ Processor ❑ Operating System

64-bit processors: Athlon 64 or Opteron
processors from AMD - Xeon with EM64T or
Pentium IV or above
32-bit processors: Pentium II or above (450
MHz or above).
❑ Monitor and its Settings
VGA Monitor with 1024 x 768 resolution
(1152 x 864 recommended)
❑ Hard Disk Space
430 MB free hard disk space
❑ RAM
128 MB RAM (256 MB recommended)
❑ Peripherals
At least two USB ports/hub to attach the
developer, distributor, and/or Sentinel Keys
❑ Disk Drive
CD-ROM drive
- Windows 98/ME (client side only)
- Windows 2000/XP/2003 (32-bit)
- Windows Vista (32-bit)
- Windows XP (64-bit), Server 2003 (64-bit)
- Windows Vista (64-bit) on Intel EMT 64-bit
processor, AMD 64-bit processor
❑ Java Runtime Environment
Java 2 Runtime Environment (J2RE) version
1.6 or higher. The Sentinel Keys installation
CD contains a copy of the 32-bit J2RE. You
may download the latest version from
http://java.sun.com.
❑ Web Browser
32-bit versions of the Internet Explorer (5.0 or
higher) and Netscape Navigator (4.0 or
higher). 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 4.0 or higher

Important Notes:
Please note the following:
■ The Sentinel Keys SDK version 1.2 will upgrade the 1.0.0, 1.0.1. 1.0.2, and 1.0.3
version, if already existing on the system.
■ The Sentinel Keys SDK can co-exist with the Sentinel SuperPro and UltraPro SDKs.
However, it will upgrade the Sentinel System Driver, if a version lower than 7.4.0 exists
already on the system.
■ This setup will install few components on Windows 98 and ME, including the Sentinel
System Driver, compiler interfaces, Secure Update module and documentation. The
Toolkit, License Manager (stand-alone), and Sentinel Keys Server will not be installed on
these operating systems.
■ This installation requires Windows Installer version 2.0 or higher on the target system. If
a lower version is found, the installer will inform the user and upgrade automatically. If
you are not sure you want to update the Windows Installer, do not run this program.

6 Sentinel Hardware Keys SDK Version 1.2.0 for Windows – Release Notes
 Installation

Installation Instructions

Note: You must have Administrator privileges to install this software.

1. Insert the installation CD in the CD drive.

2. You may need to navigate into the CD if the autorun does not work. Double-click
StartHere.exe. The StartHere screen appears.

3. Click the Install button to launch the setup program.

4. If Java 2 Runtime Environment version 1.6 or higher is already installed, the Sentinel
Keys installation wizard will be shown. Else, J2RE installation will take place first. After-
ward, the Sentinel Keys installation will resume.

The StartHere Interface

5. You may now choose the setup type as Complete or Custom. Follow the on-screen
instructions to complete the Sentinel Keys SDK installation.

Sentinel Hardware Keys SDK Version 1.2.0 for Windows – Release Notes 7
Installation

Installed Components
The table below assumes you have installed Sentinel Keys SDK using the Complete setup type
in the root directory of your system.
On a Windows 32-bit system, the default installation path is: <OS drive:>\Program Files\SafeNet
Sentinel\Sentinel Keys\1.2
On a Windows x64 system, the default installation path is: <OS drive:>\Program Files
(x86)\SafeNet Sentinel\Sentinel Keys\1.2
Installation Directory Structure

File/Folder Name Description

\Compiler Interfaces Contains client library interfaces for popular compilers.

Please note that the interfaces supported for Windows x64

contain the libraries in the respective \Libraries(x64) folders.
\Configuration File Template Contains the configuration file for your customers.
\Key Programming Header files, libraries, and samples of the Key Programming API
Module.
\Manuals Contains the various documentation items for this release.

Please note that the documentation provided in this directory

\Sentinel Keys License Manager
\Sentinel Keys License Monitor
\Sentinel Protection Installer
\Sentinel Keys Toolkit
\Secure Update
may not be accessible from the Toolkit or any other utility.
Hence, we suggest you to access them directly from this
location.
Contains the stand-alone License Manager application and
related files.
Contains files for the Sentinel Keys License Monitor
customization.
Contains a ready-to-ship installer for deploying Sentinel System
Driver with its utilities, Sentinel Keys Server, and Sentinel
Protection Server. This directory also contains the merge
modules and .msi file for both components that you can use for
customizing their installation.
Contains the Toolkit application and related files.
It also contains the Shell SDK kit that is used for adding
protection against reverse-engineering for your Shell-protected
applications.
Contains the Secure Update utility, Sentinel Update Wizard, and
Secure Update API functions.

8 Sentinel Hardware Keys SDK Version 1.2.0 for Windows – Release Notes