chrome.webAuthenticationProxy

Deskripsi

API chrome.webAuthenticationProxy memungkinkan software desktop jarak jauh yang berjalan di host jarak jauh mencegat permintaan Web Authentication API (WebAuthn) untuk menanganinya di klien lokal.

Izin

webAuthenticationProxy

Ketersediaan

Chrome 115 dan yang lebih baru MV3+

Jenis

CreateRequest

Properti

  • requestDetailsJson

    string

    PublicKeyCredentialCreationOptions yang diteruskan ke navigator.credentials.create(), diserialisasi sebagai string JSON. Format serialisasi kompatibel dengan PublicKeyCredential.parseCreationOptionsFromJSON().

  • requestId

    angka

    ID buram untuk permintaan.

CreateResponseDetails

Properti

  • error

    DOMExceptionDetails opsional

    DOMException yang dihasilkan oleh permintaan jarak jauh, jika ada.

  • requestId

    angka

    requestId dari CreateRequest.

  • responseJson

    string opsional

    PublicKeyCredential, yang dihasilkan oleh permintaan jarak jauh, jika ada, diserialisasi sebagai string JSON dengan memanggil href="https://w3c.github.io/webauthn/#dom-publickeycredential-tojson"> PublicKeyCredential.toJSON().

DOMExceptionDetails

Properti

  • pesan

    string

  • name

    string

GetRequest

Properti

  • requestDetailsJson

    string

    PublicKeyCredentialRequestOptions yang diteruskan ke navigator.credentials.get(), diserialisasi sebagai string JSON. Format serialisasi kompatibel dengan PublicKeyCredential.parseRequestOptionsFromJSON().

  • requestId

    angka

    ID buram untuk permintaan.

GetResponseDetails

Properti

  • error

    DOMExceptionDetails opsional

    DOMException yang dihasilkan oleh permintaan jarak jauh, jika ada.

  • requestId

    angka

    requestId dari CreateRequest.

  • responseJson

    string opsional

    PublicKeyCredential, yang dihasilkan oleh permintaan jarak jauh, jika ada, diserialisasi sebagai string JSON dengan memanggil href="https://w3c.github.io/webauthn/#dom-publickeycredential-tojson"> PublicKeyCredential.toJSON().

IsUvpaaRequest

Properti

  • requestId

    angka

    ID buram untuk permintaan.

IsUvpaaResponseDetails

Properti

  • isUvpaa

    boolean

  • requestId

    angka

Metode

attach()

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

Membuat ekstensi ini menjadi proxy permintaan Web Authentication API yang aktif.

Ekstensi desktop jarak jauh biasanya memanggil metode ini setelah mendeteksi lampiran sesi jarak jauh ke host ini. Setelah metode ini ditampilkan tanpa error, pemrosesan reguler permintaan WebAuthn akan ditangguhkan, dan peristiwa dari API ekstensi ini akan dimunculkan.

Metode ini gagal dengan error jika ekstensi yang berbeda sudah disertakan.

Ekstensi yang terpasang harus memanggil detach() setelah sesi desktop jarak jauh berakhir agar dapat melanjutkan pemrosesan permintaan WebAuthn reguler. Ekstensi otomatis terlepas jika tidak dimuat.

Lihat peristiwa onRemoteSessionStateChange untuk menandai perubahan lampiran sesi jarak jauh dari aplikasi native ke ekstensi (mungkin ditangguhkan).

Parameter

  • callback

    fungsi opsional

    Parameter callback terlihat seperti: 

    (error?: string)=>void

    • error

      string opsional

Hasil

  • Promise<string|undefined>

    Promise didukung di Manifes V3 dan yang lebih baru, tetapi callback disediakan untuk kompatibilitas mundur. Anda tidak dapat menggunakan keduanya pada panggilan fungsi yang sama. Promise di-resolve dengan jenis yang sama yang diteruskan ke callback.

completeCreateRequest()

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

Melaporkan hasil panggilan navigator.credentials.create(). Ekstensi harus memanggilnya untuk setiap peristiwa onCreateRequest yang diterimanya, kecuali jika permintaannya dibatalkan (dalam hal ini, peristiwa onRequestCanceled akan diaktifkan).

Parameter

Hasil

  • Promise<void>

    Promise didukung di Manifes V3 dan yang lebih baru, tetapi callback disediakan untuk kompatibilitas mundur. Anda tidak dapat menggunakan keduanya pada panggilan fungsi yang sama. Promise di-resolve dengan jenis yang sama yang diteruskan ke callback.

completeGetRequest()

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

Melaporkan hasil panggilan navigator.credentials.get(). Ekstensi harus memanggilnya untuk setiap peristiwa onGetRequest yang diterimanya, kecuali jika permintaannya dibatalkan (dalam hal ini, peristiwa onRequestCanceled akan diaktifkan).

Parameter

  • callback

    fungsi opsional

    Parameter callback terlihat seperti: 

    ()=>void

Hasil

  • Promise<void>

    Promise didukung di Manifes V3 dan yang lebih baru, tetapi callback disediakan untuk kompatibilitas mundur. Anda tidak dapat menggunakan keduanya pada panggilan fungsi yang sama. Promise di-resolve dengan jenis yang sama yang diteruskan ke callback.

completeIsUvpaaRequest()

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

Melaporkan hasil panggilan PublicKeyCredential.isUserVerifyingPlatformAuthenticator(). Ekstensi harus memanggilnya untuk setiap peristiwa onIsUvpaaRequest yang diterimanya.

Parameter

Hasil

  • Promise<void>

    Promise didukung di Manifes V3 dan yang lebih baru, tetapi callback disediakan untuk kompatibilitas mundur. Anda tidak dapat menggunakan keduanya pada panggilan fungsi yang sama. Promise di-resolve dengan jenis yang sama yang diteruskan ke callback.

detach()

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

Menghapus ekstensi ini agar tidak menjadi proxy permintaan Web Authentication API yang aktif.

Metode ini biasanya dipanggil saat ekstensi mendeteksi bahwa sesi desktop jarak jauh dihentikan. Setelah metode ini ditampilkan, ekstensi tidak lagi menjadi proxy permintaan Web Authentication API yang aktif.

Lihat peristiwa onRemoteSessionStateChange untuk menandai perubahan lampiran sesi jarak jauh dari aplikasi native ke ekstensi (mungkin ditangguhkan).

Parameter

  • callback

    fungsi opsional

    Parameter callback terlihat seperti: 

    (error?: string)=>void

    • error

      string opsional

Hasil

  • Promise<string|undefined>

    Promise didukung di Manifes V3 dan yang lebih baru, tetapi callback disediakan untuk kompatibilitas mundur. Anda tidak dapat menggunakan keduanya pada panggilan fungsi yang sama. Promise di-resolve dengan jenis yang sama yang diteruskan ke callback.

Peristiwa

onCreateRequest

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

Diaktifkan saat panggilan navigator.credentials.create() WebAuthn terjadi. Ekstensi harus memberikan respons dengan memanggil completeCreateRequest() menggunakan requestId dari requestInfo.

Parameter

onGetRequest

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

Diaktifkan saat panggilan navigator.credentials.get() WebAuthn terjadi. Ekstensi harus memberikan respons dengan memanggil completeGetRequest() menggunakan requestId dari requestInfo

Parameter

  • callback

    fungsi

    Parameter callback terlihat seperti: 

    (requestInfo: GetRequest)=>void

onIsUvpaaRequest

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

Diaktifkan saat panggilan PublicKeyCredential.isUserVerifyingPlatformAuthenticatorAvailable() terjadi. Ekstensi harus memberikan respons dengan memanggil completeIsUvpaaRequest() menggunakan requestId dari requestInfo

Parameter

onRemoteSessionStateChange

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

Aplikasi native yang terkait dengan ekstensi ini dapat menyebabkan peristiwa ini diaktifkan dengan menulis ke file dengan nama yang sama dengan ID ekstensi dalam direktori bernama WebAuthenticationProxyRemoteSessionStateChange di dalam direktori data pengguna default

Konten file harus kosong. Artinya, tidak perlu mengubah konten file untuk memicu peristiwa ini.

Aplikasi host native dapat menggunakan mekanisme peristiwa ini untuk memberi sinyal kemungkinan perubahan status sesi jarak jauh (yaitu dari terlepas menjadi terpasang, atau sebaliknya) saat pekerja layanan ekstensi mungkin ditangguhkan. Di pengendali untuk peristiwa ini, ekstensi dapat memanggil metode API attach() atau detach() sebagaimana mestinya.

Pemroses peristiwa harus didaftarkan secara sinkron pada waktu pemuatan.

Parameter

  • callback

    fungsi

    Parameter callback terlihat seperti: 

    ()=>void

onRequestCanceled

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

Diaktifkan saat peristiwa onCreateRequest atau onGetRequest dibatalkan (karena permintaan WebAuthn dibatalkan oleh pemanggil, atau karena waktu habis). Saat menerima peristiwa ini, ekstensi akan membatalkan pemrosesan permintaan yang sesuai di sisi klien. Ekstensi tidak dapat menyelesaikan permintaan setelah dibatalkan.

Parameter

  • callback

    fungsi

    Parameter callback terlihat seperti: 

    (requestId: number)=>void

    • requestId

      angka