1、ANSI INCITS 358-2002for Information Technology The BioAPI SpecificationANSIINCITS 358-2002American National Standardfor Information Technology The BioAPI SpecificationSecretariatInformation Technology Industry Council (ITI)Approved February 13, 2002American National Standards Institute, Inc.Approval
2、 of an American National Standard requires review by ANSI that therequirements for due process, consensus, and other criteria for approval havebeen met by the standards developer.Consensus is established when, in the judgement of the ANSI Board ofStandards Review, substantial agreement has been reac
3、hed by directly andmaterially affected interests. Substantial agreement means much more thana simple majority, but not necessarily unanimity. Consensus requires that allviews and objections be considered, and that a concerted effort be madetowards their resolution.The use of American National Standa
4、rds is completely voluntary; theirexistence does not in any respect preclude anyone, whether he has approvedthe standards or not, from manufacturing, marketing, purchasing, or usingproducts, processes, or procedures not conforming to the standards.The American National Standards Institute does not d
5、evelop standards andwill in no circumstances give an interpretation of any American NationalStandard. Moreover, no person shall have the right or authority to issue aninterpretation of an American National Standard in the name of the AmericanNational Standards Institute. Requests for interpretations
6、 should beaddressed to the secretariat or sponsor whose name appears on the titlepage of this standard.CAUTION NOTICE: This American National Standard may be revised orwithdrawn at any time. The procedures of the American National StandardsInstitute require that action be taken periodically to reaff
7、irm, revise, orwithdraw this standard. Purchasers of American National Standards mayreceive current information on all standards by calling or writing the AmericanNational Standards Institute.American National StandardPublished byAmerican National Standards Institute, Inc.25 West 43rd Street, New Yo
8、rk, NY 10036Copyright 2002 by Information Technology Industry Council (ITI)All rights reserved.No part of this publication may be reproduced in anyform, in an electronic retrieval system or otherwise,without prior written permission of ITI, 1250 Eye Street NW, Washington, DC 20005. Printed in the Un
9、ited States of AmericaCAUTION: The developers of this standard have requested that holders of patents that may berequired for the implementation of the standard disclose such patents to the publisher. However,neither the developers nor the publisher have undertaken a patent search in order to identi
10、fywhich, if any, patents may apply to this standard. As of the date of publication of this standardand following calls for the identification of patents that may be required for the implementation ofthe standard, no such claims have been made. No further patent search is conducted by the de-veloper
11、or publisher in respect to any standard it processes. No representation is made or impliedthat licenses are not required to avoid infringement in the use of this standard.iContentsPageForeword v1 Specification Overview . 11.1 Purpose 11.2 Scope . 11.3 Application Level API 11.4 Biometric Technology
12、. 21.5 BIRs and Templates. 31.6 The API Model 41.7 FAR and FRR. 81.8 Payloads. 81.9 BIR Databases . 81.10 User Interface Considerations 91.11 Module Registry 92 BioAPI - API Definition 112.1 BioAPI Data Structures 112.1.1 BioAPI 112.1.2 BioAPI_BIR 112.1.3 BioAPI_BIR_ARRAY_POPULATION 112.1.4 BioAPI_B
13、IR_AUTH_FACTORS. 112.1.5 BioAPI_BIR_BIOMETRIC_DATA 122.1.6 BioAPI_BIR_BIOMETRIC_DATA_FORMAT . 122.1.7 BioAPI_BIR_DATA_TYPE. 122.1.8 BioAPI_BIR_HANDLE . 122.1.9 BioAPI_BIR_HEADER. 132.1.10 BioAPI_BIR_PURPOSE 132.1.11 BioAPI_BIR_VERSION 142.1.12 BioAPI_BOOL 142.1.13 BioAPI_BSP_SCHEMA . 142.1.14 BioAPI
14、_BSP_SCHEMA_ARRAY. 142.1.15 BioAPI_CANDIDATE . 142.1.16 BioAPI_CANDIDATE_ARRAY. 152.1.17 BioAPI_DATA 152.1.18 BioAPI_DB_ACCESS_TYPE. 152.1.19 BioAPI_DB_CURSOR . 152.1.20 BioAPI_DB_HANDLE 152.1.21 BioAPI_DBBIR_ID . 162.1.22 BioAPI_DEVICE_ID. 162.1.23 BioAPI_DEVICE_SCHEMA . 162.1.24 BioAPI_FAR. 162.1.
15、25 BioAPI_FRR. 162.1.26 BioAPI_FUNC_NAME_ADDR . 172.1.27 BioAPI_GUI_BITMAP 172.1.28 BioAPI_GUI_MESSAGE 172.1.29 BioAPI_GUI_PROGRESS . 172.1.30 BioAPI_GUI_RESPONSE 172.1.31 BioAPI_GUI_STATE 172.1.32 BioAPI_GUI_STATE_CALLBACK . 182.1.33 BioAPI_GUI_STREAMING_CALLBACK . 18iiPage2.1.34 BioAPI_HANDLE . 19
16、2.1.35 BioAPI_H_LEVEL_FRAMEWORK_SCHEMA. 192.1.36 BioAPI_IDENTIFY_POPULATION 192.1.37 BioAPI_IDENTIFY_POPULATION_TYPE. 192.1.38 BioAPI_INPUT_BIR . 192.1.39 BioAPI_INPUT_BIR_FORM 202.1.40 BioAPI_MEMORY_FUNCS . 202.1.41 BioAPI_ModuleEventHandler 202.1.42 BioAPI_MODULE_EVENT 212.1.43 BioAPI_MODULE_EVENT
17、_MASK 212.1.44 BioAPI_POWER_MODE . 212.1.45 BioAPI_PROC_ADDR . 222.1.46 BioAPI_QUALITY 222.1.47 BioAPI_RETURN. 232.1.48 BioAPI_SERVICE_UID 232.1.49 BioAPI_STREAM_CALLBACK 242.1.50 BioAPI_STRING 242.1.51 BioAPI_UUID . 242.1.52 BioAPI_VERSION 242.2 BioAPI Registry Schema . 262.2.1 Data Definitions . 2
18、62.2.1.1 BioAPI_OPERATIONS_MASK 262.2.1.2 BioAPI_OPTIONS_MASK . 262.2.2 Component Schema 282.2.2.1 Framework Schema. 282.2.2.2 BSP Schema . 282.2.2.3 Biometric Device Schema 292.3 BioAPI ERROR-HANDLING 302.3.1 Error Values and Error Codes Scheme . 302.3.2 Error Codes and Error Value Enumeration 302.
19、3.2.1 Configurable BioAPI Error Code Constants. 302.3.2.2 BioAPI Error Code Constants 312.3.2.3 General Error Values . 312.3.2.4 Common Error Codes For All Module Types. 312.3.3 H-Framework Errors 322.3.3.1 H-Framework Error Values derived from the Common Error Codes . 322.3.3.2 H-Framework-specific
20、 Error Values. 332.3.4 BSP Errors. 332.3.4.1 BSP Error Values derived from the Common Error Codes 332.3.4.2 BSP-specific Error Values . 342.4 Framework Operations 362.4.1 BioAPI_Init . 362.4.2 BioAPI_Terminate 372.4.3 BioAPI_EnumModules. 382.4.4 BioAPI_ModuleLoad 392.4.5 BioAPI_ModuleUnload. 402.4.6
21、 BioAPI_ModuleAttach 412.4.7 BioAPI_ModuleDetach. 432.4.8 BioAPI_QueryDevice . 442.5 BSP Operations . 452.5.1 Handle Operations. 452.5.1.1 BioAPI_FreeBIRHandle . 45iiiPage2.5.1.2 BioAPI_GetBIRFromHandle. 462.5.1.3 BioAPI_GetHeaderFromHandle. 472.5.2 Callback and Event Operations 482.5.2.1 BioAPI_Ena
22、bleEvents 482.5.2.2 BioAPI_SetGUICallbacks. 492.5.2.3 BioAPI_SetStreamCallback . 502.5.2.4 BioAPI_StreamInputOutput 512.5.3 Biometric Operations 522.5.3.1 BioAPI_Capture . 522.5.3.2 BioAPI_CreateTemplate 532.5.3.3 BioAPI_Process . 542.5.3.4 BioAPI_VerifyMatch . 552.5.3.5 BioAPI_IdentifyMatch. 572.5.
23、3.6 BioAPI_Enroll. 592.5.3.7 BioAPI_Verify. 602.5.3.8 BioAPI_Identify. 622.5.3.9 BioAPI_Import 642.5.3.10 BioAPI_SetPowerMode 652.5.4 Database Operations . 662.5.4.1 BioAPI_DbOpen. 662.5.4.2 BioAPI_DbClose 672.5.4.3 BioAPI_DbCreate. 682.5.4.4 BioAPI_DbDelete . 692.5.4.5 BioAPI_DbSetCursor . 702.5.4.
24、6 BioAPI_DbFreeCursor . 712.5.4.7 BioAPI_DbStoreBIR. 722.5.4.8 BioAPI_DbGetBIR 732.5.4.9 BioAPI_DbGetNextBIR 742.5.4.10 BioAPI_DbQueryBIR 752.5.4.11 BioAPI_DbDeleteBIR . 763 BioAPI Service Provider Interface 773.1 Summary 773.2 Data Structure for Service Providers 783.2.1 BioSPI_ModuleEventHandler.
25、783.2.2 BioAPI_MODULE_FUNCS 783.2.3 BSP Function Pointer Table. 793.2.4 BioAPI_UPCALLS 823.3 Service Provider Operations 843.3.1 Module Management Operations. 843.3.1.1 BioSPI_ModuleLoad 843.3.1.2 BioSPI_ModuleUnload. 853.3.1.3 BioSPI_ModuleAttach 863.3.1.4 BioSPI_ModuleDetach. 883.3.2 Handle Operat
26、ions . 893.3.2.1 BioSPI_FreeBIRHandle . 893.3.2.2 BioSPI_GetBIRFromHandle. 893.3.2.3 BioSPI_GetHeaderFromHandle. 893.3.3 Callback and Event Operations 903.3.3.1 BioSPI_EnableEvents 903.3.3.2 BioSPI_SetGUICallbacks. 903.3.3.3 BioSPI_SetStreamCallback . 90ivPage3.3.3.4 BioSPI_StreamInputOutput . 903.3
27、.4 Biometric Operations . 913.3.4.1 BioSPI_Capture . 913.3.4.2 BioSPI_CreateTemplate 913.3.4.3 BioSPI_Process. 913.3.4.4 BioSPI_VerifyMatch. 913.3.4.5 BioSPI_IdentifyMatch 913.3.4.6 BioSPI_Enroll. 923.3.4.7 BioSPI_Verify. 923.3.4.8 BioSPI_Identify 923.3.4.9 BioSPI_Import 923.3.4.10 BioSPI_SetPowerMo
28、de . 933.3.5 Database Operations. 943.3.5.1 BioSPI_DbOpen 943.3.5.2 BioSPI_DbClose 943.3.5.3 BioSPI_DbCreate 943.3.5.4 BioSPI_DbDelete. 943.3.5.5 BioSPI_DbSetCursor . 943.3.5.6 BioSPI_DbFreeCursor . 943.3.5.7 BioSPI_DbStoreBIR. 953.3.5.8 BioSPI_DbGetBIR . 953.3.5.9 BioSPI_DbGetNextBIR 953.3.5.10 Bio
29、SPI_DbQueryBIR . 953.3.5.11 BioSPI_DbDeleteBIR. 95AnnexesA Conformance 96B HA-API Compatibility 104vForeword (This foreword is not part of ANSI INCITS 358-2002.)The BioAPI Consortium was formed to develop a widely available and widely accept-ed API that will serve for various biometric technologies.
30、 The BioAPI Consortium firstannounced its formation and intent to develop a biometric API standard in April of1998. By the end of the year, this Consortium had developed a multi-level API archi-tecture and begun defining the associated components. In December 1998, I/O Soft-ware joined the Consortiu
31、m and it was decided that the BAPI specification would beintegrated as the lower level of the BioAPI specification. In March of 1999, the Information Technology Laboratory (ITL) of the National Insti-tute of Standards and Technology (NIST) and the US Biometric Consortium spon-sored a unification mee
32、ting in which the Human Authentication API (HA-API) workinggroup (which had published a high level biometric API in 1997) agreed to merge theiractivities with the BioAPI Consortium. As part of this agreement, the BioAPI Consor-tium agreed to restructure their organization.In March 2000, Version 1.0
33、of the BioAPI Specification was released. This was fol-lowed on April 6th by a BioAPI Users and Developers Seminar, sponsored by NISTand the National Security Agency (NSA) and hosted by the Biometric Consortium(www.biometrics.org). In September 2000, the beta version of the BioAPI ReferenceImplement
34、ation was released.The BioAPI was originally conceived by its founders as a multi-level API, and was theinitial framework for discussion when the BioAPI, HA-API and BAPI were merged.The “high level“ would include basic calls (e.g., enroll, verify, etc.) that would satisfythe requirements of most app
35、lications. Lower levels would address increasing detail,control, sophistication, and technology dependence. In 1999, the group determinedto focus on 2 levels - the high (H) level and the lower (D, device) level. The high leveldefinition would comprise the best of HA-API, BioAPI Level H, and BAPI Lev
36、el 3.The device level would be based on BAPI Level 1 (and some of Level 2). Workinggroups (the AWG - Applications Working Group, and DWG - Device Working Group)were formed to define these levels. The AWG, with participation from members rep-resenting technology vendors, integrators and end users, su
37、cceeded in defining ahigh level interface that satisfied the known requirements of all the participants. Onthe other hand, proposals for interfaces at lower levels, when studied by the member-ship as a whole, were not believed to address issues that were broad enough, acrossthe biometrics industry,
38、to justify inclusion in the standard API.So, in late 1999, it was decided that BioAPI Version 1.0, with its single layer, provideda sufficiently comprehensive and rich feature set that would address the significantmarket requirements for a generalized API, and Version 1.0 was voted on by themembers
39、and published in March 2000.This standard contains two informative annexes, which are not considered part of thestandard.Requests for interpretation, suggestions for improvement or addenda, or defect re-ports are welcome. They should be sent to the InterNational Committee for Informa-tion Technology
40、 Standards, 1250 Eye Street, NW, Suite 200, Washington, DC20005.viThis standard was processed and approved for submittal to ANSI by INCITS. Com-mittee approval of the standard does not necessarily imply that all committee mem-bers voted for approval. At the time it approved this standard, INCITS had
41、 thefollowing members:Karen Higginbottom, ChairRuss Richards, Vice-ChairJennifer Garner, SecretaryOrganization Represented Name of RepresentativeApple Computer, Inc. David MichaelWanda Cox (Alt.)Hewlett-Packard Company. Karen HigginbottomScott Jameson (Alt.)Steve Mills (Alt.)Hitachi America, Ltd Joh
42、n NeumannHarukazu Miyamoto (Alt.)IBM Corporation Ronald F. SillettiChuck Adams (Alt.)Institute for Certification of Computer Professionals. Kenneth M. ZemrowskiThomas Kurihara (Alt.)Microsoft Corporation . Mike KsarJoseph Zajaczkowski (Alt.)National Institute of Standards one suited for any form of
43、biometric technology. It covers the basic functions of Enrollment, Verification, and Identification, and includes a database interface to allow a biometric service provider (BSP) to manage the Identification population for optimum performance. It also provides primitives that allow the application t
44、o manage the capture of samples on a client, and the Enrollment, Verification, and Identification on a server. 1.2 Scope This specification defines the Application Programming Interface and Service Provider Interface for a standard biometric technology interface. It is beyond the scope of this speci
45、fication to define security requirements for biometric applications and service providers, although some related information is included by way of explanation of how the API is intended to support good security practices. 1.3 Application Level API The Application Level (formerly referred to as Level
46、 H) is the “top“ level at which the basic biometric functions are implemented - those which an application would generally use to incorporate biometric capabilities for the purpose of human identification. The top-level functions are derived from a merging from the following sources: HA-API 2.0, dat
47、ed 22 Apr 98, plus proposed extensions from draft Version 2.02, dated 17 Feb 99 Draft BioAPI Level H Reference Manual, dated 25 Feb 99 BAPI SDK Version 1.1, High Level API - Level 3, dated 1 Jun 98 Draft BioAPI/UAS Specification Release 1.0 Version 1.2, dated April 99 It is intended that the applica
48、tion level API contain all those functions required by an application for biometric authentication. Therefore, to the extent possible, the amount of optional functionality is kept to a minimum. The major optional function is Identify; only specialized BSPs will implement this function for large popu
49、lations, and the database capability is in the interface primarily to allow the BSP to manage these large populations. The approach taken is to hide, to the degree possible, the unique aspects of individual biometric technologies, and particular vendor implementations, products, and devices, while providing a high-level abstraction that can be used within a number of potential software applications. Access to the biometric mechanisms is through the set of standard interfaces defined in this document. Theoretically, BSPs supplied by vendors ANSI INCITS 358-20022 conforming to th
