https.CallableOptions interface

可呼叫 HTTPS 函式設定的選項。

簽名:

export interface CallableOptions extends HttpsOptions 

擴充: HttpsOptions

屬性

屬性 類型 說明
consumeAppCheckToken 布林值 決定是否在要求中使用 Firebase App Check 權杖。預設值為 false。
enforceAppCheck 布林值 決定是否強制執行 Firebase AppCheck。如果設為 true,包含無效權杖的要求將自動回應,並顯示 401 (Unauthorized) 錯誤。如果設為 False,含有無效符記的要求會將 event.app 設為取消防禦。

https.CallableOptions.consumeAppCheckToken

決定是否在要求中使用 Firebase App Check 權杖。預設值為 false。

設為 true,系統就會在可呼叫的要求中使用 App Check 重播防護功能,發現要使用的權杖會將 request.app.alreadyConsumed 屬性設為 true。

只有在將這個選項設為 true 並傳送至 App Check 服務時,權杖才會被視為使用。權杖的其他用途不會消耗該權杖。

這項重播防護功能功能需要向 App Check 後端發出額外的網路呼叫,並強制用戶端向所選認證供應商取得新的認證。這可能會對效能產生負面影響,甚至可能會使認證供應商用盡讓配額更快這項功能僅適用於保護少量、攸關資安問題,或費用高昂的作業。

這個選項不會影響強制執行 AppCheck 選項。如果將後者設為 True,當要求包含無效的 App Check 權杖時,可呼叫函式會自動傳回 401 Unauthorized 狀態碼。如果要求內含有效但已使用的 App Check 權杖,系統不會自動拒絕要求。而是會將 request.app.alreadyConsumed 屬性設為 true,並將執行作業傳送至處理常式程式碼,以便做出進一步決策,例如要求進行額外的安全性檢查或拒絕要求。

簽名:

consumeAppCheckToken?: boolean;

https.CallableOptions.enforceAppCheck

決定是否強制執行 Firebase AppCheck。如果設為 true,包含無效權杖的要求將自動回應,並顯示 401 (Unauthorized) 錯誤。如果設為 False,含有無效符記的要求會將 event.app 設為取消防禦。

簽名:

enforceAppCheck?: boolean;