Fingerprint Reader Testing Prerequisites
This section describes the tasks that you must complete before you test a fingerprint reader by using the Windows Hardware Lab Kit (Windows HLK):
Hardware requirements
The following hardware is required for testing a fingerprint reader. You might need additional hardware if the test device offers other features. To determine whether additional hardware requirements apply, see the test description for each test that appears for the device in Windows HLK Studio.
One test computer. The test computer must meet the Windows HLK prerequisites. For more information, see Windows HLK Prerequisites.
The fingerprint reader to be tested.
One certified USB 2.0 hub if the fingerprint reader is a USB-based device.
Note
To certify your product for use on servers, the test computer must support four processors and a minimum of 1 GB of RAM. These system capabilities are required to test the Rebalance, D3 State, and Multiple Processor Group functionality of the device and driver. You do not need a computer that actually has more than 64 processors to test your device. Additionally, the server system(s) being used for device or driver testing must have Server Core installed prior to testing. For more information see Windows Server Installation Options.
If you use a pool of test computers to test devices, at least one computer in the pool must contain four processors and a minimum of 1 GB of RAM. Additionally, that computer must contain the device and the driver that you want to test. As long as the driver is the same on all the computers in the pool, the system creates a schedule to run against all test computers.
For tests that do not include a driver to test, such as hard disk drive tests, the Windows HLK scheduler constrains the tests that validate the device's and driver's Rebalance, D3 State and Multiple Processor Groups functionality to run on the default test computer. You must manually configure this computer to have multiple processor groups. The default computer is the first test computer in the list. Test personnel must make sure that the first test computer in the list meets the minimum hardware requirements.
Note
Except for para-virtualization drivers (as defined by the WHCP Policies and Processes document), you may not use any form of virtualization when you test physical devices and their associated drivers for server certification or signature. All virtualization products do not support the underlying functionality that is required to pass the tests that relate to multiple processor groups, device power management, device PCI functionality, and other tests.
Note
Multiple Processor Groups Setting You must set the value for the processor group size for Hardware Lab Kit testing of Windows Server 2008 R2 and later device drivers for certification. This is done by running bcdedit in an elevated command prompt window, using the /set option.
The commands for adding the group settings and restarting are as follows:
bcdedit.exe /set groupsize 2
bcdedit.exe /set groupaware on
shutdown.exe -r -t 0 -f
The commands for removing the group settings and rebooting are as follows:
bcdedit.exe /deletevalue groupsize
bcdedit.exe /deletevalue groupaware
shutdown.exe -r -t 0 -f
Note
Code Integrity Setting
The Virtualization Based Security feature (VBS) of Windows Server 2016 must be enabled using Server Manager first.
Once that has occurred, the following Registry key must be created and set:
HKLM\System\CurrentControlSet\Control\DeviceGuard
HypervisorEnforcedCodeIntegrity:REG_DWORD
0 or 1 (disabled, enabled)
Software requirements
The following software is required for testing a fingerprint reader:
The drivers for the test device.
The latest Windows HLK filters or updates.
Test computer configuration
To configure the test computer for your test device, follow these steps:
Install the appropriate Windows operating system on the test computer, and then configure the computer for your test network (the network that contains the Windows HLK Studio and Windows HLK Controller.
If the test device is connected through the USB port, connect the USB 2.0 controller to the high-speed USB 2.0 hub, and then connect the test device to the downstream port of the high-speed USB 2.0 hub.
Note
Do not connect the USB test device directly to the root hub of the USB 2.0 controller.
Attach the fingerprint reader to the test computer.
If you have to install the manufacturer-supplied device driver on the test computer, do this now.
Check that the fingerprint reader functions correctly on the test computer.
Install the Windows HLK client application on the test computer.
Use Windows HLK Studio to create a machine pool, and then move the test computer to that pool.
Create test directory [SYSTEMDRIVE]\FingerprintReaderTest.
Copy the adapter DLLs from [SYSTEMDRIVE]\Windows\System32\WinBioPlugins for the sensor, storage, and engine adapters.
Create configuration files for the sensor, storage, and engine adapters using the following templates.
Edit the sensorAdapterLib, engineAdapterLib, and storageAdapterLib configuration tags to point to correct adapter DLLs as copied previously.
Edit the supportedModes and supportedPurposes configuration tags to match the device capabilities.
The runOptional attribute is false by default. Change it to true to run extra tests.
For storage tests, change the deviceRequired attribute to true if the device has onboard storage.
Make sure that the test computer is in the ready state before you begin your testing. If a test requires parameters to be set before it is run, a dialog box will be displayed for that test. Review the specific test topic for more information.
Some Windows HLK tests require user intervention. When running tests for a submission, it is a best practice to run the automated tests in a block separately from manual tests. This prevents a manual test from interrupting completion of an automated test.
Before running any fingerprint reader driver or adapter tests, stop and disable the Windows Biometric Service. If the biometric service is running while the fingerprint reader HLK tests execute, there may be a conflict between the two, and test results will not be accurate.
Writing test configuration files
Before running any fingerprint reader adapter tests, you need to create XML configuration files for the sensor, storage, and engine adapters. The names of these files must be SensorTestConfig.XML, EngineTestConfig.XML, and StorageTestConfig.XML. Use the templates below as a starting point and modify them for your specific device.
Sensor Adapter configuration file
<?xml version="1.0" encoding="utf-8"?>
<bioTestConfiguration version="0" runOptional="false" runInteractive="true" abortOnFailure="false" manualStep="false" logType="WTT">
<testSuites>
<testSuite deviceRequired="true" id="SensorAdapterTestSuite">
<library>sensortest.dll</library>
<description>Sensor Adapter Test Suite</description>
</testSuite>
</testSuites>
<deviceInfo>
<sensorAdapterLib>winbiosensoradapter.dll</sensorAdapterLib>
<engineAdapterLib>engineadapter.dll</engineAdapterLib>
<storageAdapterLib>winbiostorageadapter.dll</storageAdapterLib>
<indicatorSupported>0</indicatorSupported>
<supportedModes>
<supportedMode>0x01</supportedMode>
<supportedMode>0x02</supportedMode>
</supportedModes>
<supportedPurposes>
<supportedPurpose>0x01</supportedPurpose>
<supportedPurpose>0x02</supportedPurpose>
<supportedPurpose>0x04</supportedPurpose>
<supportedPurpose>0x08</supportedPurpose>
<supportedPurpose>0x10</supportedPurpose>
<supportedPurpose>0x80</supportedPurpose>
</supportedPurposes>
</deviceInfo>
</bioTestConfiguration>
Engine Adapter configuration file
<?xml version="1.0" encoding="utf-8"?>
<bioTestConfiguration version="0" runOptional="false" runInteractive="true" abortOnFailure="false" manualStep="false" logType="WTT">
<testSuites>
<testSuite deviceRequired="true" id="EngineAdapterTestSuite">
<library>enginetest.dll</library>
<description>Engine Adapter Test Suite</description>
</testSuite>
</testSuites>
<deviceInfo>
<sensorAdapterLib>winbiosensoradapter.dll</sensorAdapterLib>
<engineAdapterLib>engineadapter.dll</engineAdapterLib>
<storageAdapterLib>winbiostorageadapter.dll</storageAdapterLib>
<indicatorSupported>0</indicatorSupported>
<engineOnDevice>FALSE</engineOnDevice>
<supportedModes>
<supportedMode>0x01</supportedMode>
<supportedMode>0x02</supportedMode>
</supportedModes>
<supportedPurposes>
<supportedPurpose>0x01</supportedPurpose>
<supportedPurpose>0x02</supportedPurpose>
<supportedPurpose>0x04</supportedPurpose>
<supportedPurpose>0x08</supportedPurpose>
<supportedPurpose>0x10</supportedPurpose>
<supportedPurpose>0x80</supportedPurpose>
</supportedPurposes>
</deviceInfo>
</bioTestConfiguration>
Storage Adapter configuration file
<?xml version="1.0" encoding="utf-8"?>
<bioTestConfiguration version="0" runOptional="false" runInteractive="true" abortOnFailure="false" manualStep="false" logType="WTT">
<testSuites>
<testSuite deviceRequired="false" id="StorageAdapter">
<library>storagetest.dll</library>
<description>Storage Adapter Test Suite</description>
</testSuite>
</testSuites>
<deviceInfo>
<sensorAdapterLib>winbiosensoradapter.dll</sensorAdapterLib>
<engineAdapterLib>engineadapter.dll</engineAdapterLib>
<storageAdapterLib>winbiostorageadapter.dll</storageAdapterLib>
<indicatorSupported>0</indicatorSupported>
<storageOnDevice>FALSE</storageOnDevice>
<supportedModes>
<supportedMode>0x01</supportedMode>
<supportedMode>0x02</supportedMode>
</supportedModes>
<supportedPurposes>
<supportedPurpose>0x01</supportedPurpose>
<supportedPurpose>0x02</supportedPurpose>
<supportedPurpose>0x04</supportedPurpose>
<supportedPurpose>0x08</supportedPurpose>
<supportedPurpose>0x10</supportedPurpose>
<supportedPurpose>0x80</supportedPurpose>
</supportedPurposes>
</deviceInfo>
</bioTestConfiguration>
Additional configuration tags
In the configuration file, under the "device information" section, there are three additional tags:
<deviceInfo>
<badSwipeDetectionPoint> VALUE </badSwipeDetectionPoint>
<privateConnectionSensorToEngine>BOOLEAN</privateConnectionSensorToEngine>
<privateConnectionEngineToStorage>BOOLEAN</privateConnectionEngineToStorage>
</deviceInfo>
badSwipeDetectionPoint
SensorFinishCapture
EngineAcceptData
EngineProcessData
Note
A maximum of one badSwipeDetectionPoint tag can appear in a single test configuration file.
privateConnectionSensorToEngine
If TRUE, this indicates that there is an internal connection between the sensor and the engine components that is not managed by the WinBio Framework.
If FALSE, the connection between the sensor and engine uses the standard WinBio adapter interfaces.
privateConnectionEngineToStorage
If TRUE, this indicates that there is internal connection between the engine and storage components that is not managed by the WinBio Framework.
If FALSE, the connection between the engine and storage uses the standard WinBio adapter interfaces.
Note
For a compound device, it's possible to set both the privateConnectionSensorToEngine and privateConnectionEngineToStorage.
engineOnDevice
If TRUE, this indicates that the fingerprint sensor supports the engine functionality in hardware. This typically implies that the sensor is an advanced sensor.
If FALSE, this indicates that the fingerprint sensor supports the engine functionality in software. This typically implies that the sensor is a basic sensor.
storageOnDevice
If TRUE, this indicates that the fingerprint sensor supports template storage in hardware. This typically implies that the sensor is an advanced sensor.
If FALSE, this indicates that the fingerprint sensor does not support template storage in hardware. Templates are stored on disk. This typically implies that the sensor is a basic sensor.