cordova-plugin-android-fingerprint-auth - npm Package Compare versions

Comparing version 1.2.6 to 1.2.7

changelog.md

@@ -0,1 +1,35 @@
+#Version 1.2.7
+###What's New
+* Improved German translations - pull request #58
+* **Bug fix** for issue #57 - deleting secret key in Android Keystore.
+* Added fixed error codes - pull request #56
+* Added `ERRORS` JSON Object to the FingerprintAuth class prototype with the following fields corresponding to the new fixed error codes:
+    ```
+     BAD_PADDING_EXCEPTION,
+     CERTIFICATE_EXCEPTION,
+     FINGERPRINT_CANCELLED,
+     FINGERPRINT_DATA_NOT_DELETED,
+     FINGERPRINT_ERROR,
+     FINGERPRINT_NOT_AVAILABLE,
+     FINGERPRINT_PERMISSION_DENIED,
+     FINGERPRINT_PERMISSION_DENIED_SHOW_REQUEST,
+     ILLEGAL_BLOCK_SIZE_EXCEPTION,
+     INIT_CIPHER_FAILED,
+     INVALID_ALGORITHM_PARAMETER_EXCEPTION,
+     IO_EXCEPTION,
+     JSON_EXCEPTION,
+     MINIMUM_SDK,
+     MISSING_ACTION_PARAMETERS,
+     MISSING_PARAMETERS,
+     NO_SUCH_ALGORITHM_EXCEPTION,
+     SECURITY_EXCEPTION
+    ```
+
+###Breaking Changes
+* Changed error message for cancelled from "Cancelled" to fixed error code `FingerprintAuth.ERRORS.FINGERPRINT_CANCELLED`
+
+#Version 1.2.6
+###What's New
+* **Bug fix** for issue #61 - added missing source-file element for German strings to plugin.xml
+
 #Version 1.2.5
@@ -2,0 +36,0 @@ ###What's New

package.json

 {
   "name": "cordova-plugin-android-fingerprint-auth",
-  "version": "1.2.6",
+  "version": "1.2.7",
   "description": "Cordova plugin to use Android fingerprint authentication API",
@@ -5,0 +5,0 @@ "cordova": {

README.md

@@ -1,5 +0,5 @@
-#Update to Version 1.2.0
+# Update to Version 1.2.0
 Please consult the [changelog](https://github.com/mjwheatley/cordova-plugin-android-fingerprint-auth/blob/master/changelog.md).
 
-#About
+# About
 This plugin was created referencing the [Fingerprint Dialog sample](http://developer.android.com/samples/FingerprintDialog/index.html) and the [Confirm Credential sample](http://developer.android.com/samples/ConfirmCredential/index.html) referenced by the [Android 6.0 APIs webpage](http://developer.android.com/about/versions/marshmallow/android-6.0.html).
@@ -9,19 +9,21 @@
 
-#Screenshots
-###Fingerprint Authentication Dialog
+This plugin will only work on devices whose manufacturers have implemented the Android 6.0 Fingerprint Authentication API.  This plugin does not support the Samsung Pass SDK and not all Samsung devices implement the Android 6.0 Fingerprint Authentication API.  If you are testing this plugin on a Samsung device and it is not working, please check the device compatibility before reporting an issue.
+
+# Screenshots
+### Fingerprint Authentication Dialog
 ![Fingerprint Auth Dialog](screenshots/fp_auth_dialog.jpg) ![Fingerprint Auth Dialog Success](screenshots/fp_auth_dialog_success.png) ![Fingerprint Auth Dialog Fail](screenshots/fp_auth_dialog_fail.jpg) ![Fingerprint Auth Dialog Too Many](screenshots/fp_auth_dialog_too_many.jpg) ![Fingerprint Auth Dialog No Backup](screenshots/fp_auth_dialog_no_backup.jpg) ![Fingerprint Auth Dialog No Backup](screenshots/fp_auth_dialog_longer.png)
-###Backup Credentials
+### Backup Credentials
 ![Confirm Password](screenshots/confirm_creds_pw.png) ![Confirm PIN](screenshots/confirm_creds_pin.png) ![Confirm Pattern](screenshots/confirm_creds_pattern.png)
 
-#Installation
+# Installation
 ### Cordova
 `cordova plugin add cordova-plugin-android-fingerprint-auth`
 
-###Ionic
+### Ionic
 `ionic plugin add cordova-plugin-android-fingerprint-auth`
 
-###Meteor
+### Meteor
 `meteor add cordova:cordova-plugin-android-fingerprint-auth`
 
-#How to use
+# How to use
 - Call `isAvailable()` to check the fingerprint status.
@@ -33,3 +35,3 @@ - Call `encrypt()` or `decrypt()` show the Authentication Dialog.
 
-###Encrypt/Decrypt User Credentials
+### Encrypt/Decrypt User Credentials
  
@@ -46,3 +48,3 @@ * Encrypt user credentials
 
-###Example implementation
+### Example implementation
 * I have created an example implementation using Angular2-Meteor and Ionic2 ([ionic2-meteor-login-fingerprint](https://github.com/mjwheatley/ionic2-meteor-login-fingerprint)).
@@ -52,3 +54,3 @@ * See ["How It Works"!](https://github.com/mjwheatley/ionic2-meteor-login-fingerprint#how_it_works)
 
-#API Reference
+# API Reference
 * FingerprintAuth
@@ -59,2 +61,3 @@ * [isAvailable(isAvailableSuccess, isAvailableError)](#module_fingerprintauth.isAvailable)
     * [delete(deleteConfg, successCallback, errorCallback)](#module_fingerprintauth.delete)
+    * [ERRORS](#module_fingerprintauth.errors)
 * [Config Object](#module_fingerprintauth.config)
@@ -64,3 +67,3 @@
 
-#FingerprintAuth.isAvailable(successCallback, errorCallback)
+# FingerprintAuth.isAvailable(successCallback, errorCallback)
 
@@ -70,3 +73,3 @@ Opens a native dialog fragment to use the device hardware fingerprint scanner to authenticate against fingerprints
 
-###isAvailable() Result Object
+### isAvailable() Result Object
 | Param | Type  | Description |
@@ -105,3 +108,3 @@ | --- | --- | ---  |
 
-###FingerprintAuth Config Object
+### FingerprintAuth Config Object
 
@@ -125,5 +128,5 @@ | Param | Type | Default | Description |
 
-#FingerprintAuth.encrypt(encryptConfig, encryptSuccessCallback, encryptErrorCallback)
+# FingerprintAuth.encrypt(encryptConfig, encryptSuccessCallback, encryptErrorCallback)
 
-###Result Object
+### Result Object
 | Param | Type  | Description |
@@ -158,3 +161,3 @@ | --- | --- | ---  |
 function errorCallback(error) {
-    if (error === "Cancelled") {
+    if (error === FingerprintAuth.ERRORS.FINGERPRINT_CANCELLED) {
         console.log("FingerprintAuth Dialog Cancelled!");
@@ -170,5 +173,5 @@ } else {
 
-#FingerprintAuth.decrypt(decryptConfig, encryptSuccessCallback, encryptErrorCallback)
+# FingerprintAuth.decrypt(decryptConfig, encryptSuccessCallback, encryptErrorCallback)
 
-###Result Object
+### Result Object
 | Param | Type  | Description |
@@ -205,3 +208,3 @@ | --- | --- | ---  |
 function errorCallback(error) {
-    if (error === "Cancelled") {
+    if (error === FingerprintAuth.ERRORS.FINGERPRINT_CANCELLED) {
         console.log("FingerprintAuth Dialog Cancelled!");
@@ -217,3 +220,3 @@ } else {
 
-#FingerprintAuth.delete(config, successCallback, errorCallback)
+# FingerprintAuth.delete(config, successCallback, errorCallback)
 
@@ -244,1 +247,26 @@ Used to delete a cipher.
 ```
+
+
+<a name="module_fingerprintauth.errors"></a>
+
+# FingerprintAuth.ERRORS `JSON Object`
+| Property | Type | Value |
+| --- | --- | --- |
+| BAD_PADDING_EXCEPTION | String | "BAD_PADDING_EXCEPTION" |
+| CERTIFICATE_EXCEPTION | String | "BAD_PADDING_EXCEPTION" |
+| FINGERPRINT_CANCELLED | String | "FINGERPRINT_CANCELLED" |
+| FINGERPRINT_DATA_NOT_DELETED | String | "FINGERPRINT_DATA_NOT_DELETED" |
+| FINGERPRINT_ERROR | String | "FINGERPRINT_ERROR" |
+| FINGERPRINT_NOT_AVAILABLE | String | "FINGERPRINT_NOT_AVAILABLE" |
+| FINGERPRINT_PERMISSION_DENIED | String | "FINGERPRINT_PERMISSION_DENIED" |
+| FINGERPRINT_PERMISSION_DENIED_SHOW_REQUEST | String | "FINGERPRINT_PERMISSION_DENIED_SHOW_REQUEST" |
+| ILLEGAL_BLOCK_SIZE_EXCEPTION | String | "ILLEGAL_BLOCK_SIZE_EXCEPTION" |
+| INIT_CIPHER_FAILED | String | "INIT_CIPHER_FAILED" |
+| INVALID_ALGORITHM_PARAMETER_EXCEPTION | String | "INVALID_ALGORITHM_PARAMETER_EXCEPTION" |
+| IO_EXCEPTION | String | "IO_EXCEPTION" |
+| JSON_EXCEPTION | String | "JSON_EXCEPTION" |
+| MINIMUM_SDK | String | "MINIMUM_SDK" |
+| MISSING_ACTION_PARAMETERS | String | "MISSING_ACTION_PARAMETERS" |
+| MISSING_PARAMETERS | String | "MISSING_PARAMETERS" |
+| NO_SUCH_ALGORITHM_EXCEPTION | String | "NO_SUCH_ALGORITHM_EXCEPTION" |
+| SECURITY_EXCEPTION | String | "SECURITY_EXCEPTION" |

www/FingerprintAuth.js

@@ -1,2 +0,23 @@
-function FingerprintAuth() {}
+function FingerprintAuth() {
+    FingerprintAuth.prototype.ERRORS = {
+        BAD_PADDING_EXCEPTION: "BAD_PADDING_EXCEPTION",
+        CERTIFICATE_EXCEPTION: "CERTIFICATE_EXCEPTION",
+        FINGERPRINT_CANCELLED: "FINGERPRINT_CANCELLED",
+        FINGERPRINT_DATA_NOT_DELETED: "FINGERPRINT_DATA_NOT_DELETED",
+        FINGERPRINT_ERROR: "FINGERPRINT_ERROR",
+        FINGERPRINT_NOT_AVAILABLE: "FINGERPRINT_NOT_AVAILABLE",
+        FINGERPRINT_PERMISSION_DENIED: "FINGERPRINT_PERMISSION_DENIED",
+        FINGERPRINT_PERMISSION_DENIED_SHOW_REQUEST: "FINGERPRINT_PERMISSION_DENIED_SHOW_REQUEST",
+        ILLEGAL_BLOCK_SIZE_EXCEPTION: "ILLEGAL_BLOCK_SIZE_EXCEPTION",
+        INIT_CIPHER_FAILED: "INIT_CIPHER_FAILED",
+        INVALID_ALGORITHM_PARAMETER_EXCEPTION: "INVALID_ALGORITHM_PARAMETER_EXCEPTION",
+        IO_EXCEPTION: "IO_EXCEPTION",
+        JSON_EXCEPTION: "JSON_EXCEPTION",
+        MINIMUM_SDK: "MINIMUM_SDK",
+        MISSING_ACTION_PARAMETERS: "MISSING_ACTION_PARAMETERS",
+        MISSING_PARAMETERS: "MISSING_PARAMETERS",
+        NO_SUCH_ALGORITHM_EXCEPTION: "NO_SUCH_ALGORITHM_EXCEPTION",
+        SECURITY_EXCEPTION: "SECURITY_EXCEPTION"
+    }
+}
 
@@ -3,0 +24,0 @@ FingerprintAuth.prototype.encrypt = function (params, successCallback, errorCallback) {

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

491564

increased by1.26%

Lines of code

65

increased by47.73%

Number of lines in readme file

259

increased by12.12%

No dependency changes