Фильтр ICAP (deprecated)#

Примечание

Данный механизм не рекомендован к использованию в SOWA. В качестве альтернативы рекомендуется использовать действие IcapFileChecker.

Фильтр ICAP позволяет отправить исходящий и входящий трафик в любую систему по протоколу ICAP. Такими системами могут быть АВПО или системы предупреждения утечек (DLP).

filter_icap

Тип параметра: группа параметров и их значения.

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

Опциональные параметры:
- request
  
  Тип параметра: группа параметров и их значения.
  
  По умолчанию: не имеет значения по умолчанию.
  
  Обязательные параметры:
  - icap_url
    
    В значении параметра указывается url внешнего антивируса.
    
    Тип параметра: строковое значение.
    
    По умолчанию: не имеет значения по умолчанию.
  - icap_mode
    
    В значении параметра указывается метод, использующийся при взаимодействии по протоколу ICAP.
    
    Тип параметра:
    - REQMOD;
    - RESPMOD.
    По умолчанию: не имеет значения по умолчанию.
  - icap_extensions
    
    В значении параметра указываются расширения файлов, которые необходимо направить антивирусу для проверки.
    icap_extensions: - .yml
    Тип параметра: последовательность строковых значений:
    - «*» — проверять все;
    - перечисление расширений начинающихся с «.» .
    По умолчанию: не имеет значения по умолчанию.
  - icap_custom_headers
    
    В значении параметра указывается секция заголовков для АВПО.
    
    Тип параметра: последовательность строковых значений.
    
    По умолчанию: не имеет значения по умолчанию.
  - icap_custom_http_headers
    
    В значении параметра указывается секция заголовков непосредственно запроса.
    
    Тип параметра: последовательность строковых значений.
    
    По умолчанию: не имеет значения по умолчанию.
  Опциональные параметры:
  - icap_silent
    
    В значении параметра задается флаг, в результате действия которого будет пропущен весь контент, независимо от результата проверки на вирусы.
    
    Тип параметра:
    - on;
    - off.
    По умолчанию:
    icap_silent: off
  - icap_body_temp_path
    
    В значении параметра задается путь к временным файлам.
    
    Тип параметра: строковое значение.
    
    По умолчанию:
    /sowarun/<profile_name>/body
  - icap_temp_buffer_size
    
    В значении параметра задается размер буфера временного файла.
    
    Тип параметра: строковое значение с суффиксом:
    - число без суффикса — байты;
    - k / K — килобайты;
    - m / M — мегабайты.
    По умолчанию:
    icap_temp_buffer_size: 32768
  - icap_max_none_buffered_size
    
    В значении параметра задается максимальный размер небуферизуемого контента.
    
    Тип параметра: строковое значение с суффиксом:
    - число без суффикса — байты;
    - k / K — килобайты;
    - m / M — мегабайты.
    По умолчанию:
    icap_max_none_buffered_size: 32768
  - icap_connect_timeout
    
    В значении параметра задается таймаут для установки соединения с антивирусом.
    
    Тип параметра: строковое значение с суффиксом:
    - ms — миллисекунды;
    - m / M — минуты;
    - s / S — секунды.
    По умолчанию:
    icap_connect_timeout: 10s
  - icap_read_timeout
    
    В значении параметра задается таймаут чтения контента.
    
    Тип параметра: строковое значение с суффиксом:
    - ms — миллисекунды;
    - m / M — минуты;
    - s / S — секунды.
    По умолчанию:
    icap_read_timeout: 10s
  - icap_write_timeout
    
    В значении параметра задается таймаут записи контента.
    
    Тип параметра: строковое значение с суффиксом:
    - ms — миллисекунды;
    - m / M — минуты;
    - s / S — секунды.
    По умолчанию:
    icap_write_timeout: 10s
  - icap_internal_error_code
    
    В значении параметра задается http статус код, который генерируется при соединении с ICAP сервисом (по умолчанию 500).
    
    Тип параметра: целочисленное значение.
  - icap_check_error_code
    
    В значении параметра указывается http статус код, который генерируется при блокировке сообщения антивирусом (по умолчанию 403).
    
    Тип параметра: целочисленное значение.
  - icap_internal_error_message
    
    В значении параметра указывается сообщение об ошибке, отправляемое клиенту при ошибке соединения с антивирусом (по умолчанию - пустая строка).
    
    Используется в случае:
    - icap_internal_error_message_file is None;
    Тип параметра: строковое значение.
  - icap_internal_error_message_file
    
    В значении параметра указывается файл, который содержит сообщение об ошибке, отправляемое клиенту в случае ошибки соединения с антивирусом (по умолчанию 0 пустая строка).
    
    Используется в случае:
    - icap_internal_error_message is None;
    Тип параметра: строковое значение.
  - icap_check_error_message_file
    
    В значении параметра указывается файл, который содержит сообщение об ошибке, отправляемое клиенту при блокировке сообщения антивирусом (по умолчанию — пустая строка).
    
    Используется в случае:
    - cap_check_error_message is None;
    Тип параметра: строковое значение.
  - icap_internal_error_content_type
    
    В значении параметра указывается контент-тип заголовка для сообщения об ошибке, отправляемого клиенту в случае ошибки подключения к антивирусу (по умолчанию — пустая строка).
    
    Тип параметра: строковое значение.
  - icap_check_error_content_type
    
    В значении параметра указывается контент-тип заголовка для сообщения об ошибке, отправляемого клиенту при блокировке сообщения антивирусом (по умолчанию — пустая строка).
    
    Тип параметра: строковое значение.
- response
  
  Тип параметра: группа параметров и их значения.
  
  По умолчанию: не имеет значения по умолчанию.
  
  Обязательные параметры:
  - icap_url
    
    В значении параметра указывается url внешнего антивируса.
    
    Имеется возможность использования регулярного выражения.
    
    Для использования символов
    
    \ ^ $ . | ? * + ( ) [ ] { } - в явном виде необходимо их экранирование.
    
    Тип параметра: строковое значение.
    
    По умолчанию: не имеет значения по умолчанию.
  - icap_mode
    
    В значении параметра указывается метод, использующийся при взаимодействии по протоколу ICAP.
    
    Тип параметра:
    - REQMOD;
    - RESPMOD.
    По умолчанию: не имеет значения по умолчанию.
  - icap_extensions
    
    В значении параметра указываются расширения файлов, которые необходимо направить антивирусу для проверки.
    icap_extensions: - .yml
    Тип параметра: последовательность строковых значений:
    - «*» проверять все;
    - перечисление расширений начинающихся с «.» .
    По умолчанию: не имеет значения по умолчанию.
  - icap_custom_headers
    
    В значении параметра указывается секция заголовков для АВПО.
    
    Тип параметра: последовательность строковых значений.
    
    По умолчанию: не имеет значения по умолчанию.
  - icap_custom_http_headers
    
    В значении параметра указывается секция заголовков непосредственно ответа.
    
    Тип параметра: последовательность строковых значений.
    
    По умолчанию: не имеет значения по умолчанию.
  Опциональные параметры:
  - icap_silent
    
    В значении параметра задается флаг, в результате действия которого будет пропущен весь контент, независимо от результата проверки на вирусы.
    
    Тип параметра:
    - on;
    - off.
    По умолчанию:
    icap_silent: off
  - icap_body_temp_path
    
    В значении параметра задается путь к временным файлам.
    
    Тип параметра: строковое значение.
    
    По умолчанию:
    /sowarun/<profile_name>/body
  - icap_temp_buffer_size
    
    В значении параметра задается размер буфера временного файла.
    
    Тип параметра: строковое значение с суффиксом:
    - число без суффикса — байты;
    - k / K — килобайты;
    - m / M — мегабайты.
    По умолчанию:
    icap_temp_buffer_size: 32768
  - icap_max_none_buffered_size
    
    В значении параметра задается максимальный размер небуферизуемого контента.
    
    Тип параметра: строковое значение с суффиксом:
    - число без суффикса — байты;
    - k / K — килобайты;
    - m / M — мегабайты.
    По умолчанию:
    icap_max_none_buffered_size: 32768
  - icap_connect_timeout
    
    В значении параметра задается таймаут для установки соединения с антивирусом.
    
    Тип параметра: строковое значение с суффиксом:
    - ms — миллисекунды;
    - m / M — минуты;
    - s / S — секунды.
    По умолчанию:
    icap_connect_timeout: 10s
  - icap_read_timeout
    
    В значении параметра задается таймаут чтения контента.
    
    Тип параметра: строковое значение с суффиксом:
    - ms — миллисекунды;
    - m / M — минуты;
    - s / S — секунды.
    По умолчанию:
    icap_read_timeout: 10s
  - icap_write_timeout
    
    В значении параметра задается таймаут записи контента.
    
    Тип параметра: строковое значение с суффиксом:
    - ms — миллисекунды;
    - m / M — минуты;
    - s / S — секунды.
    По умолчанию:
    icap_write_timeout: 10s
  - icap_internal_error_code
    
    В значении параметра задается http статус код, который генерируется при соединении с ICAP сервисом (по умолчанию 500).
    
    Тип параметра: целочисленное значение.
  - icap_check_error_code
    
    В значении параметра указывается http статус код, который генерируется при блокировке сообщения антивирусом (по умолчанию 403).
    
    Тип параметра: целочисленное значение.
  - icap_internal_error_message
    
    В значении параметра указывается сообщение об ошибке, отправляемое клиенту при ошибке соединения с антивирусом (по умолчанию - пустая строка).
    
    Используется в случае:
    - icap_internal_error_message_file is None;
    Тип параметра: строковое значение.
  - icap_internal_error_message_file
    
    В значении параметра указывается файл, который содержит сообщение об ошибке, отправляемое клиенту в случае ошибки соединения с антивирусом (по умолчанию 0 пустая строка).
    
    Используется в случае:
    - icap_internal_error_message is None;
    Тип параметра: строковое значение.
  - icap_check_error_message_file
    
    В значении параметра указывается файл, который содержит сообщение об ошибке, отправляемое клиенту при блокировке сообщения антивирусом (по умолчанию — пустая строка).
    
    Используется в случае:
    - cap_check_error_message is None;
    Тип параметра: строковое значение.
  - icap_internal_error_content_type
    
    В значении параметра указывается контент-тип заголовка для сообщения об ошибке, отправляемого клиенту в случае ошибки подключения к антивирусу (по умолчанию — пустая строка).
    
    Тип параметра: строковое значение.
  - icap_check_error_content_type
    
    В значении параметра указывается контент-тип заголовка для сообщения об ошибке, отправляемого клиенту при блокировке сообщения антивирусом (по умолчанию — пустая строка).
    
    Тип параметра: строковое значение.

Пример установки заголовков запросов/ответов:

avpo_custom_headers:
  - 'X-Dozor-Mapping-Schema': 'NewSystemSchema'
  - 'Host': '10.x.x.x'
  - 'X-Server-IP': '10.x.x.x'
  - 'X-Client-IP': '10.x.x.x'
avpo_custom_http_headers:
  - 'Host': 'localhost'
  - 'X-NewSystem-Sender-User-Login': '=?UTF-8?B?VEVTVERPTUFJTlx0ZXN0bG9naW4=?='
  - 'X-NewSystem-Recipient-User-Login': '=?UTF-8?B?VEVTVERPTUFJTlx0ZXN0bG9naW4sIFRFU1RET01BSU5cdGVzdGxvZ2luMiwgVEVTVERPTUFJTlx0ZXN0bG9naW4z?='
  - 'X-NewSystem-Application': 'NewSystem'
  - 'X-NewSystem-Message-ID': 'a3b88fe0-0547-11ea-eda0-adbbff4496fc'
  - 'X-NewSystem-Message-Date': '2020-10-19T14:07:34+03:00'
  - 'X-Custom-Header': '$http_content_type'