Установка Avanpost SmartPAM из архива

2.5. Установка Avanpost SmartPAM из архива

Навигатор по разделу:

1. Файлы конфигурации

Дистрибутив содержит набор конфигурационных файлов, необходимых для работы серверной части системы. Данные файлы предварительно настроены для выполнения базового развертывания с помощью данной инструкции.

Перед запуском сервисов конфигурационные файлы должны быть скорректированы в соответствии с выбранной топологией развертывания и параметрами инфраструктуры.

При внесении изменений в конфигурационные файлы учитывайте возможное влияние измененных параметров в сравнении с конфигурационными файлами из дистрибутива. Состав конфигурационных файлов и порядок их инициализации описаны далее в разделе "Конфигурационные файлы Avanpost SmartPAM".

2. Развертывание файлов дистрибутива Avanpost SmartPAM из архива

Для развертывания файлов дистрибутива из архива:

1. Пройдите по ссылке: https://packages.avanpost.ru/#browse/browse:avanpost-pam:stable, выберите конкретную версию дистрибутива и скачайте ее. Поместите дистрибутив на сервер, в каталог /opt/smartpam.

2. Распакуйте файлы дистрибутива из архива:

tar xzf Avanpost.Pam.<Номер версии и идентификатор сборки>.tar.gz -C /opt/smartpam, где <Номер версии и идентификатор> - разделенные плюсом номера версии и сборки

3. Публикация интерфейсов

Для публикации пользовательского и административного интерфейсов Avanpost SmartPAM, а также для работы live-просмотра RDP-сессий должен использоваться веб-сервер Nginx или Angie.

Веб-сервер может быть установлен на одном или нескольких узлах в зависимости от выбранной топологии развертывания. Публикация интерфейсов выполняется путем размещения статических файлов пользовательского и административного интерфейсов и проксирования запросов к сервисам user-console и admin-console. Внешний доступ и балансировка нагрузки между узлами осуществляются через HAProxy.
Перед началом настройки убедитесь, что:
• Веб-сервер Nginx или Angie установлен на узлах, на которых планируется публикация интерфейсов;
• Сервисы user-console и admin-console запущены и доступны по адресам, указанным в конфигурации веб-сервера;
• Настроено разрешение DNS-имен интерфейсов системы

3.1 Настройка клиентской APM

Для корректной работы Avanpost SmartPAM необходимо обеспечить разрешение DNS-имен интерфейсов системы с клиентских APM. если в инфраструктуре отсутствует DNS-служба, обеспечьте разрешение указанных имен любым доступным способом, например, с помощью локального файла hosts на клиентских APM.

В данном руководстве в качестве примера используются следующие DNS-имена:

smartpam-admin.avanpost.local
smartpam.avanpost.local

Лицензия привязывается к URL-адресу личного кабинета. При необходимости приведенные DNS-имена могут быть изменены.


3.2. Настройка сервера

1. Создайте конфигурационный файл smartpam.conf на основе примера:

Nginx
sudo nano /etc/nginx/conf.d/smartpam.conf
Angie
sudo nano /etc/angie/conf.d/smartpam.conf

2. Скопируйте настройки в конфигурационный файл smartpam.conf, при необходимости отредактировав параметры (порты, DNS-имена, имена сертификатов и др.). Вы можете использовать шифрованное соединение (HTTPS), для этого необходимо сгенерировать и установить сертификаты TLS.

В примере ниже применяется HTTPS-соединение, опирающееся на пару сертификатов smartpam.crt и smartpam.key (содержащих публичный и закрытый ключи). Подразумевается, что сертификаты выписаны на оба DNS-имени smartpam-admin.avanpost.local и smartpam.avanpost.local:

# Административный интерфейс, HTTP
server {
    listen       80;
    server_name  smartpam-admin.avanpost.local;
    #access_log  /var/log/nginx/host.access.log  main;

    location / {
        root   /opt/smartpam/admin-console/admin-ui;
        index  index.html index.htm;
    }

    #error_page  404              /404.html;

    # redirect server error pages to the static page /50x.html
    #
    error_page   500 502 503 504  /50x.html;
    location = /50x.html {
        root   /usr/share/nginx/html;
    }

    # Настройка live-просмотра RDP-сессий
    location ~ ^/api/v1/sessions/rdp/[^/]+/(live|mse)$ {
        proxy_pass http://127.0.0.1:5002;
        proxy_http_version 1.1;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection "upgrade";
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto $scheme;
        proxy_read_timeout 300s;
        proxy_send_timeout 300s;
    }

    location ~ /api {
        proxy_pass   http://127.0.0.1:5002;
        proxy_http_version 1.1;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection "upgrade";
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto $scheme;
        client_max_body_size 1g;
        proxy_buffering off;
        proxy_request_buffering off;
        proxy_read_timeout 600s;
        proxy_send_timeout 600s;
        if ($request_method = 'OPTIONS') {
            add_header 'Access-Control-Allow-Origin' '*';
            add_header 'Access-Control-Allow-Methods' 'GET, POST, PUT, PATCH, DELETE, OPTIONS';
            add_header 'Access-Control-Allow-Headers' 'DNT,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,Range';
            add_header 'Access-Control-Max-Age' 3600;
            add_header 'Content-Type' 'text/plain; charset=utf-8';
            add_header 'Content-Length' 0;
            return 204;
        }
        add_header 'Access-Control-Allow-Origin' '*' always;
        add_header 'Access-Control-Allow-Methods' 'GET, POST, PUT, PATCH, DELETE, OPTIONS' always;
        add_header 'Access-Control-Allow-Headers' 'DNT,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,Range' always;
        add_header 'Access-Control-Expose-Headers' 'Content-Length,Content-Range' always;
    }
    error_page 404 =200 /index.html;
}

# Административный интерфейс, HTTPS
server {
    listen 443 ssl;
    server_name smartpam-admin.avanpost.local;

    ssl_certificate     /etc/ssl/certs/smartpam.crt;
    ssl_certificate_key /etc/ssl/private/smartpam.key;

    location / {
        root   /opt/smartpam/admin-console/admin-ui;
        index  index.html index.htm;
    }
    # Настройка live-просмотра RDP-сессий
     location ~ ^/api/v1/sessions/rdp/[^/]+/(live|mse)$ {
        proxy_pass http://127.0.0.1:5002;
        proxy_http_version 1.1;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection "upgrade";
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto $scheme;
        proxy_read_timeout 300s;
        proxy_send_timeout 300s;
    } 
    location ~ /api {
        proxy_pass   http://127.0.0.1:5002;
        proxy_http_version 1.1;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection "upgrade";
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto $scheme;
        client_max_body_size 1g;
        proxy_buffering off;
        proxy_request_buffering off;
        proxy_read_timeout 600s;
        proxy_send_timeout 600s;
        if ($request_method = 'OPTIONS') {
            add_header 'Access-Control-Allow-Origin' '*';
            add_header 'Access-Control-Allow-Methods' 'GET, POST, PUT, PATCH, DELETE, OPTIONS';
            add_header 'Access-Control-Allow-Headers' 'DNT,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,Range';
            add_header 'Access-Control-Max-Age' 3600;
            add_header 'Content-Type' 'text/plain; charset=utf-8';
            add_header 'Content-Length' 0;
            return 204;
        }
        add_header 'Access-Control-Allow-Origin' '*' always;
        add_header 'Access-Control-Allow-Methods' 'GET, POST, PUT, PATCH, DELETE, OPTIONS' always;
        add_header 'Access-Control-Allow-Headers' 'DNT,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,Range' always;
        add_header 'Access-Control-Expose-Headers' 'Content-Length,Content-Range' always;
    }

    error_page 404 =200 /index.html;
}

# Личный кабинет пользователя, HTTP
server {
    listen       80;
    server_name  smartpam.avanpost.local;

    #access_log  /var/log/nginx/host.access.log  main;

    location / {
        root   /opt/smartpam/user-console/user-ui;
        index  index.html index.htm;
    }

    #error_page  404              /404.html;

    # redirect server error pages to the static page /50x.html
    #
    error_page   500 502 503 504  /50x.html;
    location = /50x.html {
        root   /usr/share/nginx/html;
    }

    location ~ /api {
        proxy_pass   http://127.0.0.1:5001;
		proxy_set_header Host $host;
        proxy_set_header X-Forwarded-Host $host;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto $scheme;
        if ($request_method = 'OPTIONS') {
            add_header 'Access-Control-Allow-Origin' '*';
            add_header 'Access-Control-Allow-Methods' 'GET, POST, PUT, PATCH, DELETE, OPTIONS';
            add_header 'Access-Control-Allow-Headers' 'DNT,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,Range';
            add_header 'Access-Control-Max-Age' 3600;
            add_header 'Content-Type' 'text/plain; charset=utf-8';
            add_header 'Content-Length' 0;
            return 204;
        }
        add_header 'Access-Control-Allow-Origin' '*' always;
        add_header 'Access-Control-Allow-Methods' 'GET, POST, PUT, PATCH, DELETE, OPTIONS' always;
        add_header 'Access-Control-Allow-Headers' 'DNT,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,Range' always;
        add_header 'Access-Control-Expose-Headers' 'Content-Length,Content-Range' always;
    }
    error_page 404 =200 /index.html;
}

# Личный кабинет пользователя, HTTPS
server {
    listen 443 ssl;
    server_name smartpam.avanpost.local;

    ssl_certificate     /etc/ssl/certs/smartpam.crt;
    ssl_certificate_key /etc/ssl/private/smartpam.key;

    location / {
        root   /opt/smartpam/user-console/user-ui;
        index  index.html index.htm;
    }

    location ~ /api {
        proxy_pass   http://127.0.0.1:5001;
		proxy_set_header Host $host;
        proxy_set_header X-Forwarded-Host $host;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto $scheme;
        if ($request_method = 'OPTIONS') {
            add_header 'Access-Control-Allow-Origin' '*';
            add_header 'Access-Control-Allow-Methods' 'GET, POST, PUT, PATCH, DELETE, OPTIONS';
            add_header 'Access-Control-Allow-Headers' 'DNT,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,Range';
            add_header 'Access-Control-Max-Age' 3600;
            add_header 'Content-Type' 'text/plain; charset=utf-8';
            add_header 'Content-Length' 0;
            return 204;
        }
        add_header 'Access-Control-Allow-Origin' '*' always;
        add_header 'Access-Control-Allow-Methods' 'GET, POST, PUT, PATCH, DELETE, OPTIONS' always;
        add_header 'Access-Control-Allow-Headers' 'DNT,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,Range' always;
        add_header 'Access-Control-Expose-Headers' 'Content-Length,Content-Range' always;
    }

    error_page 404 =200 /index.html;
}

3. Проверьте конфигурацию:

Nginx
sudo nginx -t

# nginx: the configuration file /etc/nginx/nginx.conf syntax is ok
# nginx: configuration file /etc/nginx/nginx.conf test is successful
Angie
sudo angie -t

# angie: the configuration file /etc/nginx/nginx.conf syntax is ok
# angie: configuration file /etc/nginx/nginx.conf test is successful

4. Перезапустите сервер:

Nginx
sudo systemctl restart nginx
Angie
sudo systemctl restart angie

5. Установка компонентов сервиса UBA

1. Предоставьте права на выполнение скрипта установки:

sudo chmod +x /opt/smartpam/uba/script/install.sh

2. Перейдите в каталог со скриптами UBA:

cd /opt/smartpam/uba/script

3. Запустите скрипт установки (скрипт может обрабатываться в течение длительного промежутка времени):

sudo ./install.sh

6. Генерация ключей и сертификатов для работы SSH и RDP служб и gRPC-сервисов

Для работы SSH- и RDP-прокси, а также gRPC-сервисов должны применяться ключи и сертификаты. Дистрибутив продукта включает в себя скрипты для генерации и установки самоподписанных ключей и сертификатов.

Если Вы не готовы применять самоподписанные сертификаты, Вам необходимо установить сертификаты, выпущенные центром сертификации. Информацию об этом см. в разделе "Установка ключей и сертификатов, выпущенных центром сертификации"

Если Вы готовы применять самоподписанные сертификаты, выполните следующие команды:

cd /opt/smartpam/utils/sshproxy/
./generate.sh  # генерация ключей для SSH, при запросе passphrase оставьте ее пустой

cd /opt/smartpam/utils/rdpproxy/
./generate.sh  # генерация сертификатов для RDP

cd /opt/smartpam/utils/grpc/
./generate.sh  # генерация сертификатов для gRPC

7. Регистрация системы в systemd и ее запуск

1. Запустите скрипт автоматической настройки, который находится в /opt/smartpam/utils/setup_smartpam_service.sh:

bash /opt/smartpam/utils/setup_smartpam_service.sh

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

  • Скопирует все необходимые service-файлы компонентов в системный каталог Systemd (/etc/systemd/system/)

  • Активирует и запустит службы SmartPAM

  • Создаст target для запуска служб SmartPAM

После выполнения скрипта будут зарегистрированы и запущены следующие службы:

  • admin-console.service

  • event-processor.service

  • pam-manager.service

  • rdp-proxy.service

  • session-processor.service

  • session-recorder.service

  • ssh-proxy.service

  • user-console.service

  • pam-vault.service

  • uba.service

  • scheduler.service
  • http-proxy.service 
  • connector-hub.service 

Кроме того, будет создан target "Группа сервисов SmartPAM"

2. Обновите конфигурацию systemd:

sudo systemctl daemon-reload

8. Настройка логирования

1. Откройте файл настроек:

sudo nano /etc/systemd/journald.conf

2. Измените или добавьте параметры:

Storage=persistent        # Хранить логи на диске (в /var/log/journal)
SystemMaxUse=500M         # Максимальный размер всех логов
SystemKeepFree=100M       # Минимум свободного места на диске
SystemMaxFileSize=100M    # Максимальный размер одного лог-файла
Compress=yes              # Сжимать старые журналы

3. Сохраните файл и перезапустите службу:

sudo systemctl restart systemd-journald

4. Если каталог /var/log/journal отсутствует, создайте его:

sudo mkdir -p /var/log/journal
sudo systemd-tmpfiles --create --prefix /var/log/journal

8.1. Уровни логирования

Для изменения уровня логирования необходимо отредактировать параметр log_level в соответствующих конфигурационных файлах (описание состава и параметров конфигурационных файлов см. далее в разделе "Конфигурационные файлы Avanpost SmartPAM").

Возможные уровни логирования:

  • debug — отладочная информация

  • info — информационные сообщения

  • warn — предупреждения

  • error — критические ошибки

8.2. Просмотр логов

Информация о работе с логами приведена в разделе "Просмотр логов" Руководства администратора

9. Конфигурационные файлы Avanpost SmartPAM

Конфигурационные файлы, поставляемые с продуктом, содержат настройки по умолчанию и могут потребовать корректировки в соответствии с выбранной топологией развертывания и параметрами инфраструктуры. 

В дистрибутиве каждый конфигурационный файл имеет имя config.yaml.default. Перед началом настройки переименуйте каждый файл config.yaml.default в config.yaml

При промышленном развертывании рекомендуется заменить значения секретов и учетных данных, используемых по умолчанию, включая:

  • ключи подписи JWT-токенов;
  • секреты аутентификации gRPC-сервисов;
  • пароли пользователей PostgreSQL;
  • учетные данные для подключения к NATS;
  • учетные данные для подключения к S3-совместимому хранилищу.

При размещении нескольких сервисов Avanpost SmartPAM на одном узле допускается использование адреса localhost для взаимодействия между ними. если сервисы размещены на разных узлах, необходимо указать сетевые адреса соответствующих сервисов, доступные с узла, на котором выполняется настройка.

В таблице ниже приведены параметры, которые могут использоваться в нескольких конфигурационных файлах. Проверьте наличие каждого параметра в конфигурационном файле конкретного сервиса и скорректируйте его при необходимости:

Параметр

Что необходимо проверить

db.connection_string

Укажите параметры подключения к PostgreSQL: адрес сервера, имя базы данных, имя пользователя и пароль

nats.url

Укажите адрес NATS. При использовании одного сервера NATS укажите его адрес. При использовании кластера NATS укажите адреса всех узлов через запятую

nats.login / nats.password

Укажите учетные данные для подключения к NATS

nats.replicas

Укажите количество реплик NATS JetStream. При использовании одного сервера NATS укажите значение 1. При использовании кластера NATS укажите количество узлов кластера

grpc_server.port

Укажите порт, используемый сервисом для приема gRPC-соединений

grpc_server.secret

Укажите секрет для аутентификации gRPC-взаимодействия. Значение должно совпадать со значением, используемым во всех взаимодействующих сервисах

http.port

Укажите адрес и порт HTTP-сервиса в соответствии с выбранной схемой публикации

http.signing_key

Укажите ключ подписи JWT-токенов

minio.awsEndpointUrl

Укажите адрес S3-совместимого хранилища

minio.awsAccessKeyId / minio.awsSecretAccessKey

Укажите учетные данные для подключения к S3-совместимому хранилищу

*.server_addr

Укажите адрес соответствующего сервиса Avanpost SmartPAM. если сервис размещен на том же узле, может использоваться адрес localhost. При размещении сервисов на разных узлах необходимо указать сетевой адрес сервиса

В последующих подразделах приведены параметры конфигурации для каждого сервиса Avanpost SmartPAM. если для сервиса указана дополнительная таблица параметров, необходимо проверить и скорректировать приведенные в ней настройки наряду с общими параметрами, описанными выше. если дополнительная таблица отсутствует, достаточно проверить общие параметры конфигурации в соответствии с используемой топологией развертывания.

Admin API

Файл находится по следующему пути: /opt/smartpam/admin-console/config.yaml

Проверьте параметры конфигурации и скорректируйте их в соответствии с выбранной топологией развертывания:

Параметр

Описание

proxy_manager.server_addr

Укажите адрес сервиса pam-manager. При размещении сервиса на том же узле может использоваться localhost:8009. При кластерном развертывании укажите адрес HAProxy, на котором выполняется балансировка сервиса

vault_client.server_addr

Укажите адрес сервиса pam-vault. При размещении сервиса на том же узле может использоваться localhost:8010. При кластерном развёртывании укажите адрес HAProxy, на котором выполняется балансировка сервиса

rotator.server_addr

Укажите адрес сервиса rotator. При размещении сервиса на том же узле может использоваться localhost:8014. При размещении на другом узле укажите его сетевой адрес

uba.server_addr

Укажите адрес сервиса uba. При размещении сервиса на том же узле может использоваться localhost:8013. При кластерном развертывании укажите адрес HAProxy, на котором выполняется балансировка сервиса

session_processor_mse_url

Укажите адрес сервиса session-processor. При размещении сервиса на том же узле может использоваться localhost:9113. При кластерном развертывании укажите адрес HAProxy, на котором выполняется балансировка сервиса

service_name: api_admin_console # имя сервиса
http:
  port: localhost:5002 # порт сервиса
  base_api: /api/v1 # базовый url admin api
  signing_key: Passw0rd # ключ для подписи jwt токенов
db:
  connection_string: postgres://pam:Passw0rd@localhost/pam?sslmode=disable # подключение к БД
vault_client:
  server_addr: localhost:8010 # адрес сервиса vault
  tls: true # включение TLS
  token: "grpc_secret" # токен аутентификации для доступа к серверу 
rotator:
  server_addr: localhost:8014 # адрес сервиса rotator
  tls: true # включение TLS
  token: "grpc_secret" # токен аутентификации для доступа к серверу
#hashi_corp_vault: 
  #server_addr: "http:// localhost:8200" # адрес HashiCorp Vault
  #role_id: "d0fd9347-be7c-fb5a-ab02-7f5cc1fc7d62" # роль для доступа к HashiCorp Vault
  #secret_id: "14796e13-cb87-1f0d-aaff-e4c4594a9615" # секретный идентификатор для доступа к HashiCorp Vault
  #mount_path: "secret" # путь монтирования KVv2 в HashiCorp Vault
  #key_prefix: "smartPAM" # префикс ключей внутри mount_path
  #tls: false # включение TLS
log_level: info # уровень логирования сервиса
nats:
  url: nats://localhost:4222 # адрес брокера сообщений NATS
  login: "nats_login" # логин для аутентификации клиентов NATS
  password: "nats_password" # пароль для аутентификации клиентов NATS
  replicas: 1 # количество узлов в кластере NATS 
minio:
  awsAccessKeyId: "minioadmin" # логин minio
  awsSecretAccessKey: "minioadmin" # пароль minio
  awsEndpointUrl: "http://localhost:9000" # url подключения к minio
  replaysBucket: "replays" # бакет для записей сессий
uba:
  server_addr: localhost:8013 # адрес сервера uba
  tls: true # включение TLS
  token: "grpc_secret" # токен аутентификации для доступа к серверу
session_processor_mse_url: http:// localhost:9113/api/mse/ws # internal session-processor MSE web-socket endpoint proxied by adminapi
use_idle_timeout: true # включение автоматического завершения неактивных сессий по истечении таймаута

Event Processor

Файл находится по следующему пути: /opt/smartpam/event-processor/config.yaml

Проверьте параметры конфигурации и скорректируйте их в соответствии с выбранной топологией развертывания:

Параметр

Описание

proxy_manager.server_addr

Укажите адрес сервиса pam-manager. При размещении сервиса на том же узле может использоваться localhost:8009. При кластерном развертывании укажите адрес HAProxy, на котором выполняется балансировка сервиса

uba.server_addr

Укажите адрес сервиса uba. При размещении сервиса на том же узле может использоваться localhost:8013. При кластерном развертывании укажите адрес HAProxy, на котором выполняется балансировка сервиса

grpc_server.port

Укажите порт, используемый сервисом для приема gRPC-соединений. Значение по умолчанию: 8011

# event_processor_v1 config
db:
  connection_string: "postgres://pam:Passw0rd@localhost/pam?sslmode=disable" # подключение к БД
grpc_server:
  port: :8011 # порт сервиса
  enable_tls: true  # включение TLS
  cert: "/opt/smartpam/assets/grpc/grpc_cert.pem"  # сертификат GRPC
  key: "/opt/smartpam/assets/grpc/grpc.pem" # ключ GRPC
  secret: "grpc_secret" # секрет для аутентификации
log_level: "info" # уровень логирования сервиса
nats:
  url: nats:// localhost:4222 # адрес брокера сообщений NATS
  client_login: "nats_login" # логин для аутентификации клиентов NATS
  client_password: "nats_password" # пароль для аутентификации клиентов NATS
  replicas: 1 # количество узлов в кластере NATS
proxy_manager:
  server_addr: localhost:8009 # адрес службы pam_manager
  tls: true # включение TLS
  token: "grpc_secret" # токен аутентификации для доступа к серверу 
uba:
  server_addr: localhost:8013
  tls: true # включение TLS
  token: "grpc_secret"

Manager

Файл находится по следующему пути: /opt/smartpam/pam-manager/config.yaml

Проверьте параметры конфигурации и скорректируйте их в соответствии с выбранной топологией развертывания:

Параметр

Описание

vault_client.server_addr

Укажите адрес сервиса pam-vault. При размещении сервиса на том же узле может использоваться localhost:8010. При кластерном развертывании укажите адрес HAProxy, на котором выполняется балансировка сервиса

rotator.server_addr

Укажите адрес сервиса rotator. При размещении сервиса на том же узле может использоваться localhost:8014. При размещении на другом узле укажите его сетевой адрес

grpc_server.port

Укажите порт, используемый сервисом для приема gRPC-соединений. Значение по умолчанию: 8009

# pam proxy manager node config
db:
  connection_string: "postgres://pam:Passw0rd@localhost/pam?sslmode=disable" # подключение к БД
grpc_server:
  port: :8009 # порт сервиса
  enable_tls: true  # включение TLS
  cert: "/opt/smartpam/assets/grpc/grpc_cert.pem"  # сертификат GRPC
  key: "/opt/smartpam/assets/grpc/grpc.pem" # ключ GRPC
  secret: "grpc_secret" # секрет для аутентификации 
vault_client:
  server_addr: localhost:8010 # адрес службы vault
  tls: true # включение TLS
  token: "grpc_secret" # токен аутентификации для доступа к серверу 
rotator:
  server_addr: localhost:8014 # адрес сервиса rotator
  tls: true # включение TLS
  token: "grpc_secret" # токен аутентификации для доступа к серверу
http_session_reconciliation_grace_period: "2m" # время ожидания восстановления HTTP-сессии до ее закрытия
#hashi_corp_vault: 
  #server_addr: "http:// localhost:8200" # адрес HashiCorp Vault
  #role_id: "d0fd9347-be7c-fb5a-ab02-7f5cc1fc7d62" # роль для доступа к HashiCorp Vault
  #secret_id: "14796e13-cb87-1f0d-aaff-e4c4594a9615" # секретный идентификатор для доступа к HashiCorp Vault
  #mount_path: "secret" # путь монтирования KVv2 в HashiCorp Vault
  #key_prefix: "smartPAM" # префикс ключей внутри mount_path
  #tls: false # включение TLS
nats:
  url: nats:// localhost:4222 # адрес брокера сообщений NATS
  login: "nats_login" # логин для аутентификации клиентов NATS
  password: "nats_password" # пароль для аутентификации клиентов NATS
  replicas: 1 # количество узлов в кластере NATS
log_level: "info" # уровень логирования сервиса

RDP Proxy

Файл находится по следующему пути: /opt/smartpam/rdp-proxy/config.yaml

Проверьте параметры конфигурации и скорректируйте их в соответствии с выбранной топологией развертывания:

Параметр

Описание

host_cert_public_path / host_cert_private_path

Проверьте пути к сертификату и приватному ключу RDP Proxy

gate_cert_public_path / gate_cert_private_path

Проверьте пути к сертификату и приватному ключу RDP Gateway

listen_address

Укажите адрес и порт для приема прямых RDP-подключений

listen_gw_address

Укажите адрес и порт для приема подключений через RDP Gateway. Используется при значении параметра use_gateway: "yes"

use_gateway

Укажите "yes" для включения режима RDP Gateway (протокол RDGSP) или "no" для его отключения. Прямое RDP-подключение работает при любом значении параметра

session_recorder.server_addr

Укажите адрес сервиса session-recorder. При размещении сервиса на том же узле может использоваться localhost:8012. При кластерном развертывании укажите адрес HAProxy, на котором выполняется балансировка сервиса

event_processor.server_addr

Укажите адрес сервиса event-processor. При размещении сервиса на том же узле может использоваться localhost:8011. При кластерном развертывании укажите адрес HAProxy, на котором выполняется балансировка сервиса

proxy_manager.server_addr

Укажите адрес сервиса pam-manager. При размещении сервиса на том же узле может использоваться localhost:8009. При кластерном развертывании укажите адрес HAProxy, на котором выполняется балансировка сервиса

health_addr

Укажите адрес и порт проверки состояния сервиса

host_cert_public_path: "/opt/smartpam/assets/rdp/rdp_cert.crt" # сертификат rdp
host_cert_private_path: "/opt/smartpam/assets/rdp/rdp.key" # приватный ключ rdp
gate_cert_public_path: "/opt/smartpam/assets/rdpgw/rdpgw_cert.pem" # сертификат rdp gateway
gate_cert_private_path: "/opt/smartpam/assets/rdpgw/rdpgw.pem" # приватный ключ rdp gateway
listen_address: ":60000" # порт rdp (прием подключений работает всегда)
listen_gw_address: ":4443" # порт rdp gateway (используется, если use_gateway: "yes")
session_recorder:
  server_addr: "localhost:8012" # адрес сервиса записи сессий
  tls: true # включение TLS
  token: "grpc_secret" # токен аутентификации для доступа к серверу 
event_processor:
  server_addr: "localhost:8011" # адрес сервиса обработки событий безопасности
  tls: true # включение TLS
  token: "grpc_secret" # токен аутентификации для доступа к серверу 
proxy_manager:
  server_addr: "localhost:8009" # адрес сервиса proxy manager
  tls: true # включение TLS
  token: "grpc_secret" # токен аутентификации для доступа к серверу 
nats:
  url: nats:// localhost:4222 # адрес брокера сообщений NATS
  login: "nats_login" # логин для аутентификации клиентов NATS
  password: "nats_password" # пароль для аутентификации клиентов NATS
  replicas: 1 # количество узлов в кластере NATS
use_gateway: "yes" #использовать RDGSP (yes), использовать RDP (no)
log_level: "info"  # уровень логирования сервиса
# Ниже заданы параметры настройки виртуального компьютера.
# Эти параметры должны коррелировать со вторым сертификатом (сертификатом конечного узла) 
domain_name : "rdp" # имя домена
computer_name : "avanpost_smart_pam" # имя виртуального узла
dns_domain_name : "rdp.domain" # DNS-имя домена
dns_computer_name : "avanpost_smart_pam.rdp.domain" # полное DNS-имя компьютера (обычно формируется как: <computer_name>.<dns_domain_name>) 
dns_tree_name : "rdp.domain" # полное доменное имя леса Active Directory. Обычно совпадает с dns_domain_name
health_addr: ":8014" # адрес для проверки здоровья сервиса

Session Processor

Файл находится по следующему пути: /opt/smartpam/session-processor/config.yaml

Проверьте параметры конфигурации и скорректируйте их в соответствии с выбранной топологией развертывания:

# session_processor_v1 config
db:
  connection_string: "postgres://pam:Passw0rd@localhost/pam?sslmode=disable" # подключение к БД
log_level: "info"  # уровень логирования сервиса
nats:
  url: nats:// localhost:4222 # адрес брокера сообщений NATS
  login: "nats_login" # логин для аутентификации клиентов NATS
  password: "nats_password" # пароль для аутентификации клиентов NATS
  replicas: 1 # количество узлов в кластере NATS
health_addr: ":9112"
mse_addr: ":9113" # сервер просмотра записей (MSE) и live-просмотра (WebSocket); к нему ходит adminapi
minio:
  awsAccessKeyId: "minioadmin" # логин minio
  awsSecretAccessKey: "minioadmin" # пароль minio
  awsEndpointUrl: "http://localhost:9000" # url подключения к minio
  replaysBucket: "replays" # бакет для записей сессий

Session Recorder

Файл находится по следующему пути: /opt/smartpam/session-recorder/config.yaml

# session_recorder_v1 config
minio:
  awsAccessKeyId: minioadmin # логин minio
  awsSecretAccessKey: minioadmin # пароль minio
  awsEndpointUrl: http://localhost:9000 # url подключения к minio
  awsRegion: us-east-2
  replaysBucket: replays # бакет для записей сессий
db:
  connection_string: "postgres://pam:Passw0rd@localhost/pam?sslmode=disable" # подключение к БД
grpc_server:
  port: :8012 # порт сервиса
  enable_tls: true  # включение TLS
  cert: "/opt/smartpam/assets/grpc/grpc_cert.pem"  # сертификат GRPC
  key: "/opt/smartpam/assets/grpc/grpc.pem" # ключ GRPC
  secret: "grpc_secret" # секрет для аутентификации
nats:
  url: nats:// localhost:4222 # адрес брокера сообщений NATS
  login: "nats_login" # логин для аутентификации клиентов NATS
  password: "nats_password" # пароль для аутентификации клиентов NATS
  replicas: 1 # количество узлов в кластере NATS
# Повтор запроса на обработку записанной сессии. Секция необязательна, ниже значения по умолчанию.
# task_start:
#   request_timeout: 2s      # сколько ждать ответ узла на один запрос
#   retry_min_interval: 1s   # пауза после первой неудачи, дальше растёт вдвое
#   retry_max_interval: 15s  # потолок паузы между попытками
#   post_end_attempts: 10    # сколько попыток делать после конца записи сессии
log_level: "info" # уровень логирования сервиса

SSH Proxy

Файл находится по следующему пути: /opt/smartpam/ssh-proxy/config.yaml

Перед запуском сервиса проверьте параметры конфигурации и скорректируйте их в соответствии с выбранной топологией развертывания.

Параметр

Описание

host_key_path

Проверьте путь к приватному ключу SSH Proxy

port

Укажите порт, используемый для приема SSH-подключений

proxy_manager.server_addr

Укажите адрес сервиса pam-manager. При размещении сервиса на том же узле может использоваться localhost:8009. При кластерном развертывании укажите адрес HAProxy, на котором выполняется балансировка сервиса

event_processor.server_addr

Укажите адрес сервиса event-processor. При размещении сервиса на том же узле может использоваться localhost:8011. При кластерном развертывании укажите адрес HAProxy, на котором выполняется балансировка сервиса

session_recorder.server_addr

Укажите адрес сервиса session-recorder. При размещении сервиса на том же узле может использоваться localhost:8012. При кластерном развертывании укажите адрес HAProxy, на котором выполняется балансировка сервиса

health_addr

Укажите адрес и порт проверки состояния сервиса

# ssh proxy config
host_key_path: "/opt/smartpam/assets/sshproxy/id_rsa" # путь до приватного ключа RSA
port: :2222 # порт сервиса
proxy_manager:
  server_addr: localhost:8009 # адрес службы pam_manager 
  tls: true # включение TLS
  token: "grpc_secret " # токен аутентификации для доступа к серверу
event_processor:
  server_addr: localhost:8011 # адрес службы обработки событий безопасности сессий
  tls: true # включение TLS
  token: "grpc_secret " # токен аутентификации для доступа к серверу
session_recorder:
  server_addr: localhost:8012 # адрес службы записи сессий
  tls: true # включение TLS
  token: "grpc_secret " # токен аутентификации для доступа к серверу
nats:
  url: nats:// localhost:4222 # адрес брокера сообщений NATS
  login: "nats_login" # логин для аутентификации клиентов NATS
  password: "nats_password" # пароль для аутентификации клиентов NATS
  replicas: 1 # количество узлов в кластере NATS
log_level: "info" # уровень логирования сервиса
health_addr: :2223 # адрес для проверки здоровья сервиса

# режим повышения прав на ресурсе, один на весь экземпляр службы:
#   sudo_login - запускать `sudo -i` при открытии интерактивной сессии
#   none       - не повышать права автоматически (по умолчанию; NOPASSWD настраивается на ресурсе)
#   autofill   - автоподстановка пароля из PAM в запрос команды `sudo`
privilege_escalation: none

User API

Файл находится по следующему пути: /opt/smartpam/user-console/config.yaml

Перед запуском сервиса проверьте параметры конфигурации и скорректируйте их в соответствии с выбранной топологией развертывания.

Параметр

Описание

vault_client.server_addr

Укажите адрес сервиса pam-vault. При размещении сервиса на том же узле может использоваться localhost:8010. При кластерном развертывании укажите адрес HAProxy, на котором выполняется балансировка сервиса

service_name: userapi
http:
  port: localhost:5001 # порт сервиса
  base_api: /api/v1 # базовый url user api
  signing_key: Passw0rd # ключ подписи jwt токенов
db:
  connection_string: "postgres://pam:Passw0rd@localhost/pam?sslmode=disable" # подключение к БД
log_level: info # уровень логирования
nats:
  url: nats://localhost:4222 # адрес брокера сообщений NATS
  login: "nats_login" # логин для аутентификации клиентов NATS
  password: "nats_password" # пароль для аутентификации клиентов NATS
  replicas: 1 # количество узлов в кластере NATS
#hashi_corp_vault: 
  #server_addr: "http:// localhost:8200" # адрес HashiCorp Vault
  #role_id: "d0fd9347-be7c-fb5a-ab02-7f5cc1fc7d62" # роль для доступа к HashiCorp Vault
  #secret_id: "14796e13-cb87-1f0d-aaff-e4c4594a9615" # секретный идентификатор для доступа к HashiCorp Vault
  #mount_path: "secret" # путь монтирования KVv2 в HashiCorp Vault
  #key_prefix: "smartPAM" # префикс ключей внутри mount_path
  #tls: false # optional
vault_client:
  server_addr: localhost:8010 # адрес службы vault
  tls: true # включение TLS
  token: "grpc_secret" # токен аутентификации для доступа к серверу 
use_idle_timeout: true # включение автоматического завершения неактивных сессий по истечении таймаута

Vault

Файл находится по следующему пути: /opt/smartpam/pam-vault/config.yaml

# vault_v1 config
db:
  connection_string: "postgres://pam:Passw0rd@localhost/pam?sslmode=disable" # подключение к БД
grpc_server:
  port: :8010 # порт сервиса
  enable_tls: true # включение TLS
  cert: "/opt/smartpam/assets/grpc/grpc_cert.pem"  # сертификат GRPC
  key: "/opt/smartpam/assets/grpc/grpc.pem" # ключ GRPC
  secret: "grpc_secret" # секрет для аутентификации
nats:
  url: nats://localhost:4222 # адрес брокера сообщений NATS
  login: "nats_login" # логин для аутентификации клиентов NATS
  password: "nats_password" # пароль для аутентификации клиентов NATS
  replicas: 1 # количество узлов в кластере NATS
log_level: "info" # уровень логирования

UBA

Файл находится по следующему пути: /opt/smartpam/uba/config.yaml

# uba service config
db:
  connection_string: "postgres://pam:Passw0rd@ localhost /pam?sslmode=disable" # подключение к БД
grpc_server:
  port: :8013 # порт сервиса
  enable_tls: true  # включение TLS
  cert: "/opt/smartpam/assets/grpc/grpc_cert.pem"  # сертификат GRPC
  key: "/opt/smartpam/assets/grpc/grpc.pem" # ключ GRPC
  secret: "grpc_secret" # секрет для аутентификации
nats:
  url: nats://localhost:4222 # адрес брокера сообщений NATS
  login: "nats_login" # логин для аутентификации клиентов NATS
  password: "nats_password" # пароль для аутентификации клиентов NATS
models_dir: /opt/smartpam/uba/models # каталог с моделями UBA

Scheduler

Файл находится по следующему пути: /opt/smartpam/scheduler/config.yaml

Перед запуском сервиса проверьте параметры конфигурации и скорректируйте их в соответствии с выбранной топологией развертывания.

Параметр

Описание

one_time_merge_auth_provider_ldap

Необязательная секция. Заполните ее, если требуется интеграция с LDAP-каталогом. Если интеграция с LDAP не используется, удалите секцию или закомментируйте ее. Описание параметров приведено в разделе "Интеграция с LDAP"

uba.server_addr

Укажите адрес сервиса uba. При размещении сервиса на том же узле может использоваться localhost:8013. При кластерном развертывании укажите адрес HAProxy, на котором выполняется балансировка сервиса

rotator.server_addr

Укажите адрес сервиса rotator. При размещении сервиса на том же узле может использоваться localhost:8014. При размещении на другом узле укажите его сетевой адрес

health_addr

Укажите адрес и порт проверки состояния сервиса

db:
  connection_string: postgres://pam:Passw0rd@ localhost/pam?sslmode=disable # Строка подключения к БД
  migration_dir: /opt/smartpam/migrations/postgres # Каталог с файлами миграций БД
log_level: info # Уровень логирования сервиса
nats:
  url: nats://localhost:4222 # адрес брокера сообщений NATS
  login: "nats_login" # логин для аутентификации клиентов NATS
  password: "nats_password" # пароль для аутентификации клиентов NATS
  replicas: 1 # количество узлов в кластере NATS
one_time_merge_auth_provider_ldap: # подключение провайдера ldap
  id: 8aba5e45-77c5-4aa4-ab26-a9ddfa5cbcee # id ldap провайдера (рекомендуется сгенерировать собственный, в формате UUID)
  name: example.com  # внутреннее имя ldap провайдера
  domain: example.com # домен ldap провайдера
  query: "(&(objectCategory=person)(objectClass=user)(memberOf=cn=SmartPAMGroup,cn=Users,dc=corp,dc=example,dc=com))" # фильтр для импортируемых пользователей, находящихся в
определенной группе (в нашем случае группа=SmartPAMGroup)
  url: ldap:// localhost:389 # Адрес ldap сервиса
  bind_username: ldapuser # Пользователь ldap с необходимыми правами — подключение к ката-логу (bind), чтение данных каталога с применением указанного фильтра (query)
  bind_password: Passw0rd # Пароль пользователя ldap
  bind_method: ntlm # Метод LDAP bind: ntlm, ntlm-sicily, ntlm-sasl, simple, gssapi, anonymous, digest-md5.
minio:
  awsAccessKeyId: "minioadmin" # логин minio
  awsSecretAccessKey: "minioadmin" # пароль minio
  awsEndpointUrl: "http://localhost:9000" # url подключения к minio
  replaysBucket: "replays" # бакет для записей сессий
uba:
  server_addr: localhost:8013 # Адрес сервиса uba
  tls: true # включение TLS
  token: "grpc_secret" # Токен аутентификации.
rotator:
  server_addr: localhost:8014 # Адрес сервиса rotator.
  tls: true # Опционально.
  token: "grpc_secret" # Токен аутентификации.
health_addr: :9110 # Адрес для проверки здоровья сервиса
proxy_manager:
  server_addr: localhost:8009 # адрес службы pam_manager
  tls: true # optional
  token: "grpc_secret"
# Планировщик задач (task registry). 
# Поддерживаются три формата расписания:
# 1. @after <duration> — однократный отложенный запуск.
# Можно указывать как одну единицу времени ("@after 1h"), так и комбинировать их для точности ("@after 1h5m30s").
# 2. @every <duration> — периодический запуск с фиксированным интервалом.
#  Указывается только одна единица времени: "@every 1h" (каждый час), "@every 30m" (каждые 30 минут). Комбинировать нельзя.
# 3. Классический cron — для сложных расписаний.
#    Формат: минута час день_месяца месяц день_недели.
#    Например: 45 23 * * 6 — каждую субботу в 23:45.
#    Подробнее о синтаксисе cron см. https://en.wikipedia.org/wiki/Cron 

# Миграции БД один раз после старта
- key: migrations.run
  spec: "@after 5s"
# Разовая операция слияния ldap (если настроено).
- key: auth.merge_ldap_once
  spec: "@after 10s"
# Периодический импорт пользователей.
- key: auth.import_users
  spec: "@every 1h"
# Периодический запуск инспектора UBA.
# Инспектор анализирует поведение пользователей, переобучает модели и выявляет аномалии.
# Параметры его работы (глубина выборки, период переобучения и др.) настраиваются в интерфейсе администратора в разделе "Настройки" → "UBA".
- key: uba.inspector
  spec: "@every 1h"
# Периодическая архивация завершенных сессий.
# Проверяет наличие сессий, срок хранения которых истек, и применяет к ним действие, заданное в разделе "Настройки" → "Архивация сессий".
- key: session.archivator
  spec: "@every 1h"

Rotator

Файл находится по следующему пути: /opt/smartpam/rotator/config.yaml

Перед запуском сервиса проверьте параметры конфигурации и скорректируйте их в соответствии с выбранной топологией развертывания.

Параметр

Описание

vault.server_addr

Укажите адрес сервиса pam-vault. При размещении сервиса на том же узле может использоваться localhost:8010. При кластерном развертывании укажите адрес HAProxy, на котором выполняется балансировка сервиса

log_level: info
db:
  connection_string: postgres://pam:Passw0rd@ localhost /pam?sslmode=disable
  migration_dir: /opt/smartpam/migrations/postgres
nats:
  url: nats:// localhost:4222
  login: "nats_login"
  password: "nats_password"
  replicas: 1 # количество узлов в кластере NATS
vault:
  server_addr: localhost:8010
  tls: true
  token: "grpc_secret"
grpc_server:
  port: :8014
  enable_tls: true
  cert: "/opt/smartpam/assets/grpc/grpc_cert.pem"
  key: "/opt/smartpam/assets/grpc/grpc.pem"
  secret: "grpc_secret"
rotation:
  scheduled_worker_pool_size: 10
  rotation_timeout_seconds: 120
  scheduler_run_window: 65m

HTTP Proxy

Файл находится по следующему пути: /opt/smartpam/http-proxy/config.yaml

Перед запуском сервиса проверьте параметры конфигурации и скорректируйте их в соответствии с выбранной топологией развертывания.

ПараметрОписание
https_listen_addr / http_listen_addrУкажите порт для приема HTTPS- и HTTP-подключений к защищаемым HTTP-ресурсам
tls_certificate_path / tls_private_key_pathПроверьте пути к резервному (fallback) сертификату и приватному ключу
proxy_manager.server_addrУкажите адрес сервиса pam-manager. При размещении сервиса на том же узле может использоваться localhost:8009. При кластерном развертывании укажите адрес HAProxy, на котором выполняется балансировка сервиса
event_processor.server_addrУкажите адрес сервиса event-processor. При размещении сервиса на том же узле может использоваться localhost:8011. При кластерном развертывании укажите адрес HAProxy, на котором выполняется балансировка сервиса
session_recorder.server_addrУкажите адрес сервиса session-recorder. При размещении сервиса на том же узле может использоваться localhost:8012. При кластерном развертывании укажите адрес HAProxy, на котором выполняется балансировка сервиса
vault_client.server_addrУкажите адрес сервиса pam-vault. При размещении сервиса на том же узле может использоваться localhost:8010. При кластерном развертывании укажите адрес HAProxy, на котором выполняется балансировка сервиса
https_listen_addr: ":8443" # порт приема HTTPS-подключений
http_listen_addr: ":8080" # порт приема HTTP-подключений
tls_certificate_path: "/opt/smartpam/assets/httpproxy/fallback.crt" # TLS-сертификат
tls_private_key_path: "/opt/smartpam/assets/httpproxy/fallback.key" # приватный ключ TLS-сертификата
tls_certificates_sync_interval: "30s" # период синхронизации TLS-сертификатов
proxy_protocol_mode: "disabled"  # режим поддержки PROXY protocol
proxy_protocol_trusted_cidrs: []  # доверенные подсети для PROXY protocol
session_idle_timeout: "30m" # таймаут неактивности HTTP-сессии
session_cleanup_interval: "1m"  # период фоновой очистки завершенных сессий
# allow: continue serving the session when Session Recorder is unavailable;
# deny: reject a new session and close an active session when recording is unavailable.
session_recorder_unavailable: "deny"
max_recorded_body_size_kb: 2048  # максимальный размер тела запроса/ответа, записываемого в сессию
log_level: "info" # уровень логирования сервиса
proxy_manager:
  server_addr: "127.0.0.1:8009" # адрес сервиса pam-manager
  tls: true # включение TLS
  token: "grpc_secret" # токен аутентификации для доступа к серверу
event_processor:
  server_addr: "127.0.0.1:8011" # адрес сервиса обработки событий безопасности
  tls: true # включение TLS
  token: "grpc_secret" # токен аутентификации для доступа к серверу
session_recorder:
  server_addr: "127.0.0.1:8012" # адрес сервиса записи сессий
  tls: true # включение TLS
  token: "grpc_secret" # токен аутентификации для доступа к серверу
vault_client:
  server_addr: "127.0.0.1:8010" # адрес сервиса vault
  tls: true # включение TLS
  token: "grpc_secret" # токен аутентификации для доступа к серверу
nats:
  url: "nats://127.0.0.1:4222" # адрес брокера сообщений NATS
  login: "nats_login" # логин для аутентификации клиентов NATS
  password: "nats_password" # пароль для аутентификации клиентов NATS
  replicas: 1 # количество узлов в кластере NATS

Connector Hub

Файл находится по следующему пути: /opt/smartpam/connector-hub/config.yaml

Перед запуском сервиса проверьте параметры конфигурации и скорректируйте их в соответствии с выбранной топологией развертывания.

ПараметрЧто необходимо проверить
connectors_dirУкажите путь к каталогу, в котором размещаются файлы устанавливаемых коннекторов (bundles)
service_name: connector-hub # имя сервиса
log_level: info # уровень логирования сервиса
db:
  connection_string: postgres://pam:Passw0rd@localhost/pam?sslmode=disable # подключение к БД
nats:
  url: nats://localhost:4222 # адрес брокера сообщений NATS
  login: nats_login # логин для аутентификации клиентов NATS
  password: nats_password # пароль для аутентификации клиентов NATS
  replicas: 1 # количество узлов в кластере NATS
connectors_dir: /opt/smartpam/connector-hub/configs/connectors # каталог с файлами устанавливаемых коннекторов
connector:
  protocol_version: 1 # версия протокола взаимодействия с плагинами коннекторов
  connector_name: connector 
  magic_cookie_key: CONNECTOR_HUB_CONNECTOR # ключ проверки легитимности плагина
  magic_cookie_value: enabled # значение проверки легитимности плагина
  start_timeout_seconds: 5 # таймаут запуска плагина, сек
  healthcheck_interval_seconds: 15 # период проверки работоспособности плагина, сек
  restart_max_retries: 5 # максимальное количество попыток перезапуска плагина
  restart_backoff_initial_seconds: 2 # начальная задержка перед перезапуском, сек
  restart_backoff_max_seconds: 60 # максимальная задержка перед перезапуском, сек
  restart_circuit_open_seconds: 120 # период блокировки перезапуска после исчерпания попыток, сек
jetstream_delivery:
  workers_per_consumer: 2
  backoff_initial_ms: 1000 
  backoff_max_ms: 60000 

12. Приведение конфигураций сервисов к кластерному режиму

12.1. Файлы регистрации сервисов

При кластерном развертывании для каждого сервиса Avanpost SmartPAM создается файл регистрации с именем <имя_сервиса>.yaml. Файл содержит идентификационные данные экземпляра сервиса и параметры переопределения адреса.

Пример файла регистрации для сервиса event-processor:

service:
  serviceId: c03753d0-aeaa-459f-a431-e6412aec6a27
  serviceName: eventprocessor
  registeredAt: 2026-07-20T03:40:10.728676667+03:00
  addressOverride: 
    override: false  # установите true для переопределения адреса сервиса
    address: ""      # при override true — укажите доменное имя узла, например smartpam.node1.local

12.2. Приведение конфигураций сервисов к кластерному режиму

После настройки конфигурационных файлов сервисов Avanpost SmartPAM при необходимости можно использовать скрипт apply-smartpam-cluster.sh для автоматизированного внесения типовых изменений, связанных с кластерным развертыванием.

Скрипт и пример файла параметров входят в каталог utils архива дистрибутива:

  • скрипт: /opt/smartpam/utils/apply-smartpam-cluster.sh
  • пример файла параметров: /opt/smartpam/utils/smartpam-cluster.env.example

Скрипт предназначен для кластерного развёртывания и позволяет автоматически заменить локальные адреса и значения, используемые при базовом развёртывании, на адреса компонентов кластерного контура. При одноузловом развёртывании использование скрипта не требуется.

Скрипт поддерживает 14 служб Avanpost SmartPAM версии 1.5. Он изменяет рабочие файлы config.yaml сервисов. Файлы регистрации сервисов (см. раздел “12.1. Файлы регистрации сервисов”) скрипт не изменяет.

Правила обработки параметров:

  • Непустые параметры заменяют текущие настройки в конфигурационных файлах.
  • Пустые параметры сохраняют текущие настройки без изменений.
  • Адреса отдельных gRPC-сервисов имеют приоритет над значением HAPROXY_IP.

Если какой-либо параметр не указан в файле smartpam-cluster.env, скрипт оставит соответствующее локальное значение (localhost или 127.0.0.1) без изменений. Такая конфигурация будет работать корректно только в том случае, если соответствующий компонент (PostgreSQL, NATS, S3-хранилище) установлен на том же узле.

Если компоненты инфраструктуры (PostgreSQL, NATS, S3-хранилище) вынесены на отдельные узлы, но кластер не развёртывается, их адреса необходимо указать вручную непосредственно в конфигурационных файлах сервисов.

Скрипт использует файл параметров smartpam-cluster.env и позволяет автоматически настроить:

  • адрес HAProxy для внутренних gRPC-взаимодействий сервисов;
  • адреса отдельных gRPC-сервисов;
  • адрес PostgreSQL или полную строку подключения к PostgreSQL;
  • адрес и учетные данные NATS, количество реплик NATS JetStream;
  • адрес и учетные данные S3-совместимого хранилища, имя бакета для записей сессий;
  • адрес сервиса rotator;
  • адреса привязки (bind) сервисов Admin API и User API;
  • адрес MSE endpoint сервиса session-processor в конфигурации admin-console;
  • режим PROXY protocol и доверенные подсети для сервиса http-proxy.

Скрипт выполняет следующие действия:

  • считывает параметры из файла smartpam-cluster.env;
  • обрабатывает файлы config.yaml сервисов, расположенные в каталоге SMARTPAM_DIR;
  • создаёт резервные копии изменяемых файлов;
  • заменяет локальные адреса (localhost) на значения, указанные в параметрах кластера.

Скрипт не выполняет следующие действия:

  • не запускается автоматически;
  • не создаёт и не изменяет конфигурацию HAProxy;
  • не выполняет перезапуск сервисов;
  • не выполняет миграции базы данных;
  • не проверяет доступность PostgreSQL, NATS, S3-совместимого хранилища и HAProxy;
  • не изменяет файлы служб systemd

Порядок работы со скриптом: заполните файл параметров, выполните проверочный запуск с параметром --dry-run и только после этого примените настройки. Путь к файлу параметров необходимо указывать явно.

Таблица. Параметры файла smartpam-cluster.env

ПараметрОписание
SMARTPAM_DIRКаталог установленного продукта
HAPROXY_IPОбщий адрес HAProxy для gRPC-портов 8009–8013. Указывается без http://, https:// и номера порта
PG_HOST / PG_PORTХост и порт PostgreSQL. Пользователь, пароль, имя базы данных и параметры SSL сохраняются
PG_CONNECTION_STRINGПолная строка подключения к PostgreSQL. Для замены всей строки заполните этот параметр и очистите PG_HOST. Одновременное использование PG_CONNECTION_STRING и PG_HOSTнедопустимо
NATS_URLАдрес NATS. Несколько адресов указываются через запятую
NATS_LOGIN / NATS_PASSWORDУчетные данные для подключения к NATS
NATS_REPLICASКоличество реплик NATS JetStream. Заполняйте только с учетом подготовленного NATS JetStream. Пустое значение сохраняет текущее значение nats.replicas
S3_URLАдрес S3-совместимого хранилища
S3_ACCESS_KEY / S3_SECRET_KEYУчетные данные для подключения к S3-совместимому хранилищу
S3_REPLAYS_BUCKETИмя заранее созданного бакета для записей сессий
PROXY_MANAGER_ADDR, VAULT_GRPC_ADDR, EVENT_PROCESSOR_ADDR, SESSION_RECORDER_ADDR, UBA_GRPC_ADDRНеобязательные gRPC-адреса отдельных сервисов в формате host:port. Имеют приоритет над HAPROXY_IP
ROTATOR_ADDRАдрес сервиса rotator. Задается отдельно. Пустое значение сохраняет текущий адрес, адрес HAProxy не подставляется
ADMIN_HTTP_BIND / USER_HTTP_BINDАдреса привязки (bind) Admin API и User API. Пустое значение сохраняет текущие адреса. При использовании nginx на каждом узле допустимы локальные адреса
SESSION_PROCESSOR_MSE_URLЗаполняйте при необходимости изменить MSE endpoint в файле admin-console/config.yaml
HTTP_PROXY_PROXY_PROTOCOL_MODEРежим PROXY protocol для http-proxy. Укажите required для работы за HAProxy с send-proxy-v2 или disabled для работы без PROXY protocol. Пустое значение сохраняет текущий режим
HTTP_PROXY_PROXY_PROTOCOL_TRUSTED_CIDRSДоверенные адреса или подсети. При значении required укажите реальные исходящие IP-адреса или подсети HAProxy. Несколько значений указываются через запятую. Не используйте 0.0.0.0/0 и ::/0

1. Скопируйте пример файла параметров:

cp /opt/smartpam/utils/smartpam-cluster.env.example /opt/smartpam/smartpam-cluster.env

2. Заполните параметры в файле smartpam-cluster.env:

# Каталог установленного продукта.
SMARTPAM_DIR='/opt/smartpam'

# Общий адрес HAProxy для gRPC-портов 8009–8013.
# Без http://, https:// и номера порта.
HAPROXY_IP='haproxy.example.internal'

# PostgreSQL: меняются только хост и порт.
# Пользователь, пароль, имя БД и SSL-параметры сохраняются.
PG_HOST='postgres.example.internal'
PG_PORT='5432'

# Для замены всей строки подключения заполните этот параметр
# и очистите PG_HOST. Одновременно использовать их нельзя.
PG_CONNECTION_STRING=''

# NATS. Несколько URL допускаются через запятую.
NATS_URL='nats://nats.example.internal:4222'
NATS_LOGIN=''
NATS_PASSWORD=''

# Заполнять только с учётом подготовленного NATS JetStream.
# Пусто — сохранить текущее значение nats.replicas.
NATS_REPLICAS=''

# S3-совместимое хранилище и заранее созданный bucket.
S3_URL='https://s3.example.internal:9000'
S3_ACCESS_KEY=''
S3_SECRET_KEY=''
S3_REPLAYS_BUCKET='replays'

# Необязательные gRPC-адреса отдельных сервисов.
# Формат host:port. Имеют приоритет над HAPROXY_IP.
PROXY_MANAGER_ADDR=''
VAULT_GRPC_ADDR=''
EVENT_PROCESSOR_ADDR=''
SESSION_RECORDER_ADDR=''
UBA_GRPC_ADDR=''

# Адрес rotator задаётся отдельно.
# Пусто — сохранить текущий адрес, без подстановки VIP.
ROTATOR_ADDR=''

# Пусто — сохранить текущие bind console.
# При nginx на каждой ноде допустимы локальные bind.
ADMIN_HTTP_BIND=''
USER_HTTP_BIND=''

# Заполнять при необходимости изменить MSE endpoint
# в admin-console/config.yaml.
SESSION_PROCESSOR_MSE_URL=''

# Для http-proxy за HAProxy с send-proxy-v2 задайте required.
# Для работы без PROXY protocol — disabled.
# Пусто — сохранить текущий режим.
HTTP_PROXY_PROXY_PROTOCOL_MODE=''

# При required укажите реальные исходящие IP/подсети HAProxy.
# Несколько CIDR — через запятую, например: 192.0.2.10/32.
# Не использовать 0.0.0.0/0 или ::/0.
HTTP_PROXY_PROXY_PROTOCOL_TRUSTED_CIDRS=''

3.Выполните проверочный запуск скрипта на каждом узле Avanpost SmartPAM:

sudo bash /opt/smartpam/utils/apply-smartpam-cluster.sh --dry-run /opt/smartpam/smartpam-cluster.env

4. Если результат проверочного запуска соответствует ожидаемому, примените настройки на каждом узле:

sudo bash /opt/smartpam/utils/apply-smartpam-cluster.sh /opt/smartpam/smartpam-cluster.env

5. Перезапустите службы:

sudo systemctl restart smartpam.target

13. Удаление архива дистрибутива

1. если все компоненты установлены успешно и работают корректно, то можно удалить ненужные архивы приложений:

rm -f /opt/smartpam/Avanpost.Pam.*.tar.gz
rm -f /home/smartpam/minio.deb
rm -f /home/smartpam/nats-server.zip
rm -rf /home/smartpam/nats-server-v2.10.22-linux-amd64
rm -f /home/smartpam/linux_amd64.tar.gz

Обсуждение