chrome.webAuthenticationProxy

Beschrijving

Met de chrome.webAuthenticationProxy API kan externe desktopsoftware die op een externe host draait, Web Authentication API (WebAuthn)-aanvragen onderscheppen om deze op een lokale client af te handelen.

Machtigingen

webAuthenticationProxy

Beschikbaarheid

Chroom 115+ MV3+

Soorten

CreateRequest

Eigenschappen

  • requestDetailsJson

    snaar

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

  • verzoekID

    nummer

    Een ondoorzichtige ID voor het verzoek.

CreateResponseDetails

Eigenschappen

  • fout

    DOMExceptionDetails optioneel

    De DOMException die wordt gegenereerd door het externe verzoek, indien aanwezig.

  • verzoekID

    nummer

    De requestId van CreateRequest .

  • reactieJson

    tekenreeks optioneel

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

DOMExceptionDetails

Eigenschappen

  • bericht

    snaar

  • naam

    snaar

GetRequest

Eigenschappen

  • requestDetailsJson

    snaar

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

  • verzoekID

    nummer

    Een ondoorzichtige ID voor het verzoek.

GetResponseDetails

Eigenschappen

  • fout

    DOMExceptionDetails optioneel

    De DOMException die wordt gegenereerd door het externe verzoek, indien aanwezig.

  • verzoekID

    nummer

    De requestId van CreateRequest .

  • reactieJson

    tekenreeks optioneel

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

IsUvpaaRequest

Eigenschappen

  • verzoekID

    nummer

    Een ondoorzichtige ID voor het verzoek.

IsUvpaaResponseDetails

Eigenschappen

  • isUvpaa

    Booleaans

  • verzoekID

    nummer

Methoden

attach()

Belofte
chrome.webAuthenticationProxy.attach(
  callback?: function,
)

Maakt van deze extensie de actieve webverificatie-API-verzoekproxy.

Extern bureaublad-extensies roepen deze methode doorgaans aan na het detecteren van een bijlage van een externe sessie met deze host. Zodra deze methode zonder fouten terugkeert, wordt de reguliere verwerking van WebAuthn-verzoeken opgeschort en worden er gebeurtenissen uit deze extensie-API gegenereerd.

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

De bijgevoegde extensie moet detach() aanroepen zodra de sessie met extern bureaublad is beëindigd om de reguliere verwerking van WebAuthn-aanvragen te kunnen hervatten. Extensies worden automatisch losgemaakt als ze worden gelost.

Raadpleeg de gebeurtenis onRemoteSessionStateChange voor het signaleren van een wijziging van de externe sessiebijlage van een native applicatie naar de (mogelijk opgeschorte) extensie.

Parameters

  • terugbellen

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    (error?: string) => void

    • fout

      tekenreeks optioneel

Retouren

  • Belofte<tekenreeks | ongedefinieerd>

    Beloften worden ondersteund in Manifest V3 en hoger, maar er zijn callbacks beschikbaar voor achterwaartse compatibiliteit. U kunt niet beide gebruiken bij dezelfde functieaanroep. De belofte wordt opgelost met hetzelfde type dat wordt doorgegeven aan de callback.

completeCreateRequest()

Belofte
chrome.webAuthenticationProxy.completeCreateRequest(
  details: CreateResponseDetails,
  callback?: function,
)

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

Parameters

  • terugbellen

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    () => void

Retouren

  • Beloof <nietig>

    Beloften worden ondersteund in Manifest V3 en hoger, maar er zijn callbacks beschikbaar voor achterwaartse compatibiliteit. U kunt niet beide gebruiken bij dezelfde functieaanroep. De belofte wordt opgelost met hetzelfde type dat wordt doorgegeven aan de callback.

completeGetRequest()

Belofte
chrome.webAuthenticationProxy.completeGetRequest(
  details: GetResponseDetails,
  callback?: function,
)

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

Parameters

  • terugbellen

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    () => void

Retouren

  • Beloof <nietig>

    Beloften worden ondersteund in Manifest V3 en hoger, maar er zijn callbacks beschikbaar voor achterwaartse compatibiliteit. U kunt niet beide gebruiken bij dezelfde functieaanroep. De belofte wordt opgelost met hetzelfde type dat wordt doorgegeven aan de callback.

completeIsUvpaaRequest()

Belofte
chrome.webAuthenticationProxy.completeIsUvpaaRequest(
  details: IsUvpaaResponseDetails,
  callback?: function,
)

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

Parameters

  • terugbellen

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    () => void

Retouren

  • Beloof <nietig>

    Beloften worden ondersteund in Manifest V3 en hoger, maar er zijn callbacks beschikbaar voor achterwaartse compatibiliteit. U kunt niet beide gebruiken bij dezelfde functieaanroep. De belofte wordt opgelost met hetzelfde type dat wordt doorgegeven aan de callback.

detach()

Belofte
chrome.webAuthenticationProxy.detach(
  callback?: function,
)

Hiermee wordt deze extensie verwijderd als actieve webverificatie-API-verzoekproxy.

Deze methode wordt doorgaans aangeroepen wanneer de extensie detecteert dat een extern bureaublad-sessie is beëindigd. Zodra deze methode terugkeert, is de extensie niet langer de actieve Web Authentication API-verzoekproxy.

Raadpleeg de gebeurtenis onRemoteSessionStateChange voor het signaleren van een wijziging van de externe sessiebijlage van een native applicatie naar de (mogelijk opgeschorte) extensie.

Parameters

  • terugbellen

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    (error?: string) => void

    • fout

      tekenreeks optioneel

Retouren

  • Belofte<tekenreeks | ongedefinieerd>

    Beloften worden ondersteund in Manifest V3 en hoger, maar er zijn callbacks beschikbaar voor achterwaartse compatibiliteit. U kunt niet beide gebruiken bij dezelfde functieaanroep. De belofte wordt opgelost met hetzelfde type dat wordt doorgegeven aan de callback.

Evenementen

onCreateRequest

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

Wordt geactiveerd wanneer een WebAuthn-aanroep navigator.credentials.create() plaatsvindt. De extensie moet een antwoord leveren door completeCreateRequest() aan te roepen met de requestId uit requestInfo .

Parameters

onGetRequest

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

Wordt geactiveerd wanneer een WebAuthn-aanroep navigator.credentials.get() plaatsvindt. De extensie moet een antwoord geven door completeGetRequest() aan te roepen met de requestId uit requestInfo

Parameters

  • terugbellen

    functie

    De callback parameter ziet er als volgt uit: 

    (requestInfo: GetRequest) => void

onIsUvpaaRequest

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

Wordt geactiveerd wanneer een PublicKeyCredential.isUserVerifyingPlatformAuthenticatorAvailable() -aanroep plaatsvindt. De extensie moet een antwoord geven door completeIsUvpaaRequest() aan te roepen met de requestId uit requestInfo

Parameters

onRemoteSessionStateChange

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

Een native applicatie die aan deze extensie is gekoppeld, kan ervoor zorgen dat deze gebeurtenis wordt geactiveerd door te schrijven naar een bestand met een naam die gelijk is aan de ID van de extensie in een map met de naam WebAuthenticationProxyRemoteSessionStateChange in de standaardmap met gebruikersgegevens

De inhoud van het bestand moet leeg zijn. Dat wil zeggen dat het niet nodig is om de inhoud van het bestand te wijzigen om deze gebeurtenis te activeren.

De native hosttoepassing kan dit gebeurtenismechanisme gebruiken om een ​​mogelijke wijziging van de sessiestatus op afstand te signaleren (dat wil zeggen van losgekoppeld naar gekoppeld, of omgekeerd) terwijl de extensieservicemedewerker mogelijk is opgeschort. In de handler voor deze gebeurtenis kan de extensie dienovereenkomstig de API-methoden attach() of detach() aanroepen.

De gebeurtenislistener moet tijdens het laden synchroon worden geregistreerd.

Parameters

  • terugbellen

    functie

    De callback parameter ziet er als volgt uit: 

    () => void

onRequestCanceled

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

Wordt geactiveerd wanneer een onCreateRequest of onGetRequest gebeurtenis wordt geannuleerd (omdat de WebAuthn-aanvraag is afgebroken door de aanroeper of omdat er een time-out is opgetreden). Wanneer deze gebeurtenis wordt ontvangen, moet de extensie de verwerking van het overeenkomstige verzoek aan de clientzijde annuleren. Extensies kunnen een verzoek niet voltooien nadat het is geannuleerd.

Parameters

  • terugbellen

    functie

    De callback parameter ziet er als volgt uit: 

    (requestId: number) => void

    • verzoekID

      nummer