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

Você está lendo a documentação do Apigee Edge.
Acesse a documentação da Apigee X. info

Versão: 2.0.2

Use essa 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.

Pré-requisitos

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

1. Ative a API Cloud DLP para seu projeto.

2. Conceda permissão para o nível de acesso que você quer para a extensão.

3. Use o console do Google Cloud para gerar uma chave para a conta de serviço.

4. 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 para identificar e gerenciar dados sensíveis.

Para mais informações, consulte a visão geral da DLP. Para referência à API exposta por essa extensão, consulte API Cloud Data Loss Prevention (DLP).

Amostras

Os exemplos a seguir ilustram como configurar o suporte para ações de extensão do Cloud DLP usando a política ExtensionCallout.

Para facilitar o teste desse código de amostra, esses exemplos usam uma política AssignMessage para definir valores de variáveis de fluxo e recuperar valores de resposta de extensão para exibição na ferramenta de rastreamento.

<?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>

<?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>

<?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>

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

<?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>

<?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>

<?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>

{"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 de text especificadas pela propriedade infoTypes na configuração da extensão.

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

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

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

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

Parâmetros de solicitação

Resposta

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

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

deidentifyWithTemplate

Desidentificar dados sensíveis em conteúdo de texto usando um modelo que configura qual texto desidentificar e como processá-lo.

Os modelos são úteis para desassociar a configuração, como o que você inspeciona e como desidentifica esse item da implementação das chamadas de API. Os modelos fornecem uma maneira de reutilizar a configuração e ter consistência entre usuários e conjuntos de dados.

No modelo, você vai especificar infoTypes que representam o conteúdo a ser desidentificado. Para uma lista de infoTypes, consulte Referência do detector de infoType. A remoção de identificação mascara as partes do texto especificadas pela propriedade infoTypes no modelo.

<Action>deidentifyWithTemplate</Action>
<Input><![CDATA[{
  "text" : "text-to-deidentify"
  "templateName" : "path-to-template"
}]]></Input>

<Action>deidentifyWithTemplate</Action>
<Input><![CDATA[{
    "text" : "{request.content}"
    "templateName" : "projects/[PROJECT_ID]/deidentifyTemplates/1231258663242"
}]]></Input>

Parâmetros de solicitação

Resposta

O texto de entrada com valores dos infoTypes especificados substituídos pelos nomes dos infoTypes.

deidentifyWithType

Desidentificar dados sensíveis no conteúdo de texto, substituindo cada valor correspondente pelo nome do infoType. Para uma lista de infoTypes, consulte Referência do detector de infoType. Essa ação mascara as partes de 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.

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

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

{"text":"EMAIL_ADDRESS"}

Parâmetros de solicitação

Resposta

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

{"text":"EMAIL_ADDRESS"}

redactImage

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

Para uma lista de infoTypes, consulte Referência do detector 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>

Resposta

A imagem com o texto censurado.

Referência de configuração

Use o seguinte ao configurar e implantar essa extensão para uso em proxies de API. Para saber como configurar uma extensão usando o console do Apigee, consulte Adicionar e configurar uma extensão.

Propriedades comuns de extensão

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

Propriedades deste pacote de extensão

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