rdn87 / cordova-plugin-gctouch-id

Touch ID Plugin (Cordova) for iOS

cordova-plugin-gctouch-id

Touch ID Plugin (Cordova) for iOS

Author: Giulio Caruso aka rdn

Index

1. Description
2. Technical Documentation
3. Screenshots
4. Adding the Plugin
5. Sample Code
6. To Do
7. License

1. Description

With this plug-in Cordova you can use the TouchID sensor (iPhone 5S/iPhone 6/iPhone 6 Plus/iPhone 7/iPhone 7 Plus/iPad with Touch ID Sensor) for Authenticate in your App

The Plugin is only iOS Platform.

Requirements

iOS
8.0+

2. Technical Documentation

In this plugin there are 3 basic methods:

• isAvailable
• authWithTouchID
• setPassword

[isAvailable]: Returns a flag true or false if the touch id is available for that type of Device. (No input parameters)

[authWithTouchID]: This method tries to access with Touch ID
These are input parameters:
insertPwd: In this parameter you can enter the string true or false, set false if u want Basic Authentication with only Touch ID (Optional if u want Basic Authentication only Touch ID)
textValue: In this parameter you can enter the string for label of Button (Required)
message: In this parameter you can enter the string for Touch ID popup text (Required)
security: In this parameter you can enter the string true or false, false for Auth with NSUsersDefaults Instead it is true to use the KeyChain (Optional if u want Basic Authentication only Touch ID)

[setPassword]: This method allows you to save in NSUsersDefaults or KeyChain your password that you have chosen as Fallback.
These are input parameters:
password: In this parameter you can enter the string of your password security: In this parameter you can enter the string true or false, false for Auth with NSUsersDefaults Instead it is true to use the KeyChain

3. Screenshot

       

4. Adding the Plugin

Use the Cordova CLI and type in the following command:

cordova plugin add https://github.com/rdn87/cordova-plugin-gctouch-id.git

5. Sample Code

You can find it in the DEMO folder.

6. TO DO

• Add Basic Authentication with Touch ID
• Add NSUsersDefaults support
• Add UITextField input text support
• Add Keychain support
• Improve code
• Add npm repo

7. License

cordova-plugin-gctouch-id is available under the MIT license. See the LICENSE file for more info.