Merge branch 'master' of http://git.dd:3000/AppStd/DigitalData.ActiveDirectory

- AuthenticationType-Eigenschaft zu SearchRoot in DirectorySearchQueryHandler hinzufügen

src/DigitalData.ActiveDirectory.API/Controllers/ActiveDirectoryController.cs

@@ -1,9 +1,7 @@
 using MediatR;
 using Microsoft.AspNetCore.Mvc;
-using System.DirectoryServices;
 namespace DigitalData.ActiveDirectory.API.Controllers;
 
-[System.Diagnostics.CodeAnalysis.SuppressMessage("Interoperability", "CA1416:Validate platform compatibility", Justification = "<Pending>")]
 [Route("api/[controller]")]
 [ApiController]
 public class ActiveDirectoryController : ControllerBase
@@ -16,5 +14,5 @@ public class ActiveDirectoryController : ControllerBase
     }
 
     [HttpGet]
-    public async Task<IEnumerable<ResultPropertyCollection>> GetAll([FromQuery] DirectorySearchQuery query) => await _mediator.Send(query);
+    public async Task<IActionResult> GetAll([FromQuery] DirectorySearchQuery query) => Ok(await _mediator.Send(query));
 }

src/DigitalData.ActiveDirectory.API/DigitalData.ActiveDirectory.API.csproj

@@ -6,8 +6,16 @@
     <ImplicitUsings>enable</ImplicitUsings>
   </PropertyGroup>
 
-  <ItemGroup>
+  <ItemGroup Condition="'$(TargetFramework)' == 'net7.0'">
-    <PackageReference Include="Swashbuckle.AspNetCore" Version="6.6.2" />
+    <PackageReference Include="Swashbuckle.AspNetCore" Version="7.3.2" />
+  </ItemGroup>
+
+  <ItemGroup Condition="'$(TargetFramework)' == 'net8.0'">
+    <PackageReference Include="Swashbuckle.AspNetCore" Version="8.1.4" />
+  </ItemGroup>
+
+  <ItemGroup Condition="'$(TargetFramework)' == 'net9.0'">
+    <PackageReference Include="Swashbuckle.AspNetCore" Version="9.0.3" />
   </ItemGroup>
 
   <ItemGroup>

src/DigitalData.ActiveDirectory.API/Program.cs

@@ -1,3 +1,4 @@
+using DigitalData.ActiveDirectory;
 using DigitalData.ActiveDirectory.API.Middleware;
 
 var builder = WebApplication.CreateBuilder(args);
@@ -9,6 +10,12 @@ builder.Services.AddControllers();
 builder.Services.AddEndpointsApiExplorer();
 builder.Services.AddSwaggerGen();
 
+builder.Services.AddActiveDirectory(options =>
+{
+    options.ConfigRootDirectoryEntry(builder.Configuration.GetSection("RootDirectoryEntry"));
+    options.LPLicenseKey = builder.Configuration["LPLicense"];
+});
+
 var app = builder.Build();
 
 app.UseMiddleware<ExceptionHandlingMiddleware>();

src/DigitalData.ActiveDirectory.API/appsettings.json

@@ -5,5 +5,11 @@
       "Microsoft.AspNetCore": "Warning"
     }
   },
-  "AllowedHosts": "*"
+  "AllowedHosts": "*",
+  "RootDirectoryEntry": {
+    "Path": "LDAP://DD-VMP01-DC01/DC=dd-gan,DC=local,DC=digitaldata,DC=works",
+    "Username": "FABRIK19-User01",
+    "Password": "9bWOr0UGuHn_7VkC"
+  },
+  "LPLicense": "eyJhbGciOiJSUzI1NiIsImtpZCI6Ikx1Y2t5UGVubnlTb2Z0d2FyZUxpY2Vuc2VLZXkvYmJiMTNhY2I1OTkwNGQ4OWI0Y2IxYzg1ZjA4OGNjZjkiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL2x1Y2t5cGVubnlzb2Z0d2FyZS5jb20iLCJhdWQiOiJMdWNreVBlbm55U29mdHdhcmUiLCJleHAiOiIxNzg0ODUxMjAwIiwiaWF0IjoiMTc1MzM2MjQ5MSIsImFjY291bnRfaWQiOiIwMTk4M2M1OWU0YjM3MjhlYmZkMzEwM2MyYTQ4NmU4NSIsImN1c3RvbWVyX2lkIjoiY3RtXzAxazB5NmV3MmQ4YTk4Mzg3aDJnbTRuOWswIiwic3ViX2lkIjoiLSIsImVkaXRpb24iOiIwIiwidHlwZSI6IjIifQ.ZqsFG7kv_-xGfxS6ACk3i0iuNiVUXX2AvPI8iAcZ6-z2170lGv__aO32tWpQccD9LCv5931lBNLWSblKS0MT3gOt-5he2TEftwiSQGFwoIBgtOHWsNRMinUrg2trceSp3IhyS3UaMwnxZDrCvx4-0O-kpOzVpizeHUAZNr5U7oSCWO34bpKdae6grtM5e3f93Z1vs7BW_iPgItd-aLvPwApbaG9VhmBTKlQ7b4Jh64y7UXJ9mKP7Qb_Oa97oEg0oY5DPHOWTZWeE1EzORgVr2qkK2DELSHuZ_EIUhODojkClPNAKtvEl_qEjpq0HZCIvGwfCCRlKlSkQqIeZdFkiXg"
 }

src/DigitalData.ActiveDirectory/ActiveDirectoryOptions.cs

@@ -1,10 +0,0 @@
-namespace DigitalData.ActiveDirectory;
-
-public class ActiveDirectoryOptions
-{
-    public string Path { get; set; } = null!;
-
-    public string Username { get; set; } = null!;
-
-    public string Password { get; set; } = null!;
-}

src/DigitalData.ActiveDirectory/DependencyInjection.cs

@@ -7,29 +7,55 @@ public static class DependencyInjection
 {
     public static IServiceCollection AddActiveDirectory(this IServiceCollection services, Action<ADConfigurationOptions>? options = null)
     {
-        var cOptions = new ADConfigurationOptions();
+        var cOptions = new ADConfigurationOptions(services);
         options?.Invoke(cOptions);
 
         services.AddMediatR(cfg =>
         {
             cfg.RegisterServicesFromAssemblies(typeof(DependencyInjection).Assembly);
-            cfg.LicenseKey = cOptions.MediatRLicenseKey;
+            cfg.LicenseKey = cOptions.LPLicenseKey;
         });
 
-        if (cOptions.Configuration is null)
+        services.AddAutoMapper(cfg =>
-            services.Configure<ActiveDirectoryOptions>(o => o = cOptions);
+        {
-        else
+#if NET8_0_OR_GREATER
-            services.Configure<ActiveDirectoryOptions>(cOptions.Configuration);
+            cfg.LicenseKey = cOptions.LPLicenseKey;
+#endif
+            cfg.AddMaps(typeof(DependencyInjection).Assembly);
+        });
+
+        if (!cOptions.IsADConfigured)
+            services.Configure<DirectoryEntryQuery>(_ => { });
 
         return services;
     }
 
-    public class ADConfigurationOptions : ActiveDirectoryOptions
+    public class ADConfigurationOptions
     {
-        internal ADConfigurationOptions() { }
+        private readonly IServiceCollection _services;
 
-        public string? MediatRLicenseKey { get; set; }
+        internal bool IsADConfigured { get; private set; } = false;
 
-        public IConfiguration? Configuration { get; set; }
+        internal ADConfigurationOptions(IServiceCollection services) => _services = services;
+
+        /// <summary>
+        /// Gets or sets the license key used to activate Lucky Penny Software libraries.
+        /// </summary>
+        /// <remarks>
+        /// For more information, visit: https://luckypennysoftware.com/
+        /// </remarks>
+        public string? LPLicenseKey { get; set; }
+
+        private void EnsureSingleMappingConfiguration(Action action)
+        {
+            if (IsADConfigured)
+                throw new InvalidOperationException("Mapping configuration has already been set.");
+            action();
+            IsADConfigured = true;
+        }
+
+        public void ConfigRootDirectoryEntry(IConfiguration config) => EnsureSingleMappingConfiguration(() => _services.Configure<DirectoryEntryQuery>(config));
+
+        public void ConfigRootDirectoryEntry(Action<DirectoryEntryQuery> options) => EnsureSingleMappingConfiguration(() => _services.Configure(options));
     }
 }

src/DigitalData.ActiveDirectory/DigitalData.ActiveDirectory.csproj

@@ -8,27 +8,37 @@
 
   <ItemGroup>
     <PackageReference Include="DigitalData.Core.Exceptions" Version="1.0.1" />
-    <PackageReference Include="Microsoft.Extensions.Configuration" Version="7.0.0" />
-    <PackageReference Include="Microsoft.Extensions.Logging" Version="8.0.0" />
-    <PackageReference Include="Microsoft.Extensions.Options.ConfigurationExtensions" Version="7.0.0" />
-    <PackageReference Include="System.DirectoryServices.AccountManagement" Version="7.0.1" />
-    <PackageReference Include="MediatR" Version="13.0.0" />
   </ItemGroup>
 
   <ItemGroup Condition="'$(TargetFramework)' == 'net7.0'">
+	<PackageReference Include="Microsoft.Extensions.Configuration" Version="7.0.0" />
+    <PackageReference Include="Microsoft.Extensions.Logging" Version="8.0.1" />
+    <PackageReference Include="Microsoft.Extensions.Options.ConfigurationExtensions" Version="7.0.0" />
+    <PackageReference Include="System.DirectoryServices.AccountManagement" Version="7.0.1" />
+    <PackageReference Include="MediatR" Version="13.0.0" />
 	<PackageReference Include="AutoMapper" Version="13.0.1" />
 	<PackageReference Include="Microsoft.Extensions.Caching.Memory" Version="7.0.0" />
 	<PackageReference Include="Microsoft.Extensions.Caching.Abstractions" Version="7.0.0" />
   </ItemGroup>
 
   <ItemGroup Condition="'$(TargetFramework)' == 'net8.0'">
-	<PackageReference Include="AutoMapper" Version="14.0.0" />
+	<PackageReference Include="Microsoft.Extensions.Configuration" Version="8.0.0" />
+    <PackageReference Include="Microsoft.Extensions.Logging" Version="8.0.1" />
+    <PackageReference Include="Microsoft.Extensions.Options.ConfigurationExtensions" Version="8.0.0" />
+    <PackageReference Include="System.DirectoryServices.AccountManagement" Version="8.0.1" />
+    <PackageReference Include="MediatR" Version="13.0.0" />
+	<PackageReference Include="AutoMapper" Version="15.0.1" />
 	<PackageReference Include="Microsoft.Extensions.Caching.Memory" Version="8.0.1" />
 	<PackageReference Include="Microsoft.Extensions.Caching.Abstractions" Version="8.0.0" />
   </ItemGroup>
 
   <ItemGroup Condition="'$(TargetFramework)' == 'net9.0'">
-	<PackageReference Include="AutoMapper" Version="14.0.0" />
+	<PackageReference Include="Microsoft.Extensions.Configuration" Version="9.0.7" />
+    <PackageReference Include="Microsoft.Extensions.Logging" Version="9.0.7" />
+    <PackageReference Include="Microsoft.Extensions.Options.ConfigurationExtensions" Version="9.0.7" />
+    <PackageReference Include="System.DirectoryServices.AccountManagement" Version="9.0.7" />
+    <PackageReference Include="MediatR" Version="13.0.0" />
+	<PackageReference Include="AutoMapper" Version="15.0.1" />
 	<PackageReference Include="Microsoft.Extensions.Caching.Memory" Version="9.0.5" />
 	<PackageReference Include="Microsoft.Extensions.Caching.Abstractions" Version="9.0.5" />
   </ItemGroup>

src/DigitalData.ActiveDirectory/DirectoryEntryQuery.cs

@@ -0,0 +1,16 @@
+using MediatR;
+using System.DirectoryServices;
+
+namespace DigitalData.ActiveDirectory;
+
+[System.Diagnostics.CodeAnalysis.SuppressMessage("Interoperability", "CA1416:Validate platform compatibility", Justification = "<Pending>")]
+public class DirectoryEntryQuery: IRequest
+{
+    public string Path { get; set; } = null!;
+
+    public string Username { get; set; } = null!;
+
+    public string Password { get; set; } = null!;
+
+    public IEnumerable<AuthenticationTypes> AuthenticationType { get; set; } = new List<AuthenticationTypes>() { AuthenticationTypes.None };
+}

src/DigitalData.ActiveDirectory/DirectorySearchQuery.cs

@@ -1,46 +1,53 @@
-using DigitalData.Core.Exceptions;
+using AutoMapper;
+using DigitalData.Core.Exceptions;
 using MediatR;
 using Microsoft.Extensions.Options;
 using System.DirectoryServices;
 
 namespace DigitalData.ActiveDirectory;
 
-public record DirectorySearchQuery(string? Filter = null, SearchScope Scope = SearchScope.Subtree, int SizeLimit = 5000, params string[] properties) 
+public record DirectorySearchQuery(string? Filter = null, SearchScope Scope = SearchScope.Subtree, int SizeLimit = 5000, params string[] Property) 
     : IRequest<IEnumerable<ResultPropertyCollection>>
 {
-    public Action<DirectorySearcher>? Options { get; set; }
+    public DirectoryEntryQuery? SearchRoot { get; set; }
+
+    public Action<DirectorySearcher>? AfterInit { get; set; }
 }
 
 [System.Diagnostics.CodeAnalysis.SuppressMessage("Interoperability", "CA1416:Validate platform compatibility", Justification = "<Pending>")]
-public class DirectorySearchQueryHandler(IOptions<ActiveDirectoryOptions> options) : IRequestHandler<DirectorySearchQuery, IEnumerable<ResultPropertyCollection>>
+public class DirectorySearchQueryHandler : IRequestHandler<DirectorySearchQuery, IEnumerable<ResultPropertyCollection>>
 {
-    
+    private readonly IOptions<DirectoryEntryQuery> _options;
-    public DirectoryEntry DirectoryEntry => new ()
-    {
-        Path = options.Value.Path,
-        Username = options.Value.Username,
-        Password = options.Value.Password
-    };
 
+    private readonly IMapper _mapper;
+
+    public DirectorySearchQueryHandler(IOptions<DirectoryEntryQuery> options, IMapper mapper)
+    {
+        _options = options;
+        _mapper = mapper;
+    }
+
+    //TODO: add resolver to handle SearchRoot and AfterInit mapping
     public Task<IEnumerable<ResultPropertyCollection>> Handle(DirectorySearchQuery request, CancellationToken cancellationToken = default)
     {
         return Task.Run(() =>
         {
-            using var _dirEntry = DirectoryEntry;
+            using var searcher = _mapper.Map<DirectorySearcher>(request);
-            using var searcher = new DirectorySearcher()
+
+            searcher.SearchRoot ??= new()
             {
-                Filter = request.Filter,
+                Path = _options.Value.Path,
-                SearchScope = request.Scope,
+                Username = _options.Value.Username,
-                SizeLimit = request.SizeLimit,
+                Password = _options.Value.Password,
-                SearchRoot = _dirEntry
+                AuthenticationType = _options.Value.AuthenticationType.Aggregate((a, b) => a | b)
             };
 
-            request.Options?.Invoke(searcher);
+            request.AfterInit?.Invoke(searcher);
 
-            if (request.properties.Length > 0)
+            if (request.Property.Length > 0)
                 searcher.PropertiesToLoad.Clear();
 
-            searcher.PropertiesToLoad.AddRange(request.properties.Where(p => p is not null).ToArray());
+            searcher.PropertiesToLoad.AddRange(request.Property.Where(p => p is not null).ToArray());
             var res = searcher.FindAll().Cast<SearchResult>().Select(r => r.Properties);
             return res.Any() ? res : throw new NotFoundException();
         });

src/DigitalData.ActiveDirectory/MappingProfile.cs

@@ -0,0 +1,14 @@
+using AutoMapper;
+using System.DirectoryServices;
+
+namespace DigitalData.ActiveDirectory;
+
+public class MappingProfile : Profile
+{
+    [System.Diagnostics.CodeAnalysis.SuppressMessage("Interoperability", "CA1416:Validate platform compatibility", Justification = "<Pending>")]
+    public MappingProfile()
+    {
+        CreateMap<DirectorySearchQuery, DirectorySearcher>();
+        CreateMap<DirectoryEntry, DirectoryEntry>();
+    }
+}

src/DigitalData.ActiveDirectory/README.md

@@ -0,0 +1,55 @@
+# DirectorySearchQuery
+
+**`DirectorySearchQuery`** ist ein Abfrageobjekt, das zum Durchführen von Suchvorgängen in Active Directory (AD) verwendet wird. Dieses Objekt ist mit der integrierten **`DirectorySearcher`**-Klasse von .NET verknüpft (gemappt) und stellt die erforderlichen Parameter zum Konfigurieren der Suche bereit. Die folgenden Funktionen können hinzugefügt werden. Weitere Informationen finden Sie im entsprechenden [Microsoft-Artikel](https://learn.microsoft.com/de-de/dotnet/api/system.directoryservices.directorysearcher?view=net-8.0).
+
+## Eigenschaften
+
+Die folgenden Eigenschaften werden verwendet, um Ihre AD-Abfrage anzupassen:
+
+* **`Filter`** (`string`): Dies ist die LDAP-Filterzeichenfolge, die für die Suche verwendet wird. Beispielsweise sucht `(objectClass=user)` nach allen Benutzerobjekten, während `(&(objectClass=user)(cn=Test*))` nach Benutzern sucht, deren Name mit „Test” beginnt. Weitere Informationen zur Verwendung von Filtern finden Sie in der [LDAP-Filtersyntaxdokumentation von Microsoft](https://learn.microsoft.com/en-us/windows/win32/adsi/search-filter-syntax).
+* **`Scope`** (`SearchScope`): Gibt an, auf welcher Ebene die Suche durchgeführt werden soll. Es gibt drei verschiedene Werte:
+    * **`0. Base`**: Sucht nur nach dem Startobjekt der Suche.
+    * **`1. OneLevel`**: Sucht nur nach Objekten, die sich direkt unter dem Startobjekt befinden.
+    * **`2. Subtree`** (Standard): Durchsucht den gesamten Unterbaum einschließlich des Startobjekts.
+* **`SizeLimit`** (`int`): Gibt die maximale Anzahl von Objekten an, die als Ergebnis einer Suche zurückgegeben werden sollen. Der Standardwert ist 5000. Dieser Wert ist wichtig für die Leistungsoptimierung bei der Arbeit mit großen Datensätzen.
+* **`Property`** (`string[]`): Eine Liste der Attribute, die in den Suchergebnissen zurückgegeben werden sollen. Beispielsweise gibt `[ "cn", "sAMAccountName", "mail" ]` nur die angegebenen Attribute zurück. Durch die Auswahl nur der benötigten Attribute werden der Netzwerkverkehr und der Speicherverbrauch reduziert und die Leistung verbessert.
+
+* **`SearchRoot`** (`DirectoryEntryQuery`): Gibt den Active Directory-Pfad an, an dem die Suche beginnen soll. Dies entspricht der Eigenschaft **`SearchRoot`** des Objekts **`DirectorySearcher`**. Optional können Benutzername und Passwort als spezielle Anmeldedaten angegeben werden. In DirectorySearchQuery können die folgenden drei Eigenschaften hinzugefügt werden. Weitere Informationen finden Sie im entsprechenden [Microsoft-Artikel](https://learn.microsoft.com/de-de/dotnet/api/system.directoryservices.directoryentry?view=windowsdesktop-9.0).
+    * **`Path`**: Ruft den Pfad für diesen DirectoryEntry ab oder legt diesen fest.
+    * **`Username`**: Ruft den für die Clientauthentifizierung zu verwendenden Benutzernamen ab oder legt diesen fest.
+    * **`Password`**: Legt das Kennwort fest, mit dem der Client authentifiziert werden soll.
+    * **`AuthenticationType`**: Diese Enumeration wird verwendet, um das Authentifizierungsverhalten beim Zugriff auf Active Directory über LDAP zu steuern. Mehrere Werte können mit OR kombiniert werden. Weitere Informationen finden Sie im entsprechenden [Microsoft-Artikel](https://learn.microsoft.com/de-de/dotnet/api/system.directoryservices.authenticationtypes?view=windowsdesktop-9.0).
+    
+# AuthenticationTypes (System.DirectoryServices)
+
+| Wert | Name                  | Beschreibung |
+|------|-----------------------|--------------|
+| `0`  | **None**              | Standardverhalten. Es wird keine spezielle Authentifizierung verwendet. |
+| `1`  | **Secure**            | Führt eine sichere Authentifizierung mit NTLM oder Kerberos durch. Anmeldeinformationen werden verschlüsselt übertragen. |
+| `2`  | **Encryption**        | Veraltet. Siehe `SecureSocketsLayer`. Hat denselben Wert. |
+| `2`  | **SecureSocketsLayer**| Verwendet SSL (LDAPS) über Port 636 für eine verschlüsselte Verbindung. |
+| `4`  | **ReadonlyServer**    | Gibt an, dass eine Verbindung zu einem schreibgeschützten Server (z. B. Global Catalog) hergestellt wird. |
+| `16` | **Anonymous**         | Anonyme Verbindung ohne Anmeldeinformationen. Aus Sicherheitsgründen oft deaktiviert. |
+| `32` | **FastBind**          | Überspringt die Sicherheitsüberprüfung beim Binden. Verbessert die Performance, schränkt aber die Funktionalität ein. |
+| `64` | **Signing**           | Erzwingt die digitale Signierung der Authentifizierungsdaten. |
+| `128`| **Sealing**           | Verschlüsselt die gesamte Kommunikation mit dem Server. Bietet Vertraulichkeit. |
+| `256`| **Delegation**        | Ermöglicht die Weitergabe von Anmeldeinformationen an andere Server (z. B. bei Impersonation-Szenarien). |
+| `512`| **ServerBind**        | Erzwingt eine Authentifizierung durch den Server beim Binden. Wird selten verwendet. |
+
+## Anwendungsbeispiel
+
+Das folgende Beispiel zeigt, wie ein `DirectorySearchQuery`-Objekt erstellt:
+
+```json
+{
+    "filter": "(&(objectClass=user)(sAMAccountName=john.doe))",
+    "scope": 2,
+    "sizeLimit": 500,
+    "property": [ "cn", "mail", "description" ],
+    "searchRoot": {
+        "path": "LDAP://OU=Users,DC=example,DC=com",
+        "username": "MustermannM",
+        "password": "Must3rM@nn!"
+    }
+}
+```