Questa guida si basa sulla guida linguistica Learn the Core Firebase Security Rules per mostrare come aggiungere condizioni alle regole di sicurezza del database in tempo reale di Firebase.
L'elemento principale delle regole di sicurezza del database in tempo reale è la condizione . Una condizione è un'espressione booleana che determina se una particolare operazione deve essere consentita o negata. Per le regole di base, l'uso di valori letterali true
e false
come condizioni funziona perfettamente. Ma il linguaggio delle regole di sicurezza del database in tempo reale ti offre modi per scrivere condizioni più complesse che possono:
- Controlla l'autenticazione dell'utente
- Valuta i dati esistenti rispetto ai dati appena inviati
- Accedi e confronta diverse parti del tuo database
- Convalida i dati in arrivo
- Utilizzare la struttura delle query in entrata per la logica di sicurezza
Utilizzo di variabili $ per acquisire segmenti di percorso
È possibile acquisire parti del percorso per una lettura o scrittura dichiarando le variabili di acquisizione con il prefisso $
. Questo funge da carattere jolly e memorizza il valore di quella chiave per l'uso all'interno delle condizioni delle regole:
{ "rules": { "rooms": { // this rule applies to any child of /rooms/, the key for each room id // is stored inside $room_id variable for reference "$room_id": { "topic": { // the room's topic can be changed if the room id has "public" in it ".write": "$room_id.contains('public')" } } } } }
Le variabili $
dinamiche possono anche essere utilizzate in parallelo con nomi di percorso costanti. In questo esempio, stiamo usando la variabile $other
per dichiarare una regola .validate
che garantisce che widget
non abbia figli diversi da title
e color
. Qualsiasi operazione di scrittura che comporterebbe la creazione di ulteriori figli fallirebbe.
{ "rules": { "widget": { // a widget can have a title or color attribute "title": { ".validate": true }, "color": { ".validate": true }, // but no other child paths are allowed // in this case, $other means any key excluding "title" and "color" "$other": { ".validate": false } } } }
Autenticazione
Uno dei modelli di regole di sicurezza più comuni è il controllo dell'accesso in base allo stato di autenticazione dell'utente. Ad esempio, la tua app potrebbe voler consentire solo agli utenti che hanno eseguito l'accesso di scrivere dati.
Se la tua app utilizza Firebase Authentication, la variabile request.auth
contiene le informazioni di autenticazione per il client che richiede i dati. Per ulteriori informazioni su request.auth
, consultare la documentazione di riferimento .
Firebase Authentication si integra con Firebase Realtime Database per consentirti di controllare l'accesso ai dati in base all'utente utilizzando le condizioni. Dopo che un utente si è autenticato, la variabile auth
nelle regole di Realtime Database Security Rules sarà popolata con le informazioni dell'utente. Queste informazioni includono il loro identificatore univoco ( uid
), nonché i dati dell'account collegato, come un ID di Facebook o un indirizzo e-mail e altre informazioni. Se implementi un provider di autenticazione personalizzato, puoi aggiungere i tuoi campi al payload di autenticazione dell'utente.
Questa sezione spiega come combinare il linguaggio delle regole di sicurezza del database in tempo reale di Firebase con le informazioni di autenticazione sui tuoi utenti. Combinando questi due concetti, puoi controllare l'accesso ai dati in base all'identità dell'utente.
La variabile auth
La variabile auth
predefinita nelle regole è null prima che abbia luogo l'autenticazione.
Una volta che un utente è stato autenticato con Firebase Authentication , conterrà i seguenti attributi:
fornitore | Il metodo di autenticazione utilizzato ("password", "anonymous", "facebook", "github", "google" o "twitter"). |
fluido | Un ID utente univoco, garantito per essere univoco tra tutti i fornitori. |
gettone | I contenuti del token ID autenticazione Firebase. Vedere la documentazione di riferimento per auth.token per ulteriori dettagli. |
Ecco una regola di esempio che utilizza la variabile auth
per garantire che ogni utente possa scrivere solo su un percorso specifico dell'utente:
{ "rules": { "users": { "$user_id": { // grants write access to the owner of this user account // whose uid must exactly match the key ($user_id) ".write": "$user_id === auth.uid" } } } }
Strutturare il database per supportare le condizioni di autenticazione
Di solito è utile strutturare il database in modo da rendere più semplice la scrittura delle regole. Un modello comune per l'archiviazione dei dati utente nel database in tempo reale consiste nell'archiviare tutti gli utenti in un singolo nodo users
i cui figli sono i valori uid
per ogni utente. Se desideri limitare l'accesso a questi dati in modo tale che solo l'utente che ha effettuato l'accesso possa vedere i propri dati, le tue regole sarebbero simili a questa.
{ "rules": { "users": { "$uid": { ".read": "auth !== null && auth.uid === $uid" } } } }
Utilizzo delle attestazioni personalizzate di autenticazione
Per le app che richiedono il controllo degli accessi personalizzato per utenti diversi, Firebase Authentication consente agli sviluppatori di impostare attestazioni su un utente Firebase . Queste attestazioni sono accessibili nella variabile auth.token
nelle tue regole. Di seguito è riportato un esempio di regole che utilizzano l'attestazione personalizzata hasEmergencyTowel
:
{ "rules": { "frood": { // A towel is about the most massively useful thing an interstellar // hitchhiker can have ".read": "auth.token.hasEmergencyTowel === true" } } }
Gli sviluppatori che creano i propri token di autenticazione personalizzati possono facoltativamente aggiungere attestazioni a questi token. Queste attestazioni sono disponibili nella variabile auth.token
nelle tue regole.
Dati esistenti vs. nuovi dati
La variabile data
predefinita viene utilizzata per fare riferimento ai dati prima che venga eseguita un'operazione di scrittura. Al contrario, la variabile newData
contiene i nuovi dati che esisteranno se l'operazione di scrittura ha esito positivo. newData
rappresenta il risultato unito dei nuovi dati scritti e dei dati esistenti.
Per illustrare, questa regola ci consentirebbe di creare nuovi record o eliminare quelli esistenti, ma non di apportare modifiche ai dati non nulli esistenti:
// we can write as long as old data or new data does not exist // in other words, if this is a delete or a create, but not an update ".write": "!data.exists() || !newData.exists()"
Riferimento ai dati in altri percorsi
Qualsiasi dato può essere utilizzato come criterio per le regole. Utilizzando le variabili predefinite root
, data
e newData
, possiamo accedere a qualsiasi percorso come esisterebbe prima o dopo un evento di scrittura.
Considera questo esempio, che consente operazioni di scrittura fintanto che il valore del nodo /allow_writes/
è true
, il nodo padre non ha un flag readOnly
impostato e c'è un figlio chiamato foo
nei dati appena scritti:
".write": "root.child('allow_writes').val() === true && !data.parent().child('readOnly').exists() && newData.child('foo').exists()"
Convalida dei dati
L'applicazione delle strutture di dati e la convalida del formato e del contenuto dei dati devono essere eseguite utilizzando le regole .validate
, che vengono eseguite solo dopo che una regola .write
riesce a concedere l'accesso. Di seguito è riportata una definizione di regola .validate
di esempio che consente solo le date nel formato AAAA-MM-GG comprese tra gli anni 1900-2099, verificate mediante un'espressione regolare.
".validate": "newData.isString() && newData.val().matches(/^(19|20)[0-9][0-9][-\\/. ](0[1-9]|1[012])[-\\/. ](0[1-9]|[12][0-9]|3[01])$/)"
Le regole .validate
sono l'unico tipo di regola di sicurezza che non si sovrappone. Se una regola di convalida fallisce su qualsiasi record figlio, l'intera operazione di scrittura verrà rifiutata. Inoltre, le definizioni di convalida vengono ignorate quando i dati vengono eliminati (ovvero, quando il nuovo valore scritto è null
).
Questi potrebbero sembrare punti banali, ma in realtà sono funzionalità significative per la scrittura di potenti regole di sicurezza del database in tempo reale di Firebase. Considera le seguenti regole:
{ "rules": { // write is allowed for all paths ".write": true, "widget": { // a valid widget must have attributes "color" and "size" // allows deleting widgets (since .validate is not applied to delete rules) ".validate": "newData.hasChildren(['color', 'size'])", "size": { // the value of "size" must be a number between 0 and 99 ".validate": "newData.isNumber() && newData.val() >= 0 && newData.val() <= 99" }, "color": { // the value of "color" must exist as a key in our mythical // /valid_colors/ index ".validate": "root.child('valid_colors/' + newData.val()).exists()" } } } }
Tenendo presente questa variante, guarda i risultati per le seguenti operazioni di scrittura:
javascript
var ref = db.ref("/widget"); // PERMISSION_DENIED: does not have children color and size ref.set('foo'); // PERMISSION DENIED: does not have child color ref.set({size: 22}); // PERMISSION_DENIED: size is not a number ref.set({ size: 'foo', color: 'red' }); // SUCCESS (assuming 'blue' appears in our colors list) ref.set({ size: 21, color: 'blue'}); // If the record already exists and has a color, this will // succeed, otherwise it will fail since newData.hasChildren(['color', 'size']) // will fail to validate ref.child('size').set(99);
Obiettivo-C
FIRDatabaseReference *ref = [[[FIRDatabase database] reference] child: @"widget"]; // PERMISSION_DENIED: does not have children color and size [ref setValue: @"foo"]; // PERMISSION DENIED: does not have child color [ref setValue: @{ @"size": @"foo" }]; // PERMISSION_DENIED: size is not a number [ref setValue: @{ @"size": @"foo", @"color": @"red" }]; // SUCCESS (assuming 'blue' appears in our colors list) [ref setValue: @{ @"size": @21, @"color": @"blue" }]; // If the record already exists and has a color, this will // succeed, otherwise it will fail since newData.hasChildren(['color', 'size']) // will fail to validate [[ref child:@"size"] setValue: @99];
Rapido
var ref = FIRDatabase.database().reference().child("widget") // PERMISSION_DENIED: does not have children color and size ref.setValue("foo") // PERMISSION DENIED: does not have child color ref.setValue(["size": "foo"]) // PERMISSION_DENIED: size is not a number ref.setValue(["size": "foo", "color": "red"]) // SUCCESS (assuming 'blue' appears in our colors list) ref.setValue(["size": 21, "color": "blue"]) // If the record already exists and has a color, this will // succeed, otherwise it will fail since newData.hasChildren(['color', 'size']) // will fail to validate ref.child("size").setValue(99);
Giava
FirebaseDatabase database = FirebaseDatabase.getInstance(); DatabaseReference ref = database.getReference("widget"); // PERMISSION_DENIED: does not have children color and size ref.setValue("foo"); // PERMISSION DENIED: does not have child color ref.child("size").setValue(22); // PERMISSION_DENIED: size is not a number Map<String,Object> map = new HashMap<String, Object>(); map.put("size","foo"); map.put("color","red"); ref.setValue(map); // SUCCESS (assuming 'blue' appears in our colors list) map = new HashMap<String, Object>(); map.put("size", 21); map.put("color","blue"); ref.setValue(map); // If the record already exists and has a color, this will // succeed, otherwise it will fail since newData.hasChildren(['color', 'size']) // will fail to validate ref.child("size").setValue(99);
RIPOSO
# PERMISSION_DENIED: does not have children color and size curl -X PUT -d 'foo' \ https://docs-examples.firebaseio.com/rest/securing-data/example.json # PERMISSION DENIED: does not have child color curl -X PUT -d '{"size": 22}' \ https://docs-examples.firebaseio.com/rest/securing-data/example.json # PERMISSION_DENIED: size is not a number curl -X PUT -d '{"size": "foo", "color": "red"}' \ https://docs-examples.firebaseio.com/rest/securing-data/example.json # SUCCESS (assuming 'blue' appears in our colors list) curl -X PUT -d '{"size": 21, "color": "blue"}' \ https://docs-examples.firebaseio.com/rest/securing-data/example.json # If the record already exists and has a color, this will # succeed, otherwise it will fail since newData.hasChildren(['color', 'size']) # will fail to validate curl -X PUT -d '99' \ https://docs-examples.firebaseio.com/rest/securing-data/example/size.json
Ora diamo un'occhiata alla stessa struttura, ma utilizzando le regole .write
invece di .validate
:
{ "rules": { // this variant will NOT allow deleting records (since .write would be disallowed) "widget": { // a widget must have 'color' and 'size' in order to be written to this path ".write": "newData.hasChildren(['color', 'size'])", "size": { // the value of "size" must be a number between 0 and 99, ONLY IF WE WRITE DIRECTLY TO SIZE ".write": "newData.isNumber() && newData.val() >= 0 && newData.val() <= 99" }, "color": { // the value of "color" must exist as a key in our mythical valid_colors/ index // BUT ONLY IF WE WRITE DIRECTLY TO COLOR ".write": "root.child('valid_colors/'+newData.val()).exists()" } } } }
In questa variante, una qualsiasi delle seguenti operazioni avrebbe esito positivo:
javascript
var ref = new Firebase(URL + "/widget"); // ALLOWED? Even though size is invalid, widget has children color and size, // so write is allowed and the .write rule under color is ignored ref.set({size: 99999, color: 'red'}); // ALLOWED? Works even if widget does not exist, allowing us to create a widget // which is invalid and does not have a valid color. // (allowed by the write rule under "color") ref.child('size').set(99);
Obiettivo-C
Firebase *ref = [[Firebase alloc] initWithUrl:URL]; // ALLOWED? Even though size is invalid, widget has children color and size, // so write is allowed and the .write rule under color is ignored [ref setValue: @{ @"size": @9999, @"color": @"red" }]; // ALLOWED? Works even if widget does not exist, allowing us to create a widget // which is invalid and does not have a valid color. // (allowed by the write rule under "color") [[ref childByAppendingPath:@"size"] setValue: @99];
Rapido
var ref = Firebase(url:URL) // ALLOWED? Even though size is invalid, widget has children color and size, // so write is allowed and the .write rule under color is ignored ref.setValue(["size": 9999, "color": "red"]) // ALLOWED? Works even if widget does not exist, allowing us to create a widget // which is invalid and does not have a valid color. // (allowed by the write rule under "color") ref.childByAppendingPath("size").setValue(99)
Giava
Firebase ref = new Firebase(URL + "/widget"); // ALLOWED? Even though size is invalid, widget has children color and size, // so write is allowed and the .write rule under color is ignored Map<String,Object> map = new HashMap<String, Object>(); map.put("size", 99999); map.put("color", "red"); ref.setValue(map); // ALLOWED? Works even if widget does not exist, allowing us to create a widget // which is invalid and does not have a valid color. // (allowed by the write rule under "color") ref.child("size").setValue(99);
RIPOSO
# ALLOWED? Even though size is invalid, widget has children color and size, # so write is allowed and the .write rule under color is ignored curl -X PUT -d '{size: 99999, color: "red"}' \ https://docs-examples.firebaseio.com/rest/securing-data/example.json # ALLOWED? Works even if widget does not exist, allowing us to create a widget # which is invalid and does not have a valid color. # (allowed by the write rule under "color") curl -X PUT -d '99' \ https://docs-examples.firebaseio.com/rest/securing-data/example/size.json
Questo illustra le differenze tra le regole .write
e .validate
. Come dimostrato, tutte queste regole dovrebbero essere scritte utilizzando .validate
, con la possibile eccezione della regola newData.hasChildren()
, che dipenderebbe dal fatto che le eliminazioni debbano essere consentite.
Regole basate su query
Sebbene non sia possibile utilizzare le regole come filtri , è possibile limitare l'accesso a sottoinsiemi di dati utilizzando i parametri di query nelle regole. Usa query.
espressioni nelle regole per concedere l'accesso in lettura o scrittura in base ai parametri di query.
Ad esempio, la seguente regola basata su query utilizza regole di sicurezza basate sull'utente e regole basate su query per limitare l'accesso ai dati nella raccolta baskets
solo ai carrelli acquisti di proprietà dell'utente attivo:
"baskets": {
".read": "auth.uid !== null &&
query.orderByChild === 'owner' &&
query.equalTo === auth.uid" // restrict basket access to owner of basket
}
La seguente query, che include i parametri della query nella regola, avrà esito positivo:
db.ref("baskets").orderByChild("owner")
.equalTo(auth.currentUser.uid)
.on("value", cb) // Would succeed
Tuttavia, le query che non includono i parametri nella regola fallirebbero con un errore PermissionDenied
:
db.ref("baskets").on("value", cb) // Would fail with PermissionDenied
È inoltre possibile utilizzare regole basate su query per limitare la quantità di dati scaricati da un client tramite operazioni di lettura.
Ad esempio, la seguente regola limita l'accesso in lettura solo ai primi 1000 risultati di una query, in ordine di priorità:
messages: {
".read": "query.orderByKey &&
query.limitToFirst <= 1000"
}
// Example queries:
db.ref("messages").on("value", cb) // Would fail with PermissionDenied
db.ref("messages").limitToFirst(1000)
.on("value", cb) // Would succeed (default order by key)
La seguente query.
le espressioni sono disponibili nelle regole di sicurezza del database in tempo reale.
Espressioni di regole basate su query | ||
---|---|---|
Espressione | Tipo | Descrizione |
query.orderByKey query.orderByPriority query.orderByValue | booleano | True per le query ordinate per chiave, priorità o valore. Falso altrimenti. |
query.orderByChild | corda nullo | Utilizzare una stringa per rappresentare il percorso relativo a un nodo figlio. Ad esempio, query.orderByChild === "address/zip" . Se la query non è ordinata da un nodo figlio, questo valore è null. |
query.startAt query.endAt query.equalTo | corda numero booleano nullo | Recupera i limiti della query in esecuzione o restituisce null se non è impostato alcun limite. |
query.limitToFirst query.limitToLast | numero nullo | Recupera il limite sulla query in esecuzione o restituisce null se non è stato impostato alcun limite. |
Prossimi passi
Dopo questa discussione sulle condizioni, hai una comprensione più sofisticata delle Regole e sei pronto a:
Scopri come gestire i casi d'uso principali e apprendi il flusso di lavoro per lo sviluppo, il test e l'implementazione delle regole:
- Scopri il set completo di variabili Rules predefinite che puoi utilizzare per creare condizioni .
- Scrivere regole che affrontino scenari comuni .
- Sviluppa le tue conoscenze rivedendo le situazioni in cui devi individuare ed evitare Regole insicure .
- Ulteriori informazioni su Firebase Local Emulator Suite e su come utilizzarla per testare le regole .
- Esaminare i metodi disponibili per la distribuzione delle regole .
Scopri le funzionalità delle regole specifiche di Realtime Database:
- Scopri come indicizzare il tuo database in tempo reale .
- Esamina l' API REST per la distribuzione di Rules .