Пaраметр log_masking_rules#

Последовательность параметров log_masking_rules предназначена для задания правил маскирования чувствительной информации в логах событий и логов транзакции фильтров безопасности.

Опциональные параметры:

log_masking_rules

Тип параметра: последовательность параметров и их значения.

По умолчанию: значение задается пользователем.

Обязательные параметры:
- object
  
  В значении параметра указывается объект, к которому применяется маскирование.
  
  Тип параметра: текстовое значение:
  - request_header - заголовки запроса;
  - response_header - заголовки ответа;
  - request_body - тело запроса;
  - response_body - тело ответа;
  - request_cookie - куки запроса
  - response_cookie - куки ответа.
- cookie
  
  В значении параметра указывается имя куки, к которой применяется маскирование.
  
  Обязательно в случае:
  - object: request_cookie;
  - object: response_cookie.
  Тип параметра: текстовое значение.
Опциональные параметры:
- log_type
  
  В значении параметра определяется тип логов.
  
  Тип параметра: текстовое значение:
  - all - все типы;
  - security - логи транзакций фильтра безопасности;
  - event - логи событий.
  По умолчанию:
```
log_type: all
```
- header
  
  В значении параметра объявляется имя заголовка, к которому применяется маскирование.
  
  Обязательно в случае:
  - object: request_header;
  - object: response_header.
  Тип параметра: текстовое значение.
  
  По умолчанию: значение задается пользователем.
- mask_symbol
  
  В значении параметра определяется какой символ будет использоваться для замены.
  
  Тип параметра: текстовое значение.
  
  По умолчанию:
```
mask_symbol: "*"
```
- expression
  
  Регулярное выражение, содержащее группы.
  
  Должно содержать хотя бы одну группу для определения фрагмента замены.
  
  Обязательно в случае:
  - object: request_body;
  - object: response_body.
  Тип параметра: текстовое значение.
  
  По умолчанию: значение задается пользователем.
- replace_group
  
  В значении параметра указывается номер группы в выражении, которая будет использоваться для замены тела запроса или ответа. Если 0 - замена строки полного соответствия.
  
  Используется в случае:
  - object: request_body;
  - object: response_body.
  Тип параметра: текстовое значение. Диапазон от 0 до 9.
  
  По умолчанию: значение задается пользователем.
- replace_all
  
  В значении параметра определяется, заменять все или первое найденное значение. В том случае, если гарантировано вхождение будет только один раз рекомендуется устанавливать явно значение off для оптимизации производительности.
  
  Тип параметра: текстовое значение.
  - on;
  - off.
  По умолчанию:
```
replace_all: "on"
```
- exclusion
  
  Определяет исключающее маскирование - маскировать все, кроме указанного элемента (может быть несколько).
  
  Допустимо для object = request_header, response_header, request_cookie, response_cookie.
  
  Для одного типа объектов не может быть одновременно и обычное маскирование и исключающее.
  
  Тип параметра: булевое значение.
  - true;
  - false.
  По умолчанию:
```
exclusion: "false"
```

Пример:

optional:
  log_masking_rules:
    - object: request_header
      header: TOKEN
      mask_symbol: "*"
    - object: request_body
      expression: (cardNumber\W*)([\w\ ]*)
      replace_group: 2
      replace_all: on