https.CallableOptions interface

呼び出し可能な HTTPS 関数に設定できるオプション。

サイン：

export interface CallableOptions extends HttpsOptions 

拡張: HttpsOptions

プロパティ

https.CallableOptions.consumeAppCheckToken

Firebase App Check トークンがリクエストに応じて消費されるかどうかを決定します。デフォルトは false です。

これを true に設定すると、呼び出し可能なリクエストで App Check トークンを消費することで App Check リプレイ保護機能が有効になります。すでに消費されていることが判明したトークンの request.app.alreadyConsumed プロパティは true に設定されます。

トークンは、このオプションを true に設定して App Check サービスに送信された場合にのみ消費されたとみなされます。トークンのその他の使用ではトークンは消費されません。

このリプレイ保護機能では、App Check バックエンドへの追加のネットワーク呼び出しが必要であり、クライアントは選択した証明書プロバイダーから新しい証明書を取得する必要があります。したがって、これはパフォーマンスに悪影響を及ぼす可能性があり、構成証明プロバイダーのクォータをより早く使い果たす可能性があります。この機能は、少量の操作、セキュリティが重要な操作、またはコストのかかる操作を保護する場合にのみ使用してください。

このオプションは、enforceAppCheck オプションには影響しません。後者を true に設定すると、リクエストに無効な App Check トークンが含まれている場合、呼び出し可能関数は自動的に 401 Unauthorized ステータス コードで応答します。リクエストに有効ではあるが消費された App Check トークンが含まれている場合、リクエストは自動的に拒否されません。代わりに、request.app.alreadyConsumed プロパティが true に設定され、追加のセキュリティ チェックの要求やリクエストの拒否など、さらなる決定を行うために実行がハンドラー コードに渡されます。

サイン：

consumeAppCheckToken?: boolean;

https.CallableOptions.enforceAppCheck

Firebase AppCheck を強制するかどうかを決定します。 true の場合、無効なトークンを含むリクエストは 401 (Unauthorized) エラーで自動応答します。 false の場合、無効なトークンを含むリクエストは、event.app を undefiend に設定します。

サイン：

enforceAppCheck?: boolean;