Impara la sintassi di base delle regole di sicurezza Firebase per il linguaggio Cloud Storage

Le regole di sicurezza di Firebase per Cloud Storage ti consentono di controllare l'accesso agli oggetti archiviati nei bucket di Cloud Storage. La sintassi flessibile delle regole ti consente di creare regole per controllare qualsiasi operazione, da tutte le scritture nel tuo bucket Cloud Storage alle operazioni su un file specifico.

Questa guida descrive la sintassi e la struttura di base delle regole di sicurezza di Cloud Storage per creare set di regole completi.

Dichiarazione di servizio e database

Le regole di sicurezza di Firebase per Cloud Storage iniziano sempre con la seguente dichiarazione:

service firebase.storage {
    // ...
}

La dichiarazione del service firebase.storage applica l'ambito delle regole a Cloud Storage, prevenendo i conflitti tra le regole di sicurezza di Cloud Storage e le regole per altri prodotti come Cloud Firestore.

Regole di lettura/scrittura di base

Le regole di base sono costituite da un'istruzione di match che identifica i bucket di Cloud Storage, un'istruzione di corrispondenza che specifica un nome file e un'espressione allow che specifica quando è consentita la lettura dei dati specificati. le espressioni allow specificano i metodi di accesso (ad esempio, lettura, scrittura) coinvolti e le condizioni in base alle quali l'accesso è consentito o negato.

Nel set di regole predefinito, la prima istruzione match utilizza un'espressione con caratteri jolly {bucket} per indicare che le regole si applicano a tutti i bucket nel progetto. Discuteremo maggiormente l'idea delle corrispondenze con caratteri jolly nella prossima sezione.

service firebase.storage {
  // The {bucket} wildcard indicates we match files in all Cloud Storage buckets
  match /b/{bucket}/o {
    // Match filename
    match /filename {
      allow read: if <condition>;
      allow write: if <condition>;
    }
  }
}

Tutte le istruzioni di corrispondenza puntano a file. Un'istruzione match può puntare a un file specifico, come in match /images/profilePhoto.png .

Abbina i caratteri jolly

Oltre a puntare a un singolo file, Rules può utilizzare i caratteri jolly per puntare a qualsiasi file con un determinato prefisso di stringa nel nome, comprese le barre, come in match /images/{imageId} .

Nell'esempio precedente, l'istruzione match utilizza la sintassi del carattere jolly {imageId} . Ciò significa che la regola si applica a qualsiasi file con /images/ all'inizio del nome, ad esempio /images/profilePhoto.png o /images/croppedProfilePhoto.png . Quando vengono valutate le espressioni allow nell'istruzione match, la variabile imageId si risolverà nel nome file dell'immagine, ad esempio profilePhoto.png o croppedProfilePhoto.png .

È possibile fare riferimento a una variabile jolly dall'interno della match per fornire il nome del file o l'autorizzazione del percorso:

// Another way to restrict the name of a file
match /images/{imageId} {
  allow read: if imageId == "profilePhoto.png";
}

Dati gerarchici

Come abbiamo detto prima, non esiste una struttura gerarchica all'interno di un bucket Cloud Storage. Ma utilizzando una convenzione di denominazione dei file, spesso una che include barre nei nomi dei file, possiamo imitare una struttura che assomiglia a una serie nidificata di directory e sottodirectory. È importante capire in che modo le regole di sicurezza di Firebase interagiscono con questi nomi di file.

Considera la situazione di un insieme di file con nomi che iniziano tutti con la radice /images/ . Le regole di sicurezza di Firebase si applicano solo al nome file corrispondente, quindi i controlli di accesso definiti nella radice /images/ non si applicano alla radice /mp3s/ . Invece, scrivi regole esplicite che corrispondono a diversi modelli di nomi di file:

service firebase.storage {
  match /b/{bucket}/o {
    match /images/{imageId} {
      allow read, write: if <condition>;
    }

    // Explicitly define rules for the 'mp3s' pattern
    match /mp3s/{mp3Id} {
      allow read, write: if <condition>;
    }
  }
}

Quando si nidificano le istruzioni match , il percorso dell'istruzione match interna viene sempre aggiunto al percorso dell'istruzione match esterna. I seguenti due set di regole sono quindi equivalenti:

service firebase.storage {
  match /b/{bucket}/o {
    match /images {
      // Exact match for "images/profilePhoto.png"
      match /profilePhoto.png {
        allow write: if <condition>;
      }
    }
  }
}

service firebase.storage {
  match /b/{bucket}/o {
    // Exact match for "images/profilePhoto.png"
    match /images/profilePhoto.png {
      allow write: if <condition>;
      }
  }
}

Caratteri jolly ricorsivi

Oltre ai caratteri jolly che corrispondono e restituiscono stringhe alla fine di un nome file, è possibile dichiarare un carattere jolly a più segmenti per corrispondenze più complesse aggiungendo =** al nome del carattere jolly, come {path=**} :

// Partial match for files that start with "images"
match /images {

  // Exact match for "images/**"
  // e.g. images/users/user:12345/profilePhoto.png is matched
  // images/profilePhoto.png is also matched!
  match /{allImages=**} {
    // This rule matches one or more path segments (**)
    // allImages is a path that contains all segments matched
    allow read: if <other_condition>;
  }
}

Se più regole corrispondono a un file, il risultato è l' OR del risultato di tutte le valutazioni delle regole. In altre parole, se una regola corrispondente al file restituisce true , il risultato è true .

Nelle regole di cui sopra, il file "images/profilePhoto.png" può essere letto se condition o other_condition restituisce true, mentre il file "images/users/user:12345/profilePhoto.png" è soggetto solo al risultato di other_condition .

Le regole di sicurezza di Cloud Storage non vengono applicate a cascata e le regole vengono valutate solo quando il percorso della richiesta corrisponde a un percorso con le regole specificate.

rules_version = '2';
service cloud.storage {
  match /b/{bucket}/o {
   ...
 }
}

rules_version = '2';
service firebase.storage {
 match /b/{bucket}/o {
   // Matches any file in a songs "subdirectory" under the
   // top level of your Cloud Storage bucket.
   match /{prefixSegment=**}/songs/{mp3filenames} {
     allow read, write: if <condition>;
   }
  }
}

Operazioni granulari

In alcune situazioni, è utile suddividere read e write in operazioni più granulari. Ad esempio, la tua app potrebbe voler applicare condizioni diverse alla creazione di file rispetto all'eliminazione di file.

Un'operazione read può essere suddivisa in get e list .

Una regola write può essere suddivisa in create , update e delete :

service firebase.storage {
  match /b/{bucket}/o {
    // A read rule can be divided into read and list rules
    match /images/{imageId} {
      // Applies to single file read requests
      allow get: if <condition>;
      // Applies to list and listAll requests (Rules Version 2)
      allow list: if <condition>;

    // A write rule can be divided into create, update, and delete rules
    match /images/{imageId} {
      // Applies to writes to file contents
      allow create: if <condition>;

      // Applies to updates to (pre-existing) file metadata
      allow update: if <condition>;

      // Applies to delete operations
      allow delete: if <condition>;
    }
  }
 }
}

Dichiarazioni di corrispondenza sovrapposte

È possibile che un nome file corrisponda a più di un'istruzione match . Nel caso in cui più espressioni allow corrispondano a una richiesta, l'accesso è consentito se una delle condizioni è true :

service firebase.storage {
  match b/{bucket}/o {
    // Matches file names directly inside of '/images/'.
    match /images/{imageId} {
      allow read, write: if false;
    }

    // Matches file names anywhere under `/images/`
    match /images/{imageId=**} {
      allow read, write: if true;
    }
  }
}

Nell'esempio sopra, tutte le operazioni di lettura e scrittura sui file il cui nome inizia con /images/ sono consentite perché la seconda regola è sempre true , anche quando la prima regola è false .

Le regole non sono filtri

Dopo aver protetto i dati e aver iniziato a eseguire operazioni sui file, tieni presente che le regole di sicurezza non sono filtri. Non puoi eseguire operazioni su un set di file che corrispondono a un modello di nome file e aspettarti che Cloud Storage acceda solo ai file a cui il client corrente è autorizzato ad accedere.

Ad esempio, prendi la seguente regola di sicurezza:

service firebase.storage {
  match /b/{bucket}/o {
    // Allow the client to read files with contentType 'image/png'
    match /aFileNamePrefix/{aFileName} {
      allow read: if resource.contentType == 'image/png';
    }
  }
}

Denied : questa regola rifiuta la seguente richiesta perché il set di risultati può includere file in cui contentType non è image/png :

filesRef = storage.ref().child("aFilenamePrefix");

filesRef.listAll()
    .then(function(result) {
      console.log("Success: ", result.items);
    })
});

Le regole in Cloud Storage Security Rules valutano ogni query rispetto al suo potenziale risultato e falliscono la richiesta se potrebbe restituire un file che il client non è autorizzato a leggere. Le richieste di accesso devono seguire i vincoli imposti dalle tue regole.

Prossimi passi

Puoi approfondire la tua comprensione delle regole di sicurezza di Firebase per Cloud Storage:

• Impara il prossimo concetto principale del linguaggio Rules, le condizioni dinamiche , che consentono alle tue regole di controllare l'autorizzazione dell'utente, confrontare i dati esistenti e in arrivo, convalidare i dati in arrivo e altro ancora.

• Esamina i tipici casi d'uso di sicurezza e le definizioni delle regole di sicurezza Firebase che li affrontano .

Puoi esplorare i casi d'uso delle regole di sicurezza di Firebase specifici per Cloud Storage: