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();
}
}
}
}

Hinweise

Ausgaben werden in den Beispielen durch Hilfsroutinen wie out() und PrintOut() erzeugt. Diese sind hier nicht angegeben, da deren Implementierung von der jeweiligen Umgebung abhängt. Für Konsolenanwendungen können hier z.B. Console.WriteLine() einsetzen.


 

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

Buchtipp

Buchcover Windows PowerShell 5.1 und PowerShell Core 6.1 - Das Praxishandbuch (3. Auflage 12/2018) Kindle Windows PowerShell 5.1 und PowerShell Core 6.1 - Das Praxishandbuch (3. Auflage 12/2018) Kindle
Autoren: Dr. Holger Schwichtenberg
erschienen 2018, 1000 Seiten, 42,99 €
ISBN: 978-3-446-45923-6
Bestellung: Amazon.de oder im Buchhandel über ISBN 978-3-446-45923-6

Beratung & Support:

Schulungen zu diesem Thema:

 Task Parallel Library (TPL) - Parallelprogrammierung/Multi-Threading in .NET mit C# oder Visual Basic
 Visual Basic .NET - Aufbauwissen
 Grundlagen der objektorientierten Programmierung anhand von C# oder Visual Basic .NET
 Unit Testing / Testgetriebene Entwicklung / Test Driven Development (TDD) von .NET-Anwendungen (C#/Visual Basic .NET)
 Visual Basic 6.0 (VB6.0)
 Objektorientierte Entwurfsmuster (Design Pattern) mit .NET (C#, Visual Basic .NET, C++/CLI)
 Visual Basic .NET - Basiswissen
 Windows Modern Apps/Windows Universal Apps entwickeln mit der Windows Runtime (WinRT), XAML und .NET/C#/Visual Basic
 Visual Basic Script (VBScript/VBS) - Sprachsyntax und Praxiseinsatz
 Word-Programmierung mit Visual Basic for Applications (VBA)
 Visual Studio Tools for Microsoft Office (VSTO) - Microsoft Office-Programmierung mit .NET und C# oder Visual Basic in Visual Studio
 Parallelprogrammierung mit .NET (Multi-Threading/Multi-Tasking) - mit C#/Visual Basic und/oder C++
 C# für Umsteiger von Visual Basic .NET
 Objektorientierte Programmierung (OOP) mit C#, Java, C++, Visual Basic.NET o.ä.
 Visual Basic .NET für Umsteiger von VBA/VB 4/5/6
 Visual Basic 2005 (Visual Basic 8.0)
 C# für Umsteiger von klassischem Visual Basic/COM
 Das Component Object Model - für Script- und Visual Basic-Entwickler
 .NET Micro Framework - Embedded-Entwicklung mit .NET/C# oder C++
 .NET-Akademie: .NET-/.NET Core-/C#-Basisseminar: Softwarearchitektur, Techniken, Pattern, Best Practices (2-Tages-Agenda des öffentlichen Seminars)
 Anfrage für eine individuelle Schulung zum Thema Visual Basic;C#  Gesamter Schulungsthemenkatalog

Bücher zu diesem Thema:

 Datenbankprogrammierung mit .NET 4.0. Mit Visual Studio 2010 und SQL Server 2008 R2
 .NET 3.5
 Microsoft ASP.NET 4.0 mit C# 2010
 Webanwendungen mit ASP.NET 3.5 und AJAX Crashkurs
 Moderne Datenzugriffslösungen mit Entity Framework Core 1.1: Datenbankprogrammierung mit .NET/.NET Core und C# (gedruckte Ausgabe)
 Moderne Datenzugriffslösungen mit Entity Framework Core 1.1.1 und 2.0-Preview2: Datenbankprogrammierung mit .NET/.NET Core und C# (gedruckte Ausgabe und Kindle)
 Moderne Datenzugriffslösungen mit Entity Framework Core 2.0/2.1 (Buchversion 5.x, Kindle | PDF)
 Windows 8 Apps entwickeln mit C# und XAML - Crashkurs
 Microsoft Visual C# 2010
 Microsoft SQL Server 2008 R2 - Das Entwicklerbuch
 ASP.NET 4.0 mit Visual C# 2010
 ASP.NET 4.0
 Windows PowerShell - Konzepte, Praxiseinsatz, Erweiterungen
 Microsoft .NET 2.0 Crashkurs - Final Edition
 Essential PowerShell
 Moderne Datenzugriffslösungen mit Entity Framework Core 1.1 und 2.0-Preview2 (Buchversion 1.4)
 Datenbankprogrammierung mit .NET 4.5. Mit Visual Studio 2012 und SQL Server 2012
 Moderne Datenzugriffslösungen mit Entity Framework Core 1.1 (PDF)
 Office 2010 Programmierung mit VSTO und .NET 4.0: Word, Excel und Outlook erweitern und anpassen
 Modern Data Access with Entity Framework Core: Database Programming Using .NET, .NET Core, UWP, and Xamarin with C#
 Microsoft ASP.NET 2.0 mit Visual Basic 2005 - Das Entwicklerbuch
 .NET 3.5 Crashkurs
 Windows Scripting Lernen, 6. Auflage
 Microsoft .NET 4.5 Update - Crashkurs (EBOOK - PDF)
 Visual Basic 2010: Grundlagen, ADO.NET, Windows Presentation Foundation
 Windows Scripting (5. Auflage)
 Moderne Datenzugriffslösungen mit Entity Framework Core 1.1.2 und 2.0-Preview2: Datenbankprogrammierung mit .NET/.NET Core und C# (PDF)
 Microsoft ASP.NET 2.0 mit C# 2005 - Das Entwicklerbuch
 Effizienter Datenzugriff mit Entity Framework Core: Datenbankprogrammierung mit C# für .NET Framework, .NET Core und Xamarin
 Microsoft ASP.NET 3.5 mit Visual C# 2008 - Das Entwicklerbuch
 Einblicke in C# 6.0 (shortcuts 181) Kindle Edition
 .NET 4.0 Crashkurs
 Docker und die Containerwelt - Einstieg und Expertentipps rund um Docker-Container (shortcut)
 Microsoft .NET 4.5 Update - Crashkurs
 Moderne Webanwendungen für .NET-Entwickler: Server-Anwendungen, Web APIs, SPAs & HTML-Cross-Platform-Anwendungen mit ASP.NET, ASP.NET Core, JavaScript/TypeScript und Angular
 C# 7.2 Crashkurs: Die Syntax der Programmiersprache C# für die Softwareentwicklung in .NET Framework, .NET Core und Xamarin (PDF)
 Windows Scripting Lernen, 2. Auflage
 Moderne Datenzugriffslösungen mit Entity Framework 6 (gedruckte Ausgabe)
 C# 7.3 Crashkurs: Die Syntax der Programmiersprache C# für die Softwareentwicklung in .NET Framework, .NET Core und Xamarin
 Moderne Datenzugriffslösungen mit Entity Framework Core 1.x und 2.0: Datenbankprogrammierung mit .NET/.NET Core und C# (gedruckte Ausgabe oder Kindle)
 Visual Basic 2010
 Microsoft ASP.NET 4.5 mit C# 2012 - Entwicklerbuch
 Microsoft ASP.NET 3.5 mit Visual Basic 2008 - Das Entwicklerbuch
 Moderne Datenzugriffslösungen mit Entity Framework Core 2.0 (Buchversion 4.x): Datenbankprogrammierung mit .NET/.NET Core und C# (gedruckte Ausgabe oder Kindle)
 Moderne Datenzugriffslösungen mit Entity Framework Core 2.0 (Buchversion 4.x): Datenbankprogrammierung mit .NET/.NET Core und C# (EBOOK - PDF)
 Moderne Datenzugriffslösungen mit Entity Framework 6 (EBOOK - PDF, MOBI, EPUB)
 Moderne Datenzugriffslösungen mit Entity Framework Core 1.x und 2.0: Datenbankprogrammierung mit .NET/.NET Core und C# (EBOOK - PDF)
 Windows Scripting Lernen 5. Auflage
 Alle unsere aktuellen Fachbücher