Esta página foi traduzida pela API Cloud Translation.

Extensão de Prevenção contra perda de dados do Google Cloud

Esta é a documentação do Apigee Edge.
Acesse Documentação da Apigee X. informações

Versão: 1.2.0

Use esta extensão para ocultar dados sensíveis de conteúdo e imagens. Por exemplo, é possível encobrir números de cartão de crédito, nomes e CPF ou CNPJ.

Este conteúdo fornece referência para configurar e usar essa extensão. Para acessar a referência de configuração desta extensão, consulte Referência de configuração.

Pré-requisitos

Este conteúdo fornece referência para configurar e usar essa extensão. Antes de usar a extensão de um proxy de API com a política Extension callout, você precisa:

Ative a API Google Cloud DLP para o projeto.
Conceda permissão para o nível de acesso que você quer para a extensão.
Use o Console do GCP para gerar uma chave para a conta de serviço.
Use o conteúdo do arquivo JSON da chave resultante ao adicionar e configurar a extensão usando a referência de configuração.

Sobre o Cloud Data Loss Prevention (DLP)

O Cloud Data Loss Prevention (DLP) é uma API para inspecionar textos, imagens e outros dados a fim de identificar e gerenciar dados confidenciais.

Para mais informações, consulte a Visão geral da DLP. Para consultar a API que essa extensão expõe, consulte API Cloud Data Loss Prevention (DLP).

Amostras

Os exemplos a seguir ilustram como configurar o suporte para as ações da extensão de DLP usando a política Extension callout.

Para facilitar o teste desse exemplo de código, estes exemplos usam uma políticaAssignMessage para definir valores de variável de fluxo e recuperar valores de resposta de extensão para exibição na ferramenta Trace.

Máscara com estrelas

Este exemplo usa a ação deidentifyWithMask para mascarar os tipos de texto especificados com um caractere especificado na política, aqui, o caractere *.

A política AttributionMessage a seguir define a variável request.content para fins ilustrativos. Normalmente, você recuperaria o conteúdo da solicitação do cliente.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<AssignMessage async="false" continueOnError="false" enabled="true" name="Set-Variable">
    <DisplayName>Set Variable</DisplayName>
    <AssignTo type="response" createNew="false"/>
    <AssignVariable>
        <Name>request.content</Name>
        <Value>Visit my site at https://example.com. Or contact me at gladys@example.com.</Value>
    </AssignVariable>
</AssignMessage>

A seguinte política deExtension callout recupera o valor da variável request.content e o transmite para uma extensão do Cloud DLP (aqui, chamada example-dlp). Essa extensão foi configurada para mascarar valores com base nos infoTypes URL e EMAIL_ADDRESS.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ConnectorCallout async="false" continueOnError="true" enabled="true" name="Data-Loss-Extension-Callout">
    <DisplayName>Data Loss Prevention Extension Callout</DisplayName>
    <Connector>example-dlp</Connector>
    <Action>deidentifyWithMask</Action>
    <Input><![CDATA[{
        "text" : "{request.content}",
        "mask" : "*"
    }]]></Input>
    <Output>masked.output</Output>
</ConnectorCallout>

A política AttributionMessage a seguir recupera a saída da extensão para exibição na ferramenta Trace.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<AssignMessage async="false" continueOnError="false" enabled="true" name="Get-DLP-Output">
    <DisplayName>Get DLP Output</DisplayName>
    <AssignTo type="response" createNew="false"/>
    <Set>
        <Payload contentType="application/json">{masked.output}</Payload>
    </Set>
</AssignMessage>

Confira abaixo um exemplo de saída desse código.

{"text":"Visit my site at ******************* Or contact me at *****************."}

Máscara com nome

Esse exemplo usa a ação deidentifyWithType para mascarar os tipos de texto especificados com o próprio nome do infotype. Por exemplo, ele substituiria o endereço de e-mail gladys@example.com por EMAIL_ADDRESS.

A política AttributionMessage a seguir define a variável request.content para fins ilustrativos. Normalmente, você recuperaria o conteúdo da solicitação do cliente.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<AssignMessage async="false" continueOnError="false" enabled="true" name="Set-Variable">
    <DisplayName>Set Variable</DisplayName>
    <AssignTo type="response" createNew="false"/>
    <AssignVariable>
        <Name>request.content</Name>
        <Value>Visit my site at https://example.com. Or contact me at gladys@example.com.</Value>
    </AssignVariable>
</AssignMessage>

A política ExtensionAnnotation recupera o valor da variável request.content e o transmite para uma extensão do Cloud DLP, chamada example-dlp. Essa extensão foi configurada para mascarar valores com base nos infoTypes URL e EMAIL_ADDRESS.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ConnectorCallout async="false" continueOnError="true" enabled="true" name="Data-Loss-Extension-Callout">
    <DisplayName>Data Loss Prevention Extension Callout</DisplayName>
    <Connector>example-dlp</Connector>
    <Action>deidentifyWithType</Action>
    <Input><![CDATA[{
        "text" : "{request.content}"
    }]]></Input>
    <Output>masked.output</Output>
</ConnectorCallout>

A política AttributionMessage a seguir recupera a saída da extensão para exibição na ferramenta Trace.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<AssignMessage async="false" continueOnError="false" enabled="true" name="Get-DLP-Output">
    <DisplayName>Get DLP Output</DisplayName>
    <AssignTo type="response" createNew="false"/>
    <Set>
        <Payload contentType="application/json">{masked.output}</Payload>
    </Set>
</AssignMessage>

Confira abaixo um exemplo de saída desse código.

{"text":"Visit my site at [URL] Or contact me at [EMAIL_ADDRESS]."}

Ações

deidentifyWithMask

Desidentifique os dados sensíveis de text e mascare os dados com o caractere mask. Essa ação mascara as partes do text especificadas pela propriedade infoTypes na configuração da extensão.

O mascaramento de dados sensíveis substitui caracteres por um símbolo, como asterisco (*) ou hash (#). Os tipos de dados sensíveis podem ser definidos na configuração da extensão.

Sintaxe

<Action>deidentifyWithMask</Action>
<Input><![CDATA[{
  "text" : "text-to-deidentify",
  "mask" : "masking-character"
}]]></Input>

Exemplo

No exemplo a seguir, a entrada a ser mascarada é um endereço de e-mail armazenado em uma variável de fluxo input.email.address. Para oferecer suporte a este exemplo específico, a extensão precisa ter sido configurada para oferecer suporte ao infoType EMAIL_ADDRESS. Para uma lista de infoTypes, consulte Referência do detector de InfoType.

<Action>deidentifyWithMask</Action>
<Input><![CDATA[{
    "text" : "{input.email.address}",
    "mask" : "*"
}]]></Input>
<Output>masked.output</Output>

A saída para este exemplo seria a seguinte:

{"text":"*****************"}

Parâmetros de solicitação

Parâmetro	Descrição	Tipo	Padrão	Obrigatório
texto	Texto a ser desidentificado.	String	Nenhum.	Sim.
máscara	Caractere a ser usado para mascarar dados confidenciais.	String	Nenhum.	Sim.

Resposta

O texto de entrada com valores dos infoTypes especificados é substituído pelo caractere especificado. Por exemplo,

{"text":"*********"}

deidentifyWithType

Desidentifique dados sensíveis no conteúdo de texto, substituindo cada valor correspondente pelo nome do infoType. Para ver uma lista de infoTypes, consulte Referência de detectores de InfoType. Essa ação mascara as partes do text especificadas pela propriedade infoTypes na configuração da extensão.

No exemplo a seguir, o número de telefone é reconhecido pelo serviço e substituído pelo nome do próprio infoType.

Texto de entrada:

John Smith, 123 Main St, Seattle, WA 98122, 206-555-0123.
Texto do resultado:

John Smith, 123 Main St, Seattle, WA 98122, PHONE_NUMBER.

Sintaxe

<Action>deidentifyWithType</Action>
<Input><![CDATA[{
  "text" : "text-to-deidentify"
}]]></Input>

Exemplo

<Action>deidentifyWithType</Action>
<Input><![CDATA[{
    "text" : "{input.email.address}"
}]]></Input>

A saída para este exemplo seria a seguinte:

{"text":"EMAIL_ADDRESS"}

Parâmetros de solicitação

Parâmetro	Descrição	Tipo	Padrão	Obrigatório
texto	O texto a ser desidentificado.	String	Nenhum.	Sim.

Resposta

O texto de entrada com valores dos infoTypes especificados é substituído pelos nomes dos infoTypes. Por exemplo,

{"text":"EMAIL_ADDRESS"}

redactImage

Encobrir o texto que se enquadra em uma das categorias de infoType. O conteúdo encoberto é detectado e oculto com um retângulo opaco. Essa ação mascara as partes do image_data especificadas pela propriedade infoTypes na configuração da extensão.

Para ver uma lista de infoTypes, consulte Referência de detectores de InfoType.

Parâmetros de solicitação

<Action>redactImage</Action>
<Input><![CDATA[{
  "image_data" : "base64-encoded-image-to-analyze",
  "image_type" : "type-of-image"
}]]></Input>

Parâmetro	Descrição	Tipo	Padrão	Obrigatório
image_data	Os dados da imagem codificados em base64.	String	Nenhum.	Sim.
image_type	Constante do tipo de imagem. Os valores disponíveis são IMAGE_JPEG, IMAGE_BMP, IMAGE_PNG, IMAGE_SVG.	String	Nenhum.	Sim.

Resposta

A imagem com texto encoberto.

Referência de configuração

Use o seguinte ao configurar e implantar esta extensão para uso em proxies de API. Para ver as etapas para configurar uma extensão usando o console da Apigee, consulte Como adicionar e configurar uma extensão.

Propriedades de extensão comuns

As propriedades a seguir estão presentes para cada extensão.

Propriedade	Descrição	Padrão	Obrigatório
`name`	Nome que será dado a esta configuração da extensão.	Nenhum	Sim
`packageName`	Nome do pacote de extensão fornecido pelo Apigee Edge.	Nenhum	Sim
`version`	Número da versão do pacote de extensão a partir do qual você está configurando uma extensão.	Nenhum	Sim
`configuration`	Valor de configuração específico da extensão que você está adicionando. Consulte Propriedades para este pacote de extensão.	Nenhum	Sim

Propriedades deste pacote de extensões

Especifique valores para as seguintes propriedades de configuração específicas desta extensão.

Propriedade	Descrição	Padrão	Obrigatório
projectId	O ID do projeto do GCP em que a API Cloud Data Loss Prevention está ativada.	Nenhum.	Sim.
infoTypes	Tipos de informações dos dados sensíveis. Se omitido, o serviço detectará todos os tipos integrados. Para ver uma lista de infoTypes compatíveis com o serviço do Google Cloud DLP, consulte Referência do detector de InfoType.	Nenhum.	Não.
credenciais	Quando inserido no console do Apigee Edge, este é o conteúdo do arquivo de chave da conta de serviço. Quando enviado pela API de gerenciamento, é um valor codificado em base64 gerado a partir do arquivo de chave da conta de serviço.	Nenhum.	Sim.