Scan the fingerprint of your user with the TouchID sensor (iPhone 5S).
Distorted a bit because I created it back when Apple had not yet released the SDK and they're not a fan of developers posting screenshots of unreleased features.
$ cordova plugin add cordova-plugin-touch-id$ cordova prepare
The latest, from the master repo:
$ cordova plugin add$ cordova prepare
TouchID.js is brought in automatically. There is no need to change or add anything in your html.
1. Add the following xml to your
config.xml in the root directory of your
You'll need to add the
Security.framework to your project.
Click your project, Build Phases, Link Binary With Libraries, search for and add the frameworks.
2. Grab a copy of TouchID.js, add it to your project and reference it in
3. Download the source files and copy them to your project.
iOS: Copy the two
.h and two
.m files to
First you'll want to check whether or not the user has a configured fingerprint scanner. You can use this to show a 'log in with your fingerprint' button next to a username/password login form.
If the onSuccess handler was called, you can scan the fingerprint.
There are two options:
The first method will offer a fallback option called 'enter passcode' which shows the default passcode UI when pressed.
The second method will offer a fallback option called 'enter password' (not passcode) which allows you to provide your own password dialog.
The errorhandler of the method above can receive an error code of
-2 which means the user pressed the 'enter password' fallback.
This will render a button labelled 'Enter password' in case the fingerprint is not recognized. If you want to provide your own label ('Enter PIN' perhaps), you can use awkwardly named function (added in version 3.1.0):
You can copy-paste these lines of code for a quick test:
Touch ID available?Scan fingerprint
Since iOS9 it's possible to check whether or not the list of enrolled fingerprints changed since the last time you checked it. It's recommended you add this check so you can counter hacker attacks to your app. See this article for more details.
So instead of checking the fingerprint after
isAvailable add another check.
true you probably want to re-authenticate your user
before accepting valid fingerprints again.
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.