Как включить внешнюю аутентификацию

Edge для частного облака версии 4.17.05

В этом разделе рассказывается, как получить, установить и настроить компоненты, необходимые для интеграции внешнего сервиса LDAP с Apigee Edge для аутентификации пользователей.

Требования

  • У вас должна быть установлена версия Apigee Edge для частного облака 4.17.05.
  • Для установки требуются учетные данные глобального системного администратора в Apigee Edge для частного облака.
  • Вам нужно знать корневой каталог установки Apigee Edge для частного облака. Корневой каталог по умолчанию – /opt.
  • Вам необходимо добавить учетные данные глобального системного администратора Edge во внешний каталог LDAP. Помните, что по умолчанию учетные данные системного администратора хранятся во внутреннем LDAP Edge. После перехода на внешний LDAP учетные данные системного администратора будут проверяться там. Поэтому вам нужно предоставить учетные данные внешней системе до включения внешней аутентификации в Edge.

    Например, если вы настроили и установили Apigee Edge для частного облака с учетными данными глобального системного администратора:

    имя пользователя: edgeuser@mydomain.com
    пароль: Secret123

    то пользователь edgeuser@mydomain.com с паролем Secret123 должен также присутствовать во внешней службе LDAP.
  • Если вы используете кластер серверов управления, выполните все описанные в этом документе действия для каждого сервера управления.

Настройка внешней аутентификации

Основное действие, которое вам нужно выполнить, – настроить файл management-server.properties. В частности, вам нужно будет запустить и остановить сервер управления Edge, выбрать прямой или непрямой способ привязки, зашифровать конфиденциальные учетные данные и выполнить другие связанные задачи.

  1. Важно! Сейчас вам нужно решить, какой метод аутентификации вы будете использовать: прямой или косвенный. Это решение повлияет на некоторые аспекты конфигурации. Внешняя аутентификация
  2. Важно! Эти шаги по настройке необходимо выполнить на каждом сервере управления Apigee Edge (если вы используете несколько таких серверов).
  3. Откройте файл /opt/apigee/customer/application/management-server.properties в текстовом редакторе. Если файла нет, создайте его.
  4. Добавьте следующую строку: Примечание. В конце строки не должно быть пробелов.

    conf_security_authentication.user.store=externalized.authentication

    Эта строка добавляет функцию внешней аутентификации в установку Edge для частного облака.
  5. Чтобы упростить этот шаг, мы создали два хорошо прокомментированных примера конфигурации – один для прямой, а другой для непрямой аутентификации с привязкой. Ниже приведены примеры конфигурации для разных типов привязки.

    Пример конфигурации ПРЯМОЙ ПРИВЯЗКИ
    Пример конфигурации КОСВЕННОЙ ПРИВЯЗКИ
  6. Перезапустите сервер управления:
    > /opt/apigee/apigee-service/bin/apigee-service edge-management-server restart
  7. Убедитесь, что сервер работает:
    > /opt/apigee/apigee-service/bin/apigee-all status
  8. Важно! Вам потребуется выполнить дополнительную настройку в одном или обоих из следующих случаев: а) если вы хотите, чтобы пользователи входили в систему, используя имена пользователей, которые не являются адресами электронной почты; В этом случае системный администратор должен пройти аутентификацию с помощью имени пользователя и/или (б), если пароль аккаунта системного администратора во внешнем LDAP отличается от пароля, который вы настроили при первой установке Apigee Edge для частного облака. Подробнее о том, какие настройки требуются для разных учетных данных системного администратора…

Пример конфигурации DIRECT BINDING

## The first property is always required to enable the external authorization feature. Do not change it.
conf_security_externalized.authentication.implementation.class=com.apigee.rbac.impl.LdapAuthenticatorImpl

## Identify the type of binding:
# Set to "true" for direct binding
# Set to "false" for indirect binding. 
conf_security_externalized.authentication.bind.direct.type=true

## The next seven properties are needed regardless of direct or indirect binding. You need to configure these per your external authentication installation. 
## The IP or domain for your external LDAP instance. 
conf_security_externalized.authentication.server.url=ldap://localhost:389

## Your external LDAP server version.
conf_security_externalized.authentication.server.version=3

## The server timeout in milliseconds. 
conf_security_externalized.authentication.server.conn.timeout=50000

## Change these baseDN values to match your external LDAP service. This attribute value will be provided by your external LDAP administrator, and may have more or fewer dc elements depending on your setup.
conf_security_externalized.authentication.user.store.baseDN=dc=apigee,dc=com

## Do not change this search string. It is used internally. 
conf_security_externalized.authentication.user.store.search.query=(&(${userAttribute}=${userId}))

## Identifies the external LDAP property you want to bind against for Authentication. For example if you are binding against an email address, this would typically be in the userPrincipalName property in your external LDAP instance. Alternatively if you are binding against the user’s ID, this would typically be in the sAMAccountName property:
conf_security_externalized.authentication.user.store.user.attribute=userPrincipalName

## The LDAP attribute where the user email value is stored. For direct binding, set it to userPrincipalName.
conf_security_externalized.authentication.user.store.user.email.attribute=userPrincipalName

## ONLY needed for DIRECT binding.
## The direct.bind.user.directDN property defines the string that is used for the bind against the external authentication service. Ensure it is set as follows:
conf_security_externalized.authentication.direct.bind.user.directDN=${userDN}

Пример конфигурации INDIRECT BINDING

## Required to enable the external authorization feature. Do not change it.
conf_security_externalized.authentication.implementation.class=com.apigee.rbac.impl.LdapAuthenticatorImpl

## Identifies the type of binding:
# Set to "true" for direct binding
# Set to "false" for indirect binding. 
conf_security_externalized.authentication.bind.direct.type=false

## The next seven properties are needed regardless of direct or indirect binding. You need to configure these per your external LDAP installation. 
## The IP or domain for your external LDAP instance. 
conf_security_externalized.authentication.server.url=ldap://localhost:389

## Replace with your external LDAP server version.
conf_security_externalized.authentication.server.version=3

## Set the server timeout in milliseconds. 
conf_security_externalized.authentication.server.conn.timeout=50000

## Change these baseDN values to match your external LDAP service. This attribute value will be provided by your external LDAP administrator, and may have more or fewer dc elements depending on your setup.
conf_security_externalized.authentication.user.store.baseDN=dc=apigee,dc=com

## Do not change this search string. It is used internally. 
conf_security_externalized.authentication.user.store.search.query=(&(${userAttribute}=${userId}))

## Identifies the external LDAP property you want to bind against for Authentication. For example if you are binding against an email address, this would typically be in the userPrincipalName property in your external LDAP instance. Alternatively if you are binding against the user’s ID, this would typically be in the sAMAccountName property. See also "Indirect binding only: Encrypting the external LDAP user’s password".
conf_security_externalized.authentication.user.store.user.attribute=userPrincipalName

## Used by Apigee to perform the Authorization step and currently, Apigee only supports email address for Authorization. Make sure to set it to the attribute in your external LDAP that stores the user’s email address. Typically this will be in the userPrincipalName property. 
conf_security_externalized.authentication.user.store.user.email.attribute=userPrincipalName

## The external LDAP username (for a user with search privileges on the external LDAP) and password and whether the password is encrypted. You must also set the attribute externalized.authentication.bind.direct.type to false.
## The password attribute can be encrypted or in plain text. See "Indirect binding only: Encrypting the external LDAP user’s password" for encryption instructions. Set the password.encrypted attribute to "true" if the password is encrypted. Set it to "false" if the password is in plain text.
conf_security_externalized.authentication.indirect.bind.server.admin.dn=myExtLdapUsername
conf_security_externalized.authentication.indirect.bind.server.admin.password=myExtLdapPassword
conf_security_externalized.authentication.indirect.bind.server.admin.password.encrypted=true

Как проверить установку

  1. Убедитесь, что сервер работает:
    > /opt/apigee/apigee-service/bin/apigee-all status
  2. Выполните эту команду, указав учетные данные глобального системного администратора Apigee Edge. Вызов API, который мы собираемся протестировать, может быть выполнен только системным администратором Edge.

    Важно! Идентичные учетные данные должны существовать во внешнем аккаунте LDAP. Если нет, добавьте их сейчас. Обратите внимание, что имя пользователя обычно является адресом электронной почты, но это зависит от того, как вы настроили внешнюю аутентификацию, как описано ранее в этом документе.
    > curl -v http://<management-server-ip>:8080/v1/o -u <Sysadmin Username>

    Пример:
    > curl -v http://192.168.52.100:8080/v1/o -u jdoe@mydomain.com
  3. Введите пароль.

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