chrome.webAuthenticationProxy

תיאור

ה-API של chrome.webAuthenticationProxy מאפשר לתוכנות Remote Desktop שפועלות במארח מרוחק ליירט בקשות של Web Authentication API (WebAuthn) כדי לטפל בהן בלקוח מקומי.

הרשאות

webAuthenticationProxy

זמינות

Chrome 115 ומעלה MV3+

סוגים

CreateRequest

תכונות

  • requestDetailsJson

    מחרוזת

    השדה PublicKeyCredentialCreationOptions הועבר אל navigator.credentials.create(), עבר סריאליזציה למחרוזת JSON. פורמט העריכה בסדרה תואם ל-PublicKeyCredential.parseCreationOptionsFromJSON().

  • requestId

    מספר

    מזהה אטום של הבקשה.

CreateResponseDetails

תכונות

  • error

    DOMExceptionDetails אופציונלי

    DOMException שהתקבלה על ידי הבקשה מרחוק, אם יש.

  • requestId

    מספר

    requestId של CreateRequest.

  • responseJson

    מחרוזת אופציונלי

    PublicKeyCredential, שהופק על ידי הבקשה מרחוק, אם יש כזה, עבר סריאליזציה למחרוזת JSON על ידי קריאה ל- href="https://w3c.github.io/webauthn/#dom-publickeycredential-tojson"> PublicKeyCredential.toJSON().

DOMExceptionDetails

תכונות

  • הודעה

    מחרוזת

  • name

    מחרוזת

GetRequest

תכונות

  • requestDetailsJson

    מחרוזת

    השדה PublicKeyCredentialRequestOptions הועבר אל navigator.credentials.get(), עבר סריאליזציה למחרוזת JSON. פורמט העריכה בסדרה תואם ל-PublicKeyCredential.parseRequestOptionsFromJSON().

  • requestId

    מספר

    מזהה אטום של הבקשה.

GetResponseDetails

תכונות

  • error

    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,
)

הופך את התוסף הזה לשרת proxy הפעיל של בקשות API לאימות אינטרנט.

תוספים לשולחן עבודה מרוחקים בדרך כלל קוראים לשיטה הזו אחרי שהם מזהים קובץ מצורף של סשן מרוחק למארח הזה. אחרי שהשיטה הזו חוזרת ללא שגיאות, העיבוד הרגיל של בקשות WebAuthn מושעה ומתבצעת העלאה של אירועים מ-API של תוסף זה.

שיטה זו נכשלת עם שגיאה אם תוסף אחר כבר מצורף.

כדי להמשיך את העיבוד הרגיל של בקשות WebAuthn, התוסף המצורף צריך לבצע קריאה אל detach() בסיום הסשן של Remote Desktop. תוספים ינותקו באופן אוטומטי אם הם הוסרו.

צריך לעיין באירוע onRemoteSessionStateChange לציון שינוי של קובץ מצורף לסשן מרוחק מאפליקציה מקורית לתוסף (שאולי מושעה).

פרמטרים

  • קריאה חוזרת (callback)

    פונקציה אופציונלי

    הפרמטר callback נראה כך: 

    (error?: string)=>void

    • error

      מחרוזת אופציונלי

החזרות

  • הבטחה<string|undefined>

    יש תמיכה בהבטחות במניפסט מגרסה V3 ואילך, אבל אפשר לבצע קריאה חוזרת (callback) לצורך תאימות לאחור. אי אפשר להשתמש בשתיהן באותה בקשה להפעלת פונקציה. ההבטחה מסתיימת עם אותו הסוג שמועבר לקריאה החוזרת.

completeCreateRequest()

הבטחה 
chrome.webAuthenticationProxy.completeCreateRequest(
  details: CreateResponseDetails,
  callback?: function,
)

מדווח על התוצאה של שיחה navigator.credentials.create(). התוסף חייב להפעיל את התכונה הזו עבור כל אירוע onCreateRequest שהוא קיבל, אלא אם הבקשה בוטלה (במקרה כזה, מופעל אירוע onRequestCanceled).

פרמטרים

  • קריאה חוזרת (callback)

    פונקציה אופציונלי

    הפרמטר callback נראה כך: 

    ()=>void

החזרות

  • Promise<void>

    יש תמיכה בהבטחות במניפסט מגרסה V3 ואילך, אבל אפשר לבצע קריאה חוזרת (callback) לצורך תאימות לאחור. אי אפשר להשתמש בשתיהן באותה בקשה להפעלת פונקציה. ההבטחה מסתיימת עם אותו הסוג שמועבר לקריאה החוזרת.

completeGetRequest()

הבטחה 
chrome.webAuthenticationProxy.completeGetRequest(
  details: GetResponseDetails,
  callback?: function,
)

מדווח על התוצאה של שיחה navigator.credentials.get(). התוסף חייב להפעיל את התכונה הזו עבור כל אירוע onGetRequest שהוא קיבל, אלא אם הבקשה בוטלה (במקרה כזה, מופעל אירוע onRequestCanceled).

פרמטרים

  • פרטים

    GetResponseDetails

  • קריאה חוזרת (callback)

    פונקציה אופציונלי

    הפרמטר callback נראה כך: 

    ()=>void

החזרות

  • Promise<void>

    יש תמיכה בהבטחות במניפסט מגרסה V3 ואילך, אבל אפשר לבצע קריאה חוזרת (callback) לצורך תאימות לאחור. אי אפשר להשתמש בשתיהן באותה בקשה להפעלת פונקציה. ההבטחה מסתיימת עם אותו הסוג שמועבר לקריאה החוזרת.

completeIsUvpaaRequest()

הבטחה 
chrome.webAuthenticationProxy.completeIsUvpaaRequest(
  details: IsUvpaaResponseDetails,
  callback?: function,
)

מדווח על התוצאה של שיחה PublicKeyCredential.isUserVerifyingPlatformAuthenticator(). התוסף צריך לקרוא לפונקציה הזו עבור כל אירוע onIsUvpaaRequest שהוא מקבל.

פרמטרים

  • קריאה חוזרת (callback)

    פונקציה אופציונלי

    הפרמטר callback נראה כך: 

    ()=>void

החזרות

  • Promise<void>

    יש תמיכה בהבטחות במניפסט מגרסה V3 ואילך, אבל אפשר לבצע קריאה חוזרת (callback) לצורך תאימות לאחור. אי אפשר להשתמש בשתיהן באותה בקשה להפעלת פונקציה. ההבטחה מסתיימת עם אותו הסוג שמועבר לקריאה החוזרת.

detach()

הבטחה 
chrome.webAuthenticationProxy.detach(
  callback?: function,
)

הסרת התוסף הזה משרת ה-proxy הפעיל לבקשת API לאימות באינטרנט.

השיטה הזו נקראת בדרך כלל כשהתוסף מזהה שסשן Remote Desktop הסתיים. כשהשיטה הזו חוזרת, התוסף מפסיק להיות שרת ה-proxy הפעיל לבקשת API לאימות באינטרנט.

צריך לעיין באירוע onRemoteSessionStateChange לציון שינוי של קובץ מצורף לסשן מרוחק מאפליקציה מקורית לתוסף (שאולי מושעה).

פרמטרים

  • קריאה חוזרת (callback)

    פונקציה אופציונלי

    הפרמטר callback נראה כך: 

    (error?: string)=>void

    • error

      מחרוזת אופציונלי

החזרות

  • הבטחה<string|undefined>

    יש תמיכה בהבטחות במניפסט מגרסה V3 ואילך, אבל אפשר לבצע קריאה חוזרת (callback) לצורך תאימות לאחור. אי אפשר להשתמש בשתיהן באותה בקשה להפעלת פונקציה. ההבטחה מסתיימת עם אותו הסוג שמועבר לקריאה החוזרת.

אירועים

onCreateRequest

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

מופעלת כשמתבצעת קריאה ל-navigator.credentials.create() של WebAuthn. התוסף חייב לספק תשובה על ידי התקשרות ל-completeCreateRequest() עם requestId מ-requestInfo.

פרמטרים

  • קריאה חוזרת (callback)

    פונקציה

    הפרמטר callback נראה כך: 

    (requestInfo: CreateRequest)=>void

onGetRequest

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

מופעלת כשמתבצעת קריאה ל-WebAuthn navigator.credentials.get() . התוסף חייב לספק תשובה על ידי התקשרות ל-completeGetRequest() עם requestId מתוך requestInfo

פרמטרים

  • קריאה חוזרת (callback)

    פונקציה

    הפרמטר callback נראה כך: 

    (requestInfo: GetRequest)=>void

onIsUvpaaRequest

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

מופעלת כשמתבצעת קריאה ל-PublicKeyCredential.isUserVerifyingPlatformAuthenticatorAvailable(). התוסף חייב לספק תשובה על ידי התקשרות ל-completeIsUvpaaRequest() עם requestId מתוך requestInfo

פרמטרים

  • קריאה חוזרת (callback)

    פונקציה

    הפרמטר callback נראה כך: 

    (requestInfo: IsUvpaaRequest)=>void

onRemoteSessionStateChange

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

אפליקציה מקומית שמשויכת לתוסף הזה יכולה לגרום להפעלת האירוע הזה על ידי כתיבה בקובץ עם שם זהה למזהה התוסף בספרייה בשם WebAuthenticationProxyRemoteSessionStateChange בתוך ספריית נתוני המשתמש שמוגדרת כברירת מחדל

התוכן של הקובץ צריך להיות ריק. כלומר, אין צורך לשנות את התוכן של הקובץ כדי להפעיל את האירוע הזה.

האפליקציה המארחת המקורית יכולה להשתמש במנגנון האירוע הזה כדי לאותת על שינוי אפשרי של מצב הסשן מרחוק (כלומר, ממנותק לחיבור למכשיר, או להיפך), ויכול להיות שה-service worker של התוסף מושעה. ב-handler של האירוע הזה, התוסף יכול להפעיל את ה-method של ה-API attach() או detach() בהתאם.

צריך לרשום את event listener באופן סינכרוני בזמן הטעינה.

פרמטרים

  • קריאה חוזרת (callback)

    פונקציה

    הפרמטר callback נראה כך: 

    ()=>void

onRequestCanceled

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

מופעלת כשאירועים של onCreateRequest או onGetRequest מבוטלים (כי הבקשה של WebAuthn בוטלה על ידי המתקשר או כי הסתיים הזמן הקצוב לתפוגה שלה). לאחר קבלת האירוע הזה, התוסף אמור לבטל את העיבוד של הבקשה התואמת בצד הלקוח. אי אפשר להשלים בקשה עם תוספים אחרי שהיא מבוטלת.

פרמטרים

  • קריאה חוזרת (callback)

    פונקציה

    הפרמטר callback נראה כך: 

    (requestId: number)=>void

    • requestId

      מספר