Политика RegularExpressionProtection

Вы просматриваете документацию Apigee Edge .
Перейдите в документацию Apigee X.info

Что

Извлекает информацию из сообщения (например, путь URI, параметр запроса, заголовок, параметр формы, переменная, полезная нагрузка XML или полезная нагрузка JSON) и сравнивает это содержимое с предопределенными регулярными выражениями. Если какое-либо из указанных регулярных выражений дает истинный результат, сообщение считается угрозой и отклоняется.

Видео

Посмотрите следующие видеоролики, чтобы узнать больше о политике защиты регулярных выражений.

Образцы

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

О политике защиты регулярных выражений

Apigee Edge позволяет настраивать регулярные выражения , которые могут быть проверены на API-трафике во время выполнения для выявления распространенных угроз на уровне контента, соответствующих определенным шаблонам.

Регулярное выражение , или сокращенно regex , — это набор строк, определяющих шаблон в строке. Регулярные выражения позволяют программно проверять содержимое на наличие шаблонов. Регулярные выражения можно использовать, например, для проверки адреса электронной почты, чтобы убедиться в его правильной структуре. Для получения дополнительной информации см. раздел «Регулярные выражения» в руководствах по Java.

Наиболее распространенное применение RegularExpressionProtection — это проверка JSON и XML-данных на наличие вредоносного содержимого.

Ни одно регулярное выражение не может полностью исключить атаки, основанные на содержании, и для обеспечения многоуровневой защиты следует комбинировать несколько механизмов. В этом разделе описаны некоторые рекомендуемые шаблоны для исключения содержимого.

Примеры схем исключения

Регулярные выражения должны быть закодированы в формате XML в конфигурационном XML-файле политики.

[\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.*

Установите заголовок Content-Type в запросе с полезной нагрузкой в ​​формате XML или JSON.

В состав политики защиты от регулярных выражений могут входить следующие элементы:

• Элемент <XMLPayload> : указывает, что информация должна быть извлечена из XML-данных и сопоставлена ​​с предоставленным регулярным выражением.

  Если в политике используется <XMLPayload> , заголовок Content-Type запроса должен содержать XML-тип содержимого, например, application/xml или text/xml .

• Элемент <JSONPayload> : указывает, что информация должна быть извлечена из JSON-данных и сопоставлена ​​с предоставленным регулярным выражением.

  Если в политике используется <JSONPayload> , заголовок Content-Type запроса должен содержать тип содержимого JSON, например, application/json .

Обычно API разрабатывается таким образом, чтобы принимать либо XML, либо JSON. Однако может возникнуть ситуация, когда API принимает оба формата. В этом случае можно определить политику защиты от регулярных выражений, которая использует как элементы <XMLPayload> , так и <JSONPayload> . Для конкретного запроса будет применяться только один элемент в зависимости от значения заголовка Content-Type .

Ссылка на элемент

В справочнике элементов описаны элементы и атрибуты политики 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>

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

В следующей таблице описаны атрибуты, общие для всех родительских элементов политики:

Элемент <DisplayName>

Используйте в дополнение к атрибуту name , чтобы пометить политику в редакторе прокси-сервера пользовательского интерфейса управления другим именем на естественном языке.

<DisplayName>Policy Display Name</DisplayName>

<Исходный> элемент

Указывает сообщение, из которого необходимо извлечь информацию.

Если элемент <Source> опущен, значение по умолчанию равно message . Например, <Source>message</Source> . Если установлено message , политика использует сообщение запроса в качестве источника при прикреплении к потоку запроса. Аналогично, политика использует сообщение ответа при прикреплении к потоку ответа.

Если исходное сообщение не может быть разрешено или если оно разрешается в тип, отличный от сообщения, политика возвращает ошибку.

<Source>response</Source>

элемент <IgnoreUnresolvedVariables>

Определяет, будет ли политика возвращать ошибку при обнаружении неразрешимой переменной.

Если установлено значение false (по умолчанию), политика возвращает ошибку при обнаружении неразрешимой переменной. Если установлено значение true , неразрешенная переменная рассматривается как пустая строка (Null).

<IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>

элемент <URIPath>

Указывает, что информация должна быть извлечена из пути URI запроса и сопоставлена ​​с предоставленными регулярными выражениями. Необходимо указать как минимум один элемент <Pattern> , определяющий шаблон регулярного выражения для сопоставления.

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

<QueryParam> элемент

Указывает, что информация должна быть извлечена из параметра запроса и сопоставлена ​​с предоставленными регулярными выражениями. Необходимо указать как минимум один элемент <Pattern> , определяющий шаблон регулярного выражения для сопоставления.

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

Атрибуты

<Заголовок> элемент

Указывает, что информация должна быть извлечена из заголовков запроса и ответа и сопоставлена ​​с предоставленными регулярными выражениями. Необходимо предоставить как минимум один элемент <Pattern> , определяющий шаблон регулярного выражения для сопоставления.

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

Атрибуты

<FormParam> элемент

Указывает, что информация должна быть извлечена из параметра формы запроса и проверена на соответствие предоставленным регулярным выражениям. Необходимо указать как минимум один элемент <Pattern> , определяющий шаблон регулярного выражения для сопоставления.

<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> элемент

Указывает, что информация должна быть извлечена из XML-данных и проверена на соответствие предоставленным регулярным выражениям.

<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> элемент

Указывает пространства имен, которые будут использоваться при вычислении 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>

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

Атрибуты

<XMLPayload>/<XPath> элемент

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

<XMLPayload>/<XPath>/<Expression> элемент

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

<XMLPayload>/<XPath>/<Type> элемент

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

<XMLPayload>/<XPath>/<Pattern> элемент

Определяет шаблон регулярного выражения. Если регулярное выражение в вашем элементе <Pattern> содержит зарезервированные XML-символы (", &, ', < или .), его необходимо закодировать в XML перед включением.

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

элемент <JSONPayload>

Указывает, что информация должна быть извлечена из JSON-данных и проверена на соответствие предоставленным регулярным выражениям.

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

Атрибуты

<JSONPayload>/<JSONPath>/<Expression> элемент

Указывает выражение JSONPath, определенное для переменной.

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

<JSONPayload>/<JSONPath>/<Pattern> элемент

Определяет шаблон регулярного выражения. Если регулярное выражение в вашем элементе <Pattern> содержит зарезервированные XML-символы (", &, ', < или .), его необходимо закодировать в XML перед включением.

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

Ссылка на ошибку

В этом разделе описаны коды ошибок и возвращаемые сообщения, а также переменные ошибки, установленные Edge, когда эта политика вызывает ошибку. Эту информацию важно знать, если вы разрабатываете правила обработки ошибок. Если вы хотите зафиксировать ошибку и создать собственную пользовательскую ошибку, установите атрибут continueOnError="true" в корневом элементе политики. Дополнительные сведения см. в разделах Что нужно знать об ошибках политики и Обработка ошибок .

Ошибки, возвращаемые политиками Edge, имеют единообразный формат, как описано в справочнике по кодам ошибок .

Ошибки выполнения

Эти ошибки могут возникнуть при выполнении политики.

Ошибки развертывания

Переменные неисправности

Эти переменные устанавливаются, когда эта политика вызывает ошибку. Дополнительные сведения см. в разделе Что нужно знать об ошибках политики .

Схемы

Связанные темы

Политика защиты от угроз JSON

Политика защиты от угроз XML