/* * 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.Net; using System.Net.Http; using System.Net.Http.Headers; using System.Net.Mail; using Polly; using Polly.Extensions.Http; #if NET using Microsoft.Extensions.Http.Resilience; #endif namespace OpenIddict.Validation.SystemNetHttp; /// /// Provides various settings needed to configure the OpenIddict validation/System.Net.Http integration. /// public sealed class OpenIddictValidationSystemNetHttpOptions { /// /// Gets or sets the HTTP Polly error policy used by the internal OpenIddict HTTP clients. /// /// /// Note: on .NET 8.0 and higher, this property is set to by default. /// public IAsyncPolicy? HttpErrorPolicy { get; set; } #if !NET = HttpPolicyExtensions.HandleTransientHttpError() .OrResult(static response => response.StatusCode is HttpStatusCode.NotFound) .WaitAndRetryAsync(4, static attempt => TimeSpan.FromSeconds(Math.Pow(2, attempt))); #endif #if NET /// /// Gets or sets the HTTP resilience pipeline used by the internal OpenIddict HTTP clients. /// /// /// Note: this property is not used when /// is explicitly set to a non- value. /// public ResiliencePipeline? HttpResiliencePipeline { get; set; } = new ResiliencePipelineBuilder() .AddRetry(new HttpRetryStrategyOptions { DelayGenerator = static arguments => new( TimeSpan.FromSeconds(Math.Pow(2, arguments.AttemptNumber))), MaxRetryAttempts = 4, ShouldHandle = static arguments => new( HttpClientResiliencePredicates.IsTransient(arguments.Outcome) || arguments.Outcome.Result?.StatusCode is HttpStatusCode.NotFound) }) .Build(); #endif /// /// Gets or sets the contact mail address used in the "From" header that is /// attached to the backchannel HTTP requests sent to the authorization server. /// public MailAddress? ContactAddress { get; set; } /// /// Gets or sets the product information used in the "User-Agent" header that is /// attached to the backchannel HTTP requests sent to the authorization server. /// public ProductInfoHeaderValue? ProductInformation { get; set; } /// /// Gets or sets a boolean indicating whether the raw payloads of the HTTP responses returned by /// the remote server should be included in the logs when an invalid or unexpected response is received. /// /// /// Note: raw payloads may contain sensitive data (e.g access tokens or refresh tokens). /// As such, this option should only be enabled in development environments. /// public bool EnableSensitivePayloadLogging { get; set; } /// /// Gets or sets the decompression methods the OpenIddict validation/System.Net.Http integration /// is allowed to use to decode the compressed HTTP responses returned by the remote server. /// /// /// Note: while HTTP compression is never opted-in by default, encoded responses returned by servers /// that enforce content compression are still decoded. This property can be used to exclude specific /// algorithms (e.g to mitigate a vulnerability affecting one of the decoders used by the runtime). /// By default, all the algorithms supported by OpenIddict are allowed. /// public DecompressionMethods AllowedDecompressionMethods { get; set; } = ~DecompressionMethods.None; /// /// Gets the user-defined actions used to amend the /// instances created by the OpenIddict validation/System.Net.Http integration. /// public List> HttpClientActions { get; } = []; /// /// Gets the user-defined actions used to amend the /// instances created by the OpenIddict validation/System.Net.Http integration. /// public List> HttpClientHandlerActions { get; } = []; }