JSONThreatProtection 정책

<ph type="x-smartling-placeholder"></ph> 현재 Apigee Edge 문서를 보고 있습니다.
Apigee X 문서. 정보

대상

배열과 문자열 같은 다양한 JSON 구조에 제한을 지정할 수 있도록 함으로써 콘텐츠 수준 공격에 따른 위험을 최소화합니다.

동영상: JSONThreatProtection 정책을 사용하여 콘텐츠 수준 공격으로부터 API를 보호하는 방법을 자세히 알아보려면 짧은 동영상을 확인하세요.

동영상: Apigee 교차 클라우드 API 관리 플랫폼에 대한 이 짧은 동영상을 확인하세요.

요소 참조

요소 참조는 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>

<JSONThreatProtection> 속성

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

다음 표는 모든 정책 상위 요소의 공통 속성에 대해 설명합니다.

속성 설명 기본값 현재 상태
name

정책의 내부 이름입니다. name 속성의 값에는 문자, 숫자, 공백, 하이픈, 밑줄, 마침표가 포함될 수 있습니다. 이 값은 255자(영문 기준)를 초과할 수 없습니다.

원하는 경우 <DisplayName> 요소를 사용하여 관리 UI 프록시 편집기의 정책에 다른 자연어 이름을 사용하여 정책에 라벨을 지정합니다.

 해당 없음 필수
continueOnError

정책이 실패할 경우 오류가 반환되도록 하려면 false로 설정합니다. 이는 대부분의 정책에서 예상되는 동작입니다.

정책이 실패해도 흐름 실행이 계속되도록 하려면 true로 설정합니다.

 거짓 선택사항
enabled

정책을 시행하려면 true로 설정합니다.

정책을 중지하려면 false로 설정합니다. 정책이 흐름에 연결되어 있어도 정책이 시행되지 않습니다.

 참 선택사항
async

이 속성은 지원이 중단되었습니다.

 거짓 지원 중단됨

<DisplayName> 요소

name 속성 외에도 이 요소를 사용하여 관리 UI 프록시 편집기의 정책에 다른 자연어 이름으로 라벨을 지정합니다.

<DisplayName>Policy Display Name</DisplayName>
기본값

해당 없음

이 요소를 생략하면 정책 name 속성 값이 사용됩니다.
현재 상태 선택사항
유형 문자열

<ArrayElementCount> 요소

배열에서 허용되는 최대 요소 수를 지정합니다.

<ArrayElementCount>20</ArrayElementCount>
기본값: 이 요소를 지정하지 않거나 음의 정수를 지정하면 시스템에서 한도를 적용하지 않습니다.
Presence: 선택사항
유형: 정수

<ContainerDepth> 요소

컨테이너가 객체 또는 배열인 최대 허용 포함 깊이를 지정합니다. 예를 들어 객체가 포함된 배열은 포함 깊이가 3입니다.

<ContainerDepth>10</ContainerDepth>
기본값: 이 요소를 지정하지 않거나 음의 정수를 지정하면 시스템에서 한도를 적용하지 않습니다.
Presence: 선택사항
유형: 정수

<ObjectEntryCount> 요소

객체에서 허용되는 최대 항목 수를 지정합니다.

<ObjectEntryCount>15</ObjectEntryCount>
기본값: 이 요소를 지정하지 않거나 음의 정수를 지정하면 시스템에서 한도를 적용하지 않습니다.
Presence: 선택사항
유형: 정수

<ObjectEntryNameLength> 요소

객체 내에서 속성 이름에 허용되는 최대 문자열 길이를 지정합니다.

<ObjectEntryNameLength>50</ObjectEntryNameLength>
기본값: 이 요소를 지정하지 않거나 음의 정수를 지정하면 시스템에서 한도를 적용하지 않습니다.
Presence: 선택사항
유형: 정수

<Source> 요소

JSON 페이로드 공격에 대해 필터링할 메시지입니다. 클라이언트 앱에서 인바운드 요청을 검증해야 하므로, 이 요소는 request로 설정하는 것이 가장 일반적입니다. 이 요소는 message로 설정하면 요청 흐름에 연결될 때 자동으로 요청 메시지를 평가하고 응답 흐름에 연결될 때 응답 메시지를 자동으로 평가합니다.

<Source>request</Source>
기본값: 요청
Presence: 선택사항
유형:

문자열.

유효한 값: 요청, 응답 또는 메시지.

<StringValueLength> 요소

문자열 값에 허용되는 최대 길이를 지정합니다.

<StringValueLength>500</StringValueLength>
기본값: 이 요소를 지정하지 않거나 음의 정수를 지정하면 시스템에서 한도를 적용하지 않습니다.
Presence: 선택사항
유형: 정수

오류 참조

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>

스키마

사용 참고사항

XML 기반 서비스와 마찬가지로 JSON(JavaScript Object Notation)을 지원하는 API는 콘텐츠 등급 공격에 취약합니다. 간단한 JSON 공격은 JSON 파서에 부담을 주어 서비스를 비정상 종료하고 애플리케이션 수준의 서비스 거부 공격을 유도하는 구조를 사용합니다. 모든 설정은 선택사항이며 잠재적 취약점에 맞게 서비스 요구사항을 최적화하도록 미세 조정해야 합니다.

관련 주제

JSONtoXML 정책

XMLThreatProtection 정책

RegularExpressionProtection 정책