Règles de sécurité de base

Les règles de sécurité Firebase vous permettent de contrôler l'accès à vos données stockées. La syntaxe des règles flexibles signifie que vous pouvez créer des règles qui correspondent à tout, de toutes les écritures sur l'ensemble de la base de données aux opérations sur un document spécifique.

Ce guide décrit certains des cas d'utilisation les plus élémentaires que vous pourriez souhaiter mettre en œuvre lorsque vous configurez votre application et protégez vos données. Toutefois, avant de commencer à rédiger des règles, vous souhaiterez peut-être en savoir plus sur le langage dans lequel elles sont rédigées et sur leur comportement .

Pour accéder à vos règles et les mettre à jour, suivez les étapes décrites dans Gérer et déployer les règles de sécurité Firebase .

Règles par défaut : mode verrouillé

Lorsque vous créez une base de données ou une instance de stockage dans la console Firebase, vous choisissez si vos règles de sécurité Firebase limitent l'accès à vos données ( mode verrouillé ) ou autorisent l'accès à quiconque ( mode test ). Dans Cloud Firestore et Realtime Database, les règles par défaut du mode verrouillé refusent l'accès à tous les utilisateurs. Dans Cloud Storage, seuls les utilisateurs authentifiés peuvent accéder aux buckets de stockage.

service cloud.firestore {
  match /databases/{database}/documents {
    match /{document=**} {
      allow read, write: if false;
    }
  }
}

{
  "rules": {
    ".read": false,
    ".write": false
  }
}

service firebase.storage {
  match /b/{bucket}/o {
    match /{allPaths=**} {
      allow read, write: if request.auth != null;
    }
  }
}

Règles d'environnement de développement

Pendant que vous travaillez sur votre application, vous souhaiterez peut-être un accès relativement ouvert ou sans entrave à vos données. Assurez-vous simplement de mettre à jour vos règles avant de déployer votre application en production. N'oubliez pas non plus que si vous déployez votre application, elle est accessible au public, même si vous ne l'avez pas lancée .

N'oubliez pas que Firebase permet aux clients d'accéder directement à vos données et que les règles de sécurité Firebase sont la seule protection bloquant l'accès des utilisateurs malveillants. Définir des règles séparément de la logique du produit présente un certain nombre d'avantages : les clients ne sont pas responsables de l'application de la sécurité, les implémentations boguées ne compromettront pas vos données et, plus important encore, vous ne comptez pas sur un serveur intermédiaire pour protéger les données du monde.

Tous les utilisateurs authentifiés

Bien que nous ne recommandions pas de laisser vos données accessibles à tout utilisateur connecté, il peut être utile de définir l'accès à tout utilisateur authentifié pendant que vous développez votre application.

service cloud.firestore {
  match /databases/{database}/documents {
    match /{document=**} {
      allow read, write: if request.auth != null;
    }
  }
}

{
  "rules": {
    ".read": "auth.uid !== null",
    ".write": "auth.uid !== null"
  }
}

service firebase.storage {
  match /b/{bucket}/o {
    match /{allPaths=**} {
      allow read, write: if request.auth != null;
    }
  }
}

Règles prêtes pour la production

Lorsque vous préparez le déploiement de votre application, assurez-vous que vos données sont protégées et que l'accès est correctement accordé à vos utilisateurs. Tirez parti de l'authentification pour configurer un accès basé sur l'utilisateur et lisez directement à partir de votre base de données pour configurer un accès basé sur les données.

Envisagez d'écrire des règles lorsque vous structurez vos données, car la façon dont vous configurez vos règles a une incidence sur la façon dont vous limitez l'accès aux données à différents chemins.

Accès réservé aux propriétaires de contenu

Ces règles limitent l'accès au propriétaire authentifié du contenu uniquement. Les données ne sont accessibles en lecture et en écriture que par un seul utilisateur, et le chemin de données contient l'ID de l'utilisateur.

Lorsque cette règle fonctionne : cette règle fonctionne bien si les données sont cloisonnées par utilisateur — si le seul utilisateur qui a besoin d'accéder aux données est le même utilisateur qui a créé les données.

Lorsque cette règle ne fonctionne pas : cet ensemble de règles ne fonctionne pas lorsque plusieurs utilisateurs doivent écrire ou lire les mêmes données : les utilisateurs écraseront les données ou ne pourront pas accéder aux données qu'ils ont créées.

Pour configurer cette règle : Créez une règle qui confirme que l'utilisateur demandant l'accès aux données en lecture ou en écriture est bien l'utilisateur propriétaire de ces données.

service cloud.firestore {
  match /databases/{database}/documents {
    // Allow only authenticated content owners access
    match /some_collection/{userId}/{documents=**} {
      allow read, write: if request.auth != null && request.auth.uid == userId
    }
  }
}

{
  "rules": {
    "some_path": {
      "$uid": {
        // Allow only authenticated content owners access to their data
        ".read": "auth !== null && auth.uid === $uid",
        ".write": "auth !== null && auth.uid === $uid"
      }
    }
  }
}

// Grants a user access to a node matching their user ID
service firebase.storage {
  match /b/{bucket}/o {
    // Files look like: "user/<UID>/path/to/file.txt"
    match /user/{userId}/{allPaths=**} {
      allow read, write: if request.auth != null && request.auth.uid == userId;
    }
  }
}

Accès mixte public et privé

Cette règle permet à quiconque de lire un ensemble de données, mais limite la possibilité de créer ou de modifier des données sur un chemin donné au propriétaire de contenu authentifié uniquement.

Lorsque cette règle fonctionne : cette règle fonctionne bien pour les applications qui nécessitent des éléments lisibles publiquement, mais qui doivent limiter l'accès en modification aux propriétaires de ces éléments. Par exemple, une application de chat ou un blog.

Lorsque cette règle ne fonctionne pas : comme la règle du propriétaire de contenu uniquement, cet ensemble de règles ne fonctionne pas lorsque plusieurs utilisateurs doivent modifier les mêmes données. Les utilisateurs finiront par écraser les données des autres.

Pour configurer cette règle : Créez une règle qui autorise l'accès en lecture pour tous les utilisateurs (ou tous les utilisateurs authentifiés) et confirme que l'utilisateur qui écrit les données en est le propriétaire.

service cloud.firestore {
  match /databases/{database}/documents {
    // Allow public read access, but only content owners can write
    match /some_collection/{document} {
      allow read: if true
      allow create: if request.auth.uid == request.resource.data.author_uid;
      allow update, delete: if request.auth.uid == resource.data.author_uid;
    }
  }
}

{
// Allow anyone to read data, but only authenticated content owners can
// make changes to their data

  "rules": {
    "some_path": {
      "$uid": {
        ".read": true,
        // or ".read": "auth.uid !== null" for only authenticated users
        ".write": "auth.uid === $uid"
      }
    }
  }
}

service firebase.storage {
  match /b/{bucket}/o {
    // Files look like: "user/<UID>/path/to/file.txt"
    match /user/{userId}/{allPaths=**} {
      allow read;
      allow write: if request.auth.uid == userId;
    }
  }
}

Accès basé sur les attributs et sur les rôles

Pour que ces règles fonctionnent, vous devez définir et attribuer des attributs aux utilisateurs dans vos données. Les règles de sécurité Firebase vérifient la demande par rapport aux données de votre base de données ou aux métadonnées du fichier pour confirmer ou refuser l'accès.

Lorsque cette règle fonctionne : si vous attribuez un rôle à des utilisateurs, cette règle permet de limiter facilement l'accès en fonction de rôles ou de groupes d'utilisateurs spécifiques. Par exemple, si vous stockiez des notes, vous pourriez attribuer différents niveaux d'accès au groupe "étudiants" (lire leur contenu uniquement), au groupe "enseignants" (lire et écrire dans leur matière) et au groupe "directeurs" (lire tout le contenu).

Lorsque cette règle ne fonctionne pas : dans Realtime Database et Cloud Storage, vos règles ne peuvent pas exploiter la méthode get() que les règles Cloud Firestore peuvent intégrer. Par conséquent, vous devez structurer votre base de données ou vos métadonnées de fichier pour refléter les attributs que vous utilisez dans vos règles.

Pour configurer cette règle : dans Cloud Firestore, incluez un champ dans les documents de vos utilisateurs que vous pouvez lire, puis structurez votre règle pour lire ce champ et accorder l'accès de manière conditionnelle. Dans Realtime Database, créez un chemin de données qui définit les utilisateurs de votre application et leur accorde un rôle dans un nœud enfant.

Vous pouvez également configurer des revendications personnalisées dans l'authentification , puis récupérer ces informations à partir de la variable auth.token dans n'importe quelle règle de sécurité Firebase.

Attributs et rôles définis par les données

Ces règles ne fonctionnent que dans Cloud Firestore et Realtime Database.

service cloud.firestore {
  match /databases/{database}/documents {
    // For attribute-based access control, Check a boolean `admin` attribute
    allow write: if get(/databases/$(database)/documents/users/$(request.auth.uid)).data.admin == true;
    allow read: true;

    // Alterntatively, for role-based access, assign specific roles to users
    match /some_collection/{document} {
     allow read: if get(/databases/$(database)/documents/users/$(request.auth.uid)).data.role == "Reader"
     allow write: if get(/databases/$(database)/documents/users/$(request.auth.uid)).data.role == "Writer"
   }
  }
}

{
  "rules": {
    "some_path": {
      "${subpath}": {
        //
        ".write": "root.child('users').child(auth.uid).child('role').val() === 'admin'",
        ".read": true
      }
    }
  }
}

Attributs et rôles de revendication personnalisés

Pour mettre en œuvre ces règles, configurez des revendications personnalisées dans Firebase Authentication, puis exploitez les revendications dans vos règles.

service cloud.firestore {
  match /databases/{database}/documents {
    // For attribute-based access control, check for an admin claim
    allow write: if request.auth.token.admin == true;
    allow read: true;

    // Alterntatively, for role-based access, assign specific roles to users
    match /some_collection/{document} {
     allow read: if request.auth.token.reader == "true";
     allow write: if request.auth.token.writer == "true";
   }
  }
}

{
  "rules": {
    "some_path": {
      "$uid": {
        // Create a custom claim for each role or group
        // you want to leverage
        ".write": "auth.uid !== null && auth.token.writer === true",
        ".read": "auth.uid !== null && auth.token.reader === true"
      }
    }
  }
}

service firebase.storage {
  // Allow reads if the group ID in your token matches the file metadata's `owner` property
  // Allow writes if the group ID is in the user's custom token
  match /files/{groupId}/{fileName} {
    allow read: if resource.metadata.owner == request.auth.token.groupId;
    allow write: if request.auth.token.groupId == groupId;
  }
}

Attributs de location

Pour mettre en œuvre ces règles, configurez l'architecture mutualisée dans Google Cloud Identity Platform (GCIP), puis exploitez le locataire dans vos règles. Les exemples suivants autorisent les écritures d'un utilisateur dans un locataire spécifique, par exemple tenant2-m6tyz

service cloud.firestore {
  match /databases/{database}/documents {
    // For tenant-based access control, check for a tenantID
    allow write: if request.auth.token.firebase.tenant == 'tenant2-m6tyz';
    allow read: true;
  }
}

{
  "rules": {
    "some_path": {
      "$uid": {
        // Only allow reads and writes if user belongs to a specific tenant
        ".write": "auth.uid !== null && auth.token.firebase.tenant === 'tenant2-m6tyz'",
        ".read": "auth.uid !== null
      }
    }
  }
}

service firebase.storage {
  // Only allow reads and writes if user belongs to a specific tenant
  match /files/{tenantId}/{fileName} {
    allow read: if request.auth != null;
    allow write: if request.auth.token.firebase.tenant == tenantId;
  }
}