Code-Beispiel

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

 Liste aller Codebeispiele  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 PowerShell 7 und Windows PowerShell 5 – das Praxishandbuch (5. Auflage Oktober 2022 (9. Auflage Gesamtreihe)) PowerShell 7 und Windows PowerShell 5 – das Praxishandbuch
Autor(en): Dr. Holger Schwichtenberg
Erschienen 2022
Umfang: 1426 Seiten
ISBN: 3446472967

Beratung & Support

Schulungen zu diesem Thema

 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# oder Visual Basic .NET)
 Visual Basic 6.0 (VB6.0)
 Objektorientierte Entwurfsmuster (Design-Pattern/Architektur-Pattern) mit .NET (C#, Visual Basic .NET)
 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
 Multi-Threading in .NET mit C#/Visual Basic .NET und/oder C++ und C++/CLI
 C# für Umsteiger von Visual Basic .NET
 Objektorientierte Programmierung (OOP) mit C#, Java, C++, Visual Basic.NET o.ä.
 Excel-Programmierung mit Visual Basic for Applications (VBA)
 Visual Basic .NET für Umsteiger von VBA/VB 4/5/6
 Visual Basic 2005 (Visual Basic 8.0)
 .NET und C# für Umsteiger von klassischem Visual Basic/COM
 Outlook-Programmierung mit Visual Basic for Applications (VBA)
 Das Component Object Model - für Script- und Visual Basic-Entwickler
 C#-Basiswissen (Grundlagen der Programmiersprache C#)
 .NET Akademie: Unit Testing und Test Driven Development (TDD) mit .NET/C# (3-Tages-Agenda des öffentlichen Seminars)
 Neuerungen in C# 7.0/7.1/7.2/7.3
 Task Parallel Library (TPL) - Parallelprogrammierung/Multi-Threading in .NET/C#
 Event Driven Design (mit .NET/C# oder Java)
 Neuerung in der CLR 2.0 und C# 2005
 Neuerungen in C# 6.0
 .NET Akademie: Blazor-Hands-On: Echte Single-Page-Web-Apps mit .NET und C# entwickeln (3-Tages-Agenda des öffentlichen Seminars)
 Neuerungen in C# 3.0 (Visual C# 2008)
 Refactoring von Programmcode in C, C++, C#, Java, Kotlin, JavaScript, TypeScript, Python, Go oder Rust
 Multithreading in .NET/C# (System.Threading)
 Anfrage für eine individuelle Schulung zum Thema Visual Basic C#  Gesamter Schulungsthemenkatalog

Bücher zu diesem Thema

  Blazor 9.0: Moderne Webanwendungen und hybride Cross-Platform-Apps mit .NET 9.0, C# 13.0 und Visual Studio 2022
  C# 13.0 Crashkurs
  Blazor 8.0: Moderne Webanwendungen und hybride Cross-Platform-Apps mit .NET 8.0, C# 12.0 und Visual Studio 2022
  C# 12.0 Crashkurs
  C# 11.0 Crashkurs
  C# 10.0 Crashkurs
  C# 9.0 Crashkurs: Die Syntax der Programmiersprache C# für die Softwareentwicklung in .NET 5.0, .NET Core und Xamarin
  ASP.NET Core Blazor 3.1/3.2: Blazor Server und Blazor Webassembly - Moderne Single-Page-Web-Applications mit .NET, C# und Visual Studio
  ASP.NET Core Blazor 3.0/3.1: Blazor Server und Blazor Webassembly - Moderne Single-Page-Web-Applications mit .NET, C# und Visual Studio
  C# 8.0 Crashkurs: Die Syntax der Programmiersprache C# für die Softwareentwicklung in .NET Framework, .NET Core und Xamarin
  C# 7.3 Crashkurs: Die Syntax der Programmiersprache C# für die Softwareentwicklung in .NET Framework, .NET Core und Xamarin
  Modern Data Access with Entity Framework Core: Database Programming Using .NET, .NET Core, UWP, and Xamarin with C#
  C# 7.2 Crashkurs: Die Syntax der Programmiersprache C# für die Softwareentwicklung in .NET Framework, .NET Core und Xamarin
  Effizienter Datenzugriff mit Entity Framework Core: Datenbankprogrammierung mit C# für .NET Framework, .NET Core und Xamarin
  Windows Store Apps entwickeln mit C# und XAML - Crashkurs
  Microsoft ASP.NET 4.0 mit C# 2010 - Entwicklerbuch
  Microsoft Viusal C# 2010
  Visual Basic 2010: Grundlagen, ADO.NET, Windows Presentation Foundation
  ASP.NET 4.0 mit Visual C# 2010
  Visual Basic 2010
  Microsoft ASP.NET 3.5 mit Visual Basic 2008 - Entwicklerbuch
 Alle unsere aktuellen Fachbücher  E-Book-Abo für ab 99 Euro im Jahr