Descripción
La API de chrome.webAuthenticationProxy
permite que el software de escritorio remoto que se ejecuta en un host remoto intercepte las solicitudes de la API de Web Authentication (WebAuthn) para controlarlas en un cliente local.
Permisos
webAuthenticationProxy
Disponibilidad
Tipos
CreateRequest
Propiedades
- requestDetailsJson
string
El
PublicKeyCredentialCreationOptions
que se pasó anavigator.credentials.create()
, serializado como una cadena JSON. El formato de serialización es compatible conPublicKeyCredential.parseCreationOptionsFromJSON()
. - requestId
número
Es un identificador opaco de la solicitud.
CreateResponseDetails
Propiedades
- error
DOMExceptionDetails opcional
Es el
DOMException
que generó la solicitud remota, si la hubo. - requestId
número
Es el
requestId
delCreateRequest
. - responseJson
cadena opcional
El
PublicKeyCredential
, generado por la solicitud remota, si existe, serializado como una cadena JSON llamando a href="https://w3c.github.io/webauthn/#dom-publickeycredential-tojson">PublicKeyCredential.toJSON()
.
DOMExceptionDetails
Propiedades
- mensaje
string
- nombre
string
GetRequest
Propiedades
- requestDetailsJson
string
El
PublicKeyCredentialRequestOptions
que se pasó anavigator.credentials.get()
, serializado como una cadena JSON. El formato de serialización es compatible conPublicKeyCredential.parseRequestOptionsFromJSON()
. - requestId
número
Es un identificador opaco de la solicitud.
GetResponseDetails
Propiedades
- error
DOMExceptionDetails opcional
Es el
DOMException
que generó la solicitud remota, si la hubo. - requestId
número
Es el
requestId
delCreateRequest
. - responseJson
cadena opcional
El
PublicKeyCredential
, generado por la solicitud remota, si existe, serializado como una cadena JSON llamando a href="https://w3c.github.io/webauthn/#dom-publickeycredential-tojson">PublicKeyCredential.toJSON()
.
IsUvpaaRequest
Propiedades
- requestId
número
Es un identificador opaco de la solicitud.
IsUvpaaResponseDetails
Propiedades
- isUvpaa
booleano
- requestId
número
Métodos
attach()
chrome.webAuthenticationProxy.attach(): Promise<string | undefined>
Convierte esta extensión en el proxy activo de la API de Web Authentication.
Por lo general, las extensiones de escritorio remoto llaman a este método después de detectar la conexión de una sesión remota a este host. Una vez que este método se devuelve sin errores, se suspende el procesamiento normal de las solicitudes de WebAuthn y se generan eventos desde esta API de extensión.
Este método falla con un error si ya hay adjunta otra extensión.
La extensión adjunta debe llamar a detach()
una vez que finalice la sesión de escritorio remoto para reanudar el procesamiento normal de solicitudes de WebAuthn. Las extensiones se desconectan automáticamente si se descargan.
Consulta el evento onRemoteSessionStateChange
para indicar un cambio en la vinculación de la sesión remota de una aplicación nativa a la extensión (posiblemente suspendida).
Muestra
-
Promesa<cadena | undefined>
completeCreateRequest()
chrome.webAuthenticationProxy.completeCreateRequest(
details: CreateResponseDetails,
): Promise<void>
Informa el resultado de una llamada a navigator.credentials.create()
. La extensión debe llamar a este método para cada evento onCreateRequest
que haya recibido, a menos que se haya cancelado la solicitud (en cuyo caso, se activa un evento onRequestCanceled
).
Parámetros
- detalles
Muestra
-
Promise<void>
completeGetRequest()
chrome.webAuthenticationProxy.completeGetRequest(
details: GetResponseDetails,
): Promise<void>
Informa el resultado de una llamada a navigator.credentials.get()
. La extensión debe llamar a este método para cada evento onGetRequest
que haya recibido, a menos que se haya cancelado la solicitud (en cuyo caso, se activa un evento onRequestCanceled
).
Parámetros
- detalles
Muestra
-
Promise<void>
completeIsUvpaaRequest()
chrome.webAuthenticationProxy.completeIsUvpaaRequest(
details: IsUvpaaResponseDetails,
): Promise<void>
Informa el resultado de una llamada a PublicKeyCredential.isUserVerifyingPlatformAuthenticator()
. La extensión debe llamar a este método para cada evento onIsUvpaaRequest
que haya recibido.
Parámetros
- detalles
Muestra
-
Promise<void>
detach()
chrome.webAuthenticationProxy.detach(): Promise<string | undefined>
Quita esta extensión para que deje de ser el proxy activo de la solicitud de la API de Web Authentication.
Por lo general, se llama a este método cuando la extensión detecta que se finalizó una sesión de escritorio remoto. Una vez que este método devuelve un valor, la extensión deja de ser el proxy activo de la API de Web Authentication.
Consulta el evento onRemoteSessionStateChange
para indicar un cambio en la vinculación de la sesión remota de una aplicación nativa a la extensión (posiblemente suspendida).
Muestra
-
Promesa<cadena | undefined>
Eventos
onCreateRequest
chrome.webAuthenticationProxy.onCreateRequest.addListener(
callback: function,
)
Se activa cuando se produce una llamada a navigator.credentials.create()
de WebAuthn. La extensión debe proporcionar una respuesta llamando a completeCreateRequest()
con el requestId
de requestInfo
.
Parámetros
- callback
función
El parámetro
callback
se ve de la siguiente manera:(requestInfo: CreateRequest) => void
- requestInfo
-
onGetRequest
chrome.webAuthenticationProxy.onGetRequest.addListener(
callback: function,
)
Se activa cuando se produce una llamada a navigator.credentials.get() de WebAuthn. La extensión debe proporcionar una respuesta llamando a completeGetRequest()
con el requestId
de requestInfo
.
Parámetros
- callback
función
El parámetro
callback
se ve de la siguiente manera:(requestInfo: GetRequest) => void
- requestInfo
-
onIsUvpaaRequest
chrome.webAuthenticationProxy.onIsUvpaaRequest.addListener(
callback: function,
)
Se activa cuando se realiza una llamada a PublicKeyCredential.isUserVerifyingPlatformAuthenticatorAvailable()
. La extensión debe proporcionar una respuesta llamando a completeIsUvpaaRequest()
con el requestId
de requestInfo
.
Parámetros
- callback
función
El parámetro
callback
se ve de la siguiente manera:(requestInfo: IsUvpaaRequest) => void
- requestInfo
-
onRemoteSessionStateChange
chrome.webAuthenticationProxy.onRemoteSessionStateChange.addListener(
callback: function,
)
Una aplicación nativa asociada a esta extensión puede hacer que se active este evento escribiendo en un archivo con un nombre igual al ID de la extensión en un directorio llamado WebAuthenticationProxyRemoteSessionStateChange
dentro del directorio de datos del usuario predeterminado.
El contenido del archivo debe estar vacío. Es decir, no es necesario cambiar el contenido del archivo para activar este evento.
La aplicación host nativa puede usar este mecanismo de eventos para indicar un posible cambio de estado de la sesión remota (es decir, de desconectada a conectada, o viceversa) mientras el service worker de la extensión está posiblemente suspendido. En el controlador de este evento, la extensión puede llamar a los métodos de API attach()
o detach()
según corresponda.
El objeto de escucha de eventos debe registrarse de forma síncrona en el momento de la carga.
Parámetros
- callback
función
El parámetro
callback
se ve de la siguiente manera:() => void
onRequestCanceled
chrome.webAuthenticationProxy.onRequestCanceled.addListener(
callback: function,
)
Se activa cuando se cancela un evento onCreateRequest
o onGetRequest
(porque el llamador anuló la solicitud de WebAuthn o porque se agotó el tiempo de espera). Cuando recibe este evento, la extensión debe cancelar el procesamiento de la solicitud correspondiente del lado del cliente. Las extensiones no pueden completar una solicitud una vez que se canceló.
Parámetros
- callback
función
El parámetro
callback
se ve de la siguiente manera:(requestId: number) => void
- requestId
número
-