JSONThreatProtection 정책

이 페이지는 Apigee 및 Apigee Hybrid에 적용됩니다.

Apigee Edge 문서 보기

대상

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

이 정책은 확장 가능한 정책이며, 이 정책을 사용하면 Apigee 라이선스에 따라 비용 또는 사용률이 영향을 받을 수 있습니다. 정책 유형 및 사용 영향에 대한 자세한 내용은 정책 유형을 참조하세요.

참고: 다음 동영상에서는 Apigee UI의 기본 프록시 편집기를 보여줍니다. Apigee는 동영상에 표시된 기본 버전과 다르게 설계된 새 버전의 프록시 편집기를 도입합니다.

참고: 이 정책은 요청이나 응답 헤더의 Content-Type이 application/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"> 

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

속성	설명	기본값	Presence
name	정책의 내부 이름입니다. name 속성의 값에는 문자, 숫자, 공백, 하이픈, 밑줄, 마침표가 포함될 수 있습니다. 이 값은 255자(영문 기준)를 초과할 수 없습니다. 원하는 경우 <DisplayName> 요소를 사용하여 관리 UI 프록시 편집기의 정책에 다른 자연어 이름을 사용하여 정책에 라벨을 지정합니다.	해당 사항 없음	필수
continueOnError	정책이 실패할 경우 오류가 반환되도록 하려면 false로 설정합니다. 이는 대부분의 정책에서 예상되는 동작입니다. 정책이 실패해도 흐름 실행이 계속되도록 하려면 true로 설정합니다. 참조: 오류 규칙은 오류 상태(continueOnError)에서만 트리거됨 현재 흐름 내에서 오류 처리	false	선택사항
enabled	정책을 시행하려면 true로 설정합니다. 정책을 중지하려면 false로 설정합니다. 정책이 흐름에 연결되어 있어도 정책이 시행되지 않습니다.	true	선택사항
async	이 속성은 지원이 중단되었습니다.	false	지원 중단됨

<DisplayName> 요소

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

<DisplayName>Policy Display Name</DisplayName>

기본값	해당 사항 없음 이 요소를 생략하면 정책 name 속성 값이 사용됩니다.
Presence	선택사항
유형	문자열

<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:	선택사항
유형:	정수

오류 참조

참고: 이 정책은 요청이나 응답 헤더의 Content-Type이 application/json.로 설정된 경우에만 실행됩니다.

이 섹션에서는 반환되는 오류 코드 및 오류 메시지와 이 정책이 오류를 트리거할 때 Apigee에서 설정한 오류 변수를 설명합니다. 오류를 처리하기 위해 오류 규칙을 개발 중인 경우, 이 정보는 중요합니다. 자세한 내용은 정책 오류에 대해 알아야 할 사항 및 오류 처리를 참조하세요.

런타임 오류

이러한 오류는 정책이 실행될 때 발생할 수 있습니다.

오류 코드	HTTP 상태	원인	수정
steps.jsonthreatprotection.ExecutionFailed	500	JSONThreatProtection 정책으로 인해 여러 가지 유형의 ExecutionFailed 오류가 발생할 수 있습니다. 이러한 오류의 대부분은 정책에 설정된 특정 임계값을 초과할 때 발생합니다. 이러한 유형의 오류에는 객체 항목 이름 길이, 객체 항목 수, 배열 요소 수, 컨테이너 깊이, 문자열 문자열 값 길이가 포함됩니다. 이 오류는 페이로드에 잘못된 JSON 객체가 포함되어 있을 때도 발생합니다.
steps.jsonthreatprotection.SourceUnavailable	500	이 오류는 <Source> 요소에 지정된 메시지 변수가 다음 중 하나일 때 발생합니다. 범위를 벗어난 경우(정책이 실행 중인 특정 흐름에서 사용할 수 없음) 유효한 값 request, response 또는 message 중 하나가 아님
steps.jsonthreatprotection.NonMessageVariable	500	이 오류는 <Source> 요소가 메시지 유형이 아닌 변수로 설정된 경우에 발생합니다.

배포 오류

없음.

오류 변수

이러한 변수는 이 정책으로 오류가 트리거될 때 설정됩니다. 자세한 내용은 정책 오류에 대해 알아야 할 사항을 참조하세요.

변수	장소	예
fault.name="fault_name"	fault_name은 위의 런타임 오류 표에 나열된 오류 이름입니다. 오류 이름은 오류 코드의 마지막 부분입니다.	fault.name Matches "SourceUnavailable"
jsonattack.policy_name.failed	policy_name은 오류를 발생시킨 정책의 사용자 지정 이름입니다.	jsonattack.JTP-SecureRequest.failed = true

오류 응답 예시

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

오류 규칙 예시

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

스키마

샘플: 최신 스키마는 GitHub 저장소 샘플을 참조하세요.

사용 참고사항

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

관련 주제

JSONtoXML 정책

XMLThreatProtection 정책

RegularExpressionProtection 정책