diff --git a/docs/broker-operations.md b/docs/broker-operations.md index 8597bd2..d3644d1 100644 --- a/docs/broker-operations.md +++ b/docs/broker-operations.md @@ -56,6 +56,13 @@ Eso es comportamiento esperado, no una caída del servicio. nombre y ubicación. El Credential Provider mantiene su propio límite de **90 segundos**: si SGU excede ese presupuesto, Windows continúa por el fallback normal de AD o credenciales de dominio en caché. + Cuando el HTML confirma la clave institucional, el broker solicita la foto + del endpoint de SGU con la misma sesión autenticada: `tp=1` para alumnos y + `tp=2` para administrativos/docentes. Solo acepta JPEG de hasta 100 KiB, con + un límite adicional de 3 segundos. Un error, HTML de login, timeout o foto + inválida conserva la foto anterior y no impide el inicio de sesión. La + escritura de `thumbnailPhoto` en AD también es independiente de los demás + metadatos y de la sincronización de contraseña. - El instalador configura recuperación del servicio con reinicios a los 5, 15 y 60 segundos y reinicia el contador de fallos después de 24 horas. - Si el broker o SGU no está disponible, el Credential Provider entrega la diff --git a/docs/monitoring.md b/docs/monitoring.md index 8c099f2..6e3a1d0 100644 --- a/docs/monitoring.md +++ b/docs/monitoring.md @@ -27,13 +27,16 @@ rol, `TraceId`, resultado y tiempo total. Los Event ID estables distinguen: - `1100` SGU aceptó la autenticación; `1101` timeout; `1102` fallo de red/DNS; - `1200` enriquecimiento completado y cantidad de campos; `1201` HTML sin los IDs admitidos; `1202` timeout; `1203` excepción; `1204` página opcional no - disponible; + disponible; `1205` foto SGU no disponible o timeout; `1206` imagen rechazada + por tipo, tamaño o formato; - `1300` fallo de sincronización AD; `1301` metadatos opcionales no aplicados; `1302` membresía RDP opcional no aplicada; `1303` cuenta agregada a su grupo - institucional de Alumnos, Administrativos o Docentes. + institucional de Alumnos, Administrativos o Docentes; `1304` cambio de + contraseña denegado; `1305` foto opcional no aplicada en AD. -No se almacena HTML, contraseña, hash de contraseña ni contenido de la -respuesta SGU. +Los registros no almacenan HTML, contraseñas, hashes ni cuerpos de respuesta +de SGU. Solo la imagen JPEG validada se guarda en `thumbnailPhoto` del usuario +de Active Directory; sus bytes no aparecen en los eventos. ## Retención diff --git a/scripts/Get-SguBrokerLog.ps1 b/scripts/Get-SguBrokerLog.ps1 index ac9cf93..6a4d40d 100644 --- a/scripts/Get-SguBrokerLog.ps1 +++ b/scripts/Get-SguBrokerLog.ps1 @@ -29,10 +29,14 @@ $eventNames = @{ 1202 = 'ProfileEnrichmentTimeout' 1203 = 'ProfileEnrichmentFailure' 1204 = 'ProfilePageUnavailable' + 1205 = 'ProfilePhotoUnavailable' + 1206 = 'ProfilePhotoInvalid' 1300 = 'DirectorySynchronizationFailure' 1301 = 'DirectoryOptionalMetadataFailure' 1302 = 'DirectoryGroupMembershipFailure' 1303 = 'DirectoryRoleGroupMembershipAdded' + 1304 = 'DirectoryPasswordChangeDenied' + 1305 = 'DirectoryPhotoFailure' } # Keep these reads unfiltered. Besides making archived and current logs behave diff --git a/src/SGU.AuthBroker.Core/Profiles/InstitutionalProfile.cs b/src/SGU.AuthBroker.Core/Profiles/InstitutionalProfile.cs index b3af73f..2b97056 100644 --- a/src/SGU.AuthBroker.Core/Profiles/InstitutionalProfile.cs +++ b/src/SGU.AuthBroker.Core/Profiles/InstitutionalProfile.cs @@ -13,7 +13,8 @@ public sealed record InstitutionalProfile( string? City = null, string? State = null, string? PostalCode = null, - InstitutionalGender? Gender = null) + InstitutionalGender? Gender = null, + byte[]? ThumbnailPhoto = null) { public bool HasValues => EmployeeNumber is not null || @@ -28,7 +29,8 @@ public sealed record InstitutionalProfile( City is not null || State is not null || PostalCode is not null || - Gender is not null; + Gender is not null || + ThumbnailPhoto is not null; public InstitutionalProfile Overlay(InstitutionalProfile? values) => values is null @@ -47,6 +49,7 @@ public sealed record InstitutionalProfile( City = values.City ?? City, State = values.State ?? State, PostalCode = values.PostalCode ?? PostalCode, - Gender = values.Gender ?? Gender + Gender = values.Gender ?? Gender, + ThumbnailPhoto = values.ThumbnailPhoto ?? ThumbnailPhoto }; } diff --git a/src/SGU.AuthBroker/BrokerEventIds.cs b/src/SGU.AuthBroker/BrokerEventIds.cs index c06eff7..b8fb28a 100644 --- a/src/SGU.AuthBroker/BrokerEventIds.cs +++ b/src/SGU.AuthBroker/BrokerEventIds.cs @@ -17,10 +17,13 @@ internal static class BrokerEventIds internal static readonly EventId ProfileEnrichmentTimeout = new(1202, nameof(ProfileEnrichmentTimeout)); internal static readonly EventId ProfileEnrichmentFailure = new(1203, nameof(ProfileEnrichmentFailure)); internal static readonly EventId ProfilePageUnavailable = new(1204, nameof(ProfilePageUnavailable)); + internal static readonly EventId ProfilePhotoUnavailable = new(1205, nameof(ProfilePhotoUnavailable)); + internal static readonly EventId ProfilePhotoInvalid = new(1206, nameof(ProfilePhotoInvalid)); internal static readonly EventId DirectorySynchronizationFailure = new(1300, nameof(DirectorySynchronizationFailure)); internal static readonly EventId DirectoryOptionalMetadataFailure = new(1301, nameof(DirectoryOptionalMetadataFailure)); internal static readonly EventId DirectoryGroupMembershipFailure = new(1302, nameof(DirectoryGroupMembershipFailure)); internal static readonly EventId DirectoryRoleGroupMembershipAdded = new(1303, nameof(DirectoryRoleGroupMembershipAdded)); internal static readonly EventId DirectoryPasswordChangeDenied = new(1304, nameof(DirectoryPasswordChangeDenied)); + internal static readonly EventId DirectoryPhotoFailure = new(1305, nameof(DirectoryPhotoFailure)); } diff --git a/src/SGU.AuthBroker/SGU.AuthBroker.csproj b/src/SGU.AuthBroker/SGU.AuthBroker.csproj index acf6143..3dd674b 100644 --- a/src/SGU.AuthBroker/SGU.AuthBroker.csproj +++ b/src/SGU.AuthBroker/SGU.AuthBroker.csproj @@ -11,6 +11,7 @@ + diff --git a/src/SGU.AuthBroker/Services/ActiveDirectorySynchronizer.cs b/src/SGU.AuthBroker/Services/ActiveDirectorySynchronizer.cs index e26adce..5aad985 100644 --- a/src/SGU.AuthBroker/Services/ActiveDirectorySynchronizer.cs +++ b/src/SGU.AuthBroker/Services/ActiveDirectorySynchronizer.cs @@ -142,6 +142,7 @@ public sealed class ActiveDirectorySynchronizer( user.CommitChanges(); TryApplyProfile(user, identity, profile, options.DefaultCompany, logger); + TryApplyPhoto(user, identity.UserName, profile?.ThumbnailPhoto); TryEnsureRemoteDesktopGroupMembership(user, identity.UserName); return new DirectorySyncResult( @@ -264,6 +265,42 @@ public sealed class ActiveDirectorySynchronizer( } } + private void TryApplyPhoto(DirectoryEntry user, string institutionalUser, byte[]? photo) + { + if (photo is null) + { + return; + } + + try + { + if (user.Properties["thumbnailPhoto"].Value is byte[] existing && + existing.AsSpan().SequenceEqual(photo)) + { + return; + } + + user.Properties["thumbnailPhoto"].Value = photo; + user.CommitChanges(); + } + catch (Exception exception) + { + logger.LogWarning( + BrokerEventIds.DirectoryPhotoFailure, + exception, + "Optional Active Directory thumbnailPhoto could not be committed for {InstitutionalUser}; account synchronization remains completed.", + institutionalUser); + try + { + user.RefreshCache(); + } + catch + { + // Photo metadata must not change the successful authentication result. + } + } + } + private static void SetGenderMetadata( DirectoryEntry entry, InstitutionalGender? gender, diff --git a/src/SGU.AuthBroker/Services/NtlmCredentialValidator.cs b/src/SGU.AuthBroker/Services/NtlmCredentialValidator.cs index e6297d2..60b0aab 100644 --- a/src/SGU.AuthBroker/Services/NtlmCredentialValidator.cs +++ b/src/SGU.AuthBroker/Services/NtlmCredentialValidator.cs @@ -1,4 +1,6 @@ using System.Diagnostics; +using System.Drawing; +using System.Drawing.Imaging; using System.Net; using System.Text; using System.Text.Json; @@ -11,6 +13,9 @@ namespace SGU.AuthBroker.Services; public sealed class NtlmCredentialValidator : INtlmCredentialValidator { + private const int MaximumPhotoBytes = 100 * 1024; + private const int MinimumPhotoBytes = 128; + private static readonly TimeSpan PhotoTimeout = TimeSpan.FromSeconds(3); private readonly NtlmOptions options; private readonly ILogger logger; private readonly Func handlerFactory; @@ -353,6 +358,20 @@ public sealed class NtlmCredentialValidator : INtlmCredentialValidator elapsed).ConfigureAwait(false); } + if (string.Equals(profile?.EmployeeNumber, identity.NumericId, StringComparison.Ordinal)) + { + byte[]? photo = await TryFetchPhotoAsync( + client, + identity, + allowedHosts, + timeout.Token, + cancellationToken).ConfigureAwait(false); + if (photo is not null) + { + profile = profile! with { ThumbnailPhoto = photo }; + } + } + if (profile is null) { logger.LogWarning( @@ -680,6 +699,135 @@ public sealed class NtlmCredentialValidator : INtlmCredentialValidator return null; } + private async Task TryFetchPhotoAsync( + HttpClient client, + UserIdentity identity, + HashSet allowedHosts, + CancellationToken profileTimeoutToken, + CancellationToken requestCancellationToken) + { + // Only a number verified against the authenticated profile is used. + // Never follow an image URL supplied by SGU HTML to an arbitrary host. + int photoType = identity.Role == InstitutionalRole.Student ? 1 : 2; + Uri photoUri = GetProfileUri( + $"/psulsa/gadmon/admonPersonal/ashx/Fotografia.ashx?id={identity.NumericId}&tp={photoType}"); + if (!IsAllowedHttpsUri(photoUri, allowedHosts)) + { + return null; + } + + using CancellationTokenSource timeout = CancellationTokenSource.CreateLinkedTokenSource(profileTimeoutToken); + timeout.CancelAfter(PhotoTimeout); + try + { + using HttpRequestMessage request = new(HttpMethod.Get, photoUri); + using HttpResponseMessage response = await client.SendAsync( + request, + HttpCompletionOption.ResponseHeadersRead, + timeout.Token).ConfigureAwait(false); + if (response.StatusCode != HttpStatusCode.OK) + { + logger.LogWarning( + BrokerEventIds.ProfilePhotoUnavailable, + "SGU photo for role {Role} returned HTTP {StatusCode}; preserving existing Active Directory photo.", + identity.Role, + (int)response.StatusCode); + return null; + } + + if (!string.Equals( + response.Content.Headers.ContentType?.MediaType, + "image/jpeg", + StringComparison.OrdinalIgnoreCase) || + response.Content.Headers.ContentLength is > MaximumPhotoBytes) + { + logger.LogWarning( + BrokerEventIds.ProfilePhotoInvalid, + "SGU photo for role {Role} had an unsupported media type or size; preserving existing Active Directory photo.", + identity.Role); + return null; + } + + await using Stream stream = await response.Content.ReadAsStreamAsync(timeout.Token) + .ConfigureAwait(false); + using MemoryStream buffer = new(); + byte[] chunk = new byte[8192]; + while (true) + { + int read = await stream.ReadAsync(chunk.AsMemory(), timeout.Token).ConfigureAwait(false); + if (read == 0) + { + break; + } + + if (buffer.Length + read > MaximumPhotoBytes) + { + logger.LogWarning( + BrokerEventIds.ProfilePhotoInvalid, + "SGU photo for role {Role} exceeded the size limit; preserving existing Active Directory photo.", + identity.Role); + return null; + } + + buffer.Write(chunk, 0, read); + } + + byte[] photo = buffer.ToArray(); + if (photo.Length < MinimumPhotoBytes || + photo[0] != 0xFF || photo[1] != 0xD8 || photo[2] != 0xFF || + photo[^2] != 0xFF || photo[^1] != 0xD9 || + !IsDecodableJpeg(photo)) + { + logger.LogWarning( + BrokerEventIds.ProfilePhotoInvalid, + "SGU photo for role {Role} was not a valid JPEG payload; preserving existing Active Directory photo.", + identity.Role); + return null; + } + + return photo; + } + catch (OperationCanceledException) when (requestCancellationToken.IsCancellationRequested) + { + throw; + } + catch (OperationCanceledException) + { + logger.LogWarning( + BrokerEventIds.ProfilePhotoUnavailable, + "SGU photo request for role {Role} timed out; preserving existing Active Directory photo.", + identity.Role); + } + catch (Exception exception) + { + logger.LogWarning( + BrokerEventIds.ProfilePhotoUnavailable, + exception, + "SGU photo request for role {Role} failed; preserving existing Active Directory photo.", + identity.Role); + } + + return null; + } + + private static bool IsDecodableJpeg(byte[] photo) + { + try + { + using MemoryStream input = new(photo, writable: false); + using Image image = Image.FromStream(input, useEmbeddedColorManagement: false, validateImageData: true); + return image.RawFormat.Guid == ImageFormat.Jpeg.Guid && + image.Width is >= 1 and <= 4096 && + image.Height is >= 1 and <= 4096; + } + catch (Exception) + { + // Image decoding is optional metadata validation; malformed input + // from the portal must never interrupt account provisioning. + return false; + } + } + private async Task TryPostProfilePageMethodAsync( HttpClient client, Uri requestedUri, diff --git a/tests/SGU.AuthBroker.Tests/NtlmCredentialValidatorTests.cs b/tests/SGU.AuthBroker.Tests/NtlmCredentialValidatorTests.cs index bebcffd..59a8c22 100644 --- a/tests/SGU.AuthBroker.Tests/NtlmCredentialValidatorTests.cs +++ b/tests/SGU.AuthBroker.Tests/NtlmCredentialValidatorTests.cs @@ -1,5 +1,7 @@ using System.Net; using System.Net.Http.Headers; +using System.Drawing; +using System.Drawing.Imaging; using Microsoft.Extensions.Logging.Abstractions; using SGU.AuthBroker.Core.Authentication; using SGU.AuthBroker.Core.Identity; @@ -163,7 +165,8 @@ public sealed class NtlmCredentialValidatorTests """), JsonResponse(""" {"d":[{"p_IdCP":"090001","p_Nombre":"FLORIDA","p_Cp":"01000"}]} - """)); + """), + PhotoResponse(TestJpeg())); NtlmCredentialValidator validator = CreateValidator(handler); NtlmValidationResult result = await validator.ValidateAsync( @@ -184,6 +187,7 @@ public sealed class NtlmCredentialValidatorTests Assert.Equal("Ciudad de México", result.Profile.State); Assert.Equal("01000", result.Profile.PostalCode); Assert.Equal(InstitutionalGender.Female, result.Profile.Gender); + Assert.Equal(TestJpeg(), result.Profile.ThumbnailPhoto); Assert.Equal( [ "/psulsa/", @@ -193,7 +197,8 @@ public sealed class NtlmCredentialValidatorTests "/psulsa/gadmon/capitalhumano/datos/ubicacion.aspx", "/psulsa/gadmon/capitalhumano/datos/ubicacion.aspx/GetDireccion", "/psulsa/gadmon/capitalhumano/datos/ubicacion.aspx/GetLocalidadListado", - "/psulsa/gadmon/capitalhumano/datos/ubicacion.aspx/GetColoniasListado" + "/psulsa/gadmon/capitalhumano/datos/ubicacion.aspx/GetColoniasListado", + "/psulsa/gadmon/admonPersonal/ashx/Fotografia.ashx" ], handler.RequestPaths); Assert.Equal("{\"CodigoPostal\":\"01000\"}", handler.RequestBodies[5]); @@ -201,6 +206,9 @@ public sealed class NtlmCredentialValidatorTests Assert.Equal( "{\"pIdEstado\":\"\",\"pLocalidad\":\"\",\"CodigoPostal\":\"01000\"}", handler.RequestBodies[7]); + Assert.Equal( + "https://sgu.example/psulsa/gadmon/admonPersonal/ashx/Fotografia.ashx?id=017045&tp=2", + handler.RequestUris[8]); } [Fact] @@ -278,7 +286,8 @@ public sealed class NtlmCredentialValidatorTests """), JsonResponse(""" {"d":[{"p_IdCP":"090001","p_Nombre":"FLORIDA","p_Cp":"01000"}]} - """)); + """), + Response(HttpStatusCode.NotFound)); NtlmCredentialValidator validator = CreateValidator(handler); NtlmValidationResult result = await validator.ValidateAsync( @@ -311,9 +320,13 @@ public sealed class NtlmCredentialValidatorTests "/psulsa/gadmon/capitalhumano/datos/ubicacion.aspx", "/psulsa/gadmon/capitalhumano/datos/ubicacion.aspx/GetDireccion", "/psulsa/gadmon/capitalhumano/datos/ubicacion.aspx/GetLocalidadListado", - "/psulsa/gadmon/capitalhumano/datos/ubicacion.aspx/GetColoniasListado" + "/psulsa/gadmon/capitalhumano/datos/ubicacion.aspx/GetColoniasListado", + "/psulsa/gadmon/admonPersonal/ashx/Fotografia.ashx" ], handler.RequestPaths); + Assert.Equal( + "https://sgu.example/psulsa/gadmon/admonPersonal/ashx/Fotografia.ashx?id=123456&tp=2", + handler.RequestUris[9]); } [Fact] @@ -347,6 +360,109 @@ public sealed class NtlmCredentialValidatorTests handler.RequestPaths[3]); } + [Fact] + public async Task VerifiedStudentReceivesPhotoFromAuthenticatedSguSession() + { + byte[] jpeg = TestJpeg(); + SequenceHandler handler = new( + Challenge(), + Response(HttpStatusCode.OK), + Response(HttpStatusCode.OK, + "123456"), + PhotoResponse(jpeg)); + NtlmValidationResult result = await CreateValidator(handler).ValidateAsync( + Student, + "test-password", + TestContext.Current.CancellationToken); + + Assert.Equal(NtlmValidationStatus.Valid, result.Status); + Assert.Equal(jpeg, result.Profile?.ThumbnailPhoto); + Assert.Equal( + "https://sgu.example/psulsa/gadmon/admonPersonal/ashx/Fotografia.ashx?id=123456&tp=1", + handler.RequestUris[3]); + } + + [Theory] + [InlineData("text/html")] + [InlineData("image/jpeg")] + public async Task InvalidStudentPhotoDoesNotBlockAuthentication(string mediaType) + { + byte[] invalid = new byte[150]; + invalid[0] = 0xFF; + invalid[1] = 0xD8; + invalid[2] = 0xFF; + invalid[^2] = 0xFF; + invalid[^1] = 0xD9; + SequenceHandler handler = new( + Challenge(), + Response(HttpStatusCode.OK), + Response(HttpStatusCode.OK, + "123456"), + PhotoResponse(invalid, mediaType)); + NtlmValidationResult result = await CreateValidator(handler).ValidateAsync( + Student, + "test-password", + TestContext.Current.CancellationToken); + + Assert.Equal(NtlmValidationStatus.Valid, result.Status); + Assert.Equal("123456", result.Profile?.EmployeeNumber); + Assert.Null(result.Profile?.ThumbnailPhoto); + } + + [Fact] + public async Task OversizedStudentPhotoDoesNotBlockAuthentication() + { + SequenceHandler handler = new( + Challenge(), + Response(HttpStatusCode.OK), + Response(HttpStatusCode.OK, + "123456"), + PhotoResponse(new byte[100 * 1024 + 1])); + NtlmValidationResult result = await CreateValidator(handler).ValidateAsync( + Student, + "test-password", + TestContext.Current.CancellationToken); + + Assert.Equal(NtlmValidationStatus.Valid, result.Status); + Assert.Equal("123456", result.Profile?.EmployeeNumber); + Assert.Null(result.Profile?.ThumbnailPhoto); + } + + [Fact] + public async Task UnverifiedStudentNumberNeverFetchesPhoto() + { + SequenceHandler handler = new( + Challenge(), + Response(HttpStatusCode.OK), + Response(HttpStatusCode.OK, + "654321")); + NtlmValidationResult result = await CreateValidator(handler).ValidateAsync( + Student, + "test-password", + TestContext.Current.CancellationToken); + + Assert.Equal(NtlmValidationStatus.Valid, result.Status); + Assert.Null(result.Profile); + Assert.Equal(3, handler.RequestUris.Count); + } + + private static byte[] TestJpeg() + { + using Bitmap bitmap = new(16, 16); + using MemoryStream output = new(); + bitmap.Save(output, ImageFormat.Jpeg); + return output.ToArray(); + } + + private static HttpResponseMessage PhotoResponse(byte[] bytes, string mediaType = "image/jpeg") => + new(HttpStatusCode.OK) + { + Content = new ByteArrayContent(bytes) + { + Headers = { ContentType = new MediaTypeHeaderValue(mediaType) } + } + }; + private static NtlmCredentialValidator CreateValidator(SequenceHandler handler) { BrokerOptions options = new() @@ -406,6 +522,8 @@ public sealed class NtlmCredentialValidatorTests public List RequestPaths { get; } = []; + public List RequestUris { get; } = []; + public List RequestBodies { get; } = []; protected override Task SendAsync( @@ -414,6 +532,7 @@ public sealed class NtlmCredentialValidatorTests { cancellationToken.ThrowIfCancellationRequested(); RequestPaths.Add(request.RequestUri!.AbsolutePath); + RequestUris.Add(request.RequestUri.AbsoluteUri); RequestBodies.Add(request.Content is null ? null : request.Content.ReadAsStringAsync(cancellationToken).GetAwaiter().GetResult());