Impara la sintassi di base del linguaggio delle regole di sicurezza del database in tempo reale

Le regole di sicurezza del database in tempo reale di Firebase ti consentono di controllare l'accesso ai dati archiviati nel tuo database. La sintassi flessibile delle regole consente di creare regole che corrispondono a qualsiasi cosa, da tutte le scritture nel database alle operazioni sui singoli nodi.

Le regole di sicurezza del database in tempo reale sono una configurazione dichiarativa per il tuo database. Ciò significa che le regole sono definite separatamente dalla logica del prodotto. Ciò ha una serie di vantaggi: i client non sono responsabili dell'applicazione della sicurezza, implementazioni difettose non comprometteranno i tuoi dati e, cosa forse più importante, non è necessario un arbitro intermedio, come un server, per proteggere i dati dal mondo.

Questo argomento descrive la sintassi e la struttura di base Regole di sicurezza del database in tempo reale utilizzate per creare set di regole completi.

Strutturare le regole di sicurezza

Le regole di sicurezza del database in tempo reale sono costituite da espressioni simili a JavaScript contenute in un documento JSON. La struttura delle tue regole dovrebbe seguire la struttura dei dati che hai memorizzato nel tuo database.

Le regole di base identificano un insieme di nodi da proteggere, i metodi di accesso (ad es. lettura, scrittura) coinvolti e le condizioni in base alle quali l'accesso è consentito o negato. Negli esempi seguenti, le nostre condizioni saranno semplici affermazioni true e false , ma nel prossimo argomento tratteremo modi più dinamici per esprimere le condizioni.

Quindi, ad esempio, se stiamo cercando di proteggere un child_node sotto un parent_node , la sintassi generale da seguire è:

{
  "rules": {
    "parent_node": {
      "child_node": {
        ".read": <condition>,
        ".write": <condition>,
        ".validate": <condition>,
      }
    }
  }
}

Applichiamo questo modello. Ad esempio, supponiamo che tu stia tenendo traccia di un elenco di messaggi e disponga di dati simili a questi:

{
  "messages": {
    "message0": {
      "content": "Hello",
      "timestamp": 1405704370369
    },
    "message1": {
      "content": "Goodbye",
      "timestamp": 1405704395231
    },
    ...
  }
}

Le tue regole dovrebbero essere strutturate in modo simile. Ecco un insieme di regole per la sicurezza in sola lettura che potrebbe avere senso per questa struttura di dati. Questo esempio illustra come specifichiamo i nodi del database a cui applicare le regole e le condizioni per la valutazione delle regole in quei nodi.

{
  "rules": {
    // For requests to access the 'messages' node...
    "messages": {
      // ...and the individual wildcarded 'message' nodes beneath
      // (we'll cover wildcarding variables more a bit later)....
      "$message": {

        // For each message, allow a read operation if <condition>. In this
        // case, we specify our condition as "true", so read access is always granted.
        ".read": "true",

        // For read-only behavior, we specify that for write operations, our
        // condition is false.
        ".write": "false"
      }
    }
  }
}

Regole di base Operazioni

Esistono tre tipi di regole per applicare la sicurezza in base al tipo di operazione eseguita sui dati: .write , .read e .validate . Ecco un breve riassunto dei loro scopi:

Variabili di cattura con caratteri jolly

Tutte le istruzioni delle regole puntano ai nodi. Un'istruzione può puntare a un nodo specifico o utilizzare variabili di acquisizione con caratteri jolly $ per puntare a insiemi di nodi a un livello della gerarchia. Utilizzare queste variabili di acquisizione per archiviare il valore delle chiavi del nodo da utilizzare all'interno delle successive istruzioni delle regole. Questa tecnica consente di scrivere condizioni Rules più complesse, argomento che tratteremo più dettagliatamente nel prossimo argomento.

{
  "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 }
    }
  }
}

Leggi e scrivi regole a cascata

Le regole .read e .write funzionano dall'alto verso il basso, con regole meno profonde che sovrascrivono regole più profonde. Se una regola concede autorizzazioni di lettura o scrittura su un determinato percorso, concede anche l'accesso a tutti i nodi figlio sotto di essa. Considera la seguente struttura:

{
  "rules": {
     "foo": {
        // allows read to /foo/*
        ".read": "data.child('baz').val() === true",
        "bar": {
          /* ignored, since read was allowed already */
          ".read": false
        }
     }
  }
}

Questa struttura di sicurezza consente di leggere /bar/ ogni volta che /foo/ contiene un figlio baz con valore true . La regola ".read": false sotto /foo/bar/ non ha effetto qui, poiché l'accesso non può essere revocato da un percorso figlio.

Sebbene possa non sembrare immediatamente intuitivo, questa è una parte potente del linguaggio delle regole e consente di implementare privilegi di accesso molto complessi con il minimo sforzo. Questo verrà illustrato quando entreremo nella sicurezza basata sull'utente più avanti in questa guida.

Si noti che le regole .validate non si sovrappongono. Tutte le regole di convalida devono essere soddisfatte a tutti i livelli della gerarchia affinché sia ​​consentita una scrittura.

Le regole non sono filtri

Le regole sono applicate in modo atomico. Ciò significa che un'operazione di lettura o scrittura fallisce immediatamente se non esiste una regola in quella posizione o in una posizione padre che conceda l'accesso. Anche se ogni percorso figlio interessato è accessibile, la lettura nella posizione padre fallirà completamente. Considera questa struttura:

{
  "rules": {
    "records": {
      "rec1": {
        ".read": true
      },
      "rec2": {
        ".read": false
      }
    }
  }
}

Senza comprendere che le regole vengono valutate in modo atomico, potrebbe sembrare che il recupero del percorso /records/ restituisca rec1 ma non rec2 . Il risultato effettivo, tuttavia, è un errore:

var db = firebase.database();
db.ref("records").once("value", function(snap) {
  // success method is not called
}, function(err) {
  // error callback triggered with PERMISSION_DENIED
});

FIRDatabaseReference *ref = [[FIRDatabase database] reference];
[[_ref child:@"records"] observeSingleEventOfType:FIRDataEventTypeValue withBlock:^(FIRDataSnapshot *snapshot) {
  // success block is not called
} withCancelBlock:^(NSError * _Nonnull error) {
  // cancel block triggered with PERMISSION_DENIED
}];

var ref = FIRDatabase.database().reference()
ref.child("records").observeSingleEventOfType(.Value, withBlock: { snapshot in
    // success block is not called
}, withCancelBlock: { error in
    // cancel block triggered with PERMISSION_DENIED
})

FirebaseDatabase database = FirebaseDatabase.getInstance();
DatabaseReference ref = database.getReference("records");
ref.addListenerForSingleValueEvent(new ValueEventListener() {
  @Override
  public void onDataChange(DataSnapshot snapshot) {
    // success method is not called
  }

  @Override
  public void onCancelled(FirebaseError firebaseError) {
    // error callback triggered with PERMISSION_DENIED
  });
});

curl https://docs-examples.firebaseio.com/rest/records/
# response returns a PERMISSION_DENIED error

Poiché l'operazione di lettura su /records/ è atomica e non esiste una regola di lettura che conceda l'accesso a tutti i dati in /records/ , questo genererà un errore PERMISSION_DENIED . Se valutiamo questa regola nel simulatore di sicurezza nella nostra console Firebase , possiamo vedere che l'operazione di lettura è stata negata perché nessuna regola di lettura ha consentito l'accesso al percorso /records/ . Tuttavia, tieni presente che la regola per rec1 non è mai stata valutata perché non era nel percorso richiesto. Per recuperare rec1 , dovremmo accedervi direttamente:

var db = firebase.database();
db.ref("records/rec1").once("value", function(snap) {
  // SUCCESS!
}, function(err) {
  // error callback is not called
});

FIRDatabaseReference *ref = [[FIRDatabase database] reference];
[[ref child:@"records/rec1"] observeSingleEventOfType:FEventTypeValue withBlock:^(FIRDataSnapshot *snapshot) {
    // SUCCESS!
}];

var ref = FIRDatabase.database().reference()
ref.child("records/rec1").observeSingleEventOfType(.Value, withBlock: { snapshot in
    // SUCCESS!
})

FirebaseDatabase database = FirebaseDatabase.getInstance();
DatabaseReference ref = database.getReference("records/rec1");
ref.addListenerForSingleValueEvent(new ValueEventListener() {
  @Override
  public void onDataChange(DataSnapshot snapshot) {
    // SUCCESS!
  }

  @Override
  public void onCancelled(FirebaseError firebaseError) {
    // error callback is not called
  }
});

curl https://docs-examples.firebaseio.com/rest/records/rec1
# SUCCESS!

Dichiarazioni sovrapposte

È possibile applicare più di una regola a un nodo. Nel caso in cui più espressioni di regole identifichino un nodo, il metodo di accesso viene negato se una qualsiasi delle condizioni è false :

{
  "rules": {
    "messages": {
      // A rule expression that applies to all nodes in the 'messages' node
      "$message": {
        ".read": "true",
        ".write": "true"
      },
      // A second rule expression applying specifically to the 'message1` node
      "message1": {
        ".read": "false",
        ".write": "false"
      }
    }
  }
}

Nell'esempio precedente, le letture al nodo message1 verranno negate perché la seconda regola è sempre false , anche se la prima regola è sempre true .

Prossimi passi

Puoi approfondire la tua comprensione delle regole di sicurezza del database in tempo reale di Firebase:

• 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, controllare la struttura delle query provenienti dal client e altro ancora.

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