Activer App Check avec un fournisseur personnalisé sur les plates-formes Apple

Cette page vous montre comment activer App Check dans une application Apple, à l'aide de votre fournisseur App Check personnalisé . Lorsque vous activez App Check, vous vous assurez que seule votre application peut accéder aux ressources Firebase de votre projet.

Si vous souhaitez utiliser App Check avec les fournisseurs intégrés, consultez les documents pour App Check avec App Attest et App Check avec DeviceCheck .

Avant que tu commences

1. Ajoutez la bibliothèque App Check à votre application

  1. Ajoutez la dépendance pour App Check au Podfile de votre projet :

    pod 'FirebaseAppCheck'

    Ou, alternativement, vous pouvez utiliser Swift Package Manager à la place.

    Assurez-vous également que vous utilisez la dernière version de toutes les bibliothèques clientes du service Firebase dont vous dépendez.

  2. Exécutez l' pod install et ouvrez le fichier .xcworkspace créé.

2. Implémenter les protocoles App Check

Tout d'abord, vous devez créer des classes qui implémentent les protocoles AppCheckProvider et AppCheckProviderFactory .

Votre classe AppCheckProvider doit avoir une getToken(completion:) , qui collecte toutes les informations requises par votre fournisseur App Check personnalisé comme preuve d'authenticité, et les envoie à votre service d'acquisition de jetons en échange d'un jeton App Check. Le SDK App Check gère la mise en cache des jetons, donc obtenez toujours un nouveau jeton dans votre implémentation de getToken(completion:) .

Rapide

class YourCustomAppCheckProvider: NSObject, AppCheckProvider {
    var app: FirebaseApp

    init(withFirebaseApp app: FirebaseApp) {
        self.app = app
        super.init()
    }

    func getToken(completion handler: @escaping (AppCheckToken?, Error?) -> Void) {
        DispatchQueue.main.async {
            // Logic to exchange proof of authenticity for an App Check token.
            // ...

            // Create AppCheckToken object.
            let exp = Date(timeIntervalSince1970: expirationFromServer)
            let token = AppCheckToken(
                token: tokenFromServer,
                expirationDate: exp
            )

            // Pass the token or error to the completion handler.
            handler(token, nil)
        }
    }
}

Objectif c

@interface YourCustomAppCheckProvider : NSObject <FIRAppCheckProvider>

@property FIRApp *app;

- (id)initWithApp:(FIRApp *)app;

@end

@implementation YourCustomAppCheckProvider

- (id)initWithApp:app {
    self = [super init];
    if (self) {
        self.app = app;
    }
    return self;
}

- (void)getTokenWithCompletion:(nonnull void (^)(FIRAppCheckToken * _Nullable,
                                                 NSError * _Nullable))handler {
    dispatch_async(dispatch_get_main_queue(), ^{
        // Logic to exchange proof of authenticity for an App Check token.
        // ...

        // Create FIRAppCheckToken object.
        NSTimeInterval exp = expirationFromServer;
        FIRAppCheckToken *token
            = [[FIRAppCheckToken alloc] initWithToken:tokenFromServer
                                       expirationDate:[NSDate dateWithTimeIntervalSince1970:exp]];

        // Pass the token or error to the completion handler.
        handler(token, nil);
    });
}

@end

Implémentez également une classe AppCheckProviderFactory qui crée des instances de votre implémentation AppCheckProvider :

Rapide

class YourCustomAppCheckProviderFactory: NSObject, AppCheckProviderFactory {
  func createProvider(with app: FirebaseApp) -> AppCheckProvider? {
    return YourCustomAppCheckProvider(withFirebaseApp: app)
  }
}

Objectif c

@interface YourCustomAppCheckProviderFactory : NSObject <FIRAppCheckProviderFactory>
@end

@implementation YourCustomAppCheckProviderFactory

- (nullable id<FIRAppCheckProvider>)createProviderWithApp:(FIRApp *)app {
    return [[YourCustomAppCheckProvider alloc] initWithApp:app];
}

@end

3. Initialiser App Check

Ajoutez le code d'initialisation suivant à votre délégué d'application ou à l'initialiseur d'application :

Rapide

let providerFactory = YourAppCheckProviderFactory()
AppCheck.setAppCheckProviderFactory(providerFactory)

FirebaseApp.configure()

Objectif c

YourAppCheckProviderFactory *providerFactory =
        [[YourAppCheckProviderFactory alloc] init];
[FIRAppCheck setAppCheckProviderFactory:providerFactory];

[FIRApp configure];

Une fois la bibliothèque App Check installée dans votre application, commencez à distribuer l'application mise à jour à vos utilisateurs.

L'application cliente mise à jour commencera à envoyer des jetons App Check avec chaque demande qu'elle adresse à Firebase, mais les produits Firebase n'exigeront pas que les jetons soient valides tant que vous n'aurez pas activé l'application dans la section App Check de la console Firebase. Voir les deux sections suivantes pour plus de détails.

4. Surveiller les métriques de demande

Maintenant que votre application mise à jour est entre les mains des utilisateurs, vous pouvez activer l'application d'App Check pour les produits Firebase que vous utilisez. Avant de le faire, cependant, vous devez vous assurer que cela ne perturbera pas vos utilisateurs légitimes existants.

Base de données en temps réel, Cloud Firestore et Cloud Storage

Un outil important que vous pouvez utiliser pour prendre cette décision pour la base de données en temps réel, Cloud Firestore et Cloud Storage est l'écran des métriques de demande App Check.

Pour afficher les métriques de demande d'App Check pour un produit, ouvrez la section App Check de la console Firebase. Par exemple:

Capture d'écran de la page des statistiques d'App Check

Les métriques de demande pour chaque produit sont réparties en quatre catégories :

  • Les demandes vérifiées sont celles qui ont un jeton App Check valide. Une fois que vous avez activé l'application d'App Check, seules les demandes de cette catégorie aboutiront.

  • Les demandes client obsolètes sont celles pour lesquelles il manque un jeton App Check. Ces demandes peuvent provenir d'une ancienne version du SDK Firebase avant l'inclusion d'App Check dans l'application.

  • Les requêtes d' origine inconnue sont celles pour lesquelles il manque un jeton App Check et qui ne semblent pas provenir du SDK Firebase. Celles-ci peuvent provenir de requêtes effectuées avec des clés d'API volées ou de requêtes falsifiées effectuées sans le SDK Firebase.

  • Les requêtes non valides sont celles qui ont un jeton App Check non valide, qui peut provenir d'un client non authentique tentant d'usurper l'identité de votre application, ou d'environnements émulés.

La distribution de ces catégories pour votre application doit vous informer lorsque vous décidez d'activer l'application. Voici quelques lignes directrices :

  • Si presque toutes les demandes récentes proviennent de clients vérifiés, envisagez d'activer l'application pour commencer à protéger vos ressources backend.

  • Si une partie importante des demandes récentes proviennent de clients probablement obsolètes, pour éviter de perturber les utilisateurs, envisagez d'attendre que davantage d'utilisateurs mettent à jour votre application avant d'activer l'application. L'application d'App Check sur une application publiée cassera les versions d'application précédentes qui ne sont pas intégrées au SDK App Check.

  • Si votre application n'a pas encore été lancée, vous devez activer l'application App Check immédiatement, car aucun client obsolète n'est utilisé.

Fonctions cloud

Pour Cloud Functions, vous pouvez obtenir des métriques App Check en examinant les journaux de vos fonctions. Chaque invocation d'une fonction appelable émet une entrée de journal structurée comme dans l'exemple suivant :

{
  "severity": "INFO",    // INFO, WARNING, or ERROR
  "logging.googleapis.com/labels": {"firebase-log-type": "callable-request-verification"},
  "jsonPayload": {
    "message": "Callable header verifications passed.",
    "verifications": {
      // ...
      "app": "MISSING",  // VALID, INVALID, or MISSING
    }
  }
}

Vous pouvez analyser ces métriques dans Google Cloud Console en créant une métrique de compteur basée sur les journaux avec le filtre de métrique suivant :

resource.type="cloud_function"
resource.labels.function_name="YOUR_CLOUD_FUNCTION"
resource.labels.region="us-central1"
labels.firebase-log-type="callable-request-verification"

Étiquetez la métrique à l'aide du champ jsonPayload.verifications.appCheck .

5. Activer l'application

Pour activer l'application, suivez les instructions pour chaque produit, ci-dessous. Une fois que vous avez activé l'application pour un produit, toutes les demandes non vérifiées pour ce produit seront rejetées.

Base de données en temps réel, Cloud Firestore et Cloud Storage

Pour activer l'application pour la base de données en temps réel, Cloud Firestore (iOS et Android) et Cloud Storage :

  1. Ouvrez la section App Check de la console Firebase.

  2. Développez la vue des métriques du produit pour lequel vous souhaitez activer l'application.

  3. Cliquez sur Appliquer et confirmez votre choix.

Notez qu'il peut s'écouler jusqu'à 15 minutes après l'activation de l'application pour qu'elle prenne effet.

Fonctions cloud

Voir Activer l'application de la vérification des applications pour Cloud Functions .