CBM-E2 to CBM-E3 Migration Guide

Revision 05

CBM-E2 to CBM-E3 Migration Guide Jan. 2020

2018_2000039801-05
Business restricted
CBM-E2 to CBM-E3 Migration Guide

Copyright notices

Copyright ©2002-2020 Idemia. All rights reserved.

Information in this document is subject to change without notice and does not
represent a commitment on the part of Idemia. No part of this document may
be reproduced or transmitted in any form or by any means, electronic or
mechanical, including photocopying or recording, for any purpose without the
express written permission of Idemia.

The software described in this document is supplied under a license agreement

or nondisclosure agreement. It is against the law to copy the software on any
medium except as specifically allowed in the agreement.
This manual makes reference to names and products that are trademarks of
their respective owners.

PROPRIETARY RIGHTS
This document contains information of a proprietary nature to Idemia and is
submitted in confidence for a specific purpose. The recipient assumes custody
and control and agrees that this document will not be copied or reproduced
in whole or in part, nor its contents revealed in any manner or to any person
except to meet the purpose for which it was delivered.
This caveat is applicable to all the pages of this document.

2018_2000039801-05 This document and the information therein are the property of Idemia. They must not I
be copied or communicated to a third party without the prior authorization of Idemia
Jan. 2020
CBM-E2 to CBM-E3 Migration Guide

Document History

Revision Date Description

1 August 2016
2 October 2016
3 May 2017
4 November 2018
5 January 2020
Initial version.
Fix error in section 2.1 (wrong command length in last example)
Add the support of MSO_LEGACY_USB_ID and
MSO_BACKWARD_COMPATIBILITY licenses
Update registered office address and company’s name
Add section 8.4 : maximal number of minutiae in ILV_ENROLL
command with MSO_BACKWARD_COMPATIBILITY license

2018_2000039801-05 This document and the information therein are the property of Idemia. They must not II
be copied or communicated to a third party without the prior authorization of Idemia
Jan. 2020
CBM-E2 to CBM-E3 Migration Guide

Table of Content

1 Introduction .................................................................................................................... 1
1.1 Scope ......................................................................................................................... 1
1.2 Reference Documents ............................................................................................... 1
2 Fingerprint Template Formats ...................................................................................... 1
2.1 Default Format ........................................................................................................... 1
2.2 Deprecated Formats .................................................................................................. 2
2.3 Template Truncation .................................................................................................. 3
3 Fingerprint Quality ......................................................................................................... 3
3.1 Quality Score ............................................................................................................. 3
3.2 Quality Threshold ....................................................................................................... 3
4 WSQ Fingerprint Image Compression ......................................................................... 4
5 Normalized Matching ..................................................................................................... 4
6 USB VID/PID .................................................................................................................... 4
7 Product name ................................................................................................................. 4
8 Compatibility Licenses .................................................................................................. 4
8.1 Per default template ................................................................................................... 4
8.2 VID/PID ...................................................................................................................... 5
8.3 Normalized Matching ................................................................................................. 5
8.4 Maximal number of minutiae in exported templates .................................................. 5
9 Deprecated Features ...................................................................................................... 5

2018_2000039801-05 This document and the information therein are the property of Idemia. They must not III
be copied or communicated to a third party without the prior authorization of Idemia
Jan. 2020
CBM-E2 to CBM-E3 Migration Guide
Introduction

1 Introduction

1.1 Scope
The CBM-E3 family of devices is the new family of Compact Biometric Devices that
supersedes the CBM-E2 family.
It is composed of the following devices:
- CBM-E3 (IQS-certified OEM device)
- CBM-V3 (OEM device)
- MSO1300-E3 (IQS-certified desktop device)
- MSO1300-V3 (Desktop device)
- MSO1350-E3 (IQS-certified desktop device with smartcard reader)
- MSO1350-V3 (Desktop device with smartcard reader)

The CBM-E2 family was including the following devices

- CBM-E2 (IQS-certified OEM device)
- CBM-V2 (OEM device)
- MSO1300-E2 (IQS-certified desktop device)
- MSO1300-V2 (Desktop device)
- MSO1350-E2 (IQS-certified desktop device with smartcard reader)
- MSO1350-V2 (Desktop device with smartcard reader)

The CBM-E2 and CBM-E3 families are very similar and there are only few minor
differences. This guide summarizes the functional differences between CBM-E2 and CBM-
E3 and assists the current CBM-E2 integrators in adapting their existing host
systems/applications to work with CBM-E3 devices.

Note that electrical differences such as power consumption, input voltage range, etc.… are
not covered in this document.

1.2 Reference Documents

For more detailed information, refer to the following documents:
[R1] CBM Integration Guide
[R2] NEMO Firmware Reference Manual

2 Fingerprint Template Formats

2.1 Default Format

By default (i.e. if no specific format is specified in the ILV_ENROLL (0x21) command using
the ID_BIO_ALGO_PARAM (0x38) parameter), fingerprint templates are exported in
PKLITE format on CBM-E3. They are exported in PKCOMP V2 format on CBM-E2.

NOTE: The size of fingerprint templates in PKLITE format cannot be limited to a specific
value. The maximum size of a template in PKLITE format generated by a CBM-E3 device
is 701 bytes; the average size is around 270 bytes. This format is not supported by CBM-
E2.

2018_2000039801-05 This document and the information therein are the property of Idemia. They must not
1
be copied or communicated to a third party without the prior authorization of Idemia
Jan. 2020

Business restricted
CBM-E2 to CBM-E3 Migration Guide
Fingerprint Template Formats
Examples: When receiving the following ILV_ENROLL (0x21) command (see [R2] for
details), the CBM-E3 acquires a fingerprint and exports its template in PKLITE format while
the CBM-E2 exports the template in PKCOMP V2 format.

Command: 0x21 0x08 0x00 0x00 0x00 0x00 0x00 0x01 0x01 0x00 0x01

Response:
- CBM-E2: 0x21 0xXX 0xXX 0x00 0x00 0xff 0xff 0xff 0xff 0x02 0xXX 0xXX ...
- CBM-E3: 0x21 0xXX 0xXX 0x00 0x00 0xff 0xff 0xff 0xff 0xcc 0xXX 0xXX ...

The CBM-E3 returns the ILVERR_BADPARAMETER (0xfe) status to the following

ILV_ENROLL (0x21) command (see [R2] for details) while the CBM-E2 acquires a
fingerprint and exports its template in PKCOMP V2 format of 170 (0xaa) bytes maximum.

Command: 0x21 0x08 0x00 0x00 0x00 0x00 0x00 0x01 0x01 0x00 0xaa

Response:
- CBM-E2: 0x21 0xXX 0xXX 0x00 0x00 0xff 0xff 0xff 0xff 0x02 0xXX 0xXX ...
- CBM-E3: 0x21 0x05 0x00 0xfe 0xa8 0xfe 0xff 0xff

To export templates in PKCOMP V2 format on CBM-E3, use the ID_BIO_ALGO_PARAM

(0x38) parameter.

Command: 0x21 0x0c 0x00 0x00 0x00 0x00 0x00 0x01 0x01 0x00 0xaa 0x38 0x01
0x00 0x00

Response:
- CBM-E2: 0x21 0xXX 0xXX 0x00 0x00 0xff 0xff 0xff 0xff 0x02 0xXX 0xXX ...
- CBM-E3: 0x21 0xXX 0xXX 0x00 0x00 0xff 0xff 0xff 0xff 0x02 0xXX 0xXX ...

Note : see chapter 8.1 if this feature is not compliant with your development.

2.2 Deprecated Formats

The following fingerprint template formats are not supported on CBM-E3:
- PKMOC
- PKV10

Example: The CBM-E3 returns the ILVERR_BADPARAMETER (0xfe) status to the

following ILV_ENROLL (0x21) command (see [R2] for details) while the CBM-E2 acquires
a fingerprint and exports its template in PKMOC format.

Command: 0x21 0x0c 0x00 0x00 0x00 0x00 0x00 0x01 0x01 0x00 0x01 0x38 0x01
0x00 0x7b

Response:
- CBM-E2: 0x21 0xXX 0xXX 0x00 0x00 0xff 0xff 0xff 0xff 0x7b 0xXX 0xXX ...
- CBM-E3: 0x21 0x05 0x00 0xfe 0xa8 0xfe 0xff 0xff

2018_2000039801-05 This document and the information therein are the property of Idemia. They must not
2
be copied or communicated to a third party without the prior authorization of Idemia
Jan. 2020

Business restricted
CBM-E2 to CBM-E3 Migration Guide
Fingerprint Quality

2.3 Template Truncation

The size of fingerprint templates exported in PKCOMP V2 format can be limited to 135+
bytes on CBM-E3. It can be limited to 170+ bytes on CBM-E2.

The maximum number of minutiae in fingerprint templates exported in ANSI INCITS 378-
2004, ANSI INCITS 378-2009, ISO/IEC 19794-2:2005 FMR, ISO/IEC 19794-2:2011 FMR,
ISO/IEC 19794-2:2005 FMC NS, ISO/IEC 19794-2:2005 FMC CS, DIN V66400 or MINEX
A format can be limited to 30+ minutiae on CBM-E3. It can be limited to 2+ minutiae on
CBM-E2.

Example: The CBM-E3 returns the ILVERR_BADPARAMETER (0xfe) status to the

following ILV_ENROLL (0x21) command (see [R2] for details) while the CBM-E2 acquires
a fingerprint and exports its template in ISO/IEC 19794-2:2011 FMR format with a
maximum of 25 (0x19) minutiae.

Command: 0x21 0x0c 0x00 0x00 0x00 0x00 0x00 0x01 0x01 0x00 0x19 0x38 0x01
0x00 0x6e

Response:
- CBM-E2: 0x21 0xXX 0xXX 0x00 0x00 0xff 0xff 0xff 0xff 0x6e 0xXX 0xXX ...
- CBM-E3: 0x21 0x05 0x00 0xfe 0xa8 0xfe 0xff 0xff

3 Fingerprint Quality

3.1 Quality Score

Unlike CBM-E2, the fingerprint quality scores of a user in internal database cannot be
retrieved using the ILV_GET_USER_TEMPLATE_QUALITY (0x46) command if the user
was inserted in the CBM-E3 internal database using the ILV_INSERT_USER (0x35)
command with templates in PKCOMP V2 or PKMAT format.

Example: In the case described above, the CBM-E3 always returns scores equal to 0 while
the CBM-E2 returns the actual fingerprint quality scores.

Command: 0x46 0x08 0x00 0x00 0x36 0x04 0x00 0x00 0x00 0x00 0x00

Response:
- CBM-E2: 0x46 0x03 0x00 0x00 0x85 0x97
- CBM-E3: 0x46 0x03 0x00 0x00 0x00 0x00

3.2 Quality Threshold

On CBM-E3, prior to firmware release 1.10, the fingerprint quality threshold set in the
ILV_ENROLL (0x21) command could be adjusted in the range [70—160].

Starting from firmware release 1.10, the threshold can be adjusted in the same range as
CBM-E2 (i.e. [20—100]).

2018_2000039801-05 This document and the information therein are the property of Idemia. They must not
3
be copied or communicated to a third party without the prior authorization of Idemia
Jan. 2020

Business restricted
CBM-E2 to CBM-E3 Migration Guide
WSQ Fingerprint Image Compression

4 WSQ Fingerprint Image Compression

WSQ compression requires no more license on CBM-E3.
It required the MSO_WSQ license on CBM-E2.

5 Normalized Matching
On CBM-E3, the PKCOMP_Norm and PKMAT_Norm formats can be used as input
fingerprint templates for any operation (with or without normalization enabled) but acquired
fingerprint templates cannot be exported in one of these formats.

Unlike on CBM-E2 where normalization is enabled when using templates in the

PKCOMP_Norm or PKMAT_Norm formats, normalization is enabled on CBM-E3 by using
the ID_NORMALIZATION (0xad) parameter of the ILV_VERIFY (0x20),
ILV_VERIFY_MATCH (0x23) and ILV_UPDATE_USER_PRIVATE_FIELD (0x3d)
commands or by creating a normalized database for 1:N matching operations (see [R2] for
more information).

Normalization works with fingerprint templates in PKLITE, PKCOMP V2, PKCOMP_Norm,

PKMAT, PKMAT_Norm or PKFVP formats on CBM-E3. It only works with templates in
PKCOMP_Norm or PKMAT_Norm formats on CBM-E2.

Note : see chapter 8.3 if this feature is not compliant with your development.

6 USB VID/PID
The CBM-E3 family has its own USB VIDs/PIDs, which are different from CBM-E2 family’s
ones.

Note : see chapter 8.2 if this feature is not compliant with your development.

7 Product name
The CBM-E3 family has its own product names, which are different from CBM-E2 family’s
ones.

8 Compatibility Licenses
Some licenses have been made for customers who cannot change their code and want to
use CBM-E3 just like CBM-E2.

8.1 Per default template

For integrators who use the default template and cannot change the host portion, the
MSO_BACKWARD_COMPATIBILITY license removes this difference, which means that
the default template while using CBM-E3 family is PKCOMP V2 and not PKLITE anymore.

2018_2000039801-05 This document and the information therein are the property of Idemia. They must not
4
be copied or communicated to a third party without the prior authorization of Idemia
Jan. 2020

Business restricted
CBM-E2 to CBM-E3 Migration Guide
Deprecated Features

8.2 VID/PID

For integrators who use USB VID/PID and cannot change the host portion, they can load
some licenses in the CBM-E3 product family to make it work like CBM-E2.

With the MSO_LEGACY_USB_ID in CBM-E3 :

- CBM-E3 returns the USB VID/PID of CBM-E2
- CBM-V3 returns USB VID/PID of CBM-V2
- MSO1300-E3 returns USB PID/VID of MS01300-E2
- MSO1300-V3 returns USB VID/PID of MSO1300-V2
- MSO1350-E3 returns USB VID/PID of MSO1350-E2
- MSO1350-V3 returns USB VID/PID of MSO1350-V2

8.3 Normalized Matching

Since 1.13 version of CBM-E3 family and with the MSO_BACKWARD_COMPATIBILITY

license, integrators that use PKCOMP_Norm or PKMAT_Norm formats and that cannot
change the template format, can export its acquired fingerprint templates in one of these
formats.

8.4 Maximal number of minutiae in exported templates

The number of minutiae in an ANSI template could be truncated to a value provided as a

parameter of ILV_ENROLL command. For CBM-E3 family, the minimal value of this
parameter is 30.
From firmware release 03.06.b with the MSO_BACKWARD_COMPATIBILITY license, the
minimal value is 2 as it was for CBM-E2 family.

9 Deprecated Features
The following features are deprecated on CBM-E3:

- Reference templates read from a smartcard

o ID_PK_FROM_SMARTCARD (0x76) parameter

- OTP Feature
o ILV_OTP_ENROLL_USER (0xb0) command
o ILV_OTP_GENERATE (0xb1) command
o ILV_OTP_SET_PARAMETERS (0xb2) command
o ILV_OTP_GET_STATUS (0xb3) command

2018_2000039801-05 This document and the information therein are the property of Idemia. They must not
5
be copied or communicated to a third party without the prior authorization of Idemia
Jan. 2020

Business restricted
 Copyright ©2020 Idemia

Registered Office:
2, place Samuel de Champlain
92400 Courbevoie
France

www.idemia.com
Business restricted