Referencia de funciones
PHP Manual

Funciones LDAP

Introducción

LDAP es el protocolo simple de acceso a directorios (Lightweight Directory Access Protocol), un protocolo usado para acceder a "Servidores de Directorio". El directorio es una clase especial de base de datos que contiene información estructurada en forma de árbol.

El concepto es similar a la estructura de directorios de los discos duros, pero en este caso, el directorio raiz es "El Mundo" y los subdirectorios de primer nivel son los "países". Niveles inferiores de la estructura de directorio contienen entradas para compañías, organizaciones o lugares, y en niveles aún más inferiores se encuentran las entradas para la gente, y en algunos casos equipos informáticos y documentos.

Para referirse a un archivo en un subdirectorio del disco duro se usa algo como:

    /usr/local/misapps/docs
   

Las barras marcan cada división en la referencia al archivo, y la secuencia es leida de izquierda a derecha.

El equivalente a la referencia a un archivo en LDAP es el "distinguished name" (nombre distinguible), abreviado como "dn". Un ejemplo de dn podría ser.

    cn=Pedro Pérez,ou=Contabilidad,o=Mi Compañía,c=ES
   

Las comas marcan cada división en la referencia, y la secuencia se lee de derecha a izquierda. Este dn se leería como:

    country = ES
    organization = Mi Compañía
    organizationalUnit = Contabilidad
    commonName = Pedro Pérez
   

De la misma manera que no hay reglas estrictas sobre como organizar la estructura de directorios de un disco duro, un administrador de un servidor de directorio puede establecer cualquier estructura que sea útil para sus propósitos. Sin embargo hay algunos acuerdos tácitos que siempre deben seguirse. La conclusión es que no se pueden escribir programas para acceder a un directorio si no se conoce algo de su estructura, igual que no se puede usar una base de datos sin algún conocimiento sobre lo que está disponible en ella.

Información sobre LDAP se puede encontrar en:

Netscape SDK tiene una » Guia de programación muy buena en HTML.

Requisitos

Se necesita obtener y compilar las bibliotecas LDAP cliente de la dirección de » OpenLDAP o de » Bind9.net para poder compilar PHP con soporte LDAP.

Instalación

Para incluir el soporte de LDAP en PHP, es necesario añadir el parámetro --with-ldap[=DIR] a las opciones de configuración de la compilación de PHP, donde DIR apunta al directorio base de instalación de LDAP. Para incluir soporte de SASL, también se debe añadir la siguiente opción de compilación --with-ldap-sasl[=DIR], y además el archivo sasl.h debe existir en el sistema.

Note: Nota para los usuarios de Windows Para habilitar este módulo en entornos Windows, se deben copiar varios archivos de la carpeta DLL del directorio PHP/Win32 a la carpeta SYSTEM del sistema (que normalmente se encuentra en C:\WINNT\SYSTEM32 o C:\WINDOWS\SYSTEM). Para las versiones de PHP <= 4.2.0 se tiene que copiar el archivo libsasl.dll, para las versiones de PHP >= 4.3.0 se deben copiar los archivos libeay32.dll y ssleay32.dll.

Configuración en tiempo de ejecución

El comportamiento de estas funciones está afectado por los valores definidos en php.ini.

Opciones de configuración de LDAP
Nombre Valor por defecto Donde se cambia Registro de cambios
ldap.max_links "-1" PHP_INI_SYSTEM  
For further details and definitions of the PHP_INI_* constants, see the Directivas de php.ini.

Tipos de recursos

Esta extensión no tiene ningún tipo de recurso definido.

Constantes predefinidas

Estas constantes están definidas por esta extensión y estarán disponibles solamente cuando la extensión ha sido o bien compilada dentro de PHP o grabada dinámicamente en tiempo de ejecución.

LDAP_DEREF_NEVER (integer)
LDAP_DEREF_SEARCHING (integer)
LDAP_DEREF_FINDING (integer)
LDAP_DEREF_ALWAYS (integer)
LDAP_OPT_DEREF (integer)
LDAP_OPT_SIZELIMIT (integer)
LDAP_OPT_TIMELIMIT (integer)
LDAP_OPT_PROTOCOL_VERSION (integer)
LDAP_OPT_ERROR_NUMBER (integer)
LDAP_OPT_REFERRALS (integer)
LDAP_OPT_RESTART (integer)
LDAP_OPT_HOST_NAME (integer)
LDAP_OPT_ERROR_STRING (integer)
LDAP_OPT_MATCHED_DN (integer)
LDAP_OPT_SERVER_CONTROLS (integer)
LDAP_OPT_CLIENT_CONTROLS (integer)
LDAP_OPT_DEBUG_LEVEL (integer)
GSLC_SSL_NO_AUTH (integer)
GSLC_SSL_ONEWAY_AUTH (integer)
GSLC_SSL_TWOWAY_AUTH (integer)

Ejemplos

Recuperar informacion para todas las entradas donde el apellido empiece por "P" de un servidor de directorio, mostrando un listado con el nombre y dirección de correo electrónico.

Example#1 Ejemplo de búsqueda LDAP

<?php
// La secuencia básica para trabajar con LDAP es conectar, autentificarse,
// buscar, interpretar el resultado de la búsqueda y cerrar la conexión.

echo "<h3>Prueba de consulta LDAP</h3>";
echo 
"Conectando ...";
$ds=ldap_connect("localhost");  // Debe ser un servidor LDAP valido!
echo "El resultado de la conexion es ".$ds."<br />";

if (
$ds) { 
    echo 
"Autentificandose  ..."
    
$r=ldap_bind($ds);     // Autentificacion anonima, habitual de los
                           // accesos de solo lectura
    
echo "El resultado de la autentificacion es ".$r."<br />";

    echo 
"Buscando (sn=P*) ...";
    
// Busqueda de entradas por apellidos
    
$sr=ldap_search($ds,"o=Mi Compania, c=ES""sn=P*");  
    echo 
"El resultado de la busqueda es ".$sr."<br />";

    echo 
"El numero de entradas devueltas es ".ldap_count_entries($ds,$sr)."<br />";

    echo 
"Recuperando entradas ...<p>";
    
$info ldap_get_entries($ds$sr);
    echo 
"Se han encontrado ".$info["count"]." entradas:<p>";

    for (
$i=0$i<$info["count"]; $i++) {
        echo 
"dn es: "$info[$i]["dn"] ."<br />";
        echo 
"La primera entrada cn es: "$info[$i]["cn"][0] ."<br />";
        echo 
"La primera entrada email es: "$info[$i]["mail"][0] ."<br /><hr />";
    }

    echo 
"Cerrando conexion";
    
ldap_close($ds);

} else {
    echo 
"<h4>No ha sido posible conectarse al servidor LDAP</h4>";
}
?>

Usando las funciones LDAP de PHP

Antes de usar las funciones LDAP deben conocerse los siguientes datos...

  • El nombre o dirección del servidor de directorio que se va a usar

  • El "dn base" del servidor (la parte del directorio global que maneja ese servidor, que puede ser por ejemplo "o=Mi Compañía,c=ES")

  • Si es necesaria contraseña para acceder al servidor (muchos servidores ofrecen acceso de lectura para usuarios anónimos pero requieren una contraseña para cualquier otro acceso)

La secuencia típica de llamadas a funciones LDAP que realizan las aplicaciones suele seguir el siguiente patrón:

  ldap_connect()    // establecer la conexión con el servidor
     |
  ldap_bind()       // acceso anónimo o autentificado
     |
  Hacer búsquedas o actualizaciones en el directorio
  y mostrar los resultados
     |
  ldap_close()      // cerrar la conexión
    

Table of Contents


Referencia de funciones
PHP Manual