当前位置：文档库 › 富士通-掌静脉sdk开发包说明

富士通-掌静脉sdk开发包说明

Chapter1 Before Using the Authentication Library

1.1 Overview

1.2 Downloading the Authentication

Library

1.3 List of Contents

Chapter1 Before Using the Authentication Library

1.1 Overview

The Authentication library is a library of programs which enrolls palm vein data and authenticates users.

The Authentication library enables development of customized applications for the Palm vein authentication system which runs on Windows or Linux.

★Tip The Authentication library interface

The Authentication library interface conforms to the BioAPI 1.1

Framework which is currently being standardized by the BioAPI?Consortium.

The specifications of BioAPI 1.1 "BioAPI Specification Version 1.1" can

be downloaded from the homepage of the BioAPI? Consortium. Refer

to the specifications as necessary.

The following table lists main functions of the Authentication library.

Function Descriptions

Palm vein data enrollment A function to enroll captured palm veins as

palm vein data.

Verification

A function to verify and authenticate by

matching the captured palm veins against the

palm vein data by specified entered ID.

"Verification" is also called "1 to 1

Authentication authentication".

Identification

A function to authenticate by identifying if the

captured palm veins match any of the enrolled

palm vein data. "Identification" is also called "1

to many authentication".

1.2 Downloading the Authentication Library

This section describes how to download the Authentication library.

Operation

Step1 Download the Authentication library from the SDK support Web site. !Caution Downloading the Authentication library

The following four types of Authentication libraries are

provided.

?Windows 2000/XP/Server 2003/Vista(x86)

?Windows Vista(x64)

?Red Hat Enterprise Linux v.3

?Red Hat Enterprise Linux v.4

Be sure to download the Authentication library corresponding

to the OS that you are using.

>See> For information on the SDK support Web site, refer to "System development guide".

Step2 Extract the compressed Authentication library file downloaded from the web using an extraction tool.

>See> For information on the folder structure and files contained in

each folder, refer to "1.3 List of Contents".

Chapter1 Before Using the Authentication Library

1.3 List of Contents

1.3.1 Windows Version

◆Windows 2000/XP/Server 2003/Vista(x86) Version

The following lists the provided contents of the Authentication library for Windows 2000/XP/Server 2003/Vista(x86) version.

Folder

1st

Hierarchy 2nd Hierarchy 3rd

Hierarchy

4th

Hierarchy

Stored File Description

PvFw.dll

F3BC1ENG.DLL

F3BC4COM.DLL

F3BC4CAP.DLL

F3BC4MAT.DLL

F3BC4FRM.DLL

F3BC1ENG.DAT

F3BC4COM.DAT

F3BC1SET.INI

dll

pvfwvl.txt

DLL files and operational

environment setting files for

the Authentication library

(used to run applications)

pvapi_api.h

pvapi_type.h

pvapi_err.h

bioapi_api.h

bioapi_type.h

include

bioapi_err.h

Header files

(used to build source codes)

English Authentication

Library

Windows

lib PvFw.lib Library file

(used to build source codes)

1.3 List of Contents

◆Windows Vista(x64) Version

The following lists the provided contents of the Authentication library for Windows Vista(x64) version.

Folder

1st

Hierarchy 2nd Hierarchy 3rd

Hierarchy

4th

Hierarchy

Stored File Description

F3BC4BIO.DLL

F3BC1ENG.DLL

F3BC4COM.DLL

F3BC4CAP.DLL

F3BC4MAT.DLL

F3BC4FRM.DLL

F3BC1ENG.DAT

F3BC4COM.DAT

F3BC1SET.INI

pvfwvl.txt

Microsoft.VC80.CR

T.manifest (Note)

msvcm80.dll (Note)

msvcp80.dll (Note)

dll

msvcr80.dll (Note)

DLL files and operational

environment setting files for

the Authentication library

(used to run applications)

pvapi_api.h

pvapi_type.h

pvapi_err.h

bioapi_api.h

bioapi_type.h

include

bioapi_err.h

Header files

(used to build source codes)

English Authentication

Library

Windows

lib F3BC4BIO.lib Library file

(used to build source codes)

Note) These files are stored in the "Microsoft.VC80.CRT" folder.

Chapter1 Before Using the Authentication Library

1.3.2 Linux Version

The following lists the provided contents of the Authentication library for Red Hat Enterprise Linux v.3 and Red Hat Enterprise Linux v.4.

Folder

1st

Hierarchy 2nd Hierarchy 3rd

Hierarchy

4th

Hierarchy

Stored File Description

LM libpvfw.so (Note)

libf3bc1eng.so

libf3bc4com.so

libf3bc4cap.so

libf3bc4mat.so

F3BC1ENG.DAT

F3BC4COM.DAT

F3BC1SET.INI

apivl.txt

engvl.txt

pvfwvl.txt

.so files and operational

environment setting files for

the Authentication library

(used to run applications)

English Authentication

Library

Linux

Inc pvapi_api.h

pvapi_type.h

pvapi_err.h

bioapi_api.h

bioapi_type.h

bioapi_err.h

Header files

(used to build source codes)

Note) "libpvfw.so" is also used to build source codes as a library file.

Chapter2 Running Applications 2.1 Required Hardware/Software

2.2 Preparing for Running Applications

Chapter2 Running Applications

2.1 Required Hardware/Software

The following table lists the required hardware and software for running applications developed using the Authentication library.

Required Hardware/Software Details

CPU (Note 2)

: Intel? Celeron? 600MHz

or more

Memory

(Note 3)

: 256MB or more

USB (Note 4)

(Note 5)

: USB 2.0 or 1.1

(must be able to provide 500 mA

current to the Sensor. If USB

1.1 is used, the USB controller

must be complies with UHCI.)

Personal computer

(Note 1)

HDD space

(Note 6)

: 92MB or more

Hardware

Sensor (Note 5) Included in this product.

Or, a Sensor which is purchased separately.

Either of the following:

?Windows 2000 SP4 or later

?Windows XP SP2 or later (Note 7)

?Windows Server 2003 SP1 or later (Note 8)

?Windows Vista (Note 9)

?Red Hat Linux V3

?Red Hat Linux V4

Authentication library

Software

Sensor driver (Note 5) Download from the SDK support Web site.

Note 1) This document assumes a personal computer as a typical example of hardware as the installation target of the Authentication library.

Note 2) A CPU of 1.0 GHz or faster is recommended for Windows Vista.

An x64 architecture CPU applies for Windows Vista (x64).

Also, an Intel? Pentium?4 of 3.0 GHz or faster is recommended for identification in high-speed mode.

>See> For information on the identification using High-speed mode,

refer to "System development guide", "2.2 Preparing for

Running Applications", and "3.4.17 PvAPI_SetProfile".

Note 3) Memory required is 1GB or more for Windows Vista.

Note 4) USB 2.0 is recommended. The processing speed is reduced on USB 1.1. Use USB 2.0 when connecting multiple Sensors.

>See> For information on multiple Sensor connection, refer to the

"System development guide" and "Appendix B Connecting

Multiple Sensors (Windows Version Only)".

2.1 Required Hardware/Software

Note 5) Required when connecting a Sensor.

Note 6) Minimum required space only for the Authentication library.

12MB applies if trace information is not required.

The following space is required when connecting multiple Sensors.

?With the trace information output

92MB per Sensor (736MB for 8 Sensors)

?Without the trace information output

12MB per Sensor (96MB for 8 Sensors)

>See> For information on trace information, refer to the "2.2 Preparing

for Running Applications".

>See> For information on multiple Sensor connection, refer to the

"System development guide" and "Appendix B Connecting

Multiple Sensors (Windows Version Only)".

Note7) Editions of Windows XP for which operations with the Authentication library are guaranteed are the Professional and Home Edition.

Note 8) Windows Server 2003 can be used when performing management of palm vein data, and verification and identification processes on a server.

(The operations of capturing palm veins by connecting a Sensor on a

Windows Server 2003 are not guaranteed.)

Note 9) All x86 and x64 editions of Windows Vista except the Starter Edition guarantee operations with the Authentication library and Sensor driver.

>See> For information on the SDK support Web site, refer to "System development guide".

!Caution Linux environment

The Authentication library is guaranteed to properly work under the

following Linux environment:

Distribution Kernel

Version Gcc Version Glibc

Version

Red Hat Linux V3 2.4.21-4.EL 3.2.3 20030502

(Red Hat Linux3.2.3-20) 2.3.2

2.6.9-5.EL

4.3 20041212

(Red Hat 3.4.3-9.EL4) 2.3.4

Red Hat Linux V4

2.6.9-42.0.

3.EL 3.

4.6 20060404

（Red Hat 3.4.6-3） 2.3.4

Chapter2 Running Applications

2.2 Preparing for Running Applications 2.2.1 Running on a Windows Environment

This section describes the preparation for running applications developed using the Authentication library in a Windows 2000, Windows XP, Windows Server 2003, or Windows Vista environment.

Operation

Step1 If the personal computer is designated to be connected to a Sensor,

install the Sensor driver(Windows 2000/XP/Vista(x86) version or

Windows Vista(x64) version) on the personal computer.

>See> For information on how to install the driver, refer to "Sensor

driver installation guide".

Step2 Install the Authentication library on the personal computer as follows.

(1) In a Windows 2000, Windows XP, Windows Server 2003 or Windows

Vista (x86) environment, copy the "dll" folder under the "\English\ AuthenticationLibrary\Windows" folder which is created by

downloading and decompressing the Authentication library, to any

folder on the personal computer.

In a Windows Vista (x64) environment, copy the "dll" folder under the

"\English\AuthenticationLibrary\Windows64" folder which is

created by downloading and decompressing the Authentication

library, to any folder on the personal computer.

!Caution Windows Vista environment

Avoid using system directories ("C\", "C:\Program Files",

"C:\Windows", etc.) on the personal computer as the

destination folder to copy the "dll" folder.

Operations are not guaranteed if the "dll" folder is copied into

system directories in a Windows Vista environment.

(2) Set the path to the "dll" folder on the personal computer as follows.

1. Select [System] from Control Panel.

2. Select the [Advanced] tab (for Windows 2000, Windows XP or

Windows Server 2003), or [Advanced system settings] (for Windows Vista), and click the [Environment Variables] button.

3. Select "Path" from the list of System variables at the bottom of the Environment Variables screen, and click the [Edit] button.

4. In the entry area for [Variable Value] (for Windows 2000)/

[Variable value] (for Windows XP, Windows Server 2003, or

Windows Vista) on the Edit System Variable screen, add the path

to the "dll" folder as follows:

; (the path to the "dll" folder copied in (1)) \dll

2.2 Preparing for Running Applications

!Caution Setting a path

Paths are delimited by a ";" (semi-colon).

Take care not to insert the path at the middle of another path.

!Caution When the Authentication library is no longer in use

Delete the copied folder and the added path.

Step3 Specify whether a Sensor is connected or not in the operational environment setting file "F3BC1SET.INI" under the copied "dll" folder on

the personal computer.

The following lists setting items in the operational environment setting

file.

!Caution Note on setting items

Each setting item in the operational environment setting file

must be up to 256 single byte characters and must be

terminated with a carriage return.

Each setting item must not be repeated.

[Common]

Sensor = 1 ????????????????(1)

Setting Item Description Default

(1) Sensor

Specify whether a Sensor is connected or

not.

1: Connect a Sensor

0: Do not connect a Sensor

Step4 If modifying the default values of internal setting of palm vein data and Identification mode (refer to the following table), create an operational environment setting file "PvAPI.INI" under the copied "dll" folder on the personal computer and set the internal setting of palm

vein data and Identification mode.

The following lists setting items in the operational environment setting file.

!Caution Note on setting items

Each setting item in the operational environment setting file

must be up to 256 single byte characters and must be

terminated with a carriage return.

Each setting item must not be repeated.

[Common]

RegistExtractKind = 1 ???????????(1)

MatchExtractKind = 1 ???????????(2)

IdentifyMode = 1 ???????????(3)

Chapter2 Running Applications

Setting Item Description Default

(1) RegistExtractKind

Specify the internal format of the

palm vein data in the enrollment of

the palm vein data.

0: Previous format

1: Indexed format(recommended)

Index does not generate to the

compressed format of palm vein

data even if the indexed format is

specifyed.

(Windows

version)

(Linux

version)

(2) MatchExtractKind

Specify the internal format of the

palm vein data in capturing of palm

vein

0: Previous format

1: Indexed format(recommended)

Index does not generate to the

compressed format of palm vein

data even if the indexed format is

specifyed.

This setting item should be set the

same value as “RegistExtractKind”.

(Windows

version)

(Linux

version)

(3) IdentifyMode

Specify the identification mode in

identifying the palm vein data.

0: Previous mode

1: High-speed mode(recommended)

High-speed mode can be set under

the condition of using

non-compression format and item

of “RegistExtractKind” and “Match

ExtractKind” are set to indexed

format

>See> For information on the internal Palm vein data format, and identification mode of the palm vein data, and Palm vein data

enrollment format , refer to "System development guide".

★Tip Setting in PvAPI_SetProfile

Internal format of the palm vein data and identification mode

of palm vein data are also specified using PvAPI SetProfile.

>See> For information on PvAPI SetProfile, refer to “3.4.17

PvAPI_SetProfile”.

Step5 If modifying the default values of trace acquisition information (refer to the following table), create an operational environment setting file "PvAPI.INI" under the copied "dll" folder on the personal computer and

set the trace acquisition information.

If an operational environment setting file “PvAPI.INI” is created by Step 4, it is necessary to set the trace acquision information in created file “PvAPI.INI”.

2.2 Preparing for Running Applications

The following lists setting items in the operational environment setting file.

!Caution Note on setting items

Each setting item in the operational environment setting file

must be up to 256 single byte characters and must be

terminated with a carriage return.

Each setting item must not be repeated.

[PvAPITrace]

TraceMode = 3 ???????????????(1)

TraceSize = 512 ??????????????(2)

TracePath = "C:\Temp" ???????????(3)

TraceFile = "PvAPITrc.dat" ?????????(4)

Setting Item Description Default

(1) TraceMode

Specify trace output mode in bits.

0: No log output

1: Output error information

2: Output the result of the reading

process of the operational

environment setting file

4: Output internal trace information

Because this item is specified by bits,

only the above bits are referenced even if

values are specified in other bits without

resulting in an out of range.

("1" and "2"

are valid)

(2) TraceSize

Specify the size of the trace file in Kbyte

units in the range from 1 to 1024.

The default value (512) is applied if any

values other than 1 - 1024 are specified.

512

(3) TracePath

Specify the output destination of the

trace file with an absolute path.

However, do not specify a system

directory ("C:\", "C:\Program Files",

"C:\Windows", etc.) in a Windows Vista

environment.

The trace file is not output if the

specified folder does not exist, or

read/write privileges to the specified

folder is not granted.

(The same

folder as the

Authenticati

on library

modules)

(4) TraceFile

Specify the name of the trace file.

The trace file is newly created if the

specified file does not exist.

However, the trace file is not output if

the specified file exists, and read/write

privileges to the specified file are not

granted.

PvAPITrc.dat

Chapter2 Running Applications

★Tip Trace file with multiple Sensor connections

Trace information before "BioAPI_ModuleAttach" and after

"BioAPI_ModuleDetach" is output to the specified trace file.

Also, trace information after "PvAPI_PreSetProfile" is output to trace

files for each Sensor.

The format of the trace file name for each Sensor is shown below. However, trace files for Sensors which are no longer in use are not deleted.

PvAPI_serial number_model_trace file name

Item Description

Serial

number

The serial number of the Sensor specified in

PvAPI_PreSetProfile.

Model The model of the Sensor specified in PvAPI_PreSetProfile.

Trace file

name

The trace file name specified in the operational

environment setting file "PvAPI.INI".

>See> For information on multiple Sensor connections, refer to the "System development guide" and "Appendix B Connecting Multiple Sensors (Windows Version Only)"

>See> For information on BioAPI_ModuleAttach, refer to "3.4.3

BioAPI_ModuleAttach".

>See> For information on BioAPI_ModuleDetach, refer to " 3.4.4

BioAPI_ModuleDetach".

>See> For information on PvAPI_PreSetProfile, refer to "3.4.23

PvAPI_PreSetProfile (Windows Version Only)".

2.2 Preparing for Running Applications

2.2.2 Running on a Linux Environment

This section describes the preparation for running applications developed using the Authentication library in a Red Hat Linux V3 or Red Hat Linux V4 environment.

Operation

Step1 If the personal computer is designated to be connected to a Sensor, install the Sensor driver (one of the Linux versions) on the personal computer.

>See> For information on how to install the Sensor driver, refer to

the "Sensor driver installation guide".

Step2 Install the Authentication library on the personal computer as follows.

(1) Copy all of the files in "LM" folder under the downloaded and

extracted "\English\AuthenticationLibrary\Linux" folder to any

folder on the personal computer.

(2) Use the "export" command to set the folder path where the files have

been copied to, to an environment variable LD_LIBRARY_PATH.

Command example) export LD_LIBRARY_PATH=

$LD_LIBRARY_PATH:/home/palmsecure/linux/lib

★Tip How to confirm the path setting

Use the "echo" command to confirm.

Input command) echo $LD_LIBRARY_PATH

!Caution When the Authentication library is not longer in use

Delete all the copied files. The specified path is removed as you

logout from Linux.

Step3 Specify whether a Sensor is connected or not in the operational environment setting file "F3BC1SET.INI" copied under any folder on the personal computer.

The method to specify where a Sensor is connected or not is the same as

for Windows.

>See> Refer to Step 3 of "2.2.1 Running on a Windows Environment".

Step4 If modifying the default values of internal format and identification mode of palm vein data, create an operational environment setting

file "PvAPI.INI" under the folder where the files have been copied to,

and set internal format and identification mode of vein data.

The method to modify the default settings of internal format and identification of vein data is the same as for Windows.

>See> Refer to Step 4 of "2.2.1 Running on a Windows Environment".

Chapter2 Running Applications

Step5 If modifying the default values of trace acquisition information, create an operational environment setting file "PvAPI.INI" under the folder

where the files have been copied to, and set the trace acquisition information.

If an operational environment setting file “PvAPI.INI” is created by Step

4, it is necessary to set the trace acquision information in created file “PvAPI.INI”.

The method to modify the default settings of trace acquisition

information is the same as for Windows.

>See> Refer to Step 5 of "2.2.1 Running on a Windows Environment".

Chapter3 Authentication Library Interface

3.1 List of Functions

3.2 Structures of Palm Vein Data for

Enrollment and Palm Vein Data for

Authentication

3.3 Basic Process Sequence

3.4 Interface

Chapter3 Authentication Library Interface

3.1 List of Functions

The Authentication library provides the following functions.

Function Name Ref.

BioAPI_ModuleLoad 3.4.1

BioAPI_ModuleUnload 3.4.2

BioAPI_ModuleAttach 3.4.3

BioAPI_ModuleDetach 3.4.4

BioAPI_FreeBIRHandle 3.4.5

BioAPI_GetBIRFromHandle 3.4.6

BioAPI_GetHeaderFromHandle 3.4.7

BioAPI_SetGUICallbacks 3.4.8

BioAPI_Capture 3.4.9

BioAPI_Process 3.4.10

BioAPI_VerifyMatch 3.4.11

BioAPI_IdentifyMatch 3.4.12

BioAPI_Enroll 3.4.13

BioAPI_Verify 3.4.14

BioAPI_Identify 3.4.15

PvAPI_ApAuthenticate 3.4.16

PvAPI_SetProfile 3.4.17

PvAPI_GetErrorInfo 3.4.18

PvAPI_Sense 3.4.19

PvAPI_Cancel 3.4.20

PvAPI_CreateHandleFromBiometricData 3.4.21

BioAPI_GUI_STATE_CALLBACK 3.4.22

PvAPI_PreSetProfile (Note) 3.4.23

Note) PvAPI_PreSetProfile is a function available only for the Windows version. ★Tip BioAPI compliant functions and our proprietary functions

Functions begin with "BioAPI" are BioAPI compliant functions. Also,

ones which begin with "PvAPI_" are Fujitsu's proprietary function.

★Tip Definition of variable types used by BioAPI

Variable types (unit8, etc.) used in BioAPI are defined in the header

file "bioapi_type.h" as follows.

typedef unsigned char uint8;

typedef unsigned short uint16;

typedef short sint16;

typedef unsigned int uint32;

typedef int sint32;

typedef char sint8;

3.1 List of Functions

!Caution Calling from multiple threads

Function other than PvAPI_Caancel can’t be called from multiple

threads.

!Caution Header files to be included

The following header files need to be included in source codes which

use the functions in the Authentication library.

?pvapi_api.h

?pvapi_type.h

?pvapi_err.h

?bioapi_api.h

?bioapi_type.h

?bioapi_err.h

!Caution When building a source code

The following library should be specified in advance.

?PvFw.lib (for Windows 2000/XP/Server 2003/Vista (x86))

?F3BC4BIO.lib (for Windows Vista (x64))

Chapter3 Authentication Library Interface

3.2 Structures of Palm Vein Data for Enrollment and Palm Vein Data for Authentication

Both palm vein data for enrollment which is notified by BioAPI_Enroll, and palm vein data for authentication notified by BioAPI_Capture are a single consecutive area that has the following structure.

BIR

Palm vein data

storage area

Header

Length

Header version

Type

Format

Quality

Purpose

Factors mask

Data address

Signature

Palm vein data

(4) (1) (1) (4) (1) (1) (4) (4) (4) (Variable) (Note)

Remark: Numbers in ( ) indicate the size of each field (bytes).

Note) The size of palm vein data can be calculated by subtracting the header size (16 bytes) from the value specified in the Length field.

When the enrollment format is non-compressed, the size of palm vein data

for a single hand is maximum 2448 bytes with BIR. However, if the

enrollment format is compressed, the size of palm vein data for a single

hand is maximum 832 bytes with BIR.

Field Description

A field to notify palm vein data subject to verification, a group of

palm vein data subject to identification, or the captured palm vein

data for authentication to the Authentication library.

Header The information section of BIR.

Length The total of the header size and the palm vein data size.

Length is not the size of the whole palm vein data for enrollment or authentication; since it does not include the size of the data address

and signature fields (8 bytes).

Data address The address which points to the beginning of the palm vein data

However, this is always set to 0 for Windows Vista (x64) and palm

vein data is stored immediately after the signature.

BIR

Signature Normally this field indicates the pointer of the signature, however, this Authentication library uses this field for a consistency check.

Palm vein data

storage area

The field which contains palm vein data only, without BIR.

3.2 Structures of Palm Vein Data for Enrollment and Palm Vein Data for Authentication 21

>See> For the palm vein data enrollment format, refer to "3.4.17

PvAPI_SetProfile".

!Caution Signature field

Never modify the value set in the signature field.

Any subsequent operations are not guaranteed if the value is modified.

!Caution For Windows Vista (x64)

Use the PvAPI_BIR structure for BIR.

The PvAPI_BIR structure can also be used in the Windows 2000/XP/

Server 2003/Vista (x86) version.

The following describes the existing BioAPI_BIR structure for Windows 2000/XP/Server 2003/Vista (x86) and Linux, and the PvAPI_BIR structure.

[BioAPI_BIR structure]

typedef struct bioapi_hrs_bir

{

BioAPI_BIR_HEADER Header;

BioAPI_BIR_BIOMETRIC_DATA_PTR BiometricData;

BioAPI_DATA_PTR Signature;

} BioAPI_BIR, *BioAPI_BIR_PTR;

[PvAPI_BIR structure]

typedef struct pvapi_hrs_bir

{

BioAPI_BIR_HEADER Header;

uint32 BiometricData;

uint32 Signature;

} PvAPI_BIR, *PvAPI_BIR_PTR;

★Tip Compatibility of palm vein data

Items of palm vein data registered by Windows 2000/XP/Server 2003/

Vista (x86) or Linux and Windows Vista (x64) are compatible.

★Tip Palm vein data

Generally, palm vein data is stored either as raw image data as it was captured by the Sensor, or as intrinsic characteristics extracted from

the raw image data. This Authentication library stores data as intrinsic

characteristics extracted from the raw image data.

★Tip Processed BIR

The whole palm vein data including BIR and the intrinsic

characteristic data extracted from the raw image data, is generally

called "processed BIR".

Chapter3 Authentication Library Interface

★Tip Internal format of the palm vein data

There are 2 types of internal format of the palm vein data. In addition

to the previous format used from the Authentication library V10, there

is the indexed format used from the Authentication library V12.

>See> For information on the internal format of the palm vein data, refer to “2.2 Preparing for Running Applications” or “3.4.17 PvAPI_SetProfile”

in this manual and “System development guide”.

3.3 Basic Process Sequence

3.3.1 Initialization Sequence

The following diagram indicates the basic initialization sequence.

Note 1) PvAPI_PreSetProfile is available only for the Windows version and is called for each setting item when switching the encryption method during capture of palm vein data to the AES256 method and when connecting multiple Sensors.

>See> For information on multiple Sensor connections, refer to the "System development guide" and "Appendix B Connecting

Multiple Sensors (Windows Version Only)".

Application

(1)PvAPI_ApAuthenticate()

(2)BioAPI_ModuleLoad()

(3) PvAPI_PreSetProfile (Note 1)

(4)BioAPI_ModuleAttach()

(5)PvAPI_SetProfile() (Note 2)

PvAPI_SetProfile()

(6)BioAPI_SetGUICallbacks()

Authentication library

Application authentication

process

Module registration process

Sensor initialization

Module attachment process

Operation mode setting process

Status notification callback

function registration process

Chapter3 Authentication Library Interface

Note 2) PvAPI_SetProfile should be called for each setting item.

In setting items by PvAPI SetProfile, internal format of the palm vein data and identification mode of palm vein data may be set by using an operational environment setting file “PvAPI.INI”

>See> For information on an operational environmental setting file “PvAPi.INI”, refer to “2.2 Preparing for Running Applications”.

>See> For information on “Encryption key of each smart card” of PvAPI SetProfile, refer to “3.3.9 Assignment process sequence of

encryption key for each smart card”.

★Tip Initialization sequence of Authentication library

It is recommended to execute initialization sequence of Authentication library (from (1) to (4) in above figure) right after starting of application.Start sequence of sensor will be execute simultaneously by executing initialization sequence of Authentication library (from (1) to (4) in above figure).

The start sequence of the Sensor requires approximately 3 to 7 seconds.

>See> For information on the duration required for the Sensor's start sequence, refer to "Appendix E Duration Required for the Start/

Restart Sequence of the Sensor".

3.3 Basic Process Sequence

3.3.2 Termination Sequence

The following diagram indicates the basic termination sequence.

Note) BioAPI_FreeBIRHandle is called when a handle which is notified by BioAPI_Enroll or BioAPI_Capture has not been freed.

Application

(1)BioAPI_FreeBIRHandle() (Note)

(2)BioAPI_ModuleDetach()

(3)BioAPI_ModuleUnload()

Authentication library

Handle freeing process

Module detachment process

Chapter3 Authentication Library Interface

3.3.3 Palm Vein Data Enrollment Sequence

The following diagram indicates the basic palm vein data enrollment sequence. Note 1) Status notification callback of the capturing guidance occurs when "Application" is specified as the "sender of the guidance" by calling

PvAPI_SetProfile in the initialization sequence.

Note 2) When saving palm vein data for enrollment, take the data address and signature field size (8 bytes) into consideration in addition to the size specified in Length.

>See> For information on how to determine cancellation, refer to "3.3.8 Cancellation Sequence".

Application

(1)BioAPI_Enroll ()

BioAPI_GUI_STATE_CALLBACK ()

Status notification callback

(starting the capturing guidance)

Status notification callback

(capturing guidance in progress)

Status notification callback

(capturing guidance in progress)

Status notification callback

(capturing phase complete)

(2) Determining whether it has been

canceled or not

(3)BioAPI_GetBIRFromHandle()

(4) Saving palm vein data for enrollment

(Note 2)

(5)BioAPI_FreeBIRHandle ()

Authentication library

Palm vein data enrollment

process

Capturing guidance (Note 1)

Returning palm vein data

for enrollment

BIR retrieving process

BIR handle freeing process

Sensor

etc

File

Smart

card