Como funcionam as regras de segurança

Cloud Fire Store

Estrutura básica

As regras de segurança do Firebase no Cloud Firestore e no Cloud Storage usam a seguinte estrutura e sintaxe:

service <<name>> {
  // Match the resource path.
  match <<path>> {
    // Allow the request if the following conditions are true.
    allow <<methods>> : if <<condition>>
  }
}

É importante entender os seguintes conceitos-chave à medida que você cria as regras:

• Solicitação: o método ou métodos invocados na instrução allow . Esses são métodos que você está permitindo executar. Os métodos padrão são: get , list , create , update e delete . Os métodos convenientes de read e write permitem amplo acesso de leitura e gravação no banco de dados ou caminho de armazenamento especificado.
• Caminho: O banco de dados ou local de armazenamento, representado como um caminho URI.
• Regra: A instrução allow , que inclui uma condição que permite uma solicitação se for avaliada como verdadeira.

Regras de segurança versão 2

A partir de maio de 2019, a versão 2 das regras de segurança do Firebase já está disponível. A versão 2 das regras altera o comportamento dos curingas recursivos {name=**} . Você deverá usar a versão 2 se planejar usar consultas de grupo de coleta . Você deve optar pela versão 2 fazendo rules_version = '2'; a primeira linha em suas regras de segurança:

rules_version = '2';
service cloud.firestore {
  match /databases/{database}/documents {

Caminhos correspondentes

Todas as declarações de correspondência devem apontar para documentos, não para coleções. Uma instrução match pode apontar para um documento específico, como em match /cities/SF ou usar curingas para apontar para qualquer documento no caminho especificado, como em match /cities/{city} .

No exemplo acima, a instrução match usa a sintaxe curinga {city} . Isso significa que a regra se aplica a qualquer documento da coleção cities , como /cities/SF ou /cities/NYC . Quando as expressões allow na instrução match são avaliadas, a variável city será resolvida para o nome do documento da cidade, como SF ou NYC .

Subcoleções correspondentes

Os dados no Cloud Firestore são organizados em coleções de documentos, e cada documento pode estender a hierarquia por meio de subcoleções. É importante compreender como as regras de segurança interagem com os dados hierárquicos.

Considere a situação em que cada documento da coleção de cities contém uma subcoleção landmarks . As regras de segurança aplicam-se apenas ao caminho correspondente, portanto os controles de acesso definidos na coleção cities não se aplicam à subcoleção landmarks . Em vez disso, escreva regras explícitas para controlar o acesso às subcoleções:

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>;
      }
    }
  }
}

Ao aninhar instruções match , o caminho da instrução match interna é sempre relativo ao caminho da instrução match externa. Os seguintes conjuntos de regras são, portanto, equivalentes:

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>;
    }
  }
}

Curingas recursivos

Se você deseja que as regras sejam aplicadas a uma hierarquia arbitrariamente profunda, use a sintaxe curinga recursiva, {name=**} :

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>;
    }
  }
}

Ao usar a sintaxe curinga recursiva, a variável curinga conterá todo o segmento do caminho correspondente, mesmo se o documento estiver localizado em uma subcoleção profundamente aninhada. Por exemplo, as regras listadas acima corresponderiam a um documento localizado em /cities/SF/landmarks/coit_tower e o valor da variável document seria SF/landmarks/coit_tower .

Observe, entretanto, que o comportamento dos curingas recursivos depende da versão das regras.

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>;
    }
  }
}

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 você usar consultas de grupo de coleta , deverá usar a versão 2, consulte protegendo consultas de grupo de coleta .

Sobreposição de declarações de correspondência

É possível que um documento corresponda a mais de uma instrução match . No caso de múltiplas expressões allow corresponderem a uma solicitação, o acesso será permitido se alguma das condições for 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;
    }
  }
}

No exemplo acima, todas as leituras e gravações na coleção cities serão permitidas porque a segunda regra é sempre true , mesmo que a primeira regra seja sempre false .

Limites das regras de segurança

Ao trabalhar com regras de segurança, observe os seguintes limites:

Armazenamento na núvem

Estrutura básica

As regras de segurança do Firebase no Cloud Firestore e no Cloud Storage usam a seguinte estrutura e sintaxe:

service <<name>> {
  // Match the resource path.
  match <<path>> {
    // Allow the request if the following conditions are true.
    allow <<methods>> : if <<condition>>
  }
}

É importante entender os seguintes conceitos-chave à medida que você cria as regras:

• Solicitação: o método ou métodos invocados na instrução allow . Esses são métodos que você está permitindo executar. Os métodos padrão são: get , list , create , update e delete . Os métodos convenientes de read e write permitem amplo acesso de leitura e gravação no banco de dados ou caminho de armazenamento especificado.
• Caminho: O banco de dados ou local de armazenamento, representado como um caminho URI.
• Regra: A instrução allow , que inclui uma condição que permite uma solicitação se for avaliada como verdadeira.

Caminhos correspondentes

As regras de segurança do Cloud Storage match aos caminhos de arquivo usados ​​para acessar arquivos no Cloud Storage. As regras podem match a caminhos exatos ou curingas, e as regras também podem ser aninhadas. Se nenhuma regra de correspondência permitir um método de solicitação ou se a condição for avaliada como false , a solicitação será negada.

Correspondências exatas

// Exact match for "images/profilePhoto.png"
match /images/profilePhoto.png {
  allow write: if <condition>;
}

// Exact match for "images/croppedProfilePhoto.png"
match /images/croppedProfilePhoto.png {
  allow write: if <other_condition>;
}

Correspondências aninhadas

// Partial match for files that start with "images"
match /images {
  // Exact match for "images/profilePhoto.png"
  match /profilePhoto.png {
    allow write: if <condition>;
  }

  // Exact match for "images/croppedProfilePhoto.png"
  match /croppedProfilePhoto.png {
    allow write: if <other_condition>;
  }
}

Correspondências curinga

As regras também podem ser usadas para match a um padrão usando curingas. Um curinga é uma variável nomeada que representa uma única string, como profilePhoto.png , ou vários segmentos de caminho, como images/profilePhoto.png .

Um curinga é criado adicionando chaves ao redor do nome do curinga, como {string} . Um curinga de múltiplos segmentos pode ser declarado adicionando =** ao nome do curinga, como {path=**} :

// Partial match for files that start with "images"
match /images {
  // Exact match for "images/*"
  // e.g. images/profilePhoto.png is matched
  match /{imageId} {
    // This rule only matches a single path segment (*)
    // imageId is a string that contains the specific segment matched
    allow read: if <condition>;
  }

  // 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 várias regras corresponderem a um arquivo, o resultado será o OR do resultado de todas as avaliações de regras. Ou seja, se alguma regra correspondente ao arquivo for avaliada como true , o resultado será true .

Nas regras acima, o arquivo "images/profilePhoto.png" pode ser lido se qualquer condition ou other_condition for avaliada como verdadeira, enquanto o arquivo "images/users/user:12345/profilePhoto.png" está sujeito apenas ao resultado de other_condition .

Uma variável curinga pode ser referenciada no nome do arquivo match ou na autorização do caminho:

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

As regras de segurança do Cloud Storage não são cascatas e as regras só são avaliadas quando o caminho da solicitação corresponde a um caminho com regras especificadas.

Solicitar avaliação

Uploads, downloads, alterações de metadados e exclusões são avaliados usando a request enviada ao Cloud Storage. A variável request contém o caminho do arquivo onde a solicitação está sendo executada, a hora em que a solicitação é recebida e o novo valor resource se a solicitação for uma gravação. Cabeçalhos HTTP e estado de autenticação também estão incluídos.

O objeto request também contém o ID exclusivo do usuário e a carga útil do Firebase Authentication no objeto request.auth , que será explicado mais detalhadamente na seção Autenticação dos documentos.

Uma lista completa de propriedades no objeto request está disponível abaixo:

Avaliação de recursos

Ao avaliar regras, você também pode avaliar os metadados do arquivo que está sendo carregado, baixado, modificado ou excluído. Isso permite que você crie regras complexas e poderosas que fazem coisas como permitir apenas o upload de arquivos com determinados tipos de conteúdo ou apenas a exclusão de arquivos maiores que um determinado tamanho.

As regras de segurança do Firebase para Cloud Storage fornecem metadados de arquivo no objeto resource , que contém pares chave/valor dos metadados exibidos em um objeto do Cloud Storage. Essas propriedades podem ser inspecionadas em solicitações read ou write para garantir a integridade dos dados.

Em solicitações write (como uploads, atualizações de metadados e exclusões), além do objeto resource , que contém metadados de arquivo para o arquivo que existe atualmente no caminho da solicitação, você também tem a capacidade de usar o objeto request.resource , que contém um subconjunto dos metadados do arquivo a serem gravados se a gravação for permitida. Você pode usar esses dois valores para garantir a integridade dos dados ou impor restrições de aplicativo, como tipo ou tamanho de arquivo.

Uma lista completa de propriedades no objeto resource está disponível abaixo:

request.resource contém tudo isso, com exceção de generation , metageneration , etag , timeCreated e updated .

Limites das regras de segurança

Ao trabalhar com regras de segurança, observe os seguintes limites:

Exemplo completo

Juntando tudo isso, você pode criar um exemplo completo de regras para uma solução de armazenamento de imagens:

service firebase.storage {
 match /b/{bucket}/o {
   match /images {
     // Cascade read to any image type at any path
     match /{allImages=**} {
       allow read;
     }

     // Allow write files to the path "images/*", subject to the constraints:
     // 1) File is less than 5MB
     // 2) Content type is an image
     // 3) Uploaded content type matches existing content type
     // 4) File name (stored in imageId wildcard variable) is less than 32 characters
     match /{imageId} {
       allow write: if request.resource.size < 5 * 1024 * 1024
                    && request.resource.contentType.matches('image/.*')
                    && request.resource.contentType == resource.contentType
                    && imageId.size() < 32
     }
   }
 }
}

Banco de dados em tempo real

Estrutura básica

No Realtime Database, as regras de segurança do Firebase consistem em expressões semelhantes a JavaScript contidas em um documento JSON.

Eles usam a seguinte sintaxe:

{
  "rules": {
    "<<path>>": {
    // Allow the request if the condition for each method is true.
      ".read": <<condition>>,
      ".write": <<condition>>,
      ".validate": <<condition>>
    }
  }
}

Existem três elementos básicos na regra:

• Caminho: o local do banco de dados. Isso reflete a estrutura JSON do seu banco de dados.
• Solicitação: estes são os métodos que a regra usa para conceder acesso. As regras read e write concedem amplo acesso de leitura e gravação, enquanto as regras validate atuam como uma verificação secundária para conceder acesso com base em dados recebidos ou existentes.
• Condição: A condição que permite uma solicitação se for avaliada como verdadeira.

Como as regras se aplicam aos caminhos

No Realtime Database, as regras se aplicam atomicamente, o que significa que as regras em nós pais de nível superior substituem as regras em nós filhos mais granulares e as regras em um nó mais profundo não podem conceder acesso a um caminho pai. Você não pode refinar ou revogar o acesso a um caminho mais profundo na estrutura do seu banco de dados se já o tiver concedido para um dos caminhos pai.

Considere as seguintes regras:

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

Esta estrutura de segurança permite que /bar/ seja lido sempre que /foo/ contiver um filho baz com valor true . A regra ".read": false em /foo/bar/ não tem efeito aqui, pois o acesso não pode ser revogado por um caminho filho.

Embora possa não parecer imediatamente intuitivo, esta é uma parte poderosa da linguagem de regras e permite que privilégios de acesso muito complexos sejam implementados com esforço mínimo. Isto é particularmente útil para segurança baseada no usuário .

No entanto, as regras .validate não são cascatas. Todas as regras de validação devem ser satisfeitas em todos os níveis da hierarquia para que uma gravação seja permitida.

Além disso, como as regras não se aplicam a um caminho pai, a operação de leitura ou gravação falhará se não houver uma regra no local solicitado ou em um local pai que conceda acesso. Mesmo que todos os caminhos filho afetados estejam acessíveis, a leitura no local pai falhará completamente. Considere esta estrutura:

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

Sem entender que as regras são avaliadas atomicamente, pode parecer que buscar o caminho /records/ retornaria rec1 mas não rec2 . O resultado real, no entanto, é um erro:

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

Como a operação de leitura em /records/ é atômica e não há regra de leitura que conceda acesso a todos os dados em /records/ , isso gerará um erro PERMISSION_DENIED . Se avaliarmos esta regra no simulador de segurança em nosso Firebase console , podemos ver que a operação de leitura foi negada:

Attempt to read /records with auth=Success(null)
    /
    /records

No .read rule allowed the operation.
Read was denied.

A operação foi negada porque nenhuma regra de leitura permitia acesso ao caminho /records/ , mas observe que a regra para rec1 nunca foi avaliada porque não estava no caminho que solicitamos. Para buscar rec1 , precisaríamos acessá-lo diretamente:

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!

Variável de localização

As regras do Realtime Database oferecem suporte a uma variável $location para corresponder aos segmentos de caminho. Use o prefixo $ na frente do segmento do caminho para combinar sua regra com qualquer nó filho ao longo do caminho.

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

Você também pode usar a $variable em paralelo com nomes de caminhos constantes.

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