Política JSONThreatProtection

Esta é a documentação do Apigee Edge.
Acesse Documentação da Apigee X. informações

O que

Minimize os riscos apresentados por ataques no nível de conteúdo, permitindo que você especifique limites em várias estruturas JSON, como matrizes e strings.

Vídeo: assista a um breve vídeo para saber mais sobre como a política JSONThreatProtection permite que você proteja APIs contra ataques no nível do conteúdo.

Vídeo: confira este vídeo curto sobre a plataforma de API entre nuvens da Apigee.

Referência de elemento

A referência do elemento descreve os elementos e atributos da 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 <JSONThreaProtection>

<JSONThreatProtection async="false" continueOnError="false" enabled="true" name="JSON-Threat-Protection-1">

A tabela a seguir descreve atributos comuns a todos os elementos pai de políticas:

Atributo Descrição Padrão Presença
name

O nome interno da política. O valor do atributo name pode conter letras, números, espaços, hifens, sublinhados e pontos. Esse valor não pode exceder 255 caracteres.

Opcionalmente, use o elemento <DisplayName> para rotular a política no editor de proxy da IU de gerenciamento com um nome de linguagem natural diferente.

 N/A Obrigatório
continueOnError

Defina como false para retornar um erro quando uma política falhar. Esse é o comportamento esperado na maioria das políticas.

Defina como true para que a execução do fluxo continue, mesmo depois que uma política falhar.

 falso Opcional
enabled

Defina como true para aplicar a política.

Defina como false para desativar a política. A política não será aplicada mesmo se ela permanecer anexada a um fluxo.

 true Opcional
async

Esse atributo está obsoleto.

 falso Obsoleto

Elemento <DisplayName>

Use em conjunto com o atributo name para rotular a política no editor de proxy da IU de gerenciamento com um nome de linguagem natural diferente.

<DisplayName>Policy Display Name</DisplayName>
Padrão

N/A

Se você omitir esse elemento, será usado o valor do atributo name da política.
Presença Opcional
Tipo String

Elemento <ArrayElementCount>

Especifica o número máximo de elementos permitidos em uma matriz.

<ArrayElementCount>20</ArrayElementCount>
Padrão: Se você não especificar esse elemento ou se especificar um número inteiro negativo, o sistema não aplicará um limite.
Presença: Opcional
Tipo: Inteiro

Elemento <ContainerDepth>

Especifica a profundidade de contenção máxima permitida, em que os contêineres são objetos ou matrizes. Por exemplo, uma matriz que contém um objeto que contém um objeto resultaria em uma profundidade de contenção de 3.

<ContainerDepth>10</ContainerDepth>
Padrão: Se você não especificar esse elemento ou se especificar um número inteiro negativo, o sistema não aplicará um limite.
Presença: Opcional
Tipo: Inteiro

Elemento <ObjectEntryCount>

Especifica o número máximo de entradas permitidas em um objeto.

<ObjectEntryCount>15</ObjectEntryCount>
Padrão: Se você não especificar esse elemento ou se especificar um número inteiro negativo, o sistema não aplicará um limite.
Presença: Opcional
Tipo: Inteiro

Elemento <ObjectEntryNameLength>

Especifica o comprimento máximo da string permitido para um nome de propriedade em um objeto.

<ObjectEntryNameLength>50</ObjectEntryNameLength>
Padrão: Se você não especificar esse elemento ou se especificar um número inteiro negativo, o sistema não aplicará um limite.
Presença: Opcional
Tipo: Número inteiro

Elemento <Source>

Mensagem a ser analisada por ataques de payload JSON. Geralmente, isso é definido como request, porque normalmente será necessário validar as solicitações de entrada dos aplicativos cliente. Quando definido como message, esse elemento avalia automaticamente a mensagem de solicitação quando ele está anexado ao fluxo de solicitação e a mensagem de resposta quando anexado ao fluxo.

<Source>request</Source>
Padrão: solicitação
Presença: Opcional
Tipo:

String.

Valores válidos: solicitação, resposta ou mensagem.

Elemento <StringValueLong>

Especifica o comprimento máximo permitido para um valor de string.

<StringValueLength>500</StringValueLength>
Padrão: Se você não especificar esse elemento ou se especificar um número inteiro negativo, o sistema não aplicará um limite.
Presença: Opcional
Tipo: Número inteiro

Referência de erros

This section describes the fault codes and error messages that are returned and fault variables that are set by Edge 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.jsonthreatprotection.ExecutionFailed 500 The JSONThreatProtection 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: object entry name length, object entry count, array element count, container depth, string string value length. This error also occurs when the payload contains an invalid JSON object.
steps.jsonthreatprotection.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.jsonthreatprotection.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 this policy triggers an error. 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"
jsonattack.policy_name.failed policy_name is the user-specified name of the policy that threw the fault. jsonattack.JTP-SecureRequest.failed = true

Example error response

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

Example fault rule

<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

Observações sobre o uso

Assim como os serviços baseados em XML, as APIs compatíveis com a notação de objeto JavaScript (JSON) são vulneráveis a ataques no nível do conteúdo. Ataques simples JSON usam a estrutura para sobrecarregar os analisadores JSON de causar falha em um serviço e induzir ataques de negação de serviço no nível do aplicativo. Todas as configurações são opcionais e precisam ser ajustadas para otimizar os requisitos de serviço contra possíveis vulnerabilidades.

Temas relacionados

Política JSONtoXML

Política XMLThreatProtection

Política RegularExpressionProtection