Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

NSFaceIDUsageDescription needed to enable FaceID #43

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

NSFaceIDUsageDescription needed to enable FaceID #43

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 12 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@

Keychain Plugin for Apache Cordova
=====================================
created by Shazron Abdullah
Expand All @@ -22,6 +23,11 @@ cordova plugin add https://github.com/ionic-team/cordova-plugin-ios-keychain

iCloud keychain synchonizing is enabled, so the keychain will be mirrored across all devices *if* the user is signed in to iCloud (Settings > iCloud) and has iCloud keychain turned on (Settings > iCloud > Keychain)

### Enable Face ID (Optional)

To enable FaceID, add **NSFaceIDUsageDescription** to your Info.plist
Refer: [Property List Key: NSFaceIDUsageDescription](https://developer.apple.com/documentation/bundleresources/information_property_list/nsfaceidusagedescription/)

### Usage

See the **example** folder for example usage.
Expand All @@ -44,7 +50,7 @@ Keychain.get(successCallback, failureCallback, 'key', 'TouchID Message');
@param failureCallback returns the error string as the argument to the callback, for a failure
@param key the key to set
@param value the value to set
@param useTouchID whether to store the value with security such that TouchID will be needed to grab it
@param useTouchID whether to store the value with security such that TouchID/FaceID will be needed to grab it
*/
Keychain.set(successCallback, failureCallback, 'key', 'value', useTouchID);

Expand All @@ -64,7 +70,7 @@ Keychain.remove(successCallback, failureCallback, 'key');
@param failureCallback returns the error string as the argument to the callback, for a failure
@param key the key to set
@param value the value to set
@param useTouchID whether to store the value with security such that TouchID will be needed to grab it
@param useTouchID whether to store the value with security such that TouchID/FaceID will be needed to grab it
*/
Keychain.setJson(successCallback, failureCallback, 'key', 'value', useTouchID);

Expand All @@ -75,11 +81,14 @@ Keychain.setJson(successCallback, failureCallback, 'key', 'value', useTouchID);
@param failureCallback returns the error string as the argument to the callback, for a failure
@param key the key to set
@param value the value to set
@param useTouchID whether to store the value with security such that TouchID will be needed to grab it
@param useTouchID whether to store the value with security such that TouchID/FaceID will be needed to grab it
*/
Keychain.getJson(successCallback, failureCallback, 'key', useTouchID);
```

### License

[Apache 2.0 License](http://www.apache.org/licenses/LICENSE-2.0.html) except for the Auth0 SimpelKeychain code that is under MIT