/* * Licensed under the Apache License, Version 2.0 (http://www.apache.org/licenses/LICENSE-2.0) * See https://github.com/openiddict/openiddict-core for more information concerning * the license and the contributors participating to this project. */ using System.Globalization; using System.IO.Compression; using System.Net; using System.Net.Http; using System.Text; using Microsoft.Extensions.Logging; using Microsoft.Extensions.Options; using Moq; using Xunit; using static OpenIddict.Validation.OpenIddictValidationEvents; using static OpenIddict.Validation.SystemNetHttp.OpenIddictValidationSystemNetHttpConstants; using static OpenIddict.Validation.SystemNetHttp.OpenIddictValidationSystemNetHttpHandlers; namespace OpenIddict.Validation.SystemNetHttp.Tests; public class OpenIddictValidationSystemNetHttpHandlersTests { private const string Payload = "SENSITIVE_PAYLOAD"; public static TheoryData SupportedEncodings => new() { { ContentEncodings.Gzip, DecompressionMethods.GZip }, #if SUPPORTS_ZLIB_COMPRESSION { ContentEncodings.Deflate, DecompressionMethods.Deflate }, #endif #if SUPPORTS_BROTLI_COMPRESSION { ContentEncodings.Brotli, DecompressionMethods.Brotli } #endif }; [Theory] [MemberData(nameof(SupportedEncodings))] public async Task DecompressResponseContent_DecompressesContentWhenMethodIsAllowed(string encoding, DecompressionMethods method) { // Arrange using var response = CreateCompressedResponse(encoding); var context = new PrepareConfigurationRequestContext( CreateTransaction(Mock.Of>(), response)); var handler = new DecompressResponseContent(CreateOptions(method)); // Act await handler.HandleAsync(context); // Assert Assert.False(context.IsRejected); Assert.Empty(response.Content.Headers.ContentEncoding); Assert.Equal(Payload, await response.Content.ReadAsStringAsync()); } [Theory] [MemberData(nameof(SupportedEncodings))] public async Task DecompressResponseContent_RejectsContentWhenMethodIsNotAllowed(string encoding, DecompressionMethods method) { // Arrange using var response = CreateCompressedResponse(encoding); var context = new PrepareConfigurationRequestContext( CreateTransaction(Mock.Of>(), response)); // Note: all the methods except the one used to encode the response are allowed. var handler = new DecompressResponseContent(CreateOptions(~method)); // Act await handler.HandleAsync(context); // Assert Assert.True(context.IsRejected); Assert.Equal(Errors.ServerError, context.Error); Assert.Equal(SR.GetResourceString(SR.ID2211), context.ErrorDescription); } [Theory] [MemberData(nameof(SupportedEncodings))] public async Task DecompressResponseContent_DecompressesContentWhenAllMethodsAreAllowed(string encoding, DecompressionMethods method) { // Arrange using var response = CreateCompressedResponse(encoding); var context = new PrepareConfigurationRequestContext( CreateTransaction(Mock.Of>(), response)); var handler = new DecompressResponseContent( CreateOptions(~DecompressionMethods.None)); // Act await handler.HandleAsync(context); // Assert Assert.True((~DecompressionMethods.None).HasFlag(method)); Assert.False(context.IsRejected); Assert.Empty(response.Content.Headers.ContentEncoding); Assert.Equal(Payload, await response.Content.ReadAsStringAsync()); } [Theory] [InlineData(false)] [InlineData(true)] public async Task ExtractJsonHttpResponse_OnlyLogsPayloadWhenSensitivePayloadLoggingIsEnabled(bool enabled) { // Arrange var logger = new Mock>(); using var response = new HttpResponseMessage(HttpStatusCode.OK) { // Note: the payload is deliberately malformed to trigger the JSON deserialization error. Content = new StringContent("{\"access_token\":\"" + Payload + "\"", Encoding.UTF8, "application/json") }; var context = new PrepareConfigurationRequestContext(CreateTransaction(logger.Object, response)); var handler = new ExtractJsonHttpResponse(CreateOptions(enabled)); // Act await handler.HandleAsync(context); // Assert Assert.True(context.IsRejected); Assert.Equal(Errors.ServerError, context.Error); logger.Verify(logger => logger.Log( LogLevel.Error, It.Is(id => id.Id == 6183), It.Is((state, type) => Convert.ToString(state, CultureInfo.InvariantCulture)!.Contains(Payload) == enabled), It.IsAny(), It.IsAny>()), Times.Once()); } [Theory] [InlineData(false)] [InlineData(true)] public async Task ValidateHttpResponse_OnlyLogsPayloadOfGenericErrorsWhenSensitivePayloadLoggingIsEnabled(bool enabled) { // Arrange var logger = new Mock>(); using var response = new HttpResponseMessage(HttpStatusCode.InternalServerError) { Content = new StringContent(Payload, Encoding.UTF8, "text/plain") }; var context = new PrepareConfigurationRequestContext(CreateTransaction(logger.Object, response)); var handler = new ValidateHttpResponse(CreateOptions(enabled)); // Act await handler.HandleAsync(context); // Assert Assert.True(context.IsRejected); Assert.Equal(Errors.ServerError, context.Error); logger.Verify(logger => logger.Log( LogLevel.Error, It.Is(id => id.Id == 6184), It.Is((state, type) => Convert.ToString(state, CultureInfo.InvariantCulture)!.Contains(Payload) == enabled), It.IsAny(), It.IsAny>()), Times.Once()); } [Theory] [InlineData(false)] [InlineData(true)] public async Task ValidateHttpResponse_OnlyLogsPayloadOfUnsupportedResponsesWhenSensitivePayloadLoggingIsEnabled(bool enabled) { // Arrange var logger = new Mock>(); using var response = new HttpResponseMessage(HttpStatusCode.OK) { Content = new StringContent(Payload, Encoding.UTF8, "text/plain") }; var context = new PrepareConfigurationRequestContext(CreateTransaction(logger.Object, response)); var handler = new ValidateHttpResponse(CreateOptions(enabled)); // Act await handler.HandleAsync(context); // Assert Assert.True(context.IsRejected); Assert.Equal(Errors.ServerError, context.Error); logger.Verify(logger => logger.Log( LogLevel.Error, It.Is(id => id.Id == 6185), It.Is((state, type) => Convert.ToString(state, CultureInfo.InvariantCulture)!.Contains(Payload) == enabled), It.IsAny(), It.IsAny>()), Times.Once()); } private static HttpResponseMessage CreateCompressedResponse(string encoding) { using var buffer = new MemoryStream(); using (Stream stream = encoding switch { ContentEncodings.Gzip => new GZipStream(buffer, CompressionMode.Compress, leaveOpen: true), #if NET ContentEncodings.Deflate => new ZLibStream(buffer, CompressionMode.Compress, leaveOpen: true), ContentEncodings.Brotli => new BrotliStream(buffer, CompressionMode.Compress, leaveOpen: true), #endif _ => throw new ArgumentOutOfRangeException(nameof(encoding)) }) { var bytes = Encoding.UTF8.GetBytes(Payload); stream.Write(bytes, 0, bytes.Length); } var response = new HttpResponseMessage(HttpStatusCode.OK) { Content = new ByteArrayContent(buffer.ToArray()) }; response.Content.Headers.ContentEncoding.Add(encoding); return response; } private static IOptionsMonitor CreateOptions(bool enabled) => Mock.Of>(monitor => monitor.CurrentValue == new OpenIddictValidationSystemNetHttpOptions { EnableSensitivePayloadLogging = enabled }); private static IOptionsMonitor CreateOptions(DecompressionMethods methods) => Mock.Of>(monitor => monitor.CurrentValue == new OpenIddictValidationSystemNetHttpOptions { AllowedDecompressionMethods = methods }); private static OpenIddictValidationTransaction CreateTransaction( ILogger logger, HttpResponseMessage response) { var transaction = new OpenIddictValidationTransaction { CancellationToken = CancellationToken.None, Logger = logger, Options = new OpenIddictValidationOptions() }; transaction.Properties[typeof(HttpResponseMessage).FullName!] = response; return transaction; } }