Zasada JSONThreatProtection

Przeglądasz dokumentację Apigee Edge.
Przejdź do Dokumentacja Apigee X. informacje.

Co

Minimalizuje ryzyko związane z atakami na poziomie treści, umożliwiając określenie limitów dla różnych struktury JSON, np. tablice i ciągi tekstowe.

Film: obejrzyj krótki film, aby dowiedzieć się więcej o tym, jak Zasada JSONThreatProtection umożliwia zabezpieczanie interfejsów API przed atakami na poziomie treści.

Film: obejrzyj ten krótki film o platformie Apigee API obejmującej różne chmury.

Odwołanie do elementu

Dokumentacja elementu opisuje elementy i atrybuty obiektu 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>

&lt;JSONThreatProtection&gt; atrybuty

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

W tej tabeli opisano atrybuty wspólne dla wszystkich elementów nadrzędnych zasad:

Atrybut Opis Domyślny Obecność
name

Wewnętrzna nazwa zasady. Wartość atrybutu name może zawierać litery, cyfry, spacje, łączniki, podkreślenia i kropki. Ta wartość nie może przekracza 255 znaków.

Opcjonalnie możesz użyć elementu <DisplayName> do oznaczenia zasady jako edytor proxy interfejsu zarządzania z inną nazwą w języku naturalnym.

 Nie dotyczy Wymagane
continueOnError

Ustaw jako false, aby w przypadku niepowodzenia zasady zwracany był błąd. To normalne w przypadku większości zasad.

Ustaw jako true, aby wykonywanie przepływu było kontynuowane nawet po zastosowaniu zasady niepowodzenie.

 fałsz Opcjonalnie
enabled

Aby egzekwować zasadę, ustaw wartość true.

Aby wyłączyć zasadę, ustaw wartość false. Te zasady nie będą jest wymuszane nawet wtedy, gdy jest ono połączone z przepływem.

 prawda Opcjonalnie
async

Ten atrybut został wycofany.

 fałsz Wycofano

&lt;DisplayName&gt; element

Używaj oprócz atrybutu name do oznaczania zasady w edytor proxy interfejsu zarządzania z inną nazwą w języku naturalnym.

<DisplayName>Policy Display Name</DisplayName>
Domyślny

Nie dotyczy

Jeśli pominiesz ten element, atrybut name zasady otrzyma wartość .
Obecność Opcjonalnie
Typ Ciąg znaków

&lt;ArrayElementCount&gt; element

Określa maksymalną dozwoloną liczbę elementów w tablicy.

<ArrayElementCount>20</ArrayElementCount>
Domyślne: Jeśli nie określisz tego elementu lub podasz ujemną liczbę całkowitą, system nie narzuca limitu.
Obecność: Opcjonalnie
Typ: Liczba całkowita

&lt;ContainerDepth&gt; element

Określa maksymalną dopuszczalną głębokość izolacji, gdzie kontenery są obiektami lub tablicami. Na przykład tablica zawierająca obiekt, który zawiera obiekt, spowodowałaby ograniczenie głębokość 3.

<ContainerDepth>10</ContainerDepth>
Domyślne: Jeśli nie określisz tego elementu lub podasz ujemną liczbę całkowitą, system nie wymusza żadnych limitów.
Obecność: Opcjonalnie
Typ: Liczba całkowita

&lt;ObjectEntryCount&gt; element

Określa maksymalną dozwoloną liczbę wpisów w obiekcie.

<ObjectEntryCount>15</ObjectEntryCount>
Domyślne: Jeśli nie określisz tego elementu lub podasz ujemną liczbę całkowitą, system nie wymusza żadnych limitów.
Obecność: Opcjonalnie
Typ: Liczba całkowita

&lt;ObjectEntryNameLength&gt; element

Określa maksymalną dozwoloną długość ciągu znaków dla nazwy właściwości w obiekcie.

<ObjectEntryNameLength>50</ObjectEntryNameLength>
Domyślne: Jeśli nie określisz tego elementu lub podasz ujemną liczbę całkowitą, system nie narzuca limitu.
Obecność: Opcjonalnie
Typ: Liczba całkowita

&lt;Source&gt; element

Komunikat filtrowany pod kątem ataków ładunku JSON. Najczęściej jest to wartość request, ponieważ zwykle trzeba weryfikować żądania przychodzące z aplikacji klienckich. Gdy ustawisz wartość message, ten element automatycznie sprawdzi wiadomość z prośbą. po dołączeniu do procesu żądania i komunikatu z odpowiedzią (po dołączeniu do odpowiedzi). przepływu danych.

<Source>request</Source>
Domyślne: żądanie
Obecność: Opcjonalnie
Typ:

Ciąg tekstowy.

Prawidłowe wartości: request, response lub message.

&lt;StringValueLength&gt; element

Określa maksymalną dozwoloną długość ciągu znaków.

<StringValueLength>500</StringValueLength>
Domyślne: Jeśli nie określisz tego elementu lub podasz ujemną liczbę całkowitą, system nie narzuca limitu.
Obecność: Opcjonalnie
Typ: Liczba całkowita

Informacje o błędzie

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>

Schematy

Zastosowanie

Podobnie jak usługi oparte na formacie XML, interfejsy API obsługujące format JSON (JavaScript Object Notation) są podatne na ataków na poziomie treści. Proste ataki JSON polegają na użyciu struktur, które przeciążają parsery JSON może powodować awarie usługi i wywoływać ataki typu DoS. Wszystkie ustawienia są jest opcjonalny i należy go dostosować, aby zoptymalizować wymagania usługi pod kątem potencjalnych Luki w zabezpieczeniach.

Powiązane artykuły

Zasada JSONtoXML

Zasada XMLThreatProtection

Zasada RegularExpressionProtection