ANSI INCITS ISO IEC 19784-1-2006 Information technology Biometric application programming interface Part 1 BioAPI specification.pdf

1、INCITS/ISO/IEC 19784-1:20062007 (ISO/IEC 19784-1:2006, IDT) Information technology Biometric application programming interface Part 1: BioAPI specificationINCITS/ISO/IEC 19784-1:20062007 (ISO/IEC 19784-1:2006, IDT)INCITS/ISO/IEC 19784-1:20062007 ii ITIC 2007 All rights reserved PDF disclaimer This P

2、DF file may contain embedded typefaces. In accordance with Adobes licensing policy, this file may be printed or viewed but shall not be edited unless the typefaces which are embedded are licensed to and installed on the computer performing the editing. In downloading this file, parties accept therei

3、n the responsibility of not infringing Adobes licensing policy. The ISO Central Secretariat accepts no liability in this area. Adobe is a trademark of Adobe Systems Incorporated. Details of the software products used to create this PDF file can be found in the General Info relative to the file; the

4、PDF-creation parameters were optimized for printing. Every care has been taken to ensure that the file is suitable for use by ISO member bodies. In the unlikely event that a problem relating to it is found, please inform the Central Secretariat at the address given below. Adopted by INCITS (InterNat

5、ional Committee for Information Technology Standards) as an American National Standard. Date of ANSI Approval: 4/13/2007 Published by American National Standards Institute, 25 West 43rd Street, New York, New York 10036 Copyright 2007 by Information Technology Industry Council (ITI). All rights reser

6、ved. These materials are subject to copyright claims of International Standardization Organization (ISO), International Electrotechnical Commission (IEC), American National Standards Institute (ANSI), and Information Technology Industry Council (ITI). Not for resale. No part of this publication may

7、be reproduced in any form, including an electronic retrieval system, without the prior written permission of ITI. All requests pertaining to this standard should be submitted to ITI, 1250 Eye Street NW, Washington, DC 20005. Printed in the United States of America INCITS/ISO/IEC 19784-1:20062007 ITI

8、C 2007 All rights reserved iiiContents Page Foreword vi Introduction.vii 1 Scope1 2 Conformance .2 3 Normative references2 4 Terms and definitions .2 5 Symbols and abbreviated terms 7 6 The BioAPI architecture8 6.1 The BioAPI API/SPI Architectural Model.8 6.2 The BioAPI BSP Architectural Model 9 6.3

9、 The Component Registry10 6.4 BSP and BFP Installation and De-installation 11 6.5 BSP Load and BioAPI Unit Attachment 12 6.6 Controlling BioAPI Units.13 6.7 BIR Structure and Handling .13 6.7.1 BIR Structure .13 6.7.2 BIR Data Handling .14 7 BioAPI types and macros .15 7.1 BioAPI.15 7.2 BioAPI_BFP_L

10、IST_ELEMENT 15 7.3 BioAPI_BFP_SCHEMA15 7.4 BioAPI_BIR.16 7.5 BioAPI_BIR_ARRAY_POPULATION17 7.6 BioAPI_BIR_BIOMETRIC_DATA_FORMAT.17 7.7 BioAPI_BIR_BIOMETRIC_PRODUCT_ID.17 7.8 BioAPI_BIR_BIOMETRIC_TYPE.18 7.9 BioAPI_BIR_DATA_TYPE .18 7.10 BioAPI_BIR_HANDLE19 7.11 BioAPI_BIR_HEADER .19 7.12 BioAPI_BIR_

11、PURPOSE.20 7.13 BioAPI_BIR_SECURITY_BLOCK_FORMAT21 7.14 BioAPI_BIR_SUBTYPE21 7.15 BioAPI_BOOL 22 7.16 BioAPI_BSP_SCHEMA22 7.17 BioAPI_CANDIDATE23 7.18 BioAPI_CATEGORY 24 7.19 BioAPI_DATA.24 7.20 BioAPI_DATE .24 7.21 BioAPI_DB_ACCESS_TYPE .25 7.22 BioAPI_DB_MARKER_HANDLE.25 7.23 BioAPI_DB_HANDLE.25 7

12、.24 BioAPI_DBBIR_ID25 7.25 BioAPI_DTG .25 7.26 BioAPI_EVENT.26 7.27 BioAPI_EVENT_MASK 26 7.28 BioAPI_EventHandler26 7.29 BioAPI_FMR .27 7.30 BioAPI_FRAMEWORK_SCHEMA.27 7.31 BioAPI_GUI_BITMAP.28 INCITS/ISO/IEC 19784-1:20062007 iv ITIC 2007 All rights reserved7.32 BioAPI_GUI_MESSAGE 28 7.33 BioAPI_GUI

13、_PROGRESS . 29 7.34 BioAPI_GUI_RESPONSE 29 7.35 BioAPI_GUI_STATE 29 7.36 BioAPI_GUI_STATE_CALLBACK 29 7.37 BioAPI_GUI_STREAMING_CALLBACK 30 7.38 BioAPI_HANDLE . 30 7.39 BioAPI_IDENTIFY_POPULATION31 7.40 BioAPI_IDENTIFY_POPULATION_TYPE 31 7.41 BioAPI_INDICATOR_STATUS 31 7.42 BioAPI_INPUT_BIR . 31 7.4

14、3 BioAPI_INPUT_BIR_FORM 32 7.44 BioAPI_INSTALL_ACTION . 32 7.45 BioAPI_INSTALL_ERROR 32 7.46 BioAPI_OPERATIONS_MASK 32 7.47 BioAPI_OPTIONS_MASK . 33 7.48 BioAPI_POWER_MODE 34 7.49 BioAPI_QUALITY 34 7.50 BioAPI_RETURN . 35 7.51 BioAPI_STRING. 35 7.52 BioAPI_TIME 36 7.53 BioAPI_UNIT_ID 36 7.54 BioAPI_

15、UNIT_LIST_ELEMENT. 36 7.55 BioAPI_UNIT_SCHEMA 36 7.56 BioAPI_UUID . 38 7.57 BioAPI_VERSION 38 8 BioAPI functions. 39 8.1 Component Management Functions. 39 8.1.1 BioAPI_Init. 39 8.1.2 BioAPI_Terminate. 40 8.1.3 BioAPI_GetFrameworkInfo 41 8.1.4 BioAPI_EnumBSPs. 42 8.1.5 BioAPI_BSPLoad 43 8.1.6 BioAPI

16、_BSPUnload 45 8.1.7 BioAPI_BSPAttach 46 8.1.8 BioAPI_BSPDetach. 48 8.1.9 BioAPI_QueryUnits. 49 8.1.10 BioAPI_EnumBFPs. 51 8.1.11 BioAPI_QueryBFPs. 52 8.1.12 BioAPI_ControlUnit 54 8.2 Data Handle Operations . 55 8.2.1 BioAPI_FreeBIRHandle 55 8.2.2 BioAPI_GetBIRFromHandle. 56 8.2.3 BioAPI_GetHeaderFro

17、mHandle. 57 8.3 Callback and Event Operations. 58 8.3.1 BioAPI_EnableEvents 58 8.3.2 BioAPI_SetGUICallbacks . 59 8.4 Biometric Operations . 60 8.4.1 BioAPI_Capture. 60 8.4.2 BioAPI_CreateTemplate . 62 8.4.3 BioAPI_Process 64 8.4.4 BioAPI_ProcessWithAuxBIR . 65 8.4.5 BioAPI_VerifyMatch 67 8.4.6 BioAP

18、I_IdentifyMatch. 69 8.4.7 BioAPI_Enroll 72 8.4.8 BioAPI_Verify 74 8.4.9 BioAPI_Identify . 76 8.4.10 BioAPI_Import. 79 8.4.11 BioAPI_PresetIdentifyPopulation 80 INCITS/ISO/IEC 19784-1:20062007 ITIC 2007 All rights reserved v8.5 Database Operations.81 8.5.1 BioAPI_DbOpen.81 8.5.2 BioAPI_DbClose 83 8.5

19、.3 BioAPI_DbCreate.84 8.5.4 BioAPI_DbDelete .85 8.5.5 BioAPI_DbSetMarker.86 8.5.6 BioAPI_DbFreeMarker.87 8.5.7 BioAPI_DbStoreBIR.88 8.5.8 BioAPI_DbGetBIR89 8.5.9 BioAPI_DbGetNextBIR90 8.5.10 BioAPI_DbDeleteBIR.91 8.6 BioAPI Unit operations .92 8.6.1 BioAPI_SetPowerMode.92 8.6.2 BioAPI_SetIndicatorSt

20、atus.93 8.6.3 BioAPI_GetIndicatorStatus.94 8.6.4 BioAPI_CalibrateSensor .95 8.7 Utility Functions 96 8.7.1 BioAPI_Cancel.96 8.7.2 BioAPI_Free .97 9 BioAPI Service Provider Interface .98 9.1 Summary 98 9.2 Type Definitions for Biometric Service Providers .98 9.2.1 BioSPI_EventHandler98 9.2.2 BioSPI_B

21、FP_ENUMERATION_HANDLER .99 9.2.3 BioSPI_MEMORY_FREE_HANDLER .100 9.3 Biometric Service Provider Operations 101 9.3.1 SPI Component Management Operations.101 9.3.2 SPI Data Handle Operations.107 9.3.3 SPI Callback and Event Operations.108 9.3.4 SPI Biometric Operations .109 9.3.5 SPI Database Operati

22、ons112 9.3.6 SPI BioAPI Unit operations 114 9.3.7 SPI Utility Functions115 10 Component registry interface 116 10.1 BioAPI Registry Schema.116 10.1.1 Framework Schema.116 10.1.2 BSP Schema 117 10.1.3 BFP Schema.118 10.2 Component registry functions .119 10.2.1 BioAPI_Util_InstallBSP .119 10.2.2 BioA

23、PI_Util_InstallBFP .120 11 BioAPI error handling .121 11.1 Error Values and Error Codes Scheme.121 11.2 Error Codes and Error Value Enumeration.121 11.2.1 BioAPI Error Value Constants121 11.2.2 Implementation-Specific Error Codes.121 11.2.3 General Error Codes .121 11.2.4 Component Management Error

24、Codes123 11.2.5 Database Error Values 124 11.2.6 Location Error Values .125 11.2.7 Quality Error Codes.127 Annex A (normative) Conformance 128 Annex B (normative) CBEFF Patron Format Specification: BioAPI patron format140 Annex C (informative) Specification overview.145 Annex D (informative) Calling

25、 sequence examples and sample code 154 Bibliography167 INCITS/ISO/IEC 19784-1:20062007 vi ITIC 2007 All rights reservedForeword ISO (the International Organization for Standardization) and IEC (the International Electrotechnical Commission) form the specialized system for worldwide standardization.

26、National bodies that are members of ISO or IEC participate in the development of International Standards through technical committees established by the respective organization to deal with particular fields of technical activity. ISO and IEC technical committees collaborate in fields of mutual inte

27、rest. Other international organizations, governmental and non-governmental, in liaison with ISO and IEC, also take part in the work. In the field of information technology, ISO and IEC have established a joint technical committee, ISO/IEC JTC 1. International Standards are drafted in accordance with

28、 the rules given in the ISO/IEC Directives, Part 2. The main task of the joint technical committee is to prepare International Standards. Draft International Standards adopted by the joint technical committee are circulated to national bodies for voting. Publication as an International Standard requ

29、ires approval by at least 75 % of the national bodies casting a vote. Attention is drawn to the possibility that some of the elements of this document may be the subject of patent rights. ISO and IEC shall not be held responsible for identifying any or all such patent rights. ISO/IEC 19784-1 was pre

30、pared by Joint Technical Committee ISO/IEC JTC 1, Information technology, Subcommittee SC 37, Biometrics. ISO/IEC 19784 consists of the following parts, under the general title Information technology Biometric application programming interface: Part 1: BioAPI specification Part 2: Biometric archive

31、function provider interface This is the first ISO/IEC standard on BioAPI. Previous versions were published by ANSI and the BioAPI Consortium. As the last official non-ISO release was designated Version 1.1, this ISO/IEC 19784-1 version is designated Version 2.0. This is to distinguish the versions o

32、f BioAPI products in the marketplace. INCITS/ISO/IEC 19784-1:20062007 ITIC 2007 All rights reserved viiIntroduction This part of ISO/IEC 19784, the BioAPI specification, provides a high-level generic biometric authentication model suited to most forms of biometric technology. No explicit support for

33、 multimodal biometrics is currently provided. An architectural model is described which enables components of a biometric system to be provided by different vendors, and to interwork through fully-defined Application Programming Interfaces (APIs). A key feature of the architecture is the BioAPI Fram

34、ework, which supports calls by one or more application components (provided by different vendors, and potentially running concurrently) using the BioAPI API specification. The BioAPI Framework provides this support by invoking (through a Service Provider Interface, SPI) one or more biometric service

35、 provider (BSP) components (provided by different vendors, and potentially running concurrently) which can be dynamically loaded and invoked as required by an application component. At the lowest level there is hardware or software that performs biometric functions such as capture, matching, or arch

36、iving. These parts of the architecture are called BioAPI Units, and can be integral to a BSP or can be supplied as part of a separate BioAPI Function Provider (BFP) component. Interactions (through the BioAPI Framework) can occur between BSPs from different vendors provided data structures used to r

37、ecord information from the BioAPI Units they access conform to other International Standards, and in particular to ISO/IEC 19794 5. The final component of the BioAPI architecture is the recognition that a BSP can provide its biometric services either: a) by the use of BioAPI Units that are integral

38、to (that is, directly managed by) the BSP, or b) by invoking, through the BioAPI Function Provider Interface (FPI), one or more BFP components (provided by different vendors) that manage BioAPI Units that are integral to the BFP. NOTE: A BioAPI Unit may consist of software only, or a combination of

39、software and hardware (e.g., a biometric sensor, archive, or algorithm). For each type of BioAPI Unit supported by a BSP (or BFP) there may be one or more BioAPI Units of that type which can be dynamically inserted and removed from the system. Insertion and removal generates events that can be signa

40、lled (through the BSP and the BioAPI Framework) to an application. The BioAPI specification covers the basic biometric functions of Enrollment, Verification, and Identification (see Annex C), and includes a database interface to allow an application to manage the storage of biometric records through

41、 an archive BioAPI Unit managed by a BSP or BFP. This provides for optimum performance (e.g., when performing the biometric Identification function within a large population) of the archiving and biometric search processes. The interface to the application provides primitives that allow it to manage

42、 the capture of biometric samples from a biometric sensor by accessing the corresponding BioAPI Unit, and the use of those biometric samples for Enrollment (storage in an application-controlled or BSP-controlled BIR database), and subsequent Verification or Identification against those stored record

43、s. This part of ISO/IEC 19784 also specifies the content of a biometric component registry (information about the biometric components that have been installed on the biometric system). It also provides a component registry interface for the management and inspection of that registry. This part of I

44、SO/IEC 19784 uses the C programming language (see ISO/IEC 9899) to specify the data structures and function calls that form the BioAPI interfaces. INCITS/ISO/IEC 19784-1:20062007 viii ITIC 2007 All rights reservedClause 6 describes the BioAPI architectural model and its components, and the interface

45、s that are specified between these components. Clause 7 defines the data structures used in the BioAPI. Clause 8 defines the function calls initiated by an application and supported by a conforming BioAPI Framework that are either handled internally by the BioAPI Framework (for example enumeration o

46、f installed BioAPI components) or mapped to a function provided by a BSP. Clause 9 defines the function calls supported by a conforming BSP (and invoked by the BioAPI Framework in response to a call from a biometric application). Clause 10 specifies the form of the biometric component registry and t

47、he component registry interface. Clause 11 defines the handling of events and error returns. Annex A is normative, and specifies details of conformance requirements and proformas that can be used by the vendor of a BioAPI Biometric Application, Framework, or BSP component to identify those functions

48、 and biometric record formats that must be supported. NOTE: A future International Standard (ISO/IEC 24709) will address conformance testing for this BioAPI specification. 7 Annex B is normative, and specifies the BioAPI biometric information record (BIR) as a CBEFF Patron Format in accordance with

49、ISO/IEC 19785-1. It provides a description of the biometric record specified in this part of ISO/IEC 19784, together with the platform-independent bit-pattern representation of such a record for storage and transfer. Annex C is informative, and provides a general tutorial on a number of aspects of the BioAPI specification. Annex D is informative, and provides example code to illustrate calling sequences and to provide implementation guidance. AMERICAN NATIONAL STANDARD INCITS/ISO/IEC 19784-1:20062007 ITIC 2007 All rights reserv