Use condições nas regras de segurança do Realtime Database

Este guia baseia-se no guia de linguagem principal das regras de segurança do Firebase para mostrar como adicionar condições às suas regras de segurança do Firebase Realtime Database.

O bloco de construção principal das Regras de Segurança do Realtime Database é a condição . Uma condição é uma expressão booleana que determina se uma determinada operação deve ser permitida ou negada. Para regras básicas, usar literais true e false como condições funciona perfeitamente bem. Mas a linguagem Realtime Database Security Rules oferece maneiras de escrever condições mais complexas que podem:

  • Verifique a autenticação do usuário
  • Avalie os dados existentes em relação aos dados recém-enviados
  • Acesse e compare diferentes partes do seu banco de dados
  • Validar dados de entrada
  • Use a estrutura de consultas de entrada para lógica de segurança

Usando variáveis ​​$ para capturar segmentos de caminho

Você pode capturar partes do caminho para uma leitura ou gravação declarando variáveis ​​de captura com o prefixo $ . Isso serve como um curinga e armazena o valor dessa chave para uso dentro das condições das regras:

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

As variáveis $ dinâmicas também podem ser usadas em paralelo com nomes de caminhos constantes. Neste exemplo, estamos usando a variável $other para declarar uma regra .validate que garante que o widget não tenha filhos além de title e color . Qualquer gravação que resultasse na criação de filhos adicionais falharia.

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

Autenticação

Um dos padrões de regras de segurança mais comuns é controlar o acesso com base no estado de autenticação do usuário. Por exemplo, seu aplicativo pode permitir que apenas usuários conectados gravem dados.

Se seu aplicativo usa o Firebase Authentication, a variável request.auth contém as informações de autenticação do cliente que está solicitando dados. Para obter mais informações sobre request.auth , consulte a documentação de referência .

O Firebase Authentication se integra ao Firebase Realtime Database para permitir que você controle o acesso aos dados por usuário usando condições. Depois que um usuário for autenticado, a variável auth nas regras do Realtime Database Security Rules será preenchida com as informações do usuário. Essas informações incluem seu identificador exclusivo ( uid ), bem como dados da conta vinculada, como um ID do Facebook ou um endereço de e-mail e outras informações. Se você implementar um provedor de autenticação personalizado, poderá adicionar seus próprios campos à carga de autenticação do usuário.

Esta seção explica como combinar a linguagem das regras de segurança do Firebase Realtime Database com as informações de autenticação sobre seus usuários. Ao combinar esses dois conceitos, você pode controlar o acesso aos dados com base na identidade do usuário.

A variável auth

A variável de auth predefinida nas regras é nula antes que a autenticação ocorra.

Depois que um usuário for autenticado com o Firebase Authentication , ele conterá os seguintes atributos:

fornecedor O método de autenticação usado ("senha", "anônimo", "facebook", "github", "google" ou "twitter").
fluido Um ID de usuário exclusivo, com garantia de exclusividade em todos os provedores.
símbolo O conteúdo do token de ID de autenticação do Firebase. Consulte a documentação de referência para auth.token para obter mais detalhes.

Aqui está um exemplo de regra que usa a variável auth para garantir que cada usuário possa gravar apenas em um caminho específico do usuário:

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

Estruturando seu banco de dados para dar suporte a condições de autenticação

Geralmente é útil estruturar seu banco de dados de uma forma que facilite a escrita de Regras. Um padrão comum para armazenar dados do usuário no Realtime Database é armazenar todos os seus usuários em um único nó de users cujos filhos são os valores de uid de cada usuário. Se você quisesse restringir o acesso a esses dados de forma que apenas o usuário logado pudesse ver seus próprios dados, suas regras seriam algo assim.

{
  "rules": {
    "users": {
      "$uid": {
        ".read": "auth != null && auth.uid == $uid"
      }
    }
  }
}

Trabalhando com declarações personalizadas de autenticação

Para aplicativos que exigem controle de acesso personalizado para diferentes usuários, o Firebase Authentication permite que os desenvolvedores definam declarações para um usuário do Firebase . Essas declarações podem ser acessadas na variável auth.token em suas regras. Aqui está um exemplo de regras que usam a declaração personalizada hasEmergencyTowel :

{
  "rules": {
    "frood": {
      // A towel is about the most massively useful thing an interstellar
      // hitchhiker can have
      ".read": "auth.token.hasEmergencyTowel === true"
    }
  }
}

Os desenvolvedores que criam seus próprios tokens de autenticação personalizados podem opcionalmente adicionar declarações a esses tokens. Essas declarações estão disponíveis na variável auth.token em suas regras.

Dados existentes vs. novos dados

A variável de data predefinida é usada para fazer referência aos dados antes que uma operação de gravação ocorra. Por outro lado, a variável newData contém os novos dados que existirão se a operação de gravação for bem-sucedida. newData representa o resultado mesclado dos novos dados sendo gravados e dos dados existentes.

Para ilustrar, essa regra nos permitiria criar novos registros ou excluir os existentes, mas não fazer alterações nos dados não nulos existentes:

// 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()"

Referenciando dados em outros caminhos

Qualquer dado pode ser usado como critério para regras. Usando as variáveis ​​predefinidas root , data e newData , podemos acessar qualquer caminho como existiria antes ou depois de um evento de gravação.

Considere este exemplo, que permite operações de gravação desde que o valor do nó /allow_writes/ seja true , o nó pai não tenha um sinalizador readOnly definido e haja um filho chamado foo nos dados recém-gravados:

".write": "root.child('allow_writes').val() === true &&
          !data.parent().child('readOnly').exists() &&
          newData.child('foo').exists()"

Validando dados

A imposição de estruturas de dados e a validação do formato e conteúdo dos dados devem ser feitas usando regras .validate , que são executadas somente após uma regra .write conseguir conceder acesso. Abaixo está um exemplo de definição de regra .validate que permite apenas datas no formato AAAA-MM-DD entre os anos 1900-2099, que é verificado usando uma expressão regular.

".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])$/)"

As regras .validate são o único tipo de regra de segurança que não é cascata. Se alguma regra de validação falhar em qualquer registro filho, toda a operação de gravação será rejeitada. Além disso, as definições de validação são ignoradas quando os dados são excluídos (ou seja, quando o novo valor que está sendo gravado é null ).

Esses podem parecer pontos triviais, mas na verdade são recursos importantes para escrever regras de segurança do Firebase Realtime Database poderosas. Considere as seguintes regras:

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

Com essa variante em mente, observe os resultados das seguintes operações de gravação:

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);
Objetivo-C
Observação: este produto Firebase não está disponível no destino App Clip.
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];
Rápido
Observação: este produto Firebase não está disponível no destino App Clip.
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);
Java
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);
DESCANSO
# 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

Agora vamos ver a mesma estrutura, mas usando regras .write em vez de .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()"
      }
    }
  }
}

Nesta variante, qualquer uma das seguintes operações seria bem-sucedida:

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);
Objetivo-C
Observação: este produto Firebase não está disponível no destino App Clip.
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];
Rápido
Observação: este produto Firebase não está disponível no destino App Clip.
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)
Java
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);
DESCANSO
# 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

Isso ilustra as diferenças entre as regras .write e .validate . Conforme demonstrado, todas essas regras devem ser escritas usando .validate , com a possível exceção da regra newData.hasChildren() , que dependeria se as exclusões deveriam ser permitidas.

Regras baseadas em consulta

Embora não seja possível usar regras como filtros , você pode limitar o acesso a subconjuntos de dados usando parâmetros de consulta em suas regras. Usar query. expressões em suas regras para conceder acesso de leitura ou gravação com base em parâmetros de consulta.

Por exemplo, a seguinte regra baseada em consulta usa regras de segurança baseadas em usuário e regras baseadas em consulta para restringir o acesso aos dados na coleção de baskets apenas às cestas de compras que o usuário ativo possui:

"baskets": {
  ".read": "auth.uid != null &&
            query.orderByChild == 'owner' &&
            query.equalTo == auth.uid" // restrict basket access to owner of basket
}

A consulta a seguir, que inclui os parâmetros de consulta na regra, seria bem-sucedida:

db.ref("baskets").orderByChild("owner")
                 .equalTo(auth.currentUser.uid)
                 .on("value", cb)                 // Would succeed

No entanto, as consultas que não incluem os parâmetros na regra falhariam com um erro PermissionDenied :

db.ref("baskets").on("value", cb)                 // Would fail with PermissionDenied

Você também pode usar regras baseadas em consulta para limitar a quantidade de dados que um cliente baixa por meio de operações de leitura.

Por exemplo, a regra a seguir limita o acesso de leitura apenas aos primeiros 1.000 resultados de uma consulta, conforme ordenado por prioridade:

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)

A seguinte query. expressões estão disponíveis nas regras de segurança do Realtime Database.

Expressões de regra baseadas em consulta
Expressão Modelo Descrição
query.orderByKey
query.orderByPriority
query.orderByValue
boleano True para consultas ordenadas por chave, prioridade ou valor. Falso caso contrário.
query.orderByChild corda
nulo
Use uma string para representar o caminho relativo para um nó filho. Por exemplo, query.orderByChild == "address/zip" . Se a consulta não for ordenada por um nó filho, esse valor será nulo.
query.startAt
query.endAt
query.equalTo
corda
número
boleano
nulo
Recupera os limites da consulta em execução ou retorna null se não houver um conjunto de limites.
query.limitToFirst
query.limitToLast
número
nulo
Recupera o limite na consulta em execução ou retorna null se não houver limite definido.

Próximos passos

Após essa discussão sobre as condições, você terá uma compreensão mais sofisticada das Regras e estará pronto para:

Saiba como lidar com os principais casos de uso e conheça o fluxo de trabalho para desenvolver, testar e implantar regras:

Conheça os recursos de regras específicos do Realtime Database: