Прокси для API

Функциональность API-прокси StarVault Proxy обеспечивает возможность использовать его в качестве промежуточного звена (прокси) для передачи запросов к API StarVault.

1. Функциональность

Блок конфигурации listener для StarVault Proxy настраивает слушателя для StarVault Proxy. Если его role не установлена на metrics_only, он будет действовать как прокси для сервера StarVault, который был настроен в блоке конфигурации vault Proxy Agent. Это позволяет обращаться к API StarVault через API Proxy и поддерживает настройку поведения аутентификации: использовать токен Auto-Auth автоматически или разрешать его использование при необходимости — в зависимости от конфигурации, описанной ниже.

Если слушатель был настроен вместе с блоком конфигурации cache, API Proxy сначала попытается использовать подсистему кэша для соответствующих запросов, прежде чем перенаправить запрос в StarVault. Дополнительные сведения о кэшировании см. в документации по кэшированию.

2. Использование токена автоматической аутентификации

StarVault Proxy позволяет легко аутентифицироваться в StarVault в самых разных средах с помощью Auto-Auth. При установке конфигурации use_auto_auth_token (см. ниже) клиентам не нужно будет предоставлять токен StarVault для запросов, созданных с помощью Agent. При активированной конфигурации, если входящий запрос не содержит токена, для его перенаправления на сервер StarVault будет использован токен автоматической аутентификации. Если в запросе уже присутствует токен, он будет иметь приоритет и будет использован вместо Auto-Auth токена.

3. Принудительное использование токена автоматической аутентификации

StarVault Proxy можно настроить на принудительное использование токена автоматической аутентификации, используя значение force для параметра use_auto_auth_token. Эта конфигурация переопределяет поведение по умолчанию, описанное выше в разделе Использование токена автоматической аутентификацией, и вместо этого игнорирует любой существующий токен StarVault в запросе и вместо этого использует токен автоматической аутентификации.

4. Конфигурация (api_proxy)

Блок api_proxy верхнего уровня имеет следующие записи конфигурации:

use_auto_auth_token (bool/string: false) — если установлено, запросы к Agent без токена StarVault будут пересылаться на сервер StarVault с прикрепленным токеном автоматической аутентификации. Если запросы уже содержат токен, эта конфигурация будет переопределена, и токен в запросе будет использоваться для пересылки запроса на сервер StarVault. Если установлено значение «force», Agent будет использовать токен автоматической аутентификации, перезаписывая прикрепленный токен StarVault, если он установлен.

5. Пример конфигурации

Ниже приведен пример конфигурации listener вместе с конфигурацией api_proxy для принудительного использования токена auto_auth и обеспечения согласованности.

# Другие блоки конфигурации прокси-сервера StarVault
# ...

api_proxy {
  use_auto_auth_token = "force"
}

listener "tcp" {
    address = "127.0.0.1:8100"
    tls_disable = true
}