Política XMLThreatProtection

Estás viendo la documentación de Apigee Edge.
Ve a la Documentación de Apigee X. información

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 deXML mediante los siguientes enfoques:

• Valida mensajes en un esquema XML (.xsd)
• Evaluarel 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

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:

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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

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>

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>

Atributos

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>

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>

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

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>

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

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

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

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>

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

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

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

Referencia de errores

En esta sección, se describen los códigos y mensajes de error que se muestran, y las variables de falla que establece Edge 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.

Notas:

• El nombre del error ExecutionFailed es el predeterminado y se mostrará sin importar el tipo de error detectado. Sin embargo, este valor predeterminado se puede cambiar si configuras una propiedad a nivel de la organización. Cuando se configura esta propiedad, el nombre del error reflejará el error real. Por ejemplo, “TextExceeded” o “AttrValueExceeded”. Consulta Notas de uso para obtener más detalles.
• El estado HTTP 500 es el predeterminado. Sin embargo, el estado HTTP se puede cambiar a 400 para fallas en el flujo de solicitudes mediante la configuración de una propiedad a nivel de la organización. Consulta Notas de uso para obtener más detalles.

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.

Ejemplo de respuesta de error

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

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 De forma predeterminada, Edge muestra un código de estado HTTP 500 Internal Server Error y un error ExecutionFailed código si un mensaje supera una política de protección contra amenazas 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 Edge para establecer la propiedad de la organización.

Temas relacionados

Política de protección contra amenazas de JSON

Política de protección de expresiones regulares