Você está vendo a documentação do Apigee Edge.
Acesse a
documentação da Apigee X. informações
O que
Solucione vulnerabilidades XML e minimize os ataques na API. Opcionalmente, detecte ataques de payload XML com base nos limites configurados. Proteja-se contra ameaças XML usando as seguintes abordagens:
- Validar mensagens em um esquema XML (
.xsd
) - Avalie o conteúdo da mensagem com palavras-chave ou padrões específicos a serem excluídos.
- Detecte mensagens corrompidas ou malformadas antes de analisá-las.
Referência de elemento
A referência de elemento descreve os elementos e atributos da 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 de <XMLThreatProtection>
<XMLThreatProtection async="false" continueOnError="false" enabled="true" name="XML-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 Opcionalmente, use o elemento |
N/A | Obrigatório |
continueOnError |
Defina como Defina como |
false | Opcional |
enabled |
Defina como Defina como |
verdadeiro | Opcional |
async |
Esse atributo está obsoleto. |
false | Descontinuado |
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 |
---|---|
Presença | Opcional |
Tipo | String |
Elemento <NameLimits>
Especifica os limites de caracteres a serem verificados e aplicados pela política.
<NameLimits> <Element>10</Element> <Attribute>10</Attribute> <NamespacePrefix>10</NamespacePrefix> <ProcessingInstructionTarget>10</ProcessingInstructionTarget> </NameLimits>
Padrão: | N/A |
Presença: | Opcional |
Tipo: | N/A |
Elemento <NameLimits>/<Element>
Especifica o limite do número máximo de caracteres permitidos em qualquer nome de elemento no documento XML.
Por exemplo, considere o seguinte XML:
<book category="WEB"> <title>Learning XML</title> <author>Erik T. Ray</author> <year>2003</year> </book>
Ao analisar o XML acima, o valor do elemento <Element>
no snippet da política
abaixo validará os nomes dos elementos (book
, title
,
author
e year)
) não exceder 10
caracteres.
<NameLimits> <Element>10</Element> <Attribute>10</Attribute> <NamespacePrefix>10</NamespacePrefix> <ProcessingInstructionTarget>10</ProcessingInstructionTarget> </NameLimits>
Padrão: | Se você não especificar um limite, o sistema aplicará um valor padrão de -1 ,
que o sistema equivale a não limitar. |
Presença: | Opcional |
Tipo: | Inteiro |
Elemento <NameLimits>/<Attribute>
Especifica o limite do número máximo de caracteres permitidos em qualquer nome de atributo no documento XML.
Por exemplo, considere o seguinte XML:
<book category="WEB"> <title>Learning XML</title> <author>Erik T. Ray</author> <year>2003</year> </book>
Ao analisar o XML acima, o valor do elemento <Attribute>
no snippet de política
abaixo validará que o nome do atributo category
não excede
10
caracteres.
<NameLimits> <Element>10</Element> <Attribute>10</Attribute> <NamespacePrefix>10</NamespacePrefix> <ProcessingInstructionTarget>10</ProcessingInstructionTarget> </NameLimits>
Padrão: | Se você não especificar um limite, o sistema aplicará um valor padrão de -1 ,
que o sistema equivale a não limitar. |
Presença: | Opcional |
Tipo: | Número inteiro |
Elemento <NameLimits>/<NamespacePrefix>
Especifica um limite para o número máximo de caracteres permitido no prefixo do namespace no documento XML.
Por exemplo, considere o seguinte XML:
<ns1:myelem xmlns:ns1="http://ns1.com"/>
Ao analisar o XML acima, o valor do elemento <NamespacePrefix>
no
snippet de política abaixo validará que o prefixo de namespace ns1
não excede
10
caracteres.
<NameLimits> <Element>10</Element> <Attribute>10</Attribute> <NamespacePrefix>10</NamespacePrefix> <ProcessingInstructionTarget>10</ProcessingInstructionTarget> </NameLimits>
Padrão: | Se você não especificar um limite, o sistema aplicará um valor padrão de -1 ,
que o sistema equivale a não limitar. |
Presença: | Opcional |
Tipo: | Número inteiro |
Elemento <NameLimits>/<ProcessingInstructionTarget>
Especifica um limite para o número máximo de caracteres permitido para qualquer instrução de processamento no documento XML.
Por exemplo, considere o seguinte XML:
<?xml-stylesheet type="text/xsl" href="style.xsl"?>
Ao analisar o XML acima, o valor do elemento <ProcessingInstructionTarget>
no snippet de política abaixo validará que o destino da instrução de processamento
xml-stylesheet
não excede 10
caracteres.
<NameLimits> <Element>10</Element> <Attribute>10</Attribute> <NamespacePrefix>10</NamespacePrefix> <ProcessingInstructionTarget>10</ProcessingInstructionTarget> </NameLimits>
Padrão: | Se você não especificar um limite, o sistema aplicará um valor padrão de -1 ,
que o sistema equivale a não limitar. |
Presença: | Opcional |
Tipo: | Inteiro |
Elemento <Source>
Mensagem a ser filtrada para ataques de payload XML. 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: | request |
Presença: | Opcional |
Tipo: |
String. Selecione entre |
Elemento <StructuralLimits>
Especifica os limites estruturais a serem verificados e aplicados pela política.
<StructureLimits> <NodeDepth>5</NodeDepth> <AttributeCountPerElement>2</AttributeCountPerElement> <NamespaceCountPerElement>3</NamespaceCountPerElement> <ChildCount includeComment="true" includeElement="true" includeProcessingInstruction="true" includeText="true">3</ChildCount> </StructureLimits>
Padrão: | N/A |
Presença: | Opcional |
Tipo: | N/A |
Elemento <StructuralLimits>/<NodeDepth>
Especifica a profundidade máxima do nó permitida no XML.
<StructureLimits> <NodeDepth>5</NodeDepth> <AttributeCountPerElement>2</AttributeCountPerElement> <NamespaceCountPerElement>3</NamespaceCountPerElement> <ChildCount includeComment="true" includeElement="true" includeProcessingInstruction="true" includeText="true">3</ChildCount> </StructureLimits>
Padrão: | Se você não especificar um limite, o sistema aplicará um valor padrão de -1 ,
que o sistema equivale a não limitar. |
Presença: | Opcional |
Tipo: |
Número inteiro |
Elemento <StructuralLimits>/<AttributeCountPerElement>
Especifica o número máximo de atributos permitidos para qualquer elemento.
Por exemplo, considere o seguinte XML:
<book category="WEB"> <title>Learning XML</title> <author>Erik T. Ray</author> <year>2003</year> </book>Ao analisar o XML acima, o valor do elemento
<AttributeCountPerElement>
no snippet de política abaixo vai validar que os elementos book
, title
,
author
e year
não têm mais de 2
atributos cada.
Observe que os atributos usados para definir os namespaces não são contados.
<StructureLimits> <NodeDepth>5</NodeDepth> <AttributeCountPerElement>2</AttributeCountPerElement> <NamespaceCountPerElement>3</NamespaceCountPerElement> <ChildCount includeComment="true" includeElement="true" includeProcessingInstruction="true" includeText="true">3</ChildCount> </StructureLimits>
Padrão: | Se você não especificar um limite, o sistema aplicará um valor padrão de -1 ,
que o sistema equivale a não limitar. |
Presença: | Opcional |
Tipo: |
Número inteiro |
Elemento <StructuralLimits>/<NameSpaceCountPerElement>
Especifica o número máximo de definições de namespace permitidas para qualquer elemento.
Por exemplo, considere o seguinte XML:
<e1 attr1="val1" attr2="val2"> <e2 xmlns="http://apigee.com" xmlns:yahoo="http://yahoo.com" one="1" yahoo:two="2"/> </e1>
Ao analisar o XML acima, o valor do elemento <NamespaceCountPerElement>
no snippet de política abaixo validará se os elementos e1
e e2
não têm mais de 2
definições de namespace cada. Nesse caso, <e1> tem 0 definições de namespace e
<e2> tem duas definições de
namespace: 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>
Padrão: | Se você não especificar um limite, o sistema aplicará um valor padrão de -1 ,
que o sistema equivale a não limitar. |
Presença: | Opcional |
Tipo: |
Número inteiro |
Elemento <StructuralLimits>/<ChildCount>
Especifica o número máximo de elementos filhos permitidos para qualquer elemento.
<StructureLimits> <NodeDepth>5</NodeDepth> <AttributeCountPerElement>2</AttributeCountPerElement> <NamespaceCountPerElement>3</NamespaceCountPerElement> <ChildCount includeComment="true" includeElement="true" includeProcessingInstruction="true" includeText="true">3</ChildCount> </StructureLimits>
Padrão: | Se você não especificar um limite, o sistema aplicará um valor padrão de -1 ,
que o sistema equivale a não limitar. |
Presença: | Opcional |
Tipo: |
Número inteiro |
Atributos
Atributo | Padrão | Presença |
---|---|---|
includeComment | verdadeiro | Opcional |
includeElement | verdadeiro | Opcional |
includeProcessingInstructions | verdadeiro | Opcional |
includeText | verdadeiro | Opcional |
Elemento <ValueLimits>
Especifica os limites de caracteres para os valores a serem verificados e aplicados pela política.
<ValueLimits> <Text>15</Text> <Attribute>10</Attribute> <NamespaceURI>10</NamespaceURI> <Comment>10</Comment> <ProcessingInstructionData>10</ProcessingInstructionData> </ValueLimits>
Padrão: | N/A |
Presença: | Opcional |
Tipo: |
N/A |
Elemento <ValueLimits>/<Text>
Especifica um limite de caracteres para qualquer nó de texto presente no documento XML.
Por exemplo, considere o seguinte XML:
<book category="WEB"> <title>Learning XML</title> <author>Erik T. Ray</author> <year>2003</year> </book>Ao analisar o XML acima, o valor do elemento
<Text>
no snippet de
política abaixo vai validar se os valores de texto do elemento Learning XML
, Erik T.
Ray,
e 2003
não excederão 15
caracteres cada.
<ValueLimits> <Text>15</Text> <Attribute>10</Attribute> <NamespaceURI>10</NamespaceURI> <Comment>10</Comment> <ProcessingInstructionData>10</ProcessingInstructionData> </ValueLimits>
Padrão: | Se você não especificar um limite, o sistema aplicará um valor padrão de -1 ,
que o sistema equivale a não limitar. |
Presença: | Opcional |
Tipo: |
Número inteiro |
Elemento <ValueLimits>/<Attribute>
Especifica um limite de caracteres para quaisquer valores de atributo presentes no documento XML.
Por exemplo, considere o seguinte XML:
<book category="WEB"> <title>Learning XML</title> <author>Erik T. Ray</author> <year>2003</year> </book>Ao analisar o XML acima, o valor do elemento
<Attribute>
no snippet de política
abaixo vai confirmar que o valor do atributo WEB
não excede
10
caracteres.
<ValueLimits> <Text>15</Text> <Attribute>10</Attribute> <NamespaceURI>10</NamespaceURI> <Comment>10</Comment> <ProcessingInstructionData>10</ProcessingInstructionData> </ValueLimits>
Padrão: | Se você não especificar um limite, o sistema aplicará um valor padrão de -1 ,
que o sistema equivale a não limitar. |
Presença: | Opcional |
Tipo: |
Número inteiro |
Elemento <ValueLimits>/<NamespaceURI>
Especifica um limite de caracteres para os URIs de namespace presentes no documento XML.
Por exemplo, considere o seguinte XML:
<ns1:myelem xmlns:ns1="http://ns1.com"/>Ao analisar o XML acima, o valor do elemento
<NamespaceURI>
no
snippet de política abaixo vai validar se o valor de URI do namespace http://ns1.com
não
excede caracteres 10
.
<ValueLimits> <Text>15</Text> <Attribute>10</Attribute> <NamespaceURI>10</NamespaceURI> <Comment>10</Comment> <ProcessingInstructionData>10</ProcessingInstructionData> </ValueLimits>
Padrão: | Se você não especificar um limite, o sistema aplicará um valor padrão de -1 ,
que o sistema equivale a não limitar. |
Presença: | Opcional |
Tipo: |
Número inteiro |
Elemento <ValueLimits>/<Comment>
Especifica um limite de caracteres para os comentários presentes no documento XML.
Por exemplo, considere o seguinte XML:
<book category="WEB"> <!-- This is a comment --> <title>Learning XML</title> <author>Erik T. Ray</author> <year>2003</year> </book>Ao analisar o XML acima, o valor do elemento
<Comment>
no snippet de política
abaixo vai validar que o texto do comentário This is a comment
não excede
10
caracteres.
<ValueLimits> <Text>15</Text> <Attribute>10</Attribute> <NamespaceURI>10</NamespaceURI> <Comment>10</Comment> <ProcessingInstructionData>10</ProcessingInstructionData> </ValueLimits>
Padrão: | Se você não especificar um limite, o sistema aplicará um valor padrão de -1 ,
que o sistema equivale a não limitar. |
Presença: | Opcional |
Tipo: |
Número inteiro |
Elemento <ValueLimits>/<ProcessingInstructionData>
Especifica um limite de caracteres para qualquer texto de instrução de processamento presente no documento XML.
Por exemplo, considere o seguinte XML:
<?xml-stylesheet type="text/xsl" href="style.xsl"?>Ao analisar o XML acima, o valor do elemento
<ProcessingInstructionData>
no snippet de política abaixo valida que o texto de instruções de processamento
type="text/xsl" href="style.xsl"
não excede 10
caracteres.
<ValueLimits> <Text>15</Text> <Attribute>10</Attribute> <NamespaceURI>10</NamespaceURI> <Comment>10</Comment> <ProcessingInstructionData>10</ProcessingInstructionData> </ValueLimits>
Padrão: | Se você não especificar um limite, o sistema aplicará um valor padrão de -1 ,
que o sistema equivale a não limitar. |
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.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. | build |
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.
|
build |
steps.xmlthreatprotection.SourceUnavailable |
500 |
This error occurs if the message
variable specified in the <Source> element is either:
|
build |
steps.xmlthreatprotection.NonMessageVariable |
500 |
This error occurs if the <Source> element is set to a variable which
is not of type
message.
|
build |
Notes:
- The error name ExecutionFailed is the default error name and will be returned regardless of the type of error detected; however, this default can be changed by setting an organization-level property. When this property is set, the error name will reflect the actual error. For example, "TextExceeded" or "AttrValueExceeded". See Usage Notes for details.
- The 500 HTTP status is the default; however, the HTTP Status can be changed to 400 for request flow faults by setting an organization-level property. See Usage Notes for details.
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>
Esquemas
Observações sobre uso
Qualquer servidor que recebe dados on-line está sujeito a ataque, seja malicioso ou não. Alguns ataques aproveitam a flexibilidade do XML ao criar documentos inválidos que podem comprometer sistemas de back-end. Documentos XML corrompidos ou extremamente complexos podem fazer com que os servidores aloquem mais memória do que disponível, adicionando recursos de CPU e memória, falhas de análise e, geralmente, desativando o processamento de mensagens e criando ataques de negação de serviço no nível dos aplicativos.
Configuração de erro da proteção contra ameaças
Informações importantes se você estiver criando FaultRules para esta política:por padrão, o Edge vai gerar um código de status HTTP 500 Internal Server Error e um código de erro ExecutionFailed se uma mensagem não passar por uma política de proteção contra ameaças JSON ou XML. É possível alterar
esse comportamento de erro com uma nova propriedade no nível da organização. Ao definir a propriedade
organizacional features.isPolicyHttpStatusEnabled
como "true", o seguinte
comportamento ocorre:
- Solicitação: com uma política de proteção contra ameaças anexada a qualquer fluxo de solicitação, mensagens inválidas retornam um código de status 400 400 Solicitação de solicitação com um código de erro de política correspondente (em vez de apenas ExecutionFailed).
- Resposta: com uma política de proteção contra ameaças anexada a qualquer fluxo de respostas, mensagens inválidas ainda retornam o código de status "500 Internal Server Error", e um dos códigos de erro de política correspondentes é gerado (em vez de do que apenas ExecutionFailed).
Os clientes do Cloud precisam entrar em contato com o suporte do Apigee Edge para definir a propriedade da organização.