<ph type="x-smartling-placeholder"></ph>
您正在查看 Apigee Edge 文档。
转到
Apigee X 文档。 信息
<ph type="x-smartling-placeholder">
版本:1.5.1
使用此扩展程序可对内容和图片中的敏感数据进行模糊处理。例如,您可以隐去信用卡号、姓名和社会保障号。
前提条件
本文提供了配置和使用此扩展程序的参考信息。在通过 API 代理使用 ExtensionCallout 政策使用扩展程序之前,您必须:
为您的项目启用 Google Cloud DLP API。
根据您要为扩展程序设置的访问权限级别,授予权限。
关于 Cloud Data Loss Prevention (DLP)
Cloud Data Loss Prevention (DLP) 是一个用于检查文本、图片和其他数据的 API,以识别和管理敏感数据。
如需了解详情,请参阅 DLP 概览。如需了解此扩展程序公开的 API,请参阅 Cloud Data Loss Prevention (DLP) API。
示例
以下示例说明了如何使用 ExtensionCallout 政策配置对 Cloud DLP 扩展程序操作的支持。
为了更轻松地尝试此示例代码,这些示例使用 AssignMessage 政策来设置流变量值并检索扩展程序响应值,以便在跟踪工具中显示。
用星星遮盖
此示例使用 deidentifyWithMask
操作,使用此政策中指定的字符(在本例中为 *
字符)遮盖指定类型的文本。
出于说明目的,以下 AssignMessage 政策设置 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
)。该扩展程序已配置为根据 URL
和 EMAIL_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
。
出于说明目的,以下 AssignMessage 政策设置 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
)。该扩展程序已配置为根据 URL
和 EMAIL_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]."}
操作
<ph type="x-smartling-placeholder">
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":"*****************"}
请求参数
参数 | 说明 | 类型 | 默认 | 必填 |
---|---|---|---|---|
text | 要去标识化的文本。 | 字符串 | 无。 | 是。 |
掩盖 | 用于遮盖敏感数据的字符。 | 字符串 | 无。 | 是。 |
响应
将指定 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>
此示例的输出是去标识化的请求内容。
请求参数
参数 | 说明 | 类型 | 默认 | 必填 |
---|---|---|---|---|
text | 要去标识化的文本。这是去标识化过程的运行步骤。 | 对象 | 无。 | 是。 |
模板名称 | 要使用的模板。该路径将是模板的路径,格式为 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"}
请求参数
参数 | 说明 | 类型 | 默认 | 必填 |
---|---|---|---|---|
text | 要去标识化的文本。 | 字符串 | 无。 | 是。 |
响应
将指定 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。 | 无。 | 是。 |
infoType | 敏感数据的信息类型。如果省略,服务将检测所有内置类型。如需查看 Google Cloud DLP 服务支持的 infoType 列表,请参阅 InfoType 检测器参考。 | 无。 | 数量 |
凭据 | 在 Apigee Edge 控制台中输入时,这是服务账号密钥文件的内容。通过 Management API 发送时,此值为根据服务账号密钥文件生成的 base64 编码值。 | 无。 | 是。 |