chrome.webAuthenticationProxy

ब्यौरा

chrome.webAuthenticationProxy API, रिमोट होस्ट पर चल रहे रिमोट डेस्कटॉप सॉफ़्टवेयर को Web Authentication API (WebAuthn) के अनुरोधों को लोकल क्लाइंट पर हैंडल करने की अनुमति देता है.

अनुमतियां

webAuthenticationProxy

उपलब्धता

Chrome 115 और उसके बाद वाले वर्शन संगीत वीडियो 3+

टाइप

CreateRequest

प्रॉपर्टी

  • requestDetailsJson

    स्ट्रिंग

    navigator.credentials.create() को पास किया गया PublicKeyCredentialCreationOptions, JSON स्ट्रिंग के तौर पर क्रम से लगाया जाता है. सीरियल नंबर का फ़ॉर्मैट PublicKeyCredential.parseCreationOptionsFromJSON() के साथ काम करता है.

  • requestId

    संख्या

    अनुरोध के लिए ओपेक आइडेंटिफ़ायर.

CreateResponseDetails

प्रॉपर्टी

  • गड़बड़ी

    DOMExceptionDetails optional

    रिमोट अनुरोध से मिला DOMException, अगर कोई है.

  • requestId

    संख्या

    CreateRequest का requestId.

  • responseJson

    स्ट्रिंग ज़रूरी नहीं

    रिमोट अनुरोध से मिलने वाला PublicKeyCredential, अगर कोई हो, तो href="https://w3c.github.io/webauthn/#dom-publickey स्थिति-tojson"> को कॉल करके JSON स्ट्रिंग के रूप में क्रम में लगाया गया PublicKeyCredential.toJSON().

DOMExceptionDetails

प्रॉपर्टी

  • मैसेज

    स्ट्रिंग

  • नाम

    स्ट्रिंग

GetRequest

प्रॉपर्टी

  • requestDetailsJson

    स्ट्रिंग

    navigator.credentials.get() को पास किया गया PublicKeyCredentialRequestOptions, JSON स्ट्रिंग के तौर पर क्रम से लगाया जाता है. सीरियल नंबर का फ़ॉर्मैट PublicKeyCredential.parseRequestOptionsFromJSON() के साथ काम करता है.

  • requestId

    संख्या

    अनुरोध के लिए ओपेक आइडेंटिफ़ायर.

GetResponseDetails

प्रॉपर्टी

  • गड़बड़ी

    DOMExceptionDetails optional

    रिमोट अनुरोध से मिला DOMException, अगर कोई है.

  • requestId

    संख्या

    CreateRequest का requestId.

  • responseJson

    स्ट्रिंग ज़रूरी नहीं

    रिमोट अनुरोध से मिलने वाला PublicKeyCredential, अगर कोई हो, तो href="https://w3c.github.io/webauthn/#dom-publickey स्थिति-tojson"> को कॉल करके JSON स्ट्रिंग के रूप में क्रम में लगाया गया PublicKeyCredential.toJSON().

IsUvpaaRequest

प्रॉपर्टी

  • requestId

    संख्या

    अनुरोध के लिए ओपेक आइडेंटिफ़ायर.

IsUvpaaResponseDetails

प्रॉपर्टी

  • isUvpaa

    बूलियन

  • requestId

    संख्या

तरीके

attach()

प्रॉमिस 
chrome.webAuthenticationProxy.attach(
  callback?: function,
)

इस एक्सटेंशन को ऐक्टिव Web Authentication API अनुरोध प्रॉक्सी बनाता है.

आम तौर पर, रिमोट डेस्कटॉप एक्सटेंशन इस होस्ट के किसी रिमोट सेशन के अटैचमेंट का पता लगाने के बाद इस तरीके को कॉल करते हैं. इस तरीके के गड़बड़ी के बिना वापस आने पर, WebAuthn अनुरोधों की नियमित प्रोसेस निलंबित कर दी जाती है. साथ ही, इस एक्सटेंशन एपीआई के इवेंट भी बढ़ा दिए जाते हैं.

अगर कोई दूसरा एक्सटेंशन पहले से ही अटैच है, तो यह तरीका गड़बड़ी होने पर काम नहीं करता.

अटैच किए गए एक्सटेंशन को रिमोट डेस्कटॉप सेशन खत्म होने पर detach() को कॉल करना होगा, ताकि WebAuthn अनुरोध को सामान्य तरीके से प्रोसेस किया जा सके. अगर एक्सटेंशन अनलोड हो जाते हैं, तो वे अपने-आप अलग हो जाते हैं.

रिमोट सेशन के अटैचमेंट को किसी नेटिव ऐप्लिकेशन से, निलंबित किए गए एक्सटेंशन में बदलने का सिग्नल देने के लिए, onRemoteSessionStateChange इवेंट देखें.

पैरामीटर

  • कॉलबैक

    फ़ंक्शन वैकल्पिक

    callback पैरामीटर ऐसा दिखता है: 

    (error?: string) => void

    • गड़बड़ी

      स्ट्रिंग ज़रूरी नहीं

रिटर्न

  • प्रॉमिस<string | तय नहीं है>

    मेनिफ़ेस्ट V3 और उसके बाद के वर्शन में प्रॉमिस काम करते हैं. हालांकि, कॉलबैक की सुविधा इन मामलों में दी जाती है पुराने सिस्टम के साथ काम करने की सुविधा. एक ही फ़ंक्शन कॉल में दोनों का इस्तेमाल नहीं किया जा सकता. कॉन्टेंट बनाने प्रॉमिस उसी टाइप के साथ ठीक होता है जिसे कॉलबैक में पास किया जाता है.

completeCreateRequest()

प्रॉमिस 
chrome.webAuthenticationProxy.completeCreateRequest(
  details: CreateResponseDetails,
  callback?: function,
)

navigator.credentials.create() कॉल के नतीजे की रिपोर्ट करता है. एक्सटेंशन को इसे हर onCreateRequest इवेंट के लिए कॉल करना होगा, बशर्ते अनुरोध रद्द न किया गया हो. इस मामले में, onRequestCanceled इवेंट ट्रिगर होगा.

पैरामीटर

  • विवरण

    CreateResponseDetails

  • कॉलबैक

    फ़ंक्शन वैकल्पिक

    callback पैरामीटर ऐसा दिखता है: 

    () => void

रिटर्न

  • प्रॉमिस<void>

    मेनिफ़ेस्ट V3 और उसके बाद के वर्शन में प्रॉमिस काम करते हैं. हालांकि, कॉलबैक की सुविधा इन मामलों में दी जाती है पुराने सिस्टम के साथ काम करने की सुविधा. एक ही फ़ंक्शन कॉल में दोनों का इस्तेमाल नहीं किया जा सकता. कॉन्टेंट बनाने प्रॉमिस उसी टाइप के साथ ठीक होता है जिसे कॉलबैक में पास किया जाता है.

completeGetRequest()

प्रॉमिस 
chrome.webAuthenticationProxy.completeGetRequest(
  details: GetResponseDetails,
  callback?: function,
)

navigator.credentials.get() कॉल के नतीजे की रिपोर्ट करता है. एक्सटेंशन को इसे हर onGetRequest इवेंट के लिए कॉल करना होगा, बशर्ते अनुरोध रद्द न किया गया हो. इस मामले में, onRequestCanceled इवेंट ट्रिगर होगा.

पैरामीटर

  • विवरण

    GetResponseDetails

  • कॉलबैक

    फ़ंक्शन वैकल्पिक

    callback पैरामीटर ऐसा दिखता है: 

    () => void

रिटर्न

  • प्रॉमिस<void>

    मेनिफ़ेस्ट V3 और उसके बाद के वर्शन में प्रॉमिस काम करते हैं. हालांकि, कॉलबैक की सुविधा इन मामलों में दी जाती है पुराने सिस्टम के साथ काम करने की सुविधा. एक ही फ़ंक्शन कॉल में दोनों का इस्तेमाल नहीं किया जा सकता. कॉन्टेंट बनाने प्रॉमिस उसी टाइप के साथ ठीक होता है जिसे कॉलबैक में पास किया जाता है.

completeIsUvpaaRequest()

प्रॉमिस 
chrome.webAuthenticationProxy.completeIsUvpaaRequest(
  details: IsUvpaaResponseDetails,
  callback?: function,
)

PublicKeyCredential.isUserVerifyingPlatformAuthenticator() कॉल के नतीजे की रिपोर्ट करता है. एक्सटेंशन को इसे हर onIsUvpaaRequest इवेंट के लिए कॉल करना होगा.

पैरामीटर

  • विवरण

    IsUvpaaResponseDetails

  • कॉलबैक

    फ़ंक्शन वैकल्पिक

    callback पैरामीटर ऐसा दिखता है: 

    () => void

रिटर्न

  • प्रॉमिस<void>

    मेनिफ़ेस्ट V3 और उसके बाद के वर्शन में प्रॉमिस काम करते हैं. हालांकि, कॉलबैक की सुविधा इन मामलों में दी जाती है पुराने सिस्टम के साथ काम करने की सुविधा. एक ही फ़ंक्शन कॉल में दोनों का इस्तेमाल नहीं किया जा सकता. कॉन्टेंट बनाने प्रॉमिस उसी टाइप के साथ ठीक होता है जिसे कॉलबैक में पास किया जाता है.

detach()

प्रॉमिस 
chrome.webAuthenticationProxy.detach(
  callback?: function,
)

इस एक्सटेंशन को ऐक्टिव Web Authentication API अनुरोध प्रॉक्सी से हटाता है.

यह तरीका आम तौर पर तब कॉल किया जाता है, जब एक्सटेंशन को यह पता चलता है कि कोई रिमोट डेस्कटॉप सेशन खत्म किया गया है. इस तरीके के वापस आने के बाद, एक्सटेंशन, Web Authentication API अनुरोध की मौजूदा प्रॉक्सी पर काम नहीं करता.

रिमोट सेशन के अटैचमेंट को किसी नेटिव ऐप्लिकेशन से, निलंबित किए गए एक्सटेंशन में बदलने का सिग्नल देने के लिए, onRemoteSessionStateChange इवेंट देखें.

पैरामीटर

  • कॉलबैक

    फ़ंक्शन वैकल्पिक

    callback पैरामीटर ऐसा दिखता है: 

    (error?: string) => void

    • गड़बड़ी

      स्ट्रिंग ज़रूरी नहीं

रिटर्न

  • प्रॉमिस<string | तय नहीं है>

    मेनिफ़ेस्ट V3 और उसके बाद के वर्शन में प्रॉमिस काम करते हैं. हालांकि, कॉलबैक की सुविधा इन मामलों में दी जाती है पुराने सिस्टम के साथ काम करने की सुविधा. एक ही फ़ंक्शन कॉल में दोनों का इस्तेमाल नहीं किया जा सकता. कॉन्टेंट बनाने प्रॉमिस उसी टाइप के साथ ठीक होता है जिसे कॉलबैक में पास किया जाता है.

इवेंट

onCreateRequest

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

WebAuthn navigator.credentials.create() कॉल होने पर सक्रिय होता है. एक्सटेंशन को requestInfo के requestId के साथ completeCreateRequest() को कॉल करके जवाब देना होगा.

पैरामीटर

  • कॉलबैक

    फ़ंक्शन

    callback पैरामीटर ऐसा दिखता है: 

    (requestInfo: CreateRequest) => void

onGetRequest

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

WebAuthn navgator.Credentials.get() कॉल के होने पर सक्रिय होता है. एक्सटेंशन को requestInfo के requestId के साथ completeGetRequest() को कॉल करके जवाब देना होगा

पैरामीटर

  • कॉलबैक

    फ़ंक्शन

    callback पैरामीटर ऐसा दिखता है: 

    (requestInfo: GetRequest) => void

onIsUvpaaRequest

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

PublicKeyCredential.isUserVerifyingPlatformAuthenticatorAvailable() कॉल होने पर सक्रिय होता है. एक्सटेंशन को requestInfo के requestId के साथ completeIsUvpaaRequest() को कॉल करके जवाब देना होगा

पैरामीटर

  • कॉलबैक

    फ़ंक्शन

    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

      संख्या