Cервис авторизации
Сервис авторизации использует набор конфигурационных переменных, которые определяют его поведение, параметры безопасности, подключения к внешним системам и параметры аудита.
Порядок применения значений
Значение каждой переменной определяется в следующем порядке приоритета:
- значение, сохранённое через UI — для переменных, доступных к изменению в интерфейсе;
- переменная окружения или значение из
.env; - значение по умолчанию, заданное в коде сервиса.
Таким образом:
- если параметр был изменён в UI, используется именно это значение;
- если параметр не задан в UI, используется значение из переменных среды;
- если и оно отсутствует, применяется значение по умолчанию.
- Переменные, достпные в UI
- Скрытые переменные
Переменные раздела API
LOG_LEVEL
- Переменная среды:
AUTH_LOG_LEVEL- Тип: строка
- По умолчанию:
INFO - Описание: уровень логирования сервиса авторизации.
ACCESS_LOG_LEVEL
- Переменная среды:
AUTH_ACCESS_LOG_LEVEL- Тип: строка
- По умолчанию:
INFO - Описание: уровень логирования доступа к API.
NOTIFICATION_EXPIRATION
- Переменная среды:
AUTH_NOTIFICATION_EXPIRATION- Тип: целое число
- По умолчанию:
10 - Описание: время хранения истории уведомлений в сутках.
AUDIT_CRUD_USER_LOGS_PATTERN
- Переменная среды:
AUDIT_CRUD_USER_LOGS_PATTERN- Тип: строка
- По умолчанию:
pamir-sec-crud-user-logs-* - Описание: шаблон индексов журнала доступа пользователей к CRUD-операциям.
AUDIT_CRUD_ADMIN_LOGS_PATTERN
- Переменная среды:
AUDIT_CRUD_ADMIN_LOGS_PATTERN- Тип: строка
- По умолчанию:
pamir-sec-crud-admin-logs-* - Описание: шаблон индексов журнала доступа администраторов к CRUD-операциям.
AUDIT_EXT_SERVICE_ACCESS_PATTERN
- Переменная среды:
AUDIT_EXT_SERVICE_ACCESS_PATTERN- Тип: строка
- По умолчанию:
pamir-sec-ext-service-access-* - Описание: шаблон индексов журнала доступа к корпоративным сервисам.
AUDIT_API_ACCESS_PATTERN
- Переменная среды:
AUDIT_API_ACCESS_PATTERN- Тип: строка
- По умолчанию:
pamir-sec-api-access-* - Описание: шаблон индексов журнала доступа к API системы.
AUDIT_USER_ACTIVITY_PATTERN
- Переменная среды:
AUDIT_USER_ACTIVITY_PATTERN- Тип: строка
- По умолчанию:
pamir-sec-user-activity-* - Описание: шаблон индексов журнала активности пользователей.
AUDIT_DATA_LIFECYCLE_PATTERN
- Переменная среды:
AUDIT_DATA_LIFECYCLE_PATTERN- Тип: строка
- По умолчанию:
pamir-sec-data-lifecycle-* - Описание: шаблон индексов журнала жизненного цикла данных мониторинга.
OPENSEARCH_URLS
- Переменная среды:
OPENSEARCH_URLS- Тип: строка
- По умолчанию:
https://opensearch:9200 - Описание: адреса нод OpenSearch, перечисленные через точку с запятой.
OPENSEARCH_TIMEOUT
- Переменная среды:
OPENSEARCH_TIMEOUT- Тип: целое число
- По умолчанию:
10 - Описание: таймаут запросов к OpenSearch в секундах.
Переменные раздела Security
DEFAULT_FRONTEND_URL
- Переменная среды:
DEFAULT_FRONTEND_URL- Тип: строка
- По умолчанию:
http://localhost - Описание: страница по умолчанию для перехода после успешной авторизации.
DEFAULT_FRONTEND_MERGE_URL
- Переменная среды:
DEFAULT_FRONTEND_MERGE_URL- Тип: строка
- По умолчанию:
http://localhost/conflict - Описание: страница по умолчанию для перехода в случае конфликта учетных записей с одинаковым логином.
LDAP_SERVER_CONNECT_TIMEOUT
- Переменная среды:
LDAP_SERVER_CONNECT_TIMEOUT- Тип: целое число
- По умолчанию:
5 - Описание: таймаут подключения к серверу LDAP в секундах.
LDAP_SERVER_SEARCHING_TIMEOUT
- Переменная среды:
LDAP_SERVER_SEARCHING_TIMEOUT- Тип: целое число
- По умолчанию:
5 - Описание: таймаут поиска по серверу LDAP в секундах.
ACTIVE_DIRECTORY_SIGNATURE
- Переменная среды:
ACTIVE_DIRECTORY_SIGNATURE- Тип: строка
- По умолчанию:
1.2.840.113556.1.4.800 - Описание: сигнатура Active Directory.
AUTH_FAILED_TIMEOUT_MIN
- Тип: целое число
- По умолчанию:
15 - Описание: интервал времени в минутах, в течение которого учитываются неуспешные попытки авторизации.
- По умолчанию:
AUTH_FAILED_COUNT
- Тип: целое число
- По умолчанию:
3 - Описание: количество неуспешных попыток авторизации, после которого применяется ограничение.
- По умолчанию:
AUTH_SESSIONS_MAX_COUNT
- Тип: целое число
- По умолчанию:
5 - Описание: максимальное количество сессий пользователя.
- По умолчанию:
AUTH_SESSIONS_DEFAULT_COUNT
- Тип: целое число
- По умолчанию:
1 - Описание: количество сессий пользователя по умолчанию.
- По умолчанию:
USER_INACTIVE_TIMEOUT_DAY
- Тип: целое число
- По умолчанию:
45 - Описание: срок неактивности пользователя в днях, после которого учетная запись блокируется.
- По умолчанию:
USER_LOGIN_REUSE_DAY
- Тип: целое число
- По умолчанию:
1095 - Описание: срок в днях, по истечении которого допускается повторное использование логина.
- По умолчанию:
USER_PASSWORD_MIN_LENGTH
- Тип: целое число
- По умолчанию:
8 - Описание: минимальная длина пароля.
- По умолчанию:
USER_PASSWORD_MAX_LENGTH
- Тип: целое число
- По умолчанию:
20 - Описание: максимальная длина пароля.
- По умолчанию:
USER_PASSWORD_SPECIAL_SYM
- Тип: список
- По умолчанию:
["$", "@", "#", "%"] - Описание: допустимые специальные символы в пароле.
- По умолчанию:
USER_PASSWORD_SPECIAL_SYM_MIN
- Тип: целое число
- По умолчанию:
1 - Описание: минимальное количество специальных символов в пароле.
- По умолчанию:
USER_PASSWORD_DIGITAL_MIN
- Тип: целое число
- По умолчанию:
1 - Описание: минимальное количество цифр в пароле.
- По умолчанию:
USER_PASSWORD_LOWER_MIN
- Тип: целое число
- По умолчанию:
1 - Описание: минимальное количество букв в нижнем регистре.
- По умолчанию:
USER_PASSWORD_UPPER_MIN
- Тип: целое число
- По умолчанию:
1 - Описание: минимальное количество букв в верхнем регистре.
- По умолчанию:
USER_PASSWORD_HISTORY_DEPTH
- Тип: целое число
- По умолчанию:
3 - Описание: количество предыдущих паролей, которые запрещено использовать повторно.
- По умолчанию:
USER_PASSWORD_EXPIRATION_DAY
- Тип: целое число
- По умолчанию:
60 - Описание: срок действия пароля в днях.
- По умолчанию:
Переменные раздела Mail
EMAIL_HOST
- Переменная среды:
EMAIL_HOST- Тип: строка
- По умолчанию:
test.smp.ru - Описание: адрес почтового сервера.
EMAIL_USE_TLS
- Переменная среды:
EMAIL_USE_TLS- Тип: булево значение
- По умолчанию:
True - Описание: использовать TLS при подключении к почтовому серверу.
EMAIL_PORT
- Переменная среды:
EMAIL_PORT- Тип: целое число
- По умолчанию:
587 - Описание: порт почтового сервера.
EMAIL_FROM
- Переменная среды:
EMAIL_FROM- Тип: строка
- По умолчанию:
smp.ru - Описание: адрес или имя отправителя.
EMAIL_HOST_USER
- Переменная среды:
EMAIL_HOST_USER- Тип: строка
- По умолчанию:
user - Описание: имя пользователя для подключения к почтовому серверу.
EMAIL_HOST_PASSWORD
- Переменная среды:
EMAIL_HOST_PASSWORD- Тип: строка
- По умолчанию:
password - Описание: пароль для подключения к почтовому серверу.
Переменные раздела Sentry
PROFILE
- Переменная среды:
AUTH_PROFILE- Тип: булево значение
- По умолчанию:
False - Описание: включает профилирование через Sentry.
Скрытые переменные сервиса авторизации
Следующие переменные используются сервисом авторизации, но не отображаются в UI.
Их можно изменить только через .env-файлы.
Настройки подключения к PostgreSQL
POSTGRES_SCHEMA
- Переменная среды:
AUTH_POSTGRES_SCHEMA - Тип: строка
- По умолчанию:
auth - Описание: схема PostgreSQL, используемая сервисом авторизации.
POSTGRES_POOL
- Переменная среды:
AUTH_POSTGRES_POOL - Тип: булево значение
- По умолчанию:
True - Описание: включает использование пула соединений PostgreSQL.
POSTGRES_POOL_SIZE
- Переменная среды:
AUTH_POSTGRES_POOL_CONNECT - Тип: целое число
- По умолчанию:
20 - Описание: размер пула соединений PostgreSQL.
POSTGRES_POOL_OVERFLOW
- Переменная среды:
AUTH_POSTGRES_POOL_OVERFLOW - Тип: целое число
- По умолчанию:
10 - Описание: количество дополнительных соединений сверх размера пула.
Общие параметры сервиса
PROJECT_NAME
- Переменная среды:
AUTH_PROJECT_NAME - Тип: строка
- По умолчанию:
AUTH - Описание: имя сервиса.
PROJECT_DESCRIPTION
- Переменная среды:
AUTH_PROJECT_DESCRIPTION - Тип: строка
- По умолчанию:
Сервис авторизации - Описание: описание сервиса.
USE_CONTAINER_IP_FOR_BIND
- Переменная среды:
AUTH_USE_CONTAINER_IP_FOR_BIND - Тип: булево значение
- По умолчанию:
True - Описание: использовать IP контейнера для bind-адреса сервиса.
BIND_HOST
- Переменная среды:
AUTH_BIND_HOST - Тип: строка
- По умолчанию: пустое значение
- Описание: адрес, на котором сервис принимает входящие подключения.
BIND_PORT
- Переменная среды:
AUTH_BIND_PORT - Тип: целое число
- По умолчанию:
8001 - Описание: порт входящих подключений сервиса.
ROOT_PATH
- Переменная среды:
AUTH_ROOT_PATH - Тип: строка
- По умолчанию:
/api/auth - Описание: корневой путь публикации API сервиса.
DOCS_PREFIX
- Переменная среды:
AUTH_DOCS_PREFIX - Тип: строка
- По умолчанию:
/docs - Описание: путь публикации документации сервиса.
WORKERS
- Переменная среды:
AUTH_WORKERS - Тип: целое число
- По умолчанию:
1 - Описание: количество worker-процессов сервиса.
DEBUG
- Переменная среды:
AUTH_DEBUG - Тип: булево значение
- По умолчанию:
False - Описание: включает режим отладки.
SHOW_DEBUG_SETTING
- Переменная среды:
AUTH_SHOW_DEBUG_SETTING - Тип: булево значение
- По умолчанию:
False - Описание: управляет отображением debug-настроек.
RELOAD
- Переменная среды:
AUTH_RELOAD - Тип: булево значение
- По умолчанию:
False - Описание: включает автоматическую перезагрузку сервиса при изменении кода.
EVENT_HANDLING
- Переменная среды:
AUTH_EVENT_HANDLING - Тип: булево значение
- По умолчанию:
True - Описание: включает обработку событий внутри сервиса.
STATIC_PATH
- Переменная среды:
AUTH_STATIC_PATH - Тип: строка
- По умолчанию:
/docs - Описание: путь публикации статических файлов.
STATIC_DIR
- Тип: строка
- По умолчанию:
static - Описание: директория статических файлов сервиса.
Внутренние адреса сервисов
AUTH_HOST
- Переменная среды:
AUTH_HOST - Тип: строка
- По умолчанию:
localhost - Описание: внутренний адрес auth-сервиса.
AUTH_PORT
- Переменная среды:
AUTH_PORT - Тип: целое число
- По умолчанию:
8001 - Описание: внутренний порт auth-сервиса.
AUTH_VERSION_PREFIX
- Переменная среды:
AUTH_VERSION_PREFIX - Тип: строка
- По умолчанию:
/v3 - Описание: версионный префикс API auth-сервиса.
SRM_HOST
- Переменная среды:
SRM_HOST - Тип: строка
- По умолчанию:
localhost - Описание: внутренний адрес SRM-сервиса.
SRM_PORT
- Переменная среды:
SRM_PORT - Тип: целое число
- По умолчанию:
8002 - Описание: внутренний порт SRM-сервиса.
SRM_VERSION_PREFIX
- Переменная среды:
SRM_VERSION_PREFIX - Тип: строка
- По умолчанию:
/v3 - Описание: версионный префикс API SRM-сервиса.
MONITORING_HOST
- Переменная среды:
MONITORING_HOST - Тип: строка
- По умолчанию:
localhost - Описание: внутренний адрес сервиса мониторинга.
MONITORING_PORT
- Переменная среды:
MONITORING_PORT - Тип: целое число
- По умолчанию:
8004 - Описание: внутренний порт сервиса мониторинга.
MONITORING_VERSION_PREFIX
- Переменная среды:
MONITORING_VERSION_PREFIX - Тип: строка
- По умолчанию:
/v3 - Описание: версионный префикс API сервиса мониторинга.
Параметры сессий и фоновой обработки
SESSION_SECRET_KEY
- Переменная среды:
SESSION_SECRET_KEY - Тип: строка
- По умолчанию: генерируется автоматически при запуске
- Описание: секретный ключ для работы с пользовательскими сессиями.
warning
Если SESSION_SECRET_KEY не задан явно, при запуске сервиса будет сгенерировано новое значение.
Это может привести к инвалидированию ранее созданных сессий после перезапуска сервиса.
Для стабильной работы рекомендуется задавать этот параметр явно в окружении.
OUTBOX_CONTEXT_DETACH
- Переменная среды:
OUTBOX_CONTEXT_DETACH - Тип: булево значение
- По умолчанию:
True - Описание: управляет отделением контекста при обработке outbox-сообщений.
OUTBOX_BATCH_SIZE
- Переменная среды:
OUTBOX_BATCH_SIZE - Тип: целое число
- По умолчанию:
20 - Описание: размер пакета при обработке outbox-сообщений.
BACKGROUND_TYPE
- Переменная среды:
BACKGROUND_TYPE - Тип: перечисление
- По умолчанию:
MEMORY - Описание: тип механизма фоновой обработки.
IN_APP_SCHEDULER_ENABLED
- Переменная среды:
IN_APP_SCHEDULER_ENABLED - Тип: булево значение
- По умолчанию:
True - Описание: включает встроенный планировщик фоновых задач.
DEBUG_COUNTDOWN_USER_SU
- Тип: целое число
- По умолчанию:
20 - Описание: время действия супердоступа в минутах.
- По умолчанию:
Параметры интеграции с OpenSearch
OPENSEARCH_VERIFY_CERTS
- Переменная среды:
OPENSEARCH_VERIFY_CERTS - Тип: булево значение
- По умолчанию:
False - Описание: проверять TLS-сертификаты OpenSearch при подключении.
OPENSEARCH_USER_ROLE_ATTRIBUTE
- Переменная среды:
OPENSEARCH_USER_ROLE_ATTRIBUTE - Тип: строка
- По умолчанию:
role - Описание: имя пользовательского атрибута, значение которого используется как роль при интеграции с OpenSearch.
Параметры интеграции с Sentry
SENTRY_DSN
- Переменная среды:
AUTH_SENTRY_DSN - Тип: строка
- По умолчанию: пустое значение
- Описание: DSN для отправки событий сервиса авторизации в Sentry.
SENDER_SENTRY_DSN
- Переменная среды:
SENDER_SENTRY_DSN - Тип: строка
- По умолчанию: пустое значение
- Описание: DSN для отправки событий, связанных с отправкой сообщений, в Sentry.