Google Cloud 数据泄露防护扩展程序

您正在查看的是 Apigee Edge 文档。
转到 Apigee X 文档
信息

版本:1.5.1

使用此扩展程序可遮盖内容和图片中的敏感数据。例如,您可以隐去信用卡号、姓名和社会保障号。

前提条件

本文内容提供了有关配置和使用此扩展程序的参考信息。在采用 ExtensionCallout 政策通过 API 代理使用扩展程序之前,您必须:

  1. 为您的项目启用 Google Cloud DLP API

  2. 根据您希望扩展程序的访问权限级别授予权限

  3. 使用 GCP Console 为服务帐号生成密钥

  4. 在通过配置参考添加和配置扩展程序时,使用所得到的 JSON 密钥文件的内容。

Cloud Data Loss Prevention (DLP) 简介

Cloud Data Loss Prevention (DLP) 是一个 API,用于检查文本、图片和其他数据以识别和管理敏感数据。

如需了解详情,请参阅 DLP 概览。如需参考此扩展程序公开的 API,请参阅 Cloud Data Loss Prevention (DLP) API

示例

以下示例说明了如何使用 ExtensionCallout 政策配置对 Cloud DLP 扩展程序操作的支持。

为简化示例代码的试用,这些示例使用 AllocationMessage 政策来设置流变量值,并检索扩展程序响应值以在跟踪工具中显示。

星空面具

此示例使用 deidentifyWithMask 操作通过政策中指定的字符(此处为 * 字符)遮盖指定类型的文本。

下面的 AssignmentMessage 政策会设置 request.content 变量,以便进行说明。通常,您会从客户端的请求中检索请求内容。

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

以下 ExtensionCallout 政策会检索 request.content 变量值,并将其传递给 Cloud DLP 扩展程序(此处称为 example-dlp)。该扩展程序已配置为基于 URLEMAIL_ADDRESS infoTypes 遮盖值。

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

以下 assignMessage 政策可检索扩展程序的输出,以便在“跟踪”工具中显示。

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

带有名称的遮罩

此示例使用 deidentifyWithType 操作通过 infoType 名称本身遮盖指定类型的文本。例如,它会将电子邮件地址 gladys@example.com 替换为 EMAIL_ADDRESS

下面的 AssignmentMessage 政策会设置 request.content 变量,以便进行说明。通常,您会从客户端的请求中检索请求内容。

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

以下 ExtensionCallout 政策会检索 request.content 变量值,并将其传递给 Cloud DLP 扩展程序(此处称为 example-dlp)。该扩展程序已配置为基于 URLEMAIL_ADDRESS infoTypes 遮盖值。

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

以下 assignMessage 政策可检索扩展程序的输出,以便在“跟踪”工具中显示。

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

Action

deidentifyWithMask

text 中的敏感数据进行去标识化,并使用 mask 字符遮盖数据。此操作会遮盖扩展程序配置infoTypes 属性指定的 text 部分。

遮盖敏感数据时,系统会将字符替换为星号 (*) 或井号 (#)。您可以在扩展程序配置中配置敏感数据的类型。

语法

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

示例

在以下示例中,要遮盖的输入是存储在 input.email.address 流变量中的电子邮件地址。如需支持此特定示例,必须已将此扩展程序配置为支持 EMAIL_ADDRESS infoType。如需查看 infoType 的列表,请参阅 InfoType 检测器参考

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

此示例的输出将如下所示:

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

请求参数

参数 说明 类型 默认 必需
PLAIN_TAXT; 要去标识化的文本。 字符串 无。 有。
戴口罩的脸 用于遮盖敏感数据的字符。 字符串 无。 有。

响应

将指定 infoType 的值替换为指定字符的输入文本。例如,

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

deidentifyWithTemplate

使用模板(可配置要去标识化的文本以及对文本的处理方式)对文本内容中的敏感数据进行去标识化处理。

模板可用于将配置(例如检查的内容和去标识化的方式)与 API 调用的实现分离。模板提供了一种重复使用配置的方法,并可在用户和数据集之间实现一致性。

在模板中,您需要指定表示要去标识化的内容的 infoTypes。如需查看 infoType 的列表,请参阅 InfoType 检测器参考文档。去标识化会遮盖模板中 infoTypes 属性指定的文本部分。

语法

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

示例

在以下示例中,要去标识化的输入是 request.content 数据流变量携带的请求正文。

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

此示例的输出将是去标识化请求内容。

请求参数

参数 说明 类型 默认 必需
PLAIN_TAXT; 要去标识化的文本。这是执行去标识化过程的操作。 对象 无。 有。
templateName 要使用的模板。这将是采用以下格式的模板路径:projects or organizations/PROJECT_ID/deidentifyTemplates/TEMPLATE_ID。当您使用 Google API 创建模板时,请将响应的 name 属性值用作 templateName 字符串 无。 有。

响应

将指定 infoType 的值替换为 infoType 名称的输入文本。

deidentifyWithType

对文本内容中的敏感数据进行去标识化,并将每个匹配的值替换为 infoType 的名称。如需查看 infoType 的列表,请参阅 InfoType 检测器参考文档。此操作会遮盖扩展程序配置infoTypes 属性指定的 text 部分。

在以下示例中,服务会识别电话号码,然后将其替换为 infoType 本身的名称。

  • 输入文本:

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

  • 结果文字:

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

语法

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

示例

在以下示例中,要遮盖的输入是存储在 input.email.address 流变量中的电子邮件地址。如需支持此特定示例,必须已将此扩展程序配置为支持 EMAIL_ADDRESS infoType。如需查看 infoType 的列表,请参阅 InfoType 检测器参考

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

此示例的输出将如下所示:

{"text":"EMAIL_ADDRESS"}

请求参数

参数 说明 类型 默认 必需
PLAIN_TAXT; 要去标识化的文本。 字符串 无。 有。

响应

将指定 infoType 的值替换为 infoType 名称的输入文本。例如,

{"text":"EMAIL_ADDRESS"}

redactImage

隐去属于某个 infoType 类别的文本。系统会检测隐去的内容,并使用不透明的矩形进行遮盖。此操作会遮盖扩展程序配置infoTypes 属性指定的 image_data 部分。

如需查看 infoType 的列表,请参阅 InfoType 检测器参考文档

请求参数

<Action>redactImage</Action>
<Input><![CDATA[{
  "image_data" : "base64-encoded-image-to-analyze",
  "image_type" : "type-of-image"
}]]></Input>
参数 说明 类型 默认 必需
image_data 采用 base64 编码的图片数据。 字符串 无。 有。
image_type 图片类型的常量。可用值为 IMAGE_JPEG、IMAGE_BMP、IMAGE_PNG、IMAGE_SVG。 字符串 无。 有。

响应

已遮盖文字的图片。

配置参考文档

在配置和部署此扩展程序以在 API 代理中使用时,请使用以下代码。如需了解使用 Apigee 控制台配置扩展程序的步骤,请参阅添加和配置扩展程序

通用扩展属性

每个扩展程序都有以下属性。

属性 说明 默认 必需
name 您为扩展程序配置此名称。
packageName Apigee Edge 提供的扩展包的名称。
version 配置扩展程序所用的扩展程序软件包的版本号。
configuration 特定于您要添加的附加信息的配置值。请参阅此扩展程序软件包的属性

此扩展程序软件包的属性

为此扩展程序的以下配置属性指定值。

媒体资源 说明 默认 必需
projectId 启用了 Cloud Data Loss Prevention API 的 GCP 项目 ID。 无。 有。
infoTypes 敏感数据的信息类型。如果省略,服务将检测所有内置类型。如需查看 Google Cloud DLP 服务支持的 infoType 列表,请参阅 InfoType 检测器参考 无。 没有。
凭据 在 Apigee Edge 控制台中输入时,这是服务帐号密钥文件的内容。通过 Management API 发送时,它是从服务帐号密钥文件生成的 base64 编码值。 无。 有。