LDAP-политика

Вы просматриваете документацию Apigee Edge .
Перейдите к документации Apigee X. информация

Что

Политика LDAP обеспечивает:

• Аутентификация : учетные данные пользователя, указанные в запросе, проверяются на соответствие учетным данным провайдера LDAP. Политика LDAP дает вам большую гибкость при аутентификации, позволяя использовать любое значение DN вместе с паролем, даже если нужное вам значение DN отсутствует в запросе. Например, предположим, что вам нужно использовать адрес электронной почты/пароль для аутентификации. Возможны следующие варианты:
  • Если адрес электронной почты указан в запросе, вы можете просто использовать его с паролем для аутентификации LDAP.
  • Если в запросе нет адреса электронной почты, но есть другой атрибут DN (например, номер телефона), вы можете использовать номер телефона для получения соответствующего электронного письма от LDAP, а затем использовать адрес электронной почты/пароль для аутентификации.
• Поиск по отличительному имени (DN) . Помимо аутентификации, вы также можете использовать политику LDAP для идентификации атрибута пользователя в запросе, например электронной почты, и выполнить запрос, который извлекает другие атрибуты DN из LDAP для этого пользователя. Полученное DN сохраняется в переменной.

Используйте политику LDAP, когда доступ к защищенным ресурсам должен быть ограничен пользователями вашего провайдера LDAP, например администраторами, пользователями организации и разработчиками, особенно когда доступ к токену OAuth либо не нужен, либо слишком трудоемок. Политика также предназначена для получения метаданных доменных имен для использования в потоках прокси-сервера API.

Например, вы можете выполнить вызов API только тогда, когда пользователь успешно аутентифицирован в LDAP; а затем (при необходимости) получить атрибуты DN (доменное имя) для пользователя после успешной аутентификации.

Дополнительную информацию см.:

• Управление политикой паролей LDAP по умолчанию для управления API
• « Важная информация о вашей политике паролей » в сообществе Apigee.

Образцы

<Ldap name="4GLdapPolicy">
   <LdapResource>ldap1</LdapResource>
   <Authentication>
       <UserName ref="request.header.username"/>
       <Password ref="request.header.password"/>
       <Scope>subtree</Scope>
       <BaseDN ref="apigee.baseDN"></BaseDN> <!-- default is dc=apigee,dc=com -->
    </Authentication>
 </Ldap>

<Ldap name="LdapPolicy">
   <LdapResource>ldap1</LdapResource>
   <Authentication>
       <Password ref="request.header.password"/>
       <SearchQuery>mail={request.header.mail}</SearchQuery>
       <Scope>subtree</Scope>
       <BaseDN ref="apigee.baseDN"></BaseDN> <!-- default is dc=apigee,dc=com -->
    </Authentication>
 </Ldap>

<Ldap name="LdapPolicy">
    <!-- using a custom LDAP provider -->
    <LdapConnectorClass>com.custom.ldap.MyProvider</LdapConnectorClass>
    <LdapResource>MyLdap</LdapResource>
    <Search>
        <BaseDN ref="apigee.baseDN"></BaseDN> <!-- default is dc=apigee,dc=com -->
        <SearchQuery>mail={request.header.mail}</SearchQuery>
        <Attributes>
            <Attribute>address</Attribute>
            <Attribute>phone</Attribute>
            <Attribute>title</Attribute>
        </Attributes>
        <Scope></Scope> <!-- default is ‘subtree’ -->
    </Search>
</Ldap>

Ссылка на элемент

Ниже приведены описания элементов и атрибутов политики LDAP.

<Attributes>
  <Attribute>address</Attribute>
  <Attribute>phone</Attribute>
  <Attribute>title</Attribute>
</Attributes>

Примечания по использованию

Apigee Edge для частного облака позволяет использовать провайдера LDAP в вызовах API. С помощью политики LDAP приложения могут аутентифицировать учетные данные пользователей, хранящихся в LDAP, а вы можете получать отличительные имена (DN) из LDAP — метаданные или атрибуты, связанные с каждым пользователем, такие как адрес электронной почты, адрес и номер телефона. Возвращенное DN сохраняется в переменной для дальнейшего использования прокси-сервером API.

Создать ресурс LDAP

Политика LDAP использует ресурс LDAP, который вы создаете в Apigee Edge. Ресурс LDAP предоставляет информацию о подключении к вашему репозиторию LDAP.

Для создания ресурсов LDAP и управления ими используйте следующий API и полезную нагрузку:

API

Создайте ( POST ) ресурс LDAP или перечислите ( GET ) все ресурсы LDAP:

/v1/organizations/org_name/environments/environment/ldapresources

Получите подробную информацию о ( GET ), обновлении ( POST ) и удалении ( DELETE ) ресурса LDAP:

/v1/organizations/org_name/environments/environment/ldapresources/ldap_resource_name

Полезная нагрузка

Ниже приведен пример полезных данных XML с комментариями по использованию.

<LdapResource name="ldap1">
  <Connection>
    <Hosts>
      <!-- port is optional: defaults to 389 for ldap:// and 636 for ldaps:// -->
      <Host port="636">foo.com</Host>
    </Hosts>
    <SSLEnabled>false</SSLEnabled> <!-- optional, defaults to false -->
    <Version>3</Version> <!-- optional, defaults to 3-->
    <Authentication>simple</Authentication> <!-- optional, only simple supported -->
    <ConnectionProvider>jndi|unboundid</ConnectionProvider> <!-- required -->
    <ServerSetType>single|round robin|failover</ServerSetType> <!-- not applicable for jndi -->
    <!-- If using a custom LDAP provider, the fully qualified class: -->
    <LdapConnectorClass>com.custom.ldap.MyProvider</LdapConnectorClass>
  </Connection>
  <ConnectPool enabled="true"> <!-- enabled is optional, defaults to true -->
    <Timeout>30000</Timeout> <!-- optional, in milliseconds; if not set, no timeout -->
    <Maxsize>50</Maxsize> <!-- optional; if not set, no max connections -->
    <Prefsize>30</Prefsize> <!-- optional; if not set, no pref size -->
    <Initsize></Initsize> <!-- optional; if not set, defaults to 1 -->
    <Protocol></Protocol> <!-- optional; if not set, defaults to 'ssl plain' -->
  </ConnectPool>
  <Admin>
    <DN>cn=manager,dc=apigee,dc=com</DN>
    <Password>secret</Password>
  </Admin>
</LdapResource>

пример Curl: создание ресурса LDAP

В следующем примере создается ресурс LDAP с именем ldap1 .

curl -X POST -H "Content-Type: application/xml" \
  https://api.enterprise.apigee.com/v1/organizations/myorg/environments/test/ldapresources \
  -u apigee_email:password -d \
  '<LdapResource name="ldap1">
    <Connection>
      <Hosts>
      <Host>foo.com</Host>
      </Hosts>
      <SSLEnabled>false</SSLEnabled>
      <Version>3</Version>
      <Authentication>simple</Authentication>
      <ConnectionProvider>unboundid</ConnectionProvider>
      <ServerSetType>round robin</ServerSetType>
    </Connection>
    <ConnectPool enabled="true">
      <Timeout>30000</Timeout>
      <Maxsize>50</Maxsize>
      <Prefsize>30</Prefsize>
      <Initsize></Initsize>
      <Protocol></Protocol>
    </ConnectPool>
    <Admin>
      <DN>cn=manager,dc=apigee,dc=com</DN>
      <Password>secret</Password>
    </Admin>
  </LdapResource>'

Коды ответов

Ниже приведены коды ответов HTML, которые политика возвращает в случае успеха или неудачи:

• Успех : 200
• Ошибка : 401

Использование собственного поставщика LDAP в Edge для частного облака

Использование собственного поставщика LDAP

Apigee Edge для частного облака поставляется с поставщиком LDAP, который уже настроен для взаимодействия с политикой LDAP. Однако если вы используете собственный поставщик LDAP, вам необходимо разрешить поставщику поддерживать политику LDAP. Для этого:

1. В классе поставщика LDAP реализуйте интерфейс ExternalLdapConProvider .

   public interface ExternalLdapConProvider {
     void doAuthentication(LdapBean LlapBean, String userDN, String password, String baseDN);
   
     void doSearchAndAuthentication(LdapBean LlapBean, String password, String baseDN, String query, int scope);
   
     Collection<Map<String, String[]>> doSearch(LdapBean LlapBean, String query,
       String baseDN, Collection<String> requiredAttributes, int scope);
   
     void closeConnections();
   }

2. В <LdapConnectorClass> конфигурации политики (следующие разделы) добавьте полное имя класса вашего пользовательского поставщика LDAP.
3. Загрузите этот файл: custom-ldap.jar_.zip . (Возможно, вам придется щелкнуть правой кнопкой мыши и выбрать «Сохранить как» .)
4. Разархивируйте его.
5. Добавьте файл custom-ldap.jar в свою среду и убедитесь, что он находится в вашем пути к классам.
6. Создайте ресурс среды для вашего провайдера LDAP. Вы будете использовать имя ресурса среды в элементе <LdapResource> политики LDAP.

Использование UnboundID LDAP SDK для Java

Вы можете использовать UnboundID LDAP SDK с политикой LDAP, но сначала необходимо загрузить версию 2.3.1 и добавить ее в каждый путь к классам вашего процессора сообщений.

Чтобы использовать UnboundID LDAP SDK с политикой LDAP:

1. Откройте браузер и перейдите в хранилище файлов Sourceforge для UnboundID LDAP SDK:

   https://sourceforge.net/projects/ldap-sdk/files/

2. Найдите версию 2.3.1 (SE или Standard Edition ) SDK и загрузите ZIP-файл для этой версии. Например, скачайте «unboundid-ldapsdk-2.3.1-se.zip».
3. Извлеките файл JAR из ZIP-файла SDK, как показано в следующем примере:

   unzip -j -d ~/tmp ~/Downloads/unboundid-ldapsdk-2.3.1-se.zip unboundid-ldapsdk-2.3.1-se/unboundid-ldapsdk-se.jar

   Эта команда извлекает только файл JAR в каталог ~/tmp. Он удаляет структуру каталогов с помощью -j , хотя это необязательно.

4. На каждом узле процессора сообщений:
   1. Скопируйте файл JAR в каталог /opt/apigee/edge-gateway/lib/thirdparty процессора сообщений.
   2. При необходимости предоставьте пользователю Apigee разрешение на доступ к файлу JAR, чтобы обработчик сообщений мог получить к нему доступ.

   Edge добавляет все сторонние библиотеки из каталога /opt/apigee/edge-gateway/lib/thirdparty в путь к классам.

   3. Перезапустите процессор сообщений:

      /opt/apigee/apigee-service/bin/apigee-service edge-message-processor restart

Переменные потока

Ниже приведены переменные политики LDAP, заполняемые с помощью SearchQuery .

ldap.policyName.execution.success

ldap.policyName.search.result[index].
  attribute.attrName[index]=value

ldap.policyName.search.result.attribute.address
ldap.policyName.search.result.attribute.phone
ldap.policyName.search.result.attribute.email

ldap.policyName.search.result[3].attribute.address

ldap.policyName.search.result.attribute.mail[2]

Коды ошибок

Ошибки, возвращаемые политиками Edge, имеют единообразный формат, как описано в справочнике по кодам ошибок .

Эта политика использует следующие коды ошибок: