https.CallableOptions interface

Options pouvant être définies sur une fonction HTTPS appelable.

Signature:

export interface CallableOptions extends HttpsOptions 

Extension : HttpsOptions

Propriétés

Propriété Taper Description
consommerAppCheckToken booléen Détermine si le jeton Firebase App Check est consommé sur demande. La valeur par défaut est false.
appliquerAppCheck booléen Détermine si Firebase AppCheck est appliqué. Lorsque cela est vrai, les demandes contenant des jetons non valides répondent automatiquement avec une erreur 401 (non autorisée). Lorsqu'elles sont fausses, les requêtes avec des jetons non valides définissent event.app sur undefiend.

https.CallableOptions.consumeAppCheckToken

Détermine si le jeton Firebase App Check est consommé sur demande. La valeur par défaut est false.

Définissez cette valeur sur true pour activer la fonctionnalité de protection contre la relecture d'App Check en consommant le jeton App Check sur demande appelable. Les jetons déjà consommés auront la propriété request.app.alreadyConsumed définie sur true.

Les jetons ne sont considérés comme consommés que s'ils sont envoyés au service App Check en définissant cette option sur true. Les autres utilisations du jeton ne le consomment pas.

Cette fonctionnalité de protection contre la relecture nécessite un appel réseau supplémentaire vers le backend App Check et oblige les clients à obtenir une nouvelle attestation auprès des fournisseurs d'attestation choisis. Cela peut donc avoir un impact négatif sur les performances et potentiellement épuiser plus rapidement les quotas de vos fournisseurs d'attestation. Utilisez cette fonctionnalité uniquement pour protéger les opérations à faible volume, critiques pour la sécurité ou coûteuses.

Cette option n'affecte pas l'optionforceAppCheck. Si ce dernier est défini sur true, la fonction appelable répondra automatiquement avec un code d'état 401 non autorisé lorsque la demande inclut un jeton App Check non valide. Lorsque la demande inclut des jetons App Check valides mais consommés, les demandes ne seront pas automatiquement rejetées. Au lieu de cela, la propriété request.app.alreadyConsumed sera définie sur true et transmettra l'exécution au code du gestionnaire pour prendre d'autres décisions, comme exiger des contrôles de sécurité supplémentaires ou rejeter la demande.

Signature:

consumeAppCheckToken?: boolean;

https.CallableOptions.enforceAppCheck

Détermine si Firebase AppCheck est appliqué. Lorsque cela est vrai, les demandes contenant des jetons non valides répondent automatiquement avec une erreur 401 (non autorisée). Lorsqu'elles sont fausses, les requêtes avec des jetons non valides définissent event.app sur undefiend.

Signature:

enforceAppCheck?: boolean;