Política JSONThreatProtection

Política extensible

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

Consulta la documentación de Apigee Edge.

Las APIs que aceptan cargas útiles de JSON son vulnerables a ataques maliciosos diseñados para sobrecargar el analizador de JSON. Estos ataques pueden incluir cargas útiles con una cantidad excesiva de elementos de array, estructuras anidadas de forma profunda o cadenas increíblemente largas, lo que puede provocar que el servicio falle o consuma una cantidad excesiva de memoria.

La política JSONThreatProtection minimiza este riesgo, ya que analiza las solicitudes entrantes en busca de cargas útiles que incumplan los límites definidos en estructuras como arrays y cadenas, lo que protege de manera eficaz tus servicios de backend de estos ataques de denegación de servicio o de análisis.

.

Esta política es una política extensible, y el uso de esta política 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.

Referencia del elemento

En la referencia del elemento, se describen los elementos y atributos de la política JSONThreatProtection.

<JSONThreatProtection async="false" continueOnError="false" enabled="true" name="JSON-Threat-Protection-1">
   <DisplayName>JSONThreatProtection 1</DisplayName>
   <ArrayElementCount>20</ArrayElementCount>
   <ContainerDepth>10</ContainerDepth>
   <ObjectEntryCount>15</ObjectEntryCount>
   <ObjectEntryNameLength>50</ObjectEntryNameLength>
   <Source>request</Source>
   <StringValueLength>500</StringValueLength>
</JSONThreatProtection>

Atributos <JSONThreatProtection>

<JSONThreatProtection async="false" continueOnError="false" enabled="true" name="JSON-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 Configuración predeterminada Presence
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:

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

false Obsoleto

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>
Configuración predeterminada

N/A

Si omites este elemento, se usa el valor del atributo name de la política.

Presence Opcional
Tipo String

Elemento <ArrayElementCount>

Especifica la cantidad máxima de elementos permitidos en un arreglo.

<ArrayElementCount>20</ArrayElementCount>
Predeterminado: Si no especificas este elemento o si especificas un número entero negativo, el sistema no aplica un límite.
Presencia: Opcional
Tipo: Entero

Elemento <ContainerDepth>

Especifica la profundidad de contención máxima permitida, en la que los contenedores son objetos o arreglos. Por ejemplo, un arreglo que contiene un objeto que tiene un objeto daría como resultado una profundidad de contención de 3.

<ContainerDepth>10</ContainerDepth>
Predeterminado: Si no especificas este elemento o si especificas un número entero negativo, el sistema no aplica ningún límite.
Presencia: Opcional
Tipo: Entero

Elemento <ObjectEntryCount>

Especifica la cantidad máxima de entradas permitidas en un objeto.

<ObjectEntryCount>15</ObjectEntryCount>
Predeterminado: Si no especificas este elemento o si especificas un número entero negativo, el sistema no aplica ningún límite.
Presencia: Opcional
Tipo: Entero

Elemento <ObjectEntryNameLength>

Especifica la longitud máxima de string permitida para un nombre de propiedad dentro de un objeto.

<ObjectEntryNameLength>50</ObjectEntryNameLength>
Predeterminado: Si no especificas este elemento o si especificas un número entero negativo, el sistema no aplica un límite.
Presencia: Opcional
Tipo: Entero

Elemento <Source>

Mensaje que se validará para los ataques de carga útil de JASON. 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.

Valores válidos: solicitud, respuesta o mensaje.

Elemento <StringValueLength>

Especifica la longitud máxima permitida para un valor de string.

<StringValueLength>500</StringValueLength>
Predeterminado: Si no especificas este elemento o si especificas un número entero negativo, el sistema no aplica un límite.
Presencia: Opcional
Tipo: Entero

Referencia de errores

.

En esta sección se describen los códigos de error y los mensajes de error que se devuelven, así como las variables de error que define Apigee cuando esta política activa un error. Es importante conocer esta información si vas a desarrollar reglas de errores para gestionarlos. Para obtener más información, consulta Qué debes saber sobre los errores de políticas y Cómo gestionar los fallos.

Errores de tiempo de ejecución

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

Código de fallo Estado de HTTP Causa Solucionar
steps.jsonthreatprotection.ExecutionFailed 500 La política JSONThreatProtection puede generar muchos tipos distintos de errores ExecutionFailed. La mayoría de estos errores se producen cuando se supera un umbral específico establecido en la política. Estos tipos de errores incluyen los siguientes: longitud del nombre de la entrada del objeto, número de entradas del objeto, número de elementos del array, profundidad del contenedor, longitud del valor de la cadena. Este error también se produce cuando la carga útil contiene un objeto JSON no válido.
steps.jsonthreatprotection.SourceUnavailable 500 Este error se produce si la variable message especificada en el elemento <Source> es:
  • Fuera del ámbito (no disponible en el flujo específico en el que se está ejecutando la política)
  • No es uno de los valores válidos request, response o message
steps.jsonthreatprotection.NonMessageVariable 500 Este error se produce si el elemento <Source> se asigna a una variable que no es del tipo message.

Errores de implementación

Ninguno

Variables de error

Estas variables se definen cuando esta política activa un error. Para obtener más información, consulta el artículo Información sobre los errores de las políticas.

Variables Dónde Ejemplo
fault.name="fault_name" fault_name es el nombre del fallo, tal como se indica en la tabla Errores de tiempo de ejecución de arriba. El nombre del error es la última parte del código de error. fault.name Matches "SourceUnavailable"
jsonattack.policy_name.failed policy_name es el nombre de la política especificado por el usuario que ha provocado el error. jsonattack.JTP-SecureRequest.failed = true

Ejemplo de respuesta de error

{
  "fault": {
    "faultstring": "JSONThreatProtection[JPT-SecureRequest]: Execution failed. reason: JSONThreatProtection[JTP-SecureRequest]: Exceeded object entry name length at line 2",
    "detail": {
      "errorcode": "steps.jsonthreatprotection.ExecutionFailed"
    }
  }
}

Regla de fallo de ejemplo

<FaultRule name="JSONThreatProtection Policy Faults">
    <Step>
        <Name>AM-CustomErrorResponse</Name>
        <Condition>(fault.name Matches "ExecutionFailed") </Condition>
    </Step>
    <Condition>(jsonattack.JPT-SecureRequest.failed = true) </Condition>
</FaultRule>

Esquemas

Notas de uso

Al igual que los servicios basados en XML, las API que admiten la notación de objetos de JavaScript (JSON) son vulnerables a los ataques a nivel de contenido. Los ataques JSON simples intentan usar estructuras que sobrecarguen los analizadores de JSON para hacer fallar un servicio e inyectar ataques de denegación del servicio a nivel de la aplicación. Todas las opciones de configuración son opcionales y se deben ajustar para optimizar los requisitos de tu servicio contra posibles vulnerabilidades.

Temas relacionados

Política JSONtoXML

Política XMLThreatProtection

Política RegularExpressionProtection