CodeMeter QSG En

perfection in Software protection

■ Installation

■ Use

■ Distribution

Quick Start Guide | codeMeter

Quick Start Guide codeMeter


2

Welcome to CodeMeter -

Installing CodeMeter

the ultimate copy protection and Digital Rights Management (DRM) system. This Quick Start Guide ex-plains the CodeMeter concept, and how to apply CodeMeter within a few minutes.

More detailed information about CodeMeter you find in the Code-Meter Developer Guide. This tutorial takes you step-by-step through the process of installing the system, pro-tecting your software, and preparing for distributing your application.

Installing CodeMeter To install CodeMeter, insert the CD into your CD-ROM drive. The Code-Meter CD menu will load automati-cally (otherwise run “CDStart.exe” from the root directory of the CD). Now choose your language and click the button “CodeMeter SDK”.

This installs the CodeMeter Deve-lopment Kit on your PC, including

sample applications and tools. Simply follow the instructions, and use the default settings of the setup wizard to complete the installation.

Please always use the latest software version, and check our website for available updates (www.wibu.com). The last step is to connect the CodeMeter Stick to any available USB port on the PC.

When you connect your CodeMeter Stick, it is automatically recognized and installed by Windows 2000, XP and Vista. After the installation, the CodeMeter Stick displays as a remo-vable drive.

Note: For additional operating systems like Linux, Mac OS, and Solaris there are also corresponding installation packages in the specified subdirectories of the CD.

CodeMeter SDK CD Installation

3

perfection in Software protection Quick Start GuidecodeMeter

Protecting a Windows application

CodeMeter software protection is based on encryption and decrypti-on. The CodeMeter Stick hardware provides this feature depending on entries you program into the Code-Meter Stick.

The CodeMeter Stick included in your Development Kit enables you to program entries using the evaluation Firm Code of 10.

The starting point for our short tu-torial is the CodeMeter Licensor Center. You quickly, easily and safely

protect your compiled application (*.exe, *.dll) by using the automatic encryption tool AxProtector. First, start the AxProtector tool using the respective button in the CodeMeter Licensor Center. Please refer to the CodeMeter Developer Guide for in-formation on how to run AxProtector functions from the command line.

Protecting a WindowsApplication

CodeMeter Licensor Center


4

AxProtector – Select the source file

After selecting the project type “Pro-ject for Windows 32-bit“, in AxPro-tector you specify the application you want to protect.

In our example, we will use the Win-dows editor (notepad.exe) located in the Windows root directory.

Type in the file name directly, or use the “…” button to select the appli-cation. But feel free to use also your own application for this first test.

The best way to save the destination file is to choose an alternative directory different to the source directory.

AxProtector automatically recom-mends the subdirectory “…\protected\”. Next, change the name of the de-stination file, in this example to “notepad_protected.exe”.

Now close the “File to protect“ di-alog and continue by pressing the “Next >” button.

In the next dialog you are asked to specify the protection hardware to be used.

5


AxProtector – Select the hardware

Note: For all other settings in this exercise, please use the default values.

AxProtector supports both product lines CodeMeter and WibuKey. Please check “CodeMeter“. In our tutorial, we use an evaluation Firm Code of 10, and a Product Code of 13.

The Firm Code 10 is assigned by default. Next, type 13 for the Pro-duct Code in the respective field. The CodeMeter Stick shipped with your Development Kit already holds the matching entries.

Now, step-by-step, follow through all subsequent dialogs, and use the sug-gested defaults. Detailed information on the individual options you find in the CodeMeter Developer Guide and

the AxProtector help file.


6

AxProtector – Current status of security

Note: You can anytime move back to previous selections. In the last dialog you are also able to manually start the encryption by pressing the button “Protect now!”.

In our short tutorial, we will pro-tect the Windows editor so that the protected application will only start, when a CodeMeter Stick with the matching entries is connected to the local computer. When selec-ting the “Runtime check” option in “Runtime settings”, your application checks every 30 seconds for a con-nected valid CodeMeter Stick.

In “Security options” you specify the protection methods, and whether, for example, the hardware is locked in case a hacker attack is detected. In “Error messages“ you define error handling. When selecting“User Mes-sage Dll“, automatically all required files are copied to the destination

directory. Using an *.ini file you are able to customize error message texts and the logo meeting your requests.

7


Note: There are many more features available, that are not mentioned in this Quick Start Guide. For detailed information about these features, please refer to the included manual.

AxProtector – Summary of all settings

In the “Advanced option“ dialog you check the “Activate IxProtector“ box to configure the use of the Software Protection API. In our test with an application not using this API, a con-figuration is not required.

The final dialog shows you a summary of all settings.

Please note that the supplied Code-Meter Stick must be connected to your computer while executing the encryption process, because it holds the license to use the Firm Code 10.

Start the encryption process by pres-sing the “Finish” button.

Now your application is protected. You can only start it with a con-nected CodeMeter Stick holding a matching entry.


8

The CodeMeter Concept

License Entry and Encryp-tionWhen you program a license entry into a CodeMeter Stick, it consists of a Firm Code and a Product Code. The Firm Code you receive by WIBU-SYSTEMS, the Product Code you are able to choose for yourself.

A CodeMeter Firm Security Box (FSB) guarantees that only you can pro-gram a CodeMeter Stick with your Firm Code. The CodeMeter Stick included in the SDK is, at the same time, a FSB for the Firm Code 10.

Every license entry represents a set of secret keys that can be used to protect your software. This means, your software can only be decrypted and executed, when the CodeMeter Stick holds the matching Firm Code and Product Code.

The CodeMeter Concept

Structure of the CodeMeter entries in the Test Kit

Note: There are many more features available, that are not mentioned in this short guide. For detailed information about these features, please refer to the included manual.

Each license entry may have ad-ditional different but combinable options:

■ Unit Counter: pay-per-use licen-ses, e.g. allows 5 times printing.

■ Expiration Time: time-limited licenses, internally checked in the CodeMeter Stick using an internal clock.

■ License Quantity: number of concurrent instances (see sta-tion share and terminal server detection in the manual), usually this represents the number of licenses in the network.

■ Feature Map: either/or licen-ses can be realized, e.g. 7 licenses of version 2 or 3, but never more than 7 in total.

9


CodeMeterControlCenter

CodeMeter Control Center: Status, configu-ration, event log and FAS in one

Organization of the License Entries

In each CodeMeter Stick you are able to programm more than 6,000 licen-se entries, also with different Firm Codes involved.

You can even program a CodeMeter Stick already in the possession of a user saving hardware costs.

For a clearer view, the license entries are managed in a container, the Firm Item (see Firm Item and Product Item in the manual).

CodeMeter Control Center

CodeMeter Control Center combines multiple features in one application. Control Center is the front end for the CodeMeter runtime (CodeMeter License Server) , and provides infor-mation about the status and the con-figuration of the CodeMeter Stick. Moreover, it serves for displaying the event logs, and realizing the CodeMeter Field Activaton Service (CmFAS). CmFAS represents the CodeMeter feature to program, modify or delete the complete con-tent and options of a license by file


10

CodeMeter WebAdmin

CodeMeter WebAdmin – License entries

transfer. CodeMeter Control Center starts automatically at Windows start, and is available in the system tray. The status of the CodeMeter runtime and the CodeMeter Stick is visible by color and shape of the system tray icon.

For configuring additional CodeMe-ter settings the CodeMeter WebAd-min can be started using the context menu of the system tray icon, or by clicking the “WebAdmin“ button in the CodeMeter Control Center window.

CodeMeter WebAdmin

The CodeMeter WebAdmin is used both, for the information display about the attached Code-Meter Stick(s), e.g. about existing license entries, and the configu-ration of the CodeMeter License Server. Next to status informa-tion, all CodeMeter License Ser-ver parameters are configurable. To get an overview of the licen-se entries (Firm Items), select the “Content” menu tab, and then “Licences”. For more information

11


CodeMeter WebAdmin – License for the sample application CmCalculator

Programming of License Entries

about the included licenses, click on the Firm Code you want to view.

Now in Firm Item 10 click on Product Code 13, and the detailed entries of your CodeMeter Stick related to this Product Code will display.

There are many more CodeMeter WebAdmin features to discover. De-tailed information about the individu-al options you find in the CodeMeter Developer Guide and the CodeMeter WebAdmin help file.

Programming of License Entries

Now, we will have a brief look at the options for programming license entries:

CmBoxPgmCmBoxPgm is a command line tool that can be used for programing, e.g. using a batch file.


12

Note: To program a license entry into a CodeMeter Stick a special CodeMeter Stick, the Firm Security Box (FSB), is needed. The CodeMeter Stick included in your Developer Kit is “both-in-one“, an FSB for the evaluation Firm Code 10, and an end-user CodeMeter Stick.

License EditorThe graphical user interface clearly displays Firm and Product Items of a CodeMeter Stick, and provides easy editing options.

License CentralThe databased solution allows creating, managing and delivering licenses by integration into sales and business processes. A Desktop version provides an easy start for in-house license management. An Enterprise version includes the licen-se activation via Internet providing the following interfaces: Internet Gateway to the customer, connectors to ERP/CRM systems, and connectors to online shops.

Programming APIAn extension of the CodeMeter pro-gramming interface, which provides to program the license management from within own applications. This API is available for various program-ming languages.

CodeMeter License Editor

13


The Alternative - Implementation within Software Projects

The automatic protection with Ax-Protector as described above pre-sents only one option to integrate CodeMeter as license management system. Alternatively, or best of all you should use the CodeMeter ap-plication programming interfaces for programmers.

Interfaces for ProgrammersThe ideal supplement to automatic encryption is provided with WIBU Universal Protection Interface (WUPI). The Software Protection API allows you to implement license operations, when your program pro-cedures require it. For example, you are able to assign additional licenses for modules, or query further details, such as the status of a Unit Counter. In case WUPI options do not cover all of your requirements, you can simply fall back to the Core API (C-API), and, for example, individually encrypt contents.

The connection to the CodeMeter APIs is cross-platform designed and standardized, and available for many programming languages:

■ C, C++ ■ all Microsoft .NET pro-gramming languages

■ Microsoft VisualBasic ■ Borland Delphi ■ Java

The range of programming langu-ages supported constantly expands, please contact our support team.

Benefits and Application Scenarios The explicit implementation of the software protection or the Core API offers a variety of options:

■ Realize modular protection by assigning a particular Product Code or a flag in the Feature Map to each of your software modules or subroutines.

■ Use an additional Unit Counter, for your software modules you then count down at runtime using different values. Realize a fine-grained pricing model for your software functions.

■ Provide demo versions to prospective customers running with limited functions. Or activate additional modules for existing customers as time-limited demo versions.

Implementation within Software Projects


14

CodeMeter API Guide – API functions in detail

■ In time-critical realtime applications simply implement CodeMeter in parts of the soft-ware that are not time-critical.

When explicitely implementing the APIs, it is you who determines effi-ciency and effectiveness of the licen-se management.

Learning-by-Doing – The API GuideThe CodeMeter application program-ming interfaces provide various op-tions. Learn how to use the API with the CodeMeter API Guide.

The CodeMeter API Guide allows you to test single functions of the

Software Protection API and the Core API. All parameters can be specified. Moreover, complete function blocks representing standard implementati-on of the most commonly used func-tions can be executed and copied into your own software project.

The preset function calls and blocks can be displayed and executed using the syntax of established program-ming languages, allowing you to take the first steps in the program-ming language you are most familiar with.

15


A good place to start – The CodeMeter Sample Applications

Your CodeMeter Development Kit was installed with various sample applications with a different scope:

WupiCalculator WupiCalculator demonstrates the use of the Software Protection API. The example shows modular protec-tion and pay-per-use using a Feature Map and Unit Counters for different computation functions of a simple calculator.

CmCalculatorIn CmCalculator the functionalities of WupiCalculator are shown using the Core API.

CmDemoCmDemo is a complex sample application separated in different functional groups demonstrating the implementation of most of the

Core API functions. A prepared sec-tion allows the implementation and testing of own function calls, without having to set up a new project from scratch.

You find many answers in the manual included. In case of more questions, we or your distributor are gladly at your hand. A list of contact persons is available at www.wibu.com

Note: On inquiry, our support team can develop a small sample application that demonstrates a customized license management with CodeMeter meeting your needs. Give us a challenge!

The CodeMeter Sample Applications

InternationalWIBU-SYSTEMS AGRueppurrer Straße 52-54D-76137 KarlsruheGermanyTel.: +49-721-93172-0Fax: [email protected]

USATel.: +1.800.6.GO.WIBU [email protected]

ChinaTel.: [email protected]

Quick Start Guide codeMeter

State-of-the-Art Digital Rights Management

With CodeMeter, you can protect an unlimited number of single user licenses, network licenses, and time- limited renting and leasing versions. Also pay-per-use models can be realized.

CodeMeter is characterized by transparent protection using strong encryption.

■ State-of-the-art Encryption with 128-bit AES/224-bit ECC.

■ Built-in network support with various license models.

Wibu-Systems is DIN EN ISO 9001:2008 certified and member of

BITKOM e.V., VDMA PCMCIA, SD Card Association, USB

Implementers Forum, SIIA and others, and

Microsoft Gold Certified and Embedded Partner.

© 2010 WIBU, SmartShelter und CodeMeter are registered trademarks of WIBU-SYSTEMS AG. All designated company names, labels or service names can be trademarks or service names of the respective owners. 50

40-0

08-0

2/10

1122

© W

IBU

-SYS

TEM

S AG

201

0

Awards:

When companies like SONY, Kodak, Motorola and Siemens think of software security and DRM (Digital Rights Management) for docu-ments and media, they think of Wibu-Sys-tems. These companies demand reliable and distinctive security solutions and recognize that a company, focused on DRM technolo-gies since 1989, a company that consistently wins industry awards, and a company that is looking to the next threat instead of patching for the last one; is a company to do business with.

Wibu-Systems wants to provide “Perfection in Protection” for all our DRM products; el-evate the level of customer service and in-crease the level of respect we show our own suppliers. And finally, help prepare the next generation of business leaders by investing in education and directly supporting youth activities.

■ Unique serial number. ■ Windows 2000 / XP / 2003 /Vista / 2008 / 7 / CE / Em-bedded, Linux, Mac OS X, Sun Solaris (SPARC + Intel), Cross-Plattform API.

■ Protect multiple appli-cations or modules with one CodeMeter Stick.

■ Multiple licensors can share the CodeMeter Stick entries.

■ Internal real-time clock to secure Activation and Expiration Dates.

■ Infrastructure for automatic online trade.

■ Wibu-Systems is certified according to ISO 9001:2008.

Documents

CodeMeter QSG En