Kévin Chalet
2 years ago
18 changed files with 1674 additions and 4 deletions
@ -0,0 +1,133 @@ |
|||
/* |
|||
* 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.Collections.Immutable; |
|||
using System.Diagnostics; |
|||
using System.Net.Http; |
|||
using System.Net.Http.Headers; |
|||
using System.Text; |
|||
|
|||
namespace OpenIddict.Client.SystemNetHttp; |
|||
|
|||
public static partial class OpenIddictClientSystemNetHttpHandlers |
|||
{ |
|||
public static class Revocation |
|||
{ |
|||
public static ImmutableArray<OpenIddictClientHandlerDescriptor> DefaultHandlers { get; } = [ |
|||
/* |
|||
* Revocation request processing: |
|||
*/ |
|||
CreateHttpClient<PrepareRevocationRequestContext>.Descriptor, |
|||
PreparePostHttpRequest<PrepareRevocationRequestContext>.Descriptor, |
|||
AttachHttpVersion<PrepareRevocationRequestContext>.Descriptor, |
|||
AttachJsonAcceptHeaders<PrepareRevocationRequestContext>.Descriptor, |
|||
AttachUserAgentHeader<PrepareRevocationRequestContext>.Descriptor, |
|||
AttachFromHeader<PrepareRevocationRequestContext>.Descriptor, |
|||
AttachBasicAuthenticationCredentials.Descriptor, |
|||
AttachHttpParameters<PrepareRevocationRequestContext>.Descriptor, |
|||
SendHttpRequest<ApplyRevocationRequestContext>.Descriptor, |
|||
DisposeHttpRequest<ApplyRevocationRequestContext>.Descriptor, |
|||
|
|||
/* |
|||
* Revocation response processing: |
|||
*/ |
|||
DecompressResponseContent<ExtractRevocationResponseContext>.Descriptor, |
|||
ExtractJsonHttpResponse<ExtractRevocationResponseContext>.Descriptor, |
|||
ExtractWwwAuthenticateHeader<ExtractRevocationResponseContext>.Descriptor, |
|||
ValidateHttpResponse<ExtractRevocationResponseContext>.Descriptor, |
|||
DisposeHttpResponse<ExtractRevocationResponseContext>.Descriptor |
|||
]; |
|||
|
|||
/// <summary>
|
|||
/// Contains the logic responsible for attaching the client credentials to the HTTP Authorization header.
|
|||
/// </summary>
|
|||
public sealed class AttachBasicAuthenticationCredentials : IOpenIddictClientHandler<PrepareRevocationRequestContext> |
|||
{ |
|||
/// <summary>
|
|||
/// Gets the default descriptor definition assigned to this handler.
|
|||
/// </summary>
|
|||
public static OpenIddictClientHandlerDescriptor Descriptor { get; } |
|||
= OpenIddictClientHandlerDescriptor.CreateBuilder<PrepareRevocationRequestContext>() |
|||
.AddFilter<RequireHttpMetadataUri>() |
|||
.UseSingletonHandler<AttachBasicAuthenticationCredentials>() |
|||
.SetOrder(AttachHttpParameters<PrepareRevocationRequestContext>.Descriptor.Order - 500) |
|||
.SetType(OpenIddictClientHandlerType.BuiltIn) |
|||
.Build(); |
|||
|
|||
/// <inheritdoc/>
|
|||
public ValueTask HandleAsync(PrepareRevocationRequestContext context) |
|||
{ |
|||
if (context is null) |
|||
{ |
|||
throw new ArgumentNullException(nameof(context)); |
|||
} |
|||
|
|||
Debug.Assert(context.Request is not null, SR.GetResourceString(SR.ID4008)); |
|||
|
|||
// This handler only applies to System.Net.Http requests. If the HTTP request cannot be resolved,
|
|||
// this may indicate that the request was incorrectly processed by another client stack.
|
|||
var request = context.Transaction.GetHttpRequestMessage() ?? |
|||
throw new InvalidOperationException(SR.GetResourceString(SR.ID0173)); |
|||
|
|||
// The OAuth 2.0 specification recommends sending the client credentials using basic authentication.
|
|||
// However, this authentication method is known to have severe compatibility/interoperability issues:
|
|||
//
|
|||
// - While restricted to clients that have been given a secret (i.e confidential clients) by the
|
|||
// specification, basic authentication is also sometimes required by server implementations for
|
|||
// public clients that don't have a client secret: in this case, an empty password is used and
|
|||
// the client identifier is sent alone in the Authorization header (instead of being sent using
|
|||
// the standard "client_id" parameter present in the request body).
|
|||
//
|
|||
// - While the OAuth 2.0 specification requires that the client credentials be formURL-encoded
|
|||
// before being base64-encoded, many implementations are known to implement a non-standard
|
|||
// encoding scheme, where neither the client_id nor the client_secret are formURL-encoded.
|
|||
//
|
|||
// To guarantee that the OpenIddict implementation can be used with most servers implementions,
|
|||
// basic authentication is only used when a client secret is present and client_secret_post is
|
|||
// always preferred when it's explicitly listed as a supported client authentication method.
|
|||
// If client_secret_post is not listed or if the server returned an empty methods list,
|
|||
// client_secret_basic is always used, as it MUST be implemented by all OAuth 2.0 servers.
|
|||
//
|
|||
// See https://tools.ietf.org/html/rfc8414#section-2
|
|||
// and https://tools.ietf.org/html/rfc6749#section-2.3.1 for more information.
|
|||
if (request.Headers.Authorization is null && |
|||
!string.IsNullOrEmpty(context.Request.ClientId) && |
|||
!string.IsNullOrEmpty(context.Request.ClientSecret) && |
|||
UseBasicAuthentication(context.Configuration)) |
|||
{ |
|||
// Important: the credentials MUST be formURL-encoded before being base64-encoded.
|
|||
var credentials = Convert.ToBase64String(Encoding.ASCII.GetBytes(new StringBuilder() |
|||
.Append(EscapeDataString(context.Request.ClientId)) |
|||
.Append(':') |
|||
.Append(EscapeDataString(context.Request.ClientSecret)) |
|||
.ToString())); |
|||
|
|||
// Attach the authorization header containing the client credentials to the HTTP request.
|
|||
request.Headers.Authorization = new AuthenticationHeaderValue(Schemes.Basic, credentials); |
|||
|
|||
// Remove the client credentials from the request payload to ensure they are not sent twice.
|
|||
context.Request.ClientId = context.Request.ClientSecret = null; |
|||
} |
|||
|
|||
return default; |
|||
|
|||
static bool UseBasicAuthentication(OpenIddictConfiguration configuration) |
|||
=> configuration.RevocationEndpointAuthMethodsSupported switch |
|||
{ |
|||
// If at least one authentication method was explicit added, only use basic authentication
|
|||
// if it's supported AND if client_secret_post is not supported or enabled by the server.
|
|||
{ Count: > 0 } methods => methods.Contains(ClientAuthenticationMethods.ClientSecretBasic) && |
|||
!methods.Contains(ClientAuthenticationMethods.ClientSecretPost), |
|||
|
|||
// Otherwise, if no authentication method was explicit added, assume only basic is supported.
|
|||
{ Count: _ } => true |
|||
}; |
|||
|
|||
static string EscapeDataString(string value) => Uri.EscapeDataString(value).Replace("%20", "+"); |
|||
} |
|||
} |
|||
} |
|||
} |
|||
@ -0,0 +1,148 @@ |
|||
/* |
|||
* 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.Security.Claims; |
|||
|
|||
namespace OpenIddict.Client; |
|||
|
|||
public static partial class OpenIddictClientEvents |
|||
{ |
|||
/// <summary>
|
|||
/// Represents an event called for each request to the revocation endpoint
|
|||
/// to give the user code a chance to add parameters to the revocation request.
|
|||
/// </summary>
|
|||
public sealed class PrepareRevocationRequestContext : BaseExternalContext |
|||
{ |
|||
/// <summary>
|
|||
/// Creates a new instance of the <see cref="PrepareRevocationRequestContext"/> class.
|
|||
/// </summary>
|
|||
public PrepareRevocationRequestContext(OpenIddictClientTransaction transaction) |
|||
: base(transaction) |
|||
{ |
|||
} |
|||
|
|||
/// <summary>
|
|||
/// Gets or sets the request.
|
|||
/// </summary>
|
|||
public OpenIddictRequest Request |
|||
{ |
|||
get => Transaction.Request!; |
|||
set => Transaction.Request = value; |
|||
} |
|||
|
|||
/// <summary>
|
|||
/// Gets or sets the token sent to the revocation endpoint.
|
|||
/// </summary>
|
|||
public string? Token |
|||
{ |
|||
get => Request.Token; |
|||
set => Request.Token = value; |
|||
} |
|||
|
|||
/// <summary>
|
|||
/// Gets or sets the token type sent to the revocation endpoint.
|
|||
/// </summary>
|
|||
public string? TokenTypeHint |
|||
{ |
|||
get => Request.TokenTypeHint; |
|||
set => Request.TokenTypeHint = value; |
|||
} |
|||
} |
|||
|
|||
/// <summary>
|
|||
/// Represents an event called for each request to the revocation endpoint
|
|||
/// to send the revocation request to the remote authorization server.
|
|||
/// </summary>
|
|||
public sealed class ApplyRevocationRequestContext : BaseExternalContext |
|||
{ |
|||
/// <summary>
|
|||
/// Creates a new instance of the <see cref="ApplyRevocationRequestContext"/> class.
|
|||
/// </summary>
|
|||
public ApplyRevocationRequestContext(OpenIddictClientTransaction transaction) |
|||
: base(transaction) |
|||
{ |
|||
} |
|||
|
|||
/// <summary>
|
|||
/// Gets or sets the request.
|
|||
/// </summary>
|
|||
public OpenIddictRequest Request |
|||
{ |
|||
get => Transaction.Request!; |
|||
set => Transaction.Request = value; |
|||
} |
|||
} |
|||
|
|||
/// <summary>
|
|||
/// Represents an event called for each revocation response
|
|||
/// to extract the response parameters from the server response.
|
|||
/// </summary>
|
|||
public sealed class ExtractRevocationResponseContext : BaseExternalContext |
|||
{ |
|||
/// <summary>
|
|||
/// Creates a new instance of the <see cref="ExtractRevocationResponseContext"/> class.
|
|||
/// </summary>
|
|||
public ExtractRevocationResponseContext(OpenIddictClientTransaction transaction) |
|||
: base(transaction) |
|||
{ |
|||
} |
|||
|
|||
/// <summary>
|
|||
/// Gets or sets the request.
|
|||
/// </summary>
|
|||
public OpenIddictRequest Request |
|||
{ |
|||
get => Transaction.Request!; |
|||
set => Transaction.Request = value; |
|||
} |
|||
|
|||
/// <summary>
|
|||
/// Gets or sets the response, or <see langword="null"/> if it wasn't extracted yet.
|
|||
/// </summary>
|
|||
public OpenIddictResponse? Response |
|||
{ |
|||
get => Transaction.Response; |
|||
set => Transaction.Response = value; |
|||
} |
|||
} |
|||
|
|||
/// <summary>
|
|||
/// Represents an event called for each revocation response.
|
|||
/// </summary>
|
|||
public sealed class HandleRevocationResponseContext : BaseExternalContext |
|||
{ |
|||
/// <summary>
|
|||
/// Creates a new instance of the <see cref="HandleRevocationResponseContext"/> class.
|
|||
/// </summary>
|
|||
public HandleRevocationResponseContext(OpenIddictClientTransaction transaction) |
|||
: base(transaction) |
|||
{ |
|||
} |
|||
|
|||
/// <summary>
|
|||
/// Gets or sets the request.
|
|||
/// </summary>
|
|||
public OpenIddictRequest Request |
|||
{ |
|||
get => Transaction.Request!; |
|||
set => Transaction.Request = value; |
|||
} |
|||
|
|||
/// <summary>
|
|||
/// Gets or sets the response.
|
|||
/// </summary>
|
|||
public OpenIddictResponse Response |
|||
{ |
|||
get => Transaction.Response!; |
|||
set => Transaction.Response = value; |
|||
} |
|||
|
|||
/// <summary>
|
|||
/// Gets or sets the token sent to the revocation endpoint.
|
|||
/// </summary>
|
|||
public string? Token { get; set; } |
|||
} |
|||
} |
|||
@ -0,0 +1,125 @@ |
|||
/* |
|||
* 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.Collections.Immutable; |
|||
using System.Text.Json; |
|||
using Microsoft.Extensions.Logging; |
|||
|
|||
namespace OpenIddict.Client; |
|||
|
|||
public static partial class OpenIddictClientHandlers |
|||
{ |
|||
public static class Revocation |
|||
{ |
|||
public static ImmutableArray<OpenIddictClientHandlerDescriptor> DefaultHandlers { get; } = [ |
|||
/* |
|||
* Revocation response handling: |
|||
*/ |
|||
ValidateWellKnownParameters.Descriptor, |
|||
HandleErrorResponse.Descriptor |
|||
]; |
|||
|
|||
/// <summary>
|
|||
/// Contains the logic responsible for validating the well-known parameters contained in the revocation response.
|
|||
/// </summary>
|
|||
public sealed class ValidateWellKnownParameters : IOpenIddictClientHandler<HandleRevocationResponseContext> |
|||
{ |
|||
/// <summary>
|
|||
/// Gets the default descriptor definition assigned to this handler.
|
|||
/// </summary>
|
|||
public static OpenIddictClientHandlerDescriptor Descriptor { get; } |
|||
= OpenIddictClientHandlerDescriptor.CreateBuilder<HandleRevocationResponseContext>() |
|||
.UseSingletonHandler<ValidateWellKnownParameters>() |
|||
.SetOrder(int.MinValue + 100_000) |
|||
.SetType(OpenIddictClientHandlerType.BuiltIn) |
|||
.Build(); |
|||
|
|||
/// <inheritdoc/>
|
|||
public ValueTask HandleAsync(HandleRevocationResponseContext context) |
|||
{ |
|||
if (context is null) |
|||
{ |
|||
throw new ArgumentNullException(nameof(context)); |
|||
} |
|||
|
|||
foreach (var parameter in context.Response.GetParameters()) |
|||
{ |
|||
if (!ValidateParameterType(parameter.Key, parameter.Value)) |
|||
{ |
|||
context.Reject( |
|||
error: Errors.ServerError, |
|||
description: SR.FormatID2107(parameter.Key), |
|||
uri: SR.FormatID8000(SR.ID2107)); |
|||
|
|||
return default; |
|||
} |
|||
} |
|||
|
|||
return default; |
|||
|
|||
// Note: in the typical case, the response parameters should be deserialized from a
|
|||
// JSON response and thus natively stored as System.Text.Json.JsonElement instances.
|
|||
//
|
|||
// In the rare cases where the underlying value wouldn't be a JsonElement instance
|
|||
// (e.g when custom parameters are manually added to the response), the static
|
|||
// conversion operator would take care of converting the underlying value to a
|
|||
// JsonElement instance using the same value type as the original parameter value.
|
|||
static bool ValidateParameterType(string name, OpenIddictParameter value) => name switch |
|||
{ |
|||
// Error parameters MUST be formatted as unique strings:
|
|||
Parameters.Error or Parameters.ErrorDescription or Parameters.ErrorUri |
|||
=> ((JsonElement) value).ValueKind is JsonValueKind.String, |
|||
|
|||
// Claims that are not in the well-known list can be of any type.
|
|||
_ => true |
|||
}; |
|||
} |
|||
} |
|||
|
|||
/// <summary>
|
|||
/// Contains the logic responsible for surfacing potential errors from the revocation response.
|
|||
/// </summary>
|
|||
public sealed class HandleErrorResponse : IOpenIddictClientHandler<HandleRevocationResponseContext> |
|||
{ |
|||
/// <summary>
|
|||
/// Gets the default descriptor definition assigned to this handler.
|
|||
/// </summary>
|
|||
public static OpenIddictClientHandlerDescriptor Descriptor { get; } |
|||
= OpenIddictClientHandlerDescriptor.CreateBuilder<HandleRevocationResponseContext>() |
|||
.UseSingletonHandler<HandleErrorResponse>() |
|||
.SetOrder(ValidateWellKnownParameters.Descriptor.Order + 1_000) |
|||
.SetType(OpenIddictClientHandlerType.BuiltIn) |
|||
.Build(); |
|||
|
|||
/// <inheritdoc/>
|
|||
public ValueTask HandleAsync(HandleRevocationResponseContext context) |
|||
{ |
|||
if (context is null) |
|||
{ |
|||
throw new ArgumentNullException(nameof(context)); |
|||
} |
|||
|
|||
if (!string.IsNullOrEmpty(context.Response.Error)) |
|||
{ |
|||
context.Logger.LogInformation(SR.GetResourceString(SR.ID6230), context.Response); |
|||
|
|||
context.Reject( |
|||
error: context.Response.Error switch |
|||
{ |
|||
Errors.UnauthorizedClient => Errors.UnauthorizedClient, |
|||
_ => Errors.ServerError |
|||
}, |
|||
description: SR.GetResourceString(SR.ID2175), |
|||
uri: SR.FormatID8000(SR.ID2175)); |
|||
|
|||
return default; |
|||
} |
|||
|
|||
return default; |
|||
} |
|||
} |
|||
} |
|||
} |
|||
Loading…
Reference in new issue