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

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

  1. Создайте ключи и сертификаты.
  2. Настройте базовую конфигурацию Apigee SSO. Базовый файл должен содержать свойства, общие для всех конфигураций SSO.
  3. Добавьте свойства конфигурации, относящиеся к поставщику идентификационной информации. Используйте один из следующих блоков свойств конфигурации, относящихся к поставщику идентификационной информации, в файле конфигурации:
  4. Установите Apigee SSO. Установите модуль Apigee SSO и передайте установщику файл конфигурации.

Ниже описаны все эти шаги.

Как создать ключи и сертификаты

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

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

  1. Как пользователь с правами sudo создайте следующий каталог: 
    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. Измените владельца выходного PEM-файла на пользователя apigee: 
    sudo chown apigee:apigee *.pem

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

  1. Как пользователь с правами sudo создайте новый каталог: 
    sudo mkdir -p /opt/apigee/customer/application/apigee-sso/idp/
  2. Перейдите в новый каталог: 
    cd /opt/apigee/customer/application/apigee-sso/idp/
  3. Чтобы создать закрытый ключ с кодовой фразой: 
    sudo openssl genrsa -out server.key 2048
  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. Экспортируйте ключ и сертификат в хранилище ключей:
    1. Экспортируйте ключ и сертификат в хранилище ключей PKCS12:
      2. sudo openssl pkcs12 -export -clcerts -in <certificate_path> -inkey <key_path> -out <keystore_path> -name <alias>

      Параметры:

      • certificate_path: путь к сертификату, созданному на шаге 6.
      • key_path: путь к закрытому ключу, созданному на шаге 3.
      • keystore_path: путь к созданному хранилищу ключей PKCS12, содержащему сертификат и закрытый ключ.
      • alias – псевдоним, используемый для ссылки на пару ключа и сертификата в хранилище ключей.

      Подробная информация приведена в документации по OpenSSL.

    2. При необходимости экспортируйте ключ и сертификат из PKCS12 в хранилище ключей JKS:
      3. sudo keytool -importkeystore -srckeystore <PKCS12_keystore_path> -srcstoretype PKCS12 
-destkeystore <destination_keystore_path> -deststoretype JKS -alias <alias>

      Параметры:

      • PKCS12_keystore_path: путь к хранилищу ключей PKCS12, созданному на шаге 7 и содержащему сертификат и закрытый ключ.
      • destination_keystore_path: путь к созданному хранилищу ключей JKS, содержащему тот же сертификат и ключ.
      • alias – псевдоним, используемый для пары ключа и сертификата в хранилище ключей JKS.

      Подробная информация приведена в документации по keytool.

    3. Измените владельца выходного файла хранилища ключей на пользователя apigee: 
      sudo chown apigee:apigee <keystore_file>
    4. Измените следующие свойства в объекте silent.conf:
      5. # Path to your keystore  
SSO_SAML_SERVICE_PROVIDER_KEYSTORE_PATH=/opt/apigee/customer/application/apigee-sso/saml/keystore.p12  

# Keystore password
SSO_SAML_SERVICE_PROVIDER_KEYSTORE_PASSWORD=Secret123

# Alias within keystore that stores the key and certificate  
SSO_SAML_SERVICE_PROVIDER_KEYSTORE_ALIAS=service-provider-cert  

# [Optional] Only specify if you are using something other than JKS. Values could be PKCS12 or BCFKS  
SSO_SAML_SERVICE_PROVIDER_KEYSTORE_TYPE=JKS

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

    Настройки конфигурации Apigee SSO

    Прежде чем устанавливать модуль Apigee SSO, необходимо определить файл конфигурации. Этот файл конфигурации передается установщику при установке модуля Apigee SSO.

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

    IP1=hostname_or_IP_of_apigee_SSO
IP2=hostname_or_IP_of_apigee_SSO

## Management Server configuration.
# Management Server IP address and port
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.
# Postgres IP address and port
PG_HOST=$IP1
PG_PORT=5432
# Postgres username and password as set when you installed Edge.
PG_USER=apigee
PG_PWD=postgres

## Apigee SSO module configuration.
# Choose either "saml" or "ldap".
SSO_PROFILE="[saml|ldap]"
# Externally accessible IP or DNS name of apigee-sso.
SSO_PUBLIC_URL_HOSTNAME=$IP2
SSO_PG_DB_NAME=database_name_for_sso

# 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

###########################################################
#                 Define External IDP                     #
# Use one of the following configuration blocks to        #
# define your IDP settings:                               #
#  - SAML configuration properties                     #
#  - LDAP Direct Binding configuration properties        #
#  - LDAP Indirect Binding configuration properties       #
###########################################################

INSERT_IDP_CONFIG_BLOCK_HERE (SAML, LDAP direct, or LDAP indirect, below)

# Configure an SMTP server so that the Apigee SSO module 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
# The address from which emails are sent
SMTPMAILFROM="My Company <myco@company.com>"

    Свойства конфигурации SSO на базе SAML

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

    ## SAML Configuration Properties
# Insert this section into your base configuration file, as described previously.

# Name of SAML IDP. For example, okta or adfs.
SSO_SAML_IDP_NAME=okta
# Text displayed on the SSO sign-in page after being redirected by either the New or Classic Edge UI for SAML logins.
# Note: Installing SSO does not depend on the Edge UI or which version of the UI you are using.
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

# Determines whether to skip TLS validation for the URL specified
# by SSO_SAML_IDP_METADATA_URL.
# This is necessary if the URL uses a self-signed certificate.
# The default value is "n".
SSO_SAML_IDPMETAURL_SKIPSSLVALIDATION=n

# Keystore configuration details
# [Optional] Only specify KEYSTORE_TYPE if you are using something other than JKS. Values could be PKCS12 or BCFKS.
SSO_SAML_SERVICE_PROVIDER_KEYSTORE_PATH=/opt/apigee/customer/application/apigee-sso/saml/keystore.jks
SSO_SAML_SERVICE_PROVIDER_KEYSTORE_PASSWORD=Secret123
SSO_SAML_SERVICE_PROVIDER_KEYSTORE_ALIAS=service-provider-cert
SSO_SAML_SERVICE_PROVIDER_KEYSTORE_TYPE=JKS

# Requires that SAML responses be signed by your IDP.
# This property is enabled by default since release 4.50.00.05.
SSO_SAML_SIGNED_ASSERTIONS=y

    Свойства конфигурации прямого подключения LDAP

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

    ## LDAP Direct Binding configuration
# Insert this section into your base configuration file, as described previously.

# The type of LDAP profile; in this case, "direct"
SSO_LDAP_PROFILE=direct

# The base URL to which SSO connects; in the form: "ldap://hostname_or_IP:port
SSO_LDAP_BASE_URL=LDAP_base_URL

# Attribute name used by the LDAP server to refer to the user's email address; for example, "mail"
SSO_LDAP_MAIL_ATTRIBUTE=LDAP_email_attribute

# Pattern of the user's DN; for example: =cn={0},ou=people,dc=example,dc=org
# If there is more than one pattern, separate with semicolons (";"); for example:
# =cn={0},ou=people,dc=example,dc=org;=cn={0},ou=people,dc=example,dc=com
SSO_LDAP_USER_DN_PATTERN=LDAP_DN_pattern

    Свойства конфигурации непрямого подключения LDAP

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

    ## LDAP Indirect Binding configuration
# Insert this section into your base configuration file, as described previously.

# Type of LDAP profile; in this case, "indirect"
SSO_LDAP_PROFILE=indirect

# Base URL to which SSO connects; in the form: "ldap://hostname_or_IP:port
SSO_LDAP_BASE_URL=LDAP_base_URL

# DN and password of the LDAP server's admin user
SSO_LDAP_ADMIN_USER_DN=LDAP_admin_DN
SSO_LDAP_ADMIN_PWD=LDAP_admin_password

# LDAP search base; for example, "dc=example,dc=org"
SSO_LDAP_SEARCH_BASE=LDAP_search_base

# LDAP search filter; for example, "cn={0}"
SSO_LDAP_SEARCH_FILTER=LDAP_search_filter
     # Название атрибута, используемого сервером LDAP для обозначения адреса электронной почты пользователя, например "mail" SSO_LDAP_MAIL_ATTRIBUTE=LDAP_email_attribute

    Как установить модуль Apigee SSO

    После того как вы создадите ключи и настроите файл конфигурации, вы сможете установить модуль Apigee SSO.

    Чтобы установить модуль Apigee SSO:

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

      Вы также можете установить модуль Apigee 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, для настройки Apigee SSO можно использовать XML-файл с метаданными.

    Чтобы использовать файл метаданных вместо URL для настройки Apigee SSO:

    1. Скопируйте содержимое XML-файла метаданных из поставщика идентификационной информации в файл на узле Apigee SSO. Например, скопируйте XML в: 
      /opt/apigee/customer/application/apigee-sso/saml/metadata.xml
    2. Измените владельца XML-файла на пользователя 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://", а затем абсолютный путь от корня (/).