Strutturazione delle regole di sicurezza
Le regole di sicurezza di Firestore ti consentono di controllare l'accesso ai documenti e alle raccolte nel tuo database. La sintassi flessibile delle regole ti consente di creare regole che corrispondono a tutto, dalle scritture all'intero database alle operazioni su un documento specifico.
Questa guida descrive la sintassi e la struttura di base delle regole di sicurezza. Combina questa sintassi con le condizioni delle regole di sicurezza per creare set di regole completi.
Dichiarazione relativa a servizi e database
Le regole di sicurezza di Firestore iniziano sempre con la seguente dichiarazione:
service cloud.firestore {
match /databases/{database}/documents {
// ...
}
}
La dichiarazione service cloud.firestore definisce le regole come
Firestore, evitando conflitti tra le regole di sicurezza di Firestore e le
regole per altri prodotti, ad esempio Cloud Storage.
La dichiarazione match /databases/{database}/documents specifica che le regole devono
corrispondere a qualsiasi database Firestore nel progetto. Attualmente ogni progetto ha un solo database denominato (default).
Regole di lettura/scrittura di base
Le regole di base sono costituite da un'istruzione match che specifica il percorso di un documento e da un'espressione allow che descrive in dettaglio quando è consentito leggere i dati specificati:
service cloud.firestore {
match /databases/{database}/documents {
// Match any document in the 'cities' collection
match /cities/{city} {
allow read: if <condition>;
allow write: if <condition>;
}
}
}
Tutte le istruzioni di corrispondenza devono puntare a documenti, non a raccolte. Un'istruzione di corrispondenza può indirizzare a un documento specifico, ad esempio in match /cities/SF, o utilizzare caratteri jolly per indirizzare a qualsiasi documento nel percorso specificato, ad esempio in match /cities/{city}.
Nell'esempio precedente, l'istruzione di corrispondenza utilizza la sintassi con carattere jolly {city}.
Ciò significa che la regola si applica a qualsiasi documento nella raccolta cities, come
/cities/SF o /cities/NYC. Quando vengono valutate le espressioni allow nell'istruzione di corrispondenza, la variabile city restituisce il nome del documento della città, ad esempio SF o NYC.
Operazioni granulari
In alcuni casi, è utile suddividere read e write in operazioni più granulari. Ad esempio, potresti voler applicare condizioni diverse per la creazione di documenti rispetto a quella applicata per l'eliminazione dei documenti. In alternativa, puoi consentire la lettura di singoli documenti ma rifiutare le query di grandi dimensioni.
Una regola read può essere suddivisa in get e list, mentre una regola write può essere suddivisa in create, update e delete:
service cloud.firestore {
match /databases/{database}/documents {
// A read rule can be divided into get and list rules
match /cities/{city} {
// Applies to single document read requests
allow get: if <condition>;
// Applies to queries and collection read requests
allow list: if <condition>;
}
// A write rule can be divided into create, update, and delete rules
match /cities/{city} {
// Applies to writes to nonexistent documents
allow create: if <condition>;
// Applies to writes to existing documents
allow update: if <condition>;
// Applies to delete operations
allow delete: if <condition>;
}
}
}
Dati gerarchici
I dati in Firestore sono organizzati in raccolte di documenti e ogni documento può estendere la gerarchia tramite sottoraccolte. È importante comprendere in che modo le regole di sicurezza interagiscono con i dati gerarchici.
Considera la situazione in cui ogni documento nella raccolta cities contiene una
sottoraccolta landmarks. Le regole di sicurezza si applicano solo al percorso corrispondente, pertanto i controlli di accesso definiti nella raccolta cities non si applicano alla sottoraccolta landmarks. Scrivi invece regole esplicite per controllare l'accesso alle sottoraccolte:
service cloud.firestore {
match /databases/{database}/documents {
match /cities/{city} {
allow read, write: if <condition>;
// Explicitly define rules for the 'landmarks' subcollection
match /landmarks/{landmark} {
allow read, write: if <condition>;
}
}
}
}
Quando nidificate le istruzioni match, il percorso dell'istruzione match interna è sempre relativo al percorso dell'istruzione match esterna. I seguenti set di regole
sono quindi equivalenti:
service cloud.firestore {
match /databases/{database}/documents {
match /cities/{city} {
match /landmarks/{landmark} {
allow read, write: if <condition>;
}
}
}
}
service cloud.firestore {
match /databases/{database}/documents {
match /cities/{city}/landmarks/{landmark} {
allow read, write: if <condition>;
}
}
}
Caratteri jolly ricorrenti
Se vuoi che le regole siano applicate a una gerarchia arbitrariamente profonda, utilizza la sintassi ricorrente con caratteri jolly, {name=**}. Ad esempio:
service cloud.firestore {
match /databases/{database}/documents {
// Matches any document in the cities collection as well as any document
// in a subcollection.
match /cities/{document=**} {
allow read, write: if <condition>;
}
}
}
Quando utilizzi la sintassi ricorsiva dei caratteri jolly, la variabile con caratteri jolly conterrà l'intero segmento del percorso di corrispondenza, anche se il documento si trova in una sottoraccolta profondamente nidificata. Ad esempio, le regole elencate sopra corrispondono a un documento situato in /cities/SF/landmarks/coit_tower, mentre il valore della variabile document è SF/landmarks/coit_tower.
Tieni presente, tuttavia, che il comportamento dei caratteri jolly ricorrenti dipende dalla versione delle regole.
Versione 1
Per impostazione predefinita, le regole di sicurezza utilizzano la versione 1. Nella versione 1, i caratteri jolly ricorrenti corrispondono a uno o più elementi del percorso. Non corrispondono a un percorso vuoto, quindi
match /cities/{city}/{document=**} corrisponde ai documenti nella raccolta secondaria ma
non nella raccolta cities, mentre match /cities/{document=**} corrisponde
a entrambi i documenti nella raccolta cities e nelle sottoraccolte.
I caratteri jolly ricorrenti devono essere alla fine di una dichiarazione di corrispondenza.
Versione 2
Nella versione 2 delle regole di sicurezza, i caratteri jolly ricorrenti corrispondono a zero o più elementi del percorso. match/cities/{city}/{document=**} restituisce i documenti in qualsiasi sottoraccolta e nei documenti nella raccolta cities.
Devi attivare la versione 2 aggiungendo rules_version = '2'; nella parte superiore delle regole di sicurezza:
rules_version = '2';
service cloud.firestore {
match /databases/{database}/documents {
// Matches any document in the cities collection as well as any document
// in a subcollection.
match /cities/{city}/{document=**} {
allow read, write: if <condition>;
}
}
}
È possibile avere al massimo un carattere jolly ricorrente per istruzione di corrispondenza, ma nella versione 2 è possibile inserire questo carattere jolly in qualsiasi punto dell'istruzione di corrispondenza. Ad esempio:
rules_version = '2';
service cloud.firestore {
match /databases/{database}/documents {
// Matches any document in the songs collection group
match /{path=**}/songs/{song} {
allow read, write: if <condition>;
}
}
}
Se utilizzi le query del gruppo di raccolte, devi utilizzare la versione 2, consulta l'articolo Protezione delle query del gruppo di raccolte.
Estratti conto corrispondenti sovrapposti
È possibile che un documento 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 cloud.firestore {
match /databases/{database}/documents {
// Matches any document in the 'cities' collection.
match /cities/{city} {
allow read, write: if false;
}
// Matches any document in the 'cities' collection or subcollections.
match /cities/{document=**} {
allow read, write: if true;
}
}
}
Nell'esempio precedente, tutte le operazioni di lettura e scrittura nella raccolta cities saranno
consentite perché la seconda regola è sempre true, anche se la prima
regola è sempre false.
Limiti delle regole di sicurezza
Quando utilizzi le regole di sicurezza, tieni presente i seguenti limiti:
| Limite | Dettagli |
|---|---|
Numero massimo di chiamate exists(), get() e getAfter() per richiesta |
Il superamento di uno dei limiti comporta un errore di autorizzazione negata. Alcune chiamate di accesso ai documenti possono essere memorizzate nella cache e le chiamate nella cache non vengono considerate ai fini dei limiti. |
Profondità massima delle istruzioni match nidificate |
10 |
Lunghezza massima del percorso, in segmenti di percorso, consentita all'interno di un set di istruzioni match nidificate |
100 |
Numero massimo di variabili di acquisizione percorso consentite all'interno di un set di istruzioni match nidificate |
20 |
| Profondità massima delle chiamate funzione | 20 |
| Numero massimo di argomenti di funzione | 7 |
Numero massimo di associazioni di variabili let per funzione |
10 |
| Numero massimo di chiamate di funzione ricorsive o cicliche | 0 (non consentite) |
| Numero massimo di espressioni valutate per richiesta | 1000 |
| Dimensione massima di un set di regole | I set di regole devono rispettare due limiti di dimensione:
|
Passaggi successivi
- Scrivi le condizioni relative alle regole di sicurezza personalizzate.
- Leggi il riferimento sulle regole di sicurezza.