XMLThreatProtection 政策

查看 Apigee Edge 說明文件。
前往 Apigee X說明文件。 資訊

結果

解決 API 上的 XML 安全漏洞並盡可能減少攻擊。選擇性偵測 XML 酬載 依據設定的限制來發動攻擊使用下列功能來防範 XML 威脅 方法：

  • 依據 XML 架構 (.xsd) 驗證訊息
  • 評估訊息內容，判斷要排除的特定關鍵字或模式
  • 先偵測毀損或格式有誤的訊息，再剖析這些訊息

元素參照

元素參照會說明 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>

&lt;XMLThreatProtection&gt;屬性

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

下表說明所有政策父項元素的共同屬性：

屬性 說明 預設 存在必要性
name

政策的內部名稱。name 屬性的值可以 包含英文字母、數字、空格、連字號、底線和半形句號。此值不能 超過 255 個半形字元

視需要使用 <DisplayName> 元素，為政策加上標籤： 管理使用者介面 Proxy 編輯器，使用不同的自然語言名稱。

 不適用 必填
continueOnError

如果設為「false」，系統會在政策失敗時傳回錯誤。這是可預期的情況 大多數政策的行為

如果設為 true，即使政策已發生，流程執行作業仍會繼續執行 失敗。

 false 選用
enabled

如要強制執行政策，請設為 true。

設為 false 即可停用政策。這項政策不會 仍會強制執行 政策。

 true 選用
async

此屬性已淘汰。

 false 已淘汰

&lt;DisplayName&gt;元素

除 name 屬性外，一併使用 管理 UI Proxy 編輯器，使用不同的自然語言名稱。

<DisplayName>Policy Display Name</DisplayName>
預設

不適用

如果省略這個元素，政策的 name 屬性值會是

存在必要性 選用
類型 字串

&lt;NameLimits&gt;元素

指定政策要檢查及強制執行的字元限制。

<NameLimits>
   <Element>10</Element>
   <Attribute>10</Attribute>
   <NamespacePrefix>10</NamespacePrefix>
   <ProcessingInstructionTarget>10</ProcessingInstructionTarget>     
</NameLimits>
預設： 不適用
所在地： 選用
類型： 不適用

&lt;NameLimits&gt;/&lt;Element&gt;元素

指定 XML 中任何元素名稱允許的字元數量上限 文件。

以下列 XML 為例：

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

分析上述 XML 時，政策中的 <Element> 元素值 下方的程式碼片段會驗證元素名稱 (book、title、 author 和 year) 未超過 10 個字元。

<NameLimits>
   <Element>10</Element>
   <Attribute>10</Attribute>
   <NamespacePrefix>10</NamespacePrefix>
   <ProcessingInstructionTarget>10</ProcessingInstructionTarget>     
</NameLimits>
預設： 如未指定限制，系統會套用預設值 -1。 視為無限制
所在地： 選用
類型： 整數

&lt;NameLimits&gt;/&lt;Attribute&gt;元素

指定字元數上限 XML 文件

以下列 XML 為例：

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

分析上述 XML 時，政策中的 <Attribute> 元素值 下方的程式碼片段會驗證屬性名稱 category 未超過 10 個半形字元。

<NameLimits>
   <Element>10</Element>
   <Attribute>10</Attribute>
   <NamespacePrefix>10</NamespacePrefix>
   <ProcessingInstructionTarget>10</ProcessingInstructionTarget>     
</NameLimits>
預設： 如未指定限制，系統會套用預設值 -1。 視為無限制
所在地： 選用
類型： 整數

&lt;NameLimits&gt;/&lt;NamespacePrefix&gt;元素

針對開頭的 XML 文件

以下列 XML 為例：

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

分析上述 XML 時，<NamespacePrefix> 下方的政策程式碼片段會驗證命名空間前置字串「ns1」未超過 10 個半形字元。

<NameLimits>
   <Element>10</Element>
   <Attribute>10</Attribute>
   <NamespacePrefix>10</NamespacePrefix>
   <ProcessingInstructionTarget>10</ProcessingInstructionTarget>     
</NameLimits>
預設： 如未指定限制，系統會套用預設值 -1。 視為無限制
所在地： 選用
類型： 整數

&lt;NameLimits&gt;/&lt;ProcessingInstructionTarget&gt;元素

指定任一 處理指示。

以下列 XML 為例：

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

分析上述 XML 時，<ProcessingInstructionTarget> 元素 下列政策程式碼片段中的值，將能驗證處理指示目標 「xml-stylesheet」不得超過 10 個半形字元。

<NameLimits>
   <Element>10</Element>
   <Attribute>10</Attribute>
   <NamespacePrefix>10</NamespacePrefix>
   <ProcessingInstructionTarget>10</ProcessingInstructionTarget>     
</NameLimits>
預設： 如未指定限制，系統會套用預設值 -1。 視為無限制
所在地： 選用
類型： 整數

&lt;Source&gt;元素

要過濾 XML 酬載攻擊的訊息。這通常是設為 request，因為通常需要驗證來自用戶端應用程式的傳入要求。 如果設為 message，這個元素會自動評估要求訊息 附加至要求流程，且附加至回應時的回應訊息 流程

<Source>request</Source>
預設： 申請。
所在地： 選用
類型：

字串。

選項包括「request」、「response」或「message」。

&lt;StructuralLimits&gt;元素

指定要讓政策檢查及強制執行的結構限制。

<StructureLimits>
   <NodeDepth>5</NodeDepth>
   <AttributeCountPerElement>2</AttributeCountPerElement>
   <NamespaceCountPerElement>3</NamespaceCountPerElement>
   <ChildCount includeComment="true" includeElement="true" includeProcessingInstruction="true" includeText="true">3</ChildCount>
</StructureLimits>
預設： 不適用
所在地： 選用
類型： 不適用

&lt;StructuralLimits&gt;/&lt;NodeDepth&gt;元素

指定 XML 中允許的節點深度上限。

<StructureLimits>
   <NodeDepth>5</NodeDepth>
   <AttributeCountPerElement>2</AttributeCountPerElement>
   <NamespaceCountPerElement>3</NamespaceCountPerElement>
   <ChildCount includeComment="true" includeElement="true" includeProcessingInstruction="true" includeText="true">3</ChildCount>
</StructureLimits>
預設： 如未指定限制，系統會套用預設值 -1。 視為無限制
所在地： 選用
類型：

整數

&lt;StructuralLimits&gt;/&lt;AttributeCountPerElement&gt;元素

指定任何元素允許的屬性數量上限。

以下列 XML 為例：

<book category="WEB">
   <title>Learning XML</title>
   <author>Erik T. Ray</author>
   <year>2003</year>
</book>
分析上述 XML 時，<AttributeCountPerElement> 元素值 下列政策程式碼片段會驗證元素 book、title、 author 和 year 最多只能有一個 2 屬性。 請注意，用於定義命名空間的屬性不列入計算。 
<StructureLimits>
   <NodeDepth>5</NodeDepth>
   <AttributeCountPerElement>2</AttributeCountPerElement>
   <NamespaceCountPerElement>3</NamespaceCountPerElement>
   <ChildCount includeComment="true" includeElement="true" includeProcessingInstruction="true" includeText="true">3</ChildCount>
</StructureLimits>
預設： 如未指定限制，系統會套用預設值 -1。 視為無限制
所在地： 選用
類型：

整數

&lt;StructuralLimits&gt;/&lt;NameSpaceCountPerElement&gt;元素

指定任何元素允許的命名空間定義數量上限。

以下列 XML 為例：

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

分析上述 XML 時，<NamespaceCountPerElement> 元素值 下列政策程式碼片段會驗證 e1 和 e2 元素 每個命名空間定義不得超過 2 個。在此範例中，<e1> 沒有命名空間定義，以及 <e2> 有 2 個命名空間 定義：xmlns="http://apigee.com"和 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>
預設： 如未指定限制，系統會套用預設值 -1。 視為無限制
所在地： 選用
類型：

整數

&lt;StructuralLimits&gt;/&lt;ChildCount&gt; 元素

指定任何元素允許的子元素數量上限。

<StructureLimits>
   <NodeDepth>5</NodeDepth>
   <AttributeCountPerElement>2</AttributeCountPerElement>
   <NamespaceCountPerElement>3</NamespaceCountPerElement>
   <ChildCount includeComment="true" includeElement="true" includeProcessingInstruction="true" includeText="true">3</ChildCount>
</StructureLimits>
預設： 如未指定限制，系統會套用預設值 -1。 視為無限制
所在地： 選用
類型：

整數

屬性

屬性 預設 存在必要性
includeComment true 選用
includeElement true 選用
includeProcessingInstructions true 選用
includeText true 選用

&lt;ValueLimits&gt;元素

指定要讓政策檢查及強制執行的值的字元限制。

<ValueLimits>
   <Text>15</Text>
   <Attribute>10</Attribute>
   <NamespaceURI>10</NamespaceURI>
   <Comment>10</Comment>
   <ProcessingInstructionData>10</ProcessingInstructionData>
</ValueLimits>
預設： 不適用
所在地： 選用
類型：

不適用

&lt;ValueLimits&gt;/&lt;Text&gt;元素

為 XML 文件中顯示的任何文字節點指定字元限制。

以下列 XML 為例：

<book category="WEB">
   <title>Learning XML</title>
   <author>Erik T. Ray</author>
   <year>2003</year>
</book>
分析上述 XML 時，政策中的 <Text> 元素值 下方的程式碼片段會驗證各元素文字值 Learning XML、Erik T. Ray, 和 2003 的字元數未超過 15。 
<ValueLimits>
   <Text>15</Text>
   <Attribute>10</Attribute>
   <NamespaceURI>10</NamespaceURI>
   <Comment>10</Comment>
   <ProcessingInstructionData>10</ProcessingInstructionData>
</ValueLimits>
預設： 如未指定限制，系統會套用預設值 -1。 視為無限制
所在地： 選用
類型：

整數

&lt;ValueLimits&gt;/&lt;Attribute&gt;元素

為 XML 文件中出現的任何屬性值指定字元限制。

以下列 XML 為例：

<book category="WEB">
   <title>Learning XML</title>
   <author>Erik T. Ray</author>
   <year>2003</year>
</book>
分析上述 XML 時，政策中的 <Attribute> 元素值 下方程式碼片段會驗證屬性值 WEB 未超過 10 個字元。 
<ValueLimits>
   <Text>15</Text>
   <Attribute>10</Attribute>
   <NamespaceURI>10</NamespaceURI>
   <Comment>10</Comment>
   <ProcessingInstructionData>10</ProcessingInstructionData>
</ValueLimits>
預設： 如未指定限制，系統會套用預設值 -1。 視為無限制
所在地： 選用
類型：

整數

&lt;ValueLimits&gt;/&lt;NamespaceURI&gt;元素

指定 XML 文件中任何命名空間 URI 的字元限制。

以下列 XML 為例：

<ns1:myelem xmlns:ns1="http://ns1.com"/>
分析上述 XML 時，<NamespaceURI> 下方的政策程式碼片段會驗證命名空間 URI 值「http://ns1.com」 不得超過 10 個字元。 
<ValueLimits>
   <Text>15</Text>
   <Attribute>10</Attribute>
   <NamespaceURI>10</NamespaceURI>
   <Comment>10</Comment>
   <ProcessingInstructionData>10</ProcessingInstructionData>
</ValueLimits>
預設： 如未指定限制，系統會套用預設值 -1。 視為無限制
所在地： 選用
類型：

整數

&lt;ValueLimits&gt;/&lt;Comment&gt;元素

指定 XML 文件中任何註解的字元限制。

以下列 XML 為例：

<book category="WEB">
   <!-- This is a comment -->
   <title>Learning XML</title>
   <author>Erik T. Ray</author>
   <year>2003</year>
</book>
分析上述 XML 時，政策中的 <Comment> 元素值 下方程式碼片段會驗證註解文字「This is a comment」未超過 10 個字元。 
<ValueLimits>
   <Text>15</Text>
   <Attribute>10</Attribute>
   <NamespaceURI>10</NamespaceURI>
   <Comment>10</Comment>
   <ProcessingInstructionData>10</ProcessingInstructionData>
</ValueLimits>
預設： 如未指定限制，系統會套用預設值 -1。 視為無限制
所在地： 選用
類型：

整數

&lt;ValueLimits&gt;/&lt;ProcessingInstructionData&gt;元素

指定 XML 中任何處理指示文字的字元限制 文件。

以下列 XML 為例：

<?xml-stylesheet type="text/xsl" href="style.xsl"?>
分析上述 XML 時，<ProcessingInstructionData> 元素 值將驗證處理指示文字 「type="text/xsl" href="style.xsl"」不得超過 10 個字元。 
<ValueLimits>
   <Text>15</Text>
   <Attribute>10</Attribute>
   <NamespaceURI>10</NamespaceURI>
   <Comment>10</Comment>
   <ProcessingInstructionData>10</ProcessingInstructionData>
</ValueLimits>
預設： 如未指定限制，系統會套用預設值 -1。 視為無限制
所在地： 選用
類型：

整數

錯誤參考資料

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.
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.
steps.xmlthreatprotection.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.xmlthreatprotection.NonMessageVariable 500 This error occurs if the <Source> element is set to a variable which is not of type message.

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>

結構定義

使用須知

所有收到線上資料的伺服器都會遭受攻擊 (無論是惡意或非蓄意)。 有些攻擊會建構含有基本特性的無效文件，藉此利用 XML 的靈活性 後端系統可能遭到破壞毀損或極為複雜的 XML 文件 會導致伺服器分配比可用的記憶體更多，導致佔用大量 CPU 和記憶體資源 會造成剖析器異常終止，並通常會停用訊息處理功能及建立應用程式層級 阻斷服務攻擊

威脅防護錯誤設定

如果您為這項政策建立 FaultRules，重要資訊如下： 預設，Edge 會擲回 HTTP 500 內部伺服器錯誤狀態碼與 ExecutionFailed 錯誤 程式碼。您可以 而是用新的機構層級資源引發錯誤行為設定機構時 將 features.isPolicyHttpStatusEnabled 屬性設為 true，則在以下 行為發生：

  • 要求：附加威脅防護政策到任何要求流程時，無效的訊息 會傳回 400 Bad Request 狀態碼，以及相應的政策錯誤 (不只是執行失敗)。
  • 回應：在任何回應流程中附加威脅防護政策，無效的訊息 系統仍然會傳回 500 內部伺服器錯誤狀態碼，且 系統會擲回相對應的政策錯誤代碼 (而非只是執行失敗)。

雲端客戶必須聯絡 Apigee Edge 支援以設定

相關主題

JSON 威脅 保護政策

普通 運算式保護政策