Extensión de Google Cloud Data Loss Prevention

Estás viendo la documentación de Apigee Edge.
Ir a la documentación de Apigee X. info

Versión: 1.5.1

Usa esta extensión para ocultar datos sensibles del contenido y las imágenes. Por ejemplo, puedes ocultar números de tarjetas de crédito, nombres y números de seguro social.

Requisitos previos

Este contenido proporciona una referencia para configurar y usar esta extensión. Antes de usar la extensión desde un proxy de API con la política ExtensionCallout, debes hacer lo siguiente:

1. Habilita la API de Google Cloud DLP para tu proyecto.

2. Otorga permiso para el nivel de acceso que desees para la extensión.

3. Usa GCP Console para generar una clave para la cuenta de servicio.

4. Usa el contenido del archivo JSON de claves resultante cuando agregues y configures la extensión con la referencia de configuración.

Acerca de Cloud Data Loss Prevention (DLP)

Cloud Data Loss Prevention (DLP) es una API para inspeccionar texto, imágenes y otros datos para identificar y administrar datos sensibles.

Para obtener más información, consulta la descripción general de DLP. Para obtener una referencia de la API que expone esta extensión, consulta la API de Cloud Data Loss Prevention (DLP).

Ejemplos

En los siguientes ejemplos, se ilustra cómo configurar la compatibilidad con las acciones de la extensión de Cloud DLP mediante la política ExtensionCallout.

Para facilitar la prueba de este código de muestra, estos ejemplos usan una política AssignMessage para establecer valores de variables de flujo y recuperar valores de respuesta de extensión para mostrarlos en la herramienta Trace.

<?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]."}

Acciones

deidentifyWithMask

Desidentifica los datos sensibles de text y oculta los datos con el carácter mask. Esta acción oculta las partes de text especificadas por la propiedad infoTypes en la configuración de la extensión.

La ocultación de datos sensibles reemplaza los caracteres con un símbolo, como un asterisco (*) o un signo de número (#). Los tipos de datos sensibles se pueden configurar en la configuración de la extensión.

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

Respuesta

El texto de entrada con los valores de los Infotipos especificados reemplazados por el carácter especificado. Por ejemplo:

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

deidentifyWithTemplate

Desidentifica los datos sensibles en el contenido de texto con una plantilla que configura qué texto desidentificar y cómo controlarlo.

Las plantillas son útiles para desacoplar la configuración, como lo que inspeccionas y cómo lo desidentificas de la implementación de tus llamadas a la API. Las plantillas proporcionan una forma de volver a usar la configuración y habilitar la coherencia entre los usuarios y los conjuntos de datos.

En tu plantilla, especificarás los infoTypes que representan el contenido que se desidentificará. Para obtener una lista de Infotipos, consulta la Referencia del detector de Infotipos. La desidentificación oculta las partes del texto especificadas por la propiedad infoTypes en la plantilla.

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

Respuesta

El texto de entrada con los valores de los Infotipos especificados reemplazados por los nombres de los Infotipos.

deidentifyWithType

Desidentifica los datos sensibles en el contenido de texto y reemplaza cada valor coincidente con el nombre del Infotipo. Para obtener una lista de Infotipos, consulta la Referencia del detector de Infotipos. Esta acción oculta las partes de text especificadas por la propiedad infoTypes en la configuración de la extensión.

En el siguiente ejemplo, el servicio reconoce el número de teléfono y, luego, lo reemplaza por el nombre del Infotipo.

• Texto de entrada:

  John Smith, 123 Main St, Seattle, WA 98122, 206-555-0123.

• Texto resultante:

  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 solicitud

Respuesta

El texto de entrada con los valores de los Infotipos especificados reemplazados por los nombres de los Infotipos. Por ejemplo:

{"text":"EMAIL_ADDRESS"}

redactImage

Oculta el texto que pertenece a una de las categorías de Infotipos. El contenido oculto se detecta y se oculta con un rectángulo opaco. Esta acción oculta las partes de image_data especificadas por la propiedad infoTypes en la configuración de la extensión.

Para obtener una lista de Infotipos, consulta la Referencia del detector de Infotipos.

Parámetros de solicitud

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

Respuesta

La imagen con el texto oculto.

Referencia de configuración

Usa lo siguiente cuando configures e implementes esta extensión para usarla en proxies de API. Para conocer los pasos para configurar una extensión con la consola de Apigee, consulta Cómo agregar y configurar una extensión.

Propiedades comunes de la extensión

Las siguientes propiedades están presentes para cada extensión.

Propiedades de este paquete de extensión

Especifica valores para las siguientes propiedades de configuración específicas de esta extensión.