https.CallableOptions interface

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

署名:

export interface CallableOptions extends HttpsOptions 

拡張: HttpsOptions

プロパティ

https.CallableOptions.consumeAppCheckToken

リクエスト時に Firebase App Check トークンを使用するかどうかを決定します。デフォルトは false です。

これを true に設定すると、呼び出し可能なリクエストで App Check トークンが使用され、App Check リプレイ保護機能が有効になります。すでに消費されているトークンについては、request.app.existingConsumed プロパティが 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;