PIBIO_ENGINE_CREATE_KEY_FN callback function (winbio_adapter.h)

Article
10/05/2021

Called by the Windows Biometric Framework to push an HMAC key to the sensor. The returned key identifier will be passed back to the biometric unit when the framework calls EngineAdapterIdentifyFeatureSetSecure.

Syntax

PIBIO_ENGINE_CREATE_KEY_FN PibioEngineCreateKeyFn;

HRESULT PibioEngineCreateKeyFn(
  PWINBIO_PIPELINE Pipeline,
  const UCHAR *Key,
  SIZE_T KeySize,
  PUCHAR KeyIdentifier,
  SIZE_T KeyIdentifierSize,
  PSIZE_T ResultSize
)
{...}

Parameters

Pipeline

Pointer to a WINBIO_PIPELINE structure associated with the biometric unit performing the operation.

Key

Pointer to a buffer that contains the HMAC key.

KeySize

Size, in bytes, of the buffer specified by the Key parameter.

KeyIdentifier

Pointer to a buffer that receives a key identifier. The format of the buffer is vendor-defined.

KeyIdentifierSize

Size, in bytes, of the buffer specified by the KeyIdentifier parameter.

ResultSize

Pointer to a variable that receives the size, in bytes, of the data written to the buffer specified by the KeyIdentifier parameter.

Return value

If the KeyIdentifier buffer is too small, WINBIO_E_KEY_IDENTIFIER_BUFFER_TOO_SMALL must be returned, and the required size must be written to ResultSize. The framework will call the API again with a larger buffer. If the sensor cannot create the key, WINBIO_E_KEY_CREATION_FAILED must be returned.

Remarks

Only a single key will be in use at any time. If EngineAdapterCreateKey is called when the engine has knowledge of a preexisting key, the preexisting key must be overwritten with the new one.

Requirements

Requirement	Value
Minimum supported client	Windows 10 [desktop apps only]
Minimum supported server	Windows Server 2016 [desktop apps only]
Target Platform	Windows
Header	winbio_adapter.h (include Winbio_adapter.h)

Share via