browser.webAuthenticationProxy

Beschrijving

Met de chrome.webAuthenticationProxy API kan software voor extern bureaublad die op een externe host wordt uitgevoerd, Web Authentication API-verzoeken (WebAuthn) onderscheppen om ze op een lokale client te verwerken.

Rechten

webAuthenticationProxy

Beschikbaarheid

Chrome 115+ browser.* sinds Chrome 148 MV3+

Typen

CreateRequest

Eigenschappen

  • requestDetailsJson

    tekenreeks

    De PublicKeyCredentialCreationOptions die is doorgegeven aan navigator.credentials.create(), geserialiseerd als een JSON-tekenreeks. De serialisatie-indeling is compatibel met PublicKeyCredential.parseCreationOptionsFromJSON().

  • requestId

    getal

    Een ondoorzichtige ID voor het verzoek.

CreateResponseDetails

Eigenschappen

  • fout

    DOMExceptionDetails optioneel

    De DOMException die is opgeleverd door het verzoek op afstand, indien van toepassing.

  • requestId

    getal

    De requestId van de CreateRequest.

  • responseJson

    tekenreeks optioneel

    De PublicKeyCredential, opgeleverd door het externe verzoek, indien van toepassing, geserialiseerd als een json-tekenreeks door href="https://w3c.github.io/webauthn/#dom-publickeycredential-tojson"> PublicKeyCredential.toJSON() aan te roepen.

DOMExceptionDetails

Eigenschappen

  • bericht

    tekenreeks

  • name

    tekenreeks

GetRequest

Eigenschappen

  • requestDetailsJson

    tekenreeks

    De PublicKeyCredentialRequestOptions die is doorgegeven aan navigator.credentials.get(), geserialiseerd als een JSON-tekenreeks. De serialisatie-indeling is compatibel met PublicKeyCredential.parseRequestOptionsFromJSON().

  • requestId

    getal

    Een ondoorzichtige ID voor het verzoek.

GetResponseDetails

Eigenschappen

  • fout

    DOMExceptionDetails optioneel

    De DOMException die is opgeleverd door het verzoek op afstand, indien van toepassing.

  • requestId

    getal

    De requestId van de CreateRequest.

  • responseJson

    tekenreeks optioneel

    De PublicKeyCredential, opgeleverd door het externe verzoek, indien van toepassing, geserialiseerd als een json-tekenreeks door href="https://w3c.github.io/webauthn/#dom-publickeycredential-tojson"> PublicKeyCredential.toJSON() aan te roepen.

IsUvpaaRequest

Eigenschappen

  • requestId

    getal

    Een ondoorzichtige ID voor het verzoek.

IsUvpaaResponseDetails

Eigenschappen

  • isUvpaa

    booleaans

  • requestId

    getal

Methoden

attach()

browser.webAuthenticationProxy.attach(): Promise<string | undefined>

Maakt deze extensie de actieve proxy voor Web Authentication API-verzoeken.

Extensies voor extern bureaublad roepen deze methode meestal aan nadat ze hebben vastgesteld dat een externe sessie aan deze host is gekoppeld. Zodra deze methode zonder fouten wordt geretourneerd, wordt de normale verwerking van WebAuthn-verzoeken opgeschort en worden gebeurtenissen van deze extensie-API gegenereerd.

Deze methode mislukt met een foutmelding als er al een andere extensie is gekoppeld.

De bijgevoegde extensie moet detach() aanroepen nadat de sessie op het externe bureaublad is beëindigd om de normale verwerking van WebAuthn-verzoeken te hervatten. Extensies worden automatisch losgekoppeld als ze worden verwijderd.

Ga naar de gebeurtenis onRemoteSessionStateChange om een wijziging van de bijlage van de externe sessie van een systeemeigen app naar de (mogelijk opgeschorte) extensie aan te geven.

Retourzendingen

  • Promise<string | undefined>

completeCreateRequest()

browser.webAuthenticationProxy.completeCreateRequest(
  details: CreateResponseDetails,
): Promise<void>

Rapporteert het resultaat van een navigator.credentials.create()-aanroep. De extensie moet dit aanroepen voor elke onCreateRequest-gebeurtenis die deze heeft gekregen, tenzij het verzoek is geannuleerd (in dat geval wordt een onRequestCanceled-gebeurtenis geactiveerd).

Parameters

Retourzendingen

  • Promise<void>

completeGetRequest()

browser.webAuthenticationProxy.completeGetRequest(
  details: GetResponseDetails,
): Promise<void>

Rapporteert het resultaat van een navigator.credentials.get()-aanroep. De extensie moet dit aanroepen voor elke onGetRequest-gebeurtenis die deze heeft gekregen, tenzij het verzoek is geannuleerd (in dat geval wordt een onRequestCanceled-gebeurtenis geactiveerd).

Parameters

Retourzendingen

  • Promise<void>

completeIsUvpaaRequest()

browser.webAuthenticationProxy.completeIsUvpaaRequest(
  details: IsUvpaaResponseDetails,
): Promise<void>

Rapporteert het resultaat van een PublicKeyCredential.isUserVerifyingPlatformAuthenticator()-aanroep. De extensie moet dit aanroepen voor elke onIsUvpaaRequest-gebeurtenis die deze heeft gekregen.

Parameters

Retourzendingen

  • Promise<void>

detach()

browser.webAuthenticationProxy.detach(): Promise<string | undefined>

Verwijdert deze extensie als de actieve proxy voor Web Authentication API-verzoeken.

Deze methode wordt meestal aangeroepen als de extensie vaststelt dat een externe bureaubladsessie is beëindigd. Zodra deze methode is geretourneerd, is de extensie niet meer de actieve Web Authentication API-verzoekproxy.

Ga naar de gebeurtenis onRemoteSessionStateChange om een wijziging van de bijlage van de externe sessie van een systeemeigen app naar de (mogelijk opgeschorte) extensie aan te geven.

Retourzendingen

  • Promise<string | undefined>

Evenementen

onCreateRequest

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

Wordt geactiveerd als er een WebAuthn navigator.credentials.create()-aanroep plaatsvindt. De extensie moet een reactie geven door completeCreateRequest() aan te roepen met de requestId van requestInfo.

Parameters

onGetRequest

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

Wordt geactiveerd als er een WebAuthn navigator.credentials.get()-aanroep plaatsvindt. De extensie moet een reactie leveren door completeGetRequest() aan te roepen met de requestId van requestInfo

Parameters

  • callback

    functie

    De parameter callback ziet er zo uit: 

    (requestInfo: GetRequest) => void

onIsUvpaaRequest

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

Wordt geactiveerd als er een PublicKeyCredential.isUserVerifyingPlatformAuthenticatorAvailable()-aanroep plaatsvindt. De extensie moet een reactie leveren door completeIsUvpaaRequest() aan te roepen met de requestId van requestInfo

Parameters

onRemoteSessionStateChange

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

Een systeemeigen app die aan deze extensie is gekoppeld, kan deze gebeurtenis activeren door te schrijven naar een bestand met een naam die gelijk is aan de ID van de extensie in een directory met de naam WebAuthenticationProxyRemoteSessionStateChange in de standaard directory voor gebruikersgegevens

De inhoud van het bestand moet leeg zijn. Het is dus niet nodig om de inhoud van het bestand te wijzigen om deze gebeurtenis te activeren.

De native host-app kan dit gebeurtenismechanisme gebruiken om een mogelijke wijziging in de status van de externe sessie aan te geven (bijvoorbeeld van losgekoppeld naar gekoppeld of omgekeerd) terwijl de servicemedewerker van de extensie mogelijk is opgeschort. In de handler voor deze gebeurtenis kan de extensie de API-methoden attach() of detach() aanroepen.

De gebeurtenislistener moet synchroon worden geregistreerd op het moment van laden.

Parameters

  • callback

    functie

    De parameter callback ziet er zo uit: 

    () => void

onRequestCanceled

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

Wordt geactiveerd als een onCreateRequest- of onGetRequest-gebeurtenis wordt geannuleerd (omdat het WebAuthn-verzoek is afgebroken door de beller of omdat er een time-out is opgetreden). Als de extensie deze gebeurtenis krijgt, moet deze de verwerking van het bijbehorende verzoek aan de clientzijde annuleren. Extensies kunnen een verzoek niet voltooien nadat het is geannuleerd.

Parameters

  • callback

    functie

    De parameter callback ziet er zo uit: 

    (requestId: number) => void

    • requestId

      getal