密码插件

用于创建和认证的电容插件 密码 基于 网络认证 标准.

特征

Capacitor Passkeys插件是Capacitor App最完整的密码认证解决方案之一. 以下是一些关键特征:

• 🔐 密码创建: 以平台验证器注册新的密码.
• 🔑 密码认证: 认证用户已有的密码.
• 🌐 WebAuthn 标准: 使用WebAuthn JSON序列化,所以任何WebAuthn服务器库工作不变.
• 📱 可用性检查:检查设备上是否有密码.
• 🖥️ 网络支持:通过原生WebAuthn浏览器API提供完整网页支持.
• 🤝 兼容性: 与 生物计量 财务报告和审定财务报表 奥奥特 插件 .
• 📦 可可花和SPM:支持CocoaPods和Swift软件包管理器用于iOS.
• 🔁 最新数据:总是支持最新的Capacitor版本.

缺少一个功能? 刚刚 打开一个问题 我们看看!

使用大小写

Passkeys 插件通常用于应用程序认证的现代化,例如:

• 无密码登录:让用户使用密码进行认证,而不是输入密码.
• 密码:让现有用户在签入其现有证书后为其账户注册密码.
• 逐步加强: 检查用 isAvailable() 是否在设备上支持密码,并作为您已有的登录的替代品提供密码.
• 服务器集成:通过WebAuthn服务器库传递任何WebAuthn服务器库的选项和结果,这要归功于WebAuthn JSON序列化.

兼容性

安装

你可以用我们的 AI 辅助设置 以安装插件. 添加数据 超级技能 至您的 AI 工具,使用以下命令:

npx skills add capawesome-team/skills --skill capacitor-plugins

然后使用下列提示:

 Use the `capacitor-plugins` skill from `capawesome-team/skills` to install the `@capawesome/capacitor-passkeys` plugin in my project.

如果你喜欢 手动设置,通过运行以下命令来安装插件,并遵循下面的平台特定指令:

npm install @capawesome/capacitor-passkeys
npx cap sync

机器人

在Android上,Passkey在Android 9(API 第28级)上得到支持,更高处有可用的证书提供商(如Google密码管理员).

变量

此插件将使用以下工程变量( 在您的应用程序中定义) variables.gradle 文件名 :

• $androidxCredentialsVersion 版本 androidx.credentials:credentials 财务报告和审定财务报表 androidx.credentials:credentials-play-services-auth (默认 : 1.5.0(中文(简体) )

数字资产链接

您的应用必须和依赖方的域域相关( Namerp.id 编号 : rpId)使用 数字资产链接。为此,托管 JSON 文件 https://<your-domain>/.well-known/assetlinks.json 代表大会 common.get_login_creds 允许您的应用程序 :

[
  {
    "relation": [
      "delegate_permission/common.handle_all_urls",
      "delegate_permission/common.get_login_creds"
    ],
    "target": {
      "namespace": "android_app",
      "package_name": "com.example.app",
      "sha256_cert_fingerprints": [
        "01:23:45:67:89:AB:CD:EF:01:23:45:67:89:AB:CD:EF:01:23:45:67:89:AB:CD:EF:01:23:45:67:89:AB:CD:EF"
      ]
    }
  }
]

替换 com.example.app 上面有你的应用软件的标识 还有你的应用软件的签名证书的SHA -256指纹 否则,插件方法将用 DOMAIN_NOT_ASSOCIATED 错误代码 .

iOS系统

在iOS上,在iOS 15上和上方支持密码.

相关领域

您的应用必须和依赖方的域域相关( Namerp.id 编号 : rpId) (中文(简体) ). 为此,增加: 相关领域 能力 webcredentials 应用程序的服务类型 :

<key>com.apple.developer.associated-domains</key>
<array>
  <string>webcredentials:example.com</string>
</array>

此外,主办方 apple-app-site-association 文件位于 https://<your-domain>/.well-known/apple-app-site-association数字 :

{
  "webcredentials": {
    "apps": ["TEAMID.com.example.app"]
  }
}

替换 TEAMID 与您的 Apple 开发团队 ID 和 com.example.app 与您的应用程序的捆绑标识符。 否则,插件方法将用 DOMAIN_NOT_ASSOCIATED 错误代码 .

配置

此插件不需要配置 .

使用量

以下例子说明如何用已存在的密码来创建新的密码,认证,并检查设备上是否有密码.

创建新密码

注册用户账户的新密码 。 在真实的应用程序中, 选项必须由您的 WebAuthn 服务器提供, 结果必须返回到它进行验证 :

import { Passkeys } from '@capawesome/capacitor-passkeys';

const createPasskey = async () => {
  // In a real app, the options must be provided by your WebAuthn server,
  // e.g. via `generateRegistrationOptions()` from SimpleWebAuthn.
  const result = await Passkeys.createPasskey({
    attestation: 'none',
    authenticatorSelection: {
      residentKey: 'required',
      userVerification: 'required',
    },
    challenge: 'dGhpc2lzYWNoYWxsZW5nZQ',
    pubKeyCredParams: [
      { alg: -7, type: 'public-key' },
      { alg: -257, type: 'public-key' },
    ],
    rp: { id: 'example.com', name: 'Example Inc.' },
    user: {
      displayName: 'Jane Doe',
      id: 'anVzdGFyYW5kb21pZA',
      name: '[email protected]',
    },
  });
  // Pass the result to your WebAuthn server for verification,
  // e.g. via `verifyRegistrationResponse()` from SimpleWebAuthn.
  return result;
};

使用已有的密码认证

用先前为依赖方创建的密码在用户签名 。 再次, 选项来自您的 WebAuthn 服务器, 其结果由它验证 :

import { Passkeys } from '@capawesome/capacitor-passkeys';

const getPasskey = async () => {
  // In a real app, the options must be provided by your WebAuthn server,
  // e.g. via `generateAuthenticationOptions()` from SimpleWebAuthn.
  const result = await Passkeys.getPasskey({
    challenge: 'dGhpc2lzYWNoYWxsZW5nZQ',
    rpId: 'example.com',
    userVerification: 'required',
  });
  // Pass the result to your WebAuthn server for verification,
  // e.g. via `verifyAuthenticationResponse()` from SimpleWebAuthn.
  return result;
};

检查是否有密码

在您的登录用户界面中提供密码之前, 请检查设备上是否有密码 。 在Android上,这个返回 true 如果设备运行Android 9(API 第28级)或更高。 在iOS上,它总是返回 true。在网络上,此返回 true 如果浏览器支持WebAuthn,并且有用户验证平台认证器:

import { Passkeys } from '@capawesome/capacitor-passkeys';

const isAvailable = async () => {
  const { available } = await Passkeys.isAvailable();
  return available;
};

API 密码

• createPasskey(...)
• getPasskey(...)
• isAvailable()
• 接口
• 类型异名

创建 Passkey (...)

createPasskey(options: CreatePasskeyOptions) => Promise<CreatePasskeyResult>

创建( 注册) 新密码 .

选项映射 WebAuthn PublicKeyCredentialCreationOptions 贾森 串行化,以便任意 WebAuthn 服务器库提供的值 可以通过没有改变的通道.

回返情况: Promise<CreatePasskeyResult>

自: 0.1.0 (中文(简体) )

获取 Passkey (...)

getPasskey(options: GetPasskeyOptions) => Promise<GetPasskeyResult>

获取( 自动) 现有的密码 .

选项映射 WebAuthn PublicKeyCredentialRequestOptions 贾森 串行化,以便任意 WebAuthn 服务器库提供的值 可以通过没有改变的通道.

回返情况: Promise<GetPasskeyResult>

自: 0.1.0 (中文(简体) )

易读 ()

isAvailable() => Promise<IsAvailableResult>

检查此设备是否有密码 .

打开 机器人,这个返回 true 如果设备运行Android 9(API 第28级)或更高. 打开 iOS系统,它总是返回 true。 。 。 . 打开 网页,这个返回 true 如果浏览器支持WebAuthn和 有用户验证的平台认证器.

回返情况: Promise<IsAvailableResult>

自: 0.1.0 (中文(简体) )

接口

创建 Passkey 结果

密码的创造结果.

此镜像 WebAuthn RegistrationResponseJSON 这样就可以了 转到任何 WebAuthn 服务器库进行校验.

创建 Passkey 响应

认证人关于办理新通行证注册的回复.

此镜像 WebAuthn AuthenticatorAttestationResponse 贾森 连载化.

创建 Passkey 选项

密码校正器选择

认证者必须满足的标准才能创建出密码.

密码键证书描述符

识别特定证书的描述符.

通行证

依赖方的公钥证书类型和算法 服务器支持 .

密码存储方

为谁创建了密码的依赖方.

密码用户

创建密码的用户账户 .

获取 Passkey 结果

密码认证的结果.

此镜像 WebAuthn AuthenticationResponseJSON 这样就可以了 转到任何 WebAuthn 服务器库进行校验.

获取 Passkey 响应

认证人对认证的答复 现有密码.

此镜像 WebAuthn AuthenticatorAssertionResponse 贾森 连载化.

获取 Passkey 选项

易伤性结果

类型异名

密码校正

认证器附件模式 .

'cross-platform' | 'platform'

密码运输

认证人支持的运输工具.

'ble' | 'hybrid' | 'internal' | 'nfc' | 'smart-card' | 'usb'

密码交换站

证明传递偏好.

'direct' | 'enterprise' | 'indirect' | 'none'

密码

依赖方希望在多大程度上 可发现证书( passkey).

'discouraged' | 'preferred' | 'required'

密码用户验证

用户核查要求.

• discouraged:依赖方倾向于不进行用户验证.
• preferred:依赖方倾向于用户验证,但将 没有它,操作就不会失败.
• required:依赖方需要用户验证.

'discouraged' | 'preferred' | 'required'

测试

在测试您的密码集成时, 请记住以下内容 :

• 建议使用的真正设备:在真设备上进行测试,设置了屏幕锁. 在iOS上,模拟器支持自iOS 16. 在Android上,模拟器需要Google Play服务并设置了谷歌密码管理器的Google账户.
• WebAuthn 服务器: 此插件实例中的挑战只是占位符 。 在制作过程中,必须生成选项,结果必须由 WebAuthn 服务器库验证,例如 简单WebAuthn (节点.js)或 java-webauthn 服务器 (贾瓦语).
• 域协会: 依赖方ID必须与您的应用程序相关(参见安装部分). 域关联变化需要一些时间来传播,因为文件被苹果和谷歌缓存.

限制

有条件的 UI( passkey 自动填充) 不支持此插件 。 操作系统自动填充集成以本地文本字段为目标,而不是网页视图中的HTML输入.

财务问题

此插件与其他类似插件有何不同?

它使用 JSON 序列化执行完整的WebAuthn 标准,所以任何WebAuthn 服务器库的选项和结果都会在Android,iOS,和Web上通过,没有改变. Passkey 创建、认证和 a isAvailable() 能力检查全部通过一个完全打字,积极维护的API进行. 如果您只需要本地的面部或指纹检查,简单的生物鉴别设置就足够了;如果您想要用服务器验证的密码来替换跨越每个平台的密码,这个插件就是为此设计的.

为什么插件方法会用 DOMAIN_NOT_ASSOCIATED 错误代码 ?

此错误意味着您的应用程序与依赖方的域无关( Namerp.id 编号 : rpId) (中文(简体) ). 在Android上,您必须托管数字资产链接文件 https://<your-domain>/.well-known/assetlinks.json 代表大会 common.get_login_creds 允许您的应用程序。 在iOS上,您必须添加关联域的能力与 webcredentials 服务类型和主机匹配 apple-app-site-association 文档。 见 安装 详细情况。 还要记住,这些文件的更改可能需要一些时间来传播,因为它们被苹果和谷歌缓存.

我需要我自己的WebAuthn服务器来使用这个插件吗?

对 例子中显示的挑战只是占位符。 在生产中,选择 createPasskey(...) 财务报告和审定财务报表 getPasskey(...) 必须使用 WebAuthn 服务器生成,结果必须经过它验证,例如使用库,例如 简单WebAuthn。由于插件使用 WebAuthn JSON 序列化,任何WebAuthn 服务器库都未变.

哪些设备支持密码?

在Android上,Passkey在Android 9(API 第28级)上得到支持并更高,拥有Google密码管理器等可用的认证提供者. 在iOS上,在iOS 15上和上方支持密码. 在网络上,在使用用户验证平台认证器执行WebAuthn的浏览器中支持密码. 使用 isAvailable() 在运行时检查可用性的方法.

此插件是否支持密码自动填充( 有条件的 UI ) ?

不, 有条件的 UI 不支持 。 操作系统自动填充集成以本地文本字段为目标,而不是网页视图中的HTML输入. 见 限制 详细情况.

这个插件和生物测量插件有什么区别?

这个 生物计量 插件在设备上执行本地生物鉴别检查(如面部或指纹识别),例如保护您应用中的屏幕. Passkeys插件执行WebAuthn标准,其中认证由您服务器加密验证,使其适合完全替换基于密码的登录.

我能用这个插件吗? 有Ionic、React、Vue或Angular?

是的,插件是框架不可知的。 它在任意网络框架的Capacitor app中工作,包括有Angular,React,或Vue的Ionic,以及平版JavaScript等项目.

相关插件

• 生物计量:请求生物鉴别认证,如面部或指纹识别.
• 奥奥特: 与OAuth 2.0和OpenID Connection 供应商通信.
• 密码自动填充: 将密码保存到平台认证商店.
• 安全优惠:安全地存储密钥/值对,如密码或令牌等.

通讯

随时更新有关卡帕韦索姆、Capacitor和Ionic生态系统的最新消息和最新消息,因为我们 《卡帕索克通讯》。 。 。 .

更改日志

见 变动情况。 。 。 .

许可证

见 自由主义。 。 。 .