product licensing - user's guide · 2015. 10. 30. · sentinel dongle driver setup (hasp4,...

Product LicensingUser's Guide

2015-03-27

Product Licensing

of 30

Elektrobit Automotive GmbHAm Wolfsmantel 4691058 Erlangen, Germany Phone: +49 9131 7701 0Fax: +49 9131 7701 6333Email: [email protected]

Technical support

Legal notice

Confidential and proprietary information

ALL RIGHTS RESERVED. No part of this publication may be copied in any form, by photocopy, microfilm,retrieval system, or by any other means now known or hereafter invented without the prior written permissionof Elektrobit Automotive GmbH.

ProOSEK®, tresos®, and street director® are registered trademarks of Elektrobit Automotive GmbH.

All brand names, trademarks and registered trademarks are property of their rightful owners and are used onlyfor description.Copyright 2014, Elektrobit Automotive GmbH.

mailto:[email protected]

Product Licensing

of 30

Table of Contents1. Welcome to the Licensing Administration documentation .................................................................... 4

1.1. Licensing Deliverables ........................................................................................................... 41.2. License Activation .................................................................................................................. 51.3. Dongled License .................................................................................................................... 5

2. EB Licensing Customer Portal .......................................................................................................... 62.1. Login to the Self-Service portal .............................................................................................. 62.2. Account Administration ........................................................................................................... 72.3. Your Profile ........................................................................................................................... 82.4. Search Licenses .................................................................................................................... 9

3. Licensing Project on EB Command ................................................................................................. 103.1. FNOC Licensing Project ....................................................................................................... 10

4. Single User or Evaluation Licenses ................................................................................................. 114.1. Installing the Client License Administration Utility ................................................................... 11

4.1.1. License Server Configuration ..................................................................................... 124.2. Online activation of a single-user or evaluation license ........................................................... 134.3. Offline activation of a single-user or evaluation license ........................................................... 14

5. Floating Licenses ........................................................................................................................... 165.1. Installing the Server License Administration Utility .................................................................. 165.2. License Server Components ................................................................................................. 165.3. Online activation of a floating license .................................................................................... 175.4. Offline activation of a floating license .................................................................................... 18

6. Dongle License Setup ..................................................................................................................... 206.1. Installing the Dongle Driver .................................................................................................. 206.2. License File Self Service ...................................................................................................... 20

6.2.1. License generation - Order History ............................................................................. 206.2.2. License generation - select articles ............................................................................ 216.2.3. WibuKey System Applet ............................................................................................ 226.2.4. License generation for multiple articles ....................................................................... 236.2.5. Downloading license files from the View Licenses page ............................................... 246.2.6. Downloading license files via the License Overview page ............................................ 256.2.7. Installing the license in EB tresos Studio .................................................................... 25

6.3. Manually setting up the environment ..................................................................................... 267. Partner Licenses ............................................................................................................................ 27

7.1. Usage of partner licenses .................................................................................................... 277.2. Workflow description ............................................................................................................ 287.3. Developing modules ............................................................................................................. 297.4. Using the signature tool ....................................................................................................... 297.5. Checking the signature ........................................................................................................ 307.6. Software distribution ............................................................................................................. 30

Product LicensingChapter 1. Welcome to the Licensing Administration documentation

of 30

1. Welcome to the LicensingAdministration documentationThis document describes the steps which are required to activate a license using a FlexNet Operations OnCloud activation code as well as the configuration steps required to use a file-based license in combinationwith a dongle.

1.1. Licensing DeliverablesDepending on the article you have ordered you will receive one of the following licensing bundles:

► Dongled License

► Login Credential to the EB Licensing Self-Service portal

► License-File

► Dongle

► Dongle Serial Number (HostID)

► Dongle Device Driver

► Floating License


► Floating License Activation Code

► Server License Administration Utility

► Single User or Evaluation License


► Single-User License Activation Code

► Client License Administration Utility

Product LicensingChapter 1. Welcome to the Licensing Administration documentation

of 30

1.2. License ActivationThis section provides information about license activation.

► The EB License Administration Utility communicates with the FlexNet Operations On Cloud server andtransfers a license from the FlexNet Operations On Cloud license server to the customers server or clientmachine.

► Activation-based licenses are managed by the FlexNet Operations On Cloud service.

► The license is stored in a secured file on the customers machine. This so called 'Trusted Storage' isprotected against several manipulation attempts (e.g. rollback of the machines clock, backup and restoreon different machines, usage in virtual environments).

Two different license activation utilities are provided:

► EB Server License Administrator

► for Floating Licenses

► EB Client License Administrator

► for Single-User Licenses

► for Evaluation Licenses

Choose the appropriate licensing utility depending on your license model. Please refer to the Single-User andEvaluation Licenses or the Floating Licenses section fore more details according activation based licenses.

1.3. Dongled LicenseThis section provides information about using license files.

► License files are used in combination with a dongle.

► The license file is copied to the client machine and is accessed locally by the license protected application.

Please refer to the Dongle License Setup for more details according dongle licenses.

Product LicensingChapter 2. EB Licensing Customer Portal

of 30

2. EB Licensing Customer Portal

2.1. Login to the Self-Service portalLicenses of EB products are managed by an online software delivery service that helps you manage and staycurrent with your Elektrobit Automotive (EB) licenses.

The EB licensing service provides you with the following features:

► Email notification and online access to your licenses

► Administration features which allow you to customize and self-administer your licensing account

Your login credentials are provided within the EB licensing welcome Email.

► Please use your Email address as Login ID on the EB Licensing customer portal:

► https://elektrobit.flexnetoperations.com

► If you have forgotten your password, please use the password finder to request a new password:

► https://elektrobit.flexnetoperations.com/control/elkb/password

Figure 2.1. Customer Portal Login

https://elektrobit.flexnetoperations.com

https://elektrobit.flexnetoperations.com/control/elkb/password


of 30

2.2. Account AdministrationYour customer account is provided by EB. At least one account administration member is set up in your accountper default. Additional account members can be added by EB or any other account member having accountadministrative privileges.

Figure 2.2. Account Member Administration


of 30

2.3. Your Profile

You can update your account profile on the profile configuration page:

► Configure your account member address

► Configure your permissions

Figure 2.3. Your Profile


of 30

2.4. Search LicensesOn the Search License page you can perform the following actions:

1. You can search for your licenses using different search criteria.

2. You can download ALL your company licenses in a ZIP archive.

NOTE You can download a subset of licenses using the download button at the bottom of the page.

When using the download button at the bottom of the page, only the SHOWN licensesaccording your search criterion are included in the ZIP archive.

Example: If your search criterion has provided 50 results but on the result screen you haveconfigured to show only 25 results on a page, only these 25 results are considered in theZIP archive.

Figure 2.4. Your Profile

Product LicensingChapter 3. Licensing Project on EB Command

of 30

3. Licensing Project on EB Command

3.1. FNOC Licensing ProjectSeveral components are available on the EB Command customer portal:

► https://command.elektrobit.com

The following components are available:

► EB Client License Administrator Setup

► EB Server License Administrator Setup

► FlexNet License Administration Guide (fnp_LicAdmin.pdf)

► FlexNet License Server Setup (lmadmin)

► Sentinel Dongle Driver Setup (HASP4, FLEXID-9)

► WibuKey Dongle Driver Setup (FLEXID-10)

Figure 3.1. EB Command LICENSING Project

https://command.elektrobit.com

Product LicensingChapter 4. Single User or Evaluation Licenses

of 30

4. Single User or Evaluation LicensesSingle User or Evaluation licenses are provided via FlexNet Operations Cloud activation codes. Use the ClientLicense Administration utility to activate your license.

4.1. Installing the Client License AdministrationUtilityPlease download the EB_Client_License_Administrator_Setup.exe utility from EB Command:


Follow the setup wizard to install the Client License Administration Utility

► Run the EB_Client_License_Administrator_Setup.exe

► Select destination folder

► Optionally create start menu entry

► Optionally create desktop shortcut

► Choose option to use license activation codes (default)

► Choose license server for floating licenses (optional)

► Choose license folder (recommended if you are using multiple license files)

► Choose license file (not recommended since only one file can be selected)

► The installation of the EB Client License Administrator utility is completed.



of 30

4.1.1. License Server Configuration

If you have chosen the option to receive floating licenses from a FlexNet license server please configure thelicense server and port number.

Figure 4.1. Using a License Server

NOTE Please contact your license server administrator according the server name and port num-ber used by your company specific FNP license server.

Please consider the FlexNet Publisher License Administration Guide (fnp_LicAdmin.pdf) toget more information about setting up a FlexNet license server.

Figure 4.2. License Server Configuration


of 30

4.2. Online activation of a single-user or evalua-tion license

To activate a client license, please proceed with the following steps:

► Run the EB Client License Administration utility from the Windows start menu.

► (1) Enter an activation code.

► (2) Click on the 'Activate' button.

► (3) Check the status of the license activation sequence.

► Your license is ready to use.

Figure 4.3. Online Client License Activation


of 30

4.3. Offline activation of a single-user or evalua-tion license

If your client machine is not connected to the internet, please follow the offline license activationprocess:

► Run the EB Client License Administration utility from the Windows start menu.


► (2) Click on the 'Create Activation Request' button.

► Save the activation request file and move it to a machine having internet access.

► On the machine with internet connection, please login to the EB Licensing Customer portal.

► (3) Navigate to the 'Offline License Handling' section.

► (4) Choose your previously created activation request file.

► (5) Process the activation request file and save the response file.

► Move the activation response file to your client machine where you have created the activation request.

► (6) On your client machine, select and process the activation response file.

► (7) Verify the license activation in the status section.

► Your license is ready to use.


of 30

The following picture shows the EB Client License Administration utility:

Figure 4.4. Offline Client License Activation

Please process your offline license activation request using the Offline Licensing Handling in the EB Licensingcustomer portal:

Figure 4.5. Processing the activation request file

Product LicensingChapter 5. Floating Licenses

of 30

5. Floating Licenses

5.1. Installing the Server License AdministrationUtilityPlease download the EB_Server_License_Administrator_Setup.exe utility from EB Command:


Follow the setup wizard to install the Server License Administration Utility:

► Run the EB_Server_License_Administrator_Setup.exe

► Select destination folder

► Optionally create start menu entry

► Optionally create desktop shortcut

► The installation of the EB Server License Administrator utility is completed.

5.2. License Server Components

The setup wizard provides some components required to setup a license server. Beyond severaluseful FlexNet Publisher components, the following components are mandatory to configure aFlexNet license server:

► <installfolder>/x86/EB.exe: Elektrobit vendor daemon

► <installfolder>/x86/EB_libFNP.dll: Elektrobit vendor daemon trusted storage access

► Please also refer to the FlexNet Publisher License Administration Guide for more information about con-figuring a license server.



of 30

5.3. Online activation of a floating license

To activate a floating license, please proceed with the following steps:

► Run the EB Server License Administration utility from the Windows start menu.


► (2) Enter the number of licenses you want to activate. You can activate all ordered licenses on one machineor you can split your licenses to several license servers.

► (3) Click on the 'Activate' button.

► (4) Check the status of the activation sequence.

► Restart your license server or re-read the licenses using the license server front end.

► Your licenses are ready to serve by your license server.

Figure 5.1. Online Floating License Activation


of 30

5.4. Offline activation of a floating license

If your server machine is not connected to the internet, please follow the offline license activationprocess:

► Run the EB Server License Administration utility from the Windows start menu.


► (2) Enter the number of licenses you want to activate. You can activate all ordered licenses on one machineor you can split your licenses to several license servers.

► (3) Click on the 'Create Activation Request' button.

► Save the activation request file and move it to a machine having internet access.

► On the machine with internet connection, please login to the EB Licensing Customer portal.

► (4) Navigate to the 'Offline License Handling' section.

► (5) Choose your previously created activation request file.

► (6) Process the activation request file and save the response file.

► Move the activation response file to your client machine where you have created the activation request.

► (7) On your client machine, select and process the activation response file.

► (8) Verify the license activation in the status section.

► Restart your license server or re-read the licenses using the license server front end.

► Your licenses are ready to serve by your license server.


of 30

The following picture shows the EB Server License Administration utility:

Figure 5.2. Offline Server License Activation

Please process your offline license activation request using the Offline Licensing Handling in the EB Licensingcustomer portal:

Figure 5.3. Processing the activation request file

Product LicensingChapter 6. Dongle License Setup

of 30

6. Dongle License Setup

6.1. Installing the Dongle DriverPlease download and install the latest WibuKey Runtime (WkRuntime.exe) dongle driver from:

► EB Command: https://command.elektrobit.com

► or get the latest version from WIBU-SYSTEMS AG: http://www.wibu.com

6.2. License File Self Service

6.2.1. License generation - Order History

License files can be generated by the customer within the EB Licensing customer portal.

Please proceed with the following steps if you have ordered a dongle-license:

Login to the EB Licensing customer portal: https://elektrobit.flexnetoperations.com

1. Navigate to the Order History.

2. Select 'Licenses' on the right hand side of the view.

Figure 6.1. Order History and Licenses


http://www.wibu.com

https://elektrobit.flexnetoperations.com


of 30

6.2.2. License generation - select articles

In the selected order please proceed with the following steps:

1. Select all articles to generate multiple license files.

2. Alternatively, select a subset of articles where you want to generate license files.

3. Click on the 'Generate' button on the bottom of the page.

Figure 6.2. Select Articles


of 30

6.2.3. WibuKey System Applet

You need your dongle serial number to proceed with the license generation.

Open your WibuKey dongle diagnostics tool from the Windows Control Panel.

1. Retrieve your dongle serial number - Example: 12-12114690

2. Retrieve your customer ID - Example: 180054

NOTE You can create licenses for multiple dongles at once. Please write down the Dongle IDsand the customer ID for each dongle and provide them in the following license generationprocess on each line.

Figure 6.3. WibuKey Dongle Diagnostics Tool


of 30

6.2.4. License generation for multiple articles

For each selected article, please provide the following information:

1. Vendor-defined Host ID

2. Provide the serial number as 'WIBU=##-########' - Example: WIBU=12-12114690

3. Provide the customer ID as the Name of the host - Example: 180054

4. Please provide the required information within the remaining Host ID fields.

5. Select 'Generate' after you have provided the required information.

Figure 6.4. Generate Licenses


of 30

6.2.5. Downloading license files from the View Licenses page

Select 'Save All' on the 'View Licenses' page which is shown after the licenses where generated successfully.

NOTE By using this download method, all licenses are provided as text file.

Figure 6.5. Save All


of 30

6.2.6. Downloading license files via the License Overview page

1. You can navigate to the 'License Overview' page and download all license files in a ZIP archive by selectingthe download button at the bottom of the page.

2. On the 'License Overview' page you can also download each license file separately by selecting the down-load button on the left side of each license line.

Figure 6.6. Save All

6.2.7. Installing the license in EB tresos Studio

Please proceed with the following steps to install your license:

1. Create a folder on your machine where you like to store your license files.

2. Extract the license files from the download ZIP archive into the license folder.

3. Setup the license folder in the license configuration dialog in EB tresos Studio.


of 30

6.3. Manually setting up the environmentNOTE When using license files on the client machine, installing the EB License Administration

utility is optional. You can configure the EB_LICENSE_FILE manually.

You can setup the license source folder and/or server within the license configuration dialog in EB tresos Studioor you can configure the EB vendor specific license environment variable to point to your license files and/oryour license server.

Please configure the user environment variable 'EB_LICENSE_FILE' as follows:

► License Folder: EB_LICENSE_FILE=<path_to_your_license_files>

► License File: EB_LICENSE_FILE=<path_to_your_license_file.lic>

► License Server: EB_LICENSE_FILE=<port>:<your_server_name>

NOTE A combination of the different options is possible. The license search order depends on theorder of the entries provided in the EB_LICENSE_FILE environment variable. The entriesmust be separated by semicolon.

Example: EB_LICENSE_FILE=C:\EB\Licenses;[email protected]

Product LicensingChapter 7. Partner Licenses

of 30

7. Partner Licenses

7.1. Usage of partner licensesPartner Licenses are delivered to partner companies of EB that redistribute EB tresos Studio together with theirown modules to their customers and therefore need a redistributable license.

License restrictions

► An EB tresos Studio Single-User license is provided to the partner to develop and test partner specificmodules.

NOTE The EB tresos Studio Single-User license activation code must NOT be shipped to thecustomer.

► An EB tresos Studio Partner licenses provides the cryptographic key to sign the partner specific modulesbefore they are distributed to the partners customer.

NOTE The EB tresos Studio Partner license activation code must NOT be shipped to thecustomer.

► The EB tresos Studio license for Partners Customer provides the cryptographic key to unlock the signedpartner modules on the partners customer machine.

NOTE EB ships a bundle of EB tresos Studio for Partner Customer licenses activation codesto the partner. The partner ships one activation code out of this bundle to one customer.Each customer license can be activated on up to 100 customer machines.

► All allowed modules on the partners customer machine must be cryptographically signed with the keyprovided by the partner license.

► Unsigned modules are not accepted and will be deactivated.

► The partners customer can also use a full-featured EB tresos Studio which he can order from EB if it isrequired to use also unsigned modules.


of 30

7.2. Workflow description

To work with EB tresos Studio as a partner, proceed with the following steps:

► Activate the Single-User developer license on the partner machine.

► Develop and test the partner specific modules.

► Activate the Partner License on the partner machine.

► Sign the partner modules using the partner code on the command line.

► Redistributes EB tresos Studio to the customer.

► Provide one EB tresos Studio for Partner Customer activation code to the customer.

► Redistributes the EB Client License Administration tool to the customer.

To work with EB tresos Studio as partner customer, proceed with the following steps:

► Install EB tresos Studio which you have received from the partner.

► Install signed modules received from the partner.

► Activate the EB tresos Studio for Partner Customers license by using the activation code received fromthe partner.

► Start working with EB tresos Studio.

Figure 7.1. Partner License Workflow


of 30

7.3. Developing modules

Module development without signing modules:

► While developing modules it is convenient not to always sign the modules so EB ships a Single-Userdeveloper license. The license must be activated before the partner can start developing modules in EBtresos Studio.

► When the modules under test are generated, the development license is used.

7.4. Using the signature toolEB tresos Studio includes a signature tool which is capable to sign module plug-ins. The signature tool isaccessible via the command line of EB tresos Studio. To operate the signature tool, an EB tresos Studio forPartner license must be activated.

With the signature tool the following files must be signed:

► Parameter definition files (config/*.xdm) of the module

► All Code Templates

The signature tool can be run with the following command line (cygwin syntax):

$ cd $TRESOS_BASE

$ bin/tresos_cmd.bat \

crypto -v \

- ski PartnerKey \

- files config/Can.xdm;generate/Can_Cfg.c;generate/Can_Cfg.h \

plugins/Can_TS_T16D4M2I0

► The command line above runs the tool from within the EB tresos Studion installation folder.

► -ski provides the PartnerKey that was used to create the partner license.

► -files provides the list of files that should be signed (all xdm and code template files)

► plugins/Can_TS_T16D4M2I0 specifies the base directory of the module plug-in

► The PartnerKey can be extruded from the license feature of the EB tresos Studio partner license feature:EB_TS_CRYPTO<PartnerKey>


of 30

7.5. Checking the signature► After running the signature tool, the created signatures can be found in the file META-INF/CRYP-

TOMANIFEST.MF.

► The file contains entries for each signed file.

Name: config/Can.xdm

SignatureKeyID: PartnerKey

IV: 29:54:86:96:-106:-6:-82:-11:81:123:6:124:-108:-42:25:-8:26:-54:84:

95:6:2:104:7:-71:113:84:-119:76:-93:86:121

Signature: 11313377420664456223418135491058827101182858953164286252784

2857275443401592739994875519105244003438096762908413

SignatureAlgorithmID: DSA

SignatureKeyProviderID: plugin.launcher2.licenseFileKeyProvider

NOTE Verify that all xdm and code template files are named in the crypto manifest.

7.6. Software distributionTo operate EB tresos Studio on a partners customer machine, several components must be shipped to thepartners customer.

Components to be shipped to the customer:

► EB Licensing User's Guide

► EB tresos Studio

► EB Client License Administration Utility

► EB tresos Studio for Partner Customer license activation code

► Signed partner modules

product licensing - user's guide · 2015. 10. 30. · sentinel dongle driver setup (hasp4,...

Documents