Sie sind hier: Startseite
 Liste aller Codebeispiele

Ausführen einer LDAP-Suche im AD

Ein Beispiel zum Einsatz der Klasse System.DirectoryServices.DirectorySearcher aus der .NET-Klassenbibliothek.

Autor: Dr. Holger Schwichtenberg 

Beschreibung

Im Classic-ADSI wurde diese Funktionalität des ADSI-Query durch einen OLEDB-Provider gekapselt. Dieser steht grundsätzlich natürlich auch in ADO.NET über den Managed Provider für OLEDB noch zur Verfügung. Allerdings bietet der Namespace System.DirectoryServices eine elegantere Möglichkeit zur Ausführung von LDAP-Suchanfragen.

Während der OLEDB-Provider für ADSI Anfragen sowohl in LDAP-Query-Syntax als auch als SQL-Befehle unterstützt, können mit den in der FCL eingebauten Klassen nur LDAP-Query-Syntax-Anfragen gestellt werden.

Ebenso wie mit dem OLEDB-Provider können auch mit den FCL-Klassen nur LDAP-fähige Verzeichnisdienste abgefragt werden.

Beispiel für eine LDAP-Suchabfrage
Die folgende Abfrage sucht im ganzen Active Directory alle Benutzerkonten, deren Namen mit dem Buchstaben "H" beginnen.

<LDAP://sonne2000/dc=IT Visions,dc=DE>;
(&( objectclass=user)(name=h*));
adspath,SAMAccountname;subtree

Eine Abfrage, die nur aus der Bedingung class=* besteht, funktioniert nicht. Um alle Verzeichnisobjekte zurückzuliefern, muss der Sternoperator auf ein anderes Attribut angewendet werden.

Ausführung einer Abfrage
Eine LDAP-Abfrage wird mit FCL-Klassen in folgenden Schritten ausgeführt:
  • Instanziierung der Klasse DirectorySearcher
  • Festlegung des Ausgangspunkts der Anfrage durch Zuweisung eines Zeigers auf ein DirectoryEntry-Objekt, das an den Ausgangspunkt gebunden ist, an das Attribut SearchRoot.
  • Setzen des Filter-Teils der LDAP-Abfrage im Attribut Filter
  • Festlegung der Attribute durch Füllen der Collection PropertiesToLoad
  • Festlegung des Scopes in dem Attribut SearchScope
  • Starten der Anfrage durch die Methode FindAll()
  • FindAll() liefert eine Collection vom Typ SearchResultCollection zurück.
  • Die SearchResultCollection enthält einzelne SearchResult-Objekte.
  • Von einem SearchResult-Objekt kann man entweder über die ResultsPropertyCollection lesend auf die abgefragten Attribute zugreifen oder aber man lässt sich von der Methode GetDirectoryEntry() ein DirectoryEntry-Objekt für den gefundenen Verzeichniseintrag liefern. Das so ermittelte DirectoryEntry-Objekt ermöglicht auch den Schreibzugriff.

Beispiel
In dem folgenden Beispiel werden im ganzen Active Directory alle Benutzerkonten gesucht, deren Verzeichnisname mit dem Buchstaben "H" beginnt. Für diese Objekte werden der Verzeichnisname und die Stadt ausgegeben. Außerdem wird für alle diese Objekte die Beschreibung auf den Text "Benutzer mit 'H'" geändert.

Programmcodebeispiele Visual Basic .NET (VB.NET)

' ============================
' .NET-Code-Beispiel in Visual Basic .NET
' Ausführen einer LDAP-Suche im AD
' (C) Holger@Schwichtenberg.de
' ============================
Sub ADS_suche()
Dim suche As DirectorySearcher
Dim ergebnisliste As SearchResultCollection
Dim ergebnis As SearchResult

out("# Suchanfrage im ADS")

' --- Suchanfrage
Const suchanfrage = "(&(objectclass=user)(cn=h*))"
' --- Instanziierung der Klasse
suche = New DirectorySearcher()
' --- Festlegung des Ausgangspunkts
suche.SearchRoot = New DirectoryEntry(LDAProot)
' --- Festlegung der LDAP-Query
suche.Filter = suchanfrage

' --- Ort einbeziehen
suche.PropertiesToLoad.Add("l")
suche.PropertiesToLoad.Add("Description")
' --- Suchtiefe festlegen
suche.SearchScope = SearchScope.Subtree
' --- Suche starten
ergebnisliste = suche.FindAll()
' --- Ergebnismenge ausgeben
For Each ergebnis In ergebnisliste
' --- Ergebnis lesen
out(getAtt(ergebnis, "Name") & " wohnt In " & _
getAtt(ergebnis, "l"))
out(getAtt(ergebnis, "Description"))
' --- Ergebnis verändern
Dim de As DirectoryEntry = ergebnis.GetDirectoryEntry
de.Properties("description").Clear()
de.Properties("description").Add("Benutzer mit 'H'")
de.CommitChanges()
Next
End Sub

Programmcodebeispiele CSharp (C#)

using System;
using System.DirectoryServices;
using ActiveDs;

namespace FCLBuch._SystemDirectoryServices {

public class Samples_ADSI {
public void ADS_suche() {

// Ausführen einer LDAP-Suche im AD
FclOutput.PrintOut("# Suchanfrage im ADS");

// Suchanfrage
string suchanfrage = "(+(objectclass=user)(cn=h*))";
// Instanziierung der Klasse
DirectorySearcher suche = new DirectorySearcher();
// Festlegung des Ausgangspunkts
suche.SearchRoot = new DirectoryEntry(LDAProot);
// Festlegung der LDAP-Query
suche.Filter = suchanfrage;

// Ort einbeziehen
suche.PropertiesToLoad.Add("l");
suche.PropertiesToLoad.Add("Description");
// Suchtiefe festlegen
suche.SearchScope = SearchScope.Subtree;
// Suche starten
SearchResultCollection ergebnisliste = suche.FindAll();
// Ergebnismenge ausgeben
foreach (SearchResult ergebnis in ergebnisliste) {
// Ergebnis lesen
FclOutput.PrintOut(ADSIHelperMethods.GetAtt(ergebnis, "Name") + " wohnt in " + ADSIHelperMethods.GetAtt(ergebnis, "l"));
FclOutput.PrintOut(ADSI_HelperMethods.GetAtt(ergebnis, "Description"));
// Ergebnis verändern
DirectoryEntry de = ergebnis.GetDirectoryEntry();
de.Properties["description"].Clear();
de.Properties["description"].Add("Benutzer mit 'H'");
de.CommitChanges();
}
}
}
}

Querverweise

 Definition '.NET Framework Class Library'  Verfügbarkeit der Klasse 'System.DirectoryServices.DirectorySearcher'  Übersicht über den FCL-Namensraum 'System.DirectoryServices'  .NET & Visual Studio Community Portal