chrome.webAuthenticationProxy

说明

借助 chrome.webAuthenticationProxy API，远程主机上运行的远程桌面软件可以拦截 Web Authentication API (WebAuthn) 请求，以便在本地客户端上处理这些请求。

权限

webAuthenticationProxy

可用性

Chrome 115 及更高版本 MV3+

类型

CreateRequest

属性

  • requestDetailsJson

    字符串

    传递给 navigator.credentials.create() 的 PublicKeyCredentialCreationOptions（已序列化为 JSON 字符串）。序列化格式与 PublicKeyCredential.parseCreationOptionsFromJSON() 兼容。

  • requestId

    number

    请求的不透明标识符。

CreateResponseDetails

属性

  • 错误

    DOMExceptionDetails optional

    远程请求生成的 DOMException（如果有）。

  • requestId

    number

    CreateRequest 的 requestId。

  • responseJson

    字符串（可选）

    由远程请求生成的 PublicKeyCredential（如果有），通过调用 href="https://w3c.github.io/webauthn/#dom-publickeycredential-tojson"> 序列化为 JSON 字符串PublicKeyCredential.toJSON()。

DOMExceptionDetails

属性

  • 消息

    字符串

  • name

    字符串

GetRequest

属性

  • requestDetailsJson

    字符串

    传递给 navigator.credentials.get() 的 PublicKeyCredentialRequestOptions（已序列化为 JSON 字符串）。序列化格式与 PublicKeyCredential.parseRequestOptionsFromJSON() 兼容。

  • requestId

    number

    请求的不透明标识符。

GetResponseDetails

属性

  • 错误

    DOMExceptionDetails optional

    远程请求生成的 DOMException（如果有）。

  • requestId

    number

    CreateRequest 的 requestId。

  • responseJson

    字符串（可选）

    由远程请求生成的 PublicKeyCredential（如果有），通过调用 href="https://w3c.github.io/webauthn/#dom-publickeycredential-tojson"> 序列化为 JSON 字符串PublicKeyCredential.toJSON()。

IsUvpaaRequest

属性

  • requestId

    number

    请求的不透明标识符。

IsUvpaaResponseDetails

属性

  • isUvpaa

    布尔值

  • requestId

    number

方法

attach()

<ph type="x-smartling-placeholder"></ph> 承诺 
chrome.webAuthenticationProxy.attach(
  callback?: function,
)

将此扩展程序设为活跃的 Web Authentication API 请求代理。

远程桌面扩展程序通常会在检测到远程会话连接到此主机后调用此方法。如果此方法无错误返回，系统会暂停 WebAuthn 请求的常规处理，并引发此扩展程序 API 中的事件。

如果已连接其他扩展程序，此方法将失败并显示错误。

远程桌面会话结束后，附加的扩展程序必须调用 detach()，才能继续处理常规 WebAuthn 请求。扩展程序在卸载后会自动分离。

如需了解远程会话连接从原生应用更改为（可能已暂停）的扩展程序，请参阅 onRemoteSessionStateChange 事件。

参数

  • callback

    函数（可选）

    callback 参数如下所示： 

    (error?: string) => void

    • 错误

      字符串（可选）

返回

  • Promise<string |未定义>

    Manifest V3 及更高版本支持 Promise，但为以下项目提供回调： 向后兼容性您不能在同一个函数调用中同时使用这两者。通过 promise 使用传递给回调的类型进行解析。

completeCreateRequest()

<ph type="x-smartling-placeholder"></ph> 承诺 
chrome.webAuthenticationProxy.completeCreateRequest(
  details: CreateResponseDetails,
  callback?: function,
)

报告 navigator.credentials.create() 调用的结果。扩展程序必须针对收到的每个 onCreateRequest 事件调用此方法，除非请求已取消（在这种情况下，会触发 onRequestCanceled 事件）。

参数

  • 详细信息

    CreateResponseDetails

  • callback

    函数（可选）

    callback 参数如下所示： 

    () => void

返回

  • 承诺<void>

    Manifest V3 及更高版本支持 Promise，但为以下项目提供回调： 向后兼容性您不能在同一个函数调用中同时使用这两者。通过 promise 使用传递给回调的类型进行解析。

completeGetRequest()

<ph type="x-smartling-placeholder"></ph> 承诺 
chrome.webAuthenticationProxy.completeGetRequest(
  details: GetResponseDetails,
  callback?: function,
)

报告 navigator.credentials.get() 调用的结果。扩展程序必须针对收到的每个 onGetRequest 事件调用此方法，除非请求已取消（在这种情况下，会触发 onRequestCanceled 事件）。

参数

  • 详细信息

    GetResponseDetails

  • callback

    函数（可选）

    callback 参数如下所示： 

    () => void

返回

  • 承诺<void>

    Manifest V3 及更高版本支持 Promise，但为以下项目提供回调： 向后兼容性您不能在同一个函数调用中同时使用这两者。通过 promise 使用传递给回调的类型进行解析。

completeIsUvpaaRequest()

<ph type="x-smartling-placeholder"></ph> 承诺 
chrome.webAuthenticationProxy.completeIsUvpaaRequest(
  details: IsUvpaaResponseDetails,
  callback?: function,
)

报告 PublicKeyCredential.isUserVerifyingPlatformAuthenticator() 调用的结果。扩展程序必须针对收到的每个 onIsUvpaaRequest 事件调用此方法。

参数

返回

  • 承诺<void>

    Manifest V3 及更高版本支持 Promise，但为以下项目提供回调： 向后兼容性您不能在同一个函数调用中同时使用这两者。通过 promise 使用传递给回调的类型进行解析。

detach()

<ph type="x-smartling-placeholder"></ph> 承诺 
chrome.webAuthenticationProxy.detach(
  callback?: function,
)

将此扩展程序从活跃的 Web Authentication API 请求代理中移除。

当扩展程序检测到远程桌面会话已终止时，通常会调用此方法。在该方法返回后，该扩展程序就不再是活跃的 Web Authentication API 请求代理。

如需了解远程会话连接从原生应用更改为（可能已暂停）的扩展程序，请参阅 onRemoteSessionStateChange 事件。

参数

  • callback

    函数（可选）

    callback 参数如下所示： 

    (error?: string) => void

    • 错误

      字符串（可选）

返回

  • Promise<string |未定义>

    Manifest V3 及更高版本支持 Promise，但为以下项目提供回调： 向后兼容性您不能在同一个函数调用中同时使用这两者。通过 promise 使用传递给回调的类型进行解析。

事件

onCreateRequest

chrome.webAuthenticationProxy.onCreateRequest.addListener(
  callback: function,
)

在发生 WebAuthn navigator.credentials.create() 调用时触发。该扩展程序必须通过使用来自 requestInfo 的 requestId 调用 completeCreateRequest() 来提供响应。

参数

onGetRequest

chrome.webAuthenticationProxy.onGetRequest.addListener(
  callback: function,
)

在发生 WebAuthn navigator.credentials.get() 调用时触发。该扩展程序必须通过来自 requestInfo 的 requestId 调用 completeGetRequest() 来提供响应

参数

  • callback

    函数

    callback 参数如下所示： 

    (requestInfo: GetRequest) => void

onIsUvpaaRequest

chrome.webAuthenticationProxy.onIsUvpaaRequest.addListener(
  callback: function,
)

在发生 PublicKeyCredential.isUserVerifyingPlatformAuthenticatorAvailable() 调用时触发。该扩展程序必须通过来自 requestInfo 的 requestId 调用 completeIsUvpaaRequest() 来提供响应

参数

onRemoteSessionStateChange

chrome.webAuthenticationProxy.onRemoteSessionStateChange.addListener(
  callback: function,
)

与此扩展程序相关联的原生应用可通过向 默认用户数据目录中名为 WebAuthenticationProxyRemoteSessionStateChange 的目录写入与扩展程序 ID 相同的文件来触发此事件。

该文件的内容应为空。也就是说，无需更改文件的内容即可触发此事件。

当扩展程序 Service Worker 可能处于暂停状态时，原生主机应用可以使用此事件机制发出信号，指示远程会话状态可能发生变化（即从已分离状态变为已连接状态，反之亦然）。在此事件的处理程序中，扩展程序可以相应地调用 attach() 或 detach() API 方法。

事件监听器必须在加载时同步注册。

参数

  • callback

    函数

    callback 参数如下所示： 

    () => void

onRequestCanceled

chrome.webAuthenticationProxy.onRequestCanceled.addListener(
  callback: function,
)

在 onCreateRequest 或 onGetRequest 事件被取消（因为 WebAuthn 请求被调用方取消或超时）时触发。收到此事件时，扩展程序应在客户端取消对相应请求的处理。请求一旦取消，扩展程序便无法完成。

参数

  • callback

    函数

    callback 参数如下所示： 

    (requestId: number) => void

    • requestId

      number