Изменение конфигурации сервера Kaspersky Password Manager для бизнеса

Вы можете изменить параметры сервера Kaspersky Password Manager для бизнеса с помощью следующих конфигурационных файлов:

Windows

%ProgramFiles(x86)%\Kaspersky Lab\Kaspersky Password Manager Server <version>\JobAgent\appsettings.Release.json
%ProgramFiles(x86)%\Kaspersky Lab\Kaspersky Password Manager Server <version>\ServerApp\appsettings.Release.json

Linux

/opt/kaspersky/kpmserver/server_app/appsettings.Release.json
/opt/kaspersky/kpmserver/job_agent/appsettings.Release.json

Эти конфигурационные файлы автоматически создаются в каталоге установки сервера Kaspersky Password Manager для бизнеса на устройствах, на которых развернуты экземпляры сервера Kaspersky Password Manager для бизнеса.

Как применить изменения в файлах конфигурации?

Для Windows:

Для применения изменений администратору необходимо обновить значения параметров в этих файлах, а затем перезапустить службы сервера Kaspersky Password Manager для бизнеса (Kaspersky Password Manager for Business Server Job Agent и Kaspersky Password Manager for Business Server Web API).

Если конфигурационный файл содержит некорректные значения или имеет неправильный формат, служба Kaspersky Password Manager for Business Server Web API не запустится.

Для Linux:

Чтобы применить изменения, выполните следующие команды:

systemctl restart kpm-api

systemctl restart kpm-worker

Список параметров, которые можно изменить в файлах конфигурации

Следующие параметры могут быть изменены в конфигурационных файлах appsettings.Release.json:

Параметры для служб

Параметр

Описание

Kestrel.Endpoints.Https.Url (по умолчанию)

Kestrel.Endpoints.Http.Url (если указан --use_http)

Значение по умолчанию: https://0.0.0.0:3000 или http://0.0.0.0:3000

Номер порта для подключения к серверу Kaspersky Password Manager для бизнеса.

Допустимые значения от 0 до 65535. Максимальная длина - 5 символов. Если оставить поле пустым, установщик будет использовать значение по умолчанию.

Kpm.HttpsCertificate.Path

Путь к файлу сертификата (PFX) на устройстве.

Параметры базы данных

Параметр

Описание

Тип базы данных

Этот параметр указывается в составе следующих параметров:

ConnectionStrings.ReadWriteConnection,

ConnectionStrings.ReadOnlyConnection

Пример:

postgresql://kpmuser:pwd@localhost:5432/KpmDb

где postgresql - тип базы данных.

Тип базы данных.

MySQL – будет использоваться либо MySQL, либо MariaDB.
MSSQL – будет использоваться Microsoft SQL Server.
PostgreSQL – один из следующих вариантов:
- PostgreSQL
- Postgres Pro
- Platform V Pangolin
- Jatoba

Имя экземпляра базы данных

Этот параметр указывается в составе следующих параметров:

ConnectionStrings.ReadWriteConnection,

ConnectionStrings.ReadOnlyConnection

Полное имя экземпляра базы данных.

Пример:

postgresql://kpmuser:pwd@localhost:5432/KpmDb

где localhost - экземпляр базы данных.

Максимальная длина:

Microsoft SQL Server: 270 символов
MySQL или PostgreSQL: 253 символов

Имя базы дынных

Этот параметр указывается в составе следующих параметров:

ConnectionStrings.ReadWriteConnection,

ConnectionStrings.ReadOnlyConnection

Имя базы данных.

Пример:

postgresql://kpmuser:pwd@localhost:5432/KpmDb

где KpmDb - имя базы данных.

Максимальная длина:

MySQL: 64 символов
PostgreSQL: 63 символов
Microsoft SQL Server: 128 символов

Номер порта базы данных

Этот параметр указывается в составе следующих параметров:

ConnectionStrings.ReadWriteConnection,

ConnectionStrings.ReadOnlyConnection

Номер порта для подключения к базе данных.

Пример:

postgresql://kpmuser:pwd@localhost:5432/KpmDb

где 5432 - номер порта.

Допустимые значения от 0 до 65535.

Тип аутентификации базы данных

Этот параметр указывается в составе следующих параметров:

ConnectionStrings.ReadWriteConnection,

ConnectionStrings.ReadOnlyConnection

Метод аутентификации для подключения к базе данных.

Если строка ConnectionString для MSSQL содержит подстроку Integrated Security=True, то используется Windows-аутентификация. В противном случае используется базовая аутентификация (учетная запись Kaspersky Password Manager для бизнеса), и строка должна включать DB Account Name и DB Account Pwd.

Имя учетной записи базы данных

Этот параметр указывается в составе следующих параметров:

ConnectionStrings.ReadWriteConnection,

ConnectionStrings.ReadOnlyConnection

Имя пользователя для подключения к базе данных.

Пример:

postgresql://kpmuser:pwd@localhost:5432/KpmDb

где kpmuser - логин аккаунта.

Пароль учетной записи базы данных

Этот параметр указывается в составе следующих параметров:

ConnectionStrings.ReadWriteConnection,

ConnectionStrings.ReadOnlyConnection

Пароль для подключения к базе данных.

Пример:

postgresql://kpmuser:pwd@localhost:5432/KpmDb

где pwd - пароль аккаунта.

Параметры аутентификации

Параметр

Описание

AuthenticationSchemas.Negotiate.Schema

Указывает, используется ли доменная аутентификация клиентом Kaspersky Password Manager для бизнеса на сервере Kaspersky Password Manager для бизнеса.

AuthenticationSchemas.Basic.Schema

Указывает, используется ли базовая аутентификация (аккаунт Kaspersky Password Manager для бизнеса) клиентом Kaspersky Password Manager для бизнеса на сервере Kaspersky Password Manager для бизнеса.

AuthenticationSchemas.Adfs.Schema

Указывает, используется ли SSO-аутентификация клиентом Kaspersky Password Manager для бизнеса на сервере Kaspersky Password Manager для бизнеса.

AuthenticationSchemas.Adfs.Authority

URL-адрес AD FS (Active Directory Federation Services).

Максимальная длина составляет 256 символов.

AuthenticationSchemas.Adfs.Audience

URL-адрес клиентского приложения.

Максимальная длина составляет 256 символов.

Параметры LDAP

Параметр

Описание

Kpm.Ldap.LdapEnforceUsersStatusCheck

Указывает, используется ли LDAP для хранения информации об аккаунтах пользователей Kaspersky Password Manager для бизнеса.

Kpm.Ldap.Domain

Домен LDAP сервера.

Kpm.Ldap.LdapServer

Адрес LDAP сервера.

Kpm.Ldap.UseSsl

Указывает, нужно ли использовать шифрование SSL.

Kpm.Ldap.Port

Номер порта для подключения к серверу LDAP.

Допустимые значения от 0 до 65535. Максимальная длина составляет 5 символов.

Kpm.Ldap.AuthType

Тип авторизации сервера Kaspersky Password Manager для бизнеса на сервере LDAP.

Возможные значения: Basic, Negotiate, Anonymous.

Kpm.Ldap.Username

Имя аккаунта, под которым сервер Kaspersky Password Manager для бизнеса будет аутентифицироваться на сервере LDAP.

Имя аккаунта необходимо указывать без доменной части. Поддерживаемый формат: username. Не поддерживаются: username@domain, domain\username, and Distinguished Name (DN). Неверный формат приведет к ошибке "Не удалось подключиться к серверу LDAP".

Максимальная длина составляет 256 символов.

Параметры SMTP

Параметр

Описание

Kpm.ConfirmationCodes.FromEmail

Адрес электронной почты отправителя писем (поле ОТ), которые будут отправляться пользователям с сервера Kaspersky Password Manager для бизнеса.

Максимальная длина составляет 254 символов.

Kpm.Email.Server

Адрес SMTP сервера.

Максимальная длина составляет 254 символов.

Kpm.Email.UseSsl

Указывает, нужно ли использовать шифрование SSL.

Kpm.Email.Port

Номер порта для подключения к серверу SMTP.

Kpm.Email.AuthType

Тип авторизации сервера Kaspersky Password Manager для бизнеса на сервере SMTP.

Возможные значения: Basic, Negotiate, Anonymous.

Kpm.Email.Username

Имя аккаунта, под которым сервер Kaspersky Password Manager для бизнеса будет аутентифицироваться на сервере SMTP.

Максимальная длина составляет 256 символов.

Дополнительные параметры

Параметр

Описание

WorkerSchedules.LicenseSynchronizationWorker.IsDisabled,

WorkerSchedules.LicenseUsageReportingWorker.IsDisabled

Контролирует установку службы лицензирования на текущее устройство.

LicensingServiceClient.Host

Адрес службы лицензирования.

LicensingServiceClient.Port

Порт службы лицензирования.

Serilog.WriteTo.Args.Path

Путь к файлу журнала.

Параметры ограничения скорости

Параметр

Описание

Kpm.ConfirmationCodes.OperationSettings.<operationType>.MaxNumberOfAttempts

Разрешенное количество попыток ввода кода подтверждения для опасного действия, после которого срок действия кода истекает.

Возможное значение от 1 до 50.

Kpm.ConfirmationCodes.OperationSettings.<operationType>.ConfirmationCodeLength

Длина кода подтверждения для опасного действия.

Длина составляет от 1 до 32 символов.

Kpm.ConfirmationCodes.OperationSettings.<operationType>.ExpirationTimeOut

Время жизни кода подтверждения для опасного действия.

Временной интервал должен быть больше 0.

Kpm.ConfirmationCodes.OperationSettings.<operationType>.ResendTimeOut

Время, по истечении которого вы можете сделать еще один запрос на генерацию кода.

Временной интервал должен быть больше 0.

Kpm.ConfirmationCodes.OperationSettings.<operationType>.RateLimit

Допустимое количество попыток генерации кода в пределах временного интервала Confirm Code Window Rate Limit.

Возможное значение от 1 до 50.

Kpm.ConfirmationCodes.OperationSettings.<operationType>.WindowRateLimit

Интервал времени, в течение которого разрешена генерация кода до количества Confirm Code Rate Limit.

Временной интервал должен быть больше 0.

Kpm.AuthenticationSchemas.Basic.ExpirationTimeOut

Интервал ожидания перед новой попыткой базовая аутентификации (с помощью аккаунта Kaspersky Password Manager для бизнеса) после достижения лимита неудачных попыток (Authentication Schemas Basic Max Number of Attempts).

Временной интервал должен быть больше 0.

Kpm.AuthenticationSchemas.Basic.MaxNumberOfAttempts

Допустимое количество неудачных попыток базовой аутентификации, приводящих к тайм-ауту (Authentication Schemas Basic Expiration Timeout).

Возможное значение от 1 до 50.

Kpm.RateLimiting.Policies.Basic.RateLimit

Допустимое количество попыток запроса клиента Kaspersky Password Manager для бизнеса к серверу Kaspersky Password Manager для бизнеса в пределах временного интервала Basic Window Rate Limit.

Kpm.RateLimiting.Policies.Basic.WindowRateLimit

Интервал времени, в течение которого клиент Kaspersky Password Manager для бизнеса выполняет запросы к серверу Kaspersky Password Manager для бизнеса, до предела Basic Rate Limit.

Kpm.RateLimiting.Policies.Basic.SegmentsPerWindow

Количество сегментов запросов, которые обрабатываются в "скользящем окне" (Extended Window Rate Limit).

Kpm.RateLimiting.Policies.Extended.RateLimit

Допустимое количество частоты запросов клиента Kaspersky Password Manager для бизнеса к серверу Kaspersky Password Manager для бизнеса в пределах временного интервала "скользящее окно" (Extended Window Rate Limit).

Kpm.RateLimiting.Policies.Extended.WindowRateLimit

Временной интервал "скользящее окно", в течение которого частые запросы клиента Kaspersky Password Manager для бизнеса к серверу Kaspersky Password Manager для бизнеса разрешены до предела Extended Rate Limit.

Kpm.RateLimiting.Policies.Extended.SegmentsPerWindow

Количество часто обрабатываемых сегментов запроса в течение временного интервала "скользящее окно" (Extended Window Rate Limit).

Kpm.RateLimiting.ValidateEncryptionKey.RateLimit

Допустимое количество запросов клиента Kaspersky Password Manager для бизнеса к серверу Kaspersky Password Manager для бизнеса на проверку ключа шифрования в рамках интервала времени (Validate Encryption Key Window Rate Limit).

Kpm.RateLimiting.ValidateEncryptionKey.WindowRateLimit

Временной интервал (скользящее окно), в течение которого разрешены запросы клиента Kaspersky Password Manager для бизнеса к серверу Kaspersky Password Manager для бизнеса на проверку ключа шифрования в количестве Validate Encryption Key Rate Limit.

Kpm.RateLimiting.ValidateEncryptionKey.SegmentsPerWindow

Количество запросов на проверку ключа шифрования, которые обрабатываются в скользящем окне.

Kpm.RateLimiting.AllowedIpAddresses

Белый список IP-адресов, исключенных из ограничений по частоте запросов для сервера Kaspersky Password Manager для бизнеса.

Возможные значения operationType:

ClearServerRecords
RegisterBasicUser
ResetBasicUserPassword
AuthenticateBasicUser
MasterPasswordResetRequestUserNotification
MasterPasswordResetRequestAdminNotification
MasterPasswordResetApprovedUserNotification

Чтобы изменить конфигурацию сервера Kaspersky Password Manager для бизнеса в среде Docker, выполните следующие действия:

Отредактируйте файл shared-volume/global.override.env, указав необходимые параметры.
После внесения изменений выполните следующие команды:
docker restart kpm-api

docker restart kpm-worker

Обновленные параметры будут применены к запущенным контейнерам.

Следующие параметры могут быть изменены в конфигурационном файле global.override.env:

Параметры для служб

Параметр

Описание

KPMAPI_KESTREL__ENDPOINTS__HTTPS__URL (по умолчанию)

KPMAPI_KESTREL__ENDPOINTS__HTTP__URL (если указан --use_http)

Значение по умолчанию: https://0.0.0.0:3000 или http://0.0.0.0:3000

Номер порта для подключения к серверу Kaspersky Password Manager для бизнеса.

Допустимые значения от 0 до 65535. Максимальная длина - 5 символов. Если оставить поле пустым, установщик будет использовать значение по умолчанию.

KPMAPI_KPM__HTTPSCERTIFICATE__PATH

Путь к файлу сертификата (PFX) на устройстве.

KPMAPI_KPM__HTTPSCERTIFICATE__PASSWORD

Пароль для доступа к сертификату.

Максимальная длина составляет 2047 символов.

Параметры базы данных

Параметр

Описание

Этот параметр указывается в составе следующих параметров:

KPMSERVER_CONNECTIONSTRINGS__READWRITECONNECTION,

KPMSERVER_CONNECTIONSTRINGS__READONLYCONNECTION

Пример:

postgresql://kpmuser:pwd@localhost:5432/KpmDb

где postgresql - тип базы данных.

Тип базы данных.

MySQL – будет использоваться либо MySQL, либо MariaDB.
MSSQL – будет использоваться Microsoft SQL Server.
PostgreSQL – один из следующих вариантов:
- PostgreSQL
- Postgres Pro
- Platform V Pangolin
- Jatoba

Этот параметр указывается в составе следующих параметров:

KPMSERVER_CONNECTIONSTRINGS__READWRITECONNECTION,

KPMSERVER_CONNECTIONSTRINGS__READONLYCONNECTION

Полное имя экземпляра базы данных.

Пример:

postgresql://kpmuser:pwd@localhost:5432/KpmDb

где localhost - экземпляр базы данных.

Максимальная длина:

Microsoft SQL Server: 270 символов
MySQL или PostgreSQL: 253 символов

Этот параметр указывается в составе следующих параметров:

KPMSERVER_CONNECTIONSTRINGS__READWRITECONNECTION, KPMSERVER_CONNECTIONSTRINGS__READONLYCONNECTION

Имя базы данных.

Пример:

postgresql://kpmuser:pwd@localhost:5432/KpmDb

где KpmDb - имя базы данных.

Максимальная длина:

MySQL: 64 символов
PostgreSQL: 63 символов
Microsoft SQL Server: 128 символов

Этот параметр указывается в составе следующих параметров:

KPMSERVER_CONNECTIONSTRINGS__READWRITECONNECTION, KPMSERVER_CONNECTIONSTRINGS__READONLYCONNECTION

Номер порта для подключения к базе данных.

Пример:

postgresql://kpmuser:pwd@localhost:5432/KpmDb

где 5432 - номер порта.

Допустимые значения от 0 до 65535.

Этот параметр указывается в составе следующих параметров:

KPMSERVER_CONNECTIONSTRINGS__READWRITECONNECTION, KPMSERVER_CONNECTIONSTRINGS__READONLYCONNECTION

Метод аутентификации для подключения к базе данных.

Если строка ConnectionString для MSSQL содержит подстроку Integrated Security=True, то используется Windows-аутентификация. В противном случае используется базовая аутентификация (учетная запись Kaspersky Password Manager для бизнеса), и строка должна включать DB Account Name и DB Account Pwd.

Этот параметр указывается в составе следующих параметров:

KPMSERVER_CONNECTIONSTRINGS__READWRITECONNECTION, KPMSERVER_CONNECTIONSTRINGS__READONLYCONNECTION

Имя пользователя для подключения к базе данных.

Пример:

postgresql://kpmuser:pwd@localhost:5432/KpmDb

где kpmuser - логин аккаунта.

Этот параметр указывается в составе следующих параметров:

KPMSERVER_CONNECTIONSTRINGS__READWRITECONNECTION, KPMSERVER_CONNECTIONSTRINGS__READONLYCONNECTION

Пароль для подключения к базе данных.

Пример:

postgresql://kpmuser:pwd@localhost:5432/KpmDb

где pwd - пароль аккаунта.

Параметры аутентификации

Параметр

Описание

KPMAPI_AUTHENTICATIONSCHEMAS__NEGOTIATE__SCHEMA

Указывает, используется ли доменная аутентификация клиентом Kaspersky Password Manager для бизнеса на сервере Kaspersky Password Manager для бизнеса.

KPMAPI_AUTHENTICATIONSCHEMAS__BASIC__SCHEMA

Указывает, используется ли базовая аутентификация (аккаунт Kaspersky Password Manager для бизнеса) клиентом Kaspersky Password Manager для бизнеса на сервере Kaspersky Password Manager для бизнеса.

KPMAPI_AUTHENTICATIONSCHEMAS__ADFS__SCHEMA

Указывает, используется ли SSO-аутентификация клиентом Kaspersky Password Manager для бизнеса на сервере Kaspersky Password Manager для бизнеса.

KPMAPI_AUTHENTICATIONSCHEMAS__ADFS__AUTHORITY

URL-адрес AD FS (Active Directory Federation Services).

Максимальная длина составляет 256 символов.

KPMAPI_AUTHENTICATIONSCHEMAS__ADFS__AUDIENCE

URL-адрес клиентского приложения.

Максимальная длина составляет 256 символов.

Параметры LDAP

Параметр

Описание

KPMSERVER_KPM__LDAP__ENFORCE_USERS_STATUS_CHECK

Указывает, используется ли LDAP для хранения информации об аккаунтах пользователей Kaspersky Password Manager для бизнеса.

KPMSERVER_KPM__LDAP__DOMAIN

Домен LDAP сервера.

KPMSERVER_KPM__LDAP__LDAPSERVER

Адрес LDAP сервера.

KPMSERVER_KPM__LDAP__USESSL

Указывает, нужно ли использовать шифрование SSL.

KPMSERVER_KPM__LDAP__PORT

Номер порта для подключения к серверу LDAP.

Допустимые значения от 0 до 65535. Максимальная длина составляет 5 символов.

KPMSERVER_KPM__LDAP_AUTH_TYPE

Тип авторизации сервера Kaspersky Password Manager для бизнеса на сервере LDAP.

Возможные значения: Basic, Negotiate, Anonymous.

KPMSERVER_KPM__LDAP__USERNAME

Имя аккаунта, под которым сервер Kaspersky Password Manager для бизнеса будет аутентифицироваться на сервере LDAP.

Имя аккаунта необходимо указывать без доменной части. Поддерживаемый формат: username. Не поддерживаются: username@domain, domain\username, and Distinguished Name (DN). Неверный формат приведет к ошибке "Не удалось подключиться к серверу LDAP".

Максимальная длина составляет 256 символов.

KPMSERVER_KPM__LDAP__PASSWORD

Пароль для аккаунта, под которым сервер Kaspersky Password Manager для бизнеса будет аутентифицироваться на сервере LDAP.

Максимальная длина составляет 256 символов.

Параметры SMTP

Параметр

Описание

KPMAPI_KPM__CONFIRMATIONCODES__FROMEMAIL

Адрес электронной почты отправителя писем (поле ОТ), которые будут отправляться пользователям с сервера Kaspersky Password Manager для бизнеса.

Максимальная длина составляет 254 символов.

KPMWORKER_KPM__EMAIL__SERVER

Адрес SMTP сервера.

Максимальная длина составляет 254 символов.

KPMWORKER_KPM__EMAIL__USESSL

Указывает, нужно ли использовать шифрование SSL.

KPMWORKER_KPM__EMAIL__PORT

Номер порта для подключения к серверу SMTP.

KPMWORKER_KPM__EMAIL_AUTH_TYPE

Тип авторизации сервера Kaspersky Password Manager для бизнеса на сервере SMTP.

Возможные значения: Basic, Negotiate, Anonymous.

KPMWORKER_KPM__EMAIL__USERNAME

Имя аккаунта, под которым сервер Kaspersky Password Manager для бизнеса будет аутентифицироваться на сервере SMTP.

Максимальная длина составляет 256 символов.

KPMWORKER_KPM__EMAIL__PASSWORD

Пароль для аккаунта, под которым сервер Kaspersky Password Manager для бизнеса будет аутентифицироваться на сервере SMTP.

Максимальная длина составляет 256 символов.

Дополнительные параметры

Параметр

Описание

KPMWORKER_WORKERSCHEDULES__LICENSESYNCHRONIZATIONWORKER__ISDISABLED,

KPMWORKER_WORKERSCHEDULES__LICENSEUSAGEREPORTINGWORKER__ISDISABLED

Контролирует установку службы лицензирования на текущее устройство.

Команда kpmctl modify обновляет cуществующую конфигурацию сервера Kaspersky Password Manager для бизнеса без повторного выполнения команды postinstall на Linux или переустановки сервера Kaspersky Password Manager для бизнеса на Windows.

Команда использует следующие входные данные:

существующие файлы конфигурации сервера Kaspersky Password Manager для бизнеса;
параметры командной строки.

При выполнении команды kpmctl modify:

Обновляются только те параметры, которые явно поддерживают команду kpmctl modify. Все остальные параметры конфигурации остаются без изменений.
Существующие данные пользователей Kaspersky Password Manager для бизнеса сохраняются.

Ограничения

С помощью команды kpmctl modify невозможно:

переустановить компоненты сервера Kaspersky Password Manager для бизнеса;
выполнить миграцию данных;
автоматически перезапустить службы.

Подробную информацию об утилите см. в разделе Утилита KpmCtl для командной строки.

Информацию о параметрах, которые можно изменить с помощью команды kpmctl modify, см. в этой статье.