Как установить и настроить Edge SSO

Edge for Private Cloud 4.19.01

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

Создайте ключи и сертификаты TLS

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

Чтобы создать ключ проверки и подписи и самозаверяющий сертификат:

  1. sudo mkdir -p /opt/apigee/customer/application/apigee-sso/jwt-keys
  2. cd /opt/apigee/customer/application/apigee-sso/jwt-keys/
  3. sudo openssl genrsa -out privkey.pem 2048
  4. sudo openssl rsa -pubout -in privkey.pem -out pubkey.pem
  5. sudo chown apigee:apigee *.pem

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

  1. sudo mkdir -p /opt/apigee/customer/application/apigee-sso/saml/
  2. cd /opt/apigee/customer/application/apigee-sso/saml/
  3. Сгенерируйте закрытый ключ с кодовой фразой: 
    sudo openssl genrsa -aes256 -out server.key 1024
  4. Удалите кодовую фразу из ключа:
    sudo openssl rsa -in server.key -out server.key
  5. Создать запрос на подпись сертификата для ЦС: 
    sudo openssl req -x509 -sha256 -new -key server.key -out server.csr
  6. Создайте самозаверяющийся сертификат со сроком действия 365 дней: 
    sudo openssl x509 -sha256 -days 365 -in server.csr -signkey server.key -out selfsigned.crt
     
  7. sudo chown apigee:apigee server.key
  8. sudo chown apigee:apigee selfsigned.crt

Если вы хотите включить TLS в модуле Edge SSO, задав для параметра SSO_TOMCAT_PROFILE значение SSL_TERMINATION или SSL_PROXY, вы не сможете использовать самозаверяющий сертификат. Вам необходимо сгенерировать сертификат в центре сертификации. Подробнее о том, как настроить apigee-sso для доступа по HTTPS…

Установите и настройте Edge SSO для доступа по HTTP.

Чтобы установить модуль Edge SSO, apigee-sso, необходимо использовать тот же процесс, который вы использовали для установки Edge. Поскольку apigee-sso представлен в виде RPM-файла, пользователь, выполняющий установку, должен быть пользователем root или иметь полный доступ sudo. Подробнее об установке Edge…

Передайте файл конфигурации установщику. Файл конфигурации имеет следующий формат:

IP1=hostname_or_ip_of_management_server
IP2=hostname_or_ip_of_UI_and_apigge_sso

## Management Server configuration.
MSIP=$IP1
MGMT_PORT=8080
# Edge sys admin username and password as set when you installed Edge.
ADMIN_EMAIL=opdk@google.com
APIGEE_ADMINPW=Secret123
# Set the protocol for the Edge management API. Default is http. 
# Set to https if you enabled TLS on the management API.
MS_SCHEME=http

## Postgres configuration.
PG_HOST=$IP1
PG_PORT=5432
# Postgres username and password as set when you installed Edge.
PG_USER=apigee
PG_PWD=postgres

# apigee-sso configuration.
SSO_PROFILE="saml"
# Externally accessible IP or DNS name of apigee-sso.
SSO_PUBLIC_URL_HOSTNAME=$IP2
# Default port is 9099. If changing, set both properties to the same value.
SSO_PUBLIC_URL_PORT=9099
SSO_TOMCAT_PORT=9099
# Set Tomcat TLS mode to DEFAULT to use HTTP access to apigee-sso.
SSO_TOMCAT_PROFILE=DEFAULT
SSO_PUBLIC_URL_SCHEME=http

# SSO admin user name. The default is ssoadmin.
SSO_ADMIN_NAME=ssoadmin
# SSO admin password using uppercase, lowercase, number, and special chars.
SSO_ADMIN_SECRET=Secret123

# Enable the ability to sign an authentication request with SAML SSO.
SSO_SAML_SIGN_REQUEST=y

# Path to signing key and secret from "Create the TLS keys and certificates" above.
SSO_JWT_SIGNING_KEY_FILEPATH=/opt/apigee/customer/application/apigee-sso/jwt-keys/privkey.pem
SSO_JWT_VERIFICATION_KEY_FILEPATH=/opt/apigee/customer/application/apigee-sso/jwt-keys/pubkey.pem

# Name of SAML IDP. For example, okta or adfs.
SSO_SAML_IDP_NAME=okta
# Text displayed to user when they attempt to access Edge UI.
SSO_SAML_IDP_LOGIN_TEXT="Please log in to your IDP"

# The metadata URL from your IDP.
# If you have a metadata file, and not a URL, 
# see "Specifying a metadata file instead of a URL" below.
SSO_SAML_IDP_METADATA_URL=https://dev-343434.oktapreview.com/app/exkar20cl/sso/saml/metadata

# Specifies to skip TLS validation for the URL specified
# by SSO_SAML_IDP_METADATA_URL. Necessary if URL uses a self-signed cert. 
# Default value is "n".
SSO_SAML_IDPMETAURL_SKIPSSLVALIDATION=n

# SAML service provider key and cert from "Create the TLS keys and certificates" above.
SSO_SAML_SERVICE_PROVIDER_KEY=/opt/apigee/customer/application/apigee-sso/saml/server.key
SSO_SAML_SERVICE_PROVIDER_CERTIFICATE=/opt/apigee/customer/application/apigee-sso/saml/selfsigned.crt
# The passphrase used when you created the SAML cert and key.
# The section "Create the TLS keys and certificates" above removes the passphrase,
# but this property is available if you require a passphrase.
# SSO_SAML_SERVICE_PROVIDER_PASSWORD=samlSP123

# Requires that SAML responses be signed by your IDP.
SSO_SAML_SIGNED_ASSERTIONS=y

# Must configure an SMTP server so Edge SSO can send emails to users.
SKIP_SMTP=n
SMTPHOST=smtp.example.com
SMTPUSER=smtp@example.com
# omit for no username
SMTPPASSWORD=smtppwd
# omit for no password
SMTPSSL=n
SMTPPORT=25
SMTPMAILFROM="My Company <myco@company.com>"

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

  1. Войдите в узел сервера управления. На этом узле уже должна быть установлена утилита apigee-service, как описано в разделе Как установить утилиту apigee-setup для Edge.

    Обратите внимание, что вы можете установить Edge SSO на другой узел. Однако у этого узла должен быть доступ к серверу управления через порт 8080.

  2. Установите и настройте apigee-sso: 
    /opt/apigee/apigee-setup/bin/setup.sh -p sso -f configFile

    где configFile – файл конфигурации, показанный выше.

  3. Установите утилиту apigee-ssoadminapi.sh, которая используется для управления администраторами и пользователями компьютеров для модуля apigee-sso: 
    /opt/apigee/apigee-service/bin/apigee-service apigee-ssoadminapi install
  4. Выйдите из оболочки и снова войдите в нее, чтобы добавить утилиту apigee-ssoadminapi.sh в путь.

Укажите файл метаданных вместо URL

Если ваш поставщик идентификационной информации не поддерживает URL метаданных HTTP/HTTPS, вы можете использовать XML-файл метаданных для настройки системы единого входа Edge:

  1. Скопируйте содержимое XML-файла метаданных от поставщика идентификационной информации в файл на узле SSO Edge. Например, скопируйте XML-код в: 
    /opt/apigee/customer/application/apigee-sso/saml/metadata.xml
  2. Смените владельца файла на apigee:apigee: 
    chown apigee:apigee /opt/apigee/customer/application/apigee-sso/saml/metadata.xml
  3. Установите для параметра SSO_SAML_IDP_METADATA_URL абсолютный путь к файлу: 
    SSO_SAML_IDP_METADATA_URL=file:///opt/apigee/customer/application/apigee-sso/saml/metadata.xml

    В начале пути к файлу необходимо указать file://, а затем абсолютный путь от корневого каталога (/).