chrome.webAuthenticationProxy

Açıklama

chrome.webAuthenticationProxy API, uzak ana makine üzerinde çalışan uzaktan masaüstü yazılımının, yerel bir istemcide işlemek üzere Web Authentication API (WebAuthn) isteklerine müdahale etmesine olanak tanır.

İzinler

webAuthenticationProxy

Kullanılabilirlik

Chrome 115 ve sonraki sürümler MV3+

Türler

CreateRequest

Özellikler

  • requestDetailsJson

    dize

    navigator.credentials.create() öğesine geçirilen PublicKeyCredentialCreationOptions, JSON dizesi olarak serileştirildi. Serileştirme biçimi PublicKeyCredential.parseCreationOptionsFromJSON() ile uyumludur.

  • requestId

    sayı

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

CreateResponseDetails

Özellikler

  • hata

    DOMExceptionDetails optional

    Varsa uzak isteğin sağladığı DOMException.

  • requestId

    sayı

    CreateRequest öğesinin requestId öğesi.

  • responseJson

    dize isteğe bağlı

    Varsa uzak isteğin oluşturduğu PublicKeyCredential, href="https://w3c.github.io/webauthn/#dom-publickeycredential-tojson"> çağrısı yapılarak JSON dizesi olarak serileştirilmiştir. PublicKeyCredential.toJSON().

DOMExceptionDetails

Özellikler

  • mesaj

    dize

  • ad

    dize

GetRequest

Özellikler

  • requestDetailsJson

    dize

    navigator.credentials.get() öğesine geçirilen PublicKeyCredentialRequestOptions, JSON dizesi olarak serileştirildi. Serileştirme biçimi PublicKeyCredential.parseRequestOptionsFromJSON() ile uyumludur.

  • requestId

    sayı

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

GetResponseDetails

Özellikler

  • hata

    DOMExceptionDetails optional

    Varsa uzak isteğin sağladığı DOMException.

  • requestId

    sayı

    CreateRequest öğesinin requestId öğesi.

  • responseJson

    dize isteğe bağlı

    Varsa uzak isteğin oluşturduğu PublicKeyCredential, href="https://w3c.github.io/webauthn/#dom-publickeycredential-tojson"> çağrısı yapılarak JSON dizesi olarak serileştirilmiştir. PublicKeyCredential.toJSON().

IsUvpaaRequest

Özellikler

  • requestId

    sayı

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

IsUvpaaResponseDetails

Özellikler

  • isUvpaa

    boolean

  • requestId

    sayı

Yöntemler

attach()

Söz 'nı inceleyin.
chrome.webAuthenticationProxy.attach(
  callback?: function,
)

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

Uzaktan masaüstü uzantıları, genellikle bu ana makineye uzaktan bir oturum eklendiğini algıladıktan sonra bu yöntemi çağırır. Bu yöntem hatasız geri döndüğünde, WebAuthn isteklerinin düzenli olarak işlenmesi askıya alınır ve bu uzantı API'sinden etkinlikler tetiklenir.

Farklı bir uzantı zaten eklenmişse bu yöntem hata vererek başarısız olur.

Eklenen uzantının, normal WebAuthn isteği işlemeyi devam ettirmek için uzaktan masaüstü oturumu sona erdiğinde detach() çağrısı yapması gerekir. Uzantılar kaldırılırsa otomatik olarak ayrılır.

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

Parametreler

  • geri çağırma

    işlev isteğe bağlı

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

    (error?: string) => void

    • hata

      dize isteğe bağlı

İadeler

  • Söz<dize | tanımlanmadı>

    Manifest V3 ve sonraki sürümlerde vaatler desteklenir ancak geriye dönük uyumluluk Aynı işlev çağrısında ikisini birden kullanamazsınız. İlgili içeriği oluşturmak için kullanılan taahhüt, geri çağırmaya iletilen aynı türle çözümlenir.

completeCreateRequest()

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

Bir navigator.credentials.create() çağrısının sonucunu bildirir. İstek iptal edilmediği sürece (bu durumda bir onRequestCanceled etkinliği tetiklenir) uzantının aldığı her onCreateRequest etkinliği için bu parametreyi çağırması gerekir.

Parametreler

  • ayrıntılar

    CreateResponseDetails

  • geri çağırma

    işlev isteğe bağlı

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

    () => void

İadeler

  • Taahhüt<void>

    Manifest V3 ve sonraki sürümlerde vaatler desteklenir ancak geriye dönük uyumluluk Aynı işlev çağrısında ikisini birden kullanamazsınız. İlgili içeriği oluşturmak için kullanılan taahhüt, geri çağırmaya iletilen aynı türle çözümlenir.

completeGetRequest()

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

Bir navigator.credentials.get() çağrısının sonucunu bildirir. İstek iptal edilmediği sürece (bu durumda bir onRequestCanceled etkinliği tetiklenir) uzantının aldığı her onGetRequest etkinliği için bu parametreyi çağırması gerekir.

Parametreler

  • ayrıntılar

    GetResponseDetails

  • geri çağırma

    işlev isteğe bağlı

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

    () => void

İadeler

  • Taahhüt<void>

    Manifest V3 ve sonraki sürümlerde vaatler desteklenir ancak geriye dönük uyumluluk Aynı işlev çağrısında ikisini birden kullanamazsınız. İlgili içeriği oluşturmak için kullanılan taahhüt, geri çağırmaya iletilen aynı türle çözümlenir.

completeIsUvpaaRequest()

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

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

Parametreler

  • ayrıntılar

    IsUvpaaResponseDetails

  • geri çağırma

    işlev isteğe bağlı

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

    () => void

İadeler

  • Taahhüt<void>

    Manifest V3 ve sonraki sürümlerde vaatler desteklenir ancak geriye dönük uyumluluk Aynı işlev çağrısında ikisini birden kullanamazsınız. İlgili içeriği oluşturmak için kullanılan taahhüt, geri çağırmaya iletilen aynı türle çözümlenir.

detach()

Söz 'nı inceleyin.
chrome.webAuthenticationProxy.detach(
  callback?: function,
)

Bu uzantıyı, etkin Web Authentication API istek proxy'sinden kaldırı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 geri döndüğünde, uzantı artık etkin Web Authentication API istek proxy'si olmaktan çıkar.

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

Parametreler

  • geri çağırma

    işlev isteğe bağlı

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

    (error?: string) => void

    • hata

      dize isteğe bağlı

İadeler

  • Söz<dize | tanımlanmadı>

    Manifest V3 ve sonraki sürümlerde vaatler desteklenir ancak geriye dönük uyumluluk Aynı işlev çağrısında ikisini birden kullanamazsınız. İlgili içeriği oluşturmak için kullanılan taahhüt, 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 uygulamasından requestId ile completeCreateRequest() ç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,
)

WebAuthn navigator.credentials.get() çağrısı gerçekleştiğinde tetiklenir. Uzantı, requestInfo uygulamasından requestId ile completeGetRequest() ç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,
)

Bir PublicKeyCredential.isUserVerifyingPlatformAuthenticatorAvailable() çağrısı gerçekleştiğinde tetiklenir. Uzantı, requestInfo uygulamasından requestId ile completeIsUvpaaRequest() çağırarak bir yanıt sağlamalıdır.

Parametreler

onRemoteSessionStateChange

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

Bu uzantıyla ilişkili bir yerel uygulama, varsayılan kullanıcı verileri dizini içinde WebAuthenticationProxyRemoteSessionStateChange adlı bir dizinde uzantı kimliğine eşit bir ada sahip 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ştirmeniz gerekmez.

Uzantı hizmeti çalışanı muhtemelen askıya alınmış durumdayken yerel ana makine uygulaması, olası bir uzak oturum durumu değişikliğini (ayrılmış durumundan ekliye 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 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ğinin arayan tarafından iptal edilmesi veya zaman aşımına uğraması nedeniyle) tetiklenir. Uzantı, bu etkinliği alırken istemci tarafında ilgili isteğin işlenmesini iptal etmelidir. Uzantılar, iptal edilen bir isteği tamamlayamaz.

Parametreler

  • geri çağırma

    işlev

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

    (requestId: number) => void

    • requestId

      sayı