{"_id":"@cordova-ohos/cordova-plugin-fingerprint-aio","_rev":"3-b41b61566685bb230471b5e60988d239","name":"@cordova-ohos/cordova-plugin-fingerprint-aio","dist-tags":{"latest":"6.0.2"},"versions":{"6.0.1":{"name":"@cordova-ohos/cordova-plugin-fingerprint-aio","version":"6.0.1","keywords":["cordova","fingerprint-aio","ecosystem:cordova","cordova-openharmony"],"author":{"name":"Huawei Device, Inc. Ltd. and","email":"马弓手"},"license":"Apache-2.0","_id":"@cordova-ohos/cordova-plugin-fingerprint-aio@6.0.1","maintainers":[{"name":"luqi_tan","email":"295099422@qq.com"},{"name":"wanpengsz","email":"wanpengsz@163.com"},{"name":"xkh111","email":"xukaihui11@163.com"}],"bugs":{"url":"https://gitcode.com/OpenHarmony-Cordova/cordova-plugin-fingerprint-aio/issues"},"dist":{"shasum":"56550ee5bee7b8a2a4fb1ddb6928726dc199b258","tarball":"https://registry.npmjs.org/@cordova-ohos/cordova-plugin-fingerprint-aio/-/cordova-plugin-fingerprint-aio-6.0.1.tgz","fileCount":10,"integrity":"sha512-LdgbCDY1kJUttBdCL06rO/RnYUCC8qQUlDiUqK+f7ADh9RbrgJz7KwL4Cf6Bm5cw/2F1YuCTWFWztlewV4h9pg==","signatures":[{"sig":"MEUCIQCNjIrXahveBRk54eVnwAa3uaGOjnrs5l4fs22b8f8XTgIgD+FEiuZOUeKS9ICwazd2B+UXuM2TfiWv8DgerdiD+I8=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":41752},"cordova":{"id":"cordova-plugin-fingerprint-aio","platforms":["ohos"]},"engines":{"cordovaDependencies":{"6.0.1":{"hcordova":">=1.0.0","@cordova-ohos/ohos":">=2.0.0"}}},"gitHead":"1d0b683755fd45310854d4f27bef3c44593e3adb","_npmUser":{"name":"wanpengsz","email":"wanpengsz@163.com"},"repository":{"url":"gitcode:OpenHarmony-Cordova/cordova-plugin-fingerprint-aio","type":"git"},"_npmVersion":"9.6.2","description":"Cordova fingerprint-aio Plugin","directories":{},"_nodeVersion":"20.16.0","_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/cordova-plugin-fingerprint-aio_6.0.1_1773992997962_0.05171194636235854","host":"s3://npm-registry-packages-npm-production"}},"6.0.2":{"name":"@cordova-ohos/cordova-plugin-fingerprint-aio","version":"6.0.2","description":"Cordova fingerprint-aio Plugin","cordova":{"id":"cordova-plugin-fingerprint-aio","platforms":["ohos"]},"repository":{"type":"git","url":"gitcode:CPF-Cordova/cordova-plugin-fingerprint-aio"},"bugs":{"url":"https://gitcode.com/CPF-Cordova/cordova-plugin-fingerprint-aio/issues"},"keywords":["cordova","fingerprint-aio","ecosystem:cordova","cordova-openharmony"],"engines":{"cordovaDependencies":{"6.0.2":{"@cordova-ohos/ohos":">=2.0.0","hcordova":">=1.0.0"}}},"author":{"name":"Huawei Device, Inc. Ltd. and","email":"马弓手"},"license":"Apache-2.0","_id":"@cordova-ohos/cordova-plugin-fingerprint-aio@6.0.2","gitHead":"d7744afbedf56a1983e2930fda50d06731560c41","_nodeVersion":"22.0.0","_npmVersion":"10.5.1","dist":{"integrity":"sha512-a/0Nb+f+XlKQ+SAjSzhWT+I8kpUlFvFiiNvVLPWRlx+jVmVMUKJATDvvLzXeYUJmfL88/wvhs6PzACm2veo8yQ==","shasum":"8a28a180c6631b354a64f94794e9b678665423ae","tarball":"https://registry.npmjs.org/@cordova-ohos/cordova-plugin-fingerprint-aio/-/cordova-plugin-fingerprint-aio-6.0.2.tgz","fileCount":11,"unpackedSize":71224,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEUCIHv/IOHeJ7VROAQH7MQN/z/24yTreMhi9WZaWxq4K1UNAiEA2XFlZSPLgSTVTXPR934ANhKKKhzJ1ROWCBl7u3hPrcs="}]},"_npmUser":{"name":"luqi_tan","email":"295099422@qq.com"},"directories":{},"maintainers":[{"name":"luqi_tan","email":"295099422@qq.com"},{"name":"wanpengsz","email":"wanpengsz@163.com"},{"name":"xkh111","email":"xukaihui11@163.com"},{"name":"hcordova","email":"chenlihuiabc@163.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/cordova-plugin-fingerprint-aio_6.0.2_1785152563601_0.4740682837330017"},"_hasShrinkwrap":false}},"time":{"created":"2026-03-20T07:49:57.864Z","modified":"2026-07-27T11:42:43.928Z","6.0.1":"2026-03-20T07:49:58.116Z","6.0.2":"2026-07-27T11:42:43.743Z"},"bugs":{"url":"https://gitcode.com/CPF-Cordova/cordova-plugin-fingerprint-aio/issues"},"author":{"name":"Huawei Device, Inc. Ltd. and","email":"马弓手"},"license":"Apache-2.0","keywords":["cordova","fingerprint-aio","ecosystem:cordova","cordova-openharmony"],"repository":{"type":"git","url":"gitcode:CPF-Cordova/cordova-plugin-fingerprint-aio"},"description":"Cordova fingerprint-aio Plugin","maintainers":[{"name":"luqi_tan","email":"295099422@qq.com"},{"name":"wanpengsz","email":"wanpengsz@163.com"},{"name":"xkh111","email":"xukaihui11@163.com"},{"name":"hcordova","email":"chenlihuiabc@163.com"}],"readme":"# cordova-plugin-fingerprint-aio\r\n\r\n[](README.md)\r\n[](README.en.md)\r\n\r\n本项目基于 [cordova-plugin-fingerprint-aio@6.0.1](https://www.npmjs.com/package/cordova-plugin-fingerprint-aio/v/6.0.1) 开发，本文档重点阐述其在 OpenHarmony（OHOS）系统中的具体应用。\r\n\r\n- [cordova-plugin-fingerprint-aio](#cordova-plugin-fingerprint-aio)\r\n - [简介](#简介)\r\n - [支持平台](#支持平台)\r\n - [下载安装](#下载安装)\r\n - [从 npm 安装（推荐）](#从-npm-安装推荐)\r\n - [从 GitCode 仓库安装](#从-gitcode-仓库安装)\r\n - [离线安装（本地包）](#离线安装本地包)\r\n - [安装后验证](#安装后验证)\r\n - [卸载](#卸载)\r\n - [约束与限制](#约束与限制)\r\n - [兼容性](#兼容性)\r\n - [使用示例](#使用示例)\r\n - [示例 1：检查设备生物识别支持状态](#示例-1检查设备生物识别支持状态)\r\n - [示例 2：执行生物识别认证](#示例-2执行生物识别认证)\r\n - [示例 3：安全存储敏感数据](#示例-3安全存储敏感数据)\r\n - [示例 4：读取安全存储的敏感数据](#示例-4读取安全存储的敏感数据)\r\n - [使用说明](#使用说明)\r\n - [核心 API 说明](#核心-api-说明)\r\n - [1. 检查设备生物识别支持状态](#1-检查设备生物识别支持状态)\r\n - [2. 执行生物识别认证](#2-执行生物识别认证)\r\n - [3. 安全存储敏感数据](#3-安全存储敏感数据)\r\n - [4. 读取安全存储的敏感数据（OHOS 无效）](#4-读取安全存储的敏感数据ohos-无效)\r\n - [目录结构](#目录结构)\r\n - [贡献代码](#贡献代码)\r\n - [许可证](#许可证)\r\n - [官方资源](#官方资源)\r\n\r\n\r\n## 简介\r\n\r\ncordova-plugin-fingerprint-aio（All-In-One Fingerprint Plugin）是 Cordova 生态中生物识别领域的主流插件，专为 Cordova 应用打造的跨平台生物识别工具，基于原生平台生物识别框架开发（Android Fingerprint API、iOS LocalAuthentication Framework），支持 Android 指纹识别、iOS 指纹（Touch ID）与面容识别（Face ID）及 OHOS 指纹识别，提供统一的认证接口与安全的密钥存储能力，适用于应用登录、敏感操作授权（如支付确认、数据加密）等场景，可有效提升应用安全性与用户体验。本文档重点说明其在 OpenHarmony 系统中的应用方法，核心价值如下：\r\n\r\n- 全平台生物识别支持：Android 端支持指纹识别（API Level 23+），iOS 端支持 Touch ID（iPhone 5s+、iPad Pro/Air 2+）与 Face ID（iPhone X+、iPad Pro 11-inch+），OHOS 5.0+ 指纹识别。\r\n\r\n- 统一认证接口：屏蔽 Android、iOS 和 OHOS 平台差异，使用同一套 API 实现生物识别认证，降低开发成本\r\n\r\n- 安全密钥存储：支持将敏感数据（如用户令牌、加密密钥）存储在设备安全区域（Android Keystore、iOS、OHOS Keychain），仅通过生物识别授权后可访问\r\n\r\n- 灵活的用户提示：可自定义认证弹窗标题、副标题、描述文本与取消按钮文案，匹配应用视觉风格\r\n\r\n- 错误处理完善：提供详细的错误码与描述（如“设备不支持”“用户取消认证”“生物识别已锁定”），便于业务逻辑处理\r\n\r\n- 轻量化设计：插件体积小（约 100KB），无第三方依赖，集成后不影响应用启动速度与运行性能\r\n\r\n## 支持平台\r\n\r\n- **Android**：API Level 23 及以上（支持指纹识别）\r\n\r\n- **iOS**：10.0 及以上（支持 Touch ID、Face ID，适配 iPhone 5s+、iPad Pro/Air 2+、iPhone X+ 等设备）\r\n\r\n- **OHOS**：5.0 及以上（支持指纹识别）\r\n\r\n## 下载安装\r\n\r\n通过 hcordova CLI 即可快速安装插件，支持从 npm 仓库或 GitCode 仓库获取，适配 OHOS 平台安装需求，可选择安装最新版本、指定版本或开发版本。\r\n\r\n### 从 npm 安装（推荐）\r\n\r\n```bash\r\n# 安装 hcordova 命令化工具\r\nnpm install -g hcordova\r\n\r\n# 安装最新版本（全平台）\r\nhcordova plugin add cordova-plugin-fingerprint-aio\r\n\r\n# 安装指定平台（仅 OHOS 平台）\r\nhcordova plugin add cordova-plugin-fingerprint-aio --platform ohos\r\n\r\n# 仅安装到 OHOS 平台，指定 1.0.0 版本\r\nhcordova plugin add cordova-plugin-fingerprint-aio@1.0.0 --platform ohos\r\n\r\n```\r\n\r\n### 从 GitCode 仓库安装\r\n\r\n仅为 OHOS 平台安装开发版本插件，可获取最新开发中的功能：\r\n\r\n```bash\r\n# 仅安装到 OHOS 平台，安装 GitCode 开发版本\r\nhcordova plugin add https://gitcode.com/CPF-Cordova/cordova-plugin-fingerprint-aio.git --platform ohos\r\n\r\n# 仅安装到 OHOS 平台，安装 GitCode 开发版本，指定标签/分支\r\nhcordova plugin add https://gitcode.com/CPF-Cordova/cordova-plugin-fingerprint-aio.git@develop --platform ohos\r\n```\r\n\r\n### 离线安装（本地包）\r\n\r\n适用于无网络环境，先下载插件包到本地，再执行离线安装：\r\n\r\n```bash\r\n# 下载插件包到本地（示例路径：../Downloads/cordova-plugin-fingerprint-aio）\r\n# 执行离线安装\r\nhcordova plugin add ../Downloads/cordova-plugin-fingerprint-aio --platform ohos\r\n```\r\n\r\n### 安装后验证\r\n\r\n安装完成后，可通过以下命令验证插件是否成功添加到项目中：\r\n\r\n```bash\r\n# 查看已安装的插件列表，若包含本插件 ID 则表示插件已成功安装\r\nhcordova plugin list\r\n```\r\n\r\n### 卸载\r\n\r\n```bash\r\n# Cordova CLI 全平台卸载\r\nhcordova plugin remove cordova-plugin-fingerprint-aio \r\n\r\n# 指定 OHOS 平台卸载\r\nhcordova plugin remove cordova-plugin-fingerprint-aio --platform ohos\r\n\r\n```\r\n\r\n## 约束与限制\r\n\r\n- 平台版本约束：需符合各平台最低版本要求（Android API Level 23+、iOS 10.0+、OHOS 5.0+），低于该版本可能出现功能异常或无法使用\r\n\r\n- OHOS 特性约束：OHOS 系统中，生物识别（指纹/人脸）由系统自动选择，无法通过接口手动设置；且不支持敏感数据存储功能，`registerBiometricSecret` 和 `loadBiometricSecret` 方法在 OHOS 平台仅触发认证，不执行存储/读取操作\r\n\r\n- 调用时机：所有 API 需在 `deviceready` 事件触发后调用，避免因原生接口未初始化导致报错\r\n\r\n- 设备支持约束：需确保设备具备相应的生物识别硬件（如指纹传感器、面容识别模块），否则 `isAvailable` 方法会返回不支持状态\r\n\r\n\r\n### 兼容性\r\n\r\n支持：\r\n\r\n| 项目 | 版本/信息 |\r\n|-----|--------|\r\n| SDK | API12+ |\r\n| IDE | DevEco Studio: 5.0+ |\r\n| ROM | 5.1+ |\r\n| Emulator | OpenHarmony 6.0+ |\r\n\r\n在以下版本中已测试通过：\r\n\r\n| 项目 | 版本/信息 |\r\n|-----|--------|\r\n| @cordova-ohos/ohos | 14.0.1-ohos-14.0.1 |\r\n| SDK | 5.0.0(12) |\r\n| IDE | DevEco Studio: 6.0.13.200 |\r\n| ROM | 5.1.0.120 SP3 |\r\n| Emulator | OpenHarmony 6.0.1(21) |\r\n\r\n## 使用示例\r\n\r\n以下提供 OHOS 平台常用使用示例，涵盖设备支持检查、生物识别认证、敏感数据存储/读取（注：OHOS 不支持存储/读取，仅触发认证），可直接复制到项目中调试使用，所有示例均需在 `deviceready` 事件触发后执行。\r\n\r\n### 示例 1：检查设备生物识别支持状态\r\n\r\n判断设备是否支持生物识别，根据返回结果展示或隐藏指纹登录按钮，适配 OHOS 平台特性。\r\n\r\n```javascript\r\n// 检查设备是否支持生物认证\r\nFingerprint.isAvailable(function(result){\r\n console.log(\"生物识别支持状态：\", result);\r\n if (result.isAvailable) {\r\n // 设备支持生物识别，可显示指纹登录按钮\r\n } else {\r\n // 设备不支持，隐藏指纹登录按钮\r\n }\r\n},function(error){\r\n // 设备不支持，隐藏指纹登录按钮\r\n},{requireStrongBiometrics:true})\r\n\r\n```\r\n\r\n### 示例 2：执行生物识别认证\r\n\r\n触发生物识别认证流程，自定义认证提示文案，处理认证成功与失败逻辑，适配 OHOS 系统自动选择生物识别方式的特性。\r\n\r\n```javascript\r\n/**\r\n* 执行生物识别认证\r\n* @param {AuthenticationOptions} options - 认证配置参数（可选）\r\n* @returns {Promise} - 认证成功则 resolved，失败则 rejected 并返回错误信息\r\n*/\r\n\r\nFingerprint.show({\r\n description: \"Some biometric description\"\r\n}, function successCallback(){\r\n console.log(\"Authentication successful\");\r\n}, function errorCallback(error){\r\n console.log(\"Authentication invalid \" + error.message);\r\n});\r\n\r\n```\r\n\r\n### 示例 3：安全存储敏感数据\r\n\r\nOHOS 功能限制说明：OHOS 平台不支持敏感数据存储功能，调用该方法仅触发生物识别认证，不执行存储操作，失效效果与 show 函数相同。\r\n\r\n```javascript\r\nfunction successCallback(){\r\n console.log(\"Authentication successful\");\r\n}\r\n\r\nfunction errorCallback(error){\r\n console.log(\"Authentication invalid \" + error.message);\r\n}\r\n\r\nFingerprint.registerBiometricSecret({\r\n description: \"Some biometric description\", \r\n secret: \"my-super-secret\",// OHOS 无效\r\n invalidateOnEnrollment: true,\r\n disableBackup: true, // OHOS 无效\r\n }, successCallback, errorCallback);\r\n```\r\n\r\n### 示例 4：读取安全存储的敏感数据\r\n\r\nOHOS 功能限制说明：OHOS 平台不支持敏感数据读取功能，调用该方法仅触发生物识别认证，不执行读取操作，失效效果与 show 函数相同。\r\n\r\n```javascript\r\nfunction successCallback(secret){\r\n console.log(\"Authentication successful, secret: \" + secret);\r\n}\r\n\r\nfunction errorCallback(error){\r\n console.log(\"Authentication invalid \" + error.message);\r\n}\r\n\r\nFingerprint.loadBiometricSecret({\r\n description: \"Some biometric description\",\r\n disableBackup: true, \r\n}, successCallback, errorCallback);\r\n\r\n```\r\n\r\n## 使用说明\r\n\r\n本插件核心功能为跨平台生物识别认证与敏感数据安全存储（OHOS 平台不支持存储/读取），适配 OHOS 平台特性，通过全局对象 `window.Fingerprint` 暴露所有 API，支持 Promise 调用方式（推荐）与回调函数调用方式，所有 API 需在 `deviceready` 事件触发后调用。\r\n\r\n### 核心 API 说明\r\n\r\n插件所有核心 API 均通过全局对象 `window.Fingerprint` 暴露，涵盖设备支持检查、生物识别认证、敏感数据存储与读取四大功能，其中敏感数据存储/读取在 OHOS 平台无效，仅触发认证流程。\r\n\r\n#### 1. 检查设备生物识别支持状态\r\n\r\n```javascript\r\n// 是否支持生物认证\r\nFingerprint.isAvailable(function(result){\r\n console.log(\"生物识别支持状态：\", result);\r\n if (result.isAvailable) {\r\n // 设备支持生物识别，可显示指纹登录按钮\r\n } else {\r\n // 设备不支持，隐藏指纹登录按钮\r\n }\r\n},function(error){\r\n // 设备不支持，隐藏指纹登录按钮\r\n},{requireStrongBiometrics:true})\r\n\r\n```\r\n\r\n参数说明：`requireStrongBiometrics`（可选，布尔值）：是否要求强生物识别，默认 true，OHOS 平台适配该参数。\r\n\r\n返回结果：result 对象包含 `isAvailable`（布尔值，是否支持生物识别）、`biometryType`（字符串，生物识别类型，OHOS 平台仅返回“fingerprint”）。\r\n\r\n#### 2. 执行生物识别认证\r\n\r\n```javascript\r\n/**\r\n* 执行生物识别认证\r\n* @param {AuthenticationOptions} options - 认证配置参数（可选）\r\n* @returns {Promise} - 认证成功则 resolved，失败则 rejected 并返回错误信息\r\n*/\r\n\r\nFingerprint.show({\r\n description: \"Some biometric description\"\r\n}, function successCallback(){\r\n console.log(\"Authentication successful\");\r\n}, function errorCallback(error){\r\n console.log(\"Authentication invalid \" + error.message);\r\n});\r\n\r\n```\r\n\r\n参数说明：options（可选，对象）：包含 `description`（认证弹窗描述文本）、`title`（弹窗标题，可选）、`subtitle`（弹窗副标题，可选）、`cancelButtonText`（取消按钮文案，可选）。\r\n\r\n回调说明：successCallback（认证成功回调，无参数）；errorCallback（认证失败回调，参数为 error 对象，包含错误信息）。\r\n\r\n#### 3. 安全存储敏感数据\r\n\r\n```javascript\r\n// OHOS 不能存储，失效效果和 show 函数相同\r\nfunction successCallback(){\r\n console.log(\"Authentication successful\");\r\n}\r\n\r\nfunction errorCallback(error){\r\n console.log(\"Authentication invalid \" + error.message);\r\n}\r\nFingerprint.registerBiometricSecret({\r\n description: \"Some biometric description\", \r\n secret: \"my-super-secret\",// OHOS 无效\r\n invalidateOnEnrollment: true,\r\n disableBackup: true, // OHOS 无效\r\n }, successCallback, errorCallback);\r\n\r\n```\r\n\r\n参数说明：options（必填，对象）：`description`（认证弹窗描述）、`secret`（需存储的敏感数据，OHOS 无效）、`invalidateOnEnrollment`（布尔值，重新录入生物识别后是否失效，默认 true）、`disableBackup`（布尔值，是否禁用备份密码，OHOS 无效）。\r\n\r\n注意：OHOS 平台调用该方法仅触发生物识别认证，不存储任何数据，认证成功/失败回调与 show 函数一致。\r\n\r\n#### 4. 读取安全存储的敏感数据（OHOS 无效）\r\n\r\n```javascript\r\n// OHOS 不能存储，失效效果和 show 函数相同\r\nfunction successCallback(secret){\r\n console.log(\"Authentication successful, secret: \" + secret);\r\n}\r\n\r\nfunction errorCallback(error){\r\n console.log(\"Authentication invalid \" + error.message);\r\n}\r\n\r\nFingerprint.loadBiometricSecret({\r\n description: \"Some biometric description\",\r\n disableBackup: true, \r\n}, successCallback, errorCallback);\r\n\r\n```\r\n\r\n参数说明：options（必填，对象）：`description`（认证弹窗描述）、`disableBackup`（布尔值，是否禁用备份密码，OHOS 无效）。\r\n\r\n注意：OHOS 平台调用该方法仅触发生物识别认证，不读取任何数据，successCallback 不会返回 secret 参数，认证成功/失败回调与 show 函数一致。\r\n\r\n## 目录结构\r\n\r\n```\r\ncordova-plugin-fingerprint-aio/\r\n├── src/ # 源代码目录\r\n│ └── main/ # 主要源代码\r\n│ ├── cpp/ # C++ 原生代码\r\n│ │ └── Fingerprint/ # 指纹模块\r\n│ │ ├── Fingerprint.cpp # 指纹识别功能的 C++ 实现\r\n│ │ └── Fingerprint.h # 指纹识别功能的头文件\r\n│ └── ets/ # ArkTS 代码（OpenHarmony API）\r\n│ └── components/ # 组件目录\r\n│ └── Fingerprint/ # 指纹组件\r\n│ └── Fingerprint.ets # 指纹识别的 ArkTS 实现\r\n├── www/ # Web 资源目录\r\n│ └── Fingerprint.js # JavaScript 指纹识别接口（Cordova 桥接层）\r\n├── .gitignore # Git 忽略文件配置\r\n├── LICENSE # 项目开源许可证\r\n├── OAT.xml # OpenHarmony 审核配置文件\r\n├── package.json # Node.js 包配置\r\n├── plugin.xml # Cordova 插件描述文件（核心配置）\r\n└── README.md # 项目说明文档\r\n```\r\n\r\n## 贡献代码\r\n\r\n使用过程中发现任何问题都可以提 [Issue](https://gitcode.com/CPF-Cordova/cordova-plugin-fingerprint-aio/issues) ，当然也非常欢迎发 [PR](https://gitcode.com/CPF-Cordova/cordova-plugin-fingerprint-aio/pulls) 共建。\r\n\r\n## 许可证\r\n\r\n本插件基于 **Apache License** 开源，详见 [LICENSE](LICENSE) 文件。\r\n\r\n## 官方资源\r\n\r\n- Android 和 iOS：[cordova-plugin-fingerprint-aio 官方指南](https://www.npmjs.com/package/cordova-plugin-fingerprint-aio)\r\n\r\n- GitCode 仓库：[CPF-Cordova/cordova-plugin-fingerprint-aio](https://gitcode.com/CPF-Cordova/cordova-plugin-fingerprint-aio)\r\n","readmeFilename":"README.md"}