Come mascherare e nascondere i dati

Questa pagina si applica ad Apigee e Apigee hybrid.

Visualizza la documentazione di Apigee Edge.

Quando esegui il debug delle chiamate alle API in Apigee, a volte i contenuti possono contenere dati sensibili, come carte di credito o informazioni sanitarie che consentono l'identificazione personale (PHI) che devono essere mascherate.

Apigee offre diversi modi per mascherare o nascondere i dati sensibili dalle sessioni di traduzione e di debug.

Mascherare i dati sensibili

Apigee ti consente di definire configurazioni di mascheramento per mascherare dati specifici nelle sessioni di tracciamento e debug. Quando i dati vengono mascherati, vengono sostituiti con asterischi nell'output della traccia. Puoi mascherare i dati sensibili e mantenere invariati quelli non sensibili. Ad esempio:

<ServiceRequest>
  <request-id>B540A938-F551</request-id>
  <customer-name>**********</customer-name>
</ServiceRequest>

La configurazione della maschera è una risorsa singleton che definisci a livello di ambiente. Per impostazione predefinita, non è attivo alcun mascheramento dei dati.

Il mascheramento dei dati si applica solo ai dati acquisiti in una sessione di debug per un proxy API. Il mascheramento dei dati non influisce sui dati inviati alle applicazioni client o di destinazione. Se modifichi la configurazione del mascheramento dei dati, devi avviare una nuova sessione di debug per vedere l'effetto della modifica.

Struttura di una configurazione della maschera

Le configurazioni di mascheramento sono file in formato JSON che consentono di identificare i dati sensibili nelle seguenti origini:

  • Payload XML: utilizzando XPath, puoi identificare gli elementi XML da filtrare dai payload dei messaggi di richiesta o risposta.
  • Payload JSON:con JSONPath, puoi identificare le proprietà JSON da filtrare dai payload dei messaggi di richiesta o risposta.
  • Variabili di flusso:puoi specificare un elenco di variabili da mascherare nell'output di debug. Quando specifichi le variabili di flusso request.content, response.content o message.content, anche il corpo della richiesta/risposta viene mascherato.

Di seguito è riportato un esempio della struttura di base di una configurazione della maschera in formato JSON. Per ulteriori informazioni sui campi di configurazione della maschera mostrati nell'esempio, consulta DebugMask. 

{
  "namespaces": {
    "myco": "http://example.com"
  },
  "requestXPaths": [
    "/myco:Greeting/myco:User"
  ],
  "responseXPaths": [
    "/myco:Greeting/myco:User"
  ],
  "faultXPaths": [
    "/myco:Greeting/myco:User"
  ],
  "requestJSONPaths": [
    "$.store.book[*].author"
  ],
  "responseJSONPaths": [
    "$.store.book[*].author"
  ],
  "faultJSONPaths": [
    "$.store.book[*].author"
  ],
  "variables": [
    "request.header.user-name",
    "request.formparam.password",
    "myCustomVariable"
  ]
}

Visualizzazione della configurazione della maschera in un ambiente che utilizza l'API

Per visualizzare la configurazione della maschera in un ambiente, esegui un comando GET alla seguente risorsa: 

/organizations/{org}/environments/{env}/debugmask

Ad esempio:

curl "https://apigee.googleapis.com/v1/organizations/myorg/environments/test/debugmask" \
  -X GET \
  -H "Authorization: Bearer $TOKEN"

dove $TOKEN è impostato sul tuo token di accesso OAuth 2.0, come descritto in Ottenere un token di accesso OAuth 2.0. Per informazioni sulle opzioni curl utilizzate in questo esempio, consulta Utilizzare curl. Per una descrizione delle variabili di ambiente utilizzate, consulta Impostazione delle variabili di ambiente per le richieste dell'API Apigee.

Di seguito è riportato un esempio di risposta: 

{
  "name": "organizations/myorg/environments/test/debugmask"
  "namespaces": {
    "myco": "http://example.com"
  },
  "requestXPaths": [
    "/myco:Greeting/myco:User"
  ],
  "responseXPaths": [
    "/myco:Greeting/myco:User"
  ]
}

Aggiornamento della configurazione della maschera in un ambiente mediante l'API

Per aggiornare la risorsa singleton di configurazione della maschera in un ambiente, esegui un PATCH alla seguente risorsa:

/organizations/{org}/environments/{env}/debugmask

Se vuoi, puoi passare i seguenti parametri di ricerca:

  • Imposta il parametro di query updateMask per specificare una maschera di campo che includa un elenco separato da virgole di nomi completi dei campi nella maschera di debug. Ad esempio: "requestJSONPaths"
  • Imposta il parametro di query replaceRepeatedFields per specificare se sostituire i valori esistenti nella maschera di debug durante un aggiornamento. Per impostazione predefinita, i valori vengono aggiunti (false)

Ad esempio: 

curl "https://apigee.googleapis.com/v1/organizations/myorg/environments/test/debugmask" \
  -X PATCH \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-type: application/json" \
  -d \
  '{
     "namespaces": {
       "ns1": "http://example.com"
     },
     "requestXPaths": [
       "/ns1:employee/ns1:name"
     ]
   }'

dove $TOKEN è impostato sul tuo token di accesso OAuth 2.0, come descritto in Ottenere un token di accesso OAuth 2.0. Per informazioni sulle opzioni curl utilizzate in questo esempio, consulta Utilizzare curl. Per una descrizione delle variabili di ambiente utilizzate, consulta Impostazione delle variabili di ambiente per le richieste dell'API Apigee.

Mascheramento di XML basato sullo spazio dei nomi

Se vuoi mascherare i dati XML e questi dati utilizzano gli spazi dei nomi XML, la configurazione della maschera deve fare riferimento a questi spazi dei nomi con l'elemento namespaces. Questo vale se il payload XML utilizza uno spazio dei nomi predefinito o un prefisso dello spazio dei nomi.

Ad esempio, supponiamo che tu voglia mascherare il nome del dipendente nel payload della richiesta e che il file XML non utilizzi gli spazi dei nomi XML:

<employee>
  <name>Shanmu Tharman</name>
  <age>50</age>
</employee>

Pertanto, la configurazione di debugmask non richiede l'elemento namespaces:

{
  "requestXPaths": [
    "/employee/name"
  ]
}

Se il payload XML utilizza spazi dei nomi con prefissi:

<cym:employee xmlns:cym="http://cymbalgroup.com" xmlns:id="http://cymbalgroup.com/identity">
  <id:name>Shanmu Tharman</id:name>
  <id:age>50</id:age>
</cym:employee>

La configurazione della maschera deve contenere l'elemento namespaces. Puoi scegliere qualsiasi prefisso dello spazio dei nomi valido nella configurazione di debugmask. Il prefisso dello spazio dei nomi nella configurazione di debugmask può essere uguale al prefisso dello spazio dei nomi utilizzato nel file XML, ma non è obbligatorio.

{
  "namespaces": {
    "cym": "http://cymbalgroup.com",
    "idns": "http://cymbalgroup.com/identity"
  },
  "requestXPaths": [
    "/cym:employee/idns:name"
  ]
}

Se il payload XML utilizza uno spazio dei nomi senza prefisso, ovvero lo spazio dei nomi predefinito:

<employee xmlns="http://cymbalgroup.com" xmlns:id="http://cymbalgroup.com/identity">
  <id:name>Shanmu Tharman</id:name>
  <id:age>50</id:age>
</employee>

La configurazione di debugmask deve comunque definire un prefisso nell'elemento namespaces corrispondente allo spazio dei nomi predefinito. Puoi utilizzare qualsiasi prefisso univoco.

{
  "namespaces": {
    "p1": "http://cymbalgroup.com",
    "id": "http://cymbalgroup.com/identity"
  },
  "requestXPaths": [
    "/p1:employee/id:name"
  ]
}

Altre note sulla configurazione

  • Con gli elementi di configurazione *XPaths e *JSONPaths, puoi nascondere i dati visualizzati nei messaggi request, response o fault. Tuttavia, i contenuti completi del messaggio possono essere acquisiti anche dalle sessioni di debug. Ti consigliamo inoltre di configurare request.content o response.content nella sezione variables per impedire la visualizzazione di dati sensibili.

  • Se utilizzi il criterio ServiceCallout per effettuare una richiesta, le informazioni nella richiesta e nella risposta per quel callout non verranno mascherate utilizzando gli elementi di configurazione come requestXPaths o responseJSONPaths. Se vuoi mascherare questi dati, devi specificare un nome variabile per i messaggi di richiesta e risposta nel criterio ServiceCallout e poi specificare queste variabili nella sezione variables della maschera di debug. Ad esempio, se il criterio ServiceCallout utilizza:

    <ServiceCallout name='SC-1'>
  <Request variable='rbacRequest'>
    <Set>
      <Payload contentType='application/json'>{ ... }</Payload>
       ...

    Poi devi includere rbacRequest.content nell'elemento variables per la configurazione di debugmask.

    {
  ...
  "variables": [
    "request.content",
    "response.content",
    "rbacRequest.content"
  ]
}

Nascondere i dati sensibili

Oltre a mascherare, puoi impedire la visualizzazione dei dati sensibili anche nello strumento di Trace e nelle sessioni di debug scegliendo un nome che inizi con private. per le variabili personalizzate.

Ad esempio, quando utilizzi il Regolamento relativo alle operazioni di mappatura dei valori chiave per recuperare un valore da una mappatura dei valori chiave, puoi scegliere il nome della variabile come segue per assicurarti che il valore non venga visualizzato nelle sessioni di Trace o di debug:

<KeyValueMapOperations name='KVM-Get-1'>
    <Scope>environment</Scope>
    <ExpiryTimeInSecs>300</ExpiryTimeInSecs>
    <MapName>settings</MapName>
    <Get assignTo='private.privatekey'>
      <Key>
        <Parameter>rsa_private_key</Parameter>
      </Key>
    </Get>
  </KeyValueMapOperations>

Le variabili senza il prefisso private. vengono visualizzate in testo normale nelle sessioni di Trace e di debug anche se i dati provengono da un datastore criptato, ad esempio una mappa di valori chiave. Utilizza il mascheramento se vuoi mascherare questi valori.