O Google usa tecnologia de IA na tradução de conteúdos para seu idioma de preferência. As traduções com IA podem ter erros.

Proteger e controlar o acesso aos dados do aplicativo usando visualizações seguras parametrizadas

As visualizações seguras parametrizadas oferecem segurança de dados e controle de acesso a linhas para aplicativos. Eles filtram os resultados da consulta com base na identidade do usuário do aplicativo.

Neste tutorial, descrevemos como configurar visualizações seguras parametrizadas no Cloud SQL, configurar papéis e privilégios de banco de dados para restringir o acesso a tabelas base e verificar segurança de dados. Os exemplos fornecidos neste documento são apenas para fins de demonstração.

O que são visualizações seguras parametrizadas?

Como prática recomendada geral, seu aplicativo deve ser executado usando uma conta de serviço com o acesso mínimo necessário ao banco de dados. Por exemplo, se o aplicativo não precisar gravar no banco de dados, ele deverá usar um papel com acesso somente leitura. Configure esses controles de acesso no nível do banco de dados.

Quando o aplicativo precisa de uma segurança mais granular do que o acesso padrão no nível do banco de dados, é possível usar visualizações seguras parametrizadas para garantir que os usuários tenham acesso de visualização apenas aos dados autorizados. As visualizações seguras parametrizadas oferecem segurança de dados dinâmica e controle de acesso a linhas adequados para aplicativos SaaS multilocatários sem exigir papéis de banco de dados separados para cada usuário final do aplicativo.

O uso de visualizações seguras parametrizadas oferece três benefícios principais:

Segurança de dados dinâmica e controle de acesso por linha: filtra consultas usando identificadores de usuário final para que os usuários acessem apenas os dados autorizados, independentemente da frase da consulta.
Gerenciamento de papéis mais fácil: usa um único papel de banco de dados compartilhado para todos os usuários do aplicativo, em vez de gerenciar papéis de banco de dados separados para cada indivíduo.

Objetivos

Criar visualizações seguras parametrizadas com parâmetros de visualização nomeados.
Crie o papel de banco de dados usado pelo aplicativo para se conectar ao banco de dados e acessar visualizações seguras parametrizadas.
Conceda as permissões do novo papel às visualizações seguras parametrizadas e revogue o acesso às tabelas base.
Conecte-se usando o novo papel e verifique se as tabelas restritas não podem ser acessadas.
Execute consultas nas visualizações seguras parametrizadas usando a função execute_parameterized_query() ou a API QueryData.

Custos

Neste documento, você vai usar os seguintes componentes faturáveis do Google Cloud:

Cloud SQL para PostgreSQL

Para gerar uma estimativa de custo baseada na projeção de uso deste tutorial, use a calculadora de preços.

Novos usuários do Google Cloud podem estar qualificados para um teste sem custo financeiro.

Para evitar o faturamento contínuo, exclua os recursos criados ao concluir as tarefas deste documento. Para mais informações, consulte Limpeza.

Antes de começar

Antes de criar visualizações seguras parametrizadas, conclua os pré-requisitos a seguir.

Ativar o faturamento e as APIs necessárias

No Google Cloud console, selecione um projeto.

Acessar o seletor de projetos
Verifique se o faturamento está ativado para seu projeto do Google Cloud .
Ative as APIs do Cloud necessárias para criar e se conectar ao Cloud SQL.
1. Ativar a API
2. Na etapa Confirmar projeto, clique em Avançar para confirmar o nome do projeto no qual você vai fazer alterações.
3. Na etapa Ativar APIs, clique em Ativar para ativar o seguinte:
  - API Cloud SQL para PostgreSQL
  - API Knowledge Catalog
  - API Data Analytics com Gemini (geminidataanalytics.googleapis.com)

Criar e se conectar a um banco de dados

Criar uma instância.
Conecte-se à instância e crie um banco de dados.
Ative a API Cloud SQL Data na instância do Cloud SQL para PostgreSQL para que a API QueryData possa executar consultas nela:
```
gcloud sql instances patch INSTANCE_ID \
    --project=PROJECT_ID \
    --data-api-access=ALLOW_DATA_API
```
Substitua:
- INSTANCE_ID: o ID da instância do Cloud SQL para PostgreSQL.
- PROJECT_ID: o ID do projeto Google Cloud .

Conceder os papéis necessários e criar um usuário de banco de dados do IAM

Para autenticar com o Identity and Access Management (IAM) e executar solicitações queryData em visualizações seguras parametrizadas, configure o usuário ou a conta de serviço do IAM:

Conceda os seguintes papéis do IAM a IAM_USER_EMAIL no projeto do Google Cloud :
- roles/geminidataanalytics.queryDataUser
- roles/serviceusage.serviceUsageConsumer
- roles/cloudsql.instanceUser
Para mais informações sobre como conceder papéis do IAM, consulte Adicionar vinculação de política do IAM a um projeto.
Ative a autenticação do banco de dados do IAM na instância do Cloud SQL e adicione IAM_USER_EMAIL como um usuário do banco de dados do IAM na instância. É preciso criar esse usuário do banco de dados do IAM antes de conceder a ele o papel de banco de dados psv_user. Para mais informações sobre como configurar usuários de banco de dados do IAM, consulte Gerenciar usuários com a autenticação de banco de dados do IAM.

Preparar o ambiente

Para se preparar para executar consultas em uma visualização segura parametrizada, configure o banco de dados, os papéis do banco de dados, a extensão parameterized_views e o esquema do aplicativo.

Ativar a flag de banco de dados

Ative a flag de banco de dados cloudsql.enable_parameterized_views, que carrega as bibliotecas de extensão necessárias. Para mais informações, consulte Configurar as flags de banco de dados de uma instância.

Configurar o banco de dados

Crie um banco de dados chamado database para os dados do aplicativo e as visualizações seguras parametrizadas. Para mais informações, consulte Criar um banco de dados.

Criar papéis de banco de dados, a extensão e o esquema do aplicativo

No console do Google Cloud , acesse a página do Cloud SQL.

Acessar o Cloud SQL
Selecione uma instância na lista.
No menu de navegação, clique em Cloud SQL Studio.
Faça login no Studio usando a autenticação da conta de administrador.
Clique em Autenticar. O painel Explorer mostra uma lista dos objetos no seu banco de dados.
Clique em Nova guia do editor de SQL ou Nova guia para abrir uma nova guia.
Para usar visualizações parametrizadas, crie a extensão parameterized_views no banco de dados:
```
-- Requires parameterized_views.enabled set to true
CREATE EXTENSION parameterized_views;
```
Quando a extensão é criada, o banco de dados também cria um esquema chamado parameterized_views para que as APIs sejam contidas no namespace desse esquema e não entrem em conflito com as APIs atuais.

Observação: é preciso criar uma extensão em cada banco de dados em que as visualizações parametrizadas são criadas.
Faça login como um usuário com privilégios de superusuário, como o usuário postgres integrado.
Crie um novo papel de banco de dados para executar consultas em visualizações seguras parametrizadas. Esse é um papel do Cloud SQL que o aplicativo usa para se conectar e fazer login no banco de dados para executar consultas com acesso limitado a funções ou objetos públicos ao conjunto mínimo necessário.
```
CREATE ROLE psv_user WITH LOGIN PASSWORD '...';
```
Para obter mais informações, consulte CREATE USER.
Conecte-se como usuário administrativo.
```
SET role TO postgres;
```
Crie o esquema que contém as tabelas.
```
CREATE SCHEMA store;
```

Crie as tabelas e insira os dados.

CREATE TABLE store.checked_items(bag_id INT,timestamp TIMESTAMP, loc_code CHAR(3), scan_type CHAR(1), location TEXT, customer_id INT);

INSERT INTO store.checked_items (bag_id, timestamp, loc_code, scan_type, location, customer_id) VALUES
(101, '2023-10-26 10:00:00', 'ABC', 'I', 'Warehouse A', 123),
(102, '2023-10-26 10:15:30', 'DEF', 'O', 'Loading Dock B', 456),
(103, '2023-10-26 10:30:45', 'GHI', 'I', 'Conveyor Belt 1', 789),
(104, '2023-10-26 11:00:00', 'JKL', 'O', 'Shipping Area C', 101),
(105, '2023-10-26 11:45:15', 'MNO', 'I', 'Sorting Station D', 202),
(106, '2023-10-26 12:00:00', 'PQR', 'O', 'Truck Bay E', 303);

Criar visualizações seguras parametrizadas e configurar privilégios de acesso

Para criar visualizações seguras parametrizadas e configurar os privilégios de acesso adequados para a tabela base e as visualizações, siga estas etapas:

No console do Google Cloud , acesse a página do Cloud SQL.

Acessar o Cloud SQL
Selecione uma instância na lista.
No menu de navegação, clique em Cloud SQL Studio.
Faça login no Studio e conecte-se ao banco de dados chamado database como o usuário postgres.
Clique em Autenticar. O painel Explorer mostra uma lista dos objetos no seu banco de dados.
Clique em Nova guia do editor de SQL ou Nova guia para abrir uma nova guia.
Para fornecer acesso limitado à visualização, crie uma visualização parametrizada:
```
CREATE VIEW store.secure_checked_items WITH (security_barrier) AS
SELECT bag_id, timestamp, location
FROM store.checked_items t
WHERE customer_id = $@app_end_userid;
```
Observação: use nomes de parâmetros exclusivos, como $@app_end_userid, ao criar visualizações seguras parametrizadas.

Conceda acesso à visualização.

GRANT SELECT ON store.secure_checked_items TO psv_user;

Para acessar a visualização, conceda acesso ao esquema.
```
GRANT USAGE ON SCHEMA store TO psv_user;
```
Revogue o acesso direto à tabela base.
```
REVOKE ALL PRIVILEGES ON store.checked_items FROM psv_user;
```
Observação: o proprietário da visualização parametrizada precisa ter privilégios SELECT nas tabelas base. Além disso, o usuário da visualização parametrizada precisa ter USAGE no esquema da visualização e SELECT na visualização. Por exemplo, o usuário postgres é o proprietário da visualização parametrizada, então ele tem privilégios SELECT nas tabelas base, enquanto psv_user precisa ter USAGE no esquema store e SELECT na visualização.
Verifique se IAM_USER_EMAIL foi adicionado à instância como um usuário do banco de dados do IAM, faça login como o usuário postgres e conceda o papel psv_user ao usuário autenticado pelo IAM:
```
GRANT psv_user TO "IAM_USER_EMAIL";
```
Substitua IAM_USER_EMAIL pelo endereço de e-mail do usuário do IAM.

Verificar a segurança de dados

Para verificar se as visualizações seguras parametrizadas estão restringindo o acesso às visualizações designadas, faça login no banco de dados como o usuário autenticado pelo IAM. No Cloud SQL, os usuários do IAM herdam as permissões dos papéis de banco de dados atribuídos a eles.

Faça login no banco de dados como o usuário autenticado pelo IAM.

Verifique se a tabela base não pode ser acessada.

SELECT * FROM store.checked_items;
ERROR:  permission denied for table checked_items

Acesse as visualizações seguras parametrizadas usando a função execute_parameterized_query:

SELECT * FROM parameterized_views.execute_parameterized_query(
  query => 'SELECT * from store.secure_checked_items',
  param_names => ARRAY ['app_end_userid'],
  param_values => ARRAY ['303']
);

Faça login na Google Cloud CLI como IAM_USER_EMAIL executando gcloud auth application-default login para que gcloud auth application-default print-access-token gere um token para o usuário restrito do banco de dados do IAM. Em seguida, consulte as visualizações seguras parametrizadas usando o método queryData com parâmetros de PSV:

  curl -X POST \
    "https://geminidataanalytics.googleapis.com/v1beta/projects/PROJECT_ID/locations/REGION:queryData" \
    -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
    -H "x-goog-user-project: PROJECT_ID" \
    -H "Content-Type: application/json; charset=utf-8" \
    -d '{
      "prompt": "Show me the checked items.",
      "context": {
        "datasource_references": {
          "cloud_sql_reference": {
            "database_reference": {
              "engine": "POSTGRESQL",
              "project_id": "PROJECT_ID",
              "region": "REGION",
              "instance_id": "INSTANCE_ID",
              "database_id": "DATABASE_ID",
              "table_ids": [
                "store.secure_checked_items"
              ]
            }
          }
        },
        "parameterized_secure_view_parameters": {
          "parameters": [
            {
              "key": "app_end_userid",
              "value": "303"
            }
          ]
        }
      },
      "generation_options": {
        "generate_query_result": true,
        "generate_natural_language_answer": true,
        "generate_explanation": true
      }
    }'

Use o campo table_ids em database_reference para garantir que o QueryData gere SQL apenas na visualização segura parametrizada store.secure_checked_items. Se você omitir table_ids e o papel do banco de dados tiver acesso SELECT na tabela base store.checked_items, QueryData poderá consultar a tabela base diretamente, ignorando a visualização segura. Especifique o nome da visualização qualificada pelo esquema, porque os nomes não qualificados em table_ids usam o esquema public por padrão.

Substitua:

PROJECT_ID: o ID do projeto Google Cloud .
REGION: a região em que a instância do Cloud SQL para PostgreSQL está localizada.
INSTANCE_ID: o ID da instância do Cloud SQL para PostgreSQL.
DATABASE_ID: o ID do banco de dados do Cloud SQL para PostgreSQL, que é database neste tutorial.

Limpar

Excluir a instância

Quando você exclui a instância criada na seção Antes de começar, todos os objetos criados também são excluídos.

No console do Google Cloud , acesse a página do Cloud SQL.

Acessar o Cloud SQL
Selecione uma instância na lista.
Clique em Excluir.
Confirme que você quer excluir a instância inserindo o nome dela e clicando em Excluir.

A seguir

Saiba mais sobre as visualizações seguras parametrizadas.

Saiba como usar visualizações seguras parametrizadas.