diff --git a/IdentityServer/v7/Apire.ServiceDefaults/Aspire.ServiceDefaults.csproj b/IdentityServer/v7/Aspire.ServiceDefaults/Aspire.ServiceDefaults.csproj similarity index 100% rename from IdentityServer/v7/Apire.ServiceDefaults/Aspire.ServiceDefaults.csproj rename to IdentityServer/v7/Aspire.ServiceDefaults/Aspire.ServiceDefaults.csproj diff --git a/IdentityServer/v7/Apire.ServiceDefaults/Extensions.cs b/IdentityServer/v7/Aspire.ServiceDefaults/Extensions.cs similarity index 100% rename from IdentityServer/v7/Apire.ServiceDefaults/Extensions.cs rename to IdentityServer/v7/Aspire.ServiceDefaults/Extensions.cs diff --git a/IdentityServer/v7/SessionManagement/Api/Api.csproj b/IdentityServer/v7/SessionManagement/Api/Api.csproj index de042781..3fc96860 100644 --- a/IdentityServer/v7/SessionManagement/Api/Api.csproj +++ b/IdentityServer/v7/SessionManagement/Api/Api.csproj @@ -11,8 +11,7 @@ - - + diff --git a/IdentityServer/v7/SessionManagement/Client/Client.csproj b/IdentityServer/v7/SessionManagement/Client/Client.csproj index 998b4207..44bedd1d 100644 --- a/IdentityServer/v7/SessionManagement/Client/Client.csproj +++ b/IdentityServer/v7/SessionManagement/Client/Client.csproj @@ -14,8 +14,7 @@ - - + diff --git a/IdentityServer/v7/SessionManagement/IdentityServerHost/IdentityServerHost.csproj b/IdentityServer/v7/SessionManagement/IdentityServerHost/IdentityServerHost.csproj index 8f912068..0eeb00dd 100644 --- a/IdentityServer/v7/SessionManagement/IdentityServerHost/IdentityServerHost.csproj +++ b/IdentityServer/v7/SessionManagement/IdentityServerHost/IdentityServerHost.csproj @@ -10,8 +10,7 @@ - - + diff --git a/IdentityServer/v7/SessionManagement/SessionManagement.sln b/IdentityServer/v7/SessionManagement/SessionManagement.sln index f90191ce..d7a27340 100644 --- a/IdentityServer/v7/SessionManagement/SessionManagement.sln +++ b/IdentityServer/v7/SessionManagement/SessionManagement.sln @@ -11,7 +11,7 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "IdentityServerHost", "Ident EndProject Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "SessionManagement.AppHost", "SessionManagement.AppHost\SessionManagement.AppHost.csproj", "{BD383672-7EF5-4737-91A9-92918CF2BBA7}" EndProject -Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Aspire.ServiceDefaults", "..\Apire.ServiceDefaults\Aspire.ServiceDefaults.csproj", "{A614B4B7-AB24-421D-808F-C35D4139F8E6}" +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Aspire.ServiceDefaults", "..\Aspire.ServiceDefaults\Aspire.ServiceDefaults.csproj", "{BE3015AC-8269-4D94-AB27-E835CBFC3AFC}" EndProject Global GlobalSection(SolutionConfigurationPlatforms) = preSolution @@ -35,10 +35,10 @@ Global {BD383672-7EF5-4737-91A9-92918CF2BBA7}.Debug|Any CPU.Build.0 = Debug|Any CPU {BD383672-7EF5-4737-91A9-92918CF2BBA7}.Release|Any CPU.ActiveCfg = Release|Any CPU {BD383672-7EF5-4737-91A9-92918CF2BBA7}.Release|Any CPU.Build.0 = Release|Any CPU - {A614B4B7-AB24-421D-808F-C35D4139F8E6}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {A614B4B7-AB24-421D-808F-C35D4139F8E6}.Debug|Any CPU.Build.0 = Debug|Any CPU - {A614B4B7-AB24-421D-808F-C35D4139F8E6}.Release|Any CPU.ActiveCfg = Release|Any CPU - {A614B4B7-AB24-421D-808F-C35D4139F8E6}.Release|Any CPU.Build.0 = Release|Any CPU + {BE3015AC-8269-4D94-AB27-E835CBFC3AFC}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {BE3015AC-8269-4D94-AB27-E835CBFC3AFC}.Debug|Any CPU.Build.0 = Debug|Any CPU + {BE3015AC-8269-4D94-AB27-E835CBFC3AFC}.Release|Any CPU.ActiveCfg = Release|Any CPU + {BE3015AC-8269-4D94-AB27-E835CBFC3AFC}.Release|Any CPU.Build.0 = Release|Any CPU EndGlobalSection GlobalSection(SolutionProperties) = preSolution HideSolutionNode = FALSE diff --git a/IdentityServer/v8/Aspire.ServiceDefaults/Aspire.ServiceDefaults.csproj b/IdentityServer/v8/Aspire.ServiceDefaults/Aspire.ServiceDefaults.csproj new file mode 100644 index 00000000..938db207 --- /dev/null +++ b/IdentityServer/v8/Aspire.ServiceDefaults/Aspire.ServiceDefaults.csproj @@ -0,0 +1,22 @@ + + + + net10.0 + enable + enable + true + + + + + + + + + + + + + + + diff --git a/IdentityServer/v8/Aspire.ServiceDefaults/Extensions.cs b/IdentityServer/v8/Aspire.ServiceDefaults/Extensions.cs new file mode 100644 index 00000000..d589a076 --- /dev/null +++ b/IdentityServer/v8/Aspire.ServiceDefaults/Extensions.cs @@ -0,0 +1,129 @@ +using Microsoft.AspNetCore.Builder; +using Microsoft.AspNetCore.Diagnostics.HealthChecks; +using Microsoft.Extensions.DependencyInjection; +using Microsoft.Extensions.Diagnostics.HealthChecks; +using Microsoft.Extensions.Logging; +using Microsoft.Extensions.ServiceDiscovery; +using OpenTelemetry; +using OpenTelemetry.Metrics; +using OpenTelemetry.Trace; + +namespace Microsoft.Extensions.Hosting; + +// Adds common Aspire services: service discovery, resilience, health checks, and OpenTelemetry. +// This project should be referenced by each service project in your solution. +// To learn more about using this project, see https://aka.ms/dotnet/aspire/service-defaults +public static class Extensions +{ + private const string HealthEndpointPath = "/health"; + private const string AlivenessEndpointPath = "/alive"; + + public static TBuilder AddServiceDefaults(this TBuilder builder) where TBuilder : IHostApplicationBuilder + { + builder.ConfigureOpenTelemetry(); + + builder.AddDefaultHealthChecks(); + + builder.Services.AddServiceDiscovery(); + + builder.Services.ConfigureHttpClientDefaults(http => + { + // Turn on resilience by default + http.AddStandardResilienceHandler(); + + // Turn on service discovery by default + http.AddServiceDiscovery(); + }); + + // Uncomment the following to restrict the allowed schemes for service discovery. + // builder.Services.Configure(options => + // { + // options.AllowedSchemes = ["https"]; + // }); + + return builder; + } + + public static TBuilder ConfigureOpenTelemetry(this TBuilder builder) where TBuilder : IHostApplicationBuilder + { + builder.Logging.AddOpenTelemetry(logging => + { + logging.IncludeFormattedMessage = true; + logging.IncludeScopes = true; + }); + + builder.Services.AddOpenTelemetry() + .WithMetrics(metrics => + { + metrics.AddAspNetCoreInstrumentation() + .AddHttpClientInstrumentation() + .AddRuntimeInstrumentation() + .AddMeter("Duende.IdentityServer", "Duende.IdentityServer.Expirimental", "IdentityServer"); + }) + .WithTracing(tracing => + { + tracing.AddSource(builder.Environment.ApplicationName) + .AddAspNetCoreInstrumentation(tracing => + // Exclude health check requests from tracing + tracing.Filter = context => + !context.Request.Path.StartsWithSegments(HealthEndpointPath) + && !context.Request.Path.StartsWithSegments(AlivenessEndpointPath) + ) + // Uncomment the following line to enable gRPC instrumentation (requires the OpenTelemetry.Instrumentation.GrpcNetClient package) + //.AddGrpcClientInstrumentation() + .AddHttpClientInstrumentation() + .AddSource("Duende.IdentityServer"); + }); + + builder.AddOpenTelemetryExporters(); + + return builder; + } + + private static TBuilder AddOpenTelemetryExporters(this TBuilder builder) where TBuilder : IHostApplicationBuilder + { + var useOtlpExporter = !string.IsNullOrWhiteSpace(builder.Configuration["OTEL_EXPORTER_OTLP_ENDPOINT"]); + + if (useOtlpExporter) + { + builder.Services.AddOpenTelemetry().UseOtlpExporter(); + } + + // Uncomment the following lines to enable the Azure Monitor exporter (requires the Azure.Monitor.OpenTelemetry.AspNetCore package) + //if (!string.IsNullOrEmpty(builder.Configuration["APPLICATIONINSIGHTS_CONNECTION_STRING"])) + //{ + // builder.Services.AddOpenTelemetry() + // .UseAzureMonitor(); + //} + + return builder; + } + + public static TBuilder AddDefaultHealthChecks(this TBuilder builder) where TBuilder : IHostApplicationBuilder + { + builder.Services.AddHealthChecks() + // Add a default liveness check to ensure app is responsive + .AddCheck("self", () => HealthCheckResult.Healthy(), ["live"]); + + return builder; + } + + public static WebApplication MapDefaultEndpoints(this WebApplication app) + { + // Adding health checks endpoints to applications in non-development environments has security implications. + // See https://aka.ms/dotnet/aspire/healthchecks for details before enabling these endpoints in non-development environments. + if (app.Environment.IsDevelopment()) + { + // All health checks must pass for app to be considered ready to accept traffic after starting + app.MapHealthChecks(HealthEndpointPath); + + // Only health checks tagged with the "live" tag must pass for app to be considered alive + app.MapHealthChecks(AlivenessEndpointPath, new HealthCheckOptions + { + Predicate = r => r.Tags.Contains("live") + }); + } + + return app; + } +} diff --git a/IdentityServer/v8/SessionManagement/Api/Api.csproj b/IdentityServer/v8/SessionManagement/Api/Api.csproj index a22d1a46..e3a5f240 100644 --- a/IdentityServer/v8/SessionManagement/Api/Api.csproj +++ b/IdentityServer/v8/SessionManagement/Api/Api.csproj @@ -10,4 +10,8 @@ + + + + diff --git a/IdentityServer/v8/SessionManagement/Api/Program.cs b/IdentityServer/v8/SessionManagement/Api/Program.cs index 56206ed4..48d673fe 100644 --- a/IdentityServer/v8/SessionManagement/Api/Program.cs +++ b/IdentityServer/v8/SessionManagement/Api/Program.cs @@ -13,6 +13,8 @@ .CreateLogger(); var builder = WebApplication.CreateBuilder(args); + +builder.AddServiceDefaults(); builder.Services.AddSerilog(); builder.Services.AddControllers(); @@ -30,6 +32,8 @@ var app = builder.Build(); +app.MapDefaultEndpoints(); + app.UseRouting(); app.UseAuthentication(); app.UseAuthorization(); diff --git a/IdentityServer/v8/SessionManagement/Client/Client.csproj b/IdentityServer/v8/SessionManagement/Client/Client.csproj index 9f5e118a..bcb75e97 100644 --- a/IdentityServer/v8/SessionManagement/Client/Client.csproj +++ b/IdentityServer/v8/SessionManagement/Client/Client.csproj @@ -12,4 +12,9 @@ + + + + + diff --git a/IdentityServer/v8/SessionManagement/Client/Program.cs b/IdentityServer/v8/SessionManagement/Client/Program.cs index b387007c..0517c526 100644 --- a/IdentityServer/v8/SessionManagement/Client/Program.cs +++ b/IdentityServer/v8/SessionManagement/Client/Program.cs @@ -10,6 +10,8 @@ var builder = WebApplication.CreateBuilder(args); +builder.AddServiceDefaults(); + builder.Services.AddControllersWithViews(); builder.Services.AddHttpClient(); @@ -62,6 +64,8 @@ var app = builder.Build(); +app.MapDefaultEndpoints(); + app.UseDeveloperExceptionPage(); app.UseStaticFiles(); diff --git a/IdentityServer/v8/SessionManagement/IdentityServerHost/IdentityServerHost.csproj b/IdentityServer/v8/SessionManagement/IdentityServerHost/IdentityServerHost.csproj index 78c9c033..4e3200fe 100644 --- a/IdentityServer/v8/SessionManagement/IdentityServerHost/IdentityServerHost.csproj +++ b/IdentityServer/v8/SessionManagement/IdentityServerHost/IdentityServerHost.csproj @@ -7,7 +7,10 @@ - + + + + diff --git a/IdentityServer/v8/SessionManagement/IdentityServerHost/Program.cs b/IdentityServer/v8/SessionManagement/IdentityServerHost/Program.cs index 2817a560..39251492 100644 --- a/IdentityServer/v8/SessionManagement/IdentityServerHost/Program.cs +++ b/IdentityServer/v8/SessionManagement/IdentityServerHost/Program.cs @@ -5,29 +5,17 @@ using Duende.IdentityServer; using IdentityServerHost; using Microsoft.AspNetCore.DataProtection; -using Serilog; -using Serilog.Sinks.SystemConsole.Themes; Console.Title = "IdentityServer"; -Log.Logger = new LoggerConfiguration() - .MinimumLevel.Information() - .Enrich.FromLogContext() - .WriteTo.Console(outputTemplate: "[{Timestamp:HH:mm:ss} {Level}] {SourceContext}{NewLine}{Message:lj}{NewLine}{Exception}{NewLine}", theme: AnsiConsoleTheme.Code) - .CreateLogger(); - var builder = WebApplication.CreateBuilder(args); -builder.Services.AddSerilog(); + +builder.AddServiceDefaults(); builder.Services.AddRazorPages(); var idsvrBuilder = builder.Services.AddIdentityServer(options => { - options.Events.RaiseErrorEvents = true; - options.Events.RaiseInformationEvents = true; - options.Events.RaiseFailureEvents = true; - options.Events.RaiseSuccessEvents = true; - // see https://docs.duendesoftware.com/identityserver/fundamentals/resources/ options.EmitStaticAudienceClaim = true; @@ -68,6 +56,8 @@ var app = builder.Build(); +app.MapDefaultEndpoints(); + if (app.Environment.IsDevelopment()) { app.UseDeveloperExceptionPage(); diff --git a/IdentityServer/v8/SessionManagement/README.md b/IdentityServer/v8/SessionManagement/README.md index 5e4f980e..0cd252be 100644 --- a/IdentityServer/v8/SessionManagement/README.md +++ b/IdentityServer/v8/SessionManagement/README.md @@ -1,12 +1,11 @@ -# Session Management Sample - -This sample requires all three projects to be run at once. - -Things of note: -* In the *IdentityServer* project in *Startup.cs*, server-side sessions are enabled with a call to *AddServerSideSessions*. This only uses in-memory server-side sessions by default, so restarting the host will lose session data. -* Also in *Startup.cs* with the call to *AddIdentityServer* various settings are configured on the *ServerSideSessions* options object to control the behavior. -* The client application configured in *Clients.cs* has *CoordinateLifetimeWithUserSession* enabled, which causes its refresh token to slide the server-side session for the user. -* When launching the *IdentityServer* project, you should visit the *~/serversidesessions* page to see the active sessions. Note that there is no authorization on this page (so consider adding it based on your requirements). -* Once you login, you should see a user's session in the list. -* As the client app refreshes its access token, you should see the user's session expiration being extended. -* When you revoke the user's session, the user should be logged out of the client app. \ No newline at end of file +**Session Management Sample** +This sample requires all three projects to be run at once. That can easily be done by running the included Aspire AppHost. The Aspire dashboard will show the status of all running applications and show you the links to the running applications. Aspire will also collect the Open Telemetry data (logs, metrics, traces) and make it available on the dashboard. + Please note that Aspire’s service discovery isn’t used here so that projects can still run without Aspire, but it can easily be [added](https://aspire.dev/fundamentals/service-discovery/ "https://aspire.dev/fundamentals/service-discovery/") if needed. +Things of note: +- In the *IdentityServer* project in *Startup.cs*, server-side sessions are enabled with a call to *AddServerSideSessions*. This only uses in-memory server-side sessions by default, so restarting the host will lose session data. +- Also in *Startup.cs* with the call to *AddIdentityServer* various settings are configured on the *ServerSideSessions* options object to control the behavior. +- The client application configured in *Clients.cs* has *CoordinateLifetimeWithUserSession* enabled, which causes its refresh token to slide the server-side session for the user. +- When launching the *IdentityServer* project, you should visit the *~/serversidesessions* page to see the active sessions. Note that there is no authorization on this page (so consider adding it based on your requirements). +- Once you login, you should see a user's session in the list. +- As the client app refreshes its access token, you should see the user's session expiration being extended. +- When you revoke the user's session, the user should be logged out of the client app. diff --git a/IdentityServer/v8/SessionManagement/SessionManagement.AppHost/AppHost.cs b/IdentityServer/v8/SessionManagement/SessionManagement.AppHost/AppHost.cs new file mode 100644 index 00000000..15201f92 --- /dev/null +++ b/IdentityServer/v8/SessionManagement/SessionManagement.AppHost/AppHost.cs @@ -0,0 +1,9 @@ +var builder = DistributedApplication.CreateBuilder(args); + +builder.AddProject("api"); + +builder.AddProject("client"); + +builder.AddProject("identityserverhost"); + +builder.Build().Run(); diff --git a/IdentityServer/v8/SessionManagement/SessionManagement.AppHost/Properties/launchSettings.json b/IdentityServer/v8/SessionManagement/SessionManagement.AppHost/Properties/launchSettings.json new file mode 100644 index 00000000..efcefdeb --- /dev/null +++ b/IdentityServer/v8/SessionManagement/SessionManagement.AppHost/Properties/launchSettings.json @@ -0,0 +1,31 @@ +{ + "$schema": "https://json.schemastore.org/launchsettings.json", + "profiles": { + "https": { + "commandName": "Project", + "dotnetRunMessages": true, + "launchBrowser": true, + "applicationUrl": "https://localhost:17003;http://localhost:15062", + "environmentVariables": { + "ASPNETCORE_ENVIRONMENT": "Development", + "DOTNET_ENVIRONMENT": "Development", + "ASPIRE_DASHBOARD_OTLP_ENDPOINT_URL": "https://localhost:21168", + "ASPIRE_DASHBOARD_MCP_ENDPOINT_URL": "https://localhost:23095", + "ASPIRE_RESOURCE_SERVICE_ENDPOINT_URL": "https://localhost:22227" + } + }, + "http": { + "commandName": "Project", + "dotnetRunMessages": true, + "launchBrowser": true, + "applicationUrl": "http://localhost:15062", + "environmentVariables": { + "ASPNETCORE_ENVIRONMENT": "Development", + "DOTNET_ENVIRONMENT": "Development", + "ASPIRE_DASHBOARD_OTLP_ENDPOINT_URL": "http://localhost:19169", + "ASPIRE_DASHBOARD_MCP_ENDPOINT_URL": "http://localhost:18285", + "ASPIRE_RESOURCE_SERVICE_ENDPOINT_URL": "http://localhost:20101" + } + } + } +} diff --git a/IdentityServer/v8/SessionManagement/SessionManagement.AppHost/SessionManagement.AppHost.csproj b/IdentityServer/v8/SessionManagement/SessionManagement.AppHost/SessionManagement.AppHost.csproj new file mode 100644 index 00000000..8597a3ed --- /dev/null +++ b/IdentityServer/v8/SessionManagement/SessionManagement.AppHost/SessionManagement.AppHost.csproj @@ -0,0 +1,17 @@ + + + + Exe + net10.0 + enable + enable + 1a0b33b6-a03f-480a-8b74-ac0b85c0cd37 + + + + + + + + + diff --git a/IdentityServer/v8/SessionManagement/SessionManagement.AppHost/appsettings.Development.json b/IdentityServer/v8/SessionManagement/SessionManagement.AppHost/appsettings.Development.json new file mode 100644 index 00000000..0c208ae9 --- /dev/null +++ b/IdentityServer/v8/SessionManagement/SessionManagement.AppHost/appsettings.Development.json @@ -0,0 +1,8 @@ +{ + "Logging": { + "LogLevel": { + "Default": "Information", + "Microsoft.AspNetCore": "Warning" + } + } +} diff --git a/IdentityServer/v8/SessionManagement/SessionManagement.AppHost/appsettings.json b/IdentityServer/v8/SessionManagement/SessionManagement.AppHost/appsettings.json new file mode 100644 index 00000000..31c092aa --- /dev/null +++ b/IdentityServer/v8/SessionManagement/SessionManagement.AppHost/appsettings.json @@ -0,0 +1,9 @@ +{ + "Logging": { + "LogLevel": { + "Default": "Information", + "Microsoft.AspNetCore": "Warning", + "Aspire.Hosting.Dcp": "Warning" + } + } +} diff --git a/IdentityServer/v8/SessionManagement/SessionManagement.sln b/IdentityServer/v8/SessionManagement/SessionManagement.sln index 3864b630..84c246f3 100644 --- a/IdentityServer/v8/SessionManagement/SessionManagement.sln +++ b/IdentityServer/v8/SessionManagement/SessionManagement.sln @@ -9,6 +9,10 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Api", "Api\Api.csproj", "{D EndProject Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "IdentityServerHost", "IdentityServerHost\IdentityServerHost.csproj", "{2880B5FF-9B88-476B-9869-E8A76FE65CB8}" EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "SessionManagement.AppHost", "SessionManagement.AppHost\SessionManagement.AppHost.csproj", "{B209266E-8692-4EBA-95B5-315C8C3B66B6}" +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Aspire.ServiceDefaults", "..\Aspire.ServiceDefaults\Aspire.ServiceDefaults.csproj", "{9B0ECE6E-7F9A-483D-B974-D61D6A0BA88C}" +EndProject Global GlobalSection(SolutionConfigurationPlatforms) = preSolution Debug|Any CPU = Debug|Any CPU @@ -27,6 +31,14 @@ Global {2880B5FF-9B88-476B-9869-E8A76FE65CB8}.Debug|Any CPU.Build.0 = Debug|Any CPU {2880B5FF-9B88-476B-9869-E8A76FE65CB8}.Release|Any CPU.ActiveCfg = Release|Any CPU {2880B5FF-9B88-476B-9869-E8A76FE65CB8}.Release|Any CPU.Build.0 = Release|Any CPU + {B209266E-8692-4EBA-95B5-315C8C3B66B6}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {B209266E-8692-4EBA-95B5-315C8C3B66B6}.Debug|Any CPU.Build.0 = Debug|Any CPU + {B209266E-8692-4EBA-95B5-315C8C3B66B6}.Release|Any CPU.ActiveCfg = Release|Any CPU + {B209266E-8692-4EBA-95B5-315C8C3B66B6}.Release|Any CPU.Build.0 = Release|Any CPU + {9B0ECE6E-7F9A-483D-B974-D61D6A0BA88C}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {9B0ECE6E-7F9A-483D-B974-D61D6A0BA88C}.Debug|Any CPU.Build.0 = Debug|Any CPU + {9B0ECE6E-7F9A-483D-B974-D61D6A0BA88C}.Release|Any CPU.ActiveCfg = Release|Any CPU + {9B0ECE6E-7F9A-483D-B974-D61D6A0BA88C}.Release|Any CPU.Build.0 = Release|Any CPU EndGlobalSection GlobalSection(SolutionProperties) = preSolution HideSolutionNode = FALSE diff --git a/samples.slnx b/samples.slnx index 1e2a5c49..681437eb 100644 --- a/samples.slnx +++ b/samples.slnx @@ -126,6 +126,7 @@ + @@ -289,6 +290,7 @@ + @@ -327,6 +329,7 @@ + @@ -490,6 +493,7 @@ +