get-byte-match-set

Описание

Примечание

Это документация по AWS WAF Classic. Для получения дополнительной информации см. AWS WAF Classic в руководстве разработчика.

Для последней версии AWS WAF используйте API AWS WAFV2 и см. руководство разработчика AWS WAF. В последней версии AWS WAF имеется единый набор конечных точек для регионального и глобального использования.

Возвращает ByteMatchSet, указанный в ByteMatchSetId.

См. также: Документацию API AWS

Синтаксис

  get-byte-match-set
--byte-match-set-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Параметры

--byte-match-set-id (строка)

Идентификатор ByteMatchSet, который вы хотите получить. ByteMatchSetId возвращается методами CreateByteMatchSet и ListByteMatchSets.

--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной JSON-строки. JSON-строка следует формату, указанному в --generate-cli-skeleton. Если на командной строке указаны другие аргументы, эти значения переопределят значения из JSON. Передача произвольных двоичных значений с помощью JSON невозможна, так как строка будет воспринята буквально. Это не может быть указано вместе с --cli-input-yaml.

--generate-cli-skeleton (строка) Выводит JSON-скелет в стандартный вывод без отправки запроса к API. Если не указано значение или указано значение input, выводится пример JSON-ввода, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, если указано значение yaml-input, будет напечатан пример ввода YAML, который можно использовать с --cli-input-yaml. Если указано значение output, выполняется валидация входных данных команды и возвращается пример выходного JSON для этой команды. Сгенерированный JSON-скелет нестабилен между версиями AWS CLI, и нет гарантий обратной совместимости в сгенерированном JSON-скелете.

Глобальные параметры

--debug (логическое значение)

Включить отладочную запись журнала.

--endpoint-url (строка)

Переопределить URL по умолчанию команды на указанный URL.

--no-verify-ssl (логическое значение)

По умолчанию AWS CLI использует SSL при общении с AWS-сервисами. Для каждого SSL-соединения AWS CLI проверит сертификаты SSL. Этот параметр переопределяет поведение проверки сертификатов SSL по умолчанию.

--no-paginate (логическое значение)

Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один вызов для первой страницы результатов.

--output (строка)

Стиль форматирования вывода команды.

json
text
table
yaml
yaml-stream

--query (строка)

Запрос JMESPath для фильтрации данных ответа.

--profile (строка)

Использовать определённый профиль из вашего файла учетных данных.

--region (строка)

Регион для использования. Переопределяет настройки конфигурации/среды.

--version (строка)

Отобразить версию этого инструмента.

--color (строка)

Включить/выключить цветной вывод.

on
off
auto

--no-sign-request (логическое значение)

Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент предоставлен.

--ca-bundle (строка)

Пакет сертификатов CA для проверки сертификатов SSL. Переопределяет настройки конфигурации/среды.

--cli-read-timeout (целое число)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию составляет 60 секунд.

--cli-connect-timeout (целое число)

Максимальное время подключения сокета в секундах. Если значение установлено в 0, подключение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию составляет 60 секунд.

--cli-binary-format (строка)

Стиль форматирования, используемый для двоичных блоков. Формат по умолчанию — base64. Формат base64 ожидает, что двоичные блоки будут предоставлены как закодированная строка base64. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI V1, а двоичные значения должны быть переданы буквально. При предоставлении содержимого из файла, соответствующего двоичному блоку, fileb:// всегда будет обрабатываться как двоичное и будет использовать содержимое файла непосредственно, независимо от настройки cli-binary-format. При использовании file:// содержимое файла должно быть правильно отформатировано для настроенного cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (логическое значение)

Отключить кли-пейджер для вывода.

--cli-auto-prompt (логическое значение)

Автоматически запросить параметры ввода CLI.

--no-cli-auto-prompt (логическое значение)

Отключить автоматическое запросить параметры ввода CLI.

Вывод

ByteMatchSet -> (структура)

Информация о ByteMatchSet, указанном в запросе GetByteMatchSet. Для получения дополнительной информации см. следующие разделы:

ByteMatchSet : Содержит ByteMatchSetId, ByteMatchTuples и Name
ByteMatchTuples : Содержит массив объектов ByteMatchTuple. Каждый объект ByteMatchTuple содержит FieldToMatch, PositionalConstraint, TargetString и TextTransformation
FieldToMatch : Содержит Data и Type

ByteMatchSetId -> (строка)

Идентификатор ByteMatchSetId для ByteMatchSet. Вы используете ByteMatchSetId для получения информации о ByteMatchSet (см. GetByteMatchSet), обновления ByteMatchSet (см. UpdateByteMatchSet), вставки ByteMatchSet в Rule или удаления из Rule (см. UpdateRule), и удаления ByteMatchSet из AWS WAF (см. DeleteByteMatchSet).

ByteMatchSetId возвращается методами CreateByteMatchSet и ListByteMatchSets.

Name -> (строка)

Дружественное имя или описание ByteMatchSet. Вы не можете изменить Name после создания ByteMatchSet.

ByteMatchTuples -> (список)

Указывает байты (обычно строку, соответствующую символам ASCII), которые вы хотите, чтобы AWS WAF искал в веб-запросах, местоположение в запросах, которое вы хотите, чтобы AWS WAF искал, и другие параметры.

(структура)

Примечание

Это документация для AWS WAF Classic. Дополнительную информацию см. в руководстве разработчика для AWS WAF Classic.

Для последней версии AWS WAF используйте API AWS WAFV2 и см. руководство разработчика AWS WAF. В последней версии AWS WAF используется единый набор конечных точек для региональных и глобальных случаев использования.

Байты (обычно строка, соответствующая символам ASCII), которые вы хотите, чтобы AWS WAF искал в веб-запросах, местоположение в запросах, которое вы хотите, чтобы AWS WAF искал, и другие параметры.

FieldToMatch -> (структура)

Часть веб-запроса, которую вы хотите, чтобы AWS WAF искал, например, указанный заголовок или строку запроса. Дополнительную информацию см. в разделе FieldToMatch.

Type -> (строка)

Часть веб-запроса, которую вы хотите, чтобы AWS WAF искал заданную строку. Части запроса, которые можно искать, включают следующее:

HEADER : Указанный заголовок запроса, например, значение заголовка User-Agent или Referer. Если вы выберете HEADER для типа, укажите имя заголовка в Data.
METHOD : HTTP-метод, указывающий тип операции, которую запрос просит выполнить источнику. Amazon CloudFront поддерживает следующие методы: DELETE , GET , HEAD , OPTIONS , PATCH , POST и PUT.
QUERY_STRING : Строка запроса, которая является частью URL, появляющейся после символа ?, если он есть.
URI : Часть веб-запроса, определяющая ресурс, например, /images/daily-ad.jpg.
BODY : Часть запроса, содержащая дополнительные данные, которые вы хотите отправить на свой веб-сервер в качестве тела HTTP-запроса, например, данные из формы. Тело запроса следует непосредственно за заголовками запроса. Обратите внимание, что только первые 8192 байтов тела запроса передаются AWS WAF для проверки. Чтобы разрешить или заблокировать запросы на основе длины тела, вы можете создать набор ограничений размера. Дополнительную информацию см. в разделе CreateSizeConstraintSet.
SINGLE_QUERY_ARG : Параметр в строке запроса, который вы будете проверять, например, UserName или SalesRegion. Максимальная длина для SINGLE_QUERY_ARG составляет 30 символов.
ALL_QUERY_ARGS : Аналогично SINGLE_QUERY_ARG, но вместо проверки одного параметра AWS WAF проверит все параметры в строке запроса на значение или шаблон регулярных выражений, который вы укажете в TargetString.

Data -> (строка)

Когда значение Type равно HEADER, введите имя заголовка, который вы хотите, чтобы AWS WAF искал, например, User-Agent или Referer. Название заголовка не чувствительно к регистру.

Когда значение Type равно SINGLE_QUERY_ARG, введите имя параметра, который вы хотите, чтобы AWS WAF искал, например, UserName или SalesRegion. Название параметра не чувствительно к регистру.

Если значение Type имеет другое значение, опустите Data.

TargetString -> (blob)

Значение, которое вы хотите, чтобы AWS WAF искал. AWS WAF ищет указанную строку в части веб-запросов, которую вы указали в FieldToMatch. Максимальная длина значения составляет 50 байт.

Допустимые значения зависят от значений, которые вы указали для FieldToMatch:

HEADER : Значение, которое вы хотите, чтобы AWS WAF искал в заголовке запроса, который вы указали в FieldToMatch, например, значение заголовка User-Agent или Referer.
METHOD : HTTP-метод, указывающий тип операции, указанный в запросе. CloudFront поддерживает следующие методы: DELETE , GET , HEAD , OPTIONS , PATCH , POST и PUT.
QUERY_STRING : Значение, которое вы хотите, чтобы AWS WAF искал в строке запроса, которая является частью URL, появляющейся после символа ?.
URI : Значение, которое вы хотите, чтобы AWS WAF искал в части URL, определяющей ресурс, например, /images/daily-ad.jpg.
BODY : Часть запроса, содержащая дополнительные данные, которые вы хотите отправить на свой веб-сервер в качестве тела HTTP-запроса, например, данные из формы. Тело запроса следует непосредственно за заголовками запроса. Обратите внимание, что только первые 8192 байтов тела запроса передаются AWS WAF для проверки. Чтобы разрешить или заблокировать запросы на основе длины тела, вы можете создать набор ограничений размера. Дополнительную информацию см. в разделе CreateSizeConstraintSet.
SINGLE_QUERY_ARG : Параметр в строке запроса, который вы будете проверять, например, UserName или SalesRegion. Максимальная длина для SINGLE_QUERY_ARG составляет 30 символов.
ALL_QUERY_ARGS : Аналогично SINGLE_QUERY_ARG, но вместо проверки одного параметра AWS WAF проверяет все параметры в строке запроса на значение или шаблон регулярных выражений, который вы укажете в TargetString.

Если TargetString включает буквы A-Z и a-z, обратите внимание, что значение чувствительно к регистру.

Если вы используете API AWS WAF

Укажите кодированную в base64 версию значения. Максимальная длина значения перед кодированием в base64 составляет 50 байт.

Например, предположим, что значение Type равно HEADER, а значение Data равно User-Agent. Если вы хотите найти заголовок User-Agent со значением BadBot, закодируйте BadBot в base64 с использованием MIME base64-кодирования и включите полученное значение, QmFkQm90, в значение TargetString.

Если вы используете AWS CLI или один из AWS SDK

Значение, которое вы хотите, чтобы AWS WAF искал. SDK автоматически кодирует значение в base64.

TextTransformation -> (строка)

Преобразования текста устраняют некоторые необычные форматы, которые злоумышленники используют в веб-запросах, пытаясь обойти AWS WAF. Если вы укажете преобразование, AWS WAF выполнит преобразование над FieldToMatch перед проверкой на соответствие.

Вы можете указать только один тип TextTransformation.

CMD_LINE

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

Удалить следующие символы: “ ‘ ^
Удалить пробелы перед следующими символами: / (
Заменить следующие символы пробелом: , ;
Заменить несколько пробелов одним пробелом
Преобразовать заглавные буквы (A-Z) в строчные (a-z)

COMPRESS_WHITE_SPACE

Используйте этот параметр для замены следующих символов пробелом (десятичное 32):

f, разделитель формы, десятичное 12
t, табуляция, десятичное 9
n, перевод строки, десятичное 10
r, возврат каретки, десятичное 13
v, вертикальная табуляция, десятичное 11
неразрывный пробел, десятичное 160

COMPRESS_WHITE_SPACE также заменяет несколько пробелов одним пробелом.

HTML_ENTITY_DECODE

Используйте этот параметр для замены кодированных HTML-символов на некодированные символы. HTML_ENTITY_DECODE выполняет следующие действия:

Заменяет (ampersand)quot; на "
Заменяет (ampersand)nbsp; на неразрывный пробел, десятичное 160
Заменяет (ampersand)lt; на символ «меньше чем»
Заменяет (ampersand)gt; на >
Заменяет символы, представленные в шестнадцатеричном формате, (ampersand)#xhhhh;, на соответствующие символы
Заменяет символы, представленные в десятичном формате, (ampersand)#nnnn;, на соответствующие символы

LOWERCASE

Используйте этот параметр для преобразования заглавных букв (A-Z) в строчные (a-z).

URL_DECODE

Используйте этот параметр для декодирования URL-кодированного значения.

NONE

Укажите NONE, если вы не хотите выполнять никаких преобразований текста.

PositionalConstraint -> (строка)

В части веб-запроса, которую вы хотите искать (например, в строке запроса, если она есть), укажите, где вы хотите, чтобы AWS WAF искал. Допустимые значения включают следующие:

CONTAINS

Указанная часть веб-запроса должна содержать значение TargetString, но местоположение не имеет значения.

CONTAINS_WORD

Указанная часть веб-запроса должна содержать значение TargetString, и TargetString должны содержать только буквенно-цифровые символы или символ подчеркивания (A-Z, a-z, 0-9 или _). Кроме того, TargetString должно быть словом, что означает одно из следующего:

TargetString точно соответствует значению указанной части веб-запроса, например, значению заголовка.
TargetString находится в начале указанной части веб-запроса и следует за символом, отличным от буквенно-цифрового символа или символа подчеркивания (_), например, BadBot;.
TargetString находится в конце указанной части веб-запроса и предшествует символу, отличного от буквенно-цифрового символа или символа подчеркивания (_), например, ;BadBot.
TargetString находится посередине указанной части веб-запроса и предшествует и следует за символами, отличными от буквенно-цифровых символов или символа подчеркивания (_), например, -BadBot;.

EXACTLY

Значение указанной части веб-запроса должно точно соответствовать значению TargetString.

STARTS_WITH

Значение TargetString должно появляться в начале указанной части веб-запроса.

ENDS_WITH

Значение TargetString должно появляться в конце указанной части веб-запроса.