Шаблоны уведомлений

Dr.Web ICAPD использует два типа шаблонов уведомлений – HTML-шаблоны и mail-шаблоны.

1)HTML-шаблоны используются для формирования уведомлений, показываемых клиенту в браузере в ответ на попытку обращения к заблокированному ресурсу или загрузки вредоносного или подозрительного объекта, если в результате проверки полученных от удаленного сервера данных было применено "предотвращающее" действие Move или Report.

2)mail-шаблоны используются для формирования почтовых уведомлений, отправляемых администратору при возникновении инцидентов (в зависимости от разрешений на отправку уведомлений, заданных в настройках).

Все шаблоны представляют собой обычные текстовые файлы, расположенные в каталоге %etc_dir/templates/icapd[_lng], где _lng – суффикс в имени каталога, указывающий, какой язык используется в шаблонах, находящихся в этом каталоге (например, ru для русского языка, ja для японского и т.д.). Подкаталог /icapd без добавленного суффикса хранит шаблоны уведомлений на английском языке и должен присутствовать всегда.

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

Имя файла

Описание

ERR_FAILED_CHECK

HTML-шаблон с отчетом об ошибке сканирования файла

ERR_DOWNLOAD_BLOCK

HTML-шаблон с отчетом об ошибке доступа к заблокированной веб-странице (из черного списка)

ERR_ACCESS_DENIED

HTML-шаблон с отчетом об ошибке загрузки файла с запрещенным содержимым. Данный отчет генерируется в случае, когда соответствующим параметром задано действие информировать (Report)

ERR_ACCESS_DENIED_MOVED

HTML-шаблон с отчетом об ошибке загрузки файла с запрещенным содержимым. Данный отчет генерируется в случае, когда соответствующим параметром задано действие переместить (Move)

email.templ

mail-шаблон почтового сообщения, которое посылается администратору на почтовый адрес, указанный в праметре Hostmaster

1. HTML-шаблоны

Все HTML-шаблоны по внутренней структуре представляют собой корректный HTML-файл, который может включать в себя, в том числе, стилевые таблицы и даже JavaScript, но не должен включать в себя внедренные объекты и изображения, а также URL любых ресурсов, расположенных вне файла (например, нельзя подключать стилевую таблицу из CSS-файла).

В текст HTML-шаблона могут быть внедрены (в любое место внутри HTML-структуры) специальные маркеры-заместители, которые при генерации HTML-страницы на основе данного шаблона будут заменены на соответствующий текст. В HTML-шаблонах разрешается использование следующих маркеров:

Маркер

Описание

$DAEMON_REPORT$

Заменяется на строку отчета от Dr.Web Daemon, содержащую причину возникшего инцидента (например, был найден вирус или файл не мог быть проверен вследствие установленных ограничений и т.п.)

$DATE$

Заменяется на строку даты и времени генерации уведомления

$FILE_NAME_ERROR$

Заменяется на путь к файлу, помещенному в Карантин

$HOSTMASTER$

Заменяется на почтовый адрес администратора (значение параметра Hostmaster из настроек)

$MANUAL_SUBMIT$

Заменяется на форму, содержащую кнопку, нажатие которой приводит к отправке в Доктор Веб информации об инциденте.

Текст на кнопке задается строкой, следующей непосредственно после маркера, например: $MANUAL_SUBMIT$Отправить!

$RELEASE$

Заменяется на информацию о текущем установленном релизе продукта (включает название и версию продукта, а также Антивирусного ядра).

$URL$

Заменяется на полный URL исходного запрошенного ресурса

$URL_SHORT$

Заменяется на укороченный URL исходного запрошенного ресурса

$VERSION$

Заменяется на номер текущей версии Dr.Web ICAPD

Пример HTML-шаблона:

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
 <title>Blocked by Dr.Web ICAPD</title>
</head>
<body>
 <H1>Content blocked!</H1>
 <p>Access to this resource is denied due to administration policy.<br/>
    Please save content of this page and ask your
    <a href="mailto:$HOSTMASTER$">system administrator</a>
    for further instructions.
 </p>
 <H2>Details:</H2>
 <p><strong>Restricted URL: </strong><a href="$URL$">$URL_SHORT$</a></p>
 <p><strong>Reason: </strong><pre>$DAEMON_REPORT$</pre></p>
 <H2>Product information:</H2>
 <p><strong>Release: </strong><pre>$RELEASE$</pre></p>
 <p><strong>Version: </strong><pre>Dr.Web ICAPD $VERSION$</pre></p>
 <p>$MANUAL_SUBMIT$Notify Dr.Web</p>
</body>
</html>

2. mail-шаблоны

В текущей версии Dr.Web ICAPD использует только один mail-шаблон: шаблон email.templ письма администратору о произошедшем инциденте. По внутренней структуре этот шаблон представляет собой структуру корректного письма в формате MIME multipart/mixed.

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

Маркер

Описание

$ACTION$

Заменяется на название действия, примененного к объекту

$HOSTMASTER$

Заменяется на почтовый адрес администратора (значение параметра Hostmaster из настроек)

$HTML_PAGE$

Заменяется на содержимое страницы уведомления, которая была показана пользователю

$IP$

Заменяется на IP-адрес пользователя, запросившего запрещенный объект

$REASON$

Заменяется на причину инцидента (например, был найден вирус или файл не мог быть проверен вследствие установленных ограничений и т.п.)

$SIZE$

Заменяется на размер запрещенного объекта

$TIME$

Заменяется на строку даты и времени генерации уведомления

$URL$

Заменяется на полный URL исходного запрошенного ресурса

Пример mail-шаблона:

From: "DrWeb-ICAP" <drweb-icapd>
To: "System Administrator" <$HOSTMASTER$>
Subject: $REASON$
Content-Type: multipart/mixed;
             boundary="001-DrWeb-Icapd-Notification"
MIME-Version: 1.0
Precedence: junk
X-Antivirus-Ticket: Dr.Web notification.
 
--001-DrWeb-Icapd-Notification
Content-Type: text/plain; charset=iso-8859-1
Content-Transfer-Encoding: 7bit
 
Url: $URL$
Reason: $REASON$
Action: $ACTION$
Time: $TIME$
Client-IP: $IP$
Object size: $SIZE$
 
--001-DrWeb-Icapd-Notification
Content-Type: text/html; charset=iso-8859-1
Content-Transfer-Encoding: 7bit
 
$HTML_PAGE$
--001-DrWeb-Icapd-Notification--
 

Внимание!

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

Имеется возможность изменить содержимое шаблонов прямо на специальной странице веб-интерфейса Dr.Web консоль для интернет-шлюзов UNIX.