Правило RegularExpressionProtection

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

Что

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

Видео

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

Примеры

<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, – это набор строк, которые задают шаблон в строке. Регулярные выражения позволяют программно оценивать контент на соответствие шаблонам. Регулярные выражения можно использовать, например, для проверки правильности структуры адреса электронной почты. Подробнее о регулярных выражениях…

Чаще всего 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>

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

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

Атрибуты

Элемент <Header>

Указывает, что информацию нужно извлечь из заголовков запросов и ответов и сопоставить с предоставленными регулярными выражениями. Вы должны указать хотя бы один элемент <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>

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

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