Настройки авторизации

В этой статье описан раздел Авторизация на странице Настройки.

Если при загрузке веб-страницы произошла ошибка и настройки недоступны, перезагрузите страницу.

Раздел Авторизация содержит следующие параметры:

• Включить авторизацию для HTTP-клиентов. Указывает, следует ли Kaspersky Scan Engine использовать авторизацию по токену API.

  Для авторизации токена API требуется HTTPS-соединение.

• Поле заголовка авторизации. Имя поля заголовка запроса, содержащего токен API. Значение, которое вы указываете здесь, должно соответствовать следующим требованиям:
  • длина от 3 до 40 символов;
  • содержит только символы, разрешенные для имен полей заголовков в соответствии с RFC 7230.

  Значение по умолчанию: Авторизация.

• Добавить префикс носителя. Указывает, поддерживает ли Kaspersky Scan Engine схему аутентификации Bearer. Если этот переключатель включен, Kaspersky Scan Engine ожидает, что поле заголовка запроса, имя которого указано в Поле заголовка авторизации, начинается с префикса Bearer.

Управление токенами

Таблица API-токены содержит следующую информацию об API-токенах:

• Имя токена. Каждый токен имеет уникальное имя.
• Описание. Некоторые описания могут отсутствовать. Это свойство необязательно.
• Состояние. Kaspersky Scan Engine авторизует HTTP-клиент, только если его токен включен.

Из таблицы вы можете редактировать () или удалять() существующие токены. Редактирование токена аналогично добавлению токена (см. инструкцию ниже).

Чтобы добавить новый токен:

1. Нажмите на кнопку Добавить токен.
2. Укажите параметры нового токена:
   • Имя. Уникальное имя токена. Имя должно содержать от 1 до 40 символов Unicode.
   • Описание. Дополнительная информация о токене. Например, имя владельца токена. Описание может содержать до 1000 символов Unicode.
   • Токен. Токен, который клиент должен отправить в Kaspersky Scan Engine API для авторизации. Значение должно быть уникальным и содержать от 4 до 100 символов ASCII. Должна быть как минимум одна заглавная и одна строчная буква латинского алфавита, одна цифра и один из следующих специальных символов: -._~+/).

     Чтобы Kaspersky Scan Engine сгенерировал для вас уникальный токен, нажмите кнопку Сгенерировать токен. Сгенерированный токен появится в поле Токен. Вы можете изменить это значение, если хотите.

     Скопируйте токен для дальнейшего использования. После нажатия кнопки Сохранить токен будет недоступен в Kaspersky Scan Engine GUI. В файле конфигурации kavhttpd.xml значение токена зашифровано. Если вы забыли или потеряли токен, вы можете создать новый.

   • Включить токен. Включите этот переключатель, если вы хотите, чтобы Kaspersky Scan Engine авторизовывал клиентов, указавших токен в заголовке запроса. Если переключатель выключен, Kaspersky Scan Engine не авторизует клиентов, указавших токен в заголовке запроса.

     Если вы включили авторизацию по токену API и служба kavhttpd не запущена, запуск klScanEngineUI также инициирует запуск службы kavhttpd.

3. Нажмите Сохранить.

Новый токен появится в таблице API-токены.

Известная проблема

Антивирусные базы данных невозможно обновить нажатием на кнопку Обновление, если используется авторизация с помощью API-токена. Вы можете получить обновления либо с помощью HTTP-клиента, либо путем направления запроса POST к /api/v3.0/update/start (например, с помощью curl). Эта проблема не затрагивает автоматические обновления по расписанию.

Чтобы обновить антивирусные базы через HTTP-клиент,

выполните следующую команду:

./kavhttp_client -s https://<IP>:<port> --access-token <your API token> --add-bearer-prefix -d -j

Ответ должен содержать информацию о результатах обновления, например:

Server address: https://127.0.0.1:9000

Network timeout: 2000

{

"status": "update started"

}

Чтобы получить информацию о статусе обновления через HTTP-клиент,

выполните следующую команду:

./kavhttp_client -s https://<IP>:<port> --access-token <your API token> --add-bearer-prefix -p -j

Ответ должен содержать информацию о статусе обновления, например:

Server address: https://127.0.0.1:9000

Network timeout: 2000

{

"status": "not started",

"last_update_result": "success",

"last_update_time": "07:59:36 07.05.2026"

}

Чтобы обновить антивирусные базы данных с помощью curl,

направьте запрос POST к /api/v3.0/update/start следующим образом:

curl -X POST "https://<host>:<port>/api/v3.0/update/start" \

-H "Authorization: Bearer <your API token>" \

-H "Content-Type: application/octet-stream" \

-d "{}"

Если используется самоподписанный сертификат, добавьте параметр --insecure. Обратите внимание, что это может влиять на безопасность.

Ответ должен содержать информацию о результатах обновления:

{

"status": "update finished successfully"

}