Установите и настройте систему единого входа Apigee

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

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

Каждый из этих шагов описан в следующих разделах.

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

В этом разделе описывается, как создавать самозаверяющие сертификаты, которые могут подойти для вашей среды тестирования, но для производственной среды следует использовать сертификаты, подписанные центром сертификации (CA).

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

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

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

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 -aes256 -out server.key 1024

4. Удалите парольную фразу из ключа:

   sudo openssl rsa -in server.key -out server.key

5. Создайте запрос на подпись сертификата для CA:

   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. Измените владельца ключа и файла crt на владельца «apigee»:

   sudo chown apigee:apigee server.key
   sudo chown apigee:apigee selfsigned.crt

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

Параметры конфигурации единого входа Apigee

Прежде чем вы сможете установить модуль 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>"

Свойства конфигурации единого входа SAML

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

## 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

# 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.
# This property is enabled by default since release 4.50.00.05.
SSO_SAML_SIGNED_ASSERTIONS=y

Свойства конфигурации прямой привязки LDAP

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

## 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 для своего IDP, используйте следующий блок свойств конфигурации в файле конфигурации, как показано в примере выше:

## 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 для ссылки на адрес электронной почты пользователя; например, «почта» 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-адреса

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

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

1. Скопируйте содержимое XML метаданных из вашего IDP в файл на узле 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:// », за которым следует абсолютный путь от корня (/).

,

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

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

Каждый из этих шагов описан в следующих разделах.

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

В этом разделе описывается, как создавать самозаверяющие сертификаты, которые могут подойти для вашей среды тестирования, но для производственной среды следует использовать сертификаты, подписанные центром сертификации (CA).

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

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

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

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 -aes256 -out server.key 1024

4. Удалите парольную фразу из ключа:

   sudo openssl rsa -in server.key -out server.key

5. Создайте запрос на подпись сертификата для CA:

   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. Измените владельца ключа и файла crt на владельца «apigee»:

   sudo chown apigee:apigee server.key
   sudo chown apigee:apigee selfsigned.crt

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

Параметры конфигурации единого входа Apigee

Прежде чем вы сможете установить модуль 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>"

Свойства конфигурации единого входа SAML

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

## 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

# 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.
# This property is enabled by default since release 4.50.00.05.
SSO_SAML_SIGNED_ASSERTIONS=y

Свойства конфигурации прямой привязки LDAP

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

## 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 для своего IDP, используйте следующий блок свойств конфигурации в файле конфигурации, как показано в примере выше:

## 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 для ссылки на адрес электронной почты пользователя; например, «почта» 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-адреса

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

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

1. Скопируйте содержимое XML метаданных из вашего IDP в файл на узле 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:// », за которым следует абсолютный путь от корня (/).