U8PS-LG22-06ENZ3(1)

PalmSecure™ SDK V02

How to Acquire the License File

This is a picture of PalmSecure Sensor V2.

◆ Revision History

Revised
Revision Issued Date Modification Details
Page
* For the revision history for Rev.1 to Rev.5,
refer to the "◆ Previous Revision History" at
the end of this document.
Rev. 6 Apr 2017 Page ⅲ Description added
• Added “Caution for This Manual” in “◆
Introduction”.
Entire Description modified
document • Modified the entire description according
to the new license policy.
Rev 6.1 Jun 2017 Page 9 Image added
• Added image of “License Notification” in
“2.2 Preparation Before Acquiring a
License File”.
Page 10 Screen added
to 11 • Added screenshots to the steps in “2.3
Acquiring a License File”.

i
◆ Introduction

Thank you for purchasing PalmSecure™ SDK V02 (hereinafter called "this
product").
In order to use the Authentication library, it is necessary to purchase the license
of Authentication library and acquire a license file in advance following proper
procedures.
This document explains how to acquire the license file.

Screens shown in this document may be a little different from the screens actually
displayed depending on your environment.

June 2017

June 2017 : Rev. 6.1

ii
Caution for This Manual
You are required to use this product within the specification described in this
document.

Regarding to High Safety Required Usage

This Product is designed, developed and manufactured as contemplated for
general use, including without limitation, general office use, personal use,
household use, and ordinary industrial use, but is not designed, developed and
manufactured as contemplated for use accompanying fatal risks or dangers that,
unless extremely high safety is secured, could lead directly to death, personal
injury, severe physical damage or other loss (hereinafter “High Safety Required
Use”), including without limitation, nuclear reaction control in nuclear facility,
aircraft flight control, air traffic control, mass transport control, medical life
support system, missile launch control in weapon system. You shall not use this
Product without securing the sufficient safety required for the High Safety
Required Use. If you wish to use this Product for High Safety Required Use,
please consult with the sales representatives in charge before such use.

Cautions for Exporting This Product

When exporting or providing this product and this document to a foreign country,
check relevant laws such as "Foreign Exchange and Foreign Trade Control Law",
and regulations such as U.S. export control law, and follow the necessary
procedures.

Warnings
• Reprinting or reproducing this document in part or in whole without
permission is forbidden.
• Items described in this document are subject to change without prior notice.
PalmSecure is a trademark of Fujitsu Ltd.

Microsoft and Windows are registered trademarks of Microsoft Corporation in the United

States and/or other countries.

Linux is a registered trademark or trademark of Linus Torvalds in the United States

and/or other countries.

Other company names and product names described in this document are trademarks or

registered trademarks of each company.

All Rights Reserved, Copyright © 2013 - 2017 Fujitsu Limited and Fujitsu Frontech Limited

iii
◆ Composition of This Document

This document consists of the following two chapters and the appendix.

Chapter Title Description

Chapter 1
Describes the license type of Authentication
License of Authentication
library and necessary number of licenses.
library
Chapter 2
Describes the procedure for acquiring the license
Procedure for Acquiring
file.
the License File
Appendix
Appendix A Describes the license file-related error information
Error Information of which is notified to the “error information
Authentication Library structure” of Authentication library.

◆ Abbreviations and Common Terms

Abbreviations and common terms used in this document are as follows:

Abbreviations/
Description
Common Term
This product Abbreviation for “PalmSecure™ SDK V02”.
SDK Front Page Abbreviation for “PalmSecure™ SDK Front Page”.
SDK V02 Support
Abbreviation for “PalmSecure™ SDK V02 Support Website”.
Website
Authentication Common term for the “Authentication library V32”
library and later.
"Authentication Common term for any “Authentication Library
Library Reference Reference Guide” for the “Authentication library V32”
Guide" and later.

iv
◆ Notations

The following symbols are used in this document.

Symbol Description
Describes things that you have to look out for.
!Caution You must read it.
Provides reference information.
★Tip Read it as necessary.

>See> Indicates an item to be referred.

Operation Describes operation procedures.

[ ] button Indicates a button displayed on the screen.

v
◆ Table of Contents

Chapter1 License of Authentication Library ·············· 1

1.1 License Types and Necessary Number of Licenses ............ 2

1.2 System Configuration and Necessary License .................... 4

1.3 Necessary Number of Licenses for Enterprise Edition ......... 5

Chapter2 Procedure for Acquiring the License File ··· 7

2.1 Procedure Overview............................................................... 8

2.2 Preparation Before Acquiring a License File ........................ 9

2.3 Acquiring a License File ....................................................... 10

2.4 Saving the License File on the Target Hardware................ 12

Appendix ···························································· 13

Appendix A Error Information of Authentication Library ......... 14

vi
Chapter1 License of Authentication
Library

1.1 License Types and Necessary

Number of Licenses

1.2 System Configuration and

Necessary License

1.3 Necessary Number of Licenses for

Enterprise Edition

1
 Chapter1 License of Authentication Library

1.1 License Types and Necessary Number

of Licenses

In order to use Authentication library, it is necessary to purchase the license of

the Authentication library and acquire a license file in advance.
This chapter explains about the license types and necessary number of licenses
to be purchased.

Purchase required type of license corresponding to the version, edition of

the Authentication library, License type, and OS type.
The following shows the license types and necessary number of licenses for
each edition of the Authentication library.

>See> For information on the Authentication library, refer to the

“Authentication Library Reference Guide”.

◆ Authentication library Professional Edition (PE)

Number of
licenses
Necessary number contained
License type Description
of licenses in this product
Windows Linux
The number of target
Required to develop
hardware on which you
applications using
Developer install Authentication 10 10
Authentication
library PE to develop
library PE.
applications.
License
The number of target
for PE
Required to distribute hardware to which you
your application with distribute your
Distribution 1 1
Authentication library applications with
PE to a third party. Auhtentication library
PE.

!Caution Purchasing the license

Purchase additional license in case the number of target hardware
exceeds the “number of licenses contained in this product” shown
above for each license type.

2
 1.1 License Types and Necessary Number of Licenses

◆ Authentication library Enterprise Edition (EE)

Number of licenses
Necessary number contained in this
License type Description product
of licens
Windows Linux
The maximun number of
Required to use the
cores your application Not Not
License for EE Authentication
for Authentication library contained contained
library EE.
Enterprise Edition uses.

!Caution Purchasing the license

As shown above, since the license for Enterprise Edition is not
contained in this product, you need to purchase the necessary number
of licenses.

>See> For information on the necessary number of licenses for Enterprise

Edition, refer to “1.3 Necessary Number of Licenses for Enterprise
Edition”.

!Caution Using multiple server

Purchase the license for each server.

!Caution License for Enterprise Edition

The version of the Authentication library Enterprise Edition has to be
V32 or later. Note that the license of the Authentication library
Enterprise Edition V31 or V30 cannot be used.

3
Chapter1 License of Authentication Library

1.2 System Configuration and Necessary

License

The following shows necessary license for each system configuration; we use
a stand alone configuration and a client server configuration as examples.

●: Edition of Authentication library ○: Necessary License

Authentication library
Necessary license
Edition
System configuration
Professional Enterprise License for PE License
Edition Edition Developer Distribution for EE
Stand alone
● ○ ○
configuration

Client ● ○ ○
Client server
configuration
Server ● ○

>See> For information on the necessary number of licenses, refer to “1.1

License Types and Necessary Number of Licenses”.

4
 1.3 Necessary Number of Licenses for Enterprise Edition

1.3 Necessary Number of Licenses for

Enterprise Edition

As explained in the “1.1 License Types and Necessary Number of Licenses”, you
must purchase enough number of licenses required for the maximum number of
cores your application for Authentication library Enterprise Edition (hereafter
called “Application (EE)”) uses, for each server.
Note that the licenses for Enterprise Edition are provided in packs of two cores.
Purchase the licenses for two cores to meet the necessary number of cores.

!Caution When adding the number of cores your Application (EE) uses
In case the number of cores your Application (EE) uses exceeds the
number of cores your license allows, purchase additional licenses to
make up for the insufficient license.

5
Chapter2 Procedure for Acquiring
the License File

2.1 Procedure Overview

2.2 Preparation Before Acquiring a

License File

2.3 Acquiring a License File

2.4 Saving the License File on the Target

Hardware

7
Chapter2 Procedure for Acquiring the License File

2.1 Procedure Overview

Download a license file corresponding to the purchased license from PalmSecure

SDK Front Page.
The following shows an overview of license file acquisition procedure for the license.

Your tasks

License
Notification
1. Prepare the “License Notification”.

2. Download a license file corresponding License File

to the Authentication library written Windows
VxxLicense
PE File
in the “License Notification” from
forWindows
“Download License File” page in Vxx PE
Development
SDK Front Page. fir
License File
Distribution
Windows
Vxx EE
・・・

License File
......
......
......

3. Save the acquired license file to the

target hardware.

<Target hardware>

8
 2.2 Preparation Before Acquiring a License File

2.2 Preparation Before Acquiring a

License File

Prepare the “License Notification” of this product and check the following.
･ Version and edition of Authentication library
･ Password to decompress the Licensed Software

Also, in case the license is for Professional Edition, check the following.
･ License types (Developer/Distribution)

<License for Professional Edition> <License for Enterprise Edition>

9
Chapter2 Procedure for Acquiring the License File

2.3 Acquiring a License File

Follow the steps below to acquire a license file.

Step1 Click the “Download License File” on the SDK Front Page.

A message to confirm that you already purchased the licenses is shown.

Step2 If you already purchased the licenses, click [OK] button.

The login screen is shown.

Step3 At the login screen, enter your User ID and password, and click
[OK] button.

After the login, the webpage of “Download License File” is shown.

★Tip Access to the “Download License File” page

Even when the access period to the SDK V02 Support Website
has expired, you can access the “Download License File” page.

10
 2.3 Acquiring a License File

Step4 Download a License file (LicenseFile_xxxx.zip) from the “Download

License File” page.

Confirm that the following items match with the “License Notification”.
･ Version of Authentication library
･ Edition of Authentication library
(Professional Edition/Enterprise Edition)
･ In case of Professional Edition, the type of license
(Developer/Distribution)
･ OS type

Step5 Decompress the License File (LicenseFile_xxxx.zip) downloaded in

Step4.
Use the “Password to decompress the Licensed Software” written in the
“License Notification” to decompress it.

11
Chapter2 Procedure for Acquiring the License File

2.4 Saving the License File on the Target

Hardware

After decompressing downloaded license file, save it to the target hardware in

order to use the Authentication Library.
Note that the license file must be saved in the appropriate target hardware
corresponding to the license type.

License type Save to

Developer Target hardware for development
License for Professional Edition
Distribution Target hardware to be distributed
License for Enterprise Edition Target hardware (server)

>See> For information on the hardware and OS requirements of the target

hardware, and the information on how to save the acquired license file,
refer to the “Authentication Library Reference Guide”.

!Caution Required environment for the license file

The license file is valid only if the following matches with the target
hardware.
･ The version and edition of the Authentication library
･ The OS type of the target hardware

Use the license file within the number of licenses you purchased following
“Chapter1 License of Authentication Library”. If the number of licenses becomes
insufficient, purchase additional licenses to make up for it.

!Caution In case there is already a Developer license file on the target

hardware that is to be distributed with the Distribution license file
(Professional Edition)
After deleting the Developer license file, save the Distribution license
file.

12
Appendix

13
 Appendix

Appendix A Error Information of

Authentication Library

The following shows the license file-related error information which is notified to
the “error information structure” of Authentication library.
>See> For the error information not listed on the following, refer to the
“Authentication Library Reference Guide”.
Error Detail
Error Level

Error Type

Description

The application is not authenticated.

Take the following measures according to the value of “ErrorInfo3[0]”
and “ErrorInfo3[1]”.
• The value of “ErrorInfo3[0]” is “0x00000000” in hexadecimal (“0” in
decimal):
Check if the sequence of issued “PvAPI_ApAuthenticate” is correct.
Check if the application key specified in “PvAPI_ApAuthenticate”
is correct.

• The value of “ErrorInfo3[0]” is “0x4C430000” in hexadecimal

(“1279459328” in decimal) and the value of “ErrorInfo3[1]” is
“0x00000001” in hexadecimal (“1” in decimal):
Check if the license file is stored in the same folder as
the Authentication library module.

• The value of “ErrorInfo3[0]” is “0x4C430000” in hexadecimal

(“1279459328” in decimal) and the value of “ErrorInfo3[1]” is
Hex.:0x02030003 “0x00000003” in hexadecimal (“3” in decimal):
2 3
Dec.: 33751043 Check if the edition of license file and that of Authentication library
(Authentication are the same; the license file for Professional Edition cannot be used
error)
by Authentication library Enterprise Edition. In the same way,
the license file for Enterprise Edition cannot be used by Authentication
library Professional Edition.

• The value of “ErrorInfo3[0]” is “0x4C430000” in hexadecimal

(“1279459328” in decimal) and the value of “ErrorInfo3[1]” is
“0x00000004” in hexadecimal (“4” in decimal):
Check if the OS type of the target hardware on which the
Authentication library is executed and the OS type of the license file
are the same.

• The value of “ErrorInfo3[0]” is “0x4C430000” in hexadecimal

(“1279459328” in decimal) and the value of “ErrorInfo3[1]” is
“0x00000006” in hexadecimal (“6” in decimal):
Check if the version of Authentication library being executed and
the version of Authentication library of the license file are the same.

(To be continued)

14
 Appendix

Error Detail
Error Level

Error Type

Description

(Continued)

• The value of “ErrorInfo3[0]” is “0x4C430000” in hexadecimal

(“1279459328” in decimal) and the value of “ErrorInfo3[1]” is either one
of the following.
･ “0x00000008” in hexadecimal (“8” in decimal)
･ “0x00000009” in hexadecimal (“9” in decimal)
Hex.:0x02030003
Dec.: 33751043
･ “0x00000102” in hexadecimal (“258” in decimal)
2 3 (Authentication Download a license file corresponding to the purchased license from
error) “Download License File” in the SDK Front Page.

• The value of “ErrorInfo3[0]” is “0x4C430000” in hexadecimal

(“1279459328” in decimal) and the value of “ErrorInfo3[1]” is none of
the above:
Attach the detailed error information and trace file information,
and make an inquiry from the SDK V02 Support Website.

15
◆ Previous Revision History

Revised
Revision Issued Date Modification Details
Page
Entire
Rev. 1 Oct 2013 Newly created
document
Rev. 1.1 Dec 2013 Page 1 Description modified
• Modified the description of “!Caution
About the application key to acquire the
license file”.
Rev. 2 Jan 2014 Entire Description modified
document • Divided the description of license file
acquisition procedure into two editions
of Authentication library; Professional
Edition and Enterprise Edition.
Rev. 3 Apr 2015 Entire Description modified
document • Modified the entire description according
to the change of license file acquisition
procedure and update of Request file
creation tool.
Rev. 4 Sep 2015 Page 15 Description modified
• Modified the following descriptions
in Step 4 under “2.2 Preparation Before
Creating a Request File”.
・Modified the zip file name of the Request
file creation tool.
・Modified the “Example” zip file name
in “★Tip The file name of Request file
creation tool (zip)”.
Page 16 Description modified
to 17 • Modified the following descriptions in
“2.3.1 Creating a Request File for
Page 22 Professional Edition” and “2.3.2 Creating
to 23 a Request File for Enterprise Edition”.
・Modified the version level in the Request
file creation tool screen in “!Caution
When creating a request file”.
・Modified the Request file creation tool
version level in the user ID entry
screen of the SDK V02 Support Website
in Step 1.
Page 38 Description modified and deleted
to 39 • Modified and deleted the following
descriptions in “◆ Error contents and
message” under “Appendix B Error
Message of Request File Creation Tool”.
・Modified the message No.11.
・Deleted message No.15.

16
 Revised
Revision Issued Date Modification Details
Page
Rev. 5 May 2016 Page 4 Description modified
• Modified the description in “1.1 License
Types and Necessary Number of
Licenses ◆Authentication library
Enterprise Edition (EE)” according to the
support for virtual environment.
Page 7 Description modified
to 10 • Modified the description in “1.3
Necessary Number of Licenses for
Enterprise Edition” according to the
support for virtual environment.
Page 14 Description added
• Added the definition on the target
hardware (server) in “2.1.2 License File
for Enterprise Edition”.
Page 26 Description modified
to 31 • Modified the description in “2.3.2
Creating a Request File for Enterprise
Edition” according to the support for
virtual environment.
Page 39 Description added
• Added conditions in “!Caution Required
environment for the license file” in “2.5.2
Saving the License File for Enterprise
Edition on the Target Hardware”.
Page 43 Description modified
to 45 • Modified the following descriptions in
“Appendix B Error Message of Request
File Creation Tool”.
･ Modified the description in “Meaning”
in “◆ Error location”.
･ Modified the description in “Meaning /
Measures” of №16 and №19 in “◆
Error contents and message”.
Page 47 Description modified
• Modified the “Description” in “Appendix
C Error Information of Authentication
Library”.

17