Как настроить apigee-sso для доступа по протоколу HTTPS

Edge for Private Cloud 4.19.01

В статье Как установить и настроить Edge SSO описано, как установить и настроить модуль Edge SSO для использования HTTP на порту 9099, как указано в следующем свойстве в файле конфигурации Edge:

SSO_TOMCAT_PROFILE=DEFAULT

Вы также можете задать для параметра SSO_TOMCAT_PROFILE одно из следующих значений, чтобы включить доступ по HTTPS:

  • SSL_PROXY – настраивает apigee-sso, модуль Edge SSO, в режиме прокси. Это означает, что вы установили балансировщик нагрузки перед apigee-sso и завершили TLS на балансировщике нагрузки. Затем вы указываете порт, используемый на apigee-sso для запросов от балансировщика нагрузки.
  • SSL_TERMINATION – включен доступ по TLS к apigee-sso через выбранный порт. Для этого режима необходимо указать хранилище ключей, содержащее сертификат, подписанный центром сертификации. Самозаверяющий сертификат использовать нельзя.

Вы можете включить HTTPS при установке и настройке apigee-sso или позже.

Если включить доступ к apigee-sso по протоколу HTTPS в любом режиме, доступ по протоколу HTTP будет отключен. Это означает, что вы не можете одновременно использовать протоколы HTTP и HTTPS для доступа к apigee-sso.

Включить режим SSL_PROXY

В режиме SSL_PROXY система использует балансировщик нагрузки перед модулем Edge SSO и завершает TLS на балансировщике нагрузки. На следующем рисунке балансировщик нагрузки завершает TLS на порту 443, а затем перенаправляет запросы в модуль Edge SSO на порт 9099:

В этой конфигурации вы доверяете подключению от балансировщика нагрузки к модулю Edge SSO, поэтому нет необходимости использовать TLS для этого подключения. Однако внешние объекты, такие как поставщик идентификационной информации SAML, теперь должны обращаться к модулю SSO Edge через порт 443, а не через незащищенный порт 9099.

Причина, по которой модуль Edge SSO настраивается в режиме SSL_PROXY, заключается в том, что модуль Edge SSO автоматически генерирует URL перенаправления, используемые поставщиком идентификационной информации в процессе аутентификации. Поэтому эти URL перенаправления должны содержать номер внешнего порта на балансировщике нагрузки (в этом примере – 443), а не номер внутреннего порта на модуле Edge SSO (9099).

Чтобы настроить модуль SSO Edge для режима SSL_PROXY, выполните следующие действия:

  1. Добавьте в файл конфигурации следующие настройки: 
    # Enable SSL_PROXY mode.
SSO_TOMCAT_PROFILE=SSL_PROXY

# Specify the apigee-sso port, typically between 1025 and 65535.
# Typically ports 1024 and below require root access by apigee-sso.
# The default is 9099.
SSO_TOMCAT_PORT=9099

# Specify the port number on the load balancer for terminating TLS.
# This port number is necessary for apigee-sso to auto-generate redirect URLs.
SSO_TOMCAT_PROXY_PORT=443
SSO_PUBLIC_URL_PORT=443

# Set public access scheme of apigee-sso to https.
SSO_PUBLIC_URL_SCHEME=https
  2. Настройте модуль Edge SSO: 
    /opt/apigee/apigee-service/bin/apigee-service apigee-sso setup -f configFile
  3. Обновите конфигурацию поставщика идентификационной информации, чтобы он отправлял HTTPS-запрос на порт 443 балансировщика нагрузки для доступа к Edge SSO. Подробнее о том, как настроить поставщика идентификационной информации SAML…
  4. Обновите конфигурацию Edge UI для HTTPS, задав в файле конфигурации следующие свойства:
    SSO_PUBLIC_URL_PORT=443
SSO_PUBLIC_URL_SCHEME=https

    Затем обновите пользовательский интерфейс Edge:

    /opt/apigee/apigee-service/bin/apigee-service edge-ui configure-sso -f configFile

    Подробнее о том, как включить SAML в Edge UI…

  5. Если вы установили портал Apigee Developer Services (или просто портал), обновите его, чтобы использовать HTTPS для доступа к Edge SSO. Подробнее о том, как настроить портал для использования SAML при взаимодействии с Edge…

Включить режим SSL_TERMINATION

Для режима SSL_TERMINATION необходимо:

  • Сгенерируйте сертификат и ключ TLS и сохраните их в файле хранилища ключей. Самозаверяющий сертификат использовать нельзя. Сертификат должен быть создан центром сертификации.
  • Обновите настройки конфигурации для apigee-sso.

Чтобы создать файл хранилища ключей из сертификата и ключа:

  1. Создайте каталог для файла JKS: 
    sudo mkdir -p /opt/apigee/customer/application/apigee-sso/tomcat-ssl/
  2. Перейдите в новый каталог: 
    cd /opt/apigee/customer/application/apigee-sso/tomcat-ssl/
  3. Создайте файл JKS, содержащий сертификат и ключ. Для этого режима необходимо указать хранилище ключей, содержащее сертификат, подписанный центром сертификации. Самозаверяющий сертификат использовать нельзя. Пример создания файла JKS приведен в статье Настройка TLS/SSL для Edge On Premises.
  4. Сделайте пользователя apigee владельцем файла JKS:
    sudo chown -R apigee:apigee /opt/apigee/customer/application/apigee-sso/tomcat-ssl

Чтобы настроить модуль SSO для Edge:

  1. Добавьте в файл конфигурации следующие настройки: 
    # Enable SSL_TERMINATION mode.
SSO_TOMCAT_PROFILE=SSL_TERMINATION

# Specify the path to the keystore file.
SSO_TOMCAT_KEYSTORE_FILEPATH=/opt/apigee/customer/application/apigee-sso/tomcat-ssl/keystore.jks

SSO_TOMCAT_KEYSTORE_ALIAS=sso

# The password specified when you created the keystore.
SSO_TOMCAT_KEYSTORE_PASSWORD=keystorePassword

# Specify the HTTPS port number between 1025 and 65535.
# Typically ports 1024 and below require root access by apigee-sso.
# The default is 9099.
SSO_TOMCAT_PORT=9443
SSO_PUBLIC_URL_PORT=9443

# Set public access scheme of apigee-sso to https.
SSO_PUBLIC_URL_SCHEME=https
  2. Настройте модуль Edge SSO: 
    /opt/apigee/apigee-service/bin/apigee-service apigee-sso setup -f configFile
  3. Обновите конфигурацию поставщика идентификационной информации, чтобы он отправлял HTTPS-запрос на порт 9443 балансировщика нагрузки для доступа к системе единого входа Edge. Убедитесь, что этот порт не используется другими сервисами. Подробнее о том, как настроить поставщика идентификационной информации SAML…
  4. Обновите конфигурацию Edge UI для HTTPS, задав следующие свойства: 
    SSO_PUBLIC_URL_PORT=9443
SSO_PUBLIC_URL_SCHEME=https

    Подробнее о том, как включить SAML в Edge UI…

  5. Если вы установили портал Developer Services, обновите его, чтобы использовать HTTPS для доступа к системе единого входа Edge. Подробную информацию можно найти в статье Как настроить портал Developer Services для использования SAML при взаимодействии с Edge.

Настройка SSO_TOMCAT_PROXY_PORT при использовании режима SSL_TERMINATION

Перед модулем Edge SSO может находиться балансировщик нагрузки, который завершает TLS на балансировщике нагрузки, но также включает TLS между балансировщиком нагрузки и Edge SSO. На рисунке выше для режима SSL_PROXY это означает, что подключение от балансировщика нагрузки к Edge SSO использует TLS.

В этом случае вы настраиваете TLS в Edge SSO так же, как и для режима SSL_TERMINATION. Однако если балансировщик нагрузки использует номер порта TLS, отличный от того, который используется Edge SSO для TLS, вы также должны указать свойство SSO_TOMCAT_PROXY_PORT в файле конфигурации. Пример:

  • Балансировщик нагрузки завершает TLS на порту 443.
  • Edge SSO завершает TLS на порту 9443

Добавьте в файл конфигурации следующую настройку:

# Specify the port number on the load balancer for terminating TLS.
# This port number is necessary for apigee-sso to generate redirect URLs.
SSO_TOMCAT_PROXY_PORT=443
SSO_PUBLIC_URL_PORT=443

Настройте поставщика идентификационной информации и интерфейс Edge для отправки HTTPS-запросов через порт 443.