@capgo/capacitor-native-biometric 5.0.0

package/dist/plugin.js

@@ -0,0 +1,50 @@
+var capacitorApp = (function (exports, core) {
+    'use strict';
+
+    exports.BiometryType = void 0;
+    (function (BiometryType) {
+        BiometryType[BiometryType["NONE"] = 0] = "NONE";
+        BiometryType[BiometryType["TOUCH_ID"] = 1] = "TOUCH_ID";
+        BiometryType[BiometryType["FACE_ID"] = 2] = "FACE_ID";
+        BiometryType[BiometryType["FINGERPRINT"] = 3] = "FINGERPRINT";
+        BiometryType[BiometryType["FACE_AUTHENTICATION"] = 4] = "FACE_AUTHENTICATION";
+        BiometryType[BiometryType["IRIS_AUTHENTICATION"] = 5] = "IRIS_AUTHENTICATION";
+        BiometryType[BiometryType["MULTIPLE"] = 6] = "MULTIPLE";
+    })(exports.BiometryType || (exports.BiometryType = {}));
+
+    const NativeBiometric = core.registerPlugin("NativeBiometric", {
+        web: () => Promise.resolve().then(function () { return web; }).then((m) => new m.NativeBiometricWeb()),
+    });
+
+    class NativeBiometricWeb extends core.WebPlugin {
+        constructor() {
+            super();
+        }
+        isAvailable() {
+            throw new Error("Method not implemented.");
+        }
+        verifyIdentity(_options) {
+            throw new Error("Method not implemented.");
+        }
+        getCredentials(_options) {
+            throw new Error("Method not implemented.");
+        }
+        setCredentials(_options) {
+            throw new Error("Method not implemented.");
+        }
+        deleteCredentials(_options) {
+            throw new Error("Method not implemented.");
+        }
+    }
+
+    var web = /*#__PURE__*/Object.freeze({
+        __proto__: null,
+        NativeBiometricWeb: NativeBiometricWeb
+    });
+
+    exports.NativeBiometric = NativeBiometric;
+
+    return exports;
+
+})({}, capacitorExports);
+//# sourceMappingURL=plugin.js.map

package/dist/plugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin.js","sources":["esm/definitions.js","esm/index.js","esm/web.js"],"sourcesContent":["export var BiometryType;\n(function (BiometryType) {\n    BiometryType[BiometryType[\"NONE\"] = 0] = \"NONE\";\n    BiometryType[BiometryType[\"TOUCH_ID\"] = 1] = \"TOUCH_ID\";\n    BiometryType[BiometryType[\"FACE_ID\"] = 2] = \"FACE_ID\";\n    BiometryType[BiometryType[\"FINGERPRINT\"] = 3] = \"FINGERPRINT\";\n    BiometryType[BiometryType[\"FACE_AUTHENTICATION\"] = 4] = \"FACE_AUTHENTICATION\";\n    BiometryType[BiometryType[\"IRIS_AUTHENTICATION\"] = 5] = \"IRIS_AUTHENTICATION\";\n    BiometryType[BiometryType[\"MULTIPLE\"] = 6] = \"MULTIPLE\";\n})(BiometryType || (BiometryType = {}));\n//# sourceMappingURL=definitions.js.map","import { registerPlugin } from \"@capacitor/core\";\nconst NativeBiometric = registerPlugin(\"NativeBiometric\", {\n    web: () => import(\"./web\").then((m) => new m.NativeBiometricWeb()),\n});\nexport * from \"./definitions\";\nexport { NativeBiometric };\n//# sourceMappingURL=index.js.map","import { WebPlugin } from \"@capacitor/core\";\nexport class NativeBiometricWeb extends WebPlugin {\n    constructor() {\n        super();\n    }\n    isAvailable() {\n        throw new Error(\"Method not implemented.\");\n    }\n    verifyIdentity(_options) {\n        throw new Error(\"Method not implemented.\");\n    }\n    getCredentials(_options) {\n        throw new Error(\"Method not implemented.\");\n    }\n    setCredentials(_options) {\n        throw new Error(\"Method not implemented.\");\n    }\n    deleteCredentials(_options) {\n        throw new Error(\"Method not implemented.\");\n    }\n}\n//# sourceMappingURL=web.js.map"],"names":["BiometryType","registerPlugin","WebPlugin"],"mappings":";;;AAAWA,kCAAa;IACxB,CAAC,UAAU,YAAY,EAAE;IACzB,IAAI,YAAY,CAAC,YAAY,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,GAAG,MAAM,CAAC;IACpD,IAAI,YAAY,CAAC,YAAY,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,GAAG,UAAU,CAAC;IAC5D,IAAI,YAAY,CAAC,YAAY,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,GAAG,SAAS,CAAC;IAC1D,IAAI,YAAY,CAAC,YAAY,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,GAAG,aAAa,CAAC;IAClE,IAAI,YAAY,CAAC,YAAY,CAAC,qBAAqB,CAAC,GAAG,CAAC,CAAC,GAAG,qBAAqB,CAAC;IAClF,IAAI,YAAY,CAAC,YAAY,CAAC,qBAAqB,CAAC,GAAG,CAAC,CAAC,GAAG,qBAAqB,CAAC;IAClF,IAAI,YAAY,CAAC,YAAY,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,GAAG,UAAU,CAAC;IAC5D,CAAC,EAAEA,oBAAY,KAAKA,oBAAY,GAAG,EAAE,CAAC,CAAC;;ACRlC,UAAC,eAAe,GAAGC,mBAAc,CAAC,iBAAiB,EAAE;IAC1D,IAAI,GAAG,EAAE,MAAM,mDAAe,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC,kBAAkB,EAAE,CAAC;IACtE,CAAC;;ICFM,MAAM,kBAAkB,SAASC,cAAS,CAAC;IAClD,IAAI,WAAW,GAAG;IAClB,QAAQ,KAAK,EAAE,CAAC;IAChB,KAAK;IACL,IAAI,WAAW,GAAG;IAClB,QAAQ,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;IACnD,KAAK;IACL,IAAI,cAAc,CAAC,QAAQ,EAAE;IAC7B,QAAQ,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;IACnD,KAAK;IACL,IAAI,cAAc,CAAC,QAAQ,EAAE;IAC7B,QAAQ,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;IACnD,KAAK;IACL,IAAI,cAAc,CAAC,QAAQ,EAAE;IAC7B,QAAQ,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;IACnD,KAAK;IACL,IAAI,iBAAiB,CAAC,QAAQ,EAAE;IAChC,QAAQ,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;IACnD,KAAK;IACL;;;;;;;;;;;;;;;"}

package/ios/Plugin/Info.plist

@@ -0,0 +1,24 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>CFBundleDevelopmentRegion</key>
+	<string>$(DEVELOPMENT_LANGUAGE)</string>
+	<key>CFBundleExecutable</key>
+	<string>$(EXECUTABLE_NAME)</string>
+	<key>CFBundleIdentifier</key>
+	<string>$(PRODUCT_BUNDLE_IDENTIFIER)</string>
+	<key>CFBundleInfoDictionaryVersion</key>
+	<string>6.0</string>
+	<key>CFBundleName</key>
+	<string>$(PRODUCT_NAME)</string>
+	<key>CFBundlePackageType</key>
+	<string>FMWK</string>
+	<key>CFBundleShortVersionString</key>
+	<string>1.0</string>
+	<key>CFBundleVersion</key>
+	<string>$(CURRENT_PROJECT_VERSION)</string>
+	<key>NSPrincipalClass</key>
+	<string></string>
+</dict>
+</plist>

package/ios/Plugin/Plugin.h

@@ -0,0 +1,10 @@
+#import <UIKit/UIKit.h>
+
+//! Project version number for Plugin.
+FOUNDATION_EXPORT double PluginVersionNumber;
+
+//! Project version string for Plugin.
+FOUNDATION_EXPORT const unsigned char PluginVersionString[];
+
+// In this header, you should import all the public headers of your framework using statements like #import <Plugin/PublicHeader.h>
+

package/ios/Plugin/Plugin.m

@@ -0,0 +1,12 @@
+#import <Foundation/Foundation.h>
+#import <Capacitor/Capacitor.h>
+
+// Define the plugin using the CAP_PLUGIN Macro, and
+// each method the plugin supports using the CAP_PLUGIN_METHOD macro.
+CAP_PLUGIN(NativeBiometric, "NativeBiometric",
+           CAP_PLUGIN_METHOD(isAvailable, CAPPluginReturnPromise);
+           CAP_PLUGIN_METHOD(verifyIdentity, CAPPluginReturnPromise);
+           CAP_PLUGIN_METHOD(getCredentials, CAPPluginReturnPromise);
+           CAP_PLUGIN_METHOD(setCredentials, CAPPluginReturnPromise);
+           CAP_PLUGIN_METHOD(deleteCredentials, CAPPluginReturnPromise);
+)

package/ios/Plugin/Plugin.swift

@@ -0,0 +1,264 @@
+import Foundation
+import Capacitor
+import LocalAuthentication
+
+/**
+ * Please read the Capacitor iOS Plugin Development Guide
+ * here: https://capacitor.ionicframework.com/docs/plugins/ios
+ */
+
+@objc(NativeBiometric)
+public class NativeBiometric: CAPPlugin {
+
+    struct Credentials {
+        var username: String
+        var password: String
+    }
+
+    enum KeychainError: Error {
+        case noPassword
+        case unexpectedPasswordData
+        case duplicateItem
+        case unhandledError(status: OSStatus)
+    }
+
+    typealias JSObject = [String: Any]
+
+    @objc func isAvailable(_ call: CAPPluginCall) {
+        let context = LAContext()
+        var error: NSError?
+        var obj = JSObject()
+
+        obj["isAvailable"] = false
+        obj["biometryType"] = 0
+
+        let useFallback = call.getBool("useFallback", false)
+        let policy = useFallback ? LAPolicy.deviceOwnerAuthentication : LAPolicy.deviceOwnerAuthenticationWithBiometrics
+
+        if context.canEvaluatePolicy(policy, error: &error) {
+            switch context.biometryType {
+            case .touchID:
+                obj["biometryType"] = 1
+            case .faceID:
+                obj["biometryType"] = 2
+            default:
+                obj["biomertryType"] = 0
+            }
+
+            obj["isAvailable"] = true
+            call.resolve(obj)
+        } else {
+            guard let authError = error else {
+                obj["errorCode"] = 0
+                call.resolve(obj)
+                return
+            }
+            var errorCode = 0
+            switch authError.code {
+            case LAError.biometryNotAvailable.rawValue:
+                errorCode = 1
+
+            case LAError.biometryLockout.rawValue:
+                errorCode = 2 // "Authentication could not continue because the user has been locked out of biometric authentication, due to failing authentication too many times."
+
+            case LAError.biometryNotEnrolled.rawValue:
+                errorCode = 3// message = "Authentication could not start because the user has not enrolled in biometric authentication."
+
+            default:
+                errorCode = 0 // "Did not find error code on LAError object"
+            }
+            obj["errorCode"] = errorCode
+            call.resolve(obj)
+        }
+
+    }
+
+    @objc func verifyIdentity(_ call: CAPPluginCall) {
+        let context = LAContext()
+        var canEvaluateError: NSError?
+
+        let useFallback = call.getBool("useFallback", false)
+        context.localizedFallbackTitle = useFallback ? nil : ""
+
+        let policy = useFallback ? LAPolicy.deviceOwnerAuthentication : LAPolicy.deviceOwnerAuthenticationWithBiometrics
+
+        if context.canEvaluatePolicy(policy, error: &canEvaluateError) {
+
+            let reason = call.getString("reason") ?? "For biometric authentication"
+
+            context.evaluatePolicy(policy, localizedReason: reason) { (success, evaluateError) in
+
+                if success {
+                    call.resolve()
+                } else {
+                    var errorCode = "0"
+                    guard let error = evaluateError
+                    else {
+                        call.reject("Biometrics Error", "0")
+                        return
+                    }
+
+                    switch error._code {
+
+                    case LAError.authenticationFailed.rawValue:
+                        errorCode = "10"
+
+                    case LAError.appCancel.rawValue:
+                        errorCode = "11"
+
+                    case LAError.invalidContext.rawValue:
+                        errorCode = "12"
+
+                    case LAError.notInteractive.rawValue:
+                        errorCode = "13"
+
+                    case LAError.passcodeNotSet.rawValue:
+                        errorCode = "14"
+
+                    case LAError.systemCancel.rawValue:
+                        errorCode = "15"
+
+                    case LAError.userCancel.rawValue:
+                        errorCode = "16"
+
+                    case LAError.userFallback.rawValue:
+                        errorCode = "17"
+
+                    case LAError.biometryNotAvailable.rawValue:
+                        errorCode = "1"
+
+                    case LAError.biometryLockout.rawValue:
+                        errorCode = "2" // "Authentication could not continue because the user has been locked out of biometric authentication, due to failing authentication too many times."
+
+                    case LAError.biometryNotEnrolled.rawValue:
+                        errorCode = "3" // message = "Authentication could not start because the user has not enrolled in biometric authentication."
+
+                    default:
+                        errorCode = "0" // Biometrics unavailable
+                    }
+                    call.reject(error.localizedDescription, errorCode, error )
+                }
+
+            }
+
+        } else {
+            call.reject("Authentication not available")
+        }
+    }
+
+    @objc func getCredentials(_ call: CAPPluginCall) {
+        guard let server = call.getString("server") else {
+            call.reject("No server name was provided")
+            return
+        }
+        do {
+            let credentials = try getCredentialsFromKeychain(server)
+            var obj = JSObject()
+            obj["username"] = credentials.username
+            obj["password"] = credentials.password
+            call.resolve(obj)
+        } catch {
+            call.reject(error.localizedDescription)
+        }
+    }
+
+    @objc func setCredentials(_ call: CAPPluginCall) {
+
+        guard let server = call.getString("server"), let username = call.getString("username"), let password = call.getString("password") else {
+            call.reject("Missing properties")
+            return
+        }
+
+        let credentials = Credentials(username: username, password: password)
+
+        do {
+            try storeCredentialsInKeychain(credentials, server)
+            call.resolve()
+        } catch KeychainError.duplicateItem {
+            do {
+                try updateCredentialsInKeychain(credentials, server)
+                call.resolve()
+            } catch {
+                call.reject(error.localizedDescription)
+            }
+        } catch {
+            call.reject(error.localizedDescription)
+        }
+    }
+
+    @objc func deleteCredentials(_ call: CAPPluginCall) {
+        guard let server = call.getString("server") else {
+            call.reject("No server name was provided")
+            return
+        }
+
+        do {
+            try deleteCredentialsFromKeychain(server)
+            call.resolve()
+        } catch {
+            call.reject(error.localizedDescription)
+        }
+    }
+
+    // Store user Credentials in Keychain
+    func storeCredentialsInKeychain(_ credentials: Credentials, _ server: String) throws {
+        let query: [String: Any] = [kSecClass as String: kSecClassInternetPassword,
+                                    kSecAttrAccount as String: credentials.username,
+                                    kSecAttrServer as String: server,
+                                    kSecValueData as String: credentials.password.data(using: .utf8)!]
+
+        let status = SecItemAdd(query as CFDictionary, nil)
+
+        guard status != errSecDuplicateItem else { throw KeychainError.duplicateItem }
+        guard status == errSecSuccess else { throw KeychainError.unhandledError(status: status) }
+    }
+
+    // Update user Credentials in Keychain
+    func updateCredentialsInKeychain(_ credentials: Credentials, _ server: String) throws {
+        let query: [String: Any] = [kSecClass as String: kSecClassInternetPassword,
+                                    kSecAttrServer as String: server]
+
+        let account = credentials.username
+        let password = credentials.password.data(using: String.Encoding.utf8)!
+        let attributes: [String: Any] = [kSecAttrAccount as String: account,
+                                         kSecValueData as String: password]
+
+        let status = SecItemUpdate(query as CFDictionary, attributes as CFDictionary)
+        guard status != errSecItemNotFound else { throw KeychainError.noPassword }
+        guard status == errSecSuccess else { throw KeychainError.unhandledError(status: status) }
+    }
+
+    // Get user Credentials from Keychain
+    func getCredentialsFromKeychain(_ server: String) throws -> Credentials {
+        let query: [String: Any] = [kSecClass as String: kSecClassInternetPassword,
+                                    kSecAttrServer as String: server,
+                                    kSecMatchLimit as String: kSecMatchLimitOne,
+                                    kSecReturnAttributes as String: true,
+                                    kSecReturnData as String: true]
+
+        var item: CFTypeRef?
+        let status = SecItemCopyMatching(query as CFDictionary, &item)
+        guard status != errSecItemNotFound else { throw KeychainError.noPassword }
+        guard status == errSecSuccess else { throw KeychainError.unhandledError(status: status) }
+
+        guard let existingItem = item as? [String: Any],
+              let passwordData = existingItem[kSecValueData as String] as? Data,
+              let password = String(data: passwordData, encoding: .utf8),
+              let username = existingItem[kSecAttrAccount as String] as? String
+        else {
+            throw KeychainError.unexpectedPasswordData
+        }
+
+        let credentials = Credentials(username: username, password: password)
+        return credentials
+    }
+
+    // Delete user Credentials from Keychain
+    func deleteCredentialsFromKeychain(_ server: String)throws {
+        let query: [String: Any] = [kSecClass as String: kSecClassInternetPassword,
+                                    kSecAttrServer as String: server]
+
+        let status = SecItemDelete(query as CFDictionary)
+        guard status == errSecSuccess || status == errSecItemNotFound else { throw KeychainError.unhandledError(status: status) }
+    }
+}