| BiometricKit.framework | |
| Private Framework | |
|---|---|
| Availabile | 7.0 – present |
| Class Prefix | BiometricKit |
| Headers | [headers.cynder.me] |
BiometricKit is the framework relating to the TouchID debuted on the iPhone 5s. The TouchID has an internal codename Mesa. It is a private framework compiled only for arm64. You can also Google "Biokit.h", and from the Gist you can find the headers for the BiometricKit.framework. (You can also dump them yourselves, it is shipped with the iPhoneOS 7.0 SDK on Xcode and of course on an iPhone 5s.)
Classes
BiometricKitIdentity
BiometricKitIdentity represents the enrolled fingerprints on the device. Properties for the user-defined name and UUID are available.
BiometricKitMatchInfo
A BiometricKitMatchInfo object has two properties:
- A dictionary of details, including (presumably) the area of the enrolled fingerprint, the number of nodes on file, and whether the enrollment data have been updated just now from the latest scan.
- An array of topology's of class BiometricKitEnrollProgressInfo. Currently observed to contain up to 15 "topology nodes".
BiometricKitEnrollProgressInfo
A BiometricKitEnrollProgressInfo object contains presumably the actual fingerprint digital representation as BiometricKitEnrollProgressCoordinates objects in its BKEPDNewNodeCoordinates key of messageDetails dictionary.
BiometricKitEnrollProgressCoordinates
A BiometricKitEnrollProgressCoordinates object is suspected to record the x and y coordinates and the angle (probably in radians) of the a particular fingerprint distinguishing feature.
Uses
Querying the enrolled fingerprints
You can get an array of all BiometricKitIdentity's on file with [[BiometricKit manager] identities:nil]. Note that this will only give you the user-defined names and UUIDs, but not the actual fingerprint characteristics as in BiometricKitEnrollProgressInfo.
Getting scan results
There are at least three ways you can get the scan results from the TouchID sensor.
BiometricKit manager and delegate methods
Simple to set up in your own apps. Note that if you decide to use the BiometricKit class and the BiometricKitDelegate in your own app, the app needs the entitlements of com.apple.private.biometrickit.allow and com.apple.private.bmk.allow.
SBLockScreenManager of SpringBoardUIServices
SBLockScreenManager - (void)biometricEventMonitor:(SBUIBiometricEventMonitor *)monitor handleBiometricEvent:(unsigned)event would always be invoked after the screen is on and a fingerprint is registered.
(Please investigate further on the meanings of the (unsigned)event. I believe 9 is for unrecognized fingerprint, 3 is for recognized fingerprint, 2 sometimes appears with 3, 1 perhaps means finger detected, 0 means nothing detected. --Jdoe (talk) 07:09, 4 January 2014 (PST))
XPC
BiometricKitXPCClient - (void)matchResult:(BiometricKitIdentity *)result withDictionary:(NSDictionary *)dictionary
Issues after going into the TouchID settings
For some unknown reason, no further message would be called upon scanning if the user enters the TouchID settings under Preferences.app. The device has to be slept and unlocked in order to receive messages from the aforementioned methods again.
(If you find a workaround please edit this out. --Jdoe (talk) 07:06, 4 January 2014 (PST))
Enrollment
(Not investigated, but there are some methods regarding enrollment in this framework. Also refer to the BiometricKitUI.framework --Jdoe (talk) 07:06, 4 January 2014 (PST))