browser.webAuthenticationProxy

Açıklama

chrome.webAuthenticationProxy API, uzak bir ana makinede çalışan uzaktan masaüstü yazılımının, yerel bir istemcide işlemek için Web Authentication API (WebAuthn) isteklerini yakalamasına olanak tanır.

İzinler

webAuthenticationProxy

Kullanılabilirlik

Chrome 115+ Chrome 148'den itibaren browser.* MV3+

Türler

CreateRequest

Özellikler

  • requestDetailsJson

    dize

    navigator.credentials.create() işlevine iletilen ve JSON dizesi olarak serileştirilen PublicKeyCredentialCreationOptions. Serileştirme biçimi PublicKeyCredential.parseCreationOptionsFromJSON() ile uyumludur.

  • requestId

    sayı

    İsteğin opak tanımlayıcısı.

CreateResponseDetails

Özellikler

  • hata

    DOMExceptionDetails isteğe bağlı

    Varsa uzaktan istek tarafından döndürülen DOMException.

  • requestId

    sayı

    CreateRequest öğesinin requestId.

  • responseJson

    string isteğe bağlı

    Uzak istek tarafından döndürülen PublicKeyCredential (varsa), href="https://w3c.github.io/webauthn/#dom-publickeycredential-tojson"> PublicKeyCredential.toJSON() çağrılarak JSON dizesi olarak serileştirilir.

DOMExceptionDetails

Özellikler

  • mesaj

    dize

  • ad

    dize

GetRequest

Özellikler

  • requestDetailsJson

    dize

    navigator.credentials.get() işlevine iletilen ve JSON dizesi olarak serileştirilen PublicKeyCredentialRequestOptions. Serileştirme biçimi PublicKeyCredential.parseRequestOptionsFromJSON() ile uyumludur.

  • requestId

    sayı

    İsteğin opak tanımlayıcısı.

GetResponseDetails

Özellikler

  • hata

    DOMExceptionDetails isteğe bağlı

    Varsa uzaktan istek tarafından döndürülen DOMException.

  • requestId

    sayı

    CreateRequest öğesinin requestId.

  • responseJson

    string isteğe bağlı

    Uzak istek tarafından döndürülen PublicKeyCredential (varsa), href="https://w3c.github.io/webauthn/#dom-publickeycredential-tojson"> PublicKeyCredential.toJSON() çağrılarak JSON dizesi olarak serileştirilir.

IsUvpaaRequest

Özellikler

  • requestId

    sayı

    İsteğin opak tanımlayıcısı.

IsUvpaaResponseDetails

Özellikler

  • isUvpaa

    boole

  • requestId

    sayı

Yöntemler

attach()

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

Bu uzantıyı etkin Web Authentication API istek proxy'si yapar.

Uzak masaüstü uzantıları genellikle bu ana makineye bir uzak oturumun eklendiğini algıladıktan sonra bu yöntemi çağırır. Bu yöntem hatasız bir şekilde döndürüldüğünde WebAuthn isteklerinin normal işlenmesi askıya alınır ve bu uzantı API'sinden etkinlikler oluşturulur.

Farklı bir uzantı zaten ekliyse bu yöntem hata verir.

Ekli uzantı, normal WebAuthn istek işleme sürecini devam ettirmek için uzak masaüstü oturumu sona erdiğinde detach() yöntemini çağırmalıdır. Uzantılar kaldırıldığında otomatik olarak ayrılır.

Yerel bir uygulamadan (muhtemelen askıya alınmış) uzantıya uzaktan oturum ekinde değişiklik olduğunu bildirmek için onRemoteSessionStateChange etkinliğine bakın.

İadeler

  • Promise<string | undefined>

completeCreateRequest()

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

Bir navigator.credentials.create() çağrısının sonucunu bildirir. Uzantı, istek iptal edilmediği sürece (bu durumda bir onRequestCanceled etkinliği tetiklenir) aldığı her onCreateRequest etkinliği için bunu çağırmalıdır.

Parametreler

İadeler

  • Promise<void>

completeGetRequest()

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

Bir navigator.credentials.get() çağrısının sonucunu bildirir. Uzantı, istek iptal edilmediği sürece (bu durumda bir onRequestCanceled etkinliği tetiklenir) aldığı her onGetRequest etkinliği için bunu çağırmalıdır.

Parametreler

İadeler

  • Promise<void>

completeIsUvpaaRequest()

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

Bir PublicKeyCredential.isUserVerifyingPlatformAuthenticator() çağrısının sonucunu bildirir. Uzantı, aldığı her onIsUvpaaRequest etkinliği için bunu çağırmalıdır.

Parametreler

İadeler

  • Promise<void>

detach()

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

Bu uzantıyı etkin Web Authentication API istek proxy'si olmaktan kaldırır.

Bu yöntem genellikle uzantı, uzak masaüstü oturumunun sonlandırıldığını algıladığında çağrılır. Bu yöntem döndürüldükten sonra uzantı, etkin Web Authentication API istek proxy'si olmaktan çıkar.

Yerel bir uygulamadan (muhtemelen askıya alınmış) uzantıya uzaktan oturum ekinde değişiklik olduğunu bildirmek için onRemoteSessionStateChange etkinliğine bakın.

İadeler

  • Promise<string | undefined>

Etkinlikler

onCreateRequest

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

Bir WebAuthn navigator.credentials.create() çağrısı gerçekleştiğinde tetiklenir. Uzantı, requestInfo üzerinden requestId ile completeCreateRequest() yöntemini çağırarak yanıt vermelidir.

Parametreler

onGetRequest

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

Bir WebAuthn navigator.credentials.get() çağrısı gerçekleştiğinde tetiklenir. Uzantı, requestInfo üzerinden requestId ile completeGetRequest() yöntemini çağırarak yanıt vermelidir.

Parametreler

  • callback

    işlev

    callback parametresi şu şekilde görünür: 

    (requestInfo: GetRequest) => void

onIsUvpaaRequest

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

PublicKeyCredential.isUserVerifyingPlatformAuthenticatorAvailable() araması gerçekleştiğinde tetiklenir. Uzantı, requestInfo üzerinden requestId ile completeIsUvpaaRequest() yöntemini çağırarak yanıt vermelidir.

Parametreler

onRemoteSessionStateChange

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

Bu uzantıyla ilişkili yerel bir uygulama, varsayılan kullanıcı verileri dizini içindeki WebAuthenticationProxyRemoteSessionStateChange adlı dizinde, adı uzantının kimliğiyle aynı olan bir dosyaya yazarak bu etkinliğin tetiklenmesine neden olabilir.

Dosyanın içeriği boş olmalıdır. Yani bu etkinliği tetiklemek için dosyanın içeriğini değiştirmek gerekmez.

Yerel barındırılan uygulama, uzantı hizmet çalışanının askıya alınabileceği durumlarda olası bir uzaktan oturum durumu değişikliğini (ör. ayrılmıştan eklenmişe veya tam tersi) bildirmek için bu etkinlik mekanizmasını kullanabilir. Bu etkinliğin işleyicisinde uzantı, attach() veya detach() API yöntemlerini uygun şekilde çağırabilir.

Etkinlik işleyici, yükleme sırasında eşzamanlı olarak kaydedilmelidir.

Parametreler

  • callback

    işlev

    callback parametresi şu şekilde görünür: 

    () => void

onRequestCanceled

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

Bir onCreateRequest veya onGetRequest etkinliği iptal edildiğinde (WebAuthn isteği, arayan tarafından iptal edildiği veya zaman aşımına uğradığı için) tetiklenir. Bu etkinlik alındığında uzantı, istemci tarafında ilgili isteğin işlenmesini iptal etmelidir. Uzantılar, iptal edilen istekleri tamamlayamaz.

Parametreler

  • callback

    işlev

    callback parametresi şu şekilde görünür: 

    (requestId: number) => void

    • requestId

      sayı