chrome.webAuthenticationProxy

الوصف

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

الأذونات

webAuthenticationProxy

مدى توفّر الخدمة

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

الأنواع

CreateRequest

أماكن إقامة

  • requestDetailsJson

    سلسلة

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

  • requestId

    الرقم

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

CreateResponseDetails

أماكن إقامة

  • خطأ

    DOMExceptionDetails اختياري

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

  • requestId

    الرقم

    تمثّل هذه السمة requestId من CreateRequest.

  • responseJson

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

    PublicKeyCredential، الناتجة عن الطلب البعيد، إن وجد، متسلسل كسلسلة JSON عن طريق استدعاء href="https://w3c.github.io/webauthn/#dom-publickeycredential-tojson"> PublicKeyCredential.toJSON().

DOMExceptionDetails

أماكن إقامة

  • رسالة

    سلسلة

  • اسم

    سلسلة

GetRequest

أماكن إقامة

  • requestDetailsJson

    سلسلة

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

  • requestId

    الرقم

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

GetResponseDetails

أماكن إقامة

  • خطأ

    DOMExceptionDetails اختياري

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

  • requestId

    الرقم

    تمثّل هذه السمة requestId من CreateRequest.

  • responseJson

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

    PublicKeyCredential، الناتجة عن الطلب البعيد، إن وجد، متسلسل كسلسلة JSON عن طريق استدعاء href="https://w3c.github.io/webauthn/#dom-publickeycredential-tojson"> PublicKeyCredential.toJSON().

IsUvpaaRequest

أماكن إقامة

  • requestId

    الرقم

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

IsUvpaaResponseDetails

أماكن إقامة

  • isUvpaa

    boolean

  • requestId

    الرقم

الطُرق

attach()

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

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

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

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

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

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

المَعلمات

  • معاودة الاتصال

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

    تبدو معلَمة callback على النحو التالي: 

    (error?: string)=>void

    • خطأ

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

المرتجعات

  • الوعد<string|unified>

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

completeCreateRequest()

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

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

المَعلمات

  • التفاصيل

    CreateResponseDetails

  • معاودة الاتصال

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

    تبدو معلَمة callback على النحو التالي: 

    ()=>void

المرتجعات

  • Promise<void>

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

completeGetRequest()

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

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

المَعلمات

  • التفاصيل

    GetResponseDetails

  • معاودة الاتصال

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

    تبدو معلَمة callback على النحو التالي: 

    ()=>void

المرتجعات

  • Promise<void>

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

completeIsUvpaaRequest()

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

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

المَعلمات

  • التفاصيل

    IsUvpaaResponseDetails

  • معاودة الاتصال

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

    تبدو معلَمة callback على النحو التالي: 

    ()=>void

المرتجعات

  • Promise<void>

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

detach()

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

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

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

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

المَعلمات

  • معاودة الاتصال

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

    تبدو معلَمة callback على النحو التالي: 

    (error?: string)=>void

    • خطأ

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

المرتجعات

  • الوعد<string|unified>

    تتوفّر الوعود في إصدار 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.credentials.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

      الرقم