Extension Google Cloud Data Loss Prevention

Vous consultez la documentation d'Apigee Edge.
Accédez à la documentation sur Apigee X. info

Version: 2.0.0

Utilisez cette extension pour masquer les données sensibles dans les contenus et les images. Par exemple, vous pouvez masquer les numéros de carte de crédit, les noms et les numéros de sécurité sociale.

Prérequis

Ce contenu fournit une documentation de référence pour configurer et utiliser cette extension. Avant d'utiliser l'extension à partir d'un proxy d'API à l'aide de la règle ExtensionCallout, vous devez:

1. Activez l'API Google Cloud DLP pour votre projet.

2. Accordez l'autorisation pour le niveau d'accès souhaité pour l'extension.

3. Générez une clé pour le compte de service à l'aide de la console GCP.

4. Utilisez le contenu du fichier JSON de clé généré lorsque vous ajoutez et configurez l'extension à l'aide de la référence de configuration.

À propos de Cloud Data Loss Prevention (DLP)

Cloud Data Loss Prevention (DLP) est une API qui permet d'inspecter du texte, des images et d'autres données afin d'identifier et de gérer les données sensibles.

Pour en savoir plus, consultez la présentation de la protection contre la perte de données. Pour en savoir plus sur l'API exposée par cette extension, consultez la page API Cloud Data Loss Prevention (DLP).

Exemples

Les exemples suivants montrent comment configurer la prise en charge des actions d'extension Cloud DLP à l'aide de la règle ExtensionCallout.

Pour faciliter l'essai de cet exemple de code, ces exemples utilisent une règle AssignMessage pour définir les valeurs des variables de flux et récupérer les valeurs de réponse de l'extension à afficher dans l'outil 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]."}

Actions

deidentifyWithMask

Anonymisez les données sensibles de text et masquez-les avec le caractère mask. Cette action masque les parties de text spécifiées par la propriété infoTypes dans la configuration de l'extension.

Le masquage des données sensibles remplace les caractères par un symbole, tel qu'un astérisque (*) ou un dièse (#). Les types de données sensibles peuvent être configurés dans la configuration de l'extension.

<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":"*****************"}

Paramètres de requête

Réponse

Texte saisi avec les valeurs des infoTypes spécifiés remplacées par le caractère spécifié. Par exemple,

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

deidentifyWithTemplate

Supprimez l'identification des données sensibles dans du contenu textuel à l'aide d'un modèle qui configure le texte à anonymiser et la manière de le gérer.

Les modèles sont utiles pour dissocier les informations de configuration, soit les éléments que vous inspectez d'un côté, et la méthode utilisée dans la mise en œuvre de vos appels d'API pour supprimer l'identification de ces éléments d'un autre côté. Les modèles constituent une solution pour réutiliser des configurations. Ils garantissent en outre une plus grande cohérence pour les utilisateurs et pour les ensembles de données.

Dans votre modèle, vous spécifierez les infoTypes représentant le contenu à anonymiser. Pour obtenir la liste des infoTypes, consultez la documentation de référence sur les détecteurs d'infoTypes. La suppression de l'identification masque les parties de texte spécifiées par la propriété infoTypes dans le modèle.

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

Paramètres de requête

Réponse

Texte saisi avec les valeurs des infoTypes spécifiés remplacées par les noms des infoTypes.

deidentifyWithType

Anonymiser les données sensibles dans le contenu textuel en remplaçant chaque valeur correspondante par le nom de l'infoType Pour obtenir la liste des infoTypes, consultez la documentation de référence sur les détecteurs d'infoTypes. Cette action masque les parties de text spécifiées par la propriété infoTypes dans la configuration de l'extension.

Dans l'exemple suivant, le numéro de téléphone est reconnu par le service, puis remplacé par le nom de l'infoType lui-même.

• Texte saisi:

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

• Texte du résultat:

  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"}

Paramètres de requête

Réponse

Texte saisi avec les valeurs des infoTypes spécifiés remplacées par les noms des infoTypes. Par exemple,

{"text":"EMAIL_ADDRESS"}

redactImage

Masquer le texte appartenant à l'une des catégories d'infoType Le contenu masqué est détecté et masqué par un rectangle opaque. Cette action masque les parties de image_data spécifiées par la propriété infoTypes dans la configuration de l'extension.

Pour obtenir la liste des infoTypes, consultez la documentation de référence sur les détecteurs d'infoTypes.

Paramètres de requête

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

Réponse

Image avec le texte masqué.

Documentation de référence sur la configuration

Utilisez les éléments suivants lorsque vous configurez et déployez cette extension pour l'utiliser dans des proxys d'API. Pour savoir comment configurer une extension à l'aide de la console Apigee, consultez Ajouter et configurer une extension.

Propriétés d'extension courantes

Les propriétés suivantes sont présentes pour chaque extension.

Propriétés de ce package d'extension

Spécifiez les valeurs des propriétés de configuration suivantes spécifiques à cette extension.