Política XMLThreatProtection

Esta página se aplica a Apigee y Apigee Hybrid.

Consulta la documentación de Apigee Edge.

Qué

Aborda las vulnerabilidades deXML y minimiza los ataques en la API. De manera opcional, detecta los ataques de carga útil deXML en función de los límites configurados. Detecta amenazas contra XML mediante los siguientes enfoques:

• Evalúa el contenido de los mensajes en busca de palabras clave o patrones específicos para excluir
• Detectar mensajes dañados o con errores de formato antes de que se analicen

Nota: esta política se ejecuta solo si el Content-Type de la solicitud o el encabezado de respuesta se establece en application/xml.

Esta política es una política extensible, y el uso de esta puede tener implicaciones de costo o uso, según tu licencia de Apigee. Para obtener información sobre los tipos de políticas y sus implicaciones de uso, consulta Tipos de políticas.

Mira un video breve sobre la protección contra amenazas

Video: Mira un video breve sobre las políticas de protección contra amenazas de la serie de videos de cuatro minutos para desarrolladores (4MV4D).

Referencia del elemento

En la referencia del elemento, se describen los elementos y atributos de la política 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>

Atributos <XMLThreatProtection>

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

En la siguiente tabla, se describen los atributos que son comunes a todos los elementos principales de las políticas:

Atributo	Descripción	Predeterminado	Presencia
name	El nombre interno de la política. El valor del atributo name puede contener letras, números, espacios, guiones, guiones bajos y puntos. Este valor no puede superar los 255 caracteres. De forma opcional, usa el elemento <DisplayName> para etiquetar la política en el editor de proxy de la IU de administración con un nombre de lenguaje natural diferente.	N/A	Obligatorio
continueOnError	Configúralo como false para mostrar un error cuando una política falla. Este es el comportamiento previsto para la mayoría de las políticas. Configúralo como true para continuar con la ejecución del flujo incluso después de que una política falle. También consulta lo siguiente: Las reglas de fallas se activan SOLAMENTE en un estado de error (sobre el continueOnError) Controla fallas dentro del flujo actual	falso	Opcional
enabled	Configúralo como true para aplicar la política. Configúralo como false para desactivar la política. La política no se aplicará incluso si permanece adjunta a un flujo.	true	Opcional
async	Este atributo dejó de estar disponible.	falso	Obsoleta

Elemento <DisplayName>

Se usan además del atributo name para etiquetar la política en el editor de proxy de la IU de administración con un nombre de lenguaje natural diferente.

<DisplayName>Policy Display Name</DisplayName>

Predeterminada	N/A Si omites este elemento, se usa el valor del atributo name de la política.
Presencia	Opcional
Tipo	String

Elemento <NameLimits>

Especifica los límites de caracteres que la política debe verificar y aplicar.

<NameLimits>
   <Element>10</Element>
   <Attribute>10</Attribute>
   <NamespacePrefix>10</NamespacePrefix>
   <ProcessingInstructionTarget>10</ProcessingInstructionTarget>
</NameLimits>

Predeterminado:	N/A
Presencia:	Opcional
Tipo:	N/A

Elemento <NameLimits>/<Element>

Especifica un límite para la cantidad máxima de caracteres permitida en cualquier nombre de elemento en el documento XML.

Por ejemplo, considera el siguiente XML:

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

Cuando se analiza el XML anterior, el valor del elemento <Element> en el fragmento de política a continuación validará esos nombres de elementos (book, title, author y year) no exceden los 10 caracteres).

<NameLimits>
   <Element>10</Element>
   <Attribute>10</Attribute>
   <NamespacePrefix>10</NamespacePrefix>
   <ProcessingInstructionTarget>10</ProcessingInstructionTarget>
</NameLimits>

Predeterminado:	Si no especificas un límite, el sistema aplica un valor predeterminado de -1, que el sistema considera como ningún límite.
Presencia:	Opcional
Tipo:	Entero

Elemento <NameLimits>/<Attribute>

Especifica un límite para la cantidad máxima de caracteres permitida en cualquier nombre de atributo en el documento XML.

Por ejemplo, considera el siguiente XML:

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

Cuando se analiza el XML anterior, el valor del elemento <Attribute> en el fragmento de política a continuación validará que el nombre del atributo category no supere los 10 caracteres.

<NameLimits>
   <Element>10</Element>
   <Attribute>10</Attribute>
   <NamespacePrefix>10</NamespacePrefix>
   <ProcessingInstructionTarget>10</ProcessingInstructionTarget>
</NameLimits>

Predeterminado:	Si no especificas un límite, el sistema aplica un valor predeterminado de -1, que el sistema considera como ningún límite.
Presencia:	Opcional
Tipo:	Entero

Elemento <NameLimits>/<NamespacePrefix>

Especifica un límite para la cantidad máxima de caracteres permitida en el prefijo del espacio de nombres en el documento XML.

Por ejemplo, considera el siguiente XML:

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

Cuando se analiza el XML anterior, el valor del elemento <NamespacePrefix> en el fragmento de política a continuación validará que el prefijo de espacio de nombres ns1 no supere los 10 caracteres.

<NameLimits>
   <Element>10</Element>
   <Attribute>10</Attribute>
   <NamespacePrefix>10</NamespacePrefix>
   <ProcessingInstructionTarget>10</ProcessingInstructionTarget>
</NameLimits>

Predeterminado:	Si no especificas un límite, el sistema aplica un valor predeterminado de -1, que el sistema considera como ningún límite.
Presencia:	Opcional
Tipo:	Entero

Elemento <NameLimits>/<ProcessingInstructionTarget>

Especifica un límite para la cantidad máxima de caracteres permitida en el objetivo de cualquier instrucción de procesamiento en el documento XML.

Por ejemplo, considera el siguiente XML:

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

Cuando se analiza el XML anterior, el valor del elemento <ProcessingInstructionTarget> en el fragmento de política a continuación validará que el objetivo de instrucción de procesamiento xml-stylesheet no supere los 10 caracteres.

<NameLimits>
   <Element>10</Element>
   <Attribute>10</Attribute>
   <NamespacePrefix>10</NamespacePrefix>
   <ProcessingInstructionTarget>10</ProcessingInstructionTarget>
</NameLimits>

Predeterminado:	Si no especificas un límite, el sistema aplica un valor predeterminado de -1, que el sistema considera como ningún límite.
Presencia:	Opcional
Tipo:	Entero

Elemento <Source>

Mensaje que se validará para los ataques de carga útil de XML. Normalmente, este se configura como request, ya que, por lo general, deberás validar las solicitudes entrantes de las apps cliente. Cuando se configura como message, este elemento evaluará de manera automática el mensaje de solicitud cuando se adjunta al flujo de solicitudes y el mensaje de respuesta cuando se adjunta al flujo de respuesta.

<Source>request</Source>

Predeterminado:	solicitud
Presencia:	Opcional
Tipo:	String. Selecciona entre request, response o message.

Elemento <StructuralLimits>

Especifica los límites estructurales que la política debe verificar y aplicar.

<StructureLimits>
   <NodeDepth>5</NodeDepth>
   <AttributeCountPerElement>2</AttributeCountPerElement>
   <NamespaceCountPerElement>3</NamespaceCountPerElement>
   <ChildCount includeComment="true" includeElement="true" includeProcessingInstruction="true" includeText="true">3</ChildCount>
</StructureLimits>

Predeterminado:	N/A
Presencia:	Opcional
Tipo:	N/A

Elemento <StructuralLimits>/<NodeDepth>

Especifica la profundidad de nodo máxima permitida en el archivo XML.

<StructureLimits>
   <NodeDepth>5</NodeDepth>
   <AttributeCountPerElement>2</AttributeCountPerElement>
   <NamespaceCountPerElement>3</NamespaceCountPerElement>
   <ChildCount includeComment="true" includeElement="true" includeProcessingInstruction="true" includeText="true">3</ChildCount>
</StructureLimits>

Predeterminado:	Si no especificas un límite, el sistema aplica un valor predeterminado de -1, que el sistema considera como ningún límite.
Presencia:	Opcional
Tipo:	Entero

Elemento <StructuralLimits>/<AttributeCountPerElement>

Especifica la cantidad máxima de atributos permitidos para cualquier elemento.

Por ejemplo, considera el siguiente XML:

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

Cuando se analiza el XML anterior, el valor del elemento <AttributeCountPerElement> en el fragmento de política que se muestra a continuación validará que los elementos book, title, author y year no tengan más de 2 atributos cada uno. Ten en cuenta que los atributos utilizados para definir espacios de nombres no se cuentan.

<StructureLimits>
   <NodeDepth>5</NodeDepth>
   <AttributeCountPerElement>2</AttributeCountPerElement>
   <NamespaceCountPerElement>3</NamespaceCountPerElement>
   <ChildCount includeComment="true" includeElement="true" includeProcessingInstruction="true" includeText="true">3</ChildCount>
</StructureLimits>

Predeterminado:	Si no especificas un límite, el sistema aplica un valor predeterminado de -1, que el sistema considera como ningún límite.
Presencia:	Opcional
Tipo:	Entero

Elemento <StructuralLimits>/<NameSpaceCountPerElement>

Especifica la cantidad máxima de definiciones de espacios de nombres permitidas para cualquier elemento.

Por ejemplo, considera el siguiente XML:

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

Cuando se analiza el XML anterior, el valor del elemento <NamespaceCountPerElement> en el fragmento de política que se muestra a continuación validará que los elementos e1 y e2 no tengan más de 2 definiciones de espacios de nombres cada uno. En este caso, <e1> tiene 0 definiciones de espacios de nombres y <e2> tiene 2 definiciones de espacios de nombres: xmlns="http://apigee.com" y 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>

Predeterminado:	Si no especificas un límite, el sistema aplica un valor predeterminado de -1, que el sistema considera como ningún límite.
Presencia:	Opcional
Tipo:	Entero

Elemento <StructuralLimits>/<ChildCount>

Especifica la cantidad máxima de elementos secundarios que se permiten para cualquier elemento.

<StructureLimits>
   <NodeDepth>5</NodeDepth>
   <AttributeCountPerElement>2</AttributeCountPerElement>
   <NamespaceCountPerElement>3</NamespaceCountPerElement>
   <ChildCount includeComment="true" includeElement="true" includeProcessingInstruction="true" includeText="true">3</ChildCount>
</StructureLimits>

Predeterminado:	Si no especificas un límite, el sistema aplica un valor predeterminado de -1, que el sistema considera como ningún límite.
Presencia:	Opcional
Tipo:	Entero

Atributos

Atributo	Predeterminada	Presencia
includeComment	true	Opcional
includeElement	true	Opcional
includeProcessingInstructions	true	Opcional
includeText	true	Opcional

Elemento <ValueLimits>

Especifica los límites de caracteres para los valores que la política revisará y aplicará.

<ValueLimits>
   <Text>15</Text>
   <Attribute>10</Attribute>
   <NamespaceURI>10</NamespaceURI>
   <Comment>10</Comment>
   <ProcessingInstructionData>10</ProcessingInstructionData>
</ValueLimits>

Predeterminado:	N/A
Presencia:	Opcional
Tipo:	N/A

Elemento <ValueLimits>/<Text>

Especifica un límite de caracteres para cualquier nodo de texto presente en el documento XML.

Por ejemplo, considera el siguiente XML:

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

Cuando se analiza el XML anterior, el valor del elemento <Text> en el fragmento de política incluido a continuación validará que los valores de texto del elemento Learning XML, Erik T. Ray, y 2003 no excedan los 15 caracterescada uno.

<ValueLimits>
   <Text>15</Text>
   <Attribute>10</Attribute>
   <NamespaceURI>10</NamespaceURI>
   <Comment>10</Comment>
   <ProcessingInstructionData>10</ProcessingInstructionData>
</ValueLimits>

Predeterminado:	Si no especificas un límite, el sistema aplica un valor predeterminado de -1, que el sistema considera como ningún límite.
Presencia:	Opcional
Tipo:	Entero

Elemento <ValueLimits>/<Attribute>

Especifica un límite de caracteres para los valores de atributos presentes en el documento XML.

Por ejemplo, considera el siguiente XML:

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

Cuando se analiza el XML anterior, el valor del elemento <Attribute> en el fragmento de política incluido a continuación validará que el valor del atributo WEB no supere los 10 caracteres.

<ValueLimits>
   <Text>15</Text>
   <Attribute>10</Attribute>
   <NamespaceURI>10</NamespaceURI>
   <Comment>10</Comment>
   <ProcessingInstructionData>10</ProcessingInstructionData>
</ValueLimits>

Predeterminado:	Si no especificas un límite, el sistema aplica un valor predeterminado de -1, que el sistema considera como ningún límite.
Presencia:	Opcional
Tipo:	Entero

Elemento <ValueLimits>/<NamespaceURI>

Especifica un límite de caracteres para cualquier URI de espacio de nombres presente en el documento XML.

Por ejemplo, considera el siguiente XML:

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

Cuando se analiza el XML anterior, el valor del elemento <NamespaceURI> en el fragmento de política incluido a continuación validará que el valor de URI de espacio de nombres http://ns1.com no supere los 10 caracteres.

<ValueLimits>
   <Text>15</Text>
   <Attribute>10</Attribute>
   <NamespaceURI>10</NamespaceURI>
   <Comment>10</Comment>
   <ProcessingInstructionData>10</ProcessingInstructionData>
</ValueLimits>

Predeterminado:	Si no especificas un límite, el sistema aplica un valor predeterminado de -1, que el sistema considera como ningún límite.
Presencia:	Opcional
Tipo:	Entero

Elemento <ValueLimits>/<Comment>

Especifica un límite de caracteres para cualquier comentario presente en el documento XML.

Por ejemplo, considera el siguiente XML:

<book category="WEB">
   <!-- This is a comment -->
   <title>Learning XML</title>
   <author>Erik T. Ray</author>
   <year>2003</year>
</book>

Al analizar el XML anterior, el elemento <Comment> en el fragmento de política que aparece a continuación validará que el texto del comentario This is a comment no exceda los 10 caracteres.

<ValueLimits>
   <Text>15</Text>
   <Attribute>10</Attribute>
   <NamespaceURI>10</NamespaceURI>
   <Comment>10</Comment>
   <ProcessingInstructionData>10</ProcessingInstructionData>
</ValueLimits>

Predeterminado:	Si no especificas un límite, el sistema aplica un valor predeterminado de -1, que el sistema considera como ningún límite.
Presencia:	Opcional
Tipo:	Entero

Elemento <ValueLimits>/<ProcessingInstructionData>

Especifica un límite de caracteres para cualquier texto de instrucción de procesamiento presente en el documento XML.

Por ejemplo, considera el siguiente XML:

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

Cuando se analiza el XML anterior, el valor del elemento <ProcessingInstructionData> en el fragmento de política incluidoa continuación validará que el texto de instrucción de procesamiento type="text/xsl" href="style.xsl" no supere los 10 caracteres.

<ValueLimits>
   <Text>15</Text>
   <Attribute>10</Attribute>
   <NamespaceURI>10</NamespaceURI>
   <Comment>10</Comment>
   <ProcessingInstructionData>10</ProcessingInstructionData>
</ValueLimits>

Predeterminado:	Si no especificas un límite, el sistema aplica un valor predeterminado de -1, que el sistema considera como ningún límite.
Presencia:	Opcional
Tipo:	Entero

Referencia de errores

Nota:esta política se ejecuta solo si el Content-Type de la solicitud o el encabezado de respuesta se establece en application/xml.

.

En esta sección, se describen los códigos de falla y los mensajes de error que se muestran, y las variables de falla que establece Apigee cuando esta política activa un error. Esta información es importante para saber si estás desarrollando reglas de fallas con el propósito de manejar fallas. Para obtener más información, consulta Qué debes saber sobre los errores de políticas y Cómo solucionar fallas.

Errores de entorno de ejecución

Estos errores pueden producirse cuando se ejecuta la política.

Código de falla	Estado de HTTP	Causa	Corregir
steps.xmlthreatprotection.ExecutionFailed	500	La política XMLThreatProtection puede generar muchos tipos de errores ExecutionFailed. La mayoría de estos errores se generan cuando se supera un límite específico establecido en la política. Estos tipos de errores incluyen: la longitud del nombre del elemento, el recuento secundario, profundidad del nodo, el recuento de atributos, la longitud del nombre del atributo y entre otros. Puedes ver la lista completa en el artículo Solución de problemas de errores del entorno de ejecución de la política XMLThreatProtection.
steps.xmlthreatprotection.InvalidXMLPayload	500	Este error se genera si la carga útil del mensaje de entrada que especifica el elemento <Source> de la política XMLThreatProtection no es un documento XML válido.
steps.xmlthreatprotection.SourceUnavailable	500	Este error se genera si la variable mensaje especificada en el elemento <Source>: Está fuera del alcance (no está disponible en el flujo específico en el que se ejecuta la política) o No es uno de los valores válidos request, response o message.
steps.xmlthreatprotection.NonMessageVariable	500	Este error se genera si el elemento <Source> se configura como una variable que no es del tipo mensaje.

Errores en la implementación

Ninguno

Variables con fallas

Estas variables se configuran cuando se genera un error de entorno de ejecución. Para obtener más información, consulta Qué debes saber sobre los errores de la política.

Variables	Donde	Ejemplo
fault.name="fault_name"	fault_name es el nombre de la falla, como se indica en la tabla de Errores del entorno de ejecución anterior. El nombre de la falla es la última parte del código de la falla.	fault.name Matches "SourceUnavailable"
xmlattack.policy_name.failed	policy_name es el nombre especificado por el usuario de la política que generó la falla.	xmlattack.XPT-SecureRequest.failed = true

Ejemplo de respuesta de error

Nota: Para controlar errores, se recomienda capturar la parte errorcode de la respuesta de error. No dependas del texto en la faultstring, ya que podría cambiar.

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

Ejemplo de regla de falla

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

Esquemas

Muestra: Consulta nuestros repositorios de GitHub para ver los esquemas más recientes.

Notas de uso

Cualquier servidor que recibe datos en línea está sujeto a ataques, ya sea maliciosos o no intencionales. Algunos ataques aprovechan la flexibilidad de XML y crean documentos no válidos que tienen el potencial de vulnerar sistemas de backend. Los documentos XML dañados o extremadamente complejos pueden hacer que los servidores asignen más memoria de la que está disponible y se vinculen los recursos de CPU y memoria, haya fallas en los analizadores y, generalmente, se inhabilite el procesamiento de mensajes y la creación de ataques de denegación del servicio a nivel de app.

Configuración de errores de protección contra amenazas

Información importante si creas FaultRules para esta política: de forma predeterminada, Apigee arroja un código de estado de error interno del servidor HTTP 500 y un código de error ExecutionFailed si un mensaje no pasa una política de protección contra amenazas de JSON o XML. Puedes cambiar ese comportamiento de error con una nueva propiedad a nivel de la organización. Cuando se configura la propiedad de la organización features.isPolicyHttpStatusEnabled como verdadera, se produce el siguiente comportamiento:

• Solicitud: si hay una política de protección contra amenazas vinculada a cualquier flujo de solicitud, los mensajes no válidos muestran un código de estado 400 de solicitud incorrecta, junto con un código de error de política correspondiente (en lugar de solo ExecutionFailed).
• Respuesta: con una política de protección contra amenazas vinculada a cualquier flujo de respuesta, los mensajes no válidos continúan mostrando un código de estado de error interno del servidor 500, y se genera uno de los códigos de error de la política correspondiente (en lugar de solo ExecutionFailed).

Los clientes de Cloud deben comunicarse con el equipo de Asistencia de Apigee para configurar la propiedad de la organización.

Advertencia:Cuando realices una solicitud PUT para actualizar las propiedades de la organización, asegúrate de incluir todas las propiedades existentes en la llamada a fin de evitar que se descarten.

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

Temas relacionados

Política de protección contra amenazas de JSON

Política de protección de expresiones regulares