diff --git a/src/Open.IdentityServer/test/Open.IdentityServer.UnitTests/LocalTimeZoneInfoMocker.cs b/Open.IdentityServer.Test.Utilities/LocalTimeZoneInfoMocker.cs similarity index 91% rename from src/Open.IdentityServer/test/Open.IdentityServer.UnitTests/LocalTimeZoneInfoMocker.cs rename to Open.IdentityServer.Test.Utilities/LocalTimeZoneInfoMocker.cs index b881e3cb9..e2865a037 100644 --- a/src/Open.IdentityServer/test/Open.IdentityServer.UnitTests/LocalTimeZoneInfoMocker.cs +++ b/Open.IdentityServer.Test.Utilities/LocalTimeZoneInfoMocker.cs @@ -1,7 +1,6 @@ -using System; using System.Reflection; -namespace Open.IdentityServer.UnitTests; +namespace Open.IdentityServer.Test.Utilities; public class LocalTimeZoneInfoMocker: IDisposable { diff --git a/Open.IdentityServer.Test.Utilities/Open.IdentityServer.Test.Utilities.csproj b/Open.IdentityServer.Test.Utilities/Open.IdentityServer.Test.Utilities.csproj new file mode 100644 index 000000000..237d66167 --- /dev/null +++ b/Open.IdentityServer.Test.Utilities/Open.IdentityServer.Test.Utilities.csproj @@ -0,0 +1,9 @@ + + + + net10.0 + enable + enable + + + diff --git a/Open.IdentityServer.sln b/Open.IdentityServer.sln index 701242153..00c3524ee 100644 --- a/Open.IdentityServer.sln +++ b/Open.IdentityServer.sln @@ -72,6 +72,10 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "tests", "tests", "{7A351D3D EndProject Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Open.IdentityServer.Storage.UnitTests", "src\Storage\tests\Open.IdentityServer.Storage.UnitTests\Open.IdentityServer.Storage.UnitTests.csproj", "{FF1944C8-2516-4197-9B63-8BB3581882B3}" EndProject +Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "tests", "tests", "{36985CF3-7E79-4BF4-91FD-3E9195A0FCEA}" +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Open.IdentityServer.Test.Utilities", "Open.IdentityServer.Test.Utilities\Open.IdentityServer.Test.Utilities.csproj", "{F0AD47D4-F27B-4265-B1B9-B2346824CBE4}" +EndProject Global GlobalSection(SolutionConfigurationPlatforms) = preSolution Debug|Any CPU = Debug|Any CPU @@ -109,6 +113,7 @@ Global {C459AC33-FD11-402E-8058-F76DD940190D} = {78510D3C-6BE1-4017-8AD4-CC905D58D788} {7A351D3D-4AC7-4662-8BF3-8F42D6097F87} = {7C740022-8283-4021-8E72-3F2847949309} {FF1944C8-2516-4197-9B63-8BB3581882B3} = {7A351D3D-4AC7-4662-8BF3-8F42D6097F87} + {F0AD47D4-F27B-4265-B1B9-B2346824CBE4} = {36985CF3-7E79-4BF4-91FD-3E9195A0FCEA} EndGlobalSection GlobalSection(ProjectConfigurationPlatforms) = postSolution {A2D626B8-1532-4E35-B9F2-4246C838D192}.Debug|Any CPU.ActiveCfg = Debug|Any CPU @@ -183,5 +188,9 @@ Global {FF1944C8-2516-4197-9B63-8BB3581882B3}.Debug|Any CPU.Build.0 = Debug|Any CPU {FF1944C8-2516-4197-9B63-8BB3581882B3}.Release|Any CPU.ActiveCfg = Release|Any CPU {FF1944C8-2516-4197-9B63-8BB3581882B3}.Release|Any CPU.Build.0 = Release|Any CPU + {F0AD47D4-F27B-4265-B1B9-B2346824CBE4}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {F0AD47D4-F27B-4265-B1B9-B2346824CBE4}.Debug|Any CPU.Build.0 = Debug|Any CPU + {F0AD47D4-F27B-4265-B1B9-B2346824CBE4}.Release|Any CPU.ActiveCfg = Release|Any CPU + {F0AD47D4-F27B-4265-B1B9-B2346824CBE4}.Release|Any CPU.Build.0 = Release|Any CPU EndGlobalSection EndGlobal diff --git a/src/EntityFramework.Storage/src/Options/OperationalStoreOptions.cs b/src/EntityFramework.Storage/src/Options/OperationalStoreOptions.cs index dafc5c456..59bd5095b 100644 --- a/src/EntityFramework.Storage/src/Options/OperationalStoreOptions.cs +++ b/src/EntityFramework.Storage/src/Options/OperationalStoreOptions.cs @@ -25,6 +25,14 @@ public class OperationalStoreOptions: StoreOptions /// public TableConfiguration DeviceFlowCodes { get; set; } = new TableConfiguration("DeviceCodes"); + /// + /// Gets or sets the server-side sessions table configuration. + /// + /// + /// The server-side sessions' config. + /// + public TableConfiguration ServerSideSessions { get; set; } = new("ServerSideSessions"); + /// /// Gets or sets a value indicating whether stale entries will be automatically cleaned up from the database. /// This is implemented by periodically connecting to the database (according to the TokenCleanupInterval) from the hosting application. @@ -61,14 +69,6 @@ public class OperationalStoreOptions: StoreOptions /// public TableConfiguration Keys { get; set; } = new("Keys"); - /// - /// Gets or sets the server-side sessions table configuration. - /// - /// - /// The server-side sessions' config. - /// - public TableConfiguration ServerSideSessions { get; set; } = new("ServerSideSessions"); - /// /// Gets or sets the pushed authorization requests table configuration. /// diff --git a/src/EntityFramework.Storage/src/Stores/Compatibility/IdentityServerServerSideSessionStore.cs b/src/EntityFramework.Storage/src/Stores/Compatibility/IdentityServerServerSideSessionStore.cs index e962521bf..1d3aa0ab0 100644 --- a/src/EntityFramework.Storage/src/Stores/Compatibility/IdentityServerServerSideSessionStore.cs +++ b/src/EntityFramework.Storage/src/Stores/Compatibility/IdentityServerServerSideSessionStore.cs @@ -23,6 +23,7 @@ namespace Open.IdentityServer.EntityFramework.Stores; public class IdentityServerServerSideSessionStore( IPersistedGrantDbContext dbContext, ITelemetryService telemetry, + TimeProvider timeProvider, ILogger logger) : IIdentityServerServerSideSessionStore { /// @@ -138,4 +139,23 @@ public async Task> FilterSessions( .ToListAsync()) .Select(x => x.ToModel()); } + + /// + public async Task> GetAndRemoveExpiredSessions(int batchSize = 100) + { + using var trace = telemetry.Trace(TelemetryConstants.TraceCategories.Stores, this); + + var sessions = await dbContext.ServerSideSessions + // .Where(x => x.Expires < DateTime.UtcNow) + .Where(x => x.Expires < timeProvider.GetUtcNow().UtcDateTime) + .OrderBy(x => x.Expires) + .Take(batchSize) + .ToArrayAsync(); + + dbContext.ServerSideSessions.RemoveRange(sessions); + await dbContext.SaveChangesAsync(); + + return sessions.Select(x => x.ToModel()); + + } } \ No newline at end of file diff --git a/src/EntityFramework.Storage/src/TokenCleanup/TokenCleanupService.cs b/src/EntityFramework.Storage/src/TokenCleanup/TokenCleanupService.cs index dd3bdaee5..7d07e7b8f 100644 --- a/src/EntityFramework.Storage/src/TokenCleanup/TokenCleanupService.cs +++ b/src/EntityFramework.Storage/src/TokenCleanup/TokenCleanupService.cs @@ -1,7 +1,6 @@ // Copyright (c) Brock Allen & Dominick Baier. All rights reserved. // Licensed under the Apache License, Version 2.0. See LICENSE in the project root for license information. - using System; using System.Linq; using System.Threading.Tasks; @@ -13,7 +12,7 @@ namespace Open.IdentityServer.EntityFramework; /// -/// Helper to cleanup stale persisted grants and device codes. +/// Helper to clean up stale persisted grants and device codes. /// public class TokenCleanupService { @@ -94,8 +93,7 @@ protected virtual async Task RemoveGrantsAsync() } } } - - + /// /// Removes the stale device codes. /// diff --git a/src/EntityFramework.Storage/test/IntegrationTests/Open.IdentityServer.EntityFramework.IntegrationTests.csproj b/src/EntityFramework.Storage/test/IntegrationTests/Open.IdentityServer.EntityFramework.IntegrationTests.csproj index 06f928251..e28a43e9f 100644 --- a/src/EntityFramework.Storage/test/IntegrationTests/Open.IdentityServer.EntityFramework.IntegrationTests.csproj +++ b/src/EntityFramework.Storage/test/IntegrationTests/Open.IdentityServer.EntityFramework.IntegrationTests.csproj @@ -14,6 +14,7 @@ + @@ -26,6 +27,7 @@ + diff --git a/src/EntityFramework.Storage/test/IntegrationTests/Stores/Compatibility/IdentityServerServerSideSessionStoreTests.cs b/src/EntityFramework.Storage/test/IntegrationTests/Stores/Compatibility/IdentityServerServerSideSessionStoreTests.cs index 80146b937..381739c47 100644 --- a/src/EntityFramework.Storage/test/IntegrationTests/Stores/Compatibility/IdentityServerServerSideSessionStoreTests.cs +++ b/src/EntityFramework.Storage/test/IntegrationTests/Stores/Compatibility/IdentityServerServerSideSessionStoreTests.cs @@ -5,12 +5,14 @@ using AwesomeAssertions; using Microsoft.EntityFrameworkCore; using Microsoft.Extensions.Logging; +using Microsoft.Extensions.Time.Testing; using Moq; using Open.IdentityServer.EntityFramework.DbContexts; using Open.IdentityServer.EntityFramework.Entities; using Open.IdentityServer.EntityFramework.Options; using Open.IdentityServer.EntityFramework.Stores; using Open.IdentityServer.Services; +using Open.IdentityServer.Test.Utilities; using Xunit; using SessionModel = Open.IdentityServer.Models.IdentityServerServerSideSessions; @@ -19,7 +21,10 @@ namespace Open.IdentityServer.EntityFramework.IntegrationTests.Stores.Compatibil public class IdentityServerServerSideSessionStoreTests: IntegrationTest { private readonly ITelemetryService telemetry = Mock.Of(); + private readonly FakeTimeProvider timeProvider = new(); private readonly MockLogger fakeLogger = new(); + + private static readonly DateTime FakeNow = new(2025, 02, 27, 12, 00, 00, DateTimeKind.Utc); public IdentityServerServerSideSessionStoreTests(DatabaseProviderFixture fixture) : base(fixture) { @@ -28,10 +33,12 @@ public IdentityServerServerSideSessionStoreTests(DatabaseProviderFixture - new(dbContext, telemetry, fakeLogger); + new(dbContext, telemetry, timeProvider, fakeLogger); [Theory] [InlineData(null)] @@ -39,7 +46,7 @@ private IdentityServerServerSideSessionStore CreateSut(PersistedGrantDbContext d [InlineData(" ")] public async Task GetSession_WhenKeyNullOrEmpty_ShouldThrowArgumentException(string key) { - await using var context = await CreateCleanContext(TestDatabaseProviders.FirstOrDefault()); + await using PersistedGrantDbContext context = await CreateCleanContext(TestDatabaseProviders.FirstOrDefault()); IdentityServerServerSideSessionStore sut = CreateSut(context); Func act = async () => await sut.GetSession(key); @@ -50,7 +57,7 @@ public async Task GetSession_WhenKeyNullOrEmpty_ShouldThrowArgumentException(str [Theory, MemberData(nameof(TestDatabaseProviders))] public async Task GetSession_WhenDoesntExist_ShouldReturnNull(DbContextOptions options) { - await using var context = await CreateCleanContext(options); + await using PersistedGrantDbContext context = await CreateCleanContext(options); IdentityServerServerSideSessionStore sut = CreateSut(context); SessionModel result = await sut.GetSession("missing-key"); @@ -61,7 +68,7 @@ public async Task GetSession_WhenDoesntExist_ShouldReturnNull(DbContextOptions

options) { - await using var context = await CreateCleanContext(options); + await using PersistedGrantDbContext context = await CreateCleanContext(options); string key = "session-key-1"; IdentityServerServerSideSessions seeded = new IdentityServerServerSideSessions @@ -71,9 +78,9 @@ public async Task GetSession_WhenExist_ShouldReturnValue(DbContextOptions act = async () => await sut.CreateSession(newSession); @@ -115,7 +122,7 @@ public async Task CreateSession_WhenKeyNullOrEmpty_ShouldThrowArgumentException( [Theory, MemberData(nameof(TestDatabaseProviders))] public async Task CreateSession_WhenSessionAlreadyExistsWithKey_ShouldLogError(DbContextOptions options) { - await using var context = await CreateCleanContext(options); + await using PersistedGrantDbContext context = await CreateCleanContext(options); string key = "duplicate-key"; context.ServerSideSessions.Add(new IdentityServerServerSideSessions @@ -125,15 +132,15 @@ public async Task CreateSession_WhenSessionAlreadyExistsWithKey_ShouldLogError(D SubjectId = "sub-existing", SessionId = "sid-existing", DisplayName = "existing", - Created = DateTime.UtcNow.AddMinutes(-20), - Renewed = DateTime.UtcNow.AddMinutes(-10), - Expires = DateTime.UtcNow.AddMinutes(20), + Created = FakeNow.AddMinutes(-20), + Renewed = FakeNow.AddMinutes(-10), + Expires = FakeNow.AddMinutes(20), Data = "{\"state\":\"existing\"}" }); await context.SaveChangesAsync(); IdentityServerServerSideSessionStore sut = CreateSut(context); - var newSession = BuildSessionModel(key, "sub-new", "sid-new", "new"); + SessionModel newSession = BuildSessionModel(key, "sub-new", "sid-new", "new"); await sut.CreateSession(newSession); @@ -143,16 +150,16 @@ public async Task CreateSession_WhenSessionAlreadyExistsWithKey_ShouldLogError(D [Theory, MemberData(nameof(TestDatabaseProviders))] public async Task CreateSession_WhenSessionDoesntExistsWithKey_ShouldStoreSessionInDatabase(DbContextOptions options) { - await using var context = await CreateCleanContext(options); + await using PersistedGrantDbContext context = await CreateCleanContext(options); string key = "new-key"; - var session = BuildSessionModel(key, "sub-123", "sid-123", "display-123"); + SessionModel session = BuildSessionModel(key, "sub-123", "sid-123", "display-123"); IdentityServerServerSideSessionStore sut = CreateSut(context); await sut.CreateSession(session); - var stored = await context.ServerSideSessions + IdentityServerServerSideSessions stored = await context.ServerSideSessions .AsNoTracking() .SingleOrDefaultAsync(x => x.Key == key, cancellationToken: TestContext.Current.CancellationToken); @@ -174,10 +181,10 @@ public async Task CreateSession_WhenSessionDoesntExistsWithKey_ShouldStoreSessio [InlineData(" ")] public async Task UpdateSession_WhenKeyNullOrEmpty_ShouldThrowArgumentException(string key) { - await using var context = await CreateCleanContext(TestDatabaseProviders.FirstOrDefault()); + await using PersistedGrantDbContext context = await CreateCleanContext(TestDatabaseProviders.FirstOrDefault()); IdentityServerServerSideSessionStore sut = CreateSut(context); - var session = BuildSessionModel(key, "sub-new", "sid-new", "new"); + SessionModel session = BuildSessionModel(key, "sub-new", "sid-new", "new"); Func act = async () => await sut.UpdateSession(session); @@ -187,10 +194,10 @@ public async Task UpdateSession_WhenKeyNullOrEmpty_ShouldThrowArgumentException( [Theory, MemberData(nameof(TestDatabaseProviders))] public async Task UpdateSession_WhenSessionDoesntExistsWithKey_ShouldLogError(DbContextOptions options) { - await using var context = await CreateCleanContext(options); + await using PersistedGrantDbContext context = await CreateCleanContext(options); IdentityServerServerSideSessionStore sut = CreateSut(context); - var session = BuildSessionModel("missing-update-key", "sub", "sid", "display"); + SessionModel session = BuildSessionModel("missing-update-key", "sub", "sid", "display"); await sut.UpdateSession(session); @@ -200,7 +207,7 @@ public async Task UpdateSession_WhenSessionDoesntExistsWithKey_ShouldLogError(Db [Theory, MemberData(nameof(TestDatabaseProviders))] public async Task UpdateSession_WhenSessionExistsWithKey_ShouldUpdateStoredSession(DbContextOptions options) { - await using var context = await CreateCleanContext(options); + await using PersistedGrantDbContext context = await CreateCleanContext(options); string key = "update-key"; context.ServerSideSessions.Add(new IdentityServerServerSideSessions @@ -210,25 +217,25 @@ public async Task UpdateSession_WhenSessionExistsWithKey_ShouldUpdateStoredSessi SubjectId = "old-sub", SessionId = "old-sid", DisplayName = "old-display", - Created = DateTime.UtcNow.AddHours(-2), - Renewed = DateTime.UtcNow.AddHours(-1), - Expires = DateTime.UtcNow.AddMinutes(5), + Created = FakeNow.AddHours(-2), + Renewed = FakeNow.AddHours(-1), + Expires = FakeNow.AddMinutes(5), Data = "{\"version\":1}" }); await context.SaveChangesAsync(); - var updated = BuildSessionModel(key, "new-sub", "new-sid", "new-display"); + SessionModel updated = BuildSessionModel(key, "new-sub", "new-sid", "new-display"); updated.Scheme = "new-scheme"; updated.Data = "{\"version\":2}"; - updated.Created = DateTime.UtcNow.AddHours(-3); - updated.Renewed = DateTime.UtcNow.AddMinutes(-1); - updated.Expires = DateTime.UtcNow.AddHours(2); + updated.Created = FakeNow.AddHours(-3); + updated.Renewed = FakeNow.AddMinutes(-1); + updated.Expires = FakeNow.AddHours(2); IdentityServerServerSideSessionStore sut = CreateSut(context); await sut.UpdateSession(updated); - var stored = await context.ServerSideSessions + IdentityServerServerSideSessions stored = await context.ServerSideSessions .AsNoTracking() .SingleAsync(x => x.Key == key, cancellationToken: TestContext.Current.CancellationToken); @@ -249,7 +256,7 @@ public async Task UpdateSession_WhenSessionExistsWithKey_ShouldUpdateStoredSessi [InlineData(" ")] public async Task DeleteSession_WhenKeyNullOrEmpty_ShouldThrowArgumentException(string key) { - await using var context = await CreateCleanContext(TestDatabaseProviders.FirstOrDefault()); + await using PersistedGrantDbContext context = await CreateCleanContext(TestDatabaseProviders.FirstOrDefault()); IdentityServerServerSideSessionStore sut = CreateSut(context); Func act = async () => await sut.DeleteSession(key); @@ -260,7 +267,7 @@ public async Task DeleteSession_WhenKeyNullOrEmpty_ShouldThrowArgumentException( [Theory, MemberData(nameof(TestDatabaseProviders))] public async Task DeleteSession_WhenSessionDoesntExistsWithKey_ShouldLogError(DbContextOptions options) { - await using var context = await CreateCleanContext(options); + await using PersistedGrantDbContext context = await CreateCleanContext(options); IdentityServerServerSideSessionStore sut = CreateSut(context); await sut.DeleteSession("missing-delete-key"); @@ -271,7 +278,7 @@ public async Task DeleteSession_WhenSessionDoesntExistsWithKey_ShouldLogError(Db [Theory, MemberData(nameof(TestDatabaseProviders))] public async Task DeleteSession_WhenSessionExistsWithKey_ShouldDeleteStoredSession(DbContextOptions options) { - await using var context = await CreateCleanContext(options); + await using PersistedGrantDbContext context = await CreateCleanContext(options); string key = "delete-key"; context.ServerSideSessions.Add(new IdentityServerServerSideSessions @@ -281,9 +288,9 @@ public async Task DeleteSession_WhenSessionExistsWithKey_ShouldDeleteStoredSessi SubjectId = "sub-delete", SessionId = "sid-delete", DisplayName = "delete me", - Created = DateTime.UtcNow.AddMinutes(-30), - Renewed = DateTime.UtcNow.AddMinutes(-15), - Expires = DateTime.UtcNow.AddMinutes(30), + Created = FakeNow.AddMinutes(-30), + Renewed = FakeNow.AddMinutes(-15), + Expires = FakeNow.AddMinutes(30), Data = "{\"delete\":true}" }); await context.SaveChangesAsync(); @@ -292,7 +299,7 @@ public async Task DeleteSession_WhenSessionExistsWithKey_ShouldDeleteStoredSessi await sut.DeleteSession(key); - var stored = await context.ServerSideSessions + IdentityServerServerSideSessions stored = await context.ServerSideSessions .AsNoTracking() .SingleOrDefaultAsync(x => x.Key == key, cancellationToken: TestContext.Current.CancellationToken); @@ -344,6 +351,100 @@ await context.ServerSideSessions.AddRangeAsync([ actual.Should().Contain(x => x.Key == "key-1"); actual.Should().Contain(x => x.Key == "key-6"); } + + [Theory, MemberData(nameof(TestDatabaseProviders))] + public async Task GetAndRemoveExpiredSessions_WhenNoExpiredSessionsExist_ShouldRemoveNothingAndReturnEmptyCollection(DbContextOptions options) + { + await using PersistedGrantDbContext context = await CreateCleanContext(options); + + IdentityServerServerSideSessions validSession0 = FakeSessionSession("123", "session1"); + IdentityServerServerSideSessions validSession1 = FakeSessionSession("456", "session2"); + context.ServerSideSessions.Add(validSession0); + context.ServerSideSessions.Add(validSession1); + await context.SaveChangesAsync(); + + IdentityServerServerSideSessionStore sut = CreateSut(context); + + List actual = (await sut.GetAndRemoveExpiredSessions()).ToList(); + + actual.Should().BeEmpty(); + } + + [Theory, MemberData(nameof(TestDatabaseProviders))] + public async Task GetAndRemoveExpiredSessions_WhenExpiredSessionsExist_AndUnderBatchSize_ShouldDeleteExpiredSessionsAndReturnACollectionContainingRemovedSessions(DbContextOptions options) + { + await using PersistedGrantDbContext context = await CreateCleanContext(options); + + IdentityServerServerSideSessions expiredSession0 = FakeSessionSession("123", "session1", true); + IdentityServerServerSideSessions expiredSession1 = FakeSessionSession("456", "session2", true); + context.ServerSideSessions.Add(expiredSession0); + context.ServerSideSessions.Add(expiredSession1); + await context.SaveChangesAsync(); + + IdentityServerServerSideSessionStore sut = CreateSut(context); + + List actual = (await sut.GetAndRemoveExpiredSessions()).ToList(); + + actual.Should().HaveCount(2); + actual.Should().Contain(x => x.Key == expiredSession0.Key); + actual.Should().Contain(x => x.Key == expiredSession1.Key); + } + + [Theory, MemberData(nameof(TestDatabaseProviders))] + public async Task GetAndRemoveExpiredSessions_WhenExpiredSessionsExist_AndExceedBatchSize_ShouldDeleteAndReturnExpiredSessions_WithACountOfBatchSize(DbContextOptions options) + { + await using PersistedGrantDbContext context = await CreateCleanContext(options); + + IdentityServerServerSideSessions expiredSession0 = FakeSessionSession("123", "session1", true); + IdentityServerServerSideSessions expiredSession1 = FakeSessionSession("456", "session2", true); + IdentityServerServerSideSessions expiredSession2 = FakeSessionSession("789", "session3", true); + IdentityServerServerSideSessions validSession0 = FakeSessionSession("234", "session4"); + context.ServerSideSessions.Add(expiredSession0); + context.ServerSideSessions.Add(expiredSession1); + context.ServerSideSessions.Add(expiredSession2); + context.ServerSideSessions.Add(validSession0); + await context.SaveChangesAsync(); + + IdentityServerServerSideSessionStore sut = CreateSut(context); + + List actual = (await sut.GetAndRemoveExpiredSessions(2)).ToList(); + + actual.Should().HaveCount(2); + actual.Should().Contain(x => x.Key == expiredSession0.Key); + actual.Should().Contain(x => x.Key == expiredSession1.Key); + } + + //TODO: Finish implementing test + [Theory, MemberData(nameof(TestDatabaseProviders))] + public async Task GetAndRemoveExpiredSessions_WhenUnspecifiedTimezoneInDbEntities_ShouldBeTreatedAsUtc(DbContextOptions options) + { + //Ensuring timezone info is the same across environments + using var mockedTimezone = new LocalTimeZoneInfoMocker(TimeZoneInfo.FindSystemTimeZoneById("China Standard Time")); + + DateTime nowUnspecified = new(2025, 02, 27, 12, 12, 11, DateTimeKind.Unspecified); + + var testExpired = nowUnspecified.AddDays(-1); + var testWithin8HoursToExpiry = nowUnspecified.AddHours(2); + + await using PersistedGrantDbContext context = await CreateCleanContext(options); + + IdentityServerServerSideSessions expiredSession0 = FakeSessionSession("123", "session1"); + IdentityServerServerSideSessions validSession0 = FakeSessionSession("234", "session4"); + + expiredSession0.Expires = testExpired; + validSession0.Expires = testWithin8HoursToExpiry; + + context.ServerSideSessions.Add(expiredSession0); + context.ServerSideSessions.Add(validSession0); + await context.SaveChangesAsync(); + + IdentityServerServerSideSessionStore sut = CreateSut(context); + + List actual = (await sut.GetAndRemoveExpiredSessions(2)).ToList(); + + actual.Should().HaveCount(1); + actual.Should().Contain(x => x.Key == expiredSession0.Key); + } [Theory, MemberData(nameof(TestDatabaseProviders))] public async Task PublicMethods_WhenCalled_ShouldTelemetryTrace(DbContextOptions options) @@ -355,11 +456,12 @@ public async Task PublicMethods_WhenCalled_ShouldTelemetryTrace(DbContextOptions (store => store.UpdateSession(new SessionModel { Key = "FAKE_SESSION_KEY" }), "UpdateSession"), (store => store.DeleteSession("FAKE_SESSION_KEY"), "DeleteSession"), (store => store.FilterSessions("FAKE_SUBJECT_KEY", "FAKE_SESSION_KEY"), "FilterSessions"), + (store => store.GetAndRemoveExpiredSessions(), "GetAndRemoveExpiredSessions"), ]; - foreach (var method in methods) + foreach ((Func actMethod, string traceMethodName) method in methods) { - var trace = Mock.Of(); + ITrace trace = Mock.Of(); Mock.Get(telemetry).Setup(t => t.Trace(It.IsAny(), It.IsAny(), It.IsAny())) .Returns(trace); Mock.Get(trace).Setup(t => t.AddTag(It.IsAny(), It.IsAny())).Returns(trace); @@ -367,7 +469,7 @@ public async Task PublicMethods_WhenCalled_ShouldTelemetryTrace(DbContextOptions await using PersistedGrantDbContext context = new PersistedGrantDbContext(options, StoreOptions); - var store = CreateSut(context); + IdentityServerServerSideSessionStore store = CreateSut(context); await method.actMethod(store); @@ -403,10 +505,35 @@ private static SessionModel BuildSessionModel(string key, string subjectId, stri SubjectId = subjectId, SessionId = sessionId, DisplayName = displayName, - Created = DateTime.UtcNow.AddMinutes(-10), - Renewed = DateTime.UtcNow.AddMinutes(-5), - Expires = DateTime.UtcNow.AddHours(1), + Created = FakeNow.AddMinutes(-10), + Renewed = FakeNow.AddMinutes(-5), + Expires = FakeNow.AddHours(1), Data = "{\"payload\":\"value\"}" }; } + + private static IdentityServerServerSideSessions FakeSessionSession(string subject, string sessionId, bool expired = false) + { + IdentityServerServerSideSessions session = new IdentityServerServerSideSessions + { + Key = Guid.NewGuid().ToString(), + Scheme = Guid.NewGuid().ToString(), + SubjectId = subject, + SessionId = sessionId, + DisplayName = "user" + subject, + Created = FakeNow.AddDays(-3), + Renewed = FakeNow.AddDays(-3), + Expires = FakeNow.AddDays(2), + Data = "{!}" + }; + + if (expired) + { + session.Created = FakeNow.AddDays(-5); + session.Renewed = FakeNow.AddDays(-4); + session.Expires = FakeNow.AddDays(-3); + } + + return session; + } } \ No newline at end of file diff --git a/src/EntityFramework.Storage/test/IntegrationTests/TokenCleanup/TokenCleanupTests.cs b/src/EntityFramework.Storage/test/IntegrationTests/TokenCleanup/TokenCleanupTests.cs index 76e74f943..2f813f172 100644 --- a/src/EntityFramework.Storage/test/IntegrationTests/TokenCleanup/TokenCleanupTests.cs +++ b/src/EntityFramework.Storage/test/IntegrationTests/TokenCleanup/TokenCleanupTests.cs @@ -13,7 +13,6 @@ using Open.IdentityServer.EntityFramework.Options; using Open.IdentityServer.EntityFramework.Stores; using Open.IdentityServer.Stores; -using Open.IdentityServer.Test; using Microsoft.EntityFrameworkCore; using Microsoft.Extensions.DependencyInjection; using Xunit; @@ -44,15 +43,15 @@ public async Task RemoveExpiredGrantsAsync_WhenExpiredGrantsExist_ExpectExpiredG Data = "{!}" }; - using (var context = new PersistedGrantDbContext(options, StoreOptions)) + await using (var context = new PersistedGrantDbContext(options, StoreOptions)) { context.PersistedGrants.Add(expiredGrant); - context.SaveChanges(); + await context.SaveChangesAsync(); } await CreateSut(options).RemoveExpiredGrantsAsync(); - using (var context = new PersistedGrantDbContext(options, StoreOptions)) + await using (var context = new PersistedGrantDbContext(options, StoreOptions)) { context.PersistedGrants.FirstOrDefault(x => x.Key == expiredGrant.Key).Should().BeNull(); } @@ -71,15 +70,15 @@ public async Task RemoveExpiredGrantsAsync_WhenValidGrantsExist_ExpectValidGrant Data = "{!}" }; - using (var context = new PersistedGrantDbContext(options, StoreOptions)) + await using (var context = new PersistedGrantDbContext(options, StoreOptions)) { context.PersistedGrants.Add(validGrant); - context.SaveChanges(); + await context.SaveChangesAsync(); } await CreateSut(options).RemoveExpiredGrantsAsync(); - using (var context = new PersistedGrantDbContext(options, StoreOptions)) + await using (var context = new PersistedGrantDbContext(options, StoreOptions)) { context.PersistedGrants.FirstOrDefault(x => x.Key == validGrant.Key).Should().NotBeNull(); } @@ -99,15 +98,15 @@ public async Task RemoveExpiredGrantsAsync_WhenExpiredDeviceGrantsExist_ExpectEx Data = "{!}" }; - using (var context = new PersistedGrantDbContext(options, StoreOptions)) + await using (var context = new PersistedGrantDbContext(options, StoreOptions)) { context.DeviceFlowCodes.Add(expiredGrant); - context.SaveChanges(); + await context.SaveChangesAsync(); } await CreateSut(options).RemoveExpiredGrantsAsync(); - using (var context = new PersistedGrantDbContext(options, StoreOptions)) + await using (var context = new PersistedGrantDbContext(options, StoreOptions)) { context.DeviceFlowCodes.FirstOrDefault(x => x.DeviceCode == expiredGrant.DeviceCode).Should().BeNull(); } @@ -127,25 +126,25 @@ public async Task RemoveExpiredGrantsAsync_WhenValidDeviceGrantsExist_ExpectVali Data = "{!}" }; - using (var context = new PersistedGrantDbContext(options, StoreOptions)) + await using (var context = new PersistedGrantDbContext(options, StoreOptions)) { context.DeviceFlowCodes.Add(validGrant); - context.SaveChanges(); + await context.SaveChangesAsync(); } await CreateSut(options).RemoveExpiredGrantsAsync(); - using (var context = new PersistedGrantDbContext(options, StoreOptions)) + await using (var context = new PersistedGrantDbContext(options, StoreOptions)) { context.DeviceFlowCodes.FirstOrDefault(x => x.DeviceCode == validGrant.DeviceCode).Should().NotBeNull(); } } - private EntityFramework.TokenCleanupService CreateSut(DbContextOptions options) + private TokenCleanupService CreateSut(DbContextOptions options) { IServiceCollection services = new ServiceCollection(); services.AddIdentityServer() - .AddTestUsers(new List()) + .AddTestUsers([]) .AddInMemoryClients(new List()) .AddInMemoryIdentityResources(new List()) .AddInMemoryApiResources(new List()); @@ -155,13 +154,9 @@ private EntityFramework.TokenCleanupService CreateSut(DbContextOptions(); services.AddTransient(); - services.AddTransient(); + services.AddTransient(); services.AddSingleton(StoreOptions); - return services.BuildServiceProvider().GetRequiredService(); - //return new EntityFramework.TokenCleanupService( - // services.BuildServiceProvider(), - // new NullLogger(), - // StoreOptions); + return services.BuildServiceProvider().GetRequiredService(); } } \ No newline at end of file diff --git a/src/EntityFramework/src/TokenCleanupHost.cs b/src/EntityFramework/src/TokenCleanupHost.cs index 736511d5a..ab89203f9 100644 --- a/src/EntityFramework/src/TokenCleanupHost.cs +++ b/src/EntityFramework/src/TokenCleanupHost.cs @@ -1,7 +1,6 @@ // Copyright (c) Brock Allen & Dominick Baier. All rights reserved. // Licensed under the Apache License, Version 2.0. See LICENSE in the project root for license information. - using Microsoft.Extensions.Hosting; using System.Threading; using System.Threading.Tasks; @@ -51,7 +50,7 @@ public Task StartAsync(CancellationToken cancellationToken) _source = CancellationTokenSource.CreateLinkedTokenSource(cancellationToken); - Task.Factory.StartNew(() => StartInternalAsync(_source.Token)); + Task.Factory.StartNew(() => StartInternalAsync(_source.Token), cancellationToken); } return Task.CompletedTask; @@ -81,7 +80,7 @@ private async Task StartInternalAsync(CancellationToken cancellationToken) { if (cancellationToken.IsCancellationRequested) { - _logger.LogDebug("CancellationRequested. Exiting."); + _logger.LogDebug("CancellationRequested. Exiting"); break; } @@ -89,20 +88,20 @@ private async Task StartInternalAsync(CancellationToken cancellationToken) { await Task.Delay(CleanupInterval, cancellationToken); } - catch (TaskCanceledException) + catch (TaskCanceledException ex) { - _logger.LogDebug("TaskCanceledException. Exiting."); + _logger.LogDebug(ex, "TaskCanceledException. Exiting"); break; } catch (Exception ex) { - _logger.LogError("Task.Delay exception: {0}. Exiting.", ex.Message); + _logger.LogError(ex, "Task.Delay exception: {ExceptionMsg}. Exiting", ex.Message); break; } if (cancellationToken.IsCancellationRequested) { - _logger.LogDebug("CancellationRequested. Exiting."); + _logger.LogDebug("CancellationRequested. Exiting"); break; } @@ -114,15 +113,13 @@ async Task RemoveExpiredGrantsAsync() { try { - using (var serviceScope = _serviceProvider.GetRequiredService().CreateScope()) - { - var tokenCleanupService = serviceScope.ServiceProvider.GetRequiredService(); - await tokenCleanupService.RemoveExpiredGrantsAsync(); - } + using var serviceScope = _serviceProvider.GetRequiredService().CreateScope(); + var tokenCleanupService = serviceScope.ServiceProvider.GetRequiredService(); + await tokenCleanupService.RemoveExpiredGrantsAsync(); } catch (Exception ex) { - _logger.LogError("Exception removing expired grants: {exception}", ex.Message); + _logger.LogError(ex, "Exception removing expired grants: {ExceptionMsg}", ex.Message); } } } \ No newline at end of file diff --git a/src/Open.IdentityServer/src/Configuration/DependencyInjection/BuilderExtensions/Additional.cs b/src/Open.IdentityServer/src/Configuration/DependencyInjection/BuilderExtensions/Additional.cs index 5104e7768..2d0c43058 100644 --- a/src/Open.IdentityServer/src/Configuration/DependencyInjection/BuilderExtensions/Additional.cs +++ b/src/Open.IdentityServer/src/Configuration/DependencyInjection/BuilderExtensions/Additional.cs @@ -11,6 +11,7 @@ using System; using System.Net.Http; using Microsoft.AspNetCore.Authentication.Cookies; +using Microsoft.Extensions.Hosting; using Open.IdentityServer; using Open.IdentityServer.Configuration; using Microsoft.Extensions.Logging; @@ -481,6 +482,10 @@ public static IIdentityServerBuilder AddServerSideSessions(this IIdentityServerB // provide default in-memory implementation, not suitable for most production scenarios (following pattern implemented with existing stores) builder.Services.TryAddSingleton(); + + //Clean-up Service + builder.Services.AddTransient(); + builder.Services.AddSingleton(); return builder; } diff --git a/src/Open.IdentityServer/src/Configuration/DependencyInjection/Options/ServerSideSessionsOptions.cs b/src/Open.IdentityServer/src/Configuration/DependencyInjection/Options/ServerSideSessionsOptions.cs index e9c0b12e5..22aab09a5 100644 --- a/src/Open.IdentityServer/src/Configuration/DependencyInjection/Options/ServerSideSessionsOptions.cs +++ b/src/Open.IdentityServer/src/Configuration/DependencyInjection/Options/ServerSideSessionsOptions.cs @@ -1,6 +1,8 @@ // Copyright (c) 2026, Rock Solid Knowledge Ltd // Licensed under the Apache License, Version 2.0. See LICENSE in the project root for license information. +using System; + namespace Open.IdentityServer.Configuration; /// @@ -14,4 +16,37 @@ public class ServerSideSessionsOptions /// Client.CoordinateLifetimeWithUserSession. /// public bool ExpiredSessionsTriggerBackchannelLogout { get; set; } + + /// + /// Specifies if expired sessions should be cleaned up automatically by Open.IdentityServer + /// + /// + /// The default value is true + /// + public bool RemoveExpiredSessions { get; set; } = true; + + /// + /// Specifies the frequency with which expired sessions are looked for and removed + /// + /// + /// The default value is a TimeSpan of 10 minutes + /// + public TimeSpan RemoveExpiredSessionsFrequency { get; set; } = TimeSpan.FromMinutes(10); + + /// + /// Specifies if the start time of the hosted service should be randomised to avoid limiting the occurrences of jobs + /// running simultaneously in scenarios with multiple instances of Open.IdentityServer are running. + /// + /// + /// The default value is true + /// + public bool FuzzExpiredSessionsFrequency { get; set; } = true; + + /// + /// Specifies how many expired sessions should be removed in a single pass + /// + /// + /// The default value is 100 + /// + public int RemoveExpiredSessionsBatchSize { get; set; } = 100; } \ No newline at end of file diff --git a/src/Open.IdentityServer/src/HostedServices/SessionCleanupHostedService.cs b/src/Open.IdentityServer/src/HostedServices/SessionCleanupHostedService.cs new file mode 100644 index 000000000..49c5f274a --- /dev/null +++ b/src/Open.IdentityServer/src/HostedServices/SessionCleanupHostedService.cs @@ -0,0 +1,120 @@ +using System; +using System.Threading; +using System.Threading.Tasks; +using Microsoft.Extensions.DependencyInjection; +using Microsoft.Extensions.Hosting; +using Microsoft.Extensions.Logging; +using Open.IdentityServer.Configuration; +using Open.IdentityServer.Services; + +namespace Open.IdentityServer; + +/// +/// A service for running server-side session clean-up periodically +/// +public class SessionCleanupHostedService( + IServiceProvider serviceProvider, + IdentityServerOptions options, + ILogger logger): IHostedService +{ + private CancellationTokenSource source; + + /// + /// Starts the hosted service if configured to be enabled + /// + /// + /// + public Task StartAsync(CancellationToken cancellationToken) + { + if (source != null) throw new InvalidOperationException("Already started. Call Stop first."); + + logger.LogDebug("Starting expired session removal"); + + source = CancellationTokenSource.CreateLinkedTokenSource(cancellationToken); + + Task.Factory.StartNew(() => StartInternalAsync(source.Token), cancellationToken); + + return Task.CompletedTask; + } + + /// + /// Stops the hosted service if started + /// + /// + /// + public Task StopAsync(CancellationToken cancellationToken) + { + if (source == null) throw new InvalidOperationException("Not started. Call Start first."); + + logger.LogDebug("Stopping expired session removal"); + + source.Cancel(); + source = null; + + return Task.CompletedTask; + } + + private async Task StartInternalAsync(CancellationToken cancellationToken) + { + if (options.ServerSideSessions.FuzzExpiredSessionsFrequency) + { + Random rnd = new Random(); + int seconds = rnd.Next(1, 120); + logger.LogDebug("Fuzzing session cleanup service start time by {Seconds}", seconds); + await Task.Delay(TimeSpan.FromSeconds(seconds), cancellationToken); + } + + while (true) + { + if (cancellationToken.IsCancellationRequested) + { + logger.LogDebug("CancellationRequested. Exiting"); + break; + } + + try + { + await Task.Delay(options.ServerSideSessions.RemoveExpiredSessionsFrequency, cancellationToken); + } + catch (TaskCanceledException ex) + { + logger.LogDebug(ex, "TaskCanceledException. Exiting"); + break; + } + catch (Exception ex) + { + logger.LogError(ex, "Task.Delay exception: {ExceptionMsg}. Exiting", ex.Message); + break; + } + + if (cancellationToken.IsCancellationRequested) + { + logger.LogDebug("CancellationRequested. Exiting"); + break; + } + + if (options.ServerSideSessions.RemoveExpiredSessions) + { + await RemoveExpiredSessions(); + } + else + { + logger.LogDebug("Expired session removal disabled"); + } + } + } + + private async Task RemoveExpiredSessions() + { + try + { + using var serviceScope = serviceProvider.GetRequiredService().CreateScope(); + var tokenCleanupService = serviceScope.ServiceProvider.GetRequiredService(); + await tokenCleanupService.RemoveExpiredServerSideSessionsAsync(); + } + catch (Exception ex) + { + logger.LogError(ex, "Exception removing expired sessions: {ExceptionMsg}", ex.Message); + } + } +} \ No newline at end of file diff --git a/src/Open.IdentityServer/src/Services/Default/SessionCleanupService.cs b/src/Open.IdentityServer/src/Services/Default/SessionCleanupService.cs new file mode 100644 index 000000000..8504b0576 --- /dev/null +++ b/src/Open.IdentityServer/src/Services/Default/SessionCleanupService.cs @@ -0,0 +1,80 @@ +// Copyright (c) 2026, Rock Solid Knowledge Ltd +// Licensed under the Apache License, Version 2.0. See LICENSE in the project root for license information. + +using System; +using System.Linq; +using System.Threading.Tasks; +using Microsoft.Extensions.Logging; +using Open.IdentityServer.Configuration; +using Open.IdentityServer.Extensions; +using Open.IdentityServer.Models; +using Open.IdentityServer.Stores; + +namespace Open.IdentityServer.Services; + +/// +/// Service to clean up expired server-side sessions +/// +/// IdentityServer options +/// server side sessions store +/// user session events service +/// telemetry service +/// logger +public class SessionCleanupService( + IdentityServerOptions options, + IServerSessionTicketStore serverSideSessionStore, + IUserSessionEventsService userSessionEventsService, + ITelemetryService telemetry, + ILogger logger): ISessionCleanupService +{ + /// + /// Method to clear expired server-side sessions. + /// + /// A that completes once all expired grants and device codes have been removed. + public async Task RemoveExpiredServerSideSessionsAsync() + { + using var trace = telemetry.Trace(TelemetryConstants.TraceCategories.Services, this); + + try + { + logger.LogTrace("Querying for expired sessions to remove"); + + await RemoveServerSideSessionsAsync(); + } + catch (Exception ex) + { + logger.LogError(ex, "Exception removing expired sessions: {Exception}", ex.Message); + } + } + + /// + /// Removes the expired sessions. + /// + /// A that completes once all batches of expired sessions have been deleted. + private async Task RemoveServerSideSessionsAsync() + { + int found; + + do + { + var expiredSessions = (await serverSideSessionStore + .GetAndRemoveExpiredSessions(options.ServerSideSessions.RemoveExpiredSessionsBatchSize)) + .ToList(); + + found = expiredSessions.Count; + logger.LogInformation("Removed {ExpiredSessionsCount} expired server side sessions", found); + + if (found <= 0) continue; + + foreach (var expiredSession in expiredSessions) + { + await userSessionEventsService.HandleUserSessionExpiry(new EndUserSessionEventContext() + { + SubjectId = expiredSession.Session.SubjectId, + SessionId = expiredSession.Session.SessionId, + ClientIds = expiredSession.AuthTicket?.Properties.GetClientList().ToArray() ?? [], + }); + } + } while (found >= options.ServerSideSessions.RemoveExpiredSessionsBatchSize); + } +} \ No newline at end of file diff --git a/src/Open.IdentityServer/src/Services/ISessionCleanupService.cs b/src/Open.IdentityServer/src/Services/ISessionCleanupService.cs new file mode 100644 index 000000000..9fbfa3711 --- /dev/null +++ b/src/Open.IdentityServer/src/Services/ISessionCleanupService.cs @@ -0,0 +1,15 @@ +using System.Threading.Tasks; + +namespace Open.IdentityServer.Services; + +/// +/// Service to clean up expired server-side sessions +/// +public interface ISessionCleanupService +{ + /// + /// Method to clear expired server-side sessions. + /// + /// A that completes once all expired grants and device codes have been removed. + public Task RemoveExpiredServerSideSessionsAsync(); +} \ No newline at end of file diff --git a/src/Open.IdentityServer/src/Stores/Default/ServerSessionTicketStore.cs b/src/Open.IdentityServer/src/Stores/Default/ServerSessionTicketStore.cs index 333854a3c..7c5d5ddb9 100644 --- a/src/Open.IdentityServer/src/Stores/Default/ServerSessionTicketStore.cs +++ b/src/Open.IdentityServer/src/Stores/Default/ServerSessionTicketStore.cs @@ -143,6 +143,20 @@ public async Task> FilterServerAut }).Where(x => x.AuthTicket != null); } + /// + public async Task> GetAndRemoveExpiredSessions(int batchSize = 100) + { + using ITrace? trace = telemetry.Trace(TelemetryConstants.TraceCategories.Stores, this); + + var sessionRemoved = await serverServerSideSessionStore.GetAndRemoveExpiredSessions(batchSize); + + return sessionRemoved.Select(x => new AuthenticationTicketFilterResult + { + Session = x, + AuthTicket = DeserializeAuthTicket(x), + }).Where(x => x.AuthTicket != null); + } + private async Task StoreNewSession(string key, AuthenticationTicket ticket) { IdentityServerServerSideSessions serverSideSession = new IdentityServerServerSideSessions diff --git a/src/Open.IdentityServer/src/Stores/IServerSessionTicketStore.cs b/src/Open.IdentityServer/src/Stores/IServerSessionTicketStore.cs index 0a68cede9..e65f9f8bb 100644 --- a/src/Open.IdentityServer/src/Stores/IServerSessionTicketStore.cs +++ b/src/Open.IdentityServer/src/Stores/IServerSessionTicketStore.cs @@ -21,4 +21,11 @@ public interface IServerSessionTicketStore: ITicketStore /// session id filter to apply /// collection of auth ticket matching filter Task> FilterServerAuthenticationTickets(string subjectId, string sessionId); + + /// + /// Removes expired auth tickets and returns a collection of these auth tokens and session objects they come from + /// + /// optional batch size value, defaults to 100 + /// removed expired sessions + public Task> GetAndRemoveExpiredSessions(int batchSize = 100); } \ No newline at end of file diff --git a/src/Open.IdentityServer/src/Stores/InMemory/InMemorySessionStore.cs b/src/Open.IdentityServer/src/Stores/InMemory/InMemorySessionStore.cs index 03ee23881..da96bbb8f 100644 --- a/src/Open.IdentityServer/src/Stores/InMemory/InMemorySessionStore.cs +++ b/src/Open.IdentityServer/src/Stores/InMemory/InMemorySessionStore.cs @@ -3,6 +3,7 @@ #nullable enable +using System; using System.Collections.Concurrent; using System.Collections.Generic; using System.Linq; @@ -52,4 +53,22 @@ public Task> FilterSessions(string return Task.FromResult(repo.Values .Where(x => x.SubjectId == subjectId && x.SessionId == sessionId)); } + + /// + public Task> GetAndRemoveExpiredSessions(int batchSize = 100) + { + IEnumerable sessions = repo + .Select(x => x.Value) + .Where(x => x.Expires < DateTime.UtcNow) + .OrderBy(x => x.Expires) + .Take(batchSize) + .ToList(); + + foreach (var session in sessions) + { + repo.TryRemove(session.Key, out _); + } + + return Task.FromResult(sessions); + } } \ No newline at end of file diff --git a/src/Open.IdentityServer/test/Open.IdentityServer.UnitTests/Configuration/DependencyInjection/BuilderExtensions/AdditionalTests.cs b/src/Open.IdentityServer/test/Open.IdentityServer.UnitTests/Configuration/DependencyInjection/BuilderExtensions/AdditionalTests.cs index 216f537b7..2b49272fa 100644 --- a/src/Open.IdentityServer/test/Open.IdentityServer.UnitTests/Configuration/DependencyInjection/BuilderExtensions/AdditionalTests.cs +++ b/src/Open.IdentityServer/test/Open.IdentityServer.UnitTests/Configuration/DependencyInjection/BuilderExtensions/AdditionalTests.cs @@ -6,11 +6,14 @@ using AwesomeAssertions; using Microsoft.AspNetCore.Authentication.Cookies; using Microsoft.Extensions.DependencyInjection; +using Microsoft.Extensions.Hosting; using Microsoft.Extensions.Options; using Open.IdentityServer.Configuration; using Open.IdentityServer.Configuration.DependencyInjection; +using Open.IdentityServer.EntityFramework; using Open.IdentityServer.Models; using Open.IdentityServer.Services; +using Open.IdentityServer.Services.Default; using Open.IdentityServer.Stores; using Open.IdentityServer.Validation; using Xunit; @@ -63,6 +66,15 @@ public void AddServerSideSessions_WhenNoStoreConfigured_ShouldConfigureServerSid d.ServiceType == typeof(IIdentityServerServerSideSessionStore) && d.ImplementationType == typeof(InMemorySessionStore) && d.Lifetime == ServiceLifetime.Singleton); + + serviceCollection.Should().ContainSingle(d => + d.ImplementationType == typeof(SessionCleanupService) && + d.Lifetime == ServiceLifetime.Transient); + + serviceCollection.Should().ContainSingle(d => + d.ServiceType == typeof(IHostedService) && + d.ImplementationType == typeof(SessionCleanupHostedService) && + d.Lifetime == ServiceLifetime.Singleton); } [Fact] @@ -109,6 +121,15 @@ public void AddServerSideSessions_WhenStoreConfigured_ShouldConfigureServerSideS d.ServiceType == typeof(IIdentityServerServerSideSessionStore) && d.ImplementationType == typeof(InMemorySessionStore) && d.Lifetime == ServiceLifetime.Singleton); + + serviceCollection.Should().ContainSingle(d => + d.ImplementationType == typeof(SessionCleanupService) && + d.Lifetime == ServiceLifetime.Transient); + + serviceCollection.Should().ContainSingle(d => + d.ServiceType == typeof(IHostedService) && + d.ImplementationType == typeof(SessionCleanupHostedService) && + d.Lifetime == ServiceLifetime.Singleton); } } @@ -138,4 +159,9 @@ public Task> FilterSessions(string { throw new System.NotImplementedException(); } + + public Task> GetAndRemoveExpiredSessions(int batchSize = 100) + { + throw new System.NotImplementedException(); + } } \ No newline at end of file diff --git a/src/Open.IdentityServer/test/Open.IdentityServer.UnitTests/HostedServices/SessionCleanupHostedServiceTests.cs b/src/Open.IdentityServer/test/Open.IdentityServer.UnitTests/HostedServices/SessionCleanupHostedServiceTests.cs new file mode 100644 index 000000000..93288f81f --- /dev/null +++ b/src/Open.IdentityServer/test/Open.IdentityServer.UnitTests/HostedServices/SessionCleanupHostedServiceTests.cs @@ -0,0 +1,105 @@ +// Copyright (c) 2026, Rock Solid Knowledge Ltd +// Licensed under the Apache License, Version 2.0. See LICENSE in the project root for license information. + +using System; +using System.Threading; +using System.Threading.Tasks; +using Microsoft.Extensions.DependencyInjection; +using Microsoft.Extensions.Logging; +using Moq; +using Open.IdentityServer.Configuration; +using Open.IdentityServer.Services; +using Xunit; +using Range = Moq.Range; + +namespace Open.IdentityServer.UnitTests.HostedServices; + +public class SessionCleanupHostedServiceTests +{ + private IServiceProvider serviceProvider = Mock.Of(); + private IdentityServerOptions options = new() + { + ServerSideSessions = new ServerSideSessionsOptions + { + RemoveExpiredSessions = true, + RemoveExpiredSessionsBatchSize = 100, + RemoveExpiredSessionsFrequency = TimeSpan.FromSeconds(0.25), + FuzzExpiredSessionsFrequency = false, + }, + }; + private ILogger logger = Mock.Of>(); + + private IServiceScopeFactory scopeFactory = Mock.Of(); + private IServiceScope serviceScope = Mock.Of(); + private ISessionCleanupService sessionCleanupService = Mock.Of(); + + public SessionCleanupHostedServiceTests() + { + Mock.Get(serviceProvider) + .Setup(x => x.GetService(typeof(IServiceScopeFactory))) + .Returns(scopeFactory); + + Mock.Get(serviceProvider) + .Setup(x => x.GetService(typeof(ISessionCleanupService))) + .Returns(sessionCleanupService); + + Mock.Get(scopeFactory) + .Setup(x => x.CreateScope()) + .Returns(serviceScope); + + Mock.Get(serviceScope) + .Setup(x => x.ServiceProvider) + .Returns(serviceProvider); + } + + private SessionCleanupHostedService CreateSut() => new(serviceProvider, options, logger); + + [Fact] + public async Task SessionCleanupHostedService_WhenCleanupDisabled_ShouldNeverTrigger() + { + options.ServerSideSessions.RemoveExpiredSessions = false; + + CancellationTokenSource ctSrc = CancellationTokenSource.CreateLinkedTokenSource(TestContext.Current.CancellationToken); + + var sut = CreateSut(); + + await sut.StartAsync(ctSrc.Token); + await Task.Delay(TimeSpan.FromSeconds(1), TestContext.Current.CancellationToken); + await sut.StopAsync(ctSrc.Token); + + Mock.Get(sessionCleanupService) + .Verify(x => x.RemoveExpiredServerSideSessionsAsync(), Times.Never); + } + + [Fact] + public async Task SessionCleanupHostedService_WhenFuzzDisabled_ShouldTriggerAtLeast3Time() + { + CancellationTokenSource ctSrc = CancellationTokenSource.CreateLinkedTokenSource(TestContext.Current.CancellationToken); + + var sut = CreateSut(); + + await sut.StartAsync(ctSrc.Token); + await Task.Delay(TimeSpan.FromSeconds(1), TestContext.Current.CancellationToken); + await sut.StopAsync(ctSrc.Token); + + Mock.Get(sessionCleanupService) + .Verify(x => x.RemoveExpiredServerSideSessionsAsync(), Times.Between(3, 5, Range.Inclusive)); + } + + [Fact] + public async Task SessionCleanupHostedService_WhenFuzzEnabled_ShouldTriggerAtMost2Times() + { + options.ServerSideSessions.FuzzExpiredSessionsFrequency = true; + + CancellationTokenSource ctSrc = CancellationTokenSource.CreateLinkedTokenSource(TestContext.Current.CancellationToken); + + var sut = CreateSut(); + + await sut.StartAsync(ctSrc.Token); + await Task.Delay(TimeSpan.FromSeconds(1), TestContext.Current.CancellationToken); + await sut.StopAsync(ctSrc.Token); + + Mock.Get(sessionCleanupService) + .Verify(x => x.RemoveExpiredServerSideSessionsAsync(), Times.AtMost(2)); + } +} \ No newline at end of file diff --git a/src/Open.IdentityServer/test/Open.IdentityServer.UnitTests/Open.IdentityServer.UnitTests.csproj b/src/Open.IdentityServer/test/Open.IdentityServer.UnitTests/Open.IdentityServer.UnitTests.csproj index 172649d7a..89183e118 100644 --- a/src/Open.IdentityServer/test/Open.IdentityServer.UnitTests/Open.IdentityServer.UnitTests.csproj +++ b/src/Open.IdentityServer/test/Open.IdentityServer.UnitTests/Open.IdentityServer.UnitTests.csproj @@ -36,6 +36,7 @@ + diff --git a/src/Open.IdentityServer/test/Open.IdentityServer.UnitTests/Services/Default/SessionCleanupServiceTests.cs b/src/Open.IdentityServer/test/Open.IdentityServer.UnitTests/Services/Default/SessionCleanupServiceTests.cs new file mode 100644 index 000000000..685b7d555 --- /dev/null +++ b/src/Open.IdentityServer/test/Open.IdentityServer.UnitTests/Services/Default/SessionCleanupServiceTests.cs @@ -0,0 +1,227 @@ +// Copyright (c) 2026, Rock Solid Knowledge Ltd +// Licensed under the Apache License, Version 2.0. See LICENSE in the project root for license information. + +#nullable enable + +using System; +using System.Collections.Generic; +using System.Linq; +using System.Threading.Tasks; +using AwesomeAssertions; +using Microsoft.AspNetCore.Authentication; +using Microsoft.Extensions.Logging; +using Moq; +using Open.IdentityServer.Configuration; +using Open.IdentityServer.EntityFramework; +using Open.IdentityServer.Extensions; +using Open.IdentityServer.Models; +using Open.IdentityServer.Services; +using Open.IdentityServer.Services.Default; +using Open.IdentityServer.Stores; +using Xunit; + +namespace Open.IdentityServer.UnitTests.Services; + +public class SessionCleanupServiceTests +{ + private IdentityServerOptions options = new(); + + private IServerSessionTicketStore serverSideSessionStore = + Mock.Of(); + + private IUserSessionEventsService userSessionEventsService = Mock.Of(); + private ITelemetryService telemetry = Mock.Of(); + private ILogger logger = Mock.Of>(); + + private SessionCleanupService CreateSut() => + new(options, serverSideSessionStore, userSessionEventsService, telemetry, logger); + + [Fact] + public async Task + RemoveExpiredServerSideSessionsAsync_WhenExpiredServerSideSessionExist_ExpectExpiredDeviceGrantsRemoved() + { + var expiredSession = FakeSessionSession("123", "sesh1", true); + + Mock.Get(serverSideSessionStore) + .SetupSequence(x => + x.GetAndRemoveExpiredSessions(options.ServerSideSessions.RemoveExpiredSessionsBatchSize)) + .ReturnsAsync([expiredSession]); + + var sut = CreateSut(); + + await sut.RemoveExpiredServerSideSessionsAsync(); + + Mock.Get(serverSideSessionStore) + .Verify(x => x.GetAndRemoveExpiredSessions(options.ServerSideSessions.RemoveExpiredSessionsBatchSize)); + + Mock.Get(userSessionEventsService) + .Verify(x => x.HandleUserSessionExpiry(It.IsAny()), Times.Once); + } + + [Fact] + public async Task RemoveExpiredServerSideSessionsAsync_WhenValidServerSideSessionExist_ExpectValidDeviceGrantsInDb() + { + Mock.Get(serverSideSessionStore) + .SetupSequence(x => + x.GetAndRemoveExpiredSessions(options.ServerSideSessions.RemoveExpiredSessionsBatchSize)) + .ReturnsAsync([]); + + var sut = CreateSut(); + + await sut.RemoveExpiredServerSideSessionsAsync(); + + Mock.Get(serverSideSessionStore) + .Verify(x => x.GetAndRemoveExpiredSessions(options.ServerSideSessions.RemoveExpiredSessionsBatchSize)); + + Mock.Get(userSessionEventsService) + .Verify(x => x.HandleUserSessionExpiry(It.IsAny()), Times.Never); + } + + [Fact] + public async Task + RemoveExpiredServerSideSessionsAsync_WhenMultipleExpiredServerSideSessionExist_ExpectExpiredDeviceGrantsRemoved() + { + options.ServerSideSessions.RemoveExpiredSessionsBatchSize = 2; + + var expiredSession0 = FakeSessionSession("123", "sesh1", true); + var expiredSession1 = FakeSessionSession("456", "sesh2", true); + var expiredSession2 = FakeSessionSession("789", "sesh3", true); + + Mock.Get(serverSideSessionStore) + .SetupSequence(x => + x.GetAndRemoveExpiredSessions(options.ServerSideSessions.RemoveExpiredSessionsBatchSize)) + .ReturnsAsync([expiredSession0, expiredSession1]) + .ReturnsAsync([expiredSession2]); + + var sut = CreateSut(); + + await sut.RemoveExpiredServerSideSessionsAsync(); + + Mock.Get(serverSideSessionStore) + .Verify(x => x.GetAndRemoveExpiredSessions(options.ServerSideSessions.RemoveExpiredSessionsBatchSize), + Times.Exactly(2)); + + Mock.Get(userSessionEventsService) + .Verify(x => x.HandleUserSessionExpiry(It.IsAny()), Times.Exactly(3)); + } + + [Fact] + public async Task RemoveExpiredServerSideSessionsAsync_WhenExpiredSessionContainsClientList_ExpectExpiredDeviceGrantsRemoved() + { + string[] fakeClientIds = ["client1", "client2"]; + var expiredSession0 = FakeSessionSession("123", "sesh1", true, fakeClientIds); + + Mock.Get(serverSideSessionStore) + .SetupSequence(x => + x.GetAndRemoveExpiredSessions(options.ServerSideSessions.RemoveExpiredSessionsBatchSize)) + .ReturnsAsync([expiredSession0]); + + EndUserSessionEventContext? context = null; + Mock.Get(userSessionEventsService) + .Setup(x => x.HandleUserSessionExpiry(It.IsAny())) + .Callback(x => context = x); + + var sut = CreateSut(); + + await sut.RemoveExpiredServerSideSessionsAsync(); + + Mock.Get(serverSideSessionStore) + .Verify(x => x.GetAndRemoveExpiredSessions(options.ServerSideSessions.RemoveExpiredSessionsBatchSize), + Times.Once); + + Mock.Get(userSessionEventsService) + .Verify(x => x.HandleUserSessionExpiry(It.IsAny()), Times.Once); + + context.Should().NotBeNull(); + context.SessionId.Should().Be(expiredSession0.Session.SessionId); + context.SubjectId.Should().Be(expiredSession0.Session.SubjectId); + context.ClientIds.Should().BeEquivalentTo(fakeClientIds); + } + + [Fact] + public async Task PublicMethods_WhenCalled_ShouldTelemetryTrace() + { + List<(Func actMethod, string traceMethodName)> methods = + [ + (store => store.RemoveExpiredServerSideSessionsAsync(), "RemoveExpiredServerSideSessionsAsync") + ]; + + foreach ((Func actMethod, string traceMethodName) method in methods) + { + ITrace trace = Mock.Of(); + Mock.Get(telemetry).Setup(t => t.Trace(It.IsAny(), It.IsAny(), It.IsAny())) + .Returns(trace); + Mock.Get(trace).Setup(t => t.AddTag(It.IsAny(), It.IsAny())).Returns(trace); + Mock.Get(trace).Setup(t => t.AddTag(It.IsAny(), It.IsAny())).Returns(trace); + + SessionCleanupService store = CreateSut(); + + await method.actMethod(store); + + Mock.Get(telemetry) + .Verify(t => t.Trace( + TelemetryConstants.TraceCategories.Services, store, method.traceMethodName), Times.Once); + Mock.Get(trace).Verify(t => t.Dispose(), Times.Once); + } + + // Assert all methods covered + typeof(SessionCleanupService).GetMethods() + .Where(m => m is { IsPublic: true, IsStatic: false, IsSpecialName: false }) + .Where(m => m.DeclaringType == typeof(SessionCleanupService)) + .Select(m => m.Name) + .Distinct() + .Should().BeEquivalentTo(methods.Select(m => m.traceMethodName)); + } + + private static AuthenticationTicketFilterResult FakeSessionSession(string subject, string sessionId, + bool expired = false, string[]? clientsIds = null) + { + var session = new IdentityServerServerSideSessions + { + Key = Guid.NewGuid().ToString(), + Scheme = Guid.NewGuid().ToString(), + SubjectId = subject, + SessionId = sessionId, + DisplayName = "user" + subject, + Created = DateTime.UtcNow.AddDays(-3), + Renewed = DateTime.UtcNow.AddDays(-3), + Expires = DateTime.UtcNow.AddDays(2), + Data = "{!}" + }; + + if (expired) + { + session.Created = DateTime.UtcNow.AddDays(-5); + session.Renewed = DateTime.UtcNow.AddDays(-4); + session.Expires = DateTime.UtcNow.AddDays(-3); + } + + return new AuthenticationTicketFilterResult + { + Session = session, + AuthTicket = GenerateAuthenticationTicket(session, clientsIds), + }; + } + + private static AuthenticationTicket GenerateAuthenticationTicket(IdentityServerServerSideSessions session, string[]? clientIds = null) + { + IdentityServerUser user = new(session.SubjectId); + AuthenticationProperties properties = new(); + + properties.SetSessionId(session.SessionId); + + user.DisplayName = session.DisplayName; + properties.IssuedUtc = session.Renewed; + properties.ExpiresUtc = session.Expires; + + if (clientIds != null) + { + foreach (var clientId in clientIds) + { + properties.AddClientId(clientId); + } + } + + return new AuthenticationTicket(user.CreatePrincipal(), properties, session.Scheme); + } +} \ No newline at end of file diff --git a/src/Open.IdentityServer/test/Open.IdentityServer.UnitTests/Stores/Compatibility/IdentityServerSigningCredentialStoreTests.cs b/src/Open.IdentityServer/test/Open.IdentityServer.UnitTests/Stores/Compatibility/IdentityServerSigningCredentialStoreTests.cs index b43068f67..0b4f392b5 100644 --- a/src/Open.IdentityServer/test/Open.IdentityServer.UnitTests/Stores/Compatibility/IdentityServerSigningCredentialStoreTests.cs +++ b/src/Open.IdentityServer/test/Open.IdentityServer.UnitTests/Stores/Compatibility/IdentityServerSigningCredentialStoreTests.cs @@ -17,7 +17,7 @@ using Open.IdentityServer.Models; using Open.IdentityServer.Services; using Open.IdentityServer.Stores; -using Open.IdentityServer.UnitTests; +using Open.IdentityServer.Test.Utilities; using Xunit; namespace Open.IdentityServer.UnitTests.Stores.Compatibility; diff --git a/src/Open.IdentityServer/test/Open.IdentityServer.UnitTests/Stores/Default/ServerSessionTicketStoreTests.cs b/src/Open.IdentityServer/test/Open.IdentityServer.UnitTests/Stores/Default/ServerSessionTicketStoreTests.cs index 942ca1f0b..411b02786 100644 --- a/src/Open.IdentityServer/test/Open.IdentityServer.UnitTests/Stores/Default/ServerSessionTicketStoreTests.cs +++ b/src/Open.IdentityServer/test/Open.IdentityServer.UnitTests/Stores/Default/ServerSessionTicketStoreTests.cs @@ -452,7 +452,8 @@ public async Task FilterServerAuthenticationTickets_WhenSessionReturnedFromStore ]; List expectedAuthTickets = []; - sessions = sessions.Select(x => GenerateSerialisedData(expectedAuthTickets, x)); + sessions = sessions.Select(x => GenerateSerialisedData(expectedAuthTickets, x)) + .ToList(); Mock.Get(serverServerSideSessionStore) .Setup(x => x.FilterSessions(testSubjectId, testSessionId)) @@ -464,6 +465,52 @@ public async Task FilterServerAuthenticationTickets_WhenSessionReturnedFromStore actual.Should().NotBeNullOrEmpty(); actual.Should().HaveCount(expectedAuthTickets.Count); + + foreach (var session in sessions) + { + ValidateAutTicketExists(actual, session); + } + } + + [Fact] + public async Task GetAndRemoveExpiredSessions_WhenSessionReturnedFromStore_ShouldReturnExtractedAuthTickets() + { + const int batchSize = 5; + + IEnumerable sessions = [ + FakeSession(key: "key-0", scheme: "AuthScheme", subjectId: "bob", sessionId: "session-0", displayName: "Bob Smith"), + FakeSession(key: "key-4", scheme: "AuthScheme", subjectId: "bob", sessionId: "session-0", displayName: "Bob Smith"), + FakeSession(key: "key-5", scheme: "AuthScheme", subjectId: "bob", sessionId: "session-0", displayName: "Bob Smith"), + ]; + + List expectedAuthTickets = []; + sessions = sessions.Select(x => GenerateSerialisedData(expectedAuthTickets, x)) + .ToList(); + + Mock.Get(serverServerSideSessionStore) + .Setup(x => x.GetAndRemoveExpiredSessions(batchSize)) + .ReturnsAsync(sessions); + + ServerSessionTicketStore sut = CreateSut(); + IEnumerable actual = + (await sut.GetAndRemoveExpiredSessions(batchSize)).ToList(); + + actual.Should().NotBeNullOrEmpty(); + actual.Should().HaveCount(expectedAuthTickets.Count); + + foreach (var session in sessions) + { + ValidateAutTicketExists(actual, session); + } + } + + private void ValidateAutTicketExists(IEnumerable result, IdentityServerServerSideSessions sesison) + { + result.Should().Contain(x => + x.AuthTicket != null && + x.AuthTicket.AuthenticationScheme == sesison.Scheme && + x.AuthTicket.Principal.GetSubjectId() == sesison.SubjectId && + x.AuthTicket.Properties.GetSessionId() == sesison.SessionId); } [Fact] @@ -479,6 +526,7 @@ public async Task PublicMethods_WhenCalled_ShouldTelemetryTrace() (store => store.RetrieveAsync("FAKE_KEY"), "RetrieveAsync"), (store => store.RemoveAsync("FAKE_KEY"), "RemoveAsync"), (store => store.FilterServerAuthenticationTickets("FAKE_SUB_KEY", "FAKE_SESSION_KEY"), "FilterServerAuthenticationTickets"), + (store => store.GetAndRemoveExpiredSessions(), "GetAndRemoveExpiredSessions"), ]; var sut = CreateSut(); diff --git a/src/Open.IdentityServer/test/Open.IdentityServer.UnitTests/Stores/InMemorySessionStoreTests.cs b/src/Open.IdentityServer/test/Open.IdentityServer.UnitTests/Stores/InMemorySessionStoreTests.cs index 2fd90f320..ab710593e 100644 --- a/src/Open.IdentityServer/test/Open.IdentityServer.UnitTests/Stores/InMemorySessionStoreTests.cs +++ b/src/Open.IdentityServer/test/Open.IdentityServer.UnitTests/Stores/InMemorySessionStoreTests.cs @@ -259,4 +259,98 @@ public async Task FilterSessions_WhenSessionMatch_ShouldReturnMatchingSessions() actual.Should().Contain(x => x.Key == "key-1"); actual.Should().Contain(x => x.Key == "key-6"); } + + [Fact] + public async Task GetAndRemoveExpiredSessions_WhenNoExpiredSessionsExist_ShouldRemoveNothingAndReturnEmptyCollection() + { + IdentityServerServerSideSessions validSession0 = FakeSessionSession("123", "session1"); + IdentityServerServerSideSessions validSession1 = FakeSessionSession("456", "session2"); + + InMemorySessionStore sut = CreateSut([validSession0, validSession1]); + + (await sut.GetSession(validSession0.Key)).Should().NotBeNull(); + (await sut.GetSession(validSession1.Key)).Should().NotBeNull(); + + List actual = (await sut.GetAndRemoveExpiredSessions()).ToList(); + + actual.Should().BeEmpty(); + + (await sut.GetSession(validSession0.Key)).Should().NotBeNull(); + (await sut.GetSession(validSession1.Key)).Should().NotBeNull(); + } + + [Fact] + public async Task GetAndRemoveExpiredSessions_WhenExpiredSessionsExist_AndUnderBatchSize_ShouldDeleteExpiredSessionsAndReturnACollectionContainingRemovedSessions() + { + IdentityServerServerSideSessions expiredSession0 = FakeSessionSession("123", "session1", true); + IdentityServerServerSideSessions expiredSession1 = FakeSessionSession("456", "session2", true); + + InMemorySessionStore sut = CreateSut([expiredSession0, expiredSession1]); + + (await sut.GetSession(expiredSession0.Key)).Should().NotBeNull(); + (await sut.GetSession(expiredSession1.Key)).Should().NotBeNull(); + + List actual = (await sut.GetAndRemoveExpiredSessions()).ToList(); + + actual.Should().HaveCount(2); + actual.Should().Contain(x => x.Key == expiredSession0.Key); + actual.Should().Contain(x => x.Key == expiredSession1.Key); + + (await sut.GetSession(expiredSession0.Key)).Should().BeNull(); + (await sut.GetSession(expiredSession1.Key)).Should().BeNull(); + } + + [Fact] + public async Task GetAndRemoveExpiredSessions_WhenExpiredSessionsExist_AndExceedBatchSize_ShouldDeleteAndReturnExpiredSessions_WithACountOfBatchSize() + { + IdentityServerServerSideSessions expiredSession0 = FakeSessionSession("123", "session1", true); + IdentityServerServerSideSessions expiredSession1 = FakeSessionSession("456", "session2", true); + IdentityServerServerSideSessions expiredSession2 = FakeSessionSession("789", "session3", true); + IdentityServerServerSideSessions validSession0 = FakeSessionSession("234", "session4"); + + InMemorySessionStore sut = CreateSut([expiredSession0, expiredSession1, expiredSession2, validSession0]); + + (await sut.GetSession(expiredSession0.Key)).Should().NotBeNull(); + (await sut.GetSession(expiredSession1.Key)).Should().NotBeNull(); + (await sut.GetSession(expiredSession2.Key)).Should().NotBeNull(); + (await sut.GetSession(validSession0.Key)).Should().NotBeNull(); + + List actual = (await sut.GetAndRemoveExpiredSessions(2)).ToList(); + + actual.Should().HaveCount(2); + actual.Should().Contain(x => x.Key == expiredSession0.Key); + actual.Should().Contain(x => x.Key == expiredSession1.Key); + actual.Should().NotContain(x => x.Key == expiredSession2.Key); + actual.Should().NotContain(x => x.Key == validSession0.Key); + + (await sut.GetSession(expiredSession0.Key)).Should().BeNull(); + (await sut.GetSession(expiredSession1.Key)).Should().BeNull(); + (await sut.GetSession(expiredSession2.Key)).Should().NotBeNull(); + (await sut.GetSession(validSession0.Key)).Should().NotBeNull(); + } + + private static IdentityServerServerSideSessions FakeSessionSession(string subject, string sessionId, bool expired = false) + { + IdentityServerServerSideSessions session = new IdentityServerServerSideSessions + { + Key = Guid.NewGuid().ToString(), + Scheme = Guid.NewGuid().ToString(), + SubjectId = subject, + SessionId = sessionId, + DisplayName = "user" + subject, + Created = DateTime.UtcNow.AddDays(-3), + Renewed = DateTime.UtcNow.AddDays(-3), + Expires = DateTime.UtcNow.AddDays(2), + Data = "{!}" + }; + + if (expired) + { + session.Created = DateTime.UtcNow.AddDays(-5); + session.Renewed = DateTime.UtcNow.AddDays(-4); + session.Expires = DateTime.UtcNow.AddDays(-3); + } + + return session; + } } \ No newline at end of file diff --git a/src/Storage/src/Stores/Compatibility/IIdentityServerServerSideSessionStore.cs b/src/Storage/src/Stores/Compatibility/IIdentityServerServerSideSessionStore.cs index 69f620bb7..53280814b 100644 --- a/src/Storage/src/Stores/Compatibility/IIdentityServerServerSideSessionStore.cs +++ b/src/Storage/src/Stores/Compatibility/IIdentityServerServerSideSessionStore.cs @@ -49,4 +49,11 @@ public interface IIdentityServerServerSideSessionStore /// session id filter to apply /// collection of session entities matching filter public Task> FilterSessions(string subjectId, string sessionId); + + /// + /// Removes expired sessions and returns a collection of sessions that were removed + /// + /// optional batch size value, defaults to 100 + /// removed expired sessions + public Task> GetAndRemoveExpiredSessions(int batchSize = 100); } \ No newline at end of file