Outil de recommandation pour les règles Firebase

L'outil de recommandation pour les règles Firebase est compatible avec les sous-types de recommandations suivants:

Il s'agit de problèmes de sécurité pour les clients Firestore qui accordent aux utilisateurs un accès supplémentaire qu'ils n'ont pas l'intention d'utiliser, ou d'une règle qui approche de son expiration et dont les règles d'autorisation de l'utilisateur vont bientôt changer.

Ce document explique comment activer et afficher vos recommandations et vos insights pour améliorer la sécurité de vos bases de données.

Avant de commencer

Avant de pouvoir afficher les recommandations et les insights sur les règles Firebase pour Firestore, procédez comme suit:

  1. Activez l'API Recommender comme décrit dans la page Activer l'API.

  2. Assurez-vous de disposer des autorisations nécessaires. Vous devez disposer de l'un des rôles suivants, qui fournissent les autorisations nécessaires :

    Description de la tâche Rôle
    Afficher les recommandations/insights roles/recommender.firestoredatabasefirebaserulesViewer
    Afficher et mettre à jour (ignorer) les recommandations/insights roles/recommender.firestoredatabasefirebaserulesAdmin
    Désactiver les recommandations/insights dans le Centre de contrôle et de transparence. Pour en savoir plus, consultez la page Désactiver. roles/dataprocessing.admin

    Ces rôles de l'outil de recommandation fournissent les autorisations d'API suivantes :

    Rôle Autorisations associées
    roles/recommender.firestoredatabasefirebaserulesViewer recommender.firestoreDatabaseFirebaseRulesRecommendations.get
    recommender.firestoreDatabaseFirebaseRulesRecommendations.list
    recommender.firestoreDatabaseFirebaseRulesInsights.get
    recommender.firestoreDatabaseFirebaseRulesInsights.list
    roles/recommender.firestoredatabasefirebaserulesAdmin Autorisations roles/recommender.firestoredatabasefirebaserulesViewer, plus :
    recommender.firestoreDatabaseFirebaseRulesRecommendations.update
    recommender.firestoreDatabaseFirebaseRulesInsights.update

    Pour plus d'informations sur les rôles et les accès liés, consultez les pages suivantes:

Afficher les recommandations

Vous pouvez afficher les recommandations de règles Firebase de différentes manières.

Vous ne pouvez afficher les recommandations de règles Firebase que si vous disposez de bases de données utilisées et non vides pour lesquelles des règles Firebase non sécurisées ou arrivant à expiration sont configurées.

Console Google Cloud

Pour afficher vos recommandations, procédez comme suit:

  1. Accédez à la console Google Cloud ou utilisez le bouton suivant :

    Accéder à Google Cloud Console

  2. Recherchez la page Database Center (Centre de données de base de données).

CLI gcloud

Pour répertorier les recommandations concernant les règles Firebase à l'aide de gcloud, exécutez la commande gcloud recommender recommendations list comme suit:

  gcloud recommender recommendations list \
  --project=PROJECT_ID \
  --location=global \
  --recommender=google.firestore.database.<var>RECOMMENDER</var>

Remplacez les éléments suivants :

  • PROJECT_ID : ID de votre projet
  • RECOMMENDER : ID de l'outil de recommandation en tant que FirebaseRulesRecommender.

Outil de recommandation d'API

Pour lister vos recommandations de règles Firebase à l'aide de l'API Recommendations, appelez la méthode recommendations.list comme suit:

  curl -H "Authorization: Bearer $(gcloud auth print-access-token)"  \
  -H "x-goog-user-project: PROJECT_ID" \
  "https://recommender.googleapis.com/v1/projects/PROJECT_ID/locations/global/recommenders/google.firestore.database.RECOMMENDER/recommendations"

Remplacez les éléments suivants :

  • PROJECT_ID : ID de votre projet
  • RECOMMENDER : ID de l'outil de recommandation en tant que FirebaseRulesRecommender.

Pour en savoir plus, consultez la page Utiliser l'API – Recommandations.

Afficher les statistiques

Vous pouvez afficher des insights et des recommandations détaillées sur les règles Firebase de différentes manières.

Console Google Cloud

Pour afficher des insights et des recommandations détaillées à l'aide de la console Google Cloud, recherchez des recommandations dans l'onglet "Centre de données".

CLI gcloud

Pour afficher des insights à l'aide de gcloud, exécutez la commande gcloud recommender insights list comme suit:

  gcloud recommender insights list \
  --project=PROJECT_ID \
  --location=global \
  --insight-type=google.firestore.database.INSIGHT_TYPE

Remplacez les éléments suivants :

  • PROJECT_ID : ID de votre projet
  • INSIGHT_TYPE : ID du type d'insight ; par exemple, FirebaseRulesInsight

Outil de recommandation d'API

Pour répertorier vos insights à l'aide de l'API Recommender, exécutez la commande suivante:

curl -H "Authorization: Bearer $(gcloud auth print-access-token)"  \

"https://recommender.googleapis.com/v1/projects/PROJECT_ID/locations/global/insightTypes/google.firestore.database.INSIGHT_TYPE/insights"

Remplacez les éléments suivants :

  • PROJECT_ID : ID de votre projet
  • INSIGHT_TYPE : ID du type d'insight ; par exemple, FirebaseRulesInsight

Pour en savoir plus, consultez la page Utiliser l'API – Insights.

Appliquer les recommandations

Pour en savoir plus sur l'amélioration de la sécurité de votre base de données, consultez la section Structurer les règles de sécurité.

Tarifs

Les recommandations et les insights sur les règles Firebase sont disponibles sans frais. Pour en savoir plus sur les autres niveaux de tarification, consultez la page Tarifs de l'outil de recommandation.