Stai visualizzando la documentazione di Apigee Edge.
Consulta la
documentazione di Apigee X. info
Versione: 2.0.2
Utilizza questa estensione per oscurare i dati sensibili di contenuti e immagini. Ad esempio, potresti oscurare numeri di carta di credito, nomi e codici fiscali.
Prerequisiti
Questi contenuti forniscono un riferimento per la configurazione e l'utilizzo di questa estensione. Prima di utilizzare l'estensione da un proxy API utilizzando il criterio ExtensionCallout, devi:
Abilita l'API Google Cloud DLP per il tuo progetto.
Concedi l'autorizzazione per il livello di accesso che vuoi per l'estensione.
Utilizza la console Google Cloud per generare una chiave per il service account.
Utilizza i contenuti del file JSON della chiave risultante quando aggiungi e configuri l'estensione utilizzando il riferimento alla configurazione.
Informazioni su Cloud Data Loss Prevention (DLP)
Cloud Data Loss Prevention (DLP) è un'API per l'ispezione di testo, immagini e altri dati per identificare e gestire i dati sensibili.
Per saperne di più, consulta la panoramica della DLP. Per un riferimento all'API esposta da questa estensione, consulta API Cloud Data Loss Prevention (DLP).
Esempi
Gli esempi seguenti illustrano come configurare il supporto per le azioni dell'estensione Cloud DLP utilizzando il criterio ExtensionCallout.
Per semplificare la prova di questo codice di esempio, questi esempi utilizzano una norma AssignMessage per impostare i valori delle variabili di flusso e recuperare i valori di risposta dell'estensione per la visualizzazione nello strumento Trace.
Maschera con stelle
Questo esempio utilizza l'azione deidentifyWithMask per mascherare i tipi di testo specificati con un carattere specificato nella policy, in questo caso il carattere *.
Il seguente criterio AssignMessage imposta la variabile request.content a scopo illustrativo. In genere, recuperi i contenuti della richiesta dalla richiesta del client.
<?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>
Il seguente criterio ExtensionCallout recupera il valore della variabile request.content e lo trasmette a un'estensione Cloud DLP (in questo caso, chiamata example-dlp). Questa estensione è stata configurata per mascherare i valori in base agli infoTypes URL e EMAIL_ADDRESS.
<?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>
La seguente policy AssignMessage recupera l'output dell'estensione per la visualizzazione nello strumento Trace.
<?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>
Di seguito è riportato un esempio di output di questo codice.
{"text":"Visit my site at ******************* Or contact me at *****************."}
Maschera con nome
Questo esempio utilizza l'azione deidentifyWithType per mascherare i tipi di testo specificati con il nome stesso dell'infotipo. Ad esempio, sostituirebbe l'indirizzo email gladys@example.com con EMAIL_ADDRESS.
Il seguente criterio AssignMessage imposta la variabile request.content a scopo illustrativo. In genere, recuperi i contenuti della richiesta dalla richiesta del client.
<?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>
Il seguente criterio ExtensionCallout recupera il valore della variabile request.content e lo trasmette a un'estensione Cloud DLP (in questo caso, chiamata example-dlp). Questa estensione è stata configurata per mascherare i valori in base agli infoTypes URL e EMAIL_ADDRESS.
<?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>
La seguente policy AssignMessage recupera l'output dell'estensione per la visualizzazione nello strumento Trace.
<?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>
Di seguito è riportato un esempio di output di questo codice.
{"text":"Visit my site at [URL] Or contact me at [EMAIL_ADDRESS]."}
Azioni
deidentifyWithMask
Anonimizza i dati sensibili di text e mascherali con il carattere mask. Questa azione maschera le parti di text specificate dalla proprietà infoTypes nella configurazione dell'estensione.
La mascheratura dei dati sensibili sostituisce i caratteri con un simbolo, ad esempio un asterisco (*) o un cancelletto (#). I tipi di dati sensibili possono essere configurati nella configurazione dell'estensione.
Sintassi
<Action>deidentifyWithMask</Action>
<Input><![CDATA[{
"text" : "text-to-deidentify",
"mask" : "masking-character"
}]]></Input>
Esempio
Nell'esempio seguente, l'input da mascherare è un indirizzo email archiviato in una variabile di flusso input.email.address. Per supportare questo esempio specifico, l'estensione deve essere stata configurata per supportare l'infoType EMAIL_ADDRESS. Per un elenco di infoType, consulta la Guida di riferimento per i rilevatori di infoType.
<Action>deidentifyWithMask</Action>
<Input><![CDATA[{
"text" : "{input.email.address}",
"mask" : "*"
}]]></Input>
<Output>masked.output</Output>
L'output per questo esempio sarebbe il seguente:
{"text":"*****************"}
Parametri di richiesta
| Parametro | Descrizione | Tipo | Predefinito | Obbligatorio |
|---|---|---|---|---|
| testo | Testo da anonimizzare. | Stringa | Nessuno. | Sì. |
| maschera | Carattere da utilizzare per mascherare i dati sensibili. | Stringa | Nessuno. | Sì. |
Risposta
Il testo di input con i valori degli infoType specificati sostituiti con il carattere specificato. Ad esempio,
{"text":"*********"}
deidentifyWithTemplate
Anonimizza i dati sensibili nel contenuto testuale utilizzando un modello che configura il testo da anonimizzare e come gestirlo.
I modelli sono utili per separare la configurazione, ad esempio cosa ispezionare e come deidentificare, dall'implementazione delle chiamate API. I modelli consentono di riutilizzare la configurazione e garantire la coerenza tra utenti e set di dati.
Nel modello, specificherai gli infoTypes che rappresentano i contenuti da anonimizzare. Per un elenco di infoType, consulta la Guida di riferimento per i rilevatori di infoType. L'anonimizzazione maschera le parti di testo specificate dalla proprietà infoTypes nel modello.
Sintassi
<Action>deidentifyWithTemplate</Action>
<Input><![CDATA[{
"text" : "text-to-deidentify"
"templateName" : "path-to-template"
}]]></Input>
Esempio
Nell'esempio seguente, l'input da de-identificare è il corpo della richiesta trasportato dalla variabile di flusso request.content.
<Action>deidentifyWithTemplate</Action>
<Input><![CDATA[{
"text" : "{request.content}"
"templateName" : "projects/[PROJECT_ID]/deidentifyTemplates/1231258663242"
}]]></Input>
L'output di questo esempio sarà il contenuto della richiesta di deidentificazione.
Parametri di richiesta
| Parametro | Descrizione | Tipo | Predefinito | Obbligatorio |
|---|---|---|---|---|
| testo | Il testo da anonimizzare. È su questo che opera il processo di anonimizzazione. | Oggetto | Nessuno. | Sì. |
| templateName | Il modello da utilizzare. Si tratta di un percorso al modello nel seguente formato: projects or organizations/PROJECT_ID/deidentifyTemplates/TEMPLATE_ID. Quando crei il modello con l'API Google, utilizza il valore della proprietà name della risposta come templateName. |
Stringa | Nessuno. | Sì. |
Risposta
Il testo di input con i valori degli infoType specificati sostituiti con i nomi degli infoType.
deidentifyWithType
Anonimizza i dati sensibili nei contenuti di testo, sostituendo ogni valore corrispondente con il nome dell'infoType. Per un elenco di infoType, consulta la Guida di riferimento per i rilevatori di infoType. Questa azione maschera le parti di text specificate dalla proprietà infoTypes nella configurazione dell'estensione.
Nell'esempio seguente, il numero di telefono viene riconosciuto dal servizio, quindi sostituito con il nome dell'infoType stesso.
Testo inserito:
John Smith, 123 Main St, Seattle, WA 98122, 206-555-0123.Testo del risultato:
John Smith, 123 Main St, Seattle, WA 98122, PHONE_NUMBER.
Sintassi
<Action>deidentifyWithType</Action>
<Input><![CDATA[{
"text" : "text-to-deidentify"
}]]></Input>
Esempio
Nell'esempio seguente, l'input da mascherare è un indirizzo email archiviato in una variabile di flusso input.email.address. Per supportare questo esempio specifico, l'estensione deve essere stata configurata per supportare l'infoType EMAIL_ADDRESS. Per un elenco di infoType, consulta la Guida di riferimento per i rilevatori di infoType.
<Action>deidentifyWithType</Action>
<Input><![CDATA[{
"text" : "{input.email.address}"
}]]></Input>
L'output per questo esempio sarebbe il seguente:
{"text":"EMAIL_ADDRESS"}
Parametri di richiesta
| Parametro | Descrizione | Tipo | Predefinito | Obbligatorio |
|---|---|---|---|---|
| testo | Il testo da anonimizzare. | Stringa | Nessuno. | Sì. |
Risposta
Il testo di input con i valori degli infoType specificati sostituiti con i nomi degli infoType. Ad esempio,
{"text":"EMAIL_ADDRESS"}
redactImage
Oscura il testo che rientra in una delle categorie di infoType. I contenuti oscurati vengono rilevati e nascosti con un rettangolo opaco. Questa azione maschera le parti di image_data specificate dalla proprietà infoTypes nella configurazione dell'estensione.
Per un elenco di infoType, consulta la Guida di riferimento per i rilevatori di infoType.
Parametri di richiesta
<Action>redactImage</Action>
<Input><![CDATA[{
"image_data" : "base64-encoded-image-to-analyze",
"image_type" : "type-of-image"
}]]></Input>
| Parametro | Descrizione | Tipo | Predefinito | Obbligatorio |
|---|---|---|---|---|
| image_data | I dati immagine codificati in base64. | Stringa | Nessuno. | Sì. |
| image_type | Costante del tipo di immagine. I valori disponibili sono IMAGE_JPEG, IMAGE_BMP, IMAGE_PNG, IMAGE_SVG. | Stringa | Nessuno. | Sì. |
Risposta
L'immagine con il testo oscurato.
Riferimento alla configurazione
Utilizza quanto segue quando configuri ed esegui il deployment di questa estensione per l'utilizzo nei proxy API. Per i passaggi per configurare un'estensione utilizzando la console Apigee, vedi Aggiunta e configurazione di un'estensione.
Proprietà comuni delle estensioni
Per ogni estensione sono presenti le seguenti proprietà.
| Proprietà | Descrizione | Predefinito | Obbligatorio |
|---|---|---|---|
name |
Il nome che assegni a questa configurazione dell'estensione. | Nessuno | Sì |
packageName |
Nome del pacchetto dell'estensione fornito da Apigee Edge. | Nessuno | Sì |
version |
Numero di versione del pacchetto dell'estensione da cui stai configurando un'estensione. | Nessuno | Sì |
configuration |
Valore di configurazione specifico per l'estensione che stai aggiungendo. Vedi Proprietà per questo pacchetto di estensioni | Nessuno | Sì |
Proprietà di questo pacchetto di estensioni
Specifica i valori per le seguenti proprietà di configurazione specifiche di questa estensione.
| Proprietà | Descrizione | Predefinito | Obbligatorio |
|---|---|---|---|
| ID progetto | L'ID progetto Google Cloud per il quale è abilitata l'API Cloud Data Loss Prevention. | Nessuno. | Sì. |
| previsti | Tipi di informazioni dei dati sensibili. Se omesso, il servizio rileverà tutti i tipi integrati. Per un elenco degli infoType supportati dal servizio Google Cloud DLP, consulta la Guida di riferimento per i rilevatori di infoType. | Nessuno. | No. |
| credenziali | Se inserito nella console Apigee Edge, questo è il contenuto del file della chiave dell'account di servizio. Se inviato utilizzando l'API Management, è un valore codificato in base64 generato dal file delle chiavi del service account. | Nessuno. | Sì. |