EinführungZend_Ldap ist eine Klasse, mit der LDAP
Operationen, wie das Durchsuchen, das Bearbeiten oder die Bindung an Einträge im
LDAP Verzeichnis, durchgeführt werden können.
Theorie der Verwendung
Diese Komponente besteht aus der Hauptklasse Zend_Ldap welche
konzeptionell eine Bindung an einen einzelnen LDAP Server
repräsentiert und die Ausführung von Operationen an diesem LDAP
Server erlaubt, wie zum Beispiel OpenLDAP oder ActiveDirectory (AD) Server. Die
Parameter für das Binden können explizit oder in der Form eines Options Arrays
angegeben werden. Zend_Ldap_Node bietet ein Objektorientiertes
Interface für einen einzelnen LDAP Node und kann verwendet werden
um eine Basis für ein Active-Record artiges Interface für ein LDAP
basiertes Domain-Modell zu bieten.
Die Komponente bietet verschiedene Helfer Klassen um Operationen auf
LDAP Einträgen (Zend_Ldap_Attribute)
durchzuführen, wie das Setzen und Empfangen von Attributen (Datumswerte, Passwörter,
Boolsche Werte, ...), um LDAP Filter Strings
(Zend_Ldap_Filter) zu Erstellen und zu Ändern, und um
LDAP Distinguished Names (DN) (Zend_Ldap_Dn)
zu manipulieren.
Zusätzlich abstrahiert die Komponente das Suchen im LDAP Schema
für OpenLDAP und ActiveDirectory Server Zend_Ldap_Node_Schema
und das empfangen von Server Informationen für OpenLDAP-, ActiveDirectory- und Novell
eDirectory Server (Zend_Ldap_Node_RootDse).
Die Verwendung der Zend_Ldap Klasse hängt vom Typ des
LDAP Servers ab und wird am besten mit einigen einfachen Beispielen
gezeigt.
Wenn man OpenLDAP Verwendet sieht ein einfaches Beispiel wie folgt aus
(es ist zu beachten das die bindRequiresDn Option wichtig ist wenn
man nicht AD verwendet):
's0.foo.net',
'username' => 'CN=user1,DC=foo,DC=net',
'password' => 'pass1',
'bindRequiresDn' => true,
'accountDomainName' => 'foo.net',
'baseDn' => 'OU=Sales,DC=foo,DC=net',
);
$ldap = new Zend_Ldap($options);
$acctname = $ldap->getCanonicalAccountName('abaker',
Zend_Ldap::ACCTNAME_FORM_DN);
echo "$acctname\n";
]]>
Wenn man Microsoft AD verwendet ist ein einfaches Beispiel:
'dc1.w.net',
'useStartTls' => true,
'username' => 'user1@w.net',
'password' => 'pass1',
'accountDomainName' => 'w.net',
'accountDomainNameShort' => 'W',
'baseDn' => 'CN=Users,DC=w,DC=net',
);
$ldap = new Zend_Ldap($options);
$acctname = $ldap->getCanonicalAccountName('bcarter',
Zend_Ldap::ACCTNAME_FORM_DN);
echo "$acctname\n";
]]>
Es ist zu beachten das die getCanonicalAccountName() Methode
verwendet wird um den DN Account zu empfangen da jenes das einige ist was das meiste
in diesem kleinen Code zeigt der aktuell in dieser Klasse vorhanden ist.
Automatische Kanonisierung des Benutzernamens beim Binden
Wenn bind() mit einem nicht-DN Benutzernamen aufgerufen wird
aber bindRequiresDNTRUE ist und kein
Benutzername in DN-Form als Option angegeben wurde, dann wird die Server-Bindung
fehlschlagen. Wenn allerdings ein Benutzername in DN-Form im Optionen-Array
übergeben wurde, wird Zend_Ldap sich zuerst mit diesem
Benutzernamen an den Server binden, den Account DN für den Benutzernamen empfangen
der bei bind() angegeben wurde und dann mit diesem zum DN verbinden.
Dieses Verhalten ist kritisch für Zend_Auth_Adapter_Ldap,
welches den vom Benutzer angegebenen Benutzernamen direkt an
bind() übergibt.
Das folgende Beispiel zeigt wie der nicht-DN Benutzername
'abaker' mit bind() verwendet werden
kann:
's0.foo.net',
'username' => 'CN=user1,DC=foo,DC=net',
'password' => 'pass1',
'bindRequiresDn' => true,
'accountDomainName' => 'foo.net',
'baseDn' => 'OU=Sales,DC=foo,DC=net',
);
$ldap = new Zend_Ldap($options);
$ldap->bind('abaker', 'moonbike55');
$acctname = $ldap->getCanonicalAccountName('abaker',
Zend_Ldap::ACCTNAME_FORM_DN);
echo "$acctname\n";
]]>
Der Aufruf von bind() in diesem Beispiel sieht das der
Benutzer 'abaker' nicht in DN Form ist, findet das
bindRequiresDnTRUE ist, verwendet
'CN=user1,DC=foo,DC=net' und 'pass1' um zu
Binden, empfängt den DN für 'abaker', entbindet und Bindet
dann nochmals mit dem neu erkannten
'CN=Alice Baker,OU=Sales,DC=foo,DC=net'.
Kanonisierung des Account Namens
Die Optionen accountDomainName und
accountDomainNameShort werden für zwei Zwecke verwendet:
(1) bieten Sie multi-Domain Authentifizierung und Failover Möglichkeiten, und
(2) werden Sie auch verwendet um Benutzernamen zu kanonisieren. Speziell Namen
werden in die Form kanonisiert die in der accountCanonicalForm
Option spezifiziert ist. Diese Option kann einen der folgenden Werte enthalten:
Optionen für accountCanonicalFormNameWertBeispielACCTNAME_FORM_DN1CN=Alice Baker,CN=Users,DC=example,DC=comACCTNAME_FORM_USERNAME2abakerACCTNAME_FORM_BACKSLASH3EXAMPLE\abakerACCTNAME_FORM_PRINCIPAL4abaker@example.com
Die Standardmäßige Kanonisierung hängt davon ab welche Optionen für Account Domain
Namen angegeben wurden. Wenn accountDomainNameShort angegeben
wurde, ist der Standardwert von accountCanonicalFormACCTNAME_FORM_BACKSLASH. Andernfall, wenn
accountDomainName angegeben wurde, ist der Standardwert
ACCTNAME_FORM_PRINCIPAL.
Die Kanonisierung des Account Namens stellt sicher das der String der zur
Identifikation des Accounts verwendet wird konsistent ist, unabhängig davon was an
bind() übergeben wurde. Wenn der Benutzer, zum Beispiel,
den Account Namen abaker@example.com oder nur
abaker angibt, und accountCanonicalForm
auf 3 gesetzt ist, wird der resultierende kanonisierte Name
EXAMPLE\abaker sein.
Multi-domain Authentication and Failover
The Zend_Ldap component by itself makes no attempt
to authenticate with multiple servers. However, Zend_Ldap
is specifically designed to handle this scenario gracefully. The
required technique is to simply iterate over an array of arrays of serve
options and attempt to bind with each server. As described above
bind() will automatically canonicalize each name, so
it does not matter if the user passes abaker@foo.net or
W\bcarter or cdavis - the
bind() method will only succeed if the credentials were
successfully used in the bind.
Consider the following example that illustrates the technique required to
implement multi-domain authentication and failover:
array(
'host' => 's0.foo.net',
'username' => 'CN=user1,DC=foo,DC=net',
'password' => 'pass1',
'bindRequiresDn' => true,
'accountDomainName' => 'foo.net',
'accountDomainNameShort' => 'FOO',
'accountCanonicalForm' => 4, // ACCT_FORM_PRINCIPAL
'baseDn' => 'OU=Sales,DC=foo,DC=net',
),
'server2' => array(
'host' => 'dc1.w.net',
'useSsl' => true,
'username' => 'user1@w.net',
'password' => 'pass1',
'accountDomainName' => 'w.net',
'accountDomainNameShort' => 'W',
'accountCanonicalForm' => 4, // ACCT_FORM_PRINCIPAL
'baseDn' => 'CN=Users,DC=w,DC=net',
),
);
$ldap = new Zend_Ldap();
foreach ($multiOptions as $name => $options) {
echo "Trying to bind using server options for '$name'\n";
$ldap->setOptions($options);
try {
$ldap->bind($acctname, $password);
$acctname = $ldap->getCanonicalAccountName($acctname);
echo "SUCCESS: authenticated $acctname\n";
return;
} catch (Zend_Ldap_Exception $zle) {
echo ' ' . $zle->getMessage() . "\n";
if ($zle->getCode() === Zend_Ldap_Exception::LDAP_X_DOMAIN_MISMATCH) {
continue;
}
}
}
]]>
If the bind fails for any reason, the next set of server options is tried.
The getCanonicalAccountName() call gets the canonical
account name that the application would presumably use to associate data with such
as preferences. The accountCanonicalForm = 4 in all server
options ensures that the canonical form is consistent regardless of which
server was ultimately used.
The special LDAP_X_DOMAIN_MISMATCH exception occurs when an
account name with a domain component was supplied (e.g.,
abaker@foo.net or FOO\abaker and not just
abaker) but the domain component did not match either domain
in the currently selected server options. This exception indicates
that the server is not an authority for the account. In this
case, the bind will not be performed, thereby eliminating unnecessary
communication with the server. Note that the continue
instruction has no effect in this example, but in practice for error handling and
debugging purposes, you will probably want to check for
LDAP_X_DOMAIN_MISMATCH as well as
LDAP_NO_SUCH_OBJECT and
LDAP_INVALID_CREDENTIALS.
The above code is very similar to code used within Zend_Auth_Adapter_Ldap.
In fact, we recommend that you simply use that authentication adapter for
multi-domain + failover LDAP based authentication
(or copy the code).