Zasada ExpressExpressionProtection

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

Co

Wyodrębnia informacje z wiadomości (na przykład Ścieżka URI, parametr zapytania, nagłówek, parametr formularza, zmiennej, XML Payload lub JSON Payload) i ocenia tę treść w porównaniu ze wstępnie zdefiniowanym zwykłym. wyrażeń. Jeśli określone wyrażenia regularne mają wartość prawda, wiadomość jest traktowana jako i zostanie odrzucone.

Filmy

Aby dowiedzieć się więcej o zasadach ochrony wyrażeń regularnych, obejrzyj poniższe filmy.

Przykłady

<RegularExpressionProtection name="JsonPathRegExProtection">
    <DisplayName>Regular Expression Protection 1</DisplayName>
    <Source>request</Source>
    <JSONPayload escapeSlashCharacter="true">
       <JSONPath>
          <Expression>$</Expression>
          <Pattern>&lt;\s*script\b[^&gt;]*&gt;[^&lt;]+&lt;\s*\/\s*script\s*&gt;
          </Pattern>
          <Pattern>n\s*\\\\\s*slash</Pattern>
          <Pattern>n\s*\/\s*slash</Pattern>
          <Pattern>n\s*\\"\s*quotes</Pattern>
          <Pattern>n\s*\\b\s*space</Pattern>
          <Pattern>n\s*\\f\s*forwardfeed</Pattern>
          <Pattern>n\s*\\n\s*newline</Pattern>
          <Pattern>n\s*\\r\s*carria</Pattern>
          <Pattern>n\s*\\t\s*tab</Pattern>
          <Pattern>n\s*\\uFFFF\s*hex</Pattern>
       </JSONPath>
    </JSONPayload>
 </RegularExpressionProtection>

<Pattern>[\s]*(?i)((delete)|(exec)|(drop\s*table)|(insert)|(shutdown)|(update)|(\bor\b))</Pattern>

Informacje o zasadach ochrony wyrażeń regularnych

Apigee Edge umożliwia konfigurowanie wyrażeń regularnych, których można używać oceniane na podstawie ruchu API w czasie działania w celu identyfikowania typowych zagrożeń na poziomie treści, które występują pewnych wzorców.

Wyrażenie regularne, w skrócie wyrażenie regularne, to zestaw ciągów znaków. określające wzorzec w ciągu znaków. Wyrażenia regularne umożliwiają automatyzację treści analizowanych pod kątem wzorców. Wyrażeń regularnych możesz użyć na przykład do oceny adresu e-mail. aby mieć pewność, że jest poprawnie zorganizowany. Więcej informacji znajdziesz w sekcji Zwykłe wyrażenia w samouczkach Java.

Najczęstszym zastosowaniem funkcji RegularExpressionProtection jest ocena kodu JSON i XML. pod kątem szkodliwych treści.

Żadne wyrażenie regularne nie może wyeliminować wszystkich ataków opartych na treści, a wiele mechanizmów powinien należy łączyć w celu włączenia obrony w głąb. W tej sekcji opisano kilka zalecanych wzorców wykluczając treści.

Przykładowe wykluczenie wzory

Wyrażenia regularne muszą być zakodowane w formacie XML w pliku konfiguracji zasady.

[\s]*((delete)|(exec)|(drop\s*table)|(insert)|(shutdown)|(update)|(\bor\b))

<!--#(include|exec|echo|config|printenv)\s+.*

<!--#(include|exec|echo|config|printenv)\s+.*

(/(@?[\w_?\w:\*]+(\[[^]]+\])*)?)+

/?(ancestor(-or-self)?|descendant(-or-self)?|following(-sibling))

<\s*script\b[^>]*>[^<]+<\s*/\s*script\s*>

<\s*script\b[^>]*>[^<]+<\s*/\s*script\s*>

.*?Exception in thread.*

Ustaw nagłówek Content-Type w żądaniu z ładunkiem XML lub JSON

Ładunek zasady ochrony wyrażeń regularnych może zawierać te elementy: elementy:

• Element <XMLPayload>: określa, że należy wyodrębnić informacje ładunek XML i ocenić go w oparciu o podane wyrażenie regularne.

  Jeśli w zasadzie używasz atrybutu <XMLPayload>, Nagłówek Content-Type żądania musi być typem zawartości XML, takim jak application/xml lub text/xml.

• Element <JSONPayload>: określa, że należy wyodrębnić informacje z ładunku JSON i ocenić za pomocą podanego wyrażenia regularnego.

  Jeśli w zasadzie używasz atrybutu <JSONPayload>, Nagłówek Content-Type żądania musi być typem treści JSON takim jak application/json

Zwykle projektujesz interfejs API w taki sposób, aby akceptował on format XML lub JSON. Istnieje jednak sytuacja, w których interfejs API akceptuje oba te typy. Możesz następnie zdefiniować zasadę ochrony wyrażeń regularnych. z elementami <XMLPayload> i <JSONPayload>. Do konkretnego żądania na podstawie wartości atrybutu Nagłówek Content-Type.

Odwołanie do elementu

Odwołanie do elementu opisuje elementy i atrybuty elementu RegularExpressionProtection .

<RegularExpressionProtection async="false" continueOnError="false" enabled="true" name="Regular-Expression-Protection-1">
   <DisplayName>Regular Expression Protection 1</DisplayName>
   <Source>response</Source>
   <IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>
   <URIPath>
     <Pattern>REGEX PATTERN</Pattern>
     <Pattern>REGEX PATTERN</Pattern>
   </URIPath>
   <QueryParam name="a-query-param">
     <Pattern>REGEX PATTERN</Pattern>
     <Pattern>REGEX PATTERN</Pattern>
   </QueryParam>
   <Header name="a-header">
     <Pattern>REGEX PATTERN</Pattern>
     <Pattern>REGEX PATTERN</Pattern>
   </Header>
   <FormParam name="a-form-param">
     <Pattern>REGEX PATTERN</Pattern>
     <Pattern>REGEX PATTERN</Pattern>
   </FormParam>
   <Variable name="request.content">
     <Pattern>REGEX PATTERN</Pattern>
     <Pattern>REGEX PATTERN</Pattern>
   </Variable>
   <XMLPayload>
     <Namespaces>
       <Namespace prefix="apigee">http://www.apigee.com</Namespace>
     </Namespaces>
     <XPath>
       <Expression>/apigee:Greeting/apigee:User</Expression>
       <Type>string</Type>
       <Pattern>REGEX PATTERN</Pattern>
       <Pattern>REGEX PATTERN</Pattern>
     </XPath>
   </XMLPayload>
   <JSONPayload>
     <JSONPath>
       <Expression>$.store.book[*].author</Expression>
       <Pattern>REGEX PATTERN</Pattern>
       <Pattern>REGEX PATTERN</Pattern>
     </JSONPath>
    </JSONPayload>
</RegularExpressionProtection>

<RegularExpressionProtection> atrybuty

<RegularExpressionProtection async="false" continueOnError="false" enabled="true" name="Regular-Expression-Protection-1">

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

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

<Source> element

Wskazuje wiadomość, z której należy wyodrębnić informacje.

Jeśli element <Source> zostanie pominięty, domyślną wartością jest message Na przykład: <Source>message</Source>. Po ustawieniu na message, zasada używa wiadomości z żądaniem jako źródła po dołączeniu do żądania przepływu danych. Podobnie zasada korzysta z odpowiedzi, gdy jest dołączona do procesu odpowiedzi.

Jeśli nie można znaleźć komunikatu źródłowego lub przechodzi on w typie innym niż wiadomość, zasada zwraca błąd.

<Source>response</Source>

<IgnoreUnresolvedVariables> element

Określa, czy zasada zwraca błąd po napotkaniu zmiennej, która jest nierozwiązalne.

Jeśli ma wartość false (domyślna), zasada zwraca błąd w przypadku braku rozwiązania . Jeśli ma wartość true, nierozstrzygnięta zmienna jest traktowana jako pusta ciąg znaków (wartość null).

<IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>

<URIPath> element

Określa, że informacje muszą zostać wyodrębnione ze ścieżki identyfikatora URI żądania i oceniane z podanymi wyrażeniami regularnymi. Musisz podać co najmniej jeden Element <Pattern> określający wzorzec wyrażenia regularnego do dopasowania.

<URIPath>
  <Pattern>REGEX PATTERN</Pattern>
  <Pattern>REGEX PATTERN</Pattern>
</URIPath>

<QueryParam> element

Określa, że informacje muszą zostać wyodrębnione z parametru zapytania żądania i jest oceniana na podstawie podanych wyrażeń regularnych. Musisz podać co najmniej jeden Element <Pattern> określający wzorzec wyrażenia regularnego do dopasowania.

<QueryParam name="a-query-param">
  <Pattern>REGEX PATTERN</Pattern>
  <Pattern>REGEX PATTERN</Pattern>
</QueryParam>

Atrybuty

<Header> element

określa, że informacje muszą zostać wyodrębnione z nagłówków żądania i odpowiedzi oraz jest oceniana na podstawie podanych wyrażeń regularnych. Musisz podać co najmniej jeden Element <Pattern> określający wzorzec wyrażenia regularnego do dopasowania.

<Header name="a-header">
  <Pattern>REGEX PATTERN</Pattern>
  <Pattern>REGEX PATTERN</Pattern>
</Header>

Atrybuty

<FormParam> element

Określa, że informacje muszą zostać wyodrębnione z parametru formularza żądania i oceniane z podanymi wyrażeniami regularnymi. Musisz podać co najmniej jeden Element <Pattern> określający wzorzec wyrażenia regularnego do dopasowania.

<FormParam name="a-form-param">
   <Pattern>REGEX PATTERN</Pattern>
   <Pattern>REGEX PATTERN</Pattern>
</FormParam>

Atrybuty

<Variable> element

Określa, że informacje muszą zostać wyodrębnione z danej zmiennej i oceniane w odniesieniu do z podanych wyrażeń regularnych.

<Variable name="request.content">
   <Pattern>REGEX PATTERN</Pattern>
   <Pattern>REGEX PATTERN</Pattern>
</Variable>

Atrybuty

<XMLPayload> element

Określa, że informacje muszą zostać wyodrębnione z ładunku XML i oceniane w odniesieniu do wyrażenia regularne.

<XMLPayload>
   <Namespaces>
      <Namespace prefix="apigee">http://www.apigee.com</Namespace>
   </Namespaces>
   <XPath>
      <Expression>/apigee:Greeting/apigee:User</Expression>
      <Type>string</Type>
      <Pattern>REGEX PATTERN</Pattern>
      <Pattern>REGEX PATTERN</Pattern>
   </XPath>
</XMLPayload>

<XMLPayload>/<Namespaces> element

Określa przestrzenie nazw, które mają być używane podczas oceny XPath.

<XMLPayload>
   <Namespaces>
      <Namespace prefix="apigee">http://www.apigee.com</Namespace>
   </Namespaces>
   <XPath>
      <Expression>/apigee:Greeting/apigee:User</Expression>
      <Type>string</Type>
      <Pattern>REGEX PATTERN</Pattern>
      <Pattern>REGEX PATTERN</Pattern>
   </XPath>
</XMLPayload>

<XMLPayload>/<Namespaces>/<Namespace> element

<Namespaces>
   <Namespace prefix="apigee">http://www.apigee.com</Namespace>
</Namespaces>

Atrybuty

<XMLPayload>/<XPath> element

<XPath>
   <Expression>/apigee:Greeting/apigee:User</Expression>
   <Type>string</Type>
   <Pattern>REGEX PATTERN</Pattern>
   <Pattern>REGEX PATTERN</Pattern>
</XPath>

<XMLPayload>/<XPath>/<Expression> element

<XPath>
   <Expression>/apigee:Greeting/apigee:User</Expression>
   <Type>string</Type>
   <Pattern>REGEX PATTERN</Pattern>
   <Pattern>REGEX PATTERN</Pattern>
</XPath>

<XMLPayload>/<XPath>/<Type> element

<XPath>
   <Expression>/apigee:Greeting/apigee:User</Expression>
   <Type>string</Type>
   <Pattern>REGEX PATTERN</Pattern>
   <Pattern>REGEX PATTERN</Pattern>
</XPath>

<XMLPayload>/<XPath>/<Pattern> element

Definiuje wzorzec wyrażenia regularnego. Jeśli wyrażenie regularne w argumencie element<Pattern> zawiera znaki zarezerwowane przez XML (", &, ', < lub ), musisz go zakodować w formacie XML przed dołączeniem.

<XPath>
   <Expression>/apigee:Greeting/apigee:User</Expression>
   <Type>string</Type>
   <Pattern>REGEX PATTERN</Pattern>
   <Pattern>REGEX PATTERN</Pattern>
</XPath>

&lt;JSONPayload&gt; element

Określa, że informacje muszą zostać wyodrębnione z ładunku JSON i oceniane w odniesieniu do wyrażenia regularne.

<JSONPayload>
   <JSONPath>
      <Expression>$.store.book[*].author</Expression>
      <Pattern>REGEX PATTERN</Pattern>
      <Pattern>REGEX PATTERN</Pattern>
   </JSONPath>
</JSONPayload>

Atrybuty

&lt;JSONPayload&gt;/&lt;JSONPath&gt;/&lt;Expression&gt; element

Określa wyrażenie JSONPath zdefiniowane dla zmiennej.

<JSONPath>
   <Expression>$.store.book[*].author</Expression>
   <Pattern>REGEX PATTERN</Pattern>
   <Pattern>REGEX PATTERN</Pattern>
</JSONPath>

&lt;JSONPayload&gt;/&lt;JSONPath&gt;/&lt;Pattern&gt; element

Definiuje wzorzec wyrażenia regularnego. Jeśli wyrażenie regularne w parametrze Element <Pattern> zawiera znaki zarezerwowane w formacie XML (", &, ', < lub .), musisz go zakodować w formacie XML, zanim go umieścisz.

<JSONPath>
   <Expression>$.store.book[*].author</Expression>
   <Pattern>REGEX PATTERN</Pattern>
   <Pattern>REGEX PATTERN</Pattern>
</JSONPath>

Informacje o błędzie

This section describes the error codes and messages returned and fault variables set by Edge when this policy triggers an error. This information is important to know if you are developing fault rules to handle faults. If you want to capture an error and raise your own custom error, set the continueOnError="true" attribute on the policy root element. To learn more, see What you need to know about policy errors and Handling faults.

Errors returned from Edge policies follow a consistent format as described in the Error code reference.

Runtime errors

These errors can occur when the policy executes.

Deployment errors

Fault variables

These variables are set when this policy triggers an error. For more information, see What you need to know about policy errors.

Schematy

Powiązane artykuły

Zagrożenie w JSON Zasady ochrony

Zagrożenie w formacie XML Zasady ochrony