Gérer les sessions avec Firestore

---

De nombreuses applications nécessitent une gestion de session pour l'authentification et les préférences utilisateur. ASP.NET Core est fourni avec un middleware pour stocker les sessions dans un cache distribué.

Le cache distribué par défaut d'ASP.NET n'est en fait pas du tout distribué. Il stocke les données de session dans la mémoire du serveur Web. Lorsqu'un seul serveur Web diffuse un site Web, cette stratégie convient. Toutefois, lorsque de nombreux serveurs Web diffusent un site Web, les utilisateurs du site Web peuvent rencontrer des erreurs et perdre des données.

Pour éviter les erreurs et la perte de données, une application ASP.NET doit utiliser un cache distribué qui stocke les données dans un magasin de données persistant. Ce tutoriel explique comment gérer des sessions sur Cloud Run en les stockant dans Firestore et en chiffrant des cookies avec Cloud Key Management Service.

Objectifs

• Déployez l'application sur Cloud Run.

Coûts

Dans ce document, vous utilisez les composants facturables suivants de Google Cloud :

• Cloud Key Management Service
• Cloud Storage
• Cloud Run
• Firestore

Obtenez une estimation des coûts en fonction de votre utilisation prévue à l'aide du simulateur de coût. Les nouveaux utilisateurs de Google Cloud peuvent bénéficier d'un essai gratuit.

Une fois que vous avez terminé les tâches décrites dans ce document, vous pouvez éviter de continuer à payer des frais en supprimant les ressources que vous avez créées. Pour en savoir plus, consultez la section Effectuer un nettoyage.

Avant de commencer

1. Connectez-vous à votre compte Google Cloud. Si vous débutez sur Google Cloud, créez un compte pour évaluer les performances de nos produits en conditions réelles. Les nouveaux clients bénéficient également de 300 $ de crédits gratuits pour exécuter, tester et déployer des charges de travail.

2. Dans Google Cloud Console, sur la page de sélection du projet, sélectionnez ou créez un projet Google Cloud.

   Remarque : Si vous ne comptez pas conserver les ressources créées dans cette procédure, créez un projet au lieu de sélectionner un projet existant. Après avoir suivi ces étapes, vous pouvez supprimer le projet. Cela entraîne la suppression de toutes les ressources qui lui sont associées.

   Accéder au sélecteur de projet

3. Vérifiez que la facturation est activée pour votre projet Google Cloud.

4. Activer les API Firestore, Cloud Run, Cloud Key Management Service, and Cloud Storage.

   Activer les API

5. Dans Google Cloud Console, sur la page de sélection du projet, sélectionnez ou créez un projet Google Cloud.

   Remarque : Si vous ne comptez pas conserver les ressources créées dans cette procédure, créez un projet au lieu de sélectionner un projet existant. Après avoir suivi ces étapes, vous pouvez supprimer le projet. Cela entraîne la suppression de toutes les ressources qui lui sont associées.

   Accéder au sélecteur de projet

6. Vérifiez que la facturation est activée pour votre projet Google Cloud.

7. Activer les API Firestore, Cloud Run, Cloud Key Management Service, and Cloud Storage.

   Activer les API

8. Pour créer une base de données Firestore en mode natif, effectuez la procédure suivante :
   1. Dans la console Google Cloud, accédez à la page Lecteur Firestore.
      Accéder au lecteur Firestore
   2. Sur l'écran Sélectionner un mode Cloud Firestore, cliquez sur Sélectionner le mode natif.
   3. Sélectionnez un emplacement pour votre base de données Firestore. Ce paramètre d'emplacement correspond à l'emplacement par défaut des ressources Google Cloud de votre projet Google Cloud. Cet emplacement est utilisé pour les services Google Cloud exploités dans votre projet Google Cloud qui requièrent un paramètre d'emplacement, plus précisément le bucket Cloud Storage par défaut et l'application App Engine.
      Avertissement : Une fois que vous avez défini l'emplacement par défaut des ressources pour votre projet Google Cloud, vous ne pouvez plus le modifier.
   4. Cliquez sur Create Database (Créer une base de données).

9. Dans Cloud Shell, ouvrez le code source de l'application.
   Accéder à Cloud Shell

   Cloud Shell vous permet d'accéder en ligne de commande à vos ressources Google Cloud, directement depuis votre navigateur.

10. Pour télécharger l'exemple de code et accéder au répertoire de l'application, cliquez sur Continuer.

11. Dans Cloud Shell, configurez gcloud CLI pour utiliser votre nouveau projet Google Cloud:

    # Configure gcloud for your project
    gcloud config set project PROJECT_ID
    

    Remplacez PROJECT_ID par l'ID du projet Google Cloud que vous avez créé à l'aide de la console Google Cloud.

    Google Cloud CLI est le principal moyen d'interaction avec vos ressources Google Cloud depuis la ligne de commande. Dans ce tutoriel, vous allez utiliser gcloud CLI pour déployer et surveiller votre application.

Examiner le code source

Le diagramme suivant illustre la façon dont Firestore gère les sessions pour l'application Cloud Run.

La méthode ConfigureServices du fichier Startup.cs configure l'application de sorte qu'elle utilise Cloud KMS pour le chiffrement et Cloud Storage pour le stockage des clés chiffrées.

1. Dans Cloud Shell, cliquez sur pour lancer l'éditeur et examiner le fichier Startup.cs.

   Sessions/Startup.cs

   Afficher sur GitHub

   public void ConfigureServices(IServiceCollection services)
   {
       // Antiforgery tokens require data protection.
       services.AddDataProtection()
           // Store keys in Cloud Storage so that multiple instances
           // of the web application see the same keys.
           .PersistKeysToGoogleCloudStorage(
               Configuration["DataProtection:Bucket"],
               Configuration["DataProtection:Object"])
           // Protect the keys with Google KMS for encryption and fine-
           // grained access control.
           .ProtectKeysWithGoogleKms(
               Configuration["DataProtection:KmsKeyName"]);
       services.AddFirestoreDistributedCache(
               Configuration["FIRESTORE_PROJECT_ID"])
           .AddFirestoreDistributedCacheGarbageCollector();
       services.AddSession();
   }
   

Configuration du projet Google Cloud

1. Dans l'éditeur Cloud Shell, modifiez le fichier appsettings.json et remplacez les deux instances de YOUR-PROJECT-ID par l'ID de votre projet Google Cloud. Enregistrez le fichier.

   Sessions/appsettings.json

   Afficher sur GitHub

   {
     "Logging": {
       "LogLevel": {
         "Default": "Warning"
       }
     },
     "AllowedHosts": "*",
     "DataProtection": {
       "Bucket": "YOUR-PROJECT-ID-bucket",
       "Object": "DataProtectionProviderKeys.xml",
       "KmsKeyName": "projects/YOUR-PROJECT-ID/locations/global/keyRings/dataprotectionprovider/cryptoKeys/masterkey"
     }
   }
   

2. Créez un trousseau de clés Cloud Key Management Service nommé dataprotectionprovider:

   gcloud kms keyrings create dataprotectionprovider --location global

3. Créez une clé Cloud Key Management Service nommée masterkey:

   gcloud kms keys create masterkey --location global --keyring dataprotectionprovider --purpose=encryption

4. Créez un bucket Cloud Storage pour stocker les clés chiffrées:

   gsutil mb gs://PROJECT_ID-bucket

Déployer et exécuter sur Cloud Run

Vous pouvez utiliser Cloud Run pour créer et déployer une application qui fonctionne de manière fiable sous une charge élevée et avec de grandes quantités de données.

Ce tutoriel utilise Cloud Run pour déployer le serveur.

1. Dans votre Cloud Shell, publiez votre application :

   dotnet publish -c Release
   

2. Utilisez Cloud Build pour créer un conteneur Docker et le publier dans Container Registry:

   gcloud builds submit --tag gcr.io/PROJECT_ID/sessions bin/Release/netcoreapp2.1/publish

3. Exécutez le conteneur avec Cloud Run:

   gcloud beta run deploy sessions --region us-central1 --platform managed --image gcr.io/PROJECT_ID/sessions --allow-unauthenticated

   Notez l'URL dans la sortie :

   Service [sessions] revision [sessions-00003-xiz] has been deployed and is serving
   100 percent of traffic at https://sessions-r3f3em7nuq-uc.a.run.app

4. Pour afficher l'application en direct, accédez à l'URL que vous avez copiée à l'étape précédente.

Supprimer des sessions

Vous pouvez supprimer des données de session dans la console Google Cloud ou mettre en œuvre une stratégie de suppression automatique. Si vous utilisez des solutions de stockage pour des sessions telles que Memcache ou Redis, les sessions expirées sont automatiquement supprimées.

Déboguer l'application

Si vous ne pouvez pas vous connecter à votre application Cloud Run, vérifiez les points suivants :

1. Vérifiez que les commandes de déploiement gcloud ont bien abouti et n'ont généré aucune erreur. S'il y a eu des erreurs (par exemple, message=Build failed), corrigez-les et réessayez de déployer l'application Cloud Run.
2. Consultez le guide Cloud Run sur l'affichage des journaux.

Effectuer un nettoyage

Supprimer le projet

Attention : La suppression d'un projet aura les effets suivants :

• Tout le contenu du projet est supprimé. Si vous avez utilisé un projet existant pour les tâches de ce document, lorsque vous le supprimez, vous supprimez également tout autre travail effectué dans le projet.
• Les ID de projets personnalisés sont perdus. Lorsque vous avez créé ce projet, vous avez peut-être créé un ID de projet personnalisé que vous souhaitez utiliser à l'avenir. Pour conserver les URL qui utilisent l'ID de projet, telle qu'une URL appspot.com, supprimez les ressources sélectionnées dans le projet au lieu de supprimer l'ensemble du projet.

Si vous envisagez d'explorer plusieurs architectures, tutoriels et guides de démarrage rapide, réutiliser des projets peut vous aider à ne pas dépasser les limites de quotas des projets.

1. Dans la console Google Cloud, accédez à la page Gérer les ressources.

   Accéder à la page Gérer les ressources

2. Dans la liste des projets, sélectionnez le projet que vous souhaitez supprimer, puis cliquez sur Supprimer.
3. Dans la boîte de dialogue, saisissez l'ID du projet, puis cliquez sur Arrêter pour supprimer le projet.

Étapes suivantes

• Obtenez plus d'informations sur Cloud Run.
• Découvrez Cloud KMS.
• Obtenez davantage d'informations sur Cloud Storage.