Política LDAP

Você está lendo a documentação do Apigee Edge.
Acesse a documentação da Apigee X. info

O que

A política do LDAP oferece:

• Autenticação: as credenciais de usuário fornecidas na solicitação são validadas em relação às credenciais no provedor LDAP. A política do LDAP oferece muita flexibilidade com a autenticação, permitindo que você use qualquer valor de DN com a senha, mesmo que o valor de DN desejado não esteja na solicitação. Por exemplo, digamos que você precise usar e-mail / senha para autenticação. As seguintes opções são possíveis:
  • Se o e-mail estiver na solicitação, basta usá-lo com a senha para autenticação LDAP.
  • Se o e-mail não estiver na solicitação, mas outro atributo de DN estiver (como número de telefone), use o número de telefone para receber o e-mail correspondente do LDAP e use e-mail / senha para autenticar.
• Pesquisa de nome distinto (DN): além da autenticação, você também pode usar a política LDAP para identificar um atributo de usuário na solicitação, como e-mail, e realizar uma consulta que recupera outros atributos de DN do LDAP para esse usuário. O DN recuperado é armazenado em uma variável.

Use a política do LDAP quando o acesso a recursos protegidos precisar ser limitado a usuários no provedor de LDAP, como administradores, usuários da organização e desenvolvedores, principalmente quando o acesso ao token OAuth for desnecessário ou muito pesado. A política também foi projetada para recuperar metadados de nome de domínio para uso em fluxos de proxy de API.

Por exemplo, é possível fazer com que uma chamada de API seja executada apenas quando um usuário é autenticado com sucesso no LDAP e, opcionalmente, recuperar atributos de DN (nome de domínio) para o usuário após a autenticação ser bem-sucedida.

Para mais informações, consulte:

• Como gerenciar a política de senhas LDAP padrão para o gerenciamento de APIs
• "Informações importantes sobre sua política de senhas" na Comunidade do Apigee

Amostras

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

Referência de elemento

Confira a seguir as descrições dos elementos e atributos da política LDAP.

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

Notas de uso

O Apigee Edge para nuvem privada permite aproveitar um provedor LDAP em chamadas de API. Com a política do LDAP, os aplicativos podem autenticar credenciais em relação aos usuários armazenados no LDAP, e você pode recuperar nomes distintos (DNs) do LDAP, ou seja, os metadados ou atributos associados a cada usuário, como e-mail, endereço e número de telefone. O DN retornado é armazenado em uma variável para uso posterior pelo proxy de API.

Criar um recurso LDAP

A política LDAP usa um recurso LDAP criado no Apigee Edge. Um recurso LDAP fornece as informações de conexão ao seu repositório LDAP.

Para criar e gerenciar recursos LDAP, use a seguinte API e payload:

API

Crie (POST) um recurso LDAP ou liste (GET) todos os recursos LDAP:

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

Confira detalhes sobre (GET), atualização (POST) e exclusão (DELETE) de um recurso LDAP:

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

Payload

Confira abaixo um exemplo de payload XML com comentários de uso.

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

Exemplo de curl: criar um recurso LDAP

O exemplo a seguir cria um recurso LDAP chamado 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>'

Códigos de resposta

Confira abaixo os códigos de resposta HTML que a política retorna em caso de sucesso ou falha:

• Sucesso: 200
• Falha: 401

Usar um provedor LDAP personalizado no Edge para nuvem privada

Como usar um provedor LDAP personalizado

O Apigee Edge para nuvem privada vem com um provedor LDAP já configurado para interagir com a política LDAP. No entanto, se você estiver usando um provedor LDAP personalizado, precisará ativar o provedor para oferecer suporte à política do LDAP. Para fazer isto:

1. Na sua classe de provedor LDAP, implemente a interface 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. No <LdapConnectorClass> da configuração da política (próximas seções), adicione o nome de classe totalmente qualificado do seu provedor LDAP personalizado.
3. Faça o download deste arquivo: custom-ldap.jar_.zip. Talvez seja necessário clicar com o botão direito do mouse e selecionar Salvar como.
4. Descompacte o arquivo.
5. Adicione o arquivo custom-ldap.jar ao seu ambiente e verifique se ele está no caminho de classe.
6. Crie um recurso de ambiente para seu provedor LDAP. Você vai usar o nome do recurso de ambiente no elemento <LdapResource> da política LDAP.

Usar o SDK do UnboundID LDAP para Java

Você pode usar o SDK LDAP do UnboundID com a política LDAP, mas primeiro faça o download da versão 2.3.1 e adicione-a a cada um dos caminhos de classe do processador de mensagens.

Para usar o SDK do LDAP do UnboundID com a política do LDAP:

1. Abra um navegador e acesse o repositório de arquivos do Sourceforge para o SDK LDAP do UnboundID:

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

2. Encontre a versão 2.3.1 (SE ou Standard Edition) do SDK e faça o download do arquivo ZIP dessa versão. Por exemplo, faça o download de "unboundid-ldapsdk-2.3.1-se.zip".
3. Extraia o arquivo JAR do arquivo ZIP do SDK, como mostra o exemplo a seguir:

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

   Esse comando extrai apenas o arquivo JAR para o diretório ~/tmp. Ele descarta a estrutura de diretório com -j, embora isso seja opcional.

4. Em cada nó do processador de mensagens:
   1. Copie o arquivo JAR para o diretório /opt/apigee/edge-gateway/lib/thirdparty do processador de mensagens.
   2. Se necessário, conceda permissão de usuário do Apigee no arquivo JAR para que o processador de mensagens possa acessá-lo.

   O Edge adiciona todas as bibliotecas de terceiros no diretório /opt/apigee/edge-gateway/lib/thirdparty ao caminho de classe.

   3. Reinicie o processador de mensagens:

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

Variáveis de fluxo

A seguir, estão as variáveis da política LDAP preenchidas por um 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]

Códigos de erro

Os erros retornados pelas políticas do Edge seguem um formato consistente, conforme descrito na Referência do código do erro.

Esta política usa os seguintes códigos de erro: