https.CallableOptions interface

可以在可呼叫 HTTPS 函數上設定的選項。

簽名:

export interface CallableOptions extends HttpsOptions 

擴充: HttpsOptions

特性

財產類型描述
消耗AppCheckToken布林值決定是否根據請求使用 Firebase App Check 令牌。預設為 false。
強制應用程式檢查布林值決定是否強制執行 Firebase AppCheck。如果為 true,則具有無效令牌的請求會自動回應 401(未經授權)錯誤。如果為 false,則帶有無效令牌的請求會將 event.app 設定為 undefiend。

https.CallableOptions.consumeAppCheckToken

決定是否根據請求使用 Firebase App Check 令牌。預設為 false。

將此設為 true 可透過在可呼叫請求上使用 App Check 令牌來啟用 App Check 重播保護功能。發現已被消耗的令牌會將 request.app.alreadyConsumed 屬性設為 true。

僅當透過將此選項設為 true 將令牌傳送到 App Check 服務時,令牌才被視為已消耗。令牌的其他用途不會消耗它。

此重播保護功能需要對 App Check 後端進行額外的網路調用,並強制用戶端從所選證明提供者取得新的證明。因此,這可能會對效能產生負面影響,並且可能會更快地耗盡證明提供者的配額。僅使用此功能來保護小批量、安全關鍵或昂貴的操作。

此選項不會影響 enforceAppCheck 選項。當請求包含無效的 App Check 令牌時,將後者設為 true 將導致可呼叫函數自動回應 401 Unauthorized 狀態代碼。當請求包含有效但已消耗的 App Check 令牌時,請求不會被自動拒絕。相反, request.app.alreadyConsumed 屬性將設為 true 並將執行傳遞給處理程序代碼以做出進一步的決策,例如需要額外的安全性檢查或拒絕請求。

簽名:

consumeAppCheckToken?: boolean;

https.CallableOptions.enforceAppCheck

決定是否強制執行 Firebase AppCheck。如果為 true,則具有無效令牌的請求會自動回應 401(未經授權)錯誤。如果為 false,則帶有無效令牌的請求會將 event.app 設定為 undefiend。

簽名:

enforceAppCheck?: boolean;