Criterio XMLThreatProtection

Policy estensibile

Questa pagina si applica ad Apigee e Apigee hybrid.

Visualizza la documentazione di Apigee Edge.

Il criterio XMLThreatProtection consente di risolvere le vulnerabilità XML e ridurre al minimo gli attacchi alla tua API. Puoi anche utilizzare il criterio per rilevare gli attacchi di payload XML in base ai limiti configurati. Esegui lo screening delle minacce XML utilizzando i seguenti approcci:

  • Rilevare messaggi danneggiati o non validi prima che vengano analizzati
  • Valuta il contenuto del messaggio alla ricerca di parole chiave o pattern specifici da escludere

Queste norme sono estendibili e il loro utilizzo potrebbe avere implicazioni in termini di costi o utilizzo, a seconda della licenza Apigee. Per informazioni sui tipi di policy e sulle implicazioni di utilizzo, consulta Tipi di policy.

Riferimento elemento

Il riferimento all'elemento descrive gli elementi e gli attributi della policy XMLThreatProtection.

<XMLThreatProtection async="false" continueOnError="false" enabled="true" name="XML-Threat-Protection-1">
   <DisplayName>XML Threat Protection 1</DisplayName>
   <NameLimits>
      <Element>10</Element>
      <Attribute>10</Attribute>
      <NamespacePrefix>10</NamespacePrefix>
      <ProcessingInstructionTarget>10</ProcessingInstructionTarget>
   </NameLimits>
   <Source>request</Source>
   <StructureLimits>
      <NodeDepth>5</NodeDepth>
      <AttributeCountPerElement>2</AttributeCountPerElement>
      <NamespaceCountPerElement>3</NamespaceCountPerElement>
      <ChildCount includeComment="true" includeElement="true" includeProcessingInstruction="true" includeText="true">3</ChildCount>
   </StructureLimits>
   <ValueLimits>
      <Text>15</Text>
      <Attribute>10</Attribute>
      <NamespaceURI>10</NamespaceURI>
      <Comment>10</Comment>
      <ProcessingInstructionData>10</ProcessingInstructionData>
   </ValueLimits>
</XMLThreatProtection>

Attributi <XMLThreatProtection>

<XMLThreatProtection async="false" continueOnError="false" enabled="true" name="XML-Threat-Protection-1">

La tabella seguente descrive gli attributi comuni a tutti gli elementi principali dei criteri:

Attributo Descrizione Predefinito Presence
name

Il nome interno del criterio. Il valore dell'attributo name può contenere lettere, numeri, spazi, trattini, trattini bassi e punti. Questo valore non può superare i 255 caratteri.

Se vuoi, utilizza l'elemento <DisplayName> per etichettare il criterio nell'editor proxy dell'interfaccia utente di gestione con un nome diverso in linguaggio naturale.

 N/D Obbligatorio
continueOnError

Imposta su false per restituire un errore quando un criterio non va a buon fine. Questo è un comportamento previsto per la maggior parte dei criteri.

Imposta su true per continuare l'esecuzione del flusso anche dopo un fallimento del criterio. Vedi anche:

 falso Facoltativo
enabled

Imposta su true per applicare il criterio.

Imposta su false per disattivare il criterio. Il criterio non verrà applicato anche se rimane collegato a un flusso.

 true Facoltativo
async

Questo attributo è stato ritirato.

 falso Deprecato

Elemento <DisplayName>

Da utilizzare insieme all'attributo name per etichettare il criterio nell'editor proxy dell'interfaccia utente di gestione con un nome diverso in linguaggio naturale.

<DisplayName>Policy Display Name</DisplayName>
Predefinito

N/D

Se ometti questo elemento, viene utilizzato il valore dell'attributo name del criterio.
Presence Facoltativo
Tipo Stringa

Elemento <NameLimits>

Specifica i limiti di caratteri da controllare e applicare in base alla policy.

<NameLimits>
   <Element>10</Element>
   <Attribute>10</Attribute>
   <NamespacePrefix>10</NamespacePrefix>
   <ProcessingInstructionTarget>10</ProcessingInstructionTarget>
</NameLimits>
Predefinito: N/D
Presenza: Facoltativo
Tipo: N/D

Elemento <NameLimits>/<Element>

Specifica un limite al numero massimo di caratteri consentiti in qualsiasi nome di elemento nel documento XML.

Ad esempio, considera il seguente XML:

<book category="WEB">
   <title>Learning XML</title>
   <author>Erik T. Ray</author>
   <year>2003</year>
</book>

Quando analizzi l'XML riportato sopra, il valore dell'elemento <Element> nello snippet del criterio riportato di seguito convalida che i nomi degli elementi (book, title, author e year)) non superino i 10 caratteri.

<NameLimits>
   <Element>10</Element>
   <Attribute>10</Attribute>
   <NamespacePrefix>10</NamespacePrefix>
   <ProcessingInstructionTarget>10</ProcessingInstructionTarget>
</NameLimits>
Predefinito: Se non specifichi un limite, il sistema applica un valore predefinito di -1, che il sistema considera come nessun limite.
Presenza: Facoltativo
Tipo: Numero intero

Elemento <NameLimits>/<Attribute>

Specifica un limite al numero massimo di caratteri consentiti in qualsiasi nome dell'attributo nel documento XML.

Ad esempio, considera il seguente XML:

<book category="WEB">
   <title>Learning XML</title>
   <author>Erik T. Ray</author>
   <year>2003</year>
</book>

Quando analizzi l'XML riportato sopra, il valore dell'elemento <Attribute> nello snippet della norma riportato di seguito convaliderà che il nome dell'attributo category non superi i 10 caratteri.

<NameLimits>
   <Element>10</Element>
   <Attribute>10</Attribute>
   <NamespacePrefix>10</NamespacePrefix>
   <ProcessingInstructionTarget>10</ProcessingInstructionTarget>
</NameLimits>
Predefinito: Se non specifichi un limite, il sistema applica un valore predefinito di -1, che il sistema considera come nessun limite.
Presenza: Facoltativo
Tipo: Numero intero

Elemento <NameLimits>/<NamespacePrefix>

Specifica un limite al numero massimo di caratteri consentiti nel prefisso dello spazio dei nomi nel documento XML.

Ad esempio, considera il seguente XML:

<ns1:myelem xmlns:ns1="http://ns1.com"/>

Quando analizzi l'XML riportato sopra, il valore dell'elemento <NamespacePrefix> nello snippet del criterio riportato di seguito convaliderà che il prefisso dello spazio dei nomi ns1 non superi i 10 caratteri.

<NameLimits>
   <Element>10</Element>
   <Attribute>10</Attribute>
   <NamespacePrefix>10</NamespacePrefix>
   <ProcessingInstructionTarget>10</ProcessingInstructionTarget>
</NameLimits>
Predefinito: Se non specifichi un limite, il sistema applica un valore predefinito di -1, che il sistema considera come nessun limite.
Presenza: Facoltativo
Tipo: Numero intero

Elemento <NameLimits>/<ProcessingInstructionTarget>

Specifica un limite al numero massimo di caratteri consentiti nella destinazione di qualsiasi istruzione di elaborazione nel documento XML.

Ad esempio, considera il seguente XML:

<?xml-stylesheet type="text/xsl" href="style.xsl"?>

Quando analizzi l'XML riportato sopra, il valore dell'elemento <ProcessingInstructionTarget> nel snippet di policy riportato di seguito convalida che la destinazione dell'istruzione di elaborazione xml-stylesheet non superi i 10 caratteri.

<NameLimits>
   <Element>10</Element>
   <Attribute>10</Attribute>
   <NamespacePrefix>10</NamespacePrefix>
   <ProcessingInstructionTarget>10</ProcessingInstructionTarget>
</NameLimits>
Predefinito: Se non specifichi un limite, il sistema applica un valore predefinito di -1, che il sistema considera come nessun limite.
Presenza: Facoltativo
Tipo: Numero intero

Elemento <Source>

Messaggio da analizzare per rilevare attacchi di payload XML. Questo valore è in genere impostato su request, poiché in genere devi convalidare le richieste in entrata dalle app client. Se impostato su message, questo elemento valuterà automaticamente il messaggio di richiesta se collegato al flusso di richiesta e il messaggio di risposta se collegato al flusso di risposta.

<Source>request</Source>
Predefinito: richiesta
Presenza: Facoltativo
Tipo:

Stringa.

Scegli tra request, response o message.

Elemento <StructuralLimits>

Specifica i limiti strutturali da controllare e applicare dalla policy.

<StructureLimits>
   <NodeDepth>5</NodeDepth>
   <AttributeCountPerElement>2</AttributeCountPerElement>
   <NamespaceCountPerElement>3</NamespaceCountPerElement>
   <ChildCount includeComment="true" includeElement="true" includeProcessingInstruction="true" includeText="true">3</ChildCount>
</StructureLimits>
Predefinito: N/D
Presenza: Facoltativo
Tipo: N/D

Elemento <StructuralLimits>/<NodeDepth>

Specifica la profondità massima del nodo consentita nell'XML.

<StructureLimits>
   <NodeDepth>5</NodeDepth>
   <AttributeCountPerElement>2</AttributeCountPerElement>
   <NamespaceCountPerElement>3</NamespaceCountPerElement>
   <ChildCount includeComment="true" includeElement="true" includeProcessingInstruction="true" includeText="true">3</ChildCount>
</StructureLimits>
Predefinito: Se non specifichi un limite, il sistema applica un valore predefinito di -1, che il sistema considera come nessun limite.
Presenza: Facoltativo
Tipo:

Numero intero

Elemento <StructuralLimits>/<AttributeCountPerElement>

Specifica il numero massimo di attributi consentiti per qualsiasi elemento.

Ad esempio, considera il seguente XML:

<book category="WEB">
   <title>Learning XML</title>
   <author>Erik T. Ray</author>
   <year>2003</year>
</book>
Quando analizzi l'XML riportato sopra, il valore dell'elemento <AttributeCountPerElement> nello snippet di policy riportato di seguito convalida che gli elementi book, title, author e year non abbiano più di 2 attributi ciascuno. Tieni presente che gli attributi utilizzati per definire gli spazi dei nomi non vengono conteggiati. 
<StructureLimits>
   <NodeDepth>5</NodeDepth>
   <AttributeCountPerElement>2</AttributeCountPerElement>
   <NamespaceCountPerElement>3</NamespaceCountPerElement>
   <ChildCount includeComment="true" includeElement="true" includeProcessingInstruction="true" includeText="true">3</ChildCount>
</StructureLimits>
Predefinito: Se non specifichi un limite, il sistema applica un valore predefinito di -1, che il sistema considera come nessun limite.
Presenza: Facoltativo
Tipo:

Numero intero

Elemento <StructuralLimits>/<NameSpaceCountPerElement>

Specifica il numero massimo di definizioni di spazi dei nomi consentite per qualsiasi elemento.

Ad esempio, considera il seguente XML:

<e1 attr1="val1" attr2="val2">
    <e2 xmlns="http://apigee.com" xmlns:yahoo="http://yahoo.com" one="1" yahoo:two="2"/>
</e1>

Quando analizzi l'XML riportato sopra, il valore dell'elemento <NamespaceCountPerElement> nel snippet di policy riportato di seguito convaliderà che gli elementi e1 e e2 non abbiano più di 2 definizioni di spazi dei nomi ciascuno. In questo caso, <e1> ha 0 definizioni di spazi dei nomi e <e2> ha 2 definizioni di spazi dei nomi: xmlns="http://apigee.com" e xmlns:yahoo="http://yahoo.com".

<StructureLimits>
   <NodeDepth>5</NodeDepth>
   <AttributeCountPerElement>2</AttributeCountPerElement>
   <NamespaceCountPerElement>3</NamespaceCountPerElement>
   <ChildCount includeComment="true" includeElement="true" includeProcessingInstruction="true" includeText="true">3</ChildCount>
</StructureLimits>
Predefinito: Se non specifichi un limite, il sistema applica un valore predefinito di -1, che il sistema considera come nessun limite.
Presenza: Facoltativo
Tipo:

Numero intero

<StructuralLimits>/<ChildCount> elemento

Specifica il numero massimo di elementi secondari consentiti per qualsiasi elemento.

<StructureLimits>
   <NodeDepth>5</NodeDepth>
   <AttributeCountPerElement>2</AttributeCountPerElement>
   <NamespaceCountPerElement>3</NamespaceCountPerElement>
   <ChildCount includeComment="true" includeElement="true" includeProcessingInstruction="true" includeText="true">3</ChildCount>
</StructureLimits>
Predefinito: Se non specifichi un limite, il sistema applica un valore predefinito di -1, che il sistema considera come nessun limite.
Presenza: Facoltativo
Tipo:

Numero intero

Attributi

Attributo Predefinito Presenza
includeComment true Facoltativo
includeElement true Facoltativo
includeProcessingInstructions true Facoltativo
includeText true Facoltativo

Elemento <ValueLimits>

Specifica i limiti di caratteri per i valori da controllare e applicare in modo forzato dai criteri.

<ValueLimits>
   <Text>15</Text>
   <Attribute>10</Attribute>
   <NamespaceURI>10</NamespaceURI>
   <Comment>10</Comment>
   <ProcessingInstructionData>10</ProcessingInstructionData>
</ValueLimits>
Predefinito: N/D
Presenza: Facoltativo
Tipo:

N/D

Elemento <ValueLimits>/<Text>

Specifica un limite di caratteri per tutti i nodi di testo presenti nel documento XML.

Ad esempio, considera il seguente XML:

<book category="WEB">
   <title>Learning XML</title>
   <author>Erik T. Ray</author>
   <year>2003</year>
</book>
Quando analizzi l'XML riportato sopra, il valore dell'elemento <Text> nello snippet di policy riportato di seguito convaliderà che i valori di testo degli elementi Learning XML, Erik T. Ray, e 2003 non superino i 15 caratteri ciascuno. 
<ValueLimits>
   <Text>15</Text>
   <Attribute>10</Attribute>
   <NamespaceURI>10</NamespaceURI>
   <Comment>10</Comment>
   <ProcessingInstructionData>10</ProcessingInstructionData>
</ValueLimits>
Predefinito: Se non specifichi un limite, il sistema applica un valore predefinito di -1, che il sistema considera come nessun limite.
Presenza: Facoltativo
Tipo:

Numero intero

Elemento <ValueLimits>/<Attribute>

Specifica un limite di caratteri per tutti i valori degli attributi presenti nel documento XML.

Ad esempio, considera il seguente XML:

<book category="WEB">
   <title>Learning XML</title>
   <author>Erik T. Ray</author>
   <year>2003</year>
</book>
Quando analizzi l'XML riportato sopra, il valore dell'elemento <Attribute> nello snippet del criterio riportato di seguito convalida che il valore dell'attributo WEB non superi i 10 caratteri. 
<ValueLimits>
   <Text>15</Text>
   <Attribute>10</Attribute>
   <NamespaceURI>10</NamespaceURI>
   <Comment>10</Comment>
   <ProcessingInstructionData>10</ProcessingInstructionData>
</ValueLimits>
Predefinito: Se non specifichi un limite, il sistema applica un valore predefinito di -1, che il sistema considera come nessun limite.
Presenza: Facoltativo
Tipo:

Numero intero

Elemento <ValueLimits>/<NamespaceURI>

Specifica un limite di caratteri per gli URI dello spazio dei nomi presenti nel documento XML.

Ad esempio, considera il seguente XML:

<ns1:myelem xmlns:ns1="http://ns1.com"/>
Quando analizzi l'XML riportato sopra, il valore dell'elemento <NamespaceURI> nello snippet del criterio riportato di seguito convalida che il valore dell'URI dello spazio dei nomi http://ns1.com non superi 10 caratteri. 
<ValueLimits>
   <Text>15</Text>
   <Attribute>10</Attribute>
   <NamespaceURI>10</NamespaceURI>
   <Comment>10</Comment>
   <ProcessingInstructionData>10</ProcessingInstructionData>
</ValueLimits>
Predefinito: Se non specifichi un limite, il sistema applica un valore predefinito di -1, che il sistema considera come nessun limite.
Presenza: Facoltativo
Tipo:

Numero intero

Elemento <ValueLimits>/<Comment>

Specifica un limite di caratteri per eventuali commenti presenti nel documento XML.

Ad esempio, considera il seguente XML:

<book category="WEB">
   <!-- This is a comment -->
   <title>Learning XML</title>
   <author>Erik T. Ray</author>
   <year>2003</year>
</book>
Quando analizzi l'XML riportato sopra, il valore dell'elemento <Comment> nello snippet di policy riportato di seguito convalida che il testo del commento This is a comment non superi i 10 caratteri. 
<ValueLimits>
   <Text>15</Text>
   <Attribute>10</Attribute>
   <NamespaceURI>10</NamespaceURI>
   <Comment>10</Comment>
   <ProcessingInstructionData>10</ProcessingInstructionData>
</ValueLimits>
Predefinito: Se non specifichi un limite, il sistema applica un valore predefinito di -1, che il sistema considera come nessun limite.
Presenza: Facoltativo
Tipo:

Numero intero

Elemento <ValueLimits>/<ProcessingInstructionData>

Specifica un limite di caratteri per qualsiasi testo di istruzioni di elaborazione presente nel documento XML.

Ad esempio, considera il seguente XML:

<?xml-stylesheet type="text/xsl" href="style.xsl"?>
Quando analizzi l'XML riportato sopra, il valore dell'elemento <ProcessingInstructionData> nel frammento di criterio riportato di seguito convalida che il testo dell'istruzione di elaborazione type="text/xsl" href="style.xsl" non superi i 10 caratteri. 
<ValueLimits>
   <Text>15</Text>
   <Attribute>10</Attribute>
   <NamespaceURI>10</NamespaceURI>
   <Comment>10</Comment>
   <ProcessingInstructionData>10</ProcessingInstructionData>
</ValueLimits>
Predefinito: Se non specifichi un limite, il sistema applica un valore predefinito di -1, che il sistema considera come nessun limite.
Presenza: Facoltativo
Tipo:

Numero intero

Messaggi di errore

This section describes the fault codes and error messages that are returned and fault variables that are set by Apigee when this policy triggers an error. This information is important to know if you are developing fault rules to handle faults. To learn more, see What you need to know about policy errors and Handling faults.

Runtime errors

These errors can occur when the policy executes.

Fault code HTTP status Cause Fix
steps.xmlthreatprotection.ExecutionFailed 500 The XMLThreatProtection policy can throw many different types of ExecutionFailed errors. Most of these errors occur when a specific threshold set in the policy is exceeded. These types of errors include: element name length, child count, node depth, attribute count, attribute name length, and many others. You can see the complete list in the XMLThreatProtection policy runtime error troubleshooting topic.
steps.xmlthreatprotection.InvalidXMLPayload 500 This error occurs if the input message payload specified by the XMLThreatProtection policy's <Source> element is not a valid XML Document.
steps.xmlthreatprotection.SourceUnavailable 500 This error occurs if the message variable specified in the <Source> element is either:
  • Out of scope (not available in the specific flow where the policy is being executed)
  • Is not one of the valid values request, response, or message
steps.xmlthreatprotection.NonMessageVariable 500 This error occurs if the <Source> element is set to a variable which is not of type message.

Deployment errors

None.

Fault variables

These variables are set when a runtime error occurs. For more information, see What you need to know about policy errors.

Variables Where Example
fault.name="fault_name" fault_name is the name of the fault, as listed in the Runtime errors table above. The fault name is the last part of the fault code. fault.name Matches "SourceUnavailable"
xmlattack.policy_name.failed policy_name is the user-specified name of the policy that threw the fault. xmlattack.XPT-SecureRequest.failed = true

Example error response

{
  "fault": {
    "faultstring": "XMLThreatProtection[XPT-SecureRequest]: Execution failed. reason: XMLThreatProtection[XTP-SecureRequest]: Exceeded object entry name length at line 2",
    "detail": {
      "errorcode": "steps.xmlthreatprotection.ExecutionFailed"
    }
  }
}

Example fault rule

<FaultRule name="XML Threat Protection Policy Faults">
    <Step>
        <Name>AM-CustomErrorResponse</Name>
        <Condition>(fault.name Matches "ExecutionFailed") </Condition>
    </Step>
    <Condition>(xmlattack.XPT-SecureRequest.failed = true) </Condition>
</FaultRule>

Schemi

Note sull'utilizzo

Qualsiasi server che riceve dati online è soggetto ad attacchi, intenzionali o meno. Alcuni attacchi sfruttano la flessibilità di XML creando documenti non validi che hanno il potenziale di compromettere i sistemi di backend. I documenti XML danneggiati o estremamente complessi possono far sì che i server allocchino più memoria di quella disponibile, vincolando le risorse di CPU e memoria, causando l'arresto anomalo dei parser e disattivando in generale l'elaborazione dei messaggi e creando attacchi di negazione del servizio a livello di applicazione.

Errore di configurazione della protezione dalle minacce

Informazioni importanti se stai creando FaultRules per questa norma: per impostazione predefinita, Apigee genera un codice di stato HTTP 500 Internal Server Error e un codice di errore ExecutionFailed se un messaggio non supera una norma di protezione dalle minacce JSON o XML. Puoi modificare questo comportamento di errore con una nuova proprietà a livello di organizzazione. Quando imposti la proprietà dell'organizzazione features.isPolicyHttpStatusEnabled su true, si verifica il seguente comportamento:

  • Richiesta: con una policy di protezione dalle minacce allegata a qualsiasi flusso di richieste, i messaggi non validi restituiscono un codice di stato 400 Bad Request, insieme a un codice di errore della policy corrispondente (anziché solo ExecutionFailed).
  • Risposta: con un criterio di protezione dalle minacce allegato a qualsiasi flusso di risposta, i messaggi non validi restituiscono comunque un codice di stato 500 Internal Server Error e viene generato uno dei codici di errore del criterio corrispondenti (anziché solo ExecutionFailed).

I clienti cloud devono contattare l'assistenza clienti Google Cloud per impostare la proprietà dell'organizzazione.

curl -u email:password -X POST -H "Content-type:application/xml" http://host:8080/v1/o/myorg -d \
"<Organization type="trial" name="MyOrganization">
    <Environments/>
    <Properties>
        <Property name="features.isPolicyHttpStatusEnabled">true</Property>
        ...
    </Properties>
</Organization>"

Argomenti correlati

Policy di protezione dalle minacce JSON

Norme di protezione delle espressioni regolari