chrome.webAuthenticationProxy

الوصف

تسمح واجهة برمجة التطبيقات chrome.webAuthenticationProxy لبرامج سطح المكتب البعيد التي تعمل على مضيف بعيد باعتراض طلبات Web Authentication API (WebAuthn) للتعامل معها على جهاز عميل محلي.

الأذونات

webAuthenticationProxy

مدى التوفّر

الإصدار 115 من Chrome أو الإصدارات الأحدث MV3+

الأنواع

CreateRequest

أماكن إقامة

  • requestDetailsJson

    سلسلة

    تم تمرير PublicKeyCredentialCreationOptions إلى navigator.credentials.create()، على شكل سلسلة JSON. يتوافق تنسيق التسلسل مع PublicKeyCredential.parseCreationOptionsFromJSON().

  • requestId

    الرقم

    معرّف مبهم للطلب.

CreateResponseDetails

أماكن إقامة

  • خطأ

    DOMExceptionDetails optional

    تمثّل هذه السمة DOMException الناتج عن الطلب عن بُعد، إن توفّر.

  • requestId

    الرقم

    requestId من CreateRequest.

  • responseJson

    سلسلة اختيارية

    عملية PublicKeyCredential، التي تم الحصول عليها من خلال الطلب عن بُعد، إن توفّرت، متسلسلة كسلسلة JSON من خلال استدعاء href="https://w3c.github.io/webauthn/#dom-publickeycertified-tojson"> PublicKeyCredential.toJSON()

DOMExceptionDetails

أماكن إقامة

  • رسالة

    سلسلة

  • الاسم

    سلسلة

GetRequest

أماكن إقامة

  • requestDetailsJson

    سلسلة

    تم تمرير PublicKeyCredentialRequestOptions إلى navigator.credentials.get()، على شكل سلسلة JSON. يتوافق تنسيق التسلسل مع PublicKeyCredential.parseRequestOptionsFromJSON().

  • requestId

    الرقم

    معرّف مبهم للطلب.

GetResponseDetails

أماكن إقامة

  • خطأ

    DOMExceptionDetails optional

    تمثّل هذه السمة DOMException الناتج عن الطلب عن بُعد، إن توفّر.

  • requestId

    الرقم

    requestId من CreateRequest.

  • responseJson

    سلسلة اختيارية

    عملية PublicKeyCredential، التي تم الحصول عليها من خلال الطلب عن بُعد، إن توفّرت، متسلسلة كسلسلة JSON من خلال استدعاء href="https://w3c.github.io/webauthn/#dom-publickeycertified-tojson"> PublicKeyCredential.toJSON()

IsUvpaaRequest

أماكن إقامة

  • requestId

    الرقم

    معرّف مبهم للطلب.

IsUvpaaResponseDetails

أماكن إقامة

  • isUvpaa

    منطقي

  • requestId

    الرقم

الطُرق

attach()

وعود 
chrome.webAuthenticationProxy.attach(
  callback?: function,
)

تجعل هذه الإضافة الخادم الوكيل النشط لطلب واجهة برمجة التطبيقات لمصادقة الويب.

تطلب إضافات سطح المكتب البعيد عادةً هذه الطريقة بعد رصد مرفق جلسة بعيدة بهذا المضيف. بعد إرجاع هذه الطريقة بدون خطأ، يتم تعليق المعالجة المنتظمة لطلبات WebAuthn، ويتم عرض الأحداث من واجهة برمجة تطبيقات الإضافة هذه.

يتعذّر تنفيذ هذه الطريقة مع ظهور خطأ إذا سبق إرفاق إضافة أخرى.

يجب أن تطلب الإضافة المرفقة detach() بعد انتهاء جلسة سطح المكتب البعيد لاستئناف معالجة طلبات WebAuthn العادية. ويتم فصل الإضافات تلقائيًا في حال إلغاء تحميلها.

يُرجى الرجوع إلى حدث onRemoteSessionStateChange للإشارة إلى تغيير مرفق جلسة بعيدة من تطبيق أصلي إلى الإضافة (التي قد تكون معلَّقة).

المعلمات

  • رد الاتصال

    الدالة اختيارية

    تظهر المَعلمة callback على النحو التالي: 

    (error?: string) => void

    • خطأ

      سلسلة اختيارية

المرتجعات

  • وعود<string | غير محددة>

    تتوفّر الوعود في الإصدار Manifest V3 والإصدارات الأحدث، ولكن يتم توفير معاودة الاتصال. التوافق مع الأنظمة القديمة. لا يمكنك استخدام كلتيهما في نفس استدعاء الدالة. تشير رسالة الأشكال البيانية يتم حل الوعد بنفس النوع الذي يتم إرساله إلى معاودة الاتصال.

completeCreateRequest()

وعود 
chrome.webAuthenticationProxy.completeCreateRequest(
  details: CreateResponseDetails,
  callback?: function,
)

تُبلغ عن نتيجة مكالمة navigator.credentials.create(). يجب أن تطلب الإضافة ذلك لكل حدث onCreateRequest تلقته، ما لم يتم إلغاء الطلب (وفي هذه الحالة، يتم تنشيط حدث onRequestCanceled).

المعلمات

  • التفاصيل

    CreateResponseDetails

  • رد الاتصال

    الدالة اختيارية

    تظهر المَعلمة callback على النحو التالي: 

    () => void

المرتجعات

  • وعود <باطلة>

    تتوفّر الوعود في الإصدار Manifest V3 والإصدارات الأحدث، ولكن يتم توفير معاودة الاتصال. التوافق مع الأنظمة القديمة. لا يمكنك استخدام كلتيهما في نفس استدعاء الدالة. تشير رسالة الأشكال البيانية يتم حل الوعد بنفس النوع الذي يتم إرساله إلى معاودة الاتصال.

completeGetRequest()

وعود 
chrome.webAuthenticationProxy.completeGetRequest(
  details: GetResponseDetails,
  callback?: function,
)

تُبلغ عن نتيجة مكالمة navigator.credentials.get(). يجب أن تطلب الإضافة ذلك لكل حدث onGetRequest تلقته، ما لم يتم إلغاء الطلب (وفي هذه الحالة، يتم تنشيط حدث onRequestCanceled).

المعلمات

  • التفاصيل

    GetResponseDetails

  • رد الاتصال

    الدالة اختيارية

    تظهر المَعلمة callback على النحو التالي: 

    () => void

المرتجعات

  • وعود <باطلة>

    تتوفّر الوعود في الإصدار Manifest V3 والإصدارات الأحدث، ولكن يتم توفير معاودة الاتصال. التوافق مع الأنظمة القديمة. لا يمكنك استخدام كلتيهما في نفس استدعاء الدالة. تشير رسالة الأشكال البيانية يتم حل الوعد بنفس النوع الذي يتم إرساله إلى معاودة الاتصال.

completeIsUvpaaRequest()

وعود 
chrome.webAuthenticationProxy.completeIsUvpaaRequest(
  details: IsUvpaaResponseDetails,
  callback?: function,
)

تُبلغ عن نتيجة مكالمة PublicKeyCredential.isUserVerifyingPlatformAuthenticator(). يجب أن تطلب الإضافة هذا لكل حدث onIsUvpaaRequest تتلقاه.

المعلمات

  • التفاصيل

    IsUvpaaResponseDetails

  • رد الاتصال

    الدالة اختيارية

    تظهر المَعلمة callback على النحو التالي: 

    () => void

المرتجعات

  • وعود <باطلة>

    تتوفّر الوعود في الإصدار Manifest V3 والإصدارات الأحدث، ولكن يتم توفير معاودة الاتصال. التوافق مع الأنظمة القديمة. لا يمكنك استخدام كلتيهما في نفس استدعاء الدالة. تشير رسالة الأشكال البيانية يتم حل الوعد بنفس النوع الذي يتم إرساله إلى معاودة الاتصال.

detach()

وعود 
chrome.webAuthenticationProxy.detach(
  callback?: function,
)

إزالة هذه الإضافة من أن تكون الخادم الوكيل النشط لطلب واجهة برمجة التطبيقات لمصادقة الويب

ويتم عادةً استدعاء هذه الطريقة عندما تكتشف الإضافة إنهاء جلسة على سطح المكتب البعيد. وبعد إرجاع هذه الطريقة، لن تصبح الإضافة هي الخادم الوكيل النشط لطلب واجهة برمجة التطبيقات Web Authentication API.

يُرجى الرجوع إلى حدث onRemoteSessionStateChange للإشارة إلى تغيير مرفق جلسة بعيدة من تطبيق أصلي إلى الإضافة (التي قد تكون معلَّقة).

المعلمات

  • رد الاتصال

    الدالة اختيارية

    تظهر المَعلمة callback على النحو التالي: 

    (error?: string) => void

    • خطأ

      سلسلة اختيارية

المرتجعات

  • وعود<string | غير محددة>

    تتوفّر الوعود في الإصدار Manifest V3 والإصدارات الأحدث، ولكن يتم توفير معاودة الاتصال. التوافق مع الأنظمة القديمة. لا يمكنك استخدام كلتيهما في نفس استدعاء الدالة. تشير رسالة الأشكال البيانية يتم حل الوعد بنفس النوع الذي يتم إرساله إلى معاودة الاتصال.

فعاليات

onCreateRequest

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

يتم إطلاقه عند حدوث استدعاء WebAuthn navigator.credentials.create(). يجب أن تقدِّم الإضافة ردًا من خلال طلب الرقم completeCreateRequest() باستخدام requestId من requestInfo.

المعلمات

  • رد الاتصال

    دالة

    تظهر المَعلمة callback على النحو التالي: 

    (requestInfo: CreateRequest) => void

onGetRequest

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

يتم إطلاقه عند حدوث استدعاء WebAuthn navigator.certifieds.get(). يجب أن تقدِّم الإضافة ردًا من خلال طلب الرقم completeGetRequest() باستخدام requestId من requestInfo.

المعلمات

  • رد الاتصال

    دالة

    تظهر المَعلمة callback على النحو التالي: 

    (requestInfo: GetRequest) => void

onIsUvpaaRequest

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

يتم إطلاقه عند إجراء مكالمة PublicKeyCredential.isUserVerifyingPlatformAuthenticatorAvailable(). يجب أن تقدِّم الإضافة ردًا من خلال طلب الرقم completeIsUvpaaRequest() باستخدام requestId من requestInfo.

المعلمات

  • رد الاتصال

    دالة

    تظهر المَعلمة callback على النحو التالي: 

    (requestInfo: IsUvpaaRequest) => void

onRemoteSessionStateChange

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

يمكن أن يؤدي تطبيق أصلي مرتبط بهذه الإضافة إلى تنشيط هذا الحدث من خلال الكتابة إلى ملف يحمل اسمًا يساوي معرّف الإضافة في دليل باسم WebAuthenticationProxyRemoteSessionStateChange داخل دليل بيانات المستخدم التلقائي.

يجب أن يكون محتوى الملف فارغًا. بمعنى آخر، ليس من الضروري تغيير محتوى الملف لتشغيل هذا الحدث.

قد يستخدم تطبيق المضيف الأصلي آلية الحدث هذه للإشارة إلى حدوث تغيير محتمل في حالة الجلسة البعيدة (مثلاً، تبديل الحالة لتصبح مرفقة، أو العكس)، بينما قد يكون عامل خدمات الإضافات معلقًا. وفي معالج هذا الحدث، يمكن للإضافة استدعاء طرق واجهة برمجة التطبيقات attach() أو detach() وفقًا لذلك.

يجب تسجيل أداة معالجة الحدث بالتزامن في وقت التحميل.

المعلمات

  • رد الاتصال

    دالة

    تظهر المَعلمة callback على النحو التالي: 

    () => void

onRequestCanceled

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

يتم إطلاقه عند إلغاء حدث onCreateRequest أو onGetRequest (لأنّه تم إلغاء طلب WebAuthn من قِبل المتصل أو لأنّ المهلة قد انتهت). وعند تلقّي هذا الحدث، من المفترض أن تلغي التمديد معالجة الطلب المقابل من جهة العميل. لا يمكن للإضافات إكمال طلب بعد إلغائه.

المعلمات

  • رد الاتصال

    دالة

    تظهر المَعلمة callback على النحو التالي: 

    (requestId: number) => void

    • requestId

      الرقم