Guia de início rápido: como usar uma ferramenta de linha de comando

Nesta página, mostramos como realizar tarefas básicas na API Cloud Data Loss Prevention usando uma interface de linha de comando. Especificamente, este guia de início rápido aborda o envio de uma pequena string à API DLP para inspeção.

Antes de começar

1. Faça login na sua conta do Google Cloud. Se você começou a usar o Google Cloud agora, crie uma conta para avaliar o desempenho de nossos produtos em situações reais. Clientes novos também recebem US$ 300 em créditos para executar, testar e implantar cargas de trabalho.

2. No Console do Google Cloud, na página do seletor de projetos, selecione ou crie um projeto do Google Cloud.

   Observação: se você não pretende manter os recursos criados neste procedimento, crie um projeto novo em vez de selecionar um que já existe. Depois de concluir essas etapas, é possível excluir o projeto. Para fazer isso, basta remover todos os recursos associados a ele.

   Acessar o seletor de projetos

3. Verifique se o faturamento está ativado para seu projeto na nuvem. Saiba como confirmar se o faturamento está ativado para o projeto.

4. Ative a API DLP.

   Ative a API

5. Crie uma conta de serviço:

   1. No Console do Cloud, acesse a página Criar conta de serviço.

      Acesse Criar conta de serviço
   2. Selecione um projeto.

   3. No campo Nome da conta de serviço, insira um nome. O Console do Cloud preenche o campo ID da conta de serviço com base nesse nome.

      No campo Descrição da conta de serviço, insira uma descrição. Por exemplo, Service account for quickstart.

   4. Clique em Criar e continuar.

   5. Clique no campo Selecionar um papel.

      Em Acesso rápido, clique em Básico e em Proprietário.

      Observação: o campo Papel afeta quais recursos a conta de serviço pode acessar no projeto. É possível revogar esses papéis ou conceder outros papéis posteriormente. Em ambientes de produção, não conceda os papéis de proprietário, editor ou visualizador. Em vez disso, conceda um papel predefinido ou um papel personalizado que atenda às suas necessidades.
   6. Clique em Continuar.

   7. Clique em Concluído para terminar a criação da conta de serviço.

      Não feche a janela do navegador. Você vai usá-lo na próxima etapa.

6. Crie uma chave de conta de serviço:

   1. No Console do Cloud, clique no endereço de e-mail da conta de serviço que você criou.
   2. Clique em Chaves.
   3. Clique em Adicionar chave e em Criar nova chave.
   4. Clique em Criar. O download de um arquivo de chave JSON é feito no seu computador.
   5. Clique em Fechar.

7. Defina a variável de ambiente GOOGLE_APPLICATION_CREDENTIALS como o caminho do arquivo JSON que contém a chave da conta de serviço. Essa variável só se aplica à sessão de shell atual. Dessa maneira, se você abrir uma nova sessão, defina a variável novamente.

   Exemplo: Linux ou macOS

   export GOOGLE_APPLICATION_CREDENTIALS="KEY_PATH"

   Substitua KEY_PATH pelo caminho do arquivo JSON que contém a chave da conta de serviço.

   Exemplo:

   export GOOGLE_APPLICATION_CREDENTIALS="/home/user/Downloads/service-account-file.json"

   Exemplo: Windows

   Para PowerShell:

   $env:GOOGLE_APPLICATION_CREDENTIALS="KEY_PATH"

   Substitua KEY_PATH pelo caminho do arquivo JSON que contém a chave da conta de serviço.

   Exemplo:

   $env:GOOGLE_APPLICATION_CREDENTIALS="C:\Users\username\Downloads\service-account-file.json"

   Para prompt de comando:

   set GOOGLE_APPLICATION_CREDENTIALS=KEY_PATH

   Substitua KEY_PATH pelo caminho do arquivo JSON que contém a chave da conta de serviço.

8. No Console do Google Cloud, na página do seletor de projetos, selecione ou crie um projeto do Google Cloud.

   Observação: se você não pretende manter os recursos criados neste procedimento, crie um projeto novo em vez de selecionar um que já existe. Depois de concluir essas etapas, é possível excluir o projeto. Para fazer isso, basta remover todos os recursos associados a ele.

   Acessar o seletor de projetos

9. Verifique se o faturamento está ativado para seu projeto na nuvem. Saiba como confirmar se o faturamento está ativado para o projeto.

10. Ative a API DLP.

    Ative a API

11. Crie uma conta de serviço:

    1. No Console do Cloud, acesse a página Criar conta de serviço.

       Acesse Criar conta de serviço
    2. Selecione um projeto.

    3. No campo Nome da conta de serviço, insira um nome. O Console do Cloud preenche o campo ID da conta de serviço com base nesse nome.

       No campo Descrição da conta de serviço, insira uma descrição. Por exemplo, Service account for quickstart.

    4. Clique em Criar e continuar.

    5. Clique no campo Selecionar um papel.

       Em Acesso rápido, clique em Básico e em Proprietário.

       Observação: o campo Papel afeta quais recursos a conta de serviço pode acessar no projeto. É possível revogar esses papéis ou conceder outros papéis posteriormente. Em ambientes de produção, não conceda os papéis de proprietário, editor ou visualizador. Em vez disso, conceda um papel predefinido ou um papel personalizado que atenda às suas necessidades.
    6. Clique em Continuar.

    7. Clique em Concluído para terminar a criação da conta de serviço.

       Não feche a janela do navegador. Você vai usá-lo na próxima etapa.

12. Crie uma chave de conta de serviço:

    1. No Console do Cloud, clique no endereço de e-mail da conta de serviço que você criou.
    2. Clique em Chaves.
    3. Clique em Adicionar chave e em Criar nova chave.
    4. Clique em Criar. O download de um arquivo de chave JSON é feito no seu computador.
    5. Clique em Fechar.

13. Defina a variável de ambiente GOOGLE_APPLICATION_CREDENTIALS como o caminho do arquivo JSON que contém a chave da conta de serviço. Essa variável só se aplica à sessão de shell atual. Dessa maneira, se você abrir uma nova sessão, defina a variável novamente.

    Exemplo: Linux ou macOS

    export GOOGLE_APPLICATION_CREDENTIALS="KEY_PATH"

    Substitua KEY_PATH pelo caminho do arquivo JSON que contém a chave da conta de serviço.

    Exemplo:

    export GOOGLE_APPLICATION_CREDENTIALS="/home/user/Downloads/service-account-file.json"

    Exemplo: Windows

    Para PowerShell:

    $env:GOOGLE_APPLICATION_CREDENTIALS="KEY_PATH"

    Substitua KEY_PATH pelo caminho do arquivo JSON que contém a chave da conta de serviço.

    Exemplo:

    $env:GOOGLE_APPLICATION_CREDENTIALS="C:\Users\username\Downloads\service-account-file.json"

    Para prompt de comando:

    set GOOGLE_APPLICATION_CREDENTIALS=KEY_PATH

    Substitua KEY_PATH pelo caminho do arquivo JSON que contém a chave da conta de serviço.

Permissões

A inspeção de conteúdo requer a permissão serviceusage.services.use para o projeto especificado em parent. Os papéis roles/editor, roles/owner e roles.dlp.user contêm a permissão necessária, ou é possível definir seu próprio papel personalizado.

Para dar ao usuário o papel dlp.user no nível do projeto:

Console

1. Abra a página "IAM" no Console do Google Cloud.

   Acessar IAM

2. Para selecionar um projeto, caso ainda não tenha feito isso, basta clicar no seletor.

   

3. Na página do IAM, siga estas etapas:

   • Para adicionar um novo usuário, clique em Adicionar.
   • Para adicionar o papel dlp.user a um usuário existente, clique em Editar principal para esse usuário e, em seguida, clique em Adicionar outro papel no painel Editar permissões.

4. No painel Adicionar principais, siga estas etapas:

   • No campo Novos membros, digite o endereço de e-mail do usuário que você está adicionando, por exemplo, [e-mail].
   • Em Papéis, clique em Selecionar um papel e escolha Cloud DLP > Usuário do DLP.

5. Clique em Add.

Para mais informações, consulte Conceder um papel de IAM.

gcloud

1. Para adicionar uma vinculação única à política de IAM do projeto, digite o comando a seguir.

   gcloud projects add-iam-policy-binding PROJECT_ID --member serviceAccount:SERVICE_ID --role roles/dlp.user

   Substitua:

   • O ID do projeto.PROJECT_ID
   • SERVICE_ID: a conta de serviço a ser usada.

2. Grave a política atualizada na janela do console:

   bindings:
   - members:
     - group: EMAIL_ADDRESS
       role: roles/dlp.user
   

   Substitua EMAIL_ADDRESS pelo endereço de e-mail do usuário que você está adicionando.

Configurar um app CLI do Cloud DLP

Node.js

1. Faça o download do Node.js e do NPM e instale-os.

2. Faça a clonagem ou o download de um arquivo ZIP da biblioteca de cliente do DLP do Node.js. e expanda o arquivo salvo.

3. Abra uma ferramenta de linha de comando e navegue até o diretório samples no diretório expandido.

4. Instale as dependências do aplicativo executando npm install enquanto estiver no diretório samples.

5. Se você ainda não tiver feito isso, crie a variável de ambiente GCLOUD_PROJECT e defina-a como o ID do projeto do Google Cloud que você configurou para usar com o Cloud DLP.

Linux ou macOS

export GCLOUD_PROJECT="[PROJECT_ID]"

Windows

Com o PowerShell:

$env:GCLOUD_PROJECT="[PROJECT_ID]"

Com prompt de comando:

set GCLOUD_PROJECT=[PROJECT_ID]

gcloud alpha dlp

1. Instale e inicie o SDK do Cloud.

   Esse procedimento também requer o componente gcloud Alpha Commands. Instale-o agora ou mais tarde, quando solicitado.

2. Ative a conta de serviço:

   gcloud auth activate-service-account SERVICE_ACCOUNT \\
    --key-file=PATH_TO_SERVICE_ACCOUNT_KEY

   Substitua:

   • SERVICE_ACCOUNT: o ID da sua conta de serviço.
   • PATH_TO_SERVICE_ACCOUNT_KEY: o caminho para o arquivo JSON em que está a chave privada da conta de serviço. Este é o arquivo JSON de que você fez o download quando configurou a autenticação na seção Antes de começar.

Verificar se há informações confidenciais em uma string

Nesta seção, mostramos como usar a API DLP para verificar o texto de amostra.

Node.js

Neste exemplo, usamos o script Node.js inspectString. Abra uma ferramenta de linha de comando, se ainda não tiver feito isso. Navegue até a pasta samples do repositório de amostras Node.js de que você fez o download e expandiu na seção anterior.

Execute este comando:

node inspectString.js PROJECT_ID "My email address is [e-mail]."

Substitua PROJECT_ID pelo ID do projeto.

Você receberá a seguinte resposta:

Findings:
  Quote: [e-mail]
  Info type: EMAIL_ADDRESS
  Likelihood: LIKELY

gcloud alpha dlp

Neste exemplo, usamos o comando gcloud alpha dlp text inspect. Abra uma ferramenta de linha de comando, se ainda não tiver feito isso.

Execute este comando:

gcloud alpha dlp text inspect --project="PROJECT_ID" \
--content="My email address is [e-mail]." \
--include-quote --info-types="EMAIL_ADDRESS"

Substitua PROJECT_ID pelo ID do projeto.

Se o componente gcloud Alpha Commands não tiver sido instalado, você recebe uma mensagem do sistema perguntando se quer fazer a instalação primeiro. Para continuar, pressione Y.

Você receberá a seguinte resposta:

result:
findings:
- createTime: '2021-02-26T19:31:28.051Z'
  findingId: 2021-02-26T19:31:28.054696Z5687834655654299045
  infoType:
    name: EMAIL_ADDRESS
  likelihood: LIKELY
  location:
    byteRange:
      end: '35'
      start: '20'
    codepointRange:
      end: '35'
      start: '20'
  quote: [e-mail]

Você enviou sua primeira solicitação para a API DLP.

A seguir

• Siga os guias de instruções para começar a inspecionar textos e imagens e editar dados confidenciais de textos.
• Saiba mais sobre conceitos para entender melhor inspeção, edição, infoTypes e probabilidade.
• Veja a Referência da API Service e a Referência da API da biblioteca de cliente do Node.js.