com.upek.android.ptapi
Interface PtConnectionAdvancedI

All Superinterfaces:
PtConnectionI
All Known Implementing Classes:
PtConnection

public interface PtConnectionAdvancedI
extends PtConnectionI

Extends PTAPI connection interface with advanced security operations.


Method Summary
 void controlLastMatchData(int action, byte[] secret)
          Controls status of last match data.
 void copyFingerData(PtInputBir srcTemplate, int srcTag, int dstSlotNr, int dstTag, int dstAccessRights)
          Copies additional application data assigned to a finger template from one template to another one.
 PtBir copyFingerDataWrapped(PtInputBir srcTemplate, int srcTag, PtInputBir inputBIR, int dstTag, int dstAccessRights)
          Copies additional application data assigned to a finger template from a template to another wrapped template.
 byte[] createProfileWrapped(byte[] authKey, byte[] accessRights)
          Creates wrapped profile.
 byte[] deviceControl(int controlCode, byte[] inData)
          Calls FM's extension operations in IOCTL-like style.
 byte[] diagnostics(byte[] inData, IntegerArgI resultCode)
          Runs built-in FM Diagnostics.
 byte[] generateDeviceKeyPair(int keyType, int keyLength, int publicExponent, int flags)
          Generates new random RSA key pair.
 byte[] getFingerDataEx(PtInputBir template, int tag)
          Reads the additional application data associated with a finger template stored in FM's non-volatile memory or with a wrapped template.
 PtBir loadFingerEx(PtInputBir inputBIR, boolean returnPayload)
          Loads template from stored slot or wrapped template.
 int queryFingerData(PtInputBir template, int tag)
          Queries access rights of additional application data associated with a finger template stored in FM's non-volatile memory.
 void setDevicePrivateKey(int keyType, byte[] privateKey)
          Stores private part of RSA key pair to the device.
 void setFingerDataEx(int slotNr, int tag, int accessRights, byte[] fingerData)
          Assigns an additional application data to a finger template stored in FM's non-volatile memory.
 PtBir setFingerDataExWrapped(PtInputBir inputBIR, int tag, int accessRights, byte[] fingerData)
          Assigns an additional application data to a finger template stored in wrapped template.
 void setProfileWrapped(byte[] wrappedProfile)
          Sets wrapped profile created previously by createProfileWrapped().
 PtBir storeFingerWrapped(PtInputBir template)
          Stores given fingerprint template into wrapped template.
 byte[] useFingerData(PtInputBir template, int tag, int operation, byte[] inputData)
          Performs given 'use' operation with finger data of specified template.
 byte[] useSetFingerData(int slotNr, int tag, int accessRights, int operation, byte[] inputData)
          Performs given 'use-set' operation and store result as finger data of specified template stored in FM's non-volatile memory.
 PtBir useSetFingerDataWrapped(PtInputBir inputBir, int tag, int accessRights, int operation, byte[] inputData, ByteArrayArgI outputData)
          Performs given 'use-set' operation and store result as finger data of specified wrapped template.
 byte[] useUpdateFingerData(int slotNr, int tag, int operation, byte[] inputData)
          Performs given 'use-update' operation with finger data of specified template stored in FM's non-volatile memory, updated finger data are stored back to non-volatile memory.
 PtBir useUpdateFingerDataWrapped(PtInputBir inputBir, int tag, int operation, byte[] inputData, ByteArrayArgI outputData)
          Performs given 'use-update' operation with finger data of specified wrapped template, updated wrapped template is returned back to host.
 
Methods inherited from interface com.upek.android.ptapi.PtConnectionI
authentify, authentifyAdv, authentifyEx, calibrate, cancel, capture, close, closeDevice, closeSession, convertTemplate, convertTemplateEx, deleteAllFingers, deleteFinger, detectFingerEx, enroll, extendedInfo, formatInternalNVM, getAccessRights, getAppData, getAvailableMemory, getFingerData, getImageFormat, getLED, getSessionCfgEx, getSwipeInfo, grab, grabWindow, identifyMatchOnHost, info, isStrongEncryptionEnabled, listAllFingers, loadFinger, navigate, navigateWithSleep, openSession, scanQuality, secureChannel, secureChannelEx, setAppData, setFingerData, setFingerPayload, setGUICallbacks, setImageFormat, setLED, setSessionCfgEx, sleep, sleepThenCapture, sleepThenGrab, storeFinger, transact, updateFingerPayload, verify, verifyAll, verifyEx, verifyMatch, verifyMatchOnHost
 

Method Detail

controlLastMatchData

void controlLastMatchData(int action,
                          byte[] secret)
                          throws PtException
Controls status of last match data.

Parameters:
action - Requested action (see PT_LMD_xxxx values).
secret - Optional data for some actions, can be NULL.
Throws:
PtException - Exception with operation status (error) code.

copyFingerData

void copyFingerData(PtInputBir srcTemplate,
                    int srcTag,
                    int dstSlotNr,
                    int dstTag,
                    int dstAccessRights)
                    throws PtException
Copies additional application data assigned to a finger template from one template to another one.

Parameters:
srcTemplate - Source template whose application data has to be copied.
srcTag - Source finger data tag.
dstSlotNr - The slot number of the destination template to which the finger data has to be copied.
dstTag - Destination finger data tag.
dstAccessRights - Destination finger data access rights.
Throws:
PtException - Exception with operation status (error) code.

copyFingerDataWrapped

PtBir copyFingerDataWrapped(PtInputBir srcTemplate,
                            int srcTag,
                            PtInputBir inputBIR,
                            int dstTag,
                            int dstAccessRights)
                            throws PtException
Copies additional application data assigned to a finger template from a template to another wrapped template.

Parameters:
srcTemplate - Source template whose application data has to be copied.
srcTag - Source finger data tag.
inputBIR - Pointer to a wrapped template to which the finger data has to be copied.
dstTag - Destination finger data tag.
dstAccessRights - Destination finger data access rights.
Returns:
Output wrapped template with updated finger data. (Corresponds with parameter ppUpdatedBIR in original function)
Throws:
PtException - Exception with operation status (error) code.

createProfileWrapped

byte[] createProfileWrapped(byte[] authKey,
                            byte[] accessRights)
                            throws PtException
Creates wrapped profile. Authentication key can be prepared using PtUtil.getAuthKey().

Parameters:
authKey - Authentication key to be used with created profile.
accessRights - Access rights mask to be used with created profile, if it is NULL then access rights mask of current account is used.
Returns:
Resulting wrapped profile. (Corresponds with parameter ppWrappedProfile in original function)
Throws:
PtException - Exception with operation status (error) code.

deviceControl

byte[] deviceControl(int controlCode,
                     byte[] inData)
                     throws PtException
Calls FM's extension operations in IOCTL-like style.

Parameters:
controlCode - The control code for the operation.
inData - The input buffer that contains the data required to perform the operation.
Returns:
Data returned by the operation
Throws:
PtException - Exception with operation status (error) code.

diagnostics

byte[] diagnostics(byte[] inData,
                   IntegerArgI resultCode)
                   throws PtException
Runs built-in FM Diagnostics.

Parameters:
inData - Input data block.
Returns:
Output data block.
Throws:
PtException

generateDeviceKeyPair

byte[] generateDeviceKeyPair(int keyType,
                             int keyLength,
                             int publicExponent,
                             int flags)
                             throws PtException
Generates new random RSA key pair. Its private part is stored in the device and its public part is returned to the host.

Parameters:
keyType - Type of key to be generated.
keyLength - Length of generated key in bits. Allowed values are 512, 768, 1024, 1536 and 2048.
publicExponent - Value of key's public exponent, allowed values are 0, 3, 17 and 65537 (0 is internally interpreted as 3).
flags - Additional flags for key generation.
Returns:
Public part of the generated key pair. (Corresponds with parameter ppPublicKey in original function)
Throws:
PtException - Exception with operation status (error) code.

getFingerDataEx

byte[] getFingerDataEx(PtInputBir template,
                       int tag)
                       throws PtException
Reads the additional application data associated with a finger template stored in FM's non-volatile memory or with a wrapped template.

Parameters:
template - Template whose application data has to be read.
tag - Finger data tag.
Returns:
Application data associated with given fingerprint. If no data are associated with the fingerprint, the result will be a data block with zero length. (Corresponds with parameter ppFingerData in original function)
Throws:
PtException - Exception with operation status (error) code.

loadFingerEx

PtBir loadFingerEx(PtInputBir inputBIR,
                   boolean returnPayload)
                   throws PtException
Loads template from stored slot or wrapped template.

Parameters:
inputBIR - Source of the template, it can be slot or wrapped template
returnPayload - If TRUE then the template is returned with its payload.
Returns:
Loaded template (BIR). (Corresponds with parameter ppStoredTemplate in original function)
Throws:
PtException - Exception with operation status (error) code.

queryFingerData

int queryFingerData(PtInputBir template,
                    int tag)
                    throws PtException
Queries access rights of additional application data associated with a finger template stored in FM's non-volatile memory.

Parameters:
template - Template whose application data are inquired.
tag - Finger data tag.
Returns:
Access rights of requested data tag. (Corresponds with parameter pdwAccessRights in original function)
Throws:
PtException - Exception with operation status (error) code.

setDevicePrivateKey

void setDevicePrivateKey(int keyType,
                         byte[] privateKey)
                         throws PtException
Stores private part of RSA key pair to the device.

Parameters:
keyType - Type of key to be set.
privateKey - Private part of stored key pair.
Throws:
PtException - Exception with operation status (error) code.

setFingerDataEx

void setFingerDataEx(int slotNr,
                     int tag,
                     int accessRights,
                     byte[] fingerData)
                     throws PtException
Assigns an additional application data to a finger template stored in FM's non-volatile memory.

Parameters:
slotNr - The slot number of the template to be associated with data.
tag - Finger data tag.
accessRights - Access rights assigned to this finger data.
fingerData - The data to be stored together with the template. If the data length is zero, the application data associated with given fingerprint will be deleted
Throws:
PtException - Exception with operation status (error) code.

setFingerDataExWrapped

PtBir setFingerDataExWrapped(PtInputBir inputBIR,
                             int tag,
                             int accessRights,
                             byte[] fingerData)
                             throws PtException
Assigns an additional application data to a finger template stored in wrapped template.

Parameters:
inputBIR - Input wrapped template in which finger data has to be modified.
tag - Finger data tag.
accessRights - Access rights assigned to this finger data.
fingerData - The data to be stored together with the template. If the data length is zero, the application data associated with given fingerprint will be deleted
Returns:
Output wrapped template with updated finger data. (Corresponds with parameter ppUpdatedBIR in original function)
Throws:
PtException - Exception with operation status (error) code.

setProfileWrapped

void setProfileWrapped(byte[] wrappedProfile)
                       throws PtException
Sets wrapped profile created previously by createProfileWrapped().

Parameters:
wrappedProfile - Wrapped profile to be set.
Throws:
PtException - Exception with operation status (error) code.

storeFingerWrapped

PtBir storeFingerWrapped(PtInputBir template)
                         throws PtException
Stores given fingerprint template into wrapped template.

Parameters:
template - Template (BIR) to be stored into wrapped template.
Returns:
Resulting wrapped template. (Corresponds with parameter ppOutputBIR in original function)
Throws:
PtException - Exception with operation status (error) code.

useFingerData

byte[] useFingerData(PtInputBir template,
                     int tag,
                     int operation,
                     byte[] inputData)
                     throws PtException
Performs given 'use' operation with finger data of specified template. For encapsulating of input parameters and decoding of output parameters use function encodeUseFingerData and decodeUseFingerResult from PtUtil. This functions encodes/decodes headers and precision structure of input/output data packet. See PTAPI documentation.

Parameters:
template - Template whose application data has to be used.
tag - Finger data tag.
operation - Operation to be performed.
inputData - Additional data used in operation.
Returns:
Operation's output data. (Corresponds with parameter ppOutputData in original function)
Throws:
PtException

useSetFingerData

byte[] useSetFingerData(int slotNr,
                        int tag,
                        int accessRights,
                        int operation,
                        byte[] inputData)
                        throws PtException
Performs given 'use-set' operation and store result as finger data of specified template stored in FM's non-volatile memory.

Parameters:
slotNr - The slot number of the template with which will be the result of the operation stored.
tag - Finger data tag.
accessRights - Access rights assigned to the stored finger data.
operation - Operation to be performed.
inputData - Additional data used in operation.
Returns:
The operation's output data. (Corresponds with parameter ppOutputData in original function)
Throws:
PtException - Exception with operation status (error) code.

useSetFingerDataWrapped

PtBir useSetFingerDataWrapped(PtInputBir inputBir,
                              int tag,
                              int accessRights,
                              int operation,
                              byte[] inputData,
                              ByteArrayArgI outputData)
                              throws PtException
Performs given 'use-set' operation and store result as finger data of specified wrapped template.

Parameters:
inputBir - Input wrapped template to which will be stored the result of given operation.
tag - Finger data tag.
accessRights - Access rights assigned to the stored finger data.
operation - Operation to be performed.
inputData - Additional data used in operation.
outputData - Address of the pointer, which will be set to point to the operation's output data.
Returns:
Output wrapped template with updated finger data. (Corresponds with parameter ppUpdatedBir in original function)
Throws:
PtException - Exception with operation status (error) code.

useUpdateFingerData

byte[] useUpdateFingerData(int slotNr,
                           int tag,
                           int operation,
                           byte[] inputData)
                           throws PtException
Performs given 'use-update' operation with finger data of specified template stored in FM's non-volatile memory, updated finger data are stored back to non-volatile memory.

Parameters:
slotNr - The slot number of the template whose finger data will be used for given operation.
tag - Finger data tag.
operation - Operation to be performed.
inputData - Additional data used in operation.
Returns:
The operation's output data. (Corresponds with parameter ppOutputData in original function)
Throws:
PtException - Exception with operation status (error) code.

useUpdateFingerDataWrapped

PtBir useUpdateFingerDataWrapped(PtInputBir inputBir,
                                 int tag,
                                 int operation,
                                 byte[] inputData,
                                 ByteArrayArgI outputData)
                                 throws PtException
Performs given 'use-update' operation with finger data of specified wrapped template, updated wrapped template is returned back to host.

Parameters:
inputBir - Input wrapped template whose finger data will be used for given operation.
tag - Finger data tag.
operation - Operation to be performed.
inputData - Additional data used in operation.
outputData - Address of the pointer, which will be set to point to the operation's output data.
Returns:
Output wrapped template with updated finger data. (Corresponds with parameter ppUpdatedBir in original function)
Throws:
PtException - Exception with operation status (error) code.