Rozszerzenie Google Cloud Data Loss Prevention

Wyświetlasz dokumentację Apigee Edge.
Przejdź do dokumentacji Apigee X. info

Wersja: 1.5.1

Użyj tego rozszerzenia, aby ukryć dane wrażliwe w treści i obrazach. Możesz na przykład utajnić numery kart kredytowych, imiona i nazwiska oraz numery ubezpieczenia społecznego.

Wymagania wstępne

Ta treść zawiera informacje o konfigurowaniu i używaniu tego rozszerzenia. Zanim zaczniesz korzystać z rozszerzenia w proxy interfejsu API za pomocą zasady ExtensionCallout, musisz:

1. włączyć Google Cloud DLP API w projekcie;

2. przyznać uprawnienia do poziomu dostępu, który chcesz uzyskać w rozszerzeniu;

3. wygenerować klucz konta usługi w konsoli Google Cloud Platform

4. podczas dodawania i konfigurowania rozszerzenia użyć zawartości wynikowego pliku JSON z kluczem, korzystając z odwołania do konfiguracji.

Informacje o Cloud Data Loss Prevention (DLP)

Cloud Data Loss Prevention (DLP) to interfejs API do sprawdzania tekstu, obrazów i innych danych w celu identyfikowania danych wrażliwych i zarządzania nimi.

Więcej informacji znajdziesz w omówieniu DLP. Informacje o interfejsie API, który udostępnia to rozszerzenie, znajdziesz w artykule Cloud Data Loss Prevention (DLP) API.

Przykłady

Z przykładów poniżej dowiesz się, jak skonfigurować obsługę działań rozszerzenia Cloud DLP za pomocą zasady ExtensionCallout.

Aby ułatwić wypróbowanie tego przykładowego kodu, w tych przykładach używamy zasady AssignMessage do ustawiania wartości zmiennych przepływu i pobierania wartości odpowiedzi rozszerzenia w celu wyświetlenia ich w narzędziu Trace.

<?xml version="1.0" encoding="UTF-8&quo>t<; standalone="yes"?
AssignMessage async="false" continueOnError=&q>uot;f<alse" >enabled=&quo<t;true"> name<="Set-Variable"
    DisplayNameSe>t Var<iable/DisplayN>ame
    A<ssig>nTo type="<respo>nse"< crea>teNew="false"/
    AssignVariable
        Namerequest.content/Na<me
   >     <ValueVisit my s>i<te at https://>example.com. Or contact me at gladys@example.com./Value
    /AssignVariable
/AssignMessage

<?xml version="1.0" encoding="UTF-8&quo>t<; standalone="yes"?
ConnectorCallout async="false" continueOnError="true"> enab<led="t>rue" name="Data-Loss-Extensi<on-Callout&q>uot;
<    Displ>ayNameData <Loss Preve>ntion< Exten>sion Callout/Displ<ayName
>    C<onnec><torexample-dlp/Connector
    ActiondeidentifyWithMask/Action
    Input![CDAT><A[{
  >     < "text" :< ">{<request.content}&>quot;,
        "mask" : "*"
    }]]/Input
    Outputmasked.output/Output
/ConnectorCallout

<?xml version="1.0" encoding="UTF-8&quo>t<; standalone="yes"?
AssignMessage async="false" continueOnError=&quo>t;fal<se" en>abled="tr<ue" nam>e=&qu<ot;Get-DLP-Output"
    DisplayNameGet >DLP O<utp>ut/Displa<yName
    AssignTo type="response>" createNe<w=">false<&quo>t<;/
    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&quo>t<; standalone="yes"?
AssignMessage async="false" continueOnError=&q>uot;f<alse" >enabled=&quo<t;true"> name<="Set-Variable"
    DisplayNameSe>t Var<iable/DisplayN>ame
    A<ssig>nTo type="<respo>nse"< crea>teNew="false"/
    AssignVariable
        Namerequest.content/Na<me
   >     <ValueVisit my s>i<te at https://>example.com. Or contact me at gladys@example.com./Value
    /AssignVariable
/AssignMessage

<?xml version="1.0" encoding="UTF-8&quo>t<; standalone="yes"?
ConnectorCallout async="false" continueOnError="true"> enab<led="t>rue" name="Data-Loss-Extensi<on-Callout&q>uot;
<    Displ>ayNameData <Loss Preve>ntion< Exten>sion Callout/Displ<ayName
>    C<onnec><torexample-dlp/Connector
    ActiondeidentifyWithType/><Action>
    <Input!>[CDATA[{
    <    &quo<t;text" : &q>uot;{request.content}"
    }]]/Input
    Outputmasked.output/Output
/ConnectorCallout

<?xml version="1.0" encoding="UTF-8&quo>t<; standalone="yes"?
AssignMessage async="false" continueOnError=&quo>t;fal<se" en>abled="tr<ue" nam>e=&qu<ot;Get-DLP-Output"
    DisplayNameGet >DLP O<utp>ut/Displa<yName
    AssignTo type="response>" createNe<w=">false<&quo>t<;/
    Set
   >     Payload contentType="application/json"{masked.output}/Payload
    /Set
/AssignMessage

{"text":"Visit my site at [URL] Or contact me at [EMAIL_ADDRESS]."}

Działania

deidentifyWithMask

Deidentyfikuje dane wrażliwe z text i maskuje je za pomocą znaku mask. To działanie maskuje te części text, które są określone przez właściwość infoTypes w konfiguracji rozszerzenia.

Maskowanie danych wrażliwych polega na zastępowaniu znaków symbolem, np. gwiazdką (*) lub znakiem hash (#). Typy danych wrażliwych można skonfigurować w konfiguracji rozszerzenia.

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

<Action>deidentifyWithMask</Action>
<Input><![CDATA[{
    "text" : "{input.email.address}",
><    &q>u<ot;mas>k" : &qu<ot;*&qu>ot;
}]]/Input
Outputmasked.output/Output

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

Parametry żądania

Odpowiedź

Tekst wejściowy z wartościami określonych obiektów infoType zastąpionymi określonym znakiem. Na przykład:

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

deidentifyWithTemplate

Deidentyfikuje dane wrażliwe w treści tekstowej za pomocą szablonu, który konfiguruje, jaki tekst ma zostać deidentyfikowany i jak go obsługiwać.

Szablony są przydatne do oddzielania konfiguracji, np. tego, co sprawdzasz i jak deidentyfikujesz, od implementacji wywołań interfejsu API. Szablony umożliwiają ponowne wykorzystanie konfiguracji i zapewniają spójność między użytkownikami i zbiorami danych.

W szablonie określisz obiekty infoTypes reprezentujące treść do deidentyfikacji. Listę obiektów infoType znajdziesz w artykule Odwołanie do detektora obiektów infoType. Deidentyfikacja maskuje te części tekstu, które są określone przez właściwość infoTypes w szablonie.

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

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

Parametry żądania

Odpowiedź

Tekst wejściowy z wartościami określonych obiektów infoType zastąpionymi nazwami tych obiektów.

deidentifyWithType

Deidentyfikuje dane wrażliwe w treści tekstowej, zastępując każdą pasującą wartość nazwą obiektu infoType. Listę obiektów infoType znajdziesz w artykule Odwołanie do detektora obiektów infoType. To działanie maskuje te części text, które są określone przez właściwość infoTypes w konfiguracji rozszerzenia.

W przykładzie poniżej usługa rozpoznaje numer telefonu, a następnie zastępuje go nazwą samego obiektu infoType.

• Wprowadzany tekst:

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

• Tekst wynikowy:

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

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

<Action>deidentifyWithType</Action>
<Input><![CDATA[{
    "text" : "{input.emai><l.addr>ess}"
}]]/Input

{"text":"EMAIL_ADDRESS"}

Parametry żądania

Odpowiedź

Tekst wejściowy z wartościami określonych obiektów infoType zastąpionymi nazwami tych obiektów. Na przykład:

{"text":"EMAIL_ADDRESS"}

redactImage

Utajnia tekst, który należy do jednej z kategorii obiektów infoType. Utajniona treść jest wykrywana i zasłaniana nieprzezroczystym prostokątem. To działanie maskuje te części image_data, które są określone przez właściwość infoTypes w konfiguracji rozszerzenia.

Listę obiektów infoType znajdziesz w artykule Odwołanie do detektora obiektów infoType.

Parametry żądania

<Action>redactImage</Action>
<Input><![CDATA[{
  "image_data" : "base64-encoded-image-to-analyze",
  "image_ty><pe&quo>t; : "type-of-image"
}]]/Input

Odpowiedź

Obraz z utajnionym tekstem.

Odwołanie do konfiguracji

Podczas konfigurowania i wdrażania tego rozszerzenia do użytku w proxy interfejsu API użyj tych informacji. Aby dowiedzieć się, jak skonfigurować rozszerzenie za pomocą konsoli Apigee, przeczytaj artykuł Dodawanie i konfigurowanie rozszerzenia.

Wspólne właściwości rozszerzenia

Dla każdego rozszerzenia dostępne są poniższe właściwości.

Właściwości tego pakietu rozszerzenia

Określ wartości tych właściwości konfiguracji, które są specyficzne dla tego rozszerzenia.