Configurar o acesso apropriado a uma extensão

Para que uma extensão execute as ações especificadas, o Firebase concede a cada instância de uma extensão instalada acesso limitado ao projeto e aos dados por meio de uma conta de serviço.

O que é uma conta de serviço?

Uma conta de serviço é um tipo especial de conta de usuário do Google. Ele representa um usuário não humano que pode fazer chamadas de API autorizadas para os serviços do Google.

Durante a instalação de uma extensão, o Firebase cria uma conta de serviço para a extensão no projeto. Cada instância instalada de uma extensão tem sua própria conta de serviço. Se uma instância de extensão for desinstalada, o Firebase excluirá a conta de serviço da extensão.

As contas de serviço criadas para extensões estão no formato:

ext-extension-instance-id@project-id.iam.gserviceaccount.com

O Firebase limita o acesso de uma extensão a um projeto e aos respectivos dados atribuindo papéis (pacotes de permissões) específicos à conta de serviço da extensão. Ao criar uma extensão, você determina de quais papéis ela precisa para funcionar e, em seguida, lista esses papéis e o motivo pelo qual a extensão precisa deles no arquivo extension.yaml (veja o exemplo na parte inferior de nesta página).

Determinar quais papéis sua extensão exige

Ao criar sua extensão, você determina o nível de acesso que ela precisa para funcionar.

Durante a instalação, a CLI do Firebase solicita que o usuário aceite o nível de acesso concedido por cada papel. Se sua extensão solicitar mais papéis do que realmente precisa, será menos provável que os usuários a instalem.

1. Determine se a extensão interage com um produto:

   • Se a extensão interagir com um produto, será necessário conceder a ela acesso a esse produto.

     Por exemplo, se a extensão gravar dados em uma instância Realtime Database, ela precisará de um papel Realtime Database (especificamente, firebasedatabase.admin).

   • Se a extensão apenas ouvir um evento de gatilho de um produto, ela não precisará de um papel associado a esse produto.

     Por exemplo, se a extensão acionar uma gravação em uma instância do Realtime Database, mas não gravar nada no banco de dados, ela não precisará de um papel do Realtime Database.

2. Depois de determinar com quais produtos sua extensão interage, você precisa decidir qual papel é necessário para essa interação específica. Alguns produtos oferecem funções diferentes, dependendo da ação ou do conjunto de ações realizadas.

   Por exemplo, digamos que sua extensão interaja com um bucket do Cloud Storage. O papel storage.objectCreator permite que a extensão create um objeto em um bucket do Cloud Storage, mas esse papel não permite que a extensão visualize, exclua ou substitua objetos. Para ativar a extensão para executar essas ações adicionais, é necessário atribuir o papel storage.objectAdmin.

Consulte a seção na parte inferior desta página para ver todos os papéis compatíveis que você pode atribuir à conta de serviço da sua extensão. Para saber mais sobre a descrição e as permissões concedidas de cada papel, acesse a documentação do Firebase ou a documentação do Google Cloud. Também é possível procurar papéis no painel do IAM e do administrador do Console do Google Cloud.

Como atribuir papéis a uma extensão

Liste os papéis do IAM necessários para que a extensão funcione na seção roles do arquivo extension.yaml.

Confira um exemplo de extensão que detecta um caminho Firebase Realtime Database especificado. Quando acionada, a extensão atualiza um e-mail de conta de usuário (interação com Firebase Authentication) e envia uma notificação (interação com Firebase Cloud Messaging). Observe o seguinte:

• Mesmo que a extensão seja acionada a partir de um evento do Realtime Database, o papel firebasedatabase.admin não está listado (ouvir não é considerado uma interação).
• Como a extensão interage com Authentication e Cloud Messaging, ela requer papéis para acessar esses produtos (firebaseauth.admin e firebasenotifications.admin, respectivamente).

# extension.yaml
...

# Roles assigned to the extension's service account by Firebase during installation
roles:
  - role: firebaseauth.admin
    reason: Required to update the email address of the user account

  - role: firebasenotifications.admin
    reason: Required to send a notification that the email address has been updated

...

No arquivo extension.yaml, use os seguintes campos para atribuir um papel à conta de serviço de uma extensão:

Reduzir o escopo das funções

As extensões precisam seguir o princípio do menor privilégio e solicitar acesso apenas aos recursos necessários. É possível limitar o escopo de acesso de uma extensão usando o campo role.resource. Por exemplo, se a extensão precisar gravar objetos em um bucket do Cloud Storage, use o seguinte papel:

roles:
  - role: storage.objectCreator
    reason: Needed in order to write
    resource: projects/${PROJECT_ID}/buckets/${STORAGE_BUCKET}

Isso permite que a extensão acesse apenas o bucket necessário e não outros no mesmo projeto.

Este campo é compatível com projetos (projects/{project_id}) e buckets do Storage (projects/{project_id}/buckets/{bucket_id}).

Papéis compatíveis com extensões

A tabela a seguir lista os papéis do IAM compatíveis para interagir com os produtos do Firebase. A maioria dos papéis nesta tabela são Papéis no nível do produto do Firebase, mas algumas são gerenciadas diretamente pelo Google Cloud (especificamente, Cloud Firestore e Cloud Storage).

Produtos do Firebase

Produtos do Google Cloud

Saiba mais sobre esses papéis na documentação do Google Cloud.