chrome.webAuthenticationProxy

Açıklama

chrome.webAuthenticationProxy API, uzak ana makine üzerinde çalışan uzaktan masaüstü yazılımlarının Web Authentication API (WebAuthn) isteklerine yerel bir istemcide işlem yapmak için müdahale etmelerini sağlar.

İzinler

webAuthenticationProxy

Kullanılabilirlik

Chrome 115 ve sonraki sürümler MV3 ve sonraki sürümler

Türler

CreateRequest

Özellikler

  • requestDetailsJson

    dize

    JSON dizesi olarak serileştirilmiş şekilde, navigator.credentials.create() cihazına iletilen PublicKeyCredentialCreationOptions. Serileştirme biçimi PublicKeyCredential.parseCreationOptionsFromJSON() ile uyumludur.

  • requestId

    sayı

    İstek için opak tanımlayıcı.

CreateResponseDetails

Özellikler

  • hata

    DOMExceptionDetails isteğe bağlı

    Varsa, uzak istekten elde edilen DOMException.

  • requestId

    sayı

    CreateRequest öğesinin requestId.

  • responseJson

    string isteğe bağlı

    Varsa uzak istekten elde edilen PublicKeyCredential, href="https://w3c.github.io/webauthn/#dom-publickeycredential-tojson"> PublicKeyCredential.toJSON() çağrısı yapılarak JSON dizesi olarak serileştirilir.

DOMExceptionDetails

Özellikler

  • mesaj

    dize

  • ad

    dize

GetRequest

Özellikler

  • requestDetailsJson

    dize

    JSON dizesi olarak serileştirilmiş şekilde, navigator.credentials.get() cihazına iletilen PublicKeyCredentialRequestOptions. Serileştirme biçimi PublicKeyCredential.parseRequestOptionsFromJSON() ile uyumludur.

  • requestId

    sayı

    İstek için opak tanımlayıcı.

GetResponseDetails

Özellikler

  • hata

    DOMExceptionDetails isteğe bağlı

    Varsa, uzak istekten elde edilen DOMException.

  • requestId

    sayı

    CreateRequest öğesinin requestId.

  • responseJson

    string isteğe bağlı

    Varsa uzak istekten elde edilen PublicKeyCredential, href="https://w3c.github.io/webauthn/#dom-publickeycredential-tojson"> PublicKeyCredential.toJSON() çağrısı yapılarak JSON dizesi olarak serileştirilir.

IsUvpaaRequest

Özellikler

  • requestId

    sayı

    İstek için opak tanımlayıcı.

IsUvpaaResponseDetails

Özellikler

  • isUvpaa

    boolean

  • requestId

    sayı

Yöntemler

attach()

Söz 
chrome.webAuthenticationProxy.attach(
  callback?: function,
)

Bu uzantıyı etkin Web Authentication API isteği proxy'si yapar.

Uzaktan masaüstü uzantıları, genellikle bu ana makineye bir uzak oturumun eklendiğini tespit ettikten sonra bu yöntemi çağırır. Bu yöntem hatasız olarak döndürüldüğünde, WebAuthn isteklerinin normal işlenmesi askıya alınır ve bu uzantı API'sinden etkinlikler yükselir.

Halihazırda farklı bir uzantı eklenmişse bu yöntem hatayla başarısız olur.

Ekli uzantı, WebAuthn isteklerini normal şekilde işlemeye devam etmek için uzaktan masaüstü oturumu sona erdiğinde detach() yöntemini çağırmalıdır. Uzantılar kaldırılırsa otomatik olarak ayrılır.

Uzak oturum ekinin yerel bir uygulamadan (muhtemelen askıya alınmış) uzantıya geçişini bildirmek için onRemoteSessionStateChange etkinliğine bakın.

Parametreler

  • geri çağırma

    Functions (isteğe bağlı)

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

    (error?: string)=>void

    • hata

      string isteğe bağlı

İlerlemeler

  • Söz<dize|undefined>

    Vaatler, Manifest V3 ve sonraki sürümlerde desteklenir ancak geriye dönük uyumluluk için geri çağırmalar sağlanır. Aynı işlev çağrısında ikisini birden kullanamazsınız. Vaat, geri çağırmaya iletilen aynı türle çözümlenir.

completeCreateRequest()

Söz 
chrome.webAuthenticationProxy.completeCreateRequest(
  details: CreateResponseDetails,
  callback?: function,
)

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

Parametreler

  • ayrıntılar

    CreateResponseDetails

  • geri çağırma

    Functions (isteğe bağlı)

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

    ()=>void

İlerlemeler

  • Promise<void>

    Vaatler, Manifest V3 ve sonraki sürümlerde desteklenir ancak geriye dönük uyumluluk için geri çağırmalar sağlanır. Aynı işlev çağrısında ikisini birden kullanamazsınız. Vaat, geri çağırmaya iletilen aynı türle çözümlenir.

completeGetRequest()

Söz 
chrome.webAuthenticationProxy.completeGetRequest(
  details: GetResponseDetails,
  callback?: function,
)

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

Parametreler

  • ayrıntılar

    GetResponseDetails

  • geri çağırma

    Functions (isteğe bağlı)

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

    ()=>void

İlerlemeler

  • Promise<void>

    Vaatler, Manifest V3 ve sonraki sürümlerde desteklenir ancak geriye dönük uyumluluk için geri çağırmalar sağlanır. Aynı işlev çağrısında ikisini birden kullanamazsınız. Vaat, geri çağırmaya iletilen aynı türle çözümlenir.

completeIsUvpaaRequest()

Söz 
chrome.webAuthenticationProxy.completeIsUvpaaRequest(
  details: IsUvpaaResponseDetails,
  callback?: function,
)

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

Parametreler

  • ayrıntılar

    IsUvpaaResponseDetails

  • geri çağırma

    Functions (isteğe bağlı)

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

    ()=>void

İlerlemeler

  • Promise<void>

    Vaatler, Manifest V3 ve sonraki sürümlerde desteklenir ancak geriye dönük uyumluluk için geri çağırmalar sağlanır. Aynı işlev çağrısında ikisini birden kullanamazsınız. Vaat, geri çağırmaya iletilen aynı türle çözümlenir.

detach()

Söz 
chrome.webAuthenticationProxy.detach(
  callback?: function,
)

Bu uzantıyı etkin Web Authentication API isteği proxy'si olmaktan çıkarır.

Bu yöntem genellikle uzantı, bir uzaktan masaüstü oturumunun sonlandırıldığını algıladığında çağrılır. Bu yöntem döndürüldüğünde uzantı artık etkin Web Authentication API isteği proxy'si olmaz.

Uzak oturum ekinin yerel bir uygulamadan (muhtemelen askıya alınmış) uzantıya geçişini bildirmek için onRemoteSessionStateChange etkinliğine bakın.

Parametreler

  • geri çağırma

    Functions (isteğe bağlı)

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

    (error?: string)=>void

    • hata

      string isteğe bağlı

İlerlemeler

  • Söz<dize|undefined>

    Vaatler, Manifest V3 ve sonraki sürümlerde desteklenir ancak geriye dönük uyumluluk için geri çağırmalar sağlanır. Aynı işlev çağrısında ikisini birden kullanamazsınız. Vaat, geri çağırmaya iletilen aynı türle çözümlenir.

Etkinlikler

onCreateRequest

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

Bir WebAuthn navigator.credentials.create() çağrısı gerçekleştiğinde tetiklenir. Uzantı requestInfo içindeki requestId ile completeCreateRequest() yöntemini çağırarak bir yanıt sağlamalıdır.

Parametreler

  • geri çağırma

    işlev

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

    (requestInfo: CreateRequest)=>void

onGetRequest

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

Bir WebAuthn navigator.credentials.get() çağrısı gerçekleştiğinde tetiklenir. Uzantı, requestInfo içindeki requestId ile completeGetRequest() yöntemini çağırarak bir yanıt sağlamalıdır.

Parametreler

  • geri çağırma

    işlev

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

    (requestInfo: GetRequest)=>void

onIsUvpaaRequest

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

PublicKeyCredential.isUserVerifyingPlatformAuthenticatorAvailable() çağrısı gerçekleştiğinde tetiklenir. Uzantı, requestInfo içindeki requestId ile completeIsUvpaaRequest() yöntemini çağırarak bir yanıt sağlamalıdır.

Parametreler

onRemoteSessionStateChange

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

Bu uzantıyla ilişkilendirilmiş yerel bir uygulama, varsayılan kullanıcı verileri dizini içindeki WebAuthenticationProxyRemoteSessionStateChange adlı bir dizinde, uzantının kimliğine eşit bir ada sahip bir dosyaya yazılarak 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ğinin değiştirilmesine gerek yoktur.

Yerel ana makine uygulaması, uzantı hizmet çalışanı askıya alınmışken olası bir uzak oturum durumu değişikliğine (ör. ayrılmış durumundan ekliye veya tam tersi) işaret etmek için bu etkinlik mekanizmasını kullanabilir. Bu etkinliğin işleyicisinde, uzantı uygun şekilde attach() veya detach() API yöntemlerini çağırabilir.

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

Parametreler

  • geri çağırma

    işlev

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

    ()=>void

onRequestCanceled

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

Bir onCreateRequest veya onGetRequest etkinliği iptal edildiğinde (WebAuthn isteği arayan tarafından iptal edildiği veya istek zaman aşımına uğradığı için) tetiklenir. Bu etkinliği aldığınızda, uzantı ilgili isteğin istemci tarafında işlenmesini iptal etmelidir. Uzantılar, iptal edilen istekleri gerçekleştiremez.

Parametreler

  • geri çağırma

    işlev

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

    (requestId: number)=>void

    • requestId

      sayı