Merge pull request #2231 from IEvangelist/fix-2180

* Rewrite keycloak article and include sample. Fixes #2180 and fixes #2173 * Correct bookmark * Address copilot review issues * Better HTML * Getting closer * Correct styling * More code updates and additions * Add see also * Fix MD error * Fix a few more bits * Added a diagram * Add preview to the TOC * Update the image * Updated images after discussing with Halter * Consistent styling for details * Apply suggestions from code review
dotnet · Dec 11, 2024 · c4eb671 · c4eb671
2 parents cb43916 + 1fa1d73
commit c4eb671
Show file tree

Hide file tree

Showing 85 changed files with 68,655 additions and 65 deletions.
diff --git a/docs/authentication/keycloak-integration.md b/docs/authentication/keycloak-integration.md
diff --git a/docs/authentication/media/auth-flow-diagram.excalidraw b/docs/authentication/media/auth-flow-diagram.excalidraw
diff --git a/docs/authentication/media/auth-flow-diagram.png b/docs/authentication/media/auth-flow-diagram.png
diff --git a/docs/authentication/media/simple-auth-flow-diagram.png b/docs/authentication/media/simple-auth-flow-diagram.png
diff --git a/docs/authentication/snippets/AspireApp/AspireApp.ApiService/AspireApp.ApiService.csproj b/docs/authentication/snippets/AspireApp/AspireApp.ApiService/AspireApp.ApiService.csproj
@@ -0,0 +1,18 @@
+<Project Sdk="Microsoft.NET.Sdk.Web">
+
+  <PropertyGroup>
+    <TargetFramework>net9.0</TargetFramework>
+    <ImplicitUsings>enable</ImplicitUsings>
+    <Nullable>enable</Nullable>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <ProjectReference Include="..\AspireApp.ServiceDefaults\AspireApp.ServiceDefaults.csproj" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <PackageReference Include="Microsoft.AspNetCore.OpenApi" Version="9.0.0" />
+    <PackageReference Include="Aspire.Keycloak.Authentication" Version="9.0.0-preview.5.24551.3" />
+  </ItemGroup>
+
+</Project>
diff --git a/docs/authentication/snippets/AspireApp/AspireApp.ApiService/Program.cs b/docs/authentication/snippets/AspireApp/AspireApp.ApiService/Program.cs
@@ -0,0 +1,58 @@
+var builder = WebApplication.CreateBuilder(args);
+
+// Add service defaults & Aspire client integrations.
+builder.AddServiceDefaults();
+
+// Add services to the container.
+builder.Services.AddProblemDetails();
+
+// Learn more about configuring OpenAPI at https://aka.ms/aspnet/openapi
+builder.Services.AddOpenApi();
+
+builder.Services.AddAuthentication()
+                .AddKeycloakJwtBearer(
+                    serviceName: "keycloak",
+                    realm: "WeatherShop",
+                    configureOptions: options =>
+                {
+                    options.RequireHttpsMetadata = false;
+                    options.Audience = "weather.api";
+                });
+
+builder.Services.AddAuthorizationBuilder();
+
+var app = builder.Build();
+
+// Configure the HTTP request pipeline.
+app.UseExceptionHandler();
+
+if (app.Environment.IsDevelopment())
+{
+    app.MapOpenApi();
+}
+
+string[] summaries = ["Freezing", "Bracing", "Chilly", "Cool", "Mild", "Warm", "Balmy", "Hot", "Sweltering", "Scorching"];
+
+app.MapGet("/weatherforecast", () =>
+    {
+        var forecast = Enumerable.Range(1, 5).Select(index =>
+            new WeatherForecast
+            (
+                DateOnly.FromDateTime(DateTime.Now.AddDays(index)),
+                Random.Shared.Next(-20, 55),
+                summaries[Random.Shared.Next(summaries.Length)]
+            ))
+            .ToArray();
+        return forecast;
+    })
+    .WithName("GetWeatherForecast")
+    .RequireAuthorization();
+
+app.MapDefaultEndpoints();
+
+app.Run();
+
+record WeatherForecast(DateOnly Date, int TemperatureC, string? Summary)
+{
+    public int TemperatureF => 32 + (int)(TemperatureC / 0.5556);
+}
diff --git a/docs/authentication/snippets/AspireApp/AspireApp.ApiService/Properties/launchSettings.json b/docs/authentication/snippets/AspireApp/AspireApp.ApiService/Properties/launchSettings.json
@@ -0,0 +1,23 @@
+{
+  "$schema": "https://json.schemastore.org/launchsettings.json",
+  "profiles": {
+    "http": {
+      "commandName": "Project",
+      "dotnetRunMessages": true,
+      "launchBrowser": false,
+      "applicationUrl": "http://localhost:5484",
+      "environmentVariables": {
+        "ASPNETCORE_ENVIRONMENT": "Development"
+      }
+    },
+    "https": {
+      "commandName": "Project",
+      "dotnetRunMessages": true,
+      "launchBrowser": false,
+      "applicationUrl": "https://localhost:7307;http://localhost:5484",
+      "environmentVariables": {
+        "ASPNETCORE_ENVIRONMENT": "Development"
+      }
+    }
+  }
+}
diff --git a/docs/authentication/snippets/AspireApp/AspireApp.ApiService/appsettings.Development.json b/docs/authentication/snippets/AspireApp/AspireApp.ApiService/appsettings.Development.json
@@ -0,0 +1,8 @@
+{
+  "Logging": {
+    "LogLevel": {
+      "Default": "Information",
+      "Microsoft.AspNetCore": "Warning"
+    }
+  }
+}
diff --git a/docs/authentication/snippets/AspireApp/AspireApp.ApiService/appsettings.json b/docs/authentication/snippets/AspireApp/AspireApp.ApiService/appsettings.json
@@ -0,0 +1,9 @@
+{
+  "Logging": {
+    "LogLevel": {
+      "Default": "Information",
+      "Microsoft.AspNetCore": "Warning"
+    }
+  },
+  "AllowedHosts": "*"
+}
diff --git a/docs/authentication/snippets/AspireApp/AspireApp.AppHost/AspireApp.AppHost.csproj b/docs/authentication/snippets/AspireApp/AspireApp.AppHost/AspireApp.AppHost.csproj
@@ -0,0 +1,24 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <Sdk Name="Aspire.AppHost.Sdk" Version="9.0.0" />
+
+  <PropertyGroup>
+    <OutputType>Exe</OutputType>
+    <TargetFramework>net9.0</TargetFramework>
+    <ImplicitUsings>enable</ImplicitUsings>
+    <Nullable>enable</Nullable>
+    <IsAspireHost>true</IsAspireHost>
+    <UserSecretsId>10daccf5-26f1-4641-80b2-95f0357607cf</UserSecretsId>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <ProjectReference Include="..\AspireApp.ApiService\AspireApp.ApiService.csproj" />
+    <ProjectReference Include="..\AspireApp.Web\AspireApp.Web.csproj" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <PackageReference Include="Aspire.Hosting.AppHost" Version="9.0.0" />
+    <PackageReference Include="Aspire.Hosting.Keycloak" Version="9.0.0-preview.5.24551.3" />
+  </ItemGroup>
+
+</Project>
diff --git a/docs/authentication/snippets/AspireApp/AspireApp.AppHost/Program.cs b/docs/authentication/snippets/AspireApp/AspireApp.AppHost/Program.cs
@@ -0,0 +1,17 @@
+var builder = DistributedApplication.CreateBuilder(args);
+
+var keycloak = builder.AddKeycloak("keycloak", 8080)
+                      .WithDataVolume()
+                      .WithRealmImport("./Realms");
+
+var apiService = builder.AddProject<Projects.AspireApp_ApiService>("apiservice")
+                        .WithReference(keycloak)
+                        .WaitFor(keycloak);
+
+builder.AddProject<Projects.AspireApp_Web>("webfrontend")
+       .WithExternalHttpEndpoints()
+       .WithReference(keycloak)
+       .WithReference(apiService)
+       .WaitFor(apiService);
+
+builder.Build().Run();
diff --git a/docs/authentication/snippets/AspireApp/AspireApp.AppHost/Properties/launchSettings.json b/docs/authentication/snippets/AspireApp/AspireApp.AppHost/Properties/launchSettings.json
@@ -0,0 +1,29 @@
+{
+  "$schema": "https://json.schemastore.org/launchsettings.json",
+  "profiles": {
+    "https": {
+      "commandName": "Project",
+      "dotnetRunMessages": true,
+      "launchBrowser": true,
+      "applicationUrl": "https://localhost:17077;http://localhost:15022",
+      "environmentVariables": {
+        "ASPNETCORE_ENVIRONMENT": "Development",
+        "DOTNET_ENVIRONMENT": "Development",
+        "DOTNET_DASHBOARD_OTLP_ENDPOINT_URL": "https://localhost:21257",
+        "DOTNET_RESOURCE_SERVICE_ENDPOINT_URL": "https://localhost:22149"
+      }
+    },
+    "http": {
+      "commandName": "Project",
+      "dotnetRunMessages": true,
+      "launchBrowser": true,
+      "applicationUrl": "http://localhost:15022",
+      "environmentVariables": {
+        "ASPNETCORE_ENVIRONMENT": "Development",
+        "DOTNET_ENVIRONMENT": "Development",
+        "DOTNET_DASHBOARD_OTLP_ENDPOINT_URL": "http://localhost:19200",
+        "DOTNET_RESOURCE_SERVICE_ENDPOINT_URL": "http://localhost:20201"
+      }
+    }
+  }
+}