ISO/IEC 30106-3:2016

INTERNATIONAL ISO/IEC
STANDARD 30106-3
First edition
2016-03-15
Information technology — Object
oriented BioAPI —
Part 3:
C# implementation
Technlogies de l’information — Objet orienté BioAPI —
Partie 3: Mise en oeuvre de C#
Reference number
©
ISO/IEC 2016
© ISO/IEC 2016, Published in Switzerland
All rights reserved. Unless otherwise specified, no part of this publication may be reproduced or utilized otherwise in any form
or by any means, electronic or mechanical, including photocopying, or posting on the internet or an intranet, without prior
written permission. Permission can be requested from either ISO at the address below or ISO’s member body in the country of
the requester.
ISO copyright office
Ch. de Blandonnet 8 • CP 401
CH-1214 Vernier, Geneva, Switzerland
Tel. +41 22 749 01 11
Fax +41 22 749 09 47
copyright@iso.org
www.iso.org
ii © ISO/IEC 2016 – All rights reserved

Contents Page
Foreword .vi
Introduction .vii
1 Scope . 1
2 Normative references . 1
3 BioAPI C# namespace structure . 1
3.1 Overall structure . 1
3.2 Namespace BioAPI . 1
3.2.1 Namespace description . 1
3.2.2 Structure . 1
3.3 Namespace BioAPI.Data . 2
3.3.1 Namespace description . 2
3.3.2 Structure . 2
4 Data types and constants . 2
4.1 Class ACBioParameters . 2
4.1.1 Description . . . 2
4.1.2 Properties summary . 2
4.2 Class BFPListElement . . 2
4.2.1 Description . . . 2
4.2.2 Properties summary . 2
4.3 Class BFPSchema [Serializable()] . 3
4.3.1 Description . . . 3
4.3.2 Properties summary . 3
4.3.3 Method summary . 3
4.4 Class BIR . 3
4.4.1 Description . . . 3
4.4.2 Properties summary . 4
4.4.3 Method summary . 5
4.5 Class BSPSchema [Serializable()] . 5
4.5.1 Description . . . 5
4.5.2 Properties summary . 6
4.5.3 Method summary . 7
4.6 Class Candidate . 7
4.6.1 Description . . . 7
4.6.2 Properties summary . 7
4.7 Class DataTypes . 7
4.7.1 Description . . . 7
4.7.2 Enumerations . 8
4.8 Class date .14
4.8.1 Description . . .14
4.8.2 Properties summary .15
4.8.3 Methods summary .15
4.9 Class FrameworkSchema .15
4.9.1 Description . . .15
4.9.2 Properties summary .15
4.9.3 Method summary .16
4.10 Class GUIBitmap .16
4.10.1 Description . . .16
4.10.2 Properties .16
4.10.3 Method summary .16
4.11 Class Identifypopulation .17
4.11.1 Description . . .17
4.11.2 Properties summary .17
4.11.3 Method summary .17
© ISO/IEC 2016 – All rights reserved iii

4.12 Class PopulationMember .17
4.12.1 Description . . .17
4.12.2 Properties summary .17
4.13 Class RegistryID .18
4.13.1 Description . . .18
4.13.2 Properties summary .18
4.14 Class SecurityProfileType .18
4.14.1 Description . . .18
4.14.2 Properties summary .18
4.14.3 Method summary .18
4.15 Class UnitList .19
4.15.1 Description . . .19
4.15.2 Properties summary .19
4.15.3 Methods summary .19
4.16 Class UnitListElement .19
4.16.1 Description . . .19
4.16.2 Properties summary .19
4.17 Class UnitSchema .19
4.17.1 Description . . .19
4.17.2 Properties summary .20
4.17.3 Method summary .20
4.18 Class UUID [Serializable()] .20
4.18.1 Description . . .20
4.18.2 Properties .21
5 Object-oriented interfaces for supporting BioAPI_Units .21
5.1 General .21
5.2 Interface IArchive .21
5.2.1 Description . . .21
5.2.2 Method summary .22
5.3 Interface IComparison .24
5.3.1 Description . . .24
5.3.2 Method summary .25
5.4 Interface IProcessing .27
5.4.1 Description . . .27
5.4.2 Method summary .28
5.5 Interface ISensor .29
5.5.1 Description . . .29
5.5.2 Method summary .29
6 BFP level .30
6.1 Interface IBFP .30
6.1.1 Description . . .30
6.1.2 Imported interfaces .30
6.1.3 Properties summary .30
6.1.4 Events summary .30
6.1.5 Method summary .31
7 BSP level .33
7.1 Interface IBSP .33
7.1.1 Description . . .33
7.1.2 Imported interfaces .33
7.1.3 Properties summary .33
7.1.4 Events summary .33
7.1.5 Method summary .33
8 Framework level .40
8.1 Interface IComponentRegistry .40
8.1.1 Description . . .40
8.1.2 Method summary .41
iv © ISO/IEC 2016 – All rights reserved

8.2 Interface IFramework .42
8.2.1 Description . . .42
8.2.2 Inherited interfaces .42
8.2.3 Properties summary .42
8.2.4 Method summary .43
9 Application interaction .47
9.1 Class BioAPIException: Exception .47
9.1.1 Description . . .47
9.1.2 Constructor summary .48
9.1.3 Properties summary .48
9.1.4 Method summary .49
9.2 Callback functions .49
9.2.1 Description . . .49
9.2.2 Callback functions specification .50
Annex A (informative) Calling sequence examples and sample code .55
Bibliography .56
© ISO/IEC 2016 – All rights reserved v

Foreword
ISO (the International Organization for Standardization) and IEC (the International Electrotechnical
Commission) form the specialized system for worldwide standardization. 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 interest. 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.
The procedures used to develop this document and those intended for its further maintenance are
described in the ISO/IEC Directives, Part 1. In particular the different approval criteria needed for
the different types of document should be noted. This document was drafted in accordance with the
editorial rules of the ISO/IEC Directives, Part 2 (see www.iso.org/directives).
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. Details of any patent rights identified during the development of the document will be in the
Introduction and/or on the ISO list of patent declarations received (see www.iso.org/patents).
Any trade name used in this document is information given for the convenience of users and does not
constitute an endorsement.
For an explanation on the meaning of ISO specific terms and expressions related to conformity
assessment, as well as information about ISO’s adherence to the WTO principles in the Technical
Barriers to Trade (TBT) see the following URL: Foreword - Supplementary information
The committee responsible for this document is ISO/IEC JTC 1, Information technology, SC 37, Biometrics.
ISO/IEC 30106 consists of the following parts, under the general title Information technology — Object-
oriented BioAPI:
— Part 1: Architecture
— Part 2: Java implementation
— Part 3: C# implementation
vi © ISO/IEC 2016 – All rights reserved

Introduction
In this part of ISO/IEC 30106, an application programming interface expressed in C# language is
specified. C# is intended to be a simple, general-purpose, object-oriented programming language that
is aimed at enabling programmers to quickly build a wide range of applications for the Microsoft .NET
platform.
One of the advantages of using C# is that, as it is designed for the Common Language Infrastructure
(CLI), it allows multiple high-level languages to be used on different computer platforms without being
rewritten for specific architectures.
C# shares some features (overloading, some syntactic details, etc.) with C++ but includes new
characteristics (reference and output parameters, enumerations, unified type system, etc.). Besides, C#
is very similar to Java (interfaces, exceptions, object-orientation, etc.), which implies that the structure
of interfaces and namespaces (which is the equivalent to packages in Java language) is mostly the same
as Java but, as expected, code implementation and compilation are different.
As Java implementation allows an easy use of Java BSPs, Java-based application servers or Java applets,
C# is the best way to write windows desktop and web applications/services and provides an advanced
and well-designed remote framework.
© ISO/IEC 2016 – All rights reserved vii

INTERNATIONAL STANDARD ISO/IEC 30106-3:2016(E)
Information technology — Object oriented BioAPI —
Part 3:
C# implementation
1 Scope
This part of ISO/IEC 30106 specifies an interface of a BioAPI C# framework and BioAPI C# BSP which
will mirror the corresponding components specified in ISO/IEC 30106-1. The semantic equivalence of
this part of ISO/IEC 30106 will be maintained with ISO/IEC 30106-2 (Java implementation). In spite of
the differences in actual parameters passed between functions, the names and interface structure are
the same.
2 Normative references
The following documents, in whole or in part, are normatively referenced in this document and are
indispensable for its application. For dated references, only the edition cited applies. For undated
references, the latest edition of the referenced document (including any amendments) applies.
ISO/IEC 30106-1, Information technology — BioAPI for object oriented programming languages — Part 1:
Architecture
3 BioAPI C# namespace structure
3.1 Overall structure
The BioAPI C# interface will be divided into several namespaces. The following are the namespace
structure:
— namespace BioAPI: contains functionality to manage units, BSPs, BFPs, the framework and
applications;
— namespace BioAPI.Data: contains all the data structures.
3.2 Namespace BioAPI
3.2.1 Namespace description
This namespace contains all the components responsible for managing and executing the functionality
of BioAPI. Component registry interface is also defined in this namespace.
3.2.2 Structure
The description of this namespace is given explaining a bottom-up structure. In Clause 4, the interfaces
needed to be implemented for each of the unit types are explained. It is important to note that such
interfaces do not refer to an implemented class by itself, as the accessible class will be either the
Biometric Service Provider (BSP) or the Biometric Function Provider (BFP), but the specifications in
such clause are common to the methods and properties to be added to the implemented BSP and/or BFP
classes.
© ISO/IEC 2016 – All rights reserved 1

This will be followed by the specification of the implementation of the BFP (Clause 5) and BSP (Clause
6) interfaces. These two interfaces provide the lower layer interoperability level, equivalent to the SPI
and BFPI interfaces in ISO/IEC 19784-1.
The higher layer of interoperability level is provided by the specification of the framework (Clause 7,
with the framework interface and the component registry) and the application interaction (Clause 8,
with the specification of the exceptions and callback functions). This provides the equivalence to the
API interface in ISO/IEC 19784-1.
3.3 Namespace BioAPI.Data
3.3.1 Namespace description
This namespace contains all data structures needed for the implementation of OO BioAPI.
3.3.2 Structure
Several data structures are provided to comply with the requirements of specifying this part of
ISO/IEC 30106. All the BioAPI.Data namespace is specified in Clause 3, where all needed classes and
enumerations are defined. This has to be complemented to the constants defined in ISO/IEC 30106-1.
4 Data types and constants
4.1 Class ACBioParameters
4.1.1 Description
Structure provides the information which is used to generate ACBio instances.
4.1.2 Properties summary
— int[] Challenge {get;}: Challenge from the validator of a biometric verification when ACBio is
used. This value shall be sent to the field controlValue of type ACBioContentInformation in ACBio
instances.
— int[] InitialBPUIOIndexOutput {get;}: The initial value of BPU IO index which is to be assigned to the
output from the BioAPI unit, BFP or BSP when the ACBio instances are generated. The range between
InitialBPUIOIndexOutput and SupremumBPUIOIndexOutput shall be divided into the number of BSP
units and BFPs which are accepted by the BSP and assigned to the BSP units and BSPs.
— int[] SupremumBPUIOIndexOutput {get;}: The supremum of BPU IO indexes which are to be assigned
to the output from the BioAPI unit, BFP or BSP when the ACBio instances are generated.
4.2 Class BFPListElement
4.2.1 Description
Identifies a BFP by category and UUID. A list is returned by a BSP when queried for the installed BFPs
that it supports.
4.2.2 Properties summary
— UnitCategoryType UnitCategory {get; set;}: The category of the unit.
— UUID BFPID {get; set;}: The UUID assigned to the BFP.
2 © ISO/IEC 2016 – All rights reserved

4.3 Class BFPSchema [Serializable()]
4.3.1 Description
Represents the record in the component registry that defines the properties of the BFP installed in the
system. Is a serializable class.
4.3.2 Properties summary
— UUID BFPUUID {get;}: UUID of the BFP.
— UnitCategoryType BFPCategory {get;}: Category of the BFP identified by the BFPUUID.
— String BFPDescription {get;}: A NULL-terminated string containing a text description of the BFP.
— String Path {get;}: A pointer to a NULL-terminated string containing the path of the file containing
the BFP executable code, including the filename. The path may be a URL. This string shall consist of
ISO/IEC 10646 characters encoded in UTF-8 (see ISO/IEC 10646:2014, Annex D). When BFPSchema
is used within a function call, the component that receives the call allocates the memory for the path
schema element and the calling component frees the memory.
— String SpecVersion {get;}: Major/minor version number of the BioAPI specification to which the BFP
was implemented.
— String ProductVersion {get;}: The version string of the BFP software.
— String Vendor {get;}: A NULL-terminated string containing the name of the BFP vendor.
— sbyte[] BFPProperty {get;}
— List BFPSupportedFormats {get;}: A list of the data formats that are supported by the
BFP (see 6.1).
— List FactorsMask {get;}: A list of the biometric types supported by the BFP (see 6.1).
— UUID FwPropertyID {get;}: UUID of the format of the following BFP property.
— byte[] FwProperty {get;}: Address and length of a memory buffer containing the BFP property. The
format and content of the BFP property can either be specified by a vendor or can be specified in a
related standard.
4.3.3 Method summary
4.3.3.1  virtual void Dispose ()
Description: Removes all the information in the current object, leaving it empty for a next use
Exception: None
4.4 Class BIR
4.4.1 Description
This interface represents Biometric Information Records (BIRs). It supports ISO/IEC 19785 definitions,
both for simple BIRs or for complex BIRs. The specification of the patron format that shall be used is
given in ISO/IEC 30106-1.
© ISO/IEC 2016 – All rights reserved 3

4.4.2 Properties summary
NOTE The description of each of the properties can be found in ISO/IEC 19785-1.
— RegistryID SelfID {get; set;} (see 4.13)
— byte CBEFFVersion {get; set;}
— byte PatronHeaderVersion {get; set;}
— RegistryID BDBFormat {get; set;} (see 4.13)
— bool BDBEncription {get; set;}
— bool BIRIntegrity {get; set;}
— BiometricType BDBBiometricType {get; set;} (see 4.7.2.2)
— BiometricSubtype BDBBiometricSubtype {get; set;} (see 4.7.2.1)
— RegistryID BDBCaptureDevice {get; set;} (see 4.13)
— RegistryID BDBFeatureExtractionAlg {get; set;} (see 4.13)
— RegistryID BDBComparisonAlg {get; set;} (see 4.13)
— RegistryID BDBCompresionAlg {get; set;} (see 4.13)
— RegistryID BDBPADTechnique {get; set;} (see 4.13)
— byte[] BDBChallengeResponse {get; set;}
— Date BDBCreationDate {get; set;} (see 4.8)
— byte[] BDBIndex {get; set;}
— ProcessedLevel BDBProcessedLevel {get; set;}
— RegistryID BDBProduct {get; set;} (see 4.13)
— Purpose BDBPurpose {get; set;}
— byte BDBQuality {get; set;}
— RegistryID BDBQualityAlg {get; set;} (see 4.13)
— List BDBValidityPeriod {get; set;} // 2 dates (see 4.8)
— Date BIRCreationDate {get; set;} (see 4.8)
— byte[] BIRCreator {get; set;}
— byte[] BIRIndex {get; set;}
— byte[] BIRPayload { get; set;}
— byte[] BIRPointer {get; set;}
— List BIRValidityPeriod { get; set; } // 2 dates (see 4.8)
— RegistryID SBFormat {get; set;} (see 4.13)
— byte[] BDBData {get; set;}
— byte[] SBData {get; set;}
4 © ISO/IEC 2016 – All rights reserved

4.4.3 Method summary
4.4.3.1  virtual BIR (byte[] record)
Description: Constructs the BIR data from a byte array coded as an ISO/IEC 19785
self-identifying record
Parameters: record: The byte array containing the CBEFF record
Exception: If the input parameters are invalid, the format is not supported or operation fails
due to error.
BioAPIException (see 9.1)
4.4.3.2  virtual BIR (RegistryID bDBFormat, bool bDBEncription, bool bIRIntegrity, Biome-
tricType bDBBiometricType, BiometricSubtype bDBBiometricSubtype, RegistryID bDBCap-
tureDevice, RegistryID bDBFeatureExtractionAlg, RegistryID bDBComparisonAlg, RegistryID
bDBCompresionAlg, RegistryID bDBPADTechnique, byte[] bDBChallengeResponse, Date bDB-
CreationDate, byte[] bDBIndex, ProcessedLevel bDBProcessedLevel, RegistryID bDBProduct,
Purpose bDBPurpose, byte bDBQuality, RegistryID bDBQualityAlg, List bDBValidityPer-
iod, Date bIRCreationDate, byte[] bIRCreator, byte[] bIRIndex, byte[] bIRPayload, byte[] bIR-
Pointer, List bIRValidityPeriod, RegistryID sBFormat, byte[] bDBData, byte[] sBData)
Description: Constructs the BIR data from its individual components
Parameters: Each of the properties in the BIR class
Exception: If the input parameters are invalid, the format is not supported or operation fails
due to error.
BioAPIException (see 9.1)
4.4.3.3  virtual public byte[] ToArray()
Description: Serializes a BIR record so as to provide it as a byte array representing the CBEFF
information
Return value: The byte array containing the CBEFF information
Exception: If the input parameters are invalid, the format is not supported or operation fails
due to error.
BioAPIException (see 9.1)
4.4.3.4  virtual void Dispose ()
Description: Removes all the information in the current BIR, leaving it empty for a next use
Exception: None
4.5 Class BSPSchema [Serializable()]
4.5.1 Description
Represents the record in the component registry that defines the properties of the BSP installed in the
system. Is a serializable class.
© ISO/IEC 2016 – All rights reserved 5

4.5.2 Properties summary
— UUID BSPUUID {get;}
— String BSPDescription {get;}: A NULL-terminated string containing a text description of the BSP.
— String Path {get;}: A pointer to a NULL-terminated string containing the path of the file containing
the BSP executable code, including the filename. The path may be a URL. This string shall consist
of ISO/IEC 10646 characters encoded in UTF-8 (see ISO/IEC 10646, Annex D). When BioAPI_BSP_
SCHEMA is used within a function call, the component that receives the call allocates the memory
for the path schema element and the calling component frees the memory.
— String SpecVersion {get;}: Major/minor version number of the BioAPI specification to which the BSP
was implemented.
— String ProductVersion {get;}: The version string of the BSP software.
— String Vendor {get;}: A NULL-terminated string containing the name of the BSP vendor.
— List BSPSupportedFormats {get;}: A list of the data formats that are supported by the
BSP (see 4.13).
— List FactorsMask {get;}: A list of the biometric types supported by the BSP (see
4.7.2.2).
— List Operations {get;}: A list of the biometric operations supported by the
BSP (see 4.7.2.4).
— List Options {get;}: A list of the biometric options supported by the BSP (see
4.7.2.5).
— int AdditionalDataPolicy {get;}: Threshold setting (maximum FMR value) used to determine when
to release additionalData after successful verification.
— int MaxAdditionalDataSize {get;}: Maximum additionalData size (in bytes) that the BSP can accept.
— int DefaultVerifyTimeout {get;}: Default timeout value, in milliseconds, used by the BSP for Verify
operations when no timeout is specified by the application.
— int DefaultIdentifyTimeout {get;}: Default timeout value, in milliseconds, used by the BSP for Identify
and BioAPI_IdentifyMatch operations when no timeout is specified by the application.
— int DefaultCaptureTimeout {get;}: Default timeout value, in milliseconds, used by the BSP for Capture
operations when no timeout is specified by the application.
— int DefaultEnrolTimeout {get;}: Default timeout value, in milliseconds, used by the BSP for Enrol
operations when no timeout is specified by the application.
— int DefaultCalibrateTimeout {get;}: Default timeout value, in milliseconds, used by the BSP for sensor
calibration operations when no timeout is specified by the application.
— int MaxBSPDbSize {get;}: Maximum size of a BSP-controlled BIR database. It applies only when
a BSP is only capable of directly managing a single archive unit. A value of zero means that no
information about the database size is being provided for one of the following three reasons: a)
databases are not supported; b) it is capable of managing multiple units (either directly or through
a BFP interface), each of which may have a different maximum size, and information about these
units will be provided as part of the insert notification (part of Unit Schema); or c) one archive unit
is supported, but the information is not given here; it will be provided in the insert notification.
— int MaxIdentify {get;}: Largest population supported by the identify function. Unlimited = 0xFFFFFFFF
6 © ISO/IEC 2016 – All rights reserved

— int MaxNumEnrolInstances {get;}: The maximum number of distinct instances that a BSP can create
reference templates for in one enrol operation. This information can be useful to an application that
uses the application-controlled GUI feature.
— byte[] HostingEndpointIRI {get;}: An IRI identifying the framework whose component registry
contains a registration of the BSP. This parameter shall be ignored by frameworks conforming to
this part of ISO/IEC 30106 and shall be set to NULL by an application. It is provided to support
interworking standards, which may specify the use of identical BSPs present on multiple computers
from within an application running on the same or a different computer.
— UUID BSPAccessUUID {get;}: A UUID, unique within the scope of an application, which the application
may use to refer to the BSP as an alternative to the BSP product UUID. This parameter shall be
ignored by frameworks conforming to this part of ISO/IEC 30106 and can be set to any UUID value
by an application. It is provided to support interworking standards, which may specify the use of
identical BSPs present on multiple computers from within an application running on the same or a
different computer.
NOTE The “BSPAccess_UUID” and the “HostingendpointIRI” are part of the definition of the C type
BioAPI_BSP_SCHEMA, but are not part of the BSP schema information stored in the component registry (see
ISO/IEC 19784-1).
— List BSPSupportedAlgorithms {get;}: Array of BioAPI_ALGORITHM_ID structures
specifying the supported algorithms.
— List< UUID> BSPSupportedTransformOperations {get;}: Array of BioAPI_UUID structures specifying
the transform operations supported within the BioAPI_Tranform operation.
4.5.3 Method summary
4.5.3.1  virtual void Dispose ()
Description: Removes all the information in the current object, leaving it empty for a next use
Exception: None
4.6 Class Candidate
4.6.1 Description
Defines each of the resulting candidates from the Identify functionality.
4.6.2 Properties summary
— UUID Key {
...